xref: /openbsd/usr.bin/mandoc/term.h (revision 17df1aa7)
1 /*	$Id: term.h,v 1.18 2010/05/14 19:52:43 schwarze Exp $ */
2 /*
3  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
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.
16  */
17 #ifndef TERM_H
18 #define TERM_H
19 
20 __BEGIN_DECLS
21 
22 enum	termenc {
23 	TERMENC_ASCII
24 };
25 
26 enum	termfont {
27 	TERMFONT_NONE = 0,
28 	TERMFONT_BOLD,
29 	TERMFONT_UNDER
30 };
31 
32 #define	TERM_MAXMARGIN	  100000 /* FIXME */
33 
34 struct	termp {
35 	size_t		  rmargin;	/* Current right margin. */
36 	size_t		  maxrmargin;	/* Max right margin. */
37 	size_t		  maxcols;	/* Max size of buf. */
38 	size_t		  offset;	/* Margin offest. */
39 	size_t		  tabwidth;	/* Distance of tab positions. */
40 	size_t		  col;		/* Bytes in buf. */
41 	size_t		  viscol;	/* Chars on current line. */
42 	int		  overstep;	/* See termp_flushln(). */
43 	int		  flags;
44 #define	TERMP_SENTENCE	 (1 << 1)	/* Space before a sentence. */
45 #define	TERMP_NOSPACE	 (1 << 2)	/* No space before words. */
46 #define	TERMP_NOLPAD	 (1 << 3)	/* See term_flushln(). */
47 #define	TERMP_NOBREAK	 (1 << 4)	/* See term_flushln(). */
48 #define	TERMP_IGNDELIM	 (1 << 6)	/* Delims like regulars. */
49 #define	TERMP_NONOSPACE	 (1 << 7)	/* No space (no autounset). */
50 #define	TERMP_DANGLE	 (1 << 8)	/* See term_flushln(). */
51 #define	TERMP_HANG	 (1 << 9)	/* See term_flushln(). */
52 #define	TERMP_TWOSPACE	 (1 << 10)	/* See term_flushln(). */
53 #define	TERMP_NOSPLIT	 (1 << 11)	/* See termp_an_pre/post(). */
54 #define	TERMP_SPLIT	 (1 << 12)	/* See termp_an_pre/post(). */
55 #define	TERMP_ANPREC	 (1 << 13)	/* See termp_an_pre(). */
56 	char		 *buf;		/* Output buffer. */
57 	enum termenc	  enc;		/* Type of encoding. */
58 	void		 *symtab;	/* Encoded-symbol table. */
59 	enum termfont	  fontl;	/* Last font set. */
60 	enum termfont	  fontq[10];	/* Symmetric fonts. */
61 	int		  fonti;	/* Index of font stack. */
62 };
63 
64 void		  term_newln(struct termp *);
65 void		  term_vspace(struct termp *);
66 void		  term_word(struct termp *, const char *);
67 void		  term_flushln(struct termp *);
68 
69 size_t		  term_hspan(const struct roffsu *);
70 size_t		  term_vspan(const struct roffsu *);
71 
72 enum termfont	  term_fonttop(struct termp *);
73 const void	 *term_fontq(struct termp *);
74 void		  term_fontpush(struct termp *, enum termfont);
75 void		  term_fontpop(struct termp *);
76 void		  term_fontpopq(struct termp *, const void *);
77 void		  term_fontrepl(struct termp *, enum termfont);
78 void		  term_fontlast(struct termp *);
79 
80 __END_DECLS
81 
82 #endif /*!TERM_H*/
83