Merge branch 'mm/config-xdg'
[git/jnareb-git.git] / cache.h
blob2997b918e8201516fe4df91f7cc3fbf8ee2253e4
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hash.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
11 #include SHA1_HEADER
12 #ifndef git_SHA_CTX
13 #define git_SHA_CTX SHA_CTX
14 #define git_SHA1_Init SHA1_Init
15 #define git_SHA1_Update SHA1_Update
16 #define git_SHA1_Final SHA1_Final
17 #endif
19 #include <zlib.h>
20 typedef struct git_zstream {
21 z_stream z;
22 unsigned long avail_in;
23 unsigned long avail_out;
24 unsigned long total_in;
25 unsigned long total_out;
26 unsigned char *next_in;
27 unsigned char *next_out;
28 } git_zstream;
30 void git_inflate_init(git_zstream *);
31 void git_inflate_init_gzip_only(git_zstream *);
32 void git_inflate_end(git_zstream *);
33 int git_inflate(git_zstream *, int flush);
35 void git_deflate_init(git_zstream *, int level);
36 void git_deflate_init_gzip(git_zstream *, int level);
37 void git_deflate_end(git_zstream *);
38 int git_deflate_abort(git_zstream *);
39 int git_deflate_end_gently(git_zstream *);
40 int git_deflate(git_zstream *, int flush);
41 unsigned long git_deflate_bound(git_zstream *, unsigned long);
43 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
44 #define DTYPE(de) ((de)->d_type)
45 #else
46 #undef DT_UNKNOWN
47 #undef DT_DIR
48 #undef DT_REG
49 #undef DT_LNK
50 #define DT_UNKNOWN 0
51 #define DT_DIR 1
52 #define DT_REG 2
53 #define DT_LNK 3
54 #define DTYPE(de) DT_UNKNOWN
55 #endif
57 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
58 #define S_IFINVALID 0030000
61 * A "directory link" is a link to another git directory.
63 * The value 0160000 is not normally a valid mode, and
64 * also just happens to be S_IFDIR + S_IFLNK
66 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
67 * always having the same values everywhere. We should use
68 * our internal git values for these things, and then we can
69 * translate that to the OS-specific value. It just so
70 * happens that everybody shares the same bit representation
71 * in the UNIX world (and apparently wider too..)
73 #define S_IFGITLINK 0160000
74 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
77 * Intensive research over the course of many years has shown that
78 * port 9418 is totally unused by anything else. Or
80 * Your search - "port 9418" - did not match any documents.
82 * as www.google.com puts it.
84 * This port has been properly assigned for git use by IANA:
85 * git (Assigned-9418) [I06-050728-0001].
87 * git 9418/tcp git pack transfer service
88 * git 9418/udp git pack transfer service
90 * with Linus Torvalds <torvalds@osdl.org> as the point of
91 * contact. September 2005.
93 * See http://www.iana.org/assignments/port-numbers
95 #define DEFAULT_GIT_PORT 9418
98 * Basic data structures for the directory cache
101 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
102 struct cache_header {
103 unsigned int hdr_signature;
104 unsigned int hdr_version;
105 unsigned int hdr_entries;
108 #define INDEX_FORMAT_LB 2
109 #define INDEX_FORMAT_UB 4
112 * The "cache_time" is just the low 32 bits of the
113 * time. It doesn't matter if it overflows - we only
114 * check it for equality in the 32 bits we save.
116 struct cache_time {
117 unsigned int sec;
118 unsigned int nsec;
121 struct cache_entry {
122 struct cache_time ce_ctime;
123 struct cache_time ce_mtime;
124 unsigned int ce_dev;
125 unsigned int ce_ino;
126 unsigned int ce_mode;
127 unsigned int ce_uid;
128 unsigned int ce_gid;
129 unsigned int ce_size;
130 unsigned int ce_flags;
131 unsigned char sha1[20];
132 struct cache_entry *next;
133 struct cache_entry *dir_next;
134 char name[FLEX_ARRAY]; /* more */
137 #define CE_NAMEMASK (0x0fff)
138 #define CE_STAGEMASK (0x3000)
139 #define CE_EXTENDED (0x4000)
140 #define CE_VALID (0x8000)
141 #define CE_STAGESHIFT 12
144 * Range 0xFFFF0000 in ce_flags is divided into
145 * two parts: in-memory flags and on-disk ones.
146 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
147 * if you want to save a new flag, add it in
148 * CE_EXTENDED_FLAGS
150 * In-memory only flags
152 #define CE_UPDATE (1 << 16)
153 #define CE_REMOVE (1 << 17)
154 #define CE_UPTODATE (1 << 18)
155 #define CE_ADDED (1 << 19)
157 #define CE_HASHED (1 << 20)
158 #define CE_UNHASHED (1 << 21)
159 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
160 #define CE_CONFLICTED (1 << 23)
162 #define CE_UNPACKED (1 << 24)
163 #define CE_NEW_SKIP_WORKTREE (1 << 25)
166 * Extended on-disk flags
168 #define CE_INTENT_TO_ADD (1 << 29)
169 #define CE_SKIP_WORKTREE (1 << 30)
170 /* CE_EXTENDED2 is for future extension */
171 #define CE_EXTENDED2 (1 << 31)
173 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
176 * Safeguard to avoid saving wrong flags:
177 * - CE_EXTENDED2 won't get saved until its semantic is known
178 * - Bits in 0x0000FFFF have been saved in ce_flags already
179 * - Bits in 0x003F0000 are currently in-memory flags
181 #if CE_EXTENDED_FLAGS & 0x803FFFFF
182 #error "CE_EXTENDED_FLAGS out of range"
183 #endif
186 * Copy the sha1 and stat state of a cache entry from one to
187 * another. But we never change the name, or the hash state!
189 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
190 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
192 unsigned int state = dst->ce_flags & CE_STATE_MASK;
194 /* Don't copy hash chain and name */
195 memcpy(dst, src, offsetof(struct cache_entry, next));
197 /* Restore the hash state */
198 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
201 static inline unsigned create_ce_flags(size_t len, unsigned stage)
203 if (len >= CE_NAMEMASK)
204 len = CE_NAMEMASK;
205 return (len | (stage << CE_STAGESHIFT));
208 static inline size_t ce_namelen(const struct cache_entry *ce)
210 size_t len = ce->ce_flags & CE_NAMEMASK;
211 if (len < CE_NAMEMASK)
212 return len;
213 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
216 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
217 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
218 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
219 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
220 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
222 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
223 static inline unsigned int create_ce_mode(unsigned int mode)
225 if (S_ISLNK(mode))
226 return S_IFLNK;
227 if (S_ISDIR(mode) || S_ISGITLINK(mode))
228 return S_IFGITLINK;
229 return S_IFREG | ce_permissions(mode);
231 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
233 extern int trust_executable_bit, has_symlinks;
234 if (!has_symlinks && S_ISREG(mode) &&
235 ce && S_ISLNK(ce->ce_mode))
236 return ce->ce_mode;
237 if (!trust_executable_bit && S_ISREG(mode)) {
238 if (ce && S_ISREG(ce->ce_mode))
239 return ce->ce_mode;
240 return create_ce_mode(0666);
242 return create_ce_mode(mode);
244 static inline int ce_to_dtype(const struct cache_entry *ce)
246 unsigned ce_mode = ntohl(ce->ce_mode);
247 if (S_ISREG(ce_mode))
248 return DT_REG;
249 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
250 return DT_DIR;
251 else if (S_ISLNK(ce_mode))
252 return DT_LNK;
253 else
254 return DT_UNKNOWN;
256 static inline unsigned int canon_mode(unsigned int mode)
258 if (S_ISREG(mode))
259 return S_IFREG | ce_permissions(mode);
260 if (S_ISLNK(mode))
261 return S_IFLNK;
262 if (S_ISDIR(mode))
263 return S_IFDIR;
264 return S_IFGITLINK;
267 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
269 struct index_state {
270 struct cache_entry **cache;
271 unsigned int version;
272 unsigned int cache_nr, cache_alloc, cache_changed;
273 struct string_list *resolve_undo;
274 struct cache_tree *cache_tree;
275 struct cache_time timestamp;
276 unsigned name_hash_initialized : 1,
277 initialized : 1;
278 struct hash_table name_hash;
281 extern struct index_state the_index;
283 /* Name hashing */
284 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
286 * We don't actually *remove* it, we can just mark it invalid so that
287 * we won't find it in lookups.
289 * Not only would we have to search the lists (simple enough), but
290 * we'd also have to rehash other hash buckets in case this makes the
291 * hash bucket empty (common). So it's much better to just mark
292 * it.
294 static inline void remove_name_hash(struct cache_entry *ce)
296 ce->ce_flags |= CE_UNHASHED;
300 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
301 #define active_cache (the_index.cache)
302 #define active_nr (the_index.cache_nr)
303 #define active_alloc (the_index.cache_alloc)
304 #define active_cache_changed (the_index.cache_changed)
305 #define active_cache_tree (the_index.cache_tree)
307 #define read_cache() read_index(&the_index)
308 #define read_cache_from(path) read_index_from(&the_index, (path))
309 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
310 #define is_cache_unborn() is_index_unborn(&the_index)
311 #define read_cache_unmerged() read_index_unmerged(&the_index)
312 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
313 #define discard_cache() discard_index(&the_index)
314 #define unmerged_cache() unmerged_index(&the_index)
315 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
316 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
317 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
318 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
319 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
320 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
321 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
322 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
323 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
324 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
325 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
326 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
327 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
328 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
329 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
330 #endif
332 enum object_type {
333 OBJ_BAD = -1,
334 OBJ_NONE = 0,
335 OBJ_COMMIT = 1,
336 OBJ_TREE = 2,
337 OBJ_BLOB = 3,
338 OBJ_TAG = 4,
339 /* 5 for future expansion */
340 OBJ_OFS_DELTA = 6,
341 OBJ_REF_DELTA = 7,
342 OBJ_ANY,
343 OBJ_MAX
346 static inline enum object_type object_type(unsigned int mode)
348 return S_ISDIR(mode) ? OBJ_TREE :
349 S_ISGITLINK(mode) ? OBJ_COMMIT :
350 OBJ_BLOB;
353 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
354 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
355 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
356 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
357 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
358 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
359 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
360 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
361 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
362 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
363 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
364 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
365 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
366 #define GITATTRIBUTES_FILE ".gitattributes"
367 #define INFOATTRIBUTES_FILE "info/attributes"
368 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
369 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
370 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
371 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
372 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
373 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
376 * Repository-local GIT_* environment variables
377 * The array is NULL-terminated to simplify its usage in contexts such
378 * environment creation or simple walk of the list.
379 * The number of non-NULL entries is available as a macro.
381 #define LOCAL_REPO_ENV_SIZE 9
382 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
384 extern int is_bare_repository_cfg;
385 extern int is_bare_repository(void);
386 extern int is_inside_git_dir(void);
387 extern char *git_work_tree_cfg;
388 extern int is_inside_work_tree(void);
389 extern int have_git_dir(void);
390 extern const char *get_git_dir(void);
391 extern int is_git_directory(const char *path);
392 extern char *get_object_directory(void);
393 extern char *get_index_file(void);
394 extern char *get_graft_file(void);
395 extern int set_git_dir(const char *path);
396 extern const char *get_git_namespace(void);
397 extern const char *strip_namespace(const char *namespaced_ref);
398 extern const char *get_git_work_tree(void);
399 extern const char *read_gitfile(const char *path);
400 extern const char *resolve_gitdir(const char *suspect);
401 extern void set_git_work_tree(const char *tree);
403 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
405 extern const char **get_pathspec(const char *prefix, const char **pathspec);
406 extern void setup_work_tree(void);
407 extern const char *setup_git_directory_gently(int *);
408 extern const char *setup_git_directory(void);
409 extern char *prefix_path(const char *prefix, int len, const char *path);
410 extern const char *prefix_filename(const char *prefix, int len, const char *path);
411 extern int check_filename(const char *prefix, const char *name);
412 extern void verify_filename(const char *prefix,
413 const char *name,
414 int diagnose_misspelt_rev);
415 extern void verify_non_filename(const char *prefix, const char *name);
416 extern int path_inside_repo(const char *prefix, const char *path);
418 #define INIT_DB_QUIET 0x0001
420 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
421 extern int init_db(const char *template_dir, unsigned int flags);
423 #define alloc_nr(x) (((x)+16)*3/2)
426 * Realloc the buffer pointed at by variable 'x' so that it can hold
427 * at least 'nr' entries; the number of entries currently allocated
428 * is 'alloc', using the standard growing factor alloc_nr() macro.
430 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
432 #define ALLOC_GROW(x, nr, alloc) \
433 do { \
434 if ((nr) > alloc) { \
435 if (alloc_nr(alloc) < (nr)) \
436 alloc = (nr); \
437 else \
438 alloc = alloc_nr(alloc); \
439 x = xrealloc((x), alloc * sizeof(*(x))); \
441 } while (0)
443 /* Initialize and use the cache information */
444 extern int read_index(struct index_state *);
445 extern int read_index_preload(struct index_state *, const char **pathspec);
446 extern int read_index_from(struct index_state *, const char *path);
447 extern int is_index_unborn(struct index_state *);
448 extern int read_index_unmerged(struct index_state *);
449 extern int write_index(struct index_state *, int newfd);
450 extern int discard_index(struct index_state *);
451 extern int unmerged_index(const struct index_state *);
452 extern int verify_path(const char *path);
453 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
454 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
455 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
456 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
457 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
458 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
459 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
460 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
461 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
462 extern int remove_index_entry_at(struct index_state *, int pos);
463 extern void remove_marked_cache_entries(struct index_state *istate);
464 extern int remove_file_from_index(struct index_state *, const char *path);
465 #define ADD_CACHE_VERBOSE 1
466 #define ADD_CACHE_PRETEND 2
467 #define ADD_CACHE_IGNORE_ERRORS 4
468 #define ADD_CACHE_IGNORE_REMOVAL 8
469 #define ADD_CACHE_INTENT 16
470 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
471 extern int add_file_to_index(struct index_state *, const char *path, int flags);
472 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
473 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
474 extern int index_name_is_other(const struct index_state *, const char *, int);
476 /* do stat comparison even if CE_VALID is true */
477 #define CE_MATCH_IGNORE_VALID 01
478 /* do not check the contents but report dirty on racily-clean entries */
479 #define CE_MATCH_RACY_IS_DIRTY 02
480 /* do stat comparison even if CE_SKIP_WORKTREE is true */
481 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
482 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
483 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
485 struct pathspec {
486 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
487 int nr;
488 unsigned int has_wildcard:1;
489 unsigned int recursive:1;
490 int max_depth;
491 struct pathspec_item {
492 const char *match;
493 int len;
494 unsigned int use_wildcard:1;
495 } *items;
498 extern int init_pathspec(struct pathspec *, const char **);
499 extern void free_pathspec(struct pathspec *);
500 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
502 #define HASH_WRITE_OBJECT 1
503 #define HASH_FORMAT_CHECK 2
504 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
505 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
506 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
508 #define REFRESH_REALLY 0x0001 /* ignore_valid */
509 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
510 #define REFRESH_QUIET 0x0004 /* be quiet about it */
511 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
512 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
513 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
514 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
516 struct lock_file {
517 struct lock_file *next;
518 int fd;
519 pid_t owner;
520 char on_list;
521 char filename[PATH_MAX];
523 #define LOCK_DIE_ON_ERROR 1
524 #define LOCK_NODEREF 2
525 extern int unable_to_lock_error(const char *path, int err);
526 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
527 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
528 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
529 extern int commit_lock_file(struct lock_file *);
530 extern void update_index_if_able(struct index_state *, struct lock_file *);
532 extern int hold_locked_index(struct lock_file *, int);
533 extern int commit_locked_index(struct lock_file *);
534 extern void set_alternate_index_output(const char *);
535 extern int close_lock_file(struct lock_file *);
536 extern void rollback_lock_file(struct lock_file *);
537 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
539 /* Environment bits from configuration mechanism */
540 extern int trust_executable_bit;
541 extern int trust_ctime;
542 extern int quote_path_fully;
543 extern int has_symlinks;
544 extern int minimum_abbrev, default_abbrev;
545 extern int ignore_case;
546 extern int assume_unchanged;
547 extern int prefer_symlink_refs;
548 extern int log_all_ref_updates;
549 extern int warn_ambiguous_refs;
550 extern int shared_repository;
551 extern const char *apply_default_whitespace;
552 extern const char *apply_default_ignorewhitespace;
553 extern const char *git_attributes_file;
554 extern int zlib_compression_level;
555 extern int core_compression_level;
556 extern int core_compression_seen;
557 extern size_t packed_git_window_size;
558 extern size_t packed_git_limit;
559 extern size_t delta_base_cache_limit;
560 extern unsigned long big_file_threshold;
561 extern unsigned long pack_size_limit_cfg;
562 extern int read_replace_refs;
563 extern int fsync_object_files;
564 extern int core_preload_index;
565 extern int core_apply_sparse_checkout;
566 extern int precomposed_unicode;
568 enum branch_track {
569 BRANCH_TRACK_UNSPECIFIED = -1,
570 BRANCH_TRACK_NEVER = 0,
571 BRANCH_TRACK_REMOTE,
572 BRANCH_TRACK_ALWAYS,
573 BRANCH_TRACK_EXPLICIT,
574 BRANCH_TRACK_OVERRIDE
577 enum rebase_setup_type {
578 AUTOREBASE_NEVER = 0,
579 AUTOREBASE_LOCAL,
580 AUTOREBASE_REMOTE,
581 AUTOREBASE_ALWAYS
584 enum push_default_type {
585 PUSH_DEFAULT_NOTHING = 0,
586 PUSH_DEFAULT_MATCHING,
587 PUSH_DEFAULT_SIMPLE,
588 PUSH_DEFAULT_UPSTREAM,
589 PUSH_DEFAULT_CURRENT,
590 PUSH_DEFAULT_UNSPECIFIED
593 extern enum branch_track git_branch_track;
594 extern enum rebase_setup_type autorebase;
595 extern enum push_default_type push_default;
597 enum object_creation_mode {
598 OBJECT_CREATION_USES_HARDLINKS = 0,
599 OBJECT_CREATION_USES_RENAMES = 1
602 extern enum object_creation_mode object_creation_mode;
604 extern char *notes_ref_name;
606 extern int grafts_replace_parents;
608 #define GIT_REPO_VERSION 0
609 extern int repository_format_version;
610 extern int check_repository_format(void);
612 #define MTIME_CHANGED 0x0001
613 #define CTIME_CHANGED 0x0002
614 #define OWNER_CHANGED 0x0004
615 #define MODE_CHANGED 0x0008
616 #define INODE_CHANGED 0x0010
617 #define DATA_CHANGED 0x0020
618 #define TYPE_CHANGED 0x0040
620 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
621 __attribute__((format (printf, 3, 4)));
622 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
623 __attribute__((format (printf, 3, 4)));
624 extern char *git_pathdup(const char *fmt, ...)
625 __attribute__((format (printf, 1, 2)));
626 extern char *mkpathdup(const char *fmt, ...)
627 __attribute__((format (printf, 1, 2)));
629 /* Return a statically allocated filename matching the sha1 signature */
630 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
631 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
632 extern char *git_path_submodule(const char *path, const char *fmt, ...)
633 __attribute__((format (printf, 2, 3)));
635 extern char *sha1_file_name(const unsigned char *sha1);
636 extern char *sha1_pack_name(const unsigned char *sha1);
637 extern char *sha1_pack_index_name(const unsigned char *sha1);
638 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
639 extern const unsigned char null_sha1[20];
641 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
643 int i;
645 for (i = 0; i < 20; i++, sha1++, sha2++) {
646 if (*sha1 != *sha2)
647 return *sha1 - *sha2;
650 return 0;
653 static inline int is_null_sha1(const unsigned char *sha1)
655 return !hashcmp(sha1, null_sha1);
658 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
660 memcpy(sha_dst, sha_src, 20);
662 static inline void hashclr(unsigned char *hash)
664 memset(hash, 0, 20);
667 #define EMPTY_TREE_SHA1_HEX \
668 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
669 #define EMPTY_TREE_SHA1_BIN_LITERAL \
670 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
671 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
672 #define EMPTY_TREE_SHA1_BIN \
673 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
675 #define EMPTY_BLOB_SHA1_HEX \
676 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
677 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
678 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
679 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
680 #define EMPTY_BLOB_SHA1_BIN \
681 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
683 static inline int is_empty_blob_sha1(const unsigned char *sha1)
685 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
688 int git_mkstemp(char *path, size_t n, const char *template);
690 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
692 /* set default permissions by passing mode arguments to open(2) */
693 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
694 int git_mkstemp_mode(char *pattern, int mode);
697 * NOTE NOTE NOTE!!
699 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
700 * not be changed. Old repositories have core.sharedrepository written in
701 * numeric format, and therefore these values are preserved for compatibility
702 * reasons.
704 enum sharedrepo {
705 PERM_UMASK = 0,
706 OLD_PERM_GROUP = 1,
707 OLD_PERM_EVERYBODY = 2,
708 PERM_GROUP = 0660,
709 PERM_EVERYBODY = 0664
711 int git_config_perm(const char *var, const char *value);
712 int set_shared_perm(const char *path, int mode);
713 #define adjust_shared_perm(path) set_shared_perm((path), 0)
714 int safe_create_leading_directories(char *path);
715 int safe_create_leading_directories_const(const char *path);
716 int mkdir_in_gitdir(const char *path);
717 extern void home_config_paths(char **global, char **xdg, char *file);
718 extern char *expand_user_path(const char *path);
719 const char *enter_repo(const char *path, int strict);
720 static inline int is_absolute_path(const char *path)
722 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
724 int is_directory(const char *);
725 const char *real_path(const char *path);
726 const char *absolute_path(const char *path);
727 const char *relative_path(const char *abs, const char *base);
728 int normalize_path_copy(char *dst, const char *src);
729 int longest_ancestor_length(const char *path, const char *prefix_list);
730 char *strip_path_suffix(const char *path, const char *suffix);
731 int daemon_avoid_alias(const char *path);
732 int offset_1st_component(const char *path);
734 /* object replacement */
735 #define READ_SHA1_FILE_REPLACE 1
736 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
737 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
739 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
741 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
742 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
744 if (!read_replace_refs)
745 return sha1;
746 return do_lookup_replace_object(sha1);
749 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
750 extern int sha1_object_info(const unsigned char *, unsigned long *);
751 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
752 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
753 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
754 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
755 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
756 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
757 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
759 /* global flag to enable extra checks when accessing packed objects */
760 extern int do_check_packed_object_crc;
762 /* for development: log offset of pack access */
763 extern const char *log_pack_access;
765 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
767 extern int move_temp_to_file(const char *tmpfile, const char *filename);
769 extern int has_sha1_pack(const unsigned char *sha1);
770 extern int has_sha1_file(const unsigned char *sha1);
771 extern int has_loose_object_nonlocal(const unsigned char *sha1);
773 extern int has_pack_index(const unsigned char *sha1);
775 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
777 extern const signed char hexval_table[256];
778 static inline unsigned int hexval(unsigned char c)
780 return hexval_table[c];
783 /* Convert to/from hex/sha1 representation */
784 #define MINIMUM_ABBREV minimum_abbrev
785 #define DEFAULT_ABBREV default_abbrev
787 struct object_context {
788 unsigned char tree[20];
789 char path[PATH_MAX];
790 unsigned mode;
793 #define GET_SHA1_QUIETLY 01
794 #define GET_SHA1_COMMIT 02
795 #define GET_SHA1_COMMITTISH 04
796 #define GET_SHA1_TREE 010
797 #define GET_SHA1_TREEISH 020
798 #define GET_SHA1_BLOB 040
799 #define GET_SHA1_ONLY_TO_DIE 04000
801 extern int get_sha1(const char *str, unsigned char *sha1);
802 extern int get_sha1_commit(const char *str, unsigned char *sha1);
803 extern int get_sha1_committish(const char *str, unsigned char *sha1);
804 extern int get_sha1_tree(const char *str, unsigned char *sha1);
805 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
806 extern int get_sha1_blob(const char *str, unsigned char *sha1);
807 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
808 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
810 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
811 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
814 * Try to read a SHA1 in hexadecimal format from the 40 characters
815 * starting at hex. Write the 20-byte result to sha1 in binary form.
816 * Return 0 on success. Reading stops if a NUL is encountered in the
817 * input, so it is safe to pass this function an arbitrary
818 * null-terminated string.
820 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
822 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
823 extern int read_ref_full(const char *refname, unsigned char *sha1,
824 int reading, int *flags);
825 extern int read_ref(const char *refname, unsigned char *sha1);
828 * Resolve a reference, recursively following symbolic refererences.
830 * Store the referred-to object's name in sha1 and return the name of
831 * the non-symbolic reference that ultimately pointed at it. The
832 * return value, if not NULL, is a pointer into either a static buffer
833 * or the input ref.
835 * If the reference cannot be resolved to an object, the behavior
836 * depends on the "reading" argument:
838 * - If reading is set, return NULL.
840 * - If reading is not set, clear sha1 and return the name of the last
841 * reference name in the chain, which will either be a non-symbolic
842 * reference or an undefined reference. If this is a prelude to
843 * "writing" to the ref, the return value is the name of the ref
844 * that will actually be created or changed.
846 * If flag is non-NULL, set the value that it points to the
847 * combination of REF_ISPACKED (if the reference was found among the
848 * packed references) and REF_ISSYMREF (if the initial reference was a
849 * symbolic reference).
851 * If ref is not a properly-formatted, normalized reference, return
852 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
853 * give up and return NULL.
855 * errno is sometimes set on errors, but not always.
857 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
858 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
860 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
861 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
862 extern int interpret_branch_name(const char *str, struct strbuf *);
863 extern int get_sha1_mb(const char *str, unsigned char *sha1);
865 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
866 extern const char *ref_rev_parse_rules[];
867 #define ref_fetch_rules ref_rev_parse_rules
869 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
870 extern int validate_headref(const char *ref);
872 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
873 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
874 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
876 extern void *read_object_with_reference(const unsigned char *sha1,
877 const char *required_type,
878 unsigned long *size,
879 unsigned char *sha1_ret);
881 extern struct object *peel_to_type(const char *name, int namelen,
882 struct object *o, enum object_type);
884 enum date_mode {
885 DATE_NORMAL = 0,
886 DATE_RELATIVE,
887 DATE_SHORT,
888 DATE_LOCAL,
889 DATE_ISO8601,
890 DATE_RFC2822,
891 DATE_RAW
894 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
895 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
896 struct strbuf *timebuf);
897 int parse_date(const char *date, char *buf, int bufsize);
898 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
899 void datestamp(char *buf, int bufsize);
900 #define approxidate(s) approxidate_careful((s), NULL)
901 unsigned long approxidate_careful(const char *, int *);
902 unsigned long approxidate_relative(const char *date, const struct timeval *now);
903 enum date_mode parse_date_format(const char *format);
905 #define IDENT_STRICT 1
906 #define IDENT_NO_DATE 2
907 #define IDENT_NO_NAME 4
908 extern const char *git_author_info(int);
909 extern const char *git_committer_info(int);
910 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
911 extern const char *fmt_name(const char *name, const char *email);
912 extern const char *ident_default_name(void);
913 extern const char *ident_default_email(void);
914 extern const char *ident_default_date(void);
915 extern const char *git_editor(void);
916 extern const char *git_pager(int stdout_is_tty);
917 extern int git_ident_config(const char *, const char *, void *);
919 struct ident_split {
920 const char *name_begin;
921 const char *name_end;
922 const char *mail_begin;
923 const char *mail_end;
924 const char *date_begin;
925 const char *date_end;
926 const char *tz_begin;
927 const char *tz_end;
930 * Signals an success with 0, but time part of the result may be NULL
931 * if the input lacks timestamp and zone
933 extern int split_ident_line(struct ident_split *, const char *, int);
935 struct checkout {
936 const char *base_dir;
937 int base_dir_len;
938 unsigned force:1,
939 quiet:1,
940 not_new:1,
941 refresh_cache:1;
944 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
946 struct cache_def {
947 char path[PATH_MAX + 1];
948 int len;
949 int flags;
950 int track_flags;
951 int prefix_len_stat_func;
954 extern int has_symlink_leading_path(const char *name, int len);
955 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
956 extern int check_leading_path(const char *name, int len);
957 extern int threaded_check_leading_path(struct cache_def *cache, const char *name, int len);
958 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
959 extern int threaded_has_dirs_only_path(struct cache_def *cache, const char *name, int len, int prefix_len);
960 extern void schedule_dir_for_removal(const char *name, int len);
961 extern void remove_scheduled_dirs(void);
963 extern struct alternate_object_database {
964 struct alternate_object_database *next;
965 char *name;
966 char base[FLEX_ARRAY]; /* more */
967 } *alt_odb_list;
968 extern void prepare_alt_odb(void);
969 extern void read_info_alternates(const char * relative_base, int depth);
970 extern void add_to_alternates_file(const char *reference);
971 typedef int alt_odb_fn(struct alternate_object_database *, void *);
972 extern void foreach_alt_odb(alt_odb_fn, void*);
974 struct pack_window {
975 struct pack_window *next;
976 unsigned char *base;
977 off_t offset;
978 size_t len;
979 unsigned int last_used;
980 unsigned int inuse_cnt;
983 extern struct packed_git {
984 struct packed_git *next;
985 struct pack_window *windows;
986 off_t pack_size;
987 const void *index_data;
988 size_t index_size;
989 uint32_t num_objects;
990 uint32_t num_bad_objects;
991 unsigned char *bad_object_sha1;
992 int index_version;
993 time_t mtime;
994 int pack_fd;
995 unsigned pack_local:1,
996 pack_keep:1,
997 do_not_close:1;
998 unsigned char sha1[20];
999 /* something like ".git/objects/pack/xxxxx.pack" */
1000 char pack_name[FLEX_ARRAY]; /* more */
1001 } *packed_git;
1003 struct pack_entry {
1004 off_t offset;
1005 unsigned char sha1[20];
1006 struct packed_git *p;
1009 struct ref {
1010 struct ref *next;
1011 unsigned char old_sha1[20];
1012 unsigned char new_sha1[20];
1013 char *symref;
1014 unsigned int force:1,
1015 merge:1,
1016 nonfastforward:1,
1017 deletion:1;
1018 enum {
1019 REF_STATUS_NONE = 0,
1020 REF_STATUS_OK,
1021 REF_STATUS_REJECT_NONFASTFORWARD,
1022 REF_STATUS_REJECT_NODELETE,
1023 REF_STATUS_UPTODATE,
1024 REF_STATUS_REMOTE_REJECT,
1025 REF_STATUS_EXPECTING_REPORT
1026 } status;
1027 char *remote_status;
1028 struct ref *peer_ref; /* when renaming */
1029 char name[FLEX_ARRAY]; /* more */
1032 #define REF_NORMAL (1u << 0)
1033 #define REF_HEADS (1u << 1)
1034 #define REF_TAGS (1u << 2)
1036 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1038 #define CONNECT_VERBOSE (1u << 0)
1039 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1040 extern int finish_connect(struct child_process *conn);
1041 extern int git_connection_is_socket(struct child_process *conn);
1042 struct extra_have_objects {
1043 int nr, alloc;
1044 unsigned char (*array)[20];
1046 extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
1047 extern int server_supports(const char *feature);
1048 extern const char *parse_feature_request(const char *features, const char *feature);
1050 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1052 extern void prepare_packed_git(void);
1053 extern void reprepare_packed_git(void);
1054 extern void install_packed_git(struct packed_git *pack);
1056 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1057 struct packed_git *packs);
1059 extern void pack_report(void);
1060 extern int open_pack_index(struct packed_git *);
1061 extern void close_pack_index(struct packed_git *);
1062 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1063 extern void close_pack_windows(struct packed_git *);
1064 extern void unuse_pack(struct pack_window **);
1065 extern void free_pack_by_name(const char *);
1066 extern void clear_delta_base_cache(void);
1067 extern struct packed_git *add_packed_git(const char *, int, int);
1068 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1069 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1070 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1071 extern int is_pack_valid(struct packed_git *);
1072 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1073 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1074 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1075 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1077 struct object_info {
1078 /* Request */
1079 unsigned long *sizep;
1081 /* Response */
1082 enum {
1083 OI_CACHED,
1084 OI_LOOSE,
1085 OI_PACKED,
1086 OI_DBCACHED
1087 } whence;
1088 union {
1090 * struct {
1091 * ... Nothing to expose in this case
1092 * } cached;
1093 * struct {
1094 * ... Nothing to expose in this case
1095 * } loose;
1097 struct {
1098 struct packed_git *pack;
1099 off_t offset;
1100 unsigned int is_delta;
1101 } packed;
1102 } u;
1104 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1106 /* Dumb servers support */
1107 extern int update_server_info(int);
1109 /* git_config_parse_key() returns these negated: */
1110 #define CONFIG_INVALID_KEY 1
1111 #define CONFIG_NO_SECTION_OR_NAME 2
1112 /* git_config_set(), git_config_set_multivar() return the above or these: */
1113 #define CONFIG_NO_LOCK -1
1114 #define CONFIG_INVALID_FILE 3
1115 #define CONFIG_NO_WRITE 4
1116 #define CONFIG_NOTHING_SET 5
1117 #define CONFIG_INVALID_PATTERN 6
1119 typedef int (*config_fn_t)(const char *, const char *, void *);
1120 extern int git_default_config(const char *, const char *, void *);
1121 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1122 extern void git_config_push_parameter(const char *text);
1123 extern int git_config_from_parameters(config_fn_t fn, void *data);
1124 extern int git_config(config_fn_t fn, void *);
1125 extern int git_config_with_options(config_fn_t fn, void *,
1126 const char *filename, int respect_includes);
1127 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1128 extern int git_parse_ulong(const char *, unsigned long *);
1129 extern int git_config_int(const char *, const char *);
1130 extern unsigned long git_config_ulong(const char *, const char *);
1131 extern int git_config_bool_or_int(const char *, const char *, int *);
1132 extern int git_config_bool(const char *, const char *);
1133 extern int git_config_maybe_bool(const char *, const char *);
1134 extern int git_config_string(const char **, const char *, const char *);
1135 extern int git_config_pathname(const char **, const char *, const char *);
1136 extern int git_config_set_in_file(const char *, const char *, const char *);
1137 extern int git_config_set(const char *, const char *);
1138 extern int git_config_parse_key(const char *, char **, int *);
1139 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1140 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1141 extern int git_config_rename_section(const char *, const char *);
1142 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1143 extern const char *git_etc_gitconfig(void);
1144 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1145 extern int git_env_bool(const char *, int);
1146 extern int git_config_system(void);
1147 extern int config_error_nonbool(const char *);
1148 extern const char *get_log_output_encoding(void);
1149 extern const char *get_commit_output_encoding(void);
1151 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1153 struct config_include_data {
1154 int depth;
1155 config_fn_t fn;
1156 void *data;
1158 #define CONFIG_INCLUDE_INIT { 0 }
1159 extern int git_config_include(const char *name, const char *value, void *data);
1161 #define IDENT_NAME_GIVEN 01
1162 #define IDENT_MAIL_GIVEN 02
1163 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1164 extern int user_ident_explicitly_given;
1165 extern int user_ident_sufficiently_given(void);
1167 extern const char *git_commit_encoding;
1168 extern const char *git_log_output_encoding;
1169 extern const char *git_mailmap_file;
1171 /* IO helper functions */
1172 extern void maybe_flush_or_die(FILE *, const char *);
1173 extern int copy_fd(int ifd, int ofd);
1174 extern int copy_file(const char *dst, const char *src, int mode);
1175 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1176 extern void write_or_die(int fd, const void *buf, size_t count);
1177 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1178 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1179 extern void fsync_or_die(int fd, const char *);
1181 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1182 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1183 static inline ssize_t write_str_in_full(int fd, const char *str)
1185 return write_in_full(fd, str, strlen(str));
1188 /* pager.c */
1189 extern void setup_pager(void);
1190 extern const char *pager_program;
1191 extern int pager_in_use(void);
1192 extern int pager_use_color;
1193 extern int term_columns(void);
1194 extern int decimal_width(int);
1196 extern const char *editor_program;
1197 extern const char *askpass_program;
1198 extern const char *excludes_file;
1200 /* base85 */
1201 int decode_85(char *dst, const char *line, int linelen);
1202 void encode_85(char *buf, const unsigned char *data, int bytes);
1204 /* alloc.c */
1205 extern void *alloc_blob_node(void);
1206 extern void *alloc_tree_node(void);
1207 extern void *alloc_commit_node(void);
1208 extern void *alloc_tag_node(void);
1209 extern void *alloc_object_node(void);
1210 extern void alloc_report(void);
1212 /* trace.c */
1213 __attribute__((format (printf, 1, 2)))
1214 extern void trace_printf(const char *format, ...);
1215 extern void trace_vprintf(const char *key, const char *format, va_list ap);
1216 __attribute__((format (printf, 2, 3)))
1217 extern void trace_argv_printf(const char **argv, const char *format, ...);
1218 extern void trace_repo_setup(const char *prefix);
1219 extern int trace_want(const char *key);
1220 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1222 void packet_trace_identity(const char *prog);
1224 /* add */
1226 * return 0 if success, 1 - if addition of a file failed and
1227 * ADD_FILES_IGNORE_ERRORS was specified in flags
1229 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1231 /* diff.c */
1232 extern int diff_auto_refresh_index;
1234 /* match-trees.c */
1235 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1236 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1239 * whitespace rules.
1240 * used by both diff and apply
1241 * last two digits are tab width
1243 #define WS_BLANK_AT_EOL 0100
1244 #define WS_SPACE_BEFORE_TAB 0200
1245 #define WS_INDENT_WITH_NON_TAB 0400
1246 #define WS_CR_AT_EOL 01000
1247 #define WS_BLANK_AT_EOF 02000
1248 #define WS_TAB_IN_INDENT 04000
1249 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1250 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1251 #define WS_TAB_WIDTH_MASK 077
1252 extern unsigned whitespace_rule_cfg;
1253 extern unsigned whitespace_rule(const char *);
1254 extern unsigned parse_whitespace_rule(const char *);
1255 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1256 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1257 extern char *whitespace_error_string(unsigned ws);
1258 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1259 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1260 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1262 /* ls-files */
1263 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1264 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1266 char *alias_lookup(const char *alias);
1267 int split_cmdline(char *cmdline, const char ***argv);
1268 /* Takes a negative value returned by split_cmdline */
1269 const char *split_cmdline_strerror(int cmdline_errno);
1271 /* git.c */
1272 struct startup_info {
1273 int have_repository;
1274 const char *prefix;
1276 extern struct startup_info *startup_info;
1278 /* builtin/merge.c */
1279 int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1281 int sane_execvp(const char *file, char *const argv[]);
1283 #endif /* CACHE_H */