mandoc/roff.c - diff

Return to roff.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.c between version 1.31 and 1.34

version 1.31, 2008/12/02 00:10:37

version 1.34, 2008/12/02 18:26:57

Line 17

* PERFORMANCE OF THIS SOFTWARE.

#include <sys/param.h>

#include <sys/types.h>

#include <assert.h>

#include <ctype.h>

Line 30

Line 31

#include "libmdocml.h"

#include "private.h"

/* FIXME: First letters of quoted-text interpreted in rofffindtok. */

/* FIXME: `No' not implemented. */

/* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */

/* TODO: warn about "X section only" macros. */

/* TODO: warn about empty lists. */

/* TODO: (warn) some sections need specific elements. */

/* TODO: (warn) NAME section has particular order. */

/* TODO: unify empty-content tags a la <br />. */

/* TODO: macros with a set number of arguments? */

#define ROFF_MAXARG 32

Line 67 struct rofftree;

Line 64 struct rofftree;

struct rofftok {

int (*cb)(ROFFCALL_ARGS); /* Callback. */

const int *args; /* Args (or NULL). */

const int *parents;

const int *parents; /* Limit to parents. */

const int *children;

const int *children; /* Limit to kids. */

int ctx;

int ctx; /* Blk-close node. */

enum rofftype type; /* Type of macro. */

int flags;

#define ROFF_PARSED (1 << 0) /* "Parsed". */

#define ROFF_CALLABLE (1 << 1) /* "Callable". */

#define ROFF_SHALLOW (1 << 2) /* Nesting block. */

#define ROFF_LSCOPE (1 << 3)

#define ROFF_LSCOPE (1 << 3) /* Line scope. */

};

