include/git2/common.h

   1 /*
   2  * Copyright (C) the libgit2 contributors. All rights reserved.
   3  *
   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.
   6  */
   7 #ifndef INCLUDE_git_common_h__
   8 #define INCLUDE_git_common_h__
   9
  10 #include <time.h>
  11 #include <stdlib.h>
  12
  13 #ifdef __cplusplus
  14 # define GIT_BEGIN_DECL extern "C" {
  15 # define GIT_END_DECL   }
  16 #else
  17  /** Start declarations in C mode */
  18 # define GIT_BEGIN_DECL /* empty */
  19  /** End declarations in C mode */
  20 # define GIT_END_DECL   /* empty */
  21 #endif
  22
  23 #if defined(_MSC_VER) && _MSC_VER < 1800
  24  GIT_BEGIN_DECL
  25 # include "inttypes.h"
  26  GIT_END_DECL
  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>
  30 #endif
  31
  32 #ifdef DOCURIUM
  33 /*
  34  * This is so clang's doc parser acknowledges comments on functions
  35  * with size_t parameters.
  36  */
  37 typedef size_t size_t;
  38 #endif
  39
  40 /** Declare a public function exported for application use. */
  41 #if __GNUC__ >= 4
  42 # define GIT_EXTERN(type) extern \
  43                          __attribute__((visibility("default"))) \
  44                          type
  45 #elif defined(_MSC_VER)
  46 # define GIT_EXTERN(type) __declspec(dllexport) type
  47 #else
  48 # define GIT_EXTERN(type) extern type
  49 #endif
  50
  51 /** Declare a function's takes printf style arguments. */
  52 #ifdef __GNUC__
  53 # define GIT_FORMAT_PRINTF(a,b) __attribute__((format (printf, a, b)))
  54 #else
  55 # define GIT_FORMAT_PRINTF(a,b) /* empty */
  56 #endif
  57
  58 #if (defined(_WIN32)) && !defined(__CYGWIN__)
  59 #define GIT_WIN32 1
  60 #endif
  61
  62 #ifdef __amigaos4__
  63 #include <netinet/in.h>
  64 #endif
  65
  66 /**
  67  * @file git2/common.h
  68  * @brief Git common platform definitions
  69  * @defgroup git_common Git common platform definitions
  70  * @ingroup Git
  71  * @{
  72  */
  73
  74 GIT_BEGIN_DECL
  75
  76 /**
  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.
  80  */
  81 #ifdef GIT_WIN32
  82 #define GIT_PATH_LIST_SEPARATOR ';'
  83 #else
  84 #define GIT_PATH_LIST_SEPARATOR ':'
  85 #endif
  86
  87 /**
  88  * The maximum length of a valid git path.
  89  */
  90 #define GIT_PATH_MAX 4096
  91
  92 /**
  93  * The string representation of the null object ID.
  94  */
  95 #define GIT_OID_HEX_ZERO "0000000000000000000000000000000000000000"
  96
  97 /**
  98  * Return the version of the libgit2 library
  99  * being currently used.
 100  *
 101  * @param major Store the major version number
 102  * @param minor Store the minor version number
 103  * @param rev Store the revision (patch) number
 104  */
 105 GIT_EXTERN(void) git_libgit2_version(int *major, int *minor, int *rev);
 106
 107 /**
 108  * Combinations of these values describe the features with which libgit2
 109  * was compiled
 110  */
 111 typedef enum {
 112         GIT_FEATURE_THREADS     = (1 << 0),
 113         GIT_FEATURE_HTTPS       = (1 << 1),
 114         GIT_FEATURE_SSH         = (1 << 2),
 115         GIT_FEATURE_NSEC        = (1 << 3),
 116 } git_feature_t;
 117
 118 /**
 119  * Query compile time options for libgit2.
 120  *
 121  * @return A combination of GIT_FEATURE_* values.
 122  *
 123  * - GIT_FEATURE_THREADS
 124  *   Libgit2 was compiled with thread support. Note that thread support is
 125  *   still to be seen as a 'work in progress' - basic object lookups are
 126  *   believed to be threadsafe, but other operations may not be.
 127  *
 128  * - GIT_FEATURE_HTTPS
 129  *   Libgit2 supports the https:// protocol. This requires the openssl
 130  *   library to be found when compiling libgit2.
 131  *
 132  * - GIT_FEATURE_SSH
 133  *   Libgit2 supports the SSH protocol for network operations. This requires
 134  *   the libssh2 library to be found when compiling libgit2
 135  */
 136 GIT_EXTERN(int) git_libgit2_features(void);
 137
 138 /**
 139  * Global library options
 140  *
 141  * These are used to select which global option to set or get and are
 142  * used in `git_libgit2_opts()`.
 143  */
 144 typedef enum {
 145         GIT_OPT_GET_MWINDOW_SIZE,
 146         GIT_OPT_SET_MWINDOW_SIZE,
 147         GIT_OPT_GET_MWINDOW_MAPPED_LIMIT,
 148         GIT_OPT_SET_MWINDOW_MAPPED_LIMIT,
 149         GIT_OPT_GET_SEARCH_PATH,
 150         GIT_OPT_SET_SEARCH_PATH,
 151         GIT_OPT_SET_CACHE_OBJECT_LIMIT,
 152         GIT_OPT_SET_CACHE_MAX_SIZE,
 153         GIT_OPT_ENABLE_CACHING,
 154         GIT_OPT_GET_CACHED_MEMORY,
 155         GIT_OPT_GET_TEMPLATE_PATH,
 156         GIT_OPT_SET_TEMPLATE_PATH,
 157         GIT_OPT_SET_SSL_CERT_LOCATIONS,
 158         GIT_OPT_SET_USER_AGENT,
 159         GIT_OPT_ENABLE_STRICT_OBJECT_CREATION,
 160         GIT_OPT_ENABLE_SYMBOLIC_REF_TARGET_VALIDATION,
 161         GIT_OPT_SET_SSL_CIPHERS,
 162         GIT_OPT_GET_USER_AGENT,
 163 } git_libgit2_opt_t;
 164
 165 /**
 166  * Set or query a library global option
 167  *
 168  * Available options:
 169  *
 170  *      * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):
 171  *
 172  *              > Get the maximum mmap window size
 173  *
 174  *      * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):
 175  *
 176  *              > Set the maximum mmap window size
 177  *
 178  *      * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):
 179  *
 180  *              > Get the maximum memory that will be mapped in total by the library
 181  *
 182  *      * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):
 183  *
 184  *              >Set the maximum amount of memory that can be mapped at any time
 185  *              by the library
 186  *
 187  *      * opts(GIT_OPT_GET_SEARCH_PATH, int level, git_buf *buf)
 188  *
 189  *              > Get the search path for a given level of config data.  "level" must
 190  *              > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`,
 191  *              > `GIT_CONFIG_LEVEL_XDG`, or `GIT_CONFIG_LEVEL_PROGRAMDATA`.
 192  *              > The search path is written to the `out` buffer.
 193  *
 194  *      * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)
 195  *
 196  *              > Set the search path for a level of config data.  The search path
 197  *              > applied to shared attributes and ignore files, too.
 198  *              >
 199  *              > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.
 200  *              >   Pass NULL to reset to the default (generally based on environment
 201  *              >   variables).  Use magic path `$PATH` to include the old value
 202  *              >   of the path (if you want to prepend or append, for instance).
 203  *              >
 204  *              > - `level` must be `GIT_CONFIG_LEVEL_SYSTEM`,
 205  *              >   `GIT_CONFIG_LEVEL_GLOBAL`, `GIT_CONFIG_LEVEL_XDG`, or
 206  *              >   `GIT_CONFIG_LEVEL_PROGRAMDATA`.
 207  *
 208  *      * opts(GIT_OPT_SET_CACHE_OBJECT_LIMIT, git_otype type, size_t size)
 209  *
 210  *              > Set the maximum data size for the given type of object to be
 211  *              > considered eligible for caching in memory.  Setting to value to
 212  *              > zero means that that type of object will not be cached.
 213  *              > Defaults to 0 for GIT_OBJ_BLOB (i.e. won't cache blobs) and 4k
 214  *              > for GIT_OBJ_COMMIT, GIT_OBJ_TREE, and GIT_OBJ_TAG.
 215  *
 216  *      * opts(GIT_OPT_SET_CACHE_MAX_SIZE, ssize_t max_storage_bytes)
 217  *
 218  *              > Set the maximum total data size that will be cached in memory
 219  *              > across all repositories before libgit2 starts evicting objects
 220  *              > from the cache.  This is a soft limit, in that the library might
 221  *              > briefly exceed it, but will start aggressively evicting objects
 222  *              > from cache when that happens.  The default cache size is 256MB.
 223  *
 224  *      * opts(GIT_OPT_ENABLE_CACHING, int enabled)
 225  *
 226  *              > Enable or disable caching completely.
 227  *              >
 228  *              > Because caches are repository-specific, disabling the cache
 229  *              > cannot immediately clear all cached objects, but each cache will
 230  *              > be cleared on the next attempt to update anything in it.
 231  *
 232  *      * opts(GIT_OPT_GET_CACHED_MEMORY, ssize_t *current, ssize_t *allowed)
 233  *
 234  *              > Get the current bytes in cache and the maximum that would be
 235  *              > allowed in the cache.
 236  *
 237  *      * opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)
 238  *
 239  *              > Get the default template path.
 240  *              > The path is written to the `out` buffer.
 241  *
 242  *      * opts(GIT_OPT_SET_TEMPLATE_PATH, const char *path)
 243  *
 244  *              > Set the default template path.
 245  *              >
 246  *              > - `path` directory of template.
 247  *
 248  *      * opts(GIT_OPT_SET_SSL_CERT_LOCATIONS, const char *file, const char *path)
 249  *
 250  *              > Set the SSL certificate-authority locations.
 251  *              >
 252  *              > - `file` is the location of a file containing several
 253  *              >   certificates concatenated together.
 254  *              > - `path` is the location of a directory holding several
 255  *              >   certificates, one per file.
 256  *              >
 257  *              > Either parameter may be `NULL`, but not both.
 258  *
 259  *      * opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)
 260  *
 261  *              > Set the value of the User-Agent header.  This value will be
 262  *              > appended to "git/1.0", for compatibility with other git clients.
 263  *              >
 264  *              > - `user_agent` is the value that will be delivered as the
 265  *              >   User-Agent header on HTTP requests.
 266  *
 267  *      * opts(GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, int enabled)
 268  *
 269  *              > Enable strict input validation when creating new objects
 270  *              > to ensure that all inputs to the new objects are valid.  For
 271  *              > example, when this is enabled, the parent(s) and tree inputs
 272  *              > will be validated when creating a new commit.  This defaults
 273  *              > to disabled.
 274  *
 275  *      * opts(GIT_OPT_ENABLE_SYMBOLIC_REF_TARGET_VALIDATION, int enabled)
 276  *
 277  *              > Validate the target of a symbolic ref when creating it.
 278  *              > For example, 'foobar' is not a valid ref,
 279  *              > therefore 'foobar' is not a valid target
 280  *              > for a symbolic ref by default,
 281  *              > where as 'refs/heads/foobar' is.
 282  *              > Disabling this bypasses validation so that an arbitrary
 283  *              > strings such as 'foobar' can be used for a symbolic ref target.
 284  *              > This defaults to enabled.
 285  *
 286  *      * opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers)
 287  *
 288  *              > Set the SSL ciphers use for HTTPS connections.
 289  *              >
 290  *              > - `ciphers` is the list of ciphers that are eanbled.
 291  *
 292  * @param option Option key
 293  * @param ... value to set the option
 294  * @return 0 on success, <0 on failure
 295  */
 296 GIT_EXTERN(int) git_libgit2_opts(int option, ...);
 297
 298 /** @} */
 299 GIT_END_DECL
 300
 301 #endif