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