thodg/libgit2/src/oidmap.h

• Show log

  Commit

• Hash : 9694ef20
  Author :
  Date : 2018-12-17T09:01:53
  

  oidmap: introduce high-level getter for values 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_oidmap_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/oidmap.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_oidmap_h__
  #define INCLUDE_oidmap_h__
  
  #include "common.h"
  
  #include "git2/oid.h"
  
  /** A map with `git_oid`s as key. */
  typedef struct kh_oid_s git_oidmap;
  
  /**
   * Allocate a new OID map.
   *
   * @param out Pointer to the map that shall be allocated.
   * @return 0 on success, an error code if allocation has failed.
   */
  int git_oidmap_new(git_oidmap **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_oidmap_free(git_oidmap *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_oidmap_clear(git_oidmap *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_oidmap_size(git_oidmap *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_oidmap_get(git_oidmap *map, const git_oid *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_oidmap_set(git_oidmap *map, const git_oid *key, void *value);
  
  size_t git_oidmap_lookup_index(git_oidmap *map, const git_oid *key);
  int git_oidmap_valid_index(git_oidmap *map, size_t idx);
  
  int git_oidmap_exists(git_oidmap *map, const git_oid *key);
  int git_oidmap_has_data(git_oidmap *map, size_t idx);
  
  const git_oid *git_oidmap_key(git_oidmap *map, size_t idx);
  void git_oidmap_set_key_at(git_oidmap *map, size_t idx, git_oid *key);
  void *git_oidmap_value_at(git_oidmap *map, size_t idx);
  void git_oidmap_set_value_at(git_oidmap *map, size_t idx, void *value);
  void git_oidmap_delete_at(git_oidmap *map, size_t idx);
  
  int git_oidmap_put(git_oidmap *map, const git_oid *key, int *err);
  void git_oidmap_insert(git_oidmap *map, const git_oid *key, void *value, int *rval);
  void git_oidmap_delete(git_oidmap *map, const git_oid *key);
  
  size_t git_oidmap_begin(git_oidmap *map);
  size_t git_oidmap_end(git_oidmap *map);
  
  #define git_oidmap_foreach_value(h, vvar, code) { size_t __i;			\
  	for (__i = git_oidmap_begin(h); __i != git_oidmap_end(h); ++__i) {	\
  		if (!git_oidmap_has_data(h,__i)) continue;			\
  		(vvar) = git_oidmap_value_at(h,__i);				\
  		code;								\
  	} }
  
  #endif
  

Download