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