1294113Sbapt/*	$Id: libman.h,v 1.79 2015/11/07 14:01:16 schwarze Exp $ */
2241675Suqs/*
3241675Suqs * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4294113Sbapt * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
5241675Suqs *
6241675Suqs * Permission to use, copy, modify, and distribute this software for any
7241675Suqs * purpose with or without fee is hereby granted, provided that the above
8241675Suqs * copyright notice and this permission notice appear in all copies.
9241675Suqs *
10294113Sbapt * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11241675Suqs * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12294113Sbapt * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13241675Suqs * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14241675Suqs * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15241675Suqs * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16241675Suqs * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17241675Suqs */
18241675Suqs
19294113Sbapt#define	MACRO_PROT_ARGS	  struct roff_man *man, \
20294113Sbapt			  int tok, \
21241675Suqs			  int line, \
22241675Suqs			  int ppos, \
23241675Suqs			  int *pos, \
24241675Suqs			  char *buf
25241675Suqs
26241675Suqsstruct	man_macro {
27275432Sbapt	void		(*fp)(MACRO_PROT_ARGS);
28241675Suqs	int		  flags;
29294113Sbapt#define	MAN_SCOPED	 (1 << 0)  /* Optional next-line scope. */
30294113Sbapt#define	MAN_NSCOPED	 (1 << 1)  /* Allowed in next-line element scope. */
31294113Sbapt#define	MAN_BSCOPE	 (1 << 2)  /* Break next-line block scope. */
32294113Sbapt#define	MAN_JOIN	 (1 << 3)  /* Join arguments together. */
33241675Suqs};
34241675Suqs
35241675Suqsextern	const struct man_macro *const man_macros;
36241675Suqs
37241675Suqs
38294113Sbaptint		  man_hash_find(const char *);
39294113Sbaptvoid		  man_node_validate(struct roff_man *);
40294113Sbaptvoid		  man_state(struct roff_man *, struct roff_node *);
41294113Sbaptvoid		  man_unscope(struct roff_man *, const struct roff_node *);
42