Annotation of src/usr.bin/mandoc/term.h, Revision 1.23
1.23 ! schwarze 1: /* $Id: term.h,v 1.22 2010/06/26 19:08:00 schwarze Exp $ */
1.1 kristaps 2: /*
1.21 schwarze 3: * Copyright (c) 2008, 2009 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.11 schwarze 25: TERMENC_ASCII
1.1 kristaps 26: };
27:
1.20 schwarze 28: enum termtype {
29: TERMTYPE_CHAR,
30: TERMTYPE_PS
31: };
32:
1.13 schwarze 33: enum termfont {
34: TERMFONT_NONE = 0,
35: TERMFONT_BOLD,
36: TERMFONT_UNDER
37: };
1.17 schwarze 38:
39: #define TERM_MAXMARGIN 100000 /* FIXME */
1.13 schwarze 40:
1.20 schwarze 41: typedef void (*term_margin)(struct termp *, const void *);
42:
43: struct termp_ps {
44: int psstate; /* state of ps output */
45: #define PS_INLINE (1 << 0) /* we're in a word */
46: #define PS_MARGINS (1 << 1) /* we're in the margins */
47: size_t pscol; /* visible column */
48: size_t psrow; /* visible row */
49: char *psmarg; /* margin buf */
50: size_t psmargsz; /* margin buf size */
51: size_t psmargcur; /* current pos in margin buf */
52: size_t pspage; /* current page */
1.21 schwarze 53: char last; /* character buffer */
54: enum termfont lastf; /* last set font */
1.20 schwarze 55: };
56:
1.1 kristaps 57: struct termp {
1.20 schwarze 58: enum termtype type;
1.19 schwarze 59: size_t defrmargin; /* Right margin of the device.. */
1.1 kristaps 60: size_t rmargin; /* Current right margin. */
61: size_t maxrmargin; /* Max right margin. */
62: size_t maxcols; /* Max size of buf. */
63: size_t offset; /* Margin offest. */
1.16 schwarze 64: size_t tabwidth; /* Distance of tab positions. */
1.1 kristaps 65: size_t col; /* Bytes in buf. */
1.15 schwarze 66: size_t viscol; /* Chars on current line. */
1.14 schwarze 67: int overstep; /* See termp_flushln(). */
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_NOLPAD (1 << 3) /* See term_flushln(). */
72: #define TERMP_NOBREAK (1 << 4) /* See term_flushln(). */
1.4 schwarze 73: #define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
74: #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
1.5 schwarze 75: #define TERMP_DANGLE (1 << 8) /* See term_flushln(). */
76: #define TERMP_HANG (1 << 9) /* See term_flushln(). */
1.6 schwarze 77: #define TERMP_TWOSPACE (1 << 10) /* See term_flushln(). */
1.7 schwarze 78: #define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */
79: #define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */
80: #define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */
1.23 ! schwarze 81: #define TERMP_KEEP (1 << 14) /* Keep words together. */
! 82: #define TERMP_PREKEEP (1 << 15) /* ...starting with the next one. */
1.1 kristaps 83: char *buf; /* Output buffer. */
84: enum termenc enc; /* Type of encoding. */
85: void *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 */
91: void (*letter)(struct termp *, char);
92: void (*begin)(struct termp *);
93: void (*end)(struct termp *);
94: void (*endline)(struct termp *);
95: void (*advance)(struct termp *, size_t);
1.22 schwarze 96: size_t (*width)(const struct termp *, char);
1.20 schwarze 97: const void *argf; /* arg for headf/footf */
98: union {
99: struct termp_ps ps;
100: } engine;
1.1 kristaps 101: };
102:
1.20 schwarze 103: struct termp *term_alloc(enum termenc);
104: void term_free(struct termp *);
1.1 kristaps 105: void term_newln(struct termp *);
106: void term_vspace(struct termp *);
107: void term_word(struct termp *, const char *);
108: void term_flushln(struct termp *);
1.20 schwarze 109: void term_begin(struct termp *, term_margin,
110: term_margin, const void *);
111: void term_end(struct termp *);
1.12 schwarze 112:
1.22 schwarze 113: size_t term_hspan(const struct termp *,
114: const struct roffsu *);
115: size_t term_vspan(const struct termp *,
116: const struct roffsu *);
117: size_t term_strlen(const struct termp *, const char *);
118: size_t term_len(const struct termp *, size_t);
1.13 schwarze 119:
120: enum termfont term_fonttop(struct termp *);
121: const void *term_fontq(struct termp *);
122: void term_fontpush(struct termp *, enum termfont);
123: void term_fontpop(struct termp *);
124: void term_fontpopq(struct termp *, const void *);
125: void term_fontrepl(struct termp *, enum termfont);
126: void term_fontlast(struct termp *);
1.1 kristaps 127:
128: __END_DECLS
129:
130: #endif /*!TERM_H*/
![[BACK]](/icons/back.gif){kind=icon}
Return to term.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc