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