Annotation of src/usr.bin/mandoc/term.h, Revision 1.47
1.47 ! schwarze 1: /* $OpenBSD: term.h,v 1.46 2014/09/03 05:17:08 schwarze Exp $ */
1.1 kristaps 2: /*
1.28 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.42 schwarze 4: * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.2 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18: #ifndef TERM_H
19: #define TERM_H
20:
21: __BEGIN_DECLS
22:
1.20 schwarze 23: struct termp;
24:
1.1 kristaps 25: enum termenc {
1.30 schwarze 26: TERMENC_ASCII,
27: TERMENC_LOCALE,
28: TERMENC_UTF8
1.1 kristaps 29: };
30:
1.20 schwarze 31: enum termtype {
32: TERMTYPE_CHAR,
1.26 schwarze 33: TERMTYPE_PS,
34: TERMTYPE_PDF
1.20 schwarze 35: };
36:
1.13 schwarze 37: enum termfont {
38: TERMFONT_NONE = 0,
39: TERMFONT_BOLD,
1.24 schwarze 40: TERMFONT_UNDER,
1.37 schwarze 41: TERMFONT_BI,
1.24 schwarze 42: TERMFONT__MAX
1.13 schwarze 43: };
1.17 schwarze 44:
45: #define TERM_MAXMARGIN 100000 /* FIXME */
1.13 schwarze 46:
1.20 schwarze 47: typedef void (*term_margin)(struct termp *, const void *);
48:
1.28 schwarze 49: struct termp_tbl {
50: int width; /* width in fixed chars */
51: int decimal; /* decimal point position */
52: };
53:
1.1 kristaps 54: struct termp {
1.20 schwarze 55: enum termtype type;
1.29 schwarze 56: struct rofftbl tbl; /* table configuration */
1.46 schwarze 57: int synopsisonly; /* print the synopsis only */
1.34 schwarze 58: int mdocstyle; /* imitate mdoc(7) output */
1.33 schwarze 59: size_t defindent; /* Default indent for text. */
1.28 schwarze 60: size_t defrmargin; /* Right margin of the device. */
1.42 schwarze 61: size_t lastrmargin; /* Right margin before the last ll. */
1.1 kristaps 62: size_t rmargin; /* Current right margin. */
63: size_t maxrmargin; /* Max right margin. */
1.38 schwarze 64: size_t maxcols; /* Max size of buf. */
1.1 kristaps 65: size_t offset; /* Margin offest. */
1.16 schwarze 66: size_t tabwidth; /* Distance of tab positions. */
1.38 schwarze 67: size_t col; /* Bytes in buf. */
1.15 schwarze 68: size_t viscol; /* Chars on current line. */
1.39 schwarze 69: size_t trailspace; /* See termp_flushln(). */
1.14 schwarze 70: int overstep; /* See termp_flushln(). */
1.35 schwarze 71: int skipvsp; /* Vertical space to skip. */
1.1 kristaps 72: int flags;
1.18 schwarze 73: #define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */
1.4 schwarze 74: #define TERMP_NOSPACE (1 << 2) /* No space before words. */
1.40 schwarze 75: #define TERMP_NONOSPACE (1 << 3) /* No space (no autounset). */
1.41 schwarze 76: #define TERMP_NBRWORD (1 << 4) /* Make next word nonbreaking. */
1.40 schwarze 77: #define TERMP_KEEP (1 << 5) /* Keep words together. */
78: #define TERMP_PREKEEP (1 << 6) /* ...starting with the next one. */
79: #define TERMP_SKIPCHAR (1 << 7) /* Skip the next character. */
80: #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */
1.44 schwarze 81: #define TERMP_BRIND (1 << 9) /* See term_flushln(). */
82: #define TERMP_DANGLE (1 << 10) /* See term_flushln(). */
83: #define TERMP_HANG (1 << 11) /* See term_flushln(). */
1.47 ! schwarze 84: #define TERMP_NOSPLIT (1 << 12) /* Do not break line before .An. */
! 85: #define TERMP_SPLIT (1 << 13) /* Break line before .An. */
1.30 schwarze 86: int *buf; /* Output buffer. */
1.1 kristaps 87: enum termenc enc; /* Type of encoding. */
1.30 schwarze 88: struct mchars *symtab; /* Encoded-symbol table. */
1.13 schwarze 89: enum termfont fontl; /* Last font set. */
90: enum termfont fontq[10]; /* Symmetric fonts. */
91: int fonti; /* Index of font stack. */
1.20 schwarze 92: term_margin headf; /* invoked to print head */
93: term_margin footf; /* invoked to print foot */
1.30 schwarze 94: void (*letter)(struct termp *, int);
1.20 schwarze 95: void (*begin)(struct termp *);
96: void (*end)(struct termp *);
97: void (*endline)(struct termp *);
98: void (*advance)(struct termp *, size_t);
1.43 schwarze 99: void (*setwidth)(struct termp *, int, size_t);
1.30 schwarze 100: size_t (*width)(const struct termp *, int);
1.25 schwarze 101: double (*hspan)(const struct termp *,
102: const struct roffsu *);
1.20 schwarze 103: const void *argf; /* arg for headf/footf */
1.30 schwarze 104: struct termp_ps *ps;
1.1 kristaps 105: };
106:
1.31 schwarze 107: void term_eqn(struct termp *, const struct eqn *);
1.28 schwarze 108: void term_tbl(struct termp *, const struct tbl_span *);
1.20 schwarze 109: void term_free(struct termp *);
1.1 kristaps 110: void term_newln(struct termp *);
111: void term_vspace(struct termp *);
112: void term_word(struct termp *, const char *);
113: void term_flushln(struct termp *);
1.45 schwarze 114: void term_begin(struct termp *, term_margin,
1.20 schwarze 115: term_margin, const void *);
116: void term_end(struct termp *);
1.12 schwarze 117:
1.43 schwarze 118: void term_setwidth(struct termp *, const char *);
1.45 schwarze 119: size_t term_hspan(const struct termp *,
1.22 schwarze 120: const struct roffsu *);
121: size_t term_vspan(const struct termp *,
122: const struct roffsu *);
123: size_t term_strlen(const struct termp *, const char *);
124: size_t term_len(const struct termp *, size_t);
1.13 schwarze 125:
126: enum termfont term_fonttop(struct termp *);
127: const void *term_fontq(struct termp *);
128: void term_fontpush(struct termp *, enum termfont);
129: void term_fontpop(struct termp *);
130: void term_fontpopq(struct termp *, const void *);
131: void term_fontrepl(struct termp *, enum termfont);
132: void term_fontlast(struct termp *);
1.1 kristaps 133:
134: __END_DECLS
135:
136: #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