]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.h
move man(7) validation into the dedicated validation phase, too
[mandoc.git] / man.h
diff --git a/man.h b/man.h
index 0c59d5bcfb7cf5241a12ea3e231fff0f4d3c86f3..5a8d25937c7373f8d442349e13d24e413d803a9a 100644 (file)
--- a/man.h
+++ b/man.h
-/*     $Id: man.h,v 1.22 2009/10/24 05:45:04 kristaps Exp $ */
+/*     $Id: man.h,v 1.76 2015/10/22 21:54:23 schwarze Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifndef MAN_H
-#define MAN_H
 
-#include <time.h>
-
-#define        MAN_br           0
-#define        MAN_TH           1
-#define        MAN_SH           2
-#define        MAN_SS           3
-#define        MAN_TP           4
-#define        MAN_LP           5
-#define        MAN_PP           6
-#define        MAN_P            7
-#define        MAN_IP           8
-#define        MAN_HP           9
-#define        MAN_SM           10
-#define        MAN_SB           11
-#define        MAN_BI           12
-#define        MAN_IB           13
-#define        MAN_BR           14
-#define        MAN_RB           15
-#define        MAN_R            16
-#define        MAN_B            17
-#define        MAN_I            18
-#define        MAN_IR           19
-#define        MAN_RI           20
-#define        MAN_na           21
-#define        MAN_i            22
-#define        MAN_sp           23
-#define        MAN_nf           24
-#define        MAN_fi           25
-#define        MAN_r            26
-#define        MAN_RE           27
-#define        MAN_RS           28
-#define        MAN_DT           29
-#define        MAN_UC           30
-#define        MAN_PD           31
-#define        MAN_MAX          32
-
-enum   man_type {
-       MAN_TEXT,
-       MAN_ELEM,
-       MAN_ROOT,
-       MAN_BLOCK,
-       MAN_HEAD,
-       MAN_BODY
-};
-
-struct man_meta {
-       int              msec;
-       time_t           date;
-       char            *vol;
-       char            *title;
-       char            *source;
-};
-
-struct man_node {
-       struct man_node *parent;
-       struct man_node *child;
-       struct man_node *next;
-       struct man_node *prev;
-       int              nchild;
-       int              line;
-       int              pos;
-       int              tok;
-       int              flags;
-#define        MAN_VALID       (1 << 0)
-#define        MAN_ACTED       (1 << 1)
-       enum man_type    type;
-       char            *string;
-       struct man_node *head;
-       struct man_node *body;
-};
-
-#define        MAN_IGN_MACRO    (1 << 0)
-#define        MAN_IGN_CHARS    (1 << 1)
-#define        MAN_IGN_ESCAPE   (1 << 2)
+#define        MAN_br   0
+#define        MAN_TH   1
+#define        MAN_SH   2
+#define        MAN_SS   3
+#define        MAN_TP   4
+#define        MAN_LP   5
+#define        MAN_PP   6
+#define        MAN_P    7
+#define        MAN_IP   8
+#define        MAN_HP   9
+#define        MAN_SM  10
+#define        MAN_SB  11
+#define        MAN_BI  12
+#define        MAN_IB  13
+#define        MAN_BR  14
+#define        MAN_RB  15
+#define        MAN_R   16
+#define        MAN_B   17
+#define        MAN_I   18
+#define        MAN_IR  19
+#define        MAN_RI  20
+#define        MAN_sp  21
+#define        MAN_nf  22
+#define        MAN_fi  23
+#define        MAN_RE  24
+#define        MAN_RS  25
+#define        MAN_DT  26
+#define        MAN_UC  27
+#define        MAN_PD  28
+#define        MAN_AT  29
+#define        MAN_in  30
+#define        MAN_ft  31
+#define        MAN_OP  32
+#define        MAN_EX  33
+#define        MAN_EE  34
+#define        MAN_UR  35
+#define        MAN_UE  36
+#define        MAN_ll  37
+#define        MAN_MAX 38
 
+/* Names of macros. */
 extern const char *const *man_macronames;
 
-struct man_cb {
-       int     (*man_warn)(void *, int, int, const char *);
-       int     (*man_err)(void *, int, int, const char *);
-};
-
 __BEGIN_DECLS
 
-struct man;
+struct roff_man;
 
-void             man_free(struct man *);
-struct man      *man_alloc(void *, int, const struct man_cb *);
-int              man_reset(struct man *);
-int              man_parseln(struct man *, int, char *buf);
-int              man_endparse(struct man *);
-
-const struct man_node *man_node(const struct man *);
-const struct man_meta *man_meta(const struct man *);
+const struct mparse    *man_mparse(const struct roff_man *);
+void                    man_validate(struct roff_man *);
 
 __END_DECLS
-
-#endif /*!MAN_H*/