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

1.46    ! schwarze    1: /*     $OpenBSD: term_ascii.c,v 1.45 2018/04/13 18:29:19 schwarze Exp $ */
1.1       schwarze    2: /*
1.6       schwarze    3:  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.45      schwarze    4:  * Copyright (c) 2014, 2015, 2017, 2018 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:  *
1.31      schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1       schwarze   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.31      schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1       schwarze   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.45      schwarze   21: #include <langinfo.h>
1.6       schwarze   22: #include <locale.h>
1.1       schwarze   23: #include <stdint.h>
                     24: #include <stdio.h>
                     25: #include <stdlib.h>
1.45      schwarze   26: #include <string.h>
1.1       schwarze   27: #include <unistd.h>
1.6       schwarze   28: #include <wchar.h>
1.1       schwarze   29:
1.4       schwarze   30: #include "mandoc.h"
1.11      schwarze   31: #include "mandoc_aux.h"
1.1       schwarze   32: #include "out.h"
                     33: #include "term.h"
1.31      schwarze   34: #include "manconf.h"
1.1       schwarze   35: #include "main.h"
                     36:
1.37      schwarze   37: static struct termp     *ascii_init(enum termenc, const struct manoutput *);
1.32      schwarze   38: static int               ascii_hspan(const struct termp *,
1.3       schwarze   39:                                const struct roffsu *);
1.6       schwarze   40: static size_t            ascii_width(const struct termp *, int);
1.3       schwarze   41: static void              ascii_advance(struct termp *, size_t);
                     42: static void              ascii_begin(struct termp *);
                     43: static void              ascii_end(struct termp *);
1.1       schwarze   44: static void              ascii_endline(struct termp *);
1.6       schwarze   45: static void              ascii_letter(struct termp *, int);
1.32      schwarze   46: static void              ascii_setwidth(struct termp *, int, int);
1.1       schwarze   47:
1.6       schwarze   48: static void              locale_advance(struct termp *, size_t);
                     49: static void              locale_endline(struct termp *);
                     50: static void              locale_letter(struct termp *, int);
                     51: static size_t            locale_width(const struct termp *, int);
1.1       schwarze   52:
1.14      schwarze   53:
1.6       schwarze   54: static struct termp *
1.37      schwarze   55: ascii_init(enum termenc enc, const struct manoutput *outopts)
1.1       schwarze   56: {
                     57:        char            *v;
1.6       schwarze   58:        struct termp    *p;
1.1       schwarze   59:
1.42      schwarze   60:        p = mandoc_calloc(1, sizeof(*p));
                     61:        p->tcol = p->tcols = mandoc_calloc(1, sizeof(*p->tcol));
                     62:        p->maxtcol = 1;
1.1       schwarze   63:
1.33      schwarze   64:        p->line = 1;
1.12      schwarze   65:        p->defrmargin = p->lastrmargin = 78;
1.28      schwarze   66:        p->fontq = mandoc_reallocarray(NULL,
1.42      schwarze   67:             (p->fontsz = 8), sizeof(*p->fontq));
1.28      schwarze   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) {
1.38      schwarze   83:
                     84:                /*
                     85:                 * Do not change any of this to LC_ALL.  It might break
                     86:                 * the formatting by subtly changing the behaviour of
                     87:                 * various functions, for example strftime(3).  As a
                     88:                 * worst case, it might even cause buffer overflows.
                     89:                 */
                     90:
1.6       schwarze   91:                v = TERMENC_LOCALE == enc ?
1.38      schwarze   92:                    setlocale(LC_CTYPE, "") :
1.14      schwarze   93:                    setlocale(LC_CTYPE, "en_US.UTF-8");
1.45      schwarze   94:
                     95:                /*
                     96:                 * We only support UTF-8,
                     97:                 * so revert to ASCII for anything else.
                     98:                 */
                     99:
                    100:                if (v != NULL &&
                    101:                    strcmp(nl_langinfo(CODESET), "UTF-8") != 0)
                    102:                        v = setlocale(LC_CTYPE, "C");
                    103:
                    104:                if (v != NULL && MB_CUR_MAX > 1) {
1.6       schwarze  105:                        p->enc = enc;
                    106:                        p->advance = locale_advance;
                    107:                        p->endline = locale_endline;
                    108:                        p->letter = locale_letter;
                    109:                        p->width = locale_width;
                    110:                }
                    111:        }
                    112:
1.31      schwarze  113:        if (outopts->mdoc) {
                    114:                p->mdocstyle = 1;
                    115:                p->defindent = 5;
                    116:        }
                    117:        if (outopts->indent)
                    118:                p->defindent = outopts->indent;
                    119:        if (outopts->width)
                    120:                p->defrmargin = outopts->width;
                    121:        if (outopts->synopsisonly)
                    122:                p->synopsisonly = 1;
1.1       schwarze  123:
1.46    ! schwarze  124:        assert(p->defindent < UINT16_MAX);
        !           125:        assert(p->defrmargin < UINT16_MAX);
1.35      schwarze  126:        return p;
1.2       schwarze  127: }
                    128:
1.6       schwarze  129: void *
1.37      schwarze  130: ascii_alloc(const struct manoutput *outopts)
1.6       schwarze  131: {
                    132:
1.37      schwarze  133:        return ascii_init(TERMENC_ASCII, outopts);
1.6       schwarze  134: }
                    135:
                    136: void *
1.37      schwarze  137: utf8_alloc(const struct manoutput *outopts)
1.6       schwarze  138: {
                    139:
1.37      schwarze  140:        return ascii_init(TERMENC_UTF8, outopts);
1.6       schwarze  141: }
                    142:
                    143: void *
1.37      schwarze  144: locale_alloc(const struct manoutput *outopts)
1.6       schwarze  145: {
                    146:
1.37      schwarze  147:        return ascii_init(TERMENC_LOCALE, outopts);
1.12      schwarze  148: }
                    149:
                    150: static void
1.32      schwarze  151: ascii_setwidth(struct termp *p, int iop, int width)
1.12      schwarze  152: {
                    153:
1.32      schwarze  154:        width /= 24;
1.42      schwarze  155:        p->tcol->rmargin = p->defrmargin;
1.27      schwarze  156:        if (iop > 0)
1.13      schwarze  157:                p->defrmargin += width;
1.27      schwarze  158:        else if (iop == 0)
1.32      schwarze  159:                p->defrmargin = width ? (size_t)width : p->lastrmargin;
                    160:        else if (p->defrmargin > (size_t)width)
1.13      schwarze  161:                p->defrmargin -= width;
                    162:        else
1.27      schwarze  163:                p->defrmargin = 0;
1.46    ! schwarze  164:        if (p->defrmargin > 1000)
        !           165:                p->defrmargin = 1000;
1.42      schwarze  166:        p->lastrmargin = p->tcol->rmargin;
                    167:        p->tcol->rmargin = p->maxrmargin = p->defrmargin;
1.29      schwarze  168: }
                    169:
                    170: void
1.39      schwarze  171: terminal_sepline(void *arg)
1.29      schwarze  172: {
                    173:        struct termp    *p;
                    174:        size_t           i;
                    175:
                    176:        p = (struct termp *)arg;
1.39      schwarze  177:        (*p->endline)(p);
1.29      schwarze  178:        for (i = 0; i < p->defrmargin; i++)
1.39      schwarze  179:                (*p->letter)(p, '-');
                    180:        (*p->endline)(p);
                    181:        (*p->endline)(p);
1.6       schwarze  182: }
1.2       schwarze  183:
                    184: static size_t
1.6       schwarze  185: ascii_width(const struct termp *p, int c)
1.2       schwarze  186: {
                    187:
1.35      schwarze  188:        return 1;
1.1       schwarze  189: }
                    190:
                    191: void
                    192: ascii_free(void *arg)
                    193: {
                    194:
                    195:        term_free((struct termp *)arg);
                    196: }
                    197:
                    198: static void
