diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-02-21 19:05:28 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-02-21 19:05:28 +0000 |
commit | 90b7feb891f3f87751c0a0c0b57b38c8834ede8e (patch) | |
tree | 09820ff749c6795cccca121a7d1ee9752a101825 | |
parent | 258474969d9b8106ce94ac7945ea0635c4726b95 (diff) | |
download | mandoc-90b7feb891f3f87751c0a0c0b57b38c8834ede8e.tar.gz |
Split down term.c into term.h, termact.c.
-rw-r--r-- | Makefile | 18 | ||||
-rw-r--r-- | term.c | 598 | ||||
-rw-r--r-- | term.h | 59 | ||||
-rw-r--r-- | termact.c | 678 |
4 files changed, 774 insertions, 579 deletions
@@ -5,7 +5,7 @@ CFLAGS += -W -Wall -Wstrict-prototypes -Wno-unused-parameter -g LIBLNS = macro.ln mdoc.ln hash.ln strings.ln xstd.ln argv.ln \ validate.ln action.ln -BINLNS = mdocml.ln term.ln tree.ln +BINLNS = mdocml.ln term.ln tree.ln termact.ln LNS = $(LIBLNS) $(BINLNS) @@ -16,14 +16,14 @@ LIBS = libmdoc.a LIBOBJS = macro.o mdoc.o hash.o strings.o xstd.o argv.o \ validate.o action.o -BINOBJS = mdocml.o term.o tree.o +BINOBJS = mdocml.o term.o tree.o termact.o OBJS = $(LIBOBJS) $(BINOBJS) SRCS = macro.c mdoc.c mdocml.c hash.c strings.c xstd.c argv.c \ - validate.c action.c + validate.c action.c term.c tree.c termact.c -HEADS = mdoc.h private.h +HEADS = mdoc.h private.h term.h MANS = mdocml.1 mdoc.3 @@ -136,9 +136,13 @@ tree.ln: tree.c mdoc.h tree.o: tree.c mdoc.h -term.ln: term.c private.h +term.ln: term.c term.h -term.o: term.c private.h +term.o: term.c term.h + +termact.ln: termact.c term.h + +termact.o: termact.c term.h strings.ln: strings.c private.h @@ -206,5 +210,5 @@ libmdoc.a: $(LIBOBJS) $(AR) rs $@ $(LIBOBJS) mdocml: $(BINOBJS) libmdoc.a - $(CC) $(CFLAGS) -o $@ $(BINOBJS) libmdoc.a -lcurses + $(CC) $(CFLAGS) -o $@ $(BINOBJS) libmdoc.a @@ -1,6 +1,6 @@ /* $Id$ */ /* - * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> + * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the @@ -18,44 +18,19 @@ */ #include <assert.h> #include <ctype.h> -#include <curses.h> #include <err.h> #include <stdlib.h> #include <stdio.h> #include <string.h> -#include <term.h> #include <unistd.h> -#include "private.h" +#include "term.h" +#include "private.h" /* XXX */ -enum termesc { - ESC_CLEAR, - ESC_BOLD, - ESC_UNDERLINE -}; - -struct termp { - size_t rmargin; - size_t maxrmargin; - size_t maxcols; - size_t offset; - size_t col; - int flags; -#define TERMP_BOLD (1 << 0) /* Embolden words. */ -#define TERMP_UNDERLINE (1 << 1) /* Underline words. */ -#define TERMP_NOSPACE (1 << 2) /* No space before words. */ -#define TERMP_NOLPAD (1 << 3) /* No left-padding. */ -#define TERMP_NOBREAK (1 << 4) /* No break after line */ - char *buf; -}; - -struct termact { - int (*pre)(struct termp *, - const struct mdoc_meta *, - const struct mdoc_node *); - int (*post)(struct termp *, - const struct mdoc_meta *, - const struct mdoc_node *); +enum termstyle { + STYLE_CLEAR, + STYLE_BOLD, + STYLE_UNDERLINE }; static void termprint_r(struct termp *, @@ -66,175 +41,12 @@ static void termprint_header(struct termp *, static void termprint_footer(struct termp *, const struct mdoc_meta *); -static int arg_hasattr(int, size_t, - const struct mdoc_arg *); -static int arg_getattr(int, size_t, - const struct mdoc_arg *); - -static void newln(struct termp *); -static void vspace(struct termp *); static void pword(struct termp *, const char *, size_t); -static void word(struct termp *, const char *); - -#define decl_prepost(name, suffix) \ -static int name##_##suffix(struct termp *, \ - const struct mdoc_meta *, \ - const struct mdoc_node *) - -#define decl_pre(name) decl_prepost(name, pre) -#define decl_post(name) decl_prepost(name, post) - -decl_pre(termp_fl); -decl_pre(termp_it); -decl_pre(termp_nd); -decl_pre(termp_ns); -decl_pre(termp_op); -decl_pre(termp_pp); -decl_pre(termp_sh); -decl_pre(termp_xr); - -decl_post(termp_bl); -decl_post(termp_it); -decl_post(termp_op); -decl_post(termp_sh); - -decl_pre(termp_bold); -decl_pre(termp_under); - -decl_post(termp_bold); -decl_post(termp_under); - -const struct termact termacts[MDOC_MAX] = { - { NULL, NULL }, /* \" */ - { NULL, NULL }, /* Dd */ - { NULL, NULL }, /* Dt */ - { NULL, NULL }, /* Os */ - { termp_sh_pre, termp_sh_post }, /* Sh */ - { NULL, NULL }, /* Ss */ - { termp_pp_pre, NULL }, /* Pp */ - { NULL, NULL }, /* D1 */ - { NULL, NULL }, /* Dl */ - { NULL, NULL }, /* Bd */ - { NULL, NULL }, /* Ed */ - { NULL, termp_bl_post }, /* Bl */ - { NULL, NULL }, /* El */ - { termp_it_pre, termp_it_post }, /* It */ - { NULL, NULL }, /* Ad */ - { NULL, NULL }, /* An */ - { termp_under_pre, termp_under_post }, /* Ar */ - { NULL, NULL }, /* Cd */ - { NULL, NULL }, /* Cm */ - { NULL, NULL }, /* Dv */ - { NULL, NULL }, /* Er */ - { NULL, NULL }, /* Ev */ - { NULL, NULL }, /* Ex */ - { NULL, NULL }, /* Fa */ - { NULL, NULL }, /* Fd */ - { termp_fl_pre, termp_bold_post }, /* Fl */ - { NULL, NULL }, /* Fn */ - { NULL, NULL }, /* Ft */ - { NULL, NULL }, /* Ic */ - { NULL, NULL }, /* In */ - { NULL, NULL }, /* Li */ - { termp_nd_pre, NULL }, /* Nd */ - { termp_bold_pre, termp_bold_post }, /* Nm */ - { termp_op_pre, termp_op_post }, /* Op */ - { NULL, NULL }, /* Ot */ - { NULL, NULL }, /* Pa */ - { NULL, NULL }, /* Rv */ - { NULL, NULL }, /* St */ - { NULL, NULL }, /* Va */ - { NULL, NULL }, /* Vt */ - { termp_xr_pre, NULL }, /* Xr */ - { NULL, NULL }, /* %A */ - { NULL, NULL }, /* %B */ - { NULL, NULL }, /* %D */ - { NULL, NULL }, /* %I */ - { NULL, NULL }, /* %J */ - { NULL, NULL }, /* %N */ - { NULL, NULL }, /* %O */ - { NULL, NULL }, /* %P */ - { NULL, NULL }, /* %R */ - { NULL, NULL }, /* %T */ - { NULL, NULL }, /* %V */ - { NULL, NULL }, /* Ac */ - { NULL, NULL }, /* Ao */ - { NULL, NULL }, /* Aq */ - { NULL, NULL }, /* At */ - { NULL, NULL }, /* Bc */ - { NULL, NULL }, /* Bf */ - { NULL, NULL }, /* Bo */ - { NULL, NULL }, /* Bq */ - { NULL, NULL }, /* Bsx */ - { NULL, NULL }, /* Bx */ - { NULL, NULL }, /* Db */ - { NULL, NULL }, /* Dc */ - { NULL, NULL }, /* Do */ - { NULL, NULL }, /* Dq */ - { NULL, NULL }, /* Ec */ - { NULL, NULL }, /* Ef */ - { NULL, NULL }, /* Em */ - { NULL, NULL }, /* Eo */ - { NULL, NULL }, /* Fx */ - { NULL, NULL }, /* Ms */ - { NULL, NULL }, /* No */ - { termp_ns_pre, NULL }, /* Ns */ - { NULL, NULL }, /* Nx */ - { NULL, NULL }, /* Ox */ - { NULL, NULL }, /* Pc */ - { NULL, NULL }, /* Pf */ - { NULL, NULL }, /* Po */ - { NULL, NULL }, /* Pq */ - { NULL, NULL }, /* Qc */ - { NULL, NULL }, /* Ql */ - { NULL, NULL }, /* Qo */ - { NULL, NULL }, /* Qq */ - { NULL, NULL }, /* Re */ - { NULL, NULL }, /* Rs */ - { NULL, NULL }, /* Sc */ - { NULL, NULL }, /* So */ - { NULL, NULL }, /* Sq */ - { NULL, NULL }, /* Sm */ - { NULL, NULL }, /* Sx */ - { NULL, NULL }, /* Sy */ - { NULL, NULL }, /* Tn */ - { NULL, NULL }, /* Ux */ - { NULL, NULL }, /* Xc */ - { NULL, NULL }, /* Xo */ - { NULL, NULL }, /* Fo */ - { NULL, NULL }, /* Fc */ - { NULL, NULL }, /* Oo */ - { NULL, NULL }, /* Oc */ - { NULL, NULL }, /* Bk */ - { NULL, NULL }, /* Ek */ - { NULL, NULL }, /* Bt */ - { NULL, NULL }, /* Hf */ - { NULL, NULL }, /* Fr */ - { NULL, NULL }, /* Ud */ -}; +static void chara(struct termp *, char); +static void escape(struct termp *, enum termstyle); -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); -} - - -static void +void flushln(struct termp *p) { size_t i, j, vsz, vis, maxvis; @@ -333,7 +145,7 @@ flushln(struct termp *p) } -static void +void newln(struct termp *p) { @@ -348,7 +160,7 @@ newln(struct termp *p) } -static void +void vspace(struct termp *p) { @@ -373,7 +185,7 @@ chara(struct termp *p, char c) static void -escape(struct termp *p, enum termesc esc) +escape(struct termp *p, enum termstyle esc) { if (p->col + 4 >= p->maxcols) @@ -382,13 +194,13 @@ escape(struct termp *p, enum termesc esc) p->buf[(p->col)++] = 27; p->buf[(p->col)++] = '['; switch (esc) { - case (ESC_CLEAR): + case (STYLE_CLEAR): p->buf[(p->col)++] = '0'; break; - case (ESC_BOLD): + case (STYLE_BOLD): p->buf[(p->col)++] = '1'; break; - case (ESC_UNDERLINE): + case (STYLE_UNDERLINE): p->buf[(p->col)++] = '4'; break; default: @@ -412,9 +224,9 @@ pword(struct termp *p, const char *word, size_t len) p->flags &= ~TERMP_NOSPACE; if (p->flags & TERMP_BOLD) - escape(p, ESC_BOLD); + escape(p, STYLE_BOLD); if (p->flags & TERMP_UNDERLINE) - escape(p, ESC_UNDERLINE); + escape(p, STYLE_UNDERLINE); /* TODO: escape patterns. */ @@ -423,11 +235,11 @@ pword(struct termp *p, const char *word, size_t len) if (p->flags & TERMP_BOLD || p->flags & TERMP_UNDERLINE) - escape(p, ESC_CLEAR); + escape(p, STYLE_CLEAR); } -static void +void word(struct termp *p, const char *word) { size_t i, j, len; @@ -457,350 +269,13 @@ word(struct termp *p, const char *word) } -/* ARGSUSED */ -static int -termp_it_post(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - const struct mdoc_node *n, *it; - const struct mdoc_block *bl; - int i; - size_t width; - - switch (node->type) { - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_HEAD): - break; - default: - return(1); - } - - it = node->parent; - assert(MDOC_BLOCK == it->type); - assert(MDOC_It == it->tok); - - n = it->parent; - assert(MDOC_BODY == n->type); - assert(MDOC_Bl == n->tok); - n = n->parent; - bl = &n->data.block; - - /* If `-tag', adjust our margins accordingly. */ - - if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) { - i = arg_getattr(MDOC_Width, bl->argc, bl->argv); - assert(i >= 0); - assert(1 == bl->argv[i].sz); - width = strlen(*bl->argv[i].value); /* XXX */ - - if (MDOC_HEAD == node->type) { - flushln(p); - /* FIXME: nested lists. */ - p->rmargin = p->maxrmargin; - p->flags &= ~TERMP_NOBREAK; - } else { - flushln(p); - p->offset -= width + 1; - p->flags &= ~TERMP_NOLPAD; - } - } - - return(1); -} - - -/* ARGSUSED */ -static int -termp_it_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - const struct mdoc_node *n, *it; - const struct mdoc_block *bl; - int i; - size_t width; - - switch (node->type) { - case (MDOC_BODY): - /* FALLTHROUGH */ - case (MDOC_HEAD): - it = node->parent; - break; - case (MDOC_BLOCK): - it = node; - break; - default: - return(1); - } - - assert(MDOC_BLOCK == it->type); - assert(MDOC_It == it->tok); - - n = it->parent; - assert(MDOC_BODY == n->type); - assert(MDOC_Bl == n->tok); - n = n->parent; - bl = &n->data.block; - - /* If `-compact', don't assert vertical space. */ - - if (MDOC_BLOCK == node->type) { - if (arg_hasattr(MDOC_Compact, bl->argc, bl->argv)) - newln(p); - else - vspace(p); - return(1); - } - - assert(MDOC_HEAD == node->type - || MDOC_BODY == node->type); - - /* If `-tag', adjust our margins accordingly. */ - - if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) { - i = arg_getattr(MDOC_Width, bl->argc, bl->argv); - assert(i >= 0); /* XXX */ - assert(1 == bl->argv[i].sz); - width = strlen(*bl->argv[i].value); /* XXX */ - - /* FIXME: nested lists. */ - - if (MDOC_HEAD == node->type) { - p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_NOSPACE; - p->rmargin = p->offset + width; - } else { - p->flags |= TERMP_NOSPACE; - p->flags |= TERMP_NOLPAD; - p->offset += width + 1; - } - } - - return(1); -} - - -/* ARGSUSED */ -static int -termp_bold_post(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - p->flags &= ~TERMP_BOLD; - return(1); -} - - -/* ARGSUSED */ -static int -termp_under_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - p->flags |= TERMP_UNDERLINE; - return(1); -} - - -/* ARGSUSED */ -static int -termp_bold_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - p->flags |= TERMP_BOLD; - return(1); -} - - -/* ARGSUSED */ -static int -termp_ns_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - p->flags |= TERMP_NOSPACE; - return(1); -} - - -/* ARGSUSED */ -static int -termp_pp_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - vspace(p); - return(1); -} - - -/* ARGSUSED */ -static int -termp_under_post(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - p->flags &= ~TERMP_UNDERLINE; - return(1); -} - - -/* ARGSUSED */ -static int -termp_nd_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - word(p, "-"); - return(1); -} - - -/* ARGSUSED */ -static int -termp_bl_post(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - switch (node->type) { - case (MDOC_BLOCK): - newln(p); - break; - default: - break; - } - return(1); -} - - -/* ARGSUSED */ -static int -termp_op_post(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - switch (node->type) { - case (MDOC_BODY): - p->flags |= TERMP_NOSPACE; - word(p, "\\]"); - break; - default: - break; - } - return(1); -} - - -/* ARGSUSED */ -static int -termp_sh_post(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - switch (node->type) { - case (MDOC_HEAD): - p->flags &= ~TERMP_BOLD; - newln(p); - break; - case (MDOC_BODY): - newln(p); - p->offset -= 4; - break; - default: - break; - } - return(1); -} - - -/* ARGSUSED */ -static int -termp_xr_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - const struct mdoc_node *n; - - n = node->child; - assert(n); - - assert(MDOC_TEXT == n->type); - word(p, n->data.text.string); - - if (NULL == (n = n->next)) - return(0); - - assert(MDOC_TEXT == n->type); - p->flags |= TERMP_NOSPACE; - word(p, "\\("); - p->flags |= TERMP_NOSPACE; - word(p, n->data.text.string); - p->flags |= TERMP_NOSPACE; - word(p, "\\)"); - - return(0); -} - - -/* ARGSUSED */ -static int -termp_sh_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - switch (node->type) { - case (MDOC_HEAD): - vspace(p); - p->flags |= TERMP_BOLD; - break; - case (MDOC_BODY): - p->offset += 4; - break; - default: - break; - } - return(1); -} - - -/* ARGSUSED */ -static int -termp_op_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - switch (node->type) { - case (MDOC_BODY): - word(p, "\\["); - p->flags |= TERMP_NOSPACE; - break; - default: - break; - } - return(1); -} - - -/* ARGSUSED */ -static int -termp_fl_pre(struct termp *p, const struct mdoc_meta *meta, - const struct mdoc_node *node) -{ - - p->flags |= TERMP_BOLD; - word(p, "-"); - p->flags |= TERMP_NOSPACE; - return(1); -} - - static void termprint_r(struct termp *p, const struct mdoc_meta *meta, const struct mdoc_node *node) { int dochild; - /* Pre-processing ----------------- */ + /* Pre-processing. */ dochild = 1; @@ -811,30 +286,12 @@ termprint_r(struct termp *p, const struct mdoc_meta *meta, } else /* MDOC_TEXT == node->type */ word(p, node->data.text.string); - /* Children ---------------------- */ + /* Children. */ - if (dochild && NULL == node->child) { - /* No-child processing. */ - switch (node->type) { - case (MDOC_ELEM): - switch (node->tok) { - case (MDOC_Nm): - word(p, "progname"); /* TODO */ - break; - case (MDOC_Ar): - word(p, "..."); - break; - default: - break; - } - break; - default: - break; - } - } else if (dochild) + if (dochild && node->child) termprint_r(p, meta, node->child); - /* Post-processing --------------- */ + /* Post-processing. */ if (MDOC_TEXT != node->type) { if (termacts[node->tok].post) @@ -842,7 +299,7 @@ termprint_r(struct termp *p, const struct mdoc_meta *meta, return; } - /* Siblings ---------------------- */ + /* Siblings. */ if (node->next) termprint_r(p, meta, node->next); @@ -988,10 +445,7 @@ termprint(const struct mdoc_node *node, { struct termp p; - if (ERR == setupterm(NULL, STDOUT_FILENO, NULL)) - return(0); - - p.maxrmargin = columns < 60 ? 60 : (size_t)columns; + p.maxrmargin = 80; /* XXX */ p.rmargin = p.maxrmargin; p.maxcols = 1024; p.offset = p.col = 0; @@ -0,0 +1,59 @@ +/* $Id$ */ +/* + * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> + * + * 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. + * + * 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. + */ +#ifndef TERM_H +#define TERM_H + +#include "mdoc.h" + +__BEGIN_DECLS + +struct termp { + size_t rmargin; + size_t maxrmargin; + size_t maxcols; + size_t offset; + size_t col; + int flags; +#define TERMP_BOLD (1 << 0) /* Embolden words. */ +#define TERMP_UNDERLINE (1 << 1) /* Underline words. */ +#define TERMP_NOSPACE (1 << 2) /* No space before words. */ +#define TERMP_NOLPAD (1 << 3) /* No leftpad before flush. */ +#define TERMP_NOBREAK (1 << 4) /* No break after flush. */ + char *buf; +}; + +struct termact { + int (*pre)(struct termp *, + const struct mdoc_meta *, + const struct mdoc_node *); + int (*post)(struct termp *, + const struct mdoc_meta *, + const struct mdoc_node *); +}; + +void newln(struct termp *); +void vspace(struct termp *); +void word(struct termp *, const char *); +void flushln(struct termp *); + +const struct termact *termacts; + +__END_DECLS + +#endif /*!TERM_H*/ diff --git a/termact.c b/termact.c new file mode 100644 index 00000000..7fdc5fd1 --- /dev/null +++ b/termact.c @@ -0,0 +1,678 @@ +/* $Id$ */ +/* + * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> + * + * 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. + * + * 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 <assert.h> +#include <stdlib.h> +#include <string.h> + +#include "term.h" + +#define TTYPE_PROG 0 +#define TTYPE_CMD_FLAG 1 +#define TTYPE_CMD_ARG 2 +#define TTYPE_SECTION 3 +#define TTYPE_NMAX 4 + +/* + * These define "styles" for element types, like command arguments or + * executable names. This is useful when multiple macros must decorate + * the same thing (like .Ex -std cmd and .Nm cmd). + */ + +const int ttypes[TTYPE_NMAX] = { + TERMP_BOLD, /* TTYPE_PROG */ + TERMP_BOLD, /* TTYPE_CMD_FLAG */ + TERMP_UNDERLINE, /* TTYPE_CMD_ARG */ + TERMP_BOLD /* TTYPE_SECTION */ +}; + +static int arg_hasattr(int, size_t, + const struct mdoc_arg *); +static int arg_getattr(int, size_t, + const struct mdoc_arg *); + +/* + * What follows describes prefix and postfix operations for the abstract + * syntax tree descent. + */ + +#define DECL_ARGS \ + struct termp *p, \ + const struct mdoc_meta *meta, \ + const struct mdoc_node *node + +#define DECL_PREPOST(name, suffix) \ +static int name##_##suffix(DECL_ARGS) + +#define DECL_PRE(name) DECL_PREPOST(name, pre) +#define DECL_POST(name) DECL_PREPOST(name, post) + +DECL_PRE(termp_aq); +DECL_PRE(termp_ar); +DECL_PRE(termp_d1); +DECL_PRE(termp_dq); +DECL_PRE(termp_ex); +DECL_PRE(termp_fl); +DECL_PRE(termp_it); +DECL_PRE(termp_nd); +DECL_PRE(termp_nm); +DECL_PRE(termp_ns); +DECL_PRE(termp_op); +DECL_PRE(termp_pp); +DECL_PRE(termp_sh); +DECL_PRE(termp_ud); +DECL_PRE(termp_xr); + +DECL_POST(termp_aq); +DECL_POST(termp_ar); +DECL_POST(termp_bl); +DECL_POST(termp_d1); +DECL_POST(termp_dq); +DECL_POST(termp_fl); +DECL_POST(termp_it); +DECL_POST(termp_nm); +DECL_POST(termp_op); +DECL_POST(termp_sh); + +const struct termact __termacts[MDOC_MAX] = { + { NULL, NULL }, /* \" */ + { NULL, NULL }, /* Dd */ + { NULL, NULL }, /* Dt */ + { NULL, NULL }, /* Os */ + { termp_sh_pre, termp_sh_post }, /* Sh */ + { NULL, NULL }, /* Ss */ + { termp_pp_pre, NULL }, /* Pp */ + { termp_d1_pre, termp_d1_post }, /* D1 */ + { NULL, NULL }, /* Dl */ + { NULL, NULL }, /* Bd */ + { NULL, NULL }, /* Ed */ + { NULL, termp_bl_post }, /* Bl */ + { NULL, NULL }, /* El */ + { termp_it_pre, termp_it_post }, /* It */ + { NULL, NULL }, /* Ad */ + { NULL, NULL }, /* An */ + { termp_ar_pre, termp_ar_post }, /* Ar */ + { NULL, NULL }, /* Cd */ + { NULL, NULL }, /* Cm */ + { NULL, NULL }, /* Dv */ + { NULL, NULL }, /* Er */ + { NULL, NULL }, /* Ev */ + { termp_ex_pre, NULL }, /* Ex */ + { NULL, NULL }, /* Fa */ + { NULL, NULL }, /* Fd */ + { termp_fl_pre, termp_fl_post }, /* Fl */ + { NULL, NULL }, /* Fn */ + { NULL, NULL }, /* Ft */ + { NULL, NULL }, /* Ic */ + { NULL, NULL }, /* In */ + { NULL, NULL }, /* Li */ + { termp_nd_pre, NULL }, /* Nd */ + { termp_nm_pre, termp_nm_post }, /* Nm */ + { termp_op_pre, termp_op_post }, /* Op */ + { NULL, NULL }, /* Ot */ + { NULL, NULL }, /* Pa */ + { NULL, NULL }, /* Rv */ + { NULL, NULL }, /* St */ + { NULL, NULL }, /* Va */ + { NULL, NULL }, /* Vt */ + { termp_xr_pre, NULL }, /* Xr */ + { NULL, NULL }, /* %A */ + { NULL, NULL }, /* %B */ + { NULL, NULL }, /* %D */ + { NULL, NULL }, /* %I */ + { NULL, NULL }, /* %J */ + { NULL, NULL }, /* %N */ + { NULL, NULL }, /* %O */ + { NULL, NULL }, /* %P */ + { NULL, NULL }, /* %R */ + { NULL, NULL }, /* %T */ + { NULL, NULL }, /* %V */ + { NULL, NULL }, /* Ac */ + { NULL, NULL }, /* Ao */ + { termp_aq_pre, termp_aq_post }, /* Aq */ + { NULL, NULL }, /* At */ + { NULL, NULL }, /* Bc */ + { NULL, NULL }, /* Bf */ + { NULL, NULL }, /* Bo */ + { NULL, NULL }, /* Bq */ + { NULL, NULL }, /* Bsx */ + { NULL, NULL }, /* Bx */ + { NULL, NULL }, /* Db */ + { NULL, NULL }, /* Dc */ + { NULL, NULL }, /* Do */ + { termp_dq_pre, termp_dq_post }, /* Dq */ + { NULL, NULL }, /* Ec */ + { NULL, NULL }, /* Ef */ + { NULL, NULL }, /* Em */ + { NULL, NULL }, /* Eo */ + { NULL, NULL }, /* Fx */ + { NULL, NULL }, /* Ms */ + { NULL, NULL }, /* No */ + { termp_ns_pre, NULL }, /* Ns */ + { NULL, NULL }, /* Nx */ + { NULL, NULL }, /* Ox */ + { NULL, NULL }, /* Pc */ + { NULL, NULL }, /* Pf */ + { NULL, NULL }, /* Po */ + { NULL, NULL }, /* Pq */ + { NULL, NULL }, /* Qc */ + { NULL, NULL }, /* Ql */ + { NULL, NULL }, /* Qo */ + { NULL, NULL }, /* Qq */ + { NULL, NULL }, /* Re */ + { NULL, NULL }, /* Rs */ + { NULL, NULL }, /* Sc */ + { NULL, NULL }, /* So */ + { NULL, NULL }, /* Sq */ + { NULL, NULL }, /* Sm */ + { NULL, NULL }, /* Sx */ + { NULL, NULL }, /* Sy */ + { NULL, NULL }, /* Tn */ + { NULL, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { NULL, NULL }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, NULL }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, NULL }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { termp_ud_pre, NULL }, /* Ud */ +}; + +const struct termact *termacts = __termacts; + + +/* ARGSUSED */ +static int +termp_dq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + + word(p, "``"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static int +termp_dq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + + p->flags |= TERMP_NOSPACE; + word(p, "''"); + return(1); +} + + +/* ARGSUSED */ +static int +termp_it_post(DECL_ARGS) +{ + const struct mdoc_node *n, *it; + const struct mdoc_block *bl; + int i; + size_t width; + + /* + * This (and termp_it_pre()) are the most complicated functions + * here. They must account for a considerable number of + * switches that completely change the output behaviour, like + * -tag versus -column. Yech. + */ + + switch (node->type) { + case (MDOC_BODY): + /* FALLTHROUGH */ + case (MDOC_HEAD): + break; + default: + return(1); + } + + it = node->parent; + assert(MDOC_BLOCK == it->type); + assert(MDOC_It == it->tok); + + n = it->parent; + assert(MDOC_BODY == n->type); + assert(MDOC_Bl == n->tok); + n = n->parent; + bl = &n->data.block; + + /* If `-tag', adjust our margins accordingly. */ + + if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) { + i = arg_getattr(MDOC_Width, bl->argc, bl->argv); + assert(i >= 0); + assert(1 == bl->argv[i].sz); + width = strlen(*bl->argv[i].value); /* XXX */ + + if (MDOC_HEAD == node->type) { + flushln(p); + /* FIXME: nested lists. */ + p->rmargin = p->maxrmargin; + p->flags &= ~TERMP_NOBREAK; + } else { + flushln(p); + p->offset -= width + 1; + p->flags &= ~TERMP_NOLPAD; + } + } + + return(1); +} + + +/* ARGSUSED */ +static int +termp_it_pre(DECL_ARGS) +{ + const struct mdoc_node *n, *it; + const struct mdoc_block *bl; + int i; + size_t width; + + /* + * Also see termp_it_post() for general comments. + */ + + switch (node->type) { + case (MDOC_BODY): + /* FALLTHROUGH */ + case (MDOC_HEAD): + it = node->parent; + break; + case (MDOC_BLOCK): + it = node; + break; + default: + return(1); + } + + assert(MDOC_BLOCK == it->type); + assert(MDOC_It == it->tok); + + n = it->parent; + assert(MDOC_BODY == n->type); + assert(MDOC_Bl == n->tok); + n = n->parent; + bl = &n->data.block; + + /* If `-compact', don't assert vertical space. */ + + if (MDOC_BLOCK == node->type) { + if (arg_hasattr(MDOC_Compact, bl->argc, bl->argv)) + newln(p); + else + vspace(p); + return(1); + } + + assert(MDOC_HEAD == node->type + || MDOC_BODY == node->type); + + /* If `-tag', adjust our margins accordingly. */ + + if (arg_hasattr(MDOC_Tag, bl->argc, bl->argv)) { + i = arg_getattr(MDOC_Width, bl->argc, bl->argv); + assert(i >= 0); /* XXX */ + assert(1 == bl->argv[i].sz); + width = strlen(*bl->argv[i].value); /* XXX */ + + /* FIXME: nested lists. */ + + if (MDOC_HEAD == node->type) { + p->flags |= TERMP_NOBREAK; + p->flags |= TERMP_NOSPACE; + p->rmargin = p->offset + width; + } else { + p->flags |= TERMP_NOSPACE; + p->flags |= TERMP_NOLPAD; + p->offset += width + 1; + } + } + + return(1); +} + + +/* ARGSUSED */ +static int +termp_nm_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_PROG]; + return(1); +} + + +/* ARGSUSED */ +static int +termp_fl_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_CMD_FLAG]; + return(1); +} + + +/* ARGSUSED */ +static int +termp_ar_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_CMD_ARG]; + if (NULL == node->child) + word(p, "..."); + return(1); +} + + +/* ARGSUSED */ +static int +termp_nm_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_PROG]; + if (NULL == node->child) + word(p, meta->name); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ns_pre(DECL_ARGS) +{ + + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static int +termp_pp_pre(DECL_ARGS) +{ + + vspace(p); + return(1); +} + + +/* ARGSUSED */ +static int +termp_ar_post(DECL_ARGS) +{ + + p->flags &= ~ttypes[TTYPE_CMD_ARG]; + return(1); +} + + +/* ARGSUSED */ +static int +termp_ex_pre(DECL_ARGS) +{ + int i; + + i = arg_getattr(MDOC_Std, node->data.elem.argc, + node->data.elem.argv); + assert(i >= 0); + + word(p, "The"); + p->flags |= ttypes[TTYPE_PROG]; + word(p, *node->data.elem.argv[i].value); + p->flags &= ~ttypes[TTYPE_PROG]; + word(p, "utility exits 0 on success, and >0 if an error occurs."); + + return(1); +} + + +/* ARGSUSED */ +static int +termp_nd_pre(DECL_ARGS) +{ + + word(p, "\\-"); + return(1); +} + + +/* ARGSUSED */ +static int +termp_bl_post(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_BLOCK): + newln(p); + break; + default: + break; + } + return(1); +} + + +/* ARGSUSED */ +static int +termp_op_post(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_BODY): + p->flags |= TERMP_NOSPACE; + word(p, "\\]"); + break; + default: + break; + } + return(1); +} + + +/* ARGSUSED */ +static int +termp_sh_post(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_HEAD): + p->flags &= ~ttypes[TTYPE_SECTION]; + newln(p); + break; + case (MDOC_BODY): + newln(p); + p->offset -= 4; + break; + default: + break; + } + return(1); +} + + +/* ARGSUSED */ +static int +termp_xr_pre(DECL_ARGS) +{ + const struct mdoc_node *n; + + n = node->child; + assert(n); + + assert(MDOC_TEXT == n->type); + word(p, n->data.text.string); + + if (NULL == (n = n->next)) + return(0); + + assert(MDOC_TEXT == n->type); + p->flags |= TERMP_NOSPACE; + word(p, "\\("); + p->flags |= TERMP_NOSPACE; + word(p, n->data.text.string); + p->flags |= TERMP_NOSPACE; + word(p, "\\)"); + + return(0); +} + + +/* ARGSUSED */ +static int +termp_sh_pre(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_HEAD): + vspace(p); + p->flags |= ttypes[TTYPE_SECTION]; + break; + case (MDOC_BODY): + p->offset += 4; + break; + default: + break; + } + return(1); +} + + +/* ARGSUSED */ +static int +termp_op_pre(DECL_ARGS) +{ + + switch (node->type) { + case (MDOC_BODY): + word(p, "\\["); + p->flags |= TERMP_NOSPACE; + break; + default: + break; + } + return(1); +} + + +/* ARGSUSED */ +static int +termp_ud_pre(DECL_ARGS) +{ + + word(p, "currently under development."); + return(1); +} + + +/* ARGSUSED */ +static int +termp_fl_pre(DECL_ARGS) +{ + + p->flags |= ttypes[TTYPE_CMD_FLAG]; + word(p, "\\-"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static int +termp_d1_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + newln(p); + p->offset += 4; + return(1); +} + + +/* ARGSUSED */ +static int +termp_d1_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + newln(p); + p->offset -= 4; + return(1); +} + + +/* ARGSUSED */ +static int +termp_aq_pre(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + word(p, "\\<"); + p->flags |= TERMP_NOSPACE; + return(1); +} + + +/* ARGSUSED */ +static int +termp_aq_post(DECL_ARGS) +{ + + if (MDOC_BODY != node->type) + return(1); + p->flags |= TERMP_NOSPACE; + word(p, "\\>"); + return(1); +} + + +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); +} + |