idxmap.h 5.24 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/*
 * Copyright (C) the libgit2 contributors. All rights reserved.
 *
 * 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_idxmap_h__
#define INCLUDE_idxmap_h__

#include "common.h"
11

12 13
#include "git2/index.h"

14
/** A map with `git_index_entry`s as key. */
15
typedef struct kh_idx_s git_idxmap;
16
/** A map with case-insensitive `git_index_entry`s as key */
17
typedef struct kh_idxicase_s git_idxmap_icase;
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
/**
 * Allocate a new index entry map.
 *
 * @param out Pointer to the map that shall be allocated.
 * @return 0 on success, an error code if allocation has failed.
 */
int git_idxmap_new(git_idxmap **out);

/**
 * Allocate a new case-insensitive index entry map.
 *
 * @param out Pointer to the map that shall be allocated.
 * @return 0 on success, an error code if allocation has failed.
 */
int git_idxmap_icase_new(git_idxmap_icase **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_idxmap_free(git_idxmap *map);

/**
 * 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_idxmap_icase_free(git_idxmap_icase *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_idxmap_clear(git_idxmap *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_idxmap_icase_clear(git_idxmap_icase *map);

79
/**
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
 * Resize the map by allocating more memory.
 *
 * @param map map that shall be resized
 * @param size count of entries that the map shall hold
 * @return `0` if the map was successfully resized, a negative
 *         error code otherwise
 */
int git_idxmap_resize(git_idxmap *map, size_t size);

/**
 * Resize the map by allocating more memory.
 *
 * @param map map that shall be resized
 * @param size count of entries that the map shall hold
 * @return `0` if the map was successfully resized, a negative
 *         error code otherwise
 */
int git_idxmap_icase_resize(git_idxmap_icase *map, size_t size);

/**
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
 * Return value associated with the given key.
 *
 * @param map map to search key in
 * @param key key to search for; the index entry will be searched
 *            for by its case-sensitive path
 * @return value associated with the given key or NULL if the key was not found
 */
void *git_idxmap_get(git_idxmap *map, const git_index_entry *key);

/**
 * Return value associated with the given key.
 *
 * @param map map to search key in
 * @param key key to search for; the index entry will be searched
 *            for by its case-insensitive path
 * @return value associated with the given key or NULL if the key was not found
 */
void *git_idxmap_icase_get(git_idxmap_icase *map, const git_index_entry *key);

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
/**
 * Set the entry for key to value.
 *
 * If the map has no corresponding entry for the given key, a new
 * entry will be created with the given value. If an entry exists
 * already, its value will be updated to match the given value.
 *
 * @param map map to create new entry in
 * @param key key to set
 * @param value value to associate the key with; may be NULL
 * @return zero if the key was successfully set, a negative error
 *         code otherwise
 */
int git_idxmap_set(git_idxmap *map, const git_index_entry *key, void *value);

/**
 * Set the entry for key to value.
 *
 * If the map has no corresponding entry for the given key, a new
 * entry will be created with the given value. If an entry exists
 * already, its value will be updated to match the given value.
 *
 * @param map map to create new entry in
 * @param key key to set
 * @param value value to associate the key with; may be NULL
 * @return zero if the key was successfully set, a negative error
 *         code otherwise
 */
int git_idxmap_icase_set(git_idxmap_icase *map, const git_index_entry *key, void *value);

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
/**
 * Delete an entry from the map.
 *
 * Delete the given key and its value from the map. If no such
 * key exists, this will do nothing.
 *
 * @param map map to delete key in
 * @param key key to delete
 * @return `0` if the key has been deleted, GIT_ENOTFOUND if no
 *         such key was found, a negative code in case of an
 *         error
 */
int git_idxmap_delete(git_idxmap *map, const git_index_entry *key);

/**
 * Delete an entry from the map.
 *
 * Delete the given key and its value from the map. If no such
 * key exists, this will do nothing.
 *
 * @param map map to delete key in
 * @param key key to delete
 * @return `0` if the key has been deleted, GIT_ENOTFOUND if no
 *         such key was found, a negative code in case of an
 *         error
 */
int git_idxmap_icase_delete(git_idxmap_icase *map, const git_index_entry *key);

177
#endif