2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
7 #ifndef INCLUDE_git_common_h__
8 #define INCLUDE_git_common_h__
14 # define GIT_BEGIN_DECL extern "C" {
15 # define GIT_END_DECL }
17 /** Start declarations in C mode */
18 # define GIT_BEGIN_DECL /* empty */
19 /** End declarations in C mode */
20 # define GIT_END_DECL /* empty */
23 #if defined(_MSC_VER) && _MSC_VER < 1800
25 # include "inttypes.h"
27 /** This check is needed for importing this file in an iOS/OS X framework throws an error in Xcode otherwise.*/
28 #elif !defined(__CLANG_INTTYPES_H)
29 # include <inttypes.h>
34 * This is so clang's doc parser acknowledges comments on functions
35 * with size_t parameters.
37 typedef size_t size_t;
40 /** Declare a public function exported for application use. */
42 # define GIT_EXTERN(type) extern \
43 __attribute__((visibility("default"))) \
45 #elif defined(_MSC_VER)
46 # define GIT_EXTERN(type) __declspec(dllexport) type
48 # define GIT_EXTERN(type) extern type
51 /** Declare a function's takes printf style arguments. */
53 # define GIT_FORMAT_PRINTF(a,b) __attribute__((format (printf, a, b)))
55 # define GIT_FORMAT_PRINTF(a,b) /* empty */
58 #if (defined(_WIN32)) && !defined(__CYGWIN__)
63 #include <netinet/in.h>
68 * @brief Git common platform definitions
69 * @defgroup git_common Git common platform definitions
77 * The separator used in path list strings (ie like in the PATH
78 * environment variable). A semi-colon ";" is used on Windows, and
79 * a colon ":" for all other systems.
82 #define GIT_PATH_LIST_SEPARATOR ';'
84 #define GIT_PATH_LIST_SEPARATOR ':'
88 * The maximum length of a valid git path.
90 #define GIT_PATH_MAX 4096
93 * The string representation of the null object ID.
95 #define GIT_OID_HEX_ZERO "0000000000000000000000000000000000000000"
98 * Return the version of the libgit2 library
99 * being currently used.
101 * @param major Store the major version number
102 * @param minor Store the minor version number
103 * @param rev Store the revision (patch) number
105 GIT_EXTERN(void) git_libgit2_version(int *major
, int *minor
, int *rev
);
108 * Combinations of these values describe the features with which libgit2
113 * If set, libgit2 was built thread-aware and can be safely used from multiple
116 GIT_FEATURE_THREADS
= (1 << 0),
118 * If set, libgit2 was built with and linked against a TLS implementation.
119 * Custom TLS streams may still be added by the user to support HTTPS
120 * regardless of this.
122 GIT_FEATURE_HTTPS
= (1 << 1),
124 * If set, libgit2 was built with and linked against libssh2. A custom
125 * transport may still be added by the user to support libssh2 regardless of
128 GIT_FEATURE_SSH
= (1 << 2),
130 * If set, libgit2 was built with support for sub-second resolution in file
131 * modification times.
133 GIT_FEATURE_NSEC
= (1 << 3),
137 * Query compile time options for libgit2.
139 * @return A combination of GIT_FEATURE_* values.
141 * - GIT_FEATURE_THREADS
142 * Libgit2 was compiled with thread support. Note that thread support is
143 * still to be seen as a 'work in progress' - basic object lookups are
144 * believed to be threadsafe, but other operations may not be.
146 * - GIT_FEATURE_HTTPS
147 * Libgit2 supports the https:// protocol. This requires the openssl
148 * library to be found when compiling libgit2.
151 * Libgit2 supports the SSH protocol for network operations. This requires
152 * the libssh2 library to be found when compiling libgit2
154 GIT_EXTERN(int) git_libgit2_features(void);
157 * Global library options
159 * These are used to select which global option to set or get and are
160 * used in `git_libgit2_opts()`.
163 GIT_OPT_GET_MWINDOW_SIZE
,
164 GIT_OPT_SET_MWINDOW_SIZE
,
165 GIT_OPT_GET_MWINDOW_MAPPED_LIMIT
,
166 GIT_OPT_SET_MWINDOW_MAPPED_LIMIT
,
167 GIT_OPT_GET_SEARCH_PATH
,
168 GIT_OPT_SET_SEARCH_PATH
,
169 GIT_OPT_SET_CACHE_OBJECT_LIMIT
,
170 GIT_OPT_SET_CACHE_MAX_SIZE
,
171 GIT_OPT_ENABLE_CACHING
,
172 GIT_OPT_GET_CACHED_MEMORY
,
173 GIT_OPT_GET_TEMPLATE_PATH
,
174 GIT_OPT_SET_TEMPLATE_PATH
,
175 GIT_OPT_SET_SSL_CERT_LOCATIONS
,
176 GIT_OPT_SET_USER_AGENT
,
177 GIT_OPT_ENABLE_STRICT_OBJECT_CREATION
,
178 GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION
,
179 GIT_OPT_SET_SSL_CIPHERS
,
180 GIT_OPT_GET_USER_AGENT
,
181 GIT_OPT_ENABLE_OFS_DELTA
,
185 * Set or query a library global option
189 * * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):
191 * > Get the maximum mmap window size
193 * * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):
195 * > Set the maximum mmap window size
197 * * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):
199 * > Get the maximum memory that will be mapped in total by the library
201 * * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):
203 * >Set the maximum amount of memory that can be mapped at any time
206 * * opts(GIT_OPT_GET_SEARCH_PATH, int level, git_buf *buf)
208 * > Get the search path for a given level of config data. "level" must
209 * > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`,
210 * > `GIT_CONFIG_LEVEL_XDG`, or `GIT_CONFIG_LEVEL_PROGRAMDATA`.
211 * > The search path is written to the `out` buffer.
213 * * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)
215 * > Set the search path for a level of config data. The search path
216 * > applied to shared attributes and ignore files, too.
218 * > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.
219 * > Pass NULL to reset to the default (generally based on environment
220 * > variables). Use magic path `$PATH` to include the old value
221 * > of the path (if you want to prepend or append, for instance).
223 * > - `level` must be `GIT_CONFIG_LEVEL_SYSTEM`,
224 * > `GIT_CONFIG_LEVEL_GLOBAL`, `GIT_CONFIG_LEVEL_XDG`, or
225 * > `GIT_CONFIG_LEVEL_PROGRAMDATA`.
227 * * opts(GIT_OPT_SET_CACHE_OBJECT_LIMIT, git_otype type, size_t size)
229 * > Set the maximum data size for the given type of object to be
230 * > considered eligible for caching in memory. Setting to value to
231 * > zero means that that type of object will not be cached.
232 * > Defaults to 0 for GIT_OBJ_BLOB (i.e. won't cache blobs) and 4k
233 * > for GIT_OBJ_COMMIT, GIT_OBJ_TREE, and GIT_OBJ_TAG.
235 * * opts(GIT_OPT_SET_CACHE_MAX_SIZE, ssize_t max_storage_bytes)
237 * > Set the maximum total data size that will be cached in memory
238 * > across all repositories before libgit2 starts evicting objects
239 * > from the cache. This is a soft limit, in that the library might
240 * > briefly exceed it, but will start aggressively evicting objects
241 * > from cache when that happens. The default cache size is 256MB.
243 * * opts(GIT_OPT_ENABLE_CACHING, int enabled)
245 * > Enable or disable caching completely.
247 * > Because caches are repository-specific, disabling the cache
248 * > cannot immediately clear all cached objects, but each cache will
249 * > be cleared on the next attempt to update anything in it.
251 * * opts(GIT_OPT_GET_CACHED_MEMORY, ssize_t *current, ssize_t *allowed)
253 * > Get the current bytes in cache and the maximum that would be
254 * > allowed in the cache.
256 * * opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)
258 * > Get the default template path.
259 * > The path is written to the `out` buffer.
261 * * opts(GIT_OPT_SET_TEMPLATE_PATH, const char *path)
263 * > Set the default template path.
265 * > - `path` directory of template.
267 * * opts(GIT_OPT_SET_SSL_CERT_LOCATIONS, const char *file, const char *path)
269 * > Set the SSL certificate-authority locations.
271 * > - `file` is the location of a file containing several
272 * > certificates concatenated together.
273 * > - `path` is the location of a directory holding several
274 * > certificates, one per file.
276 * > Either parameter may be `NULL`, but not both.
278 * * opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)
280 * > Set the value of the User-Agent header. This value will be
281 * > appended to "git/1.0", for compatibility with other git clients.
283 * > - `user_agent` is the value that will be delivered as the
284 * > User-Agent header on HTTP requests.
286 * * opts(GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, int enabled)
288 * > Enable strict input validation when creating new objects
289 * > to ensure that all inputs to the new objects are valid. For
290 * > example, when this is enabled, the parent(s) and tree inputs
291 * > will be validated when creating a new commit. This defaults
294 * * opts(GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, int enabled)
296 * > Validate the target of a symbolic ref when creating it. For
297 * > example, `foobar` is not a valid ref, therefore `foobar` is
298 * > not a valid target for a symbolic ref by default, whereas
299 * > `refs/heads/foobar` is. Disabling this bypasses validation
300 * > so that an arbitrary strings such as `foobar` can be used
301 * > for a symbolic ref target. This defaults to enabled.
303 * * opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers)
305 * > Set the SSL ciphers use for HTTPS connections.
307 * > - `ciphers` is the list of ciphers that are eanbled.
309 * * opts(GIT_OPT_ENABLE_OFS_DELTA, int enabled)
311 * > Enable or disable the use of "offset deltas" when creating packfiles,
312 * > and the negotiation of them when talking to a remote server.
313 * > Offset deltas store a delta base location as an offset into the
314 * > packfile from the current location, which provides a shorter encoding
315 * > and thus smaller resultant packfiles.
316 * > Packfiles containing offset deltas can still be read.
317 * > This defaults to enabled.
319 * @param option Option key
320 * @param ... value to set the option
321 * @return 0 on success, <0 on failure
323 GIT_EXTERN(int) git_libgit2_opts(int option
, ...);