1 /* $Id: term.h,v 1.113 2015/04/04 17:47:18 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
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.
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.
39 #define TERM_MAXMARGIN 100000 /* FIXME */
44 typedef void (*term_margin
)(struct termp
*, const struct roff_meta
*);
47 int width
; /* width in fixed chars */
48 int decimal
; /* decimal point position */
53 struct rofftbl tbl
; /* table configuration */
54 int synopsisonly
; /* print the synopsis only */
55 int mdocstyle
; /* imitate mdoc(7) output */
56 size_t defindent
; /* Default indent for text. */
57 size_t defrmargin
; /* Right margin of the device. */
58 size_t lastrmargin
; /* Right margin before the last ll. */
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 size_t trailspace
; /* See termp_flushln(). */
67 int overstep
; /* See termp_flushln(). */
68 int skipvsp
; /* Vertical space to skip. */
70 #define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */
71 #define TERMP_NOSPACE (1 << 2) /* No space before words. */
72 #define TERMP_NONOSPACE (1 << 3) /* No space (no autounset). */
73 #define TERMP_NBRWORD (1 << 4) /* Make next word nonbreaking. */
74 #define TERMP_KEEP (1 << 5) /* Keep words together. */
75 #define TERMP_PREKEEP (1 << 6) /* ...starting with the next one. */
76 #define TERMP_SKIPCHAR (1 << 7) /* Skip the next character. */
77 #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */
78 #define TERMP_BRIND (1 << 9) /* See term_flushln(). */
79 #define TERMP_DANGLE (1 << 10) /* See term_flushln(). */
80 #define TERMP_HANG (1 << 11) /* See term_flushln(). */
81 #define TERMP_NOSPLIT (1 << 12) /* Do not break line before .An. */
82 #define TERMP_SPLIT (1 << 13) /* Break line before .An. */
83 #define TERMP_NONEWLINE (1 << 14) /* No line break in nofill mode. */
84 int *buf
; /* Output buffer. */
85 enum termenc enc
; /* Type of encoding. */
86 const struct mchars
*symtab
; /* Character table. */
87 enum termfont fontl
; /* Last font set. */
88 enum termfont
*fontq
; /* Symmetric fonts. */
89 int fontsz
; /* Allocated size of font stack */
90 int fonti
; /* Index of font stack. */
91 term_margin headf
; /* invoked to print head */
92 term_margin footf
; /* invoked to print foot */
93 void (*letter
)(struct termp
*, int);
94 void (*begin
)(struct termp
*);
95 void (*end
)(struct termp
*);
96 void (*endline
)(struct termp
*);
97 void (*advance
)(struct termp
*, size_t);
98 void (*setwidth
)(struct termp
*, int, int);
99 size_t (*width
)(const struct termp
*, int);
100 int (*hspan
)(const struct termp
*,
101 const struct roffsu
*);
102 const void *argf
; /* arg for headf/footf */
111 const char *ascii_uc2str(int);
113 void term_eqn(struct termp
*, const struct eqn
*);
114 void term_tbl(struct termp
*, const struct tbl_span
*);
115 void term_free(struct termp
*);
116 void term_newln(struct termp
*);
117 void term_vspace(struct termp
*);
118 void term_word(struct termp
*, const char *);
119 void term_flushln(struct termp
*);
120 void term_begin(struct termp
*, term_margin
,
121 term_margin
, const struct roff_meta
*);
122 void term_end(struct termp
*);
124 void term_setwidth(struct termp
*, const char *);
125 int term_hspan(const struct termp
*, const struct roffsu
*);
126 int term_vspan(const struct termp
*, const struct roffsu
*);
127 size_t term_strlen(const struct termp
*, const char *);
128 size_t term_len(const struct termp
*, size_t);
130 void term_fontpush(struct termp
*, enum termfont
);
131 void term_fontpop(struct termp
*);
132 void term_fontpopq(struct termp
*, int);
133 void term_fontrepl(struct termp
*, enum termfont
);
134 void term_fontlast(struct termp
*);