Documentation, more validations, cleaned up actions, added Nm action.

[mandoc.git] / macro.c

diff --git a/macro.c b/macro.c
index 6777d3b8ee2c4a4cd28252f2ab201f4e498406f2..4c24c01fbbd4d2fc73e2cab6bc58f4125bcb1b21 100644 (file)
--- a/macro.c
+++ b/macro.c
@@ -1,4 +1,4 @@
-/* $Id: macro.c,v 1.37 2009/01/15 17:38:57 kristaps Exp $ */
+/* $Id: macro.c,v 1.40 2009/01/17 16:15:27 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -40,8 +40,8 @@ static        int       rewind_dobreak(int, enum mdoc_type,
 
 
 static int       rewind_elem(struct mdoc *, int);
 
 
 static int       rewind_elem(struct mdoc *, int);

-static int       rewind_impblock(struct mdoc *, int);
-static int       rewind_expblock(struct mdoc *, int);
+static int       rewind_impblock(struct mdoc *, int, int, int);
+static int       rewind_expblock(struct mdoc *, int, int, int);

 static int       rewind_subblock(enum mdoc_type, struct mdoc *, int);
 static int       rewind_last(int, int, 
                        struct mdoc *, struct mdoc_node *);
 static int       rewind_subblock(enum mdoc_type, struct mdoc *, int);
 static int       rewind_last(int, int, 
                        struct mdoc *, struct mdoc_node *);


@@ -61,7 +61,7 @@ lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p)
        if (MDOC_MAX == res)
                return(res);
 
        if (MDOC_MAX == res)
                return(res);
 

-       if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX_MACLIKE))
+       if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, "macro-like parameter"))

                return(-1);
        return(MDOC_MAX);
 }
                return(-1);
        return(MDOC_MAX);
 }


@@ -364,14 +364,14 @@ rewind_subblock(enum mdoc_type type, struct mdoc *mdoc, int tok)
 
 
 static int
 
 
 static int

-rewind_expblock(struct mdoc *mdoc, int tok)
+rewind_expblock(struct mdoc *mdoc, int tok, int line, int ppos)

 {
        struct mdoc_node *n;
        int               c;
 
        c = rewind_dohalt(tok, MDOC_BLOCK, mdoc->last);
        if (REWIND_HALT == c)
 {
        struct mdoc_node *n;
        int               c;
 
        c = rewind_dohalt(tok, MDOC_BLOCK, mdoc->last);
        if (REWIND_HALT == c)

-               return(mdoc_err(mdoc, ERR_SCOPE_NOCTX));
+               return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));

        if (REWIND_REWIND == c)
                return(rewind_last(tok, MDOC_BLOCK, mdoc, mdoc->last));
 
        if (REWIND_REWIND == c)
                return(rewind_last(tok, MDOC_BLOCK, mdoc, mdoc->last));
 


@@ -379,12 +379,12 @@ rewind_expblock(struct mdoc *mdoc, int tok)
        for (n = mdoc->last->parent; n; n = n->parent) {
                c = rewind_dohalt(tok, MDOC_BLOCK, n);
                if (REWIND_HALT == c)
        for (n = mdoc->last->parent; n; n = n->parent) {
                c = rewind_dohalt(tok, MDOC_BLOCK, n);
                if (REWIND_HALT == c)

-                       return(mdoc_err(mdoc, ERR_SCOPE_NOCTX));
+                       return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));

                if (REWIND_REWIND == c)
                        break;
                else if (rewind_dobreak(tok, MDOC_BLOCK, n))
                        continue;
                if (REWIND_REWIND == c)
                        break;
                else if (rewind_dobreak(tok, MDOC_BLOCK, n))
                        continue;

-               return(mdoc_nerr(mdoc, n, "macro scope broken"));
+               return(mdoc_nerr(mdoc, n, "block scope broken"));

        }
 
        assert(n);
        }
 
        assert(n);


@@ -393,12 +393,11 @@ rewind_expblock(struct mdoc *mdoc, int tok)
 
 
 static int
 
 
 static int

-rewind_impblock(struct mdoc *mdoc, int tok)
+rewind_impblock(struct mdoc *mdoc, int tok, int line, int ppos)

 {
        struct mdoc_node *n;
        int               c;
 
 {
        struct mdoc_node *n;
        int               c;
 

-       printf("1\n");

        c = rewind_dohalt(tok, MDOC_BLOCK, mdoc->last);
        if (REWIND_HALT == c)
                return(1);
        c = rewind_dohalt(tok, MDOC_BLOCK, mdoc->last);
        if (REWIND_HALT == c)
                return(1);


@@ -414,7 +413,7 @@ rewind_impblock(struct mdoc *mdoc, int tok)
                        break;
                else if (rewind_dobreak(tok, MDOC_BLOCK, n))
                        continue;
                        break;
                else if (rewind_dobreak(tok, MDOC_BLOCK, n))
                        continue;

-               return(mdoc_nerr(mdoc, n, "macro scope broken"));
+               return(mdoc_nerr(mdoc, n, "block scope broken"));

        }
 
        assert(n);
        }
 
        assert(n);


@@ -474,9 +473,9 @@ macro_scoped_close(MACRO_PROT_ARGS)
                if (0 == buf[*pos]) {
                        if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))
                                return(0);
                if (0 == buf[*pos]) {
                        if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))
                                return(0);

-                       return(rewind_expblock(mdoc, tok));
+                       return(rewind_expblock(mdoc, tok, line, ppos));

                }
                }

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_EQ0));
+               return(mdoc_perr(mdoc, line, ppos, "macro expects no parameters"));

        }
 
        if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))
        }
 
        if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))


@@ -495,7 +494,7 @@ macro_scoped_close(MACRO_PROT_ARGS)
                lastarg = *pos;
 
                if (j == maxargs && ! flushed) {
                lastarg = *pos;
 
                if (j == maxargs && ! flushed) {

-                       if ( ! rewind_expblock(mdoc, tok))
+                       if ( ! rewind_expblock(mdoc, tok, line, ppos))

                                return(0);
                        flushed = 1;
                }
                                return(0);
                        flushed = 1;
                }


@@ -512,7 +511,7 @@ macro_scoped_close(MACRO_PROT_ARGS)
                        return(0);
                else if (MDOC_MAX != c) {
                        if ( ! flushed) {
                        return(0);
                else if (MDOC_MAX != c) {
                        if ( ! flushed) {

-                               if ( ! rewind_expblock(mdoc, tok))
+                               if ( ! rewind_expblock(mdoc, tok, line, ppos))

                                        return(0);
                                flushed = 1;
                        }
                                        return(0);
                                flushed = 1;
                        }


@@ -527,9 +526,9 @@ macro_scoped_close(MACRO_PROT_ARGS)
        }
 
        if (MDOC_LINEARG_MAX == j)
        }
 
        if (MDOC_LINEARG_MAX == j)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
 

-       if ( ! flushed && ! rewind_expblock(mdoc, tok))
+       if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos))

                return(0);
 
        if (ppos > 1)
                return(0);
 
        if (ppos > 1)


@@ -561,20 +560,24 @@ macro_text(MACRO_PROT_ARGS)
                la = *pos;
 
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                la = *pos;
 
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);

-               if (ARGV_EOLN == c || ARGV_WORD == c)
+               if (ARGV_EOLN == c)

                        break;
                        break;

-               else if (ARGV_ARG == c)
+               if (ARGV_WORD == c) {
+                       *pos = la;
+                       break;
+               } else if (ARGV_ARG == c)

                        continue;
                        continue;

+

                mdoc_argv_free(argc, argv);
                return(0);
        }
 
        if (MDOC_LINEARG_MAX == argc) {
                mdoc_argv_free(argc, argv);
                mdoc_argv_free(argc, argv);
                return(0);
        }
 
        if (MDOC_LINEARG_MAX == argc) {
                mdoc_argv_free(argc, argv);

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

        }
 
        }
 

-       c = mdoc_elem_alloc(mdoc, line, la, tok, argc, argv);
+       c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);

 
        if (0 == c) {
                mdoc_argv_free(argc, argv);
 
        if (0 == c) {
                mdoc_argv_free(argc, argv);


@@ -626,7 +629,7 @@ macro_text(MACRO_PROT_ARGS)
                        lastpunct = 1;
                } else if (lastpunct) {
                        c = mdoc_elem_alloc(mdoc, line, 
                        lastpunct = 1;
                } else if (lastpunct) {
                        c = mdoc_elem_alloc(mdoc, line, 

-                                       la, tok, argc, argv);
+                                       ppos, tok, argc, argv);

                        if (0 == c) {
                                mdoc_argv_free(argc, argv);
                                return(0);
                        if (0 == c) {
                                mdoc_argv_free(argc, argv);
                                return(0);


@@ -643,7 +646,7 @@ macro_text(MACRO_PROT_ARGS)
        mdoc_argv_free(argc, argv);
 
        if (sz == MDOC_LINEARG_MAX)
        mdoc_argv_free(argc, argv);
 
        if (sz == MDOC_LINEARG_MAX)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        if (0 == lastpunct && ! rewind_elem(mdoc, tok))
                return(0);
 
        if (0 == lastpunct && ! rewind_elem(mdoc, tok))
                return(0);


@@ -668,16 +671,19 @@ macro_scoped(MACRO_PROT_ARGS)
        if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
                if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))
                        return(0);
        if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
                if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))
                        return(0);

-               if ( ! rewind_impblock(mdoc, tok))
+               if ( ! rewind_impblock(mdoc, tok, line, ppos))

                        return(0);
        }
 
        for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                lastarg = *pos;
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                        return(0);
        }
 
        for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                lastarg = *pos;
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);

-               if (ARGV_EOLN == c || ARGV_WORD == c)
+               if (ARGV_EOLN == c)

                        break;
                        break;

-               else if (ARGV_ARG == c)
+               if (ARGV_WORD == c) {
+                       *pos = lastarg;
+                       break;
+               } else if (ARGV_ARG == c)

                        continue;
                mdoc_argv_free(argc, argv);
                return(0);
                        continue;
                mdoc_argv_free(argc, argv);
                return(0);


@@ -685,7 +691,7 @@ macro_scoped(MACRO_PROT_ARGS)
 
        if (MDOC_LINEARG_MAX == argc) {
                mdoc_argv_free(argc, argv);
 
        if (MDOC_LINEARG_MAX == argc) {
                mdoc_argv_free(argc, argv);

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

        }
 
        c = mdoc_block_alloc(mdoc, line, ppos, 
        }
 
        c = mdoc_block_alloc(mdoc, line, ppos, 


@@ -742,7 +748,7 @@ macro_scoped(MACRO_PROT_ARGS)
        }
 
        if (j == MDOC_LINEARG_MAX)
        }
 
        if (j == MDOC_LINEARG_MAX)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))
                return(0);
 
        if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))
                return(0);


@@ -804,7 +810,7 @@ macro_scoped_line(MACRO_PROT_ARGS)
        }
 
        if (j == MDOC_LINEARG_MAX)
        }
 
        if (j == MDOC_LINEARG_MAX)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        if (1 == ppos) {
                if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))
 
        if (1 == ppos) {
                if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))


@@ -813,7 +819,7 @@ macro_scoped_line(MACRO_PROT_ARGS)
                        return(0);
        } else if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))
                return(0);
                        return(0);
        } else if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))
                return(0);

-       return(rewind_impblock(mdoc, tok));
+       return(rewind_impblock(mdoc, tok, line, ppos));

 }
 
 
 }
 
 


@@ -907,7 +913,7 @@ macro_constant_scoped(MACRO_PROT_ARGS)
        }
 
        if (MDOC_LINEARG_MAX == j)
        }
 
        if (MDOC_LINEARG_MAX == j)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        if ( ! flushed) {
                if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))
 
        if ( ! flushed) {
                if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))


@@ -944,6 +950,8 @@ macro_constant_delimited(MACRO_PROT_ARGS)
                /* FALLTHROUGH */
        case (MDOC_Ns):
                /* FALLTHROUGH */
                /* FALLTHROUGH */
        case (MDOC_Ns):
                /* FALLTHROUGH */

