Noted lacking areas in mdocterm.1.

[mandoc.git] / mdoc.h

diff --git a/mdoc.h b/mdoc.h
index db4b8489e5c0083c0bb615ec5fc7e509e8799c10..6ec0e467d246216ff3ac381a0ae7c18a4802aeec 100644 (file)
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,4 +1,4 @@
-/* $Id: mdoc.h,v 1.29 2009/02/20 07:43:15 kristaps Exp $ */
+/* $Id: mdoc.h,v 1.36 2009/03/02 12:09:32 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -19,6 +19,14 @@
 #ifndef MDOC_H
 #define MDOC_H
 
+/*
+ * This library implements a validating scanner/parser for ``mdoc'' roff
+ * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file
+ * drives the parser, while macro.c describes the macro ontologies.
+ * validate.c pre- and post-validates parsed macros, and action.c
+ * performs actions on parsed and validated macros.
+ */
+
 /* What follows is a list of ALL possible macros. */
 
 #define        MDOC___          0
@@ -212,6 +220,7 @@ enum        mdoc_att {
        ATT_v6,
        ATT_v7,
        ATT_32v,
+       ATT_V,
        ATT_V1,
        ATT_V2,
        ATT_V3,
@@ -355,8 +364,6 @@ struct      mdoc_block {
 
 /* In-line element node. */
 struct mdoc_elem {
-       size_t            sz;
-       char            **args;
        size_t            argc;
        struct mdoc_arg  *argv;
 };
@@ -382,7 +389,7 @@ struct      mdoc_node {
 #define        MDOC_ACTED       (1 << 1)
        enum mdoc_type    type;
        union mdoc_data   data;
-       /* FIXME: have an enum mdoc_sec. */
+       enum mdoc_sec     sec;
 };
 
 /* Call-backs for parse messages. */
@@ -413,14 +420,23 @@ struct    mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
 int              mdoc_parseln(struct mdoc *, int, char *buf);
 
 /* Get result first node (after mdoc_endparse!). */
-const struct mdoc_node *mdoc_node(struct mdoc *);
+const struct mdoc_node *mdoc_node(const struct mdoc *);
 
 /* Get result meta-information (after mdoc_endparse!). */
-const struct mdoc_meta *mdoc_meta(struct mdoc *);
+const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 
 /* Signal end of parse sequence (boolean retval). */
 int              mdoc_endparse(struct mdoc *);
 
+/* The following are utility functions. */
+const char      *mdoc_arch2a(enum mdoc_arch);
+const char      *mdoc_vol2a(enum mdoc_vol);
+const char      *mdoc_msec2a(enum mdoc_msec);
+const char      *mdoc_att2a(enum mdoc_att);
+enum   mdoc_att  mdoc_atoatt(const char *);
+const char      *mdoc_st2a(int);
+int              mdoc_isdelim(const char *);
+
 __END_DECLS
 
 #endif /*!MDOC_H*/