]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_macro.c
1 /* $Id: mdoc_macro.c,v 1.49 2010/03/31 08:04:57 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.
30 #define REWIND_REWIND (1 << 0)
31 #define REWIND_NOHALT (1 << 1)
32 #define REWIND_HALT (1 << 2)
34 static int ctx_synopsis(MACRO_PROT_ARGS
);
35 static int obsolete(MACRO_PROT_ARGS
);
36 static int blk_part_exp(MACRO_PROT_ARGS
);
37 static int in_line_eoln(MACRO_PROT_ARGS
);
38 static int in_line_argn(MACRO_PROT_ARGS
);
39 static int in_line(MACRO_PROT_ARGS
);
40 static int blk_full(MACRO_PROT_ARGS
);
41 static int blk_exp_close(MACRO_PROT_ARGS
);
42 static int blk_part_imp(MACRO_PROT_ARGS
);
44 static int phrase(struct mdoc
*, int, int, char *);
45 static int rew_dohalt(enum mdoct
, enum mdoc_type
,
46 const struct mdoc_node
*);
47 static enum mdoct
rew_alt(enum mdoct
);
48 static int rew_dobreak(enum mdoct
, const struct mdoc_node
*);
49 static int rew_elem(struct mdoc
*, enum mdoct
);
50 static int rew_sub(enum mdoc_type
, struct mdoc
*,
51 enum mdoct
, int, int);
52 static int rew_last(struct mdoc
*,
53 const struct mdoc_node
*);
54 static int append_delims(struct mdoc
*, int, int *, char *);
55 static int lookup(int, const char *);
56 static int lookup_raw(const char *);
57 static int swarn(struct mdoc
*, enum mdoc_type
, int, int,
58 const struct mdoc_node
*);
60 /* Central table of library: who gets parsed how. */
62 const struct mdoc_macro __mdoc_macros
[MDOC_MAX
] = {
63 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ap */
64 { in_line_eoln
, MDOC_PROLOGUE
}, /* Dd */
65 { in_line_eoln
, MDOC_PROLOGUE
}, /* Dt */
66 { in_line_eoln
, MDOC_PROLOGUE
}, /* Os */
67 { blk_full
, 0 }, /* Sh */
68 { blk_full
, 0 }, /* Ss */
69 { in_line_eoln
, 0 }, /* Pp */
70 { blk_part_imp
, MDOC_PARSED
}, /* D1 */
71 { blk_part_imp
, MDOC_PARSED
}, /* Dl */
72 { blk_full
, MDOC_EXPLICIT
}, /* Bd */
73 { blk_exp_close
, MDOC_EXPLICIT
}, /* Ed */
74 { blk_full
, MDOC_EXPLICIT
}, /* Bl */
75 { blk_exp_close
, MDOC_EXPLICIT
}, /* El */
76 { blk_full
, MDOC_PARSED
}, /* It */
77 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ad */
78 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* An */
79 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ar */
80 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Cd */
81 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Cm */
82 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Dv */
83 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Er */
84 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ev */
85 { in_line_eoln
, 0 }, /* Ex */
86 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Fa */
87 { in_line_eoln
, 0 }, /* Fd */
88 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Fl */
89 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Fn */
90 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ft */
91 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ic */
92 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* In */
93 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Li */
94 { blk_full
, 0 }, /* Nd */
95 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Nm */
96 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Op */
97 { obsolete
, 0 }, /* Ot */
98 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Pa */
99 { in_line_eoln
, 0 }, /* Rv */
100 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* St */
101 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Va */
102 { ctx_synopsis
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Vt */
103 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Xr */
104 { in_line_eoln
, 0 }, /* %A */
105 { in_line_eoln
, 0 }, /* %B */
106 { in_line_eoln
, 0 }, /* %D */
107 { in_line_eoln
, 0 }, /* %I */
108 { in_line_eoln
, 0 }, /* %J */
109 { in_line_eoln
, 0 }, /* %N */
110 { in_line_eoln
, 0 }, /* %O */
111 { in_line_eoln
, 0 }, /* %P */
112 { in_line_eoln
, 0 }, /* %R */
113 { in_line_eoln
, 0 }, /* %T */
114 { in_line_eoln
, 0 }, /* %V */
115 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Ac */
116 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Ao */
117 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Aq */
118 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* At */
119 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Bc */
120 { blk_full
, MDOC_EXPLICIT
}, /* Bf */
121 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Bo */
122 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Bq */
123 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Bsx */
124 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Bx */
125 { in_line_eoln
, 0 }, /* Db */
126 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Dc */
127 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Do */
128 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Dq */
129 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Ec */
130 { blk_exp_close
, MDOC_EXPLICIT
}, /* Ef */
131 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Em */
132 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Eo */
133 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Fx */
134 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ms */
135 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* No */
136 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ns */
137 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Nx */
138 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ox */
139 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Pc */
140 { in_line_argn
, MDOC_PARSED
| MDOC_IGNDELIM
}, /* Pf */
141 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Po */
142 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Pq */
143 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Qc */
144 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ql */
145 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Qo */
146 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Qq */
147 { blk_exp_close
, MDOC_EXPLICIT
}, /* Re */
148 { blk_full
, MDOC_EXPLICIT
}, /* Rs */
149 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Sc */
150 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* So */
151 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sq */
152 { in_line_eoln
, 0 }, /* Sm */
153 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sx */
154 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sy */
155 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Tn */
156 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ux */
157 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Xc */
158 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Xo */
159 { blk_full
, MDOC_EXPLICIT
| MDOC_CALLABLE
}, /* Fo */
160 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Fc */
161 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Oo */
162 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Oc */
163 { blk_full
, MDOC_EXPLICIT
}, /* Bk */
164 { blk_exp_close
, MDOC_EXPLICIT
}, /* Ek */
165 { in_line_eoln
, 0 }, /* Bt */
166 { in_line_eoln
, 0 }, /* Hf */
167 { obsolete
, 0 }, /* Fr */
168 { in_line_eoln
, 0 }, /* Ud */
169 { in_line_eoln
, 0 }, /* Lb */
170 { in_line_eoln
, 0 }, /* Lp */
171 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Lk */
172 { in_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Mt */
173 { blk_part_imp
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Brq */
174 { blk_part_exp
, MDOC_CALLABLE
| MDOC_PARSED
| MDOC_EXPLICIT
}, /* Bro */
175 { blk_exp_close
, MDOC_EXPLICIT
| MDOC_CALLABLE
| MDOC_PARSED
}, /* Brc */
176 { in_line_eoln
, 0 }, /* %C */
177 { obsolete
, 0 }, /* Es */
178 { obsolete
, 0 }, /* En */
179 { in_line_argn
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Dx */
180 { in_line_eoln
, 0 }, /* %Q */
181 { in_line_eoln
, 0 }, /* br */
182 { in_line_eoln
, 0 }, /* sp */
183 { in_line_eoln
, 0 }, /* %U */
186 const struct mdoc_macro
* const mdoc_macros
= __mdoc_macros
;
190 swarn(struct mdoc
*mdoc
, enum mdoc_type type
,
191 int line
, int pos
, const struct mdoc_node
*p
)
193 const char *n
, *t
, *tt
;
211 n
= mdoc_macronames
[p
->tok
];
215 n
= mdoc_macronames
[p
->tok
];
219 n
= mdoc_macronames
[p
->tok
];
226 if ( ! (MDOC_IGN_SCOPE
& mdoc
->pflags
))
227 return(mdoc_verr(mdoc
, line
, pos
,
228 "%s scope breaks %s scope of %s",
230 return(mdoc_vwarn(mdoc
, line
, pos
,
231 "%s scope breaks %s scope of %s",
237 * This is called at the end of parsing. It must traverse up the tree,
238 * closing out open [implicit] scopes. Obviously, open explicit scopes
242 mdoc_macroend(struct mdoc
*m
)
246 /* Scan for open explicit scopes. */
248 n
= MDOC_VALID
& m
->last
->flags
? m
->last
->parent
: m
->last
;
250 for ( ; n
; n
= n
->parent
) {
251 if (MDOC_BLOCK
!= n
->type
)
253 if ( ! (MDOC_EXPLICIT
& mdoc_macros
[n
->tok
].flags
))
255 return(mdoc_nerr(m
, n
, EOPEN
));
258 /* Rewind to the first. */
260 return(rew_last(m
, m
->first
));
265 * Look up a macro from within a subsequent context.
268 lookup(int from
, const char *p
)
270 /* FIXME: make -diag lists be un-PARSED. */
272 if ( ! (MDOC_PARSED
& mdoc_macros
[from
].flags
))
274 return(lookup_raw(p
));
279 * Lookup a macro following the initial line macro.
282 lookup_raw(const char *p
)
286 if (MDOC_MAX
== (res
= mdoc_hash_find(p
)))
288 if (MDOC_CALLABLE
& mdoc_macros
[res
].flags
)
295 rew_last(struct mdoc
*mdoc
, const struct mdoc_node
*to
)
299 mdoc
->next
= MDOC_NEXT_SIBLING
;
302 while (mdoc
->last
!= to
) {
303 if ( ! mdoc_valid_post(mdoc
))
305 if ( ! mdoc_action_post(mdoc
))
307 mdoc
->last
= mdoc
->last
->parent
;
311 if ( ! mdoc_valid_post(mdoc
))
313 return(mdoc_action_post(mdoc
));
318 * Return the opening macro of a closing one, e.g., `Ec' has `Eo' as its
322 rew_alt(enum mdoct tok
)
366 * Rewind rules. This indicates whether to stop rewinding
367 * (REWIND_HALT) without touching our current scope, stop rewinding and
368 * close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT).
369 * The scope-closing and so on occurs in the various rew_* routines.
372 rew_dohalt(enum mdoct tok
, enum mdoc_type type
,
373 const struct mdoc_node
*p
)
376 if (MDOC_ROOT
== p
->type
)
378 if (MDOC_VALID
& p
->flags
)
379 return(REWIND_NOHALT
);
405 assert(MDOC_TAIL
!= type
);
406 if (type
== p
->type
&& tok
== p
->tok
)
407 return(REWIND_REWIND
);
410 assert(MDOC_TAIL
!= type
);
411 if (type
== p
->type
&& tok
== p
->tok
)
412 return(REWIND_REWIND
);
413 if (MDOC_BODY
== p
->type
&& MDOC_Bl
== p
->tok
)
417 if (type
== p
->type
&& tok
== p
->tok
)
418 return(REWIND_REWIND
);
423 assert(MDOC_TAIL
!= type
);
424 if (type
== p
->type
&& tok
== p
->tok
)
425 return(REWIND_REWIND
);
426 if (MDOC_BODY
== p
->type
&& MDOC_Sh
== p
->tok
)
460 if (type
== p
->type
&& tok
== p
->tok
)
461 return(REWIND_REWIND
);
463 /* Multi-line explicit scope close. */
495 if (type
== p
->type
&& rew_alt(tok
) == p
->tok
)
496 return(REWIND_REWIND
);
503 return(REWIND_NOHALT
);
508 * See if we can break an encountered scope (the rew_dohalt has returned
512 rew_dobreak(enum mdoct tok
, const struct mdoc_node
*p
)
515 assert(MDOC_ROOT
!= p
->type
);
516 if (MDOC_ELEM
== p
->type
)
518 if (MDOC_TEXT
== p
->type
)
520 if (MDOC_VALID
& p
->flags
)
525 return(MDOC_It
== p
->tok
);
527 return(MDOC_Nd
== p
->tok
);
529 return(MDOC_Ss
== p
->tok
);
531 if (MDOC_Nd
== p
->tok
)
533 if (MDOC_Ss
== p
->tok
)
535 return(MDOC_Sh
== p
->tok
);
537 if (MDOC_It
== p
->tok
)
541 if (MDOC_Op
== p
->tok
)
548 if (MDOC_EXPLICIT
& mdoc_macros
[tok
].flags
)
549 return(p
->tok
== rew_alt(tok
));
550 else if (MDOC_BLOCK
== p
->type
)
553 return(tok
== p
->tok
);
558 rew_elem(struct mdoc
*mdoc
, enum mdoct tok
)
563 if (MDOC_ELEM
!= n
->type
)
565 assert(MDOC_ELEM
== n
->type
);
566 assert(tok
== n
->tok
);
568 return(rew_last(mdoc
, n
));
573 rew_sub(enum mdoc_type t
, struct mdoc
*m
,
574 enum mdoct tok
, int line
, int ppos
)
580 for (n
= m
->last
; n
; n
= n
->parent
) {
581 c
= rew_dohalt(tok
, t
, n
);
582 if (REWIND_HALT
== c
) {
585 if ( ! (MDOC_EXPLICIT
& mdoc_macros
[tok
].flags
))
587 return(mdoc_perr(m
, line
, ppos
, ENOCTX
));
589 if (REWIND_REWIND
== c
)
591 else if (rew_dobreak(tok
, n
))
593 if ( ! swarn(m
, t
, line
, ppos
, n
))
598 if ( ! rew_last(m
, n
))
603 * The current block extends an enclosing block beyond a line
604 * break. Now that the current block ends, close the enclosing
607 if (NULL
!= (n
= n
->pending
)) {
608 assert(MDOC_HEAD
== n
->type
);
609 if ( ! rew_last(m
, n
))
611 if ( ! mdoc_body_alloc(m
, n
->line
, n
->pos
, n
->tok
))
621 append_delims(struct mdoc
*mdoc
, int line
, int *pos
, char *buf
)
631 c
= mdoc_zargs(mdoc
, line
, pos
, buf
, ARGS_NOWARN
, &p
);
632 assert(ARGS_PHRASE
!= c
);
636 else if (ARGS_EOLN
== c
)
638 assert(mdoc_isdelim(p
));
639 if ( ! mdoc_word_alloc(mdoc
, line
, lastarg
, p
))
648 * Close out block partial/full explicit.
651 blk_exp_close(MACRO_PROT_ARGS
)
653 int j
, c
, lastarg
, maxargs
, flushed
;
665 if ( ! (MDOC_CALLABLE
& mdoc_macros
[tok
].flags
)) {
667 if ( ! mdoc_pwarn(m
, line
, ppos
, ENOLINE
))
670 if ( ! rew_sub(MDOC_BODY
, m
, tok
, line
, ppos
))
672 return(rew_sub(MDOC_BLOCK
, m
, tok
, line
, ppos
));
675 if ( ! rew_sub(MDOC_BODY
, m
, tok
, line
, ppos
))
679 if ( ! mdoc_tail_alloc(m
, line
, ppos
, rew_alt(tok
)))
682 for (flushed
= j
= 0; ; j
++) {
685 if (j
== maxargs
&& ! flushed
) {
686 if ( ! rew_sub(MDOC_BLOCK
, m
, tok
, line
, ppos
))
691 c
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
700 if (MDOC_MAX
!= (c
= lookup(tok
, p
))) {
702 if ( ! rew_sub(MDOC_BLOCK
, m
, tok
, line
, ppos
))
706 if ( ! mdoc_macro(m
, c
, line
, lastarg
, pos
, buf
))
711 if ( ! mdoc_word_alloc(m
, line
, lastarg
, p
))
715 if ( ! flushed
&& ! rew_sub(MDOC_BLOCK
, m
, tok
, line
, ppos
))
720 return(append_delims(m
, line
, pos
, buf
));
725 in_line(MACRO_PROT_ARGS
)
727 int la
, lastpunct
, c
, w
, cnt
, d
, nc
;
728 struct mdoc_arg
*arg
;
732 * Whether we allow ignored elements (those without content,
733 * usually because of reserved words) to squeak by.
755 for (arg
= NULL
;; ) {
757 c
= mdoc_argv(m
, line
, tok
, &arg
, pos
, buf
);
759 if (ARGV_WORD
== c
) {
772 for (cnt
= 0, lastpunct
= 1;; ) {
774 w
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
783 /* Quoted words shouldn't be looked-up. */
785 c
= ARGS_QWORD
== w
? MDOC_MAX
: lookup(tok
, p
);
788 * In this case, we've located a submacro and must
789 * execute it. Close out scope, if open. If no
790 * elements have been generated, either create one (nc)
791 * or raise a warning.
795 if (0 == lastpunct
&& ! rew_elem(m
, tok
))
797 if (nc
&& 0 == cnt
) {
798 if ( ! mdoc_elem_alloc(m
, line
, ppos
, tok
, arg
))
800 if ( ! rew_last(m
, m
->last
))
802 } else if ( ! nc
&& 0 == cnt
) {
804 if ( ! mdoc_pwarn(m
, line
, ppos
, EIGNE
))
807 c
= mdoc_macro(m
, c
, line
, la
, pos
, buf
);
812 return(append_delims(m
, line
, pos
, buf
));
816 * Non-quote-enclosed punctuation. Set up our scope, if
817 * a word; rewind the scope, if a delimiter; then append
823 if (ARGS_QWORD
!= w
&& d
) {
824 if (0 == lastpunct
&& ! rew_elem(m
, tok
))
827 } else if (lastpunct
) {
828 if ( ! mdoc_elem_alloc(m
, line
, ppos
, tok
, arg
))
835 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
839 * `Fl' macros have their scope re-opened with each new
840 * word so that the `-' can be added to each one without
841 * having to parse out spaces.
843 if (0 == lastpunct
&& MDOC_Fl
== tok
) {
844 if ( ! rew_elem(m
, tok
))
850 if (0 == lastpunct
&& ! rew_elem(m
, tok
))
854 * If no elements have been collected and we're allowed to have
855 * empties (nc), open a scope and close it out. Otherwise,
859 if (nc
&& 0 == cnt
) {
860 if ( ! mdoc_elem_alloc(m
, line
, ppos
, tok
, arg
))
862 if ( ! rew_last(m
, m
->last
))
864 } else if ( ! nc
&& 0 == cnt
) {
866 if ( ! mdoc_pwarn(m
, line
, ppos
, EIGNE
))
872 return(append_delims(m
, line
, pos
, buf
));
877 blk_full(MACRO_PROT_ARGS
)
880 struct mdoc_arg
*arg
;
881 struct mdoc_node
*head
; /* save of head macro */
882 struct mdoc_node
*body
; /* save of body macro */
888 /* Close out prior implicit scope. */
890 if ( ! (MDOC_EXPLICIT
& mdoc_macros
[tok
].flags
)) {
891 if ( ! rew_sub(MDOC_BODY
, m
, tok
, line
, ppos
))
893 if ( ! rew_sub(MDOC_BLOCK
, m
, tok
, line
, ppos
))
898 * This routine accomodates implicitly- and explicitly-scoped
899 * macro openings. Implicit ones first close out prior scope
900 * (seen above). Delay opening the head until necessary to
901 * allow leading punctuation to print. Special consideration
902 * for `It -column', which has phrase-part syntax instead of
903 * regular child nodes.
906 for (arg
= NULL
;; ) {
908 c
= mdoc_argv(m
, line
, tok
, &arg
, pos
, buf
);
910 if (ARGV_WORD
== c
) {
924 if ( ! mdoc_block_alloc(m
, line
, ppos
, tok
, arg
))
930 * The `Nd' macro has all arguments in its body: it's a hybrid
931 * of block partial-explicit and full-implicit. Stupid.
934 if (MDOC_Nd
== tok
) {
935 if ( ! mdoc_head_alloc(m
, line
, ppos
, tok
))
938 if ( ! rew_sub(MDOC_HEAD
, m
, tok
, line
, ppos
))
940 if ( ! mdoc_body_alloc(m
, line
, ppos
, tok
))
947 c
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
954 /* Don't emit leading punct. for phrases. */
956 if (NULL
== head
&& ARGS_PHRASE
!= c
&&
957 1 == mdoc_isdelim(p
)) {
958 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
963 /* Always re-open head for phrases. */
965 if (NULL
== head
|| ARGS_PHRASE
== c
) {
966 if ( ! mdoc_head_alloc(m
, line
, ppos
, tok
))
971 if (ARGS_PHRASE
== c
) {
972 if ( ! phrase(m
, line
, la
, buf
))
974 if ( ! rew_sub(MDOC_HEAD
, m
, tok
, line
, ppos
))
981 if ( ! mdoc_macro(m
, c
, line
, la
, pos
, buf
))
985 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
991 if ( ! mdoc_head_alloc(m
, line
, ppos
, tok
))
996 if (1 == ppos
&& ! append_delims(m
, line
, pos
, buf
))
999 /* If we've already opened our body, exit now. */
1006 * If there is an open (i.e., unvalidated) sub-block requiring
1007 * explicit close-out, postpone switching the current block from
1008 * head to body until the rew_sub() call closing out that
1011 for (n
= m
->last
; n
&& n
!= head
; n
= n
->parent
) {
1012 if (MDOC_BLOCK
== n
->type
&&
1013 MDOC_EXPLICIT
& mdoc_macros
[n
->tok
].flags
&&
1014 ! (MDOC_VALID
& n
->flags
)) {
1015 assert( ! (MDOC_ACTED
& n
->flags
));
1022 /* Close out scopes to remain in a consistent state. */
1024 if ( ! rew_sub(MDOC_HEAD
, m
, tok
, line
, ppos
))
1026 if ( ! mdoc_body_alloc(m
, line
, ppos
, tok
))
1034 blk_part_imp(MACRO_PROT_ARGS
)
1038 struct mdoc_node
*blk
; /* saved block context */
1039 struct mdoc_node
*body
; /* saved body context */
1040 struct mdoc_node
*n
;
1043 * A macro that spans to the end of the line. This is generally
1044 * (but not necessarily) called as the first macro. The block
1045 * has a head as the immediate child, which is always empty,
1046 * followed by zero or more opening punctuation nodes, then the
1047 * body (which may be empty, depending on the macro), then zero
1048 * or more closing punctuation nodes.
1051 if ( ! mdoc_block_alloc(m
, line
, ppos
, tok
, NULL
))
1056 if ( ! mdoc_head_alloc(m
, line
, ppos
, tok
))
1058 if ( ! rew_sub(MDOC_HEAD
, m
, tok
, line
, ppos
))
1062 * Open the body scope "on-demand", that is, after we've
1063 * processed all our the leading delimiters (open parenthesis,
1067 for (body
= NULL
; ; ) {
1069 c
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
1071 assert(ARGS_PHRASE
!= c
);
1073 if (ARGS_ERROR
== c
)
1077 if (ARGS_PUNCT
== c
)
1080 if (NULL
== body
&& 1 == mdoc_isdelim(p
)) {
1081 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1087 if ( ! mdoc_body_alloc(m
, line
, ppos
, tok
))
1092 if (MDOC_MAX
!= (c
= lookup(tok
, p
))) {
1093 if ( ! mdoc_macro(m
, c
, line
, la
, pos
, buf
))
1098 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1102 /* Clean-ups to leave in a consistent state. */
1105 if ( ! mdoc_body_alloc(m
, line
, ppos
, tok
))
1111 * If we can't rewind to our body, then our scope has already
1112 * been closed by another macro (like `Oc' closing `Op'). This
1113 * is ugly behaviour nodding its head to OpenBSD's overwhelming
1114 * crufty use of `Op' breakage.
1116 for (n
= m
->last
; n
; n
= n
->parent
)
1120 if (NULL
== n
&& ! mdoc_nwarn(m
, body
, EIMPBRK
))
1123 if (n
&& ! rew_last(m
, body
))
1126 /* Standard appending of delimiters. */
1128 if (1 == ppos
&& ! append_delims(m
, line
, pos
, buf
))
1131 /* Rewind scope, if applicable. */
1133 if (n
&& ! rew_last(m
, blk
))
1141 blk_part_exp(MACRO_PROT_ARGS
)
1144 struct mdoc_node
*head
; /* keep track of head */
1145 struct mdoc_node
*body
; /* keep track of body */
1149 * The opening of an explicit macro having zero or more leading
1150 * punctuation nodes; a head with optional single element (the
1151 * case of `Eo'); and a body that may be empty.
1154 if ( ! mdoc_block_alloc(m
, line
, ppos
, tok
, NULL
))
1157 for (head
= body
= NULL
; ; ) {
1159 c
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
1161 if (ARGS_ERROR
== c
)
1163 if (ARGS_PUNCT
== c
)
1168 assert(ARGS_PHRASE
!= c
);
1170 /* Flush out leading punctuation. */
1172 if (NULL
== head
&& 1 == mdoc_isdelim(p
)) {
1173 assert(NULL
== body
);
1174 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1180 assert(NULL
== body
);
1181 if ( ! mdoc_head_alloc(m
, line
, ppos
, tok
))
1187 * `Eo' gobbles any data into the head, but most other
1188 * macros just immediately close out and begin the body.
1193 /* No check whether it's a macro! */
1195 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1198 if ( ! rew_sub(MDOC_HEAD
, m
, tok
, line
, ppos
))
1200 if ( ! mdoc_body_alloc(m
, line
, ppos
, tok
))
1208 assert(NULL
!= head
&& NULL
!= body
);
1210 if (MDOC_MAX
!= (c
= lookup(tok
, p
))) {
1211 if ( ! mdoc_macro(m
, c
, line
, la
, pos
, buf
))
1216 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1220 /* Clean-up to leave in a consistent state. */
1223 if ( ! mdoc_head_alloc(m
, line
, ppos
, tok
))
1229 if ( ! rew_sub(MDOC_HEAD
, m
, tok
, line
, ppos
))
1231 if ( ! mdoc_body_alloc(m
, line
, ppos
, tok
))
1236 /* Standard appending of delimiters. */
1241 return(append_delims(m
, line
, pos
, buf
));
1246 in_line_argn(MACRO_PROT_ARGS
)
1248 int la
, flushed
, j
, c
, maxargs
;
1249 struct mdoc_arg
*arg
;
1253 * A line macro that has a fixed number of arguments (maxargs).
1254 * Only open the scope once the first non-leading-punctuation is
1255 * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
1256 * keep it open until the maximum number of arguments are
1278 for (arg
= NULL
; ; ) {
1280 c
= mdoc_argv(m
, line
, tok
, &arg
, pos
, buf
);
1282 if (ARGV_WORD
== c
) {
1292 mdoc_argv_free(arg
);
1296 for (flushed
= j
= 0; ; ) {
1298 c
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
1300 if (ARGS_ERROR
== c
)
1302 if (ARGS_PUNCT
== c
)
1307 if ( ! (MDOC_IGNDELIM
& mdoc_macros
[tok
].flags
) &&
1308 0 == j
&& 1 == mdoc_isdelim(p
)) {
1309 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1313 if ( ! mdoc_elem_alloc(m
, line
, la
, tok
, arg
))
1316 if (j
== maxargs
&& ! flushed
) {
1317 if ( ! rew_elem(m
, tok
))
1322 if (MDOC_MAX
!= (c
= lookup(tok
, p
))) {
1323 if ( ! flushed
&& ! rew_elem(m
, tok
))
1326 if ( ! mdoc_macro(m
, c
, line
, la
, pos
, buf
))
1332 if ( ! (MDOC_IGNDELIM
& mdoc_macros
[tok
].flags
) &&
1333 ! flushed
&& mdoc_isdelim(p
)) {
1334 if ( ! rew_elem(m
, tok
))
1340 * XXX: this is a hack to work around groff's ugliness
1341 * as regards `Xr' and extraneous arguments. It should
1342 * ideally be deprecated behaviour, but because this is
1343 * code is no here, it's unlikely to be removed.
1347 if (MDOC_Xr
== tok
&& j
== maxargs
) {
1348 if ( ! mdoc_elem_alloc(m
, line
, la
, MDOC_Ns
, NULL
))
1350 if ( ! rew_elem(m
, MDOC_Ns
))
1355 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1360 if (0 == j
&& ! mdoc_elem_alloc(m
, line
, la
, tok
, arg
))
1363 /* Close out in a consistent state. */
1365 if ( ! flushed
&& ! rew_elem(m
, tok
))
1370 return(append_delims(m
, line
, pos
, buf
));
1375 in_line_eoln(MACRO_PROT_ARGS
)
1378 struct mdoc_arg
*arg
;
1381 assert( ! (MDOC_PARSED
& mdoc_macros
[tok
].flags
));
1383 /* Parse macro arguments. */
1385 for (arg
= NULL
; ; ) {
1387 c
= mdoc_argv(m
, line
, tok
, &arg
, pos
, buf
);
1389 if (ARGV_WORD
== c
) {
1398 mdoc_argv_free(arg
);
1402 /* Open element scope. */
1404 if ( ! mdoc_elem_alloc(m
, line
, ppos
, tok
, arg
))
1407 /* Parse argument terms. */
1411 w
= mdoc_args(m
, line
, pos
, buf
, tok
, &p
);
1413 if (ARGS_ERROR
== w
)
1418 c
= ARGS_QWORD
== w
? MDOC_MAX
: lookup(tok
, p
);
1420 if (MDOC_MAX
!= c
) {
1421 if ( ! rew_elem(m
, tok
))
1423 return(mdoc_macro(m
, c
, line
, la
, pos
, buf
));
1426 if ( ! mdoc_word_alloc(m
, line
, la
, p
))
1430 /* Close out (no delimiters). */
1432 return(rew_elem(m
, tok
));
1438 ctx_synopsis(MACRO_PROT_ARGS
)
1441 /* If we're not in the SYNOPSIS, go straight to in-line. */
1442 if (SEC_SYNOPSIS
!= m
->lastsec
)
1443 return(in_line(m
, tok
, line
, ppos
, pos
, buf
));
1445 /* If we're a nested call, same place. */
1447 return(in_line(m
, tok
, line
, ppos
, pos
, buf
));
1450 * XXX: this will open a block scope; however, if later we end
1451 * up formatting the block scope, then child nodes will inherit
1452 * the formatting. Be careful.
1455 return(blk_part_imp(m
, tok
, line
, ppos
, pos
, buf
));
1461 obsolete(MACRO_PROT_ARGS
)
1464 return(mdoc_pwarn(m
, line
, ppos
, EOBS
));
1469 * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
1470 * They're unusual because they're basically free-form text until a
1471 * macro is encountered.
1474 phrase(struct mdoc
*m
, int line
, int ppos
, char *buf
)
1479 for (pos
= ppos
; ; ) {
1482 /* Note: no calling context! */
1483 w
= mdoc_zargs(m
, line
, &pos
, buf
, 0, &p
);
1485 if (ARGS_ERROR
== w
)
1490 c
= ARGS_QWORD
== w
? MDOC_MAX
: lookup_raw(p
);
1492 if (MDOC_MAX
!= c
) {
1493 if ( ! mdoc_macro(m
, c
, line
, la
, &pos
, buf
))
1495 return(append_delims(m
, line
, &pos
, buf
));
1498 if ( ! mdoc_word_alloc(m
, line
, la
, p
))