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