Annotation of src/usr.bin/mandoc/term.h, Revision 1.50
1.50 ! deraadt 1: /* $OpenBSD: term.h,v 1.49 2014/10/28 17:35:42 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: __BEGIN_DECLS
19:
1.20 schwarze 20: struct termp;
21:
1.1 kristaps 22: enum termenc {
1.30 schwarze 23: TERMENC_ASCII,
24: TERMENC_LOCALE,
25: TERMENC_UTF8
1.1 kristaps 26: };
27:
1.20 schwarze 28: enum termtype {
29: TERMTYPE_CHAR,
1.26 schwarze 30: TERMTYPE_PS,
31: TERMTYPE_PDF
1.20 schwarze 32: };
33:
1.13 schwarze 34: enum termfont {
35: TERMFONT_NONE = 0,
36: TERMFONT_BOLD,
1.24 schwarze 37: TERMFONT_UNDER,
1.37 schwarze 38: TERMFONT_BI,
1.24 schwarze 39: TERMFONT__MAX
1.13 schwarze 40: };
1.17 schwarze 41:
42: #define TERM_MAXMARGIN 100000 /* FIXME */
1.13 schwarze 43:
1.20 schwarze 44: typedef void (*term_margin)(struct termp *, const void *);
45:
1.28 schwarze 46: struct termp_tbl {
47: int width; /* width in fixed chars */
48: int decimal; /* decimal point position */
49: };
50:
1.1 kristaps 51: struct termp {
1.20 schwarze 52: enum termtype type;
1.29 schwarze 53: struct rofftbl tbl; /* table configuration */
1.46 schwarze 54: int synopsisonly; /* print the synopsis only */
1.34 schwarze 55: int mdocstyle; /* imitate mdoc(7) output */
1.33 schwarze 56: size_t defindent; /* Default indent for text. */
1.28 schwarze 57: size_t defrmargin; /* Right margin of the device. */
1.42 schwarze 58: size_t lastrmargin; /* Right margin before the last ll. */
1.1 kristaps 59: size_t rmargin; /* Current right margin. */
60: size_t maxrmargin; /* Max right margin. */
1.38 schwarze 61: size_t maxcols; /* Max size of buf. */
1.1 kristaps 62: size_t offset; /* Margin offest. */
1.16 schwarze 63: size_t tabwidth; /* Distance of tab positions. */
1.38 schwarze 64: size_t col; /* Bytes in buf. */
1.15 schwarze 65: size_t viscol; /* Chars on current line. */
1.39 schwarze 66: size_t trailspace; /* See termp_flushln(). */
1.14 schwarze 67: int overstep; /* See termp_flushln(). */
1.35 schwarze 68: int skipvsp; /* Vertical space to skip. */
1.1 kristaps 69: int flags;
1.18 schwarze 70: #define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */
1.4 schwarze 71: #define TERMP_NOSPACE (1 << 2) /* No space before words. */
1.40 schwarze 72: #define TERMP_NONOSPACE (1 << 3) /* No space (no autounset). */
1.41 schwarze 73: #define TERMP_NBRWORD (1 << 4) /* Make next word nonbreaking. */
1.40 schwarze 74: #define TERMP_KEEP (1 << 5) /* Keep words together. */
75: #define TERMP_PREKEEP (1 << 6) /* ...starting with the next one. */
76: #define TERMP_SKIPCHAR (1 << 7) /* Skip the next character. */
77: #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */
1.44 schwarze 78: #define TERMP_BRIND (1 << 9) /* See term_flushln(). */
79: #define TERMP_DANGLE (1 << 10) /* See term_flushln(). */
80: #define TERMP_HANG (1 << 11) /* See term_flushln(). */
1.47 schwarze 81: #define TERMP_NOSPLIT (1 << 12) /* Do not break line before .An. */
82: #define TERMP_SPLIT (1 << 13) /* Break line before .An. */
1.30 schwarze 83: int *buf; /* Output buffer. */
1.1 kristaps 84: enum termenc enc; /* Type of encoding. */
1.49 schwarze 85: const struct mchars *symtab; /* Character 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 */
1.30 schwarze 91: void (*letter)(struct termp *, int);
1.20 schwarze 92: void (*begin)(struct termp *);
93: void (*end)(struct termp *);
94: void (*endline)(struct termp *);
95: void (*advance)(struct termp *, size_t);
1.43 schwarze 96: void (*setwidth)(struct termp *, int, size_t);
1.30 schwarze 97: size_t (*width)(const struct termp *, int);
1.25 schwarze 98: double (*hspan)(const struct termp *,
99: const struct roffsu *);
1.20 schwarze 100: const void *argf; /* arg for headf/footf */
1.30 schwarze 101: struct termp_ps *ps;
1.1 kristaps 102: };
1.48 schwarze 103:
104: const char *ascii_uc2str(int);
1.1 kristaps 105:
1.31 schwarze 106: void term_eqn(struct termp *, const struct eqn *);
1.28 schwarze 107: void term_tbl(struct termp *, const struct tbl_span *);
1.20 schwarze 108: void term_free(struct termp *);
1.1 kristaps 109: void term_newln(struct termp *);
110: void term_vspace(struct termp *);
111: void term_word(struct termp *, const char *);
112: void term_flushln(struct termp *);
1.45 schwarze 113: void term_begin(struct termp *, term_margin,
1.20 schwarze 114: term_margin, const void *);
115: void term_end(struct termp *);
1.12 schwarze 116:
1.43 schwarze 117: void term_setwidth(struct termp *, const char *);
1.45 schwarze 118: size_t term_hspan(const struct termp *,
1.22 schwarze 119: const struct roffsu *);
120: size_t term_vspan(const struct termp *,
121: const struct roffsu *);
122: size_t term_strlen(const struct termp *, const char *);
123: size_t term_len(const struct termp *, size_t);
1.13 schwarze 124:
125: enum termfont term_fonttop(struct termp *);
126: const void *term_fontq(struct termp *);
127: void term_fontpush(struct termp *, enum termfont);
128: void term_fontpop(struct termp *);
129: void term_fontpopq(struct termp *, const void *);
130: void term_fontrepl(struct termp *, enum termfont);
131: void term_fontlast(struct termp *);
1.1 kristaps 132:
133: __END_DECLS
![[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