xref: /illumos-gate/usr/src/cmd/mandoc/tag.h (revision 4d131170e62381276a07ffc0aeb1b62e527d940c)
1 /* $Id: tag.h,v 1.14 2020/04/18 20:40:10 schwarze Exp $ */
2 /*
3  * Copyright (c) 2015, 2018, 2019, 2020 Ingo Schwarze <schwarze@openbsd.org>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  *
17  * Internal interfaces to tag syntax tree nodes.
18  * For use by mandoc(1) validation modules only.
19  */
20 
21 /*
22  * Tagging priorities.
23  * Lower numbers indicate higher importance.
24  */
25 #define	TAG_MANUAL	1		/* Set with a .Tg macro. */
26 #define	TAG_STRONG	2		/* Good automatic tagging. */
27 #define	TAG_WEAK	(INT_MAX - 2)	/* Dubious automatic tagging. */
28 #define	TAG_FALLBACK	(INT_MAX - 1)	/* Tag only used if unique. */
29 #define	TAG_DELETE	(INT_MAX)	/* Tag not used at all. */
30 
31 void		 tag_alloc(void);
32 int		 tag_exists(const char *);
33 void		 tag_put(const char *, int, struct roff_node *);
34 void		 tag_postprocess(struct roff_man *, struct roff_node *);
35 void		 tag_free(void);
36