Annotation of src/usr.bin/mandoc/term.h, Revision 1.70
1.70 ! schwarze 1: /* $OpenBSD: term.h,v 1.69 2017/06/07 17:38:08 schwarze Exp $ */
1.1 kristaps 2: /*
1.28 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.63 schwarze 4: * Copyright (c) 2011-2015, 2017 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.56 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.56 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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: */
1.20 schwarze 18:
1.1 kristaps 19: enum termenc {
1.30 schwarze 20: TERMENC_ASCII,
21: TERMENC_LOCALE,
22: TERMENC_UTF8
1.1 kristaps 23: };
24:
1.20 schwarze 25: enum termtype {
26: TERMTYPE_CHAR,
1.26 schwarze 27: TERMTYPE_PS,
28: TERMTYPE_PDF
1.20 schwarze 29: };
30:
1.13 schwarze 31: enum termfont {
32: TERMFONT_NONE = 0,
33: TERMFONT_BOLD,
1.24 schwarze 34: TERMFONT_UNDER,
1.37 schwarze 35: TERMFONT_BI,
1.24 schwarze 36: TERMFONT__MAX
1.13 schwarze 37: };
1.17 schwarze 38:
1.63 schwarze 39: struct eqn;
1.56 schwarze 40: struct roff_meta;
1.63 schwarze 41: struct roff_node;
42: struct tbl_span;
1.51 schwarze 43: struct termp;
44:
1.56 schwarze 45: typedef void (*term_margin)(struct termp *, const struct roff_meta *);
1.20 schwarze 46:
1.28 schwarze 47: struct termp_tbl {
48: int width; /* width in fixed chars */
49: int decimal; /* decimal point position */
50: };
51:
1.69 schwarze 52: struct termp_col {
53: int *buf; /* Output buffer. */
54: size_t maxcols; /* Allocated bytes in buf. */
1.70 ! schwarze 55: size_t col; /* Byte in buf to be written. */
1.69 schwarze 56: size_t rmargin; /* Current right margin. */
57: size_t offset; /* Current left margin. */
58: };
59:
1.1 kristaps 60: struct termp {
1.69 schwarze 61: struct rofftbl tbl; /* Table configuration. */
62: struct termp_col *tcols; /* Array of table columns. */
63: struct termp_col *tcol; /* Current table column. */
64: size_t maxtcol; /* Allocated table columns. */
1.70 ! schwarze 65: size_t lasttcol; /* Last column currently used. */
1.59 schwarze 66: size_t line; /* Current output line number. */
1.33 schwarze 67: size_t defindent; /* Default indent for text. */
1.28 schwarze 68: size_t defrmargin; /* Right margin of the device. */
1.42 schwarze 69: size_t lastrmargin; /* Right margin before the last ll. */
1.1 kristaps 70: size_t maxrmargin; /* Max right margin. */
1.68 schwarze 71: size_t col; /* Byte position in buf. */
72: size_t lastcol; /* Bytes in buf. */
1.15 schwarze 73: size_t viscol; /* Chars on current line. */
1.70 ! schwarze 74: size_t trailspace; /* See term_flushln(). */
1.66 schwarze 75: size_t minbl; /* Minimum blanks before next field. */
1.69 schwarze 76: int synopsisonly; /* Print the synopsis only. */
77: int mdocstyle; /* Imitate mdoc(7) output. */
1.65 schwarze 78: int ti; /* Temporary indent for one line. */
1.35 schwarze 79: int skipvsp; /* Vertical space to skip. */
1.1 kristaps 80: int flags;
1.58 schwarze 81: #define TERMP_SENTENCE (1 << 0) /* Space before a sentence. */
82: #define TERMP_NOSPACE (1 << 1) /* No space before words. */
83: #define TERMP_NONOSPACE (1 << 2) /* No space (no autounset). */
84: #define TERMP_NBRWORD (1 << 3) /* Make next word nonbreaking. */
85: #define TERMP_KEEP (1 << 4) /* Keep words together. */
86: #define TERMP_PREKEEP (1 << 5) /* ...starting with the next one. */
87: #define TERMP_BACKAFTER (1 << 6) /* Back up after next character. */
88: #define TERMP_BACKBEFORE (1 << 7) /* Back up before next character. */
1.40 schwarze 89: #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */
1.60 schwarze 90: #define TERMP_BRTRSP (1 << 9) /* See term_flushln(). */
91: #define TERMP_BRIND (1 << 10) /* See term_flushln(). */
1.66 schwarze 92: #define TERMP_HANG (1 << 11) /* See term_flushln(). */
93: #define TERMP_NOPAD (1 << 12) /* See term_flushln(). */
1.60 schwarze 94: #define TERMP_NOSPLIT (1 << 13) /* Do not break line before .An. */
95: #define TERMP_SPLIT (1 << 14) /* Break line before .An. */
96: #define TERMP_NONEWLINE (1 << 15) /* No line break in nofill mode. */
1.67 schwarze 97: #define TERMP_BRNEVER (1 << 16) /* Don't even break at maxrmargin. */
98: #define TERMP_NOBUF (1 << 17) /* Bypass output buffer. */
99: #define TERMP_NEWMC (1 << 18) /* No .mc printed yet. */
100: #define TERMP_ENDMC (1 << 19) /* Next break ends .mc mode. */
1.69 schwarze 101: enum termtype type; /* Terminal, PS, or PDF. */
1.1 kristaps 102: enum termenc enc; /* Type of encoding. */
1.13 schwarze 103: enum termfont fontl; /* Last font set. */
1.53 schwarze 104: enum termfont *fontq; /* Symmetric fonts. */
105: int fontsz; /* Allocated size of font stack */
1.13 schwarze 106: int fonti; /* Index of font stack. */
1.20 schwarze 107: term_margin headf; /* invoked to print head */
108: term_margin footf; /* invoked to print foot */
1.30 schwarze 109: void (*letter)(struct termp *, int);
1.20 schwarze 110: void (*begin)(struct termp *);
111: void (*end)(struct termp *);
112: void (*endline)(struct termp *);
113: void (*advance)(struct termp *, size_t);
1.57 schwarze 114: void (*setwidth)(struct termp *, int, int);
1.30 schwarze 115: size_t (*width)(const struct termp *, int);
1.57 schwarze 116: int (*hspan)(const struct termp *,
1.25 schwarze 117: const struct roffsu *);
1.20 schwarze 118: const void *argf; /* arg for headf/footf */
1.67 schwarze 119: const char *mc; /* Margin character. */
1.30 schwarze 120: struct termp_ps *ps;
1.1 kristaps 121: };
1.51 schwarze 122:
123:
1.63 schwarze 124: const char *ascii_uc2str(int);
1.48 schwarze 125:
1.63 schwarze 126: void roff_term_pre(struct termp *, const struct roff_node *);
1.1 kristaps 127:
1.31 schwarze 128: void term_eqn(struct termp *, const struct eqn *);
1.28 schwarze 129: void term_tbl(struct termp *, const struct tbl_span *);
1.20 schwarze 130: void term_free(struct termp *);
1.1 kristaps 131: void term_newln(struct termp *);
132: void term_vspace(struct termp *);
133: void term_word(struct termp *, const char *);
134: void term_flushln(struct termp *);
1.45 schwarze 135: void term_begin(struct termp *, term_margin,
1.56 schwarze 136: term_margin, const struct roff_meta *);
1.20 schwarze 137: void term_end(struct termp *);
1.12 schwarze 138:
1.43 schwarze 139: void term_setwidth(struct termp *, const char *);
1.54 schwarze 140: int term_hspan(const struct termp *, const struct roffsu *);
141: int term_vspan(const struct termp *, const struct roffsu *);
1.22 schwarze 142: size_t term_strlen(const struct termp *, const char *);
143: size_t term_len(const struct termp *, size_t);
1.64 schwarze 144:
145: void term_tab_set(const struct termp *, const char *);
146: size_t term_tab_next(size_t);
1.13 schwarze 147:
148: void term_fontpush(struct termp *, enum termfont);
149: void term_fontpop(struct termp *);
1.55 schwarze 150: void term_fontpopq(struct termp *, int);
1.13 schwarze 151: void term_fontrepl(struct termp *, enum termfont);
152: void term_fontlast(struct termp *);
![[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