/*

 * 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_common_h__

#define INCLUDE_git_common_h__

#include <time.h>

#include <stdlib.h>

#ifdef __cplusplus

# define GIT_BEGIN_DECL extern "C" {

# define GIT_END_DECL	}

#else

 /** Start declarations in C mode */

# define GIT_BEGIN_DECL /* empty */

 /** End declarations in C mode */

# define GIT_END_DECL	/* empty */

#endif

#if defined(_MSC_VER) && _MSC_VER < 1800

 GIT_BEGIN_DECL

# include "inttypes.h"

 GIT_END_DECL

/** This check is needed for importing this file in an iOS/OS X framework throws an error in Xcode otherwise.*/

#elif !defined(__CLANG_INTTYPES_H)

# include <inttypes.h>

#endif

#ifdef DOCURIUM

/*

 * This is so clang's doc parser acknowledges comments on functions

 * with size_t parameters.

 */

typedef size_t size_t;

#endif

/** Declare a public function exported for application use. */

#if __GNUC__ >= 4

# define GIT_EXTERN(type) extern \

			 __attribute__((visibility("default"))) \

			 type

#elif defined(_MSC_VER)

# define GIT_EXTERN(type) __declspec(dllexport) type

#else

# define GIT_EXTERN(type) extern type

#endif

/** Declare a function's takes printf style arguments. */

#ifdef __GNUC__

# define GIT_FORMAT_PRINTF(a,b) __attribute__((format (printf, a, b)))

#else

# define GIT_FORMAT_PRINTF(a,b) /* empty */

#endif

#if (defined(_WIN32)) && !defined(__CYGWIN__)

#define GIT_WIN32 1

#endif

#ifdef __amigaos4__

#include <netinet/in.h>

#endif

/**

 * @file git2/common.h

 * @brief Git common platform definitions

 * @defgroup git_common Git common platform definitions

 * @ingroup Git

 * @{

 */

GIT_BEGIN_DECL

/**

 * The separator used in path list strings (ie like in the PATH

 * environment variable). A semi-colon ";" is used on Windows, and

 * a colon ":" for all other systems.

 */

#ifdef GIT_WIN32

#define GIT_PATH_LIST_SEPARATOR ';'

#else

#define GIT_PATH_LIST_SEPARATOR ':'

#endif

/**

 * The maximum length of a valid git path.

 */

#define GIT_PATH_MAX 4096

/**

 * The string representation of the null object ID.

 */

#define GIT_OID_HEX_ZERO "0000000000000000000000000000000000000000"

/**

 * Return the version of the libgit2 library

 * being currently used.

 *

 * @param major Store the major version number

 * @param minor Store the minor version number

 * @param rev Store the revision (patch) number

 */

GIT_EXTERN(void) git_libgit2_version(int *major, int *minor, int *rev);

/**

 * Combinations of these values describe the features with which libgit2

 * was compiled

 */

typedef enum {

  /**

   * If set, libgit2 was built thread-aware and can be safely used from multiple

   * threads.

   */

	GIT_FEATURE_THREADS	= (1 << 0),

  /**

   * If set, libgit2 was built with and linked against a TLS implementation.

   * Custom TLS streams may still be added by the user to support HTTPS

   * regardless of this.

   */

	GIT_FEATURE_HTTPS	= (1 << 1),

  /**

   * If set, libgit2 was built with and linked against libssh2. A custom

   * transport may still be added by the user to support libssh2 regardless of

   * this.

   */

	GIT_FEATURE_SSH		= (1 << 2),

  /**

   * If set, libgit2 was built with support for sub-second resolution in file

   * modification times.

   */

	GIT_FEATURE_NSEC	= (1 << 3),

} git_feature_t;

/**

 * Query compile time options for libgit2.

 *

 * @return A combination of GIT_FEATURE_* values.

 *

 * - GIT_FEATURE_THREADS

 *   Libgit2 was compiled with thread support. Note that thread support is

 *   still to be seen as a 'work in progress' - basic object lookups are

 *   believed to be threadsafe, but other operations may not be.

 *

 * - GIT_FEATURE_HTTPS

 *   Libgit2 supports the https:// protocol. This requires the openssl

 *   library to be found when compiling libgit2.

 *

 * - GIT_FEATURE_SSH

 *   Libgit2 supports the SSH protocol for network operations. This requires

 *   the libssh2 library to be found when compiling libgit2

 */

