thodg/libgit2/src/offmap.h

• Show log

  Commit

• Hash : aa245623
  Author :
  Date : 2018-11-30T18:28:05
  

  offmap: 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_offmap_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/offmap.h

• /*
   * 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);
  
  /**
   * 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_offmap_get(git_offmap *map, const git_off_t key);
  
  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
  

Download