Import mdocml-1.12.3
[dragonfly.git] / contrib / mdocml / term.h
CommitLineData
7888c61d 1/* $Id: term.h,v 1.97 2013/12/25 00:39:31 schwarze Exp $ */
80387638 2/*
36342e81 3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
7888c61d 4 * Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
80387638
SW
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
23struct termp;
24
25enum termenc {
a4c7eb57
SW
26 TERMENC_ASCII,
27 TERMENC_LOCALE,
28 TERMENC_UTF8
80387638
SW
29};
30
31enum termtype {
32 TERMTYPE_CHAR,
33 TERMTYPE_PS,
34 TERMTYPE_PDF
35};
36
37enum termfont {
38 TERMFONT_NONE = 0,
39 TERMFONT_BOLD,
40 TERMFONT_UNDER,
f88b6c16 41 TERMFONT_BI,
80387638
SW
42 TERMFONT__MAX
43};
44
45#define TERM_MAXMARGIN 100000 /* FIXME */
46
47typedef void (*term_margin)(struct termp *, const void *);
48
80387638
SW
49struct termp_tbl {
50 int width; /* width in fixed chars */
51 int decimal; /* decimal point position */
52};
53
54struct termp {
55 enum termtype type;
56 struct rofftbl tbl; /* table configuration */
36342e81
SW
57 int mdocstyle; /* imitate mdoc(7) output */
58 size_t defindent; /* Default indent for text. */
80387638
SW
59 size_t defrmargin; /* Right margin of the device. */
60 size_t rmargin; /* Current right margin. */
61 size_t maxrmargin; /* Max right margin. */
f88b6c16 62 size_t maxcols; /* Max size of buf. */
80387638
SW
63 size_t offset; /* Margin offest. */
64 size_t tabwidth; /* Distance of tab positions. */
f88b6c16 65 size_t col; /* Bytes in buf. */
80387638 66 size_t viscol; /* Chars on current line. */
7888c61d 67 size_t trailspace; /* See termp_flushln(). */
80387638 68 int overstep; /* See termp_flushln(). */
f88b6c16 69 int skipvsp; /* Vertical space to skip. */
80387638
SW
70 int flags;
71#define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */
72#define TERMP_NOSPACE (1 << 2) /* No space before words. */
7888c61d
FF
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(). */
80387638
SW
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(). */
a4c7eb57 84 int *buf; /* Output buffer. */
80387638 85 enum termenc enc; /* Type of encoding. */
a4c7eb57 86 struct mchars *symtab; /* Encoded-symbol table. */
80387638
SW
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 */
a4c7eb57 92 void (*letter)(struct termp *, int);
80387638
SW
93 void (*begin)(struct termp *);
94 void (*end)(struct termp *);
95 void (*endline)(struct termp *);
96 void (*advance)(struct termp *, size_t);
a4c7eb57 97 size_t (*width)(const struct termp *, int);
80387638
SW
98 double (*hspan)(const struct termp *,
99 const struct roffsu *);
100 const void *argf; /* arg for headf/footf */
a4c7eb57 101 struct termp_ps *ps;
80387638
SW
102};
103
36342e81 104void term_eqn(struct termp *, const struct eqn *);
80387638
SW
105void term_tbl(struct termp *, const struct tbl_span *);
106void term_free(struct termp *);
107void term_newln(struct termp *);
108void term_vspace(struct termp *);
109void term_word(struct termp *, const char *);
110void term_flushln(struct termp *);
111void term_begin(struct termp *, term_margin,
112 term_margin, const void *);
113void term_end(struct termp *);
114
115size_t term_hspan(const struct termp *,
116 const struct roffsu *);
117size_t term_vspan(const struct termp *,
118 const struct roffsu *);
119size_t term_strlen(const struct termp *, const char *);
120size_t term_len(const struct termp *, size_t);
121
122enum termfont term_fonttop(struct termp *);
123const void *term_fontq(struct termp *);
124void term_fontpush(struct termp *, enum termfont);
125void term_fontpop(struct termp *);
126void term_fontpopq(struct termp *, const void *);
127void term_fontrepl(struct termp *, enum termfont);
128void term_fontlast(struct termp *);
129
130__END_DECLS
131
132#endif /*!TERM_H*/