Annotation of mandoc/term.h, Revision 1.74
1.74 ! schwarze 1: /* $Id: term.h,v 1.73 2010/07/04 19:42:25 kristaps Exp $ */
1.1 kristaps 2: /*
1.74 ! schwarze 3: * Copyright (c) 2008, 2009, 2010 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.46 kristaps 25: TERMENC_ASCII
1.28 kristaps 26: };
27:
1.58 kristaps 28: enum termtype {
29: TERMTYPE_CHAR,
30: TERMTYPE_PS
31: };
32:
1.51 kristaps 33: enum termfont {
34: TERMFONT_NONE = 0,
35: TERMFONT_BOLD,
1.68 kristaps 36: TERMFONT_UNDER,
37: TERMFONT__MAX
1.51 kristaps 38: };
1.53 kristaps 39:
40: #define TERM_MAXMARGIN 100000 /* FIXME */
1.51 kristaps 41:
1.58 kristaps 42: typedef void (*term_margin)(struct termp *, const void *);
43:
1.60 kristaps 44: struct termp_ps {
1.73 kristaps 45: int flags;
1.61 kristaps 46: #define PS_INLINE (1 << 0) /* we're in a word */
47: #define PS_MARGINS (1 << 1) /* we're in the margins */
1.73 kristaps 48: #define PS_NEWPAGE (1 << 2) /* new page, no words yet */
1.69 kristaps 49: size_t pscol; /* visible column (AFM units) */
50: size_t psrow; /* visible row (AFM units) */
1.61 kristaps 51: char *psmarg; /* margin buf */
52: size_t psmargsz; /* margin buf size */
1.68 kristaps 53: size_t psmargcur; /* cur index in margin buf */
1.62 kristaps 54: char last; /* character buffer */
1.63 kristaps 55: enum termfont lastf; /* last set font */
1.72 kristaps 56: size_t scale; /* font scaling factor */
1.68 kristaps 57: size_t pages; /* number of pages shown */
1.69 kristaps 58: size_t lineheight; /* line height (AFM units) */
59: size_t top; /* body top (AFM units) */
60: size_t bottom; /* body bottom (AFM units) */
61: size_t height; /* page height (AFM units */
62: size_t width; /* page width (AFM units) */
63: size_t left; /* body left (AFM units) */
64: size_t header; /* header pos (AFM units) */
65: size_t footer; /* footer pos (AFM units) */
1.60 kristaps 66: };
67:
1.1 kristaps 68: struct termp {
1.58 kristaps 69: enum termtype type;
1.55 joerg 70: size_t defrmargin; /* Right margin of the device.. */
1.27 kristaps 71: size_t rmargin; /* Current right margin. */
72: size_t maxrmargin; /* Max right margin. */
73: size_t maxcols; /* Max size of buf. */
74: size_t offset; /* Margin offest. */
1.56 schwarze 75: size_t tabwidth; /* Distance of tab positions. */
1.27 kristaps 76: size_t col; /* Bytes in buf. */
1.57 schwarze 77: size_t viscol; /* Chars on current line. */
1.52 kristaps 78: int overstep; /* See termp_flushln(). */
1.1 kristaps 79: int flags;
1.54 kristaps 80: #define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */
1.38 kristaps 81: #define TERMP_NOSPACE (1 << 2) /* No space before words. */
1.39 kristaps 82: #define TERMP_NOLPAD (1 << 3) /* See term_flushln(). */
83: #define TERMP_NOBREAK (1 << 4) /* See term_flushln(). */
1.38 kristaps 84: #define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
85: #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
1.39 kristaps 86: #define TERMP_DANGLE (1 << 8) /* See term_flushln(). */
87: #define TERMP_HANG (1 << 9) /* See term_flushln(). */
1.41 kristaps 88: #define TERMP_TWOSPACE (1 << 10) /* See term_flushln(). */
1.42 kristaps 89: #define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */
90: #define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */
91: #define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */
1.66 schwarze 92: #define TERMP_KEEP (1 << 14) /* Keep words together. */
93: #define TERMP_PREKEEP (1 << 15) /* ...starting with the next one. */
1.27 kristaps 94: char *buf; /* Output buffer. */
1.28 kristaps 95: enum termenc enc; /* Type of encoding. */
1.27 kristaps 96: void *symtab; /* Encoded-symbol table. */
1.51 kristaps 97: enum termfont fontl; /* Last font set. */
98: enum termfont fontq[10]; /* Symmetric fonts. */
99: int fonti; /* Index of font stack. */
1.58 kristaps 100: term_margin headf; /* invoked to print head */
101: term_margin footf; /* invoked to print foot */
1.60 kristaps 102: void (*letter)(struct termp *, char);
103: void (*begin)(struct termp *);
104: void (*end)(struct termp *);
105: void (*endline)(struct termp *);
106: void (*advance)(struct termp *, size_t);
1.65 kristaps 107: size_t (*width)(const struct termp *, char);
1.71 kristaps 108: double (*hspan)(const struct termp *,
1.70 kristaps 109: const struct roffsu *);
1.58 kristaps 110: const void *argf; /* arg for headf/footf */
1.60 kristaps 111: union {
112: struct termp_ps ps;
113: } engine;
1.1 kristaps 114: };
115:
1.59 kristaps 116: struct termp *term_alloc(enum termenc);
117: void term_free(struct termp *);
1.29 kristaps 118: void term_newln(struct termp *);
119: void term_vspace(struct termp *);
120: void term_word(struct termp *, const char *);
121: void term_flushln(struct termp *);
1.58 kristaps 122: void term_begin(struct termp *, term_margin,
123: term_margin, const void *);
124: void term_end(struct termp *);
1.1 kristaps 125:
1.65 kristaps 126: size_t term_hspan(const struct termp *,
127: const struct roffsu *);
128: size_t term_vspan(const struct termp *,
129: const struct roffsu *);
130: size_t term_strlen(const struct termp *, const char *);
131: size_t term_len(const struct termp *, size_t);
1.48 kristaps 132:
1.51 kristaps 133: enum termfont term_fonttop(struct termp *);
134: const void *term_fontq(struct termp *);
135: void term_fontpush(struct termp *, enum termfont);
136: void term_fontpop(struct termp *);
137: void term_fontpopq(struct termp *, const void *);
138: void term_fontrepl(struct termp *, enum termfont);
139: void term_fontlast(struct termp *);
140:
1.1 kristaps 141: __END_DECLS
142:
143: #endif /*!TERM_H*/
CVSweb