Annotation of src/usr.bin/mandoc/eqn.c, Revision 1.26
1.26 ! schwarze 1: /* $OpenBSD: eqn.c,v 1.25 2017/03/11 15:42:03 schwarze Exp $ */
1.1 schwarze 2: /*
1.13 schwarze 3: * Copyright (c) 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.20 schwarze 4: * Copyright (c) 2014, 2015 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: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
1.14 schwarze 18: #include <sys/types.h>
19:
1.1 schwarze 20: #include <assert.h>
1.4 schwarze 21: #include <limits.h>
22: #include <stdio.h>
1.1 schwarze 23: #include <stdlib.h>
24: #include <string.h>
1.5 schwarze 25: #include <time.h>
1.1 schwarze 26:
27: #include "mandoc.h"
1.6 schwarze 28: #include "mandoc_aux.h"
1.1 schwarze 29: #include "libmandoc.h"
30: #include "libroff.h"
31:
1.4 schwarze 32: #define EQN_NEST_MAX 128 /* maximum nesting of defines */
1.14 schwarze 33: #define STRNEQ(p1, sz1, p2, sz2) \
34: ((sz1) == (sz2) && 0 == strncmp((p1), (p2), (sz1)))
35:
36: enum eqn_tok {
37: EQN_TOK_DYAD = 0,
38: EQN_TOK_VEC,
39: EQN_TOK_UNDER,
40: EQN_TOK_BAR,
41: EQN_TOK_TILDE,
42: EQN_TOK_HAT,
43: EQN_TOK_DOT,
44: EQN_TOK_DOTDOT,
45: EQN_TOK_FWD,
46: EQN_TOK_BACK,
47: EQN_TOK_DOWN,
48: EQN_TOK_UP,
49: EQN_TOK_FAT,
50: EQN_TOK_ROMAN,
51: EQN_TOK_ITALIC,
52: EQN_TOK_BOLD,
53: EQN_TOK_SIZE,
54: EQN_TOK_SUB,
55: EQN_TOK_SUP,
56: EQN_TOK_SQRT,
57: EQN_TOK_OVER,
58: EQN_TOK_FROM,
59: EQN_TOK_TO,
60: EQN_TOK_BRACE_OPEN,
61: EQN_TOK_BRACE_CLOSE,
62: EQN_TOK_GSIZE,
63: EQN_TOK_GFONT,
64: EQN_TOK_MARK,
65: EQN_TOK_LINEUP,
66: EQN_TOK_LEFT,
67: EQN_TOK_RIGHT,
68: EQN_TOK_PILE,
69: EQN_TOK_LPILE,
70: EQN_TOK_RPILE,
71: EQN_TOK_CPILE,
72: EQN_TOK_MATRIX,
73: EQN_TOK_CCOL,
74: EQN_TOK_LCOL,
75: EQN_TOK_RCOL,
76: EQN_TOK_DELIM,
77: EQN_TOK_DEFINE,
78: EQN_TOK_TDEFINE,
79: EQN_TOK_NDEFINE,
80: EQN_TOK_UNDEF,
81: EQN_TOK_EOF,
82: EQN_TOK_ABOVE,
83: EQN_TOK__MAX
84: };
1.4 schwarze 85:
1.14 schwarze 86: static const char *eqn_toks[EQN_TOK__MAX] = {
87: "dyad", /* EQN_TOK_DYAD */
88: "vec", /* EQN_TOK_VEC */
89: "under", /* EQN_TOK_UNDER */
90: "bar", /* EQN_TOK_BAR */
91: "tilde", /* EQN_TOK_TILDE */
92: "hat", /* EQN_TOK_HAT */
93: "dot", /* EQN_TOK_DOT */
94: "dotdot", /* EQN_TOK_DOTDOT */
95: "fwd", /* EQN_TOK_FWD * */
96: "back", /* EQN_TOK_BACK */
97: "down", /* EQN_TOK_DOWN */
98: "up", /* EQN_TOK_UP */
99: "fat", /* EQN_TOK_FAT */
100: "roman", /* EQN_TOK_ROMAN */
101: "italic", /* EQN_TOK_ITALIC */
102: "bold", /* EQN_TOK_BOLD */
103: "size", /* EQN_TOK_SIZE */
104: "sub", /* EQN_TOK_SUB */
105: "sup", /* EQN_TOK_SUP */
106: "sqrt", /* EQN_TOK_SQRT */
107: "over", /* EQN_TOK_OVER */
108: "from", /* EQN_TOK_FROM */
109: "to", /* EQN_TOK_TO */
110: "{", /* EQN_TOK_BRACE_OPEN */
111: "}", /* EQN_TOK_BRACE_CLOSE */
112: "gsize", /* EQN_TOK_GSIZE */
113: "gfont", /* EQN_TOK_GFONT */
114: "mark", /* EQN_TOK_MARK */
115: "lineup", /* EQN_TOK_LINEUP */
116: "left", /* EQN_TOK_LEFT */
117: "right", /* EQN_TOK_RIGHT */
118: "pile", /* EQN_TOK_PILE */
119: "lpile", /* EQN_TOK_LPILE */
120: "rpile", /* EQN_TOK_RPILE */
121: "cpile", /* EQN_TOK_CPILE */
122: "matrix", /* EQN_TOK_MATRIX */
123: "ccol", /* EQN_TOK_CCOL */
124: "lcol", /* EQN_TOK_LCOL */
125: "rcol", /* EQN_TOK_RCOL */
126: "delim", /* EQN_TOK_DELIM */
127: "define", /* EQN_TOK_DEFINE */
128: "tdefine", /* EQN_TOK_TDEFINE */
129: "ndefine", /* EQN_TOK_NDEFINE */
130: "undef", /* EQN_TOK_UNDEF */
131: NULL, /* EQN_TOK_EOF */
132: "above", /* EQN_TOK_ABOVE */
1.4 schwarze 133: };
134:
135: enum eqn_symt {
136: EQNSYM_alpha,
137: EQNSYM_beta,
138: EQNSYM_chi,
139: EQNSYM_delta,
140: EQNSYM_epsilon,
141: EQNSYM_eta,
142: EQNSYM_gamma,
143: EQNSYM_iota,
144: EQNSYM_kappa,
145: EQNSYM_lambda,
146: EQNSYM_mu,
147: EQNSYM_nu,
148: EQNSYM_omega,
149: EQNSYM_omicron,
150: EQNSYM_phi,
151: EQNSYM_pi,
152: EQNSYM_ps,
153: EQNSYM_rho,
154: EQNSYM_sigma,
155: EQNSYM_tau,
156: EQNSYM_theta,
157: EQNSYM_upsilon,
158: EQNSYM_xi,
159: EQNSYM_zeta,
160: EQNSYM_DELTA,
161: EQNSYM_GAMMA,
162: EQNSYM_LAMBDA,
163: EQNSYM_OMEGA,
164: EQNSYM_PHI,
165: EQNSYM_PI,
166: EQNSYM_PSI,
167: EQNSYM_SIGMA,
168: EQNSYM_THETA,
169: EQNSYM_UPSILON,
170: EQNSYM_XI,
171: EQNSYM_inter,
172: EQNSYM_union,
173: EQNSYM_prod,
174: EQNSYM_int,
175: EQNSYM_sum,
176: EQNSYM_grad,
177: EQNSYM_del,
178: EQNSYM_times,
179: EQNSYM_cdot,
180: EQNSYM_nothing,
181: EQNSYM_approx,
182: EQNSYM_prime,
183: EQNSYM_half,
184: EQNSYM_partial,
185: EQNSYM_inf,
186: EQNSYM_muchgreat,
187: EQNSYM_muchless,
188: EQNSYM_larrow,
189: EQNSYM_rarrow,
190: EQNSYM_pm,
191: EQNSYM_nequal,
192: EQNSYM_equiv,
193: EQNSYM_lessequal,
194: EQNSYM_moreequal,
1.21 bentley 195: EQNSYM_minus,
1.4 schwarze 196: EQNSYM__MAX
197: };
198:
199: struct eqnsym {
1.14 schwarze 200: const char *str;
1.4 schwarze 201: const char *sym;
202: };
203:
204: static const struct eqnsym eqnsyms[EQNSYM__MAX] = {
1.14 schwarze 205: { "alpha", "*a" }, /* EQNSYM_alpha */
206: { "beta", "*b" }, /* EQNSYM_beta */
207: { "chi", "*x" }, /* EQNSYM_chi */
208: { "delta", "*d" }, /* EQNSYM_delta */
209: { "epsilon", "*e" }, /* EQNSYM_epsilon */
210: { "eta", "*y" }, /* EQNSYM_eta */
211: { "gamma", "*g" }, /* EQNSYM_gamma */
212: { "iota", "*i" }, /* EQNSYM_iota */
213: { "kappa", "*k" }, /* EQNSYM_kappa */
214: { "lambda", "*l" }, /* EQNSYM_lambda */
215: { "mu", "*m" }, /* EQNSYM_mu */
216: { "nu", "*n" }, /* EQNSYM_nu */
217: { "omega", "*w" }, /* EQNSYM_omega */
218: { "omicron", "*o" }, /* EQNSYM_omicron */
219: { "phi", "*f" }, /* EQNSYM_phi */
220: { "pi", "*p" }, /* EQNSYM_pi */
221: { "psi", "*q" }, /* EQNSYM_psi */
222: { "rho", "*r" }, /* EQNSYM_rho */
223: { "sigma", "*s" }, /* EQNSYM_sigma */
224: { "tau", "*t" }, /* EQNSYM_tau */
225: { "theta", "*h" }, /* EQNSYM_theta */
226: { "upsilon", "*u" }, /* EQNSYM_upsilon */
227: { "xi", "*c" }, /* EQNSYM_xi */
228: { "zeta", "*z" }, /* EQNSYM_zeta */
229: { "DELTA", "*D" }, /* EQNSYM_DELTA */
230: { "GAMMA", "*G" }, /* EQNSYM_GAMMA */
231: { "LAMBDA", "*L" }, /* EQNSYM_LAMBDA */
232: { "OMEGA", "*W" }, /* EQNSYM_OMEGA */
233: { "PHI", "*F" }, /* EQNSYM_PHI */
234: { "PI", "*P" }, /* EQNSYM_PI */
235: { "PSI", "*Q" }, /* EQNSYM_PSI */
236: { "SIGMA", "*S" }, /* EQNSYM_SIGMA */
237: { "THETA", "*H" }, /* EQNSYM_THETA */
238: { "UPSILON", "*U" }, /* EQNSYM_UPSILON */
239: { "XI", "*C" }, /* EQNSYM_XI */
240: { "inter", "ca" }, /* EQNSYM_inter */
241: { "union", "cu" }, /* EQNSYM_union */
242: { "prod", "product" }, /* EQNSYM_prod */
243: { "int", "integral" }, /* EQNSYM_int */
244: { "sum", "sum" }, /* EQNSYM_sum */
245: { "grad", "gr" }, /* EQNSYM_grad */
246: { "del", "gr" }, /* EQNSYM_del */
247: { "times", "mu" }, /* EQNSYM_times */
248: { "cdot", "pc" }, /* EQNSYM_cdot */
249: { "nothing", "&" }, /* EQNSYM_nothing */
250: { "approx", "~~" }, /* EQNSYM_approx */
1.21 bentley 251: { "prime", "fm" }, /* EQNSYM_prime */
1.14 schwarze 252: { "half", "12" }, /* EQNSYM_half */
253: { "partial", "pd" }, /* EQNSYM_partial */
254: { "inf", "if" }, /* EQNSYM_inf */
255: { ">>", ">>" }, /* EQNSYM_muchgreat */
256: { "<<", "<<" }, /* EQNSYM_muchless */
257: { "<-", "<-" }, /* EQNSYM_larrow */
258: { "->", "->" }, /* EQNSYM_rarrow */
259: { "+-", "+-" }, /* EQNSYM_pm */
260: { "!=", "!=" }, /* EQNSYM_nequal */
261: { "==", "==" }, /* EQNSYM_equiv */
262: { "<=", "<=" }, /* EQNSYM_lessequal */
263: { ">=", ">=" }, /* EQNSYM_moreequal */
1.21 bentley 264: { "-", "mi" }, /* EQNSYM_minus */
1.4 schwarze 265: };
266:
1.20 schwarze 267: static struct eqn_box *eqn_box_alloc(struct eqn_node *, struct eqn_box *);
268: static void eqn_box_free(struct eqn_box *);
269: static struct eqn_box *eqn_box_makebinary(struct eqn_node *,
270: enum eqn_post, struct eqn_box *);
271: static void eqn_def(struct eqn_node *);
272: static struct eqn_def *eqn_def_find(struct eqn_node *, const char *, size_t);
273: static void eqn_delim(struct eqn_node *);
274: static const char *eqn_next(struct eqn_node *, char, size_t *, int);
275: static const char *eqn_nextrawtok(struct eqn_node *, size_t *);
276: static const char *eqn_nexttok(struct eqn_node *, size_t *);
277: static enum rofferr eqn_parse(struct eqn_node *, struct eqn_box *);
278: static enum eqn_tok eqn_tok_parse(struct eqn_node *, char **);
279: static void eqn_undef(struct eqn_node *);
280:
281:
1.1 schwarze 282: enum rofferr
1.7 schwarze 283: eqn_read(struct eqn_node **epp, int ln,
1.4 schwarze 284: const char *p, int pos, int *offs)
1.1 schwarze 285: {
286: size_t sz;
287: struct eqn_node *ep;
1.4 schwarze 288: enum rofferr er;
1.1 schwarze 289:
290: ep = *epp;
291:
1.4 schwarze 292: /*
293: * If we're the terminating mark, unset our equation status and
294: * validate the full equation.
295: */
296:
297: if (0 == strncmp(p, ".EN", 3)) {
298: er = eqn_end(epp);
299: p += 3;
300: while (' ' == *p || '\t' == *p)
301: p++;
1.7 schwarze 302: if ('\0' == *p)
1.22 schwarze 303: return er;
1.10 schwarze 304: mandoc_vmsg(MANDOCERR_ARG_SKIP, ep->parse,
305: ln, pos, "EN %s", p);
1.22 schwarze 306: return er;
1.4 schwarze 307: }
1.1 schwarze 308:
1.4 schwarze 309: /*
310: * Build up the full string, replacing all newlines with regular
311: * whitespace.
312: */
313:
314: sz = strlen(p + pos) + 1;
315: ep->data = mandoc_realloc(ep->data, ep->sz + sz + 1);
316:
317: /* First invocation: nil terminate the string. */
318:
319: if (0 == ep->sz)
320: *ep->data = '\0';
321:
322: ep->sz += sz;
323: strlcat(ep->data, p + pos, ep->sz + 1);
324: strlcat(ep->data, " ", ep->sz + 1);
1.22 schwarze 325: return ROFF_IGN;
1.1 schwarze 326: }
327:
328: struct eqn_node *
1.18 schwarze 329: eqn_alloc(int pos, int line, struct mparse *parse)
1.1 schwarze 330: {
331: struct eqn_node *p;
332:
333: p = mandoc_calloc(1, sizeof(struct eqn_node));
1.4 schwarze 334:
335: p->parse = parse;
336: p->eqn.ln = line;
1.1 schwarze 337: p->eqn.pos = pos;
1.4 schwarze 338: p->gsize = EQN_DEFSIZE;
1.1 schwarze 339:
1.22 schwarze 340: return p;
1.1 schwarze 341: }
342:
1.14 schwarze 343: /*
344: * Find the key "key" of the give size within our eqn-defined values.
345: */
346: static struct eqn_def *
347: eqn_def_find(struct eqn_node *ep, const char *key, size_t sz)
1.1 schwarze 348: {
1.4 schwarze 349: int i;
350:
1.14 schwarze 351: for (i = 0; i < (int)ep->defsz; i++)
352: if (ep->defs[i].keysz && STRNEQ(ep->defs[i].key,
353: ep->defs[i].keysz, key, sz))
1.22 schwarze 354: return &ep->defs[i];
1.4 schwarze 355:
1.22 schwarze 356: return NULL;
1.4 schwarze 357: }
358:
1.14 schwarze 359: /*
360: * Get the next token from the input stream using the given quote
361: * character.
362: * Optionally make any replacements.
363: */
1.4 schwarze 364: static const char *
365: eqn_next(struct eqn_node *ep, char quote, size_t *sz, int repl)
366: {
1.25 schwarze 367: static size_t last_len;
368: static int lim;
369:
1.4 schwarze 370: char *start, *next;
1.25 schwarze 371: int q, diff;
1.4 schwarze 372: size_t ssz, dummy;
373: struct eqn_def *def;
374:
375: if (NULL == sz)
376: sz = &dummy;
377:
1.25 schwarze 378: if (ep->cur >= last_len)
379: lim = 0;
1.4 schwarze 380: ep->rew = ep->cur;
381: again:
382: /* Prevent self-definitions. */
383:
384: if (lim >= EQN_NEST_MAX) {
1.20 schwarze 385: mandoc_msg(MANDOCERR_ROFFLOOP, ep->parse,
386: ep->eqn.ln, ep->eqn.pos, NULL);
1.22 schwarze 387: return NULL;
1.4 schwarze 388: }
389:
390: ep->cur = ep->rew;
391: start = &ep->data[(int)ep->cur];
392: q = 0;
393:
394: if ('\0' == *start)
1.22 schwarze 395: return NULL;
1.4 schwarze 396:
397: if (quote == *start) {
398: ep->cur++;
399: q = 1;
400: }
401:
402: start = &ep->data[(int)ep->cur];
403:
404: if ( ! q) {
405: if ('{' == *start || '}' == *start)
406: ssz = 1;
407: else
408: ssz = strcspn(start + 1, " ^~\"{}\t") + 1;
409: next = start + (int)ssz;
410: if ('\0' == *next)
411: next = NULL;
412: } else
413: next = strchr(start, quote);
414:
415: if (NULL != next) {
416: *sz = (size_t)(next - start);
417: ep->cur += *sz;
418: if (q)
419: ep->cur++;
420: while (' ' == ep->data[(int)ep->cur] ||
1.7 schwarze 421: '\t' == ep->data[(int)ep->cur] ||
422: '^' == ep->data[(int)ep->cur] ||
423: '~' == ep->data[(int)ep->cur])
1.4 schwarze 424: ep->cur++;
425: } else {
426: if (q)
1.20 schwarze 427: mandoc_msg(MANDOCERR_ARG_QUOTE, ep->parse,
428: ep->eqn.ln, ep->eqn.pos, NULL);
1.4 schwarze 429: next = strchr(start, '\0');
430: *sz = (size_t)(next - start);
431: ep->cur += *sz;
432: }
433:
434: /* Quotes aren't expanded for values. */
435:
436: if (q || ! repl)
1.22 schwarze 437: return start;
1.4 schwarze 438:
439: if (NULL != (def = eqn_def_find(ep, start, *sz))) {
440: diff = def->valsz - *sz;
441:
442: if (def->valsz > *sz) {
443: ep->sz += diff;
444: ep->data = mandoc_realloc(ep->data, ep->sz + 1);
445: ep->data[ep->sz] = '\0';
446: start = &ep->data[(int)ep->rew];
447: }
448:
449: diff = def->valsz - *sz;
1.7 schwarze 450: memmove(start + *sz + diff, start + *sz,
451: (strlen(start) - *sz) + 1);
1.4 schwarze 452: memcpy(start, def->val, def->valsz);
1.25 schwarze 453: last_len = start - ep->data + def->valsz;
1.23 schwarze 454: lim++;
1.4 schwarze 455: goto again;
456: }
457:
1.22 schwarze 458: return start;
1.4 schwarze 459: }
460:
1.14 schwarze 461: /*
462: * Get the next delimited token using the default current quote
463: * character.
464: */
465: static const char *
466: eqn_nexttok(struct eqn_node *ep, size_t *sz)
467: {
468:
1.22 schwarze 469: return eqn_next(ep, '"', sz, 1);
1.14 schwarze 470: }
471:
472: /*
473: * Get next token without replacement.
474: */
475: static const char *
476: eqn_nextrawtok(struct eqn_node *ep, size_t *sz)
477: {
478:
1.22 schwarze 479: return eqn_next(ep, '"', sz, 0);
1.14 schwarze 480: }
481:
482: /*
483: * Parse a token from the stream of text.
484: * A token consists of one of the recognised eqn(7) strings.
485: * Strings are separated by delimiting marks.
486: * This returns EQN_TOK_EOF when there are no more tokens.
487: * If the token is an unrecognised string literal, then it returns
488: * EQN_TOK__MAX and sets the "p" pointer to an allocated, nil-terminated
489: * string.
490: * This must be later freed with free(3).
491: */
492: static enum eqn_tok
493: eqn_tok_parse(struct eqn_node *ep, char **p)
494: {
495: const char *start;
496: size_t i, sz;
1.16 schwarze 497: int quoted;
1.14 schwarze 498:
499: if (NULL != p)
500: *p = NULL;
501:
1.16 schwarze 502: quoted = ep->data[ep->cur] == '"';
503:
1.14 schwarze 504: if (NULL == (start = eqn_nexttok(ep, &sz)))
1.22 schwarze 505: return EQN_TOK_EOF;
1.16 schwarze 506:
507: if (quoted) {
508: if (p != NULL)
509: *p = mandoc_strndup(start, sz);
1.22 schwarze 510: return EQN_TOK__MAX;
1.16 schwarze 511: }
1.14 schwarze 512:
513: for (i = 0; i < EQN_TOK__MAX; i++) {
514: if (NULL == eqn_toks[i])
515: continue;
516: if (STRNEQ(start, sz, eqn_toks[i], strlen(eqn_toks[i])))
517: break;
518: }
519:
520: if (i == EQN_TOK__MAX && NULL != p)
521: *p = mandoc_strndup(start, sz);
522:
1.22 schwarze 523: return i;
1.14 schwarze 524: }
525:
526: static void
527: eqn_box_free(struct eqn_box *bp)
1.4 schwarze 528: {
529:
1.14 schwarze 530: if (bp->first)
531: eqn_box_free(bp->first);
532: if (bp->next)
533: eqn_box_free(bp->next);
1.4 schwarze 534:
1.14 schwarze 535: free(bp->text);
536: free(bp->left);
537: free(bp->right);
538: free(bp->top);
539: free(bp->bottom);
540: free(bp);
1.4 schwarze 541: }
542:
1.14 schwarze 543: /*
544: * Allocate a box as the last child of the parent node.
545: */
546: static struct eqn_box *
547: eqn_box_alloc(struct eqn_node *ep, struct eqn_box *parent)
1.4 schwarze 548: {
1.14 schwarze 549: struct eqn_box *bp;
550:
551: bp = mandoc_calloc(1, sizeof(struct eqn_box));
552: bp->parent = parent;
553: bp->parent->args++;
554: bp->expectargs = UINT_MAX;
555: bp->size = ep->gsize;
556:
557: if (NULL != parent->first) {
558: parent->last->next = bp;
559: bp->prev = parent->last;
560: } else
561: parent->first = bp;
562:
563: parent->last = bp;
1.22 schwarze 564: return bp;
1.14 schwarze 565: }
1.4 schwarze 566:
1.14 schwarze 567: /*
568: * Reparent the current last node (of the current parent) under a new
569: * EQN_SUBEXPR as the first element.
570: * Then return the new parent.
571: * The new EQN_SUBEXPR will have a two-child limit.
572: */
573: static struct eqn_box *
574: eqn_box_makebinary(struct eqn_node *ep,
575: enum eqn_post pos, struct eqn_box *parent)
576: {
577: struct eqn_box *b, *newb;
1.4 schwarze 578:
1.14 schwarze 579: assert(NULL != parent->last);
580: b = parent->last;
581: if (parent->last == parent->first)
582: parent->first = NULL;
583: parent->args--;
584: parent->last = b->prev;
585: b->prev = NULL;
586: newb = eqn_box_alloc(ep, parent);
587: newb->pos = pos;
588: newb->type = EQN_SUBEXPR;
589: newb->expectargs = 2;
590: newb->args = 1;
591: newb->first = newb->last = b;
592: newb->first->next = NULL;
593: b->parent = newb;
1.22 schwarze 594: return newb;
1.4 schwarze 595: }
596:
1.14 schwarze 597: /*
1.17 schwarze 598: * Parse the "delim" control statement.
599: */
600: static void
601: eqn_delim(struct eqn_node *ep)
602: {
603: const char *start;
604: size_t sz;
605:
606: if ((start = eqn_nextrawtok(ep, &sz)) == NULL)
607: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
608: ep->eqn.ln, ep->eqn.pos, "delim");
609: else if (strncmp(start, "off", 3) == 0)
610: ep->delim = 0;
611: else if (strncmp(start, "on", 2) == 0) {
612: if (ep->odelim && ep->cdelim)
613: ep->delim = 1;
614: } else if (start[1] != '\0') {
615: ep->odelim = start[0];
616: ep->cdelim = start[1];
617: ep->delim = 1;
618: }
619: }
620:
621: /*
1.14 schwarze 622: * Undefine a previously-defined string.
623: */
1.20 schwarze 624: static void
1.14 schwarze 625: eqn_undef(struct eqn_node *ep)
1.4 schwarze 626: {
1.14 schwarze 627: const char *start;
628: struct eqn_def *def;
629: size_t sz;
1.4 schwarze 630:
1.20 schwarze 631: if ((start = eqn_nextrawtok(ep, &sz)) == NULL) {
632: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
633: ep->eqn.ln, ep->eqn.pos, "undef");
634: return;
635: }
636: if ((def = eqn_def_find(ep, start, sz)) == NULL)
637: return;
638: free(def->key);
639: free(def->val);
640: def->key = def->val = NULL;
641: def->keysz = def->valsz = 0;
1.4 schwarze 642: }
643:
1.20 schwarze 644: static void
1.14 schwarze 645: eqn_def(struct eqn_node *ep)
1.4 schwarze 646: {
647: const char *start;
648: size_t sz;
649: struct eqn_def *def;
650: int i;
651:
1.20 schwarze 652: if ((start = eqn_nextrawtok(ep, &sz)) == NULL) {
653: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
654: ep->eqn.ln, ep->eqn.pos, "define");
655: return;
1.4 schwarze 656: }
657:
1.7 schwarze 658: /*
659: * Search for a key that already exists.
1.4 schwarze 660: * Create a new key if none is found.
661: */
662: if (NULL == (def = eqn_def_find(ep, start, sz))) {
663: /* Find holes in string array. */
664: for (i = 0; i < (int)ep->defsz; i++)
665: if (0 == ep->defs[i].keysz)
666: break;
667:
668: if (i == (int)ep->defsz) {
669: ep->defsz++;
1.9 schwarze 670: ep->defs = mandoc_reallocarray(ep->defs,
671: ep->defsz, sizeof(struct eqn_def));
1.4 schwarze 672: ep->defs[i].key = ep->defs[i].val = NULL;
673: }
674:
1.20 schwarze 675: def = ep->defs + i;
676: free(def->key);
677: def->key = mandoc_strndup(start, sz);
678: def->keysz = sz;
1.4 schwarze 679: }
680:
681: start = eqn_next(ep, ep->data[(int)ep->cur], &sz, 0);
1.20 schwarze 682: if (start == NULL) {
683: mandoc_vmsg(MANDOCERR_REQ_EMPTY, ep->parse,
684: ep->eqn.ln, ep->eqn.pos, "define %s", def->key);
685: free(def->key);
686: free(def->val);
687: def->key = def->val = NULL;
688: def->keysz = def->valsz = 0;
689: return;
1.4 schwarze 690: }
1.20 schwarze 691: free(def->val);
692: def->val = mandoc_strndup(start, sz);
1.4 schwarze 693: def->valsz = sz;
694: }
695:
1.14 schwarze 696: /*
697: * Recursively parse an eqn(7) expression.
698: */
1.20 schwarze 699: static enum rofferr
1.14 schwarze 700: eqn_parse(struct eqn_node *ep, struct eqn_box *parent)
1.4 schwarze 701: {
1.20 schwarze 702: char sym[64];
703: struct eqn_box *cur;
704: const char *start;
1.14 schwarze 705: char *p;
1.20 schwarze 706: size_t i, sz;
1.15 schwarze 707: enum eqn_tok tok, subtok;
1.14 schwarze 708: enum eqn_post pos;
1.20 schwarze 709: int size;
1.4 schwarze 710:
1.19 schwarze 711: assert(parent != NULL);
1.20 schwarze 712:
713: /*
714: * Empty equation.
715: * Do not add it to the high-level syntax tree.
716: */
717:
1.19 schwarze 718: if (ep->data == NULL)
1.22 schwarze 719: return ROFF_IGN;
1.4 schwarze 720:
1.15 schwarze 721: next_tok:
722: tok = eqn_tok_parse(ep, &p);
723:
724: this_tok:
725: switch (tok) {
1.26 ! schwarze 726: case EQN_TOK_UNDEF:
1.20 schwarze 727: eqn_undef(ep);
1.14 schwarze 728: break;
1.26 ! schwarze 729: case EQN_TOK_NDEFINE:
! 730: case EQN_TOK_DEFINE:
1.20 schwarze 731: eqn_def(ep);
1.14 schwarze 732: break;
1.26 ! schwarze 733: case EQN_TOK_TDEFINE:
1.20 schwarze 734: if (eqn_nextrawtok(ep, NULL) == NULL ||
735: eqn_next(ep, ep->data[(int)ep->cur], NULL, 0) == NULL)
736: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
737: ep->eqn.ln, ep->eqn.pos, "tdefine");
1.14 schwarze 738: break;
1.26 ! schwarze 739: case EQN_TOK_DELIM:
1.17 schwarze 740: eqn_delim(ep);
741: break;
1.26 ! schwarze 742: case EQN_TOK_GFONT:
1.15 schwarze 743: if (eqn_nextrawtok(ep, NULL) == NULL)
744: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
745: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
1.14 schwarze 746: break;
1.26 ! schwarze 747: case EQN_TOK_MARK:
! 748: case EQN_TOK_LINEUP:
1.14 schwarze 749: /* Ignore these. */
750: break;
1.26 ! schwarze 751: case EQN_TOK_DYAD:
! 752: case EQN_TOK_VEC:
! 753: case EQN_TOK_UNDER:
! 754: case EQN_TOK_BAR:
! 755: case EQN_TOK_TILDE:
! 756: case EQN_TOK_HAT:
! 757: case EQN_TOK_DOT:
! 758: case EQN_TOK_DOTDOT:
1.15 schwarze 759: if (parent->last == NULL) {
760: mandoc_msg(MANDOCERR_EQN_NOBOX, ep->parse,
761: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
762: cur = eqn_box_alloc(ep, parent);
763: cur->type = EQN_TEXT;
764: cur->text = mandoc_strdup("");
1.14 schwarze 765: }
766: parent = eqn_box_makebinary(ep, EQNPOS_NONE, parent);
767: parent->type = EQN_LISTONE;
768: parent->expectargs = 1;
769: switch (tok) {
1.26 ! schwarze 770: case EQN_TOK_DOTDOT:
1.14 schwarze 771: strlcpy(sym, "\\[ad]", sizeof(sym));
772: break;
1.26 ! schwarze 773: case EQN_TOK_VEC:
1.14 schwarze 774: strlcpy(sym, "\\[->]", sizeof(sym));
775: break;
1.26 ! schwarze 776: case EQN_TOK_DYAD:
1.14 schwarze 777: strlcpy(sym, "\\[<>]", sizeof(sym));
778: break;
1.26 ! schwarze 779: case EQN_TOK_TILDE:
1.14 schwarze 780: strlcpy(sym, "\\[a~]", sizeof(sym));
781: break;
1.26 ! schwarze 782: case EQN_TOK_UNDER:
1.14 schwarze 783: strlcpy(sym, "\\[ul]", sizeof(sym));
784: break;
1.26 ! schwarze 785: case EQN_TOK_BAR:
1.14 schwarze 786: strlcpy(sym, "\\[rl]", sizeof(sym));
787: break;
1.26 ! schwarze 788: case EQN_TOK_DOT:
1.14 schwarze 789: strlcpy(sym, "\\[a.]", sizeof(sym));
790: break;
1.26 ! schwarze 791: case EQN_TOK_HAT:
1.14 schwarze 792: strlcpy(sym, "\\[ha]", sizeof(sym));
793: break;
794: default:
795: abort();
796: }
1.4 schwarze 797:
1.14 schwarze 798: switch (tok) {
1.26 ! schwarze 799: case EQN_TOK_DOTDOT:
! 800: case EQN_TOK_VEC:
! 801: case EQN_TOK_DYAD:
! 802: case EQN_TOK_TILDE:
! 803: case EQN_TOK_BAR:
! 804: case EQN_TOK_DOT:
! 805: case EQN_TOK_HAT:
1.14 schwarze 806: parent->top = mandoc_strdup(sym);
807: break;
1.26 ! schwarze 808: case EQN_TOK_UNDER:
1.14 schwarze 809: parent->bottom = mandoc_strdup(sym);
810: break;
811: default:
812: abort();
813: }
814: parent = parent->parent;
815: break;
1.26 ! schwarze 816: case EQN_TOK_FWD:
! 817: case EQN_TOK_BACK:
! 818: case EQN_TOK_DOWN:
! 819: case EQN_TOK_UP:
1.15 schwarze 820: subtok = eqn_tok_parse(ep, NULL);
821: if (subtok != EQN_TOK__MAX) {
822: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
823: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
824: tok = subtok;
825: goto this_tok;
1.14 schwarze 826: }
827: break;
1.26 ! schwarze 828: case EQN_TOK_FAT:
! 829: case EQN_TOK_ROMAN:
! 830: case EQN_TOK_ITALIC:
! 831: case EQN_TOK_BOLD:
1.14 schwarze 832: while (parent->args == parent->expectargs)
1.15 schwarze 833: parent = parent->parent;
1.14 schwarze 834: /*
835: * These values apply to the next word or sequence of
836: * words; thus, we mark that we'll have a child with
837: * exactly one of those.
838: */
839: parent = eqn_box_alloc(ep, parent);
840: parent->type = EQN_LISTONE;
841: parent->expectargs = 1;
842: switch (tok) {
1.26 ! schwarze 843: case EQN_TOK_FAT:
1.14 schwarze 844: parent->font = EQNFONT_FAT;
845: break;
1.26 ! schwarze 846: case EQN_TOK_ROMAN:
1.14 schwarze 847: parent->font = EQNFONT_ROMAN;
848: break;
1.26 ! schwarze 849: case EQN_TOK_ITALIC:
1.14 schwarze 850: parent->font = EQNFONT_ITALIC;
851: break;
1.26 ! schwarze 852: case EQN_TOK_BOLD:
1.14 schwarze 853: parent->font = EQNFONT_BOLD;
854: break;
855: default:
856: abort();
857: }
858: break;
1.26 ! schwarze 859: case EQN_TOK_SIZE:
! 860: case EQN_TOK_GSIZE:
1.14 schwarze 861: /* Accept two values: integral size and a single. */
862: if (NULL == (start = eqn_nexttok(ep, &sz))) {
1.15 schwarze 863: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
864: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
865: break;
1.14 schwarze 866: }
867: size = mandoc_strntoi(start, sz, 10);
868: if (-1 == size) {
1.15 schwarze 869: mandoc_msg(MANDOCERR_IT_NONUM, ep->parse,
870: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
871: break;
1.14 schwarze 872: }
873: if (EQN_TOK_GSIZE == tok) {
874: ep->gsize = size;
875: break;
876: }
877: parent = eqn_box_alloc(ep, parent);
878: parent->type = EQN_LISTONE;
879: parent->expectargs = 1;
880: parent->size = size;
881: break;
1.26 ! schwarze 882: case EQN_TOK_FROM:
! 883: case EQN_TOK_TO:
! 884: case EQN_TOK_SUB:
! 885: case EQN_TOK_SUP:
1.14 schwarze 886: /*
887: * We have a left-right-associative expression.
888: * Repivot under a positional node, open a child scope
889: * and keep on reading.
890: */
1.15 schwarze 891: if (parent->last == NULL) {
892: mandoc_msg(MANDOCERR_EQN_NOBOX, ep->parse,
893: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
894: cur = eqn_box_alloc(ep, parent);
895: cur->type = EQN_TEXT;
896: cur->text = mandoc_strdup("");
1.14 schwarze 897: }
898: /* Handle the "subsup" and "fromto" positions. */
899: if (EQN_TOK_SUP == tok && parent->pos == EQNPOS_SUB) {
900: parent->expectargs = 3;
901: parent->pos = EQNPOS_SUBSUP;
902: break;
903: }
904: if (EQN_TOK_TO == tok && parent->pos == EQNPOS_FROM) {
905: parent->expectargs = 3;
906: parent->pos = EQNPOS_FROMTO;
907: break;
908: }
909: switch (tok) {
1.26 ! schwarze 910: case EQN_TOK_FROM:
1.14 schwarze 911: pos = EQNPOS_FROM;
912: break;
1.26 ! schwarze 913: case EQN_TOK_TO:
1.14 schwarze 914: pos = EQNPOS_TO;
915: break;
1.26 ! schwarze 916: case EQN_TOK_SUP:
1.14 schwarze 917: pos = EQNPOS_SUP;
918: break;
1.26 ! schwarze 919: case EQN_TOK_SUB:
1.14 schwarze 920: pos = EQNPOS_SUB;
921: break;
922: default:
923: abort();
924: }
925: parent = eqn_box_makebinary(ep, pos, parent);
926: break;
1.26 ! schwarze 927: case EQN_TOK_SQRT:
1.14 schwarze 928: while (parent->args == parent->expectargs)
1.15 schwarze 929: parent = parent->parent;
1.14 schwarze 930: /*
931: * Accept a left-right-associative set of arguments just
932: * like sub and sup and friends but without rebalancing
933: * under a pivot.
934: */
935: parent = eqn_box_alloc(ep, parent);
936: parent->type = EQN_SUBEXPR;
937: parent->pos = EQNPOS_SQRT;
938: parent->expectargs = 1;
939: break;
1.26 ! schwarze 940: case EQN_TOK_OVER:
1.14 schwarze 941: /*
942: * We have a right-left-associative fraction.
943: * Close out anything that's currently open, then
944: * rebalance and continue reading.
945: */
1.15 schwarze 946: if (parent->last == NULL) {
947: mandoc_msg(MANDOCERR_EQN_NOBOX, ep->parse,
948: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
949: cur = eqn_box_alloc(ep, parent);
950: cur->type = EQN_TEXT;
951: cur->text = mandoc_strdup("");
1.14 schwarze 952: }
953: while (EQN_SUBEXPR == parent->type)
1.15 schwarze 954: parent = parent->parent;
1.14 schwarze 955: parent = eqn_box_makebinary(ep, EQNPOS_OVER, parent);
956: break;
1.26 ! schwarze 957: case EQN_TOK_RIGHT:
! 958: case EQN_TOK_BRACE_CLOSE:
1.14 schwarze 959: /*
960: * Close out the existing brace.
961: * FIXME: this is a shitty sentinel: we should really
962: * have a native EQN_BRACE type or whatnot.
963: */
1.15 schwarze 964: for (cur = parent; cur != NULL; cur = cur->parent)
965: if (cur->type == EQN_LIST &&
966: (tok == EQN_TOK_BRACE_CLOSE ||
967: cur->left != NULL))
968: break;
969: if (cur == NULL) {
970: mandoc_msg(MANDOCERR_BLK_NOTOPEN, ep->parse,
971: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
972: break;
973: }
974: parent = cur;
1.14 schwarze 975: if (EQN_TOK_RIGHT == tok) {
976: if (NULL == (start = eqn_nexttok(ep, &sz))) {
1.15 schwarze 977: mandoc_msg(MANDOCERR_REQ_EMPTY,
978: ep->parse, ep->eqn.ln,
979: ep->eqn.pos, eqn_toks[tok]);
980: break;
1.14 schwarze 981: }
982: /* Handling depends on right/left. */
983: if (STRNEQ(start, sz, "ceiling", 7)) {
984: strlcpy(sym, "\\[rc]", sizeof(sym));
985: parent->right = mandoc_strdup(sym);
986: } else if (STRNEQ(start, sz, "floor", 5)) {
987: strlcpy(sym, "\\[rf]", sizeof(sym));
988: parent->right = mandoc_strdup(sym);
989: } else
990: parent->right = mandoc_strndup(start, sz);
991: }
1.15 schwarze 992: parent = parent->parent;
1.24 schwarze 993: if (tok == EQN_TOK_BRACE_CLOSE &&
1.14 schwarze 994: (parent->type == EQN_PILE ||
995: parent->type == EQN_MATRIX))
996: parent = parent->parent;
997: /* Close out any "singleton" lists. */
998: while (parent->type == EQN_LISTONE &&
999: parent->args == parent->expectargs)
1.15 schwarze 1000: parent = parent->parent;
1.14 schwarze 1001: break;
1.26 ! schwarze 1002: case EQN_TOK_BRACE_OPEN:
! 1003: case EQN_TOK_LEFT:
1.14 schwarze 1004: /*
1005: * If we already have something in the stack and we're
1006: * in an expression, then rewind til we're not any more
1007: * (just like with the text node).
1008: */
1009: while (parent->args == parent->expectargs)
1.15 schwarze 1010: parent = parent->parent;
1011: if (EQN_TOK_LEFT == tok &&
1012: (start = eqn_nexttok(ep, &sz)) == NULL) {
1013: mandoc_msg(MANDOCERR_REQ_EMPTY, ep->parse,
1014: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
1015: break;
1016: }
1.14 schwarze 1017: parent = eqn_box_alloc(ep, parent);
1018: parent->type = EQN_LIST;
1019: if (EQN_TOK_LEFT == tok) {
1020: if (STRNEQ(start, sz, "ceiling", 7)) {
1021: strlcpy(sym, "\\[lc]", sizeof(sym));
1022: parent->left = mandoc_strdup(sym);
1023: } else if (STRNEQ(start, sz, "floor", 5)) {
1024: strlcpy(sym, "\\[lf]", sizeof(sym));
1025: parent->left = mandoc_strdup(sym);
1026: } else
1027: parent->left = mandoc_strndup(start, sz);
1028: }
1029: break;
1.26 ! schwarze 1030: case EQN_TOK_PILE:
! 1031: case EQN_TOK_LPILE:
! 1032: case EQN_TOK_RPILE:
! 1033: case EQN_TOK_CPILE:
! 1034: case EQN_TOK_CCOL:
! 1035: case EQN_TOK_LCOL:
! 1036: case EQN_TOK_RCOL:
1.14 schwarze 1037: while (parent->args == parent->expectargs)
1.15 schwarze 1038: parent = parent->parent;
1.14 schwarze 1039: parent = eqn_box_alloc(ep, parent);
1040: parent->type = EQN_PILE;
1.15 schwarze 1041: parent->expectargs = 1;
1.14 schwarze 1042: break;
1.26 ! schwarze 1043: case EQN_TOK_ABOVE:
1.15 schwarze 1044: for (cur = parent; cur != NULL; cur = cur->parent)
1045: if (cur->type == EQN_PILE)
1046: break;
1047: if (cur == NULL) {
1048: mandoc_msg(MANDOCERR_IT_STRAY, ep->parse,
1049: ep->eqn.ln, ep->eqn.pos, eqn_toks[tok]);
1050: break;
1051: }
1052: parent = eqn_box_alloc(ep, cur);
1.14 schwarze 1053: parent->type = EQN_LIST;
1054: break;
1.26 ! schwarze 1055: case EQN_TOK_MATRIX:
1.14 schwarze 1056: while (parent->args == parent->expectargs)
1.15 schwarze 1057: parent = parent->parent;
1.14 schwarze 1058: parent = eqn_box_alloc(ep, parent);
1059: parent->type = EQN_MATRIX;
1.15 schwarze 1060: parent->expectargs = 1;
1.14 schwarze 1061: break;
1.26 ! schwarze 1062: case EQN_TOK_EOF:
1.14 schwarze 1063: /*
1064: * End of file!
1065: * TODO: make sure we're not in an open subexpression.
1066: */
1.22 schwarze 1067: return ROFF_EQN;
1.14 schwarze 1068: default:
1069: assert(tok == EQN_TOK__MAX);
1070: assert(NULL != p);
1071: /*
1072: * If we already have something in the stack and we're
1073: * in an expression, then rewind til we're not any more.
1074: */
1075: while (parent->args == parent->expectargs)
1.15 schwarze 1076: parent = parent->parent;
1.14 schwarze 1077: cur = eqn_box_alloc(ep, parent);
1078: cur->type = EQN_TEXT;
1079: for (i = 0; i < EQNSYM__MAX; i++)
1080: if (0 == strcmp(eqnsyms[i].str, p)) {
1081: (void)snprintf(sym, sizeof(sym),
1082: "\\[%s]", eqnsyms[i].sym);
1083: cur->text = mandoc_strdup(sym);
1084: free(p);
1085: break;
1086: }
1087:
1088: if (i == EQNSYM__MAX)
1089: cur->text = p;
1090: /*
1091: * Post-process list status.
1092: */
1093: while (parent->type == EQN_LISTONE &&
1.15 schwarze 1094: parent->args == parent->expectargs)
1095: parent = parent->parent;
1.14 schwarze 1096: break;
1.7 schwarze 1097: }
1.15 schwarze 1098: goto next_tok;
1.4 schwarze 1099: }
1100:
1.14 schwarze 1101: enum rofferr
1102: eqn_end(struct eqn_node **epp)
1.4 schwarze 1103: {
1.14 schwarze 1104: struct eqn_node *ep;
1.4 schwarze 1105:
1.14 schwarze 1106: ep = *epp;
1107: *epp = NULL;
1.4 schwarze 1108:
1.14 schwarze 1109: ep->eqn.root = mandoc_calloc(1, sizeof(struct eqn_box));
1110: ep->eqn.root->expectargs = UINT_MAX;
1.22 schwarze 1111: return eqn_parse(ep, ep->eqn.root);
1.4 schwarze 1112: }
1113:
1.14 schwarze 1114: void
1115: eqn_free(struct eqn_node *p)
1.4 schwarze 1116: {
1117: int i;
1118:
1.14 schwarze 1119: eqn_box_free(p->eqn.root);
1120:
1121: for (i = 0; i < (int)p->defsz; i++) {
1122: free(p->defs[i].key);
1123: free(p->defs[i].val);
1124: }
1.4 schwarze 1125:
1.14 schwarze 1126: free(p->data);
1127: free(p->defs);
1128: free(p);
1.1 schwarze 1129: }
![[BACK]](/icons/back.gif){kind=icon}
Return to eqn.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc