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