1 /* $OpenBSD: term.h,v 1.78 2022/08/16 17:44:53 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2011-2015,2017,2019,2022 Ingo Schwarze <schwarze@openbsd.org> 4 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 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 AUTHORS DISCLAIM ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 19 enum termenc { 20 TERMENC_ASCII, 21 TERMENC_LOCALE, 22 TERMENC_UTF8 23 }; 24 25 enum termtype { 26 TERMTYPE_CHAR, 27 TERMTYPE_PS, 28 TERMTYPE_PDF 29 }; 30 31 enum termfont { 32 TERMFONT_NONE = 0, 33 TERMFONT_BOLD, 34 TERMFONT_UNDER, 35 TERMFONT_BI, 36 TERMFONT__MAX 37 }; 38 39 struct eqn_box; 40 struct roff_meta; 41 struct roff_node; 42 struct tbl_span; 43 struct termp; 44 45 typedef void (*term_margin)(struct termp *, const struct roff_meta *); 46 47 struct termp_tbl { 48 int width; /* width in fixed chars */ 49 int decimal; /* decimal point position */ 50 }; 51 52 struct termp_col { 53 int *buf; /* Output buffer. */ 54 size_t maxcols; /* Allocated bytes in buf. */ 55 size_t lastcol; /* Last byte in buf. */ 56 size_t col; /* Byte in buf to be written. */ 57 size_t rmargin; /* Current right margin. */ 58 size_t offset; /* Current left margin. */ 59 size_t taboff; /* Offset for literal tabs. */ 60 }; 61 62 struct termp { 63 struct rofftbl tbl; /* Table configuration. */ 64 struct termp_col *tcols; /* Array of table columns. */ 65 struct termp_col *tcol; /* Current table column. */ 66 size_t maxtcol; /* Allocated table columns. */ 67 size_t lasttcol; /* Last column currently used. */ 68 size_t line; /* Current output line number. */ 69 size_t defindent; /* Default indent for text. */ 70 size_t defrmargin; /* Right margin of the device. */ 71 size_t lastrmargin; /* Right margin before the last ll. */ 72 size_t maxrmargin; /* Max right margin. */ 73 size_t col; /* Byte position in buf. */ 74 size_t viscol; /* Chars on current line. */ 75 size_t trailspace; /* See term_flushln(). */ 76 size_t minbl; /* Minimum blanks before next field. */ 77 int synopsisonly; /* Print the synopsis only. */ 78 int mdocstyle; /* Imitate mdoc(7) output. */ 79 int ti; /* Temporary indent for one line. */ 80 int skipvsp; /* Vertical space to skip. */ 81 int flags; 82 #define TERMP_SENTENCE (1 << 0) /* Space before a sentence. */ 83 #define TERMP_NOSPACE (1 << 1) /* No space before words. */ 84 #define TERMP_NONOSPACE (1 << 2) /* No space (no autounset). */ 85 #define TERMP_NBRWORD (1 << 3) /* Make next word nonbreaking. */ 86 #define TERMP_KEEP (1 << 4) /* Keep words together. */ 87 #define TERMP_PREKEEP (1 << 5) /* ...starting with the next one. */ 88 #define TERMP_BACKAFTER (1 << 6) /* Back up after next character. */ 89 #define TERMP_BACKBEFORE (1 << 7) /* Back up before next character. */ 90 #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */ 91 #define TERMP_BRTRSP (1 << 9) /* See term_flushln(). */ 92 #define TERMP_BRIND (1 << 10) /* See term_flushln(). */ 93 #define TERMP_HANG (1 << 11) /* See term_flushln(). */ 94 #define TERMP_NOPAD (1 << 12) /* See term_flushln(). */ 95 #define TERMP_NOSPLIT (1 << 13) /* Do not break line before .An. */ 96 #define TERMP_SPLIT (1 << 14) /* Break line before .An. */ 97 #define TERMP_NONEWLINE (1 << 15) /* No line break in nofill mode. */ 98 #define TERMP_BRNEVER (1 << 16) /* Don't even break at maxrmargin. */ 99 #define TERMP_NOBUF (1 << 17) /* Bypass output buffer. */ 100 #define TERMP_NEWMC (1 << 18) /* No .mc printed yet. */ 101 #define TERMP_ENDMC (1 << 19) /* Next break ends .mc mode. */ 102 #define TERMP_MULTICOL (1 << 20) /* Multiple column mode. */ 103 #define TERMP_CENTER (1 << 21) /* Center output lines. */ 104 #define TERMP_RIGHT (1 << 22) /* Adjust to the right margin. */ 105 enum termtype type; /* Terminal, PS, or PDF. */ 106 enum termenc enc; /* Type of encoding. */ 107 enum termfont fontl; /* Last font set. */ 108 enum termfont *fontq; /* Symmetric fonts. */ 109 int fontsz; /* Allocated size of font stack */ 110 int fonti; /* Index of font stack. */ 111 term_margin headf; /* invoked to print head */ 112 term_margin footf; /* invoked to print foot */ 113 void (*letter)(struct termp *, int); 114 void (*begin)(struct termp *); 115 void (*end)(struct termp *); 116 void (*endline)(struct termp *); 117 void (*advance)(struct termp *, size_t); 118 void (*setwidth)(struct termp *, int, int); 119 size_t (*width)(const struct termp *, int); 120 int (*hspan)(const struct termp *, 121 const struct roffsu *); 122 const void *argf; /* arg for headf/footf */ 123 const char *mc; /* Margin character. */ 124 struct termp_ps *ps; 125 }; 126 127 128 const char *ascii_uc2str(int); 129 130 void roff_term_pre(struct termp *, const struct roff_node *); 131 132 void term_eqn(struct termp *, const struct eqn_box *); 133 void term_tbl(struct termp *, const struct tbl_span *); 134 void term_free(struct termp *); 135 void term_setcol(struct termp *, size_t); 136 void term_newln(struct termp *); 137 void term_vspace(struct termp *); 138 void term_word(struct termp *, const char *); 139 void term_flushln(struct termp *); 140 void term_begin(struct termp *, term_margin, 141 term_margin, const struct roff_meta *); 142 void term_end(struct termp *); 143 144 void term_setwidth(struct termp *, const char *); 145 int term_hspan(const struct termp *, const struct roffsu *); 146 int term_hen(const struct termp *, const struct roffsu *); 147 int term_vspan(const struct termp *, const struct roffsu *); 148 size_t term_strlen(const struct termp *, const char *); 149 size_t term_len(const struct termp *, size_t); 150 151 void term_tab_set(const struct termp *, const char *); 152 void term_tab_iset(size_t); 153 void term_tab_ref(struct termp *); 154 size_t term_tab_next(size_t); 155 void term_tab_free(void); 156 157 void term_fontpush(struct termp *, enum termfont); 158 void term_fontpop(struct termp *); 159 void term_fontpopq(struct termp *, int); 160 void term_fontrepl(struct termp *, enum termfont); 161 void term_fontlast(struct termp *); 162