struct roffarg {

Line 90 struct roffnode {

Line 87 struct roffnode {

struct rofftree {

struct roffnode *last; /* Last parsed node. */

char *cur;

char *cur; /* Line start. */

struct tm tm; /* `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. */

#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 roffcb cb; /* Callbacks. */

struct roffcb cb;

void *arg; /* Callbacks' arg. */

void *arg;

};

static int roff_Dd(ROFFCALL_ARGS);

static int roff_Dt(ROFFCALL_ARGS);

static int roff_Os(ROFFCALL_ARGS);

static int roff_Ns(ROFFCALL_ARGS);

static int roff_Sm(ROFFCALL_ARGS);

static int roff_layout(ROFFCALL_ARGS);

static int roff_text(ROFFCALL_ARGS);

static int roff_noop(ROFFCALL_ARGS);

static int roff_depr(ROFFCALL_ARGS);

static struct roffnode *roffnode_new(int, struct rofftree *);

static void roffnode_free(struct rofftree *);

static void roff_warn(const struct rofftree *,

const char *, char *, ...);

static void roff_err(const struct rofftree *,

const char *, char *, ...);

static int roffpurgepunct(struct rofftree *, char **);

static int roffscan(int, const int *);

static int rofffindtok(const char *);

Line 139 static int roffnextopt(const struct rofftree *,

Line 130 static int roffnextopt(const struct rofftree *,

int, char ***, char **);

static int roffparseopts(struct rofftree *, int,

char ***, int *, char **);

static int roffcall(struct rofftree *, int, char **);

static int roffparse(struct rofftree *, char *);

static int textparse(const struct rofftree *, char *);

#ifdef __linux__ /* FIXME: remove */

static size_t strlcat(char *, const char *, size_t);

static size_t strlcpy(char *, const char *, size_t);

extern int vsnprintf(char *, size_t,

const char *, va_list);

extern char *strptime(const char *, const char *,

struct tm *);

#endif

static const int roffarg_An[] = { ROFF_Split, ROFF_Nosplit,

ROFF_ARGMAX };

static const int roffarg_An[] = { ROFF_Split, ROFF_Nosplit, ROFF_ARGMAX };

static const int roffarg_Bd[] = { ROFF_Ragged, ROFF_Unfilled,

static const int roffarg_Bd[] = { ROFF_Ragged, ROFF_Unfilled, ROFF_Literal,

ROFF_Literal, ROFF_File, ROFF_Offset, ROFF_Filled,

ROFF_File, ROFF_Offset, ROFF_Filled, ROFF_Compact, ROFF_ARGMAX };

ROFF_Compact, ROFF_ARGMAX };

static const int roffarg_Bk[] = { ROFF_Words, ROFF_ARGMAX };

static const int roffarg_Ex[] = { ROFF_Std, ROFF_ARGMAX };

static const int roffarg_Rv[] = { ROFF_Std, ROFF_ARGMAX };

static const int roffarg_Bl[] = { ROFF_Bullet, ROFF_Dash,

static const int roffarg_Bl[] = { ROFF_Bullet, ROFF_Dash, ROFF_Hyphen,

ROFF_Hyphen, ROFF_Item, ROFF_Enum, ROFF_Tag, ROFF_Diag,

ROFF_Item, ROFF_Enum, ROFF_Tag, ROFF_Diag, ROFF_Hang, ROFF_Ohang,

ROFF_Hang, ROFF_Ohang, ROFF_Inset, ROFF_Column, ROFF_Offset,

ROFF_Inset, ROFF_Column, ROFF_Offset, ROFF_Width, ROFF_Compact,

ROFF_Width, ROFF_Compact, ROFF_ARGMAX };

static const int roffarg_St[] = {

ROFF_p1003_1_88, ROFF_p1003_1_90, ROFF_p1003_1_96,

ROFF_p1003_1_2001, ROFF_p1003_1_2004, ROFF_p1003_1,

ROFF_p1003_1b, ROFF_p1003_1b_93, ROFF_p1003_1c_95,

ROFF_p1003_1g_2000, ROFF_p1003_2_92, ROFF_p1387_2_95,

ROFF_p1003_2, ROFF_p1387_2, ROFF_isoC_90, ROFF_isoC_amd1,

ROFF_isoC_tcor1, ROFF_isoC_tcor2, ROFF_isoC_99, ROFF_ansiC,

ROFF_ansiC_89, ROFF_ansiC_99, ROFF_ieee754, ROFF_iso8802_3,

ROFF_xpg3, ROFF_xpg4, ROFF_xpg4_2, ROFF_xpg4_3, ROFF_xbd5,

ROFF_xcu5, ROFF_xsh5, ROFF_xns5, ROFF_xns5_2d2_0,

ROFF_xcurses4_2, ROFF_susv2, ROFF_susv3, ROFF_svid4,

ROFF_ARGMAX };

static const int roffarg_St[] = { ROFF_p1003_1_88, ROFF_p1003_1_90,

ROFF_p1003_1_96, ROFF_p1003_1_2001, ROFF_p1003_1_2004, ROFF_p1003_1,

ROFF_p1003_1b, ROFF_p1003_1b_93, ROFF_p1003_1c_95, ROFF_p1003_1g_2000,

ROFF_p1003_2_92, ROFF_p1387_2_95, ROFF_p1003_2, ROFF_p1387_2,

ROFF_isoC_90, ROFF_isoC_amd1, ROFF_isoC_tcor1, ROFF_isoC_tcor2,

ROFF_isoC_99, ROFF_ansiC, ROFF_ansiC_89, ROFF_ansiC_99, ROFF_ieee754,

ROFF_iso8802_3, ROFF_xpg3, ROFF_xpg4, ROFF_xpg4_2, ROFF_xpg4_3,

ROFF_xbd5, ROFF_xcu5, ROFF_xsh5, ROFF_xns5, ROFF_xns5_2d2_0,

ROFF_xcurses4_2, ROFF_susv2, ROFF_susv3, ROFF_svid4, ROFF_ARGMAX };

static const int roffchild_Bl[] = { ROFF_It, ROFF_El, ROFF_MAX };

static const int roffchild_Fo[] = { ROFF_Fa, ROFF_Fc, ROFF_MAX };

static const int roffchild_Rs[] = { ROFF_Re, ROFF__A, ROFF__B,

static const int roffchild_Rs[] = { ROFF_Re, ROFF__A, ROFF__B, ROFF__D,

ROFF__D, ROFF__I, ROFF__J, ROFF__N, ROFF__O, ROFF__P,

ROFF__I, ROFF__J, ROFF__N, ROFF__O, ROFF__P, ROFF__R, ROFF__T, ROFF__V,

ROFF__R, ROFF__T, ROFF__V, ROFF_MAX };

ROFF_MAX };

static const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX };

static const int roffparent_Fc[] = { ROFF_Fo, ROFF_Fa, ROFF_MAX };

Line 180 static const int roffparent_Oc[] = { ROFF_Oo, ROFF_MAX

Line 176 static const int roffparent_Oc[] = { ROFF_Oo, ROFF_MAX

static const int roffparent_It[] = { ROFF_Bl, ROFF_It, ROFF_MAX };

static const int roffparent_Re[] = { ROFF_Rs, ROFF_MAX };

/* Table of all known tokens. */

static const struct rofftok tokens[ROFF_MAX] = {

{ roff_noop, NULL, NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */

{ roff_Dd, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dd */

Line 271 static const struct rofftok tokens[ROFF_MAX] = {

Line 266 static const struct rofftok tokens[ROFF_MAX] = {

{ roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */

{ roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */

{ roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Sq */

{ NULL, NULL, NULL, NULL, 0, ROFF_SPECIAL, 0 }, /* Sm */

{ roff_Sm, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Sm */

{ roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */

{ roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */

{ roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */

Line 290 static const struct rofftok tokens[ROFF_MAX] = {

Line 285 static const struct rofftok tokens[ROFF_MAX] = {

{ NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ud */

};

/* Table of all known token arguments. */

static const int tokenargs[ROFF_ARGMAX] = {

0, 0, 0, 0,

0, ROFF_VALUE, ROFF_VALUE, 0,

Line 665 roffparse(struct rofftree *tree, char *buf)

Line 659 roffparse(struct rofftree *tree, char *buf)

assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);

/* LINTED */

for (n = tree->last; n; n = n->parent)

if (n->tok != tokens[tok].ctx) {

if (n->tok == tokens[n->tok].ctx)

Line 837 roffnode_free(struct rofftree *tree)

Line 832 roffnode_free(struct rofftree *tree)

static int

roffcall(struct rofftree *tree, int tok, char **argv)

{

if (NULL == tokens[tok].cb) {

roff_err(tree, *argv, "unsupported macro `%s'",

toknames[tok]);

return(0);

}

if ( ! (*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER))

return(0);

return(1);

}

static int

roffnextopt(const struct rofftree *tree, int tok,

char ***in, char **val)

{

Line 854 roffnextopt(const struct rofftree *tree, int tok,

Line 864 roffnextopt(const struct rofftree *tree, int tok,

if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {

roff_warn(tree, arg, "argument-like parameter `%s' to "

"`%s'", &arg[1], toknames[tok]);

"`%s'", arg, toknames[tok]);

return(-1);

}

Line 1072 roff_Dt(ROFFCALL_ARGS)

Line 1082 roff_Dt(ROFFCALL_ARGS)

/* ARGSUSED */

static int

roff_Ns(ROFFCALL_ARGS)

roff_Sm(ROFFCALL_ARGS)

{

int j, c, first;

int argcp[1];

char *argvp[1], *morep[1], *p;

first = (*argv == tree->cur);

p = *argv++;

argv++;

argcp[0] = ROFF_ARGMAX;

argvp[0] = NULL;

if (NULL == (morep[0] = *argv++)) {

roff_err(tree, p, "`Sm' expects an argument");

return(0);

} else if (0 != strcmp(morep[0], "on") &&

0 != strcmp(morep[0], "off")) {

roff_err(tree, p, "`Sm' has invalid argument");

return(0);

}

if (ROFF_MAX != (c = rofffindcallable(*argv))) {

if (*argv)

if (NULL == tokens[c].cb) {

roff_warn(tree, *argv, "`Sm' shouldn't have arguments");

roff_err(tree, *argv, "unsupported macro `%s'",

toknames[c]);

return(0);

}

if ( ! (*tree->cb.roffspecial)(tree->arg, tok))

return(0);

if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))

return(0);

if ( ! first)

return(1);

return(roffpurgepunct(tree, argv));

}

if ( ! (*tree->cb.roffdata)(tree->arg, 0, *argv++))

if ( ! (*tree->cb.roffspecial)(tree->arg,

tok, argcp, argvp, morep))

return(0);

while (*argv) {

if (ROFF_MAX == (c = rofffindcallable(*argv))) {

if ((*tree->cb.roffdata)(tree->arg, 1, *argv++))

if ( ! roffispunct(*argv)) {

continue;

if ( ! (*tree->cb.roffdata)

return(0);

(tree->arg, 1, *argv++))

}

return(0);

continue;

}

/* FIXME: this is identical to that of

* roff_text. */

/* See if only punctuation remains. */

return(1);

}

for (j = 0; argv[j]; j++)

if ( ! roffispunct(argv[j]))

break;

if (argv[j]) {

/* ARGSUSED */

if ( ! (*tree->cb.roffdata)

static int

(tree->arg, 0, *argv++))

roff_Ns(ROFFCALL_ARGS)

return(0);

{

continue;

int j, c, first;

}

int argcp[1];

char *argvp[1], *morep[1];

/* Only punctuation remains. */

first = (*argv++ == tree->cur);

argcp[0] = ROFF_ARGMAX;

argvp[0] = morep[0] = NULL;

if ( ! (*tree->cb.roffspecial)(tree->arg,

tok, argcp, argvp, morep))

return(0);

while (*argv) {

if (ROFF_MAX != (c = rofffindcallable(*argv))) {

if ( ! roffcall(tree, c, argv))

return(0);

break;

}

if (NULL == tokens[c].cb) {

roff_err(tree, *argv, "unsupported macro `%s'",

if ( ! roffispunct(*argv)) {

toknames[c]);

if ((*tree->cb.roffdata)(tree->arg, 1, *argv++))

continue;

return(0);

}

if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))

for (j = 0; argv[j]; j++)

if ( ! roffispunct(argv[j]))

break;

if (argv[j]) {

if ((*tree->cb.roffdata)(tree->arg, 0, *argv++))

continue;

return(0);

}

break;

}

if ( ! first)

return(1);

return(roffpurgepunct(tree, argv));

}

Line 1259 roff_layout(ROFFCALL_ARGS)

Line 1282 roff_layout(ROFFCALL_ARGS)

i = 1;

continue;

}

if ( ! roffcall(tree, c, argv))

if (NULL == tokens[c].cb) {

roff_err(tree, *argv, "unsupported macro `%s'",

toknames[c]);

return(0);

}

if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))

return(0);

break;

}

Line 1335 roff_text(ROFFCALL_ARGS)

Line 1350 roff_text(ROFFCALL_ARGS)

i = 0;

while (*argv) {

if (ROFF_MAX == (c = rofffindcallable(*argv))) {

if (ROFF_MAX != (c = rofffindcallable(*argv))) {

if ( ! roffispunct(*argv)) {

if ( ! (ROFF_LSCOPE & tokens[tok].flags))

if ( ! (*tree->cb.roffdata)

if ( ! (*tree->cb.roffout)(tree->arg, tok))

(tree->arg, i, *argv++))

return(0);

i = 1;

continue;

if ( ! roffcall(tree, c, argv))

}

return(0);

/* See if only punctuation remains. */

if (ROFF_LSCOPE & tokens[tok].flags)

if ( ! (*tree->cb.roffout)(tree->arg, tok))

i = 1;

for (j = 0; argv[j]; j++)

if ( ! roffispunct(argv[j]))

break;

if (argv[j]) {

if ( ! (*tree->cb.roffdata)

(tree->arg, 0, *argv++))

return(0);

continue;

}

break;

}

/* Only punctuation remains. */

if ( ! roffispunct(*argv)) {

if ( ! (*tree->cb.roffdata)(tree->arg, i, *argv++))

if ( ! (*tree->cb.roffout)(tree->arg, tok))

return(0);

break;

i = 1;

continue;

}

i = 1;

* A sub-command has been found. Execute it and

for (j = 0; argv[j]; j++)

* discontinue parsing for arguments. If we're

if ( ! roffispunct(argv[j]))

* line-scoped, then close out after it returns; if we

break;

* aren't, then close out before.

if (NULL == tokens[c].cb) {

if (argv[j]) {

roff_err(tree, *argv, "unsupported macro `%s'",

if ( ! (*tree->cb.roffdata)(tree->arg, 0, *argv++))

toknames[c]);

return(0);

}

if ( ! (ROFF_LSCOPE & tokens[tok].flags))

if ( ! (*tree->cb.roffout)(tree->arg, tok))

return(0);

continue;

if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))

}

return(0);

if (ROFF_LSCOPE & tokens[tok].flags)

if ( ! (*tree->cb.roffout)(tree->arg, tok))

return(0);

break;

}

Line 1448 roff_err(const struct rofftree *tree, const char *pos,

Line 1444 roff_err(const struct rofftree *tree, const char *pos,

(*tree->cb.roffmsg)(tree->arg,

ROFF_ERROR, tree->cur, pos, buf);

}

#ifdef __linux /* FIXME: remove. */

/* $OpenBSD$ */

* 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.

* 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.

static size_t

strlcat(char *dst, const char *src, size_t siz)

{

char *d = dst;

const char *s = src;

size_t n = siz;

size_t dlen;

/* Find the end of dst and adjust bytes left but don't go past

* end */

while (n-- != 0 && *d != '\0')

d++;

dlen = d - dst;

n = siz - dlen;

if (n == 0)

return(dlen + strlen(s));

while (*s != '\0') {

if (n != 1) {

*d++ = *s;

n--;

}

s++;

}

*d = '\0';

return(dlen + (s - src)); /* count does not include NUL */

}

static size_t

strlcpy(char *dst, const char *src, size_t siz)

{

char *d = dst;

const char *s = src;

size_t n = siz;

/* Copy as many bytes as will fit */

if (n != 0) {

while (--n != 0) {

if ((*d++ = *s++) == '\0')

break;

}

/* Not enough room in dst, add NUL and traverse rest of src */

if (n == 0) {

if (siz != 0)

*d = '\0'; /* NUL-terminate dst */

while (*s++)

;

}

return(s - src - 1); /* count does not include NUL */

}

#endif /*__linux__*/

CVSweb