Annotation of src/usr.bin/mandoc/roff.c, Revision 1.93
1.93 ! schwarze 1: /* $Id: roff.c,v 1.92 2014/07/06 19:08:56 schwarze Exp $ */
1.1 schwarze 2: /*
1.48 schwarze 3: * Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.63 schwarze 4: * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 5: *
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.
9: *
1.16 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.16 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 schwarze 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.
17: */
18: #include <assert.h>
1.3 schwarze 19: #include <ctype.h>
1.51 schwarze 20: #include <stdio.h>
1.1 schwarze 21: #include <stdlib.h>
22: #include <string.h>
23:
24: #include "mandoc.h"
1.74 schwarze 25: #include "mandoc_aux.h"
1.27 schwarze 26: #include "libroff.h"
1.8 schwarze 27: #include "libmandoc.h"
1.1 schwarze 28:
1.37 schwarze 29: /* Maximum number of nested if-else conditionals. */
1.2 schwarze 30: #define RSTACK_MAX 128
31:
1.43 schwarze 32: /* Maximum number of string expansions per line, to break infinite loops. */
33: #define EXPAND_LIMIT 1000
34:
1.1 schwarze 35: enum rofft {
1.20 schwarze 36: ROFF_ad,
1.2 schwarze 37: ROFF_am,
38: ROFF_ami,
39: ROFF_am1,
1.66 schwarze 40: ROFF_as,
1.48 schwarze 41: ROFF_cc,
1.67 schwarze 42: ROFF_ce,
1.1 schwarze 43: ROFF_de,
44: ROFF_dei,
1.2 schwarze 45: ROFF_de1,
46: ROFF_ds,
47: ROFF_el,
1.58 schwarze 48: ROFF_fam,
1.59 schwarze 49: ROFF_hw,
1.20 schwarze 50: ROFF_hy,
1.2 schwarze 51: ROFF_ie,
52: ROFF_if,
1.1 schwarze 53: ROFF_ig,
1.30 schwarze 54: ROFF_it,
1.20 schwarze 55: ROFF_ne,
56: ROFF_nh,
1.14 schwarze 57: ROFF_nr,
1.31 schwarze 58: ROFF_ns,
59: ROFF_ps,
1.2 schwarze 60: ROFF_rm,
1.76 schwarze 61: ROFF_rr,
1.14 schwarze 62: ROFF_so,
1.31 schwarze 63: ROFF_ta,
1.2 schwarze 64: ROFF_tr,
1.47 schwarze 65: ROFF_Dd,
66: ROFF_TH,
1.27 schwarze 67: ROFF_TS,
68: ROFF_TE,
69: ROFF_T_,
1.32 schwarze 70: ROFF_EQ,
71: ROFF_EN,
1.2 schwarze 72: ROFF_cblock,
1.16 schwarze 73: ROFF_USERDEF,
1.1 schwarze 74: ROFF_MAX
75: };
76:
1.41 schwarze 77: /*
1.42 schwarze 78: * An incredibly-simple string buffer.
79: */
1.8 schwarze 80: struct roffstr {
1.42 schwarze 81: char *p; /* nil-terminated buffer */
82: size_t sz; /* saved strlen(p) */
83: };
84:
85: /*
86: * A key-value roffstr pair as part of a singly-linked list.
87: */
88: struct roffkv {
89: struct roffstr key;
90: struct roffstr val;
91: struct roffkv *next; /* next in list */
1.8 schwarze 92: };
93:
1.52 schwarze 94: /*
95: * A single number register as part of a singly-linked list.
96: */
97: struct roffreg {
98: struct roffstr key;
1.53 schwarze 99: int val;
1.52 schwarze 100: struct roffreg *next;
101: };
102:
1.1 schwarze 103: struct roff {
1.35 schwarze 104: struct mparse *parse; /* parse point */
1.72 schwarze 105: int options; /* parse options */
1.1 schwarze 106: struct roffnode *last; /* leaf of stack */
1.71 schwarze 107: int rstack[RSTACK_MAX]; /* stack of !`ie' rules */
1.48 schwarze 108: char control; /* control character */
1.2 schwarze 109: int rstackpos; /* position in rstack */
1.52 schwarze 110: struct roffreg *regtab; /* number registers */
1.42 schwarze 111: struct roffkv *strtab; /* user-defined strings & macros */
112: struct roffkv *xmbtab; /* multi-byte trans table (`tr') */
113: struct roffstr *xtab; /* single-byte trans table (`tr') */
1.16 schwarze 114: const char *current_string; /* value of last called user macro */
1.27 schwarze 115: struct tbl_node *first_tbl; /* first table parsed */
116: struct tbl_node *last_tbl; /* last table parsed */
117: struct tbl_node *tbl; /* current table being parsed */
1.32 schwarze 118: struct eqn_node *last_eqn; /* last equation parsed */
119: struct eqn_node *first_eqn; /* first equation parsed */
120: struct eqn_node *eqn; /* current equation being parsed */
1.1 schwarze 121: };
122:
123: struct roffnode {
124: enum rofft tok; /* type of node */
125: struct roffnode *parent; /* up one in stack */
126: int line; /* parse line */
127: int col; /* parse col */
1.16 schwarze 128: char *name; /* node name, e.g. macro name */
1.2 schwarze 129: char *end; /* end-rules: custom token */
130: int endspan; /* end-rules: next-line or infty */
1.71 schwarze 131: int rule; /* current evaluation rule */
1.1 schwarze 132: };
133:
134: #define ROFF_ARGS struct roff *r, /* parse ctx */ \
135: enum rofft tok, /* tok of macro */ \
1.80 schwarze 136: char **bufp, /* input buffer */ \
1.1 schwarze 137: size_t *szp, /* size of input buffer */ \
138: int ln, /* parse line */ \
1.2 schwarze 139: int ppos, /* original pos in buffer */ \
140: int pos, /* current pos in buffer */ \
141: int *offs /* reset offset of buffer data */
1.1 schwarze 142:
143: typedef enum rofferr (*roffproc)(ROFF_ARGS);
144:
145: struct roffmac {
146: const char *name; /* macro name */
1.2 schwarze 147: roffproc proc; /* process new macro */
148: roffproc text; /* process as child text of macro */
149: roffproc sub; /* process as child of macro */
150: int flags;
151: #define ROFFMAC_STRUCT (1 << 0) /* always interpret */
1.3 schwarze 152: struct roffmac *next;
1.1 schwarze 153: };
154:
1.37 schwarze 155: struct predef {
156: const char *name; /* predefined input name */
157: const char *str; /* replacement symbol */
158: };
159:
160: #define PREDEF(__name, __str) \
161: { (__name), (__str) },
162:
1.42 schwarze 163: static enum rofft roffhash_find(const char *, size_t);
164: static void roffhash_init(void);
165: static void roffnode_cleanscope(struct roff *);
166: static void roffnode_pop(struct roff *);
167: static void roffnode_push(struct roff *, enum rofft,
168: const char *, int, int);
1.2 schwarze 169: static enum rofferr roff_block(ROFF_ARGS);
170: static enum rofferr roff_block_text(ROFF_ARGS);
171: static enum rofferr roff_block_sub(ROFF_ARGS);
172: static enum rofferr roff_cblock(ROFF_ARGS);
1.48 schwarze 173: static enum rofferr roff_cc(ROFF_ARGS);
1.68 schwarze 174: static void roff_ccond(struct roff *, int, int);
1.2 schwarze 175: static enum rofferr roff_cond(ROFF_ARGS);
176: static enum rofferr roff_cond_text(ROFF_ARGS);
177: static enum rofferr roff_cond_sub(ROFF_ARGS);
1.7 schwarze 178: static enum rofferr roff_ds(ROFF_ARGS);
1.71 schwarze 179: static int roff_evalcond(const char *, int *);
1.77 schwarze 180: static int roff_evalnum(const char *, int *, int *, int);
181: static int roff_evalpar(const char *, int *, int *);
1.71 schwarze 182: static int roff_evalstrcond(const char *, int *);
1.42 schwarze 183: static void roff_free1(struct roff *);
1.52 schwarze 184: static void roff_freereg(struct roffreg *);
1.42 schwarze 185: static void roff_freestr(struct roffkv *);
1.85 schwarze 186: static size_t roff_getname(struct roff *, char **, int, int);
1.56 schwarze 187: static int roff_getnum(const char *, int *, int *);
188: static int roff_getop(const char *, int *, char *);
1.53 schwarze 189: static int roff_getregn(const struct roff *,
190: const char *, size_t);
1.65 schwarze 191: static int roff_getregro(const char *name);
1.80 schwarze 192: static const char *roff_getstrn(const struct roff *,
1.8 schwarze 193: const char *, size_t);
1.51 schwarze 194: static enum rofferr roff_it(ROFF_ARGS);
1.21 schwarze 195: static enum rofferr roff_line_ignore(ROFF_ARGS);
1.6 schwarze 196: static enum rofferr roff_nr(ROFF_ARGS);
1.41 schwarze 197: static void roff_openeqn(struct roff *, const char *,
198: int, int, const char *);
1.87 schwarze 199: static enum rofft roff_parse(struct roff *, char *, int *,
200: int, int);
1.51 schwarze 201: static enum rofferr roff_parsetext(char **, size_t *, int, int *);
1.80 schwarze 202: static enum rofferr roff_res(struct roff *,
1.37 schwarze 203: char **, size_t *, int, int);
1.29 schwarze 204: static enum rofferr roff_rm(ROFF_ARGS);
1.76 schwarze 205: static enum rofferr roff_rr(ROFF_ARGS);
1.8 schwarze 206: static void roff_setstr(struct roff *,
1.16 schwarze 207: const char *, const char *, int);
1.80 schwarze 208: static void roff_setstrn(struct roffkv **, const char *,
1.42 schwarze 209: size_t, const char *, size_t, int);
1.14 schwarze 210: static enum rofferr roff_so(ROFF_ARGS);
1.42 schwarze 211: static enum rofferr roff_tr(ROFF_ARGS);
1.47 schwarze 212: static enum rofferr roff_Dd(ROFF_ARGS);
213: static enum rofferr roff_TH(ROFF_ARGS);
1.27 schwarze 214: static enum rofferr roff_TE(ROFF_ARGS);
215: static enum rofferr roff_TS(ROFF_ARGS);
1.32 schwarze 216: static enum rofferr roff_EQ(ROFF_ARGS);
217: static enum rofferr roff_EN(ROFF_ARGS);
1.27 schwarze 218: static enum rofferr roff_T_(ROFF_ARGS);
1.16 schwarze 219: static enum rofferr roff_userdef(ROFF_ARGS);
1.1 schwarze 220:
1.42 schwarze 221: /* See roffhash_find() */
1.3 schwarze 222:
223: #define ASCII_HI 126
224: #define ASCII_LO 33
225: #define HASHWIDTH (ASCII_HI - ASCII_LO + 1)
226:
227: static struct roffmac *hash[HASHWIDTH];
228:
229: static struct roffmac roffs[ROFF_MAX] = {
1.21 schwarze 230: { "ad", roff_line_ignore, NULL, NULL, 0, NULL },
1.3 schwarze 231: { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
232: { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
233: { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
1.66 schwarze 234: { "as", roff_ds, NULL, NULL, 0, NULL },
1.48 schwarze 235: { "cc", roff_cc, NULL, NULL, 0, NULL },
1.67 schwarze 236: { "ce", roff_line_ignore, NULL, NULL, 0, NULL },
1.3 schwarze 237: { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
238: { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
239: { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
1.7 schwarze 240: { "ds", roff_ds, NULL, NULL, 0, NULL },
1.3 schwarze 241: { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
1.58 schwarze 242: { "fam", roff_line_ignore, NULL, NULL, 0, NULL },
1.59 schwarze 243: { "hw", roff_line_ignore, NULL, NULL, 0, NULL },
1.21 schwarze 244: { "hy", roff_line_ignore, NULL, NULL, 0, NULL },
1.3 schwarze 245: { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
246: { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
247: { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
1.51 schwarze 248: { "it", roff_it, NULL, NULL, 0, NULL },
1.21 schwarze 249: { "ne", roff_line_ignore, NULL, NULL, 0, NULL },
250: { "nh", roff_line_ignore, NULL, NULL, 0, NULL },
1.14 schwarze 251: { "nr", roff_nr, NULL, NULL, 0, NULL },
1.31 schwarze 252: { "ns", roff_line_ignore, NULL, NULL, 0, NULL },
253: { "ps", roff_line_ignore, NULL, NULL, 0, NULL },
1.29 schwarze 254: { "rm", roff_rm, NULL, NULL, 0, NULL },
1.76 schwarze 255: { "rr", roff_rr, NULL, NULL, 0, NULL },
1.14 schwarze 256: { "so", roff_so, NULL, NULL, 0, NULL },
1.31 schwarze 257: { "ta", roff_line_ignore, NULL, NULL, 0, NULL },
1.42 schwarze 258: { "tr", roff_tr, NULL, NULL, 0, NULL },
1.47 schwarze 259: { "Dd", roff_Dd, NULL, NULL, 0, NULL },
260: { "TH", roff_TH, NULL, NULL, 0, NULL },
1.27 schwarze 261: { "TS", roff_TS, NULL, NULL, 0, NULL },
262: { "TE", roff_TE, NULL, NULL, 0, NULL },
263: { "T&", roff_T_, NULL, NULL, 0, NULL },
1.32 schwarze 264: { "EQ", roff_EQ, NULL, NULL, 0, NULL },
265: { "EN", roff_EN, NULL, NULL, 0, NULL },
1.3 schwarze 266: { ".", roff_cblock, NULL, NULL, 0, NULL },
1.16 schwarze 267: { NULL, roff_userdef, NULL, NULL, 0, NULL },
1.1 schwarze 268: };
269:
1.73 schwarze 270: /* not currently implemented: Ds em Eq LP Me PP pp Or Rd Sf SH */
1.47 schwarze 271: const char *const __mdoc_reserved[] = {
272: "Ac", "Ad", "An", "Ao", "Ap", "Aq", "Ar", "At",
273: "Bc", "Bd", "Bf", "Bk", "Bl", "Bo", "Bq",
274: "Brc", "Bro", "Brq", "Bsx", "Bt", "Bx",
275: "Cd", "Cm", "Db", "Dc", "Dd", "Dl", "Do", "Dq",
1.73 schwarze 276: "Dt", "Dv", "Dx", "D1",
277: "Ec", "Ed", "Ef", "Ek", "El", "Em",
278: "En", "Eo", "Er", "Es", "Ev", "Ex",
1.47 schwarze 279: "Fa", "Fc", "Fd", "Fl", "Fn", "Fo", "Fr", "Ft", "Fx",
1.73 schwarze 280: "Hf", "Ic", "In", "It", "Lb", "Li", "Lk", "Lp",
281: "Ms", "Mt", "Nd", "Nm", "No", "Ns", "Nx",
1.47 schwarze 282: "Oc", "Oo", "Op", "Os", "Ot", "Ox",
1.73 schwarze 283: "Pa", "Pc", "Pf", "Po", "Pp", "Pq",
284: "Qc", "Ql", "Qo", "Qq", "Re", "Rs", "Rv",
285: "Sc", "Sh", "Sm", "So", "Sq",
1.47 schwarze 286: "Ss", "St", "Sx", "Sy",
287: "Ta", "Tn", "Ud", "Ux", "Va", "Vt", "Xc", "Xo", "Xr",
1.73 schwarze 288: "%A", "%B", "%C", "%D", "%I", "%J", "%N", "%O",
1.47 schwarze 289: "%P", "%Q", "%R", "%T", "%U", "%V",
290: NULL
291: };
292:
1.73 schwarze 293: /* not currently implemented: BT DE DS ME MT PT SY TQ YS */
1.47 schwarze 294: const char *const __man_reserved[] = {
1.73 schwarze 295: "AT", "B", "BI", "BR", "DT",
296: "EE", "EN", "EQ", "EX", "HP", "I", "IB", "IP", "IR",
297: "LP", "OP", "P", "PD", "PP",
298: "R", "RB", "RE", "RI", "RS", "SB", "SH", "SM", "SS",
299: "TE", "TH", "TP", "TS", "T&", "UC", "UE", "UR",
1.47 schwarze 300: NULL
301: };
302:
1.37 schwarze 303: /* Array of injected predefined strings. */
304: #define PREDEFS_MAX 38
305: static const struct predef predefs[PREDEFS_MAX] = {
306: #include "predefs.in"
307: };
308:
1.42 schwarze 309: /* See roffhash_find() */
1.3 schwarze 310: #define ROFF_HASH(p) (p[0] - ASCII_LO)
311:
1.51 schwarze 312: static int roffit_lines; /* number of lines to delay */
313: static char *roffit_macro; /* nil-terminated macro line */
314:
1.80 schwarze 315:
1.3 schwarze 316: static void
1.42 schwarze 317: roffhash_init(void)
1.3 schwarze 318: {
319: struct roffmac *n;
320: int buc, i;
321:
1.16 schwarze 322: for (i = 0; i < (int)ROFF_USERDEF; i++) {
1.3 schwarze 323: assert(roffs[i].name[0] >= ASCII_LO);
324: assert(roffs[i].name[0] <= ASCII_HI);
325:
326: buc = ROFF_HASH(roffs[i].name);
327:
328: if (NULL != (n = hash[buc])) {
329: for ( ; n->next; n = n->next)
330: /* Do nothing. */ ;
331: n->next = &roffs[i];
332: } else
333: hash[buc] = &roffs[i];
334: }
335: }
336:
1.1 schwarze 337: /*
338: * Look up a roff token by its name. Returns ROFF_MAX if no macro by
339: * the nil-terminated string name could be found.
340: */
341: static enum rofft
1.42 schwarze 342: roffhash_find(const char *p, size_t s)
1.1 schwarze 343: {
1.3 schwarze 344: int buc;
345: struct roffmac *n;
1.1 schwarze 346:
1.3 schwarze 347: /*
348: * libroff has an extremely simple hashtable, for the time
349: * being, which simply keys on the first character, which must
350: * be printable, then walks a chain. It works well enough until
351: * optimised.
352: */
353:
354: if (p[0] < ASCII_LO || p[0] > ASCII_HI)
355: return(ROFF_MAX);
356:
357: buc = ROFF_HASH(p);
358:
359: if (NULL == (n = hash[buc]))
360: return(ROFF_MAX);
361: for ( ; n; n = n->next)
1.16 schwarze 362: if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s])
1.3 schwarze 363: return((enum rofft)(n - roffs));
1.1 schwarze 364:
365: return(ROFF_MAX);
366: }
367:
368: /*
369: * Pop the current node off of the stack of roff instructions currently
370: * pending.
371: */
372: static void
373: roffnode_pop(struct roff *r)
374: {
375: struct roffnode *p;
376:
1.2 schwarze 377: assert(r->last);
1.80 schwarze 378: p = r->last;
1.2 schwarze 379:
380: r->last = r->last->parent;
1.16 schwarze 381: free(p->name);
382: free(p->end);
1.1 schwarze 383: free(p);
384: }
385:
386: /*
387: * Push a roff node onto the instruction stack. This must later be
388: * removed with roffnode_pop().
389: */
1.11 schwarze 390: static void
1.16 schwarze 391: roffnode_push(struct roff *r, enum rofft tok, const char *name,
392: int line, int col)
1.1 schwarze 393: {
394: struct roffnode *p;
395:
1.11 schwarze 396: p = mandoc_calloc(1, sizeof(struct roffnode));
1.1 schwarze 397: p->tok = tok;
1.16 schwarze 398: if (name)
399: p->name = mandoc_strdup(name);
1.1 schwarze 400: p->parent = r->last;
401: p->line = line;
402: p->col = col;
1.71 schwarze 403: p->rule = p->parent ? p->parent->rule : 0;
1.1 schwarze 404:
405: r->last = p;
406: }
407:
408: static void
409: roff_free1(struct roff *r)
410: {
1.49 schwarze 411: struct tbl_node *tbl;
1.32 schwarze 412: struct eqn_node *e;
1.42 schwarze 413: int i;
1.27 schwarze 414:
1.49 schwarze 415: while (NULL != (tbl = r->first_tbl)) {
416: r->first_tbl = tbl->next;
417: tbl_free(tbl);
1.27 schwarze 418: }
419:
420: r->first_tbl = r->last_tbl = r->tbl = NULL;
1.1 schwarze 421:
1.32 schwarze 422: while (NULL != (e = r->first_eqn)) {
423: r->first_eqn = e->next;
424: eqn_free(e);
425: }
426:
427: r->first_eqn = r->last_eqn = r->eqn = NULL;
428:
1.1 schwarze 429: while (r->last)
430: roffnode_pop(r);
1.27 schwarze 431:
1.42 schwarze 432: roff_freestr(r->strtab);
433: roff_freestr(r->xmbtab);
434:
435: r->strtab = r->xmbtab = NULL;
436:
1.52 schwarze 437: roff_freereg(r->regtab);
438:
439: r->regtab = NULL;
440:
1.42 schwarze 441: if (r->xtab)
442: for (i = 0; i < 128; i++)
443: free(r->xtab[i].p);
444:
445: free(r->xtab);
446: r->xtab = NULL;
1.1 schwarze 447: }
448:
449: void
450: roff_reset(struct roff *r)
451: {
452:
453: roff_free1(r);
1.48 schwarze 454: r->control = 0;
1.1 schwarze 455: }
456:
457: void
458: roff_free(struct roff *r)
459: {
460:
461: roff_free1(r);
462: free(r);
463: }
464:
465: struct roff *
1.72 schwarze 466: roff_alloc(struct mparse *parse, int options)
1.1 schwarze 467: {
468: struct roff *r;
469:
1.11 schwarze 470: r = mandoc_calloc(1, sizeof(struct roff));
1.35 schwarze 471: r->parse = parse;
1.72 schwarze 472: r->options = options;
1.2 schwarze 473: r->rstackpos = -1;
1.80 schwarze 474:
1.42 schwarze 475: roffhash_init();
1.37 schwarze 476:
1.1 schwarze 477: return(r);
478: }
479:
1.8 schwarze 480: /*
1.79 schwarze 481: * In the current line, expand escape sequences that tend to get
482: * used in numerical expressions and conditional requests.
483: * Also check the syntax of the remaining escape sequences.
1.8 schwarze 484: */
1.45 schwarze 485: static enum rofferr
1.37 schwarze 486: roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
1.8 schwarze 487: {
1.81 schwarze 488: char ubuf[24]; /* buffer to print the number */
1.78 schwarze 489: const char *start; /* start of the string to process */
1.82 schwarze 490: char *stesc; /* start of an escape sequence ('\\') */
1.23 schwarze 491: const char *stnam; /* start of the name, after "[(*" */
492: const char *cp; /* end of the name, e.g. before ']' */
493: const char *res; /* the string to be substituted */
1.53 schwarze 494: char *nbuf; /* new buffer to copy bufp to */
495: size_t maxl; /* expected length of the escape name */
496: size_t naml; /* actual length of the escape name */
497: int expand_count; /* to avoid infinite loops */
1.79 schwarze 498: int npos; /* position in numeric expression */
1.91 schwarze 499: int arg_complete; /* argument not interrupted by eol */
1.79 schwarze 500: char term; /* character terminating the escape */
1.8 schwarze 501:
1.43 schwarze 502: expand_count = 0;
1.78 schwarze 503: start = *bufp + pos;
504: stesc = strchr(start, '\0') - 1;
505: while (stesc-- > start) {
1.43 schwarze 506:
1.78 schwarze 507: /* Search backwards for the next backslash. */
508:
509: if ('\\' != *stesc)
510: continue;
511:
512: /* If it is escaped, skip it. */
513:
514: for (cp = stesc - 1; cp >= start; cp--)
515: if ('\\' != *cp)
516: break;
517:
518: if (0 == (stesc - cp) % 2) {
1.82 schwarze 519: stesc = (char *)cp;
1.78 schwarze 520: continue;
521: }
1.23 schwarze 522:
1.79 schwarze 523: /* Decide whether to expand or to check only. */
1.23 schwarze 524:
1.79 schwarze 525: term = '\0';
1.78 schwarze 526: cp = stesc + 1;
1.53 schwarze 527: switch (*cp) {
1.80 schwarze 528: case '*':
1.53 schwarze 529: res = NULL;
530: break;
1.80 schwarze 531: case 'B':
1.79 schwarze 532: /* FALLTHROUGH */
1.80 schwarze 533: case 'w':
1.79 schwarze 534: term = cp[1];
535: /* FALLTHROUGH */
1.80 schwarze 536: case 'n':
1.53 schwarze 537: res = ubuf;
538: break;
539: default:
1.78 schwarze 540: if (ESCAPE_ERROR == mandoc_escape(&cp, NULL, NULL))
1.92 schwarze 541: mandoc_vmsg(MANDOCERR_ESC_BAD,
542: r->parse, ln, (int)(stesc - *bufp),
543: "%.*s", (int)(cp - stesc), stesc);
1.78 schwarze 544: continue;
1.42 schwarze 545: }
546:
1.78 schwarze 547: if (EXPAND_LIMIT < ++expand_count) {
548: mandoc_msg(MANDOCERR_ROFFLOOP, r->parse,
549: ln, (int)(stesc - *bufp), NULL);
550: return(ROFF_IGN);
551: }
1.23 schwarze 552:
553: /*
554: * The third character decides the length
1.53 schwarze 555: * of the name of the string or register.
1.23 schwarze 556: * Save a pointer to the name.
557: */
558:
1.79 schwarze 559: if ('\0' == term) {
560: switch (*++cp) {
1.80 schwarze 561: case '\0':
1.79 schwarze 562: maxl = 0;
563: break;
1.80 schwarze 564: case '(':
1.79 schwarze 565: cp++;
566: maxl = 2;
567: break;
1.80 schwarze 568: case '[':
1.79 schwarze 569: cp++;
570: term = ']';
571: maxl = 0;
572: break;
573: default:
574: maxl = 1;
575: break;
576: }
577: } else {
578: cp += 2;
1.8 schwarze 579: maxl = 0;
580: }
1.23 schwarze 581: stnam = cp;
1.8 schwarze 582:
1.23 schwarze 583: /* Advance to the end of the name. */
1.8 schwarze 584:
1.91 schwarze 585: arg_complete = 1;
1.53 schwarze 586: for (naml = 0; 0 == maxl || naml < maxl; naml++, cp++) {
1.42 schwarze 587: if ('\0' == *cp) {
1.92 schwarze 588: mandoc_msg(MANDOCERR_ESC_BAD, r->parse,
589: ln, (int)(stesc - *bufp), stesc);
1.91 schwarze 590: arg_complete = 0;
1.79 schwarze 591: break;
1.42 schwarze 592: }
1.79 schwarze 593: if (0 == maxl && *cp == term) {
594: cp++;
1.8 schwarze 595: break;
1.79 schwarze 596: }
1.8 schwarze 597: }
598:
1.23 schwarze 599: /*
600: * Retrieve the replacement string; if it is
601: * undefined, resume searching for escapes.
602: */
603:
1.79 schwarze 604: switch (stesc[1]) {
1.80 schwarze 605: case '*':
1.91 schwarze 606: if (arg_complete)
607: res = roff_getstrn(r, stnam, naml);
1.79 schwarze 608: break;
1.80 schwarze 609: case 'B':
1.79 schwarze 610: npos = 0;
1.91 schwarze 611: ubuf[0] = arg_complete &&
612: roff_evalnum(stnam, &npos, NULL, 0) &&
613: stnam + npos + 1 == cp ? '1' : '0';
1.79 schwarze 614: ubuf[1] = '\0';
615: break;
1.80 schwarze 616: case 'n':
1.91 schwarze 617: if (arg_complete)
618: (void)snprintf(ubuf, sizeof(ubuf), "%d",
619: roff_getregn(r, stnam, naml));
620: else
621: ubuf[0] = '\0';
1.79 schwarze 622: break;
1.80 schwarze 623: case 'w':
1.91 schwarze 624: /* use even incomplete args */
1.81 schwarze 625: (void)snprintf(ubuf, sizeof(ubuf), "%d",
1.79 schwarze 626: 24 * (int)naml);
627: break;
628: }
1.8 schwarze 629:
630: if (NULL == res) {
1.92 schwarze 631: mandoc_vmsg(MANDOCERR_STR_UNDEF,
632: r->parse, ln, (int)(stesc - *bufp),
633: "%.*s", (int)naml, stnam);
1.37 schwarze 634: res = "";
1.8 schwarze 635: }
636:
1.23 schwarze 637: /* Replace the escape sequence by the string. */
638:
1.82 schwarze 639: *stesc = '\0';
640: *szp = mandoc_asprintf(&nbuf, "%s%s%s",
641: *bufp, res, cp) + 1;
1.8 schwarze 642:
1.78 schwarze 643: /* Prepare for the next replacement. */
1.8 schwarze 644:
1.78 schwarze 645: start = nbuf + pos;
1.82 schwarze 646: stesc = nbuf + (stesc - *bufp) + strlen(res);
1.8 schwarze 647: free(*bufp);
1.53 schwarze 648: *bufp = nbuf;
1.42 schwarze 649: }
1.45 schwarze 650: return(ROFF_CONT);
1.42 schwarze 651: }
652:
653: /*
1.51 schwarze 654: * Process text streams:
655: * Convert all breakable hyphens into ASCII_HYPH.
656: * Decrement and spring input line trap.
1.42 schwarze 657: */
658: static enum rofferr
1.51 schwarze 659: roff_parsetext(char **bufp, size_t *szp, int pos, int *offs)
1.42 schwarze 660: {
661: size_t sz;
662: const char *start;
1.51 schwarze 663: char *p;
664: int isz;
1.42 schwarze 665: enum mandoc_esc esc;
666:
1.51 schwarze 667: start = p = *bufp + pos;
1.42 schwarze 668:
669: while ('\0' != *p) {
670: sz = strcspn(p, "-\\");
671: p += sz;
672:
673: if ('\0' == *p)
674: break;
675:
676: if ('\\' == *p) {
677: /* Skip over escapes. */
678: p++;
1.62 schwarze 679: esc = mandoc_escape((const char **)&p, NULL, NULL);
1.42 schwarze 680: if (ESCAPE_ERROR == esc)
681: break;
682: continue;
683: } else if (p == start) {
684: p++;
685: continue;
686: }
687:
1.44 schwarze 688: if (isalpha((unsigned char)p[-1]) &&
689: isalpha((unsigned char)p[1]))
1.42 schwarze 690: *p = ASCII_HYPH;
691: p++;
1.8 schwarze 692: }
693:
1.51 schwarze 694: /* Spring the input line trap. */
695: if (1 == roffit_lines) {
1.75 schwarze 696: isz = mandoc_asprintf(&p, "%s\n.%s", *bufp, roffit_macro);
1.51 schwarze 697: free(*bufp);
698: *bufp = p;
699: *szp = isz + 1;
700: *offs = 0;
701: free(roffit_macro);
702: roffit_lines = 0;
703: return(ROFF_REPARSE);
704: } else if (1 < roffit_lines)
705: --roffit_lines;
1.42 schwarze 706: return(ROFF_CONT);
1.8 schwarze 707: }
708:
1.1 schwarze 709: enum rofferr
1.80 schwarze 710: roff_parseln(struct roff *r, int ln, char **bufp,
1.6 schwarze 711: size_t *szp, int pos, int *offs)
1.1 schwarze 712: {
713: enum rofft t;
1.27 schwarze 714: enum rofferr e;
1.35 schwarze 715: int ppos, ctl;
1.1 schwarze 716:
1.2 schwarze 717: /*
1.8 schwarze 718: * Run the reserved-word filter only if we have some reserved
719: * words to fill in.
720: */
721:
1.45 schwarze 722: e = roff_res(r, bufp, szp, ln, pos);
723: if (ROFF_IGN == e)
724: return(e);
725: assert(ROFF_CONT == e);
1.8 schwarze 726:
1.35 schwarze 727: ppos = pos;
1.48 schwarze 728: ctl = roff_getcontrol(r, *bufp, &pos);
1.35 schwarze 729:
1.8 schwarze 730: /*
1.2 schwarze 731: * First, if a scope is open and we're not a macro, pass the
732: * text through the macro's filter. If a scope isn't open and
733: * we're not a macro, just let it through.
1.32 schwarze 734: * Finally, if there's an equation scope open, divert it into it
735: * no matter our state.
1.2 schwarze 736: */
737:
1.35 schwarze 738: if (r->last && ! ctl) {
1.2 schwarze 739: t = r->last->tok;
740: assert(roffs[t].text);
1.80 schwarze 741: e = (*roffs[t].text)(r, t, bufp, szp, ln, pos, pos, offs);
1.27 schwarze 742: assert(ROFF_IGN == e || ROFF_CONT == e);
1.32 schwarze 743: if (ROFF_CONT != e)
744: return(e);
1.54 schwarze 745: }
746: if (r->eqn)
747: return(eqn_read(&r->eqn, ln, *bufp, ppos, offs));
748: if ( ! ctl) {
1.32 schwarze 749: if (r->tbl)
1.35 schwarze 750: return(tbl_read(r->tbl, ln, *bufp, pos));
1.51 schwarze 751: return(roff_parsetext(bufp, szp, pos, offs));
1.54 schwarze 752: }
1.2 schwarze 753:
754: /*
755: * If a scope is open, go to the child handler for that macro,
756: * as it may want to preprocess before doing anything with it.
1.32 schwarze 757: * Don't do so if an equation is open.
1.2 schwarze 758: */
759:
760: if (r->last) {
1.1 schwarze 761: t = r->last->tok;
762: assert(roffs[t].sub);
1.80 schwarze 763: return((*roffs[t].sub)(r, t, bufp, szp,
764: ln, ppos, pos, offs));
1.2 schwarze 765: }
766:
767: /*
768: * Lastly, as we've no scope open, try to look up and execute
769: * the new macro. If no macro is found, simply return and let
770: * the compilers handle it.
771: */
772:
1.87 schwarze 773: if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos, ln, ppos)))
1.1 schwarze 774: return(ROFF_CONT);
775:
1.2 schwarze 776: assert(roffs[t].proc);
1.80 schwarze 777: return((*roffs[t].proc)(r, t, bufp, szp, ln, ppos, pos, offs));
1.2 schwarze 778: }
779:
1.27 schwarze 780: void
1.2 schwarze 781: roff_endparse(struct roff *r)
782: {
1.1 schwarze 783:
1.27 schwarze 784: if (r->last)
1.35 schwarze 785: mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
1.80 schwarze 786: r->last->line, r->last->col, NULL);
1.27 schwarze 787:
1.32 schwarze 788: if (r->eqn) {
1.80 schwarze 789: mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
790: r->eqn->eqn.ln, r->eqn->eqn.pos, NULL);
1.41 schwarze 791: eqn_end(&r->eqn);
1.32 schwarze 792: }
793:
1.27 schwarze 794: if (r->tbl) {
1.80 schwarze 795: mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
796: r->tbl->line, r->tbl->pos, NULL);
1.41 schwarze 797: tbl_end(&r->tbl);
1.27 schwarze 798: }
1.1 schwarze 799: }
800:
801: /*
802: * Parse a roff node's type from the input buffer. This must be in the
803: * form of ".foo xxx" in the usual way.
804: */
805: static enum rofft
1.87 schwarze 806: roff_parse(struct roff *r, char *buf, int *pos, int ln, int ppos)
1.1 schwarze 807: {
1.87 schwarze 808: char *cp;
1.16 schwarze 809: const char *mac;
810: size_t maclen;
1.1 schwarze 811: enum rofft t;
812:
1.87 schwarze 813: cp = buf + *pos;
814:
815: if ('\0' == *cp || '"' == *cp || '\t' == *cp || ' ' == *cp)
1.1 schwarze 816: return(ROFF_MAX);
817:
1.87 schwarze 818: mac = cp;
819: maclen = roff_getname(r, &cp, ln, ppos);
1.1 schwarze 820:
1.16 schwarze 821: t = (r->current_string = roff_getstrn(r, mac, maclen))
1.42 schwarze 822: ? ROFF_USERDEF : roffhash_find(mac, maclen);
1.1 schwarze 823:
1.87 schwarze 824: if (ROFF_MAX != t)
825: *pos = cp - buf;
1.1 schwarze 826:
827: return(t);
828: }
829:
830: static enum rofferr
1.2 schwarze 831: roff_cblock(ROFF_ARGS)
1.1 schwarze 832: {
833:
1.2 schwarze 834: /*
835: * A block-close `..' should only be invoked as a child of an
836: * ignore macro, otherwise raise a warning and just ignore it.
837: */
838:
839: if (NULL == r->last) {
1.35 schwarze 840: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.2 schwarze 841: return(ROFF_IGN);
842: }
1.1 schwarze 843:
1.2 schwarze 844: switch (r->last->tok) {
1.80 schwarze 845: case ROFF_am:
1.93 ! schwarze 846: /* ROFF_am1 is remapped to ROFF_am in roff_block(). */
1.2 schwarze 847: /* FALLTHROUGH */
1.80 schwarze 848: case ROFF_ami:
1.2 schwarze 849: /* FALLTHROUGH */
1.80 schwarze 850: case ROFF_de:
1.23 schwarze 851: /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
1.2 schwarze 852: /* FALLTHROUGH */
1.80 schwarze 853: case ROFF_dei:
1.2 schwarze 854: /* FALLTHROUGH */
1.80 schwarze 855: case ROFF_ig:
1.2 schwarze 856: break;
857: default:
1.35 schwarze 858: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.1 schwarze 859: return(ROFF_IGN);
1.2 schwarze 860: }
861:
862: if ((*bufp)[pos])
1.90 schwarze 863: mandoc_vmsg(MANDOCERR_ARG_SKIP, r->parse, ln, pos,
864: ".. %s", *bufp + pos);
1.2 schwarze 865:
866: roffnode_pop(r);
867: roffnode_cleanscope(r);
868: return(ROFF_IGN);
869:
870: }
1.1 schwarze 871:
1.2 schwarze 872: static void
873: roffnode_cleanscope(struct roff *r)
874: {
1.1 schwarze 875:
1.2 schwarze 876: while (r->last) {
1.46 schwarze 877: if (--r->last->endspan != 0)
1.2 schwarze 878: break;
879: roffnode_pop(r);
880: }
881: }
1.1 schwarze 882:
1.68 schwarze 883: static void
884: roff_ccond(struct roff *r, int ln, int ppos)
1.2 schwarze 885: {
1.1 schwarze 886:
1.2 schwarze 887: if (NULL == r->last) {
1.35 schwarze 888: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.68 schwarze 889: return;
1.2 schwarze 890: }
1.1 schwarze 891:
1.2 schwarze 892: switch (r->last->tok) {
1.80 schwarze 893: case ROFF_el:
1.2 schwarze 894: /* FALLTHROUGH */
1.80 schwarze 895: case ROFF_ie:
1.2 schwarze 896: /* FALLTHROUGH */
1.80 schwarze 897: case ROFF_if:
1.2 schwarze 898: break;
899: default:
1.35 schwarze 900: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.68 schwarze 901: return;
1.2 schwarze 902: }
1.1 schwarze 903:
1.2 schwarze 904: if (r->last->endspan > -1) {
1.35 schwarze 905: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.68 schwarze 906: return;
1.2 schwarze 907: }
908:
909: roffnode_pop(r);
910: roffnode_cleanscope(r);
1.68 schwarze 911: return;
1.1 schwarze 912: }
913:
914: static enum rofferr
1.2 schwarze 915: roff_block(ROFF_ARGS)
1.1 schwarze 916: {
1.93 ! schwarze 917: const char *name;
! 918: char *iname, *cp;
1.86 schwarze 919: size_t namesz;
1.16 schwarze 920:
1.93 ! schwarze 921: /* Ignore groff compatibility mode for now. */
1.2 schwarze 922:
1.93 ! schwarze 923: if (ROFF_de1 == tok)
! 924: tok = ROFF_de;
! 925: else if (ROFF_am1 == tok)
! 926: tok = ROFF_am;
! 927:
! 928: /* Parse the macro name argument. */
! 929:
! 930: cp = *bufp + pos;
! 931: if (ROFF_ig == tok) {
! 932: iname = NULL;
! 933: namesz = 0;
! 934: } else {
! 935: iname = cp;
! 936: namesz = roff_getname(r, &cp, ln, ppos);
! 937: iname[namesz] = '\0';
! 938: }
1.22 schwarze 939:
1.93 ! schwarze 940: /* Resolve the macro name argument if it is indirect. */
1.22 schwarze 941:
1.93 ! schwarze 942: if (namesz && (ROFF_dei == tok || ROFF_ami == tok)) {
! 943: if (NULL == (name = roff_getstrn(r, iname, namesz))) {
! 944: mandoc_vmsg(MANDOCERR_STR_UNDEF,
! 945: r->parse, ln, (int)(iname - *bufp),
! 946: "%.*s", (int)namesz, iname);
! 947: namesz = 0;
! 948: } else
! 949: namesz = strlen(name);
! 950: } else
! 951: name = iname;
1.22 schwarze 952:
1.93 ! schwarze 953: if (0 == namesz && ROFF_ig != tok) {
! 954: mandoc_msg(MANDOCERR_REQ_EMPTY, r->parse,
! 955: ln, ppos, roffs[tok].name);
! 956: return(ROFF_IGN);
! 957: }
1.2 schwarze 958:
1.16 schwarze 959: roffnode_push(r, tok, name, ln, ppos);
960:
961: /*
962: * At the beginning of a `de' macro, clear the existing string
963: * with the same name, if there is one. New content will be
1.66 schwarze 964: * appended from roff_block_text() in multiline mode.
1.16 schwarze 965: */
1.22 schwarze 966:
1.93 ! schwarze 967: if (ROFF_de == tok || ROFF_dei == tok)
1.86 schwarze 968: roff_setstrn(&r->strtab, name, namesz, "", 0, 0);
1.2 schwarze 969:
1.86 schwarze 970: if ('\0' == *cp)
1.2 schwarze 971: return(ROFF_IGN);
1.1 schwarze 972:
1.93 ! schwarze 973: /* Get the custom end marker. */
1.22 schwarze 974:
1.93 ! schwarze 975: iname = cp;
1.86 schwarze 976: namesz = roff_getname(r, &cp, ln, ppos);
1.93 ! schwarze 977:
! 978: /* Resolve the end marker if it is indirect. */
! 979:
! 980: if (namesz && (ROFF_dei == tok || ROFF_ami == tok)) {
! 981: if (NULL == (name = roff_getstrn(r, iname, namesz))) {
! 982: mandoc_vmsg(MANDOCERR_STR_UNDEF,
! 983: r->parse, ln, (int)(iname - *bufp),
! 984: "%.*s", (int)namesz, iname);
! 985: namesz = 0;
! 986: } else
! 987: namesz = strlen(name);
! 988: } else
! 989: name = iname;
! 990:
1.86 schwarze 991: if (namesz)
992: r->last->end = mandoc_strndup(name, namesz);
1.2 schwarze 993:
1.86 schwarze 994: if ('\0' != *cp)
1.90 schwarze 995: mandoc_vmsg(MANDOCERR_ARG_EXCESS, r->parse,
996: ln, pos, ".%s ... %s", roffs[tok].name, cp);
1.1 schwarze 997:
998: return(ROFF_IGN);
999: }
1000:
1001: static enum rofferr
1.2 schwarze 1002: roff_block_sub(ROFF_ARGS)
1.1 schwarze 1003: {
1.2 schwarze 1004: enum rofft t;
1005: int i, j;
1006:
1007: /*
1008: * First check whether a custom macro exists at this level. If
1009: * it does, then check against it. This is some of groff's
1010: * stranger behaviours. If we encountered a custom end-scope
1011: * tag and that tag also happens to be a "real" macro, then we
1012: * need to try interpreting it again as a real macro. If it's
1013: * not, then return ignore. Else continue.
1014: */
1015:
1016: if (r->last->end) {
1.35 schwarze 1017: for (i = pos, j = 0; r->last->end[j]; j++, i++)
1.2 schwarze 1018: if ((*bufp)[i] != r->last->end[j])
1019: break;
1.1 schwarze 1020:
1.80 schwarze 1021: if ('\0' == r->last->end[j] &&
1022: ('\0' == (*bufp)[i] ||
1023: ' ' == (*bufp)[i] ||
1024: '\t' == (*bufp)[i])) {
1.2 schwarze 1025: roffnode_pop(r);
1026: roffnode_cleanscope(r);
1.1 schwarze 1027:
1.35 schwarze 1028: while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
1029: i++;
1030:
1031: pos = i;
1.87 schwarze 1032: if (ROFF_MAX != roff_parse(r, *bufp, &pos, ln, ppos))
1.2 schwarze 1033: return(ROFF_RERUN);
1034: return(ROFF_IGN);
1035: }
1.1 schwarze 1036: }
1037:
1.2 schwarze 1038: /*
1039: * If we have no custom end-query or lookup failed, then try
1040: * pulling it out of the hashtable.
1041: */
1.1 schwarze 1042:
1.87 schwarze 1043: t = roff_parse(r, *bufp, &pos, ln, ppos);
1.1 schwarze 1044:
1.16 schwarze 1045: if (ROFF_cblock != t) {
1.93 ! schwarze 1046: if (ROFF_ig != tok)
1.66 schwarze 1047: roff_setstr(r, r->last->name, *bufp + ppos, 2);
1.1 schwarze 1048: return(ROFF_IGN);
1.16 schwarze 1049: }
1.1 schwarze 1050:
1.2 schwarze 1051: assert(roffs[t].proc);
1.80 schwarze 1052: return((*roffs[t].proc)(r, t, bufp, szp, ln, ppos, pos, offs));
1.2 schwarze 1053: }
1054:
1055: static enum rofferr
1056: roff_block_text(ROFF_ARGS)
1057: {
1058:
1.93 ! schwarze 1059: if (ROFF_ig != tok)
1.66 schwarze 1060: roff_setstr(r, r->last->name, *bufp + pos, 2);
1.16 schwarze 1061:
1.2 schwarze 1062: return(ROFF_IGN);
1063: }
1064:
1065: static enum rofferr
1066: roff_cond_sub(ROFF_ARGS)
1067: {
1068: enum rofft t;
1.37 schwarze 1069: char *ep;
1.71 schwarze 1070: int rr;
1.2 schwarze 1071:
1072: rr = r->last->rule;
1.37 schwarze 1073: roffnode_cleanscope(r);
1.87 schwarze 1074: t = roff_parse(r, *bufp, &pos, ln, ppos);
1.2 schwarze 1075:
1.37 schwarze 1076: /*
1.50 schwarze 1077: * Fully handle known macros when they are structurally
1078: * required or when the conditional evaluated to true.
1.5 schwarze 1079: */
1080:
1.50 schwarze 1081: if ((ROFF_MAX != t) &&
1.71 schwarze 1082: (rr || ROFFMAC_STRUCT & roffs[t].flags)) {
1.50 schwarze 1083: assert(roffs[t].proc);
1084: return((*roffs[t].proc)(r, t, bufp, szp,
1.80 schwarze 1085: ln, ppos, pos, offs));
1.50 schwarze 1086: }
1.39 schwarze 1087:
1.69 schwarze 1088: /*
1089: * If `\}' occurs on a macro line without a preceding macro,
1090: * drop the line completely.
1091: */
1092:
1093: ep = *bufp + pos;
1094: if ('\\' == ep[0] && '}' == ep[1])
1.71 schwarze 1095: rr = 0;
1.69 schwarze 1096:
1.50 schwarze 1097: /* Always check for the closing delimiter `\}'. */
1.39 schwarze 1098:
1.50 schwarze 1099: while (NULL != (ep = strchr(ep, '\\'))) {
1.70 schwarze 1100: if ('}' == *(++ep)) {
1101: *ep = '&';
1102: roff_ccond(r, ln, ep - *bufp - 1);
1103: }
1104: ++ep;
1.50 schwarze 1105: }
1.71 schwarze 1106: return(rr ? ROFF_CONT : ROFF_IGN);
1.2 schwarze 1107: }
1108:
1109: static enum rofferr
1110: roff_cond_text(ROFF_ARGS)
1111: {
1.37 schwarze 1112: char *ep;
1.71 schwarze 1113: int rr;
1.2 schwarze 1114:
1115: rr = r->last->rule;
1.37 schwarze 1116: roffnode_cleanscope(r);
1.1 schwarze 1117:
1.70 schwarze 1118: ep = *bufp + pos;
1119: while (NULL != (ep = strchr(ep, '\\'))) {
1120: if ('}' == *(++ep)) {
1121: *ep = '&';
1122: roff_ccond(r, ln, ep - *bufp - 1);
1123: }
1124: ++ep;
1.2 schwarze 1125: }
1.71 schwarze 1126: return(rr ? ROFF_CONT : ROFF_IGN);
1.2 schwarze 1127: }
1128:
1.77 schwarze 1129: /*
1130: * Parse a single signed integer number. Stop at the first non-digit.
1131: * If there is at least one digit, return success and advance the
1132: * parse point, else return failure and let the parse point unchanged.
1133: * Ignore overflows, treat them just like the C language.
1134: */
1.56 schwarze 1135: static int
1136: roff_getnum(const char *v, int *pos, int *res)
1137: {
1.79 schwarze 1138: int myres, n, p;
1139:
1140: if (NULL == res)
1141: res = &myres;
1.56 schwarze 1142:
1143: p = *pos;
1144: n = v[p] == '-';
1145: if (n)
1146: p++;
1147:
1148: for (*res = 0; isdigit((unsigned char)v[p]); p++)
1.77 schwarze 1149: *res = 10 * *res + v[p] - '0';
1.56 schwarze 1150: if (p == *pos + n)
1151: return 0;
1152:
1153: if (n)
1154: *res = -*res;
1155:
1156: *pos = p;
1157: return 1;
1158: }
1159:
1.71 schwarze 1160: /*
1161: * Evaluate a string comparison condition.
1162: * The first character is the delimiter.
1163: * Succeed if the string up to its second occurrence
1164: * matches the string up to its third occurence.
1165: * Advance the cursor after the third occurrence
1166: * or lacking that, to the end of the line.
1167: */
1168: static int
1169: roff_evalstrcond(const char *v, int *pos)
1170: {
1171: const char *s1, *s2, *s3;
1172: int match;
1173:
1174: match = 0;
1175: s1 = v + *pos; /* initial delimiter */
1176: s2 = s1 + 1; /* for scanning the first string */
1177: s3 = strchr(s2, *s1); /* for scanning the second string */
1178:
1179: if (NULL == s3) /* found no middle delimiter */
1180: goto out;
1181:
1182: while ('\0' != *++s3) {
1183: if (*s2 != *s3) { /* mismatch */
1184: s3 = strchr(s3, *s1);
1185: break;
1186: }
1187: if (*s3 == *s1) { /* found the final delimiter */
1188: match = 1;
1189: break;
1190: }
1191: s2++;
1192: }
1193:
1194: out:
1195: if (NULL == s3)
1196: s3 = strchr(s2, '\0');
1197: else
1198: s3++;
1199: *pos = s3 - v;
1200: return(match);
1201: }
1202:
1.77 schwarze 1203: /*
1204: * Evaluate an optionally negated single character, numerical,
1205: * or string condition.
1206: */
1.71 schwarze 1207: static int
1.5 schwarze 1208: roff_evalcond(const char *v, int *pos)
1209: {
1.77 schwarze 1210: int wanttrue, number;
1.5 schwarze 1211:
1.71 schwarze 1212: if ('!' == v[*pos]) {
1213: wanttrue = 0;
1214: (*pos)++;
1215: } else
1216: wanttrue = 1;
1217:
1.5 schwarze 1218: switch (v[*pos]) {
1.80 schwarze 1219: case 'n':
1.71 schwarze 1220: /* FALLTHROUGH */
1.80 schwarze 1221: case 'o':
1.5 schwarze 1222: (*pos)++;
1.71 schwarze 1223: return(wanttrue);
1.80 schwarze 1224: case 'c':
1.71 schwarze 1225: /* FALLTHROUGH */
1.80 schwarze 1226: case 'd':
1.71 schwarze 1227: /* FALLTHROUGH */
1.80 schwarze 1228: case 'e':
1.5 schwarze 1229: /* FALLTHROUGH */
1.80 schwarze 1230: case 'r':
1.5 schwarze 1231: /* FALLTHROUGH */
1.80 schwarze 1232: case 't':
1.5 schwarze 1233: (*pos)++;
1.71 schwarze 1234: return(!wanttrue);
1.5 schwarze 1235: default:
1236: break;
1237: }
1238:
1.77 schwarze 1239: if (roff_evalnum(v, pos, &number, 0))
1240: return((number > 0) == wanttrue);
1241: else
1.71 schwarze 1242: return(roff_evalstrcond(v, pos) == wanttrue);
1.5 schwarze 1243: }
1244:
1.2 schwarze 1245: static enum rofferr
1.21 schwarze 1246: roff_line_ignore(ROFF_ARGS)
1.6 schwarze 1247: {
1.30 schwarze 1248:
1.21 schwarze 1249: return(ROFF_IGN);
1250: }
1251:
1252: static enum rofferr
1.2 schwarze 1253: roff_cond(ROFF_ARGS)
1254: {
1.46 schwarze 1255:
1256: roffnode_push(r, tok, NULL, ln, ppos);
1.2 schwarze 1257:
1.80 schwarze 1258: /*
1.35 schwarze 1259: * An `.el' has no conditional body: it will consume the value
1260: * of the current rstack entry set in prior `ie' calls or
1.80 schwarze 1261: * defaults to DENY.
1.35 schwarze 1262: *
1263: * If we're not an `el', however, then evaluate the conditional.
1264: */
1.1 schwarze 1265:
1.46 schwarze 1266: r->last->rule = ROFF_el == tok ?
1.80 schwarze 1267: (r->rstackpos < 0 ? 0 : r->rstack[r->rstackpos--]) :
1268: roff_evalcond(*bufp, &pos);
1.2 schwarze 1269:
1.35 schwarze 1270: /*
1271: * An if-else will put the NEGATION of the current evaluated
1272: * conditional into the stack of rules.
1273: */
1274:
1.2 schwarze 1275: if (ROFF_ie == tok) {
1.35 schwarze 1276: if (r->rstackpos == RSTACK_MAX - 1) {
1.80 schwarze 1277: mandoc_msg(MANDOCERR_MEM,
1278: r->parse, ln, ppos, NULL);
1.35 schwarze 1279: return(ROFF_ERR);
1280: }
1.71 schwarze 1281: r->rstack[++r->rstackpos] = !r->last->rule;
1.2 schwarze 1282: }
1.5 schwarze 1283:
1284: /* If the parent has false as its rule, then so do we. */
1285:
1.71 schwarze 1286: if (r->last->parent && !r->last->parent->rule)
1287: r->last->rule = 0;
1.5 schwarze 1288:
1289: /*
1.46 schwarze 1290: * Determine scope.
1291: * If there is nothing on the line after the conditional,
1292: * not even whitespace, use next-line scope.
1.5 schwarze 1293: */
1.2 schwarze 1294:
1.46 schwarze 1295: if ('\0' == (*bufp)[pos]) {
1296: r->last->endspan = 2;
1297: goto out;
1298: }
1299:
1300: while (' ' == (*bufp)[pos])
1301: pos++;
1302:
1303: /* An opening brace requests multiline scope. */
1.2 schwarze 1304:
1305: if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
1306: r->last->endspan = -1;
1307: pos += 2;
1.46 schwarze 1308: goto out;
1.80 schwarze 1309: }
1.2 schwarze 1310:
1311: /*
1.46 schwarze 1312: * Anything else following the conditional causes
1313: * single-line scope. Warn if the scope contains
1314: * nothing but trailing whitespace.
1.2 schwarze 1315: */
1316:
1317: if ('\0' == (*bufp)[pos])
1.89 schwarze 1318: mandoc_msg(MANDOCERR_COND_EMPTY, r->parse,
1319: ln, ppos, roffs[tok].name);
1.2 schwarze 1320:
1.46 schwarze 1321: r->last->endspan = 1;
1.1 schwarze 1322:
1.46 schwarze 1323: out:
1.2 schwarze 1324: *offs = pos;
1325: return(ROFF_RERUN);
1.1 schwarze 1326: }
1327:
1.2 schwarze 1328: static enum rofferr
1.7 schwarze 1329: roff_ds(ROFF_ARGS)
1330: {
1.85 schwarze 1331: char *string;
1332: const char *name;
1333: size_t namesz;
1.10 schwarze 1334:
1335: /*
1.85 schwarze 1336: * The first word is the name of the string.
1337: * If it is empty or terminated by an escape sequence,
1338: * abort the `ds' request without defining anything.
1.10 schwarze 1339: */
1.7 schwarze 1340:
1.85 schwarze 1341: name = string = *bufp + pos;
1.7 schwarze 1342: if ('\0' == *name)
1343: return(ROFF_IGN);
1344:
1.85 schwarze 1345: namesz = roff_getname(r, &string, ln, pos);
1346: if ('\\' == name[namesz])
1347: return(ROFF_IGN);
1348:
1349: /* Read past the initial double-quote, if any. */
1.28 schwarze 1350: if ('"' == *string)
1.7 schwarze 1351: string++;
1352:
1.10 schwarze 1353: /* The rest is the value. */
1.85 schwarze 1354: roff_setstrn(&r->strtab, name, namesz, string, strlen(string),
1355: ROFF_as == tok);
1.7 schwarze 1356: return(ROFF_IGN);
1357: }
1358:
1.77 schwarze 1359: /*
1360: * Parse a single operator, one or two characters long.
1361: * If the operator is recognized, return success and advance the
1362: * parse point, else return failure and let the parse point unchanged.
1363: */
1364: static int
1365: roff_getop(const char *v, int *pos, char *res)
1366: {
1367:
1368: *res = v[*pos];
1369:
1370: switch (*res) {
1.80 schwarze 1371: case '+':
1.77 schwarze 1372: /* FALLTHROUGH */
1.80 schwarze 1373: case '-':
1.77 schwarze 1374: /* FALLTHROUGH */
1.80 schwarze 1375: case '*':
1.77 schwarze 1376: /* FALLTHROUGH */
1.80 schwarze 1377: case '/':
1.77 schwarze 1378: /* FALLTHROUGH */
1.80 schwarze 1379: case '%':
1.77 schwarze 1380: /* FALLTHROUGH */
1.80 schwarze 1381: case '&':
1.77 schwarze 1382: /* FALLTHROUGH */
1.80 schwarze 1383: case ':':
1.77 schwarze 1384: break;
1385: case '<':
1386: switch (v[*pos + 1]) {
1.80 schwarze 1387: case '=':
1.77 schwarze 1388: *res = 'l';
1389: (*pos)++;
1390: break;
1.80 schwarze 1391: case '>':
1.77 schwarze 1392: *res = '!';
1393: (*pos)++;
1394: break;
1.80 schwarze 1395: case '?':
1.77 schwarze 1396: *res = 'i';
1397: (*pos)++;
1398: break;
1399: default:
1400: break;
1401: }
1402: break;
1403: case '>':
1404: switch (v[*pos + 1]) {
1.80 schwarze 1405: case '=':
1.77 schwarze 1406: *res = 'g';
1407: (*pos)++;
1408: break;
1.80 schwarze 1409: case '?':
1.77 schwarze 1410: *res = 'a';
1411: (*pos)++;
1412: break;
1413: default:
1414: break;
1415: }
1416: break;
1417: case '=':
1418: if ('=' == v[*pos + 1])
1419: (*pos)++;
1420: break;
1421: default:
1422: return(0);
1423: }
1424: (*pos)++;
1425:
1426: return(*res);
1427: }
1428:
1429: /*
1430: * Evaluate either a parenthesized numeric expression
1431: * or a single signed integer number.
1432: */
1433: static int
1434: roff_evalpar(const char *v, int *pos, int *res)
1435: {
1436:
1437: if ('(' != v[*pos])
1438: return(roff_getnum(v, pos, res));
1439:
1440: (*pos)++;
1441: if ( ! roff_evalnum(v, pos, res, 1))
1442: return(0);
1443:
1.79 schwarze 1444: /*
1445: * Omission of the closing parenthesis
1446: * is an error in validation mode,
1447: * but ignored in evaluation mode.
1448: */
1449:
1.77 schwarze 1450: if (')' == v[*pos])
1451: (*pos)++;
1.79 schwarze 1452: else if (NULL == res)
1453: return(0);
1.77 schwarze 1454:
1455: return(1);
1456: }
1457:
1458: /*
1459: * Evaluate a complete numeric expression.
1460: * Proceed left to right, there is no concept of precedence.
1461: */
1462: static int
1463: roff_evalnum(const char *v, int *pos, int *res, int skipwhite)
1464: {
1465: int mypos, operand2;
1466: char operator;
1467:
1468: if (NULL == pos) {
1469: mypos = 0;
1470: pos = &mypos;
1471: }
1472:
1473: if (skipwhite)
1474: while (isspace((unsigned char)v[*pos]))
1475: (*pos)++;
1476:
1477: if ( ! roff_evalpar(v, pos, res))
1478: return(0);
1479:
1480: while (1) {
1481: if (skipwhite)
1482: while (isspace((unsigned char)v[*pos]))
1483: (*pos)++;
1484:
1485: if ( ! roff_getop(v, pos, &operator))
1486: break;
1487:
1488: if (skipwhite)
1489: while (isspace((unsigned char)v[*pos]))
1490: (*pos)++;
1491:
1492: if ( ! roff_evalpar(v, pos, &operand2))
1493: return(0);
1494:
1495: if (skipwhite)
1496: while (isspace((unsigned char)v[*pos]))
1497: (*pos)++;
1.79 schwarze 1498:
1499: if (NULL == res)
1500: continue;
1.77 schwarze 1501:
1502: switch (operator) {
1.80 schwarze 1503: case '+':
1.77 schwarze 1504: *res += operand2;
1505: break;
1.80 schwarze 1506: case '-':
1.77 schwarze 1507: *res -= operand2;
1508: break;
1.80 schwarze 1509: case '*':
1.77 schwarze 1510: *res *= operand2;
1511: break;
1.80 schwarze 1512: case '/':
1.77 schwarze 1513: *res /= operand2;
1514: break;
1.80 schwarze 1515: case '%':
1.77 schwarze 1516: *res %= operand2;
1517: break;
1.80 schwarze 1518: case '<':
1.77 schwarze 1519: *res = *res < operand2;
1520: break;
1.80 schwarze 1521: case '>':
1.77 schwarze 1522: *res = *res > operand2;
1523: break;
1.80 schwarze 1524: case 'l':
1.77 schwarze 1525: *res = *res <= operand2;
1526: break;
1.80 schwarze 1527: case 'g':
1.77 schwarze 1528: *res = *res >= operand2;
1529: break;
1.80 schwarze 1530: case '=':
1.77 schwarze 1531: *res = *res == operand2;
1532: break;
1.80 schwarze 1533: case '!':
1.77 schwarze 1534: *res = *res != operand2;
1535: break;
1.80 schwarze 1536: case '&':
1.77 schwarze 1537: *res = *res && operand2;
1538: break;
1.80 schwarze 1539: case ':':
1.77 schwarze 1540: *res = *res || operand2;
1541: break;
1.80 schwarze 1542: case 'i':
1.77 schwarze 1543: if (operand2 < *res)
1544: *res = operand2;
1545: break;
1.80 schwarze 1546: case 'a':
1.77 schwarze 1547: if (operand2 > *res)
1548: *res = operand2;
1549: break;
1550: default:
1551: abort();
1552: }
1553: }
1554: return(1);
1555: }
1556:
1.52 schwarze 1557: void
1.60 schwarze 1558: roff_setreg(struct roff *r, const char *name, int val, char sign)
1.41 schwarze 1559: {
1.52 schwarze 1560: struct roffreg *reg;
1561:
1562: /* Search for an existing register with the same name. */
1563: reg = r->regtab;
1564:
1565: while (reg && strcmp(name, reg->key.p))
1566: reg = reg->next;
1.41 schwarze 1567:
1.52 schwarze 1568: if (NULL == reg) {
1569: /* Create a new register. */
1570: reg = mandoc_malloc(sizeof(struct roffreg));
1571: reg->key.p = mandoc_strdup(name);
1572: reg->key.sz = strlen(name);
1.60 schwarze 1573: reg->val = 0;
1.52 schwarze 1574: reg->next = r->regtab;
1575: r->regtab = reg;
1576: }
1577:
1.60 schwarze 1578: if ('+' == sign)
1579: reg->val += val;
1580: else if ('-' == sign)
1581: reg->val -= val;
1582: else
1583: reg->val = val;
1.41 schwarze 1584: }
1585:
1.65 schwarze 1586: /*
1587: * Handle some predefined read-only number registers.
1588: * For now, return -1 if the requested register is not predefined;
1589: * in case a predefined read-only register having the value -1
1590: * were to turn up, another special value would have to be chosen.
1591: */
1592: static int
1593: roff_getregro(const char *name)
1594: {
1595:
1596: switch (*name) {
1.80 schwarze 1597: case 'A': /* ASCII approximation mode is always off. */
1.65 schwarze 1598: return(0);
1.80 schwarze 1599: case 'g': /* Groff compatibility mode is always on. */
1.65 schwarze 1600: return(1);
1.80 schwarze 1601: case 'H': /* Fixed horizontal resolution. */
1.65 schwarze 1602: return (24);
1.80 schwarze 1603: case 'j': /* Always adjust left margin only. */
1.65 schwarze 1604: return(0);
1.80 schwarze 1605: case 'T': /* Some output device is always defined. */
1.65 schwarze 1606: return(1);
1.80 schwarze 1607: case 'V': /* Fixed vertical resolution. */
1.65 schwarze 1608: return (40);
1609: default:
1610: return (-1);
1611: }
1612: }
1613:
1.53 schwarze 1614: int
1.52 schwarze 1615: roff_getreg(const struct roff *r, const char *name)
1.41 schwarze 1616: {
1.52 schwarze 1617: struct roffreg *reg;
1.65 schwarze 1618: int val;
1619:
1620: if ('.' == name[0] && '\0' != name[1] && '\0' == name[2]) {
1621: val = roff_getregro(name + 1);
1622: if (-1 != val)
1623: return (val);
1624: }
1.52 schwarze 1625:
1626: for (reg = r->regtab; reg; reg = reg->next)
1627: if (0 == strcmp(name, reg->key.p))
1.53 schwarze 1628: return(reg->val);
1629:
1630: return(0);
1631: }
1632:
1633: static int
1634: roff_getregn(const struct roff *r, const char *name, size_t len)
1635: {
1636: struct roffreg *reg;
1.65 schwarze 1637: int val;
1638:
1639: if ('.' == name[0] && 2 == len) {
1640: val = roff_getregro(name + 1);
1641: if (-1 != val)
1642: return (val);
1643: }
1.53 schwarze 1644:
1645: for (reg = r->regtab; reg; reg = reg->next)
1646: if (len == reg->key.sz &&
1647: 0 == strncmp(name, reg->key.p, len))
1648: return(reg->val);
1.41 schwarze 1649:
1.52 schwarze 1650: return(0);
1.41 schwarze 1651: }
1652:
1.52 schwarze 1653: static void
1654: roff_freereg(struct roffreg *reg)
1.41 schwarze 1655: {
1.52 schwarze 1656: struct roffreg *old_reg;
1.41 schwarze 1657:
1.52 schwarze 1658: while (NULL != reg) {
1659: free(reg->key.p);
1660: old_reg = reg;
1661: reg = reg->next;
1662: free(old_reg);
1663: }
1.41 schwarze 1664: }
1.7 schwarze 1665:
1666: static enum rofferr
1.6 schwarze 1667: roff_nr(ROFF_ARGS)
1.1 schwarze 1668: {
1.85 schwarze 1669: char *key, *val;
1670: size_t keysz;
1.37 schwarze 1671: int iv;
1.60 schwarze 1672: char sign;
1.6 schwarze 1673:
1.85 schwarze 1674: key = val = *bufp + pos;
1675: if ('\0' == *key)
1676: return(ROFF_IGN);
1677:
1678: keysz = roff_getname(r, &val, ln, pos);
1679: if ('\\' == key[keysz])
1680: return(ROFF_IGN);
1681: key[keysz] = '\0';
1.6 schwarze 1682:
1.60 schwarze 1683: sign = *val;
1684: if ('+' == sign || '-' == sign)
1685: val++;
1686:
1.77 schwarze 1687: if (roff_evalnum(val, NULL, &iv, 0))
1688: roff_setreg(r, key, iv, sign);
1.1 schwarze 1689:
1.76 schwarze 1690: return(ROFF_IGN);
1691: }
1692:
1693: static enum rofferr
1694: roff_rr(ROFF_ARGS)
1695: {
1696: struct roffreg *reg, **prev;
1.85 schwarze 1697: char *name, *cp;
1698: size_t namesz;
1.76 schwarze 1699:
1.85 schwarze 1700: name = cp = *bufp + pos;
1701: if ('\0' == *name)
1702: return(ROFF_IGN);
1703: namesz = roff_getname(r, &cp, ln, pos);
1704: name[namesz] = '\0';
1.76 schwarze 1705:
1706: prev = &r->regtab;
1707: while (1) {
1708: reg = *prev;
1709: if (NULL == reg || !strcmp(name, reg->key.p))
1710: break;
1711: prev = ®->next;
1712: }
1713: if (NULL != reg) {
1714: *prev = reg->next;
1715: free(reg->key.p);
1716: free(reg);
1717: }
1.29 schwarze 1718: return(ROFF_IGN);
1719: }
1720:
1721: static enum rofferr
1722: roff_rm(ROFF_ARGS)
1723: {
1724: const char *name;
1725: char *cp;
1.85 schwarze 1726: size_t namesz;
1.29 schwarze 1727:
1728: cp = *bufp + pos;
1729: while ('\0' != *cp) {
1.85 schwarze 1730: name = cp;
1731: namesz = roff_getname(r, &cp, ln, (int)(cp - *bufp));
1732: roff_setstrn(&r->strtab, name, namesz, NULL, 0, 0);
1733: if ('\\' == name[namesz])
1734: break;
1.29 schwarze 1735: }
1.51 schwarze 1736: return(ROFF_IGN);
1737: }
1738:
1739: static enum rofferr
1740: roff_it(ROFF_ARGS)
1741: {
1742: char *cp;
1743: size_t len;
1744: int iv;
1745:
1746: /* Parse the number of lines. */
1747: cp = *bufp + pos;
1748: len = strcspn(cp, " \t");
1749: cp[len] = '\0';
1750: if ((iv = mandoc_strntoi(cp, len, 10)) <= 0) {
1751: mandoc_msg(MANDOCERR_NUMERIC, r->parse,
1.80 schwarze 1752: ln, ppos, *bufp + 1);
1.51 schwarze 1753: return(ROFF_IGN);
1754: }
1755: cp += len + 1;
1756:
1757: /* Arm the input line trap. */
1758: roffit_lines = iv;
1759: roffit_macro = mandoc_strdup(cp);
1.2 schwarze 1760: return(ROFF_IGN);
1.47 schwarze 1761: }
1762:
1763: static enum rofferr
1764: roff_Dd(ROFF_ARGS)
1765: {
1766: const char *const *cp;
1767:
1.72 schwarze 1768: if (0 == ((MPARSE_MDOC | MPARSE_QUICK) & r->options))
1.47 schwarze 1769: for (cp = __mdoc_reserved; *cp; cp++)
1770: roff_setstr(r, *cp, NULL, 0);
1771:
1772: return(ROFF_CONT);
1773: }
1774:
1775: static enum rofferr
1776: roff_TH(ROFF_ARGS)
1777: {
1778: const char *const *cp;
1779:
1.72 schwarze 1780: if (0 == (MPARSE_QUICK & r->options))
1.47 schwarze 1781: for (cp = __man_reserved; *cp; cp++)
1782: roff_setstr(r, *cp, NULL, 0);
1783:
1784: return(ROFF_CONT);
1.14 schwarze 1785: }
1786:
1787: static enum rofferr
1.27 schwarze 1788: roff_TE(ROFF_ARGS)
1789: {
1790:
1791: if (NULL == r->tbl)
1.35 schwarze 1792: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.27 schwarze 1793: else
1.41 schwarze 1794: tbl_end(&r->tbl);
1.27 schwarze 1795:
1796: return(ROFF_IGN);
1797: }
1798:
1799: static enum rofferr
1800: roff_T_(ROFF_ARGS)
1801: {
1802:
1803: if (NULL == r->tbl)
1.35 schwarze 1804: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.27 schwarze 1805: else
1806: tbl_restart(ppos, ln, r->tbl);
1807:
1808: return(ROFF_IGN);
1809: }
1810:
1.41 schwarze 1811: #if 0
1812: static int
1813: roff_closeeqn(struct roff *r)
1814: {
1815:
1816: return(r->eqn && ROFF_EQN == eqn_end(&r->eqn) ? 1 : 0);
1817: }
1818: #endif
1819:
1820: static void
1.80 schwarze 1821: roff_openeqn(struct roff *r, const char *name, int line,
1.41 schwarze 1822: int offs, const char *buf)
1.32 schwarze 1823: {
1.41 schwarze 1824: struct eqn_node *e;
1825: int poff;
1.32 schwarze 1826:
1827: assert(NULL == r->eqn);
1.41 schwarze 1828: e = eqn_alloc(name, offs, line, r->parse);
1.32 schwarze 1829:
1830: if (r->last_eqn)
1831: r->last_eqn->next = e;
1832: else
1833: r->first_eqn = r->last_eqn = e;
1834:
1835: r->eqn = r->last_eqn = e;
1.41 schwarze 1836:
1837: if (buf) {
1838: poff = 0;
1839: eqn_read(&r->eqn, line, buf, offs, &poff);
1840: }
1841: }
1842:
1843: static enum rofferr
1844: roff_EQ(ROFF_ARGS)
1845: {
1846:
1847: roff_openeqn(r, *bufp + pos, ln, ppos, NULL);
1.32 schwarze 1848: return(ROFF_IGN);
1849: }
1850:
1851: static enum rofferr
1852: roff_EN(ROFF_ARGS)
1853: {
1854:
1.35 schwarze 1855: mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
1.32 schwarze 1856: return(ROFF_IGN);
1857: }
1858:
1859: static enum rofferr
1.27 schwarze 1860: roff_TS(ROFF_ARGS)
1861: {
1.49 schwarze 1862: struct tbl_node *tbl;
1.27 schwarze 1863:
1864: if (r->tbl) {
1.35 schwarze 1865: mandoc_msg(MANDOCERR_SCOPEBROKEN, r->parse, ln, ppos, NULL);
1.41 schwarze 1866: tbl_end(&r->tbl);
1.27 schwarze 1867: }
1868:
1.49 schwarze 1869: tbl = tbl_alloc(ppos, ln, r->parse);
1.27 schwarze 1870:
1871: if (r->last_tbl)
1.49 schwarze 1872: r->last_tbl->next = tbl;
1.27 schwarze 1873: else
1.49 schwarze 1874: r->first_tbl = r->last_tbl = tbl;
1.27 schwarze 1875:
1.49 schwarze 1876: r->tbl = r->last_tbl = tbl;
1.27 schwarze 1877: return(ROFF_IGN);
1878: }
1879:
1880: static enum rofferr
1.48 schwarze 1881: roff_cc(ROFF_ARGS)
1882: {
1883: const char *p;
1884:
1885: p = *bufp + pos;
1886:
1887: if ('\0' == *p || '.' == (r->control = *p++))
1888: r->control = 0;
1889:
1890: if ('\0' != *p)
1891: mandoc_msg(MANDOCERR_ARGCOUNT, r->parse, ln, ppos, NULL);
1892:
1893: return(ROFF_IGN);
1894: }
1895:
1896: static enum rofferr
1.42 schwarze 1897: roff_tr(ROFF_ARGS)
1898: {
1899: const char *p, *first, *second;
1900: size_t fsz, ssz;
1901: enum mandoc_esc esc;
1902:
1903: p = *bufp + pos;
1904:
1905: if ('\0' == *p) {
1906: mandoc_msg(MANDOCERR_ARGCOUNT, r->parse, ln, ppos, NULL);
1907: return(ROFF_IGN);
1908: }
1909:
1910: while ('\0' != *p) {
1911: fsz = ssz = 1;
1912:
1913: first = p++;
1914: if ('\\' == *first) {
1915: esc = mandoc_escape(&p, NULL, NULL);
1916: if (ESCAPE_ERROR == esc) {
1.92 schwarze 1917: mandoc_msg(MANDOCERR_ESC_BAD, r->parse,
1918: ln, (int)(p - *bufp), first);
1.42 schwarze 1919: return(ROFF_IGN);
1920: }
1921: fsz = (size_t)(p - first);
1922: }
1923:
1924: second = p++;
1925: if ('\\' == *second) {
1926: esc = mandoc_escape(&p, NULL, NULL);
1927: if (ESCAPE_ERROR == esc) {
1.92 schwarze 1928: mandoc_msg(MANDOCERR_ESC_BAD, r->parse,
1929: ln, (int)(p - *bufp), second);
1.42 schwarze 1930: return(ROFF_IGN);
1931: }
1932: ssz = (size_t)(p - second);
1933: } else if ('\0' == *second) {
1.80 schwarze 1934: mandoc_msg(MANDOCERR_ARGCOUNT, r->parse,
1935: ln, (int)(p - *bufp), NULL);
1.42 schwarze 1936: second = " ";
1937: p--;
1938: }
1939:
1940: if (fsz > 1) {
1.80 schwarze 1941: roff_setstrn(&r->xmbtab, first, fsz,
1942: second, ssz, 0);
1.42 schwarze 1943: continue;
1944: }
1945:
1946: if (NULL == r->xtab)
1.80 schwarze 1947: r->xtab = mandoc_calloc(128,
1948: sizeof(struct roffstr));
1.42 schwarze 1949:
1950: free(r->xtab[(int)*first].p);
1951: r->xtab[(int)*first].p = mandoc_strndup(second, ssz);
1952: r->xtab[(int)*first].sz = ssz;
1953: }
1954:
1955: return(ROFF_IGN);
1956: }
1957:
1958: static enum rofferr
1.14 schwarze 1959: roff_so(ROFF_ARGS)
1960: {
1961: char *name;
1.15 schwarze 1962:
1.83 schwarze 1963: name = *bufp + pos;
1964: mandoc_vmsg(MANDOCERR_SO, r->parse, ln, ppos, ".so %s", name);
1.14 schwarze 1965:
1.22 schwarze 1966: /*
1967: * Handle `so'. Be EXTREMELY careful, as we shouldn't be
1968: * opening anything that's not in our cwd or anything beneath
1969: * it. Thus, explicitly disallow traversing up the file-system
1970: * or using absolute paths.
1971: */
1972:
1.14 schwarze 1973: if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
1.83 schwarze 1974: mandoc_vmsg(MANDOCERR_SO_PATH, r->parse, ln, ppos,
1975: ".so %s", name);
1.14 schwarze 1976: return(ROFF_ERR);
1977: }
1978:
1979: *offs = pos;
1980: return(ROFF_SO);
1.7 schwarze 1981: }
1982:
1.16 schwarze 1983: static enum rofferr
1984: roff_userdef(ROFF_ARGS)
1.12 schwarze 1985: {
1.16 schwarze 1986: const char *arg[9];
1987: char *cp, *n1, *n2;
1.25 schwarze 1988: int i;
1.12 schwarze 1989:
1.16 schwarze 1990: /*
1991: * Collect pointers to macro argument strings
1.61 schwarze 1992: * and NUL-terminate them.
1.16 schwarze 1993: */
1994: cp = *bufp + pos;
1.25 schwarze 1995: for (i = 0; i < 9; i++)
1.26 schwarze 1996: arg[i] = '\0' == *cp ? "" :
1.35 schwarze 1997: mandoc_getarg(r->parse, &cp, ln, &pos);
1.16 schwarze 1998:
1999: /*
2000: * Expand macro arguments.
1.12 schwarze 2001: */
1.16 schwarze 2002: *szp = 0;
2003: n1 = cp = mandoc_strdup(r->current_string);
2004: while (NULL != (cp = strstr(cp, "\\$"))) {
2005: i = cp[2] - '1';
2006: if (0 > i || 8 < i) {
2007: /* Not an argument invocation. */
2008: cp += 2;
2009: continue;
2010: }
1.82 schwarze 2011: *cp = '\0';
2012: *szp = mandoc_asprintf(&n2, "%s%s%s",
2013: n1, arg[i], cp + 3) + 1;
1.16 schwarze 2014: cp = n2 + (cp - n1);
2015: free(n1);
2016: n1 = n2;
1.12 schwarze 2017: }
2018:
1.16 schwarze 2019: /*
2020: * Replace the macro invocation
2021: * by the expanded macro.
2022: */
2023: free(*bufp);
2024: *bufp = n1;
2025: if (0 == *szp)
2026: *szp = strlen(*bufp) + 1;
2027:
1.19 schwarze 2028: return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
1.16 schwarze 2029: ROFF_REPARSE : ROFF_APPEND);
1.12 schwarze 2030: }
1.28 schwarze 2031:
1.85 schwarze 2032: static size_t
1.28 schwarze 2033: roff_getname(struct roff *r, char **cpp, int ln, int pos)
2034: {
2035: char *name, *cp;
1.85 schwarze 2036: size_t namesz;
1.28 schwarze 2037:
2038: name = *cpp;
2039: if ('\0' == *name)
1.85 schwarze 2040: return(0);
1.28 schwarze 2041:
1.85 schwarze 2042: /* Read until end of name and terminate it with NUL. */
2043: for (cp = name; 1; cp++) {
2044: if ('\0' == *cp || ' ' == *cp) {
2045: namesz = cp - name;
2046: break;
2047: }
1.28 schwarze 2048: if ('\\' != *cp)
2049: continue;
1.88 schwarze 2050: namesz = cp - name;
2051: if ('{' == cp[1] || '}' == cp[1])
2052: break;
1.28 schwarze 2053: cp++;
2054: if ('\\' == *cp)
2055: continue;
1.35 schwarze 2056: mandoc_msg(MANDOCERR_NAMESC, r->parse, ln, pos, NULL);
1.85 schwarze 2057: mandoc_escape((const char **)&cp, NULL, NULL);
2058: break;
1.28 schwarze 2059: }
2060:
2061: /* Read past spaces. */
2062: while (' ' == *cp)
2063: cp++;
2064:
2065: *cpp = cp;
1.85 schwarze 2066: return(namesz);
1.28 schwarze 2067: }
2068:
1.16 schwarze 2069: /*
2070: * Store *string into the user-defined string called *name.
2071: * To clear an existing entry, call with (*r, *name, NULL, 0).
1.66 schwarze 2072: * append == 0: replace mode
2073: * append == 1: single-line append mode
2074: * append == 2: multiline append mode, append '\n' after each call
1.16 schwarze 2075: */
1.8 schwarze 2076: static void
1.16 schwarze 2077: roff_setstr(struct roff *r, const char *name, const char *string,
1.66 schwarze 2078: int append)
1.7 schwarze 2079: {
1.42 schwarze 2080:
2081: roff_setstrn(&r->strtab, name, strlen(name), string,
1.80 schwarze 2082: string ? strlen(string) : 0, append);
1.42 schwarze 2083: }
2084:
2085: static void
2086: roff_setstrn(struct roffkv **r, const char *name, size_t namesz,
1.66 schwarze 2087: const char *string, size_t stringsz, int append)
1.42 schwarze 2088: {
2089: struct roffkv *n;
2090: char *c;
2091: int i;
2092: size_t oldch, newch;
1.7 schwarze 2093:
1.16 schwarze 2094: /* Search for an existing string with the same name. */
1.42 schwarze 2095: n = *r;
2096:
1.84 schwarze 2097: while (n && (namesz != n->key.sz ||
2098: strncmp(n->key.p, name, namesz)))
1.7 schwarze 2099: n = n->next;
1.8 schwarze 2100:
2101: if (NULL == n) {
1.16 schwarze 2102: /* Create a new string table entry. */
1.42 schwarze 2103: n = mandoc_malloc(sizeof(struct roffkv));
2104: n->key.p = mandoc_strndup(name, namesz);
2105: n->key.sz = namesz;
2106: n->val.p = NULL;
2107: n->val.sz = 0;
2108: n->next = *r;
2109: *r = n;
1.66 schwarze 2110: } else if (0 == append) {
1.42 schwarze 2111: free(n->val.p);
2112: n->val.p = NULL;
2113: n->val.sz = 0;
1.16 schwarze 2114: }
2115:
2116: if (NULL == string)
2117: return;
2118:
2119: /*
2120: * One additional byte for the '\n' in multiline mode,
2121: * and one for the terminating '\0'.
2122: */
1.66 schwarze 2123: newch = stringsz + (1 < append ? 2u : 1u);
1.42 schwarze 2124:
2125: if (NULL == n->val.p) {
2126: n->val.p = mandoc_malloc(newch);
2127: *n->val.p = '\0';
1.16 schwarze 2128: oldch = 0;
2129: } else {
1.42 schwarze 2130: oldch = n->val.sz;
2131: n->val.p = mandoc_realloc(n->val.p, oldch + newch);
1.16 schwarze 2132: }
2133:
2134: /* Skip existing content in the destination buffer. */
1.42 schwarze 2135: c = n->val.p + (int)oldch;
1.16 schwarze 2136:
2137: /* Append new content to the destination buffer. */
1.42 schwarze 2138: i = 0;
2139: while (i < (int)stringsz) {
1.16 schwarze 2140: /*
2141: * Rudimentary roff copy mode:
2142: * Handle escaped backslashes.
2143: */
1.42 schwarze 2144: if ('\\' == string[i] && '\\' == string[i + 1])
2145: i++;
2146: *c++ = string[i++];
1.16 schwarze 2147: }
1.8 schwarze 2148:
1.16 schwarze 2149: /* Append terminating bytes. */
1.66 schwarze 2150: if (1 < append)
1.16 schwarze 2151: *c++ = '\n';
1.42 schwarze 2152:
1.16 schwarze 2153: *c = '\0';
1.42 schwarze 2154: n->val.sz = (int)(c - n->val.p);
1.7 schwarze 2155: }
2156:
1.8 schwarze 2157: static const char *
2158: roff_getstrn(const struct roff *r, const char *name, size_t len)
1.7 schwarze 2159: {
1.42 schwarze 2160: const struct roffkv *n;
1.64 schwarze 2161: int i;
1.7 schwarze 2162:
1.42 schwarze 2163: for (n = r->strtab; n; n = n->next)
1.80 schwarze 2164: if (0 == strncmp(name, n->key.p, len) &&
2165: '\0' == n->key.p[(int)len])
1.42 schwarze 2166: return(n->val.p);
1.64 schwarze 2167:
2168: for (i = 0; i < PREDEFS_MAX; i++)
2169: if (0 == strncmp(name, predefs[i].name, len) &&
2170: '\0' == predefs[i].name[(int)len])
2171: return(predefs[i].str);
1.8 schwarze 2172:
1.42 schwarze 2173: return(NULL);
1.7 schwarze 2174: }
2175:
1.8 schwarze 2176: static void
1.42 schwarze 2177: roff_freestr(struct roffkv *r)
1.7 schwarze 2178: {
1.42 schwarze 2179: struct roffkv *n, *nn;
1.7 schwarze 2180:
1.42 schwarze 2181: for (n = r; n; n = nn) {
2182: free(n->key.p);
2183: free(n->val.p);
1.7 schwarze 2184: nn = n->next;
2185: free(n);
2186: }
1.27 schwarze 2187: }
2188:
2189: const struct tbl_span *
2190: roff_span(const struct roff *r)
2191: {
1.80 schwarze 2192:
1.27 schwarze 2193: return(r->tbl ? tbl_span(r->tbl) : NULL);
1.32 schwarze 2194: }
2195:
2196: const struct eqn *
2197: roff_eqn(const struct roff *r)
2198: {
1.80 schwarze 2199:
1.32 schwarze 2200: return(r->last_eqn ? &r->last_eqn->eqn : NULL);
1.42 schwarze 2201: }
2202:
2203: /*
2204: * Duplicate an input string, making the appropriate character
2205: * conversations (as stipulated by `tr') along the way.
2206: * Returns a heap-allocated string with all the replacements made.
2207: */
2208: char *
2209: roff_strdup(const struct roff *r, const char *p)
2210: {
2211: const struct roffkv *cp;
2212: char *res;
2213: const char *pp;
2214: size_t ssz, sz;
2215: enum mandoc_esc esc;
2216:
2217: if (NULL == r->xmbtab && NULL == r->xtab)
2218: return(mandoc_strdup(p));
2219: else if ('\0' == *p)
2220: return(mandoc_strdup(""));
2221:
2222: /*
2223: * Step through each character looking for term matches
2224: * (remember that a `tr' can be invoked with an escape, which is
2225: * a glyph but the escape is multi-character).
2226: * We only do this if the character hash has been initialised
2227: * and the string is >0 length.
2228: */
2229:
2230: res = NULL;
2231: ssz = 0;
2232:
2233: while ('\0' != *p) {
2234: if ('\\' != *p && r->xtab && r->xtab[(int)*p].p) {
2235: sz = r->xtab[(int)*p].sz;
2236: res = mandoc_realloc(res, ssz + sz + 1);
2237: memcpy(res + ssz, r->xtab[(int)*p].p, sz);
2238: ssz += sz;
2239: p++;
2240: continue;
2241: } else if ('\\' != *p) {
2242: res = mandoc_realloc(res, ssz + 2);
2243: res[ssz++] = *p++;
2244: continue;
2245: }
2246:
2247: /* Search for term matches. */
2248: for (cp = r->xmbtab; cp; cp = cp->next)
2249: if (0 == strncmp(p, cp->key.p, cp->key.sz))
2250: break;
2251:
2252: if (NULL != cp) {
2253: /*
2254: * A match has been found.
2255: * Append the match to the array and move
2256: * forward by its keysize.
2257: */
1.80 schwarze 2258: res = mandoc_realloc(res,
2259: ssz + cp->val.sz + 1);
1.42 schwarze 2260: memcpy(res + ssz, cp->val.p, cp->val.sz);
2261: ssz += cp->val.sz;
2262: p += (int)cp->key.sz;
2263: continue;
2264: }
2265:
2266: /*
2267: * Handle escapes carefully: we need to copy
2268: * over just the escape itself, or else we might
2269: * do replacements within the escape itself.
2270: * Make sure to pass along the bogus string.
2271: */
2272: pp = p++;
2273: esc = mandoc_escape(&p, NULL, NULL);
2274: if (ESCAPE_ERROR == esc) {
2275: sz = strlen(pp);
2276: res = mandoc_realloc(res, ssz + sz + 1);
2277: memcpy(res + ssz, pp, sz);
2278: break;
2279: }
1.80 schwarze 2280: /*
2281: * We bail out on bad escapes.
1.42 schwarze 2282: * No need to warn: we already did so when
2283: * roff_res() was called.
2284: */
2285: sz = (int)(p - pp);
2286: res = mandoc_realloc(res, ssz + sz + 1);
2287: memcpy(res + ssz, pp, sz);
2288: ssz += sz;
2289: }
2290:
2291: res[(int)ssz] = '\0';
2292: return(res);
1.48 schwarze 2293: }
2294:
2295: /*
1.80 schwarze 2296: * Find out whether a line is a macro line or not.
1.48 schwarze 2297: * If it is, adjust the current position and return one; if it isn't,
2298: * return zero and don't change the current position.
2299: * If the control character has been set with `.cc', then let that grain
2300: * precedence.
2301: * This is slighly contrary to groff, where using the non-breaking
2302: * control character when `cc' has been invoked will cause the
2303: * non-breaking macro contents to be printed verbatim.
2304: */
2305: int
2306: roff_getcontrol(const struct roff *r, const char *cp, int *ppos)
2307: {
2308: int pos;
2309:
2310: pos = *ppos;
2311:
2312: if (0 != r->control && cp[pos] == r->control)
2313: pos++;
2314: else if (0 != r->control)
2315: return(0);
2316: else if ('\\' == cp[pos] && '.' == cp[pos + 1])
2317: pos += 2;
2318: else if ('.' == cp[pos] || '\'' == cp[pos])
2319: pos++;
2320: else
2321: return(0);
2322:
2323: while (' ' == cp[pos] || '\t' == cp[pos])
2324: pos++;
2325:
2326: *ppos = pos;
2327: return(1);
1.1 schwarze 2328: }