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"
28 # include <inttypes.h>
31 /** Declare a public function exported for application use. */
33 # define GIT_EXTERN(type) extern \
34 __attribute__((visibility("default"))) \
36 #elif defined(_MSC_VER)
37 # define GIT_EXTERN(type) __declspec(dllexport) type
39 # define GIT_EXTERN(type) extern type
42 /** Declare a function's takes printf style arguments. */
44 # define GIT_FORMAT_PRINTF(a,b) __attribute__((format (printf, a, b)))
46 # define GIT_FORMAT_PRINTF(a,b) /* empty */
49 #if (defined(_WIN32)) && !defined(__CYGWIN__)
54 #include <netinet/in.h>
59 * @brief Git common platform definitions
60 * @defgroup git_common Git common platform definitions
68 * The separator used in path list strings (ie like in the PATH
69 * environment variable). A semi-colon ";" is used on Windows, and
70 * a colon ":" for all other systems.
73 #define GIT_PATH_LIST_SEPARATOR ';'
75 #define GIT_PATH_LIST_SEPARATOR ':'
79 * The maximum length of a valid git path.
81 #define GIT_PATH_MAX 4096
84 * The string representation of the null object ID.
86 #define GIT_OID_HEX_ZERO "0000000000000000000000000000000000000000"
89 * Return the version of the libgit2 library
90 * being currently used.
92 * @param major Store the major version number
93 * @param minor Store the minor version number
94 * @param rev Store the revision (patch) number
96 GIT_EXTERN(void) git_libgit2_version(int *major
, int *minor
, int *rev
);
99 * Combinations of these values describe the features with which libgit2
103 GIT_FEATURE_THREADS
= (1 << 0),
104 GIT_FEATURE_HTTPS
= (1 << 1),
105 GIT_FEATURE_SSH
= (1 << 2),
106 GIT_FEATURE_NSEC
= (1 << 3),
110 * Query compile time options for libgit2.
112 * @return A combination of GIT_FEATURE_* values.
114 * - GIT_FEATURE_THREADS
115 * Libgit2 was compiled with thread support. Note that thread support is
116 * still to be seen as a 'work in progress' - basic object lookups are
117 * believed to be threadsafe, but other operations may not be.
119 * - GIT_FEATURE_HTTPS
120 * Libgit2 supports the https:// protocol. This requires the openssl
121 * library to be found when compiling libgit2.
124 * Libgit2 supports the SSH protocol for network operations. This requires
125 * the libssh2 library to be found when compiling libgit2
127 GIT_EXTERN(int) git_libgit2_features(void);
130 * Global library options
132 * These are used to select which global option to set or get and are
133 * used in `git_libgit2_opts()`.
136 GIT_OPT_GET_MWINDOW_SIZE
,
137 GIT_OPT_SET_MWINDOW_SIZE
,
138 GIT_OPT_GET_MWINDOW_MAPPED_LIMIT
,
139 GIT_OPT_SET_MWINDOW_MAPPED_LIMIT
,
140 GIT_OPT_GET_SEARCH_PATH
,
141 GIT_OPT_SET_SEARCH_PATH
,
142 GIT_OPT_SET_CACHE_OBJECT_LIMIT
,
143 GIT_OPT_SET_CACHE_MAX_SIZE
,
144 GIT_OPT_ENABLE_CACHING
,
145 GIT_OPT_GET_CACHED_MEMORY
,
146 GIT_OPT_GET_TEMPLATE_PATH
,
147 GIT_OPT_SET_TEMPLATE_PATH
,
148 GIT_OPT_SET_SSL_CERT_LOCATIONS
,
149 GIT_OPT_SET_USER_AGENT
,
153 * Set or query a library global option
157 * * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):
159 * > Get the maximum mmap window size
161 * * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):
163 * > Set the maximum mmap window size
165 * * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):
167 * > Get the maximum memory that will be mapped in total by the library
169 * * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):
171 * >Set the maximum amount of memory that can be mapped at any time
174 * * opts(GIT_OPT_GET_SEARCH_PATH, int level, git_buf *buf)
176 * > Get the search path for a given level of config data. "level" must
177 * > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`,
178 * > `GIT_CONFIG_LEVEL_XDG`, or `GIT_CONFIG_LEVEL_PROGRAMDATA`.
179 * > The search path is written to the `out` buffer.
181 * * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)
183 * > Set the search path for a level of config data. The search path
184 * > applied to shared attributes and ignore files, too.
186 * > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.
187 * > Pass NULL to reset to the default (generally based on environment
188 * > variables). Use magic path `$PATH` to include the old value
189 * > of the path (if you want to prepend or append, for instance).
191 * > - `level` must be `GIT_CONFIG_LEVEL_SYSTEM`,
192 * > `GIT_CONFIG_LEVEL_GLOBAL`, `GIT_CONFIG_LEVEL_XDG`, or
193 * > `GIT_CONFIG_LEVEL_PROGRAMDATA`.
195 * * opts(GIT_OPT_SET_CACHE_OBJECT_LIMIT, git_otype type, size_t size)
197 * > Set the maximum data size for the given type of object to be
198 * > considered eligible for caching in memory. Setting to value to
199 * > zero means that that type of object will not be cached.
200 * > Defaults to 0 for GIT_OBJ_BLOB (i.e. won't cache blobs) and 4k
201 * > for GIT_OBJ_COMMIT, GIT_OBJ_TREE, and GIT_OBJ_TAG.
203 * * opts(GIT_OPT_SET_CACHE_MAX_SIZE, ssize_t max_storage_bytes)
205 * > Set the maximum total data size that will be cached in memory
206 * > across all repositories before libgit2 starts evicting objects
207 * > from the cache. This is a soft limit, in that the library might
208 * > briefly exceed it, but will start aggressively evicting objects
209 * > from cache when that happens. The default cache size is 256MB.
211 * * opts(GIT_OPT_ENABLE_CACHING, int enabled)
213 * > Enable or disable caching completely.
215 * > Because caches are repository-specific, disabling the cache
216 * > cannot immediately clear all cached objects, but each cache will
217 * > be cleared on the next attempt to update anything in it.
219 * * opts(GIT_OPT_GET_CACHED_MEMORY, ssize_t *current, ssize_t *allowed)
221 * > Get the current bytes in cache and the maximum that would be
222 * > allowed in the cache.
224 * * opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)
226 * > Get the default template path.
227 * > The path is written to the `out` buffer.
229 * * opts(GIT_OPT_SET_TEMPLATE_PATH, const char *path)
231 * > Set the default template path.
233 * > - `path` directory of template.
235 * * opts(GIT_OPT_SET_SSL_CERT_LOCATIONS, const char *file, const char *path)
237 * > Set the SSL certificate-authority locations.
239 * > - `file` is the location of a file containing several
240 * > certificates concatenated together.
241 * > - `path` is the location of a directory holding several
242 * > certificates, one per file.
244 * > Either parameter may be `NULL`, but not both.
246 * * opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)
248 * > Set the value of the User-Agent header. This value will be
249 * > appended to "git/1.0", for compatibility with other git clients.
251 * > - `user_agent` is the value that will be delivered as the
252 * > User-Agent header on HTTP requests.
254 * @param option Option key
255 * @param ... value to set the option
256 * @return 0 on success, <0 on failure
258 GIT_EXTERN(int) git_libgit2_opts(int option
, ...);