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