Return to tag.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/tag.h, Revision 1.11

1.11    ! schwarze    1: /* $Id$ */
1.1       schwarze    2: /*
1.10      schwarze    3:  * Copyright (c) 2015, 2018, 2019, 2020 Ingo Schwarze <schwarze@openbsd.org>
1.1       schwarze    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.
1.11    ! schwarze   16:  *
        !            17:  * Internal interfaces to tag syntax tree nodes.
        !            18:  * For use by mandoc(1) validation modules only.
1.1       schwarze   19:  */
1.10      schwarze   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:
1.11    ! schwarze   31: /*
        !            32:  * Return values of tag_check().
        !            33:  */
        !            34: enum tag_result {
        !            35:        TAG_OK,         /* Argument exists as a tag. */
        !            36:        TAG_MISS,       /* Argument not found. */
        !            37:        TAG_EMPTY       /* No tag exists at all. */
1.5       schwarze   38: };
                     39:
1.1       schwarze   40:
1.11    ! schwarze   41: void            tag_alloc(void);
        !            42: void            tag_put(const char *, int, struct roff_node *);
        !            43: enum tag_result         tag_check(const char *);
        !            44: void            tag_free(void);