1 /* $Id: roff.c,v 1.324 2017/07/14 17:16:16 schwarze Exp $ */
3 * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010-2015, 2017 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>
32 #include "mandoc_aux.h"
33 #include "mandoc_ohash.h"
35 #include "libmandoc.h"
39 /* Maximum number of string expansions per line, to break infinite loops. */
40 #define EXPAND_LIMIT 1000
42 /* Types of definitions of macros and strings. */
43 #define ROFFDEF_USER (1 << 1) /* User-defined. */
44 #define ROFFDEF_PRE (1 << 2) /* Predefined. */
45 #define ROFFDEF_REN (1 << 3) /* Renamed standard macro. */
46 #define ROFFDEF_STD (1 << 4) /* mdoc(7) or man(7) macro. */
47 #define ROFFDEF_ANY (ROFFDEF_USER | ROFFDEF_PRE | \
48 ROFFDEF_REN | ROFFDEF_STD)
50 /* --- data types --------------------------------------------------------- */
53 * An incredibly-simple string buffer.
56 char *p
; /* nil-terminated buffer */
57 size_t sz
; /* saved strlen(p) */
61 * A key-value roffstr pair as part of a singly-linked list.
66 struct roffkv
*next
; /* next in list */
70 * A single number register as part of a singly-linked list.
79 * Association of request and macro names with token IDs.
87 struct mparse
*parse
; /* parse point */
88 struct roff_man
*man
; /* mdoc or man parser */
89 struct roffnode
*last
; /* leaf of stack */
90 int *rstack
; /* stack of inverted `ie' values */
91 struct ohash
*reqtab
; /* request lookup table */
92 struct roffreg
*regtab
; /* number registers */
93 struct roffkv
*strtab
; /* user-defined strings & macros */
94 struct roffkv
*rentab
; /* renamed strings & macros */
95 struct roffkv
*xmbtab
; /* multi-byte trans table (`tr') */
96 struct roffstr
*xtab
; /* single-byte trans table (`tr') */
97 const char *current_string
; /* value of last called user macro */
98 struct tbl_node
*first_tbl
; /* first table parsed */
99 struct tbl_node
*last_tbl
; /* last table parsed */
100 struct tbl_node
*tbl
; /* current table being parsed */
101 struct eqn_node
*last_eqn
; /* equation parser */
102 struct eqn_node
*eqn
; /* active equation parser */
103 int eqn_inline
; /* current equation is inline */
104 int options
; /* parse options */
105 int rstacksz
; /* current size limit of rstack */
106 int rstackpos
; /* position in rstack */
107 int format
; /* current file in mdoc or man format */
108 int argc
; /* number of args of the last macro */
109 char control
; /* control character */
110 char escape
; /* escape character */
114 enum roff_tok tok
; /* type of node */
115 struct roffnode
*parent
; /* up one in stack */
116 int line
; /* parse line */
117 int col
; /* parse col */
118 char *name
; /* node name, e.g. macro name */
119 char *end
; /* end-rules: custom token */
120 int endspan
; /* end-rules: next-line or infty */
121 int rule
; /* current evaluation rule */
124 #define ROFF_ARGS struct roff *r, /* parse ctx */ \
125 enum roff_tok tok, /* tok of macro */ \
126 struct buf *buf, /* input buffer */ \
127 int ln, /* parse line */ \
128 int ppos, /* original pos in buffer */ \
129 int pos, /* current pos in buffer */ \
130 int *offs /* reset offset of buffer data */
132 typedef enum rofferr (*roffproc
)(ROFF_ARGS
);
135 roffproc proc
; /* process new macro */
136 roffproc text
; /* process as child text of macro */
137 roffproc sub
; /* process as child of macro */
139 #define ROFFMAC_STRUCT (1 << 0) /* always interpret */
143 const char *name
; /* predefined input name */
144 const char *str
; /* replacement symbol */
147 #define PREDEF(__name, __str) \
148 { (__name), (__str) },
150 /* --- function prototypes ------------------------------------------------ */
152 static void roffnode_cleanscope(struct roff
*);
153 static void roffnode_pop(struct roff
*);
154 static void roffnode_push(struct roff
*, enum roff_tok
,
155 const char *, int, int);
156 static void roff_addtbl(struct roff_man
*, struct tbl_node
*);
157 static enum rofferr
roff_als(ROFF_ARGS
);
158 static enum rofferr
roff_block(ROFF_ARGS
);
159 static enum rofferr
roff_block_text(ROFF_ARGS
);
160 static enum rofferr
roff_block_sub(ROFF_ARGS
);
161 static enum rofferr
roff_br(ROFF_ARGS
);
162 static enum rofferr
roff_cblock(ROFF_ARGS
);
163 static enum rofferr
roff_cc(ROFF_ARGS
);
164 static void roff_ccond(struct roff
*, int, int);
165 static enum rofferr
roff_cond(ROFF_ARGS
);
166 static enum rofferr
roff_cond_text(ROFF_ARGS
);
167 static enum rofferr
roff_cond_sub(ROFF_ARGS
);
168 static enum rofferr
roff_ds(ROFF_ARGS
);
169 static enum rofferr
roff_ec(ROFF_ARGS
);
170 static enum rofferr
roff_eo(ROFF_ARGS
);
171 static enum rofferr
roff_eqndelim(struct roff
*, struct buf
*, int);
172 static int roff_evalcond(struct roff
*r
, int, char *, int *);
173 static int roff_evalnum(struct roff
*, int,
174 const char *, int *, int *, int);
175 static int roff_evalpar(struct roff
*, int,
176 const char *, int *, int *, int);
177 static int roff_evalstrcond(const char *, int *);
178 static void roff_free1(struct roff
*);
179 static void roff_freereg(struct roffreg
*);
180 static void roff_freestr(struct roffkv
*);
181 static size_t roff_getname(struct roff
*, char **, int, int);
182 static int roff_getnum(const char *, int *, int *, int);
183 static int roff_getop(const char *, int *, char *);
184 static int roff_getregn(const struct roff
*,
185 const char *, size_t);
186 static int roff_getregro(const struct roff
*,
188 static const char *roff_getstrn(const struct roff
*,
189 const char *, size_t, int *);
190 static int roff_hasregn(const struct roff
*,
191 const char *, size_t);
192 static enum rofferr
roff_insec(ROFF_ARGS
);
193 static enum rofferr
roff_it(ROFF_ARGS
);
194 static enum rofferr
roff_line_ignore(ROFF_ARGS
);
195 static void roff_man_alloc1(struct roff_man
*);
196 static void roff_man_free1(struct roff_man
*);
197 static enum rofferr
roff_manyarg(ROFF_ARGS
);
198 static enum rofferr
roff_nr(ROFF_ARGS
);
199 static enum rofferr
roff_onearg(ROFF_ARGS
);
200 static enum roff_tok
roff_parse(struct roff
*, char *, int *,
202 static enum rofferr
roff_parsetext(struct roff
*, struct buf
*,
204 static enum rofferr
roff_renamed(ROFF_ARGS
);
205 static enum rofferr
roff_res(struct roff
*, struct buf
*, int, int);
206 static enum rofferr
roff_rm(ROFF_ARGS
);
207 static enum rofferr
roff_rn(ROFF_ARGS
);
208 static enum rofferr
roff_rr(ROFF_ARGS
);
209 static void roff_setstr(struct roff
*,
210 const char *, const char *, int);
211 static void roff_setstrn(struct roffkv
**, const char *,
212 size_t, const char *, size_t, int);
213 static enum rofferr
roff_so(ROFF_ARGS
);
214 static enum rofferr
roff_tr(ROFF_ARGS
);
215 static enum rofferr
roff_Dd(ROFF_ARGS
);
216 static enum rofferr
roff_TE(ROFF_ARGS
);
217 static enum rofferr
roff_TS(ROFF_ARGS
);
218 static enum rofferr
roff_EQ(ROFF_ARGS
);
219 static enum rofferr
roff_EN(ROFF_ARGS
);
220 static enum rofferr
roff_T_(ROFF_ARGS
);
221 static enum rofferr
roff_unsupp(ROFF_ARGS
);
222 static enum rofferr
roff_userdef(ROFF_ARGS
);
224 /* --- constant data ------------------------------------------------------ */
226 #define ROFFNUM_SCALE (1 << 0) /* Honour scaling in roff_getnum(). */
227 #define ROFFNUM_WHITE (1 << 1) /* Skip whitespace in roff_evalnum(). */
229 const char *__roff_name
[MAN_MAX
+ 1] = {
230 "br", "ce", "ft", "ll",
231 "mc", "po", "rj", "sp",
233 "ab", "ad", "af", "aln",
234 "als", "am", "am1", "ami",
235 "ami1", "as", "as1", "asciify",
236 "backtrace", "bd", "bleedat", "blm",
237 "box", "boxa", "bp", "BP",
238 "break", "breakchar", "brnl", "brp",
240 "cf", "cflags", "ch", "char",
241 "chop", "class", "close", "CL",
242 "color", "composite", "continue", "cp",
243 "cropat", "cs", "cu", "da",
244 "dch", "Dd", "de", "de1",
245 "defcolor", "dei", "dei1", "device",
246 "devicem", "di", "do", "ds",
247 "ds1", "dwh", "dt", "ec",
248 "ecr", "ecs", "el", "em",
249 "EN", "eo", "EP", "EQ",
250 "errprint", "ev", "evc", "ex",
251 "fallback", "fam", "fc", "fchar",
252 "fcolor", "fdeferlig", "feature", "fkern",
253 "fl", "flig", "fp", "fps",
254 "fschar", "fspacewidth", "fspecial", "ftr",
255 "fzoom", "gcolor", "hc", "hcode",
256 "hidechar", "hla", "hlm", "hpf",
257 "hpfa", "hpfcode", "hw", "hy",
258 "hylang", "hylen", "hym", "hypp",
259 "hys", "ie", "if", "ig",
260 "index", "it", "itc", "IX",
261 "kern", "kernafter", "kernbefore", "kernpair",
262 "lc", "lc_ctype", "lds", "length",
263 "letadj", "lf", "lg", "lhang",
264 "linetabs", "lnr", "lnrf", "lpfx",
266 "mediasize", "minss", "mk", "mso",
267 "na", "ne", "nh", "nhychar",
268 "nm", "nn", "nop", "nr",
269 "nrf", "nroff", "ns", "nx",
270 "open", "opena", "os", "output",
271 "padj", "papersize", "pc", "pev",
272 "pi", "PI", "pl", "pm",
274 "psbb", "pshape", "pso", "ptr",
275 "pvs", "rchar", "rd", "recursionlimit",
276 "return", "rfschar", "rhang",
277 "rm", "rn", "rnn", "rr",
278 "rs", "rt", "schar", "sentchar",
279 "shc", "shift", "sizes", "so",
280 "spacewidth", "special", "spreadwarn", "ss",
281 "sty", "substring", "sv", "sy",
284 "tm", "tm1", "tmc", "tr",
285 "track", "transchar", "trf", "trimat",
286 "trin", "trnt", "troff", "TS",
287 "uf", "ul", "unformat", "unwatch",
288 "unwatchn", "vpt", "vs", "warn",
289 "warnscale", "watch", "watchlength", "watchn",
290 "wh", "while", "write", "writec",
291 "writem", "xflag", ".", NULL
,
293 "Dd", "Dt", "Os", "Sh",
294 "Ss", "Pp", "D1", "Dl",
295 "Bd", "Ed", "Bl", "El",
296 "It", "Ad", "An", "Ap",
297 "Ar", "Cd", "Cm", "Dv",
298 "Er", "Ev", "Ex", "Fa",
299 "Fd", "Fl", "Fn", "Ft",
300 "Ic", "In", "Li", "Nd",
301 "Nm", "Op", "Ot", "Pa",
302 "Rv", "St", "Va", "Vt",
303 "Xr", "%A", "%B", "%D",
304 "%I", "%J", "%N", "%O",
305 "%P", "%R", "%T", "%V",
306 "Ac", "Ao", "Aq", "At",
307 "Bc", "Bf", "Bo", "Bq",
308 "Bsx", "Bx", "Db", "Dc",
309 "Do", "Dq", "Ec", "Ef",
310 "Em", "Eo", "Fx", "Ms",
311 "No", "Ns", "Nx", "Ox",
312 "Pc", "Pf", "Po", "Pq",
313 "Qc", "Ql", "Qo", "Qq",
314 "Re", "Rs", "Sc", "So",
315 "Sq", "Sm", "Sx", "Sy",
316 "Tn", "Ux", "Xc", "Xo",
317 "Fo", "Fc", "Oo", "Oc",
318 "Bk", "Ek", "Bt", "Hf",
319 "Fr", "Ud", "Lb", "Lp",
320 "Lk", "Mt", "Brq", "Bro",
321 "Brc", "%C", "Es", "En",
322 "Dx", "%Q", "%U", "Ta",
324 "TH", "SH", "SS", "TP",
325 "LP", "PP", "P", "IP",
326 "HP", "SM", "SB", "BI",
327 "IB", "BR", "RB", "R",
328 "B", "I", "IR", "RI",
330 "RE", "RS", "DT", "UC",
332 "OP", "EX", "EE", "UR",
333 "UE", "MT", "ME", NULL
335 const char *const *roff_name
= __roff_name
;
337 static struct roffmac roffs
[TOKEN_NONE
] = {
338 { roff_br
, NULL
, NULL
, 0 }, /* br */
339 { roff_onearg
, NULL
, NULL
, 0 }, /* ce */
340 { roff_onearg
, NULL
, NULL
, 0 }, /* ft */
341 { roff_onearg
, NULL
, NULL
, 0 }, /* ll */
342 { roff_onearg
, NULL
, NULL
, 0 }, /* mc */
343 { roff_onearg
, NULL
, NULL
, 0 }, /* po */
344 { roff_onearg
, NULL
, NULL
, 0 }, /* rj */
345 { roff_onearg
, NULL
, NULL
, 0 }, /* sp */
346 { roff_manyarg
, NULL
, NULL
, 0 }, /* ta */
347 { roff_onearg
, NULL
, NULL
, 0 }, /* ti */
348 { NULL
, NULL
, NULL
, 0 }, /* ROFF_MAX */
349 { roff_unsupp
, NULL
, NULL
, 0 }, /* ab */
350 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ad */
351 { roff_line_ignore
, NULL
, NULL
, 0 }, /* af */
352 { roff_unsupp
, NULL
, NULL
, 0 }, /* aln */
353 { roff_als
, NULL
, NULL
, 0 }, /* als */
354 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* am */
355 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* am1 */
356 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* ami */
357 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* ami1 */
358 { roff_ds
, NULL
, NULL
, 0 }, /* as */
359 { roff_ds
, NULL
, NULL
, 0 }, /* as1 */
360 { roff_unsupp
, NULL
, NULL
, 0 }, /* asciify */
361 { roff_line_ignore
, NULL
, NULL
, 0 }, /* backtrace */
362 { roff_line_ignore
, NULL
, NULL
, 0 }, /* bd */
363 { roff_line_ignore
, NULL
, NULL
, 0 }, /* bleedat */
364 { roff_unsupp
, NULL
, NULL
, 0 }, /* blm */
365 { roff_unsupp
, NULL
, NULL
, 0 }, /* box */
366 { roff_unsupp
, NULL
, NULL
, 0 }, /* boxa */
367 { roff_line_ignore
, NULL
, NULL
, 0 }, /* bp */
368 { roff_unsupp
, NULL
, NULL
, 0 }, /* BP */
369 { roff_unsupp
, NULL
, NULL
, 0 }, /* break */
370 { roff_line_ignore
, NULL
, NULL
, 0 }, /* breakchar */
371 { roff_line_ignore
, NULL
, NULL
, 0 }, /* brnl */
372 { roff_br
, NULL
, NULL
, 0 }, /* brp */
373 { roff_line_ignore
, NULL
, NULL
, 0 }, /* brpnl */
374 { roff_unsupp
, NULL
, NULL
, 0 }, /* c2 */
375 { roff_cc
, NULL
, NULL
, 0 }, /* cc */
376 { roff_insec
, NULL
, NULL
, 0 }, /* cf */
377 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cflags */
378 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ch */
379 { roff_unsupp
, NULL
, NULL
, 0 }, /* char */
380 { roff_unsupp
, NULL
, NULL
, 0 }, /* chop */
381 { roff_line_ignore
, NULL
, NULL
, 0 }, /* class */
382 { roff_insec
, NULL
, NULL
, 0 }, /* close */
383 { roff_unsupp
, NULL
, NULL
, 0 }, /* CL */
384 { roff_line_ignore
, NULL
, NULL
, 0 }, /* color */
385 { roff_unsupp
, NULL
, NULL
, 0 }, /* composite */
386 { roff_unsupp
, NULL
, NULL
, 0 }, /* continue */
387 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cp */
388 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cropat */
389 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cs */
390 { roff_line_ignore
, NULL
, NULL
, 0 }, /* cu */
391 { roff_unsupp
, NULL
, NULL
, 0 }, /* da */
392 { roff_unsupp
, NULL
, NULL
, 0 }, /* dch */
393 { roff_Dd
, NULL
, NULL
, 0 }, /* Dd */
394 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* de */
395 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* de1 */
396 { roff_line_ignore
, NULL
, NULL
, 0 }, /* defcolor */
397 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* dei */
398 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* dei1 */
399 { roff_unsupp
, NULL
, NULL
, 0 }, /* device */
400 { roff_unsupp
, NULL
, NULL
, 0 }, /* devicem */
401 { roff_unsupp
, NULL
, NULL
, 0 }, /* di */
402 { roff_unsupp
, NULL
, NULL
, 0 }, /* do */
403 { roff_ds
, NULL
, NULL
, 0 }, /* ds */
404 { roff_ds
, NULL
, NULL
, 0 }, /* ds1 */
405 { roff_unsupp
, NULL
, NULL
, 0 }, /* dwh */
406 { roff_unsupp
, NULL
, NULL
, 0 }, /* dt */
407 { roff_ec
, NULL
, NULL
, 0 }, /* ec */
408 { roff_unsupp
, NULL
, NULL
, 0 }, /* ecr */
409 { roff_unsupp
, NULL
, NULL
, 0 }, /* ecs */
410 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /* el */
411 { roff_unsupp
, NULL
, NULL
, 0 }, /* em */
412 { roff_EN
, NULL
, NULL
, 0 }, /* EN */
413 { roff_eo
, NULL
, NULL
, 0 }, /* eo */
414 { roff_unsupp
, NULL
, NULL
, 0 }, /* EP */
415 { roff_EQ
, NULL
, NULL
, 0 }, /* EQ */
416 { roff_line_ignore
, NULL
, NULL
, 0 }, /* errprint */
417 { roff_unsupp
, NULL
, NULL
, 0 }, /* ev */
418 { roff_unsupp
, NULL
, NULL
, 0 }, /* evc */
419 { roff_unsupp
, NULL
, NULL
, 0 }, /* ex */
420 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fallback */
421 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fam */
422 { roff_unsupp
, NULL
, NULL
, 0 }, /* fc */
423 { roff_unsupp
, NULL
, NULL
, 0 }, /* fchar */
424 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fcolor */
425 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fdeferlig */
426 { roff_line_ignore
, NULL
, NULL
, 0 }, /* feature */
427 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fkern */
428 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fl */
429 { roff_line_ignore
, NULL
, NULL
, 0 }, /* flig */
430 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fp */
431 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fps */
432 { roff_unsupp
, NULL
, NULL
, 0 }, /* fschar */
433 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fspacewidth */
434 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fspecial */
435 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ftr */
436 { roff_line_ignore
, NULL
, NULL
, 0 }, /* fzoom */
437 { roff_line_ignore
, NULL
, NULL
, 0 }, /* gcolor */
438 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hc */
439 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hcode */
440 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hidechar */
441 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hla */
442 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hlm */
443 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hpf */
444 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hpfa */
445 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hpfcode */
446 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hw */
447 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hy */
448 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hylang */
449 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hylen */
450 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hym */
451 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hypp */
452 { roff_line_ignore
, NULL
, NULL
, 0 }, /* hys */
453 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /* ie */
454 { roff_cond
, roff_cond_text
, roff_cond_sub
, ROFFMAC_STRUCT
}, /* if */
455 { roff_block
, roff_block_text
, roff_block_sub
, 0 }, /* ig */
456 { roff_unsupp
, NULL
, NULL
, 0 }, /* index */
457 { roff_it
, NULL
, NULL
, 0 }, /* it */
458 { roff_unsupp
, NULL
, NULL
, 0 }, /* itc */
459 { roff_line_ignore
, NULL
, NULL
, 0 }, /* IX */
460 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kern */
461 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kernafter */
462 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kernbefore */
463 { roff_line_ignore
, NULL
, NULL
, 0 }, /* kernpair */
464 { roff_unsupp
, NULL
, NULL
, 0 }, /* lc */
465 { roff_unsupp
, NULL
, NULL
, 0 }, /* lc_ctype */
466 { roff_unsupp
, NULL
, NULL
, 0 }, /* lds */
467 { roff_unsupp
, NULL
, NULL
, 0 }, /* length */
468 { roff_line_ignore
, NULL
, NULL
, 0 }, /* letadj */
469 { roff_insec
, NULL
, NULL
, 0 }, /* lf */
470 { roff_line_ignore
, NULL
, NULL
, 0 }, /* lg */
471 { roff_line_ignore
, NULL
, NULL
, 0 }, /* lhang */
472 { roff_unsupp
, NULL
, NULL
, 0 }, /* linetabs */
473 { roff_unsupp
, NULL
, NULL
, 0 }, /* lnr */
474 { roff_unsupp
, NULL
, NULL
, 0 }, /* lnrf */
475 { roff_unsupp
, NULL
, NULL
, 0 }, /* lpfx */
476 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ls */
477 { roff_unsupp
, NULL
, NULL
, 0 }, /* lsm */
478 { roff_line_ignore
, NULL
, NULL
, 0 }, /* lt */
479 { roff_line_ignore
, NULL
, NULL
, 0 }, /* mediasize */
480 { roff_line_ignore
, NULL
, NULL
, 0 }, /* minss */
481 { roff_line_ignore
, NULL
, NULL
, 0 }, /* mk */
482 { roff_insec
, NULL
, NULL
, 0 }, /* mso */
483 { roff_line_ignore
, NULL
, NULL
, 0 }, /* na */
484 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ne */
485 { roff_line_ignore
, NULL
, NULL
, 0 }, /* nh */
486 { roff_line_ignore
, NULL
, NULL
, 0 }, /* nhychar */
487 { roff_unsupp
, NULL
, NULL
, 0 }, /* nm */
488 { roff_unsupp
, NULL
, NULL
, 0 }, /* nn */
489 { roff_unsupp
, NULL
, NULL
, 0 }, /* nop */
490 { roff_nr
, NULL
, NULL
, 0 }, /* nr */
491 { roff_unsupp
, NULL
, NULL
, 0 }, /* nrf */
492 { roff_line_ignore
, NULL
, NULL
, 0 }, /* nroff */
493 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ns */
494 { roff_insec
, NULL
, NULL
, 0 }, /* nx */
495 { roff_insec
, NULL
, NULL
, 0 }, /* open */
496 { roff_insec
, NULL
, NULL
, 0 }, /* opena */
497 { roff_line_ignore
, NULL
, NULL
, 0 }, /* os */
498 { roff_unsupp
, NULL
, NULL
, 0 }, /* output */
499 { roff_line_ignore
, NULL
, NULL
, 0 }, /* padj */
500 { roff_line_ignore
, NULL
, NULL
, 0 }, /* papersize */
501 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pc */
502 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pev */
503 { roff_insec
, NULL
, NULL
, 0 }, /* pi */
504 { roff_unsupp
, NULL
, NULL
, 0 }, /* PI */
505 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pl */
506 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pm */
507 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pn */
508 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pnr */
509 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ps */
510 { roff_unsupp
, NULL
, NULL
, 0 }, /* psbb */
511 { roff_unsupp
, NULL
, NULL
, 0 }, /* pshape */
512 { roff_insec
, NULL
, NULL
, 0 }, /* pso */
513 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ptr */
514 { roff_line_ignore
, NULL
, NULL
, 0 }, /* pvs */
515 { roff_unsupp
, NULL
, NULL
, 0 }, /* rchar */
516 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rd */
517 { roff_line_ignore
, NULL
, NULL
, 0 }, /* recursionlimit */
518 { roff_unsupp
, NULL
, NULL
, 0 }, /* return */
519 { roff_unsupp
, NULL
, NULL
, 0 }, /* rfschar */
520 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rhang */
521 { roff_rm
, NULL
, NULL
, 0 }, /* rm */
522 { roff_rn
, NULL
, NULL
, 0 }, /* rn */
523 { roff_unsupp
, NULL
, NULL
, 0 }, /* rnn */
524 { roff_rr
, NULL
, NULL
, 0 }, /* rr */
525 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rs */
526 { roff_line_ignore
, NULL
, NULL
, 0 }, /* rt */
527 { roff_unsupp
, NULL
, NULL
, 0 }, /* schar */
528 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sentchar */
529 { roff_line_ignore
, NULL
, NULL
, 0 }, /* shc */
530 { roff_unsupp
, NULL
, NULL
, 0 }, /* shift */
531 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sizes */
532 { roff_so
, NULL
, NULL
, 0 }, /* so */
533 { roff_line_ignore
, NULL
, NULL
, 0 }, /* spacewidth */
534 { roff_line_ignore
, NULL
, NULL
, 0 }, /* special */
535 { roff_line_ignore
, NULL
, NULL
, 0 }, /* spreadwarn */
536 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ss */
537 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sty */
538 { roff_unsupp
, NULL
, NULL
, 0 }, /* substring */
539 { roff_line_ignore
, NULL
, NULL
, 0 }, /* sv */
540 { roff_insec
, NULL
, NULL
, 0 }, /* sy */
541 { roff_T_
, NULL
, NULL
, 0 }, /* T& */
542 { roff_unsupp
, NULL
, NULL
, 0 }, /* tc */
543 { roff_TE
, NULL
, NULL
, 0 }, /* TE */
544 { roff_Dd
, NULL
, NULL
, 0 }, /* TH */
545 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tkf */
546 { roff_unsupp
, NULL
, NULL
, 0 }, /* tl */
547 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tm */
548 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tm1 */
549 { roff_line_ignore
, NULL
, NULL
, 0 }, /* tmc */
550 { roff_tr
, NULL
, NULL
, 0 }, /* tr */
551 { roff_line_ignore
, NULL
, NULL
, 0 }, /* track */
552 { roff_line_ignore
, NULL
, NULL
, 0 }, /* transchar */
553 { roff_insec
, NULL
, NULL
, 0 }, /* trf */
554 { roff_line_ignore
, NULL
, NULL
, 0 }, /* trimat */
555 { roff_unsupp
, NULL
, NULL
, 0 }, /* trin */
556 { roff_unsupp
, NULL
, NULL
, 0 }, /* trnt */
557 { roff_line_ignore
, NULL
, NULL
, 0 }, /* troff */
558 { roff_TS
, NULL
, NULL
, 0 }, /* TS */
559 { roff_line_ignore
, NULL
, NULL
, 0 }, /* uf */
560 { roff_line_ignore
, NULL
, NULL
, 0 }, /* ul */
561 { roff_unsupp
, NULL
, NULL
, 0 }, /* unformat */
562 { roff_line_ignore
, NULL
, NULL
, 0 }, /* unwatch */
563 { roff_line_ignore
, NULL
, NULL
, 0 }, /* unwatchn */
564 { roff_line_ignore
, NULL
, NULL
, 0 }, /* vpt */
565 { roff_line_ignore
, NULL
, NULL
, 0 }, /* vs */
566 { roff_line_ignore
, NULL
, NULL
, 0 }, /* warn */
567 { roff_line_ignore
, NULL
, NULL
, 0 }, /* warnscale */
568 { roff_line_ignore
, NULL
, NULL
, 0 }, /* watch */
569 { roff_line_ignore
, NULL
, NULL
, 0 }, /* watchlength */
570 { roff_line_ignore
, NULL
, NULL
, 0 }, /* watchn */
571 { roff_unsupp
, NULL
, NULL
, 0 }, /* wh */
572 { roff_unsupp
, NULL
, NULL
, 0 }, /* while */
573 { roff_insec
, NULL
, NULL
, 0 }, /* write */
574 { roff_insec
, NULL
, NULL
, 0 }, /* writec */
575 { roff_insec
, NULL
, NULL
, 0 }, /* writem */
576 { roff_line_ignore
, NULL
, NULL
, 0 }, /* xflag */
577 { roff_cblock
, NULL
, NULL
, 0 }, /* . */
578 { roff_renamed
, NULL
, NULL
, 0 },
579 { roff_userdef
, NULL
, NULL
, 0 }
582 /* Array of injected predefined strings. */
583 #define PREDEFS_MAX 38
584 static const struct predef predefs
[PREDEFS_MAX
] = {
585 #include "predefs.in"
588 static int roffce_lines
; /* number of input lines to center */
589 static struct roff_node
*roffce_node
; /* active request */
590 static int roffit_lines
; /* number of lines to delay */
591 static char *roffit_macro
; /* nil-terminated macro line */
594 /* --- request table ------------------------------------------------------ */
597 roffhash_alloc(enum roff_tok mintok
, enum roff_tok maxtok
)
605 htab
= mandoc_malloc(sizeof(*htab
));
606 mandoc_ohash_init(htab
, 8, offsetof(struct roffreq
, name
));
608 for (tok
= mintok
; tok
< maxtok
; tok
++) {
609 if (roff_name
[tok
] == NULL
)
611 sz
= strlen(roff_name
[tok
]);
612 req
= mandoc_malloc(sizeof(*req
) + sz
+ 1);
614 memcpy(req
->name
, roff_name
[tok
], sz
+ 1);
615 slot
= ohash_qlookup(htab
, req
->name
);
616 ohash_insert(htab
, slot
, req
);
622 roffhash_free(struct ohash
*htab
)
629 for (req
= ohash_first(htab
, &slot
); req
!= NULL
;
630 req
= ohash_next(htab
, &slot
))
637 roffhash_find(struct ohash
*htab
, const char *name
, size_t sz
)
644 req
= ohash_find(htab
, ohash_qlookupi(htab
, name
, &end
));
646 req
= ohash_find(htab
, ohash_qlookup(htab
, name
));
647 return req
== NULL
? TOKEN_NONE
: req
->tok
;
650 /* --- stack of request blocks -------------------------------------------- */
653 * Pop the current node off of the stack of roff instructions currently
657 roffnode_pop(struct roff
*r
)
664 r
->last
= r
->last
->parent
;
671 * Push a roff node onto the instruction stack. This must later be
672 * removed with roffnode_pop().
675 roffnode_push(struct roff
*r
, enum roff_tok tok
, const char *name
,
680 p
= mandoc_calloc(1, sizeof(struct roffnode
));
683 p
->name
= mandoc_strdup(name
);
687 p
->rule
= p
->parent
? p
->parent
->rule
: 0;
692 /* --- roff parser state data management ---------------------------------- */
695 roff_free1(struct roff
*r
)
697 struct tbl_node
*tbl
;
700 while (NULL
!= (tbl
= r
->first_tbl
)) {
701 r
->first_tbl
= tbl
->next
;
704 r
->first_tbl
= r
->last_tbl
= r
->tbl
= NULL
;
706 if (r
->last_eqn
!= NULL
)
707 eqn_free(r
->last_eqn
);
708 r
->last_eqn
= r
->eqn
= NULL
;
718 roff_freereg(r
->regtab
);
721 roff_freestr(r
->strtab
);
722 roff_freestr(r
->rentab
);
723 roff_freestr(r
->xmbtab
);
724 r
->strtab
= r
->rentab
= r
->xmbtab
= NULL
;
727 for (i
= 0; i
< 128; i
++)
734 roff_reset(struct roff
*r
)
737 r
->format
= r
->options
& (MPARSE_MDOC
| MPARSE_MAN
);
747 roff_free(struct roff
*r
)
750 roffhash_free(r
->reqtab
);
755 roff_alloc(struct mparse
*parse
, int options
)
759 r
= mandoc_calloc(1, sizeof(struct roff
));
761 r
->reqtab
= roffhash_alloc(0, ROFF_USERDEF
);
762 r
->options
= options
;
763 r
->format
= options
& (MPARSE_MDOC
| MPARSE_MAN
);
769 /* --- syntax tree state data management ---------------------------------- */
772 roff_man_free1(struct roff_man
*man
)
775 if (man
->first
!= NULL
)
776 roff_node_delete(man
, man
->first
);
777 free(man
->meta
.msec
);
780 free(man
->meta
.arch
);
781 free(man
->meta
.title
);
782 free(man
->meta
.name
);
783 free(man
->meta
.date
);
787 roff_man_alloc1(struct roff_man
*man
)
790 memset(&man
->meta
, 0, sizeof(man
->meta
));
791 man
->first
= mandoc_calloc(1, sizeof(*man
->first
));
792 man
->first
->type
= ROFFT_ROOT
;
793 man
->last
= man
->first
;
796 man
->macroset
= MACROSET_NONE
;
797 man
->lastsec
= man
->lastnamed
= SEC_NONE
;
798 man
->next
= ROFF_NEXT_CHILD
;
802 roff_man_reset(struct roff_man
*man
)
806 roff_man_alloc1(man
);
810 roff_man_free(struct roff_man
*man
)
818 roff_man_alloc(struct roff
*roff
, struct mparse
*parse
,
819 const char *os_s
, int quick
)
821 struct roff_man
*man
;
823 man
= mandoc_calloc(1, sizeof(*man
));
828 roff_man_alloc1(man
);
833 /* --- syntax tree handling ----------------------------------------------- */
836 roff_node_alloc(struct roff_man
*man
, int line
, int pos
,
837 enum roff_type type
, int tok
)
841 n
= mandoc_calloc(1, sizeof(*n
));
846 n
->sec
= man
->lastsec
;
848 if (man
->flags
& MDOC_SYNOPSIS
)
849 n
->flags
|= NODE_SYNPRETTY
;
851 n
->flags
&= ~NODE_SYNPRETTY
;
852 if (man
->flags
& MDOC_NEWLINE
)
853 n
->flags
|= NODE_LINE
;
854 man
->flags
&= ~MDOC_NEWLINE
;
860 roff_node_append(struct roff_man
*man
, struct roff_node
*n
)
864 case ROFF_NEXT_SIBLING
:
865 if (man
->last
->next
!= NULL
) {
866 n
->next
= man
->last
->next
;
867 man
->last
->next
->prev
= n
;
869 man
->last
->parent
->last
= n
;
872 n
->parent
= man
->last
->parent
;
874 case ROFF_NEXT_CHILD
:
875 if (man
->last
->child
!= NULL
) {
876 n
->next
= man
->last
->child
;
877 man
->last
->child
->prev
= n
;
880 man
->last
->child
= n
;
881 n
->parent
= man
->last
;
893 if (n
->end
!= ENDBODY_NOT
)
905 * Copy over the normalised-data pointer of our parent. Not
906 * everybody has one, but copying a null pointer is fine.
909 n
->norm
= n
->parent
->norm
;
910 assert(n
->parent
->type
== ROFFT_BLOCK
);
914 roff_word_alloc(struct roff_man
*man
, int line
, int pos
, const char *word
)
918 n
= roff_node_alloc(man
, line
, pos
, ROFFT_TEXT
, TOKEN_NONE
);
919 n
->string
= roff_strdup(man
->roff
, word
);
920 roff_node_append(man
, n
);
921 n
->flags
|= NODE_VALID
| NODE_ENDED
;
922 man
->next
= ROFF_NEXT_SIBLING
;
926 roff_word_append(struct roff_man
*man
, const char *word
)
929 char *addstr
, *newstr
;
932 addstr
= roff_strdup(man
->roff
, word
);
933 mandoc_asprintf(&newstr
, "%s %s", n
->string
, addstr
);
937 man
->next
= ROFF_NEXT_SIBLING
;
941 roff_elem_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
945 n
= roff_node_alloc(man
, line
, pos
, ROFFT_ELEM
, tok
);
946 roff_node_append(man
, n
);
947 man
->next
= ROFF_NEXT_CHILD
;
951 roff_block_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
955 n
= roff_node_alloc(man
, line
, pos
, ROFFT_BLOCK
, tok
);
956 roff_node_append(man
, n
);
957 man
->next
= ROFF_NEXT_CHILD
;
962 roff_head_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
966 n
= roff_node_alloc(man
, line
, pos
, ROFFT_HEAD
, tok
);
967 roff_node_append(man
, n
);
968 man
->next
= ROFF_NEXT_CHILD
;
973 roff_body_alloc(struct roff_man
*man
, int line
, int pos
, int tok
)
977 n
= roff_node_alloc(man
, line
, pos
, ROFFT_BODY
, tok
);
978 roff_node_append(man
, n
);
979 man
->next
= ROFF_NEXT_CHILD
;
984 roff_addtbl(struct roff_man
*man
, struct tbl_node
*tbl
)
987 const struct tbl_span
*span
;
989 if (man
->macroset
== MACROSET_MAN
)
990 man_breakscope(man
, ROFF_TS
);
991 while ((span
= tbl_span(tbl
)) != NULL
) {
992 n
= roff_node_alloc(man
, tbl
->line
, 0, ROFFT_TBL
, TOKEN_NONE
);
994 roff_node_append(man
, n
);
995 n
->flags
|= NODE_VALID
| NODE_ENDED
;
996 man
->next
= ROFF_NEXT_SIBLING
;
1001 roff_node_unlink(struct roff_man
*man
, struct roff_node
*n
)
1004 /* Adjust siblings. */
1007 n
->prev
->next
= n
->next
;
1009 n
->next
->prev
= n
->prev
;
1011 /* Adjust parent. */
1013 if (n
->parent
!= NULL
) {
1014 if (n
->parent
->child
== n
)
1015 n
->parent
->child
= n
->next
;
1016 if (n
->parent
->last
== n
)
1017 n
->parent
->last
= n
->prev
;
1020 /* Adjust parse point. */
1024 if (man
->last
== n
) {
1025 if (n
->prev
== NULL
) {
1026 man
->last
= n
->parent
;
1027 man
->next
= ROFF_NEXT_CHILD
;
1029 man
->last
= n
->prev
;
1030 man
->next
= ROFF_NEXT_SIBLING
;
1033 if (man
->first
== n
)
1038 roff_node_free(struct roff_node
*n
)
1041 if (n
->args
!= NULL
)
1042 mdoc_argv_free(n
->args
);
1043 if (n
->type
== ROFFT_BLOCK
|| n
->type
== ROFFT_ELEM
)
1046 eqn_box_free(n
->eqn
);
1052 roff_node_delete(struct roff_man
*man
, struct roff_node
*n
)
1055 while (n
->child
!= NULL
)
1056 roff_node_delete(man
, n
->child
);
1057 roff_node_unlink(man
, n
);
1062 deroff(char **dest
, const struct roff_node
*n
)
1067 if (n
->type
!= ROFFT_TEXT
) {
1068 for (n
= n
->child
; n
!= NULL
; n
= n
->next
)
1073 /* Skip leading whitespace. */
1075 for (cp
= n
->string
; *cp
!= '\0'; cp
++) {
1076 if (cp
[0] == '\\' && cp
[1] != '\0' &&
1077 strchr(" %&0^|~", cp
[1]) != NULL
)
1079 else if ( ! isspace((unsigned char)*cp
))
1083 /* Skip trailing backslash. */
1086 if (sz
> 0 && cp
[sz
- 1] == '\\')
1089 /* Skip trailing whitespace. */
1092 if ( ! isspace((unsigned char)cp
[sz
-1]))
1095 /* Skip empty strings. */
1100 if (*dest
== NULL
) {
1101 *dest
= mandoc_strndup(cp
, sz
);
1105 mandoc_asprintf(&cp
, "%s %*s", *dest
, (int)sz
, cp
);
1110 /* --- main functions of the roff parser ---------------------------------- */
1113 * In the current line, expand escape sequences that tend to get
1114 * used in numerical expressions and conditional requests.
1115 * Also check the syntax of the remaining escape sequences.
1118 roff_res(struct roff
*r
, struct buf
*buf
, int ln
, int pos
)
1120 char ubuf
[24]; /* buffer to print the number */
1121 const char *start
; /* start of the string to process */
1122 char *stesc
; /* start of an escape sequence ('\\') */
1123 const char *stnam
; /* start of the name, after "[(*" */
1124 const char *cp
; /* end of the name, e.g. before ']' */
1125 const char *res
; /* the string to be substituted */
1126 char *nbuf
; /* new buffer to copy buf->buf to */
1127 size_t maxl
; /* expected length of the escape name */
1128 size_t naml
; /* actual length of the escape name */
1129 enum mandoc_esc esc
; /* type of the escape sequence */
1130 int inaml
; /* length returned from mandoc_escape() */
1131 int expand_count
; /* to avoid infinite loops */
1132 int npos
; /* position in numeric expression */
1133 int arg_complete
; /* argument not interrupted by eol */
1134 int done
; /* no more input available */
1135 int deftype
; /* type of definition to paste */
1136 int rcsid
; /* kind of RCS id seen */
1137 char term
; /* character terminating the escape */
1139 /* Search forward for comments. */
1142 start
= buf
->buf
+ pos
;
1143 for (stesc
= buf
->buf
+ pos
; *stesc
!= '\0'; stesc
++) {
1144 if (stesc
[0] != r
->escape
|| stesc
[1] == '\0')
1147 if (*stesc
!= '"' && *stesc
!= '#')
1150 /* Comment found, look for RCS id. */
1153 if ((cp
= strstr(stesc
, "$" "OpenBSD")) != NULL
) {
1154 rcsid
= 1 << MANDOC_OS_OPENBSD
;
1156 } else if ((cp
= strstr(stesc
, "$" "NetBSD")) != NULL
) {
1157 rcsid
= 1 << MANDOC_OS_NETBSD
;
1161 isalnum((unsigned char)*cp
) == 0 &&
1162 strchr(cp
, '$') != NULL
) {
1163 if (r
->man
->meta
.rcsids
& rcsid
)
1164 mandoc_msg(MANDOCERR_RCS_REP
, r
->parse
,
1165 ln
, stesc
+ 1 - buf
->buf
, stesc
+ 1);
1166 r
->man
->meta
.rcsids
|= rcsid
;
1169 /* Handle trailing whitespace. */
1171 cp
= strchr(stesc
--, '\0') - 1;
1176 if (*cp
== ' ' || *cp
== '\t')
1177 mandoc_msg(MANDOCERR_SPACE_EOL
, r
->parse
,
1178 ln
, cp
- buf
->buf
, NULL
);
1179 while (stesc
> start
&& stesc
[-1] == ' ')
1188 /* Notice the end of the input. */
1190 if (*stesc
== '\n') {
1196 while (stesc
>= start
) {
1198 /* Search backwards for the next backslash. */
1200 if (*stesc
!= r
->escape
) {
1201 if (*stesc
== '\\') {
1203 buf
->sz
= mandoc_asprintf(&nbuf
, "%s\\e%s",
1204 buf
->buf
, stesc
+ 1) + 1;
1206 stesc
= nbuf
+ (stesc
- buf
->buf
);
1214 /* If it is escaped, skip it. */
1216 for (cp
= stesc
- 1; cp
>= start
; cp
--)
1217 if (*cp
!= r
->escape
)
1220 if ((stesc
- cp
) % 2 == 0) {
1224 } else if (stesc
[1] != '\0') {
1234 /* Decide whether to expand or to check only. */
1250 esc
= mandoc_escape(&cp
, &stnam
, &inaml
);
1251 if (esc
== ESCAPE_ERROR
||
1252 (esc
== ESCAPE_SPECIAL
&&
1253 mchars_spec2cp(stnam
, inaml
) < 0))
1254 mandoc_vmsg(MANDOCERR_ESC_BAD
,
1255 r
->parse
, ln
, (int)(stesc
- buf
->buf
),
1256 "%.*s", (int)(cp
- stesc
), stesc
);
1261 if (EXPAND_LIMIT
< ++expand_count
) {
1262 mandoc_msg(MANDOCERR_ROFFLOOP
, r
->parse
,
1263 ln
, (int)(stesc
- buf
->buf
), NULL
);
1268 * The third character decides the length
1269 * of the name of the string or register.
1270 * Save a pointer to the name.
1297 /* Advance to the end of the name. */
1301 while (maxl
== 0 || naml
< maxl
) {
1303 mandoc_msg(MANDOCERR_ESC_BAD
, r
->parse
,
1304 ln
, (int)(stesc
- buf
->buf
), stesc
);
1308 if (maxl
== 0 && *cp
== term
) {
1312 if (*cp
++ != '\\' || stesc
[1] != 'w') {
1316 switch (mandoc_escape(&cp
, NULL
, NULL
)) {
1317 case ESCAPE_SPECIAL
:
1318 case ESCAPE_UNICODE
:
1319 case ESCAPE_NUMBERED
:
1320 case ESCAPE_OVERSTRIKE
:
1329 * Retrieve the replacement string; if it is
1330 * undefined, resume searching for escapes.
1336 deftype
= ROFFDEF_USER
| ROFFDEF_PRE
;
1337 res
= roff_getstrn(r
, stnam
, naml
, &deftype
);
1342 ubuf
[0] = arg_complete
&&
1343 roff_evalnum(r
, ln
, stnam
, &npos
,
1344 NULL
, ROFFNUM_SCALE
) &&
1345 stnam
+ npos
+ 1 == cp
? '1' : '0';
1350 (void)snprintf(ubuf
, sizeof(ubuf
), "%d",
1351 roff_getregn(r
, stnam
, naml
));
1356 /* use even incomplete args */
1357 (void)snprintf(ubuf
, sizeof(ubuf
), "%d",
1363 mandoc_vmsg(MANDOCERR_STR_UNDEF
,
1364 r
->parse
, ln
, (int)(stesc
- buf
->buf
),
1365 "%.*s", (int)naml
, stnam
);
1367 } else if (buf
->sz
+ strlen(res
) > SHRT_MAX
) {
1368 mandoc_msg(MANDOCERR_ROFFLOOP
, r
->parse
,
1369 ln
, (int)(stesc
- buf
->buf
), NULL
);
1373 /* Replace the escape sequence by the string. */
1376 buf
->sz
= mandoc_asprintf(&nbuf
, "%s%s%s",
1377 buf
->buf
, res
, cp
) + 1;
1379 /* Prepare for the next replacement. */
1382 stesc
= nbuf
+ (stesc
- buf
->buf
) + strlen(res
);
1390 * Process text streams.
1393 roff_parsetext(struct roff
*r
, struct buf
*buf
, int pos
, int *offs
)
1399 enum mandoc_esc esc
;
1401 /* Spring the input line trap. */
1403 if (roffit_lines
== 1) {
1404 isz
= mandoc_asprintf(&p
, "%s\n.%s", buf
->buf
, roffit_macro
);
1411 return ROFF_REPARSE
;
1412 } else if (roffit_lines
> 1)
1415 if (roffce_node
!= NULL
&& buf
->buf
[pos
] != '\0') {
1416 if (roffce_lines
< 1) {
1417 r
->man
->last
= roffce_node
;
1418 r
->man
->next
= ROFF_NEXT_SIBLING
;
1425 /* Convert all breakable hyphens into ASCII_HYPH. */
1427 start
= p
= buf
->buf
+ pos
;
1429 while (*p
!= '\0') {
1430 sz
= strcspn(p
, "-\\");
1437 /* Skip over escapes. */
1439 esc
= mandoc_escape((const char **)&p
, NULL
, NULL
);
1440 if (esc
== ESCAPE_ERROR
)
1445 } else if (p
== start
) {
1450 if (isalpha((unsigned char)p
[-1]) &&
1451 isalpha((unsigned char)p
[1]))
1459 roff_parseln(struct roff
*r
, int ln
, struct buf
*buf
, int *offs
)
1463 int pos
; /* parse point */
1464 int spos
; /* saved parse point for messages */
1465 int ppos
; /* original offset in buf->buf */
1466 int ctl
; /* macro line (boolean) */
1470 /* Handle in-line equation delimiters. */
1472 if (r
->tbl
== NULL
&&
1473 r
->last_eqn
!= NULL
&& r
->last_eqn
->delim
&&
1474 (r
->eqn
== NULL
|| r
->eqn_inline
)) {
1475 e
= roff_eqndelim(r
, buf
, pos
);
1476 if (e
== ROFF_REPARSE
)
1478 assert(e
== ROFF_CONT
);
1481 /* Expand some escape sequences. */
1483 e
= roff_res(r
, buf
, ln
, pos
);
1484 if (e
== ROFF_IGN
|| e
== ROFF_APPEND
)
1486 assert(e
== ROFF_CONT
);
1488 ctl
= roff_getcontrol(r
, buf
->buf
, &pos
);
1491 * First, if a scope is open and we're not a macro, pass the
1492 * text through the macro's filter.
1493 * Equations process all content themselves.
1494 * Tables process almost all content themselves, but we want
1495 * to warn about macros before passing it there.
1498 if (r
->last
!= NULL
&& ! ctl
) {
1500 e
= (*roffs
[t
].text
)(r
, t
, buf
, ln
, pos
, pos
, offs
);
1503 assert(e
== ROFF_CONT
);
1505 if (r
->eqn
!= NULL
&& strncmp(buf
->buf
+ ppos
, ".EN", 3)) {
1506 eqn_read(r
->eqn
, buf
->buf
+ ppos
);
1509 if (r
->tbl
!= NULL
&& (ctl
== 0 || buf
->buf
[pos
] == '\0')) {
1510 tbl_read(r
->tbl
, ln
, buf
->buf
, ppos
);
1511 roff_addtbl(r
->man
, r
->tbl
);
1515 return roff_parsetext(r
, buf
, pos
, offs
);
1517 /* Skip empty request lines. */
1519 if (buf
->buf
[pos
] == '"') {
1520 mandoc_msg(MANDOCERR_COMMENT_BAD
, r
->parse
,
1523 } else if (buf
->buf
[pos
] == '\0')
1527 * If a scope is open, go to the child handler for that macro,
1528 * as it may want to preprocess before doing anything with it.
1529 * Don't do so if an equation is open.
1534 return (*roffs
[t
].sub
)(r
, t
, buf
, ln
, ppos
, pos
, offs
);
1537 /* No scope is open. This is a new request or macro. */
1540 t
= roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
);
1542 /* Tables ignore most macros. */
1544 if (r
->tbl
!= NULL
&& (t
== TOKEN_NONE
|| t
== ROFF_TS
||
1545 t
== ROFF_br
|| t
== ROFF_ce
|| t
== ROFF_rj
|| t
== ROFF_sp
)) {
1546 mandoc_msg(MANDOCERR_TBLMACRO
, r
->parse
,
1547 ln
, pos
, buf
->buf
+ spos
);
1548 if (t
!= TOKEN_NONE
)
1550 while (buf
->buf
[pos
] != '\0' && buf
->buf
[pos
] != ' ')
1552 while (buf
->buf
[pos
] == ' ')
1554 tbl_read(r
->tbl
, ln
, buf
->buf
, pos
);
1555 roff_addtbl(r
->man
, r
->tbl
);
1559 /* For now, let high level macros abort .ce mode. */
1561 if (ctl
&& roffce_node
!= NULL
&&
1562 (t
== TOKEN_NONE
|| t
== ROFF_Dd
|| t
== ROFF_EQ
||
1563 t
== ROFF_TH
|| t
== ROFF_TS
)) {
1564 r
->man
->last
= roffce_node
;
1565 r
->man
->next
= ROFF_NEXT_SIBLING
;
1571 * This is neither a roff request nor a user-defined macro.
1572 * Let the standard macro set parsers handle it.
1575 if (t
== TOKEN_NONE
)
1578 /* Execute a roff request or a user defined macro. */
1580 return (*roffs
[t
].proc
)(r
, t
, buf
, ln
, spos
, pos
, offs
);
1584 roff_endparse(struct roff
*r
)
1586 if (r
->last
!= NULL
)
1587 mandoc_msg(MANDOCERR_BLK_NOEND
, r
->parse
,
1588 r
->last
->line
, r
->last
->col
,
1589 roff_name
[r
->last
->tok
]);
1591 if (r
->eqn
!= NULL
) {
1592 mandoc_msg(MANDOCERR_BLK_NOEND
, r
->parse
,
1593 r
->eqn
->node
->line
, r
->eqn
->node
->pos
, "EQ");
1598 if (r
->tbl
!= NULL
) {
1599 mandoc_msg(MANDOCERR_BLK_NOEND
, r
->parse
,
1600 r
->tbl
->line
, r
->tbl
->pos
, "TS");
1607 * Parse a roff node's type from the input buffer. This must be in the
1608 * form of ".foo xxx" in the usual way.
1610 static enum roff_tok
1611 roff_parse(struct roff
*r
, char *buf
, int *pos
, int ln
, int ppos
)
1621 if ('\0' == *cp
|| '"' == *cp
|| '\t' == *cp
|| ' ' == *cp
)
1625 maclen
= roff_getname(r
, &cp
, ln
, ppos
);
1627 deftype
= ROFFDEF_USER
| ROFFDEF_REN
;
1628 r
->current_string
= roff_getstrn(r
, mac
, maclen
, &deftype
);
1637 t
= roffhash_find(r
->reqtab
, mac
, maclen
);
1640 if (t
!= TOKEN_NONE
)
1645 /* --- handling of request blocks ----------------------------------------- */
1648 roff_cblock(ROFF_ARGS
)
1652 * A block-close `..' should only be invoked as a child of an
1653 * ignore macro, otherwise raise a warning and just ignore it.
1656 if (r
->last
== NULL
) {
1657 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
1662 switch (r
->last
->tok
) {
1664 /* ROFF_am1 is remapped to ROFF_am in roff_block(). */
1667 /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
1672 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
1677 if (buf
->buf
[pos
] != '\0')
1678 mandoc_vmsg(MANDOCERR_ARG_SKIP
, r
->parse
, ln
, pos
,
1679 ".. %s", buf
->buf
+ pos
);
1682 roffnode_cleanscope(r
);
1688 roffnode_cleanscope(struct roff
*r
)
1692 if (--r
->last
->endspan
!= 0)
1699 roff_ccond(struct roff
*r
, int ln
, int ppos
)
1702 if (NULL
== r
->last
) {
1703 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
1708 switch (r
->last
->tok
) {
1714 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
1719 if (r
->last
->endspan
> -1) {
1720 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
1726 roffnode_cleanscope(r
);
1731 roff_block(ROFF_ARGS
)
1733 const char *name
, *value
;
1734 char *call
, *cp
, *iname
, *rname
;
1735 size_t csz
, namesz
, rsz
;
1738 /* Ignore groff compatibility mode for now. */
1740 if (tok
== ROFF_de1
)
1742 else if (tok
== ROFF_dei1
)
1744 else if (tok
== ROFF_am1
)
1746 else if (tok
== ROFF_ami1
)
1749 /* Parse the macro name argument. */
1751 cp
= buf
->buf
+ pos
;
1752 if (tok
== ROFF_ig
) {
1757 namesz
= roff_getname(r
, &cp
, ln
, ppos
);
1758 iname
[namesz
] = '\0';
1761 /* Resolve the macro name argument if it is indirect. */
1763 if (namesz
&& (tok
== ROFF_dei
|| tok
== ROFF_ami
)) {
1764 deftype
= ROFFDEF_USER
;
1765 name
= roff_getstrn(r
, iname
, namesz
, &deftype
);
1767 mandoc_vmsg(MANDOCERR_STR_UNDEF
,
1768 r
->parse
, ln
, (int)(iname
- buf
->buf
),
1769 "%.*s", (int)namesz
, iname
);
1772 namesz
= strlen(name
);
1776 if (namesz
== 0 && tok
!= ROFF_ig
) {
1777 mandoc_msg(MANDOCERR_REQ_EMPTY
, r
->parse
,
1778 ln
, ppos
, roff_name
[tok
]);
1782 roffnode_push(r
, tok
, name
, ln
, ppos
);
1785 * At the beginning of a `de' macro, clear the existing string
1786 * with the same name, if there is one. New content will be
1787 * appended from roff_block_text() in multiline mode.
1790 if (tok
== ROFF_de
|| tok
== ROFF_dei
) {
1791 roff_setstrn(&r
->strtab
, name
, namesz
, "", 0, 0);
1792 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
1793 } else if (tok
== ROFF_am
|| tok
== ROFF_ami
) {
1794 deftype
= ROFFDEF_ANY
;
1795 value
= roff_getstrn(r
, iname
, namesz
, &deftype
);
1796 switch (deftype
) { /* Before appending, ... */
1797 case ROFFDEF_PRE
: /* copy predefined to user-defined. */
1798 roff_setstrn(&r
->strtab
, name
, namesz
,
1799 value
, strlen(value
), 0);
1801 case ROFFDEF_REN
: /* call original standard macro. */
1802 csz
= mandoc_asprintf(&call
, ".%.*s \\$* \\\"\n",
1803 (int)strlen(value
), value
);
1804 roff_setstrn(&r
->strtab
, name
, namesz
, call
, csz
, 0);
1805 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
1808 case ROFFDEF_STD
: /* rename and call standard macro. */
1809 rsz
= mandoc_asprintf(&rname
, "__%s_renamed", name
);
1810 roff_setstrn(&r
->rentab
, rname
, rsz
, name
, namesz
, 0);
1811 csz
= mandoc_asprintf(&call
, ".%.*s \\$* \\\"\n",
1813 roff_setstrn(&r
->strtab
, name
, namesz
, call
, csz
, 0);
1825 /* Get the custom end marker. */
1828 namesz
= roff_getname(r
, &cp
, ln
, ppos
);
1830 /* Resolve the end marker if it is indirect. */
1832 if (namesz
&& (tok
== ROFF_dei
|| tok
== ROFF_ami
)) {
1833 deftype
= ROFFDEF_USER
;
1834 name
= roff_getstrn(r
, iname
, namesz
, &deftype
);
1836 mandoc_vmsg(MANDOCERR_STR_UNDEF
,
1837 r
->parse
, ln
, (int)(iname
- buf
->buf
),
1838 "%.*s", (int)namesz
, iname
);
1841 namesz
= strlen(name
);
1846 r
->last
->end
= mandoc_strndup(name
, namesz
);
1849 mandoc_vmsg(MANDOCERR_ARG_EXCESS
, r
->parse
,
1850 ln
, pos
, ".%s ... %s", roff_name
[tok
], cp
);
1856 roff_block_sub(ROFF_ARGS
)
1862 * First check whether a custom macro exists at this level. If
1863 * it does, then check against it. This is some of groff's
1864 * stranger behaviours. If we encountered a custom end-scope
1865 * tag and that tag also happens to be a "real" macro, then we
1866 * need to try interpreting it again as a real macro. If it's
1867 * not, then return ignore. Else continue.
1871 for (i
= pos
, j
= 0; r
->last
->end
[j
]; j
++, i
++)
1872 if (buf
->buf
[i
] != r
->last
->end
[j
])
1875 if (r
->last
->end
[j
] == '\0' &&
1876 (buf
->buf
[i
] == '\0' ||
1877 buf
->buf
[i
] == ' ' ||
1878 buf
->buf
[i
] == '\t')) {
1880 roffnode_cleanscope(r
);
1882 while (buf
->buf
[i
] == ' ' || buf
->buf
[i
] == '\t')
1886 if (roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
) !=
1894 * If we have no custom end-query or lookup failed, then try
1895 * pulling it out of the hashtable.
1898 t
= roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
);
1900 if (t
!= ROFF_cblock
) {
1902 roff_setstr(r
, r
->last
->name
, buf
->buf
+ ppos
, 2);
1906 return (*roffs
[t
].proc
)(r
, t
, buf
, ln
, ppos
, pos
, offs
);
1910 roff_block_text(ROFF_ARGS
)
1914 roff_setstr(r
, r
->last
->name
, buf
->buf
+ pos
, 2);
1920 roff_cond_sub(ROFF_ARGS
)
1927 roffnode_cleanscope(r
);
1930 * If `\}' occurs on a macro line without a preceding macro,
1931 * drop the line completely.
1934 ep
= buf
->buf
+ pos
;
1935 if (ep
[0] == '\\' && ep
[1] == '}')
1938 /* Always check for the closing delimiter `\}'. */
1940 while ((ep
= strchr(ep
, '\\')) != NULL
) {
1943 memmove(ep
, ep
+ 2, strlen(ep
+ 2) + 1);
1944 roff_ccond(r
, ln
, ep
- buf
->buf
);
1956 * Fully handle known macros when they are structurally
1957 * required or when the conditional evaluated to true.
1960 t
= roff_parse(r
, buf
->buf
, &pos
, ln
, ppos
);
1961 return t
!= TOKEN_NONE
&& (rr
|| roffs
[t
].flags
& ROFFMAC_STRUCT
)
1962 ? (*roffs
[t
].proc
)(r
, t
, buf
, ln
, ppos
, pos
, offs
) : rr
1963 ? ROFF_CONT
: ROFF_IGN
;
1967 roff_cond_text(ROFF_ARGS
)
1973 roffnode_cleanscope(r
);
1975 ep
= buf
->buf
+ pos
;
1976 while ((ep
= strchr(ep
, '\\')) != NULL
) {
1977 if (*(++ep
) == '}') {
1979 roff_ccond(r
, ln
, ep
- buf
->buf
- 1);
1984 return rr
? ROFF_CONT
: ROFF_IGN
;
1987 /* --- handling of numeric and conditional expressions -------------------- */
1990 * Parse a single signed integer number. Stop at the first non-digit.
1991 * If there is at least one digit, return success and advance the
1992 * parse point, else return failure and let the parse point unchanged.
1993 * Ignore overflows, treat them just like the C language.
1996 roff_getnum(const char *v
, int *pos
, int *res
, int flags
)
1998 int myres
, scaled
, n
, p
;
2005 if (n
|| v
[p
] == '+')
2008 if (flags
& ROFFNUM_WHITE
)
2009 while (isspace((unsigned char)v
[p
]))
2012 for (*res
= 0; isdigit((unsigned char)v
[p
]); p
++)
2013 *res
= 10 * *res
+ v
[p
] - '0';
2020 /* Each number may be followed by one optional scaling unit. */
2024 scaled
= *res
* 65536;
2027 scaled
= *res
* 240;
2030 scaled
= *res
* 240 / 2.54;
2041 scaled
= *res
* 10 / 3;
2047 scaled
= *res
* 6 / 25;
2054 if (flags
& ROFFNUM_SCALE
)
2062 * Evaluate a string comparison condition.
2063 * The first character is the delimiter.
2064 * Succeed if the string up to its second occurrence
2065 * matches the string up to its third occurence.
2066 * Advance the cursor after the third occurrence
2067 * or lacking that, to the end of the line.
2070 roff_evalstrcond(const char *v
, int *pos
)
2072 const char *s1
, *s2
, *s3
;
2076 s1
= v
+ *pos
; /* initial delimiter */
2077 s2
= s1
+ 1; /* for scanning the first string */
2078 s3
= strchr(s2
, *s1
); /* for scanning the second string */
2080 if (NULL
== s3
) /* found no middle delimiter */
2083 while ('\0' != *++s3
) {
2084 if (*s2
!= *s3
) { /* mismatch */
2085 s3
= strchr(s3
, *s1
);
2088 if (*s3
== *s1
) { /* found the final delimiter */
2097 s3
= strchr(s2
, '\0');
2098 else if (*s3
!= '\0')
2105 * Evaluate an optionally negated single character, numerical,
2106 * or string condition.
2109 roff_evalcond(struct roff
*r
, int ln
, char *v
, int *pos
)
2113 int deftype
, number
, savepos
, istrue
, wanttrue
;
2115 if ('!' == v
[*pos
]) {
2140 sz
= roff_getname(r
, &cp
, ln
, cp
- v
);
2143 else if (v
[*pos
] == 'r')
2144 istrue
= roff_hasregn(r
, name
, sz
);
2146 deftype
= ROFFDEF_ANY
;
2147 roff_getstrn(r
, name
, sz
, &deftype
);
2151 return istrue
== wanttrue
;
2157 if (roff_evalnum(r
, ln
, v
, pos
, &number
, ROFFNUM_SCALE
))
2158 return (number
> 0) == wanttrue
;
2159 else if (*pos
== savepos
)
2160 return roff_evalstrcond(v
, pos
) == wanttrue
;
2166 roff_line_ignore(ROFF_ARGS
)
2173 roff_insec(ROFF_ARGS
)
2176 mandoc_msg(MANDOCERR_REQ_INSEC
, r
->parse
,
2177 ln
, ppos
, roff_name
[tok
]);
2182 roff_unsupp(ROFF_ARGS
)
2185 mandoc_msg(MANDOCERR_REQ_UNSUPP
, r
->parse
,
2186 ln
, ppos
, roff_name
[tok
]);
2191 roff_cond(ROFF_ARGS
)
2194 roffnode_push(r
, tok
, NULL
, ln
, ppos
);
2197 * An `.el' has no conditional body: it will consume the value
2198 * of the current rstack entry set in prior `ie' calls or
2201 * If we're not an `el', however, then evaluate the conditional.
2204 r
->last
->rule
= tok
== ROFF_el
?
2205 (r
->rstackpos
< 0 ? 0 : r
->rstack
[r
->rstackpos
--]) :
2206 roff_evalcond(r
, ln
, buf
->buf
, &pos
);
2209 * An if-else will put the NEGATION of the current evaluated
2210 * conditional into the stack of rules.
2213 if (tok
== ROFF_ie
) {
2214 if (r
->rstackpos
+ 1 == r
->rstacksz
) {
2216 r
->rstack
= mandoc_reallocarray(r
->rstack
,
2217 r
->rstacksz
, sizeof(int));
2219 r
->rstack
[++r
->rstackpos
] = !r
->last
->rule
;
2222 /* If the parent has false as its rule, then so do we. */
2224 if (r
->last
->parent
&& !r
->last
->parent
->rule
)
2229 * If there is nothing on the line after the conditional,
2230 * not even whitespace, use next-line scope.
2233 if (buf
->buf
[pos
] == '\0') {
2234 r
->last
->endspan
= 2;
2238 while (buf
->buf
[pos
] == ' ')
2241 /* An opening brace requests multiline scope. */
2243 if (buf
->buf
[pos
] == '\\' && buf
->buf
[pos
+ 1] == '{') {
2244 r
->last
->endspan
= -1;
2246 while (buf
->buf
[pos
] == ' ')
2252 * Anything else following the conditional causes
2253 * single-line scope. Warn if the scope contains
2254 * nothing but trailing whitespace.
2257 if (buf
->buf
[pos
] == '\0')
2258 mandoc_msg(MANDOCERR_COND_EMPTY
, r
->parse
,
2259 ln
, ppos
, roff_name
[tok
]);
2261 r
->last
->endspan
= 1;
2275 /* Ignore groff compatibility mode for now. */
2277 if (tok
== ROFF_ds1
)
2279 else if (tok
== ROFF_as1
)
2283 * The first word is the name of the string.
2284 * If it is empty or terminated by an escape sequence,
2285 * abort the `ds' request without defining anything.
2288 name
= string
= buf
->buf
+ pos
;
2292 namesz
= roff_getname(r
, &string
, ln
, pos
);
2293 if (name
[namesz
] == '\\')
2296 /* Read past the initial double-quote, if any. */
2300 /* The rest is the value. */
2301 roff_setstrn(&r
->strtab
, name
, namesz
, string
, strlen(string
),
2303 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
2308 * Parse a single operator, one or two characters long.
2309 * If the operator is recognized, return success and advance the
2310 * parse point, else return failure and let the parse point unchanged.
2313 roff_getop(const char *v
, int *pos
, char *res
)
2328 switch (v
[*pos
+ 1]) {
2346 switch (v
[*pos
+ 1]) {
2360 if ('=' == v
[*pos
+ 1])
2372 * Evaluate either a parenthesized numeric expression
2373 * or a single signed integer number.
2376 roff_evalpar(struct roff
*r
, int ln
,
2377 const char *v
, int *pos
, int *res
, int flags
)
2381 return roff_getnum(v
, pos
, res
, flags
);
2384 if ( ! roff_evalnum(r
, ln
, v
, pos
, res
, flags
| ROFFNUM_WHITE
))
2388 * Omission of the closing parenthesis
2389 * is an error in validation mode,
2390 * but ignored in evaluation mode.
2395 else if (NULL
== res
)
2402 * Evaluate a complete numeric expression.
2403 * Proceed left to right, there is no concept of precedence.
2406 roff_evalnum(struct roff
*r
, int ln
, const char *v
,
2407 int *pos
, int *res
, int flags
)
2409 int mypos
, operand2
;
2417 if (flags
& ROFFNUM_WHITE
)
2418 while (isspace((unsigned char)v
[*pos
]))
2421 if ( ! roff_evalpar(r
, ln
, v
, pos
, res
, flags
))
2425 if (flags
& ROFFNUM_WHITE
)
2426 while (isspace((unsigned char)v
[*pos
]))
2429 if ( ! roff_getop(v
, pos
, &operator))
2432 if (flags
& ROFFNUM_WHITE
)
2433 while (isspace((unsigned char)v
[*pos
]))
2436 if ( ! roff_evalpar(r
, ln
, v
, pos
, &operand2
, flags
))
2439 if (flags
& ROFFNUM_WHITE
)
2440 while (isspace((unsigned char)v
[*pos
]))
2457 if (operand2
== 0) {
2458 mandoc_msg(MANDOCERR_DIVZERO
,
2459 r
->parse
, ln
, *pos
, v
);
2466 if (operand2
== 0) {
2467 mandoc_msg(MANDOCERR_DIVZERO
,
2468 r
->parse
, ln
, *pos
, v
);
2475 *res
= *res
< operand2
;
2478 *res
= *res
> operand2
;
2481 *res
= *res
<= operand2
;
2484 *res
= *res
>= operand2
;
2487 *res
= *res
== operand2
;
2490 *res
= *res
!= operand2
;
2493 *res
= *res
&& operand2
;
2496 *res
= *res
|| operand2
;
2499 if (operand2
< *res
)
2503 if (operand2
> *res
)
2513 /* --- register management ------------------------------------------------ */
2516 roff_setreg(struct roff
*r
, const char *name
, int val
, char sign
)
2518 struct roffreg
*reg
;
2520 /* Search for an existing register with the same name. */
2523 while (reg
&& strcmp(name
, reg
->key
.p
))
2527 /* Create a new register. */
2528 reg
= mandoc_malloc(sizeof(struct roffreg
));
2529 reg
->key
.p
= mandoc_strdup(name
);
2530 reg
->key
.sz
= strlen(name
);
2532 reg
->next
= r
->regtab
;
2538 else if ('-' == sign
)
2545 * Handle some predefined read-only number registers.
2546 * For now, return -1 if the requested register is not predefined;
2547 * in case a predefined read-only register having the value -1
2548 * were to turn up, another special value would have to be chosen.
2551 roff_getregro(const struct roff
*r
, const char *name
)
2555 case '$': /* Number of arguments of the last macro evaluated. */
2557 case 'A': /* ASCII approximation mode is always off. */
2559 case 'g': /* Groff compatibility mode is always on. */
2561 case 'H': /* Fixed horizontal resolution. */
2563 case 'j': /* Always adjust left margin only. */
2565 case 'T': /* Some output device is always defined. */
2567 case 'V': /* Fixed vertical resolution. */
2575 roff_getreg(const struct roff
*r
, const char *name
)
2577 struct roffreg
*reg
;
2580 if ('.' == name
[0] && '\0' != name
[1] && '\0' == name
[2]) {
2581 val
= roff_getregro(r
, name
+ 1);
2586 for (reg
= r
->regtab
; reg
; reg
= reg
->next
)
2587 if (0 == strcmp(name
, reg
->key
.p
))
2594 roff_getregn(const struct roff
*r
, const char *name
, size_t len
)
2596 struct roffreg
*reg
;
2599 if ('.' == name
[0] && 2 == len
) {
2600 val
= roff_getregro(r
, name
+ 1);
2605 for (reg
= r
->regtab
; reg
; reg
= reg
->next
)
2606 if (len
== reg
->key
.sz
&&
2607 0 == strncmp(name
, reg
->key
.p
, len
))
2614 roff_hasregn(const struct roff
*r
, const char *name
, size_t len
)
2616 struct roffreg
*reg
;
2619 if ('.' == name
[0] && 2 == len
) {
2620 val
= roff_getregro(r
, name
+ 1);
2625 for (reg
= r
->regtab
; reg
; reg
= reg
->next
)
2626 if (len
== reg
->key
.sz
&&
2627 0 == strncmp(name
, reg
->key
.p
, len
))
2634 roff_freereg(struct roffreg
*reg
)
2636 struct roffreg
*old_reg
;
2638 while (NULL
!= reg
) {
2654 key
= val
= buf
->buf
+ pos
;
2658 keysz
= roff_getname(r
, &val
, ln
, pos
);
2659 if (key
[keysz
] == '\\')
2664 if (sign
== '+' || sign
== '-')
2667 if (roff_evalnum(r
, ln
, val
, NULL
, &iv
, ROFFNUM_SCALE
))
2668 roff_setreg(r
, key
, iv
, sign
);
2676 struct roffreg
*reg
, **prev
;
2680 name
= cp
= buf
->buf
+ pos
;
2683 namesz
= roff_getname(r
, &cp
, ln
, pos
);
2684 name
[namesz
] = '\0';
2689 if (reg
== NULL
|| !strcmp(name
, reg
->key
.p
))
2701 /* --- handler functions for roff requests -------------------------------- */
2710 cp
= buf
->buf
+ pos
;
2711 while (*cp
!= '\0') {
2713 namesz
= roff_getname(r
, &cp
, ln
, (int)(cp
- buf
->buf
));
2714 roff_setstrn(&r
->strtab
, name
, namesz
, NULL
, 0, 0);
2715 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
2716 if (name
[namesz
] == '\\')
2727 /* Parse the number of lines. */
2729 if ( ! roff_evalnum(r
, ln
, buf
->buf
, &pos
, &iv
, 0)) {
2730 mandoc_msg(MANDOCERR_IT_NONUM
, r
->parse
,
2731 ln
, ppos
, buf
->buf
+ 1);
2735 while (isspace((unsigned char)buf
->buf
[pos
]))
2739 * Arm the input line trap.
2740 * Special-casing "an-trap" is an ugly workaround to cope
2741 * with DocBook stupidly fiddling with man(7) internals.
2745 roffit_macro
= mandoc_strdup(iv
!= 1 ||
2746 strcmp(buf
->buf
+ pos
, "an-trap") ?
2747 buf
->buf
+ pos
: "br");
2755 enum roff_tok t
, te
;
2762 r
->format
= MPARSE_MDOC
;
2763 mask
= MPARSE_MDOC
| MPARSE_QUICK
;
2769 r
->format
= MPARSE_MAN
;
2770 mask
= MPARSE_QUICK
;
2775 if ((r
->options
& mask
) == 0)
2776 for (t
= tok
; t
< te
; t
++)
2777 roff_setstr(r
, roff_name
[t
], NULL
, 0);
2784 if (r
->tbl
== NULL
) {
2785 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
2789 if (tbl_end(r
->tbl
) == 0) {
2792 buf
->buf
= mandoc_strdup(".sp");
2794 return ROFF_REPARSE
;
2805 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
,
2808 tbl_restart(ln
, ppos
, r
->tbl
);
2814 * Handle in-line equation delimiters.
2817 roff_eqndelim(struct roff
*r
, struct buf
*buf
, int pos
)
2820 const char *bef_pr
, *bef_nl
, *mac
, *aft_nl
, *aft_pr
;
2823 * Outside equations, look for an opening delimiter.
2824 * If we are inside an equation, we already know it is
2825 * in-line, or this function wouldn't have been called;
2826 * so look for a closing delimiter.
2829 cp1
= buf
->buf
+ pos
;
2830 cp2
= strchr(cp1
, r
->eqn
== NULL
?
2831 r
->last_eqn
->odelim
: r
->last_eqn
->cdelim
);
2836 bef_pr
= bef_nl
= aft_nl
= aft_pr
= "";
2838 /* Handle preceding text, protecting whitespace. */
2840 if (*buf
->buf
!= '\0') {
2847 * Prepare replacing the delimiter with an equation macro
2848 * and drop leading white space from the equation.
2851 if (r
->eqn
== NULL
) {
2858 /* Handle following text, protecting whitespace. */
2866 /* Do the actual replacement. */
2868 buf
->sz
= mandoc_asprintf(&cp1
, "%s%s%s%s%s%s%s", buf
->buf
,
2869 bef_pr
, bef_nl
, mac
, aft_nl
, aft_pr
, cp2
) + 1;
2873 /* Toggle the in-line state of the eqn subsystem. */
2875 r
->eqn_inline
= r
->eqn
== NULL
;
2876 return ROFF_REPARSE
;
2882 struct roff_node
*n
;
2884 if (r
->man
->macroset
== MACROSET_MAN
)
2885 man_breakscope(r
->man
, ROFF_EQ
);
2886 n
= roff_node_alloc(r
->man
, ln
, ppos
, ROFFT_EQN
, TOKEN_NONE
);
2887 if (ln
> r
->man
->last
->line
)
2888 n
->flags
|= NODE_LINE
;
2889 n
->eqn
= mandoc_calloc(1, sizeof(*n
->eqn
));
2890 n
->eqn
->expectargs
= UINT_MAX
;
2891 roff_node_append(r
->man
, n
);
2892 r
->man
->next
= ROFF_NEXT_SIBLING
;
2894 assert(r
->eqn
== NULL
);
2895 if (r
->last_eqn
== NULL
)
2896 r
->last_eqn
= eqn_alloc(r
->parse
);
2898 eqn_reset(r
->last_eqn
);
2899 r
->eqn
= r
->last_eqn
;
2902 if (buf
->buf
[pos
] != '\0')
2903 mandoc_vmsg(MANDOCERR_ARG_SKIP
, r
->parse
, ln
, pos
,
2904 ".EQ %s", buf
->buf
+ pos
);
2912 if (r
->eqn
!= NULL
) {
2916 mandoc_msg(MANDOCERR_BLK_NOTOPEN
, r
->parse
, ln
, ppos
, "EN");
2917 if (buf
->buf
[pos
] != '\0')
2918 mandoc_vmsg(MANDOCERR_ARG_SKIP
, r
->parse
, ln
, pos
,
2919 "EN %s", buf
->buf
+ pos
);
2926 if (r
->tbl
!= NULL
) {
2927 mandoc_msg(MANDOCERR_BLK_BROKEN
, r
->parse
,
2928 ln
, ppos
, "TS breaks TS");
2931 r
->tbl
= tbl_alloc(ppos
, ln
, r
->parse
);
2933 r
->last_tbl
->next
= r
->tbl
;
2935 r
->first_tbl
= r
->tbl
;
2936 r
->last_tbl
= r
->tbl
;
2941 roff_onearg(ROFF_ARGS
)
2943 struct roff_node
*n
;
2947 if (r
->man
->flags
& (MAN_BLINE
| MAN_ELINE
) &&
2948 (tok
== ROFF_ce
|| tok
== ROFF_rj
|| tok
== ROFF_sp
||
2950 man_breakscope(r
->man
, tok
);
2952 if (roffce_node
!= NULL
&& (tok
== ROFF_ce
|| tok
== ROFF_rj
)) {
2953 r
->man
->last
= roffce_node
;
2954 r
->man
->next
= ROFF_NEXT_SIBLING
;
2957 roff_elem_alloc(r
->man
, ln
, ppos
, tok
);
2960 cp
= buf
->buf
+ pos
;
2962 while (*cp
!= '\0' && *cp
!= ' ')
2967 mandoc_vmsg(MANDOCERR_ARG_EXCESS
,
2968 r
->parse
, ln
, cp
- buf
->buf
,
2969 "%s ... %s", roff_name
[tok
], cp
);
2970 roff_word_alloc(r
->man
, ln
, pos
, buf
->buf
+ pos
);
2973 if (tok
== ROFF_ce
|| tok
== ROFF_rj
) {
2974 if (r
->man
->last
->type
== ROFFT_ELEM
) {
2975 roff_word_alloc(r
->man
, ln
, pos
, "1");
2976 r
->man
->last
->flags
|= NODE_NOSRC
;
2979 if (roff_evalnum(r
, ln
, r
->man
->last
->string
, &npos
,
2980 &roffce_lines
, 0) == 0) {
2981 mandoc_vmsg(MANDOCERR_CE_NONUM
,
2982 r
->parse
, ln
, pos
, "ce %s", buf
->buf
+ pos
);
2985 if (roffce_lines
< 1) {
2986 r
->man
->last
= r
->man
->last
->parent
;
2990 roffce_node
= r
->man
->last
->parent
;
2992 n
->flags
|= NODE_VALID
| NODE_ENDED
;
2995 n
->flags
|= NODE_LINE
;
2996 r
->man
->next
= ROFF_NEXT_SIBLING
;
3001 roff_manyarg(ROFF_ARGS
)
3003 struct roff_node
*n
;
3006 roff_elem_alloc(r
->man
, ln
, ppos
, tok
);
3009 for (sp
= ep
= buf
->buf
+ pos
; *sp
!= '\0'; sp
= ep
) {
3010 while (*ep
!= '\0' && *ep
!= ' ')
3014 roff_word_alloc(r
->man
, ln
, sp
- buf
->buf
, sp
);
3017 n
->flags
|= NODE_LINE
| NODE_VALID
| NODE_ENDED
;
3019 r
->man
->next
= ROFF_NEXT_SIBLING
;
3026 char *oldn
, *newn
, *end
, *value
;
3027 size_t oldsz
, newsz
, valsz
;
3029 newn
= oldn
= buf
->buf
+ pos
;
3033 newsz
= roff_getname(r
, &oldn
, ln
, pos
);
3034 if (newn
[newsz
] == '\\' || *oldn
== '\0')
3038 oldsz
= roff_getname(r
, &end
, ln
, oldn
- buf
->buf
);
3042 valsz
= mandoc_asprintf(&value
, ".%.*s \\$*\\\"\n",
3044 roff_setstrn(&r
->strtab
, newn
, newsz
, value
, valsz
, 0);
3045 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3053 if (r
->man
->flags
& (MAN_BLINE
| MAN_ELINE
))
3054 man_breakscope(r
->man
, ROFF_br
);
3055 roff_elem_alloc(r
->man
, ln
, ppos
, ROFF_br
);
3056 if (buf
->buf
[pos
] != '\0')
3057 mandoc_vmsg(MANDOCERR_ARG_SKIP
, r
->parse
, ln
, pos
,
3058 "%s %s", roff_name
[tok
], buf
->buf
+ pos
);
3059 r
->man
->last
->flags
|= NODE_LINE
| NODE_VALID
| NODE_ENDED
;
3060 r
->man
->next
= ROFF_NEXT_SIBLING
;
3071 if (*p
== '\0' || (r
->control
= *p
++) == '.')
3075 mandoc_vmsg(MANDOCERR_ARG_EXCESS
, r
->parse
,
3076 ln
, p
- buf
->buf
, "cc ... %s", p
);
3092 mandoc_vmsg(MANDOCERR_ARG_EXCESS
, r
->parse
,
3093 ln
, p
- buf
->buf
, "ec ... %s", p
);
3102 if (buf
->buf
[pos
] != '\0')
3103 mandoc_vmsg(MANDOCERR_ARG_SKIP
, r
->parse
,
3104 ln
, pos
, "eo %s", buf
->buf
+ pos
);
3111 const char *p
, *first
, *second
;
3113 enum mandoc_esc esc
;
3118 mandoc_msg(MANDOCERR_REQ_EMPTY
, r
->parse
, ln
, ppos
, "tr");
3122 while (*p
!= '\0') {
3126 if (*first
== '\\') {
3127 esc
= mandoc_escape(&p
, NULL
, NULL
);
3128 if (esc
== ESCAPE_ERROR
) {
3129 mandoc_msg(MANDOCERR_ESC_BAD
, r
->parse
,
3130 ln
, (int)(p
- buf
->buf
), first
);
3133 fsz
= (size_t)(p
- first
);
3137 if (*second
== '\\') {
3138 esc
= mandoc_escape(&p
, NULL
, NULL
);
3139 if (esc
== ESCAPE_ERROR
) {
3140 mandoc_msg(MANDOCERR_ESC_BAD
, r
->parse
,
3141 ln
, (int)(p
- buf
->buf
), second
);
3144 ssz
= (size_t)(p
- second
);
3145 } else if (*second
== '\0') {
3146 mandoc_vmsg(MANDOCERR_TR_ODD
, r
->parse
,
3147 ln
, first
- buf
->buf
, "tr %s", first
);
3153 roff_setstrn(&r
->xmbtab
, first
, fsz
,
3158 if (r
->xtab
== NULL
)
3159 r
->xtab
= mandoc_calloc(128,
3160 sizeof(struct roffstr
));
3162 free(r
->xtab
[(int)*first
].p
);
3163 r
->xtab
[(int)*first
].p
= mandoc_strndup(second
, ssz
);
3164 r
->xtab
[(int)*first
].sz
= ssz
;
3174 char *oldn
, *newn
, *end
;
3175 size_t oldsz
, newsz
;
3178 oldn
= newn
= buf
->buf
+ pos
;
3182 oldsz
= roff_getname(r
, &newn
, ln
, pos
);
3183 if (oldn
[oldsz
] == '\\' || *newn
== '\0')
3187 newsz
= roff_getname(r
, &end
, ln
, newn
- buf
->buf
);
3191 deftype
= ROFFDEF_ANY
;
3192 value
= roff_getstrn(r
, oldn
, oldsz
, &deftype
);
3195 roff_setstrn(&r
->strtab
, newn
, newsz
, value
, strlen(value
), 0);
3196 roff_setstrn(&r
->strtab
, oldn
, oldsz
, NULL
, 0, 0);
3197 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3200 roff_setstrn(&r
->strtab
, newn
, newsz
, value
, strlen(value
), 0);
3201 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3204 roff_setstrn(&r
->rentab
, newn
, newsz
, value
, strlen(value
), 0);
3205 roff_setstrn(&r
->rentab
, oldn
, oldsz
, NULL
, 0, 0);
3206 roff_setstrn(&r
->strtab
, newn
, newsz
, NULL
, 0, 0);
3209 roff_setstrn(&r
->rentab
, newn
, newsz
, oldn
, oldsz
, 0);
3210 roff_setstrn(&r
->strtab
, newn
, newsz
, NULL
, 0, 0);
3213 roff_setstrn(&r
->strtab
, newn
, newsz
, NULL
, 0, 0);
3214 roff_setstrn(&r
->rentab
, newn
, newsz
, NULL
, 0, 0);
3225 name
= buf
->buf
+ pos
;
3226 mandoc_vmsg(MANDOCERR_SO
, r
->parse
, ln
, ppos
, "so %s", name
);
3229 * Handle `so'. Be EXTREMELY careful, as we shouldn't be
3230 * opening anything that's not in our cwd or anything beneath
3231 * it. Thus, explicitly disallow traversing up the file-system
3232 * or using absolute paths.
3235 if (*name
== '/' || strstr(name
, "../") || strstr(name
, "/..")) {
3236 mandoc_vmsg(MANDOCERR_SO_PATH
, r
->parse
, ln
, ppos
,
3238 buf
->sz
= mandoc_asprintf(&cp
,
3239 ".sp\nSee the file %s.\n.sp", name
) + 1;
3243 return ROFF_REPARSE
;
3250 /* --- user defined strings and macros ------------------------------------ */
3253 roff_userdef(ROFF_ARGS
)
3255 const char *arg
[16], *ap
;
3257 int expand_count
, i
, ib
, ie
;
3261 * Collect pointers to macro argument strings
3262 * and NUL-terminate them.
3266 cp
= buf
->buf
+ pos
;
3267 for (i
= 0; i
< 16; i
++) {
3271 arg
[i
] = mandoc_getarg(r
->parse
, &cp
, ln
, &pos
);
3277 * Expand macro arguments.
3280 buf
->sz
= strlen(r
->current_string
) + 1;
3281 n1
= n2
= cp
= mandoc_malloc(buf
->sz
);
3282 memcpy(n1
, r
->current_string
, buf
->sz
);
3284 while (*cp
!= '\0') {
3286 /* Scan ahead for the next argument invocation. */
3292 if (*cp
== '*') { /* \\$* inserts all arguments */
3295 } else { /* \\$1 .. \\$9 insert one argument */
3296 ib
= ie
= *cp
- '1';
3297 if (ib
< 0 || ib
> 8)
3303 * Prevent infinite recursion.
3308 else if (++expand_count
> EXPAND_LIMIT
) {
3309 mandoc_msg(MANDOCERR_ROFFLOOP
, r
->parse
,
3310 ln
, (int)(cp
- n1
), NULL
);
3317 * Determine the size of the expanded argument,
3318 * taking escaping of quotes into account.
3321 asz
= ie
> ib
? ie
- ib
: 0; /* for blanks */
3322 for (i
= ib
; i
<= ie
; i
++) {
3323 for (ap
= arg
[i
]; *ap
!= '\0'; ap
++) {
3332 * Determine the size of the rest of the
3333 * unexpanded macro, including the NUL.
3336 rsz
= buf
->sz
- (cp
- n1
) - 3;
3339 * When shrinking, move before
3340 * releasing the storage.
3344 memmove(cp
+ asz
, cp
+ 3, rsz
);
3347 * Resize the storage for the macro
3348 * and readjust the parse pointer.
3352 n2
= mandoc_realloc(n1
, buf
->sz
);
3353 cp
= n2
+ (cp
- n1
);
3357 * When growing, make room
3358 * for the expanded argument.
3362 memmove(cp
+ asz
, cp
+ 3, rsz
);
3365 /* Copy the expanded argument, escaping quotes. */
3368 for (i
= ib
; i
<= ie
; i
++) {
3369 for (ap
= arg
[i
]; *ap
!= '\0'; ap
++) {
3371 memcpy(n2
, "\\(dq", 4);
3382 * Replace the macro invocation
3383 * by the expanded macro.
3390 return buf
->sz
> 1 && buf
->buf
[buf
->sz
- 2] == '\n' ?
3391 ROFF_REPARSE
: ROFF_APPEND
;
3395 * Calling a high-level macro that was renamed with .rn.
3396 * r->current_string has already been set up by roff_parse().
3399 roff_renamed(ROFF_ARGS
)
3403 buf
->sz
= mandoc_asprintf(&nbuf
, ".%s%s%s", r
->current_string
,
3404 buf
->buf
[pos
] == '\0' ? "" : " ", buf
->buf
+ pos
) + 1;
3411 roff_getname(struct roff
*r
, char **cpp
, int ln
, int pos
)
3420 /* Read until end of name and terminate it with NUL. */
3421 for (cp
= name
; 1; cp
++) {
3422 if ('\0' == *cp
|| ' ' == *cp
) {
3429 if ('{' == cp
[1] || '}' == cp
[1])
3434 mandoc_vmsg(MANDOCERR_NAMESC
, r
->parse
, ln
, pos
,
3435 "%.*s", (int)(cp
- name
+ 1), name
);
3436 mandoc_escape((const char **)&cp
, NULL
, NULL
);
3440 /* Read past spaces. */
3449 * Store *string into the user-defined string called *name.
3450 * To clear an existing entry, call with (*r, *name, NULL, 0).
3451 * append == 0: replace mode
3452 * append == 1: single-line append mode
3453 * append == 2: multiline append mode, append '\n' after each call
3456 roff_setstr(struct roff
*r
, const char *name
, const char *string
,
3461 namesz
= strlen(name
);
3462 roff_setstrn(&r
->strtab
, name
, namesz
, string
,
3463 string
? strlen(string
) : 0, append
);
3464 roff_setstrn(&r
->rentab
, name
, namesz
, NULL
, 0, 0);
3468 roff_setstrn(struct roffkv
**r
, const char *name
, size_t namesz
,
3469 const char *string
, size_t stringsz
, int append
)
3474 size_t oldch
, newch
;
3476 /* Search for an existing string with the same name. */
3479 while (n
&& (namesz
!= n
->key
.sz
||
3480 strncmp(n
->key
.p
, name
, namesz
)))
3484 /* Create a new string table entry. */
3485 n
= mandoc_malloc(sizeof(struct roffkv
));
3486 n
->key
.p
= mandoc_strndup(name
, namesz
);
3492 } else if (0 == append
) {
3502 * One additional byte for the '\n' in multiline mode,
3503 * and one for the terminating '\0'.
3505 newch
= stringsz
+ (1 < append
? 2u : 1u);
3507 if (NULL
== n
->val
.p
) {
3508 n
->val
.p
= mandoc_malloc(newch
);
3513 n
->val
.p
= mandoc_realloc(n
->val
.p
, oldch
+ newch
);
3516 /* Skip existing content in the destination buffer. */
3517 c
= n
->val
.p
+ (int)oldch
;
3519 /* Append new content to the destination buffer. */
3521 while (i
< (int)stringsz
) {
3523 * Rudimentary roff copy mode:
3524 * Handle escaped backslashes.
3526 if ('\\' == string
[i
] && '\\' == string
[i
+ 1])
3531 /* Append terminating bytes. */
3536 n
->val
.sz
= (int)(c
- n
->val
.p
);
3540 roff_getstrn(const struct roff
*r
, const char *name
, size_t len
,
3543 const struct roffkv
*n
;
3547 if (*deftype
& ROFFDEF_USER
) {
3548 for (n
= r
->strtab
; n
!= NULL
; n
= n
->next
) {
3549 if (strncmp(name
, n
->key
.p
, len
) == 0 &&
3550 n
->key
.p
[len
] == '\0' &&
3552 *deftype
= ROFFDEF_USER
;
3557 if (*deftype
& ROFFDEF_PRE
) {
3558 for (i
= 0; i
< PREDEFS_MAX
; i
++) {
3559 if (strncmp(name
, predefs
[i
].name
, len
) == 0 &&
3560 predefs
[i
].name
[len
] == '\0') {
3561 *deftype
= ROFFDEF_PRE
;
3562 return predefs
[i
].str
;
3566 if (*deftype
& ROFFDEF_REN
) {
3567 for (n
= r
->rentab
; n
!= NULL
; n
= n
->next
) {
3568 if (strncmp(name
, n
->key
.p
, len
) == 0 &&
3569 n
->key
.p
[len
] == '\0' &&
3571 *deftype
= ROFFDEF_REN
;
3576 if (*deftype
& ROFFDEF_STD
) {
3577 if (r
->man
->macroset
!= MACROSET_MAN
) {
3578 for (tok
= MDOC_Dd
; tok
< MDOC_MAX
; tok
++) {
3579 if (strncmp(name
, roff_name
[tok
], len
) == 0 &&
3580 roff_name
[tok
][len
] == '\0') {
3581 *deftype
= ROFFDEF_STD
;
3586 if (r
->man
->macroset
!= MACROSET_MDOC
) {
3587 for (tok
= MAN_TH
; tok
< MAN_MAX
; tok
++) {
3588 if (strncmp(name
, roff_name
[tok
], len
) == 0 &&
3589 roff_name
[tok
][len
] == '\0') {
3590 *deftype
= ROFFDEF_STD
;
3601 roff_freestr(struct roffkv
*r
)
3603 struct roffkv
*n
, *nn
;
3605 for (n
= r
; n
; n
= nn
) {
3613 /* --- accessors and utility functions ------------------------------------ */
3616 * Duplicate an input string, making the appropriate character
3617 * conversations (as stipulated by `tr') along the way.
3618 * Returns a heap-allocated string with all the replacements made.
3621 roff_strdup(const struct roff
*r
, const char *p
)
3623 const struct roffkv
*cp
;
3627 enum mandoc_esc esc
;
3629 if (NULL
== r
->xmbtab
&& NULL
== r
->xtab
)
3630 return mandoc_strdup(p
);
3631 else if ('\0' == *p
)
3632 return mandoc_strdup("");
3635 * Step through each character looking for term matches
3636 * (remember that a `tr' can be invoked with an escape, which is
3637 * a glyph but the escape is multi-character).
3638 * We only do this if the character hash has been initialised
3639 * and the string is >0 length.
3645 while ('\0' != *p
) {
3646 assert((unsigned int)*p
< 128);
3647 if ('\\' != *p
&& r
->xtab
&& r
->xtab
[(unsigned int)*p
].p
) {
3648 sz
= r
->xtab
[(int)*p
].sz
;
3649 res
= mandoc_realloc(res
, ssz
+ sz
+ 1);
3650 memcpy(res
+ ssz
, r
->xtab
[(int)*p
].p
, sz
);
3654 } else if ('\\' != *p
) {
3655 res
= mandoc_realloc(res
, ssz
+ 2);
3660 /* Search for term matches. */
3661 for (cp
= r
->xmbtab
; cp
; cp
= cp
->next
)
3662 if (0 == strncmp(p
, cp
->key
.p
, cp
->key
.sz
))
3667 * A match has been found.
3668 * Append the match to the array and move
3669 * forward by its keysize.
3671 res
= mandoc_realloc(res
,
3672 ssz
+ cp
->val
.sz
+ 1);
3673 memcpy(res
+ ssz
, cp
->val
.p
, cp
->val
.sz
);
3675 p
+= (int)cp
->key
.sz
;
3680 * Handle escapes carefully: we need to copy
3681 * over just the escape itself, or else we might
3682 * do replacements within the escape itself.
3683 * Make sure to pass along the bogus string.
3686 esc
= mandoc_escape(&p
, NULL
, NULL
);
3687 if (ESCAPE_ERROR
== esc
) {
3689 res
= mandoc_realloc(res
, ssz
+ sz
+ 1);
3690 memcpy(res
+ ssz
, pp
, sz
);
3694 * We bail out on bad escapes.
3695 * No need to warn: we already did so when
3696 * roff_res() was called.
3699 res
= mandoc_realloc(res
, ssz
+ sz
+ 1);
3700 memcpy(res
+ ssz
, pp
, sz
);
3704 res
[(int)ssz
] = '\0';
3709 roff_getformat(const struct roff
*r
)
3716 * Find out whether a line is a macro line or not.
3717 * If it is, adjust the current position and return one; if it isn't,
3718 * return zero and don't change the current position.
3719 * If the control character has been set with `.cc', then let that grain
3721 * This is slighly contrary to groff, where using the non-breaking
3722 * control character when `cc' has been invoked will cause the
3723 * non-breaking macro contents to be printed verbatim.
3726 roff_getcontrol(const struct roff
*r
, const char *cp
, int *ppos
)
3732 if (r
->control
!= '\0' && cp
[pos
] == r
->control
)
3734 else if (r
->control
!= '\0')
3736 else if ('\\' == cp
[pos
] && '.' == cp
[pos
+ 1])
3738 else if ('.' == cp
[pos
] || '\'' == cp
[pos
])
3743 while (' ' == cp
[pos
] || '\t' == cp
[pos
])