GIT_EXTERN(int) git_libgit2_features(void);

/**

 * Global library options

 *

 * These are used to select which global option to set or get and are

 * used in `git_libgit2_opts()`.

 */

typedef enum {

	GIT_OPT_GET_MWINDOW_SIZE,

	GIT_OPT_SET_MWINDOW_SIZE,

	GIT_OPT_GET_MWINDOW_MAPPED_LIMIT,

	GIT_OPT_SET_MWINDOW_MAPPED_LIMIT,

	GIT_OPT_GET_SEARCH_PATH,

	GIT_OPT_SET_SEARCH_PATH,

	GIT_OPT_SET_CACHE_OBJECT_LIMIT,

	GIT_OPT_SET_CACHE_MAX_SIZE,

	GIT_OPT_ENABLE_CACHING,

	GIT_OPT_GET_CACHED_MEMORY,

	GIT_OPT_GET_TEMPLATE_PATH,

	GIT_OPT_SET_TEMPLATE_PATH,

	GIT_OPT_SET_SSL_CERT_LOCATIONS,

	GIT_OPT_SET_USER_AGENT,

	GIT_OPT_ENABLE_STRICT_OBJECT_CREATION,

	GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION,

	GIT_OPT_SET_SSL_CIPHERS,

	GIT_OPT_GET_USER_AGENT,

	GIT_OPT_ENABLE_OFS_DELTA,

	GIT_OPT_ENABLE_FSYNC_GITDIR,

	GIT_OPT_GET_WINDOWS_SHAREMODE,

	GIT_OPT_SET_WINDOWS_SHAREMODE,

	GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION,

} git_libgit2_opt_t;

