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