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