xref: /dflybsd-src/contrib/mdocml/libman.h (revision 54ba96075f5891e4574304da6ba88f1a1afe520b)
1*54ba9607SSascha Wildner /*	$Id: libman.h,v 1.86 2018/12/31 10:04:39 schwarze Exp $ */
280387638SSascha Wildner /*
336342e81SSascha Wildner  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4*54ba9607SSascha Wildner  * Copyright (c) 2014, 2015, 2018 Ingo Schwarze <schwarze@openbsd.org>
580387638SSascha Wildner  *
680387638SSascha Wildner  * Permission to use, copy, modify, and distribute this software for any
780387638SSascha Wildner  * purpose with or without fee is hereby granted, provided that the above
880387638SSascha Wildner  * copyright notice and this permission notice appear in all copies.
980387638SSascha Wildner  *
10*54ba9607SSascha Wildner  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1180387638SSascha Wildner  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12*54ba9607SSascha Wildner  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1380387638SSascha Wildner  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1480387638SSascha Wildner  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1580387638SSascha Wildner  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1680387638SSascha Wildner  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1780387638SSascha Wildner  */
1880387638SSascha Wildner 
19*54ba9607SSascha Wildner struct	roff_node;
20*54ba9607SSascha Wildner struct	roff_man;
2180387638SSascha Wildner 
22*54ba9607SSascha Wildner #define	MACRO_PROT_ARGS	  struct roff_man *man, \
23*54ba9607SSascha Wildner 			  enum roff_tok tok, \
2480387638SSascha Wildner 			  int line, \
2580387638SSascha Wildner 			  int ppos, \
2680387638SSascha Wildner 			  int *pos, \
2780387638SSascha Wildner 			  char *buf
2880387638SSascha Wildner 
2980387638SSascha Wildner struct	man_macro {
30*54ba9607SSascha Wildner 	void		(*fp)(MACRO_PROT_ARGS);
3180387638SSascha Wildner 	int		  flags;
32*54ba9607SSascha Wildner #define	MAN_BSCOPED	 (1 << 0)  /* Optional next-line block scope. */
33*54ba9607SSascha Wildner #define	MAN_ESCOPED	 (1 << 1)  /* Optional next-line element scope. */
34*54ba9607SSascha Wildner #define	MAN_NSCOPED	 (1 << 2)  /* Allowed in next-line element scope. */
35*54ba9607SSascha Wildner #define	MAN_XSCOPE	 (1 << 3)  /* Exit next-line block scope. */
36*54ba9607SSascha Wildner #define	MAN_JOIN	 (1 << 4)  /* Join arguments together. */
3780387638SSascha Wildner };
3880387638SSascha Wildner 
39*54ba9607SSascha Wildner const struct man_macro *man_macro(enum roff_tok);
4080387638SSascha Wildner 
41*54ba9607SSascha Wildner void		  man_descope(struct roff_man *, int, int, char *);
42*54ba9607SSascha Wildner void		  man_unscope(struct roff_man *, const struct roff_node *);
43