summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/util/tagmap.c
blob: 6cd9ddad601d6632e57c0af3c6cca0cd47509097 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/***************************************************************************

    tagmap.c

    Simple tag->object mapping functions.

****************************************************************************

    Copyright Aaron Giles
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are
    met:

        * Redistributions of source code must retain the above copyright
          notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright
          notice, this list of conditions and the following disclaimer in
          the documentation and/or other materials provided with the
          distribution.
        * Neither the name 'MAME' nor the names of its contributors may be
          used to endorse or promote products derived from this software
          without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY AARON GILES ''AS IS'' AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL AARON GILES BE LIABLE FOR ANY DIRECT,
    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

****************************************************************************/

#include "tagmap.h"


/***************************************************************************
    FUNCTION PROTOTYPES
***************************************************************************/

static tagmap_error tagmap_add_common(tagmap *map, const char *tag, void *object, int unique_hash);



/***************************************************************************
    MAP ALLOCATION AND MANAGEMENT
***************************************************************************/

/*-------------------------------------------------
    tagmap_alloc - allocate a new tagmap
-------------------------------------------------*/

tagmap *tagmap_alloc(void)
{
	tagmap *map = malloc(sizeof(*map));
	if (map != NULL)
		memset(map, 0, sizeof(*map));
	return map;
}


/*-------------------------------------------------
    tagmap_free - free a tagmap, and all 
    entries within it
-------------------------------------------------*/

void tagmap_free(tagmap *map)
{
	tagmap_reset(map);
	free(map);
}


/*-------------------------------------------------
    tagmap_reset - reset a tagmap by freeing 
    all entries
-------------------------------------------------*/

void tagmap_reset(tagmap *map)
{
	UINT32 hashindex;
	
	for (hashindex = 0; hashindex < ARRAY_LENGTH(map->table); hashindex++)
	{
		tagmap_entry *entry, *next;

		for (entry = map->table[hashindex]; entry != NULL; entry = next)
		{
			next = entry->next;
			free(entry);
		}
	}
}



/***************************************************************************
    MAP ALLOCATION AND MANAGEMENT
***************************************************************************/

/*-------------------------------------------------
    tagmap_add - add a new object to the
    tagmap
-------------------------------------------------*/

tagmap_error tagmap_add(tagmap *map, const char *tag, void *object)
{
	return tagmap_add_common(map, tag, object, FALSE);
}


/*-------------------------------------------------
    tagmap_add_unique_hash - add a new entry to a 
    tagmap, ensuring it has a unique hash value
-------------------------------------------------*/

tagmap_error tagmap_add_unique_hash(tagmap *map, const char *tag, void *object)
{
	return tagmap_add_common(map, tag, object, TRUE);
}


/*-------------------------------------------------
    tagmap_remove - remove an object from a
    tagmap
-------------------------------------------------*/

void tagmap_remove(tagmap *map, const char *tag)
{
	UINT32 fullhash = tagmap_hash(tag);
	tagmap_entry **entryptr;
	
	for (entryptr = &map->table[fullhash % ARRAY_LENGTH(map->table)]; *entryptr != NULL; entryptr = &(*entryptr)->next)
		if ((*entryptr)->fullhash == fullhash && strcmp((*entryptr)->tag, tag) == 0)
		{
			tagmap_entry *entry = *entryptr;
			*entryptr = entry->next;
			free(entry);
			break;
		}
}



/***************************************************************************
    LOCAL FUNCTIONS
***************************************************************************/

/*-------------------------------------------------
    tagmap_add_common - core implementation of
    a tagmap addition
-------------------------------------------------*/

static tagmap_error tagmap_add_common(tagmap *map, const char *tag, void *object, int unique_hash)
{
	UINT32 fullhash = tagmap_hash(tag);
	UINT32 hashindex = fullhash % ARRAY_LENGTH(map->table);
	tagmap_entry *entry;

	/* first make sure we don't have a duplicate */
	for (entry = map->table[hashindex]; entry != NULL; entry = entry->next)
		if (entry->fullhash == fullhash)
		{
			/* if we require a unique hash, fail here */
			if (unique_hash)
				return TMERR_DUPLICATE;
		
			/* validate the string */
			if (strcmp(tag, entry->tag) == 0)
				return TMERR_DUPLICATE;
		}

	/* now allocate a new entry */
	entry = malloc(sizeof(*entry) + strlen(tag));
	if (entry == NULL)
		return TMERR_OUT_OF_MEMORY;
	
	/* fill in the entry */
	entry->object = object;
	entry->fullhash = fullhash;
	strcpy(entry->tag, tag);

	/* add it to the head of the list */
	entry->next = map->table[hashindex];
	map->table[hashindex] = entry;
	return TMERR_NONE;
}