1 /* $Id: term.h,v 1.97 2013/12/25 00:39:31 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011, 2012, 2013 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 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 << 1) /* Space before a sentence. */
72 #define TERMP_NOSPACE (1 << 2) /* No space before words. */
73 #define TERMP_NONOSPACE (1 << 3) /* No space (no autounset). */
74 #define TERMP_NBRWORD (1 << 4) /* Make next word nonbreaking. */
75 #define TERMP_KEEP (1 << 5) /* Keep words together. */
76 #define TERMP_PREKEEP (1 << 6) /* ...starting with the next one. */
77 #define TERMP_SKIPCHAR (1 << 7) /* Skip the next character. */
78 #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */
79 #define TERMP_DANGLE (1 << 9) /* See term_flushln(). */
80 #define TERMP_HANG (1 << 10) /* See term_flushln(). */
81 #define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */
82 #define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */
83 #define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */
84 int *buf; /* Output buffer. */
85 enum termenc enc; /* Type of encoding. */
86 struct mchars *symtab; /* Encoded-symbol table. */
87 enum termfont fontl; /* Last font set. */
88 enum termfont fontq[10]; /* Symmetric fonts. */
89 int fonti; /* Index of font stack. */
90 term_margin headf; /* invoked to print head */
91 term_margin footf; /* invoked to print foot */
92 void (*letter)(struct termp *, int);
93 void (*begin)(struct termp *);
94 void (*end)(struct termp *);
95 void (*endline)(struct termp *);
96 void (*advance)(struct termp *, size_t);
97 size_t (*width)(const struct termp *, int);
98 double (*hspan)(const struct termp *,
99 const struct roffsu *);
100 const void *argf; /* arg for headf/footf */
101 struct termp_ps *ps;
102 };
103
104 void term_eqn(struct termp *, const struct eqn *);
105 void term_tbl(struct termp *, const struct tbl_span *);
106 void term_free(struct termp *);
107 void term_newln(struct termp *);
108 void term_vspace(struct termp *);
109 void term_word(struct termp *, const char *);
110 void term_flushln(struct termp *);
111 void term_begin(struct termp *, term_margin,
112 term_margin, const void *);
113 void term_end(struct termp *);
114
115 size_t term_hspan(const struct termp *,
116 const struct roffsu *);
117 size_t term_vspan(const struct termp *,
118 const struct roffsu *);
119 size_t term_strlen(const struct termp *, const char *);
120 size_t term_len(const struct termp *, size_t);
121
122 enum termfont term_fonttop(struct termp *);
123 const void *term_fontq(struct termp *);
124 void term_fontpush(struct termp *, enum termfont);
125 void term_fontpop(struct termp *);
126 void term_fontpopq(struct termp *, const void *);
127 void term_fontrepl(struct termp *, enum termfont);
128 void term_fontlast(struct termp *);
129
130 __END_DECLS
131
132 #endif /*!TERM_H*/