]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc.h
git.ckatri.com / mandoc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fixed STRUCTURE repeat (schwarze@openbsd.org).
[mandoc.git] / mdoc.h
diff --git a/mdoc.h b/mdoc.h
index 740da2a589d3092968d8f2596f357cb89ddf82d5..bd139d6c9e30e47c29049c9183d8fd2d22e91825 100644 (file)
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,24 +1,24 @@
-/* $Id: mdoc.h,v 1.39 2009/03/08 13:52:29 kristaps Exp $ */
+/*     $Id: mdoc.h,v 1.61 2009/06/18 20:46:19 kristaps Exp $ */
 /*
 /*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 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 MDOC_H
 #define MDOC_H
 
  */
 #ifndef MDOC_H
 #define MDOC_H
 
+#include <time.h>
+
 /*
  * This library implements a validating scanner/parser for ``mdoc'' roff
  * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file
 /*
  * This library implements a validating scanner/parser for ``mdoc'' roff
  * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file
@@ -29,9 +29,7 @@
 
 /* What follows is a list of ALL possible macros. */
 
 
 /* What follows is a list of ALL possible macros. */
 
-/* TODO: Brq et al. */
-
-#define        MDOC___          0
+#define        MDOC_Ap          0
 #define        MDOC_Dd          1
 #define        MDOC_Dt          2
 #define        MDOC_Os          3
 #define        MDOC_Dd          1
 #define        MDOC_Dt          2
 #define        MDOC_Os          3
@@ -138,7 +136,18 @@
 #define        MDOC_Fr          104
 #define        MDOC_Ud          105
 #define        MDOC_Lb          106
 #define        MDOC_Fr          104
 #define        MDOC_Ud          105
 #define        MDOC_Lb          106
-#define        MDOC_MAX         107
+#define        MDOC_Lp          107
+#define        MDOC_Lk          108
+#define        MDOC_Mt          109
+#define        MDOC_Brq         110
+#define        MDOC_Bro         111
+#define        MDOC_Brc         112
+#define        MDOC__C          113
+#define        MDOC_Es          114
+#define        MDOC_En          115
+#define        MDOC_Dx          116
+#define        MDOC__Q          117
+#define        MDOC_MAX         118
 
 /* What follows is a list of ALL possible macro arguments. */
 
 
 /* What follows is a list of ALL possible macro arguments. */
 
@@ -167,7 +176,8 @@
 #define        MDOC_Words       22
 #define        MDOC_Emphasis    23
 #define        MDOC_Symbolic    24
 #define        MDOC_Words       22
 #define        MDOC_Emphasis    23
 #define        MDOC_Symbolic    24
