diff options
| -rw-r--r-- | action.c | 1 | ||||
| -rw-r--r-- | mdoc.c | 24 | ||||
| -rw-r--r-- | mdoc.h | 2 | ||||
| -rw-r--r-- | private.h | 1 | ||||
| -rw-r--r-- | term.c | 13 | ||||
| -rw-r--r-- | termact.c | 269 | ||||
| -rw-r--r-- | validate.c | 416 |
7 files changed, 508 insertions, 218 deletions
@@ -194,6 +194,7 @@ post_sh(struct mdoc *mdoc) if (xstrlcats(buf, mdoc->last->child, 64)) { if (SEC_CUSTOM != (sec = mdoc_atosec(buf))) mdoc->lastnamed = sec; + mdoc->lastsec = sec; return(1); } @@ -212,7 +212,7 @@ static void argfree(size_t, struct mdoc_arg *); static void argcpy(struct mdoc_arg *, const struct mdoc_arg *); -static struct mdoc_node *mdoc_node_alloc(void); +static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); static int mdoc_node_append(struct mdoc *, struct mdoc_node *); static void mdoc_elem_free(struct mdoc_elem *); @@ -513,10 +513,14 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p) static struct mdoc_node * -mdoc_node_alloc(void) +mdoc_node_alloc(const struct mdoc *mdoc) { + struct mdoc_node *p; + + p = xcalloc(1, sizeof(struct mdoc_node)); + p->sec = mdoc->lastsec; - return(xcalloc(1, sizeof(struct mdoc_node))); + return(p); } @@ -528,7 +532,7 @@ mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok) assert(mdoc->first); assert(mdoc->last); - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->line = line; p->pos = pos; @@ -547,7 +551,7 @@ mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok) assert(mdoc->first); assert(mdoc->last); - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->line = line; p->pos = pos; @@ -566,7 +570,7 @@ mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok) assert(mdoc->first); assert(mdoc->last); - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->line = line; p->pos = pos; @@ -582,7 +586,7 @@ mdoc_root_alloc(struct mdoc *mdoc) { struct mdoc_node *p; - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->type = MDOC_ROOT; @@ -596,7 +600,7 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, { struct mdoc_node *p; - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->pos = pos; p->line = line; @@ -615,7 +619,7 @@ mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, { struct mdoc_node *p; - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->line = line; p->pos = pos; @@ -634,7 +638,7 @@ mdoc_word_alloc(struct mdoc *mdoc, { struct mdoc_node *p; - p = mdoc_node_alloc(); + p = mdoc_node_alloc(mdoc); p->line = line; p->pos = pos; @@ -382,7 +382,7 @@ struct mdoc_node { #define MDOC_ACTED (1 << 1) enum mdoc_type type; union mdoc_data data; - /* FIXME: have an enum mdoc_sec. */ + enum mdoc_sec sec; }; /* Call-backs for parse messages. */ @@ -38,6 +38,7 @@ struct mdoc { struct mdoc_node *first; struct mdoc_meta meta; enum mdoc_sec lastnamed; + enum mdoc_sec lastsec; }; @@ -24,6 +24,10 @@ #include <string.h> #include <unistd.h> +#ifdef __linux__ +#include <time.h> +#endif + #include "term.h" enum termstyle { @@ -46,6 +50,10 @@ static void pescape(struct termp *, static void chara(struct termp *, char); static void style(struct termp *, enum termstyle); +#ifdef __linux__ +extern size_t strlcat(char *, const char *, size_t); +extern size_t strlcpy(char *, const char *, size_t); +#endif void flushln(struct termp *p) @@ -363,7 +371,12 @@ termprint_footer(struct termp *p, const struct mdoc_meta *meta) err(1, "malloc"); tm = localtime(&meta->date); + +#ifdef __linux__ + if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) +#else if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm)) +#endif err(1, "strftime"); osz = strlcpy(os, meta->os, p->rmargin); @@ -22,11 +22,24 @@ #include "term.h" +#define INDENT 4 + +/* + * Performs actions on nodes of the abstract syntax tree. Both pre- and + * post-fix operations are defined here. + */ + #define TTYPE_PROG 0 #define TTYPE_CMD_FLAG 1 #define TTYPE_CMD_ARG 2 #define TTYPE_SECTION 3 -#define TTYPE_NMAX 4 +#define TTYPE_FUNC_DECL 4 +#define TTYPE_VAR_DECL 5 +#define TTYPE_FUNC_TYPE 6 +#define TTYPE_FUNC_NAME 7 +#define TTYPE_FUNC_ARG 8 +#define TTYPE_LINK 9 +#define TTYPE_NMAX 10 /* * These define "styles" for element types, like command arguments or @@ -38,13 +51,20 @@ const int ttypes[TTYPE_NMAX] = { TERMP_BOLD, /* TTYPE_PROG */ TERMP_BOLD, /* TTYPE_CMD_FLAG */ TERMP_UNDERLINE, /* TTYPE_CMD_ARG */ - TERMP_BOLD /* TTYPE_SECTION */ + TERMP_BOLD, /* TTYPE_SECTION */ + TERMP_BOLD, /* TTYPE_FUNC_DECL */ + TERMP_UNDERLINE, /* TTYPE_VAR_DECL */ + TERMP_UNDERLINE, /* TTYPE_FUNC_TYPE */ + TERMP_BOLD, /* TTYPE_FUNC_NAME */ + TERMP_UNDERLINE, /* TTYPE_FUNC_ARG */ + TERMP_UNDERLINE /* TTYPE_LINK */ }; static int arg_hasattr(int, size_t, const struct mdoc_arg *); static int arg_getattr(int, size_t, const struct mdoc_arg *); +static size_t arg_offset(const char *); /* * What follows describes prefix and postfix operations for the abstract @@ -66,7 +86,11 @@ DECL_PRE(termp_ar); DECL_PRE(termp_d1); DECL_PRE(termp_dq); DECL_PRE(termp_ex); +DECL_PRE(termp_fa); +DECL_PRE(termp_fd); DECL_PRE(termp_fl); +DECL_PRE(termp_fn); +DECL_PRE(termp_ft); DECL_PRE(termp_it); DECL_PRE(termp_nd); DECL_PRE(termp_nm); @@ -74,7 +98,9 @@ DECL_PRE(termp_ns); DECL_PRE(termp_op); DECL_PRE(termp_pp); DECL_PRE(termp_sh); +DECL_PRE(termp_sx); DECL_PRE(termp_ud); +DECL_PRE(termp_vt); DECL_PRE(termp_xr); DECL_POST(termp_aq); @@ -82,11 +108,17 @@ DECL_POST(termp_ar); DECL_POST(termp_bl); DECL_POST(termp_d1); DECL_POST(termp_dq); +DECL_POST(termp_fa); +DECL_POST(termp_fd); DECL_POST(termp_fl); +DECL_POST(termp_fn); +DECL_POST(termp_ft); DECL_POST(termp_it); DECL_POST(termp_nm); DECL_POST(termp_op); DECL_POST(termp_sh); +DECL_POST(termp_sx); +DECL_POST(termp_vt); const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* \" */ @@ -112,11 +144,11 @@ const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* Er */ { NULL, NULL }, /* Ev */ { termp_ex_pre, NULL }, /* Ex */ - { NULL, NULL }, /* Fa */ - { NULL, NULL }, /* Fd */ + { termp_fa_pre, termp_fa_post }, /* Fa */ + { termp_fd_pre, termp_fd_post }, /* Fd */ { termp_fl_pre, termp_fl_post }, /* Fl */ - { NULL, NULL }, /* Fn */ - { NULL, NULL }, /* Ft */ + { termp_fn_pre, termp_fn_post }, /* Fn */ + { termp_ft_pre, termp_ft_post }, /* Ft */ { NULL, NULL }, /* Ic */ { NULL, NULL }, /* In */ { NULL, NULL }, /* Li */ @@ -128,7 +160,7 @@ const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* Rv */ { NULL, NULL }, /* St */ { NULL, NULL }, /* Va */ - { NULL, NULL }, /* Vt */ + { termp_vt_pre, termp_vt_post }, /* Vt */ { termp_xr_pre, NULL }, /* Xr */ { NULL, NULL }, /* %A */ { NULL, NULL }, /* %B */ @@ -179,7 +211,7 @@ const struct termact __termacts[MDOC_MAX] = { { NULL, NULL }, /* So */ { NULL, NULL }, /* Sq */ { NULL, NULL }, /* Sm */ - { NULL, NULL }, /* Sx */ + { termp_sx_pre, termp_sx_post }, /* Sx */ { NULL, NULL }, /* Sy */ { NULL, NULL }, /* Tn */ { NULL, NULL }, /* Ux */ @@ -200,6 +232,39 @@ const struct termact __termacts[MDOC_MAX] = { const struct termact *termacts = __termacts; +static size_t +arg_offset(const char *v) +{ + if (0 == strcmp(v, "indent")) + return(INDENT); + if (0 == strcmp(v, "indent-two")) + return(INDENT * 2); + + /* TODO */ + return(0); +} + + +static int +arg_hasattr(int arg, size_t argc, const struct mdoc_arg *argv) +{ + + return(-1 != arg_getattr(arg, argc, argv)); +} + + +static int +arg_getattr(int arg, size_t argc, const struct mdoc_arg *argv) +{ + int i; + + for (i = 0; i < (int)argc; i++) + if (argv[i].arg == arg) + return(i); + return(-1); +} + + /* ARGSUSED */ static int termp_dq_pre(DECL_ARGS) @@ -280,6 +345,18 @@ termp_it_post(DECL_ARGS) p->offset -= width + 1; p->flags &= ~TERMP_NOLPAD; } + return; + } + + if (arg_hasattr(MDOC_Ohang, bl->argc, bl->argv)) { + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + assert(i >= 0); + assert(1 == bl->argv[i].sz); + width = arg_offset(*bl->argv[i].value); + + flushln(p); + p->offset -= width + 1; + return; } } @@ -351,6 +428,20 @@ termp_it_pre(DECL_ARGS) p->flags |= TERMP_NOLPAD; p->offset += width + 1; } + return(1); + } + + /* If `-ohang', adjust left-margin. */ + + if (arg_hasattr(MDOC_Ohang, bl->argc, bl->argv)) { + i = arg_getattr(MDOC_Offset, bl->argc, bl->argv); + assert(i >= 0); + assert(1 == bl->argv[i].sz); + width = arg_offset(*bl->argv[i].value); + + p->flags |= TERMP_NOSPACE; + p->offset += width + 1; + return(1); } return(1); @@ -492,7 +583,7 @@ termp_sh_post(DECL_ARGS) break; case (MDOC_BODY): newln(p); - p->offset -= 4; + p->offset -= INDENT; break; default: break; @@ -529,6 +620,54 @@ termp_xr_pre(DECL_ARGS) /* ARGSUSED */ static int +termp_vt_pre(DECL_ARGS) +{ + + /* FIXME: this can be "type name". */ + p->flags |= ttypes[TTYPE_VAR_DECL]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_vt_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_VAR_DECL]; + if (node->sec == SEC_SYNOPSIS) + vspace(p); +} + + +/* ARGSUSED */ +static int +termp_fd_pre(DECL_ARGS) +{ + + /* + * FIXME: this naming is bad. This value is used, in general, + * for the #include header or other preprocessor statement. + */ + p->flags |= ttypes[TTYPE_FUNC_DECL]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_fd_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_FUNC_DECL]; + if (node->sec == SEC_SYNOPSIS) + vspace(p); + +} + + +/* ARGSUSED */ +static int termp_sh_pre(DECL_ARGS) { @@ -538,7 +677,7 @@ termp_sh_pre(DECL_ARGS) p->flags |= ttypes[TTYPE_SECTION]; break; case (MDOC_BODY): - p->offset += 4; + p->offset += INDENT; break; default: break; @@ -594,7 +733,7 @@ termp_d1_pre(DECL_ARGS) if (MDOC_BODY != node->type) return(1); newln(p); - p->offset += 4; + p->offset += INDENT; return(1); } @@ -607,7 +746,7 @@ termp_d1_post(DECL_ARGS) if (MDOC_BODY != node->type) return; newln(p); - p->offset -= 4; + p->offset -= INDENT; } @@ -636,22 +775,112 @@ termp_aq_post(DECL_ARGS) } +/* ARGSUSED */ static int -arg_hasattr(int arg, size_t argc, const struct mdoc_arg *argv) +termp_ft_pre(DECL_ARGS) { - return(-1 != arg_getattr(arg, argc, argv)); + p->flags |= ttypes[TTYPE_FUNC_TYPE]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_ft_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_FUNC_TYPE]; + if (node->sec == SEC_SYNOPSIS) + newln(p); + } +/* ARGSUSED */ static int -arg_getattr(int arg, size_t argc, const struct mdoc_arg *argv) +termp_fn_pre(DECL_ARGS) { - int i; + const struct mdoc_node *n; - for (i = 0; i < (int)argc; i++) - if (argv[i].arg == arg) - return(i); - return(-1); + assert(node->child); + assert(MDOC_TEXT == node->child->type); + + /* FIXME: can be "type funcname" "type varname"... */ + + p->flags |= ttypes[TTYPE_FUNC_NAME]; + word(p, node->child->data.text.string); + p->flags &= ~ttypes[TTYPE_FUNC_NAME]; + + p->flags |= TERMP_NOSPACE; + word(p, "("); + + p->flags |= TERMP_NOSPACE; + for (n = node->child->next; n; n = n->next) { + assert(MDOC_TEXT == n->type); + p->flags |= ttypes[TTYPE_FUNC_ARG]; + word(p, n->data.text.string); + p->flags &= ~ttypes[TTYPE_FUNC_ARG]; + if ((n->next)) + word(p, ","); + } + + p->flags |= TERMP_NOSPACE; + word(p, ")"); + + if (SEC_SYNOPSIS == node->sec) + word(p, ";"); + + return(0); } + +/* ARGSUSED */ +static void +termp_fn_post(DECL_ARGS) +{ + + if (node->sec == SEC_SYNOPSIS) + vspace(p); + +} + + +/* ARGSUSED */ +static int +termp_sx_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_LINK]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_sx_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_LINK]; +} + + +/* ARGSUSED */ +static int +termp_fa_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_FUNC_ARG]; + return(1); +} + + +/* ARGSUSED */ +static void +termp_fa_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_FUNC_ARG]; +} + + @@ -34,9 +34,10 @@ typedef int (*v_post)(struct mdoc *); /* FIXME: some sections should only occur in specific msecs. */ /* FIXME: ignoring Pp. */ +/* FIXME: .Ef arguments */ /* FIXME: math symbols. */ -/* FIXME: valid character-escape checks!!!! */ -/* FIXME: make sure required sections are included (NAME, ...). */ +/* FIXME: valid character-escape checks. */ +/* FIXME: .Fd only in synopsis section. */ struct valids { v_pre *pre; @@ -45,17 +46,24 @@ struct valids { /* Utility checks. */ -static int pre_check_parent(struct mdoc *, struct mdoc_node *, +static int check_parent(struct mdoc *, struct mdoc_node *, int, enum mdoc_type); -static int pre_check_msecs(struct mdoc *, struct mdoc_node *, +static int check_msec(struct mdoc *, struct mdoc_node *, int, enum mdoc_msec *); -static int pre_check_stdarg(struct mdoc *, struct mdoc_node *); -static int post_check_children_count(struct mdoc *); -static int post_check_children_lt(struct mdoc *, const char *, int); -static int post_check_children_gt(struct mdoc *, const char *, int); -static int post_check_children_wgt(struct mdoc *, const char *, int); -static int post_check_children_eq(struct mdoc *, const char *, int); -static int post_check_children_weq(struct mdoc *, const char *, int); +static int check_stdarg(struct mdoc *, struct mdoc_node *); +static int err_child_lt(struct mdoc *, const char *, int); +static int err_child_gt(struct mdoc *, const char *, int); +static int warn_child_gt(struct mdoc *, const char *, int); +static int err_child_eq(struct mdoc *, const char *, int); +static int warn_child_eq(struct mdoc *, const char *, int); + +/* Utility auxiliaries. */ + +static inline int count_child(struct mdoc *); +static inline int warn_count(struct mdoc *, const char *, + int, const char *, int); +static inline int err_count(struct mdoc *, const char *, + int, const char *, int); /* Specific pre-child-parse routines. */ @@ -146,121 +154,140 @@ static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL }; /* Per-macro pre- and post-child-check routine collections. */ const struct valids mdoc_valids[MDOC_MAX] = { - { NULL, NULL }, /* \" */ - { pres_prologue, posts_text }, /* Dd */ - { pres_prologue, NULL }, /* Dt */ - { pres_prologue, NULL }, /* Os */ - { pres_sh, posts_sh }, /* Sh */ - { pres_ss, posts_ss }, /* Ss */ - { NULL, posts_pp }, /* Pp */ - { pres_d1, posts_wline }, /* D1 */ - { pres_d1, posts_wline }, /* Dl */ - { pres_bd, posts_bd }, /* Bd */ - { NULL, NULL }, /* Ed */ - { pres_bl, posts_bl }, /* Bl */ - { NULL, NULL }, /* El */ - { pres_it, posts_it }, /* It */ - { NULL, posts_text }, /* Ad */ - { pres_an, posts_an }, /* An */ - { NULL, NULL }, /* Ar */ - { pres_cd, posts_text }, /* Cd */ - { NULL, NULL }, /* Cm */ - { NULL, posts_text }, /* Dv */ - { pres_er, posts_text }, /* Er */ - { NULL, posts_text }, /* Ev */ - { pres_ex, posts_ex }, /* Ex */ - { NULL, posts_text }, /* Fa */ - /* FIXME: only in SYNOPSIS section. */ - { NULL, posts_wtext }, /* Fd */ - { NULL, NULL }, /* Fl */ - { NULL, posts_text }, /* Fn */ - { NULL, posts_wtext }, /* Ft */ - { NULL, posts_text }, /* Ic */ - { NULL, posts_in }, /* In */ - { NULL, posts_text }, /* Li */ - { NULL, posts_wtext }, /* Nd */ - { NULL, posts_nm }, /* Nm */ - { NULL, posts_wline }, /* Op */ - { NULL, NULL }, /* Ot */ - { NULL, NULL }, /* Pa */ - { pres_rv, posts_notext }, /* Rv */ - { pres_st, posts_notext }, /* St */ - { NULL, posts_text }, /* Va */ - { NULL, posts_text }, /* Vt */ - { NULL, posts_xr }, /* Xr */ - { NULL, posts_text }, /* %A */ - { NULL, posts_text }, /* %B */ - { NULL, posts_text }, /* %D */ - { NULL, posts_text }, /* %I */ - { NULL, posts_text }, /* %J */ - { NULL, posts_text }, /* %N */ - { NULL, posts_text }, /* %O */ - { NULL, posts_text }, /* %P */ - { NULL, posts_text }, /* %R */ - { NULL, posts_text }, /* %T */ - { NULL, posts_text }, /* %V */ - { NULL, NULL }, /* Ac */ - { NULL, NULL }, /* Ao */ - { NULL, posts_wline }, /* Aq */ - { NULL, posts_at }, /* At */ - { NULL, NULL }, /* Bc */ - { NULL, posts_bf }, /* Bf */ - { NULL, NULL }, /* Bo */ - { NULL, posts_wline }, /* Bq */ - { NULL, NULL }, /* Bsx */ - { NULL, NULL }, /* Bx */ - { NULL, posts_bool }, /* Db */ - { NULL, NULL }, /* Dc */ - { NULL, NULL }, /* Do */ - { NULL, posts_wline }, /* Dq */ - { NULL, NULL }, /* Ec */ - { NULL, NULL }, /* Ef */ /* -symbolic, etc. */ - { NULL, posts_text }, /* Em */ - { NULL, NULL }, /* Eo */ - { NULL, NULL }, /* Fx */ - { NULL, posts_text }, /* Ms */ - { NULL, posts_notext }, /* No */ - { NULL, posts_notext }, /* Ns */ - { NULL, NULL }, /* Nx */ - { NULL, NULL }, /* Ox */ - { NULL, NULL }, /* Pc */ - { NULL, NULL }, /* Pf */ - { NULL, NULL }, /* Po */ - { NULL, posts_wline }, /* Pq */ - { NULL, NULL }, /* Qc */ - { NULL, posts_wline }, /* Ql */ - { NULL, NULL }, /* Qo */ - { NULL, posts_wline }, /* Qq */ - { NULL, NULL }, /* Re */ - { NULL, posts_rs }, /* Rs */ - { NULL, NULL }, /* Sc */ - { NULL, NULL }, /* So */ - { NULL, posts_wline }, /* Sq */ - { NULL, posts_bool }, /* Sm */ - { NULL, posts_text }, /* Sx */ - { NULL, posts_text }, /* Sy */ - { NULL, posts_text }, /* Tn */ - { NULL, NULL }, /* Ux */ - { NULL, NULL }, /* Xc */ - { NULL, NULL }, /* Xo */ - { NULL, posts_fo }, /* Fo */ - { NULL, NULL }, /* Fc */ - { NULL, NULL }, /* Oo */ - { NULL, NULL }, /* Oc */ - { NULL, posts_bk }, /* Bk */ - { NULL, NULL }, /* Ek */ - { NULL, posts_notext }, /* Bt */ - { NULL, NULL }, /* Hf */ - { NULL, NULL }, /* Fr */ - { NULL, posts_notext }, /* Ud */ + { NULL, NULL }, /* \" */ + { pres_prologue, posts_text }, /* Dd */ + { pres_prologue, NULL }, /* Dt */ + { pres_prologue, NULL }, /* Os */ + { pres_sh, posts_sh }, /* Sh */ + { pres_ss, posts_ss }, /* Ss */ + { NULL, posts_pp }, /* Pp */ + { pres_d1, posts_wline }, /* D1 */ + { pres_d1, posts_wline }, /* Dl */ + { pres_bd, posts_bd }, /* Bd */ + { NULL, NULL }, /* Ed */ + { pres_bl, posts_bl }, /* Bl */ + { NULL, NULL }, /* El */ + { pres_it, posts_it }, /* It */ + { NULL, posts_text }, /* Ad */ + { pres_an, posts_an }, /* An */ + { NULL, NULL }, /* Ar */ + { pres_cd, posts_text }, /* Cd */ + { NULL, NULL }, /* Cm */ + { NULL, posts_text }, /* Dv */ + { pres_er, posts_text }, /* Er */ + { NULL, posts_text }, /* Ev */ + { pres_ex, posts_ex }, /* Ex */ + { NULL, posts_text }, /* Fa */ + { NULL, posts_wtext }, /* Fd */ + { NULL, NULL }, /* Fl */ + { NULL, posts_text }, /* Fn */ + { NULL, posts_wtext }, /* Ft */ + { NULL, posts_text }, /* Ic */ + { NULL, posts_in }, /* In */ + { NULL, posts_text }, /* Li */ + { NULL, posts_wtext }, /* Nd */ + { NULL, posts_nm }, /* Nm */ + { NULL, posts_wline }, /* Op */ + { NULL, NULL }, /* Ot */ + { NULL, NULL }, /* Pa */ + { pres_rv, posts_notext }, /* Rv */ + { pres_st, posts_notext }, /* St */ + { NULL, posts_text }, /* Va */ + { NULL, posts_text }, /* Vt */ + { NULL, posts_xr }, /* Xr */ + { NULL, posts_text }, /* %A */ + { NULL, posts_text }, /* %B */ + { NULL, posts_text }, /* %D */ + { NULL, posts_text }, /* %I */ + { NULL, posts_text }, /* %J */ + { NULL, posts_text }, /* %N */ + { NULL, posts_text }, /* %O */ + { NULL, posts_text }, /* %P */ + { NULL, posts_text }, /* %R */ + { NULL, posts_text }, /* %T */ + { NULL, posts_text }, /* %V */ + { NULL, NULL }, /* Ac */ + { NULL, NULL }, /* Ao */ + { NULL, posts_wline }, /* Aq */ + { NULL, posts_at }, /* At */ + { NULL, NULL }, /* Bc */ + { NULL, posts_bf }, /* Bf */ + { NULL, NULL }, /* Bo */ + { NULL, posts_wline }, /* Bq */ + { NULL, NULL }, /* Bsx */ + { NULL, NULL }, /* Bx */ + { NULL, posts_bool }, /* Db */ + { NULL, NULL }, /* Dc */ + { NULL, NULL }, /* Do */ + { NULL, posts_wline }, /* Dq */ + { NULL, NULL }, /* Ec */ + { NULL, NULL }, /* Ef */ + { NULL, posts_text }, /* Em */ + { NULL, NULL }, /* Eo */ + { NULL, NULL }, /* Fx */ + { NULL, posts_text }, /* Ms */ + { NULL, posts_notext }, /* No */ + { NULL, posts_notext }, /* Ns */ + { NULL, NULL }, /* Nx */ + { NULL, NULL }, /* Ox */ + { NULL, NULL }, /* Pc */ + { NULL, NULL }, /* Pf */ + { NULL, NULL }, /* Po */ + { NULL, posts_wline }, /* Pq */ + { NULL, NULL }, /* Qc */ + { NULL, posts_wline }, /* Ql */ + { NULL, NULL }, /* Qo */ + { NULL, posts_wline }, /* Qq */ + { NULL, NULL }, /* Re */ + { NULL, posts_rs }, /* Rs */ + { NULL, NULL }, /* Sc */ + { NULL, NULL }, /* So */ + { NULL, posts_wline }, /* Sq */ + { NULL, posts_bool }, /* Sm */ + { NULL, posts_text }, /* Sx */ + { NULL, posts_text }, /* Sy */ + { NULL, posts_text }, /* Tn */ + { NULL, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { NULL, posts_fo }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, posts_bk }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, posts_notext }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { NULL, posts_notext }, /* Ud */ }; -static int -post_check_children_count(struct mdoc *mdoc) +static inline int +warn_count(struct mdoc *m, const char *k, + int want, const char *v, int has) +{ + + return(mdoc_warn(m, WARN_SYNTAX, "suggests %s %d %s " + "(has %d)", v, want, k, has)); +} + + +static inline int +err_count(struct mdoc *m, const char *k, + int want, const char *v, int has) +{ + + return(mdoc_err(m, "requires %s %d %s (has %d)", + v, want, k, has)); +} + + +static inline int +count_child(struct mdoc *mdoc) { - struct mdoc_node *n; int i; + struct mdoc_node *n; for (i = 0, n = mdoc->last->child; n; n = n->next, i++) /* Do nothing */ ; @@ -269,72 +296,68 @@ post_check_children_count(struct mdoc *mdoc) static int -post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz) +warn_child_gt(struct mdoc *mdoc, const char *p, int sz) { int i; - if ((i = post_check_children_count(mdoc)) > sz) + if ((i = count_child(mdoc)) > sz) return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more " - "than %d %s (has %d)", sz, p, i)); + return(warn_count(mdoc, ">", sz, p, i)); } static int -post_check_children_gt(struct mdoc *mdoc, const char *p, int sz) +err_child_gt(struct mdoc *mdoc, const char *p, int sz) { int i; - if ((i = post_check_children_count(mdoc)) > sz) + if ((i = count_child(mdoc)) > sz) return(1); - return(mdoc_err(mdoc, "macro requires more than %d " - "%s (has %d)", sz, p, i)); + return(err_count(mdoc, ">", sz, p, i)); } static int -post_check_children_weq(struct mdoc *mdoc, const char *p, int sz) +warn_child_eq(struct mdoc *mdoc, const char *p, int sz) { int i; - if ((i = post_check_children_count(mdoc)) == sz) + if ((i = count_child(mdoc)) == sz) return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d " - "%s (has %d)", sz, p, i)); + return(warn_count(mdoc, "==", sz, p, i)); } static int -post_check_children_eq(struct mdoc *mdoc, const char *p, int sz) +err_child_eq(struct mdoc *mdoc, const char *p, int sz) { int i; - if ((i = post_check_children_count(mdoc)) == sz) + if ((i = count_child(mdoc)) == sz) return(1); - return(mdoc_err(mdoc, "macro requires %d %s " - "(have %d)", sz, p, i)); + return(err_count(mdoc, "==", sz, p, i)); } static int -post_check_children_lt(struct mdoc *mdoc, const char *p, int sz) +err_child_lt(struct mdoc *mdoc, const char *p, int sz) { int i; - if ((i = post_check_children_count(mdoc)) < sz) + if ((i = count_child(mdoc)) < sz) return(1); - return(mdoc_err(mdoc, "macro requires less than %d " - "%s (have %d)", sz, p, i)); + return(err_count(mdoc, "<", sz, p, i)); } static int -pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) +check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) { - if (1 == node->data.elem.argc && - MDOC_Std == node->data.elem.argv[0].arg) + if (MDOC_Std == node->data.elem.argv[0].arg && + 1 == node->data.elem.argc) return(1); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro suggests single `%s' argument", mdoc_argnames[MDOC_Std])); @@ -342,7 +365,7 @@ pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) static int -pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, +check_msec(struct mdoc *mdoc, struct mdoc_node *node, int sz, enum mdoc_msec *msecs) { int i; @@ -356,19 +379,20 @@ pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, static int -pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, - int tok, enum mdoc_type type) +check_parent(struct mdoc *mdoc, struct mdoc_node *n, + int tok, enum mdoc_type t) { - if (type != node->parent->type) - return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", - mdoc_type2a(node->parent->type), - mdoc_type2a(type))); - if (MDOC_ROOT != type && tok != node->parent->tok) - return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", - mdoc_macronames[node->parent->tok], - mdoc_macronames[tok])); - return(1); + assert(n->parent); + if ((MDOC_ROOT == t || tok == n->parent->tok) && + (t == n->parent->type)) + return(1); + + return(mdoc_nerr(mdoc, n, "require parent %s (have %s)", + MDOC_ROOT == t ? "<root>" : + mdoc_macronames[tok], + MDOC_ROOT == n->parent->type ? "<root>" : + mdoc_macronames[n->parent->type])); } @@ -378,7 +402,7 @@ bwarn_ge1(struct mdoc *mdoc) if (MDOC_BODY != mdoc->last->type) return(1); - return(post_check_children_wgt(mdoc, "body children", 0)); + return(warn_child_gt(mdoc, "multi-line parameters", 0)); } @@ -387,7 +411,7 @@ ewarn_eq1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_weq(mdoc, "parameters", 1)); + return(warn_child_eq(mdoc, "line parameters", 1)); } @@ -396,7 +420,7 @@ ewarn_eq0(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_weq(mdoc, "parameters", 0)); + return(warn_child_eq(mdoc, "line parameters", 0)); } @@ -405,7 +429,7 @@ ewarn_ge1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_wgt(mdoc, "parameters", 0)); + return(warn_child_gt(mdoc, "line parameters", 0)); } @@ -414,7 +438,7 @@ eerr_eq1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_eq(mdoc, "parameters", 1)); + return(err_child_eq(mdoc, "line parameters", 1)); } @@ -423,7 +447,7 @@ eerr_le2(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_lt(mdoc, "parameters", 3)); + return(err_child_lt(mdoc, "line parameters", 3)); } @@ -432,7 +456,7 @@ eerr_le1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_lt(mdoc, "parameters", 2)); + return(err_child_lt(mdoc, "line parameters", 2)); } @@ -441,7 +465,7 @@ eerr_eq0(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_eq(mdoc, "parameters", 0)); + return(err_child_eq(mdoc, "line parameters", 0)); } @@ -450,7 +474,7 @@ eerr_ge1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - return(post_check_children_gt(mdoc, "parameters", 0)); + return(err_child_gt(mdoc, "line parameters", 0)); } @@ -460,7 +484,7 @@ herr_eq0(struct mdoc *mdoc) if (MDOC_HEAD != mdoc->last->type) return(1); - return(post_check_children_eq(mdoc, "parameters", 0)); + return(err_child_eq(mdoc, "line parameters", 0)); } @@ -469,7 +493,7 @@ herr_le1(struct mdoc *mdoc) { if (MDOC_HEAD != mdoc->last->type) return(1); - return(post_check_children_lt(mdoc, "parameters", 2)); + return(err_child_lt(mdoc, "line parameters", 2)); } @@ -479,7 +503,7 @@ herr_ge1(struct mdoc *mdoc) if (MDOC_HEAD != mdoc->last->type) return(1); - return(post_check_children_gt(mdoc, "parameters", 0)); + return(err_child_gt(mdoc, "line parameters", 0)); } @@ -613,7 +637,7 @@ pre_ss(struct mdoc *mdoc, struct mdoc_node *node) if (MDOC_BLOCK != node->type) return(1); - return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); + return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); } @@ -623,7 +647,7 @@ pre_sh(struct mdoc *mdoc, struct mdoc_node *node) if (MDOC_BLOCK != node->type) return(1); - return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); + return(check_parent(mdoc, node, -1, MDOC_ROOT)); } @@ -661,9 +685,9 @@ pre_rv(struct mdoc *mdoc, struct mdoc_node *node) msecs[0] = MSEC_2; msecs[1] = MSEC_3; - if ( ! pre_check_msecs(mdoc, node, 2, msecs)) + if ( ! check_msec(mdoc, node, 2, msecs)) return(0); - return(pre_check_stdarg(mdoc, node)); + return(check_stdarg(mdoc, node)); } @@ -678,9 +702,9 @@ pre_ex(struct mdoc *mdoc, struct mdoc_node *node) msecs[0] = MSEC_1; msecs[1] = MSEC_6; msecs[2] = MSEC_8; - if ( ! pre_check_msecs(mdoc, node, 3, msecs)) + if ( ! check_msec(mdoc, node, 3, msecs)) return(0); - return(pre_check_stdarg(mdoc, node)); + return(check_stdarg(mdoc, node)); } @@ -690,7 +714,7 @@ pre_er(struct mdoc *mdoc, struct mdoc_node *node) enum mdoc_msec msecs[1]; msecs[0] = MSEC_2; - return(pre_check_msecs(mdoc, node, 1, msecs)); + return(check_msec(mdoc, node, 1, msecs)); } @@ -700,7 +724,7 @@ pre_cd(struct mdoc *mdoc, struct mdoc_node *node) enum mdoc_msec msecs[1]; msecs[0] = MSEC_4; - return(pre_check_msecs(mdoc, node, 1, msecs)); + return(check_msec(mdoc, node, 1, msecs)); } @@ -713,7 +737,7 @@ pre_it(struct mdoc *mdoc, struct mdoc_node *node) if (MDOC_BLOCK != node->type) return(1); - return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); + return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); } @@ -1102,22 +1126,40 @@ post_sh_body(struct mdoc *mdoc) struct mdoc_node *n; assert(MDOC_Sh == mdoc->last->tok); + assert(MDOC_BODY == mdoc->last->type); if (SEC_NAME != mdoc->lastnamed) return(1); + /* + * Warn if the NAME section doesn't contain the `Nm' and `Nd' + * macros (can have multiple `Nm' and one `Nd'). Note that the + * children of the BODY declaration can also be "text". + */ + if (NULL == (n = mdoc->last->child)) - return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm])); - if (MDOC_ELEM != n->type || MDOC_Nm != n->tok) - return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm])); - if (NULL == (n = n->next)) - return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd])); - if (MDOC_ELEM != n->type || MDOC_Nd != n->tok) - return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd])); - if (NULL == (n = n->next)) + return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME " + "should contain %s and %s", + mdoc_macronames[MDOC_Nm], + mdoc_macronames[MDOC_Nd])); + + for ( ; n && n->next; n = n->next) { + if (MDOC_ELEM == n->type && MDOC_Nm == n->tok) + continue; + if (MDOC_TEXT == n->type) + continue; + if ( ! (mdoc_nwarn(mdoc, n, WARN_COMPAT, "section " + "NAME should contain %s as " + "initial body child", + mdoc_macronames[MDOC_Nm]))) + return(0); + } + + if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "section NAME usually limited to %s and %s body children", - mdoc_macronames[MDOC_Nm], mdoc_macronames[MDOC_Nd])); + return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME should " + "contain %s as the last child", + mdoc_macronames[MDOC_Nd])); } |