[BACK]Return to term_ascii.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/term_ascii.c, Revision 1.30

1.30    ! tedu        1: /*     $OpenBSD: term_ascii.c,v 1.29 2014/12/31 16:50:54 schwarze Exp $ */
1.1       schwarze    2: /*
1.6       schwarze    3:  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.12      schwarze    4:  * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1       schwarze    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
                      7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     17:  */
                     18: #include <sys/types.h>
                     19:
1.26      schwarze   20: #include <assert.h>
1.6       schwarze   21: #include <locale.h>
1.1       schwarze   22: #include <stdint.h>
                     23: #include <stdio.h>
                     24: #include <stdlib.h>
                     25: #include <unistd.h>
1.6       schwarze   26: #include <wchar.h>
1.1       schwarze   27:
1.4       schwarze   28: #include "mandoc.h"
1.11      schwarze   29: #include "mandoc_aux.h"
1.1       schwarze   30: #include "out.h"
                     31: #include "term.h"
                     32: #include "main.h"
                     33:
1.25      schwarze   34: static struct termp     *ascii_init(enum termenc,
                     35:                                const struct mchars *, char *);
1.3       schwarze   36: static double            ascii_hspan(const struct termp *,
                     37:                                const struct roffsu *);
1.6       schwarze   38: static size_t            ascii_width(const struct termp *, int);
1.3       schwarze   39: static void              ascii_advance(struct termp *, size_t);
                     40: static void              ascii_begin(struct termp *);
                     41: static void              ascii_end(struct termp *);
1.1       schwarze   42: static void              ascii_endline(struct termp *);
1.6       schwarze   43: static void              ascii_letter(struct termp *, int);
1.13      schwarze   44: static void              ascii_setwidth(struct termp *, int, size_t);
1.1       schwarze   45:
1.6       schwarze   46: static void              locale_advance(struct termp *, size_t);
                     47: static void              locale_endline(struct termp *);
                     48: static void              locale_letter(struct termp *, int);
                     49: static size_t            locale_width(const struct termp *, int);
1.1       schwarze   50:
1.14      schwarze   51:
1.6       schwarze   52: static struct termp *
1.25      schwarze   53: ascii_init(enum termenc enc, const struct mchars *mchars, char *outopts)
1.1       schwarze   54: {
1.21      schwarze   55:        const char      *toks[5];
1.1       schwarze   56:        char            *v;
1.6       schwarze   57:        struct termp    *p;
1.30    ! tedu       58:        const char      *errstr;
        !            59:        int             num;
1.1       schwarze   60:
1.6       schwarze   61:        p = mandoc_calloc(1, sizeof(struct termp));
1.1       schwarze   62:
1.25      schwarze   63:        p->symtab = mchars;
1.2       schwarze   64:        p->tabwidth = 5;
1.12      schwarze   65:        p->defrmargin = p->lastrmargin = 78;
1.28      schwarze   66:        p->fontq = mandoc_reallocarray(NULL,
                     67:             (p->fontsz = 8), sizeof(enum termfont));
                     68:        p->fontq[0] = p->fontl = TERMFONT_NONE;
1.2       schwarze   69:
1.1       schwarze   70:        p->begin = ascii_begin;
                     71:        p->end = ascii_end;
1.6       schwarze   72:        p->hspan = ascii_hspan;
                     73:        p->type = TERMTYPE_CHAR;
                     74:
                     75:        p->enc = TERMENC_ASCII;
                     76:        p->advance = ascii_advance;
1.1       schwarze   77:        p->endline = ascii_endline;
1.3       schwarze   78:        p->letter = ascii_letter;
1.12      schwarze   79:        p->setwidth = ascii_setwidth;
1.2       schwarze   80:        p->width = ascii_width;
1.1       schwarze   81:
1.6       schwarze   82:        if (TERMENC_ASCII != enc) {
                     83:                v = TERMENC_LOCALE == enc ?
1.14      schwarze   84:                    setlocale(LC_ALL, "") :
                     85:                    setlocale(LC_CTYPE, "en_US.UTF-8");
1.6       schwarze   86:                if (NULL != v && MB_CUR_MAX > 1) {
                     87:                        p->enc = enc;
                     88:                        p->advance = locale_advance;
                     89:                        p->endline = locale_endline;
                     90:                        p->letter = locale_letter;
                     91:                        p->width = locale_width;
                     92:                }
                     93:        }
                     94:
1.7       schwarze   95:        toks[0] = "indent";
                     96:        toks[1] = "width";
1.8       schwarze   97:        toks[2] = "mdoc";
1.21      schwarze   98:        toks[3] = "synopsis";
                     99:        toks[4] = NULL;
1.1       schwarze  100:
                    101:        while (outopts && *outopts)
                    102:                switch (getsubopt(&outopts, UNCONST(toks), &v)) {
1.14      schwarze  103:                case 0:
1.30    ! tedu      104:                        num = strtonum(v, 0, 1000, &errstr);
        !           105:                        if (!errstr)
        !           106:                                p->defindent = num;
1.7       schwarze  107:                        break;
1.14      schwarze  108:                case 1:
1.30    ! tedu      109:                        num = strtonum(v, 0, 1000, &errstr);
        !           110:                        if (!errstr)
        !           111:                                p->defrmargin = num;
1.8       schwarze  112:                        break;
1.14      schwarze  113:                case 2:
1.9       schwarze  114:                        /*
                    115:                         * Temporary, undocumented mode
                    116:                         * to imitate mdoc(7) output style.
                    117:                         */
1.8       schwarze  118:                        p->mdocstyle = 1;
                    119:                        p->defindent = 5;
1.21      schwarze  120:                        break;
                    121:                case 3:
                    122:                        p->synopsisonly = 1;
1.1       schwarze  123:                        break;
                    124:                default:
                    125:                        break;
                    126:                }
                    127:
                    128:        /* Enforce a lower boundary. */
                    129:        if (p->defrmargin < 58)
                    130:                p->defrmargin = 58;
                    131:
                    132:        return(p);
1.2       schwarze  133: }
                    134:
