mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-02 11:49:04 +00:00

The goal of this work is to expose the search logic for "global", "system", and "xdg" files through the git_libgit2_opts() interface. Behind the scenes, I changed the logic for finding files to have a notion of a git_strarray that represents a search path and to store a separate search path for each of the three tiers of config file. For each tier, I implemented a function to initialize it to default values (generally based on environment variables), and then general interfaces to get it, set it, reset it, and prepend new directories to it. Next, I exposed these interfaces through the git_libgit2_opts interface, reusing the GIT_CONFIG_LEVEL_SYSTEM, etc., constants for the user to control which search path they were modifying. There are alternative designs for the opts interface / argument ordering, so I'm putting this phase out for discussion. Additionally, I ended up doing a little bit of clean up regarding attr.h and attr_file.h, adding a new attrcache.h so the other two files wouldn't have to be included in so many places.
87 lines
2.5 KiB
C
87 lines
2.5 KiB
C
/*
|
|
* 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_git_strarray_h__
|
|
#define INCLUDE_git_strarray_h__
|
|
|
|
#include "common.h"
|
|
|
|
/**
|
|
* @file git2/strarray.h
|
|
* @brief Git string array routines
|
|
* @defgroup git_strarray Git string array routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/** Array of strings */
|
|
typedef struct git_strarray {
|
|
char **strings;
|
|
size_t count;
|
|
} git_strarray;
|
|
|
|
/**
|
|
* Close a string array object
|
|
*
|
|
* This method should be called on `git_strarray` objects where the strings
|
|
* array is allocated and contains allocated strings, such as what you
|
|
* would get from `git_strarray_copy()`. Not doing so, will result in a
|
|
* memory leak.
|
|
*
|
|
* This does not free the `git_strarray` itself, since the library will
|
|
* never allocate that object directly itself (it is more commonly embedded
|
|
* inside another struct or created on the stack).
|
|
*
|
|
* @param array git_strarray from which to free string data
|
|
*/
|
|
GIT_EXTERN(void) git_strarray_free(git_strarray *array);
|
|
|
|
/**
|
|
* Copy a string array object from source to target.
|
|
*
|
|
* Note: target is overwritten and hence should be empty, otherwise its
|
|
* contents are leaked. Call git_strarray_free() if necessary.
|
|
*
|
|
* @param tgt target
|
|
* @param src source
|
|
* @return 0 on success, < 0 on allocation failure
|
|
*/
|
|
GIT_EXTERN(int) git_strarray_copy(git_strarray *tgt, const git_strarray *src);
|
|
|
|
/**
|
|
* Initialize a string array from a list of strings
|
|
*
|
|
* Note: target is overwritten and hence should be empty, otherwise its
|
|
* contents are leaked. Call git_strarray_free() if necessary.
|
|
*
|
|
* @param tgt target
|
|
* @param count number of strings to follow
|
|
* @return 0 on success, <0 on allocation failure
|
|
*/
|
|
GIT_EXTERN(int) git_strarray_set(git_strarray *tgt, size_t count, ...);
|
|
|
|
/**
|
|
* Insert a strarray into the beginning of another
|
|
*
|
|
* In this case, tgt is an existing (initialized) strarray and the result
|
|
* will be reallocated with all the strings in src inserted before all of
|
|
* the existing strings in tgt. Strings in src will be strdup'ed, so
|
|
* you should still `git_strarray_free()` src when you are done with it.
|
|
*
|
|
* @param tgt strarray to update
|
|
* @param src strarray to copy from
|
|
* @return 0 on success, <0 on allocation failure (tgt will be unchanged)
|
|
*/
|
|
GIT_EXTERN(int) git_strarray_prepend(git_strarray *tgt, const git_strarray *src);
|
|
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
|
|
#endif
|
|
|