xref: /openbsd/usr.bin/mandoc/libman.h (revision 16fe0cfc)
1*16fe0cfcSschwarze /*	$OpenBSD: libman.h,v 1.57 2018/08/17 20:31:52 schwarze Exp $ */
2f73abda9Skristaps /*
3a35fc07aSschwarze  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4*16fe0cfcSschwarze  * Copyright (c) 2014, 2015, 2018 Ingo Schwarze <schwarze@openbsd.org>
5f73abda9Skristaps  *
6f73abda9Skristaps  * Permission to use, copy, modify, and distribute this software for any
7a6464425Sschwarze  * purpose with or without fee is hereby granted, provided that the above
8a6464425Sschwarze  * copyright notice and this permission notice appear in all copies.
9f73abda9Skristaps  *
103a0d07afSschwarze  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11a6464425Sschwarze  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
123a0d07afSschwarze  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13a6464425Sschwarze  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14a6464425Sschwarze  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15a6464425Sschwarze  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16a6464425Sschwarze  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17f73abda9Skristaps  */
18f73abda9Skristaps 
19ede1b9d0Sschwarze #define	MACRO_PROT_ARGS	  struct roff_man *man, \
2014a309e3Sschwarze 			  enum roff_tok tok, \
219830bf9fSschwarze 			  int line, \
229830bf9fSschwarze 			  int ppos, \
239830bf9fSschwarze 			  int *pos, \
249830bf9fSschwarze 			  char *buf
25e35cb253Sschwarze 
26e35cb253Sschwarze struct	man_macro {
27eae2af84Sschwarze 	void		(*fp)(MACRO_PROT_ARGS);
28e35cb253Sschwarze 	int		  flags;
2970a5c2d4Sschwarze #define	MAN_SCOPED	 (1 << 0)  /* Optional next-line scope. */
3070a5c2d4Sschwarze #define	MAN_NSCOPED	 (1 << 1)  /* Allowed in next-line element scope. */
3170a5c2d4Sschwarze #define	MAN_BSCOPE	 (1 << 2)  /* Break next-line block scope. */
3270a5c2d4Sschwarze #define	MAN_JOIN	 (1 << 3)  /* Join arguments together. */
33e35cb253Sschwarze };
34e35cb253Sschwarze 
35*16fe0cfcSschwarze const struct man_macro *man_macro(enum roff_tok);
36f73abda9Skristaps 
37b3cd4c9aSschwarze void		  man_node_validate(struct roff_man *);
38b3cd4c9aSschwarze void		  man_state(struct roff_man *, struct roff_node *);
39ede1b9d0Sschwarze void		  man_unscope(struct roff_man *, const struct roff_node *);
40