1.6       schwarze  135: void *
1.25      schwarze  136: ascii_alloc(const struct mchars *mchars, char *outopts)
1.6       schwarze  137: {
                    138:
1.25      schwarze  139:        return(ascii_init(TERMENC_ASCII, mchars, outopts));
1.6       schwarze  140: }
                    141:
                    142: void *
1.25      schwarze  143: utf8_alloc(const struct mchars *mchars, char *outopts)
1.6       schwarze  144: {
                    145:
1.25      schwarze  146:        return(ascii_init(TERMENC_UTF8, mchars, outopts));
1.6       schwarze  147: }
                    148:
                    149: void *
1.25      schwarze  150: locale_alloc(const struct mchars *mchars, char *outopts)
1.6       schwarze  151: {
                    152:
1.25      schwarze  153:        return(ascii_init(TERMENC_LOCALE, mchars, outopts));
1.12      schwarze  154: }
                    155:
                    156: static void
1.13      schwarze  157: ascii_setwidth(struct termp *p, int iop, size_t width)
1.12      schwarze  158: {
                    159:
1.13      schwarze  160:        p->rmargin = p->defrmargin;
1.27      schwarze  161:        if (iop > 0)
1.13      schwarze  162:                p->defrmargin += width;
1.27      schwarze  163:        else if (iop == 0)
                    164:                p->defrmargin = width ? width : p->lastrmargin;
                    165:        else if (p->defrmargin > width)
1.13      schwarze  166:                p->defrmargin -= width;
                    167:        else
1.27      schwarze  168:                p->defrmargin = 0;
1.13      schwarze  169:        p->lastrmargin = p->rmargin;
                    170:        p->rmargin = p->maxrmargin = p->defrmargin;
1.29      schwarze  171: }
                    172:
                    173: void
                    174: ascii_sepline(void *arg)
                    175: {
                    176:        struct termp    *p;
                    177:        size_t           i;
                    178:
                    179:        p = (struct termp *)arg;
                    180:        putchar('\n');
                    181:        for (i = 0; i < p->defrmargin; i++)
                    182:                putchar('-');
                    183:        putchar('\n');
                    184:        putchar('\n');
1.6       schwarze  185: }
1.2       schwarze  186:
                    187: static size_t
