include/git2/types.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_types_h__
   8 #define INCLUDE_git_types_h__
   9
  10 #include "common.h"
  11
  12 /**
  13  * @file git2/types.h
  14  * @brief libgit2 base & compatibility types
  15  * @ingroup Git
  16  * @{
  17  */
  18 GIT_BEGIN_DECL
  19
  20 /**
  21  * Cross-platform compatibility types for off_t / time_t
  22  *
  23  * NOTE: This needs to be in a public header so that both the library
  24  * implementation and client applications both agree on the same types.
  25  * Otherwise we get undefined behavior.
  26  *
  27  * Use the "best" types that each platform provides. Currently we truncate
  28  * these intermediate representations for compatibility with the git ABI, but
  29  * if and when it changes to support 64 bit types, our code will naturally
  30  * adapt.
  31  * NOTE: These types should match those that are returned by our internal
  32  * stat() functions, for all platforms.
  33  */
  34 #include <sys/types.h>
  35 #ifdef __amigaos4__
  36 #include <stdint.h>
  37 #endif
  38
  39 #if defined(_MSC_VER)
  40
  41 typedef __int64 git_off_t;
  42 typedef __time64_t git_time_t;
  43
  44 #elif defined(__MINGW32__)
  45
  46 typedef off64_t git_off_t;
  47 typedef __time64_t git_time_t;
  48
  49 #elif defined(__HAIKU__)
  50
  51 typedef __haiku_std_int64 git_off_t;
  52 typedef __haiku_std_int64 git_time_t;
  53
  54 #else /* POSIX */
  55
  56 /*
  57  * Note: Can't use off_t since if a client program includes <sys/types.h>
  58  * before us (directly or indirectly), they'll get 32 bit off_t in their client
  59  * app, even though /we/ define _FILE_OFFSET_BITS=64.
  60  */
  61 typedef int64_t git_off_t;
  62 typedef int64_t git_time_t;
  63
  64 #endif
  65
  66 /** Basic type (loose or packed) of any Git object. */
  67 typedef enum {
  68         GIT_OBJ_ANY = -2,               /**< Object can be any of the following */
  69         GIT_OBJ_BAD = -1,               /**< Object is invalid. */
  70         GIT_OBJ__EXT1 = 0,              /**< Reserved for future use. */
  71         GIT_OBJ_COMMIT = 1,             /**< A commit object. */
  72         GIT_OBJ_TREE = 2,               /**< A tree (directory listing) object. */
  73         GIT_OBJ_BLOB = 3,               /**< A file revision object. */
  74         GIT_OBJ_TAG = 4,                /**< An annotated tag object. */
  75         GIT_OBJ__EXT2 = 5,              /**< Reserved for future use. */
  76         GIT_OBJ_OFS_DELTA = 6, /**< A delta, base is given by an offset. */
  77         GIT_OBJ_REF_DELTA = 7, /**< A delta, base is given by object id. */
  78 } git_otype;
  79
  80 /** An open object database handle. */
  81 typedef struct git_odb git_odb;
  82
  83 /** A custom backend in an ODB */
  84 typedef struct git_odb_backend git_odb_backend;
  85
  86 /** An object read from the ODB */
  87 typedef struct git_odb_object git_odb_object;
  88
  89 /** A stream to read/write from the ODB */
  90 typedef struct git_odb_stream git_odb_stream;
  91
  92 /** A stream to write a packfile to the ODB */
  93 typedef struct git_odb_writepack git_odb_writepack;
  94
  95 /** An open refs database handle. */
  96 typedef struct git_refdb git_refdb;
  97
  98 /** A custom backend for refs */
  99 typedef struct git_refdb_backend git_refdb_backend;
 100
 101 /**
 102  * Representation of an existing git repository,
 103  * including all its object contents
 104  */
 105 typedef struct git_repository git_repository;
 106
 107 /** Representation of a generic object in a repository */
 108 typedef struct git_object git_object;
 109
 110 /** Representation of an in-progress walk through the commits in a repo */
 111 typedef struct git_revwalk git_revwalk;
 112
 113 /** Parsed representation of a tag object. */
 114 typedef struct git_tag git_tag;
 115
 116 /** In-memory representation of a blob object. */
 117 typedef struct git_blob git_blob;
 118
 119 /** Parsed representation of a commit object. */
 120 typedef struct git_commit git_commit;
 121
 122 /** Representation of each one of the entries in a tree object. */
 123 typedef struct git_tree_entry git_tree_entry;
 124
 125 /** Representation of a tree object. */
 126 typedef struct git_tree git_tree;
 127
 128 /** Constructor for in-memory trees */
 129 typedef struct git_treebuilder git_treebuilder;
 130
 131 /** Memory representation of an index file. */
 132 typedef struct git_index git_index;
 133
 134 /** An iterator for conflicts in the index. */
 135 typedef struct git_index_conflict_iterator git_index_conflict_iterator;
 136
 137 /** Memory representation of a set of config files */
 138 typedef struct git_config git_config;
 139
 140 /** Interface to access a configuration file */
 141 typedef struct git_config_backend git_config_backend;
 142
 143 /** Representation of a reference log entry */
 144 typedef struct git_reflog_entry git_reflog_entry;
 145
 146 /** Representation of a reference log */
 147 typedef struct git_reflog git_reflog;
 148
 149 /** Representation of a git note */
 150 typedef struct git_note git_note;
 151
 152 /** Representation of a git packbuilder */
 153 typedef struct git_packbuilder git_packbuilder;
 154
 155 /** Time in a signature */
 156 typedef struct git_time {
 157         git_time_t time; /**< time in seconds from epoch */
 158         int offset; /**< timezone offset, in minutes */
 159 } git_time;
 160
 161 /** An action signature (e.g. for committers, taggers, etc) */
 162 typedef struct git_signature {
 163         char *name; /**< full name of the author */
 164         char *email; /**< email of the author */
 165         git_time when; /**< time when the action happened */
 166 } git_signature;
 167
 168 /** In-memory representation of a reference. */
 169 typedef struct git_reference git_reference;
 170
 171 /** Iterator for references */
 172 typedef struct git_reference_iterator  git_reference_iterator;
 173
 174 /** Merge heads, the input to merge */
 175 typedef struct git_merge_head git_merge_head;
 176
 177 /** Merge result */
 178 typedef struct git_merge_result git_merge_result;
 179
 180 /** Representation of a status collection */
 181 typedef struct git_status_list git_status_list;
 182
 183
 184 /** Basic type of any Git reference. */
 185 typedef enum {
 186         GIT_REF_INVALID = 0, /**< Invalid reference */
 187         GIT_REF_OID = 1, /**< A reference which points at an object id */
 188         GIT_REF_SYMBOLIC = 2, /**< A reference which points at another reference */
 189         GIT_REF_LISTALL = GIT_REF_OID|GIT_REF_SYMBOLIC,
 190 } git_ref_t;
 191
 192 /** Basic type of any Git branch. */
 193 typedef enum {
 194         GIT_BRANCH_LOCAL = 1,
 195         GIT_BRANCH_REMOTE = 2,
 196         GIT_BRANCH_ALL = GIT_BRANCH_LOCAL|GIT_BRANCH_REMOTE,
 197 } git_branch_t;
 198
 199 /** Valid modes for index and tree entries. */
 200 typedef enum {
 201         GIT_FILEMODE_UNREADABLE          = 0000000,
 202         GIT_FILEMODE_TREE                = 0040000,
 203         GIT_FILEMODE_BLOB                = 0100644,
 204         GIT_FILEMODE_BLOB_EXECUTABLE     = 0100755,
 205         GIT_FILEMODE_LINK                = 0120000,
 206         GIT_FILEMODE_COMMIT              = 0160000,
 207 } git_filemode_t;
 208
 209 typedef struct git_refspec git_refspec;
 210 typedef struct git_remote git_remote;
 211 typedef struct git_push git_push;
 212
 213 typedef struct git_remote_head git_remote_head;
 214 typedef struct git_remote_callbacks git_remote_callbacks;
 215
 216 /**
 217  * This is passed as the first argument to the callback to allow the
 218  * user to see the progress.
 219  *
 220  * - total_objects: number of objects in the packfile being downloaded
 221  * - indexed_objects: received objects that have been hashed
 222  * - received_objects: objects which have been downloaded
 223  * - local_objects: locally-available objects that have been injected
 224  *    in order to fix a thin pack.
 225  * - received-bytes: size of the packfile received up to now
 226  */
 227 typedef struct git_transfer_progress {
 228         unsigned int total_objects;
 229         unsigned int indexed_objects;
 230         unsigned int received_objects;
 231         unsigned int local_objects;
 232         unsigned int total_deltas;
 233         unsigned int indexed_deltas;
 234         size_t received_bytes;
 235 } git_transfer_progress;
 236
 237 /**
 238  * Type for progress callbacks during indexing.  Return a value less than zero
 239  * to cancel the transfer.
 240  *
 241  * @param stats Structure containing information about the state of the transfer
 242  * @param payload Payload provided by caller
 243  */
 244 typedef int (*git_transfer_progress_cb)(const git_transfer_progress *stats, void *payload);
 245
 246 /**
 247  * Type for messages delivered by the transport.  Return a negative value
 248  * to cancel the network operation.
 249  *
 250  * @param str The message from the transport
 251  * @param len The length of the message
 252  * @param payload Payload provided by the caller
 253  */
 254 typedef int (*git_transport_message_cb)(const char *str, int len, void *payload);
 255
 256 /**
 257  * Opaque structure representing a submodule.
 258  */
 259 typedef struct git_submodule git_submodule;
 260
 261 /**
 262  * Submodule update values
 263  *
 264  * These values represent settings for the `submodule.$name.update`
 265  * configuration value which says how to handle `git submodule update` for
 266  * this submodule.  The value is usually set in the ".gitmodules" file and
 267  * copied to ".git/config" when the submodule is initialized.
 268  *
 269  * You can override this setting on a per-submodule basis with
 270  * `git_submodule_set_update()` and write the changed value to disk using
 271  * `git_submodule_save()`.  If you have overwritten the value, you can
 272  * revert it by passing `GIT_SUBMODULE_UPDATE_RESET` to the set function.
 273  *
 274  * The values are:
 275  *
 276  * - GIT_SUBMODULE_UPDATE_RESET: reset to the on-disk value.
 277  * - GIT_SUBMODULE_UPDATE_CHECKOUT: the default; when a submodule is
 278  *   updated, checkout the new detached HEAD to the submodule directory.
 279  * - GIT_SUBMODULE_UPDATE_REBASE: update by rebasing the current checked
 280  *   out branch onto the commit from the superproject.
 281  * - GIT_SUBMODULE_UPDATE_MERGE: update by merging the commit in the
 282  *   superproject into the current checkout out branch of the submodule.
 283  * - GIT_SUBMODULE_UPDATE_NONE: do not update this submodule even when
 284  *   the commit in the superproject is updated.
 285  * - GIT_SUBMODULE_UPDATE_DEFAULT: not used except as static initializer
 286  *   when we don't want any particular update rule to be specified.
 287  */
 288 typedef enum {
 289         GIT_SUBMODULE_UPDATE_RESET    = -1,
 290
 291         GIT_SUBMODULE_UPDATE_CHECKOUT = 1,
 292         GIT_SUBMODULE_UPDATE_REBASE   = 2,
 293         GIT_SUBMODULE_UPDATE_MERGE    = 3,
 294         GIT_SUBMODULE_UPDATE_NONE     = 4,
 295
 296         GIT_SUBMODULE_UPDATE_DEFAULT  = 0
 297 } git_submodule_update_t;
 298
 299 /**
 300  * Submodule ignore values
 301  *
 302  * These values represent settings for the `submodule.$name.ignore`
 303  * configuration value which says how deeply to look at the working
 304  * directory when getting submodule status.
 305  *
 306  * You can override this value in memory on a per-submodule basis with
 307  * `git_submodule_set_ignore()` and can write the changed value to disk
 308  * with `git_submodule_save()`.  If you have overwritten the value, you
 309  * can revert to the on disk value by using `GIT_SUBMODULE_IGNORE_RESET`.
 310  *
 311  * The values are:
 312  *
 313  * - GIT_SUBMODULE_IGNORE_RESET: reset to the on-disk value.
 314  * - GIT_SUBMODULE_IGNORE_NONE: don't ignore any change - i.e. even an
 315  *   untracked file, will mark the submodule as dirty.  Ignored files are
 316  *   still ignored, of course.
 317  * - GIT_SUBMODULE_IGNORE_UNTRACKED: ignore untracked files; only changes
 318  *   to tracked files, or the index or the HEAD commit will matter.
 319  * - GIT_SUBMODULE_IGNORE_DIRTY: ignore changes in the working directory,
 320  *   only considering changes if the HEAD of submodule has moved from the
 321  *   value in the superproject.
 322  * - GIT_SUBMODULE_IGNORE_ALL: never check if the submodule is dirty
 323  * - GIT_SUBMODULE_IGNORE_DEFAULT: not used except as static initializer
 324  *   when we don't want any particular ignore rule to be specified.
 325  */
 326 typedef enum {
 327         GIT_SUBMODULE_IGNORE_RESET     = -1, /**< reset to on-disk value */
 328
 329         GIT_SUBMODULE_IGNORE_NONE      = 1,  /**< any change or untracked == dirty */
 330         GIT_SUBMODULE_IGNORE_UNTRACKED = 2,  /**< dirty if tracked files change */
 331         GIT_SUBMODULE_IGNORE_DIRTY     = 3,  /**< only dirty if HEAD moved */
 332         GIT_SUBMODULE_IGNORE_ALL       = 4,  /**< never dirty */
 333
 334         GIT_SUBMODULE_IGNORE_DEFAULT   = 0
 335 } git_submodule_ignore_t;
 336
 337 /**
 338  * Options for submodule recurse.
 339  *
 340  * Represent the value of `submodule.$name.fetchRecurseSubmodules`
 341  *
 342  * * GIT_SUBMODULE_RECURSE_RESET - reset to the on-disk value
 343  * * GIT_SUBMODULE_RECURSE_NO    - do no recurse into submodules
 344  * * GIT_SUBMODULE_RECURSE_YES   - recurse into submodules
 345  * * GIT_SUBMODULE_RECURSE_ONDEMAND - recurse into submodules only when
 346  *                                    commit not already in local clone
 347  */
 348 typedef enum {
 349         GIT_SUBMODULE_RECURSE_RESET = -1,
 350
 351         GIT_SUBMODULE_RECURSE_NO = 0,
 352         GIT_SUBMODULE_RECURSE_YES = 1,
 353         GIT_SUBMODULE_RECURSE_ONDEMAND = 2,
 354 } git_submodule_recurse_t;
 355
 356 /** @} */
 357 GIT_END_DECL
 358
 359 #endif