[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.26

1.26    ! schwarze    1: /*     $OpenBSD: term_ascii.c,v 1.25 2014/10/28 17:35:42 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.1       schwarze   58:
1.6       schwarze   59:        p = mandoc_calloc(1, sizeof(struct termp));
1.1       schwarze   60:
1.25      schwarze   61:        p->symtab = mchars;
1.2       schwarze   62:        p->tabwidth = 5;
1.12      schwarze   63:        p->defrmargin = p->lastrmargin = 78;
1.2       schwarze   64:
1.1       schwarze   65:        p->begin = ascii_begin;
                     66:        p->end = ascii_end;
1.6       schwarze   67:        p->hspan = ascii_hspan;
                     68:        p->type = TERMTYPE_CHAR;
                     69:
                     70:        p->enc = TERMENC_ASCII;
                     71:        p->advance = ascii_advance;
1.1       schwarze   72:        p->endline = ascii_endline;
1.3       schwarze   73:        p->letter = ascii_letter;
1.12      schwarze   74:        p->setwidth = ascii_setwidth;
1.2       schwarze   75:        p->width = ascii_width;
1.1       schwarze   76:
1.6       schwarze   77:        if (TERMENC_ASCII != enc) {
                     78:                v = TERMENC_LOCALE == enc ?
1.14      schwarze   79:                    setlocale(LC_ALL, "") :
                     80:                    setlocale(LC_CTYPE, "en_US.UTF-8");
1.6       schwarze   81:                if (NULL != v && MB_CUR_MAX > 1) {
                     82:                        p->enc = enc;
                     83:                        p->advance = locale_advance;
                     84:                        p->endline = locale_endline;
                     85:                        p->letter = locale_letter;
                     86:                        p->width = locale_width;
                     87:                }
                     88:        }
                     89:
1.7       schwarze   90:        toks[0] = "indent";
                     91:        toks[1] = "width";
1.8       schwarze   92:        toks[2] = "mdoc";
1.21      schwarze   93:        toks[3] = "synopsis";
                     94:        toks[4] = NULL;
1.1       schwarze   95:
                     96:        while (outopts && *outopts)
                     97:                switch (getsubopt(&outopts, UNCONST(toks), &v)) {
1.14      schwarze   98:                case 0:
1.7       schwarze   99:                        p->defindent = (size_t)atoi(v);
                    100:                        break;
1.14      schwarze  101:                case 1:
1.1       schwarze  102:                        p->defrmargin = (size_t)atoi(v);
1.8       schwarze  103:                        break;
1.14      schwarze  104:                case 2:
1.9       schwarze  105:                        /*
                    106:                         * Temporary, undocumented mode
                    107:                         * to imitate mdoc(7) output style.
                    108:                         */
1.8       schwarze  109:                        p->mdocstyle = 1;
                    110:                        p->defindent = 5;
1.21      schwarze  111:                        break;
                    112:                case 3:
                    113:                        p->synopsisonly = 1;
1.1       schwarze  114:                        break;
                    115:                default:
                    116:                        break;
                    117:                }
                    118:
                    119:        /* Enforce a lower boundary. */
                    120:        if (p->defrmargin < 58)
                    121:                p->defrmargin = 58;
                    122:
                    123:        return(p);
1.2       schwarze  124: }
                    125:
1.6       schwarze  126: void *
1.25      schwarze  127: ascii_alloc(const struct mchars *mchars, char *outopts)
1.6       schwarze  128: {
                    129:
1.25      schwarze  130:        return(ascii_init(TERMENC_ASCII, mchars, outopts));
1.6       schwarze  131: }
                    132:
                    133: void *
1.25      schwarze  134: utf8_alloc(const struct mchars *mchars, char *outopts)
1.6       schwarze  135: {
                    136:
1.25      schwarze  137:        return(ascii_init(TERMENC_UTF8, mchars, outopts));
1.6       schwarze  138: }
                    139:
                    140: void *
1.25      schwarze  141: locale_alloc(const struct mchars *mchars, char *outopts)
1.6       schwarze  142: {
                    143:
1.25      schwarze  144:        return(ascii_init(TERMENC_LOCALE, mchars, outopts));
1.12      schwarze  145: }
                    146:
                    147: static void
