]> git.proxmox.com Git - libgit2.git/commit - src/strmap.h
map: remove `*map_free` macros
authorPatrick Steinhardt <ps@pks.im>
Mon, 20 Mar 2017 08:01:18 +0000 (09:01 +0100)
committerPatrick Steinhardt <ps@pks.im>
Mon, 20 Mar 2017 08:01:18 +0000 (09:01 +0100)
commit94af9155cf908f402e07408d900177280c2e90bb
tree492d150ff5713cb967b3d1ebdde1404a359516aa
parent77c8ee74ff0f0ef4462fd6e963bc993c7a9721b3
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.
src/idxmap.c
src/idxmap.h
src/offmap.c
src/offmap.h
src/oidmap.c
src/oidmap.h
src/strmap.c
src/strmap.h