Annotation of mandoc/mdoc_state.c, Revision 1.10
1.10 ! schwarze 1: /* $Id: mdoc_state.c,v 1.9 2017/11/29 20:05:33 schwarze Exp $ */
1.1 schwarze 2: /*
1.5 schwarze 3: * Copyright (c) 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 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 above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #include <sys/types.h>
18:
1.6 schwarze 19: #include <assert.h>
1.1 schwarze 20: #include <stdlib.h>
21: #include <string.h>
22:
23: #include "mandoc.h"
24: #include "roff.h"
25: #include "mdoc.h"
26: #include "libmandoc.h"
27: #include "libmdoc.h"
28:
29: #define STATE_ARGS struct roff_man *mdoc, struct roff_node *n
30:
31: typedef void (*state_handler)(STATE_ARGS);
32:
33: static void state_bd(STATE_ARGS);
1.2 schwarze 34: static void state_bl(STATE_ARGS);
1.1 schwarze 35: static void state_dl(STATE_ARGS);
36: static void state_sh(STATE_ARGS);
37: static void state_sm(STATE_ARGS);
38:
1.10 ! schwarze 39: static const state_handler state_handlers[MDOC_MAX - MDOC_Dd] = {
1.1 schwarze 40: NULL, /* Dd */
41: NULL, /* Dt */
42: NULL, /* Os */
43: state_sh, /* Sh */
44: NULL, /* Ss */
45: NULL, /* Pp */
46: NULL, /* D1 */
47: state_dl, /* Dl */
48: state_bd, /* Bd */
49: NULL, /* Ed */
1.2 schwarze 50: state_bl, /* Bl */
1.1 schwarze 51: NULL, /* El */
52: NULL, /* It */
53: NULL, /* Ad */
54: NULL, /* An */
1.5 schwarze 55: NULL, /* Ap */
1.1 schwarze 56: NULL, /* Ar */
57: NULL, /* Cd */
58: NULL, /* Cm */
59: NULL, /* Dv */
60: NULL, /* Er */
61: NULL, /* Ev */
62: NULL, /* Ex */
63: NULL, /* Fa */
64: NULL, /* Fd */
65: NULL, /* Fl */
66: NULL, /* Fn */
67: NULL, /* Ft */
68: NULL, /* Ic */
69: NULL, /* In */
70: NULL, /* Li */
71: NULL, /* Nd */
72: NULL, /* Nm */
73: NULL, /* Op */
74: NULL, /* Ot */
75: NULL, /* Pa */
76: NULL, /* Rv */
77: NULL, /* St */
78: NULL, /* Va */
79: NULL, /* Vt */
80: NULL, /* Xr */
81: NULL, /* %A */
82: NULL, /* %B */
83: NULL, /* %D */
84: NULL, /* %I */
85: NULL, /* %J */
86: NULL, /* %N */
87: NULL, /* %O */
88: NULL, /* %P */
89: NULL, /* %R */
90: NULL, /* %T */
91: NULL, /* %V */
92: NULL, /* Ac */
93: NULL, /* Ao */
94: NULL, /* Aq */
95: NULL, /* At */
96: NULL, /* Bc */
97: NULL, /* Bf */
98: NULL, /* Bo */
99: NULL, /* Bq */
100: NULL, /* Bsx */
101: NULL, /* Bx */
102: NULL, /* Db */
103: NULL, /* Dc */
104: NULL, /* Do */
105: NULL, /* Dq */
106: NULL, /* Ec */
107: NULL, /* Ef */
108: NULL, /* Em */
109: NULL, /* Eo */
110: NULL, /* Fx */
111: NULL, /* Ms */
112: NULL, /* No */
113: NULL, /* Ns */
114: NULL, /* Nx */
115: NULL, /* Ox */
116: NULL, /* Pc */
117: NULL, /* Pf */
118: NULL, /* Po */
119: NULL, /* Pq */
120: NULL, /* Qc */
121: NULL, /* Ql */
122: NULL, /* Qo */
123: NULL, /* Qq */
124: NULL, /* Re */
125: NULL, /* Rs */
126: NULL, /* Sc */
127: NULL, /* So */
128: NULL, /* Sq */
129: state_sm, /* Sm */
130: NULL, /* Sx */
131: NULL, /* Sy */
132: NULL, /* Tn */
133: NULL, /* Ux */
134: NULL, /* Xc */
135: NULL, /* Xo */
136: NULL, /* Fo */
137: NULL, /* Fc */
138: NULL, /* Oo */
139: NULL, /* Oc */
140: NULL, /* Bk */
141: NULL, /* Ek */
142: NULL, /* Bt */
143: NULL, /* Hf */
144: NULL, /* Fr */
145: NULL, /* Ud */
146: NULL, /* Lb */
147: NULL, /* Lp */
148: NULL, /* Lk */
149: NULL, /* Mt */
150: NULL, /* Brq */
151: NULL, /* Bro */
152: NULL, /* Brc */
153: NULL, /* %C */
154: NULL, /* Es */
155: NULL, /* En */
156: NULL, /* Dx */
157: NULL, /* %Q */
158: NULL, /* %U */
159: NULL, /* Ta */
160: };
161:
162:
163: void
164: mdoc_state(struct roff_man *mdoc, struct roff_node *n)
165: {
166: state_handler handler;
167:
1.6 schwarze 168: if (n->tok == TOKEN_NONE || n->tok < ROFF_MAX)
1.1 schwarze 169: return;
170:
1.6 schwarze 171: assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
1.10 ! schwarze 172: if ((mdoc_macro(n->tok)->flags & MDOC_PROLOGUE) == 0)
1.1 schwarze 173: mdoc->flags |= MDOC_PBODY;
174:
1.10 ! schwarze 175: handler = state_handlers[n->tok - MDOC_Dd];
1.1 schwarze 176: if (*handler)
177: (*handler)(mdoc, n);
178: }
179:
180: void
181: mdoc_state_reset(struct roff_man *mdoc)
182: {
183:
184: roff_setreg(mdoc->roff, "nS", 0, '=');
185: mdoc->flags = 0;
186: }
187:
188: static void
189: state_bd(STATE_ARGS)
190: {
191: enum mdocargt arg;
192:
193: if (n->type != ROFFT_HEAD &&
194: (n->type != ROFFT_BODY || n->end != ENDBODY_NOT))
1.3 schwarze 195: return;
196:
197: if (n->parent->args == NULL)
1.1 schwarze 198: return;
199:
200: arg = n->parent->args->argv[0].arg;
201: if (arg != MDOC_Literal && arg != MDOC_Unfilled)
202: return;
203:
204: state_dl(mdoc, n);
1.2 schwarze 205: }
206:
207: static void
208: state_bl(STATE_ARGS)
209: {
1.9 schwarze 210: struct mdoc_arg *args;
211: size_t i;
1.2 schwarze 212:
213: if (n->type != ROFFT_HEAD || n->parent->args == NULL)
214: return;
215:
1.9 schwarze 216: args = n->parent->args;
217: for (i = 0; i < args->argc; i++) {
218: switch(args->argv[i].arg) {
219: case MDOC_Diag:
220: n->norm->Bl.type = LIST_diag;
221: return;
222: case MDOC_Column:
223: n->norm->Bl.type = LIST_column;
224: return;
225: default:
226: break;
227: }
1.2 schwarze 228: }
1.1 schwarze 229: }
230:
231: static void
232: state_dl(STATE_ARGS)
233: {
234:
235: switch (n->type) {
236: case ROFFT_HEAD:
237: mdoc->flags |= MDOC_LITERAL;
238: break;
239: case ROFFT_BODY:
240: mdoc->flags &= ~MDOC_LITERAL;
241: break;
242: default:
243: break;
244: }
245: }
246:
247: static void
248: state_sh(STATE_ARGS)
249: {
250: struct roff_node *nch;
251: char *secname;
252:
253: if (n->type != ROFFT_HEAD)
254: return;
255:
1.4 schwarze 256: if ( ! (n->flags & NODE_VALID)) {
1.1 schwarze 257: secname = NULL;
258: deroff(&secname, n);
259:
260: /*
261: * Set the section attribute for the BLOCK, HEAD,
262: * and HEAD children; the latter can only be TEXT
263: * nodes, so no recursion is needed. For other
264: * nodes, including the .Sh BODY, this is done
265: * when allocating the node data structures, but
266: * for .Sh BLOCK and HEAD, the section is still
267: * unknown at that time.
268: */
269:
270: n->sec = n->parent->sec = secname == NULL ?
271: SEC_CUSTOM : mdoc_a2sec(secname);
272: for (nch = n->child; nch != NULL; nch = nch->next)
273: nch->sec = n->sec;
274: free(secname);
275: }
276:
277: if ((mdoc->lastsec = n->sec) == SEC_SYNOPSIS) {
278: roff_setreg(mdoc->roff, "nS", 1, '=');
279: mdoc->flags |= MDOC_SYNOPSIS;
280: } else {
281: roff_setreg(mdoc->roff, "nS", 0, '=');
282: mdoc->flags &= ~MDOC_SYNOPSIS;
283: }
284: }
285:
286: static void
287: state_sm(STATE_ARGS)
288: {
289:
290: if (n->child == NULL)
291: mdoc->flags ^= MDOC_SMOFF;
292: else if ( ! strcmp(n->child->string, "on"))
293: mdoc->flags &= ~MDOC_SMOFF;
294: else if ( ! strcmp(n->child->string, "off"))
295: mdoc->flags |= MDOC_SMOFF;
296: }
CVSweb