1/*	$Id: libman.h,v 1.55 2011/11/07 01:24:40 schwarze Exp $ */
2/*
3 * Copyright (c) 2009, 2010, 2011 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
20enum	man_next {
21	MAN_NEXT_SIBLING = 0,
22	MAN_NEXT_CHILD
23};
24
25struct	man {
26	struct mparse	*parse; /* parse pointer */
27	int		 flags; /* parse flags */
28#define	MAN_HALT	(1 << 0) /* badness happened: die */
29#define	MAN_ELINE	(1 << 1) /* Next-line element scope. */
30#define	MAN_BLINE	(1 << 2) /* Next-line block scope. */
31#define	MAN_ILINE	(1 << 3) /* Ignored in next-line scope. */
32#define	MAN_LITERAL	(1 << 4) /* Literal input. */
33#define	MAN_BPLINE	(1 << 5)
34#define	MAN_NEWLINE	(1 << 6) /* first macro/text in a line */
35	enum man_next	 next; /* where to put the next node */
36	struct man_node	*last; /* the last parsed node */
37	struct man_node	*first; /* the first parsed node */
38	struct man_meta	 meta; /* document meta-data */
39	struct roff	*roff;
40};
41
42#define	MACRO_PROT_ARGS	  struct man *m, \
43			  enum mant tok, \
44			  int line, \
45			  int ppos, \
46			  int *pos, \
47			  char *buf
48
49struct	man_macro {
50	int		(*fp)(MACRO_PROT_ARGS);
51	int		  flags;
52#define	MAN_SCOPED	 (1 << 0)
53#define	MAN_EXPLICIT	 (1 << 1)	/* See blk_imp(). */
54#define	MAN_FSCOPED	 (1 << 2)	/* See blk_imp(). */
55#define	MAN_NSCOPED	 (1 << 3)	/* See in_line_eoln(). */
56#define	MAN_NOCLOSE	 (1 << 4)	/* See blk_exp(). */
57#define	MAN_BSCOPE	 (1 << 5)	/* Break BLINE scope. */
58};
59
60extern	const struct man_macro *const man_macros;
61
62__BEGIN_DECLS
63
64#define		  man_pmsg(m, l, p, t) \
65		  mandoc_msg((t), (m)->parse, (l), (p), NULL)
66#define		  man_nmsg(m, n, t) \
67		  mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL)
68int		  man_word_alloc(struct man *, int, int, const char *);
69int		  man_block_alloc(struct man *, int, int, enum mant);
70int		  man_head_alloc(struct man *, int, int, enum mant);
71int		  man_tail_alloc(struct man *, int, int, enum mant);
72int		  man_body_alloc(struct man *, int, int, enum mant);
73int		  man_elem_alloc(struct man *, int, int, enum mant);
74void		  man_node_delete(struct man *, struct man_node *);
75void		  man_hash_init(void);
76enum mant	  man_hash_find(const char *);
77int		  man_macroend(struct man *);
78int		  man_valid_post(struct man *);
79int		  man_valid_pre(struct man *, struct man_node *);
80int		  man_unscope(struct man *,
81			const struct man_node *, enum mandocerr);
82
83__END_DECLS
84
85#endif /*!LIBMAN_H*/
86