Return to man.c CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.1, 2009/03/23 14:22:11 | version 1.30, 2009/08/19 09:14:50 | ||
---|---|---|---|
|
|
||
/* $Id$ */ | /* $Id$ */ | ||
/* | /* | ||
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org> | * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> | ||
* | * | ||
* Permission to use, copy, modify, and distribute this software for any | * Permission to use, copy, modify, and distribute this software for any | ||
* purpose with or without fee is hereby granted, provided that the | * purpose with or without fee is hereby granted, provided that the above | ||
* above copyright notice and this permission notice appear in all | * copyright notice and this permission notice appear in all copies. | ||
* copies. | |||
* | * | ||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR | * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
* PERFORMANCE OF THIS SOFTWARE. | |||
*/ | */ | ||
#include <assert.h> | #include <assert.h> | ||
#include <ctype.h> | #include <ctype.h> | ||
#include <err.h> | |||
#include <stdarg.h> | #include <stdarg.h> | ||
#include <stdlib.h> | #include <stdlib.h> | ||
#include <stdio.h> | #include <stdio.h> | ||
|
|
||
#include "libman.h" | #include "libman.h" | ||
const char *const __man_merrnames[WERRMAX] = { | |||
"invalid character", /* WNPRINT */ | |||
"system: malloc error", /* WNMEM */ | |||
"invalid manual section", /* WMSEC */ | |||
"invalid date format", /* WDATE */ | |||
"scope of prior line violated", /* WLNSCOPE */ | |||
"trailing whitespace", /* WTSPACE */ | |||
"unterminated quoted parameter", /* WTQUOTE */ | |||
"document has no body", /* WNODATA */ | |||
"document has no title/section", /* WNOTITLE */ | |||
"invalid escape sequence", /* WESCAPE */ | |||
"invalid number format", /* WNUMFMT */ | |||
"expected block head arguments", /* WHEADARGS */ | |||
"expected block body arguments", /* WBODYARGS */ | |||
"expected empty block head", /* WNHEADARGS */ | |||
"unknown macro", /* WMACRO */ | |||
"ill-formed macro", /* WMACROFORM */ | |||
"scope open on exit", /* WEXITSCOPE */ | |||
"no scope context" /* WNOSCOPE */ | |||
}; | |||
const char *const __man_macronames[MAN_MAX] = { | const char *const __man_macronames[MAN_MAX] = { | ||
"\\\"", "TH", "SH", "SS", | "br", "TH", "SH", "SS", | ||
"TP", "LP", "PP", "P", | "TP", "LP", "PP", "P", | ||
"IP", "HP", "SM", "SB", | "IP", "HP", "SM", "SB", | ||
"BI", "IB", "BR", "RB", | "BI", "IB", "BR", "RB", | ||
"R", "B", "I" | "R", "B", "I", "IR", | ||
"RI", "na", "i", "sp", | |||
"nf", "fi", "r", "RE", | |||
"RS" | |||
}; | }; | ||
const char * const *man_macronames = __man_macronames; | 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 *, | static int man_node_append(struct man *, | ||
struct man_node *); | struct man_node *); | ||
static int man_ptext(struct man *, int, char *); | static int man_ptext(struct man *, int, char *); | ||
static int man_pmacro(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 * | 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 * | 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) | man_reset(struct man *man) | ||
{ | { | ||
if (man->first) | man_free1(man); | ||
man_node_freelist(man->first); | return(man_alloc1(man)); | ||
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_free(struct man *man) | man_free(struct man *man) | ||
{ | { | ||
if (man->first) | man_free1(man); | ||
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); | |||
if (man->htab) | if (man->htab) | ||
man_hash_free(man->htab); | man_hash_free(man->htab); | ||
free(man); | free(man); | ||
|
|
||
struct man * | struct man * | ||
man_alloc(void) | man_alloc(void *data, int pflags, const struct man_cb *cb) | ||
{ | { | ||
struct man *p; | struct man *p; | ||
if (NULL == (p = calloc(1, sizeof(struct man)))) | if (NULL == (p = calloc(1, sizeof(struct man)))) | ||
err(1, "malloc"); | return(NULL); | ||
if (NULL == (p->last = calloc(1, sizeof(struct man_node)))) | |||
err(1, "malloc"); | |||
p->first = p->last; | if ( ! man_alloc1(p)) { | ||
p->last->type = MAN_ROOT; | free(p); | ||
p->next = MAN_NEXT_CHILD; | return(NULL); | ||
p->htab = man_hash_alloc(); | } | ||
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); | return(p); | ||
} | } | ||
|
|
||
man_endparse(struct man *m) | 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); | |||
} | } | ||
|
|
||
} | } | ||
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 | 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) | man_node_append(struct man *man, struct man_node *p) | ||
{ | { | ||
|
|
||
abort(); | abort(); | ||
/* NOTREACHED */ | /* NOTREACHED */ | ||
} | } | ||
p->parent->nchild++; | |||
#if 0 | |||
if ( ! man_valid_pre(man, p)) | if ( ! man_valid_pre(man, p)) | ||
return(0); | return(0); | ||
if ( ! man_action_pre(man, p)) | |||
return(0); | |||
#endif | |||
switch (p->type) { | switch (p->type) { | ||
case (MAN_HEAD): | case (MAN_HEAD): | ||
|
|
||
} | } | ||
man->last = p; | man->last = p; | ||
switch (p->type) { | |||
case (MAN_TEXT): | |||
if ( ! man_valid_post(man)) | |||
return(0); | |||
if ( ! man_action_post(man)) | |||
return(0); | |||
break; | |||
default: | |||
break; | |||
} | |||
return(1); | return(1); | ||
} | } | ||
static struct man_node * | 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; | struct man_node *p; | ||
if (NULL == (p = calloc(1, sizeof(struct man_node)))) | p = calloc(1, sizeof(struct man_node)); | ||
err(1, "malloc"); | if (NULL == p) | ||
return(NULL); | |||
p->line = line; | p->line = line; | ||
p->pos = pos; | p->pos = pos; | ||
p->type = type; | p->type = type; | ||
p->tok = tok; | |||
return(p); | return(p); | ||
} | } | ||
int | int | ||
man_head_alloc(struct man *man, int line, int pos, int tok) | man_elem_alloc(struct man *m, int line, int pos, int tok) | ||
{ | { | ||
struct man_node *p; | struct man_node *p; | ||
p = man_node_alloc(line, pos, MAN_HEAD); | p = man_node_alloc(line, pos, MAN_ELEM, tok); | ||
p->tok = tok; | if (NULL == p) | ||
return(0); | |||
return(man_node_append(man, p)); | if ( ! man_node_append(m, p)) | ||
return(0); | |||
m->next = MAN_NEXT_CHILD; | |||
return(1); | |||
} | } | ||
int | int | ||
man_body_alloc(struct man *man, int line, int pos, int tok) | man_head_alloc(struct man *m, int line, int pos, int tok) | ||
{ | { | ||
struct man_node *p; | struct man_node *p; | ||
p = man_node_alloc(line, pos, MAN_BODY); | p = man_node_alloc(line, pos, MAN_HEAD, tok); | ||
p->tok = tok; | if (NULL == p) | ||
return(0); | |||
return(man_node_append(man, p)); | if ( ! man_node_append(m, p)) | ||
return(0); | |||
m->next = MAN_NEXT_CHILD; | |||
return(1); | |||
} | } | ||
int | int | ||
man_block_alloc(struct man *man, int line, int pos, int tok) | man_body_alloc(struct man *m, int line, int pos, int tok) | ||
{ | { | ||
struct man_node *p; | struct man_node *p; | ||
p = man_node_alloc(line, pos, MAN_BLOCK); | p = man_node_alloc(line, pos, MAN_BODY, tok); | ||
p->tok = tok; | if (NULL == p) | ||
return(0); | |||
return(man_node_append(man, p)); | if ( ! man_node_append(m, p)) | ||
return(0); | |||
m->next = MAN_NEXT_CHILD; | |||
return(1); | |||
} | } | ||
int | int | ||
man_elem_alloc(struct man *man, int line, int pos, int tok) | man_block_alloc(struct man *m, int line, int pos, int tok) | ||
{ | { | ||
struct man_node *p; | struct man_node *p; | ||
p = man_node_alloc(line, pos, MAN_ELEM); | p = man_node_alloc(line, pos, MAN_BLOCK, tok); | ||
p->tok = tok; | if (NULL == p) | ||
return(0); | |||
return(man_node_append(man, p)); | if ( ! man_node_append(m, p)) | ||
return(0); | |||
m->next = MAN_NEXT_CHILD; | |||
return(1); | |||
} | } | ||
int | int | ||
man_word_alloc(struct man *man, | man_word_alloc(struct man *m, int line, int pos, const char *word) | ||
int line, int pos, const char *word) | |||
{ | { | ||
struct man_node *p; | 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))) | if (NULL == (p->string = strdup(word))) | ||
err(1, "strdup"); | return(0); | ||
if ( ! man_node_append(m, p)) | |||
return(man_node_append(man, p)); | return(0); | ||
m->next = MAN_NEXT_SIBLING; | |||
return(1); | |||
} | } | ||
|
|
||
if (p->string) | if (p->string) | ||
free(p->string); | free(p->string); | ||
if (p->parent) | |||
p->parent->nchild--; | |||
free(p); | free(p); | ||
} | } | ||
|
|
||
if (p->next) | if (p->next) | ||
man_node_freelist(p->next); | man_node_freelist(p->next); | ||
assert(0 == p->nchild); | |||
man_node_free(p); | man_node_free(p); | ||
} | } | ||
|
|
||
man_ptext(struct man *m, int line, char *buf) | man_ptext(struct man *m, int line, char *buf) | ||
{ | { | ||
if (0 == buf[0]) { | /* First allocate word. */ | ||
warnx("blank line!"); | |||
return(1); | |||
} | |||
/* FIXME: dechunk words! */ | |||
if ( ! man_word_alloc(m, line, 0, buf)) | if ( ! man_word_alloc(m, line, 0, buf)) | ||
return(0); | return(0); | ||
m->next = MAN_NEXT_SIBLING; | m->next = MAN_NEXT_SIBLING; | ||
return(1); | |||
/* | |||
* Co-ordinate what happens with having a next-line scope open: | |||
* first close out the element scope (if applicable), then close | |||
* out the block scope (also if applicable). | |||
*/ | |||
/* XXX - this should be in man_action.c. */ | |||
if (MAN_ELINE & m->flags) { | |||
m->flags &= ~MAN_ELINE; | |||
if ( ! man_unscope(m, m->last->parent)) | |||
return(0); | |||
} | |||
if ( ! (MAN_BLINE & m->flags)) | |||
return(1); | |||
m->flags &= ~MAN_BLINE; | |||
if ( ! man_unscope(m, m->last->parent)) | |||
return(0); | |||
return(man_body_alloc(m, line, 0, m->last->tok)); | |||
} | } | ||
int | int | ||
man_pmacro(struct man *m, int ln, char *buf) | man_pmacro(struct man *m, int ln, char *buf) | ||
{ | { | ||
int i, c; | int i, j, c, ppos, fl; | ||
char mac[5]; | char mac[5]; | ||
/* Comments and empties are quickly ignored. */ | /* Comments and empties are quickly ignored. */ | ||
fl = m->flags; | |||
if (0 == buf[1]) | if (0 == buf[1]) | ||
return(1); | goto out; | ||
if (' ' == buf[1]) { | i = 1; | ||
i = 2; | |||
if (' ' == buf[i]) { | |||
i++; | |||
while (buf[i] && ' ' == buf[i]) | while (buf[i] && ' ' == buf[i]) | ||
i++; | i++; | ||
if (0 == buf[i]) | if (0 == buf[i]) | ||
return(1); | goto out; | ||
warnx("invalid syntax"); | |||
return(0); | |||
} | } | ||
if (buf[1] && '\\' == buf[1]) | ppos = i; | ||
if (buf[2] && '\"' == buf[2]) | |||
return(1); | |||
/* Copy the first word into a nil-terminated buffer. */ | /* Copy the first word into a nil-terminated buffer. */ | ||
for (i = 1; i < 5; i++) { | for (j = 0; j < 4; j++, i++) { | ||
if (0 == (mac[i - 1] = buf[i])) | if (0 == (mac[j] = buf[i])) | ||
break; | break; | ||
else if (' ' == buf[i]) | else if (' ' == buf[i]) | ||
break; | break; | ||
} | } | ||
mac[i - 1] = 0; | mac[j] = 0; | ||
if (i == 5 || i <= 1) { | if (j == 4 || j < 1) { | ||
warnx("unknown macro: %s", mac); | if ( ! (MAN_IGN_MACRO & m->pflags)) { | ||
goto err; | (void)man_perr(m, ln, ppos, WMACROFORM); | ||
} | goto err; | ||
} | |||
if ( ! man_pwarn(m, ln, ppos, WMACROFORM)) | |||
goto err; | |||
return(1); | |||
} | |||
if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { | if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { | ||
warnx("unknown macro: %s", mac); | if ( ! (MAN_IGN_MACRO & m->pflags)) { | ||
goto err; | (void)man_perr(m, ln, ppos, WMACRO); | ||
goto err; | |||
} | |||
if ( ! man_pwarn(m, ln, ppos, WMACRO)) | |||
goto err; | |||
return(1); | |||
} | } | ||
/* The macro is sane. Jump to the next word. */ | /* The macro is sane. Jump to the next word. */ | ||
|
|
||
/* Begin recursive parse sequence. */ | /* Begin recursive parse sequence. */ | ||
if ( ! (*man_macros[c].fp)(m, c, ln, 1, &i, buf)) | assert(man_macros[c].fp); | ||
if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf)) | |||
goto err; | goto err; | ||
return(1); | out: | ||
if ( ! (MAN_BLINE & fl)) | |||
return(1); | |||
/* | |||
* If we've opened a new next-line element scope, then return | |||
* now, as the next line will close out the block scope. | |||
*/ | |||
if (MAN_ELINE & m->flags) | |||
return(1); | |||
/* Close out the block scope opened in the prior line. */ | |||
/* XXX - this should be in man_action.c. */ | |||
assert(MAN_BLINE & m->flags); | |||
m->flags &= ~MAN_BLINE; | |||
if ( ! man_unscope(m, m->last->parent)) | |||
return(0); | |||
return(man_body_alloc(m, ln, 0, m->last->tok)); | |||
err: /* Error out. */ | err: /* Error out. */ | ||
#if 0 | m->flags |= MAN_HALT; | ||
m->flags |= MDOC_HALT; | |||
#endif | |||
return(0); | 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 = __man_merrnames[(int)type]; | |||
assert(p); | |||
if (iserr) | |||
return(man_verr(m, line, pos, p)); | |||
return(man_vwarn(m, line, pos, p)); | |||
} | } |