1*54ba9607SSascha Wildner /* $Id: term.h,v 1.131 2019/01/04 03:21:02 schwarze Exp $ */ 280387638SSascha Wildner /* 336342e81SSascha Wildner * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4*54ba9607SSascha Wildner * Copyright (c) 2011-2015, 2017, 2019 Ingo Schwarze <schwarze@openbsd.org> 580387638SSascha Wildner * 680387638SSascha Wildner * Permission to use, copy, modify, and distribute this software for any 780387638SSascha Wildner * purpose with or without fee is hereby granted, provided that the above 880387638SSascha Wildner * copyright notice and this permission notice appear in all copies. 980387638SSascha Wildner * 10*54ba9607SSascha Wildner * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES 1180387638SSascha Wildner * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12*54ba9607SSascha Wildner * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR 1380387638SSascha Wildner * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 1480387638SSascha Wildner * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 1580387638SSascha Wildner * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 1680387638SSascha Wildner * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 1780387638SSascha Wildner */ 1880387638SSascha Wildner 1980387638SSascha Wildner enum termenc { 20a4c7eb57SSascha Wildner TERMENC_ASCII, 21a4c7eb57SSascha Wildner TERMENC_LOCALE, 22a4c7eb57SSascha Wildner TERMENC_UTF8 2380387638SSascha Wildner }; 2480387638SSascha Wildner 2580387638SSascha Wildner enum termtype { 2680387638SSascha Wildner TERMTYPE_CHAR, 2780387638SSascha Wildner TERMTYPE_PS, 2880387638SSascha Wildner TERMTYPE_PDF 2980387638SSascha Wildner }; 3080387638SSascha Wildner 3180387638SSascha Wildner enum termfont { 3280387638SSascha Wildner TERMFONT_NONE = 0, 3380387638SSascha Wildner TERMFONT_BOLD, 3480387638SSascha Wildner TERMFONT_UNDER, 35f88b6c16SFranco Fichtner TERMFONT_BI, 3680387638SSascha Wildner TERMFONT__MAX 3780387638SSascha Wildner }; 3880387638SSascha Wildner 39*54ba9607SSascha Wildner struct eqn_box; 40*54ba9607SSascha Wildner struct roff_meta; 41*54ba9607SSascha Wildner struct roff_node; 42*54ba9607SSascha Wildner struct tbl_span; 43*54ba9607SSascha Wildner struct termp; 4480387638SSascha Wildner 45*54ba9607SSascha Wildner typedef void (*term_margin)(struct termp *, const struct roff_meta *); 4680387638SSascha Wildner 4780387638SSascha Wildner struct termp_tbl { 4880387638SSascha Wildner int width; /* width in fixed chars */ 4980387638SSascha Wildner int decimal; /* decimal point position */ 5080387638SSascha Wildner }; 5180387638SSascha Wildner 52*54ba9607SSascha Wildner struct termp_col { 53*54ba9607SSascha Wildner int *buf; /* Output buffer. */ 54*54ba9607SSascha Wildner size_t maxcols; /* Allocated bytes in buf. */ 55*54ba9607SSascha Wildner size_t lastcol; /* Last byte in buf. */ 56*54ba9607SSascha Wildner size_t col; /* Byte in buf to be written. */ 57*54ba9607SSascha Wildner size_t rmargin; /* Current right margin. */ 58*54ba9607SSascha Wildner size_t offset; /* Current left margin. */ 59*54ba9607SSascha Wildner }; 60*54ba9607SSascha Wildner 6180387638SSascha Wildner struct termp { 62*54ba9607SSascha Wildner struct rofftbl tbl; /* Table configuration. */ 63*54ba9607SSascha Wildner struct termp_col *tcols; /* Array of table columns. */ 64*54ba9607SSascha Wildner struct termp_col *tcol; /* Current table column. */ 65*54ba9607SSascha Wildner size_t maxtcol; /* Allocated table columns. */ 66*54ba9607SSascha Wildner size_t lasttcol; /* Last column currently used. */ 67*54ba9607SSascha Wildner size_t line; /* Current output line number. */ 6836342e81SSascha Wildner size_t defindent; /* Default indent for text. */ 6980387638SSascha Wildner size_t defrmargin; /* Right margin of the device. */ 70070c62a6SFranco Fichtner size_t lastrmargin; /* Right margin before the last ll. */ 7180387638SSascha Wildner size_t maxrmargin; /* Max right margin. */ 72*54ba9607SSascha Wildner size_t col; /* Byte position in buf. */ 7380387638SSascha Wildner size_t viscol; /* Chars on current line. */ 74*54ba9607SSascha Wildner size_t trailspace; /* See term_flushln(). */ 75*54ba9607SSascha Wildner size_t minbl; /* Minimum blanks before next field. */ 76*54ba9607SSascha Wildner int synopsisonly; /* Print the synopsis only. */ 77*54ba9607SSascha Wildner int mdocstyle; /* Imitate mdoc(7) output. */ 78*54ba9607SSascha Wildner int ti; /* Temporary indent for one line. */ 79f88b6c16SFranco Fichtner int skipvsp; /* Vertical space to skip. */ 8080387638SSascha Wildner int flags; 81*54ba9607SSascha Wildner #define TERMP_SENTENCE (1 << 0) /* Space before a sentence. */ 82*54ba9607SSascha Wildner #define TERMP_NOSPACE (1 << 1) /* No space before words. */ 83*54ba9607SSascha Wildner #define TERMP_NONOSPACE (1 << 2) /* No space (no autounset). */ 84*54ba9607SSascha Wildner #define TERMP_NBRWORD (1 << 3) /* Make next word nonbreaking. */ 85*54ba9607SSascha Wildner #define TERMP_KEEP (1 << 4) /* Keep words together. */ 86*54ba9607SSascha Wildner #define TERMP_PREKEEP (1 << 5) /* ...starting with the next one. */ 87*54ba9607SSascha Wildner #define TERMP_BACKAFTER (1 << 6) /* Back up after next character. */ 88*54ba9607SSascha Wildner #define TERMP_BACKBEFORE (1 << 7) /* Back up before next character. */ 897888c61dSFranco Fichtner #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */ 90*54ba9607SSascha Wildner #define TERMP_BRTRSP (1 << 9) /* See term_flushln(). */ 91*54ba9607SSascha Wildner #define TERMP_BRIND (1 << 10) /* See term_flushln(). */ 92070c62a6SFranco Fichtner #define TERMP_HANG (1 << 11) /* See term_flushln(). */ 93*54ba9607SSascha Wildner #define TERMP_NOPAD (1 << 12) /* See term_flushln(). */ 94*54ba9607SSascha Wildner #define TERMP_NOSPLIT (1 << 13) /* Do not break line before .An. */ 95*54ba9607SSascha Wildner #define TERMP_SPLIT (1 << 14) /* Break line before .An. */ 96*54ba9607SSascha Wildner #define TERMP_NONEWLINE (1 << 15) /* No line break in nofill mode. */ 97*54ba9607SSascha Wildner #define TERMP_BRNEVER (1 << 16) /* Don't even break at maxrmargin. */ 98*54ba9607SSascha Wildner #define TERMP_NOBUF (1 << 17) /* Bypass output buffer. */ 99*54ba9607SSascha Wildner #define TERMP_NEWMC (1 << 18) /* No .mc printed yet. */ 100*54ba9607SSascha Wildner #define TERMP_ENDMC (1 << 19) /* Next break ends .mc mode. */ 101*54ba9607SSascha Wildner #define TERMP_MULTICOL (1 << 20) /* Multiple column mode. */ 102*54ba9607SSascha Wildner #define TERMP_CENTER (1 << 21) /* Center output lines. */ 103*54ba9607SSascha Wildner #define TERMP_RIGHT (1 << 22) /* Adjust to the right margin. */ 104*54ba9607SSascha Wildner enum termtype type; /* Terminal, PS, or PDF. */ 10580387638SSascha Wildner enum termenc enc; /* Type of encoding. */ 10680387638SSascha Wildner enum termfont fontl; /* Last font set. */ 107*54ba9607SSascha Wildner enum termfont *fontq; /* Symmetric fonts. */ 108*54ba9607SSascha Wildner int fontsz; /* Allocated size of font stack */ 10980387638SSascha Wildner int fonti; /* Index of font stack. */ 11080387638SSascha Wildner term_margin headf; /* invoked to print head */ 11180387638SSascha Wildner term_margin footf; /* invoked to print foot */ 112a4c7eb57SSascha Wildner void (*letter)(struct termp *, int); 11380387638SSascha Wildner void (*begin)(struct termp *); 11480387638SSascha Wildner void (*end)(struct termp *); 11580387638SSascha Wildner void (*endline)(struct termp *); 11680387638SSascha Wildner void (*advance)(struct termp *, size_t); 117*54ba9607SSascha Wildner void (*setwidth)(struct termp *, int, int); 118a4c7eb57SSascha Wildner size_t (*width)(const struct termp *, int); 119*54ba9607SSascha Wildner int (*hspan)(const struct termp *, 12080387638SSascha Wildner const struct roffsu *); 12180387638SSascha Wildner const void *argf; /* arg for headf/footf */ 122*54ba9607SSascha Wildner const char *mc; /* Margin character. */ 123a4c7eb57SSascha Wildner struct termp_ps *ps; 12480387638SSascha Wildner }; 12580387638SSascha Wildner 126*54ba9607SSascha Wildner 127*54ba9607SSascha Wildner const char *ascii_uc2str(int); 128*54ba9607SSascha Wildner 129*54ba9607SSascha Wildner void roff_term_pre(struct termp *, const struct roff_node *); 130*54ba9607SSascha Wildner 131*54ba9607SSascha Wildner void term_eqn(struct termp *, const struct eqn_box *); 13280387638SSascha Wildner void term_tbl(struct termp *, const struct tbl_span *); 13380387638SSascha Wildner void term_free(struct termp *); 134*54ba9607SSascha Wildner void term_setcol(struct termp *, size_t); 13580387638SSascha Wildner void term_newln(struct termp *); 13680387638SSascha Wildner void term_vspace(struct termp *); 13780387638SSascha Wildner void term_word(struct termp *, const char *); 13880387638SSascha Wildner void term_flushln(struct termp *); 13980387638SSascha Wildner void term_begin(struct termp *, term_margin, 140*54ba9607SSascha Wildner term_margin, const struct roff_meta *); 14180387638SSascha Wildner void term_end(struct termp *); 14280387638SSascha Wildner 143070c62a6SFranco Fichtner void term_setwidth(struct termp *, const char *); 144*54ba9607SSascha Wildner int term_hspan(const struct termp *, const struct roffsu *); 145*54ba9607SSascha Wildner int term_hen(const struct termp *, const struct roffsu *); 146*54ba9607SSascha Wildner int term_vspan(const struct termp *, const struct roffsu *); 14780387638SSascha Wildner size_t term_strlen(const struct termp *, const char *); 14880387638SSascha Wildner size_t term_len(const struct termp *, size_t); 14980387638SSascha Wildner 150*54ba9607SSascha Wildner void term_tab_set(const struct termp *, const char *); 151*54ba9607SSascha Wildner void term_tab_iset(size_t); 152*54ba9607SSascha Wildner size_t term_tab_next(size_t); 153*54ba9607SSascha Wildner 15480387638SSascha Wildner void term_fontpush(struct termp *, enum termfont); 15580387638SSascha Wildner void term_fontpop(struct termp *); 156*54ba9607SSascha Wildner void term_fontpopq(struct termp *, int); 15780387638SSascha Wildner void term_fontrepl(struct termp *, enum termfont); 15880387638SSascha Wildner void term_fontlast(struct termp *); 159