xref: /openbsd/usr.bin/mandoc/libman.h (revision 542a495f)
1*542a495fSschwarze /*	$OpenBSD: libman.h,v 1.61 2018/12/31 10:03:38 schwarze Exp $ */
2f73abda9Skristaps /*
3a35fc07aSschwarze  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
416fe0cfcSschwarze  * 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 
196b86842eSschwarze struct	roff_node;
206b86842eSschwarze struct	roff_man;
216b86842eSschwarze 
22ede1b9d0Sschwarze #define	MACRO_PROT_ARGS	  struct roff_man *man, \
2314a309e3Sschwarze 			  enum roff_tok tok, \
249830bf9fSschwarze 			  int line, \
259830bf9fSschwarze 			  int ppos, \
269830bf9fSschwarze 			  int *pos, \
279830bf9fSschwarze 			  char *buf
28e35cb253Sschwarze 
29e35cb253Sschwarze struct	man_macro {
30eae2af84Sschwarze 	void		(*fp)(MACRO_PROT_ARGS);
31e35cb253Sschwarze 	int		  flags;
3263f82d49Sschwarze #define	MAN_BSCOPED	 (1 << 0)  /* Optional next-line block scope. */
3363f82d49Sschwarze #define	MAN_ESCOPED	 (1 << 1)  /* Optional next-line element scope. */
3463f82d49Sschwarze #define	MAN_NSCOPED	 (1 << 2)  /* Allowed in next-line element scope. */
3563f82d49Sschwarze #define	MAN_XSCOPE	 (1 << 3)  /* Exit next-line block scope. */
3663f82d49Sschwarze #define	MAN_JOIN	 (1 << 4)  /* Join arguments together. */
37e35cb253Sschwarze };
38e35cb253Sschwarze 
3916fe0cfcSschwarze const struct man_macro *man_macro(enum roff_tok);
40f73abda9Skristaps 
4163f82d49Sschwarze void		  man_descope(struct roff_man *, int, int, char *);
42ede1b9d0Sschwarze void		  man_unscope(struct roff_man *, const struct roff_node *);
43