xref: /openbsd-src/usr.bin/mandoc/term.h (revision 43003dfe3ad45d1698bed8a37f2b0f5b14f20d4f)
1 /*	$Id: term.h,v 1.10 2009/09/21 20:28: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 	TERMENC_LATIN1,		/* Not implemented. */
25 	TERMENC_UTF8		/* Not implemented. */
26 };
27 
28 struct	termp {
29 	size_t		  rmargin;	/* Current right margin. */
30 	size_t		  maxrmargin;	/* Max right margin. */
31 	size_t		  maxcols;	/* Max size of buf. */
32 	size_t		  offset;	/* Margin offest. */
33 	size_t		  col;		/* Bytes in buf. */
34 	int		  flags;
35 #define	TERMP_NOSPACE	 (1 << 2)	/* No space before words. */
36 #define	TERMP_NOLPAD	 (1 << 3)	/* See term_flushln(). */
37 #define	TERMP_NOBREAK	 (1 << 4)	/* See term_flushln(). */
38 #define	TERMP_IGNDELIM	 (1 << 6)	/* Delims like regulars. */
39 #define	TERMP_NONOSPACE	 (1 << 7)	/* No space (no autounset). */
40 #define	TERMP_DANGLE	 (1 << 8)	/* See term_flushln(). */
41 #define	TERMP_HANG	 (1 << 9)	/* See term_flushln(). */
42 #define	TERMP_TWOSPACE	 (1 << 10)	/* See term_flushln(). */
43 #define	TERMP_NOSPLIT	 (1 << 11)	/* See termp_an_pre/post(). */
44 #define	TERMP_SPLIT	 (1 << 12)	/* See termp_an_pre/post(). */
45 #define	TERMP_ANPREC	 (1 << 13)	/* See termp_an_pre(). */
46 	int		  bold;
47 	int		  under;
48 	char		 *buf;		/* Output buffer. */
49 	enum termenc	  enc;		/* Type of encoding. */
50 	void		 *symtab;	/* Encoded-symbol table. */
51 };
52 
53 void		 *term_ascii2htab(void);
54 const char	 *term_a2ascii(void *, const char *, size_t, size_t *);
55 const char	 *term_a2res(void *, const char *, size_t, size_t *);
56 void		  term_asciifree(void *);
57 
58 void		  term_newln(struct termp *);
59 void		  term_vspace(struct termp *);
60 void		  term_word(struct termp *, const char *);
61 void		  term_flushln(struct termp *);
62 
63 __END_DECLS
64 
65 #endif /*!TERM_H*/
66