1 /* $Id: mdoc_macro.c,v 1.46 2010/03/30 08:24:01 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
26 #define REWIND_REWIND (1 << 0)
27 #define REWIND_NOHALT (1 << 1)
28 #define REWIND_HALT (1 << 2)
30 static int ctx_synopsis(MACRO_PROT_ARGS);
31 static int obsolete(MACRO_PROT_ARGS);
32 static int blk_part_exp(MACRO_PROT_ARGS);
33 static int in_line_eoln(MACRO_PROT_ARGS);
34 static int in_line_argn(MACRO_PROT_ARGS);
35 static int in_line(MACRO_PROT_ARGS);
36 static int blk_full(MACRO_PROT_ARGS);
37 static int blk_exp_close(MACRO_PROT_ARGS);
38 static int blk_part_imp(MACRO_PROT_ARGS);
40 static int phrase(struct mdoc *, int, int, char *);
41 static int rew_dohalt(int, enum mdoc_type,
42 const struct mdoc_node *);
43 static int rew_alt(int);
44 static int rew_dobreak(int, const struct mdoc_node *);
45 static int rew_elem(struct mdoc *, int);
46 static int rew_sub(enum mdoc_type, struct mdoc *,
48 static int rew_last(struct mdoc *,
49 const struct mdoc_node *);
50 static int append_delims(struct mdoc *, int, int *, char *);
51 static int lookup(int, const char *);
52 static int lookup_raw(const char *);
53 static int swarn(struct mdoc *, enum mdoc_type, int, int,
54 const struct mdoc_node *);
56 /* Central table of library: who gets parsed how. */
58 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
59 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */
60 { in_line_eoln, MDOC_PROLOGUE }, /* Dd */
61 { in_line_eoln, MDOC_PROLOGUE }, /* Dt */
62 { in_line_eoln, MDOC_PROLOGUE }, /* Os */
63 { blk_full, 0 }, /* Sh */
64 { blk_full, 0 }, /* Ss */
65 { in_line_eoln, 0 }, /* Pp */
66 { blk_part_imp, MDOC_PARSED }, /* D1 */
67 { blk_part_imp, MDOC_PARSED }, /* Dl */
68 { blk_full, MDOC_EXPLICIT }, /* Bd */
69 { blk_exp_close, MDOC_EXPLICIT }, /* Ed */
70 { blk_full, MDOC_EXPLICIT }, /* Bl */
71 { blk_exp_close, MDOC_EXPLICIT }, /* El */
72 { blk_full, MDOC_PARSED }, /* It */
73 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
74 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */
75 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
76 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cd */
77 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
78 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
79 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
80 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
81 { in_line_eoln, 0 }, /* Ex */
82 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
83 { in_line_eoln, 0 }, /* Fd */
84 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
85 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
86 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
87 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
88 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
89 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
90 { blk_full, 0 }, /* Nd */
91 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
92 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
93 { obsolete, 0 }, /* Ot */
94 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
95 { in_line_eoln, 0 }, /* Rv */
96 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
97 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
98 { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
99 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
100 { in_line_eoln, 0 }, /* %A */
101 { in_line_eoln, 0 }, /* %B */
102 { in_line_eoln, 0 }, /* %D */
103 { in_line_eoln, 0 }, /* %I */
104 { in_line_eoln, 0 }, /* %J */
105 { in_line_eoln, 0 }, /* %N */
106 { in_line_eoln, 0 }, /* %O */
107 { in_line_eoln, 0 }, /* %P */
108 { in_line_eoln, 0 }, /* %R */
109 { in_line_eoln, 0 }, /* %T */
110 { in_line_eoln, 0 }, /* %V */
111 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
112 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
113 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
114 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
115 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
116 { blk_full, MDOC_EXPLICIT }, /* Bf */
117 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */
118 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
119 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
120 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
121 { in_line_eoln, 0 }, /* Db */
122 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
123 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */
124 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
125 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
126 { blk_exp_close, MDOC_EXPLICIT }, /* Ef */
127 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
128 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
129 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
130 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
131 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */
132 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */
133 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
134 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
135 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
136 { in_line_argn, MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
137 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
138 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
139 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
140 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
141 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
142 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
143 { blk_exp_close, MDOC_EXPLICIT }, /* Re */
144 { blk_full, MDOC_EXPLICIT }, /* Rs */
145 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
146 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */
147 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
148 { in_line_eoln, 0 }, /* Sm */
149 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
150 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
151 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
152 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ux */
153 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
154 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
155 { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
156 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */
157 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */
158 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
159 { blk_full, MDOC_EXPLICIT }, /* Bk */
160 { blk_exp_close, MDOC_EXPLICIT }, /* Ek */
161 { in_line_eoln, 0 }, /* Bt */
162 { in_line_eoln, 0 }, /* Hf */
163 { obsolete, 0 }, /* Fr */
164 { in_line_eoln, 0 }, /* Ud */
165 { in_line_eoln, 0 }, /* Lb */
166 { in_line_eoln, 0 }, /* Lp */
167 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
168 { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
169 { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */
170 { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */
171 { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */
172 { in_line_eoln, 0 }, /* %C */
173 { obsolete, 0 }, /* Es */
174 { obsolete, 0 }, /* En */
175 { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
176 { in_line_eoln, 0 }, /* %Q */
177 { in_line_eoln, 0 }, /* br */
178 { in_line_eoln, 0 }, /* sp */
179 { in_line_eoln, 0 }, /* %U */
182 const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
186 swarn(struct mdoc *mdoc, enum mdoc_type type,
187 int line, int pos, const struct mdoc_node *p)
189 const char *n, *t, *tt;
207 n = mdoc_macronames[p->tok];
211 n = mdoc_macronames[p->tok];
215 n = mdoc_macronames[p->tok];
222 if ( ! (MDOC_IGN_SCOPE & mdoc->pflags))
223 return(mdoc_verr(mdoc, line, pos,
224 "%s scope breaks %s scope of %s",
226 return(mdoc_vwarn(mdoc, line, pos,
227 "%s scope breaks %s scope of %s",
233 * This is called at the end of parsing. It must traverse up the tree,
234 * closing out open [implicit] scopes. Obviously, open explicit scopes
238 mdoc_macroend(struct mdoc *m)
242 /* Scan for open explicit scopes. */
244 n = MDOC_VALID & m->last->flags ? m->last->parent : m->last;
246 for ( ; n; n = n->parent) {
247 if (MDOC_BLOCK != n->type)
249 if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))
251 return(mdoc_nerr(m, n, EOPEN));
254 /* Rewind to the first. */
256 return(rew_last(m, m->first));
261 * Look up a macro from within a subsequent context.
264 lookup(int from, const char *p)
266 /* FIXME: make -diag lists be un-PARSED. */
268 if ( ! (MDOC_PARSED & mdoc_macros[from].flags))
270 return(lookup_raw(p));
275 * Lookup a macro following the initial line macro.
278 lookup_raw(const char *p)
282 if (MDOC_MAX == (res = mdoc_hash_find(p)))
284 if (MDOC_CALLABLE & mdoc_macros[res].flags)
291 rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
295 mdoc->next = MDOC_NEXT_SIBLING;
298 while (mdoc->last != to) {
299 if ( ! mdoc_valid_post(mdoc))
301 if ( ! mdoc_action_post(mdoc))
303 mdoc->last = mdoc->last->parent;
307 if ( ! mdoc_valid_post(mdoc))
309 return(mdoc_action_post(mdoc));
314 * Return the opening macro of a closing one, e.g., `Ec' has `Eo' as its
362 * Rewind rules. This indicates whether to stop rewinding
363 * (REWIND_HALT) without touching our current scope, stop rewinding and
364 * close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT).
365 * The scope-closing and so on occurs in the various rew_* routines.
368 rew_dohalt(int tok, enum mdoc_type type, const struct mdoc_node *p)
371 if (MDOC_ROOT == p->type)
373 if (MDOC_VALID & p->flags)
374 return(REWIND_NOHALT);
400 assert(MDOC_TAIL != type);
401 if (type == p->type && tok == p->tok)
402 return(REWIND_REWIND);
405 assert(MDOC_TAIL != type);
406 if (type == p->type && tok == p->tok)
407 return(REWIND_REWIND);
408 if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
412 if (type == p->type && tok == p->tok)
413 return(REWIND_REWIND);
418 assert(MDOC_TAIL != type);
419 if (type == p->type && tok == p->tok)
420 return(REWIND_REWIND);
421 if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
455 if (type == p->type && tok == p->tok)
456 return(REWIND_REWIND);
458 /* Multi-line explicit scope close. */
490 if (type == p->type && rew_alt(tok) == p->tok)
491 return(REWIND_REWIND);
498 return(REWIND_NOHALT);
503 * See if we can break an encountered scope (the rew_dohalt has returned
507 rew_dobreak(int tok, const struct mdoc_node *p)
510 assert(MDOC_ROOT != p->type);
511 if (MDOC_ELEM == p->type)
513 if (MDOC_TEXT == p->type)
515 if (MDOC_VALID & p->flags)
520 return(MDOC_It == p->tok);
522 return(MDOC_Nd == p->tok);
524 return(MDOC_Ss == p->tok);
526 if (MDOC_Nd == p->tok)
528 if (MDOC_Ss == p->tok)
530 return(MDOC_Sh == p->tok);
532 if (MDOC_It == p->tok)
536 /* XXX - experimental! */
537 if (MDOC_Op == p->tok)
544 if (MDOC_EXPLICIT & mdoc_macros[tok].flags)
545 return(p->tok == rew_alt(tok));
546 else if (MDOC_BLOCK == p->type)
549 return(tok == p->tok);
554 rew_elem(struct mdoc *mdoc, int tok)
559 if (MDOC_ELEM != n->type)
561 assert(MDOC_ELEM == n->type);
562 assert(tok == n->tok);
564 return(rew_last(mdoc, n));
569 rew_sub(enum mdoc_type t, struct mdoc *m,
570 int tok, int line, int ppos)
576 for (n = m->last; n; n = n->parent) {
577 c = rew_dohalt(tok, t, n);
578 if (REWIND_HALT == c) {
581 if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags))
583 return(mdoc_perr(m, line, ppos, ENOCTX));
585 if (REWIND_REWIND == c)
587 else if (rew_dobreak(tok, n))
589 if ( ! swarn(m, t, line, ppos, n))
594 return(rew_last(m, n));
599 append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
609 c = mdoc_zargs(mdoc, line, pos, buf, ARGS_NOWARN, &p);
610 assert(ARGS_PHRASE != c);
614 else if (ARGS_EOLN == c)
616 assert(mdoc_isdelim(p));
617 if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
626 * Close out block partial/full explicit.
629 blk_exp_close(MACRO_PROT_ARGS)
631 int j, c, lastarg, maxargs, flushed;
643 if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
645 if ( ! mdoc_pwarn(m, line, ppos, ENOLINE))
648 if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
650 return(rew_sub(MDOC_BLOCK, m, tok, line, ppos));
653 if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
657 if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok)))
660 for (flushed = j = 0; ; j++) {
663 if (j == maxargs && ! flushed) {
664 if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
669 c = mdoc_args(m, line, pos, buf, tok, &p);
678 if (MDOC_MAX != (c = lookup(tok, p))) {
680 if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
684 if ( ! mdoc_macro(m, c, line, lastarg, pos, buf))
689 if ( ! mdoc_word_alloc(m, line, lastarg, p))
693 if ( ! flushed && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
698 return(append_delims(m, line, pos, buf));
703 in_line(MACRO_PROT_ARGS)
705 int la, lastpunct, c, w, cnt, d, nc;
706 struct mdoc_arg *arg;
710 * Whether we allow ignored elements (those without content,
711 * usually because of reserved words) to squeak by.
733 for (arg = NULL;; ) {
735 c = mdoc_argv(m, line, tok, &arg, pos, buf);
737 if (ARGV_WORD == c) {
750 for (cnt = 0, lastpunct = 1;; ) {
752 w = mdoc_args(m, line, pos, buf, tok, &p);
761 /* Quoted words shouldn't be looked-up. */
763 c = ARGS_QWORD == w ? MDOC_MAX : lookup(tok, p);
766 * In this case, we've located a submacro and must
767 * execute it. Close out scope, if open. If no
768 * elements have been generated, either create one (nc)
769 * or raise a warning.
773 if (0 == lastpunct && ! rew_elem(m, tok))
775 if (nc && 0 == cnt) {
776 if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
778 if ( ! rew_last(m, m->last))
780 } else if ( ! nc && 0 == cnt) {
782 if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
785 c = mdoc_macro(m, c, line, la, pos, buf);
790 return(append_delims(m, line, pos, buf));
794 * Non-quote-enclosed punctuation. Set up our scope, if
795 * a word; rewind the scope, if a delimiter; then append
801 if (ARGS_QWORD != w && d) {
802 if (0 == lastpunct && ! rew_elem(m, tok))
805 } else if (lastpunct) {
806 if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
813 if ( ! mdoc_word_alloc(m, line, la, p))
817 * `Fl' macros have their scope re-opened with each new
818 * word so that the `-' can be added to each one without
819 * having to parse out spaces.
821 if (0 == lastpunct && MDOC_Fl == tok) {
822 if ( ! rew_elem(m, tok))
828 if (0 == lastpunct && ! rew_elem(m, tok))
832 * If no elements have been collected and we're allowed to have
833 * empties (nc), open a scope and close it out. Otherwise,
837 if (nc && 0 == cnt) {
838 if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
840 if ( ! rew_last(m, m->last))
842 } else if ( ! nc && 0 == cnt) {
844 if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
850 return(append_delims(m, line, pos, buf));
855 blk_full(MACRO_PROT_ARGS)
858 struct mdoc_arg *arg;
859 struct mdoc_node *head; /* save of head macro */
862 /* Close out prior implicit scope. */
864 if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
865 if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
867 if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
872 * This routine accomodates implicitly- and explicitly-scoped
873 * macro openings. Implicit ones first close out prior scope
874 * (seen above). Delay opening the head until necessary to
875 * allow leading punctuation to print. Special consideration
876 * for `It -column', which has phrase-part syntax instead of
877 * regular child nodes.
880 for (arg = NULL;; ) {
882 c = mdoc_argv(m, line, tok, &arg, pos, buf);
884 if (ARGV_WORD == c) {
898 if ( ! mdoc_block_alloc(m, line, ppos, tok, arg))
904 * The `Nd' macro has all arguments in its body: it's a hybrid
905 * of block partial-explicit and full-implicit. Stupid.
908 if (MDOC_Nd == tok) {
909 if ( ! mdoc_head_alloc(m, line, ppos, tok))
912 if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
914 if ( ! mdoc_body_alloc(m, line, ppos, tok))
920 c = mdoc_args(m, line, pos, buf, tok, &p);
927 /* Don't emit leading punct. for phrases. */
929 if (NULL == head && ARGS_PHRASE != c &&
930 1 == mdoc_isdelim(p)) {
931 if ( ! mdoc_word_alloc(m, line, la, p))
936 /* Always re-open head for phrases. */
938 if (NULL == head || ARGS_PHRASE == c) {
939 if ( ! mdoc_head_alloc(m, line, ppos, tok))
944 if (ARGS_PHRASE == c) {
945 if ( ! phrase(m, line, la, buf))
947 if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
954 if ( ! mdoc_macro(m, c, line, la, pos, buf))
958 if ( ! mdoc_word_alloc(m, line, la, p))
964 if ( ! mdoc_head_alloc(m, line, ppos, tok))
969 if (1 == ppos && ! append_delims(m, line, pos, buf))
972 /* See notes on `Nd' hybrid, above. */
977 /* Close out scopes to remain in a consistent state. */
979 if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
981 if ( ! mdoc_body_alloc(m, line, ppos, tok))
989 blk_part_imp(MACRO_PROT_ARGS)
993 struct mdoc_node *blk; /* saved block context */
994 struct mdoc_node *body; /* saved body context */
998 * A macro that spans to the end of the line. This is generally
999 * (but not necessarily) called as the first macro. The block
1000 * has a head as the immediate child, which is always empty,
1001 * followed by zero or more opening punctuation nodes, then the
1002 * body (which may be empty, depending on the macro), then zero
1003 * or more closing punctuation nodes.
1006 if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL))
1011 if ( ! mdoc_head_alloc(m, line, ppos, tok))
1013 if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1017 * Open the body scope "on-demand", that is, after we've
1018 * processed all our the leading delimiters (open parenthesis,
1022 for (body = NULL; ; ) {
1024 c = mdoc_args(m, line, pos, buf, tok, &p);
1026 assert(ARGS_PHRASE != c);
1028 if (ARGS_ERROR == c)
1032 if (ARGS_PUNCT == c)
1035 if (NULL == body && 1 == mdoc_isdelim(p)) {
1036 if ( ! mdoc_word_alloc(m, line, la, p))
1042 if ( ! mdoc_body_alloc(m, line, ppos, tok))
1047 if (MDOC_MAX != (c = lookup(tok, p))) {
1048 if ( ! mdoc_macro(m, c, line, la, pos, buf))
1053 if ( ! mdoc_word_alloc(m, line, la, p))
1057 /* Clean-ups to leave in a consistent state. */
1060 if ( ! mdoc_body_alloc(m, line, ppos, tok))
1066 * If we can't rewind to our body, then our scope has already
1067 * been closed by another macro (like `Oc' closing `Op'). This
1068 * is ugly behaviour nodding its head to OpenBSD's overwhelming
1069 * crufty use of `Op' breakage. XXX: DEPRECATE.
1072 for (n = m->last; n; n = n->parent)
1076 if (NULL == n && ! mdoc_nwarn(m, body, EIMPBRK))
1079 if (n && ! rew_last(m, body))
1082 /* Standard appending of delimiters. */
1084 if (1 == ppos && ! append_delims(m, line, pos, buf))
1087 /* Rewind scope, if applicable. */
1089 if (n && ! rew_last(m, blk))
1097 blk_part_exp(MACRO_PROT_ARGS)
1100 struct mdoc_node *head; /* keep track of head */
1101 struct mdoc_node *body; /* keep track of body */
1105 * The opening of an explicit macro having zero or more leading
1106 * punctuation nodes; a head with optional single element (the
1107 * case of `Eo'); and a body that may be empty.
1110 if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL))
1113 for (head = body = NULL; ; ) {
1115 c = mdoc_args(m, line, pos, buf, tok, &p);
1117 if (ARGS_ERROR == c)
1119 if (ARGS_PUNCT == c)
1124 assert(ARGS_PHRASE != c);
1126 /* Flush out leading punctuation. */
1128 if (NULL == head && 1 == mdoc_isdelim(p)) {
1129 assert(NULL == body);
1130 if ( ! mdoc_word_alloc(m, line, la, p))
1136 assert(NULL == body);
1137 if ( ! mdoc_head_alloc(m, line, ppos, tok))
1143 * `Eo' gobbles any data into the head, but most other
1144 * macros just immediately close out and begin the body.
1149 /* No check whether it's a macro! */
1151 if ( ! mdoc_word_alloc(m, line, la, p))
1154 if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1156 if ( ! mdoc_body_alloc(m, line, ppos, tok))
1164 assert(NULL != head && NULL != body);
1166 if (MDOC_MAX != (c = lookup(tok, p))) {
1167 if ( ! mdoc_macro(m, c, line, la, pos, buf))
1172 if ( ! mdoc_word_alloc(m, line, la, p))
1176 /* Clean-up to leave in a consistent state. */
1179 if ( ! mdoc_head_alloc(m, line, ppos, tok))
1185 if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
1187 if ( ! mdoc_body_alloc(m, line, ppos, tok))
1192 /* Standard appending of delimiters. */
1197 return(append_delims(m, line, pos, buf));
1202 in_line_argn(MACRO_PROT_ARGS)
1204 int la, flushed, j, c, maxargs;
1205 struct mdoc_arg *arg;
1209 * A line macro that has a fixed number of arguments (maxargs).
1210 * Only open the scope once the first non-leading-punctuation is
1211 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1212 * keep it open until the maximum number of arguments are
1234 for (arg = NULL;; ) {
1236 c = mdoc_argv(m, line, tok, &arg, pos, buf);
1238 if (ARGV_WORD == c) {
1248 mdoc_argv_free(arg);
1252 for (flushed = j = 0; ; ) {
1254 c = mdoc_args(m, line, pos, buf, tok, &p);
1256 if (ARGS_ERROR == c)
1258 if (ARGS_PUNCT == c)
1263 if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1264 0 == j && 1 == mdoc_isdelim(p)) {
1265 if ( ! mdoc_word_alloc(m, line, la, p))
1269 if ( ! mdoc_elem_alloc(m, line, la, tok, arg))
1272 if (j == maxargs && ! flushed) {
1273 if ( ! rew_elem(m, tok))
1278 if (MDOC_MAX != (c = lookup(tok, p))) {
1279 if ( ! flushed && ! rew_elem(m, tok))
1282 if ( ! mdoc_macro(m, c, line, la, pos, buf))
1288 if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
1289 ! flushed && mdoc_isdelim(p)) {
1290 if ( ! rew_elem(m, tok))
1296 * XXX: this is a hack to work around groff's ugliness
1297 * as regards `Xr' and extraneous arguments. It should
1298 * ideally be deprecated behaviour, but because this is
1299 * code is no here, it's unlikely to be removed.
1303 if (MDOC_Xr == tok && j == maxargs) {
1304 if ( ! mdoc_elem_alloc(m, line, la, MDOC_Ns, NULL))
1306 if ( ! rew_elem(m, MDOC_Ns))
1311 if ( ! mdoc_word_alloc(m, line, la, p))
1316 if (0 == j && ! mdoc_elem_alloc(m, line, la, tok, arg))
1319 /* Close out in a consistent state. */
1321 if ( ! flushed && ! rew_elem(m, tok))
1326 return(append_delims(m, line, pos, buf));
1331 in_line_eoln(MACRO_PROT_ARGS)
1334 struct mdoc_arg *arg;
1337 assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
1339 /* Parse macro arguments. */
1341 for (arg = NULL; ; ) {
1343 c = mdoc_argv(m, line, tok, &arg, pos, buf);
1345 if (ARGV_WORD == c) {
1354 mdoc_argv_free(arg);
1358 /* Open element scope. */
1360 if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
1363 /* Parse argument terms. */
1367 w = mdoc_args(m, line, pos, buf, tok, &p);
1369 if (ARGS_ERROR == w)
1374 c = ARGS_QWORD == w ? MDOC_MAX : lookup(tok, p);
1376 if (MDOC_MAX != c) {
1377 if ( ! rew_elem(m, tok))
1379 return(mdoc_macro(m, c, line, la, pos, buf));
1382 if ( ! mdoc_word_alloc(m, line, la, p))
1386 /* Close out (no delimiters). */
1388 return(rew_elem(m, tok));
1394 ctx_synopsis(MACRO_PROT_ARGS)
1397 /* If we're not in the SYNOPSIS, go straight to in-line. */
1398 if (SEC_SYNOPSIS != m->lastsec)
1399 return(in_line(m, tok, line, ppos, pos, buf));
1401 /* If we're a nested call, same place. */
1403 return(in_line(m, tok, line, ppos, pos, buf));
1406 * XXX: this will open a block scope; however, if later we end
1407 * up formatting the block scope, then child nodes will inherit
1408 * the formatting. Be careful.
1411 return(blk_part_imp(m, tok, line, ppos, pos, buf));
1417 obsolete(MACRO_PROT_ARGS)
1420 return(mdoc_pwarn(m, line, ppos, EOBS));
1425 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1426 * They're unusual because they're basically free-form text until a
1427 * macro is encountered.
1430 phrase(struct mdoc *m, int line, int ppos, char *buf)
1435 for (pos = ppos; ; ) {
1438 /* Note: no calling context! */
1439 w = mdoc_zargs(m, line, &pos, buf, 0, &p);
1441 if (ARGS_ERROR == w)
1446 c = ARGS_QWORD == w ? MDOC_MAX : lookup_raw(p);
1448 if (MDOC_MAX != c) {
1449 if ( ! mdoc_macro(m, c, line, la, &pos, buf))
1451 return(append_delims(m, line, &pos, buf));
1454 if ( ! mdoc_word_alloc(m, line, la, p))