xref: /openbsd-src/usr.bin/mandoc/libman.h (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /* $Id: libman.h,v 1.1 2009/04/06 20:30:40 kristaps Exp $ */
2 /*
3  * Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
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
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 #ifndef LIBMAN_H
20 #define LIBMAN_H
21 
22 #include "man.h"
23 
24 enum	man_next {
25 	MAN_NEXT_SIBLING = 0,
26 	MAN_NEXT_CHILD
27 };
28 
29 struct	man {
30 	void		*data;
31 	struct man_cb	 cb;
32 	void		*htab;
33 	int		 pflags;
34 	int		 flags;
35 #define	MAN_HALT	(1 << 0)
36 #define	MAN_NLINE	(1 << 1)
37 	enum man_next	 next;
38 	struct man_node	*last;
39 	struct man_node	*first;
40 	struct man_meta	 meta;
41 };
42 
43 __BEGIN_DECLS
44 
45 int		  man_word_alloc(struct man *, int, int, const char *);
46 int		  man_elem_alloc(struct man *, int, int, int);
47 void		  man_node_free(struct man_node *);
48 void		  man_node_freelist(struct man_node *);
49 void		 *man_hash_alloc(void);
50 int		  man_macro(struct man *, int,
51 			int, int, int *, char *);
52 int		  man_hash_find(const void *, const char *);
53 void		  man_hash_free(void *);
54 int		  man_macroend(struct man *);
55 int		  man_vwarn(struct man *, int, int, const char *, ...);
56 int		  man_verr(struct man *, int, int, const char *, ...);
57 int		  man_valid_post(struct man *);
58 int		  man_action_post(struct man *);
59 
60 __END_DECLS
61 
62 #endif /*!LIBMAN_H*/
63