version 1.4, 2009/03/27 14:56:15 |
version 1.16, 2009/07/06 13:04:52 |
|
|
/* $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 "libmdoc.h" |
#include "libmdoc.h" |
|
|
/* |
|
* This has scanning/parsing routines, each of which extract a macro and |
|
* its arguments and parameters, then know how to progress to the next |
|
* macro. |
|
*/ |
|
|
|
/* FIXME: .Fl, .Ar, .Cd handling of `|'. */ |
|
|
|
enum mwarn { |
|
WIGNE, |
|
WIMPBRK, |
|
WMACPARM, |
|
WOBS |
|
}; |
|
|
|
enum merr { |
|
EOPEN, |
|
EQUOT, |
|
ENOCTX, |
|
ENOPARMS |
|
}; |
|
|
|
#define REWIND_REWIND (1 << 0) |
#define REWIND_REWIND (1 << 0) |
#define REWIND_NOHALT (1 << 1) |
#define REWIND_NOHALT (1 << 1) |
#define REWIND_HALT (1 << 2) |
#define REWIND_HALT (1 << 2) |
Line 72 static int rew_subblock(enum mdoc_type, |
|
Line 48 static int rew_subblock(enum mdoc_type, |
|
static int rew_last(struct mdoc *, struct mdoc_node *); |
static int rew_last(struct mdoc *, struct mdoc_node *); |
static int append_delims(struct mdoc *, int, int *, char *); |
static int append_delims(struct mdoc *, int, int *, char *); |
static int lookup(struct mdoc *, int, int, int, const char *); |
static int lookup(struct mdoc *, int, int, int, const char *); |
static int pwarn(struct mdoc *, int, int, enum mwarn); |
|
static int perr(struct mdoc *, int, int, enum merr); |
|
static int swarn(struct mdoc *, enum mdoc_type, int, int, |
static int swarn(struct mdoc *, enum mdoc_type, int, int, |
const struct mdoc_node *); |
const struct mdoc_node *); |
|
|
#define nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t)) |
|
|
|
/* Central table of library: who gets parsed how. */ |
/* Central table of library: who gets parsed how. */ |
|
|
const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
{ NULL, 0 }, /* \" */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ |
{ in_line_eoln, MDOC_PROLOGUE }, /* Dd */ |
{ in_line_eoln, MDOC_PROLOGUE }, /* Dd */ |
{ in_line_eoln, MDOC_PROLOGUE }, /* Dt */ |
{ in_line_eoln, MDOC_PROLOGUE }, /* Dt */ |
{ in_line_eoln, MDOC_PROLOGUE }, /* Os */ |
{ in_line_eoln, MDOC_PROLOGUE }, /* Os */ |
Line 97 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
Line 69 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
{ blk_exp_close, MDOC_EXPLICIT }, /* El */ |
{ blk_exp_close, MDOC_EXPLICIT }, /* El */ |
{ blk_full, MDOC_PARSED }, /* It */ |
{ blk_full, MDOC_PARSED }, /* It */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ |
{ in_line, MDOC_PARSED }, /* An */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ |
{ in_line_eoln, MDOC_CALLABLE }, /* Cd */ |
{ in_line_eoln, MDOC_CALLABLE }, /* Cd */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ |
Line 109 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
Line 81 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
{ in_line_eoln, 0 }, /* Fd */ |
{ in_line_eoln, 0 }, /* Fd */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ |
{ in_line, MDOC_PARSED }, /* Ft */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ |
{ in_line_eoln, 0 }, /* In */ |
{ in_line_eoln, 0 }, /* In */ /* FIXME: historic usage! */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ |
{ in_line_eoln, 0 }, /* Nd */ |
{ in_line_eoln, 0 }, /* Nd */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ |
Line 153 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
Line 125 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ |
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ |
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */ |
{ in_line, MDOC_PARSED }, /* Ms */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */ |
Line 189 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
Line 161 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { |
|
{ obsolete, 0 }, /* Fr */ |
{ obsolete, 0 }, /* Fr */ |
{ in_line_eoln, 0 }, /* Ud */ |
{ in_line_eoln, 0 }, /* Ud */ |
{ in_line_eoln, 0 }, /* Lb */ |
{ in_line_eoln, 0 }, /* Lb */ |
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ |
|
{ in_line, 0 }, /* Lp */ |
{ in_line, 0 }, /* Lp */ |
{ in_line, MDOC_PARSED }, /* Lk */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */ |
{ in_line, MDOC_PARSED }, /* Mt */ |
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */ |
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */ |
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */ |
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */ |
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */ |
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */ |
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */ |
Line 207 const struct mdoc_macro * const mdoc_macros = __mdoc_m |
|
Line 178 const struct mdoc_macro * const mdoc_macros = __mdoc_m |
|
|
|
|
|
static int |
static int |
perr(struct mdoc *mdoc, int line, int pos, enum merr type) |
|
{ |
|
char *p; |
|
|
|
p = NULL; |
|
switch (type) { |
|
case (EOPEN): |
|
p = "explicit scope still open on exit"; |
|
break; |
|
case (EQUOT): |
|
p = "unterminated quotation"; |
|
break; |
|
case (ENOCTX): |
|
p = "closure has no prior context"; |
|
break; |
|
case (ENOPARMS): |
|
p = "unexpect line arguments"; |
|
break; |
|
} |
|
assert(p); |
|
return(mdoc_perr(mdoc, line, pos, p)); |
|
} |
|
|
|
|
|
static int |
|
pwarn(struct mdoc *mdoc, int line, int pos, enum mwarn type) |
|
{ |
|
char *p; |
|
|
|
p = NULL; |
|
switch (type) { |
|
case (WIGNE): |
|
p = "ignoring empty element"; |
|
break; |
|
case (WIMPBRK): |
|
p = "crufty end-of-line scope violation"; |
|
break; |
|
case (WMACPARM): |
|
p = "macro-like parameter"; |
|
break; |
|
case (WOBS): |
|
p = "macro marked obsolete"; |
|
break; |
|
} |
|
assert(p); |
|
return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, p)); |
|
} |
|
|
|
|
|
static int |
|
swarn(struct mdoc *mdoc, enum mdoc_type type, |
swarn(struct mdoc *mdoc, enum mdoc_type type, |
int line, int pos, const struct mdoc_node *p) |
int line, int pos, const struct mdoc_node *p) |
{ |
{ |
Line 294 swarn(struct mdoc *mdoc, enum mdoc_type type, |
|
Line 215 swarn(struct mdoc *mdoc, enum mdoc_type type, |
|
} |
} |
|
|
if ( ! (MDOC_IGN_SCOPE & mdoc->pflags)) |
if ( ! (MDOC_IGN_SCOPE & mdoc->pflags)) |
return(mdoc_perr(mdoc, line, pos, |
return(mdoc_verr(mdoc, line, pos, |
"%s scope breaks %s scope of %s", |
"%s scope breaks %s scope of %s", |
tt, t, n)); |
tt, t, n)); |
return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, |
return(mdoc_vwarn(mdoc, line, pos, |
"%s scope breaks %s scope of %s", |
"%s scope breaks %s scope of %s", |
tt, t, n)); |
tt, t, n)); |
} |
} |
Line 323 mdoc_macroend(struct mdoc *mdoc) |
|
Line 244 mdoc_macroend(struct mdoc *mdoc) |
|
continue; |
continue; |
if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) |
if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) |
continue; |
continue; |
return(nerr(mdoc, n, EOPEN)); |
return(mdoc_nerr(mdoc, n, EOPEN)); |
} |
} |
|
|
return(rew_last(mdoc, mdoc->first)); |
return(rew_last(mdoc, mdoc->first)); |
Line 334 lookup(struct mdoc *mdoc, int line, int pos, int from, |
|
Line 255 lookup(struct mdoc *mdoc, int line, int pos, int from, |
|
{ |
{ |
int res; |
int res; |
|
|
res = mdoc_tokhash_find(mdoc->htab, p); |
res = mdoc_hash_find(mdoc->htab, p); |
if (MDOC_PARSED & mdoc_macros[from].flags) |
if (MDOC_PARSED & mdoc_macros[from].flags) |
return(res); |
return(res); |
if (MDOC_MAX == res) |
if (MDOC_MAX == res) |
return(res); |
return(res); |
if ( ! pwarn(mdoc, line, pos, WMACPARM)) |
if ( ! mdoc_pwarn(mdoc, line, pos, EMACPARM)) |
return(-1); |
return(-1); |
return(MDOC_MAX); |
return(MDOC_MAX); |
} |
} |
Line 648 rew_expblock(struct mdoc *mdoc, int tok, int line, int |
|
Line 569 rew_expblock(struct mdoc *mdoc, int tok, int line, int |
|
for (n = mdoc->last; n; n = n->parent) { |
for (n = mdoc->last; n; n = n->parent) { |
c = rew_dohalt(tok, MDOC_BLOCK, n); |
c = rew_dohalt(tok, MDOC_BLOCK, n); |
if (REWIND_HALT == c) |
if (REWIND_HALT == c) |
return(perr(mdoc, line, ppos, ENOCTX)); |
return(mdoc_perr(mdoc, line, ppos, ENOCTX)); |
if (REWIND_REWIND == c) |
if (REWIND_REWIND == c) |
break; |
break; |
else if (rew_dobreak(tok, n)) |
else if (rew_dobreak(tok, n)) |
Line 739 blk_exp_close(MACRO_PROT_ARGS) |
|
Line 660 blk_exp_close(MACRO_PROT_ARGS) |
|
return(0); |
return(0); |
return(rew_expblock(mdoc, tok, line, ppos)); |
return(rew_expblock(mdoc, tok, line, ppos)); |
} |
} |
return(perr(mdoc, line, ppos, ENOPARMS)); |
return(mdoc_perr(mdoc, line, ppos, ENOPARMS)); |
} |
} |
|
|
if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) |
if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) |
Line 821 in_line(MACRO_PROT_ARGS) |
|
Line 742 in_line(MACRO_PROT_ARGS) |
|
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (MDOC_Fl): |
case (MDOC_Fl): |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
|
case (MDOC_Lk): |
|
/* FALLTHROUGH */ |
case (MDOC_Ar): |
case (MDOC_Ar): |
nc = 1; |
nc = 1; |
break; |
break; |
Line 876 in_line(MACRO_PROT_ARGS) |
|
Line 799 in_line(MACRO_PROT_ARGS) |
|
if ( ! mdoc_elem_alloc(mdoc, line, ppos, |
if ( ! mdoc_elem_alloc(mdoc, line, ppos, |
tok, arg)) |
tok, arg)) |
return(0); |
return(0); |
mdoc->next = MDOC_NEXT_SIBLING; |
if ( ! rew_last(mdoc, mdoc->last)) |
} else if ( ! nc && 0 == cnt) |
|
if ( ! pwarn(mdoc, line, ppos, WIGNE)) |
|
return(0); |
return(0); |
|
} else if ( ! nc && 0 == cnt) { |
|
mdoc_argv_free(arg); |
|
if ( ! mdoc_pwarn(mdoc, line, ppos, EIGNE)) |
|
return(0); |
|
} |
c = mdoc_macro(mdoc, c, line, la, pos, buf); |
c = mdoc_macro(mdoc, c, line, la, pos, buf); |
if (0 == c) |
if (0 == c) |
return(0); |
return(0); |
Line 929 in_line(MACRO_PROT_ARGS) |
|
Line 855 in_line(MACRO_PROT_ARGS) |
|
c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); |
c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); |
if (0 == c) |
if (0 == c) |
return(0); |
return(0); |
mdoc->next = MDOC_NEXT_SIBLING; |
if ( ! rew_last(mdoc, mdoc->last)) |
} else if ( ! nc && 0 == cnt) |
|
if ( ! pwarn(mdoc, line, ppos, WIGNE)) |
|
return(0); |
return(0); |
|
} else if ( ! nc && 0 == cnt) { |
|
mdoc_argv_free(arg); |
|
if ( ! mdoc_pwarn(mdoc, line, ppos, EIGNE)) |
|
return(0); |
|
} |
|
|
if (ppos > 1) |
if (ppos > 1) |
return(1); |
return(1); |
Line 1114 blk_part_imp(MACRO_PROT_ARGS) |
|
Line 1043 blk_part_imp(MACRO_PROT_ARGS) |
|
if (body == n) |
if (body == n) |
break; |
break; |
|
|
if (NULL == n && ! pwarn(mdoc, body->line, body->pos, WIMPBRK)) |
if (NULL == n && ! mdoc_nwarn(mdoc, body, EIMPBRK)) |
return(0); |
return(0); |
|
|
if (n && ! rew_last(mdoc, body)) |
if (n && ! rew_last(mdoc, body)) |
|
|
obsolete(MACRO_PROT_ARGS) |
obsolete(MACRO_PROT_ARGS) |
{ |
{ |
|
|
return(pwarn(mdoc, line, ppos, WOBS)); |
return(mdoc_pwarn(mdoc, line, ppos, EOBS)); |
} |
} |
|
|
|
|
Line 1453 phrase(struct mdoc *mdoc, int line, int ppos, char *bu |
|
Line 1382 phrase(struct mdoc *mdoc, int line, int ppos, char *bu |
|
else if ('\\' != buf[i - 1]) |
else if ('\\' != buf[i - 1]) |
break; |
break; |
if (0 == buf[i]) |
if (0 == buf[i]) |
return(perr(mdoc, line, la, EQUOT)); |
return(mdoc_perr(mdoc, line, la, EQUOT)); |
quoted = 1; |
quoted = 1; |
} else |
} else |
for ( ; buf[i]; i++) |
for ( ; buf[i]; i++) |
Line 1479 phrase(struct mdoc *mdoc, int line, int ppos, char *bu |
|
Line 1408 phrase(struct mdoc *mdoc, int line, int ppos, char *bu |
|
*/ |
*/ |
|
|
c = quoted ? MDOC_MAX : |
c = quoted ? MDOC_MAX : |
mdoc_tokhash_find(mdoc->htab, &buf[la]); |
mdoc_hash_find(mdoc->htab, &buf[la]); |
|
|
if (MDOC_MAX != c) { |
if (MDOC_MAX != c) { |
if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) |
if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) |