+       case (MDOC_Pf):
+               /* FALLTHROUGH */

        case (MDOC_Ux):
                /* FALLTHROUGH */
        case (MDOC_St):
        case (MDOC_Ux):
                /* FALLTHROUGH */
        case (MDOC_St):


@@ -957,15 +965,18 @@ macro_constant_delimited(MACRO_PROT_ARGS)
        for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                lastarg = *pos;
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
        for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                lastarg = *pos;
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);

-               if (ARGV_EOLN == c || ARGV_WORD == c)
+               if (ARGV_EOLN == c)

                        break;
                        break;

-               else if (ARGV_ARG == c)
+               if (ARGV_WORD == c) {
+                       *pos = lastarg;
+                       break;
+               } else if (ARGV_ARG == c)

                        continue;
                mdoc_argv_free(argc, argv);
                return(0);
        }
 
                        continue;
                mdoc_argv_free(argc, argv);
                return(0);
        }
 

-       c = mdoc_elem_alloc(mdoc, line, lastarg, tok, argc, argv);
+       c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);

        mdoc_argv_free(argc, argv);
 
        if (0 == c)
        mdoc_argv_free(argc, argv);
 
        if (0 == c)


@@ -1013,7 +1024,7 @@ macro_constant_delimited(MACRO_PROT_ARGS)
        }
 
        if (MDOC_LINEARG_MAX == j)
        }
 
        if (MDOC_LINEARG_MAX == j)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        if ( ! flushed && rewind_elem(mdoc, tok))
                return(0);
 
        if ( ! flushed && rewind_elem(mdoc, tok))
                return(0);