1.13      schwarze  148: ascii_setwidth(struct termp *p, int iop, size_t width)
1.12      schwarze  149: {
                    150:
1.13      schwarze  151:        p->rmargin = p->defrmargin;
                    152:        if (0 < iop)
                    153:                p->defrmargin += width;
                    154:        else if (0 > iop)
                    155:                p->defrmargin -= width;
                    156:        else
                    157:                p->defrmargin = width ? width : p->lastrmargin;
                    158:        p->lastrmargin = p->rmargin;
                    159:        p->rmargin = p->maxrmargin = p->defrmargin;
1.6       schwarze  160: }
1.2       schwarze  161:
                    162: static size_t
1.6       schwarze  163: ascii_width(const struct termp *p, int c)
1.2       schwarze  164: {
                    165:
                    166:        return(1);
1.1       schwarze  167: }
                    168:
                    169: void
                    170: ascii_free(void *arg)
                    171: {
                    172:
                    173:        term_free((struct termp *)arg);
                    174: }
                    175:
                    176: static void
1.6       schwarze  177: ascii_letter(struct termp *p, int c)
1.1       schwarze  178: {
1.14      schwarze  179:
1.1       schwarze  180:        putchar(c);
                    181: }
                    182:
                    183: static void
                    184: ascii_begin(struct termp *p)
                    185: {
                    186:
                    187:        (*p->headf)(p, p->argf);
                    188: }
                    189:
                    190: static void
                    191: ascii_end(struct termp *p)
                    192: {
                    193:
                    194:        (*p->footf)(p, p->argf);
                    195: }
                    196:
                    197: static void
                    198: ascii_endline(struct termp *p)
                    199: {
                    200:
                    201:        putchar('\n');
                    202: }
                    203:
                    204: static void
                    205: ascii_advance(struct termp *p, size_t len)
                    206: {
1.14      schwarze  207:        size_t          i;
1.1       schwarze  208:
                    209:        for (i = 0; i < len; i++)
                    210:                putchar(' ');
                    211: }
