mandoc(1): Update to 1.9.14.
[dragonfly.git] / usr.bin / mandoc / term.h
CommitLineData
4a06b3fd 1/* $Id: term.h,v 1.51 2009/11/12 05:50:13 kristaps Exp $ */
589e7c1d
SW
2/*
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
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
22enum termenc {
23 TERMENC_ASCII
24};
25
4a06b3fd
SW
26enum termfont {
27 TERMFONT_NONE = 0,
28 TERMFONT_BOLD,
29 TERMFONT_UNDER
30};
31
589e7c1d
SW
32struct termp {
33 size_t rmargin; /* Current right margin. */
34 size_t maxrmargin; /* Max right margin. */
35 size_t maxcols; /* Max size of buf. */
36 size_t offset; /* Margin offest. */
37 size_t col; /* Bytes in buf. */
38 int flags;
39#define TERMP_NOSPACE (1 << 2) /* No space before words. */
40#define TERMP_NOLPAD (1 << 3) /* See term_flushln(). */
41#define TERMP_NOBREAK (1 << 4) /* See term_flushln(). */
42#define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
43#define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
44#define TERMP_DANGLE (1 << 8) /* See term_flushln(). */
45#define TERMP_HANG (1 << 9) /* See term_flushln(). */
46#define TERMP_TWOSPACE (1 << 10) /* See term_flushln(). */
47#define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */
48#define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */
49#define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */
589e7c1d
SW
50 char *buf; /* Output buffer. */
51 enum termenc enc; /* Type of encoding. */
52 void *symtab; /* Encoded-symbol table. */
4a06b3fd
SW
53 enum termfont fontl; /* Last font set. */
54 enum termfont fontq[10]; /* Symmetric fonts. */
55 int fonti; /* Index of font stack. */
589e7c1d
SW
56};
57
58void term_newln(struct termp *);
59void term_vspace(struct termp *);
60void term_word(struct termp *, const char *);
61void term_flushln(struct termp *);
62
63size_t term_hspan(const struct roffsu *);
64size_t term_vspan(const struct roffsu *);
65
4a06b3fd
SW
66enum termfont term_fonttop(struct termp *);
67const void *term_fontq(struct termp *);
68void term_fontpush(struct termp *, enum termfont);
69void term_fontpop(struct termp *);
70void term_fontpopq(struct termp *, const void *);
71void term_fontrepl(struct termp *, enum termfont);
72void term_fontlast(struct termp *);
73
589e7c1d
SW
74__END_DECLS
75
76#endif /*!TERM_H*/