thodg/libgit2/include/git2/deprecated.h

• Show log

  Commit

• Hash : c8e249b0
  Author :
  Date : 2019-07-29T10:51:22
  

  object: deprecate git_object__size for removal In #5118 we remove the double-underscore to make it a normally-named public function. However, this is not an interesting function outside of the library and it takes up a name for something that could be more useful. Remove the single-underscore version as we have not done any releases with it.

Download

• include/git2/deprecated.h

• /*
   * 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_deprecated_h__
  #define INCLUDE_git_deprecated_h__
  
  #include "config.h"
  #include "common.h"
  #include "blame.h"
  #include "buffer.h"
  #include "checkout.h"
  #include "cherrypick.h"
  #include "clone.h"
  #include "describe.h"
  #include "diff.h"
  #include "errors.h"
  #include "index.h"
  #include "indexer.h"
  #include "merge.h"
  #include "object.h"
  #include "proxy.h"
  #include "refs.h"
  #include "rebase.h"
  #include "remote.h"
  #include "trace.h"
  #include "repository.h"
  #include "revert.h"
  #include "stash.h"
  #include "status.h"
  #include "submodule.h"
  #include "worktree.h"
  
  /*
   * Users can avoid deprecated functions by defining `GIT_DEPRECATE_HARD`.
   */
  #ifndef GIT_DEPRECATE_HARD
  
  /**
   * @file git2/deprecated.h
   * @brief libgit2 deprecated functions and values
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /** @name Deprecated Attribute Constants
   *
   * These enumeration values are retained for backward compatibility.
   * The newer versions of these functions should be preferred in all
   * new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  #define GIT_ATTR_UNSPECIFIED_T GIT_ATTR_VALUE_UNSPECIFIED
  #define GIT_ATTR_TRUE_T GIT_ATTR_VALUE_TRUE
  #define GIT_ATTR_FALSE_T GIT_ATTR_VALUE_FALSE
  #define GIT_ATTR_VALUE_T GIT_ATTR_VALUE_STRING
  
  #define GIT_ATTR_TRUE(attr) GIT_ATTR_IS_TRUE(attr)
  #define GIT_ATTR_FALSE(attr) GIT_ATTR_IS_FALSE(attr)
  #define GIT_ATTR_UNSPECIFIED(attr) GIT_ATTR_IS_UNSPECIFIED(attr)
  
  /**@}*/
  
  /** @name Deprecated Blob Functions
   *
   * These functions are retained for backward compatibility.  The newer
   * versions of these functions should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  GIT_EXTERN(int) git_blob_create_fromworkdir(git_oid *id, git_repository *repo, const char *relative_path);
  GIT_EXTERN(int) git_blob_create_fromdisk(git_oid *id, git_repository *repo, const char *path);
  GIT_EXTERN(int) git_blob_create_fromstream(
  	git_writestream **out,
  	git_repository *repo,
  	const char *hintpath);
  GIT_EXTERN(int) git_blob_create_fromstream_commit(
  	git_oid *out,
  	git_writestream *stream);
  GIT_EXTERN(int) git_blob_create_frombuffer(
  	git_oid *id, git_repository *repo, const void *buffer, size_t len);
  
  /**@}*/
  
  /** @name Deprecated Buffer Functions
   *
   * These functions and enumeration values are retained for backward
   * compatibility.  The newer versions of these functions should be
   * preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  /**
   * Free the memory referred to by the git_buf.  This is an alias of
   * `git_buf_dispose` and is preserved for backward compatibility.
   *
   * This function is deprecated, but there is no plan to remove this
   * function at this time.
   *
   * @deprecated Use git_buf_dispose
   * @see git_buf_dispose
   */
  GIT_EXTERN(void) git_buf_free(git_buf *buffer);
  
  /**@}*/
  
  /** @name Deprecated Config Functions and Constants
   */
  /**@{*/
  
  #define GIT_CVAR_FALSE  GIT_CONFIGMAP_FALSE
  #define GIT_CVAR_TRUE   GIT_CONFIGMAP_TRUE
  #define GIT_CVAR_INT32  GIT_CONFIGMAP_INT32
  #define GIT_CVAR_STRING GIT_CONFIGMAP_STRING
  
  typedef git_configmap git_cvar_map;
  
  /**@}*/
  
  /** @name Deprecated Error Functions and Constants
   *
   * These functions and enumeration values are retained for backward
   * compatibility.  The newer versions of these functions and values
   * should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  #define GITERR_NONE GIT_ERROR_NONE
  #define GITERR_NOMEMORY GIT_ERROR_NOMEMORY
  #define GITERR_OS GIT_ERROR_OS
  #define GITERR_INVALID GIT_ERROR_INVALID
  #define GITERR_REFERENCE GIT_ERROR_REFERENCE
  #define GITERR_ZLIB GIT_ERROR_ZLIB
  #define GITERR_REPOSITORY GIT_ERROR_REPOSITORY
  #define GITERR_CONFIG GIT_ERROR_CONFIG
  #define GITERR_REGEX GIT_ERROR_REGEX
  #define GITERR_ODB GIT_ERROR_ODB
  #define GITERR_INDEX GIT_ERROR_INDEX
  #define GITERR_OBJECT GIT_ERROR_OBJECT
  #define GITERR_NET GIT_ERROR_NET
  #define GITERR_TAG GIT_ERROR_TAG
  #define GITERR_TREE GIT_ERROR_TREE
  #define GITERR_INDEXER GIT_ERROR_INDEXER
  #define GITERR_SSL GIT_ERROR_SSL
  #define GITERR_SUBMODULE GIT_ERROR_SUBMODULE
  #define GITERR_THREAD GIT_ERROR_THREAD
  #define GITERR_STASH GIT_ERROR_STASH
  #define GITERR_CHECKOUT GIT_ERROR_CHECKOUT
  #define GITERR_FETCHHEAD GIT_ERROR_FETCHHEAD
  #define GITERR_MERGE GIT_ERROR_MERGE
  #define GITERR_SSH GIT_ERROR_SSH
  #define GITERR_FILTER GIT_ERROR_FILTER
  #define GITERR_REVERT GIT_ERROR_REVERT
  #define GITERR_CALLBACK GIT_ERROR_CALLBACK
  #define GITERR_CHERRYPICK GIT_ERROR_CHERRYPICK
  #define GITERR_DESCRIBE GIT_ERROR_DESCRIBE
  #define GITERR_REBASE GIT_ERROR_REBASE
  #define GITERR_FILESYSTEM GIT_ERROR_FILESYSTEM
  #define GITERR_PATCH GIT_ERROR_PATCH
  #define GITERR_WORKTREE GIT_ERROR_WORKTREE
  #define GITERR_SHA1 GIT_ERROR_SHA1
  
  /**
   * Return the last `git_error` object that was generated for the
   * current thread.  This is an alias of `git_error_last` and is
   * preserved for backward compatibility.
   *
   * This function is deprecated, but there is no plan to remove this
   * function at this time.
   *
   * @deprecated Use git_error_last
   * @see git_error_last
   */
  GIT_EXTERN(const git_error *) giterr_last(void);
  
  /**
   * Clear the last error.  This is an alias of `git_error_last` and is
   * preserved for backward compatibility.
   *
   * This function is deprecated, but there is no plan to remove this
   * function at this time.
   *
   * @deprecated Use git_error_clear
   * @see git_error_clear
   */
  GIT_EXTERN(void) giterr_clear(void);
  
  /**
   * Sets the error message to the given string.  This is an alias of
   * `git_error_set_str` and is preserved for backward compatibility.
   *
   * This function is deprecated, but there is no plan to remove this
   * function at this time.
   *
   * @deprecated Use git_error_set_str
   * @see git_error_set_str
   */
  GIT_EXTERN(void) giterr_set_str(int error_class, const char *string);
  
  /**
   * Indicates that an out-of-memory situation occured.  This is an alias
   * of `git_error_set_oom` and is preserved for backward compatibility.
   *
   * This function is deprecated, but there is no plan to remove this
   * function at this time.
   *
   * @deprecated Use git_error_set_oom
   * @see git_error_set_oom
   */
  GIT_EXTERN(void) giterr_set_oom(void);
  
  /**@}*/
  
  /** @name Deprecated Index Functions and Constants
   *
   * These functions and enumeration values are retained for backward
   * compatibility.  The newer versions of these values should be
   * preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  #define GIT_IDXENTRY_NAMEMASK          GIT_INDEX_ENTRY_NAMEMASK
  #define GIT_IDXENTRY_STAGEMASK         GIT_INDEX_ENTRY_STAGEMASK
  #define GIT_IDXENTRY_STAGESHIFT        GIT_INDEX_ENTRY_STAGESHIFT
  
  /* The git_indxentry_flag_t enum */
  #define GIT_IDXENTRY_EXTENDED          GIT_INDEX_ENTRY_EXTENDED
  #define GIT_IDXENTRY_VALID             GIT_INDEX_ENTRY_VALID
  
  #define GIT_IDXENTRY_STAGE(E)          GIT_INDEX_ENTRY_STAGE(E)
  #define GIT_IDXENTRY_STAGE_SET(E,S)    GIT_INDEX_ENTRY_STAGE_SET(E,S)
  
  /* The git_idxentry_extended_flag_t enum */
  #define GIT_IDXENTRY_INTENT_TO_ADD     GIT_INDEX_ENTRY_INTENT_TO_ADD
  #define GIT_IDXENTRY_SKIP_WORKTREE     GIT_INDEX_ENTRY_SKIP_WORKTREE
  #define GIT_IDXENTRY_EXTENDED_FLAGS    (GIT_INDEX_ENTRY_INTENT_TO_ADD | GIT_INDEX_ENTRY_SKIP_WORKTREE)
  #define GIT_IDXENTRY_EXTENDED2         (1 << 15)
  #define GIT_IDXENTRY_UPDATE            (1 << 0)
  #define GIT_IDXENTRY_REMOVE            (1 << 1)
  #define GIT_IDXENTRY_UPTODATE          (1 << 2)
  #define GIT_IDXENTRY_ADDED             (1 << 3)
  #define GIT_IDXENTRY_HASHED            (1 << 4)
  #define GIT_IDXENTRY_UNHASHED          (1 << 5)
  #define GIT_IDXENTRY_WT_REMOVE         (1 << 6)
  #define GIT_IDXENTRY_CONFLICTED        (1 << 7)
  #define GIT_IDXENTRY_UNPACKED          (1 << 8)
  #define GIT_IDXENTRY_NEW_SKIP_WORKTREE (1 << 9)
  
  /* The git_index_capability_t enum */
  #define GIT_INDEXCAP_IGNORE_CASE       GIT_INDEX_CAPABILITY_IGNORE_CASE
  #define GIT_INDEXCAP_NO_FILEMODE       GIT_INDEX_CAPABILITY_NO_FILEMODE
  #define GIT_INDEXCAP_NO_SYMLINKS       GIT_INDEX_CAPABILITY_NO_SYMLINKS
  #define GIT_INDEXCAP_FROM_OWNER        GIT_INDEX_CAPABILITY_FROM_OWNER
  
  GIT_EXTERN(int) git_index_add_frombuffer(
  	git_index *index,
  	const git_index_entry *entry,
  	const void *buffer, size_t len);
  
  /**@}*/
  
  /** @name Deprecated Object Constants
   *
   * These enumeration values are retained for backward compatibility.  The
   * newer versions of these values should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  #define git_otype git_object_t
  
  #define GIT_OBJ_ANY GIT_OBJECT_ANY
  #define GIT_OBJ_BAD GIT_OBJECT_INVALID
  #define GIT_OBJ__EXT1 0
  #define GIT_OBJ_COMMIT GIT_OBJECT_COMMIT
  #define GIT_OBJ_TREE GIT_OBJECT_TREE
  #define GIT_OBJ_BLOB GIT_OBJECT_BLOB
  #define GIT_OBJ_TAG GIT_OBJECT_TAG
  #define GIT_OBJ__EXT2 5
  #define GIT_OBJ_OFS_DELTA GIT_OBJECT_OFS_DELTA
  #define GIT_OBJ_REF_DELTA GIT_OBJECT_REF_DELTA
  
  /**
   * Get the size in bytes for the structure which
   * acts as an in-memory representation of any given
   * object type.
   *
   * For all the core types, this would the equivalent
   * of calling `sizeof(git_commit)` if the core types
   * were not opaque on the external API.
   *
   * @param type object type to get its size
   * @return size in bytes of the object
   */
  GIT_EXTERN(size_t) git_object__size(git_object_t type);
  
  /**@}*/
  
  /** @name Deprecated Reference Constants
   *
   * These enumeration values are retained for backward compatibility.  The
   * newer versions of these values should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
   /** Basic type of any Git reference. */
  #define git_ref_t git_reference_t
  #define git_reference_normalize_t git_reference_format_t
  
  #define GIT_REF_INVALID GIT_REFERENCE_INVALID
  #define GIT_REF_OID GIT_REFERENCE_DIRECT
  #define GIT_REF_SYMBOLIC GIT_REFERENCE_SYMBOLIC
  #define GIT_REF_LISTALL GIT_REFERENCE_ALL
  
  #define GIT_REF_FORMAT_NORMAL GIT_REFERENCE_FORMAT_NORMAL
  #define GIT_REF_FORMAT_ALLOW_ONELEVEL GIT_REFERENCE_FORMAT_ALLOW_ONELEVEL
  #define GIT_REF_FORMAT_REFSPEC_PATTERN GIT_REFERENCE_FORMAT_REFSPEC_PATTERN
  #define GIT_REF_FORMAT_REFSPEC_SHORTHAND GIT_REFERENCE_FORMAT_REFSPEC_SHORTHAND
  
  GIT_EXTERN(int) git_tag_create_frombuffer(
  	git_oid *oid,
  	git_repository *repo,
  	const char *buffer,
  	int force);
  
  /**@}*/
  
  /** @name Deprecated Credential Callback Types
   *
   * These types are retained for backward compatibility.  The newer
   * versions of these values should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  
  typedef git_cred_sign_cb git_cred_sign_callback;
  typedef git_cred_ssh_interactive_cb git_cred_ssh_interactive_callback;
  
  /**@}*/
  
  /** @name Deprecated Trace Callback Types
   *
   * These types are retained for backward compatibility.  The newer
   * versions of these values should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  typedef git_trace_cb git_trace_callback;
  
  /**@}*/
  
  /** @name Deprecated Object ID Types
   *
   * These types are retained for backward compatibility.  The newer
   * versions of these values should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  GIT_EXTERN(int) git_oid_iszero(const git_oid *id);
  
  /**@}*/
  
  /** @name Deprecated Transfer Progress Types
   *
   * These types are retained for backward compatibility.  The newer
   * versions of these values should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility values at
   * this time.
   */
  /**@{*/
  
  /**
   * This structure is used to provide callers information about the
   * progress of indexing a packfile.
   *
   * This type is deprecated, but there is no plan to remove this
   * type definition at this time.
   */
  typedef git_indexer_progress git_transfer_progress;
  
  /**
   * Type definition for progress callbacks during indexing.
   *
   * This type is deprecated, but there is no plan to remove this
   * type definition at this time.
   */
  typedef git_indexer_progress_cb git_transfer_progress_cb;
  
  /**
   * Type definition for push transfer progress callbacks.
   *
   * This type is deprecated, but there is no plan to remove this
   * type definition at this time.
   */
  typedef git_push_transfer_progress_cb git_push_transfer_progress;
  
   /** The type of a remote completion event */
  #define git_remote_completion_type git_remote_completion_t
  
  /**
   * Callback for listing the remote heads
   */
  typedef int GIT_CALLBACK(git_headlist_cb)(git_remote_head *rhead, void *payload);
  
  /**@}*/
  
  /** @name Deprecated Options Initialization Functions
   *
   * These functions are retained for backward compatibility.  The newer
   * versions of these functions should be preferred in all new code.
   *
   * There is no plan to remove these backward compatibility functions at
   * this time.
   */
  /**@{*/
  
  GIT_EXTERN(int) git_blame_init_options(git_blame_options *opts, unsigned int version);
  GIT_EXTERN(int) git_checkout_init_options(git_checkout_options *opts, unsigned int version);
  GIT_EXTERN(int) git_cherrypick_init_options(git_cherrypick_options *opts, unsigned int version);
  GIT_EXTERN(int) git_clone_init_options(git_clone_options *opts, unsigned int version);
  GIT_EXTERN(int) git_describe_init_options(git_describe_options *opts, unsigned int version);
  GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version);
  GIT_EXTERN(int) git_diff_init_options(git_diff_options *opts, unsigned int version);
  GIT_EXTERN(int) git_diff_find_init_options(git_diff_find_options *opts, unsigned int version);
  GIT_EXTERN(int) git_diff_format_email_init_options(git_diff_format_email_options *opts, unsigned int version);
  GIT_EXTERN(int) git_diff_patchid_init_options(git_diff_patchid_options *opts, unsigned int version);
  GIT_EXTERN(int) git_fetch_init_options(git_fetch_options *opts, unsigned int version);
  GIT_EXTERN(int) git_indexer_init_options(git_indexer_options *opts, unsigned int version);
  GIT_EXTERN(int) git_merge_init_options(git_merge_options *opts, unsigned int version);
  GIT_EXTERN(int) git_merge_file_init_input(git_merge_file_input *input, unsigned int version);
  GIT_EXTERN(int) git_merge_file_init_options(git_merge_file_options *opts, unsigned int version);
  GIT_EXTERN(int) git_proxy_init_options(git_proxy_options *opts, unsigned int version);
  GIT_EXTERN(int) git_push_init_options(git_push_options *opts, unsigned int version);
  GIT_EXTERN(int) git_rebase_init_options(git_rebase_options *opts, unsigned int version);
  GIT_EXTERN(int) git_remote_create_init_options(git_remote_create_options *opts, unsigned int version);
  GIT_EXTERN(int) git_repository_init_init_options(git_repository_init_options *opts, unsigned int version);
  GIT_EXTERN(int) git_revert_init_options(git_revert_options *opts, unsigned int version);
  GIT_EXTERN(int) git_stash_apply_init_options(git_stash_apply_options *opts, unsigned int version);
  GIT_EXTERN(int) git_status_init_options(git_status_options *opts, unsigned int version);
  GIT_EXTERN(int) git_submodule_update_init_options(git_submodule_update_options *opts, unsigned int version);
  GIT_EXTERN(int) git_worktree_add_init_options(git_worktree_add_options *opts, unsigned int version);
  GIT_EXTERN(int) git_worktree_prune_init_options(git_worktree_prune_options *opts, unsigned int version);
  
  /**@}*/
  
  /** @} */
  GIT_END_DECL
  
  #endif
  
  #endif
  

Download