xref: /freebsd/contrib/mandoc/libman.h (revision 6be3386466ab79a84b48429ae66244f21526d3df)
1 /*	$Id: libman.h,v 1.86 2018/12/31 10:04:39 schwarze Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2014, 2015, 2018 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 struct	roff_node;
20 struct	roff_man;
21 
22 #define	MACRO_PROT_ARGS	  struct roff_man *man, \
23 			  enum roff_tok tok, \
24 			  int line, \
25 			  int ppos, \
26 			  int *pos, \
27 			  char *buf
28 
29 struct	man_macro {
30 	void		(*fp)(MACRO_PROT_ARGS);
31 	int		  flags;
32 #define	MAN_BSCOPED	 (1 << 0)  /* Optional next-line block scope. */
33 #define	MAN_ESCOPED	 (1 << 1)  /* Optional next-line element scope. */
34 #define	MAN_NSCOPED	 (1 << 2)  /* Allowed in next-line element scope. */
35 #define	MAN_XSCOPE	 (1 << 3)  /* Exit next-line block scope. */
36 #define	MAN_JOIN	 (1 << 4)  /* Join arguments together. */
37 };
38 
39 const struct man_macro *man_macro(enum roff_tok);
40 
41 void		  man_descope(struct roff_man *, int, int, char *);
42 void		  man_unscope(struct roff_man *, const struct roff_node *);
43