]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc.c
Strings abstracted into dynamically-created C files.
[mandoc.git] / mdoc.c
diff --git a/mdoc.c b/mdoc.c
index ccd9e238c08c40e6ce3c6d48b99e10fb4cdd67f9..48785716e0f9bbe69fd4ce8a89c21b8a556688b9 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc.c,v 1.44 2009/01/21 11:35:26 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.52 2009/03/06 14:13:47 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Main caller in the libmdoc library.  This begins the parsing routine,
  * handles allocation of data, and so forth.  Most of the "work" is done
- * in macro.c, but this orchestrates who does what, when.
+ * in macro.c and validate.c.
  */
 
+static struct mdoc_arg  *argdup(size_t, const struct mdoc_arg *);
+static void              argfree(size_t, struct mdoc_arg *);
+static void              argcpy(struct mdoc_arg *, 
+                               const struct mdoc_arg *);
+
+static struct mdoc_node *mdoc_node_alloc(const struct mdoc *);
+static int               mdoc_node_append(struct mdoc *, 
+                               struct mdoc_node *);
+static void              mdoc_elem_free(struct mdoc_elem *);
+static void              mdoc_text_free(struct mdoc_text *);
+
+
 const  char *const __mdoc_macronames[MDOC_MAX] = {              
        "\\\"",         "Dd",           "Dt",           "Os",
        "Sh",           "Ss",           "Pp",           "D1",
@@ -62,7 +74,7 @@ const char *const __mdoc_macronames[MDOC_MAX] = {
        "Tn",           "Ux",           "Xc",           "Xo",
        "Fo",           "Fc",           "Oo",           "Oc",
        "Bk",           "Ek",           "Bt",           "Hf",
-       "Fr",           "Ud",
+       "Fr",           "Ud",           "Lb",
        };
 
 const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {            
@@ -73,153 +85,16 @@ const      char *const __mdoc_argnames[MDOC_ARG_MAX] = {
        "tag",                  "diag",                 "hang",          
        "ohang",                "inset",                "column",        
        "width",                "compact",              "std",   
-       "p1003.1-88",           "p1003.1-90",           "p1003.1-96",
-       "p1003.1-2001",         "p1003.1-2004",         "p1003.1",
-       "p1003.1b",             "p1003.1b-93",          "p1003.1c-95",
-       "p1003.1g-2000",        "p1003.2-92",           "p1387.2-95",
-       "p1003.2",              "p1387.2",              "isoC-90",
-       "isoC-amd1",            "isoC-tcor1",           "isoC-tcor2",
-       "isoC-99",              "ansiC",                "ansiC-89",
-       "ansiC-99",             "ieee754",              "iso8802-3",
-       "xpg3",                 "xpg4",                 "xpg4.2",
-       "xpg4.3",               "xbd5",                 "xcu5",
-       "xsh5",                 "xns5",                 "xns5.2d2.0",
-       "xcurses4.2",           "susv2",                "susv3",
-       "svid4",                "filled",               "words",
-       "emphasis",             "symbolic",
+       "filled",               "words",                "emphasis",
+       "symbolic"
        };
 
-/* Central table of library: who gets parsed how. */
-
-const  struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
-       { NULL, 0 }, /* \" */
-       { macro_constant, MDOC_PROLOGUE }, /* Dd */
-       { macro_constant, MDOC_PROLOGUE }, /* Dt */
-       { macro_constant, MDOC_PROLOGUE }, /* Os */
-       { macro_scoped, 0 }, /* Sh */
-       { macro_scoped, 0 }, /* Ss */ 
-       { macro_text, 0 }, /* Pp */ 
-       { macro_scoped_line, MDOC_PARSED }, /* D1 */
-       { macro_scoped_line, MDOC_PARSED }, /* Dl */
-       { macro_scoped, MDOC_EXPLICIT }, /* Bd */
-       { macro_scoped_close, MDOC_EXPLICIT }, /* Ed */
-       { macro_scoped, MDOC_EXPLICIT }, /* Bl */
-       { macro_scoped_close, MDOC_EXPLICIT }, /* El */
-       { macro_scoped, MDOC_PARSED }, /* It */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ 
-       { macro_text, MDOC_PARSED }, /* An */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
-       { macro_constant, 0 }, /* Cd */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */ 
-       { macro_constant, 0 }, /* Ex */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */ 
-       { macro_constant, 0 }, /* Fd */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ 
-       { macro_text, MDOC_PARSED }, /* Ft */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ 
-       { macro_constant, 0 }, /* In */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
-       { macro_constant, 0 }, /* Nd */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ 
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
-       { macro_obsolete, 0 }, /* Ot */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
-       { macro_constant, 0 }, /* Rv */
-       /* XXX - .St supposed to be (but isn't) callable. */
-       { macro_constant_delimited, MDOC_PARSED }, /* St */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ 
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
-       { macro_constant, 0 }, /* %A */
-       { macro_constant, 0 }, /* %B */
-       { macro_constant, 0 }, /* %D */
-       { macro_constant, 0 }, /* %I */
-       { macro_constant, 0 }, /* %J */
-       { macro_constant, 0 }, /* %N */
-       { macro_constant, 0 }, /* %O */
-       { macro_constant, 0 }, /* %P */
-       { macro_constant, 0 }, /* %R */
-       { macro_constant, 0 }, /* %T */
-       { macro_constant, 0 }, /* %V */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
-       { macro_constant_delimited, 0 }, /* At */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
-       { macro_scoped, MDOC_EXPLICIT }, /* Bf */ 
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
-       { macro_constant_delimited, MDOC_PARSED }, /* Bsx */
-       { macro_constant_delimited, MDOC_PARSED }, /* Bx */
-       { macro_constant, 0 }, /* Db */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
-       { macro_scoped_close, MDOC_EXPLICIT }, /* Ef */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ 
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
-       { macro_constant_delimited, MDOC_PARSED }, /* Fx */
-       { macro_text, MDOC_PARSED }, /* Ms */
-       { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */
-       { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */
-       { macro_constant_delimited, MDOC_PARSED }, /* Nx */
-       { macro_constant_delimited, MDOC_PARSED }, /* Ox */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
-       { macro_constant_delimited, MDOC_PARSED }, /* Pf */
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
-       { macro_scoped_close, MDOC_EXPLICIT }, /* Re */
-       { macro_scoped, MDOC_EXPLICIT }, /* Rs */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */
-       { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
-       { macro_constant, 0 }, /* Sm */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
-       { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
-       { macro_constant_delimited, MDOC_PARSED }, /* Ux */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
-       /* XXX - .Fo supposed to be (but isn't) callable. */
-       { macro_scoped, MDOC_EXPLICIT }, /* Fo */ 
-       /* XXX - .Fc supposed to be (but isn't) callable. */
-       { macro_scoped_close, MDOC_EXPLICIT }, /* Fc */ 
-       { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */
-       { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
-       { macro_scoped, MDOC_EXPLICIT }, /* Bk */
-       { macro_scoped_close, MDOC_EXPLICIT }, /* Ek */
-       { macro_constant, 0 }, /* Bt */
-       { macro_constant, 0 }, /* Hf */
-       { macro_obsolete, 0 }, /* Fr */
-       { macro_constant, 0 }, /* Ud */
-};
-
 const  char * const *mdoc_macronames = __mdoc_macronames;
 const  char * const *mdoc_argnames = __mdoc_argnames;
-const  struct mdoc_macro * const mdoc_macros = __mdoc_macros;
-
-static struct mdoc_arg  *argdup(size_t, const struct mdoc_arg *);
-static void              argfree(size_t, struct mdoc_arg *);
-static void              argcpy(struct mdoc_arg *, 
-                               const struct mdoc_arg *);
-
-static int               mdoc_node_append(struct mdoc *, 
-                               struct mdoc_node *);
-static void              mdoc_elem_free(struct mdoc_elem *);
-static void              mdoc_text_free(struct mdoc_text *);
 
 
 const struct mdoc_node *
-mdoc_node(struct mdoc *mdoc)
+mdoc_node(const struct mdoc *mdoc)
 {
 
        return(mdoc->first);
@@ -227,7 +102,7 @@ mdoc_node(struct mdoc *mdoc)
 
 
 const struct mdoc_meta *
-mdoc_meta(struct mdoc *mdoc)
+mdoc_meta(const struct mdoc *mdoc)
 {
 
        return(&mdoc->meta);
@@ -248,6 +123,10 @@ mdoc_free(struct mdoc *mdoc)
                free(mdoc->meta.os);
        if (mdoc->meta.name)
                free(mdoc->meta.name);
+       if (mdoc->meta.arch)
+               free(mdoc->meta.arch);
+       if (mdoc->meta.vol)
+               free(mdoc->meta.vol);
 
        free(mdoc);
 }
@@ -293,6 +172,12 @@ mdoc_endparse(struct mdoc *mdoc)
 }
 
 
+/*
+ * Main line-parsing routine.  If the line is a macro-line (started with
+ * a '.' control character), then pass along to the parser, which parses
+ * subsequent macros until the end of line.  If normal text, simply
+ * append the entire line to the chain.
+ */
 int
 mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
 {
@@ -305,20 +190,30 @@ mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
        mdoc->linetok = 0;
 
        if ('.' != *buf) {
+               /*
+                * Free-form text.  Not allowed in the prologue.
+                */
                if (SEC_PROLOGUE == mdoc->lastnamed)
-                       return(mdoc_perr(mdoc, line, 0, "text disallowed in document prologue"));
+                       return(mdoc_perr(mdoc, line, 0, 
+                                       "no text in prologue"));
+
                if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
                        return(0);
                mdoc->next = MDOC_NEXT_SIBLING;
                return(1);
        }
 
+       /*
+        * Control-character detected.  Begin the parsing sequence.
+        */
+
        if (buf[1] && '\\' == buf[1])
                if (buf[2] && '\"' == buf[2])
                        return(1);
 
        i = 1;
-       while (buf[i] && ! isspace((int)buf[i]) && i < (int)sizeof(tmp))
+       while (buf[i] && ! isspace((u_char)buf[i]) && 
+                       i < (int)sizeof(tmp))
                i++;
 
        if (i == (int)sizeof(tmp)) {
@@ -339,13 +234,14 @@ mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
                return(mdoc_perr(mdoc, line, 1, "unknown macro"));
        }
 
-       while (buf[i] && isspace((int)buf[i]))
+       while (buf[i] && isspace((u_char)buf[i]))
                i++;
 
        if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) {
                mdoc->flags |= MDOC_HALT;
                return(0);
        }
+
        return(1);
 }
 
@@ -422,7 +318,6 @@ mdoc_macro(struct mdoc *mdoc, int tok,
 static int
 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
 {
-       const char       *nn, *nt, *on, *ot, *act;
 
        assert(mdoc->last);
        assert(mdoc->first);
@@ -449,34 +344,15 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
                                        MDOC_LINEARG_SOFTMAX, mdoc->linetok))
                        return(0);
 
-       if (MDOC_TEXT == mdoc->last->type)
-               on = "<text>";
-       else if (MDOC_ROOT == mdoc->last->type)
-               on = "<root>";
-       else
-               on = mdoc_macronames[mdoc->last->tok];
-
-       if (MDOC_TEXT == p->type)
-               nn = "<text>";
-       else if (MDOC_ROOT == p->type)
-               nn = "<root>";
-       else
-               nn = mdoc_macronames[p->tok];
-
-       ot = mdoc_type2a(mdoc->last->type);
-       nt = mdoc_type2a(p->type);
-
        switch (mdoc->next) {
        case (MDOC_NEXT_SIBLING):
                mdoc->last->next = p;
                p->prev = mdoc->last;
                p->parent = mdoc->last->parent;
-               act = "sibling";
                break;
        case (MDOC_NEXT_CHILD):
                mdoc->last->child = p;
                p->parent = mdoc->last;
-               act = "child";
                break;
        default:
                abort();
@@ -504,12 +380,22 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
        }
 
        mdoc->last = p;
-       mdoc_msg(mdoc, "parse: %s `%s' %s of %s `%s'", 
-                       nt, nn, act, ot, on);
        return(1);
 }
 
 
+static struct mdoc_node *
+mdoc_node_alloc(const struct mdoc *mdoc)
+{
+       struct mdoc_node *p;
+
+       p = xcalloc(1, sizeof(struct mdoc_node));
+       p->sec = mdoc->lastsec;
+
+       return(p);
+}
+
+
 int
 mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
 {
@@ -518,7 +404,7 @@ mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
        assert(mdoc->first);
        assert(mdoc->last);
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
 
        p->line = line;
        p->pos = pos;
@@ -537,7 +423,7 @@ mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
        assert(mdoc->first);
        assert(mdoc->last);
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
 
        p->line = line;
        p->pos = pos;
@@ -556,7 +442,7 @@ mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
        assert(mdoc->first);
        assert(mdoc->last);
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
 
        p->line = line;
        p->pos = pos;
@@ -572,7 +458,7 @@ mdoc_root_alloc(struct mdoc *mdoc)
 {
        struct mdoc_node *p;
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
 
        p->type = MDOC_ROOT;
 
@@ -586,7 +472,7 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
 {
        struct mdoc_node *p;
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
 
        p->pos = pos;
        p->line = line;
@@ -605,7 +491,7 @@ mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
 {
        struct mdoc_node *p;
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
 
        p->line = line;
        p->pos = pos;
@@ -624,7 +510,8 @@ mdoc_word_alloc(struct mdoc *mdoc,
 {
        struct mdoc_node *p;
 
-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mdoc_node_alloc(mdoc);
+
        p->line = line;
        p->pos = pos;
        p->type = MDOC_TEXT;
@@ -756,27 +643,3 @@ argdup(size_t argsz, const struct mdoc_arg *args)
        return(pp);
 }
 
-
-/* FIXME: deprecate. */
-char *
-mdoc_node2a(struct mdoc_node *node)
-{
-       static char      buf[64];
-
-       assert(node);
-
-       buf[0] = 0;
-       (void)xstrlcat(buf, mdoc_type2a(node->type), 64);
-       if (MDOC_ROOT == node->type)
-               return(buf);
-       (void)xstrlcat(buf, " `", 64);
-       if (MDOC_TEXT == node->type)
-               (void)xstrlcat(buf, node->data.text.string, 64);
-       else
-               (void)xstrlcat(buf, mdoc_macronames[node->tok], 64);
-       (void)xstrlcat(buf, "'", 64);
-
-       return(buf);
-}
-
-