thodg/libgit2/src/strmap.h

• Show log

  Commit

• Hash : ef507bc7
  Author :
  Date : 2019-01-23T10:44:02
  

  strmap: introduce `git_strmap_get` and use it throughout the tree The current way of looking up an entry from a map is tightly coupled with the map implementation, as one first has to look up the index of the key and then retrieve the associated value by using the index. As a caller, you usually do not care about any indices at all, though, so this is more complicated than really necessary. Furthermore, it invites for errors to happen if the correct error checking sequence is not being followed. Introduce a new high-level function `git_strmap_get` that takes a map and a key and returns a pointer to the associated value if such a key exists. Otherwise, a `NULL` pointer is returned. Adjust all callers that can trivially be converted.

Download

• src/strmap.h

• /*
   * 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_strmap_h__
  #define INCLUDE_strmap_h__
  
  #include "common.h"
  
  /** A map with C strings as key. */
  typedef struct kh_str_s git_strmap;
  
  /**
   * Allocate a new string map.
   *
   * @param out Pointer to the map that shall be allocated.
   * @return 0 on success, an error code if allocation has failed.
   */
  int git_strmap_new(git_strmap **out);
  
  /**
   * Free memory associated with the map.
   *
   * Note that this function will _not_ free keys or values added
   * to this map.
   *
   * @param map Pointer to the map that is to be free'd. May be
   *            `NULL`.
   */
  void git_strmap_free(git_strmap *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_strmap_clear(git_strmap *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_strmap_size(git_strmap *map);
  
  /**
   * Return value associated with the given key.
   *
   * @param map map to search key in
   * @param key key to search for
   * @return value associated with the given key or NULL if the key was not found
   */
  void *git_strmap_get(git_strmap *map, const char *key);
  
  /**
   * 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_strmap_set(git_strmap *map, const char *key, void *value);
  
  size_t git_strmap_lookup_index(git_strmap *map, const char *key);
  int git_strmap_valid_index(git_strmap *map, size_t idx);
  
  int git_strmap_exists(git_strmap *map, const char *key);
  int git_strmap_has_data(git_strmap *map, size_t idx);
  
  const char *git_strmap_key(git_strmap *map, size_t idx);
  void git_strmap_set_key_at(git_strmap *map, size_t idx, char *key);
  void *git_strmap_value_at(git_strmap *map, size_t idx);
  void git_strmap_set_value_at(git_strmap *map, size_t idx, void *value);
  void git_strmap_delete_at(git_strmap *map, size_t idx);
  
  int git_strmap_put(git_strmap *map, const char *key, int *err);
  void git_strmap_insert(git_strmap *map, const char *key, void *value, int *rval);
  void git_strmap_delete(git_strmap *map, const char *key);
  
  #define git_strmap_foreach(h, kvar, vvar, code) { size_t __i;			\
  	for (__i = git_strmap_begin(h); __i != git_strmap_end(h); ++__i) {	\
  		if (!git_strmap_has_data(h,__i)) continue;			\
  		(kvar) = git_strmap_key(h,__i);					\
  		(vvar) = git_strmap_value_at(h,__i);				\
  		code;								\
  	} }
  
  #define git_strmap_foreach_value(h, vvar, code) { size_t __i;			\
  	for (__i = git_strmap_begin(h); __i != git_strmap_end(h); ++__i) {	\
  		if (!git_strmap_has_data(h,__i)) continue;			\
  		(vvar) = git_strmap_value_at(h,__i);				\
  		code;								\
  	} }
  
  size_t git_strmap_begin(git_strmap *map);
  size_t git_strmap_end(git_strmap *map);
  
  int git_strmap_next(
  	void **data,
  	size_t *iter,
  	git_strmap *map);
  
  #endif
  

Download