Churn-ish check-in getting mdoc_parseln() and man_parseln() to accept a

[mandoc.git] / mdoc.h

diff --git a/mdoc.h b/mdoc.h
index 2abb1d401398a004d8ac3a3145f2978e3dfa0f66..dc4be5875d560aefc28fd74fca8f2e8e4b21fdd6 100644 (file)
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,6 +1,6 @@
-/*     $Id: mdoc.h,v 1.75 2010/05/09 21:19:42 kristaps Exp $ */
+/*     $Id: mdoc.h,v 1.92 2010/06/26 15:36:37 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -149,11 +149,13 @@ enum      mdoct {
        MDOC_br,
        MDOC_sp,
        MDOC__U,
+       MDOC_Ta,
        MDOC_MAX
 };
 
 /* What follows is a list of ALL possible macro arguments. */
 
+/* FIXME: make this into an enum. */
 #define        MDOC_Split       0
 #define        MDOC_Nosplit     1
 #define        MDOC_Ragged      2
@@ -202,10 +204,10 @@ enum      mdoc_sec {
        SEC_SYNOPSIS,
        SEC_DESCRIPTION,
        SEC_IMPLEMENTATION,
-       SEC_EXIT_STATUS,
        SEC_RETURN_VALUES,
        SEC_ENVIRONMENT, 
        SEC_FILES,
+       SEC_EXIT_STATUS,
        SEC_EXAMPLES,
        SEC_DIAGNOSTICS,
        SEC_COMPATIBILITY,
@@ -217,12 +219,13 @@ enum      mdoc_sec {
        SEC_CAVEATS,
        SEC_BUGS,
        SEC_SECURITY,
-       SEC_CUSTOM              /* User-defined. */
+       SEC_CUSTOM,             /* User-defined. */
+       SEC__MAX
 };
 
 /* Information from prologue. */
 struct mdoc_meta {
-       int               msec;
+       char             *msec;
        char             *vol;
        char             *arch;
        time_t            date;
@@ -246,22 +249,60 @@ struct    mdoc_arg {
        unsigned int      refcnt;
 };
 
+enum   mdoc_list {
+       LIST__NONE = 0,
+       LIST_bullet,
+       LIST_column,
+       LIST_dash,
+       LIST_diag,
+       LIST_enum,
+       LIST_hang,
+       LIST_hyphen,
+       LIST_inset,
+       LIST_item,
+       LIST_ohang,
+       LIST_tag
+};
+
+enum   mdoc_disp {
+       DISP__NONE = 0,
+       DISP_centred,
+       DISP_ragged,
+       DISP_unfilled,
+       DISP_filled,
+       DISP_literal
+};
+
+struct mdoc_bd {
+       const char       *offs; /* -offset */
+       enum mdoc_disp    type; /* -ragged, etc. */
+       int               comp; /* -compact */
+};
+
+struct mdoc_bl {
+       const char       *width; /* -width */
+       const char       *offs; /* -offset */
+       enum mdoc_list    type; /* -tag, -enum, etc. */
+       int               comp; /* -compact */
+};
+
 /* Node in AST. */
 struct mdoc_node {
-       struct mdoc_node *parent;
-       struct mdoc_node *child;
-       struct mdoc_node *next;
-       struct mdoc_node *prev;
-       int               nchild;
-       int               line;
-       int               pos;
-       enum mdoct        tok;
+       struct mdoc_node *parent; /* parent AST node */
+       struct mdoc_node *child; /* first child AST node */
+       struct mdoc_node *next; /* sibling AST node */
+       struct mdoc_node *prev; /* prior sibling AST node */
+       int               nchild; /* number children */
+       int               line; /* parse line */
+       int               pos; /* parse column */
+       enum mdoct        tok; /* tok or MDOC__MAX if none */
        int               flags;
-#define        MDOC_VALID       (1 << 0)
-#define        MDOC_ACTED       (1 << 1)
-       enum mdoc_type    type;
-       enum mdoc_sec     sec;
-
+#define        MDOC_VALID       (1 << 0) /* has been validated */
+#define        MDOC_ACTED       (1 << 1) /* has been acted upon */
+#define        MDOC_EOS         (1 << 2) /* at sentence boundary */
+#define        MDOC_LINE        (1 << 3) /* first macro/text on line */
+       enum mdoc_type    type; /* AST node type */
+       enum mdoc_sec     sec; /* current named section */
        struct mdoc_arg  *args;         /* BLOCK/ELEM */
 #ifdef UGLY
        struct mdoc_node *pending;      /* BLOCK */
@@ -270,19 +311,17 @@ struct    mdoc_node {
        struct mdoc_node *body;         /* BLOCK */
        struct mdoc_node *tail;         /* BLOCK */
        char             *string;       /* TEXT */
+
+       union {
+               struct mdoc_bl Bl;
+               struct mdoc_bd Bd;
+       } data;
 };
 
 #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. */
 
-/* Call-backs for parse messages. */
-
-struct mdoc_cb {
-       int     (*mdoc_err)(void *, int, int, const char *);
-       int     (*mdoc_warn)(void *, int, int, const char *);
-};
-
 /* See mdoc.3 for documentation. */
 
 extern const char *const *mdoc_macronames;
@@ -295,9 +334,11 @@ struct     mdoc;
 /* See mdoc.3 for documentation. */
 
 void             mdoc_free(struct mdoc *);
-struct mdoc     *mdoc_alloc(void *, int, const struct mdoc_cb *);
+struct mdoc     *mdoc_alloc(void *, int, mandocmsg);
 void             mdoc_reset(struct mdoc *);
-int              mdoc_parseln(struct mdoc *, int, char *buf);
+int              mdoc_parseln(struct mdoc *, 
+                       const struct regset *,
+                       int, char *, int);
 const struct mdoc_node *mdoc_node(const struct mdoc *);
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 int              mdoc_endparse(struct mdoc *);