1.6       schwarze  188: ascii_width(const struct termp *p, int c)
1.2       schwarze  189: {
                    190:
                    191:        return(1);
1.1       schwarze  192: }
                    193:
                    194: void
                    195: ascii_free(void *arg)
                    196: {
                    197:
                    198:        term_free((struct termp *)arg);
                    199: }
                    200:
                    201: static void
1.6       schwarze  202: ascii_letter(struct termp *p, int c)
1.1       schwarze  203: {
1.14      schwarze  204:
1.1       schwarze  205:        putchar(c);
                    206: }
                    207:
                    208: static void
                    209: ascii_begin(struct termp *p)
                    210: {
                    211:
                    212:        (*p->headf)(p, p->argf);
                    213: }
                    214:
                    215: static void
                    216: ascii_end(struct termp *p)
                    217: {
                    218:
                    219:        (*p->footf)(p, p->argf);
                    220: }
                    221:
                    222: static void
                    223: ascii_endline(struct termp *p)
                    224: {
                    225:
                    226:        putchar('\n');
                    227: }
                    228:
                    229: static void
                    230: ascii_advance(struct termp *p, size_t len)
                    231: {
1.14      schwarze  232:        size_t          i;
1.1       schwarze  233:
                    234:        for (i = 0; i < len; i++)
                    235:                putchar(' ');
                    236: }
