=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.1 retrieving revision 1.26 diff -u -p -r1.1 -r1.26 --- mandoc/man.c 2009/03/23 14:22:11 1.1 +++ mandoc/man.c 2009/07/04 09:01:55 1.26 @@ -1,24 +1,21 @@ -/* $Id: man.c,v 1.1 2009/03/23 14:22:11 kristaps Exp $ */ +/* $Id: man.c,v 1.26 2009/07/04 09:01:55 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * 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. */ #include #include -#include #include #include #include @@ -27,58 +24,48 @@ #include "libman.h" const char *const __man_macronames[MAN_MAX] = { - "\\\"", "TH", "SH", "SS", + "br", "TH", "SH", "SS", "TP", "LP", "PP", "P", "IP", "HP", "SM", "SB", "BI", "IB", "BR", "RB", - "R", "B", "I" + "R", "B", "I", "IR", + "RI", "na", "i" }; const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(int, int, enum man_type); +static struct man_node *man_node_alloc(int, int, + enum man_type, int); static int man_node_append(struct man *, struct man_node *); static int man_ptext(struct man *, int, char *); static int man_pmacro(struct man *, int, char *); +static void man_free1(struct man *); +static int man_alloc1(struct man *); const struct man_node * -man_node(const struct man *man) +man_node(const struct man *m) { - return(man->first); + return(MAN_HALT & m->flags ? NULL : m->first); } const struct man_meta * -man_meta(const struct man *man) +man_meta(const struct man *m) { - return(&man->meta); + return(MAN_HALT & m->flags ? NULL : &m->meta); } -void +int man_reset(struct man *man) { - if (man->first) - man_node_freelist(man->first); - if (man->meta.title) - free(man->meta.title); - if (man->meta.os) - free(man->meta.os); - if (man->meta.vol) - free(man->meta.vol); - - bzero(&man->meta, sizeof(struct man_meta)); - man->flags = 0; - if (NULL == (man->last = calloc(1, sizeof(struct man_node)))) - err(1, "malloc"); - man->first = man->last; - man->last->type = MAN_ROOT; - man->next = MAN_NEXT_CHILD; + man_free1(man); + return(man_alloc1(man)); } @@ -86,14 +73,8 @@ void man_free(struct man *man) { - if (man->first) - man_node_freelist(man->first); - if (man->meta.title) - free(man->meta.title); - if (man->meta.os) - free(man->meta.os); - if (man->meta.vol) - free(man->meta.vol); + man_free1(man); + if (man->htab) man_hash_free(man->htab); free(man); @@ -101,19 +82,26 @@ man_free(struct man *man) struct man * -man_alloc(void) +man_alloc(void *data, int pflags, const struct man_cb *cb) { struct man *p; if (NULL == (p = calloc(1, sizeof(struct man)))) - err(1, "malloc"); - if (NULL == (p->last = calloc(1, sizeof(struct man_node)))) - err(1, "malloc"); + return(NULL); - p->first = p->last; - p->last->type = MAN_ROOT; - p->next = MAN_NEXT_CHILD; - p->htab = man_hash_alloc(); + if ( ! man_alloc1(p)) { + free(p); + return(NULL); + } + + p->data = data; + p->pflags = pflags; + (void)memcpy(&p->cb, cb, sizeof(struct man_cb)); + + if (NULL == (p->htab = man_hash_alloc())) { + free(p); + return(NULL); + } return(p); } @@ -122,7 +110,12 @@ int man_endparse(struct man *m) { - return(1); + if (MAN_HALT & m->flags) + return(0); + else if (man_macroend(m)) + return(1); + m->flags |= MAN_HALT; + return(0); } @@ -136,7 +129,38 @@ man_parseln(struct man *m, int ln, char *buf) } +static void +man_free1(struct man *man) +{ + + if (man->first) + man_node_freelist(man->first); + if (man->meta.title) + free(man->meta.title); + if (man->meta.source) + free(man->meta.source); + if (man->meta.vol) + free(man->meta.vol); +} + + static int +man_alloc1(struct man *m) +{ + + bzero(&m->meta, sizeof(struct man_meta)); + m->flags = 0; + m->last = calloc(1, sizeof(struct man_node)); + if (NULL == m->last) + return(0); + m->first = m->last; + m->last->type = MAN_ROOT; + m->next = MAN_NEXT_CHILD; + return(1); +} + + +static int man_node_append(struct man *man, struct man_node *p) { @@ -158,91 +182,51 @@ man_node_append(struct man *man, struct man_node *p) abort(); /* NOTREACHED */ } + + p->parent->nchild++; -#if 0 - if ( ! man_valid_pre(man, p)) - return(0); - if ( ! man_action_pre(man, p)) - return(0); -#endif + man->last = p; switch (p->type) { - case (MAN_HEAD): - assert(MAN_BLOCK == p->parent->type); - p->parent->head = p; + case (MAN_TEXT): + if ( ! man_valid_post(man)) + return(0); + if ( ! man_action_post(man)) + return(0); break; - case (MAN_BODY): - assert(MAN_BLOCK == p->parent->type); - p->parent->body = p; - break; default: break; } - man->last = p; return(1); } static struct man_node * -man_node_alloc(int line, int pos, enum man_type type) +man_node_alloc(int line, int pos, enum man_type type, int tok) { struct man_node *p; - if (NULL == (p = calloc(1, sizeof(struct man_node)))) - err(1, "malloc"); + p = calloc(1, sizeof(struct man_node)); + if (NULL == p) + return(NULL); + p->line = line; p->pos = pos; p->type = type; - + p->tok = tok; return(p); } int -man_head_alloc(struct man *man, int line, int pos, int tok) -{ - struct man_node *p; - - p = man_node_alloc(line, pos, MAN_HEAD); - p->tok = tok; - - return(man_node_append(man, p)); -} - - -int -man_body_alloc(struct man *man, int line, int pos, int tok) -{ - struct man_node *p; - - p = man_node_alloc(line, pos, MAN_BODY); - p->tok = tok; - - return(man_node_append(man, p)); -} - - -int -man_block_alloc(struct man *man, int line, int pos, int tok) -{ - struct man_node *p; - - p = man_node_alloc(line, pos, MAN_BLOCK); - p->tok = tok; - - return(man_node_append(man, p)); -} - - -int man_elem_alloc(struct man *man, int line, int pos, int tok) { struct man_node *p; - p = man_node_alloc(line, pos, MAN_ELEM); - p->tok = tok; - + p = man_node_alloc(line, pos, MAN_ELEM, tok); + if (NULL == p) + return(0); return(man_node_append(man, p)); } @@ -253,10 +237,11 @@ man_word_alloc(struct man *man, { struct man_node *p; - p = man_node_alloc(line, pos, MAN_TEXT); + p = man_node_alloc(line, pos, MAN_TEXT, -1); + if (NULL == p) + return(0); if (NULL == (p->string = strdup(word))) - err(1, "strdup"); - + return(0); return(man_node_append(man, p)); } @@ -267,6 +252,8 @@ man_node_free(struct man_node *p) if (p->string) free(p->string); + if (p->parent) + p->parent->nchild--; free(p); } @@ -280,6 +267,7 @@ man_node_freelist(struct man_node *p) if (p->next) man_node_freelist(p->next); + assert(0 == p->nchild); man_node_free(p); } @@ -288,15 +276,28 @@ static int man_ptext(struct man *m, int line, char *buf) { - if (0 == buf[0]) { - warnx("blank line!"); + if ( ! man_word_alloc(m, line, 0, buf)) + return(0); + m->next = MAN_NEXT_SIBLING; + + /* + * If this is one of the zany NLINE macros that consumes the + * next line of input as being influenced, then close out the + * existing macro "scope" and continue processing. + */ + + if ( ! (MAN_NLINE & m->flags)) return(1); - } - if ( ! man_word_alloc(m, line, 0, buf)) + m->flags &= ~MAN_NLINE; + m->last = m->last->parent; + + assert(MAN_ROOT != m->last->type); + if ( ! man_valid_post(m)) return(0); + if ( ! man_action_post(m)) + return(0); - m->next = MAN_NEXT_SIBLING; return(1); } @@ -304,47 +305,63 @@ man_ptext(struct man *m, int line, char *buf) int man_pmacro(struct man *m, int ln, char *buf) { - int i, c; + int i, j, c, ppos, fl; char mac[5]; + struct man_node *n; /* Comments and empties are quickly ignored. */ + n = m->last; + fl = MAN_NLINE & m->flags; + if (0 == buf[1]) - return(1); + goto out; - if (' ' == buf[1]) { - i = 2; + i = 1; + + if (' ' == buf[i]) { + i++; while (buf[i] && ' ' == buf[i]) i++; if (0 == buf[i]) - return(1); - warnx("invalid syntax"); - return(0); + goto out; } - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) - return(1); + ppos = i; /* Copy the first word into a nil-terminated buffer. */ - for (i = 1; i < 5; i++) { - if (0 == (mac[i - 1] = buf[i])) + for (j = 0; j < 4; j++, i++) { + if (0 == (mac[j] = buf[i])) break; else if (' ' == buf[i]) break; } - mac[i - 1] = 0; + mac[j] = 0; - if (i == 5 || i <= 1) { - warnx("unknown macro: %s", mac); - goto err; - } + if (j == 4 || j < 1) { + if ( ! (MAN_IGN_MACRO & m->pflags)) { + (void)man_verr(m, ln, ppos, + "ill-formed macro: %s", mac); + goto err; + } + if ( ! man_vwarn(m, ln, ppos, + "ill-formed macro: %s", mac)) + goto err; + return(1); + } if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { - warnx("unknown macro: %s", mac); - goto err; + if ( ! (MAN_IGN_MACRO & m->pflags)) { + (void)man_verr(m, ln, ppos, + "unknown macro: %s", mac); + goto err; + } + if ( ! man_vwarn(m, ln, ppos, + "unknown macro: %s", mac)) + goto err; + return(1); } /* The macro is sane. Jump to the next word. */ @@ -354,15 +371,115 @@ man_pmacro(struct man *m, int ln, char *buf) /* Begin recursive parse sequence. */ - if ( ! (*man_macros[c].fp)(m, c, ln, 1, &i, buf)) + if ( ! man_macro(m, c, ln, ppos, &i, buf)) goto err; +out: + if (fl) { + /* + * A NLINE macro has been immediately followed with + * another. Close out the preceding macro's scope, and + * continue. + */ + assert(MAN_ROOT != m->last->type); + assert(m->last->parent); + assert(MAN_ROOT != m->last->parent->type); + + if (n != m->last) + m->last = m->last->parent; + + if ( ! man_valid_post(m)) + return(0); + if ( ! man_action_post(m)) + return(0); + m->next = MAN_NEXT_SIBLING; + m->flags &= ~MAN_NLINE; + } + return(1); err: /* Error out. */ -#if 0 - m->flags |= MDOC_HALT; -#endif + m->flags |= MAN_HALT; return(0); +} + + +int +man_verr(struct man *man, int ln, int pos, const char *fmt, ...) +{ + char buf[256]; + va_list ap; + + if (NULL == man->cb.man_err) + return(0); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + return((*man->cb.man_err)(man->data, ln, pos, buf)); +} + + +int +man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...) +{ + char buf[256]; + va_list ap; + + if (NULL == man->cb.man_warn) + return(0); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + return((*man->cb.man_warn)(man->data, ln, pos, buf)); +} + + +int +man_err(struct man *m, int line, int pos, + int iserr, enum merr type) +{ + const char *p; + + p = NULL; + switch (type) { + case (WNPRINT): + p = "invalid character"; + break; + case (WNMEM): + p = "memory exhausted"; + break; + case (WMSEC): + p = "invalid manual section"; + break; + case (WDATE): + p = "invalid date format"; + break; + case (WLNSCOPE): + p = "scope of prior line violated"; + break; + case (WTSPACE): + p = "trailing whitespace at end of line"; + break; + case (WTQUOTE): + p = "unterminated quotation"; + break; + case (WNODATA): + p = "document has no data"; + break; + case (WNOTITLE): + p = "document has no title/section"; + break; + case (WESCAPE): + p = "invalid escape sequence"; + break; + } + assert(p); + + if (iserr) + return(man_verr(m, line, pos, p)); + + return(man_vwarn(m, line, pos, p)); }