[BACK]Return to tag.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/tag.c, Revision 1.29

1.29    ! schwarze    1: /* $Id: tag.c,v 1.28 2020/03/13 15:32:29 schwarze Exp $ */
1.1       schwarze    2: /*
1.26      schwarze    3:  * Copyright (c) 2015,2016,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.28      schwarze   16:  *
                     17:  * Functions to tag syntax tree nodes.
                     18:  * For internal use by mandoc(1) validation modules only.
1.1       schwarze   19:  */
1.7       schwarze   20: #include "config.h"
                     21:
1.1       schwarze   22: #include <sys/types.h>
                     23:
1.27      schwarze   24: #include <assert.h>
1.20      schwarze   25: #include <limits.h>
1.1       schwarze   26: #include <stddef.h>
                     27: #include <stdlib.h>
                     28: #include <string.h>
                     29:
                     30: #include "mandoc_aux.h"
1.10      schwarze   31: #include "mandoc_ohash.h"
1.28      schwarze   32: #include "roff.h"
1.1       schwarze   33: #include "tag.h"
                     34:
                     35: struct tag_entry {
1.28      schwarze   36:        struct roff_node **nodes;
                     37:        size_t   maxnodes;
                     38:        size_t   nnodes;
1.4       schwarze   39:        int      prio;
1.1       schwarze   40:        char     s[];
                     41: };
                     42:
                     43: static struct ohash     tag_data;
                     44:
                     45:
                     46: /*
1.28      schwarze   47:  * Set up the ohash table to collect nodes
                     48:  * where various marked-up terms are documented.
1.1       schwarze   49:  */
1.28      schwarze   50: void
                     51: tag_alloc(void)
1.1       schwarze   52: {
1.28      schwarze   53:        mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
                     54: }
1.1       schwarze   55:
1.28      schwarze   56: void
                     57: tag_free(void)
                     58: {
                     59:        struct tag_entry        *entry;
                     60:        unsigned int             slot;
1.12      schwarze   61:
1.29    ! schwarze   62:        if (tag_data.info.free == NULL)
        !            63:                return;
1.28      schwarze   64:        entry = ohash_first(&tag_data, &slot);
                     65:        while (entry != NULL) {
                     66:                free(entry->nodes);
                     67:                free(entry);
                     68:                entry = ohash_next(&tag_data, &slot);
1.22      schwarze   69:        }
1.28      schwarze   70:        ohash_delete(&tag_data);
1.29    ! schwarze   71:        tag_data.info.free = NULL;
1.1       schwarze   72: }
                     73:
                     74: /*
1.28      schwarze   75:  * Set a node where a term is defined,
1.20      schwarze   76:  * unless it is already defined at a lower priority.
1.1       schwarze   77:  */
                     78: void
1.28      schwarze   79: tag_put(const char *s, int prio, struct roff_node *n)
1.1       schwarze   80: {
                     81:        struct tag_entry        *entry;
1.20      schwarze   82:        const char              *se;
1.5       schwarze   83:        size_t                   len;
1.1       schwarze   84:        unsigned int             slot;
                     85:
1.27      schwarze   86:        assert(prio <= TAG_FALLBACK);
1.20      schwarze   87:
1.28      schwarze   88:        if (s == NULL) {
                     89:                if (n->child == NULL || n->child->type != ROFFT_TEXT)
                     90:                        return;
                     91:                s = n->child->string;
                     92:                if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))
                     93:                        s += 2;
                     94:        }
1.20      schwarze   95:
                     96:        /*
1.24      schwarze   97:         * Skip whitespace and escapes and whatever follows,
1.20      schwarze   98:         * and if there is any, downgrade the priority.
                     99:         */
                    100:
1.24      schwarze  101:        len = strcspn(s, " \t\\");
1.20      schwarze  102:        if (len == 0)
1.1       schwarze  103:                return;
1.14      schwarze  104:
1.20      schwarze  105:        se = s + len;
1.27      schwarze  106:        if (*se != '\0' && prio < TAG_WEAK)
                    107:                prio = TAG_WEAK;
1.20      schwarze  108:
                    109:        slot = ohash_qlookupi(&tag_data, s, &se);
1.1       schwarze  110:        entry = ohash_find(&tag_data, slot);
1.14      schwarze  111:
1.28      schwarze  112:        /* Build a new entry. */
                    113:
1.1       schwarze  114:        if (entry == NULL) {
1.20      schwarze  115:                entry = mandoc_malloc(sizeof(*entry) + len + 1);
1.1       schwarze  116:                memcpy(entry->s, s, len);
1.20      schwarze  117:                entry->s[len] = '\0';
1.28      schwarze  118:                entry->nodes = NULL;
                    119:                entry->maxnodes = entry->nnodes = 0;
1.1       schwarze  120:                ohash_insert(&tag_data, slot, entry);
1.28      schwarze  121:        }
1.14      schwarze  122:
1.28      schwarze  123:        /*
                    124:         * Lower priority numbers take precedence.
                    125:         * If a better entry is already present, ignore the new one.
                    126:         */
                    127:
                    128:        else if (entry->prio < prio)
                    129:                        return;
                    130:
                    131:        /*
                    132:         * If the existing entry is worse, clear it.
                    133:         * In addition, a tag with priority TAG_FALLBACK
                    134:         * is only used if the tag occurs exactly once.
                    135:         */
1.14      schwarze  136:
1.28      schwarze  137:        else if (entry->prio > prio || prio == TAG_FALLBACK) {
                    138:                while (entry->nnodes > 0)
                    139:                        entry->nodes[--entry->nnodes]->flags &= ~NODE_ID;
1.16      schwarze  140:
1.27      schwarze  141:                if (prio == TAG_FALLBACK) {
1.28      schwarze  142:                        entry->prio = TAG_DELETE;
1.16      schwarze  143:                        return;
                    144:                }
1.14      schwarze  145:        }
                    146:
1.28      schwarze  147:        /* Remember the new node. */
1.14      schwarze  148:
1.28      schwarze  149:        if (entry->maxnodes == entry->nnodes) {
                    150:                entry->maxnodes += 4;
                    151:                entry->nodes = mandoc_reallocarray(entry->nodes,
                    152:                    entry->maxnodes, sizeof(*entry->nodes));
1.14      schwarze  153:        }
1.28      schwarze  154:        entry->nodes[entry->nnodes++] = n;
1.4       schwarze  155:        entry->prio = prio;
1.28      schwarze  156:        n->flags |= NODE_ID;
                    157:        if (n->child == NULL || n->child->string != s || *se != '\0') {
                    158:                assert(n->string == NULL);
                    159:                n->string = mandoc_strndup(s, len);
                    160:        }
1.1       schwarze  161: }
                    162:
1.28      schwarze  163: enum tag_result
                    164: tag_check(const char *test_tag)
1.1       schwarze  165: {
1.28      schwarze  166:        unsigned int slot;
1.1       schwarze  167:
1.28      schwarze  168:        if (ohash_first(&tag_data, &slot) == NULL)
                    169:                return TAG_EMPTY;
                    170:        else if (test_tag != NULL && ohash_find(&tag_data,
                    171:            ohash_qlookup(&tag_data, test_tag)) == NULL)
                    172:                return TAG_MISS;
1.19      schwarze  173:        else
1.28      schwarze  174:                return TAG_OK;
1.1       schwarze  175: }

CVSweb