summaryrefslogtreecommitdiff
path: root/src/offmap.h
blob: cde6c31c284a269f9c0ed68ff559586c2672a5d6 (plain)
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
/*
 * Copyright (C) 2012 the libgit2 contributors
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
#ifndef INCLUDE_offmap_h__
#define INCLUDE_offmap_h__

#include "common.h"

#include "git2/types.h"

/** A map with `git_off_t`s as key. */
typedef struct kh_off_s git_offmap;

/**
 * Allocate a new `git_off_t` map.
 *
 * @param out Pointer to the map that shall be allocated.
 * @return 0 on success, an error code if allocation has failed.
 */
int git_offmap_new(git_offmap **out);

/**
 * Free memory associated with the map.
 *
 * Note that this function will _not_ free values added to this
 * map.
 *
 * @param map Pointer to the map that is to be free'd. May be
 *            `NULL`.
 */
void git_offmap_free(git_offmap *map);

/**
 * Clear all entries from the map.
 *
 * This function will remove all entries from the associated map.
 * Memory associated with it will not be released, though.
 *
 * @param map Pointer to the map that shall be cleared. May be
 *            `NULL`.
 */
void git_offmap_clear(git_offmap *map);

/**
 * Return the number of elements in the map.
 *
 * @parameter map map containing the elements
 * @return number of elements in the map
 */
size_t git_offmap_size(git_offmap *map);

size_t git_offmap_lookup_index(git_offmap *map, const git_off_t key);
int git_offmap_valid_index(git_offmap *map, size_t idx);

int git_offmap_exists(git_offmap *map, const git_off_t key);
int git_offmap_has_data(git_offmap *map, size_t idx);

git_off_t git_offmap_key_at(git_offmap *map, size_t idx);
void *git_offmap_value_at(git_offmap *map, size_t idx);
void git_offmap_set_value_at(git_offmap *map, size_t idx, void *value);
void git_offmap_delete_at(git_offmap *map, size_t idx);

int git_offmap_put(git_offmap *map, const git_off_t key, int *err);
void git_offmap_insert(git_offmap *map, const git_off_t key, void *value, int *rval);
void git_offmap_delete(git_offmap *map, const git_off_t key);

size_t git_offmap_begin(git_offmap *map);
size_t git_offmap_end(git_offmap *map);

#define git_offmap_foreach(h, kvar, vvar, code) { size_t __i;			\
	for (__i = git_offmap_begin(h); __i != git_offmap_end(h); ++__i) {	\
		if (!git_offmap_has_data(h,__i)) continue;			\
		(kvar) = git_offmap_key_at(h,__i);				\
		(vvar) = git_offmap_value_at(h,__i);				\
		code;								\
	} }

#define git_offmap_foreach_value(h, vvar, code) { size_t __i;			\
	for (__i = git_offmap_begin(h); __i != git_offmap_end(h); ++__i) {	\
		if (!git_offmap_has_data(h,__i)) continue;			\
		(vvar) = git_offmap_value_at(h,__i);				\
		code;								\
	} }

#endif