1 /* $Id: term.h,v 1.94 2013/08/21 21:20:40 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 #ifndef TERM_H 18 #define TERM_H 19 20 __BEGIN_DECLS 21 22 struct termp; 23 24 enum termenc { 25 TERMENC_ASCII, 26 TERMENC_LOCALE, 27 TERMENC_UTF8 28 }; 29 30 enum termtype { 31 TERMTYPE_CHAR, 32 TERMTYPE_PS, 33 TERMTYPE_PDF 34 }; 35 36 enum termfont { 37 TERMFONT_NONE = 0, 38 TERMFONT_BOLD, 39 TERMFONT_UNDER, 40 TERMFONT_BI, 41 TERMFONT__MAX 42 }; 43 44 #define TERM_MAXMARGIN 100000 /* FIXME */ 45 46 typedef void (*term_margin)(struct termp *, const void *); 47 48 struct termp_tbl { 49 int width; /* width in fixed chars */ 50 int decimal; /* decimal point position */ 51 }; 52 53 struct termp { 54 enum termtype type; 55 struct rofftbl tbl; /* table configuration */ 56 int mdocstyle; /* imitate mdoc(7) output */ 57 size_t defindent; /* Default indent for text. */ 58 size_t defrmargin; /* Right margin of the device. */ 59 size_t rmargin; /* Current right margin. */ 60 size_t maxrmargin; /* Max right margin. */ 61 size_t maxcols; /* Max size of buf. */ 62 size_t offset; /* Margin offest. */ 63 size_t tabwidth; /* Distance of tab positions. */ 64 size_t col; /* Bytes in buf. */ 65 size_t viscol; /* Chars on current line. */ 66 int overstep; /* See termp_flushln(). */ 67 int skipvsp; /* Vertical space to skip. */ 68 int flags; 69 #define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */ 70 #define TERMP_NOSPACE (1 << 2) /* No space before words. */ 71 #define TERMP_NOBREAK (1 << 4) /* See term_flushln(). */ 72 #define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */ 73 #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */ 74 #define TERMP_DANGLE (1 << 8) /* See term_flushln(). */ 75 #define TERMP_HANG (1 << 9) /* See term_flushln(). */ 76 #define TERMP_TWOSPACE (1 << 10) /* See term_flushln(). */ 77 #define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */ 78 #define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */ 79 #define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */ 80 #define TERMP_KEEP (1 << 14) /* Keep words together. */ 81 #define TERMP_PREKEEP (1 << 15) /* ...starting with the next one. */ 82 #define TERMP_SKIPCHAR (1 << 16) /* Skip the next character. */ 83 int *buf; /* Output buffer. */ 84 enum termenc enc; /* Type of encoding. */ 85 struct mchars *symtab; /* Encoded-symbol table. */ 86 enum termfont fontl; /* Last font set. */ 87 enum termfont fontq[10]; /* Symmetric fonts. */ 88 int fonti; /* Index of font stack. */ 89 term_margin headf; /* invoked to print head */ 90 term_margin footf; /* invoked to print foot */ 91 void (*letter)(struct termp *, int); 92 void (*begin)(struct termp *); 93 void (*end)(struct termp *); 94 void (*endline)(struct termp *); 95 void (*advance)(struct termp *, size_t); 96 size_t (*width)(const struct termp *, int); 97 double (*hspan)(const struct termp *, 98 const struct roffsu *); 99 const void *argf; /* arg for headf/footf */ 100 struct termp_ps *ps; 101 }; 102 103 void term_eqn(struct termp *, const struct eqn *); 104 void term_tbl(struct termp *, const struct tbl_span *); 105 void term_free(struct termp *); 106 void term_newln(struct termp *); 107 void term_vspace(struct termp *); 108 void term_word(struct termp *, const char *); 109 void term_flushln(struct termp *); 110 void term_begin(struct termp *, term_margin, 111 term_margin, const void *); 112 void term_end(struct termp *); 113 114 size_t term_hspan(const struct termp *, 115 const struct roffsu *); 116 size_t term_vspan(const struct termp *, 117 const struct roffsu *); 118 size_t term_strlen(const struct termp *, const char *); 119 size_t term_len(const struct termp *, size_t); 120 121 enum termfont term_fonttop(struct termp *); 122 const void *term_fontq(struct termp *); 123 void term_fontpush(struct termp *, enum termfont); 124 void term_fontpop(struct termp *); 125 void term_fontpopq(struct termp *, const void *); 126 void term_fontrepl(struct termp *, enum termfont); 127 void term_fontlast(struct termp *); 128 129 __END_DECLS 130 131 #endif /*!TERM_H*/ 132