[BACK]Return to term_ascii.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/term_ascii.c, Revision 1.70

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

CVSweb