/**

 * Set or query a library global option

 *

 * Available options:

 *

 *	* opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):

 *

 *		> Get the maximum mmap window size

 *

 *	* opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):

 *

 *		> Set the maximum mmap window size

 *

 *	* opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):

 *

 *		> Get the maximum memory that will be mapped in total by the library

 *

 *	* opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):

 *

 *		>Set the maximum amount of memory that can be mapped at any time

 *		by the library

 *

 *	* opts(GIT_OPT_GET_SEARCH_PATH, int level, git_buf *buf)

 *

 *		> Get the search path for a given level of config data.  "level" must

 *		> be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`,

 *		> `GIT_CONFIG_LEVEL_XDG`, or `GIT_CONFIG_LEVEL_PROGRAMDATA`.

 *		> The search path is written to the `out` buffer.

 *

 *	* opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)

 *

 *		> Set the search path for a level of config data.  The search path

 *		> applied to shared attributes and ignore files, too.

 *		>

 *		> - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.

 *		>   Pass NULL to reset to the default (generally based on environment

 *		>   variables).  Use magic path `$PATH` to include the old value

 *		>   of the path (if you want to prepend or append, for instance).

 *		>

 *		> - `level` must be `GIT_CONFIG_LEVEL_SYSTEM`,

 *		>   `GIT_CONFIG_LEVEL_GLOBAL`, `GIT_CONFIG_LEVEL_XDG`, or

 *		>   `GIT_CONFIG_LEVEL_PROGRAMDATA`.

 *

 *	* opts(GIT_OPT_SET_CACHE_OBJECT_LIMIT, git_otype type, size_t size)

 *

 *		> Set the maximum data size for the given type of object to be

 *		> considered eligible for caching in memory.  Setting to value to

 *		> zero means that that type of object will not be cached.

 *		> Defaults to 0 for GIT_OBJ_BLOB (i.e. won't cache blobs) and 4k

 *		> for GIT_OBJ_COMMIT, GIT_OBJ_TREE, and GIT_OBJ_TAG.

 *

 *	* opts(GIT_OPT_SET_CACHE_MAX_SIZE, ssize_t max_storage_bytes)

 *

 *		> Set the maximum total data size that will be cached in memory

 *		> across all repositories before libgit2 starts evicting objects

 *		> from the cache.  This is a soft limit, in that the library might

 *		> briefly exceed it, but will start aggressively evicting objects

 *		> from cache when that happens.  The default cache size is 256MB.

 *

 *	* opts(GIT_OPT_ENABLE_CACHING, int enabled)

 *

 *		> Enable or disable caching completely.

 *		>

 *		> Because caches are repository-specific, disabling the cache

 *		> cannot immediately clear all cached objects, but each cache will

 *		> be cleared on the next attempt to update anything in it.

 *

 *	* opts(GIT_OPT_GET_CACHED_MEMORY, ssize_t *current, ssize_t *allowed)

 *

 *		> Get the current bytes in cache and the maximum that would be

 *		> allowed in the cache.

 *

 *	* opts(GIT_OPT_GET_TEMPLATE_PATH, git_buf *out)

 *

 *		> Get the default template path.

 *		> The path is written to the `out` buffer.

 *

 *	* opts(GIT_OPT_SET_TEMPLATE_PATH, const char *path)

 *

 *		> Set the default template path.

 *		>

 *		> - `path` directory of template.

 *

 *	* opts(GIT_OPT_SET_SSL_CERT_LOCATIONS, const char *file, const char *path)

 *

 *		> Set the SSL certificate-authority locations.

 *		>

 *		> - `file` is the location of a file containing several

 *		>   certificates concatenated together.

 *		> - `path` is the location of a directory holding several

 *		>   certificates, one per file.

 *		>

 * 		> Either parameter may be `NULL`, but not both.

 *

 *	* opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)

 *

 *		> Set the value of the User-Agent header.  This value will be

 *		> appended to "git/1.0", for compatibility with other git clients.

 *		>

 *		> - `user_agent` is the value that will be delivered as the

 *		>   User-Agent header on HTTP requests.

 *

 *	* opts(GIT_OPT_SET_WINDOWS_SHAREMODE, unsigned long value)

 *

 *		> Set the share mode used when opening files on Windows.

 *		> For more information, see the documentation for CreateFile.

 *		> The default is: FILE_SHARE_READ | FILE_SHARE_WRITE.  This is

 *		> ignored and unused on non-Windows platforms.

 *

 *	* opts(GIT_OPT_GET_WINDOWS_SHAREMODE, unsigned long *value)

 *

 *		> Get the share mode used when opening files on Windows.

 *

 *	* opts(GIT_OPT_ENABLE_STRICT_OBJECT_CREATION, int enabled)

 *

 *		> Enable strict input validation when creating new objects

 *		> to ensure that all inputs to the new objects are valid.  For

 *		> example, when this is enabled, the parent(s) and tree inputs

 *		> will be validated when creating a new commit.  This defaults

 *		> to enabled.

 *

 *	* opts(GIT_OPT_ENABLE_STRICT_SYMBOLIC_REF_CREATION, int enabled)

 *

 *		> Validate the target of a symbolic ref when creating it.  For

 *		> example, `foobar` is not a valid ref, therefore `foobar` is

 *		> not a valid target for a symbolic ref by default, whereas

 *		> `refs/heads/foobar` is.  Disabling this bypasses validation

 *		> so that an arbitrary strings such as `foobar` can be used

 *		> for a symbolic ref target.  This defaults to enabled.

 *

 *	* opts(GIT_OPT_SET_SSL_CIPHERS, const char *ciphers)

 *

 *		> Set the SSL ciphers use for HTTPS connections.

 *		>

 *		> - `ciphers` is the list of ciphers that are eanbled.

 *

 *	* opts(GIT_OPT_ENABLE_OFS_DELTA, int enabled)

 *

 *		> Enable or disable the use of "offset deltas" when creating packfiles,

 *		> and the negotiation of them when talking to a remote server.

 *		> Offset deltas store a delta base location as an offset into the

 *		> packfile from the current location, which provides a shorter encoding

 *		> and thus smaller resultant packfiles.

 *		> Packfiles containing offset deltas can still be read.

 *		> This defaults to enabled.

 *

 *	* opts(GIT_OPT_ENABLE_FSYNC_GITDIR, int enabled)

 *

 *		> Enable synchronized writes of files in the gitdir using `fsync`

 *		> (or the platform equivalent) to ensure that new object data

 *		> is written to permanent storage, not simply cached.  This

 *		> defaults to disabled.

 *

 *	 opts(GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION, int enabled)

 *

 *		> Enable strict verification of object hashsums when reading

 *		> objects from disk. This may impact performance due to an

 *		> additional checksum calculation on each object. This defaults

 *		> to enabled.

 *

 * @param option Option key

 * @param ... value to set the option

 * @return 0 on success, <0 on failure

 */

GIT_EXTERN(int) git_libgit2_opts(int option, ...);

/** @} */

GIT_END_DECL

#endif