@@ -1035,8 +1046,6 @@ macro_constant(MACRO_PROT_ARGS)
        struct mdoc_arg  argv[MDOC_LINEARG_MAX];
        char            *p;
 
        struct mdoc_arg  argv[MDOC_LINEARG_MAX];
        char            *p;
 

-       /* FIXME: parsing macros! */
-

        fl = 0;
        if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                fl = ARGS_QUOTED;
        fl = 0;
        if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                fl = ARGS_QUOTED;


@@ -1046,10 +1055,11 @@ macro_constant(MACRO_PROT_ARGS)
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                if (ARGV_EOLN == c) 
                        break;
                c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                if (ARGV_EOLN == c) 
                        break;

-               else if (ARGV_ARG == c)
-                       continue;
-               else if (ARGV_WORD == c)
+               if (ARGV_WORD == c) {
+                       *pos = lastarg;

                        break;
                        break;

+               } else if (ARGV_ARG == c)
+                       continue;

 
                mdoc_argv_free(argc, argv);
                return(0);
 
                mdoc_argv_free(argc, argv);
                return(0);


@@ -1064,7 +1074,7 @@ macro_constant(MACRO_PROT_ARGS)
        mdoc->next = MDOC_NEXT_CHILD;
 
        if (MDOC_LINEARG_MAX == argc)
        mdoc->next = MDOC_NEXT_CHILD;
 
        if (MDOC_LINEARG_MAX == argc)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        for (sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) {
                lastarg = *pos;
 
        for (sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) {
                lastarg = *pos;


@@ -1074,13 +1084,22 @@ macro_constant(MACRO_PROT_ARGS)
                if (ARGS_EOLN == c)
                        break;
 
                if (ARGS_EOLN == c)
                        break;
 

+               if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
+                       return(0);
+               else if (MDOC_MAX != c) {
+                       if ( ! rewind_elem(mdoc, tok))
+                               return(0);
+                       return(mdoc_macro(mdoc, c, line, 
+                                               lastarg, pos, buf));
+               }
+

                if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                        return(0);
                mdoc->next = MDOC_NEXT_SIBLING;
        }
 
        if (MDOC_LINEARG_MAX == sz + argc)
                if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                        return(0);
                mdoc->next = MDOC_NEXT_SIBLING;
        }
 
        if (MDOC_LINEARG_MAX == sz + argc)

-               return(mdoc_perr(mdoc, line, ppos, ERR_ARGS_MANY));
+               return(mdoc_perr(mdoc, line, ppos, "too many arguments"));

 
        return(rewind_elem(mdoc, tok));
 }
 
        return(rewind_elem(mdoc, tok));
 }


@@ -1091,7 +1110,7 @@ int
 macro_obsolete(MACRO_PROT_ARGS)
 {
 
 macro_obsolete(MACRO_PROT_ARGS)
 {
 

-       return(mdoc_pwarn(mdoc, line, ppos, WARN_IGN_OBSOLETE));
+       return(mdoc_pwarn(mdoc, line, ppos, WARN_SYNTAX, "macro is obsolete"));

 }
 
 
 }