1.3       schwarze  237:
                    238: static double
                    239: ascii_hspan(const struct termp *p, const struct roffsu *su)
                    240: {
                    241:        double           r;
                    242:
                    243:        /*
1.17      schwarze  244:         * Approximate based on character width.
                    245:         * None of these will be actually correct given that an inch on
                    246:         * the screen depends on character size, terminal, etc., etc.
1.3       schwarze  247:         */
                    248:        switch (su->unit) {
1.17      schwarze  249:        case SCALE_BU:
                    250:                r = su->scale * 10.0 / 240.0;
                    251:                break;
1.14      schwarze  252:        case SCALE_CM:
1.17      schwarze  253:                r = su->scale * 10.0 / 2.54;
                    254:                break;
                    255:        case SCALE_FS:
                    256:                r = su->scale * 2730.666;
1.3       schwarze  257:                break;
1.14      schwarze  258:        case SCALE_IN:
1.16      schwarze  259:                r = su->scale * 10.0;
1.3       schwarze  260:                break;
1.17      schwarze  261:        case SCALE_MM:
                    262:                r = su->scale / 100.0;
                    263:                break;
1.14      schwarze  264:        case SCALE_PC:
1.17      schwarze  265:                r = su->scale * 10.0 / 6.0;
1.3       schwarze  266:                break;
1.14      schwarze  267:        case SCALE_PT:
1.17      schwarze  268:                r = su->scale * 10.0 / 72.0;
1.3       schwarze  269:                break;
1.14      schwarze  270:        case SCALE_VS:
1.16      schwarze  271:                r = su->scale * 2.0 - 1.0;
1.3       schwarze  272:                break;
1.17      schwarze  273:        case SCALE_EN:
1.18      schwarze  274:                /* FALLTHROUGH */
1.17      schwarze  275:        case SCALE_EM:
1.3       schwarze  276:                r = su->scale;
1.17      schwarze  277:                break;
1.20      schwarze  278:        default:
1.17      schwarze  279:                abort();
1.18      schwarze  280:                /* NOTREACHED */
1.3       schwarze  281:        }
                    282:
                    283:        return(r);
1.22      schwarze  284: }
                    285:
                    286: const char *
                    287: ascii_uc2str(int uc)
                    288: {
                    289:        static const char nbrsp[2] = { ASCII_NBRSP, '\0' };
                    290:        static const char *tab[] = {
                    291:        "<NUL>","<SOH>","<STX>","<ETX>","<EOT>","<ENQ>","<ACK>","<BEL>",
                    292:        "<BS>", "\t",   "<LF>", "<VT>", "<FF>", "<CR>", "<SO>", "<SI>",
                    293:        "<DLE>","<DC1>","<DC2>","<DC3>","<DC4>","<NAK>","<SYN>","<ETB>",
                    294:        "<CAN>","<EM>", "<SUB>","<ESC>","<FS>", "<GS>", "<RS>", "<US>",
                    295:        " ",    "!",    "\"",   "#",    "$",    "%",    "&",    "'",
                    296:        "(",    ")",    "*",    "+",    ",",    "-",    ".",    "/",
                    297:        "0",    "1",    "2",    "3",    "4",    "5",    "6",    "7",
                    298:        "8",    "9",    ":",    ";",    "<",    "=",    ">",    "?",
                    299:        "@",    "A",    "B",    "C",    "D",    "E",    "F",    "G",
                    300:        "H",    "I",    "J",    "K",    "L",    "M",    "N",    "O",
                    301:        "P",    "Q",    "R",    "S",    "T",    "U",    "V",    "W",
                    302:        "X",    "Y",    "Z",    "[",    "\\",   "]",    "^",    "_",
                    303:        "`",    "a",    "b",    "c",    "d",    "e",    "f",    "g",
                    304:        "h",    "i",    "j",    "k",    "l",    "m",    "n",    "o",
                    305:        "p",    "q",    "r",    "s",    "t",    "u",    "v",    "w",
                    306:        "x",    "y",    "z",    "{",    "|",    "}",    "~",    "<DEL>",
                    307:        "<80>", "<81>", "<82>", "<83>", "<84>", "<85>", "<86>", "<87>",
                    308:        "<88>", "<89>", "<8A>", "<8B>", "<8C>", "<8D>", "<8E>", "<8F>",
                    309:        "<90>", "<91>", "<92>", "<93>", "<94>", "<95>", "<96>", "<97>",
                    310:        "<99>", "<99>", "<9A>", "<9B>", "<9C>", "<9D>", "<9E>", "<9F>",
1.24      schwarze  311:        nbrsp,  "!",    "/\bc", "GBP",  "o\bx", "=\bY", "|",    "<sec>",
                    312:        "\"",   "(C)",  "_\ba", "<<",   "~",    "",     "(R)",  "-",
                    313:        "<deg>","+-",   "2",    "3",    "'",    ",\bu", "<par>",".",
                    314:        ",",    "1",    "_\bo", ">>",   "1/4",  "1/2",  "3/4",  "?",
                    315:        "`\bA", "'\bA", "^\bA", "~\bA", "\"\bA","o\bA", "AE",   ",\bC",
                    316:        "`\bE", "'\bE", "^\bE", "\"\bE","`\bI", "'\bI", "^\bI", "\"\bI",
                    317:        "-\bD", "~\bN", "`\bO", "'\bO", "^\bO", "~\bO", "\"\bO","x",
                    318:        "/\bO", "`\bU", "'\bU", "^\bU", "\"\bU","'\bY", "Th",   "ss",
                    319:        "`\ba", "'\ba", "^\ba", "~\ba", "\"\ba","o\ba", "ae",   ",\bc",
                    320:        "`\be", "'\be", "^\be", "\"\be","`\bi", "'\bi", "^\bi", "\"\bi",
                    321:        "d",    "~\bn", "`\bo", "'\bo", "^\bo", "~\bo", "\"\bo","-:-",
                    322:        "/\bo", "`\bu", "'\bu", "^\bu", "\"\bu","'\by", "th",   "\"\by",
                    323:        "A",    "a",    "A",    "a",    "A",    "a",    "'\bC", "'\bc",
                    324:        "^\bC", "^\bc", "C",    "c",    "C",    "c",    "D",    "d",
                    325:        "/\bD", "/\bd", "E",    "e",    "E",    "e",    "E",    "e",
                    326:        "E",    "e",    "E",    "e",    "^\bG", "^\bg", "G",    "g",
                    327:        "G",    "g",    ",\bG", ",\bg", "^\bH", "^\bh", "/\bH", "/\bh",
                    328:        "~\bI", "~\bi", "I",    "i",    "I",    "i",    "I",    "i",
                    329:        "I",    "i",    "IJ",   "ij",   "^\bJ", "^\bj", ",\bK", ",\bk",
                    330:        "q",    "'\bL", "'\bl", ",\bL", ",\bl", "L",    "l",    "L",
                    331:        "l",    "/\bL", "/\bl", "'\bN", "'\bn", ",\bN", ",\bn", "N",
1.22      schwarze  332:        "n",    "'n",   "Ng",   "ng",   "O",    "o",    "O",    "o",
1.24      schwarze  333:        "O",    "o",    "OE",   "oe",   "'\bR", "'\br", ",\bR", ",\br",
                    334:        "R",    "r",    "'\bS", "'\bs", "^\bS", "^\bs", ",\bS", ",\bs",
                    335:        "S",    "s",    ",\bT", ",\bt", "T",    "t",    "/\bT", "/\bt",
                    336:        "~\bU", "~\bu", "U",    "u",    "U",    "u",    "U",    "u",
                    337:        "U",    "u",    "U",    "u",    "^\bW", "^\bw", "^\bY", "^\by",
                    338:        "\"\bY","'\bZ", "'\bz", "Z",    "z",    "Z",    "z",    "s",
1.22      schwarze  339:        "b",    "B",    "B",    "b",    "6",    "6",    "O",    "C",
                    340:        "c",    "D",    "D",    "D",    "d",    "d",    "3",    "@",
1.24      schwarze  341:        "E",    "F",    ",\bf", "G",    "G",    "hv",   "I",    "/\bI",
                    342:        "K",    "k",    "/\bl", "l",    "W",    "N",    "n",    "~\bO",
1.22      schwarze  343:        "O",    "o",    "OI",   "oi",   "P",    "p",    "YR",   "2",
                    344:        "2",    "SH",   "sh",   "t",    "T",    "t",    "T",    "U",
1.24      schwarze  345:        "u",    "Y",    "V",    "Y",    "y",    "/\bZ", "/\bz", "ZH",
                    346:        "ZH",   "zh",   "zh",   "/\b2", "5",    "5",    "ts",   "w",
1.22      schwarze  347:        "|",    "||",   "|=",   "!",    "DZ",   "Dz",   "dz",   "LJ",
                    348:        "Lj",   "lj",   "NJ",   "Nj",   "nj",   "A",    "a",    "I",
                    349:        "i",    "O",    "o",    "U",    "u",    "U",    "u",    "U",
                    350:        "u",    "U",    "u",    "U",    "u",    "@",    "A",    "a",
1.24      schwarze  351:        "A",    "a",    "AE",   "ae",   "/\bG", "/\bg", "G",    "g",
1.22      schwarze  352:        "K",    "k",    "O",    "o",    "O",    "o",    "ZH",   "zh",
1.24      schwarze  353:        "j",    "DZ",   "Dz",   "dz",   "'\bG", "'\bg", "HV",   "W",
                    354:        "`\bN", "`\bn", "A",    "a",    "'\bAE","'\bae","O",    "o"};
1.22      schwarze  355:
1.26      schwarze  356:        assert(uc >= 0);
1.23      schwarze  357:        if ((size_t)uc < sizeof(tab)/sizeof(tab[0]))
                    358:                return(tab[uc]);
                    359:        return(mchars_uc2str(uc));
1.3       schwarze  360: }
                    361:
1.6       schwarze  362: static size_t
                    363: locale_width(const struct termp *p, int c)
                    364: {
                    365:        int             rc;
                    366:
1.15      schwarze  367:        if (c == ASCII_NBRSP)
                    368:                c = ' ';
                    369:        rc = wcwidth(c);
                    370:        if (rc < 0)
                    371:                rc = 0;
                    372:        return(rc);
1.6       schwarze  373: }
                    374:
                    375: static void
                    376: locale_advance(struct termp *p, size_t len)
                    377: {
1.14      schwarze  378:        size_t          i;
1.6       schwarze  379:
                    380:        for (i = 0; i < len; i++)
                    381:                putwchar(L' ');
                    382: }
                    383:
                    384: static void
                    385: locale_endline(struct termp *p)
                    386: {
                    387:
                    388:        putwchar(L'\n');
                    389: }
                    390:
                    391: static void
                    392: locale_letter(struct termp *p, int c)
                    393: {
1.14      schwarze  394:
1.6       schwarze  395:        putwchar(c);
                    396: }