1.3       schwarze  212:
                    213: static double
                    214: ascii_hspan(const struct termp *p, const struct roffsu *su)
                    215: {
                    216:        double           r;
                    217:
                    218:        /*
1.17      schwarze  219:         * Approximate based on character width.
                    220:         * None of these will be actually correct given that an inch on
                    221:         * the screen depends on character size, terminal, etc., etc.
1.3       schwarze  222:         */
                    223:        switch (su->unit) {
1.17      schwarze  224:        case SCALE_BU:
                    225:                r = su->scale * 10.0 / 240.0;
                    226:                break;
1.14      schwarze  227:        case SCALE_CM:
1.17      schwarze  228:                r = su->scale * 10.0 / 2.54;
                    229:                break;
                    230:        case SCALE_FS:
                    231:                r = su->scale * 2730.666;
1.3       schwarze  232:                break;
1.14      schwarze  233:        case SCALE_IN:
1.16      schwarze  234:                r = su->scale * 10.0;
1.3       schwarze  235:                break;
1.17      schwarze  236:        case SCALE_MM:
                    237:                r = su->scale / 100.0;
                    238:                break;
1.14      schwarze  239:        case SCALE_PC:
1.17      schwarze  240:                r = su->scale * 10.0 / 6.0;
1.3       schwarze  241:                break;
1.14      schwarze  242:        case SCALE_PT:
1.17      schwarze  243:                r = su->scale * 10.0 / 72.0;
1.3       schwarze  244:                break;
1.14      schwarze  245:        case SCALE_VS:
1.16      schwarze  246:                r = su->scale * 2.0 - 1.0;
1.3       schwarze  247:                break;
1.17      schwarze  248:        case SCALE_EN:
1.18      schwarze  249:                /* FALLTHROUGH */
1.17      schwarze  250:        case SCALE_EM:
1.3       schwarze  251:                r = su->scale;
1.17      schwarze  252:                break;
1.20      schwarze  253:        default:
1.17      schwarze  254:                abort();
1.18      schwarze  255:                /* NOTREACHED */
1.3       schwarze  256:        }
                    257:
                    258:        return(r);
1.22      schwarze  259: }
                    260:
                    261: const char *
                    262: ascii_uc2str(int uc)
                    263: {
                    264:        static const char nbrsp[2] = { ASCII_NBRSP, '\0' };
                    265:        static const char *tab[] = {
                    266:        "<NUL>","<SOH>","<STX>","<ETX>","<EOT>","<ENQ>","<ACK>","<BEL>",
                    267:        "<BS>", "\t",   "<LF>", "<VT>", "<FF>", "<CR>", "<SO>", "<SI>",
                    268:        "<DLE>","<DC1>","<DC2>","<DC3>","<DC4>","<NAK>","<SYN>","<ETB>",
                    269:        "<CAN>","<EM>", "<SUB>","<ESC>","<FS>", "<GS>", "<RS>", "<US>",
                    270:        " ",    "!",    "\"",   "#",    "$",    "%",    "&",    "'",
                    271:        "(",    ")",    "*",    "+",    ",",    "-",    ".",    "/",
                    272:        "0",    "1",    "2",    "3",    "4",    "5",    "6",    "7",
                    273:        "8",    "9",    ":",    ";",    "<",    "=",    ">",    "?",
                    274:        "@",    "A",    "B",    "C",    "D",    "E",    "F",    "G",
                    275:        "H",    "I",    "J",    "K",    "L",    "M",    "N",    "O",
                    276:        "P",    "Q",    "R",    "S",    "T",    "U",    "V",    "W",
                    277:        "X",    "Y",    "Z",    "[",    "\\",   "]",    "^",    "_",
                    278:        "`",    "a",    "b",    "c",    "d",    "e",    "f",    "g",
                    279:        "h",    "i",    "j",    "k",    "l",    "m",    "n",    "o",
                    280:        "p",    "q",    "r",    "s",    "t",    "u",    "v",    "w",
                    281:        "x",    "y",    "z",    "{",    "|",    "}",    "~",    "<DEL>",
                    282:        "<80>", "<81>", "<82>", "<83>", "<84>", "<85>", "<86>", "<87>",
                    283:        "<88>", "<89>", "<8A>", "<8B>", "<8C>", "<8D>", "<8E>", "<8F>",
                    284:        "<90>", "<91>", "<92>", "<93>", "<94>", "<95>", "<96>", "<97>",
                    285:        "<99>", "<99>", "<9A>", "<9B>", "<9C>", "<9D>", "<9E>", "<9F>",
1.24      schwarze  286:        nbrsp,  "!",    "/\bc", "GBP",  "o\bx", "=\bY", "|",    "<sec>",
                    287:        "\"",   "(C)",  "_\ba", "<<",   "~",    "",     "(R)",  "-",
                    288:        "<deg>","+-",   "2",    "3",    "'",    ",\bu", "<par>",".",
                    289:        ",",    "1",    "_\bo", ">>",   "1/4",  "1/2",  "3/4",  "?",
                    290:        "`\bA", "'\bA", "^\bA", "~\bA", "\"\bA","o\bA", "AE",   ",\bC",
                    291:        "`\bE", "'\bE", "^\bE", "\"\bE","`\bI", "'\bI", "^\bI", "\"\bI",
                    292:        "-\bD", "~\bN", "`\bO", "'\bO", "^\bO", "~\bO", "\"\bO","x",
                    293:        "/\bO", "`\bU", "'\bU", "^\bU", "\"\bU","'\bY", "Th",   "ss",
                    294:        "`\ba", "'\ba", "^\ba", "~\ba", "\"\ba","o\ba", "ae",   ",\bc",
                    295:        "`\be", "'\be", "^\be", "\"\be","`\bi", "'\bi", "^\bi", "\"\bi",
                    296:        "d",    "~\bn", "`\bo", "'\bo", "^\bo", "~\bo", "\"\bo","-:-",
                    297:        "/\bo", "`\bu", "'\bu", "^\bu", "\"\bu","'\by", "th",   "\"\by",
                    298:        "A",    "a",    "A",    "a",    "A",    "a",    "'\bC", "'\bc",
                    299:        "^\bC", "^\bc", "C",    "c",    "C",    "c",    "D",    "d",
                    300:        "/\bD", "/\bd", "E",    "e",    "E",    "e",    "E",    "e",
                    301:        "E",    "e",    "E",    "e",    "^\bG", "^\bg", "G",    "g",
                    302:        "G",    "g",    ",\bG", ",\bg", "^\bH", "^\bh", "/\bH", "/\bh",
                    303:        "~\bI", "~\bi", "I",    "i",    "I",    "i",    "I",    "i",
                    304:        "I",    "i",    "IJ",   "ij",   "^\bJ", "^\bj", ",\bK", ",\bk",
                    305:        "q",    "'\bL", "'\bl", ",\bL", ",\bl", "L",    "l",    "L",
                    306:        "l",    "/\bL", "/\bl", "'\bN", "'\bn", ",\bN", ",\bn", "N",
1.22      schwarze  307:        "n",    "'n",   "Ng",   "ng",   "O",    "o",    "O",    "o",
1.24      schwarze  308:        "O",    "o",    "OE",   "oe",   "'\bR", "'\br", ",\bR", ",\br",
                    309:        "R",    "r",    "'\bS", "'\bs", "^\bS", "^\bs", ",\bS", ",\bs",
                    310:        "S",    "s",    ",\bT", ",\bt", "T",    "t",    "/\bT", "/\bt",
                    311:        "~\bU", "~\bu", "U",    "u",    "U",    "u",    "U",    "u",
                    312:        "U",    "u",    "U",    "u",    "^\bW", "^\bw", "^\bY", "^\by",
                    313:        "\"\bY","'\bZ", "'\bz", "Z",    "z",    "Z",    "z",    "s",
1.22      schwarze  314:        "b",    "B",    "B",    "b",    "6",    "6",    "O",    "C",
                    315:        "c",    "D",    "D",    "D",    "d",    "d",    "3",    "@",
1.24      schwarze  316:        "E",    "F",    ",\bf", "G",    "G",    "hv",   "I",    "/\bI",
                    317:        "K",    "k",    "/\bl", "l",    "W",    "N",    "n",    "~\bO",
1.22      schwarze  318:        "O",    "o",    "OI",   "oi",   "P",    "p",    "YR",   "2",
                    319:        "2",    "SH",   "sh",   "t",    "T",    "t",    "T",    "U",
1.24      schwarze  320:        "u",    "Y",    "V",    "Y",    "y",    "/\bZ", "/\bz", "ZH",
                    321:        "ZH",   "zh",   "zh",   "/\b2", "5",    "5",    "ts",   "w",
1.22      schwarze  322:        "|",    "||",   "|=",   "!",    "DZ",   "Dz",   "dz",   "LJ",
                    323:        "Lj",   "lj",   "NJ",   "Nj",   "nj",   "A",    "a",    "I",
                    324:        "i",    "O",    "o",    "U",    "u",    "U",    "u",    "U",
                    325:        "u",    "U",    "u",    "U",    "u",    "@",    "A",    "a",
1.24      schwarze  326:        "A",    "a",    "AE",   "ae",   "/\bG", "/\bg", "G",    "g",
1.22      schwarze  327:        "K",    "k",    "O",    "o",    "O",    "o",    "ZH",   "zh",
1.24      schwarze  328:        "j",    "DZ",   "Dz",   "dz",   "'\bG", "'\bg", "HV",   "W",
                    329:        "`\bN", "`\bn", "A",    "a",    "'\bAE","'\bae","O",    "o"};
1.22      schwarze  330:
1.26    ! schwarze  331:        assert(uc >= 0);
1.23      schwarze  332:        if ((size_t)uc < sizeof(tab)/sizeof(tab[0]))
                    333:                return(tab[uc]);
                    334:        return(mchars_uc2str(uc));
1.3       schwarze  335: }
                    336:
1.6       schwarze  337: static size_t
                    338: locale_width(const struct termp *p, int c)
                    339: {
                    340:        int             rc;
                    341:
1.15      schwarze  342:        if (c == ASCII_NBRSP)
                    343:                c = ' ';
                    344:        rc = wcwidth(c);
                    345:        if (rc < 0)
                    346:                rc = 0;
                    347:        return(rc);
1.6       schwarze  348: }
                    349:
                    350: static void
                    351: locale_advance(struct termp *p, size_t len)
                    352: {
1.14      schwarze  353:        size_t          i;
1.6       schwarze  354:
                    355:        for (i = 0; i < len; i++)
                    356:                putwchar(L' ');
                    357: }
                    358:
                    359: static void
                    360: locale_endline(struct termp *p)
                    361: {
                    362:
                    363:        putwchar(L'\n');
                    364: }
                    365:
                    366: static void
                    367: locale_letter(struct termp *p, int c)
                    368: {
1.14      schwarze  369:
1.6       schwarze  370:        putwchar(c);
                    371: }