thodg/libgit2/src/strmap.h

• Show log

  Commit

• Hash : 94af9155
  Author :
  Date : 2017-03-20T09:01:18
  

  map: remove `*map_free` macros
  
  The `map_free` functions were not implemented as functions but instead
  as macros which also set the map to NULL. While this is most certainly
  sensible in most cases, we should prefer the more obvious behavior,
  namingly leaving the map pointer intact.
  
  Furthermore, this macro has been refactored incorrectly during the
  map-refactorings: the two statements are not actually grouped together
  by a `do { ... } while (0)` block, as it is required for macros to
  match the behavior of functions more closely. This has led to at least
  one subtle nesting error in `pack-objects.c`. The following code block
  
  ```
      if (pb->object_ix)
          git_oidmap_free(pb->object_ix);
  ```
  
  would be expanded to
  
  ```
      if (pb->object_ix)
          git_oidmap__free(pb->object_ix); pb->object_ix = NULL;
  ```
  
  which is not what one woudl expect. While it is not a bug here as it
  would simply become a no-op, the wrong implementation could lead to bugs
  in other occasions.
  
  Fix this by simply removing the macro altogether and replacing it with
  real function calls. This leaves the burden of setting the pointer to
  NULL afterwards to the caller, but this is actually expected and behaves
  like other `free` functions.
  

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"
  
  #define kmalloc git__malloc
  #define kcalloc git__calloc
  #define krealloc git__realloc
  #define kreallocarray git__reallocarray
  #define kfree git__free
  #include "khash.h"
  
  __KHASH_TYPE(str, const char *, void *)
  typedef khash_t(str) git_strmap;
  typedef khiter_t git_strmap_iter;
  
  int git_strmap_alloc(git_strmap **map);
  void git_strmap_free(git_strmap *map);
  void git_strmap_clear(git_strmap *map);
  
  size_t git_strmap_num_entries(git_strmap *map);
  
  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		kh_foreach
  #define git_strmap_foreach_value	kh_foreach_value
  
  #define git_strmap_begin		kh_begin
  #define git_strmap_end		kh_end
  
  int git_strmap_next(
  	void **data,
  	git_strmap_iter* iter,
  	git_strmap *map);
  
  #endif
  

Download