1.6       schwarze  199: ascii_letter(struct termp *p, int c)
1.1       schwarze  200: {
1.14      schwarze  201:
1.1       schwarze  202:        putchar(c);
                    203: }
                    204:
                    205: static void
                    206: ascii_begin(struct termp *p)
                    207: {
                    208:
                    209:        (*p->headf)(p, p->argf);
                    210: }
                    211:
                    212: static void
                    213: ascii_end(struct termp *p)
                    214: {
                    215:
                    216:        (*p->footf)(p, p->argf);
                    217: }
                    218:
                    219: static void
                    220: ascii_endline(struct termp *p)
                    221: {
                    222:
1.33      schwarze  223:        p->line++;
1.42      schwarze  224:        p->tcol->offset -= p->ti;
1.41      schwarze  225:        p->ti = 0;
1.1       schwarze  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:
1.46    ! schwarze  234:        assert(len < UINT16_MAX);
1.1       schwarze  235:        for (i = 0; i < len; i++)
                    236:                putchar(' ');
                    237: }
1.3       schwarze  238:
1.32      schwarze  239: static int
1.3       schwarze  240: ascii_hspan(const struct termp *p, const struct roffsu *su)
                    241: {
                    242:        double           r;
                    243:
                    244:        switch (su->unit) {
1.17      schwarze  245:        case SCALE_BU:
1.32      schwarze  246:                r = su->scale;
1.17      schwarze  247:                break;
1.14      schwarze  248:        case SCALE_CM:
1.32      schwarze  249:                r = su->scale * 240.0 / 2.54;
1.17      schwarze  250:                break;
                    251:        case SCALE_FS:
1.32      schwarze  252:                r = su->scale * 65536.0;
1.3       schwarze  253:                break;
1.14      schwarze  254:        case SCALE_IN:
1.32      schwarze  255:                r = su->scale * 240.0;
1.3       schwarze  256:                break;
1.17      schwarze  257:        case SCALE_MM:
1.32      schwarze  258:                r = su->scale * 0.24;
1.17      schwarze  259:                break;
1.32      schwarze  260:        case SCALE_VS:
1.14      schwarze  261:        case SCALE_PC:
1.32      schwarze  262:                r = su->scale * 40.0;
1.3       schwarze  263:                break;
1.14      schwarze  264:        case SCALE_PT:
1.32      schwarze  265:                r = su->scale * 10.0 / 3.0;
1.3       schwarze  266:                break;
1.17      schwarze  267:        case SCALE_EN:
                    268:        case SCALE_EM:
1.32      schwarze  269:                r = su->scale * 24.0;
1.17      schwarze  270:                break;
1.20      schwarze  271:        default:
1.17      schwarze  272:                abort();
1.3       schwarze  273:        }
1.35      schwarze  274:        return r > 0.0 ? r + 0.01 : r - 0.01;
1.22      schwarze  275: }
                    276:
                    277: const char *
                    278: ascii_uc2str(int uc)
                    279: {
                    280:        static const char nbrsp[2] = { ASCII_NBRSP, '\0' };
                    281:        static const char *tab[] = {
                    282:        "<NUL>","<SOH>","<STX>","<ETX>","<EOT>","<ENQ>","<ACK>","<BEL>",
                    283:        "<BS>", "\t",   "<LF>", "<VT>", "<FF>", "<CR>", "<SO>", "<SI>",
                    284:        "<DLE>","<DC1>","<DC2>","<DC3>","<DC4>","<NAK>","<SYN>","<ETB>",
                    285:        "<CAN>","<EM>", "<SUB>","<ESC>","<FS>", "<GS>", "<RS>", "<US>",
                    286:        " ",    "!",    "\"",   "#",    "$",    "%",    "&",    "'",
                    287:        "(",    ")",    "*",    "+",    ",",    "-",    ".",    "/",
                    288:        "0",    "1",    "2",    "3",    "4",    "5",    "6",    "7",
                    289:        "8",    "9",    ":",    ";",    "<",    "=",    ">",    "?",
                    290:        "@",    "A",    "B",    "C",    "D",    "E",    "F",    "G",
                    291:        "H",    "I",    "J",    "K",    "L",    "M",    "N",    "O",
                    292:        "P",    "Q",    "R",    "S",    "T",    "U",    "V",    "W",
                    293:        "X",    "Y",    "Z",    "[",    "\\",   "]",    "^",    "_",
                    294:        "`",    "a",    "b",    "c",    "d",    "e",    "f",    "g",
                    295:        "h",    "i",    "j",    "k",    "l",    "m",    "n",    "o",
                    296:        "p",    "q",    "r",    "s",    "t",    "u",    "v",    "w",
                    297:        "x",    "y",    "z",    "{",    "|",    "}",    "~",    "<DEL>",
                    298:        "<80>", "<81>", "<82>", "<83>", "<84>", "<85>", "<86>", "<87>",
                    299:        "<88>", "<89>", "<8A>", "<8B>", "<8C>", "<8D>", "<8E>", "<8F>",
                    300:        "<90>", "<91>", "<92>", "<93>", "<94>", "<95>", "<96>", "<97>",
1.43      schwarze  301:        "<98>", "<99>", "<9A>", "<9B>", "<9C>", "<9D>", "<9E>", "<9F>",
1.44      schwarze  302:        nbrsp,  "!",    "/\bc", "GBP",  "o\bx", "=\bY", "|",    "<section>",
1.24      schwarze  303:        "\"",   "(C)",  "_\ba", "<<",   "~",    "",     "(R)",  "-",
1.44      schwarze  304:        "<degree>","+-","^2",   "^3",   "'","<micro>","<paragraph>",".",
                    305:        ",",    "^1",   "_\bo", ">>",   "1/4",  "1/2",  "3/4",  "?",
1.24      schwarze  306:        "`\bA", "'\bA", "^\bA", "~\bA", "\"\bA","o\bA", "AE",   ",\bC",
                    307:        "`\bE", "'\bE", "^\bE", "\"\bE","`\bI", "'\bI", "^\bI", "\"\bI",
1.44      schwarze  308:        "Dh",   "~\bN", "`\bO", "'\bO", "^\bO", "~\bO", "\"\bO","x",
1.24      schwarze  309:        "/\bO", "`\bU", "'\bU", "^\bU", "\"\bU","'\bY", "Th",   "ss",
                    310:        "`\ba", "'\ba", "^\ba", "~\ba", "\"\ba","o\ba", "ae",   ",\bc",
                    311:        "`\be", "'\be", "^\be", "\"\be","`\bi", "'\bi", "^\bi", "\"\bi",
1.44      schwarze  312:        "dh",   "~\bn", "`\bo", "'\bo", "^\bo", "~\bo", "\"\bo","/",
1.24      schwarze  313:        "/\bo", "`\bu", "'\bu", "^\bu", "\"\bu","'\by", "th",   "\"\by",
                    314:        "A",    "a",    "A",    "a",    "A",    "a",    "'\bC", "'\bc",
                    315:        "^\bC", "^\bc", "C",    "c",    "C",    "c",    "D",    "d",
                    316:        "/\bD", "/\bd", "E",    "e",    "E",    "e",    "E",    "e",
                    317:        "E",    "e",    "E",    "e",    "^\bG", "^\bg", "G",    "g",
                    318:        "G",    "g",    ",\bG", ",\bg", "^\bH", "^\bh", "/\bH", "/\bh",
                    319:        "~\bI", "~\bi", "I",    "i",    "I",    "i",    "I",    "i",
                    320:        "I",    "i",    "IJ",   "ij",   "^\bJ", "^\bj", ",\bK", ",\bk",
                    321:        "q",    "'\bL", "'\bl", ",\bL", ",\bl", "L",    "l",    "L",
                    322:        "l",    "/\bL", "/\bl", "'\bN", "'\bn", ",\bN", ",\bn", "N",
1.22      schwarze  323:        "n",    "'n",   "Ng",   "ng",   "O",    "o",    "O",    "o",
1.24      schwarze  324:        "O",    "o",    "OE",   "oe",   "'\bR", "'\br", ",\bR", ",\br",
                    325:        "R",    "r",    "'\bS", "'\bs", "^\bS", "^\bs", ",\bS", ",\bs",
                    326:        "S",    "s",    ",\bT", ",\bt", "T",    "t",    "/\bT", "/\bt",
                    327:        "~\bU", "~\bu", "U",    "u",    "U",    "u",    "U",    "u",
                    328:        "U",    "u",    "U",    "u",    "^\bW", "^\bw", "^\bY", "^\by",
                    329:        "\"\bY","'\bZ", "'\bz", "Z",    "z",    "Z",    "z",    "s",
1.22      schwarze  330:        "b",    "B",    "B",    "b",    "6",    "6",    "O",    "C",
                    331:        "c",    "D",    "D",    "D",    "d",    "d",    "3",    "@",
1.24      schwarze  332:        "E",    "F",    ",\bf", "G",    "G",    "hv",   "I",    "/\bI",
                    333:        "K",    "k",    "/\bl", "l",    "W",    "N",    "n",    "~\bO",
1.22      schwarze  334:        "O",    "o",    "OI",   "oi",   "P",    "p",    "YR",   "2",
                    335:        "2",    "SH",   "sh",   "t",    "T",    "t",    "T",    "U",
1.24      schwarze  336:        "u",    "Y",    "V",    "Y",    "y",    "/\bZ", "/\bz", "ZH",
                    337:        "ZH",   "zh",   "zh",   "/\b2", "5",    "5",    "ts",   "w",
1.22      schwarze  338:        "|",    "||",   "|=",   "!",    "DZ",   "Dz",   "dz",   "LJ",
                    339:        "Lj",   "lj",   "NJ",   "Nj",   "nj",   "A",    "a",    "I",
                    340:        "i",    "O",    "o",    "U",    "u",    "U",    "u",    "U",
                    341:        "u",    "U",    "u",    "U",    "u",    "@",    "A",    "a",
1.24      schwarze  342:        "A",    "a",    "AE",   "ae",   "/\bG", "/\bg", "G",    "g",
1.22      schwarze  343:        "K",    "k",    "O",    "o",    "O",    "o",    "ZH",   "zh",
1.24      schwarze  344:        "j",    "DZ",   "Dz",   "dz",   "'\bG", "'\bg", "HV",   "W",
                    345:        "`\bN", "`\bn", "A",    "a",    "'\bAE","'\bae","O",    "o"};
1.22      schwarze  346:
1.26      schwarze  347:        assert(uc >= 0);
1.23      schwarze  348:        if ((size_t)uc < sizeof(tab)/sizeof(tab[0]))
1.35      schwarze  349:                return tab[uc];
                    350:        return mchars_uc2str(uc);
1.3       schwarze  351: }
                    352:
1.6       schwarze  353: static size_t
                    354: locale_width(const struct termp *p, int c)
                    355: {
                    356:        int             rc;
                    357:
1.15      schwarze  358:        if (c == ASCII_NBRSP)
                    359:                c = ' ';
                    360:        rc = wcwidth(c);
                    361:        if (rc < 0)
                    362:                rc = 0;
1.35      schwarze  363:        return rc;
1.6       schwarze  364: }
                    365:
                    366: static void
                    367: locale_advance(struct termp *p, size_t len)
                    368: {
1.14      schwarze  369:        size_t          i;
1.6       schwarze  370:
1.46    ! schwarze  371:        assert(len < UINT16_MAX);
1.6       schwarze  372:        for (i = 0; i < len; i++)
                    373:                putwchar(L' ');
                    374: }
                    375:
                    376: static void
                    377: locale_endline(struct termp *p)
                    378: {
                    379:
1.33      schwarze  380:        p->line++;
1.42      schwarze  381:        p->tcol->offset -= p->ti;
1.41      schwarze  382:        p->ti = 0;
1.6       schwarze  383:        putwchar(L'\n');
                    384: }
                    385:
                    386: static void
                    387: locale_letter(struct termp *p, int c)
                    388: {
1.14      schwarze  389:
1.6       schwarze  390:        putwchar(c);
                    391: }