Annotation of src/usr.bin/mandoc/term.h, Revision 1.14
1.14 ! schwarze 1: /* $Id: term.h,v 1.13 2009/12/24 02:08:14 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 schwarze 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.2 schwarze 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.
1.1 kristaps 16: */
17: #ifndef TERM_H
18: #define TERM_H
19:
20: __BEGIN_DECLS
21:
22: enum termenc {
1.11 schwarze 23: TERMENC_ASCII
1.1 kristaps 24: };
25:
1.13 schwarze 26: enum termfont {
27: TERMFONT_NONE = 0,
28: TERMFONT_BOLD,
29: TERMFONT_UNDER
30: };
31:
1.1 kristaps 32: struct 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. */
1.14 ! schwarze 38: int overstep; /* See termp_flushln(). */
1.1 kristaps 39: int flags;
1.4 schwarze 40: #define TERMP_NOSPACE (1 << 2) /* No space before words. */
1.5 schwarze 41: #define TERMP_NOLPAD (1 << 3) /* See term_flushln(). */
42: #define TERMP_NOBREAK (1 << 4) /* See term_flushln(). */
1.4 schwarze 43: #define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
44: #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
1.5 schwarze 45: #define TERMP_DANGLE (1 << 8) /* See term_flushln(). */
46: #define TERMP_HANG (1 << 9) /* See term_flushln(). */
1.6 schwarze 47: #define TERMP_TWOSPACE (1 << 10) /* See term_flushln(). */
1.7 schwarze 48: #define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */
49: #define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */
50: #define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */
1.1 kristaps 51: char *buf; /* Output buffer. */
52: enum termenc enc; /* Type of encoding. */
53: void *symtab; /* Encoded-symbol table. */
1.13 schwarze 54: enum termfont fontl; /* Last font set. */
55: enum termfont fontq[10]; /* Symmetric fonts. */
56: int fonti; /* Index of font stack. */
1.1 kristaps 57: };
58:
59: void term_newln(struct termp *);
60: void term_vspace(struct termp *);
61: void term_word(struct termp *, const char *);
62: void term_flushln(struct termp *);
1.12 schwarze 63:
64: size_t term_hspan(const struct roffsu *);
65: size_t term_vspan(const struct roffsu *);
1.13 schwarze 66:
67: enum termfont term_fonttop(struct termp *);
68: const void *term_fontq(struct termp *);
69: void term_fontpush(struct termp *, enum termfont);
70: void term_fontpop(struct termp *);
71: void term_fontpopq(struct termp *, const void *);
72: void term_fontrepl(struct termp *, enum termfont);
73: void term_fontlast(struct termp *);
1.1 kristaps 74:
75: __END_DECLS
76:
77: #endif /*!TERM_H*/