-#define        MDOC_ARG_MAX     25
+#define        MDOC_Nested      25
+#define        MDOC_ARG_MAX     26
 
 /* Warnings are either syntax or groff-compatibility. */
 enum   mdoc_warn {
 
 /* Warnings are either syntax or groff-compatibility. */
 enum   mdoc_warn {
@@ -188,27 +198,26 @@ enum      mdoc_type {
 
 /* Section (named/unnamed) of `Sh'. */
 enum   mdoc_sec {
 
 /* Section (named/unnamed) of `Sh'. */
 enum   mdoc_sec {
-       SEC_PROLOGUE            = 0,
-       SEC_BODY                = 1,
-       SEC_NAME                = 2,
-       SEC_LIBRARY             = 3,
-       SEC_SYNOPSIS            = 4,
-       SEC_DESCRIPTION         = 5,
-       SEC_IMPLEMENTATION      = 6,
-       SEC_RETURN_VALUES       = 7,
-       SEC_ENVIRONMENT         = 8,
-       SEC_FILES               = 9,
-       SEC_EXAMPLES            = 10,
-       SEC_DIAGNOSTICS         = 11,
-       SEC_COMPATIBILITY       = 12,
-       SEC_ERRORS              = 13,
-       SEC_SEE_ALSO            = 14,
-       SEC_STANDARDS           = 15,
-       SEC_HISTORY             = 16,
-       SEC_AUTHORS             = 17,
-       SEC_CAVEATS             = 18,
-       SEC_BUGS                = 19,
-       SEC_CUSTOM
+       SEC_NONE,               /* No section, yet. */
+       SEC_NAME,
+       SEC_LIBRARY,
+       SEC_SYNOPSIS,
+       SEC_DESCRIPTION,
+       SEC_IMPLEMENTATION,
+       SEC_RETURN_VALUES,
+       SEC_ENVIRONMENT,
+       SEC_FILES,
+       SEC_EXAMPLES,
+       SEC_DIAGNOSTICS,
+       SEC_COMPATIBILITY,
+       SEC_ERRORS,
+       SEC_SEE_ALSO,
+       SEC_STANDARDS,
+       SEC_HISTORY,
+       SEC_AUTHORS,
+       SEC_CAVEATS,
+       SEC_BUGS,
+       SEC_CUSTOM              /* User-defined. */
 };
 
 /* Information from prologue. */
 };
 
 /* Information from prologue. */
@@ -243,6 +252,7 @@ struct      mdoc_node {
        struct mdoc_node *child;
        struct mdoc_node *next;
        struct mdoc_node *prev;
        struct mdoc_node *child;
        struct mdoc_node *next;
        struct mdoc_node *prev;
+       int               nchild;
        int               line;
        int               pos;
        int               tok;
        int               line;
        int               pos;
        int               tok;
@@ -251,6 +261,8 @@ struct      mdoc_node {
 #define        MDOC_ACTED       (1 << 1)
        enum mdoc_type    type;
        enum mdoc_sec     sec;
 #define        MDOC_ACTED       (1 << 1)
        enum mdoc_type    type;
        enum mdoc_sec     sec;
+
+       /* FIXME: union/struct this with #defines. */
        struct mdoc_arg  *args;         /* BLOCK/ELEM */
        struct mdoc_node *head;         /* BLOCK */
        struct mdoc_node *body;         /* BLOCK */
        struct mdoc_arg  *args;         /* BLOCK/ELEM */
        struct mdoc_node *head;         /* BLOCK */
        struct mdoc_node *body;         /* BLOCK */
@@ -258,55 +270,42 @@ struct    mdoc_node {
        char             *string;       /* TEXT */
 };
 
        char             *string;       /* TEXT */
 };
 
-#define        MDOC_IGN_SCOPE   (1 << 0)
+#define        MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */
+#define        MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */
+#define        MDOC_IGN_MACRO   (1 << 2) /* Ignore unknown macros. */
+#define        MDOC_IGN_CHARS   (1 << 3) /* Ignore disallowed chars. */
 
 /* Call-backs for parse messages. */
 
 /* Call-backs for parse messages. */
+/* FIXME: unify somehow with man_cb. */
 struct mdoc_cb {
 struct mdoc_cb {
-       void    (*mdoc_msg)(void *, int, int, const char *);
        int     (*mdoc_err)(void *, int, int, const char *);
        int     (*mdoc_warn)(void *, int, int, 
                        enum mdoc_warn, const char *);
 };
 
        int     (*mdoc_err)(void *, int, int, const char *);
        int     (*mdoc_warn)(void *, int, int, 
                        enum mdoc_warn, const char *);
 };
 
-/* Global table of macro names (`Bd', `Ed', etc.). */
-extern const char *const *mdoc_macronames;
+/* See mdoc.3 for documentation. */
 
 
-/* Global table of argument names (`column', `tag', etc.). */
+extern const char *const *mdoc_macronames;
 extern const char *const *mdoc_argnames;
 
 __BEGIN_DECLS
 
 struct mdoc;
 
 extern const char *const *mdoc_argnames;
 
 __BEGIN_DECLS
 
 struct mdoc;
 
-/* Free memory allocated with mdoc_alloc. */
-void             mdoc_free(struct mdoc *);
-
-/* Allocate a new parser instance. */
-struct mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
+/* See mdoc.3 for documentation. */
 
 
-/* Set parse options. */
-void             mdoc_setflags(struct mdoc *, int);
-
-/* Parse a single line in a stream (boolean retval). */
+void             mdoc_free(struct mdoc *);
+struct mdoc     *mdoc_alloc(void *, int, const struct mdoc_cb *);
+int              mdoc_reset(struct mdoc *);
 int              mdoc_parseln(struct mdoc *, int, char *buf);
 int              mdoc_parseln(struct mdoc *, int, char *buf);
-
-/* Get result first node (after mdoc_endparse!). */
 const struct mdoc_node *mdoc_node(const struct mdoc *);
 const struct mdoc_node *mdoc_node(const struct mdoc *);
-
-/* Get result meta-information (after mdoc_endparse!). */
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
-
-/* Signal end of parse sequence (boolean retval). */
 int              mdoc_endparse(struct mdoc *);
 
 int              mdoc_endparse(struct mdoc *);
 
-/* The following are utility functions. */
-
 const char      *mdoc_a2att(const char *);
 const char      *mdoc_a2lib(const char *);
 const char      *mdoc_a2st(const char *);
 
 const char      *mdoc_a2att(const char *);
 const char      *mdoc_a2lib(const char *);
 const char      *mdoc_a2st(const char *);
 
-int              mdoc_isdelim(const char *);
-
 __END_DECLS
 
 #endif /*!MDOC_H*/
 __END_DECLS
 
 #endif /*!MDOC_H*/
A git conversion mirror of mandoc.bsd.lv