mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-02 17:42:31 +00:00
61 lines
1.5 KiB
C
61 lines
1.5 KiB
C
/*
|
|
* Copyright (C) 2009-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_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.
|
|
*
|
|
* @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);
|
|
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
|
|
#endif
|
|
|