-/* $Id: roff.c,v 1.6 2008/11/26 16:50:34 kristaps Exp $ */
+/* $Id: roff.c,v 1.97 2010/07/27 19:56:50 kristaps Exp $ */
/*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
#include <assert.h>
+#include <errno.h>
#include <ctype.h>
-#include <err.h>
+#include <limits.h>
#include <stdlib.h>
-#include <stdio.h>
#include <string.h>
-#include <time.h>
+#include <stdio.h>
-#include "libmdocml.h"
-#include "private.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "libmandoc.h"
-/* FIXME: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */
+#define RSTACK_MAX 128
-/* FIXME: warn about empty lists. */
+#define ROFF_CTL(c) \
+ ('.' == (c) || '\'' == (c))
-#define ROFF_MAXARG 10
+#if 1
+#define ROFF_DEBUG(fmt, args...) \
+ do { /* Nothing. */ } while (/*CONSTCOND*/ 0)
+#else
+#define ROFF_DEBUG(fmt, args...) \
+ do { fprintf(stderr, fmt , ##args); } while (/*CONSTCOND*/ 0)
+#endif
-enum roffd {
- ROFF_ENTER = 0,
- ROFF_EXIT
+enum rofft {
+ ROFF_am,
+ ROFF_ami,
+ ROFF_am1,
+ ROFF_de,
+ ROFF_dei,
+ ROFF_de1,
+ ROFF_ds,
+ ROFF_el,
+ ROFF_ie,
+ ROFF_if,
+ ROFF_ig,
+ ROFF_rm,
+ ROFF_tr,
+ ROFF_cblock,
+ ROFF_ccond,
+ ROFF_nr,
+ ROFF_MAX
};
-enum rofftype {
- ROFF_COMMENT,
- ROFF_TEXT,
- ROFF_LAYOUT
+enum roffrule {
+ ROFFRULE_ALLOW,
+ ROFFRULE_DENY
};
-#define ROFFCALL_ARGS \
- int tok, struct rofftree *tree, \
- const char *argv[], enum roffd type
-
-struct rofftree;
-
-struct rofftok {
- int (*cb)(ROFFCALL_ARGS); /* Callback. */
- const int *args; /* Args (or NULL). */
- const int *parents;
- const int *children;
- int ctx;
- enum rofftype type; /* Type of macro. */
- int flags;
-#define ROFF_NESTED (1 << 0) /* Nested-layout. */
-#define ROFF_PARSED (1 << 1) /* "Parsed". */
-#define ROFF_CALLABLE (1 << 2) /* "Callable". */
-#define ROFF_QUOTES (1 << 3) /* Quoted args. */
+
+struct roffstr {
+ char *name; /* key of symbol */
+ char *string; /* current value */
+ struct roffstr *next; /* next in list */
};
-struct roffarg {
- int flags;
-#define ROFF_VALUE (1 << 0) /* Has a value. */
+struct roff {
+ struct roffnode *last; /* leaf of stack */
+ mandocmsg msg; /* err/warn/fatal messages */
+ void *data; /* privdata for messages */
+ enum roffrule rstack[RSTACK_MAX]; /* stack of !`ie' rules */
+ int rstackpos; /* position in rstack */
+ struct regset *regs; /* read/writable registers */
+ struct roffstr *first_string;
};
struct roffnode {
- int tok; /* Token id. */
- struct roffnode *parent; /* Parent (or NULL). */
- size_t line; /* Parsed at line. */
+ enum rofft tok; /* type of node */
+ struct roffnode *parent; /* up one in stack */
+ int line; /* parse line */
+ int col; /* parse col */
+ char *end; /* end-rules: custom token */
+ int endspan; /* end-rules: next-line or infty */
+ enum roffrule rule; /* current evaluation rule */
};
-struct rofftree {
- struct roffnode *last; /* Last parsed node. */
- time_t date; /* `Dd' results. */
- char os[64]; /* `Os' results. */
- char title[64]; /* `Dt' results. */
- char section[64]; /* `Dt' results. */
- char volume[64]; /* `Dt' results. */
- int state;
-#define ROFF_PRELUDE (1 << 1) /* In roff prelude. */
- /* FIXME: if we had prev ptrs, this wouldn't be necessary. */
-#define ROFF_PRELUDE_Os (1 << 2) /* `Os' is parsed. */
-#define ROFF_PRELUDE_Dt (1 << 3) /* `Dt' is parsed. */
-#define ROFF_PRELUDE_Dd (1 << 4) /* `Dd' is parsed. */
-#define ROFF_BODY (1 << 5) /* In roff body. */
- struct md_mbuf *mbuf; /* Output (or NULL). */
- const struct md_args *args; /* Global args. */
- const struct md_rbuf *rbuf; /* Input. */
- const struct roffcb *cb;
+#define ROFF_ARGS struct roff *r, /* parse ctx */ \
+ enum rofft tok, /* tok of macro */ \
+ char **bufp, /* input buffer */ \
+ size_t *szp, /* size of input buffer */ \
+ int ln, /* parse line */ \
+ int ppos, /* original pos in buffer */ \
+ int pos, /* current pos in buffer */ \
+ int *offs /* reset offset of buffer data */
+
+typedef enum rofferr (*roffproc)(ROFF_ARGS);
+
+struct roffmac {
+ const char *name; /* macro name */
+ roffproc proc; /* process new macro */
+ roffproc text; /* process as child text of macro */
+ roffproc sub; /* process as child of macro */
+ int flags;
+#define ROFFMAC_STRUCT (1 << 0) /* always interpret */
+ struct roffmac *next;
};
-static int roff_Dd(ROFFCALL_ARGS);
-static int roff_Dt(ROFFCALL_ARGS);
-static int roff_Os(ROFFCALL_ARGS);
-
-static int roff_layout(ROFFCALL_ARGS);
-static int roff_text(ROFFCALL_ARGS);
-static int roff_comment(ROFFCALL_ARGS);
-
-static struct roffnode *roffnode_new(int, struct rofftree *);
-static void roffnode_free(int, struct rofftree *);
-
-static int rofffindtok(const char *);
-static int rofffindarg(const char *);
-static int rofffindcallable(const char *);
-static int roffargs(int, char *, char **);
-static int roffargok(int, int);
-static int roffnextopt(int, const char ***, char **);
-static int roffparse(struct rofftree *, char *, size_t);
-static int textparse(const struct rofftree *,
+static enum rofferr roff_block(ROFF_ARGS);
+static enum rofferr roff_block_text(ROFF_ARGS);
+static enum rofferr roff_block_sub(ROFF_ARGS);
+static enum rofferr roff_cblock(ROFF_ARGS);
+static enum rofferr roff_ccond(ROFF_ARGS);
+static enum rofferr roff_cond(ROFF_ARGS);
+static enum rofferr roff_cond_text(ROFF_ARGS);
+static enum rofferr roff_cond_sub(ROFF_ARGS);
+static enum rofferr roff_ds(ROFF_ARGS);
+static enum roffrule roff_evalcond(const char *, int *);
+static void roff_freestr(struct roff *);
+static const char *roff_getstrn(const struct roff *,
const char *, size_t);
-
-
-static const int roffarg_An[] = {
- ROFF_Split, ROFF_Nosplit, ROFF_ARGMAX };
-
-static const int roffarg_Bd[] = {
- ROFF_Ragged, ROFF_Unfilled, ROFF_Literal, ROFF_File,
- ROFF_Offset, ROFF_ARGMAX };
-
-static const int roffarg_Bl[] = {
- ROFF_Bullet, ROFF_Dash, ROFF_Hyphen, ROFF_Item, ROFF_Enum,
- ROFF_Tag, ROFF_Diag, ROFF_Hang, ROFF_Ohang, ROFF_Inset,
- ROFF_Column, ROFF_Offset, ROFF_ARGMAX };
-
-static const int roffchild_Bl[] = { ROFF_It, ROFF_El, ROFF_MAX };
-
-static const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX };
-
-static const int roffparent_It[] = { ROFF_Bl, ROFF_MAX };
-
-/* Table of all known tokens. */
-static const struct rofftok tokens[ROFF_MAX] = {
- {roff_comment, NULL, NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */
- { roff_Dd, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dd */
- { roff_Dt, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dt */
- { roff_Os, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Os */
- { roff_layout, NULL, NULL, NULL, ROFF_Sh, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */
- { roff_layout, NULL, NULL, NULL, ROFF_Ss, ROFF_LAYOUT, ROFF_PARSED }, /* Ss */
- { roff_text, NULL, NULL, NULL, ROFF_Pp, ROFF_TEXT, 0 }, /* Pp */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* D1 */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dl */
- { NULL, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bd */
- { NULL, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Ed */
- { roff_layout, roffarg_Bl, NULL, roffchild_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */
- { roff_layout, NULL, roffparent_El, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */
- { roff_layout, NULL, roffparent_It, NULL, ROFF_It, ROFF_LAYOUT, 0 }, /* It */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* An */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ar */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Cd */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dv */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Er */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ev */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ex */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fa */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Fd */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fl */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fn */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ft */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ic */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* In */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Nd */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Nm */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Op */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ot */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pa */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Rv */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* St */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Va */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Vt */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xr */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %D */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %N */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %O */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %P */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %R */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %V */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Aq */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* At */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Bf */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bq */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Db */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dq */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ef */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Em */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Eo */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Fx */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ms */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Nx */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ox */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pq */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qq */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Re */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Rs */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sq */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Sm */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ux */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */
- { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */
+static enum rofferr roff_line(ROFF_ARGS);
+static enum rofferr roff_nr(ROFF_ARGS);
+static int roff_res(struct roff *,
+ char **, size_t *, int);
+static void roff_setstr(struct roff *,
+ const char *, const char *);
+
+/* See roff_hash_find() */
+
+#define ASCII_HI 126
+#define ASCII_LO 33
+#define HASHWIDTH (ASCII_HI - ASCII_LO + 1)
+
+static struct roffmac *hash[HASHWIDTH];
+
+static struct roffmac roffs[ROFF_MAX] = {
+ { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "ds", roff_ds, NULL, NULL, 0, NULL },
+ { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+ { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+ { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+ { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "rm", roff_line, NULL, NULL, 0, NULL },
+ { "tr", roff_line, NULL, NULL, 0, NULL },
+ { ".", roff_cblock, NULL, NULL, 0, NULL },
+ { "\\}", roff_ccond, NULL, NULL, 0, NULL },
+ { "nr", roff_nr, NULL, NULL, 0, NULL },
};
-/* Table of all known token arguments. */
-static const struct roffarg tokenargs[ROFF_ARGMAX] = {
- { 0 }, /* split */
- { 0 }, /* nosplit */
- { 0 }, /* ragged */
- { 0 }, /* unfilled */
- { 0 }, /* literal */
- { ROFF_VALUE }, /* file */
- { ROFF_VALUE }, /* offset */
- { 0 }, /* bullet */
- { 0 }, /* dash */
- { 0 }, /* hyphen */
- { 0 }, /* item */
- { 0 }, /* enum */
- { 0 }, /* tag */
- { 0 }, /* diag */
- { 0 }, /* hang */
- { 0 }, /* ohang */
- { 0 }, /* inset */
- { 0 }, /* column */
- { 0 }, /* width */
- { 0 }, /* compact */
-};
+static void roff_free1(struct roff *);
+static enum rofft roff_hash_find(const char *);
+static void roff_hash_init(void);
+static void roffnode_cleanscope(struct roff *);
+static int roffnode_push(struct roff *,
+ enum rofft, int, int);
+static void roffnode_pop(struct roff *);
+static enum rofft roff_parse(const char *, int *);
+static int roff_parse_nat(const char *, unsigned int *);
-const char *const toknamesp[ROFF_MAX] =
- {
- "\\\"",
- "Dd", /* Title macros. */
- "Dt",
- "Os",
- "Sh", /* Layout macros */
- "Ss",
- "Pp",
- "D1",
- "Dl",
- "Bd",
- "Ed",
- "Bl",
- "El",
- "It",
- "Ad", /* Text macros. */
- "An",
- "Ar",
- "Cd",
- "Cm",
- "Dr",
- "Er",
- "Ev",
- "Ex",
- "Fa",
- "Fd",
- "Fl",
- "Fn",
- "Ft",
- "Ex",
- "Ic",
- "In",
- "Li",
- "Nd",
- "Nm",
- "Op",
- "Ot",
- "Pa",
- "Rv",
- "St",
- "Va",
- "Vt",
- "Xr",
- "\%A", /* General text macros. */
- "\%B",
- "\%D",
- "\%I",
- "\%J",
- "\%N",
- "\%O",
- "\%P",
- "\%R",
- "\%T",
- "\%V",
- "Ac",
- "Ao",
- "Aq",
- "At",
- "Bc",
- "Bf",
- "Bo",
- "Bq",
- "Bsx",
- "Bx",
- "Db",
- "Dc",
- "Do",
- "Dq",
- "Ec",
- "Ef",
- "Em",
- "Eo",
- "Fx",
- "Ms",
- "No",
- "Ns",
- "Nx",
- "Ox",
- "Pc",
- "Pf",
- "Po",
- "Pq",
- "Qc",
- "Ql",
- "Qo",
- "Qq",
- "Re",
- "Rs",
- "Sc",
- "So",
- "Sq",
- "Sm",
- "Sx",
- "Sy",
- "Tn",
- "Ux",
- "Xc", /* FIXME: do not support! */
- "Xo", /* FIXME: do not support! */
- };
-
-const char *const tokargnamesp[ROFF_ARGMAX] =
- {
- "split",
- "nosplit",
- "ragged",
- "unfilled",
- "literal",
- "file",
- "offset",
- "bullet",
- "dash",
- "hyphen",
- "item",
- "enum",
- "tag",
- "diag",
- "hang",
- "ohang",
- "inset",
- "column",
- "width",
- "compact",
- };
-
-const char *const *toknames = toknamesp;
-const char *const *tokargnames = tokargnamesp;
+/* See roff_hash_find() */
+#define ROFF_HASH(p) (p[0] - ASCII_LO)
-
-int
-roff_free(struct rofftree *tree, int flush)
+static void
+roff_hash_init(void)
{
- int error;
+ struct roffmac *n;
+ int buc, i;
- assert(tree->mbuf);
- if ( ! flush)
- tree->mbuf = NULL;
+ for (i = 0; i < (int)ROFF_MAX; i++) {
+ assert(roffs[i].name[0] >= ASCII_LO);
+ assert(roffs[i].name[0] <= ASCII_HI);
- /* LINTED */
- while (tree->last)
- if ( ! (*tokens[tree->last->tok].cb)
- (tree->last->tok, tree, NULL, ROFF_EXIT))
- /* Disallow flushing. */
- tree->mbuf = NULL;
-
- error = tree->mbuf ? 0 : 1;
-
- if (tree->mbuf && (ROFF_PRELUDE & tree->state)) {
- warnx("%s: prelude never finished",
- tree->rbuf->name);
- error = 1;
- }
+ buc = ROFF_HASH(roffs[i].name);
- free(tree);
- return(error ? 0 : 1);
+ if (NULL != (n = hash[buc])) {
+ for ( ; n->next; n = n->next)
+ /* Do nothing. */ ;
+ n->next = &roffs[i];
+ } else
+ hash[buc] = &roffs[i];
+ }
}
-struct rofftree *
-roff_alloc(const struct md_args *args, struct md_mbuf *out,
- const struct md_rbuf *in, const struct roffcb *cb)
+/*
+ * Look up a roff token by its name. Returns ROFF_MAX if no macro by
+ * the nil-terminated string name could be found.
+ */
+static enum rofft
+roff_hash_find(const char *p)
{
- struct rofftree *tree;
+ int buc;
+ struct roffmac *n;
- if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) {
- warn("malloc");
- return(NULL);
- }
+ /*
+ * libroff has an extremely simple hashtable, for the time
+ * being, which simply keys on the first character, which must
+ * be printable, then walks a chain. It works well enough until
+ * optimised.
+ */
+
+ if (p[0] < ASCII_LO || p[0] > ASCII_HI)
+ return(ROFF_MAX);
- tree->state = ROFF_PRELUDE;
- tree->args = args;
- tree->mbuf = out;
- tree->rbuf = in;
- tree->cb = cb;
+ buc = ROFF_HASH(p);
- return(tree);
+ if (NULL == (n = hash[buc]))
+ return(ROFF_MAX);
+ for ( ; n; n = n->next)
+ if (0 == strcmp(n->name, p))
+ return((enum rofft)(n - roffs));
+
+ return(ROFF_MAX);
}
-int
-roff_engine(struct rofftree *tree, char *buf, size_t sz)
+/*
+ * Pop the current node off of the stack of roff instructions currently
+ * pending.
+ */
+static void
+roffnode_pop(struct roff *r)
{
+ struct roffnode *p;
- if (0 == sz) {
- warnx("%s: blank line (line %zu)",
- tree->rbuf->name,
- tree->rbuf->line);
- return(0);
- } else if ('.' != *buf)
- return(textparse(tree, buf, sz));
+ assert(r->last);
+ p = r->last;
+
+ if (ROFF_el == p->tok)
+ if (r->rstackpos > -1)
+ r->rstackpos--;
- return(roffparse(tree, buf, sz));
+ r->last = r->last->parent;
+ if (p->end)
+ free(p->end);
+ free(p);
}
+/*
+ * Push a roff node onto the instruction stack. This must later be
+ * removed with roffnode_pop().
+ */
static int
-textparse(const struct rofftree *tree, const char *buf, size_t sz)
+roffnode_push(struct roff *r, enum rofft tok, int line, int col)
{
-
- if (NULL == tree->last) {
- warnx("%s: unexpected text (line %zu)",
- tree->rbuf->name,
- tree->rbuf->line);
- return(0);
- } else if (NULL == tree->last->parent) {
- warnx("%s: disallowed text (line %zu)",
- tree->rbuf->name,
- tree->rbuf->line);
+ struct roffnode *p;
+
+ if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
+ (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
return(0);
}
- /* Print text. */
+ p->tok = tok;
+ p->parent = r->last;
+ p->line = line;
+ p->col = col;
+ p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
+ r->last = p;
return(1);
}
-static int
-roffargs(int tok, char *buf, char **argv)
+static void
+roff_free1(struct roff *r)
{
- int i;
- (void)tok;/* FIXME: quotable strings? */
+ while (r->last)
+ roffnode_pop(r);
+ roff_freestr(r);
+}
- assert(tok >= 0 && tok < ROFF_MAX);
- assert('.' == *buf);
- /* LINTED */
- for (i = 0; *buf && i < ROFF_MAXARG; i++) {
- argv[i] = buf++;
- while (*buf && ! isspace(*buf))
- buf++;
- if (0 == *buf) {
- continue;
- }
- *buf++ = 0;
- while (*buf && isspace(*buf))
- buf++;
- }
-
- assert(i > 0);
- if (i < ROFF_MAXARG)
- argv[i] = NULL;
+void
+roff_reset(struct roff *r)
+{
- return(ROFF_MAXARG > i);
+ roff_free1(r);
}
-/* XXX */
-static int
-roffscan(int tok, const int *tokv)
+void
+roff_free(struct roff *r)
{
- if (NULL == tokv)
- return(1);
- for ( ; ROFF_MAX != *tokv; tokv++)
- if (tok == *tokv)
- return(1);
+ roff_free1(r);
+ free(r);
+}
+
+
+struct roff *
+roff_alloc(struct regset *regs, const mandocmsg msg, void *data)
+{
+ struct roff *r;
- return(0);
+ if (NULL == (r = calloc(1, sizeof(struct roff)))) {
+ (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
+ return(0);
+ }
+
+ r->regs = regs;
+ r->msg = msg;
+ r->data = data;
+ r->rstackpos = -1;
+
+ roff_hash_init();
+ return(r);
}
+/*
+ * Pre-filter each and every line for reserved words (one beginning with
+ * `\*', e.g., `\*(ab'). These must be handled before the actual line
+ * is processed.
+ */
static int
-roffparse(struct rofftree *tree, char *buf, size_t sz)
+roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
{
- int tok, t;
- struct roffnode *n;
- char *argv[ROFF_MAXARG];
- const char **argvp;
+ const char *cp, *cpp, *st, *res;
+ int i, maxl;
+ size_t nsz;
+ char *n;
- assert(sz > 0);
+ /* LINTED */
+ for (cp = &(*bufp)[pos]; (cpp = strstr(cp, "\\*")); cp++) {
+ cp = cpp + 2;
+ switch (*cp) {
+ case ('('):
+ cp++;
+ maxl = 2;
+ break;
+ case ('['):
+ cp++;
+ maxl = 0;
+ break;
+ default:
+ maxl = 1;
+ break;
+ }
- if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {
- warnx("%s: unknown line macro (line %zu)",
- tree->rbuf->name, tree->rbuf->line);
- return(0);
- } else if (NULL == tokens[tok].cb) {
- warnx("%s: macro `%s' not supported (line %zu)",
- tree->rbuf->name, toknames[tok],
- tree->rbuf->line);
- return(0);
- } else if (ROFF_COMMENT == tokens[tok].type)
- return(1);
-
- if ( ! roffargs(tok, buf, argv)) {
- warnx("%s: too many args to `%s' (line %zu)",
- tree->rbuf->name, toknames[tok],
- tree->rbuf->line);
- return(0);
- } else
- argvp = (const char **)argv + 1;
+ st = cp;
- /*
- * Prelude macros break some assumptions: branch now.
- */
-
- if (ROFF_PRELUDE & tree->state) {
- assert(NULL == tree->last);
- return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
- } else
- assert(tree->last);
+ for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
+ if ('\0' == *cp)
+ return(1); /* Error. */
+ if (0 == maxl && ']' == *cp)
+ break;
+ }
- assert(ROFF_BODY & tree->state);
+ res = roff_getstrn(r, st, (size_t)i);
- /*
- * First check that our possible parents and parent's possible
- * children are satisfied.
- */
+ if (NULL == res) {
+ cp -= maxl ? 1 : 0;
+ continue;
+ }
- if ( ! roffscan(tree->last->tok, tokens[tok].parents)) {
- warnx("%s: invalid parent `%s' for `%s' (line %zu)",
- tree->rbuf->name,
- toknames[tree->last->tok],
- toknames[tok], tree->rbuf->line);
- return(0);
- }
+ ROFF_DEBUG("roff: splicing reserved: [%.*s]\n", i, st);
+
+ nsz = *szp + strlen(res) + 1;
+ n = mandoc_malloc(nsz);
+
+ *n = '\0';
+
+ strlcat(n, *bufp, (size_t)(cpp - *bufp + 1));
+ strlcat(n, res, nsz);
+ strlcat(n, cp + (maxl ? 0 : 1), nsz);
- if ( ! roffscan(tok, tokens[tree->last->tok].children)) {
- warnx("%s: invalid child `%s' for `%s' (line %zu)",
- tree->rbuf->name, toknames[tok],
- toknames[tree->last->tok],
- tree->rbuf->line);
+ free(*bufp);
+
+ *bufp = n;
+ *szp = nsz;
return(0);
}
+ return(1);
+}
+
+
+enum rofferr
+roff_parseln(struct roff *r, int ln, char **bufp,
+ size_t *szp, int pos, int *offs)
+{
+ enum rofft t;
+ int ppos;
+
/*
- * Branch if we're not a layout token.
+ * Run the reserved-word filter only if we have some reserved
+ * words to fill in.
*/
- if (ROFF_LAYOUT != tokens[tok].type)
- return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
+ if (r->first_string && ! roff_res(r, bufp, szp, pos))
+ return(ROFF_RERUN);
- /*
- * Check our scope rules.
+ /*
+ * First, if a scope is open and we're not a macro, pass the
+ * text through the macro's filter. If a scope isn't open and
+ * we're not a macro, just let it through.
*/
- if (0 == tokens[tok].ctx)
- return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
+ if (r->last && ! ROFF_CTL((*bufp)[pos])) {
+ t = r->last->tok;
+ assert(roffs[t].text);
+ ROFF_DEBUG("roff: intercept scoped text: %s, [%s]\n",
+ roffs[t].name, &(*bufp)[pos]);
+ return((*roffs[t].text)
+ (r, t, bufp, szp,
+ ln, pos, pos, offs));
+ } else if ( ! ROFF_CTL((*bufp)[pos]))
+ return(ROFF_CONT);
- if (tok == tokens[tok].ctx) {
- for (n = tree->last; n; n = n->parent) {
- assert(0 == tokens[n->tok].ctx ||
- n->tok == tokens[n->tok].ctx);
- if (n->tok == tok)
- break;
- }
- if (NULL == n) {
-#ifdef DEBUG
- (void)printf("scope: new `%s'\n",
- toknames[tok]);
-#endif
- return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
- }
- do {
- t = tree->last->tok;
-#ifdef DEBUG
- (void)printf("scope: closing `%s'\n",
- toknames[t]);
-#endif
- if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))
- return(0);
- } while (t != tok);
+ /*
+ * If a scope is open, go to the child handler for that macro,
+ * as it may want to preprocess before doing anything with it.
+ */
- return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
+ if (r->last) {
+ t = r->last->tok;
+ assert(roffs[t].sub);
+ ROFF_DEBUG("roff: intercept scoped context: %s\n",
+ roffs[t].name);
+ return((*roffs[t].sub)
+ (r, t, bufp, szp,
+ ln, pos, pos, offs));
}
- assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);
+ /*
+ * Lastly, as we've no scope open, try to look up and execute
+ * the new macro. If no macro is found, simply return and let
+ * the compilers handle it.
+ */
- do {
- t = tree->last->tok;
-#ifdef DEBUG
- (void)printf("scope: closing `%s'\n", toknames[t]);
-#endif
- if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))
- return(0);
- } while (t != tokens[tok].ctx);
+ ppos = pos;
+ if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
+ return(ROFF_CONT);
- return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));
+ ROFF_DEBUG("roff: intercept new-scope: %s, [%s]\n",
+ roffs[t].name, &(*bufp)[pos]);
+ assert(roffs[t].proc);
+ return((*roffs[t].proc)
+ (r, t, bufp, szp,
+ ln, ppos, pos, offs));
}
-static int
-rofffindarg(const char *name)
+int
+roff_endparse(struct roff *r)
{
- size_t i;
- /* FIXME: use a table, this is slow but ok for now. */
-
- /* LINTED */
- for (i = 0; i < ROFF_ARGMAX; i++)
- /* LINTED */
- if (0 == strcmp(name, tokargnames[i]))
- return((int)i);
-
- return(ROFF_ARGMAX);
+ if (NULL == r->last)
+ return(1);
+ return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
+ r->last->col, NULL));
}
-static int
-rofffindtok(const char *buf)
+/*
+ * Parse a roff node's type from the input buffer. This must be in the
+ * form of ".foo xxx" in the usual way.
+ */
+static enum rofft
+roff_parse(const char *buf, int *pos)
{
- char token[4];
- size_t i;
+ int j;
+ char mac[5];
+ enum rofft t;
- for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)
- token[i] = *buf;
+ assert(ROFF_CTL(buf[*pos]));
+ (*pos)++;
- if (i == 3) {
-#ifdef DEBUG
- (void)printf("lookup: macro too long: `%s'\n", buf);
-#endif
+ while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
+ (*pos)++;
+
+ if ('\0' == buf[*pos])
return(ROFF_MAX);
- }
- token[i] = 0;
+ for (j = 0; j < 4; j++, (*pos)++)
+ if ('\0' == (mac[j] = buf[*pos]))
+ break;
+ else if (' ' == buf[*pos] || (j && '\\' == buf[*pos]))
+ break;
-#ifdef DEBUG
- (void)printf("lookup: `%s'\n", token);
-#endif
+ if (j == 4 || j < 1)
+ return(ROFF_MAX);
- /* FIXME: use a table, this is slow but ok for now. */
+ mac[j] = '\0';
- /* LINTED */
- for (i = 0; i < ROFF_MAX; i++)
- /* LINTED */
- if (0 == strcmp(toknames[i], token))
- return((int)i);
-
- return(ROFF_MAX);
+ if (ROFF_MAX == (t = roff_hash_find(mac)))
+ return(t);
+
+ while (buf[*pos] && ' ' == buf[*pos])
+ (*pos)++;
+
+ return(t);
}
static int
-rofffindcallable(const char *name)
+roff_parse_nat(const char *buf, unsigned int *res)
{
- int c;
+ char *ep;
+ long lval;
- if (ROFF_MAX == (c = rofffindtok(name)))
- return(ROFF_MAX);
- return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);
+ errno = 0;
+ lval = strtol(buf, &ep, 10);
+ if (buf[0] == '\0' || *ep != '\0')
+ return(0);
+ if ((errno == ERANGE &&
+ (lval == LONG_MAX || lval == LONG_MIN)) ||
+ (lval > INT_MAX || lval < 0))
+ return(0);
+
+ *res = (unsigned int)lval;
+ return(1);
}
-static struct roffnode *
-roffnode_new(int tokid, struct rofftree *tree)
+/* ARGSUSED */
+static enum rofferr
+roff_cblock(ROFF_ARGS)
{
- struct roffnode *p;
-
- if (NULL == (p = malloc(sizeof(struct roffnode)))) {
- warn("malloc");
- return(NULL);
- }
- p->line = tree->rbuf->line;
- p->tok = tokid;
- p->parent = tree->last;
- tree->last = p;
- return(p);
-}
+ /*
+ * A block-close `..' should only be invoked as a child of an
+ * ignore macro, otherwise raise a warning and just ignore it.
+ */
+ if (NULL == r->last) {
+ if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
+ return(ROFF_ERR);
+ return(ROFF_IGN);
+ }
-static int
-roffargok(int tokid, int argid)
-{
- const int *c;
+ switch (r->last->tok) {
+ case (ROFF_am):
+ /* FALLTHROUGH */
+ case (ROFF_ami):
+ /* FALLTHROUGH */
+ case (ROFF_am1):
+ /* FALLTHROUGH */
+ case (ROFF_de):
+ /* FALLTHROUGH */
+ case (ROFF_dei):
+ /* FALLTHROUGH */
+ case (ROFF_de1):
+ /* FALLTHROUGH */
+ case (ROFF_ig):
+ break;
+ default:
+ if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
+ return(ROFF_ERR);
+ return(ROFF_IGN);
+ }
- if (NULL == (c = tokens[tokid].args))
- return(0);
+ if ((*bufp)[pos])
+ if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
+ return(ROFF_ERR);
- for ( ; ROFF_ARGMAX != *c; c++)
- if (argid == *c)
- return(1);
+ roffnode_pop(r);
+ roffnode_cleanscope(r);
+ return(ROFF_IGN);
- return(0);
}
static void
-roffnode_free(int tokid, struct rofftree *tree)
+roffnode_cleanscope(struct roff *r)
{
- struct roffnode *p;
- assert(tree->last);
- assert(tree->last->tok == tokid);
+ while (r->last) {
+ if (--r->last->endspan < 0)
+ break;
+ roffnode_pop(r);
+ }
+}
- p = tree->last;
- tree->last = tree->last->parent;
- free(p);
+
+/* ARGSUSED */
+static enum rofferr
+roff_ccond(ROFF_ARGS)
+{
+
+ if (NULL == r->last) {
+ if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
+ return(ROFF_ERR);
+ return(ROFF_IGN);
+ }
+
+ switch (r->last->tok) {
+ case (ROFF_el):
+ /* FALLTHROUGH */
+ case (ROFF_ie):
+ /* FALLTHROUGH */
+ case (ROFF_if):
+ break;
+ default:
+ if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
+ return(ROFF_ERR);
+ return(ROFF_IGN);
+ }
+
+ if (r->last->endspan > -1) {
+ if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
+ return(ROFF_ERR);
+ return(ROFF_IGN);
+ }
+
+ if ((*bufp)[pos])
+ if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
+ return(ROFF_ERR);
+
+ roffnode_pop(r);
+ roffnode_cleanscope(r);
+ return(ROFF_IGN);
}
-static int
-roffnextopt(int tok, const char ***in, char **val)
+/* ARGSUSED */
+static enum rofferr
+roff_block(ROFF_ARGS)
{
- const char *arg, **argv;
- int v;
+ int sv;
+ size_t sz;
+
+ if (ROFF_ig != tok && '\0' == (*bufp)[pos]) {
+ if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
+ return(ROFF_ERR);
+ return(ROFF_IGN);
+ } else if (ROFF_ig != tok) {
+ while ((*bufp)[pos] && ' ' != (*bufp)[pos])
+ pos++;
+ while (' ' == (*bufp)[pos])
+ pos++;
+ }
- *val = NULL;
- argv = *in;
- assert(argv);
+ if ( ! roffnode_push(r, tok, ln, ppos))
+ return(ROFF_ERR);
- if (NULL == (arg = *argv))
- return(-1);
- if ('-' != *arg)
- return(-1);
+ if ('\0' == (*bufp)[pos])
+ return(ROFF_IGN);
- /* FIXME: should we let this slide... ? */
+ sv = pos;
+ while ((*bufp)[pos] && ' ' != (*bufp)[pos] &&
+ '\t' != (*bufp)[pos])
+ pos++;
- if (ROFF_ARGMAX == (v = rofffindarg(&arg[1])))
- return(-1);
+ /*
+ * Note: groff does NOT like escape characters in the input.
+ * Instead of detecting this, we're just going to let it fly and
+ * to hell with it.
+ */
- /* FIXME: should we let this slide... ? */
+ assert(pos > sv);
+ sz = (size_t)(pos - sv);
- if ( ! roffargok(tok, v))
- return(-1);
- if ( ! (ROFF_VALUE & tokenargs[v].flags))
- return(v);
+ if (1 == sz && '.' == (*bufp)[sv])
+ return(ROFF_IGN);
- *in = ++argv;
+ r->last->end = malloc(sz + 1);
+
+ if (NULL == r->last->end) {
+ (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
+ return(ROFF_ERR);
+ }
- /* FIXME: what if this looks like a roff token or argument? */
+ memcpy(r->last->end, *bufp + sv, sz);
+ r->last->end[(int)sz] = '\0';
- return(*argv ? v : ROFF_ARGMAX);
+ if ((*bufp)[pos])
+ if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
+ return(ROFF_ERR);
+
+ return(ROFF_IGN);
}
/* ARGSUSED */
-static int
-roff_Dd(ROFFCALL_ARGS)
+static enum rofferr
+roff_block_sub(ROFF_ARGS)
{
+ enum rofft t;
+ int i, j;
- if (ROFF_BODY & tree->state) {
- assert( ! (ROFF_PRELUDE & tree->state));
- assert(ROFF_PRELUDE_Dd & tree->state);
- return(roff_text(tok, tree, argv, type));
- }
+ /*
+ * First check whether a custom macro exists at this level. If
+ * it does, then check against it. This is some of groff's
+ * stranger behaviours. If we encountered a custom end-scope
+ * tag and that tag also happens to be a "real" macro, then we
+ * need to try interpreting it again as a real macro. If it's
+ * not, then return ignore. Else continue.
+ */
- assert(ROFF_PRELUDE & tree->state);
- assert( ! (ROFF_BODY & tree->state));
+ if (r->last->end) {
+ i = pos + 1;
+ while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
+ i++;
- if (ROFF_PRELUDE_Dd & tree->state) {
- warnx("%s: prelude `Dd' repeated (line %zu)",
- tree->rbuf->name, tree->rbuf->line);
- return(0);
- } else if (ROFF_PRELUDE_Dt & tree->state) {
- warnx("%s: prelude `Dd' out-of-order (line %zu)",
- tree->rbuf->name, tree->rbuf->line);
- return(0);
+ for (j = 0; r->last->end[j]; j++, i++)
+ if ((*bufp)[i] != r->last->end[j])
+ break;
+
+ if ('\0' == r->last->end[j] &&
+ ('\0' == (*bufp)[i] ||
+ ' ' == (*bufp)[i] ||
+ '\t' == (*bufp)[i])) {
+ roffnode_pop(r);
+ roffnode_cleanscope(r);
+
+ if (ROFF_MAX != roff_parse(*bufp, &pos))
+ return(ROFF_RERUN);
+ return(ROFF_IGN);
+ }
}
- /* TODO: parse date. */
+ /*
+ * If we have no custom end-query or lookup failed, then try
+ * pulling it out of the hashtable.
+ */
+
+ ppos = pos;
+ t = roff_parse(*bufp, &pos);
- assert(NULL == tree->last);
- tree->state |= ROFF_PRELUDE_Dd;
+ /* If we're not a comment-end, then throw it away. */
+ if (ROFF_cblock != t)
+ return(ROFF_IGN);
- return(1);
+ assert(roffs[t].proc);
+ return((*roffs[t].proc)(r, t, bufp, szp,
+ ln, ppos, pos, offs));
}
/* ARGSUSED */
-static int
-roff_Dt(ROFFCALL_ARGS)
+static enum rofferr
+roff_block_text(ROFF_ARGS)
{
- if (ROFF_BODY & tree->state) {
- assert( ! (ROFF_PRELUDE & tree->state));
- assert(ROFF_PRELUDE_Dt & tree->state);
- return(roff_text(tok, tree, argv, type));
- }
+ return(ROFF_IGN);
+}
- assert(ROFF_PRELUDE & tree->state);
- assert( ! (ROFF_BODY & tree->state));
- if ( ! (ROFF_PRELUDE_Dd & tree->state)) {
- warnx("%s: prelude `Dt' out-of-order (line %zu)",
- tree->rbuf->name, tree->rbuf->line);
- return(0);
- } else if (ROFF_PRELUDE_Dt & tree->state) {
- warnx("%s: prelude `Dt' repeated (line %zu)",
- tree->rbuf->name, tree->rbuf->line);
- return(0);
- }
+/* ARGSUSED */
+static enum rofferr
+roff_cond_sub(ROFF_ARGS)
+{
+ enum rofft t;
+ enum roffrule rr;
+ struct roffnode *l;
- /* TODO: parse date. */
+ ppos = pos;
+ rr = r->last->rule;
- assert(NULL == tree->last);
- tree->state |= ROFF_PRELUDE_Dt;
+ /*
+ * Clean out scope. If we've closed ourselves, then don't
+ * continue.
+ */
- return(1);
+ l = r->last;
+ roffnode_cleanscope(r);
+
+ if (l != r->last)
+ return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
+
+ if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
+ return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
+
+ /*
+ * A denied conditional must evaluate its children if and only
+ * if they're either structurally required (such as loops and
+ * conditionals) or a closing macro.
+ */
+ if (ROFFRULE_DENY == rr)
+ if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
+ if (ROFF_ccond != t)
+ return(ROFF_IGN);
+
+ assert(roffs[t].proc);
+ return((*roffs[t].proc)(r, t, bufp, szp,
+ ln, ppos, pos, offs));
}
/* ARGSUSED */
-static int
-roff_Os(ROFFCALL_ARGS)
+static enum rofferr
+roff_cond_text(ROFF_ARGS)
{
+ char *ep, *st;
+ enum roffrule rr;
- if (ROFF_EXIT == type) {
- assert(ROFF_PRELUDE_Os & tree->state);
- return(roff_layout(tok, tree, argv, type));
- } else if (ROFF_BODY & tree->state) {
- assert( ! (ROFF_PRELUDE & tree->state));
- assert(ROFF_PRELUDE_Os & tree->state);
- return(roff_text(tok, tree, argv, type));
+ rr = r->last->rule;
+
+ /*
+ * We display the value of the text if out current evaluation
+ * scope permits us to do so.
+ */
+
+ st = &(*bufp)[pos];
+ if (NULL == (ep = strstr(st, "\\}"))) {
+ roffnode_cleanscope(r);
+ return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
}
- assert(ROFF_PRELUDE & tree->state);
- if ( ! (ROFF_PRELUDE_Dt & tree->state) ||
- ! (ROFF_PRELUDE_Dd & tree->state)) {
- warnx("%s: prelude `Os' out-of-order (line %zu)",
- tree->rbuf->name, tree->rbuf->line);
- return(0);
+ if (ep == st || (ep > st && '\\' != *(ep - 1)))
+ roffnode_pop(r);
+
+ roffnode_cleanscope(r);
+ return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
+}
+
+
+static enum roffrule
+roff_evalcond(const char *v, int *pos)
+{
+
+ switch (v[*pos]) {
+ case ('n'):
+ (*pos)++;
+ return(ROFFRULE_ALLOW);
+ case ('e'):
+ /* FALLTHROUGH */
+ case ('o'):
+ /* FALLTHROUGH */
+ case ('t'):
+ (*pos)++;
+ return(ROFFRULE_DENY);
+ default:
+ break;
}
- /* TODO: extract OS. */
+ while (v[*pos] && ' ' != v[*pos])
+ (*pos)++;
+ return(ROFFRULE_DENY);
+}
- tree->state |= ROFF_PRELUDE_Os;
- tree->state &= ~ROFF_PRELUDE;
- tree->state |= ROFF_BODY;
- assert(NULL == tree->last);
+/* ARGSUSED */
+static enum rofferr
+roff_line(ROFF_ARGS)
+{
- return(roff_layout(tok, tree, argv, type));
+ return(ROFF_IGN);
}
/* ARGSUSED */
-static int
-roff_layout(ROFFCALL_ARGS)
+static enum rofferr
+roff_cond(ROFF_ARGS)
{
- int i, c, argcp[ROFF_MAXARG];
- char *v, *argvp[ROFF_MAXARG];
-
- if (ROFF_PRELUDE & tree->state) {
- warnx("%s: macro `%s' called in prelude (line %zu)",
- tree->rbuf->name,
- toknames[tok],
- tree->rbuf->line);
- return(0);
- }
+ int sv;
+ enum roffrule rule;
- if (ROFF_EXIT == type) {
- roffnode_free(tok, tree);
- return((*tree->cb->roffblkout)(tok));
- }
-
- i = 0;
-
- while (-1 != (c = roffnextopt(tok, &argv, &v))) {
- if (ROFF_ARGMAX == c) {
- warnx("%s: error parsing `%s' args (line %zu)",
- tree->rbuf->name,
- toknames[tok],
- tree->rbuf->line);
- return(0);
- } else if ( ! roffargok(tok, c)) {
- warnx("%s: arg `%s' not for `%s' (line %zu)",
- tree->rbuf->name,
- tokargnames[c],
- toknames[tok],
- tree->rbuf->line);
- return(0);
- }
- argcp[i] = c;
- argvp[i] = v;
- i++;
- argv++;
+ /* Stack overflow! */
+
+ if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
+ (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL);
+ return(ROFF_ERR);
}
- argcp[i] = ROFF_ARGMAX;
- argvp[i] = NULL;
+ /* First, evaluate the conditional. */
+
+ if (ROFF_el == tok) {
+ /*
+ * An `.el' will get the value of the current rstack
+ * entry set in prior `ie' calls or defaults to DENY.
+ */
+ if (r->rstackpos < 0)
+ rule = ROFFRULE_DENY;
+ else
+ rule = r->rstack[r->rstackpos];
+ } else
+ rule = roff_evalcond(*bufp, &pos);
- if (NULL == roffnode_new(tok, tree))
- return(0);
+ sv = pos;
- if ( ! (*tree->cb->roffin)(tok, argcp, argvp))
- return(0);
+ while (' ' == (*bufp)[pos])
+ pos++;
- if ( ! (ROFF_PARSED & tokens[tok].flags)) {
- /* TODO: print all tokens. */
+ /*
+ * Roff is weird. If we have just white-space after the
+ * conditional, it's considered the BODY and we exit without
+ * really doing anything. Warn about this. It's probably
+ * wrong.
+ */
- if ( ! ((*tree->cb->roffout)(tok)))
- return(0);
- return((*tree->cb->roffblkin)(tok));
+ if ('\0' == (*bufp)[pos] && sv != pos) {
+ if ((*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
+ return(ROFF_IGN);
+ return(ROFF_ERR);
}
- while (*argv) {
- if (2 >= strlen(*argv) && ROFF_MAX !=
- (c = rofffindcallable(*argv)))
- if ( ! (*tokens[c].cb)(c, tree,
- argv + 1, ROFF_ENTER))
- return(0);
+ if ( ! roffnode_push(r, tok, ln, ppos))
+ return(ROFF_ERR);
+
+ r->last->rule = rule;
+
+ ROFF_DEBUG("roff: cond: %s -> %s\n", roffs[tok].name,
+ ROFFRULE_ALLOW == rule ? "allow" : "deny");
- /* TODO: print token. */
- argv++;
+ if (ROFF_ie == tok) {
+ /*
+ * An if-else will put the NEGATION of the current
+ * evaluated conditional into the stack.
+ */
+ r->rstackpos++;
+ if (ROFFRULE_DENY == r->last->rule)
+ r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
+ else
+ r->rstack[r->rstackpos] = ROFFRULE_DENY;
}
- if ( ! ((*tree->cb->roffout)(tok)))
- return(0);
+ /* If the parent has false as its rule, then so do we. */
+
+ if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule) {
+ r->last->rule = ROFFRULE_DENY;
+ ROFF_DEBUG("roff: cond override: %s -> deny\n",
+ roffs[tok].name);
+ }
+
+ /*
+ * Determine scope. If we're invoked with "\{" trailing the
+ * conditional, then we're in a multiline scope. Else our scope
+ * expires on the next line.
+ */
+
+ r->last->endspan = 1;
+
+ if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
+ r->last->endspan = -1;
+ pos += 2;
+ ROFF_DEBUG("roff: cond-scope: %s, multi-line\n",
+ roffs[tok].name);
+ } else
+ ROFF_DEBUG("roff: cond-scope: %s, one-line\n",
+ roffs[tok].name);
+
+ /*
+ * If there are no arguments on the line, the next-line scope is
+ * assumed.
+ */
+
+ if ('\0' == (*bufp)[pos])
+ return(ROFF_IGN);
- return((*tree->cb->roffblkin)(tok));
+ /* Otherwise re-run the roff parser after recalculating. */
+
+ *offs = pos;
+ return(ROFF_RERUN);
}
/* ARGSUSED */
-static int
-roff_text(ROFFCALL_ARGS)
+static enum rofferr
+roff_ds(ROFF_ARGS)
{
- int i, c, argcp[ROFF_MAXARG];
- char *v, *argvp[ROFF_MAXARG];
-
- if (ROFF_PRELUDE & tree->state) {
- warnx("%s: macro `%s' called in prelude (line %zu)",
- tree->rbuf->name,
- toknames[tok],
- tree->rbuf->line);
- return(0);
- }
+ char *name, *string;
- i = 0;
-
- while (-1 != (c = roffnextopt(tok, &argv, &v))) {
- if (ROFF_ARGMAX == c) {
- warnx("%s: error parsing `%s' args (line %zu)",
- tree->rbuf->name,
- toknames[tok],
- tree->rbuf->line);
- return(0);
- }
- argcp[i] = c;
- argvp[i] = v;
- i++;
- argv++;
- }
+ /*
+ * A symbol is named by the first word following the macro
+ * invocation up to a space. Its value is anything after the
+ * name's trailing whitespace and optional double-quote. Thus,
+ *
+ * [.ds foo "bar " ]
+ *
+ * will have `bar " ' as its value.
+ */
- argcp[i] = ROFF_ARGMAX;
- argvp[i] = NULL;
+ name = *bufp + pos;
+ if ('\0' == *name)
+ return(ROFF_IGN);
- if ( ! (*tree->cb->roffin)(tok, argcp, argvp))
- return(0);
+ string = name;
+ /* Read until end of name. */
+ while (*string && ' ' != *string)
+ string++;
- if ( ! (ROFF_PARSED & tokens[tok].flags)) {
- /* TODO: print all tokens. */
- return((*tree->cb->roffout)(tok));
- }
+ /* Nil-terminate name. */
+ if (*string)
+ *(string++) = '\0';
+
+ /* Read past spaces. */
+ while (*string && ' ' == *string)
+ string++;
- while (*argv) {
- if (2 >= strlen(*argv) && ROFF_MAX !=
- (c = rofffindcallable(*argv)))
- if ( ! (*tokens[c].cb)(c, tree,
- argv + 1, ROFF_ENTER))
- return(0);
+ /* Read passed initial double-quote. */
+ if (*string && '"' == *string)
+ string++;
- /* TODO: print token. */
- argv++;
- }
+ /* The rest is the value. */
+ roff_setstr(r, name, string);
+ return(ROFF_IGN);
+}
- return((*tree->cb->roffout)(tok));
+
+/* ARGSUSED */
+static enum rofferr
+roff_nr(ROFF_ARGS)
+{
+ const char *key, *val;
+ struct reg *rg;
+
+ key = &(*bufp)[pos];
+ rg = r->regs->regs;
+
+ /* Parse register request. */
+ while ((*bufp)[pos] && ' ' != (*bufp)[pos])
+ pos++;
+
+ /*
+ * Set our nil terminator. Because this line is going to be
+ * ignored anyway, we can munge it as we please.
+ */
+ if ((*bufp)[pos])
+ (*bufp)[pos++] = '\0';
+
+ /* Skip whitespace to register token. */
+ while ((*bufp)[pos] && ' ' == (*bufp)[pos])
+ pos++;
+
+ val = &(*bufp)[pos];
+
+ /* Process register token. */
+
+ if (0 == strcmp(key, "nS")) {
+ rg[(int)REG_nS].set = 1;
+ if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u))
+ rg[(int)REG_nS].v.u = 0;
+
+ ROFF_DEBUG("roff: register nS: %u\n",
+ rg[(int)REG_nS].v.u);
+ } else
+ ROFF_DEBUG("roff: ignoring register: %s\n", key);
+
+ return(ROFF_IGN);
}
-/* ARGUSED */
-static int
-roff_comment(ROFFCALL_ARGS)
+static void
+roff_setstr(struct roff *r, const char *name, const char *string)
{
+ struct roffstr *n;
+ char *namecopy;
+
+ n = r->first_string;
+ while (n && strcmp(name, n->name))
+ n = n->next;
+
+ if (NULL == n) {
+ namecopy = mandoc_strdup(name);
+ n = mandoc_malloc(sizeof(struct roffstr));
+ n->name = namecopy;
+ n->next = r->first_string;
+ r->first_string = n;
+ } else
+ free(n->string);
- return(1);
+ ROFF_DEBUG("roff: new symbol: [%s] = [%s]\n", name, string);
+ n->string = string ? strdup(string) : NULL;
+}
+
+
+static const char *
+roff_getstrn(const struct roff *r, const char *name, size_t len)
+{
+ const struct roffstr *n;
+
+ n = r->first_string;
+ while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len]))
+ n = n->next;
+
+ return(n ? n->string : NULL);
+}
+
+
+static void
+roff_freestr(struct roff *r)
+{
+ struct roffstr *n, *nn;
+
+ for (n = r->first_string; n; n = nn) {
+ free(n->name);
+ free(n->string);
+ nn = n->next;
+ free(n);
+ }
+
+ r->first_string = NULL;
}