Annotation of mandoc/roff.c, Revision 1.39
1.39 ! kristaps 1: /* $Id: roff.c,v 1.38 2008/12/04 16:34:59 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
1.30 kristaps 19: #include <sys/param.h>
1.33 kristaps 20: #include <sys/types.h>
1.30 kristaps 21:
1.1 kristaps 22: #include <assert.h>
23: #include <ctype.h>
24: #include <err.h>
1.12 kristaps 25: #include <stdarg.h>
1.1 kristaps 26: #include <stdlib.h>
27: #include <stdio.h>
28: #include <string.h>
29: #include <time.h>
30:
31: #include "libmdocml.h"
32: #include "private.h"
33:
1.33 kristaps 34: /* FIXME: First letters of quoted-text interpreted in rofffindtok. */
35: /* FIXME: `No' not implemented. */
1.27 kristaps 36: /* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */
37: /* TODO: warn about "X section only" macros. */
38: /* TODO: warn about empty lists. */
39: /* TODO: (warn) some sections need specific elements. */
40: /* TODO: (warn) NAME section has particular order. */
41: /* TODO: unify empty-content tags a la <br />. */
42: /* TODO: macros with a set number of arguments? */
1.36 kristaps 43: /* TODO: validate Dt macro arguments. */
1.11 kristaps 44:
1.1 kristaps 45: enum roffd {
46: ROFF_ENTER = 0,
47: ROFF_EXIT
48: };
49:
50: enum rofftype {
51: ROFF_COMMENT,
52: ROFF_TEXT,
1.11 kristaps 53: ROFF_LAYOUT,
54: ROFF_SPECIAL
1.1 kristaps 55: };
56:
57: #define ROFFCALL_ARGS \
1.2 kristaps 58: int tok, struct rofftree *tree, \
1.18 kristaps 59: char *argv[], enum roffd type
1.1 kristaps 60:
61: struct rofftree;
62:
63: struct rofftok {
1.5 kristaps 64: int (*cb)(ROFFCALL_ARGS); /* Callback. */
65: const int *args; /* Args (or NULL). */
1.32 kristaps 66: const int *parents; /* Limit to parents. */
67: const int *children; /* Limit to kids. */
68: int ctx; /* Blk-close node. */
1.5 kristaps 69: enum rofftype type; /* Type of macro. */
1.1 kristaps 70: int flags;
1.7 kristaps 71: #define ROFF_PARSED (1 << 0) /* "Parsed". */
72: #define ROFF_CALLABLE (1 << 1) /* "Callable". */
1.21 kristaps 73: #define ROFF_SHALLOW (1 << 2) /* Nesting block. */
1.32 kristaps 74: #define ROFF_LSCOPE (1 << 3) /* Line scope. */
1.1 kristaps 75: };
76:
77: struct roffarg {
78: int flags;
1.5 kristaps 79: #define ROFF_VALUE (1 << 0) /* Has a value. */
1.1 kristaps 80: };
81:
82: struct roffnode {
1.5 kristaps 83: int tok; /* Token id. */
84: struct roffnode *parent; /* Parent (or NULL). */
1.1 kristaps 85: };
86:
87: struct rofftree {
1.5 kristaps 88: struct roffnode *last; /* Last parsed node. */
1.32 kristaps 89: char *cur; /* Line start. */
1.30 kristaps 90: struct tm tm; /* `Dd' results. */
1.5 kristaps 91: char os[64]; /* `Os' results. */
92: char title[64]; /* `Dt' results. */
93: char section[64]; /* `Dt' results. */
94: char volume[64]; /* `Dt' results. */
1.1 kristaps 95: int state;
1.5 kristaps 96: #define ROFF_PRELUDE (1 << 1) /* In roff prelude. */
97: #define ROFF_PRELUDE_Os (1 << 2) /* `Os' is parsed. */
98: #define ROFF_PRELUDE_Dt (1 << 3) /* `Dt' is parsed. */
99: #define ROFF_PRELUDE_Dd (1 << 4) /* `Dd' is parsed. */
100: #define ROFF_BODY (1 << 5) /* In roff body. */
1.32 kristaps 101: struct roffcb cb; /* Callbacks. */
102: void *arg; /* Callbacks' arg. */
1.1 kristaps 103: };
104:
105: static int roff_Dd(ROFFCALL_ARGS);
106: static int roff_Dt(ROFFCALL_ARGS);
107: static int roff_Os(ROFFCALL_ARGS);
1.31 kristaps 108: static int roff_Ns(ROFFCALL_ARGS);
1.33 kristaps 109: static int roff_Sm(ROFFCALL_ARGS);
1.2 kristaps 110: static int roff_layout(ROFFCALL_ARGS);
111: static int roff_text(ROFFCALL_ARGS);
1.27 kristaps 112: static int roff_noop(ROFFCALL_ARGS);
113: static int roff_depr(ROFFCALL_ARGS);
1.4 kristaps 114: static struct roffnode *roffnode_new(int, struct rofftree *);
1.15 kristaps 115: static void roffnode_free(struct rofftree *);
1.12 kristaps 116: static void roff_warn(const struct rofftree *,
117: const char *, char *, ...);
118: static void roff_err(const struct rofftree *,
119: const char *, char *, ...);
1.31 kristaps 120: static int roffpurgepunct(struct rofftree *, char **);
1.7 kristaps 121: static int roffscan(int, const int *);
1.1 kristaps 122: static int rofffindtok(const char *);
123: static int rofffindarg(const char *);
1.2 kristaps 124: static int rofffindcallable(const char *);
1.10 kristaps 125: static int roffargs(const struct rofftree *,
126: int, char *, char **);
1.5 kristaps 127: static int roffargok(int, int);
1.12 kristaps 128: static int roffnextopt(const struct rofftree *,
1.18 kristaps 129: int, char ***, char **);
1.27 kristaps 130: static int roffparseopts(struct rofftree *, int,
131: char ***, int *, char **);
1.33 kristaps 132: static int roffcall(struct rofftree *, int, char **);
1.17 kristaps 133: static int roffparse(struct rofftree *, char *);
1.37 kristaps 134: static int textparse(struct rofftree *, char *);
135: static int roffdata(struct rofftree *, int, char *);
1.1 kristaps 136:
1.35 kristaps 137: #ifdef __linux__
138: extern size_t strlcat(char *, const char *, size_t);
139: extern size_t strlcpy(char *, const char *, size_t);
1.33 kristaps 140: extern int vsnprintf(char *, size_t,
141: const char *, va_list);
142: extern char *strptime(const char *, const char *,
143: struct tm *);
144: #endif
145:
1.6 kristaps 146:
1.32 kristaps 147: static const int roffarg_An[] = { ROFF_Split, ROFF_Nosplit, ROFF_ARGMAX };
148: static const int roffarg_Bd[] = { ROFF_Ragged, ROFF_Unfilled, ROFF_Literal,
149: ROFF_File, ROFF_Offset, ROFF_Filled, ROFF_Compact, ROFF_ARGMAX };
1.12 kristaps 150: static const int roffarg_Bk[] = { ROFF_Words, ROFF_ARGMAX };
1.7 kristaps 151: static const int roffarg_Ex[] = { ROFF_Std, ROFF_ARGMAX };
152: static const int roffarg_Rv[] = { ROFF_Std, ROFF_ARGMAX };
1.32 kristaps 153: static const int roffarg_Bl[] = { ROFF_Bullet, ROFF_Dash, ROFF_Hyphen,
154: ROFF_Item, ROFF_Enum, ROFF_Tag, ROFF_Diag, ROFF_Hang, ROFF_Ohang,
155: ROFF_Inset, ROFF_Column, ROFF_Offset, ROFF_Width, ROFF_Compact,
1.7 kristaps 156: ROFF_ARGMAX };
1.32 kristaps 157: static const int roffarg_St[] = { ROFF_p1003_1_88, ROFF_p1003_1_90,
158: ROFF_p1003_1_96, ROFF_p1003_1_2001, ROFF_p1003_1_2004, ROFF_p1003_1,
159: ROFF_p1003_1b, ROFF_p1003_1b_93, ROFF_p1003_1c_95, ROFF_p1003_1g_2000,
160: ROFF_p1003_2_92, ROFF_p1387_2_95, ROFF_p1003_2, ROFF_p1387_2,
161: ROFF_isoC_90, ROFF_isoC_amd1, ROFF_isoC_tcor1, ROFF_isoC_tcor2,
162: ROFF_isoC_99, ROFF_ansiC, ROFF_ansiC_89, ROFF_ansiC_99, ROFF_ieee754,
163: ROFF_iso8802_3, ROFF_xpg3, ROFF_xpg4, ROFF_xpg4_2, ROFF_xpg4_3,
164: ROFF_xbd5, ROFF_xcu5, ROFF_xsh5, ROFF_xns5, ROFF_xns5_2d2_0,
165: ROFF_xcurses4_2, ROFF_susv2, ROFF_susv3, ROFF_svid4, ROFF_ARGMAX };
1.5 kristaps 166:
1.6 kristaps 167: static const int roffchild_Bl[] = { ROFF_It, ROFF_El, ROFF_MAX };
1.7 kristaps 168: static const int roffchild_Fo[] = { ROFF_Fa, ROFF_Fc, ROFF_MAX };
1.32 kristaps 169: static const int roffchild_Rs[] = { ROFF_Re, ROFF__A, ROFF__B, ROFF__D,
170: ROFF__I, ROFF__J, ROFF__N, ROFF__O, ROFF__P, ROFF__R, ROFF__T, ROFF__V,
171: ROFF_MAX };
1.6 kristaps 172:
173: static const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX };
1.7 kristaps 174: static const int roffparent_Fc[] = { ROFF_Fo, ROFF_Fa, ROFF_MAX };
1.29 kristaps 175: static const int roffparent_Oc[] = { ROFF_Oo, ROFF_MAX };
1.8 kristaps 176: static const int roffparent_It[] = { ROFF_Bl, ROFF_It, ROFF_MAX };
1.9 kristaps 177: static const int roffparent_Re[] = { ROFF_Rs, ROFF_MAX };
1.1 kristaps 178:
1.14 kristaps 179: static const struct rofftok tokens[ROFF_MAX] = {
1.27 kristaps 180: { roff_noop, NULL, NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */
1.10 kristaps 181: { roff_Dd, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dd */
182: { roff_Dt, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dt */
1.21 kristaps 183: { roff_Os, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Os */
184: { roff_layout, NULL, NULL, NULL, ROFF_Sh, ROFF_LAYOUT, 0 }, /* Sh */
185: { roff_layout, NULL, NULL, NULL, ROFF_Ss, ROFF_LAYOUT, 0 }, /* Ss */
1.27 kristaps 186: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Pp */ /* XXX 0 args */
187: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_LSCOPE }, /* D1 */
188: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_LSCOPE }, /* Dl */
1.12 kristaps 189: { roff_layout, roffarg_Bd, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bd */
1.27 kristaps 190: { roff_noop, NULL, NULL, NULL, ROFF_Bd, ROFF_LAYOUT, 0 }, /* Ed */
1.7 kristaps 191: { roff_layout, roffarg_Bl, NULL, roffchild_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */
1.27 kristaps 192: { roff_noop, NULL, roffparent_El, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */
1.21 kristaps 193: { roff_layout, NULL, roffparent_It, NULL, ROFF_It, ROFF_LAYOUT, ROFF_PARSED | ROFF_SHALLOW }, /* It */
1.20 kristaps 194: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */ /* FIXME */
195: { roff_text, roffarg_An, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* An */
196: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ar */
1.21 kristaps 197: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Cd */ /* XXX man.4 only */
1.7 kristaps 198: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */
1.20 kristaps 199: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dv */ /* XXX needs arg */
200: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Er */ /* XXX needs arg */
201: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ev */ /* XXX needs arg */
1.7 kristaps 202: { roff_text, roffarg_Ex, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ex */
1.20 kristaps 203: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fa */ /* XXX needs arg */
1.10 kristaps 204: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Fd */
1.20 kristaps 205: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fl */
206: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fn */ /* XXX needs arg */ /* FIXME */
207: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ft */
208: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ic */ /* XXX needs arg */
1.10 kristaps 209: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* In */
1.20 kristaps 210: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */
1.21 kristaps 211: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Nd */
1.20 kristaps 212: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Nm */ /* FIXME */
1.27 kristaps 213: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Op */
214: { roff_depr, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ot */
1.20 kristaps 215: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pa */
1.10 kristaps 216: { roff_text, roffarg_Rv, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Rv */
1.7 kristaps 217: { roff_text, roffarg_St, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* St */
1.20 kristaps 218: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Va */
219: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Vt */ /* XXX needs arg */
220: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xr */ /* XXX needs arg */
1.9 kristaps 221: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */
222: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */
1.10 kristaps 223: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %D */
1.9 kristaps 224: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */
225: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */
1.10 kristaps 226: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %N */
227: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %O */
228: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %P */
229: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %R */
1.9 kristaps 230: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */
1.10 kristaps 231: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %V */
232: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */
233: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */
1.27 kristaps 234: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Aq */
1.10 kristaps 235: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* At */ /* XXX at most 2 args */
236: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */
1.28 kristaps 237: { roff_layout, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bf */ /* FIXME */
1.10 kristaps 238: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */
1.27 kristaps 239: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Bq */
1.20 kristaps 240: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */
241: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */
1.26 kristaps 242: { NULL, NULL, NULL, NULL, 0, ROFF_SPECIAL, 0 }, /* Db */
1.10 kristaps 243: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */
244: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */
1.27 kristaps 245: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Dq */
1.10 kristaps 246: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */
1.28 kristaps 247: { roff_noop, NULL, NULL, NULL, ROFF_Bf, ROFF_LAYOUT, 0 }, /* Ef */
1.20 kristaps 248: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Em */ /* XXX needs arg */
1.10 kristaps 249: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Eo */
1.20 kristaps 250: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Fx */
251: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ms */
1.6 kristaps 252: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */
1.31 kristaps 253: { roff_Ns, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */
1.20 kristaps 254: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Nx */
255: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ox */
1.10 kristaps 256: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */
1.26 kristaps 257: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */
1.28 kristaps 258: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */
1.27 kristaps 259: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Pq */
1.10 kristaps 260: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */
1.8 kristaps 261: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */
1.27 kristaps 262: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */
263: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Qq */
264: { roff_noop, NULL, roffparent_Re, NULL, ROFF_Rs, ROFF_LAYOUT, 0 }, /* Re */
1.9 kristaps 265: { roff_layout, NULL, NULL, roffchild_Rs, 0, ROFF_LAYOUT, 0 }, /* Rs */
1.10 kristaps 266: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */
267: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */
1.27 kristaps 268: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Sq */
1.33 kristaps 269: { roff_Sm, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Sm */
1.8 kristaps 270: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */
1.20 kristaps 271: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */
272: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */
273: { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ux */
1.37 kristaps 274: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */
275: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */
1.14 kristaps 276: { roff_layout, NULL, NULL, roffchild_Fo, 0, ROFF_LAYOUT, 0 }, /* Fo */
1.27 kristaps 277: { roff_noop, NULL, roffparent_Fc, NULL, ROFF_Fo, ROFF_LAYOUT, 0 }, /* Fc */
1.29 kristaps 278: { roff_layout, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Oo */
1.27 kristaps 279: { roff_noop, NULL, roffparent_Oc, NULL, ROFF_Oo, ROFF_LAYOUT, 0 }, /* Oc */
1.12 kristaps 280: { roff_layout, roffarg_Bk, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bk */
1.27 kristaps 281: { roff_noop, NULL, NULL, NULL, ROFF_Bk, ROFF_LAYOUT, 0 }, /* Ek */
282: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Bt */
283: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Hf */
284: { roff_depr, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Fr */
285: { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ud */
1.12 kristaps 286: };
1.1 kristaps 287:
1.14 kristaps 288: static const int tokenargs[ROFF_ARGMAX] = {
1.12 kristaps 289: 0, 0, 0, 0,
290: 0, ROFF_VALUE, ROFF_VALUE, 0,
291: 0, 0, 0, 0,
292: 0, 0, 0, 0,
1.18 kristaps 293: 0, 0, ROFF_VALUE, 0,
1.12 kristaps 294: 0, 0, 0, 0,
295: 0, 0, 0, 0,
296: 0, 0, 0, 0,
297: 0, 0, 0, 0,
298: 0, 0, 0, 0,
299: 0, 0, 0, 0,
300: 0, 0, 0, 0,
301: 0, 0, 0, 0,
302: 0, 0, 0, 0,
303: 0, 0, 0, 0,
304: };
1.1 kristaps 305:
1.14 kristaps 306: const char *const toknamesp[ROFF_MAX] = {
1.8 kristaps 307: "\\\"", "Dd", "Dt", "Os",
308: "Sh", "Ss", "Pp", "D1",
309: "Dl", "Bd", "Ed", "Bl",
310: "El", "It", "Ad", "An",
311: "Ar", "Cd", "Cm", "Dv",
312: "Er", "Ev", "Ex", "Fa",
313: "Fd", "Fl", "Fn", "Ft",
314: "Ic", "In", "Li", "Nd",
315: "Nm", "Op", "Ot", "Pa",
316: "Rv", "St", "Va", "Vt",
1.23 kristaps 317: /* LINTED */
1.8 kristaps 318: "Xr", "\%A", "\%B", "\%D",
1.23 kristaps 319: /* LINTED */
1.8 kristaps 320: "\%I", "\%J", "\%N", "\%O",
1.23 kristaps 321: /* LINTED */
1.8 kristaps 322: "\%P", "\%R", "\%T", "\%V",
323: "Ac", "Ao", "Aq", "At",
324: "Bc", "Bf", "Bo", "Bq",
325: "Bsx", "Bx", "Db", "Dc",
326: "Do", "Dq", "Ec", "Ef",
327: "Em", "Eo", "Fx", "Ms",
328: "No", "Ns", "Nx", "Ox",
329: "Pc", "Pf", "Po", "Pq",
330: "Qc", "Ql", "Qo", "Qq",
331: "Re", "Rs", "Sc", "So",
332: "Sq", "Sm", "Sx", "Sy",
333: "Tn", "Ux", "Xc", "Xo",
1.9 kristaps 334: "Fo", "Fc", "Oo", "Oc",
1.27 kristaps 335: "Bk", "Ek", "Bt", "Hf",
336: "Fr", "Ud",
1.5 kristaps 337: };
338:
1.14 kristaps 339: const char *const tokargnamesp[ROFF_ARGMAX] = {
1.9 kristaps 340: "split", "nosplit", "ragged",
341: "unfilled", "literal", "file",
342: "offset", "bullet", "dash",
343: "hyphen", "item", "enum",
344: "tag", "diag", "hang",
345: "ohang", "inset", "column",
346: "width", "compact", "std",
347: "p1003.1-88", "p1003.1-90", "p1003.1-96",
348: "p1003.1-2001", "p1003.1-2004", "p1003.1",
349: "p1003.1b", "p1003.1b-93", "p1003.1c-95",
350: "p1003.1g-2000", "p1003.2-92", "p1387.2-95",
351: "p1003.2", "p1387.2", "isoC-90",
352: "isoC-amd1", "isoC-tcor1", "isoC-tcor2",
353: "isoC-99", "ansiC", "ansiC-89",
354: "ansiC-99", "ieee754", "iso8802-3",
355: "xpg3", "xpg4", "xpg4.2",
356: "xpg4.3", "xbd5", "xcu5",
357: "xsh5", "xns5", "xns5.2d2.0",
358: "xcurses4.2", "susv2", "susv3",
1.12 kristaps 359: "svid4", "filled", "words",
1.5 kristaps 360: };
361:
362: const char *const *toknames = toknamesp;
363: const char *const *tokargnames = tokargnamesp;
1.4 kristaps 364:
1.1 kristaps 365:
366: int
367: roff_free(struct rofftree *tree, int flush)
368: {
1.16 kristaps 369: int error, t;
1.15 kristaps 370: struct roffnode *n;
1.1 kristaps 371:
1.17 kristaps 372: error = 0;
373:
1.16 kristaps 374: if ( ! flush)
375: goto end;
1.1 kristaps 376:
1.16 kristaps 377: error = 1;
1.1 kristaps 378:
1.16 kristaps 379: if (ROFF_PRELUDE & tree->state) {
1.28 kristaps 380: roff_err(tree, NULL, "prelude never finished");
1.16 kristaps 381: goto end;
382: }
383:
1.28 kristaps 384: for (n = tree->last; n; n = n->parent) {
1.16 kristaps 385: if (0 != tokens[n->tok].ctx)
1.17 kristaps 386: continue;
1.28 kristaps 387: roff_err(tree, NULL, "closing explicit scope `%s'",
1.16 kristaps 388: toknames[n->tok]);
389: goto end;
390: }
391:
392: while (tree->last) {
393: t = tree->last->tok;
394: if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))
395: goto end;
1.1 kristaps 396: }
397:
1.30 kristaps 398: if ( ! (*tree->cb.rofftail)(tree->arg))
399: goto end;
400:
1.16 kristaps 401: error = 0;
402:
403: end:
404:
1.15 kristaps 405: while (tree->last)
406: roffnode_free(tree);
407:
1.1 kristaps 408: free(tree);
1.17 kristaps 409:
1.1 kristaps 410: return(error ? 0 : 1);
411: }
412:
413:
414: struct rofftree *
1.15 kristaps 415: roff_alloc(const struct roffcb *cb, void *args)
1.1 kristaps 416: {
417: struct rofftree *tree;
418:
1.17 kristaps 419: assert(args);
420: assert(cb);
421:
1.12 kristaps 422: if (NULL == (tree = calloc(1, sizeof(struct rofftree))))
423: err(1, "calloc");
1.1 kristaps 424:
425: tree->state = ROFF_PRELUDE;
1.15 kristaps 426: tree->arg = args;
427:
428: (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));
1.1 kristaps 429:
430: return(tree);
431: }
432:
433:
434: int
1.17 kristaps 435: roff_engine(struct rofftree *tree, char *buf)
1.1 kristaps 436: {
437:
1.17 kristaps 438: tree->cur = buf;
439: assert(buf);
1.12 kristaps 440:
1.17 kristaps 441: if (0 == *buf) {
1.29 kristaps 442: roff_err(tree, buf, "blank line");
1.1 kristaps 443: return(0);
444: } else if ('.' != *buf)
1.17 kristaps 445: return(textparse(tree, buf));
1.1 kristaps 446:
1.17 kristaps 447: return(roffparse(tree, buf));
1.1 kristaps 448: }
449:
450:
451: static int
1.37 kristaps 452: textparse(struct rofftree *tree, char *buf)
1.1 kristaps 453: {
1.37 kristaps 454: char *bufp;
455:
456: /* TODO: literal parsing. */
1.17 kristaps 457:
1.30 kristaps 458: if ( ! (ROFF_BODY & tree->state)) {
459: roff_err(tree, buf, "data not in body");
460: return(0);
461: }
1.37 kristaps 462:
463: /* LINTED */
464: while (*buf) {
465: while (*buf && isspace(*buf))
466: buf++;
467:
468: if (0 == *buf)
469: break;
470:
471: bufp = buf++;
472:
473: while (*buf && ! isspace(*buf))
474: buf++;
475:
476: if (0 != *buf) {
477: *buf++ = 0;
478: if ( ! roffdata(tree, 1, bufp))
479: return(0);
480: continue;
481: }
482:
483: if ( ! roffdata(tree, 1, bufp))
484: return(0);
485: break;
486: }
487:
488: return(1);
1.1 kristaps 489: }
490:
491:
492: static int
1.10 kristaps 493: roffargs(const struct rofftree *tree,
494: int tok, char *buf, char **argv)
1.1 kristaps 495: {
496: int i;
1.12 kristaps 497: char *p;
1.1 kristaps 498:
499: assert(tok >= 0 && tok < ROFF_MAX);
500: assert('.' == *buf);
501:
1.12 kristaps 502: p = buf;
503:
1.1 kristaps 504: /* LINTED */
1.37 kristaps 505: for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) {
1.10 kristaps 506: if ('\"' == *buf) {
507: argv[i] = ++buf;
508: while (*buf && '\"' != *buf)
509: buf++;
510: if (0 == *buf) {
1.13 kristaps 511: roff_err(tree, argv[i], "unclosed "
1.12 kristaps 512: "quote in argument "
513: "list for `%s'",
514: toknames[tok]);
1.10 kristaps 515: return(0);
516: }
517: } else {
518: argv[i] = buf++;
519: while (*buf && ! isspace(*buf))
520: buf++;
521: if (0 == *buf)
522: continue;
1.1 kristaps 523: }
524: *buf++ = 0;
525: while (*buf && isspace(*buf))
526: buf++;
527: }
528:
529: assert(i > 0);
1.37 kristaps 530: if (ROFF_MAXLINEARG == i && *buf) {
1.13 kristaps 531: roff_err(tree, p, "too many arguments for `%s'", toknames
1.12 kristaps 532: [tok]);
1.10 kristaps 533: return(0);
534: }
535:
536: argv[i] = NULL;
537: return(1);
1.1 kristaps 538: }
539:
540:
1.6 kristaps 541: static int
542: roffscan(int tok, const int *tokv)
543: {
1.7 kristaps 544:
1.6 kristaps 545: if (NULL == tokv)
546: return(1);
547:
1.7 kristaps 548: for ( ; ROFF_MAX != *tokv; tokv++)
1.6 kristaps 549: if (tok == *tokv)
550: return(1);
551:
552: return(0);
553: }
554:
555:
1.1 kristaps 556: static int
1.17 kristaps 557: roffparse(struct rofftree *tree, char *buf)
1.1 kristaps 558: {
559: int tok, t;
1.6 kristaps 560: struct roffnode *n;
1.37 kristaps 561: char *argv[ROFF_MAXLINEARG];
1.18 kristaps 562: char **argvp;
1.1 kristaps 563:
1.25 kristaps 564: if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))
565: if (0 == strncmp(buf, ".\\\"", 3))
566: return(1);
567:
1.6 kristaps 568: if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {
1.12 kristaps 569: roff_err(tree, buf + 1, "bogus line macro");
1.6 kristaps 570: return(0);
571: } else if (NULL == tokens[tok].cb) {
1.12 kristaps 572: roff_err(tree, buf + 1, "unsupported macro `%s'",
573: toknames[tok]);
1.1 kristaps 574: return(0);
1.25 kristaps 575: }
576:
577: assert(ROFF___ != tok);
1.10 kristaps 578: if ( ! roffargs(tree, tok, buf, argv))
1.1 kristaps 579: return(0);
1.12 kristaps 580:
1.18 kristaps 581: argvp = (char **)argv;
1.6 kristaps 582:
583: /*
1.12 kristaps 584: * Prelude macros break some assumptions, so branch now.
1.6 kristaps 585: */
1.1 kristaps 586:
1.6 kristaps 587: if (ROFF_PRELUDE & tree->state) {
588: assert(NULL == tree->last);
589: return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
1.28 kristaps 590: }
1.6 kristaps 591:
592: assert(ROFF_BODY & tree->state);
593:
594: /*
595: * First check that our possible parents and parent's possible
596: * children are satisfied.
597: */
598:
1.28 kristaps 599: if (tree->last && ! roffscan
600: (tree->last->tok, tokens[tok].parents)) {
1.15 kristaps 601: roff_err(tree, *argvp, "`%s' has invalid parent `%s'",
602: toknames[tok],
603: toknames[tree->last->tok]);
1.6 kristaps 604: return(0);
605: }
606:
1.28 kristaps 607: if (tree->last && ! roffscan
608: (tok, tokens[tree->last->tok].children)) {
1.18 kristaps 609: roff_err(tree, *argvp, "`%s' is invalid child of `%s'",
610: toknames[tok],
611: toknames[tree->last->tok]);
1.1 kristaps 612: return(0);
613: }
614:
615: /*
1.6 kristaps 616: * Branch if we're not a layout token.
1.1 kristaps 617: */
618:
1.6 kristaps 619: if (ROFF_LAYOUT != tokens[tok].type)
620: return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
621: if (0 == tokens[tok].ctx)
622: return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
1.1 kristaps 623:
1.12 kristaps 624: /*
625: * First consider implicit-end tags, like as follows:
626: * .Sh SECTION 1
627: * .Sh SECTION 2
628: * In this, we want to close the scope of the NAME section. If
629: * there's an intermediary implicit-end tag, such as
630: * .Sh SECTION 1
631: * .Ss Subsection 1
632: * .Sh SECTION 2
633: * then it must be closed as well.
634: */
635:
1.6 kristaps 636: if (tok == tokens[tok].ctx) {
1.12 kristaps 637: /*
638: * First search up to the point where we must close.
639: * If one doesn't exist, then we can open a new scope.
640: */
641:
1.6 kristaps 642: for (n = tree->last; n; n = n->parent) {
643: assert(0 == tokens[n->tok].ctx ||
644: n->tok == tokens[n->tok].ctx);
645: if (n->tok == tok)
646: break;
1.10 kristaps 647: if (ROFF_SHALLOW & tokens[tok].flags) {
648: n = NULL;
649: break;
650: }
1.28 kristaps 651: if (tokens[n->tok].ctx == n->tok)
652: continue;
653: roff_err(tree, *argv, "`%s' breaks `%s' scope",
654: toknames[tok], toknames[n->tok]);
655: return(0);
1.6 kristaps 656: }
1.10 kristaps 657:
658: /*
659: * Create a new scope, as no previous one exists to
660: * close out.
661: */
1.12 kristaps 662:
663: if (NULL == n)
1.6 kristaps 664: return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
1.10 kristaps 665:
666: /*
1.12 kristaps 667: * Close out all intermediary scoped blocks, then hang
668: * the current scope from our predecessor's parent.
1.10 kristaps 669: */
670:
1.1 kristaps 671: do {
672: t = tree->last->tok;
1.6 kristaps 673: if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))
1.1 kristaps 674: return(0);
675: } while (t != tok);
1.6 kristaps 676:
677: return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
1.1 kristaps 678: }
679:
1.12 kristaps 680: /*
681: * Now consider explicit-end tags, where we want to close back
682: * to a specific tag. Example:
683: * .Bl
684: * .It Item.
685: * .El
686: * In this, the `El' tag closes out the scope of `Bl'.
687: */
688:
1.6 kristaps 689: assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);
690:
1.32 kristaps 691: /* LINTED */
1.28 kristaps 692: for (n = tree->last; n; n = n->parent)
693: if (n->tok != tokens[tok].ctx) {
694: if (n->tok == tokens[n->tok].ctx)
695: continue;
696: roff_err(tree, *argv, "`%s' breaks `%s' scope",
697: toknames[tok], toknames[n->tok]);
698: return(0);
699: } else
700: break;
701:
702:
703: if (NULL == n) {
704: roff_err(tree, *argv, "`%s' has no starting tag `%s'",
705: toknames[tok],
706: toknames[tokens[tok].ctx]);
707: return(0);
708: }
709:
1.14 kristaps 710: /* LINTED */
1.6 kristaps 711: do {
712: t = tree->last->tok;
713: if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))
714: return(0);
715: } while (t != tokens[tok].ctx);
1.1 kristaps 716:
1.9 kristaps 717: return(1);
1.1 kristaps 718: }
719:
720:
721: static int
722: rofffindarg(const char *name)
723: {
724: size_t i;
725:
726: /* FIXME: use a table, this is slow but ok for now. */
727:
728: /* LINTED */
729: for (i = 0; i < ROFF_ARGMAX; i++)
730: /* LINTED */
1.4 kristaps 731: if (0 == strcmp(name, tokargnames[i]))
1.1 kristaps 732: return((int)i);
733:
734: return(ROFF_ARGMAX);
735: }
736:
737:
738: static int
1.6 kristaps 739: rofffindtok(const char *buf)
1.1 kristaps 740: {
1.6 kristaps 741: char token[4];
1.23 kristaps 742: int i;
1.1 kristaps 743:
1.6 kristaps 744: for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)
745: token[i] = *buf;
746:
1.9 kristaps 747: if (i == 3)
1.6 kristaps 748: return(ROFF_MAX);
749:
750: token[i] = 0;
751:
1.1 kristaps 752: /* FIXME: use a table, this is slow but ok for now. */
753:
754: /* LINTED */
755: for (i = 0; i < ROFF_MAX; i++)
756: /* LINTED */
1.12 kristaps 757: if (0 == strcmp(toknames[i], token))
1.1 kristaps 758: return((int)i);
1.7 kristaps 759:
1.1 kristaps 760: return(ROFF_MAX);
761: }
762:
763:
1.20 kristaps 764: static int
765: roffispunct(const char *p)
766: {
767:
768: if (0 == *p)
769: return(0);
770: if (0 != *(p + 1))
771: return(0);
772:
773: switch (*p) {
774: case('{'):
775: /* FALLTHROUGH */
776: case('.'):
777: /* FALLTHROUGH */
778: case(','):
779: /* FALLTHROUGH */
780: case(';'):
781: /* FALLTHROUGH */
782: case(':'):
783: /* FALLTHROUGH */
784: case('?'):
785: /* FALLTHROUGH */
786: case('!'):
787: /* FALLTHROUGH */
788: case('('):
789: /* FALLTHROUGH */
790: case(')'):
791: /* FALLTHROUGH */
792: case('['):
793: /* FALLTHROUGH */
794: case(']'):
795: /* FALLTHROUGH */
796: case('}'):
797: return(1);
798: default:
799: break;
800: }
801:
802: return(0);
803: }
804:
805:
1.2 kristaps 806: static int
807: rofffindcallable(const char *name)
808: {
809: int c;
810:
811: if (ROFF_MAX == (c = rofffindtok(name)))
812: return(ROFF_MAX);
1.8 kristaps 813: assert(c >= 0 && c < ROFF_MAX);
1.2 kristaps 814: return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);
815: }
816:
817:
1.1 kristaps 818: static struct roffnode *
1.4 kristaps 819: roffnode_new(int tokid, struct rofftree *tree)
1.1 kristaps 820: {
821: struct roffnode *p;
822:
1.12 kristaps 823: if (NULL == (p = malloc(sizeof(struct roffnode))))
824: err(1, "malloc");
1.1 kristaps 825:
826: p->tok = tokid;
827: p->parent = tree->last;
828: tree->last = p;
1.9 kristaps 829:
1.1 kristaps 830: return(p);
831: }
832:
833:
1.5 kristaps 834: static int
835: roffargok(int tokid, int argid)
836: {
837: const int *c;
838:
839: if (NULL == (c = tokens[tokid].args))
840: return(0);
841:
842: for ( ; ROFF_ARGMAX != *c; c++)
843: if (argid == *c)
844: return(1);
845:
846: return(0);
847: }
848:
849:
1.1 kristaps 850: static void
1.15 kristaps 851: roffnode_free(struct rofftree *tree)
1.1 kristaps 852: {
853: struct roffnode *p;
854:
855: assert(tree->last);
856:
857: p = tree->last;
858: tree->last = tree->last->parent;
859: free(p);
860: }
861:
862:
1.6 kristaps 863: static int
1.33 kristaps 864: roffcall(struct rofftree *tree, int tok, char **argv)
865: {
866:
867: if (NULL == tokens[tok].cb) {
868: roff_err(tree, *argv, "unsupported macro `%s'",
869: toknames[tok]);
870: return(0);
871: }
872: if ( ! (*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER))
873: return(0);
874: return(1);
875: }
876:
877:
878: static int
1.12 kristaps 879: roffnextopt(const struct rofftree *tree, int tok,
1.18 kristaps 880: char ***in, char **val)
1.6 kristaps 881: {
1.18 kristaps 882: char *arg, **argv;
1.6 kristaps 883: int v;
884:
885: *val = NULL;
886: argv = *in;
887: assert(argv);
888:
889: if (NULL == (arg = *argv))
890: return(-1);
891: if ('-' != *arg)
892: return(-1);
893:
1.12 kristaps 894: if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {
895: roff_warn(tree, arg, "argument-like parameter `%s' to "
1.33 kristaps 896: "`%s'", arg, toknames[tok]);
1.6 kristaps 897: return(-1);
1.12 kristaps 898: }
899:
900: if ( ! roffargok(tok, v)) {
901: roff_warn(tree, arg, "invalid argument parameter `%s' to "
902: "`%s'", tokargnames[v], toknames[tok]);
1.6 kristaps 903: return(-1);
1.12 kristaps 904: }
905:
906: if ( ! (ROFF_VALUE & tokenargs[v]))
1.6 kristaps 907: return(v);
908:
909: *in = ++argv;
910:
1.12 kristaps 911: if (NULL == *argv) {
912: roff_err(tree, arg, "empty value of `%s' for `%s'",
913: tokargnames[v], toknames[tok]);
914: return(ROFF_ARGMAX);
915: }
1.6 kristaps 916:
1.12 kristaps 917: return(v);
1.6 kristaps 918: }
919:
920:
1.27 kristaps 921: static int
1.31 kristaps 922: roffpurgepunct(struct rofftree *tree, char **argv)
923: {
924: int i;
925:
926: i = 0;
927: while (argv[i])
928: i++;
929: assert(i > 0);
930: if ( ! roffispunct(argv[--i]))
931: return(1);
932: while (i >= 0 && roffispunct(argv[i]))
933: i--;
934: i++;
935:
936: /* LINTED */
937: while (argv[i])
1.37 kristaps 938: if ( ! roffdata(tree, 0, argv[i++]))
1.31 kristaps 939: return(0);
940: return(1);
941: }
942:
943:
944: static int
1.27 kristaps 945: roffparseopts(struct rofftree *tree, int tok,
946: char ***args, int *argc, char **argv)
947: {
948: int i, c;
949: char *v;
950:
951: i = 0;
952:
953: while (-1 != (c = roffnextopt(tree, tok, args, &v))) {
954: if (ROFF_ARGMAX == c)
955: return(0);
956:
957: argc[i] = c;
958: argv[i] = v;
959: i++;
960: *args = *args + 1;
961: }
962:
963: argc[i] = ROFF_ARGMAX;
964: argv[i] = NULL;
965: return(1);
966: }
967:
968:
1.37 kristaps 969: static int
970: roffdata(struct rofftree *tree, int space, char *buf)
971: {
972:
1.38 kristaps 973: if (0 == *buf)
974: return(1);
1.37 kristaps 975: return((*tree->cb.roffdata)(tree->arg,
976: space != 0, tree->cur, buf));
977: }
978:
979:
1.1 kristaps 980: /* ARGSUSED */
981: static int
982: roff_Dd(ROFFCALL_ARGS)
983: {
1.30 kristaps 984: time_t t;
985: char *p, buf[32];
1.1 kristaps 986:
1.4 kristaps 987: if (ROFF_BODY & tree->state) {
988: assert( ! (ROFF_PRELUDE & tree->state));
989: assert(ROFF_PRELUDE_Dd & tree->state);
990: return(roff_text(tok, tree, argv, type));
991: }
992:
1.1 kristaps 993: assert(ROFF_PRELUDE & tree->state);
1.4 kristaps 994: assert( ! (ROFF_BODY & tree->state));
995:
1.6 kristaps 996: if (ROFF_PRELUDE_Dd & tree->state) {
1.12 kristaps 997: roff_err(tree, *argv, "repeated `Dd' in prelude");
1.6 kristaps 998: return(0);
999: } else if (ROFF_PRELUDE_Dt & tree->state) {
1.12 kristaps 1000: roff_err(tree, *argv, "out-of-order `Dd' in prelude");
1.1 kristaps 1001: return(0);
1002: }
1003:
1.30 kristaps 1004: assert(NULL == tree->last);
1005:
1006: argv++;
1007:
1008: if (0 == strcmp(*argv, "$Mdocdate$")) {
1009: t = time(NULL);
1010: if (NULL == localtime_r(&t, &tree->tm))
1011: err(1, "localtime_r");
1012: tree->state |= ROFF_PRELUDE_Dd;
1013: return(1);
1014: }
1015:
1016: /* Build this from Mdocdate or raw date. */
1017:
1018: buf[0] = 0;
1019: p = *argv;
1020:
1021: if (0 != strcmp(*argv, "$Mdocdate:")) {
1022: while (*argv) {
1023: if (strlcat(buf, *argv++, sizeof(buf))
1024: < sizeof(buf))
1025: continue;
1026: roff_err(tree, p, "bad `Dd' date");
1027: return(0);
1028: }
1029: if (strptime(buf, "%b%d,%Y", &tree->tm)) {
1030: tree->state |= ROFF_PRELUDE_Dd;
1031: return(1);
1032: }
1033: roff_err(tree, *argv, "bad `Dd' date");
1034: return(0);
1035: }
1036:
1037: argv++;
1038: while (*argv && **argv != '$') {
1039: if (strlcat(buf, *argv++, sizeof(buf))
1040: >= sizeof(buf)) {
1041: roff_err(tree, p, "bad `Dd' Mdocdate");
1042: return(0);
1043: }
1044: if (strlcat(buf, " ", sizeof(buf))
1045: >= sizeof(buf)) {
1046: roff_err(tree, p, "bad `Dd' Mdocdate");
1047: return(0);
1048: }
1049: }
1050: if (NULL == *argv) {
1051: roff_err(tree, p, "bad `Dd' Mdocdate");
1052: return(0);
1053: }
1054:
1055: if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) {
1056: roff_err(tree, *argv, "bad `Dd' Mdocdate");
1057: return(0);
1058: }
1.4 kristaps 1059:
1.1 kristaps 1060: tree->state |= ROFF_PRELUDE_Dd;
1061: return(1);
1062: }
1063:
1064:
1065: /* ARGSUSED */
1066: static int
1067: roff_Dt(ROFFCALL_ARGS)
1068: {
1069:
1.4 kristaps 1070: if (ROFF_BODY & tree->state) {
1071: assert( ! (ROFF_PRELUDE & tree->state));
1072: assert(ROFF_PRELUDE_Dt & tree->state);
1073: return(roff_text(tok, tree, argv, type));
1074: }
1075:
1.1 kristaps 1076: assert(ROFF_PRELUDE & tree->state);
1.4 kristaps 1077: assert( ! (ROFF_BODY & tree->state));
1078:
1.6 kristaps 1079: if ( ! (ROFF_PRELUDE_Dd & tree->state)) {
1.12 kristaps 1080: roff_err(tree, *argv, "out-of-order `Dt' in prelude");
1.1 kristaps 1081: return(0);
1.6 kristaps 1082: } else if (ROFF_PRELUDE_Dt & tree->state) {
1.12 kristaps 1083: roff_err(tree, *argv, "repeated `Dt' in prelude");
1.6 kristaps 1084: return(0);
1.1 kristaps 1085: }
1086:
1.30 kristaps 1087: argv++;
1088: if (NULL == *argv) {
1089: roff_err(tree, *argv, "`Dt' needs document title");
1090: return(0);
1091: } else if (strlcpy(tree->title, *argv, sizeof(tree->title))
1092: >= sizeof(tree->title)) {
1093: roff_err(tree, *argv, "`Dt' document title too long");
1094: return(0);
1095: }
1096:
1097: argv++;
1098: if (NULL == *argv) {
1099: roff_err(tree, *argv, "`Dt' needs section");
1100: return(0);
1101: } else if (strlcpy(tree->section, *argv, sizeof(tree->section))
1102: >= sizeof(tree->section)) {
1103: roff_err(tree, *argv, "`Dt' section too long");
1104: return(0);
1105: }
1106:
1107: argv++;
1108: if (NULL == *argv) {
1109: tree->volume[0] = 0;
1110: } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume))
1111: >= sizeof(tree->volume)) {
1112: roff_err(tree, *argv, "`Dt' volume too long");
1113: return(0);
1114: }
1.4 kristaps 1115:
1.1 kristaps 1116: assert(NULL == tree->last);
1117: tree->state |= ROFF_PRELUDE_Dt;
1118:
1119: return(1);
1120: }
1121:
1122:
1123: /* ARGSUSED */
1124: static int
1.33 kristaps 1125: roff_Sm(ROFFCALL_ARGS)
1.31 kristaps 1126: {
1.33 kristaps 1127: int argcp[1];
1128: char *argvp[1], *morep[1], *p;
1.31 kristaps 1129:
1.33 kristaps 1130: p = *argv++;
1.31 kristaps 1131:
1.33 kristaps 1132: argcp[0] = ROFF_ARGMAX;
1133: argvp[0] = NULL;
1134: if (NULL == (morep[0] = *argv++)) {
1135: roff_err(tree, p, "`Sm' expects an argument");
1136: return(0);
1137: } else if (0 != strcmp(morep[0], "on") &&
1138: 0 != strcmp(morep[0], "off")) {
1139: roff_err(tree, p, "`Sm' has invalid argument");
1140: return(0);
1141: }
1.31 kristaps 1142:
1.33 kristaps 1143: if (*argv)
1144: roff_warn(tree, *argv, "`Sm' shouldn't have arguments");
1.31 kristaps 1145:
1.33 kristaps 1146: if ( ! (*tree->cb.roffspecial)(tree->arg,
1147: tok, argcp, argvp, morep))
1.31 kristaps 1148: return(0);
1149:
1.37 kristaps 1150: while (*argv)
1151: if ( ! roffdata(tree, 1, *argv++))
1152: return(0);
1.33 kristaps 1153:
1154: return(1);
1155: }
1156:
1157:
1158: /* ARGSUSED */
1159: static int
1160: roff_Ns(ROFFCALL_ARGS)
1161: {
1162: int j, c, first;
1163: int argcp[1];
1164: char *argvp[1], *morep[1];
1165:
1166: first = (*argv++ == tree->cur);
1167:
1168: argcp[0] = ROFF_ARGMAX;
1169: argvp[0] = morep[0] = NULL;
1.31 kristaps 1170:
1.33 kristaps 1171: if ( ! (*tree->cb.roffspecial)(tree->arg,
1172: tok, argcp, argvp, morep))
1173: return(0);
1.31 kristaps 1174:
1.33 kristaps 1175: while (*argv) {
1176: if (ROFF_MAX != (c = rofffindcallable(*argv))) {
1177: if ( ! roffcall(tree, c, argv))
1178: return(0);
1.31 kristaps 1179: break;
1180: }
1.33 kristaps 1181:
1182: if ( ! roffispunct(*argv)) {
1.37 kristaps 1183: if ( ! roffdata(tree, 1, *argv++))
1184: return(0);
1185: continue;
1.31 kristaps 1186: }
1.37 kristaps 1187:
1.33 kristaps 1188: for (j = 0; argv[j]; j++)
1189: if ( ! roffispunct(argv[j]))
1190: break;
1191:
1192: if (argv[j]) {
1.37 kristaps 1193: if ( ! roffdata(tree, 0, *argv++))
1194: return(0);
1195: continue;
1.33 kristaps 1196: }
1197:
1.31 kristaps 1198: break;
1199: }
1200:
1201: if ( ! first)
1202: return(1);
1.33 kristaps 1203:
1.31 kristaps 1204: return(roffpurgepunct(tree, argv));
1205: }
1206:
1207:
1208: /* ARGSUSED */
1209: static int
1.1 kristaps 1210: roff_Os(ROFFCALL_ARGS)
1211: {
1.30 kristaps 1212: char *p;
1.1 kristaps 1213:
1.30 kristaps 1214: if (ROFF_BODY & tree->state) {
1.4 kristaps 1215: assert( ! (ROFF_PRELUDE & tree->state));
1216: assert(ROFF_PRELUDE_Os & tree->state);
1217: return(roff_text(tok, tree, argv, type));
1218: }
1.1 kristaps 1219:
1220: assert(ROFF_PRELUDE & tree->state);
1221: if ( ! (ROFF_PRELUDE_Dt & tree->state) ||
1222: ! (ROFF_PRELUDE_Dd & tree->state)) {
1.12 kristaps 1223: roff_err(tree, *argv, "out-of-order `Os' in prelude");
1.1 kristaps 1224: return(0);
1225: }
1226:
1.30 kristaps 1227: tree->os[0] = 0;
1228:
1229: p = *++argv;
1230:
1231: while (*argv) {
1232: if (strlcat(tree->os, *argv++, sizeof(tree->os))
1233: < sizeof(tree->os))
1234: continue;
1235: roff_err(tree, p, "`Os' value too long");
1236: return(0);
1237: }
1238:
1239: if (0 == tree->os[0])
1240: if (strlcpy(tree->os, "LOCAL", sizeof(tree->os))
1241: >= sizeof(tree->os)) {
1242: roff_err(tree, p, "`Os' value too long");
1243: return(0);
1244: }
1.1 kristaps 1245:
1246: tree->state |= ROFF_PRELUDE_Os;
1247: tree->state &= ~ROFF_PRELUDE;
1248: tree->state |= ROFF_BODY;
1249:
1.4 kristaps 1250: assert(NULL == tree->last);
1251:
1.36 kristaps 1252: return((*tree->cb.roffhead)(tree->arg, &tree->tm,
1253: tree->os, tree->title, tree->section,
1254: tree->volume));
1.1 kristaps 1255: }
1256:
1257:
1258: /* ARGSUSED */
1259: static int
1.2 kristaps 1260: roff_layout(ROFFCALL_ARGS)
1.1 kristaps 1261: {
1.37 kristaps 1262: int i, c, argcp[ROFF_MAXLINEARG];
1263: char *argvp[ROFF_MAXLINEARG];
1.1 kristaps 1264:
1.4 kristaps 1265: if (ROFF_PRELUDE & tree->state) {
1.27 kristaps 1266: roff_err(tree, *argv, "bad `%s' in prelude",
1.12 kristaps 1267: toknames[tok]);
1.4 kristaps 1268: return(0);
1.27 kristaps 1269: } else if (ROFF_EXIT == type) {
1.15 kristaps 1270: roffnode_free(tree);
1.35 kristaps 1271: if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))
1272: return(0);
1.15 kristaps 1273: return((*tree->cb.roffblkout)(tree->arg, tok));
1.2 kristaps 1274: }
1.1 kristaps 1275:
1.27 kristaps 1276: assert( ! (ROFF_CALLABLE & tokens[tok].flags));
1.5 kristaps 1277:
1.27 kristaps 1278: ++argv;
1.5 kristaps 1279:
1.27 kristaps 1280: if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))
1281: return(0);
1.4 kristaps 1282: if (NULL == roffnode_new(tok, tree))
1.2 kristaps 1283: return(0);
1284:
1.27 kristaps 1285: /*
1286: * Layouts have two parts: the layout body and header. The
1287: * layout header is the trailing text of the line macro, while
1288: * the layout body is everything following until termination.
1289: */
1290:
1.18 kristaps 1291: if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp, argvp))
1292: return(0);
1293: if (NULL == *argv)
1.35 kristaps 1294: return((*tree->cb.roffblkbodyin)
1295: (tree->arg, tok, argcp, argvp));
1296:
1297: if ( ! (*tree->cb.roffblkheadin)(tree->arg, tok, argcp, argvp))
1.2 kristaps 1298: return(0);
1299:
1.27 kristaps 1300: /*
1301: * If there are no parsable parts, then write remaining tokens
1302: * into the layout header and exit.
1303: */
1304:
1.2 kristaps 1305: if ( ! (ROFF_PARSED & tokens[tok].flags)) {
1.21 kristaps 1306: i = 0;
1.37 kristaps 1307: while (*argv)
1308: if ( ! roffdata(tree, i++, *argv++))
1.14 kristaps 1309: return(0);
1.37 kristaps 1310:
1.35 kristaps 1311: if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
1312: return(0);
1313: return((*tree->cb.roffblkbodyin)
1314: (tree->arg, tok, argcp, argvp));
1.2 kristaps 1315: }
1316:
1.27 kristaps 1317: /*
1318: * Parsable elements may be in the header (or be the header, for
1319: * that matter). Follow the regular parsing rules for these.
1320: */
1321:
1.21 kristaps 1322: i = 0;
1.1 kristaps 1323: while (*argv) {
1.26 kristaps 1324: if (ROFF_MAX == (c = rofffindcallable(*argv))) {
1325: assert(tree->arg);
1.37 kristaps 1326: if ( ! roffdata(tree, i++, *argv++))
1.8 kristaps 1327: return(0);
1.26 kristaps 1328: continue;
1329: }
1.33 kristaps 1330: if ( ! roffcall(tree, c, argv))
1.14 kristaps 1331: return(0);
1.26 kristaps 1332: break;
1.21 kristaps 1333: }
1334:
1335: /*
1.27 kristaps 1336: * If there's trailing punctuation in the header, then write it
1337: * out now. Here we mimic the behaviour of a line-dominant text
1338: * macro.
1.21 kristaps 1339: */
1340:
1.35 kristaps 1341: if (NULL == *argv) {
1342: if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
1343: return(0);
1344: return((*tree->cb.roffblkbodyin)
1345: (tree->arg, tok, argcp, argvp));
1346: }
1.21 kristaps 1347:
1.27 kristaps 1348: /*
1349: * Expensive. Scan to the end of line then work backwards until
1350: * a token isn't punctuation.
1351: */
1352:
1.31 kristaps 1353: if ( ! roffpurgepunct(tree, argv))
1354: return(0);
1.12 kristaps 1355:
1.35 kristaps 1356: if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
1357: return(0);
1358: return((*tree->cb.roffblkbodyin)
1359: (tree->arg, tok, argcp, argvp));
1.2 kristaps 1360: }
1361:
1362:
1363: /* ARGSUSED */
1364: static int
1365: roff_text(ROFFCALL_ARGS)
1366: {
1.37 kristaps 1367: int i, j, first, c, argcp[ROFF_MAXLINEARG];
1368: char *argvp[ROFF_MAXLINEARG];
1.2 kristaps 1369:
1.4 kristaps 1370: if (ROFF_PRELUDE & tree->state) {
1.12 kristaps 1371: roff_err(tree, *argv, "`%s' disallowed in prelude",
1372: toknames[tok]);
1.4 kristaps 1373: return(0);
1374: }
1375:
1.27 kristaps 1376: first = (*argv == tree->cur);
1.12 kristaps 1377: argv++;
1.5 kristaps 1378:
1.27 kristaps 1379: if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))
1380: return(0);
1.24 kristaps 1381: if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))
1.2 kristaps 1382: return(0);
1.27 kristaps 1383: if (NULL == *argv)
1384: return((*tree->cb.roffout)(tree->arg, tok));
1.1 kristaps 1385:
1.2 kristaps 1386: if ( ! (ROFF_PARSED & tokens[tok].flags)) {
1.21 kristaps 1387: i = 0;
1.37 kristaps 1388: while (*argv)
1389: if ( ! roffdata(tree, i++, *argv++))
1.14 kristaps 1390: return(0);
1.37 kristaps 1391:
1.15 kristaps 1392: return((*tree->cb.roffout)(tree->arg, tok));
1.2 kristaps 1393: }
1.1 kristaps 1394:
1.27 kristaps 1395: /*
1396: * Deal with punctuation. Ugly. Work ahead until we encounter
1397: * terminating punctuation. If we encounter it and all
1398: * subsequent tokens are punctuation, then stop processing (the
1399: * line-dominant macro will print these tokens after closure).
1400: */
1401:
1.21 kristaps 1402: i = 0;
1.2 kristaps 1403: while (*argv) {
1.33 kristaps 1404: if (ROFF_MAX != (c = rofffindcallable(*argv))) {
1405: if ( ! (ROFF_LSCOPE & tokens[tok].flags))
1406: if ( ! (*tree->cb.roffout)(tree->arg, tok))
1407: return(0);
1408:
1409: if ( ! roffcall(tree, c, argv))
1410: return(0);
1411:
1412: if (ROFF_LSCOPE & tokens[tok].flags)
1413: if ( ! (*tree->cb.roffout)(tree->arg, tok))
1.27 kristaps 1414: return(0);
1.33 kristaps 1415:
1416: break;
1417: }
1.21 kristaps 1418:
1.33 kristaps 1419: if ( ! roffispunct(*argv)) {
1.37 kristaps 1420: if ( ! roffdata(tree, i++, *argv++))
1.33 kristaps 1421: return(0);
1422: continue;
1423: }
1.27 kristaps 1424:
1.33 kristaps 1425: i = 1;
1426: for (j = 0; argv[j]; j++)
1427: if ( ! roffispunct(argv[j]))
1428: break;
1.27 kristaps 1429:
1.33 kristaps 1430: if (argv[j]) {
1.37 kristaps 1431: if ( ! roffdata(tree, 0, *argv++))
1.27 kristaps 1432: return(0);
1.33 kristaps 1433: continue;
1.8 kristaps 1434: }
1.20 kristaps 1435:
1.33 kristaps 1436: if ( ! (*tree->cb.roffout)(tree->arg, tok))
1.14 kristaps 1437: return(0);
1.20 kristaps 1438: break;
1.14 kristaps 1439: }
1.12 kristaps 1440:
1.27 kristaps 1441: if (NULL == *argv)
1442: return((*tree->cb.roffout)(tree->arg, tok));
1443: if ( ! first)
1444: return(1);
1.21 kristaps 1445:
1.31 kristaps 1446: return(roffpurgepunct(tree, argv));
1.6 kristaps 1447: }
1448:
1449:
1.9 kristaps 1450: /* ARGSUSED */
1.6 kristaps 1451: static int
1.27 kristaps 1452: roff_noop(ROFFCALL_ARGS)
1.6 kristaps 1453: {
1454:
1455: return(1);
1.1 kristaps 1456: }
1.9 kristaps 1457:
1458:
1459: /* ARGSUSED */
1460: static int
1.27 kristaps 1461: roff_depr(ROFFCALL_ARGS)
1.9 kristaps 1462: {
1463:
1.27 kristaps 1464: roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]);
1465: return(0);
1.11 kristaps 1466: }
1.12 kristaps 1467:
1468:
1469: static void
1470: roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...)
1471: {
1472: va_list ap;
1473: char buf[128];
1474:
1475: va_start(ap, fmt);
1476: (void)vsnprintf(buf, sizeof(buf), fmt, ap);
1477: va_end(ap);
1478:
1.15 kristaps 1479: (*tree->cb.roffmsg)(tree->arg,
1480: ROFF_WARN, tree->cur, pos, buf);
1.12 kristaps 1481: }
1482:
1483:
1484: static void
1485: roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)
1486: {
1487: va_list ap;
1488: char buf[128];
1489:
1490: va_start(ap, fmt);
1491: (void)vsnprintf(buf, sizeof(buf), fmt, ap);
1492: va_end(ap);
1493:
1.15 kristaps 1494: (*tree->cb.roffmsg)(tree->arg,
1495: ROFF_ERROR, tree->cur, pos, buf);
1.12 kristaps 1496: }
1.33 kristaps 1497:
CVSweb