version 1.70, 2010/05/15 22:44:04 |
version 1.88, 2010/11/30 15:36:28 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* |
* |
* 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 above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
#include <sys/types.h> |
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <ctype.h> |
|
#include <stdarg.h> |
#include <stdarg.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <string.h> |
#include <string.h> |
|
|
|
#include "mandoc.h" |
#include "libman.h" |
#include "libman.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
|
|
const char *const __man_merrnames[WERRMAX] = { |
|
"invalid character", /* WNPRINT */ |
|
"invalid date format", /* WDATE */ |
|
"scope of prior line violated", /* WLNSCOPE */ |
|
"over-zealous prior line scope violation", /* WLNSCOPE2 */ |
|
"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 */ |
|
"ill-formed macro", /* WMACROFORM */ |
|
"scope open on exit", /* WEXITSCOPE */ |
|
"no scope context", /* WNOSCOPE */ |
|
"literal context already open", /* WOLITERAL */ |
|
"no literal context open", /* WNLITERAL */ |
|
"document title should be uppercase", /* WTITLECASE */ |
|
"deprecated comment style", /* WBADCOMMENT */ |
|
}; |
|
|
|
const char *const __man_macronames[MAN_MAX] = { |
const char *const __man_macronames[MAN_MAX] = { |
"br", "TH", "SH", "SS", |
"br", "TH", "SH", "SS", |
"TP", "LP", "PP", "P", |
"TP", "LP", "PP", "P", |
Line 62 const char *const __man_macronames[MAN_MAX] = { |
|
Line 39 const char *const __man_macronames[MAN_MAX] = { |
|
"RI", "na", "i", "sp", |
"RI", "na", "i", "sp", |
"nf", "fi", "r", "RE", |
"nf", "fi", "r", "RE", |
"RS", "DT", "UC", "PD", |
"RS", "DT", "UC", "PD", |
"Sp", "Vb", "Ve", |
"Sp", "Vb", "Ve", "AT", |
|
"in" |
}; |
}; |
|
|
const char * const *man_macronames = __man_macronames; |
const char * const *man_macronames = __man_macronames; |
Line 74 static int man_node_append(struct man *, |
|
Line 52 static int man_node_append(struct man *, |
|
static void man_node_free(struct man_node *); |
static void man_node_free(struct man_node *); |
static void man_node_unlink(struct man *, |
static void man_node_unlink(struct man *, |
struct man_node *); |
struct man_node *); |
static int man_ptext(struct man *, int, char *); |
static int man_ptext(struct man *, int, char *, int); |
static int man_pmacro(struct man *, int, char *); |
static int man_pmacro(struct man *, int, char *, int); |
static void man_free1(struct man *); |
static void man_free1(struct man *); |
static void man_alloc1(struct man *); |
static void man_alloc1(struct man *); |
static int macrowarn(struct man *, int, const char *); |
|
|
|
|
|
const struct man_node * |
const struct man_node * |
Line 116 man_free(struct man *man) |
|
Line 93 man_free(struct man *man) |
|
|
|
|
|
struct man * |
struct man * |
man_alloc(void *data, int pflags, const struct man_cb *cb) |
man_alloc(struct regset *regs, void *data, mandocmsg msg) |
{ |
{ |
struct man *p; |
struct man *p; |
|
|
p = mandoc_calloc(1, sizeof(struct man)); |
p = mandoc_calloc(1, sizeof(struct man)); |
|
|
if (cb) |
|
memcpy(&p->cb, cb, sizeof(struct man_cb)); |
|
|
|
man_hash_init(); |
man_hash_init(); |
p->data = data; |
p->data = data; |
p->pflags = pflags; |
p->msg = msg; |
|
p->regs = regs; |
|
|
man_alloc1(p); |
man_alloc1(p); |
return(p); |
return(p); |
Line 148 man_endparse(struct man *m) |
|
Line 123 man_endparse(struct man *m) |
|
|
|
|
|
int |
int |
man_parseln(struct man *m, int ln, char *buf) |
man_parseln(struct man *m, int ln, char *buf, int offs) |
{ |
{ |
|
|
return('.' == *buf || '\'' == *buf ? |
if (MAN_HALT & m->flags) |
man_pmacro(m, ln, buf) : |
return(0); |
man_ptext(m, ln, buf)); |
|
|
return(('.' == buf[offs] || '\'' == buf[offs]) ? |
|
man_pmacro(m, ln, buf, offs) : |
|
man_ptext(m, ln, buf, offs)); |
} |
} |
|
|
|
|
Line 167 man_free1(struct man *man) |
|
Line 145 man_free1(struct man *man) |
|
free(man->meta.title); |
free(man->meta.title); |
if (man->meta.source) |
if (man->meta.source) |
free(man->meta.source); |
free(man->meta.source); |
|
if (man->meta.rawdate) |
|
free(man->meta.rawdate); |
if (man->meta.vol) |
if (man->meta.vol) |
free(man->meta.vol); |
free(man->meta.vol); |
if (man->meta.msec) |
if (man->meta.msec) |
Line 236 man_node_append(struct man *man, struct man_node *p) |
|
Line 216 man_node_append(struct man *man, struct man_node *p) |
|
case (MAN_TEXT): |
case (MAN_TEXT): |
if ( ! man_valid_post(man)) |
if ( ! man_valid_post(man)) |
return(0); |
return(0); |
if ( ! man_action_post(man)) |
|
return(0); |
|
break; |
break; |
default: |
default: |
break; |
break; |
Line 363 man_node_delete(struct man *m, struct man_node *p) |
|
Line 341 man_node_delete(struct man *m, struct man_node *p) |
|
|
|
|
|
static int |
static int |
man_ptext(struct man *m, int line, char *buf) |
man_ptext(struct man *m, int line, char *buf, int offs) |
{ |
{ |
int i; |
int i; |
|
|
/* Ignore bogus comments. */ |
/* Ignore bogus comments. */ |
|
|
if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2]) |
if ('\\' == buf[offs] && |
return(man_pwarn(m, line, 0, WBADCOMMENT)); |
'.' == buf[offs + 1] && |
|
'"' == buf[offs + 2]) |
|
return(man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); |
|
|
/* Literal free-form text whitespace is preserved. */ |
/* Literal free-form text whitespace is preserved. */ |
|
|
if (MAN_LITERAL & m->flags) { |
if (MAN_LITERAL & m->flags) { |
if ( ! man_word_alloc(m, line, 0, buf)) |
if ( ! man_word_alloc(m, line, offs, buf + offs)) |
return(0); |
return(0); |
goto descope; |
goto descope; |
} |
} |
|
|
/* Pump blank lines directly into the backend. */ |
/* Pump blank lines directly into the backend. */ |
|
|
for (i = 0; ' ' == buf[i]; i++) |
for (i = offs; ' ' == buf[i]; i++) |
/* Skip leading whitespace. */ ; |
/* Skip leading whitespace. */ ; |
|
|
if ('\0' == buf[i]) { |
if ('\0' == buf[i]) { |
/* Allocate a blank entry. */ |
/* Allocate a blank entry. */ |
if ( ! man_word_alloc(m, line, 0, "")) |
if ( ! man_word_alloc(m, line, offs, "")) |
return(0); |
return(0); |
goto descope; |
goto descope; |
} |
} |
Line 402 man_ptext(struct man *m, int line, char *buf) |
|
Line 382 man_ptext(struct man *m, int line, char *buf) |
|
|
|
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { |
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { |
if (i > 1 && '\\' != buf[i - 2]) |
if (i > 1 && '\\' != buf[i - 2]) |
if ( ! man_pwarn(m, line, i - 1, WTSPACE)) |
if ( ! man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE)) |
return(0); |
return(0); |
|
|
for (--i; i && ' ' == buf[i]; i--) |
for (--i; i && ' ' == buf[i]; i--) |
Line 414 man_ptext(struct man *m, int line, char *buf) |
|
Line 394 man_ptext(struct man *m, int line, char *buf) |
|
buf[i] = '\0'; |
buf[i] = '\0'; |
} |
} |
|
|
if ( ! man_word_alloc(m, line, 0, buf)) |
if ( ! man_word_alloc(m, line, offs, buf + offs)) |
return(0); |
return(0); |
|
|
/* |
/* |
Line 423 man_ptext(struct man *m, int line, char *buf) |
|
Line 403 man_ptext(struct man *m, int line, char *buf) |
|
* sentence. The front-end will know how to interpret this. |
* sentence. The front-end will know how to interpret this. |
*/ |
*/ |
|
|
/* FIXME: chain of close delims. */ |
|
|
|
assert(i); |
assert(i); |
|
if (mandoc_eos(buf, (size_t)i, 0)) |
if (mandoc_eos(buf, (size_t)i)) |
|
m->last->flags |= MAN_EOS; |
m->last->flags |= MAN_EOS; |
|
|
descope: |
descope: |
|
|
|
|
if (MAN_ELINE & m->flags) { |
if (MAN_ELINE & m->flags) { |
m->flags &= ~MAN_ELINE; |
m->flags &= ~MAN_ELINE; |
if ( ! man_unscope(m, m->last->parent, WERRMAX)) |
if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) |
return(0); |
return(0); |
} |
} |
|
|
|
|
return(1); |
return(1); |
m->flags &= ~MAN_BLINE; |
m->flags &= ~MAN_BLINE; |
|
|
if ( ! man_unscope(m, m->last->parent, WERRMAX)) |
if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) |
return(0); |
return(0); |
return(man_body_alloc(m, line, 0, m->last->tok)); |
return(man_body_alloc(m, line, offs, m->last->tok)); |
} |
} |
|
|
|
|
static int |
|
macrowarn(struct man *m, int ln, const char *buf) |
|
{ |
|
if ( ! (MAN_IGN_MACRO & m->pflags)) |
|
return(man_verr(m, ln, 0, "unknown macro: %s%s", |
|
buf, strlen(buf) > 3 ? "..." : "")); |
|
return(man_vwarn(m, ln, 0, "unknown macro: %s%s", |
|
buf, strlen(buf) > 3 ? "..." : "")); |
|
} |
|
|
|
|
|
int |
int |
man_pmacro(struct man *m, int ln, char *buf) |
man_pmacro(struct man *m, int ln, char *buf, int offs) |
{ |
{ |
int i, j, ppos; |
int i, j, ppos; |
enum mant tok; |
enum mant tok; |
Line 474 man_pmacro(struct man *m, int ln, char *buf) |
|
Line 440 man_pmacro(struct man *m, int ln, char *buf) |
|
|
|
/* Comments and empties are quickly ignored. */ |
/* Comments and empties are quickly ignored. */ |
|
|
if ('\0' == buf[1]) |
offs++; |
|
|
|
if ('\0' == buf[offs]) |
return(1); |
return(1); |
|
|
i = 1; |
i = offs; |
|
|
/* |
/* |
* Skip whitespace between the control character and initial |
* Skip whitespace between the control character and initial |
Line 494 man_pmacro(struct man *m, int ln, char *buf) |
|
Line 462 man_pmacro(struct man *m, int ln, char *buf) |
|
|
|
ppos = i; |
ppos = i; |
|
|
/* Copy the first word into a nil-terminated buffer. */ |
/* |
|
* Copy the first word into a nil-terminated buffer. |
|
* Stop copying when a tab, space, or eoln is encountered. |
|
*/ |
|
|
for (j = 0; j < 4; j++, i++) { |
j = 0; |
if ('\0' == (mac[j] = buf[i])) |
while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i]) |
break; |
mac[j++] = buf[i++]; |
else if (' ' == buf[i]) |
|
break; |
|
|
|
/* Check for invalid characters. */ |
|
|
|
if (isgraph((u_char)buf[i])) |
|
continue; |
|
return(man_perr(m, ln, i, WNPRINT)); |
|
} |
|
|
|
mac[j] = '\0'; |
mac[j] = '\0'; |
|
|
if (j == 4 || j < 1) { |
tok = (j > 0 && j < 4) ? man_hash_find(mac) : MAN_MAX; |
if ( ! (MAN_IGN_MACRO & m->pflags)) { |
if (MAN_MAX == tok) { |
(void)man_perr(m, ln, ppos, WMACROFORM); |
man_vmsg(m, MANDOCERR_MACRO, ln, ppos, |
goto err; |
"unknown macro: %s%s", |
} |
buf, strlen(buf) > 3 ? "..." : ""); |
if ( ! man_pwarn(m, ln, ppos, WMACROFORM)) |
|
goto err; |
|
return(1); |
return(1); |
} |
} |
|
|
if (MAN_MAX == (tok = man_hash_find(mac))) { |
|
if ( ! macrowarn(m, ln, mac)) |
|
goto err; |
|
return(1); |
|
} |
|
|
|
/* The macro is sane. Jump to the next word. */ |
/* The macro is sane. Jump to the next word. */ |
|
|
Line 538 man_pmacro(struct man *m, int ln, char *buf) |
|
Line 491 man_pmacro(struct man *m, int ln, char *buf) |
|
*/ |
*/ |
|
|
if ('\0' == buf[i] && ' ' == buf[i - 1]) |
if ('\0' == buf[i] && ' ' == buf[i - 1]) |
if ( ! man_pwarn(m, ln, i - 1, WTSPACE)) |
if ( ! man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) |
goto err; |
goto err; |
|
|
/* |
/* |
Line 560 man_pmacro(struct man *m, int ln, char *buf) |
|
Line 513 man_pmacro(struct man *m, int ln, char *buf) |
|
* I hate man macros. |
* I hate man macros. |
* Flat-out disallow this madness. |
* Flat-out disallow this madness. |
*/ |
*/ |
if (MAN_NSCOPED & man_macros[m->last->tok].flags) |
if (MAN_NSCOPED & man_macros[m->last->tok].flags) { |
return(man_perr(m, ln, ppos, WLNSCOPE)); |
man_pmsg(m, ln, ppos, MANDOCERR_SYNTLINESCOPE); |
|
return(0); |
|
} |
|
|
n = m->last; |
n = m->last; |
|
|
Line 569 man_pmacro(struct man *m, int ln, char *buf) |
|
Line 524 man_pmacro(struct man *m, int ln, char *buf) |
|
assert(NULL == n->child); |
assert(NULL == n->child); |
assert(0 == n->nchild); |
assert(0 == n->nchild); |
|
|
if ( ! man_nwarn(m, n, WLNSCOPE)) |
if ( ! man_nmsg(m, n, MANDOCERR_LINESCOPE)) |
return(0); |
return(0); |
|
|
man_node_delete(m, n); |
man_node_delete(m, n); |
|
|
assert(MAN_BLINE & m->flags); |
assert(MAN_BLINE & m->flags); |
m->flags &= ~MAN_BLINE; |
m->flags &= ~MAN_BLINE; |
|
|
if ( ! man_unscope(m, m->last->parent, WERRMAX)) |
if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) |
return(0); |
return(0); |
return(man_body_alloc(m, ln, 0, m->last->tok)); |
return(man_body_alloc(m, ln, offs, m->last->tok)); |
|
|
err: /* Error out. */ |
err: /* Error out. */ |
|
|
Line 638 err: /* Error out. */ |
|
Line 593 err: /* Error out. */ |
|
|
|
|
|
int |
int |
man_verr(struct man *man, int ln, int pos, const char *fmt, ...) |
man_vmsg(struct man *man, enum mandocerr t, |
|
int ln, int pos, const char *fmt, ...) |
{ |
{ |
char buf[256]; |
char buf[256]; |
va_list ap; |
va_list ap; |
|
|
if (NULL == man->cb.man_err) |
|
return(0); |
|
|
|
va_start(ap, fmt); |
va_start(ap, fmt); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
va_end(ap); |
va_end(ap); |
return((*man->cb.man_err)(man->data, ln, pos, buf)); |
return((*man->msg)(t, 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)); |
|
} |
} |
|
|
|
|