]>
git.cameronkatri.com Git - mandoc.git/blob - roff.c
1 /* $Id: roff.c,v 1.357 2018/12/31 04:55:47 schwarze Exp $ */
3 * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <sys/types.h>
31 #include "mandoc_aux.h"
32 #include "mandoc_ohash.h"
35 #include "mandoc_parse.h"
36 #include "libmandoc.h"
38 #include "tbl_parse.h"
39 #include "eqn_parse.h"
42 * ASCII_ESC is used to signal from roff_getarg() to roff_expand()
43 * that an escape sequence resulted from copy-in processing and
44 * needs to be checked or interpolated. As it is used nowhere
45 * else, it is defined here rather than in a header file.
49 /* Maximum number of string expansions per line, to break infinite loops. */
50 #define EXPAND_LIMIT 1000
52 /* Types of definitions of macros and strings. */
53 #define ROFFDEF_USER (1 << 1) /* User-defined. */
54 #define ROFFDEF_PRE (1 << 2) /* Predefined. */
55 #define ROFFDEF_REN (1 << 3) /* Renamed standard macro. */
56 #define ROFFDEF_STD (1 << 4) /* mdoc(7) or man(7) macro. */
57 #define ROFFDEF_ANY (ROFFDEF_USER | ROFFDEF_PRE | \
58 ROFFDEF_REN | ROFFDEF_STD)
59 #define ROFFDEF_UNDEF (1 << 5) /* Completely undefined. */
61 /* --- data types --------------------------------------------------------- */
64 * An incredibly-simple string buffer.
67 char *p
; /* nil-terminated buffer */
68 size_t sz
; /* saved strlen(p) */
72 * A key-value roffstr pair as part of a singly-linked list.
77 struct roffkv
*next
; /* next in list */
81 * A single number register as part of a singly-linked list.
91 * Association of request and macro names with token IDs.
99 * A macro processing context.
100 * More than one is needed when macro calls are nested.
109 struct roff_man
*man
; /* mdoc or man parser */
110 struct roffnode
*last
; /* leaf of stack */
111 struct mctx
*mstack
; /* stack of macro contexts */
112 int *rstack
; /* stack of inverted `ie' values */
113 struct ohash
*reqtab
; /* request lookup table */
114 struct roffreg
*regtab
; /* number registers */
115 struct roffkv
*strtab
; /* user-defined strings & macros */
116 struct roffkv
*rentab
; /* renamed strings & macros */
117 struct roffkv
*xmbtab
; /* multi-byte trans table (`tr') */
118 struct roffstr
*xtab
; /* single-byte trans table (`tr') */
119 const char *current_string
; /* value of last called user macro */
120 struct tbl_node
*first_tbl
; /* first table parsed */
121 struct tbl_node
*last_tbl
; /* last table parsed */
122 struct tbl_node
*tbl
; /* current table being parsed */
123 struct eqn_node
*last_eqn
; /* equation parser */
124 struct eqn_node
*eqn
; /* active equation parser */
125 int eqn_inline
; /* current equation is inline */
126 int options
; /* parse options */
127 int mstacksz
; /* current size of mstack */
128 int mstackpos
; /* position in mstack */
129 int rstacksz
; /* current size limit of rstack */
130 int rstackpos
; /* position in rstack */
131 int format
; /* current file in mdoc or man format */
132 char control
; /* control character */
133 char escape
; /* escape character */
137 enum roff_tok tok
; /* type of node */
138 struct roffnode
*parent
; /* up one in stack */
139 int line
; /* parse line */
140 int col
; /* parse col */
141 char *name
; /* node name, e.g. macro name */
142 char *end
; /* end-rules: custom token */
143 int endspan
; /* end-rules: next-line or infty */
144 int rule
; /* current evaluation rule */
147 #define ROFF_ARGS struct roff *r, /* parse ctx */ \
148 enum roff_tok tok, /* tok of macro */ \
149 struct buf *buf, /* input buffer */ \
150 int ln, /* parse line */ \
151 int ppos, /* original pos in buffer */ \
152 int pos, /* current pos in buffer */ \
153 int *offs /* reset offset of buffer data */
155 typedef int (*roffproc
)(ROFF_ARGS
);
158 roffproc proc
; /* process new macro */
159 roffproc text
; /* process as child text of macro */
160 roffproc sub
; /* process as child of macro */
162 #define ROFFMAC_STRUCT (1 << 0) /* always interpret */
166 const char *name
; /* predefined input name */
167 const char *str
; /* replacement symbol */
170 #define PREDEF(__name, __str) \
171 { (__name), (__str) },
173 /* --- function prototypes ------------------------------------------------ */
175 static int roffnode_cleanscope(struct roff
*);
176 static int roffnode_pop(struct roff
*);
177 static void roffnode_push(struct roff
*, enum roff_tok
,
178 const char *, int, int);
179 static void roff_addtbl(struct roff_man
*, int, struct tbl_node
*);
180 static int roff_als(ROFF_ARGS
);
181 static int roff_block(ROFF_ARGS
);
182 static int roff_block_text(ROFF_ARGS
);
183 static int roff_block_sub(ROFF_ARGS
);
184 static int roff_br(ROFF_ARGS
);
185 static int roff_cblock(ROFF_ARGS
);
186 static int roff_cc(ROFF_ARGS
);
187 static int roff_ccond(struct roff
*, int, int);
188 static int roff_char(ROFF_ARGS
);
189 static int roff_cond(ROFF_ARGS
);
190 static int roff_cond_text(ROFF_ARGS
);
191 static int roff_cond_sub(ROFF_ARGS
);
192 static int roff_ds(ROFF_ARGS
);
193 static int roff_ec(ROFF_ARGS
);
194 static int roff_eo(ROFF_ARGS
);
195 static int roff_eqndelim(struct roff
*, struct buf
*, int);
196 static int roff_evalcond(struct roff
*r
, int, char *, int *);
197 static int roff_evalnum(struct roff
*, int,
198 const char *, int *, int *, int);
199 static int roff_evalpar(struct roff
*, int,
200 const char *, int *, int *, int);
201 static int roff_evalstrcond(const char *, int *);
202 static int roff_expand(struct roff
*, struct buf
*,
204 static void roff_free1(struct roff
*);
205 static void roff_freereg(struct roffreg
*);
206 static void roff_freestr(struct roffkv
*);
207 static size_t roff_getname(struct roff
*, char **, int, int);
208 static int roff_getnum(const char *, int *, int *, int);
209 static int roff_getop(const char *, int *, char *);
210 static int roff_getregn(struct roff
*,
211 const char *, size_t, char);
212 static int roff_getregro(const struct roff
*,
214 static const char *roff_getstrn(struct roff
*,
215 const char *, size_t, int *);
216 static int roff_hasregn(const struct roff
*,
217 const char *, size_t);
218 static int roff_insec(ROFF_ARGS
);
219 static int roff_it(ROFF_ARGS
);
220 static int roff_line_ignore(ROFF_ARGS
);
221 static void roff_man_alloc1(struct roff_man
*);
222 static void roff_man_free1(struct roff_man
*);
223 static int roff_manyarg(ROFF_ARGS
);
224 static int roff_nop(ROFF_ARGS
);
225 static int roff_nr(ROFF_ARGS
);
226 static int roff_onearg(ROFF_ARGS
);
227 static enum roff_tok
roff_parse(struct roff
*, char *, int *,
229 static int roff_parsetext(struct roff
*, struct buf
*,
231 static int roff_renamed(ROFF_ARGS
);
232 static int roff_return(ROFF_ARGS
);
233 static int roff_rm(ROFF_ARGS
);
234 static int roff_rn(ROFF_ARGS
);
235 static int roff_rr(ROFF_ARGS
);
236 static void roff_setregn(struct roff
*, const char *,
237 size_t, int, char, int);
238 static void roff_setstr(struct roff
*,
239 const char *, const char *, int);
240 static void roff_setstrn(struct roffkv
**, const char *,
241 size_t, const char *, size_t, int);
242 static int roff_shift(ROFF_ARGS
);
243 static int roff_so(ROFF_ARGS
);
244 static int roff_tr(ROFF_ARGS
);
245 static int roff_Dd(ROFF_ARGS
);
246 static int roff_TE(ROFF_ARGS
);
247 static int roff_TS(ROFF_ARGS
);
248 static int roff_EQ(ROFF_ARGS
);
249 static int roff_EN(ROFF_ARGS
);
250 static int roff_T_(ROFF_ARGS
);
251 static int roff_unsupp(ROFF_ARGS
);
252 static int roff_userdef(ROFF_ARGS
);
254 /* --- constant data ------------------------------------------------------ */
256 #define ROFFNUM_SCALE (1 << 0) /* Honour scaling in roff_getnum(). */
257 #define ROFFNUM_WHITE (1 << 1) /* Skip whitespace in roff_evalnum(). */
259 const char *__roff_name
[MAN_MAX
+ 1] = {
260 "br", "ce", "ft", "ll",
261 "mc", "po", "rj", "sp",
263 "ab", "ad", "af", "aln",
264 "als", "am", "am1", "ami",
265 "ami1", "as", "as1", "asciify",
266 "backtrace", "bd", "bleedat", "blm",
267 "box", "boxa", "bp", "BP",
268 "break", "breakchar", "brnl", "brp",
270 "cf", "cflags", "ch", "char",
271 "chop", "class", "close", "CL",
272 "color", "composite", "continue", "cp",
273 "cropat", "cs", "cu", "da",
274 "dch", "Dd", "de", "de1",
275 "defcolor", "dei", "dei1", "device",
276 "devicem", "di", "do", "ds",
277 "ds1", "dwh", "dt", "ec",
278 "ecr", "ecs", "el", "em",
279 "EN", "eo", "EP", "EQ",
280 "errprint", "ev", "evc", "ex",
281 "fallback", "fam", "fc", "fchar",
282 "fcolor", "fdeferlig", "feature", "fkern",
283 "fl", "flig", "fp", "fps",
284 "fschar", "fspacewidth", "fspecial", "ftr",
285 "fzoom", "gcolor", "hc", "hcode",
286 "hidechar", "hla", "hlm", "hpf",
287 "hpfa", "hpfcode", "hw", "hy",
288 "hylang", "hylen", "hym", "hypp",
289 "hys", "ie", "if", "ig",
290 "index", "it", "itc", "IX",
291 "kern", "kernafter", "kernbefore", "kernpair",
292 "lc", "lc_ctype", "lds", "length",
293 "letadj", "lf", "lg", "lhang",
294 "linetabs", "lnr", "lnrf", "lpfx",
296 "mediasize", "minss", "mk", "mso",
297 "na", "ne", "nh", "nhychar",
298 "nm", "nn", "nop", "nr",
299 "nrf", "nroff", "ns", "nx",
300 "open", "opena", "os", "output",
301 "padj", "papersize", "pc", "pev",
302 "pi", "PI", "pl", "pm",
304 "psbb", "pshape", "pso", "ptr",
305 "pvs", "rchar", "rd", "recursionlimit",
306 "return", "rfschar", "rhang",
307 "rm", "rn", "rnn", "rr",
308 "rs", "rt", "schar", "sentchar",
309 "shc", "shift", "sizes", "so",
310 "spacewidth", "special", "spreadwarn", "ss",
311 "sty", "substring", "sv", "sy",
314 "tm", "tm1", "tmc", "tr",
315 "track", "transchar", "trf", "trimat",
316 "trin", "trnt", "troff", "TS",
317 "uf", "ul", "unformat", "unwatch",
318 "unwatchn", "vpt", "vs", "warn",
319 "warnscale", "watch", "watchlength", "watchn",
320 "wh", "while", "write", "writec",
321 "writem", "xflag", ".", NULL
,
323 "Dd", "Dt", "Os", "Sh",
324 "Ss", "Pp", "D1", "Dl",
325 "Bd", "Ed", "Bl", "El",
326 "It", "Ad", "An", "Ap",
327 "Ar", "Cd", "Cm", "Dv",
328 "Er", "Ev", "Ex", "Fa",
329 "Fd", "Fl", "Fn", "Ft",
330 "Ic", "In", "Li", "Nd",
331 "Nm", "Op", "Ot", "Pa",
332 "Rv", "St", "Va", "Vt",
333 "Xr", "%A", "%B", "%D",
334 "%I", "%J", "%N", "%O",
335 "%P", "%R", "%T", "%V",
336 "Ac", "Ao", "Aq", "At",
337 "Bc", "Bf", "Bo", "Bq",
338 "Bsx", "Bx", "Db", "Dc",
339 "Do", "Dq", "Ec", "Ef",
340 "Em", "Eo", "Fx", "Ms",
341 "No", "Ns", "Nx", "Ox",
342 "Pc", "Pf", "Po", "Pq",
343 "Qc", "Ql", "Qo", "Qq",
344 "Re", "Rs", "Sc", "So",
345 "Sq", "Sm", "Sx", "Sy",
346 "Tn", "Ux", "Xc", "Xo",
347 "Fo", "Fc", "Oo", "Oc",
348 "Bk", "Ek", "Bt", "Hf",
349 "Fr", "Ud", "Lb", "Lp",
350 "Lk", "Mt", "Brq", "Bro",
351 "Brc", "%C", "Es", "En",
352 "Dx", "%Q", "%U", "Ta",
354 "TH", "SH", "SS", "TP",
356 "LP", "PP", "P", "IP",
357 "HP", "SM", "SB", "BI",
358 "IB", "BR", "RB", "R",
359 "B", "I", "IR", "RI",
361 "RE", "RS", "DT", "UC",
365 "UE", "MT", "ME", NULL
367 const char *const *roff_name
= __roff_name
;
369 static struct roffmac roffs
[TOKEN_NONE
] = {
370 { roff_br
, NULL
, NULL
, 0 }, /* br */
371 { roff_onearg
, NULL
, NULL
, 0 }, /* ce */
372 { roff_onearg
, NULL
, NULL
, 0 }, /* ft */
373 { roff_onearg
, NULL
, NULL
, 0 }, /* ll */
374 { roff_onearg
, NULL
, NULL
, 0 }, /* mc */
375 { roff_onearg
, NULL
, NULL
, 0 }, /* po */
376 { roff_onearg
, NULL
, NULL
, 0 }, /* rj */
377 { roff_onearg
, NULL
, NULL
, 0 }, /* sp */
378 { roff_manyarg
, NULL
, NULL
, 0 }, /* ta */
379 { roff_onearg
, NULL
, NULL
, 0 }, /* ti */
380 { NULL
, NULL
, NULL
, 0 }, /* ROFF_MAX */
381 { roff_unsupp
, NULL
, NULL
, 0 }, /* ab */
382 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ad */
383 { roff_line_ignore
, NULL
, NULL
, 0 }, /* af */
384 { roff_unsupp
, NULL
, NULL
, 0 }, /* aln */
385 { roff_als
, NULL
, NULL
, 0 }, /* als */
386 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* am */
387 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* am1 */
388 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* ami */
389 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* ami1 */
390 { roff_ds
, NULL
, NULL
, 0 }, /* as */
391 { roff_ds
, NULL
, NULL
, 0 }, /* as1 */
392 { roff_unsupp
, NULL
, NULL
, 0 }, /* asciify */
393 { roff_line_ignore
, NULL
, NULL
, 0 }, /* backtrace */
394 { roff_line_ignore
, NULL
, NULL
, 0 }, /* bd */
395 { roff_line_ignore
, NULL
, NULL
, 0 }, /* bleedat */
396 { roff_unsupp
, NULL
, NULL
, 0 }, /* blm */
397 { roff_unsupp
, NULL
, NULL
, 0 }, /* box */
398 { roff_unsupp
, NULL
, NULL
, 0 }, /* boxa */
399 { roff_line_ignore
, NULL
, NULL
, 0 }, /* bp */
400 { roff_unsupp
, NULL
, NULL
, 0 }, /* BP */
401 { roff_unsupp
, NULL
, NULL
, 0 }, /* break */
402 { roff_line_ignore
, NULL
, NULL
, 0 }, /* breakchar */
403 { roff_line_ignore
, NULL
, NULL
, 0 }, /* brnl */
404 { roff_br
, NULL
, NULL
, 0 }, /* brp */
405 { roff_line_ignore
, NULL
, NULL
, 0 }, /* brpnl */
406 { roff_unsupp
, NULL
, NULL
, 0 }, /* c2 */
407 { roff_cc
, NULL
, NULL
, 0 }, /* cc */
408 { roff_insec
, NULL
, NULL
, 0 }, /* cf */
409 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cflags */
410 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ch */
411 { roff_char
, NULL
, NULL
, 0 }, /* char */
412 { roff_unsupp
, NULL
, NULL
, 0 }, /* chop */
413 { roff_line_ignore
, NULL
, NULL
, 0 }, /* class */
414 { roff_insec
, NULL
, NULL
, 0 }, /* close */
415 { roff_unsupp
, NULL
, NULL
, 0 }, /* CL */
416 { roff_line_ignore
, NULL
, NULL
, 0 }, /* color */
417 { roff_unsupp
, NULL
, NULL
, 0 }, /* composite */
418 { roff_unsupp
, NULL
, NULL
, 0 }, /* continue */
419 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cp */
420 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cropat */
421 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cs */
422 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cu */
423 { roff_unsupp
, NULL
, NULL
, 0 }, /* da */
424 { roff_unsupp
, NULL
, NULL
, 0 }, /* dch */
425 { roff_Dd
, NULL
, NULL
, 0 }, /* Dd */
426 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* de */
427 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* de1 */
428 { roff_line_ignore
, NULL
, NULL
, 0 }, /* defcolor */
429 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* dei */
430 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* dei1 */
431 { roff_unsupp
, NULL
, NULL
, 0 }, /* device */
432 { roff_unsupp
, NULL
, NULL
, 0 }, /* devicem */
433 { roff_unsupp
, NULL
, NULL
, 0 }, /* di */
434 { roff_unsupp
, NULL
, NULL
, 0 }, /* do */
435 { roff_ds
, NULL
, NULL
, 0 }, /* ds */
436 { roff_ds
, NULL
, NULL
, 0 }, /* ds1 */
437 { roff_unsupp
, NULL
, NULL
, 0 }, /* dwh */
438 { roff_unsupp
, NULL
, NULL
, 0 }, /* dt */
439 { roff_ec
, NULL
, NULL
, 0 }, /* ec */
440 { roff_unsupp
, NULL
, NULL
, 0 }, /* ecr */
441 { roff_unsupp
, NULL
, NULL
, 0 }, /* ecs */
442 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /* el */
443 { roff_unsupp
, NULL
, NULL
, 0 }, /* em */
444 { roff_EN
, NULL
, NULL
, 0 }, /* EN */
445 { roff_eo
, NULL
, NULL
, 0 }, /* eo */
446 { roff_unsupp
, NULL
, NULL
, 0 }, /* EP */
447 { roff_EQ
, NULL
, NULL
, 0 }, /* EQ */
448 { roff_line_ignore
, NULL
, NULL
, 0 }, /* errprint */
449 { roff_unsupp
, NULL
, NULL
, 0 }, /* ev */
450 { roff_unsupp
, NULL
, NULL
, 0 }, /* evc */
451 { roff_unsupp
, NULL
, NULL
, 0 }, /* ex */
452 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fallback */
453 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fam */
454 { roff_unsupp
, NULL
, NULL
, 0 }, /* fc */
455 { roff_unsupp
, NULL
, NULL
, 0 }, /* fchar */
456 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fcolor */
457 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fdeferlig */
458 { roff_line_ignore
, NULL
, NULL
, 0 }, /* feature */
459 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fkern */
460 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fl */
461 { roff_line_ignore
, NULL
, NULL
, 0 }, /* flig */
462 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fp */
463 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fps */
464 { roff_unsupp
, NULL
, NULL
, 0 }, /* fschar */
465 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fspacewidth */
466 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fspecial */
467 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ftr */
468 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fzoom */
469 { roff_line_ignore
, NULL
, NULL
, 0 }, /* gcolor */
470 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hc */
471 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hcode */
472 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hidechar */
473 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hla */
474 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hlm */
475 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hpf */
476 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hpfa */
477 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hpfcode */
478 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hw */
479 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hy */
480 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hylang */
481 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hylen */
482 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hym */
483 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hypp */
484 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hys */
485 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /* ie */
486 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /* if */
487 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* ig */
488 { roff_unsupp
, NULL
, NULL
, 0 }, /* index */
489 { roff_it
, NULL
, NULL
, 0 }, /* it */
490 { roff_unsupp
, NULL
, NULL
, 0 }, /* itc */
491 { roff_line_ignore
, NULL
, NULL
, 0 }, /* IX */
492 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kern */
493 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kernafter */
494 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kernbefore */
495 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kernpair */
496 { roff_unsupp
, NULL
, NULL
, 0 }, /* lc */
497 { roff_unsupp
, NULL
, NULL
, 0 }, /* lc_ctype */
498 { roff_unsupp
, NULL
, NULL
, 0 }, /* lds */
499 { roff_unsupp
, NULL
, NULL
, 0 }, /* length */
500 { roff_line_ignore
, NULL
, NULL
, 0 }, /* letadj */
501 { roff_insec
, NULL
, NULL
, 0 }, /* lf */
502 { roff_line_ignore
, NULL
, NULL
, 0 }, /* lg */
503 { roff_line_ignore
, NULL
, NULL
, 0 }, /* lhang */
504 { roff_unsupp
, NULL
, NULL
, 0 }, /* linetabs */
505 { roff_unsupp
, NULL
, NULL
, 0 }, /* lnr */
506 { roff_unsupp
, NULL
, NULL
, 0 }, /* lnrf */
507 { roff_unsupp
, NULL
, NULL
, 0 }, /* lpfx */
508 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ls */
509 { roff_unsupp
, NULL
, NULL
, 0 }, /* lsm */
510 { roff_line_ignore
, NULL
, NULL
, 0 }, /* lt */
511 { roff_line_ignore
, NULL
, NULL
, 0 }, /* mediasize */
512 { roff_line_ignore
, NULL
, NULL
, 0 }, /* minss */
513 { roff_line_ignore
, NULL
, NULL
, 0 }, /* mk */
514 { roff_insec
, NULL
, NULL
, 0 }, /* mso */
515 { roff_line_ignore
, NULL
, NULL
, 0 }, /* na */
516 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ne */
517 { roff_line_ignore
, NULL
, NULL
, 0 }, /* nh */
518 { roff_line_ignore
, NULL
, NULL
, 0 }, /* nhychar */
519 { roff_unsupp
, NULL
, NULL
, 0 }, /* nm */
520 { roff_unsupp
, NULL
, NULL
, 0 }, /* nn */
521 { roff_nop
, NULL
, NULL
, 0 }, /* nop */
522 { roff_nr
, NULL
, NULL
, 0 }, /* nr */
523 { roff_unsupp
, NULL
, NULL
, 0 }, /* nrf */
524 { roff_line_ignore
, NULL
, NULL
, 0 }, /* nroff */
525 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ns */
526 { roff_insec
, NULL
, NULL
, 0 }, /* nx */
527 { roff_insec
, NULL
, NULL
, 0 }, /* open */
528 { roff_insec
, NULL
, NULL
, 0 }, /* opena */
529 { roff_line_ignore
, NULL
, NULL
, 0 }, /* os */
530 { roff_unsupp
, NULL
, NULL
, 0 }, /* output */
531 { roff_line_ignore
, NULL
, NULL
, 0 }, /* padj */
532 { roff_line_ignore
, NULL
, NULL
, 0 }, /* papersize */
533 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pc */
534 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pev */
535 { roff_insec
, NULL
, NULL
, 0 }, /* pi */
536 { roff_unsupp
, NULL
, NULL
, 0 }, /* PI */
537 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pl */
538 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pm */
539 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pn */
540 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pnr */
541 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ps */
542 { roff_unsupp
, NULL
, NULL
, 0 }, /* psbb */
543 { roff_unsupp
, NULL
, NULL
, 0 }, /* pshape */
544 { roff_insec
, NULL
, NULL
, 0 }, /* pso */
545 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ptr */
546 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pvs */
547 { roff_unsupp
, NULL
, NULL
, 0 }, /* rchar */
548 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rd */
549 { roff_line_ignore
, NULL
, NULL
, 0 }, /* recursionlimit */
550 { roff_return
, NULL
, NULL
, 0 }, /* return */
551 { roff_unsupp
, NULL
, NULL
, 0 }, /* rfschar */
552 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rhang */
553 { roff_rm
, NULL
, NULL
, 0 }, /* rm */
554 { roff_rn
, NULL
, NULL
, 0 }, /* rn */
555 { roff_unsupp
, NULL
, NULL
, 0 }, /* rnn */
556 { roff_rr
, NULL
, NULL
, 0 }, /* rr */
557 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rs */
558 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rt */
559 { roff_unsupp
, NULL
, NULL
, 0 }, /* schar */
560 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sentchar */
561 { roff_line_ignore
, NULL
, NULL
, 0 }, /* shc */
562 { roff_shift
, NULL
, NULL
, 0 }, /* shift */
563 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sizes */
564 { roff_so
, NULL
, NULL
, 0 }, /* so */
565 { roff_line_ignore
, NULL
, NULL
, 0 }, /* spacewidth */
566 { roff_line_ignore
, NULL
, NULL
, 0 }, /* special */
567 { roff_line_ignore
, NULL
, NULL
, 0 }, /* spreadwarn */
568 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ss */
569 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sty */
570 { roff_unsupp
, NULL
, NULL
, 0 }, /* substring */
571 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sv */
572 { roff_insec
, NULL
, NULL
, 0 }, /* sy */
573 { roff_T_
, NULL
, NULL
, 0 }, /* T& */
574 { roff_unsupp
, NULL
, NULL
, 0 }, /* tc */
575 { roff_TE
, NULL
, NULL
, 0 }, /* TE */
576 { roff_Dd
, NULL
, NULL
, 0 }, /* TH */
577 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tkf */
578 { roff_unsupp
, NULL
, NULL
, 0 }, /* tl */
579 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tm */
580 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tm1 */
581 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tmc */
582 { roff_tr
, NULL
, NULL
, 0 }, /* tr */
583 { roff_line_ignore
, NULL
, NULL
, 0 }, /* track */
584 { roff_line_ignore
, NULL
, NULL
, 0 }, /* transchar */
585 { roff_insec
, NULL
, NULL
, 0 }, /* trf */
586 { roff_line_ignore
, NULL
, NULL
, 0 }, /* trimat */
587 { roff_unsupp
, NULL
, NULL
, 0 }, /* trin */
588 { roff_unsupp
, NULL
, NULL
, 0 }, /* trnt */
589 { roff_line_ignore
, NULL
, NULL
, 0 }, /* troff */
590 { roff_TS
, NULL
, NULL
, 0 }, /* TS */
591 { roff_line_ignore
, NULL
, NULL
, 0 }, /* uf */
592 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ul */
593 { roff_unsupp
, NULL
, NULL
, 0 }, /* unformat */
594 { roff_line_ignore
, NULL
, NULL
, 0 }, /* unwatch */
595 { roff_line_ignore
, NULL
, NULL
, 0 }, /* unwatchn */
596 { roff_line_ignore
, NULL
, NULL
, 0 }, /* vpt */
597 { roff_line_ignore
, NULL
, NULL
, 0 }, /* vs */
598 { roff_line_ignore
, NULL
, NULL
, 0 }, /* warn */
599 { roff_line_ignore
, NULL
, NULL
, 0 }, /* warnscale */
600 { roff_line_ignore
, NULL
, NULL
, 0 }, /* watch */
601 { roff_line_ignore
, NULL
, NULL
, 0 }, /* watchlength */
602 { roff_line_ignore
, NULL
, NULL
, 0 }, /* watchn */
603 { roff_unsupp
, NULL
, NULL
, 0 }, /* wh */
604 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /*while*/
605 { roff_insec
, NULL
, NULL
, 0 }, /* write */
606 { roff_insec
, NULL
, NULL
, 0 }, /* writec */
607 { roff_insec
, NULL
, NULL
, 0 }, /* writem */
608 { roff_line_ignore
, NULL
, NULL
, 0 }, /* xflag */
609 { roff_cblock
, NULL
, NULL
, 0 }, /* . */
610 { roff_renamed
, NULL
, NULL
, 0 },
611 { roff_userdef
, NULL
, NULL
, 0 }
614 /* Array of injected predefined strings. */
615 #define PREDEFS_MAX 38
616 static const struct predef predefs
[PREDEFS_MAX
] = {
617 #include "predefs.in"
620 static int roffce_lines
; /* number of input lines to center */
621 static struct roff_node
*roffce_node
; /* active request */
622 static int roffit_lines
; /* number of lines to delay */
623 static char *roffit_macro
; /* nil-terminated macro line */
626 /* --- request table ------------------------------------------------------ */
629 roffhash_alloc(enum roff_tok mintok
, enum roff_tok maxtok
)
637 htab
= mandoc_malloc(sizeof(*htab
));
638 mandoc_ohash_init(htab
, 8, offsetof(struct roffreq
, name
));
640 for (tok
= mintok
; tok
< maxtok
; tok
++) {
641 if (roff_name
[tok
] == NULL
)
643 sz
= strlen(roff_name
[tok
]);
644 req
= mandoc_malloc(sizeof(*req
) + sz
+ 1);
646 memcpy(req
->name
, roff_name
[tok
], sz
+ 1);
647 slot
= ohash_qlookup(htab
, req
->name
);
648 ohash_insert(htab
, slot
, req
);
654 roffhash_free(struct ohash
*htab
)
661 for (req
= ohash_first(htab
, &slot
); req
!= NULL
;
662 req
= ohash_next(htab
, &slot
))
669 roffhash_find(struct ohash
*htab
, const char *name
, size_t sz
)
676 req
= ohash_find(htab
, ohash_qlookupi(htab
, name
, &end
));
678 req
= ohash_find(htab
, ohash_qlookup(htab
, name
));
679 return req
== NULL
? TOKEN_NONE
: req
->tok
;
682 /* --- stack of request blocks -------------------------------------------- */
685 * Pop the current node off of the stack of roff instructions currently
689 roffnode_pop(struct roff
*r
)
695 inloop
= p
->tok
== ROFF_while
;
704 * Push a roff node onto the instruction stack. This must later be
705 * removed with roffnode_pop().
708 roffnode_push(struct roff
*r
, enum roff_tok tok
, const char *name
,
713 p
= mandoc_calloc(1, sizeof(struct roffnode
));
716 p
->name
= mandoc_strdup(name
);
720 p
->rule
= p
->parent
? p
->parent
->rule
: 0;
725 /* --- roff parser state data management ---------------------------------- */
728 roff_free1(struct roff
*r
)
732 tbl_free(r
->first_tbl
);
733 r
->first_tbl
= r
->last_tbl
= r
->tbl
= NULL
;
735 eqn_free(r
->last_eqn
);
736 r
->last_eqn
= r
->eqn
= NULL
;
738 while (r
->mstackpos
>= 0)
749 roff_freereg(r
->regtab
);
752 roff_freestr(r
->strtab
);
753 roff_freestr(r
->rentab
);
754 roff_freestr(r
->xmbtab
);
755 r
->strtab
= r
->rentab
= r
->xmbtab
= NULL
;
758 for (i
= 0; i
< 128; i
++)
765 roff_reset(struct roff
*r
)
768 r
->format
= r
->options
& (MPARSE_MDOC
| MPARSE_MAN
);
778 roff_free(struct roff
*r
)
783 for (i
= 0; i
< r
->mstacksz
; i
++)
784 free(r
->mstack
[i
].argv
);
786 roffhash_free(r
->reqtab
);
791 roff_alloc(int options
)
795 r
= mandoc_calloc(1, sizeof(struct roff
));
796 r
->reqtab
= roffhash_alloc(0, ROFF_RENAMED
);
797 r
->options
= options
;
798 r
->format
= options
& (MPARSE_MDOC
| MPARSE_MAN
);
805 /* --- syntax tree state data management ---------------------------------- */
808 roff_man_free1(struct roff_man
*man
)
810 if (man
->meta
.first
!= NULL
)
811 roff_node_delete(man
, man
->meta
.first
);
812 free(man
->meta
.msec
);
815 free(man
->meta
.arch
);
816 free(man
->meta
.title
);
817 free(man
->meta
.name
);
818 free(man
->meta
.date
);
819 free(man
->meta
.sodest
);
823 roff_state_reset(struct roff_man
*man
)
825 man
->last
= man
->meta
.first
;
828 man
->lastsec
= man
->lastnamed
= SEC_NONE
;
829 man
->next
= ROFF_NEXT_CHILD
;
830 roff_setreg(man
->roff
, "nS", 0, '=');
834 roff_man_alloc1(struct roff_man
*man
)
836 memset(&man
->meta
, 0, sizeof(man
->meta
));
837 man
->meta
.first
= mandoc_calloc(1, sizeof(*man
->meta
.first
));
838 man
->meta
.first
->type
= ROFFT_ROOT
;
839 man
->meta
.macroset
= MACROSET_NONE
;
840 roff_state_reset(man
);
844 roff_man_reset(struct roff_man
*man
)
847 roff_man_alloc1(man
);
851 roff_man_free(struct roff_man
*man
)
858 roff_man_alloc(struct roff
*roff
, const char *os_s
, int quick
)
860 struct roff_man
*man
;
862 man
= mandoc_calloc(1, sizeof(*man
));
866 roff_man_alloc1(man
);
871 /* --- syntax tree handling ----------------------------------------------- */
874 roff_node_alloc(struct roff_man
*man
, int line
, int pos
,
875 enum roff_type type
, int tok
)
879 n
= mandoc_calloc(1, sizeof(*n
));
884 n
->sec
= man
->lastsec
;
886 if (man
->flags
& MDOC_SYNOPSIS
)
887 n
->flags
|= NODE_SYNPRETTY
;
889 n
->flags
&= ~NODE_SYNPRETTY
;
890 if (man
->flags
& MDOC_NEWLINE
)
891 n
->flags
|= NODE_LINE
;
892 man
->flags
&= ~MDOC_NEWLINE
;
898 roff_node_append(struct roff_man
*man
, struct roff_node
*n
)
902 case ROFF_NEXT_SIBLING
:
903 if (man
->last
->next
!= NULL
) {
904 n
->next
= man
->last
->next
;
905 man
->last
->next
->prev
= n
;
907 man
->last
->parent
->last
= n
;
910 n
->parent
= man
->last
->parent
;
912 case ROFF_NEXT_CHILD
:
913 if (man
->last
->child
!= NULL
) {
914 n
->next
= man
->last
->child
;
915 man
->last
->child
->prev
= n
;
918 man
->last
->child
= n
;
919 n
->parent
= man
->last
;
931 if (n
->end
!= ENDBODY_NOT
)
943 * Copy over the normalised-data pointer of our parent. Not
944 * everybody has one, but copying a null pointer is fine.
947 n
->norm
= n
->parent
->norm
;
948 assert(n
->parent
->type
== ROFFT_BLOCK
);
952 roff_word_alloc(struct roff_man
*man
, int line
, int pos
, const char *word
)
956 n
= roff_node_alloc(man
, line
, pos
, ROFFT_TEXT
, TOKEN_NONE
);
957 n
->string
= roff_strdup(man
->roff
, word
);
958 roff_node_append(man
, n
);
959 n
->flags
|= NODE_VALID
| NODE_ENDED
;
960 man
->next
= ROFF_NEXT_SIBLING
;
964 roff_word_append(struct roff_man
*man
, const char *word
)
967 char *addstr
, *newstr
;
970 addstr
= roff_strdup(man
->roff
, word
);
971 mandoc_asprintf(&newstr
, "%s %s", n
->string
, addstr
);
975 man
->next
= ROFF_NEXT_SIBLING
;
979 roff_elem_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
983 n
= roff_node_alloc(man
, line
, pos
, ROFFT_ELEM
, tok
);
984 roff_node_append(man
, n
);
985 man
->next
= ROFF_NEXT_CHILD
;
989 roff_block_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
993 n
= roff_node_alloc(man
, line
, pos
, ROFFT_BLOCK
, tok
);
994 roff_node_append(man
, n
);
995 man
->next
= ROFF_NEXT_CHILD
;
1000 roff_head_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
1002 struct roff_node
*n
;
1004 n
= roff_node_alloc(man
, line
, pos
, ROFFT_HEAD
, tok
);
1005 roff_node_append(man
, n
);
1006 man
->next
= ROFF_NEXT_CHILD
;
1011 roff_body_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
1013 struct roff_node
*n
;
1015 n
= roff_node_alloc(man
, line
, pos
, ROFFT_BODY
, tok
);
1016 roff_node_append(man
, n
);
1017 man
->next
= ROFF_NEXT_CHILD
;
1022 roff_addtbl(struct roff_man
*man
, int line
, struct tbl_node
*tbl
)
1024 struct roff_node
*n
;
1025 struct tbl_span
*span
;
1027 if (man
->meta
.macroset
== MACROSET_MAN
)
1028 man_breakscope(man
, ROFF_TS
);
1029 while ((span
= tbl_span(tbl
)) != NULL
) {
1030 n
= roff_node_alloc(man
, line
, 0, ROFFT_TBL
, TOKEN_NONE
);
1032 roff_node_append(man
, n
);
1033 n
->flags
|= NODE_VALID
| NODE_ENDED
;
1034 man
->next
= ROFF_NEXT_SIBLING
;
1039 roff_node_unlink(struct roff_man
*man
, struct roff_node
*n
)
1042 /* Adjust siblings. */
1045 n
->prev
->next
= n
->next
;
1047 n
->next
->prev
= n
->prev
;
1049 /* Adjust parent. */
1051 if (n
->parent
!= NULL
) {
1052 if (n
->parent
->child
== n
)
1053 n
->parent
->child
= n
->next
;
1054 if (n
->parent
->last
== n
)
1055 n
->parent
->last
= n
->prev
;
1058 /* Adjust parse point. */
1062 if (man
->last
== n
) {
1063 if (n
->prev
== NULL
) {
1064 man
->last
= n
->parent
;
1065 man
->next
= ROFF_NEXT_CHILD
;
1067 man
->last
= n
->prev
;
1068 man
->next
= ROFF_NEXT_SIBLING
;
1071 if (man
->meta
.first
== n
)
1072 man
->meta
.first
= NULL
;
1076 roff_node_relink(struct roff_man
*man
, struct roff_node
*n
)
1078 roff_node_unlink(man
, n
);
1079 n
->prev
= n
->next
= NULL
;
1080 roff_node_append(man
, n
);
1084 roff_node_free(struct roff_node
*n
)
1087 if (n
->args
!= NULL
)
1088 mdoc_argv_free(n
->args
);
1089 if (n
->type
== ROFFT_BLOCK
|| n
->type
== ROFFT_ELEM
)
1091 eqn_box_free(n
->eqn
);
1097 roff_node_delete(struct roff_man
*man
, struct roff_node
*n
)
1100 while (n
->child
!= NULL
)
1101 roff_node_delete(man
, n
->child
);
1102 roff_node_unlink(man
, n
);
1107 deroff(char **dest
, const struct roff_node
*n
)
1112 if (n
->type
!= ROFFT_TEXT
) {
1113 for (n
= n
->child
; n
!= NULL
; n
= n
->next
)
1118 /* Skip leading whitespace. */
1120 for (cp
= n
->string
; *cp
!= '\0'; cp
++) {
1121 if (cp
[0] == '\\' && cp
[1] != '\0' &&
1122 strchr(" %&0^|~", cp
[1]) != NULL
)
1124 else if ( ! isspace((unsigned char)*cp
))
1128 /* Skip trailing backslash. */
1131 if (sz
> 0 && cp
[sz
- 1] == '\\')
1134 /* Skip trailing whitespace. */
1137 if ( ! isspace((unsigned char)cp
[sz
-1]))
1140 /* Skip empty strings. */
1145 if (*dest
== NULL
) {
1146 *dest
= mandoc_strndup(cp
, sz
);
1150 mandoc_asprintf(&cp
, "%s %*s", *dest
, (int)sz
, cp
);
1155 /* --- main functions of the roff parser ---------------------------------- */
1158 * In the current line, expand escape sequences that produce parsable
1159 * input text. Also check the syntax of the remaining escape sequences,
1160 * which typically produce output glyphs or change formatter state.
1163 roff_expand(struct roff
*r
, struct buf
*buf
, int ln
, int pos
, char newesc
)
1165 struct mctx
*ctx
; /* current macro call context */
1166 char ubuf
[24]; /* buffer to print the number */
1167 struct roff_node
*n
; /* used for header comments */
1168 const char *start
; /* start of the string to process */
1169 char *stesc
; /* start of an escape sequence ('\\') */
1170 const char *esct
; /* type of esccape sequence */
1171 char *ep
; /* end of comment string */
1172 const char *stnam
; /* start of the name, after "[(*" */
1173 const char *cp
; /* end of the name, e.g. before ']' */
1174 const char *res
; /* the string to be substituted */
1175 char *nbuf
; /* new buffer to copy buf->buf to */
1176 size_t maxl
; /* expected length of the escape name */
1177 size_t naml
; /* actual length of the escape name */
1178 size_t asz
; /* length of the replacement */
1179 size_t rsz
; /* length of the rest of the string */
1180 int inaml
; /* length returned from mandoc_escape() */
1181 int expand_count
; /* to avoid infinite loops */
1182 int npos
; /* position in numeric expression */
1183 int arg_complete
; /* argument not interrupted by eol */
1184 int quote_args
; /* true for \\$@, false for \\$* */
1185 int done
; /* no more input available */
1186 int deftype
; /* type of definition to paste */
1187 int rcsid
; /* kind of RCS id seen */
1188 enum mandocerr err
; /* for escape sequence problems */
1189 char sign
; /* increment number register */
1190 char term
; /* character terminating the escape */
1192 /* Search forward for comments. */
1195 start
= buf
->buf
+ pos
;
1196 for (stesc
= buf
->buf
+ pos
; *stesc
!= '\0'; stesc
++) {
1197 if (stesc
[0] != newesc
|| stesc
[1] == '\0')
1200 if (*stesc
!= '"' && *stesc
!= '#')
1203 /* Comment found, look for RCS id. */
1206 if ((cp
= strstr(stesc
, "$" "OpenBSD")) != NULL
) {
1207 rcsid
= 1 << MANDOC_OS_OPENBSD
;
1209 } else if ((cp
= strstr(stesc
, "$" "NetBSD")) != NULL
) {
1210 rcsid
= 1 << MANDOC_OS_NETBSD
;
1214 isalnum((unsigned char)*cp
) == 0 &&
1215 strchr(cp
, '$') != NULL
) {
1216 if (r
->man
->meta
.rcsids
& rcsid
)
1217 mandoc_msg(MANDOCERR_RCS_REP
, ln
,
1218 (int)(stesc
- buf
->buf
) + 1,
1220 r
->man
->meta
.rcsids
|= rcsid
;
1223 /* Handle trailing whitespace. */
1225 ep
= strchr(stesc
--, '\0') - 1;
1230 if (*ep
== ' ' || *ep
== '\t')
1231 mandoc_msg(MANDOCERR_SPACE_EOL
,
1232 ln
, (int)(ep
- buf
->buf
), NULL
);
1235 * Save comments preceding the title macro
1236 * in the syntax tree.
1239 if (newesc
!= ASCII_ESC
&& r
->format
== 0) {
1240 while (*ep
== ' ' || *ep
== '\t')
1243 n
= roff_node_alloc(r
->man
,
1244 ln
, stesc
+ 1 - buf
->buf
,
1245 ROFFT_COMMENT
, TOKEN_NONE
);
1246 n
->string
= mandoc_strdup(stesc
+ 2);
1247 roff_node_append(r
->man
, n
);
1248 n
->flags
|= NODE_VALID
| NODE_ENDED
;
1249 r
->man
->next
= ROFF_NEXT_SIBLING
;
1252 /* Line continuation with comment. */
1254 if (stesc
[1] == '#') {
1256 return ROFF_IGN
| ROFF_APPEND
;
1259 /* Discard normal comments. */
1261 while (stesc
> start
&& stesc
[-1] == ' ' &&
1262 (stesc
== start
+ 1 || stesc
[-2] != '\\'))
1271 /* Notice the end of the input. */
1273 if (*stesc
== '\n') {
1279 while (stesc
>= start
) {
1280 if (*stesc
!= newesc
) {
1283 * If we have a non-standard escape character,
1284 * escape literal backslashes because all
1285 * processing in subsequent functions uses
1286 * the standard escaping rules.
1289 if (newesc
!= ASCII_ESC
&& *stesc
== '\\') {
1291 buf
->sz
= mandoc_asprintf(&nbuf
, "%s\\e%s",
1292 buf
->buf
, stesc
+ 1) + 1;
1294 stesc
= nbuf
+ (stesc
- buf
->buf
);
1299 /* Search backwards for the next escape. */
1305 /* If it is escaped, skip it. */
1307 for (cp
= stesc
- 1; cp
>= start
; cp
--)
1308 if (*cp
!= r
->escape
)
1311 if ((stesc
- cp
) % 2 == 0) {
1315 } else if (stesc
[1] != '\0') {
1322 return ROFF_IGN
| ROFF_APPEND
;
1325 /* Decide whether to expand or to check only. */
1343 if (sign
== '+' || sign
== '-')
1349 switch(mandoc_escape(&cp
, &stnam
, &inaml
)) {
1350 case ESCAPE_SPECIAL
:
1351 if (mchars_spec2cp(stnam
, inaml
) >= 0)
1355 err
= MANDOCERR_ESC_BAD
;
1358 err
= MANDOCERR_ESC_UNDEF
;
1361 err
= MANDOCERR_ESC_UNSUPP
;
1366 if (err
!= MANDOCERR_OK
)
1367 mandoc_msg(err
, ln
, (int)(stesc
- buf
->buf
),
1368 "%.*s", (int)(cp
- stesc
), stesc
);
1373 if (EXPAND_LIMIT
< ++expand_count
) {
1374 mandoc_msg(MANDOCERR_ROFFLOOP
,
1375 ln
, (int)(stesc
- buf
->buf
), NULL
);
1380 * The third character decides the length
1381 * of the name of the string or register.
1382 * Save a pointer to the name.
1409 /* Advance to the end of the name. */
1413 while (maxl
== 0 || naml
< maxl
) {
1415 mandoc_msg(MANDOCERR_ESC_BAD
, ln
,
1416 (int)(stesc
- buf
->buf
), "%s", stesc
);
1420 if (maxl
== 0 && *cp
== term
) {
1424 if (*cp
++ != '\\' || *esct
!= 'w') {
1428 switch (mandoc_escape(&cp
, NULL
, NULL
)) {
1429 case ESCAPE_SPECIAL
:
1430 case ESCAPE_UNICODE
:
1431 case ESCAPE_NUMBERED
:
1433 case ESCAPE_OVERSTRIKE
:
1442 * Retrieve the replacement string; if it is
1443 * undefined, resume searching for escapes.
1449 deftype
= ROFFDEF_USER
| ROFFDEF_PRE
;
1450 res
= roff_getstrn(r
, stnam
, naml
, &deftype
);
1453 * If not overriden, let \*(.T
1454 * through to the formatters.
1457 if (res
== NULL
&& naml
== 2 &&
1458 stnam
[0] == '.' && stnam
[1] == 'T') {
1459 roff_setstrn(&r
->strtab
,
1460 ".T", 2, NULL
, 0, 0);
1467 if (r
->mstackpos
< 0) {
1468 mandoc_msg(MANDOCERR_ARG_UNDEF
, ln
,
1469 (int)(stesc
- buf
->buf
), "%.3s", stesc
);
1472 ctx
= r
->mstack
+ r
->mstackpos
;
1473 npos
= esct
[1] - '1';
1474 if (npos
>= 0 && npos
<= 8) {
1475 res
= npos
< ctx
->argc
?
1476 ctx
->argv
[npos
] : "";
1481 else if (esct
[1] == '@')
1484 mandoc_msg(MANDOCERR_ARG_NONUM
, ln
,
1485 (int)(stesc
- buf
->buf
), "%.3s", stesc
);
1489 for (npos
= 0; npos
< ctx
->argc
; npos
++) {
1493 asz
+= 2; /* quotes */
1494 asz
+= strlen(ctx
->argv
[npos
]);
1497 rsz
= buf
->sz
- (stesc
- buf
->buf
) - 3;
1499 memmove(stesc
+ asz
, stesc
+ 3, rsz
);
1501 nbuf
= mandoc_realloc(buf
->buf
, buf
->sz
);
1503 stesc
= nbuf
+ (stesc
- buf
->buf
);
1506 memmove(stesc
+ asz
, stesc
+ 3, rsz
);
1508 for (npos
= 0; npos
< ctx
->argc
; npos
++) {
1513 cp
= ctx
->argv
[npos
];
1522 ubuf
[0] = arg_complete
&&
1523 roff_evalnum(r
, ln
, stnam
, &npos
,
1524 NULL
, ROFFNUM_SCALE
) &&
1525 stnam
+ npos
+ 1 == cp
? '1' : '0';
1530 (void)snprintf(ubuf
, sizeof(ubuf
), "%d",
1531 roff_getregn(r
, stnam
, naml
, sign
));
1536 /* use even incomplete args */
1537 (void)snprintf(ubuf
, sizeof(ubuf
), "%d",
1544 mandoc_msg(MANDOCERR_STR_UNDEF
,
1545 ln
, (int)(stesc
- buf
->buf
),
1546 "%.*s", (int)naml
, stnam
);
1548 } else if (buf
->sz
+ strlen(res
) > SHRT_MAX
) {
1549 mandoc_msg(MANDOCERR_ROFFLOOP
,
1550 ln
, (int)(stesc
- buf
->buf
), NULL
);
1554 /* Replace the escape sequence by the string. */
1557 buf
->sz
= mandoc_asprintf(&nbuf
, "%s%s%s",
1558 buf
->buf
, res
, cp
) + 1;
1560 /* Prepare for the next replacement. */
1563 stesc
= nbuf
+ (stesc
- buf
->buf
) + strlen(res
);
1571 * Parse a quoted or unquoted roff-style request or macro argument.
1572 * Return a pointer to the parsed argument, which is either the original
1573 * pointer or advanced by one byte in case the argument is quoted.
1574 * NUL-terminate the argument in place.
1575 * Collapse pairs of quotes inside quoted arguments.
1576 * Advance the argument pointer to the next argument,
1577 * or to the NUL byte terminating the argument line.
1580 roff_getarg(struct roff
*r
, char **cpp
, int ln
, int *pos
)
1584 int newesc
, pairs
, quoted
, white
;
1586 /* Quoting can only start with a new word. */
1589 if ('"' == *start
) {
1594 newesc
= pairs
= white
= 0;
1595 for (cp
= start
; '\0' != *cp
; cp
++) {
1598 * Move the following text left
1599 * after quoted quotes and after "\\" and "\t".
1604 if ('\\' == cp
[0]) {
1606 * In copy mode, translate double to single
1607 * backslashes and backslash-t to literal tabs.
1618 cp
[-pairs
] = ASCII_ESC
;
1623 /* Skip escaped blanks. */
1630 } else if (0 == quoted
) {
1632 /* Unescaped blanks end unquoted args. */
1636 } else if ('"' == cp
[0]) {
1638 /* Quoted quotes collapse. */
1642 /* Unquoted quotes end quoted args. */
1649 /* Quoted argument without a closing quote. */
1651 mandoc_msg(MANDOCERR_ARG_QUOTE
, ln
, *pos
, NULL
);
1653 /* NUL-terminate this argument and move to the next one. */
1661 *pos
+= (int)(cp
- start
) + (quoted
? 1 : 0);
1664 if ('\0' == *cp
&& (white
|| ' ' == cp
[-1]))
1665 mandoc_msg(MANDOCERR_SPACE_EOL
, ln
, *pos
, NULL
);
1667 start
= mandoc_strdup(start
);
1672 buf
.sz
= strlen(start
) + 1;
1674 if (roff_expand(r
, &buf
, ln
, 0, ASCII_ESC
) & ROFF_IGN
) {
1676 buf
.buf
= mandoc_strdup("");
1683 * Process text streams.
1686 roff_parsetext(struct roff
*r
, struct buf
*buf
, int pos
, int *offs
)
1692 enum mandoc_esc esc
;
1694 /* Spring the input line trap. */
1696 if (roffit_lines
== 1) {
1697 isz
= mandoc_asprintf(&p
, "%s\n.%s", buf
->buf
, roffit_macro
);
1704 return ROFF_REPARSE
;
1705 } else if (roffit_lines
> 1)
1708 if (roffce_node
!= NULL
&& buf
->buf
[pos
] != '\0') {
1709 if (roffce_lines
< 1) {
1710 r
->man
->last
= roffce_node
;
1711 r
->man
->next
= ROFF_NEXT_SIBLING
;
1718 /* Convert all breakable hyphens into ASCII_HYPH. */
1720 start
= p
= buf
->buf
+ pos
;
1722 while (*p
!= '\0') {
1723 sz
= strcspn(p
, "-\\");
1730 /* Skip over escapes. */
1732 esc
= mandoc_escape((const char **)&p
, NULL
, NULL
);
1733 if (esc
== ESCAPE_ERROR
)
1738 } else if (p
== start
) {
1743 if (isalpha((unsigned char)p
[-1]) &&
1744 isalpha((unsigned char)p
[1]))
1752 roff_parseln(struct roff
*r
, int ln
, struct buf
*buf
, int *offs
)
1756 int pos
; /* parse point */
1757 int spos
; /* saved parse point for messages */
1758 int ppos
; /* original offset in buf->buf */
1759 int ctl
; /* macro line (boolean) */
1763 /* Handle in-line equation delimiters. */
1765 if (r
->tbl
== NULL
&&
1766 r
->last_eqn
!= NULL
&& r
->last_eqn
->delim
&&
1767 (r
->eqn
== NULL
|| r
->eqn_inline
)) {
1768 e
= roff_eqndelim(r
, buf
, pos
);
1769 if (e
== ROFF_REPARSE
)
1771 assert(e
== ROFF_CONT
);
1774 /* Expand some escape sequences. */
1776 e
= roff_expand(r
, buf
, ln
, pos
, r
->escape
);
1777 if ((e
& ROFF_MASK
) == ROFF_IGN
)
1779 assert(e
== ROFF_CONT
);
1781 ctl
= roff_getcontrol(r
, buf
->buf
, &pos
);
1784 * First, if a scope is open and we're not a macro, pass the
1785 * text through the macro's filter.
1786 * Equations process all content themselves.
1787 * Tables process almost all content themselves, but we want
1788 * to warn about macros before passing it there.
1791 if (r
->last
!= NULL
&& ! ctl
) {
1793 e
= (*roffs
[t
].text
)(r
, t
, buf
, ln
, pos
, pos
, offs
);
1794 if ((e
& ROFF_MASK
) == ROFF_IGN
)
1799 if (r
->eqn
!= NULL
&& strncmp(buf
->buf
+ ppos
, ".EN", 3)) {
1800 eqn_read(r
->eqn
, buf
->buf
+ ppos
);
1803 if (r
->tbl
!= NULL
&& (ctl
== 0 || buf
->buf
[pos
] == '\0')) {
1804 tbl_read(r
->tbl
, ln
, buf
->buf
, ppos
);
1805 roff_addtbl(r
->man
, ln
, r
->tbl
);
1809 return roff_parsetext(r
, buf
, pos
, offs
) | e
;
1811 /* Skip empty request lines. */
1813 if (buf
->buf
[pos
] == '"') {
1814 mandoc_msg(MANDOCERR_COMMENT_BAD
, ln
, pos
, NULL
);
1816 } else if (buf
->buf
[pos
] == '\0')
1820 * If a scope is open, go to the child handler for that macro,
1821 * as it may want to preprocess before doing anything with it.
1822 * Don't do so if an equation is open.
1827 return (*roffs
[t
].sub
)(r
, t
, buf
, ln
, ppos
, pos
, offs
);
1830 /* No scope is open. This is a new request or macro. */
1833 t
= roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
);
1835 /* Tables ignore most macros. */
1837 if (r
->tbl
!= NULL
&& (t
== TOKEN_NONE
|| t
== ROFF_TS
||
1838 t
== ROFF_br
|| t
== ROFF_ce
|| t
== ROFF_rj
|| t
== ROFF_sp
)) {
1839 mandoc_msg(MANDOCERR_TBLMACRO
,
1840 ln
, pos
, "%s", buf
->buf
+ spos
);
1841 if (t
!= TOKEN_NONE
)
1843 while (buf
->buf
[pos
] != '\0' && buf
->buf
[pos
] != ' ')
1845 while (buf
->buf
[pos
] == ' ')
1847 tbl_read(r
->tbl
, ln
, buf
->buf
, pos
);
1848 roff_addtbl(r
->man
, ln
, r
->tbl
);
1852 /* For now, let high level macros abort .ce mode. */
1854 if (ctl
&& roffce_node
!= NULL
&&
1855 (t
== TOKEN_NONE
|| t
== ROFF_Dd
|| t
== ROFF_EQ
||
1856 t
== ROFF_TH
|| t
== ROFF_TS
)) {
1857 r
->man
->last
= roffce_node
;
1858 r
->man
->next
= ROFF_NEXT_SIBLING
;
1864 * This is neither a roff request nor a user-defined macro.
1865 * Let the standard macro set parsers handle it.
1868 if (t
== TOKEN_NONE
)
1871 /* Execute a roff request or a user defined macro. */
1873 return (*roffs
[t
].proc
)(r
, t
, buf
, ln
, spos
, pos
, offs
);
1877 * Internal interface function to tell the roff parser that execution
1878 * of the current macro ended. This is required because macro
1879 * definitions usually do not end with a .return request.
1882 roff_userret(struct roff
*r
)
1887 assert(r
->mstackpos
>= 0);
1888 ctx
= r
->mstack
+ r
->mstackpos
;
1889 for (i
= 0; i
< ctx
->argc
; i
++)
1896 roff_endparse(struct roff
*r
)
1898 if (r
->last
!= NULL
)
1899 mandoc_msg(MANDOCERR_BLK_NOEND
, r
->last
->line
,
1900 r
->last
->col
, "%s", roff_name
[r
->last
->tok
]);
1902 if (r
->eqn
!= NULL
) {
1903 mandoc_msg(MANDOCERR_BLK_NOEND
,
1904 r
->eqn
->node
->line
, r
->eqn
->node
->pos
, "EQ");
1909 if (r
->tbl
!= NULL
) {
1916 * Parse a roff node's type from the input buffer. This must be in the
1917 * form of ".foo xxx" in the usual way.
1919 static enum roff_tok
1920 roff_parse(struct roff
*r
, char *buf
, int *pos
, int ln
, int ppos
)
1930 if ('\0' == *cp
|| '"' == *cp
|| '\t' == *cp
|| ' ' == *cp
)
1934 maclen
= roff_getname(r
, &cp
, ln
, ppos
);
1936 deftype
= ROFFDEF_USER
| ROFFDEF_REN
;
1937 r
->current_string
= roff_getstrn(r
, mac
, maclen
, &deftype
);
1946 t
= roffhash_find(r
->reqtab
, mac
, maclen
);
1949 if (t
!= TOKEN_NONE
)
1951 else if (deftype
== ROFFDEF_UNDEF
) {
1952 /* Using an undefined macro defines it to be empty. */
1953 roff_setstrn(&r
->strtab
, mac
, maclen
, "", 0, 0);
1954 roff_setstrn(&r
->rentab
, mac
, maclen
, NULL
, 0, 0);
1959 /* --- handling of request blocks ----------------------------------------- */
1962 roff_cblock(ROFF_ARGS
)
1966 * A block-close `..' should only be invoked as a child of an
1967 * ignore macro, otherwise raise a warning and just ignore it.
1970 if (r
->last
== NULL
) {
1971 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "..");
1975 switch (r
->last
->tok
) {
1977 /* ROFF_am1 is remapped to ROFF_am in roff_block(). */
1980 /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
1985 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "..");
1989 if (buf
->buf
[pos
] != '\0')
1990 mandoc_msg(MANDOCERR_ARG_SKIP
, ln
, pos
,
1991 ".. %s", buf
->buf
+ pos
);
1994 roffnode_cleanscope(r
);
2000 roffnode_cleanscope(struct roff
*r
)
2005 while (r
->last
!= NULL
) {
2006 if (--r
->last
->endspan
!= 0)
2008 inloop
+= roffnode_pop(r
);
2014 roff_ccond(struct roff
*r
, int ln
, int ppos
)
2016 if (NULL
== r
->last
) {
2017 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "\\}");
2021 switch (r
->last
->tok
) {
2028 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "\\}");
2032 if (r
->last
->endspan
> -1) {
2033 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "\\}");
2037 return roffnode_pop(r
) + roffnode_cleanscope(r
);
2041 roff_block(ROFF_ARGS
)
2043 const char *name
, *value
;
2044 char *call
, *cp
, *iname
, *rname
;
2045 size_t csz
, namesz
, rsz
;
2048 /* Ignore groff compatibility mode for now. */
2050 if (tok
== ROFF_de1
)
2052 else if (tok
== ROFF_dei1
)
2054 else if (tok
== ROFF_am1
)
2056 else if (tok
== ROFF_ami1
)
2059 /* Parse the macro name argument. */
2061 cp
= buf
->buf
+ pos
;
2062 if (tok
== ROFF_ig
) {
2067 namesz
= roff_getname(r
, &cp
, ln
, ppos
);
2068 iname
[namesz
] = '\0';
2071 /* Resolve the macro name argument if it is indirect. */
2073 if (namesz
&& (tok
== ROFF_dei
|| tok
== ROFF_ami
)) {
2074 deftype
= ROFFDEF_USER
;
2075 name
= roff_getstrn(r
, iname
, namesz
, &deftype
);
2077 mandoc_msg(MANDOCERR_STR_UNDEF
,
2078 ln
, (int)(iname
- buf
->buf
),
2079 "%.*s", (int)namesz
, iname
);
2082 namesz
= strlen(name
);
2086 if (namesz
== 0 && tok
!= ROFF_ig
) {
2087 mandoc_msg(MANDOCERR_REQ_EMPTY
,
2088 ln
, ppos
, "%s", roff_name
[tok
]);
2092 roffnode_push(r
, tok
, name
, ln
, ppos
);
2095 * At the beginning of a `de' macro, clear the existing string
2096 * with the same name, if there is one. New content will be
2097 * appended from roff_block_text() in multiline mode.
2100 if (tok
== ROFF_de
|| tok
== ROFF_dei
) {
2101 roff_setstrn(&r
->strtab
, name
, namesz
, "", 0, 0);
2102 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
2103 } else if (tok
== ROFF_am
|| tok
== ROFF_ami
) {
2104 deftype
= ROFFDEF_ANY
;
2105 value
= roff_getstrn(r
, iname
, namesz
, &deftype
);
2106 switch (deftype
) { /* Before appending, ... */
2107 case ROFFDEF_PRE
: /* copy predefined to user-defined. */
2108 roff_setstrn(&r
->strtab
, name
, namesz
,
2109 value
, strlen(value
), 0);
2111 case ROFFDEF_REN
: /* call original standard macro. */
2112 csz
= mandoc_asprintf(&call
, ".%.*s \\$* \\\"\n",
2113 (int)strlen(value
), value
);
2114 roff_setstrn(&r
->strtab
, name
, namesz
, call
, csz
, 0);
2115 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
2118 case ROFFDEF_STD
: /* rename and call standard macro. */
2119 rsz
= mandoc_asprintf(&rname
, "__%s_renamed", name
);
2120 roff_setstrn(&r
->rentab
, rname
, rsz
, name
, namesz
, 0);
2121 csz
= mandoc_asprintf(&call
, ".%.*s \\$* \\\"\n",
2123 roff_setstrn(&r
->strtab
, name
, namesz
, call
, csz
, 0);
2135 /* Get the custom end marker. */
2138 namesz
= roff_getname(r
, &cp
, ln
, ppos
);
2140 /* Resolve the end marker if it is indirect. */
2142 if (namesz
&& (tok
== ROFF_dei
|| tok
== ROFF_ami
)) {
2143 deftype
= ROFFDEF_USER
;
2144 name
= roff_getstrn(r
, iname
, namesz
, &deftype
);
2146 mandoc_msg(MANDOCERR_STR_UNDEF
,
2147 ln
, (int)(iname
- buf
->buf
),
2148 "%.*s", (int)namesz
, iname
);
2151 namesz
= strlen(name
);
2156 r
->last
->end
= mandoc_strndup(name
, namesz
);
2159 mandoc_msg(MANDOCERR_ARG_EXCESS
,
2160 ln
, pos
, ".%s ... %s", roff_name
[tok
], cp
);
2166 roff_block_sub(ROFF_ARGS
)
2172 * First check whether a custom macro exists at this level. If
2173 * it does, then check against it. This is some of groff's
2174 * stranger behaviours. If we encountered a custom end-scope
2175 * tag and that tag also happens to be a "real" macro, then we
2176 * need to try interpreting it again as a real macro. If it's
2177 * not, then return ignore. Else continue.
2181 for (i
= pos
, j
= 0; r
->last
->end
[j
]; j
++, i
++)
2182 if (buf
->buf
[i
] != r
->last
->end
[j
])
2185 if (r
->last
->end
[j
] == '\0' &&
2186 (buf
->buf
[i
] == '\0' ||
2187 buf
->buf
[i
] == ' ' ||
2188 buf
->buf
[i
] == '\t')) {
2190 roffnode_cleanscope(r
);
2192 while (buf
->buf
[i
] == ' ' || buf
->buf
[i
] == '\t')
2196 if (roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
) !=
2204 * If we have no custom end-query or lookup failed, then try
2205 * pulling it out of the hashtable.
2208 t
= roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
);
2210 if (t
!= ROFF_cblock
) {
2212 roff_setstr(r
, r
->last
->name
, buf
->buf
+ ppos
, 2);
2216 return (*roffs
[t
].proc
)(r
, t
, buf
, ln
, ppos
, pos
, offs
);
2220 roff_block_text(ROFF_ARGS
)
2224 roff_setstr(r
, r
->last
->name
, buf
->buf
+ pos
, 2);
2230 roff_cond_sub(ROFF_ARGS
)
2233 int endloop
, irc
, rr
;
2238 endloop
= tok
!= ROFF_while
? ROFF_IGN
:
2239 rr
? ROFF_LOOPCONT
: ROFF_LOOPEXIT
;
2240 if (roffnode_cleanscope(r
))
2244 * If `\}' occurs on a macro line without a preceding macro,
2245 * drop the line completely.
2248 ep
= buf
->buf
+ pos
;
2249 if (ep
[0] == '\\' && ep
[1] == '}')
2253 * The closing delimiter `\}' rewinds the conditional scope
2254 * but is otherwise ignored when interpreting the line.
2257 while ((ep
= strchr(ep
, '\\')) != NULL
) {
2260 memmove(ep
, ep
+ 2, strlen(ep
+ 2) + 1);
2261 if (roff_ccond(r
, ln
, ep
- buf
->buf
))
2274 * Fully handle known macros when they are structurally
2275 * required or when the conditional evaluated to true.
2278 t
= roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
);
2279 irc
|= t
!= TOKEN_NONE
&& (rr
|| roffs
[t
].flags
& ROFFMAC_STRUCT
) ?
2280 (*roffs
[t
].proc
)(r
, t
, buf
, ln
, ppos
, pos
, offs
) :
2281 rr
? ROFF_CONT
: ROFF_IGN
;
2286 roff_cond_text(ROFF_ARGS
)
2289 int endloop
, irc
, rr
;
2293 endloop
= tok
!= ROFF_while
? ROFF_IGN
:
2294 rr
? ROFF_LOOPCONT
: ROFF_LOOPEXIT
;
2295 if (roffnode_cleanscope(r
))
2299 * If `\}' occurs on a text line with neither preceding
2300 * nor following characters, drop the line completely.
2303 ep
= buf
->buf
+ pos
;
2304 if (strcmp(ep
, "\\}") == 0)
2308 * The closing delimiter `\}' rewinds the conditional scope
2309 * but is otherwise ignored when interpreting the line.
2312 while ((ep
= strchr(ep
, '\\')) != NULL
) {
2315 memmove(ep
, ep
+ 2, strlen(ep
+ 2) + 1);
2316 if (roff_ccond(r
, ln
, ep
- buf
->buf
))
2332 /* --- handling of numeric and conditional expressions -------------------- */
2335 * Parse a single signed integer number. Stop at the first non-digit.
2336 * If there is at least one digit, return success and advance the
2337 * parse point, else return failure and let the parse point unchanged.
2338 * Ignore overflows, treat them just like the C language.
2341 roff_getnum(const char *v
, int *pos
, int *res
, int flags
)
2343 int myres
, scaled
, n
, p
;
2350 if (n
|| v
[p
] == '+')
2353 if (flags
& ROFFNUM_WHITE
)
2354 while (isspace((unsigned char)v
[p
]))
2357 for (*res
= 0; isdigit((unsigned char)v
[p
]); p
++)
2358 *res
= 10 * *res
+ v
[p
] - '0';
2365 /* Each number may be followed by one optional scaling unit. */
2369 scaled
= *res
* 65536;
2372 scaled
= *res
* 240;
2375 scaled
= *res
* 240 / 2.54;
2386 scaled
= *res
* 10 / 3;
2392 scaled
= *res
* 6 / 25;
2399 if (flags
& ROFFNUM_SCALE
)
2407 * Evaluate a string comparison condition.
2408 * The first character is the delimiter.
2409 * Succeed if the string up to its second occurrence
2410 * matches the string up to its third occurence.
2411 * Advance the cursor after the third occurrence
2412 * or lacking that, to the end of the line.
2415 roff_evalstrcond(const char *v
, int *pos
)
2417 const char *s1
, *s2
, *s3
;
2421 s1
= v
+ *pos
; /* initial delimiter */
2422 s2
= s1
+ 1; /* for scanning the first string */
2423 s3
= strchr(s2
, *s1
); /* for scanning the second string */
2425 if (NULL
== s3
) /* found no middle delimiter */
2428 while ('\0' != *++s3
) {
2429 if (*s2
!= *s3
) { /* mismatch */
2430 s3
= strchr(s3
, *s1
);
2433 if (*s3
== *s1
) { /* found the final delimiter */
2442 s3
= strchr(s2
, '\0');
2443 else if (*s3
!= '\0')
2450 * Evaluate an optionally negated single character, numerical,
2451 * or string condition.
2454 roff_evalcond(struct roff
*r
, int ln
, char *v
, int *pos
)
2456 const char *start
, *end
;
2459 int deftype
, len
, number
, savepos
, istrue
, wanttrue
;
2461 if ('!' == v
[*pos
]) {
2482 } while (v
[*pos
] == ' ');
2485 * Quirk for groff compatibility:
2486 * The horizontal tab is neither available nor unavailable.
2489 if (v
[*pos
] == '\t') {
2494 /* Printable ASCII characters are available. */
2496 if (v
[*pos
] != '\\') {
2502 switch (mandoc_escape(&end
, &start
, &len
)) {
2503 case ESCAPE_SPECIAL
:
2504 istrue
= mchars_spec2cp(start
, len
) != -1;
2506 case ESCAPE_UNICODE
:
2509 case ESCAPE_NUMBERED
:
2510 istrue
= mchars_num2char(start
, len
) != -1;
2517 return istrue
== wanttrue
;
2524 sz
= roff_getname(r
, &cp
, ln
, cp
- v
);
2527 else if (v
[*pos
] == 'r')
2528 istrue
= roff_hasregn(r
, name
, sz
);
2530 deftype
= ROFFDEF_ANY
;
2531 roff_getstrn(r
, name
, sz
, &deftype
);
2535 return istrue
== wanttrue
;
2541 if (roff_evalnum(r
, ln
, v
, pos
, &number
, ROFFNUM_SCALE
))
2542 return (number
> 0) == wanttrue
;
2543 else if (*pos
== savepos
)
2544 return roff_evalstrcond(v
, pos
) == wanttrue
;
2550 roff_line_ignore(ROFF_ARGS
)
2557 roff_insec(ROFF_ARGS
)
2560 mandoc_msg(MANDOCERR_REQ_INSEC
, ln
, ppos
, "%s", roff_name
[tok
]);
2565 roff_unsupp(ROFF_ARGS
)
2568 mandoc_msg(MANDOCERR_REQ_UNSUPP
, ln
, ppos
, "%s", roff_name
[tok
]);
2573 roff_cond(ROFF_ARGS
)
2577 roffnode_push(r
, tok
, NULL
, ln
, ppos
);
2580 * An `.el' has no conditional body: it will consume the value
2581 * of the current rstack entry set in prior `ie' calls or
2584 * If we're not an `el', however, then evaluate the conditional.
2587 r
->last
->rule
= tok
== ROFF_el
?
2588 (r
->rstackpos
< 0 ? 0 : r
->rstack
[r
->rstackpos
--]) :
2589 roff_evalcond(r
, ln
, buf
->buf
, &pos
);
2592 * An if-else will put the NEGATION of the current evaluated
2593 * conditional into the stack of rules.
2596 if (tok
== ROFF_ie
) {
2597 if (r
->rstackpos
+ 1 == r
->rstacksz
) {
2599 r
->rstack
= mandoc_reallocarray(r
->rstack
,
2600 r
->rstacksz
, sizeof(int));
2602 r
->rstack
[++r
->rstackpos
] = !r
->last
->rule
;
2605 /* If the parent has false as its rule, then so do we. */
2607 if (r
->last
->parent
&& !r
->last
->parent
->rule
)
2612 * If there is nothing on the line after the conditional,
2613 * not even whitespace, use next-line scope.
2614 * Except that .while does not support next-line scope.
2617 if (buf
->buf
[pos
] == '\0' && tok
!= ROFF_while
) {
2618 r
->last
->endspan
= 2;
2622 while (buf
->buf
[pos
] == ' ')
2625 /* An opening brace requests multiline scope. */
2627 if (buf
->buf
[pos
] == '\\' && buf
->buf
[pos
+ 1] == '{') {
2628 r
->last
->endspan
= -1;
2630 while (buf
->buf
[pos
] == ' ')
2636 * Anything else following the conditional causes
2637 * single-line scope. Warn if the scope contains
2638 * nothing but trailing whitespace.
2641 if (buf
->buf
[pos
] == '\0')
2642 mandoc_msg(MANDOCERR_COND_EMPTY
,
2643 ln
, ppos
, "%s", roff_name
[tok
]);
2645 r
->last
->endspan
= 1;
2650 if (tok
== ROFF_while
)
2662 /* Ignore groff compatibility mode for now. */
2664 if (tok
== ROFF_ds1
)
2666 else if (tok
== ROFF_as1
)
2670 * The first word is the name of the string.
2671 * If it is empty or terminated by an escape sequence,
2672 * abort the `ds' request without defining anything.
2675 name
= string
= buf
->buf
+ pos
;
2679 namesz
= roff_getname(r
, &string
, ln
, pos
);
2680 if (name
[namesz
] == '\\')
2683 /* Read past the initial double-quote, if any. */
2687 /* The rest is the value. */
2688 roff_setstrn(&r
->strtab
, name
, namesz
, string
, strlen(string
),
2690 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
2695 * Parse a single operator, one or two characters long.
2696 * If the operator is recognized, return success and advance the
2697 * parse point, else return failure and let the parse point unchanged.
2700 roff_getop(const char *v
, int *pos
, char *res
)
2715 switch (v
[*pos
+ 1]) {
2733 switch (v
[*pos
+ 1]) {
2747 if ('=' == v
[*pos
+ 1])
2759 * Evaluate either a parenthesized numeric expression
2760 * or a single signed integer number.
2763 roff_evalpar(struct roff
*r
, int ln
,
2764 const char *v
, int *pos
, int *res
, int flags
)
2768 return roff_getnum(v
, pos
, res
, flags
);
2771 if ( ! roff_evalnum(r
, ln
, v
, pos
, res
, flags
| ROFFNUM_WHITE
))
2775 * Omission of the closing parenthesis
2776 * is an error in validation mode,
2777 * but ignored in evaluation mode.
2782 else if (NULL
== res
)
2789 * Evaluate a complete numeric expression.
2790 * Proceed left to right, there is no concept of precedence.
2793 roff_evalnum(struct roff
*r
, int ln
, const char *v
,
2794 int *pos
, int *res
, int flags
)
2796 int mypos
, operand2
;
2804 if (flags
& ROFFNUM_WHITE
)
2805 while (isspace((unsigned char)v
[*pos
]))
2808 if ( ! roff_evalpar(r
, ln
, v
, pos
, res
, flags
))
2812 if (flags
& ROFFNUM_WHITE
)
2813 while (isspace((unsigned char)v
[*pos
]))
2816 if ( ! roff_getop(v
, pos
, &operator))
2819 if (flags
& ROFFNUM_WHITE
)
2820 while (isspace((unsigned char)v
[*pos
]))
2823 if ( ! roff_evalpar(r
, ln
, v
, pos
, &operand2
, flags
))
2826 if (flags
& ROFFNUM_WHITE
)
2827 while (isspace((unsigned char)v
[*pos
]))
2844 if (operand2
== 0) {
2845 mandoc_msg(MANDOCERR_DIVZERO
,
2853 if (operand2
== 0) {
2854 mandoc_msg(MANDOCERR_DIVZERO
,
2862 *res
= *res
< operand2
;
2865 *res
= *res
> operand2
;
2868 *res
= *res
<= operand2
;
2871 *res
= *res
>= operand2
;
2874 *res
= *res
== operand2
;
2877 *res
= *res
!= operand2
;
2880 *res
= *res
&& operand2
;
2883 *res
= *res
|| operand2
;
2886 if (operand2
< *res
)
2890 if (operand2
> *res
)
2900 /* --- register management ------------------------------------------------ */
2903 roff_setreg(struct roff
*r
, const char *name
, int val
, char sign
)
2905 roff_setregn(r
, name
, strlen(name
), val
, sign
, INT_MIN
);
2909 roff_setregn(struct roff
*r
, const char *name
, size_t len
,
2910 int val
, char sign
, int step
)
2912 struct roffreg
*reg
;
2914 /* Search for an existing register with the same name. */
2917 while (reg
!= NULL
&& (reg
->key
.sz
!= len
||
2918 strncmp(reg
->key
.p
, name
, len
) != 0))
2922 /* Create a new register. */
2923 reg
= mandoc_malloc(sizeof(struct roffreg
));
2924 reg
->key
.p
= mandoc_strndup(name
, len
);
2928 reg
->next
= r
->regtab
;
2934 else if ('-' == sign
)
2938 if (step
!= INT_MIN
)
2943 * Handle some predefined read-only number registers.
2944 * For now, return -1 if the requested register is not predefined;
2945 * in case a predefined read-only register having the value -1
2946 * were to turn up, another special value would have to be chosen.
2949 roff_getregro(const struct roff
*r
, const char *name
)
2953 case '$': /* Number of arguments of the last macro evaluated. */
2954 return r
->mstackpos
< 0 ? 0 : r
->mstack
[r
->mstackpos
].argc
;
2955 case 'A': /* ASCII approximation mode is always off. */
2957 case 'g': /* Groff compatibility mode is always on. */
2959 case 'H': /* Fixed horizontal resolution. */
2961 case 'j': /* Always adjust left margin only. */
2963 case 'T': /* Some output device is always defined. */
2965 case 'V': /* Fixed vertical resolution. */
2973 roff_getreg(struct roff
*r
, const char *name
)
2975 return roff_getregn(r
, name
, strlen(name
), '\0');
2979 roff_getregn(struct roff
*r
, const char *name
, size_t len
, char sign
)
2981 struct roffreg
*reg
;
2984 if ('.' == name
[0] && 2 == len
) {
2985 val
= roff_getregro(r
, name
+ 1);
2990 for (reg
= r
->regtab
; reg
; reg
= reg
->next
) {
2991 if (len
== reg
->key
.sz
&&
2992 0 == strncmp(name
, reg
->key
.p
, len
)) {
2995 reg
->val
+= reg
->step
;
2998 reg
->val
-= reg
->step
;
3007 roff_setregn(r
, name
, len
, 0, '\0', INT_MIN
);
3012 roff_hasregn(const struct roff
*r
, const char *name
, size_t len
)
3014 struct roffreg
*reg
;
3017 if ('.' == name
[0] && 2 == len
) {
3018 val
= roff_getregro(r
, name
+ 1);
3023 for (reg
= r
->regtab
; reg
; reg
= reg
->next
)
3024 if (len
== reg
->key
.sz
&&
3025 0 == strncmp(name
, reg
->key
.p
, len
))
3032 roff_freereg(struct roffreg
*reg
)
3034 struct roffreg
*old_reg
;
3036 while (NULL
!= reg
) {
3047 char *key
, *val
, *step
;
3052 key
= val
= buf
->buf
+ pos
;
3056 keysz
= roff_getname(r
, &val
, ln
, pos
);
3057 if (key
[keysz
] == '\\')
3061 if (sign
== '+' || sign
== '-')
3065 if (roff_evalnum(r
, ln
, val
, &len
, &iv
, ROFFNUM_SCALE
) == 0)
3069 while (isspace((unsigned char)*step
))
3071 if (roff_evalnum(r
, ln
, step
, NULL
, &is
, 0) == 0)
3074 roff_setregn(r
, key
, keysz
, iv
, sign
, is
);
3081 struct roffreg
*reg
, **prev
;
3085 name
= cp
= buf
->buf
+ pos
;
3088 namesz
= roff_getname(r
, &cp
, ln
, pos
);
3089 name
[namesz
] = '\0';
3094 if (reg
== NULL
|| !strcmp(name
, reg
->key
.p
))
3106 /* --- handler functions for roff requests -------------------------------- */
3115 cp
= buf
->buf
+ pos
;
3116 while (*cp
!= '\0') {
3118 namesz
= roff_getname(r
, &cp
, ln
, (int)(cp
- buf
->buf
));
3119 roff_setstrn(&r
->strtab
, name
, namesz
, NULL
, 0, 0);
3120 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
3121 if (name
[namesz
] == '\\')
3132 /* Parse the number of lines. */
3134 if ( ! roff_evalnum(r
, ln
, buf
->buf
, &pos
, &iv
, 0)) {
3135 mandoc_msg(MANDOCERR_IT_NONUM
,
3136 ln
, ppos
, "%s", buf
->buf
+ 1);
3140 while (isspace((unsigned char)buf
->buf
[pos
]))
3144 * Arm the input line trap.
3145 * Special-casing "an-trap" is an ugly workaround to cope
3146 * with DocBook stupidly fiddling with man(7) internals.
3150 roffit_macro
= mandoc_strdup(iv
!= 1 ||
3151 strcmp(buf
->buf
+ pos
, "an-trap") ?
3152 buf
->buf
+ pos
: "br");
3160 enum roff_tok t
, te
;
3167 r
->format
= MPARSE_MDOC
;
3168 mask
= MPARSE_MDOC
| MPARSE_QUICK
;
3174 r
->format
= MPARSE_MAN
;
3175 mask
= MPARSE_QUICK
;
3180 if ((r
->options
& mask
) == 0)
3181 for (t
= tok
; t
< te
; t
++)
3182 roff_setstr(r
, roff_name
[t
], NULL
, 0);
3189 if (r
->tbl
== NULL
) {
3190 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "TE");
3193 if (tbl_end(r
->tbl
, 0) == 0) {
3196 buf
->buf
= mandoc_strdup(".sp");
3199 return ROFF_REPARSE
;
3210 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "T&");
3212 tbl_restart(ln
, ppos
, r
->tbl
);
3218 * Handle in-line equation delimiters.
3221 roff_eqndelim(struct roff
*r
, struct buf
*buf
, int pos
)
3224 const char *bef_pr
, *bef_nl
, *mac
, *aft_nl
, *aft_pr
;
3227 * Outside equations, look for an opening delimiter.
3228 * If we are inside an equation, we already know it is
3229 * in-line, or this function wouldn't have been called;
3230 * so look for a closing delimiter.
3233 cp1
= buf
->buf
+ pos
;
3234 cp2
= strchr(cp1
, r
->eqn
== NULL
?
3235 r
->last_eqn
->odelim
: r
->last_eqn
->cdelim
);
3240 bef_pr
= bef_nl
= aft_nl
= aft_pr
= "";
3242 /* Handle preceding text, protecting whitespace. */
3244 if (*buf
->buf
!= '\0') {
3251 * Prepare replacing the delimiter with an equation macro
3252 * and drop leading white space from the equation.
3255 if (r
->eqn
== NULL
) {
3262 /* Handle following text, protecting whitespace. */
3270 /* Do the actual replacement. */
3272 buf
->sz
= mandoc_asprintf(&cp1
, "%s%s%s%s%s%s%s", buf
->buf
,
3273 bef_pr
, bef_nl
, mac
, aft_nl
, aft_pr
, cp2
) + 1;
3277 /* Toggle the in-line state of the eqn subsystem. */
3279 r
->eqn_inline
= r
->eqn
== NULL
;
3280 return ROFF_REPARSE
;
3286 struct roff_node
*n
;
3288 if (r
->man
->meta
.macroset
== MACROSET_MAN
)
3289 man_breakscope(r
->man
, ROFF_EQ
);
3290 n
= roff_node_alloc(r
->man
, ln
, ppos
, ROFFT_EQN
, TOKEN_NONE
);
3291 if (ln
> r
->man
->last
->line
)
3292 n
->flags
|= NODE_LINE
;
3293 n
->eqn
= eqn_box_new();
3294 roff_node_append(r
->man
, n
);
3295 r
->man
->next
= ROFF_NEXT_SIBLING
;
3297 assert(r
->eqn
== NULL
);
3298 if (r
->last_eqn
== NULL
)
3299 r
->last_eqn
= eqn_alloc();
3301 eqn_reset(r
->last_eqn
);
3302 r
->eqn
= r
->last_eqn
;
3305 if (buf
->buf
[pos
] != '\0')
3306 mandoc_msg(MANDOCERR_ARG_SKIP
, ln
, pos
,
3307 ".EQ %s", buf
->buf
+ pos
);
3315 if (r
->eqn
!= NULL
) {
3319 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, ln
, ppos
, "EN");
3320 if (buf
->buf
[pos
] != '\0')
3321 mandoc_msg(MANDOCERR_ARG_SKIP
, ln
, pos
,
3322 "EN %s", buf
->buf
+ pos
);
3329 if (r
->tbl
!= NULL
) {
3330 mandoc_msg(MANDOCERR_BLK_BROKEN
, ln
, ppos
, "TS breaks TS");
3333 r
->tbl
= tbl_alloc(ppos
, ln
, r
->last_tbl
);
3334 if (r
->last_tbl
== NULL
)
3335 r
->first_tbl
= r
->tbl
;
3336 r
->last_tbl
= r
->tbl
;
3341 roff_onearg(ROFF_ARGS
)
3343 struct roff_node
*n
;
3347 if (r
->man
->flags
& (MAN_BLINE
| MAN_ELINE
) &&
3348 (tok
== ROFF_ce
|| tok
== ROFF_rj
|| tok
== ROFF_sp
||
3350 man_breakscope(r
->man
, tok
);
3352 if (roffce_node
!= NULL
&& (tok
== ROFF_ce
|| tok
== ROFF_rj
)) {
3353 r
->man
->last
= roffce_node
;
3354 r
->man
->next
= ROFF_NEXT_SIBLING
;
3357 roff_elem_alloc(r
->man
, ln
, ppos
, tok
);
3360 cp
= buf
->buf
+ pos
;
3362 while (*cp
!= '\0' && *cp
!= ' ')
3367 mandoc_msg(MANDOCERR_ARG_EXCESS
,
3368 ln
, (int)(cp
- buf
->buf
),
3369 "%s ... %s", roff_name
[tok
], cp
);
3370 roff_word_alloc(r
->man
, ln
, pos
, buf
->buf
+ pos
);
3373 if (tok
== ROFF_ce
|| tok
== ROFF_rj
) {
3374 if (r
->man
->last
->type
== ROFFT_ELEM
) {
3375 roff_word_alloc(r
->man
, ln
, pos
, "1");
3376 r
->man
->last
->flags
|= NODE_NOSRC
;
3379 if (roff_evalnum(r
, ln
, r
->man
->last
->string
, &npos
,
3380 &roffce_lines
, 0) == 0) {
3381 mandoc_msg(MANDOCERR_CE_NONUM
,
3382 ln
, pos
, "ce %s", buf
->buf
+ pos
);
3385 if (roffce_lines
< 1) {
3386 r
->man
->last
= r
->man
->last
->parent
;
3390 roffce_node
= r
->man
->last
->parent
;
3392 n
->flags
|= NODE_VALID
| NODE_ENDED
;
3395 n
->flags
|= NODE_LINE
;
3396 r
->man
->next
= ROFF_NEXT_SIBLING
;
3401 roff_manyarg(ROFF_ARGS
)
3403 struct roff_node
*n
;
3406 roff_elem_alloc(r
->man
, ln
, ppos
, tok
);
3409 for (sp
= ep
= buf
->buf
+ pos
; *sp
!= '\0'; sp
= ep
) {
3410 while (*ep
!= '\0' && *ep
!= ' ')
3414 roff_word_alloc(r
->man
, ln
, sp
- buf
->buf
, sp
);
3417 n
->flags
|= NODE_LINE
| NODE_VALID
| NODE_ENDED
;
3419 r
->man
->next
= ROFF_NEXT_SIBLING
;
3426 char *oldn
, *newn
, *end
, *value
;
3427 size_t oldsz
, newsz
, valsz
;
3429 newn
= oldn
= buf
->buf
+ pos
;
3433 newsz
= roff_getname(r
, &oldn
, ln
, pos
);
3434 if (newn
[newsz
] == '\\' || *oldn
== '\0')
3438 oldsz
= roff_getname(r
, &end
, ln
, oldn
- buf
->buf
);
3442 valsz
= mandoc_asprintf(&value
, ".%.*s \\$@\\\"\n",
3444 roff_setstrn(&r
->strtab
, newn
, newsz
, value
, valsz
, 0);
3445 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3453 if (r
->man
->flags
& (MAN_BLINE
| MAN_ELINE
))
3454 man_breakscope(r
->man
, ROFF_br
);
3455 roff_elem_alloc(r
->man
, ln
, ppos
, ROFF_br
);
3456 if (buf
->buf
[pos
] != '\0')
3457 mandoc_msg(MANDOCERR_ARG_SKIP
, ln
, pos
,
3458 "%s %s", roff_name
[tok
], buf
->buf
+ pos
);
3459 r
->man
->last
->flags
|= NODE_LINE
| NODE_VALID
| NODE_ENDED
;
3460 r
->man
->next
= ROFF_NEXT_SIBLING
;
3471 if (*p
== '\0' || (r
->control
= *p
++) == '.')
3475 mandoc_msg(MANDOCERR_ARG_EXCESS
,
3476 ln
, p
- buf
->buf
, "cc ... %s", p
);
3482 roff_char(ROFF_ARGS
)
3484 const char *p
, *kp
, *vp
;
3488 /* Parse the character to be replaced. */
3490 kp
= buf
->buf
+ pos
;
3492 if (*kp
== '\0' || (*kp
== '\\' &&
3493 mandoc_escape(&p
, NULL
, NULL
) != ESCAPE_SPECIAL
) ||
3494 (*p
!= ' ' && *p
!= '\0')) {
3495 mandoc_msg(MANDOCERR_CHAR_ARG
, ln
, pos
, "char %s", kp
);
3503 * If the replacement string contains a font escape sequence,
3504 * we have to restore the font at the end.
3510 while (*p
!= '\0') {
3513 switch (mandoc_escape(&p
, NULL
, NULL
)) {
3515 case ESCAPE_FONTROMAN
:
3516 case ESCAPE_FONTITALIC
:
3517 case ESCAPE_FONTBOLD
:
3520 case ESCAPE_FONTPREV
:
3528 mandoc_msg(MANDOCERR_CHAR_FONT
,
3529 ln
, (int)(vp
- buf
->buf
), "%s", vp
);
3532 * Approximate the effect of .char using the .tr tables.
3533 * XXX In groff, .char and .tr interact differently.
3537 if (r
->xtab
== NULL
)
3538 r
->xtab
= mandoc_calloc(128, sizeof(*r
->xtab
));
3539 assert((unsigned int)*kp
< 128);
3540 free(r
->xtab
[(int)*kp
].p
);
3541 r
->xtab
[(int)*kp
].sz
= mandoc_asprintf(&r
->xtab
[(int)*kp
].p
,
3542 "%s%s", vp
, font
? "\fP" : "");
3544 roff_setstrn(&r
->xmbtab
, kp
, ksz
, vp
, vsz
, 0);
3546 roff_setstrn(&r
->xmbtab
, kp
, ksz
, "\\fP", 3, 1);
3562 mandoc_msg(MANDOCERR_ARG_EXCESS
, ln
,
3563 (int)(p
- buf
->buf
), "ec ... %s", p
);
3572 if (buf
->buf
[pos
] != '\0')
3573 mandoc_msg(MANDOCERR_ARG_SKIP
,
3574 ln
, pos
, "eo %s", buf
->buf
+ pos
);
3581 while (buf
->buf
[pos
] == ' ')
3590 const char *p
, *first
, *second
;
3592 enum mandoc_esc esc
;
3597 mandoc_msg(MANDOCERR_REQ_EMPTY
, ln
, ppos
, "tr");
3601 while (*p
!= '\0') {
3605 if (*first
== '\\') {
3606 esc
= mandoc_escape(&p
, NULL
, NULL
);
3607 if (esc
== ESCAPE_ERROR
) {
3608 mandoc_msg(MANDOCERR_ESC_BAD
, ln
,
3609 (int)(p
- buf
->buf
), "%s", first
);
3612 fsz
= (size_t)(p
- first
);
3616 if (*second
== '\\') {
3617 esc
= mandoc_escape(&p
, NULL
, NULL
);
3618 if (esc
== ESCAPE_ERROR
) {
3619 mandoc_msg(MANDOCERR_ESC_BAD
, ln
,
3620 (int)(p
- buf
->buf
), "%s", second
);
3623 ssz
= (size_t)(p
- second
);
3624 } else if (*second
== '\0') {
3625 mandoc_msg(MANDOCERR_TR_ODD
, ln
,
3626 (int)(first
- buf
->buf
), "tr %s", first
);
3632 roff_setstrn(&r
->xmbtab
, first
, fsz
,
3637 if (r
->xtab
== NULL
)
3638 r
->xtab
= mandoc_calloc(128,
3639 sizeof(struct roffstr
));
3641 free(r
->xtab
[(int)*first
].p
);
3642 r
->xtab
[(int)*first
].p
= mandoc_strndup(second
, ssz
);
3643 r
->xtab
[(int)*first
].sz
= ssz
;
3650 * Implementation of the .return request.
3651 * There is no need to call roff_userret() from here.
3652 * The read module will call that after rewinding the reader stack
3653 * to the place from where the current macro was called.
3656 roff_return(ROFF_ARGS
)
3658 if (r
->mstackpos
>= 0)
3659 return ROFF_IGN
| ROFF_USERRET
;
3661 mandoc_msg(MANDOCERR_REQ_NOMAC
, ln
, ppos
, "return");
3669 char *oldn
, *newn
, *end
;
3670 size_t oldsz
, newsz
;
3673 oldn
= newn
= buf
->buf
+ pos
;
3677 oldsz
= roff_getname(r
, &newn
, ln
, pos
);
3678 if (oldn
[oldsz
] == '\\' || *newn
== '\0')
3682 newsz
= roff_getname(r
, &end
, ln
, newn
- buf
->buf
);
3686 deftype
= ROFFDEF_ANY
;
3687 value
= roff_getstrn(r
, oldn
, oldsz
, &deftype
);
3690 roff_setstrn(&r
->strtab
, newn
, newsz
, value
, strlen(value
), 0);
3691 roff_setstrn(&r
->strtab
, oldn
, oldsz
, NULL
, 0, 0);
3692 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3695 roff_setstrn(&r
->strtab
, newn
, newsz
, value
, strlen(value
), 0);
3696 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3699 roff_setstrn(&r
->rentab
, newn
, newsz
, value
, strlen(value
), 0);
3700 roff_setstrn(&r
->rentab
, oldn
, oldsz
, NULL
, 0, 0);
3701 roff_setstrn(&r
->strtab
, newn
, newsz
, NULL
, 0, 0);
3704 roff_setstrn(&r
->rentab
, newn
, newsz
, oldn
, oldsz
, 0);
3705 roff_setstrn(&r
->strtab
, newn
, newsz
, NULL
, 0, 0);
3708 roff_setstrn(&r
->strtab
, newn
, newsz
, NULL
, 0, 0);
3709 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3716 roff_shift(ROFF_ARGS
)
3722 if (buf
->buf
[pos
] != '\0' &&
3723 roff_evalnum(r
, ln
, buf
->buf
, &pos
, &levels
, 0) == 0) {
3724 mandoc_msg(MANDOCERR_CE_NONUM
,
3725 ln
, pos
, "shift %s", buf
->buf
+ pos
);
3728 if (r
->mstackpos
< 0) {
3729 mandoc_msg(MANDOCERR_REQ_NOMAC
, ln
, ppos
, "shift");
3732 ctx
= r
->mstack
+ r
->mstackpos
;
3733 if (levels
> ctx
->argc
) {
3734 mandoc_msg(MANDOCERR_SHIFT
,
3735 ln
, pos
, "%d, but max is %d", levels
, ctx
->argc
);
3740 for (i
= 0; i
< levels
; i
++)
3742 ctx
->argc
-= levels
;
3743 for (i
= 0; i
< ctx
->argc
; i
++)
3744 ctx
->argv
[i
] = ctx
->argv
[i
+ levels
];
3753 name
= buf
->buf
+ pos
;
3754 mandoc_msg(MANDOCERR_SO
, ln
, ppos
, "so %s", name
);
3757 * Handle `so'. Be EXTREMELY careful, as we shouldn't be
3758 * opening anything that's not in our cwd or anything beneath
3759 * it. Thus, explicitly disallow traversing up the file-system
3760 * or using absolute paths.
3763 if (*name
== '/' || strstr(name
, "../") || strstr(name
, "/..")) {
3764 mandoc_msg(MANDOCERR_SO_PATH
, ln
, ppos
, ".so %s", name
);
3765 buf
->sz
= mandoc_asprintf(&cp
,
3766 ".sp\nSee the file %s.\n.sp", name
) + 1;
3770 return ROFF_REPARSE
;
3777 /* --- user defined strings and macros ------------------------------------ */
3780 roff_userdef(ROFF_ARGS
)
3783 char *arg
, *ap
, *dst
, *src
;
3786 /* Initialize a new macro stack context. */
3788 if (++r
->mstackpos
== r
->mstacksz
) {
3789 r
->mstack
= mandoc_recallocarray(r
->mstack
,
3790 r
->mstacksz
, r
->mstacksz
+ 8, sizeof(*r
->mstack
));
3793 ctx
= r
->mstack
+ r
->mstackpos
;
3799 * Collect pointers to macro argument strings,
3800 * NUL-terminating them and escaping quotes.
3803 src
= buf
->buf
+ pos
;
3804 while (*src
!= '\0') {
3805 if (ctx
->argc
== ctx
->argsz
) {
3807 ctx
->argv
= mandoc_reallocarray(ctx
->argv
,
3808 ctx
->argsz
, sizeof(*ctx
->argv
));
3810 arg
= roff_getarg(r
, &src
, ln
, &pos
);
3811 sz
= 1; /* For the terminating NUL. */
3812 for (ap
= arg
; *ap
!= '\0'; ap
++)
3813 sz
+= *ap
== '"' ? 4 : 1;
3814 ctx
->argv
[ctx
->argc
++] = dst
= mandoc_malloc(sz
);
3815 for (ap
= arg
; *ap
!= '\0'; ap
++) {
3817 memcpy(dst
, "\\(dq", 4);
3826 /* Replace the macro invocation by the macro definition. */
3829 buf
->buf
= mandoc_strdup(r
->current_string
);
3830 buf
->sz
= strlen(buf
->buf
) + 1;
3833 return buf
->sz
> 1 && buf
->buf
[buf
->sz
- 2] == '\n' ?
3834 ROFF_REPARSE
| ROFF_USERCALL
: ROFF_IGN
| ROFF_APPEND
;
3838 * Calling a high-level macro that was renamed with .rn.
3839 * r->current_string has already been set up by roff_parse().
3842 roff_renamed(ROFF_ARGS
)
3846 buf
->sz
= mandoc_asprintf(&nbuf
, ".%s%s%s", r
->current_string
,
3847 buf
->buf
[pos
] == '\0' ? "" : " ", buf
->buf
+ pos
) + 1;
3855 roff_getname(struct roff
*r
, char **cpp
, int ln
, int pos
)
3864 /* Read until end of name and terminate it with NUL. */
3865 for (cp
= name
; 1; cp
++) {
3866 if ('\0' == *cp
|| ' ' == *cp
) {
3873 if ('{' == cp
[1] || '}' == cp
[1])
3878 mandoc_msg(MANDOCERR_NAMESC
, ln
, pos
,
3879 "%.*s", (int)(cp
- name
+ 1), name
);
3880 mandoc_escape((const char **)&cp
, NULL
, NULL
);
3884 /* Read past spaces. */
3893 * Store *string into the user-defined string called *name.
3894 * To clear an existing entry, call with (*r, *name, NULL, 0).
3895 * append == 0: replace mode
3896 * append == 1: single-line append mode
3897 * append == 2: multiline append mode, append '\n' after each call
3900 roff_setstr(struct roff
*r
, const char *name
, const char *string
,
3905 namesz
= strlen(name
);
3906 roff_setstrn(&r
->strtab
, name
, namesz
, string
,
3907 string
? strlen(string
) : 0, append
);
3908 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
3912 roff_setstrn(struct roffkv
**r
, const char *name
, size_t namesz
,
3913 const char *string
, size_t stringsz
, int append
)
3918 size_t oldch
, newch
;
3920 /* Search for an existing string with the same name. */
3923 while (n
&& (namesz
!= n
->key
.sz
||
3924 strncmp(n
->key
.p
, name
, namesz
)))
3928 /* Create a new string table entry. */
3929 n
= mandoc_malloc(sizeof(struct roffkv
));
3930 n
->key
.p
= mandoc_strndup(name
, namesz
);
3936 } else if (0 == append
) {
3946 * One additional byte for the '\n' in multiline mode,
3947 * and one for the terminating '\0'.
3949 newch
= stringsz
+ (1 < append
? 2u : 1u);
3951 if (NULL
== n
->val
.p
) {
3952 n
->val
.p
= mandoc_malloc(newch
);
3957 n
->val
.p
= mandoc_realloc(n
->val
.p
, oldch
+ newch
);
3960 /* Skip existing content in the destination buffer. */
3961 c
= n
->val
.p
+ (int)oldch
;
3963 /* Append new content to the destination buffer. */
3965 while (i
< (int)stringsz
) {
3967 * Rudimentary roff copy mode:
3968 * Handle escaped backslashes.
3970 if ('\\' == string
[i
] && '\\' == string
[i
+ 1])
3975 /* Append terminating bytes. */
3980 n
->val
.sz
= (int)(c
- n
->val
.p
);
3984 roff_getstrn(struct roff
*r
, const char *name
, size_t len
,
3987 const struct roffkv
*n
;
3992 for (n
= r
->strtab
; n
!= NULL
; n
= n
->next
) {
3993 if (strncmp(name
, n
->key
.p
, len
) != 0 ||
3994 n
->key
.p
[len
] != '\0' || n
->val
.p
== NULL
)
3996 if (*deftype
& ROFFDEF_USER
) {
3997 *deftype
= ROFFDEF_USER
;
4004 for (n
= r
->rentab
; n
!= NULL
; n
= n
->next
) {
4005 if (strncmp(name
, n
->key
.p
, len
) != 0 ||
4006 n
->key
.p
[len
] != '\0' || n
->val
.p
== NULL
)
4008 if (*deftype
& ROFFDEF_REN
) {
4009 *deftype
= ROFFDEF_REN
;
4016 for (i
= 0; i
< PREDEFS_MAX
; i
++) {
4017 if (strncmp(name
, predefs
[i
].name
, len
) != 0 ||
4018 predefs
[i
].name
[len
] != '\0')
4020 if (*deftype
& ROFFDEF_PRE
) {
4021 *deftype
= ROFFDEF_PRE
;
4022 return predefs
[i
].str
;
4028 if (r
->man
->meta
.macroset
!= MACROSET_MAN
) {
4029 for (tok
= MDOC_Dd
; tok
< MDOC_MAX
; tok
++) {
4030 if (strncmp(name
, roff_name
[tok
], len
) != 0 ||
4031 roff_name
[tok
][len
] != '\0')
4033 if (*deftype
& ROFFDEF_STD
) {
4034 *deftype
= ROFFDEF_STD
;
4042 if (r
->man
->meta
.macroset
!= MACROSET_MDOC
) {
4043 for (tok
= MAN_TH
; tok
< MAN_MAX
; tok
++) {
4044 if (strncmp(name
, roff_name
[tok
], len
) != 0 ||
4045 roff_name
[tok
][len
] != '\0')
4047 if (*deftype
& ROFFDEF_STD
) {
4048 *deftype
= ROFFDEF_STD
;
4057 if (found
== 0 && *deftype
!= ROFFDEF_ANY
) {
4058 if (*deftype
& ROFFDEF_REN
) {
4060 * This might still be a request,
4061 * so do not treat it as undefined yet.
4063 *deftype
= ROFFDEF_UNDEF
;
4067 /* Using an undefined string defines it to be empty. */
4069 roff_setstrn(&r
->strtab
, name
, len
, "", 0, 0);
4070 roff_setstrn(&r
->rentab
, name
, len
, NULL
, 0, 0);
4078 roff_freestr(struct roffkv
*r
)
4080 struct roffkv
*n
, *nn
;
4082 for (n
= r
; n
; n
= nn
) {
4090 /* --- accessors and utility functions ------------------------------------ */
4093 * Duplicate an input string, making the appropriate character
4094 * conversations (as stipulated by `tr') along the way.
4095 * Returns a heap-allocated string with all the replacements made.
4098 roff_strdup(const struct roff
*r
, const char *p
)
4100 const struct roffkv
*cp
;
4104 enum mandoc_esc esc
;
4106 if (NULL
== r
->xmbtab
&& NULL
== r
->xtab
)
4107 return mandoc_strdup(p
);
4108 else if ('\0' == *p
)
4109 return mandoc_strdup("");
4112 * Step through each character looking for term matches
4113 * (remember that a `tr' can be invoked with an escape, which is
4114 * a glyph but the escape is multi-character).
4115 * We only do this if the character hash has been initialised
4116 * and the string is >0 length.
4122 while ('\0' != *p
) {
4123 assert((unsigned int)*p
< 128);
4124 if ('\\' != *p
&& r
->xtab
&& r
->xtab
[(unsigned int)*p
].p
) {
4125 sz
= r
->xtab
[(int)*p
].sz
;
4126 res
= mandoc_realloc(res
, ssz
+ sz
+ 1);
4127 memcpy(res
+ ssz
, r
->xtab
[(int)*p
].p
, sz
);
4131 } else if ('\\' != *p
) {
4132 res
= mandoc_realloc(res
, ssz
+ 2);
4137 /* Search for term matches. */
4138 for (cp
= r
->xmbtab
; cp
; cp
= cp
->next
)
4139 if (0 == strncmp(p
, cp
->key
.p
, cp
->key
.sz
))
4144 * A match has been found.
4145 * Append the match to the array and move
4146 * forward by its keysize.
4148 res
= mandoc_realloc(res
,
4149 ssz
+ cp
->val
.sz
+ 1);
4150 memcpy(res
+ ssz
, cp
->val
.p
, cp
->val
.sz
);
4152 p
+= (int)cp
->key
.sz
;
4157 * Handle escapes carefully: we need to copy
4158 * over just the escape itself, or else we might
4159 * do replacements within the escape itself.
4160 * Make sure to pass along the bogus string.
4163 esc
= mandoc_escape(&p
, NULL
, NULL
);
4164 if (ESCAPE_ERROR
== esc
) {
4166 res
= mandoc_realloc(res
, ssz
+ sz
+ 1);
4167 memcpy(res
+ ssz
, pp
, sz
);
4171 * We bail out on bad escapes.
4172 * No need to warn: we already did so when
4173 * roff_expand() was called.
4176 res
= mandoc_realloc(res
, ssz
+ sz
+ 1);
4177 memcpy(res
+ ssz
, pp
, sz
);
4181 res
[(int)ssz
] = '\0';
4186 roff_getformat(const struct roff
*r
)
4193 * Find out whether a line is a macro line or not.
4194 * If it is, adjust the current position and return one; if it isn't,
4195 * return zero and don't change the current position.
4196 * If the control character has been set with `.cc', then let that grain
4198 * This is slighly contrary to groff, where using the non-breaking
4199 * control character when `cc' has been invoked will cause the
4200 * non-breaking macro contents to be printed verbatim.
4203 roff_getcontrol(const struct roff
*r
, const char *cp
, int *ppos
)
4209 if (r
->control
!= '\0' && cp
[pos
] == r
->control
)
4211 else if (r
->control
!= '\0')
4213 else if ('\\' == cp
[pos
] && '.' == cp
[pos
+ 1])
4215 else if ('.' == cp
[pos
] || '\'' == cp
[pos
])
4220 while (' ' == cp
[pos
] || '\t' == cp
[pos
])