]>
git.cameronkatri.com Git - mandoc.git/blob - man_macro.c
1 /* $Id: man_macro.c,v 1.63 2011/06/18 17:36:52 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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.
28 #include "libmandoc.h"
37 static int blk_close(MACRO_PROT_ARGS
);
38 static int blk_exp(MACRO_PROT_ARGS
);
39 static int blk_imp(MACRO_PROT_ARGS
);
40 static int in_line_eoln(MACRO_PROT_ARGS
);
41 static int man_args(struct man
*, int,
42 int *, char *, char **);
44 static int rew_scope(enum man_type
,
45 struct man
*, enum mant
);
46 static enum rew
rew_dohalt(enum mant
, enum man_type
,
47 const struct man_node
*);
48 static enum rew
rew_block(enum mant
, enum man_type
,
49 const struct man_node
*);
50 static void rew_warn(struct man
*,
51 struct man_node
*, enum mandocerr
);
53 const struct man_macro __man_macros
[MAN_MAX
] = {
54 { in_line_eoln
, MAN_NSCOPED
}, /* br */
55 { in_line_eoln
, 0 }, /* TH */
56 { blk_imp
, MAN_SCOPED
}, /* SH */
57 { blk_imp
, MAN_SCOPED
}, /* SS */
58 { blk_imp
, MAN_SCOPED
| MAN_FSCOPED
}, /* TP */
59 { blk_imp
, 0 }, /* LP */
60 { blk_imp
, 0 }, /* PP */
61 { blk_imp
, 0 }, /* P */
62 { blk_imp
, 0 }, /* IP */
63 { blk_imp
, 0 }, /* HP */
64 { in_line_eoln
, MAN_SCOPED
}, /* SM */
65 { in_line_eoln
, MAN_SCOPED
}, /* SB */
66 { in_line_eoln
, 0 }, /* BI */
67 { in_line_eoln
, 0 }, /* IB */
68 { in_line_eoln
, 0 }, /* BR */
69 { in_line_eoln
, 0 }, /* RB */
70 { in_line_eoln
, MAN_SCOPED
}, /* R */
71 { in_line_eoln
, MAN_SCOPED
}, /* B */
72 { in_line_eoln
, MAN_SCOPED
}, /* I */
73 { in_line_eoln
, 0 }, /* IR */
74 { in_line_eoln
, 0 }, /* RI */
75 { in_line_eoln
, MAN_NSCOPED
}, /* na */
76 { in_line_eoln
, MAN_NSCOPED
}, /* sp */
77 { in_line_eoln
, 0 }, /* nf */
78 { in_line_eoln
, 0 }, /* fi */
79 { blk_close
, 0 }, /* RE */
80 { blk_exp
, MAN_EXPLICIT
}, /* RS */
81 { in_line_eoln
, 0 }, /* DT */
82 { in_line_eoln
, 0 }, /* UC */
83 { in_line_eoln
, 0 }, /* PD */
84 { in_line_eoln
, 0 }, /* AT */
85 { in_line_eoln
, 0 }, /* in */
86 { in_line_eoln
, 0 }, /* ft */
89 const struct man_macro
* const man_macros
= __man_macros
;
93 * Warn when "n" is an explicit non-roff macro.
96 rew_warn(struct man
*m
, struct man_node
*n
, enum mandocerr er
)
99 if (er
== MANDOCERR_MAX
|| MAN_BLOCK
!= n
->type
)
101 if (MAN_VALID
& n
->flags
)
103 if ( ! (MAN_EXPLICIT
& man_macros
[n
->tok
].flags
))
106 assert(er
< MANDOCERR_FATAL
);
112 * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
113 * will be used if an explicit block scope is being closed out.
116 man_unscope(struct man
*m
, const struct man_node
*to
,
124 while (m
->last
!= to
) {
126 * Save the parent here, because we may delete the
127 * m->last node in the post-validation phase and reset
128 * it to m->last->parent, causing a step in the closing
132 rew_warn(m
, m
->last
, er
);
133 if ( ! man_valid_post(m
))
139 rew_warn(m
, m
->last
, er
);
140 if ( ! man_valid_post(m
))
143 m
->next
= MAN_ROOT
== m
->last
->type
?
144 MAN_NEXT_CHILD
: MAN_NEXT_SIBLING
;
151 rew_block(enum mant ntok
, enum man_type type
, const struct man_node
*n
)
154 if (MAN_BLOCK
== type
&& ntok
== n
->parent
->tok
&&
155 MAN_BODY
== n
->parent
->type
)
157 return(ntok
== n
->tok
? REW_HALT
: REW_NOHALT
);
162 * There are three scope levels: scoped to the root (all), scoped to the
163 * section (all less sections), and scoped to subsections (all less
164 * sections and subsections).
167 rew_dohalt(enum mant tok
, enum man_type type
, const struct man_node
*n
)
171 /* We cannot progress beyond the root ever. */
172 if (MAN_ROOT
== n
->type
)
177 /* Normal nodes shouldn't go to the level of the root. */
178 if (MAN_ROOT
== n
->parent
->type
)
181 /* Already-validated nodes should be closed out. */
182 if (MAN_VALID
& n
->flags
)
185 /* First: rewind to ourselves. */
186 if (type
== n
->type
&& tok
== n
->tok
)
190 * Next follow the implicit scope-smashings as defined by man.7:
191 * section, sub-section, etc.
198 /* Rewind to a section, if a block. */
199 if (REW_NOHALT
!= (c
= rew_block(MAN_SH
, type
, n
)))
203 /* Rewind to a subsection, if a block. */
204 if (REW_NOHALT
!= (c
= rew_block(MAN_SS
, type
, n
)))
206 /* Rewind to a section, if a block. */
207 if (REW_NOHALT
!= (c
= rew_block(MAN_SH
, type
, n
)))
211 /* Rewind to an offsetter, if a block. */
212 if (REW_NOHALT
!= (c
= rew_block(MAN_RS
, type
, n
)))
214 /* Rewind to a subsection, if a block. */
215 if (REW_NOHALT
!= (c
= rew_block(MAN_SS
, type
, n
)))
217 /* Rewind to a section, if a block. */
218 if (REW_NOHALT
!= (c
= rew_block(MAN_SH
, type
, n
)))
228 * Rewinding entails ascending the parse tree until a coherent point,
229 * for example, the `SH' macro will close out any intervening `SS'
230 * scopes. When a scope is closed, it must be validated and actioned.
233 rew_scope(enum man_type type
, struct man
*m
, enum mant tok
)
239 for (n
= m
->last
; n
; n
= n
->parent
) {
241 * Whether we should stop immediately (REW_HALT), stop
242 * and rewind until this point (REW_REWIND), or keep
243 * rewinding (REW_NOHALT).
245 c
= rew_dohalt(tok
, type
, n
);
253 * Rewind until the current point. Warn if we're a roff
254 * instruction that's mowing over explicit scopes.
258 return(man_unscope(m
, n
, MANDOCERR_MAX
));
263 * Close out a generic explicit macro.
267 blk_close(MACRO_PROT_ARGS
)
270 const struct man_node
*nn
;
281 for (nn
= m
->last
->parent
; nn
; nn
= nn
->parent
)
286 man_pmsg(m
, line
, ppos
, MANDOCERR_NOSCOPE
);
288 if ( ! rew_scope(MAN_BODY
, m
, ntok
))
290 if ( ! rew_scope(MAN_BLOCK
, m
, ntok
))
299 blk_exp(MACRO_PROT_ARGS
)
305 * Close out prior scopes. "Regular" explicit macros cannot be
306 * nested, but we allow roff macros to be placed just about
310 if ( ! man_block_alloc(m
, line
, ppos
, tok
))
312 if ( ! man_head_alloc(m
, line
, ppos
, tok
))
317 if ( ! man_args(m
, line
, pos
, buf
, &p
))
319 if ( ! man_word_alloc(m
, line
, la
, p
))
324 assert(tok
!= MAN_MAX
);
326 if ( ! rew_scope(MAN_HEAD
, m
, tok
))
328 return(man_body_alloc(m
, line
, ppos
, tok
));
334 * Parse an implicit-block macro. These contain a MAN_HEAD and a
335 * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
336 * scopes, such as `SH' closing out an `SS', are defined in the rew
341 blk_imp(MACRO_PROT_ARGS
)
347 /* Close out prior scopes. */
349 if ( ! rew_scope(MAN_BODY
, m
, tok
))
351 if ( ! rew_scope(MAN_BLOCK
, m
, tok
))
354 /* Allocate new block & head scope. */
356 if ( ! man_block_alloc(m
, line
, ppos
, tok
))
358 if ( ! man_head_alloc(m
, line
, ppos
, tok
))
363 /* Add line arguments. */
367 if ( ! man_args(m
, line
, pos
, buf
, &p
))
369 if ( ! man_word_alloc(m
, line
, la
, p
))
373 /* Close out head and open body (unless MAN_SCOPE). */
375 if (MAN_SCOPED
& man_macros
[tok
].flags
) {
376 /* If we're forcing scope (`TP'), keep it open. */
377 if (MAN_FSCOPED
& man_macros
[tok
].flags
) {
378 m
->flags
|= MAN_BLINE
;
380 } else if (n
== m
->last
) {
381 m
->flags
|= MAN_BLINE
;
386 if ( ! rew_scope(MAN_HEAD
, m
, tok
))
388 return(man_body_alloc(m
, line
, ppos
, tok
));
394 in_line_eoln(MACRO_PROT_ARGS
)
400 if ( ! man_elem_alloc(m
, line
, ppos
, tok
))
407 if ( ! man_args(m
, line
, pos
, buf
, &p
))
409 if ( ! man_word_alloc(m
, line
, la
, p
))
414 * If no arguments are specified and this is MAN_SCOPED (i.e.,
415 * next-line scoped), then set our mode to indicate that we're
416 * waiting for terms to load into our context.
419 if (n
== m
->last
&& MAN_SCOPED
& man_macros
[tok
].flags
) {
420 assert( ! (MAN_NSCOPED
& man_macros
[tok
].flags
));
421 m
->flags
|= MAN_ELINE
;
425 /* Set ignorable context, if applicable. */
427 if (MAN_NSCOPED
& man_macros
[tok
].flags
) {
428 assert( ! (MAN_SCOPED
& man_macros
[tok
].flags
));
429 m
->flags
|= MAN_ILINE
;
433 * Rewind our element scope. Note that when TH is pruned, we'll
434 * be back at the root, so make sure that we don't clobber as
438 for ( ; m
->last
; m
->last
= m
->last
->parent
) {
441 if (m
->last
->type
== MAN_ROOT
)
443 if ( ! man_valid_post(m
))
450 * Same here regarding whether we're back at the root.
453 if (m
->last
->type
!= MAN_ROOT
&& ! man_valid_post(m
))
456 m
->next
= MAN_ROOT
== m
->last
->type
?
457 MAN_NEXT_CHILD
: MAN_NEXT_SIBLING
;
464 man_macroend(struct man
*m
)
467 return(man_unscope(m
, m
->first
, MANDOCERR_SCOPEEXIT
));
471 man_args(struct man
*m
, int line
, int *pos
, char *buf
, char **v
)
476 *v
= start
= buf
+ *pos
;
477 assert(' ' != *start
);
482 *v
= mandoc_getarg(m
->parse
, v
, line
, pos
);