1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-05-18 18:16:08 +02:00
git/strmap.c
Elijah Newren b70c82e6ed strmap: add more utility functions
This adds a number of additional convienence functions I want/need:
  * strmap_get_size()
  * strmap_empty()
  * strmap_remove()
  * strmap_for_each_entry()
  * strmap_get_entry()

I suspect the first four are self-explanatory.

strmap_get_entry() is similar to strmap_get() except that instead of just
returning the void* value that the string maps to, it returns the
strmap_entry that contains both the string and the void* value (or
NULL if the string isn't in the map).  This is helpful because it avoids
multiple lookups, e.g. in some cases a caller would need to call:
  * strmap_contains() to check that the map has an entry for the string
  * strmap_get() to get the void* value
  * <do some work to update the value>
  * strmap_put() to update/overwrite the value
If the void* pointer returned really is a pointer, then the last step is
unnecessary, but if the void* pointer is just cast to an integer then
strmap_put() will be needed.  In contrast, one can call strmap_get_entry()
and then:
  * check if the string was in the map by whether the pointer is NULL
  * access the value via entry->value
  * directly update entry->value
meaning that we can replace two or three hash table lookups with one.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-11-04 17:09:49 -08:00

120 lines
2.8 KiB
C

#include "git-compat-util.h"
#include "strmap.h"
int cmp_strmap_entry(const void *hashmap_cmp_fn_data,
const struct hashmap_entry *entry1,
const struct hashmap_entry *entry2,
const void *keydata)
{
const struct strmap_entry *e1, *e2;
e1 = container_of(entry1, const struct strmap_entry, ent);
e2 = container_of(entry2, const struct strmap_entry, ent);
return strcmp(e1->key, e2->key);
}
static struct strmap_entry *find_strmap_entry(struct strmap *map,
const char *str)
{
struct strmap_entry entry;
hashmap_entry_init(&entry.ent, strhash(str));
entry.key = str;
return hashmap_get_entry(&map->map, &entry, ent, NULL);
}
void strmap_init(struct strmap *map)
{
strmap_init_with_options(map, 1);
}
void strmap_init_with_options(struct strmap *map,
int strdup_strings)
{
hashmap_init(&map->map, cmp_strmap_entry, NULL, 0);
map->strdup_strings = strdup_strings;
}
static void strmap_free_entries_(struct strmap *map, int free_values)
{
struct hashmap_iter iter;
struct strmap_entry *e;
if (!map)
return;
/*
* We need to iterate over the hashmap entries and free
* e->key and e->value ourselves; hashmap has no API to
* take care of that for us. Since we're already iterating over
* the hashmap, though, might as well free e too and avoid the need
* to make some call into the hashmap API to do that.
*/
hashmap_for_each_entry(&map->map, &iter, e, ent) {
if (free_values)
free(e->value);
if (map->strdup_strings)
free((char*)e->key);
free(e);
}
}
void strmap_clear(struct strmap *map, int free_values)
{
strmap_free_entries_(map, free_values);
hashmap_clear(&map->map);
}
void *strmap_put(struct strmap *map, const char *str, void *data)
{
struct strmap_entry *entry = find_strmap_entry(map, str);
void *old = NULL;
if (entry) {
old = entry->value;
entry->value = data;
} else {
const char *key = str;
entry = xmalloc(sizeof(*entry));
hashmap_entry_init(&entry->ent, strhash(str));
if (map->strdup_strings)
key = xstrdup(str);
entry->key = key;
entry->value = data;
hashmap_add(&map->map, &entry->ent);
}
return old;
}
struct strmap_entry *strmap_get_entry(struct strmap *map, const char *str)
{
return find_strmap_entry(map, str);
}
void *strmap_get(struct strmap *map, const char *str)
{
struct strmap_entry *entry = find_strmap_entry(map, str);
return entry ? entry->value : NULL;
}
int strmap_contains(struct strmap *map, const char *str)
{
return find_strmap_entry(map, str) != NULL;
}
void strmap_remove(struct strmap *map, const char *str, int free_value)
{
struct strmap_entry entry, *ret;
hashmap_entry_init(&entry.ent, strhash(str));
entry.key = str;
ret = hashmap_remove_entry(&map->map, &entry, ent, NULL);
if (!ret)
return;
if (free_value)
free(ret->value);
if (map->strdup_strings)
free((char*)ret->key);
free(ret);
}