1 /* $Id: term.h,v 1.118 2015/11/07 14:01:16 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org> 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 #define TERM_MAXMARGIN 100000 /* FIXME */ 40 41 struct roff_meta; 42 struct termp; 43 44 typedef void (*term_margin)(struct termp *, const struct roff_meta *); 45 46 struct termp_tbl { 47 int width; /* width in fixed chars */ 48 int decimal; /* decimal point position */ 49 }; 50 51 struct termp { 52 enum termtype type; 53 struct rofftbl tbl; /* table configuration */ 54 int synopsisonly; /* print the synopsis only */ 55 int mdocstyle; /* imitate mdoc(7) output */ 56 size_t line; /* Current output line number. */ 57 size_t defindent; /* Default indent for text. */ 58 size_t defrmargin; /* Right margin of the device. */ 59 size_t lastrmargin; /* Right margin before the last ll. */ 60 size_t rmargin; /* Current right margin. */ 61 size_t maxrmargin; /* Max right margin. */ 62 size_t maxcols; /* Max size of buf. */ 63 size_t offset; /* Margin offest. */ 64 size_t tabwidth; /* Distance of tab positions. */ 65 size_t col; /* Bytes in buf. */ 66 size_t viscol; /* Chars on current line. */ 67 size_t trailspace; /* See termp_flushln(). */ 68 int overstep; /* See termp_flushln(). */ 69 int skipvsp; /* Vertical space to skip. */ 70 int flags; 71 #define TERMP_SENTENCE (1 << 0) /* Space before a sentence. */ 72 #define TERMP_NOSPACE (1 << 1) /* No space before words. */ 73 #define TERMP_NONOSPACE (1 << 2) /* No space (no autounset). */ 74 #define TERMP_NBRWORD (1 << 3) /* Make next word nonbreaking. */ 75 #define TERMP_KEEP (1 << 4) /* Keep words together. */ 76 #define TERMP_PREKEEP (1 << 5) /* ...starting with the next one. */ 77 #define TERMP_BACKAFTER (1 << 6) /* Back up after next character. */ 78 #define TERMP_BACKBEFORE (1 << 7) /* Back up before next character. */ 79 #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */ 80 #define TERMP_BRTRSP (1 << 9) /* See term_flushln(). */ 81 #define TERMP_BRIND (1 << 10) /* See term_flushln(). */ 82 #define TERMP_DANGLE (1 << 11) /* See term_flushln(). */ 83 #define TERMP_HANG (1 << 12) /* See term_flushln(). */ 84 #define TERMP_NOSPLIT (1 << 13) /* Do not break line before .An. */ 85 #define TERMP_SPLIT (1 << 14) /* Break line before .An. */ 86 #define TERMP_NONEWLINE (1 << 15) /* No line break in nofill mode. */ 87 int *buf; /* Output buffer. */ 88 enum termenc enc; /* Type of encoding. */ 89 enum termfont fontl; /* Last font set. */ 90 enum termfont *fontq; /* Symmetric fonts. */ 91 int fontsz; /* Allocated size of font stack */ 92 int fonti; /* Index of font stack. */ 93 term_margin headf; /* invoked to print head */ 94 term_margin footf; /* invoked to print foot */ 95 void (*letter)(struct termp *, int); 96 void (*begin)(struct termp *); 97 void (*end)(struct termp *); 98 void (*endline)(struct termp *); 99 void (*advance)(struct termp *, size_t); 100 void (*setwidth)(struct termp *, int, int); 101 size_t (*width)(const struct termp *, int); 102 int (*hspan)(const struct termp *, 103 const struct roffsu *); 104 const void *argf; /* arg for headf/footf */ 105 struct termp_ps *ps; 106 }; 107 108 109 struct tbl_span; 110 struct eqn; 111 112 const char *ascii_uc2str(int); 113 114 void term_eqn(struct termp *, const struct eqn *); 115 void term_tbl(struct termp *, const struct tbl_span *); 116 void term_free(struct termp *); 117 void term_newln(struct termp *); 118 void term_vspace(struct termp *); 119 void term_word(struct termp *, const char *); 120 void term_flushln(struct termp *); 121 void term_begin(struct termp *, term_margin, 122 term_margin, const struct roff_meta *); 123 void term_end(struct termp *); 124 125 void term_setwidth(struct termp *, const char *); 126 int term_hspan(const struct termp *, const struct roffsu *); 127 int term_vspan(const struct termp *, const struct roffsu *); 128 size_t term_strlen(const struct termp *, const char *); 129 size_t term_len(const struct termp *, size_t); 130 131 void term_fontpush(struct termp *, enum termfont); 132 void term_fontpop(struct termp *); 133 void term_fontpopq(struct termp *, int); 134 void term_fontrepl(struct termp *, enum termfont); 135 void term_fontlast(struct termp *); 136