Updated libman AST documentation.

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index add78a8acc3b88d565d943c48d896efb13acffba..f17964bb21049493a7f5068867deffc312315f3c 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,27 +1,25 @@
-/* $Id: man.h,v 1.10 2009/04/05 16:34:22 kristaps Exp $ */
+/*     $Id: man.h,v 1.17 2009/08/13 11:45:29 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>

  *
  * Permission to use, copy, modify, and distribute this software for any
  *
  * 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.
+ * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR 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.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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>
 
  */
 #ifndef MAN_H
 #define MAN_H
 
 #include <time.h>
 

-#define        MAN___           0
+#define        MAN_br           0

 #define        MAN_TH           1
 #define        MAN_SH           2
 #define        MAN_SS           3
 #define        MAN_TH           1
 #define        MAN_SH           2
 #define        MAN_SS           3


@@ -42,15 +40,21 @@
 #define        MAN_I            18
 #define        MAN_IR           19
 #define        MAN_RI           20
 #define        MAN_I            18
 #define        MAN_IR           19
 #define        MAN_RI           20

-#define        MAN_br           21
-#define        MAN_na           22
-#define        MAN_i            23
-#define        MAN_MAX          24
+#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_MAX          27

 
 enum   man_type {
        MAN_TEXT,
        MAN_ELEM,
 
 enum   man_type {
        MAN_TEXT,
        MAN_ELEM,

-       MAN_ROOT
+       MAN_ROOT,
+       MAN_BLOCK,
+       MAN_HEAD,
+       MAN_BODY

 };
 
 struct man_meta {
 };
 
 struct man_meta {


@@ -66,6 +70,7 @@ struct        man_node {
        struct man_node *child;
        struct man_node *next;
        struct man_node *prev;
        struct man_node *child;
        struct man_node *next;
        struct man_node *prev;

+       int              nchild;

        int              line;
        int              pos;
        int              tok;
        int              line;
        int              pos;
        int              tok;


@@ -74,9 +79,13 @@ struct       man_node {
 #define        MAN_ACTED       (1 << 1)
        enum man_type    type;
        char            *string;
 #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) /* Ignore unknown macros. */
+#define        MAN_IGN_MACRO    (1 << 0)
+#define        MAN_IGN_CHARS    (1 << 1)
+#define        MAN_IGN_ESCAPE   (1 << 2)

 
 extern const char *const *man_macronames;
 
 
 extern const char *const *man_macronames;