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