1/*	$Id: libman.h,v 1.81 2017/04/29 12:45:41 schwarze Exp $ */
2/*
3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19#define	MACRO_PROT_ARGS	  struct roff_man *man, \
20			  enum roff_tok tok, \
21			  int line, \
22			  int ppos, \
23			  int *pos, \
24			  char *buf
25
26struct	man_macro {
27	void		(*fp)(MACRO_PROT_ARGS);
28	int		  flags;
29#define	MAN_SCOPED	 (1 << 0)  /* Optional next-line scope. */
30#define	MAN_NSCOPED	 (1 << 1)  /* Allowed in next-line element scope. */
31#define	MAN_BSCOPE	 (1 << 2)  /* Break next-line block scope. */
32#define	MAN_JOIN	 (1 << 3)  /* Join arguments together. */
33};
34
35extern	const struct man_macro *const man_macros;
36
37
38void		  man_node_validate(struct roff_man *);
39void		  man_state(struct roff_man *, struct roff_node *);
40void		  man_unscope(struct roff_man *, const struct roff_node *);
41