libman.h revision 1.1.1.8 
1/*	$Vendor-Id: libman.h,v 1.42 2010/07/13 23:53:20 schwarze Exp $ */
2/*
3 * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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 LIBMAN_H
18#define LIBMAN_H
19
20#include "man.h"
21
22enum	man_next {
23	MAN_NEXT_SIBLING = 0,
24	MAN_NEXT_CHILD
25};
26
27struct	man {
28	void		*data; /* private application data */
29	mandocmsg	 msg; /* output message handler */
30	int		 pflags; /* parse flags (see man.h) */
31	int		 flags; /* parse flags */
32#define	MAN_HALT	(1 << 0) /* badness happened: die */
33#define	MAN_ELINE	(1 << 1) /* Next-line element scope. */
34#define	MAN_BLINE	(1 << 2) /* Next-line block scope. */
35#define	MAN_ILINE	(1 << 3) /* Ignored in next-line scope. */
36#define	MAN_LITERAL	(1 << 4) /* Literal input. */
37#define	MAN_BPLINE	(1 << 5)
38	enum man_next	 next; /* where to put the next node */
39	struct man_node	*last; /* the last parsed node */
40	struct man_node	*first; /* the first parsed node */
41	struct man_meta	 meta; /* document meta-data */
42	struct regset	*regs; /* registers */
43};
44
45#define	MACRO_PROT_ARGS	  struct man *m, \
46			  enum mant tok, \
47			  int line, \
48			  int ppos, \
49			  int *pos, \
50			  char *buf
51
52struct	man_macro {
53	int		(*fp)(MACRO_PROT_ARGS);
54	int		  flags;
55#define	MAN_SCOPED	 (1 << 0)
56#define	MAN_EXPLICIT	 (1 << 1)	/* See blk_imp(). */
57#define	MAN_FSCOPED	 (1 << 2)	/* See blk_imp(). */
58#define	MAN_NSCOPED	 (1 << 3)	/* See in_line_eoln(). */
59#define	MAN_NOCLOSE	 (1 << 4)	/* See blk_exp(). */
60};
61
62extern	const struct man_macro *const man_macros;
63
64__BEGIN_DECLS
65
66#define		  man_pmsg(m, l, p, t) \
67		  (*(m)->msg)((t), (m)->data, (l), (p), NULL)
68#define		  man_nmsg(m, n, t) \
69		  (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
70int		  man_word_alloc(struct man *, int, int, const char *);
71int		  man_block_alloc(struct man *, int, int, enum mant);
72int		  man_head_alloc(struct man *, int, int, enum mant);
73int		  man_body_alloc(struct man *, int, int, enum mant);
74int		  man_elem_alloc(struct man *, int, int, enum mant);
75void		  man_node_delete(struct man *, struct man_node *);
76void		  man_hash_init(void);
77enum	mant	  man_hash_find(const char *);
78int		  man_macroend(struct man *);
79int		  man_args(struct man *, int, int *, char *, char **);
80#define	ARGS_ERROR	(-1)
81#define	ARGS_EOLN	(0)
82#define	ARGS_WORD	(1)
83#define	ARGS_QWORD	(1)
84int		  man_vmsg(struct man *, enum mandocerr,
85			int, int, const char *, ...);
86int		  man_valid_post(struct man *);
87int		  man_valid_pre(struct man *, struct man_node *);
88int		  man_action_post(struct man *);
89int		  man_action_pre(struct man *, struct man_node *);
90int		  man_unscope(struct man *,
91			const struct man_node *, enum mandocerr);
92
93__END_DECLS
94
95#endif /*!LIBMAN_H*/
96