Merge branch 'lt/case-insensitive'
[git/git.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
8 #include SHA1_HEADER
9 #include <zlib.h>
10
11 #if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
12 #define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
13 #endif
14
15 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
16 #define DTYPE(de) ((de)->d_type)
17 #else
18 #undef DT_UNKNOWN
19 #undef DT_DIR
20 #undef DT_REG
21 #undef DT_LNK
22 #define DT_UNKNOWN 0
23 #define DT_DIR 1
24 #define DT_REG 2
25 #define DT_LNK 3
26 #define DTYPE(de) DT_UNKNOWN
27 #endif
28
29 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
30 #define S_IFINVALID 0030000
31
32 /*
33 * A "directory link" is a link to another git directory.
34 *
35 * The value 0160000 is not normally a valid mode, and
36 * also just happens to be S_IFDIR + S_IFLNK
37 *
38 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
39 * always having the same values everywhere. We should use
40 * our internal git values for these things, and then we can
41 * translate that to the OS-specific value. It just so
42 * happens that everybody shares the same bit representation
43 * in the UNIX world (and apparently wider too..)
44 */
45 #define S_IFGITLINK 0160000
46 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
47
48 /*
49 * Intensive research over the course of many years has shown that
50 * port 9418 is totally unused by anything else. Or
51 *
52 * Your search - "port 9418" - did not match any documents.
53 *
54 * as www.google.com puts it.
55 *
56 * This port has been properly assigned for git use by IANA:
57 * git (Assigned-9418) [I06-050728-0001].
58 *
59 * git 9418/tcp git pack transfer service
60 * git 9418/udp git pack transfer service
61 *
62 * with Linus Torvalds <torvalds@osdl.org> as the point of
63 * contact. September 2005.
64 *
65 * See http://www.iana.org/assignments/port-numbers
66 */
67 #define DEFAULT_GIT_PORT 9418
68
69 /*
70 * Basic data structures for the directory cache
71 */
72
73 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
74 struct cache_header {
75 unsigned int hdr_signature;
76 unsigned int hdr_version;
77 unsigned int hdr_entries;
78 };
79
80 /*
81 * The "cache_time" is just the low 32 bits of the
82 * time. It doesn't matter if it overflows - we only
83 * check it for equality in the 32 bits we save.
84 */
85 struct cache_time {
86 unsigned int sec;
87 unsigned int nsec;
88 };
89
90 /*
91 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
92 * Again - this is just a (very strong in practice) heuristic that
93 * the inode hasn't changed.
94 *
95 * We save the fields in big-endian order to allow using the
96 * index file over NFS transparently.
97 */
98 struct ondisk_cache_entry {
99 struct cache_time ctime;
100 struct cache_time mtime;
101 unsigned int dev;
102 unsigned int ino;
103 unsigned int mode;
104 unsigned int uid;
105 unsigned int gid;
106 unsigned int size;
107 unsigned char sha1[20];
108 unsigned short flags;
109 char name[FLEX_ARRAY]; /* more */
110 };
111
112 struct cache_entry {
113 unsigned int ce_ctime;
114 unsigned int ce_mtime;
115 unsigned int ce_dev;
116 unsigned int ce_ino;
117 unsigned int ce_mode;
118 unsigned int ce_uid;
119 unsigned int ce_gid;
120 unsigned int ce_size;
121 unsigned int ce_flags;
122 unsigned char sha1[20];
123 struct cache_entry *next;
124 char name[FLEX_ARRAY]; /* more */
125 };
126
127 #define CE_NAMEMASK (0x0fff)
128 #define CE_STAGEMASK (0x3000)
129 #define CE_VALID (0x8000)
130 #define CE_STAGESHIFT 12
131
132 /* In-memory only */
133 #define CE_UPDATE (0x10000)
134 #define CE_REMOVE (0x20000)
135 #define CE_UPTODATE (0x40000)
136 #define CE_ADDED (0x80000)
137
138 #define CE_HASHED (0x100000)
139 #define CE_UNHASHED (0x200000)
140
141 /*
142 * Copy the sha1 and stat state of a cache entry from one to
143 * another. But we never change the name, or the hash state!
144 */
145 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
146 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
147 {
148 unsigned int state = dst->ce_flags & CE_STATE_MASK;
149
150 /* Don't copy hash chain and name */
151 memcpy(dst, src, offsetof(struct cache_entry, next));
152
153 /* Restore the hash state */
154 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
155 }
156
157 static inline unsigned create_ce_flags(size_t len, unsigned stage)
158 {
159 if (len >= CE_NAMEMASK)
160 len = CE_NAMEMASK;
161 return (len | (stage << CE_STAGESHIFT));
162 }
163
164 static inline size_t ce_namelen(const struct cache_entry *ce)
165 {
166 size_t len = ce->ce_flags & CE_NAMEMASK;
167 if (len < CE_NAMEMASK)
168 return len;
169 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
170 }
171
172 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
173 #define ondisk_ce_size(ce) ondisk_cache_entry_size(ce_namelen(ce))
174 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
175 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
176 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
177
178 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
179 static inline unsigned int create_ce_mode(unsigned int mode)
180 {
181 if (S_ISLNK(mode))
182 return S_IFLNK;
183 if (S_ISDIR(mode) || S_ISGITLINK(mode))
184 return S_IFGITLINK;
185 return S_IFREG | ce_permissions(mode);
186 }
187 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
188 {
189 extern int trust_executable_bit, has_symlinks;
190 if (!has_symlinks && S_ISREG(mode) &&
191 ce && S_ISLNK(ce->ce_mode))
192 return ce->ce_mode;
193 if (!trust_executable_bit && S_ISREG(mode)) {
194 if (ce && S_ISREG(ce->ce_mode))
195 return ce->ce_mode;
196 return create_ce_mode(0666);
197 }
198 return create_ce_mode(mode);
199 }
200 static inline int ce_to_dtype(const struct cache_entry *ce)
201 {
202 unsigned ce_mode = ntohl(ce->ce_mode);
203 if (S_ISREG(ce_mode))
204 return DT_REG;
205 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
206 return DT_DIR;
207 else if (S_ISLNK(ce_mode))
208 return DT_LNK;
209 else
210 return DT_UNKNOWN;
211 }
212 #define canon_mode(mode) \
213 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
214 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
215
216 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
217 #define ondisk_cache_entry_size(len) ((offsetof(struct ondisk_cache_entry,name) + (len) + 8) & ~7)
218
219 struct index_state {
220 struct cache_entry **cache;
221 unsigned int cache_nr, cache_alloc, cache_changed;
222 struct cache_tree *cache_tree;
223 time_t timestamp;
224 void *alloc;
225 unsigned name_hash_initialized : 1;
226 struct hash_table name_hash;
227 };
228
229 extern struct index_state the_index;
230
231 /* Name hashing */
232 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
233 /*
234 * We don't actually *remove* it, we can just mark it invalid so that
235 * we won't find it in lookups.
236 *
237 * Not only would we have to search the lists (simple enough), but
238 * we'd also have to rehash other hash buckets in case this makes the
239 * hash bucket empty (common). So it's much better to just mark
240 * it.
241 */
242 static inline void remove_name_hash(struct cache_entry *ce)
243 {
244 ce->ce_flags |= CE_UNHASHED;
245 }
246
247
248 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
249 #define active_cache (the_index.cache)
250 #define active_nr (the_index.cache_nr)
251 #define active_alloc (the_index.cache_alloc)
252 #define active_cache_changed (the_index.cache_changed)
253 #define active_cache_tree (the_index.cache_tree)
254
255 #define read_cache() read_index(&the_index)
256 #define read_cache_from(path) read_index_from(&the_index, (path))
257 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
258 #define discard_cache() discard_index(&the_index)
259 #define unmerged_cache() unmerged_index(&the_index)
260 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
261 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
262 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
263 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
264 #define add_file_to_cache(path, verbose) add_file_to_index(&the_index, (path), (verbose))
265 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
266 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
267 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
268 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
269 #endif
270
271 enum object_type {
272 OBJ_BAD = -1,
273 OBJ_NONE = 0,
274 OBJ_COMMIT = 1,
275 OBJ_TREE = 2,
276 OBJ_BLOB = 3,
277 OBJ_TAG = 4,
278 /* 5 for future expansion */
279 OBJ_OFS_DELTA = 6,
280 OBJ_REF_DELTA = 7,
281 OBJ_ANY,
282 OBJ_MAX,
283 };
284
285 static inline enum object_type object_type(unsigned int mode)
286 {
287 return S_ISDIR(mode) ? OBJ_TREE :
288 S_ISGITLINK(mode) ? OBJ_COMMIT :
289 OBJ_BLOB;
290 }
291
292 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
293 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
294 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
295 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
296 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
297 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
298 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
299 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
300 #define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
301 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
302 #define GITATTRIBUTES_FILE ".gitattributes"
303 #define INFOATTRIBUTES_FILE "info/attributes"
304 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
305
306 extern int is_bare_repository_cfg;
307 extern int is_bare_repository(void);
308 extern int is_inside_git_dir(void);
309 extern char *git_work_tree_cfg;
310 extern int is_inside_work_tree(void);
311 extern const char *get_git_dir(void);
312 extern char *get_object_directory(void);
313 extern char *get_refs_directory(void);
314 extern char *get_index_file(void);
315 extern char *get_graft_file(void);
316 extern int set_git_dir(const char *path);
317 extern const char *get_git_work_tree(void);
318 extern const char *read_gitfile_gently(const char *path);
319
320 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
321
322 extern const char **get_pathspec(const char *prefix, const char **pathspec);
323 extern void setup_work_tree(void);
324 extern const char *setup_git_directory_gently(int *);
325 extern const char *setup_git_directory(void);
326 extern const char *prefix_path(const char *prefix, int len, const char *path);
327 extern const char *prefix_filename(const char *prefix, int len, const char *path);
328 extern void verify_filename(const char *prefix, const char *name);
329 extern void verify_non_filename(const char *prefix, const char *name);
330
331 #define alloc_nr(x) (((x)+16)*3/2)
332
333 /*
334 * Realloc the buffer pointed at by variable 'x' so that it can hold
335 * at least 'nr' entries; the number of entries currently allocated
336 * is 'alloc', using the standard growing factor alloc_nr() macro.
337 *
338 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
339 */
340 #define ALLOC_GROW(x, nr, alloc) \
341 do { \
342 if ((nr) > alloc) { \
343 if (alloc_nr(alloc) < (nr)) \
344 alloc = (nr); \
345 else \
346 alloc = alloc_nr(alloc); \
347 x = xrealloc((x), alloc * sizeof(*(x))); \
348 } \
349 } while(0)
350
351 /* Initialize and use the cache information */
352 extern int read_index(struct index_state *);
353 extern int read_index_from(struct index_state *, const char *path);
354 extern int write_index(const struct index_state *, int newfd);
355 extern int discard_index(struct index_state *);
356 extern int unmerged_index(const struct index_state *);
357 extern int verify_path(const char *path);
358 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
359 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
360 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
361 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
362 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
363 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
364 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
365 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
366 extern int remove_index_entry_at(struct index_state *, int pos);
367 extern int remove_file_from_index(struct index_state *, const char *path);
368 extern int add_file_to_index(struct index_state *, const char *path, int verbose);
369 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
370 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
371
372 /* do stat comparison even if CE_VALID is true */
373 #define CE_MATCH_IGNORE_VALID 01
374 /* do not check the contents but report dirty on racily-clean entries */
375 #define CE_MATCH_RACY_IS_DIRTY 02
376 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
377 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
378
379 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
380 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
381 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
382 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
383 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
384
385 #define REFRESH_REALLY 0x0001 /* ignore_valid */
386 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
387 #define REFRESH_QUIET 0x0004 /* be quiet about it */
388 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
389 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
390
391 struct lock_file {
392 struct lock_file *next;
393 int fd;
394 pid_t owner;
395 char on_list;
396 char filename[PATH_MAX];
397 };
398 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
399 extern int commit_lock_file(struct lock_file *);
400
401 extern int hold_locked_index(struct lock_file *, int);
402 extern int commit_locked_index(struct lock_file *);
403 extern void set_alternate_index_output(const char *);
404 extern int close_lock_file(struct lock_file *);
405 extern void rollback_lock_file(struct lock_file *);
406 extern int delete_ref(const char *, const unsigned char *sha1);
407
408 /* Environment bits from configuration mechanism */
409 extern int trust_executable_bit;
410 extern int quote_path_fully;
411 extern int has_symlinks;
412 extern int ignore_case;
413 extern int assume_unchanged;
414 extern int prefer_symlink_refs;
415 extern int log_all_ref_updates;
416 extern int warn_ambiguous_refs;
417 extern int shared_repository;
418 extern const char *apply_default_whitespace;
419 extern int zlib_compression_level;
420 extern int core_compression_level;
421 extern int core_compression_seen;
422 extern size_t packed_git_window_size;
423 extern size_t packed_git_limit;
424 extern size_t delta_base_cache_limit;
425 extern int auto_crlf;
426
427 enum safe_crlf {
428 SAFE_CRLF_FALSE = 0,
429 SAFE_CRLF_FAIL = 1,
430 SAFE_CRLF_WARN = 2,
431 };
432
433 extern enum safe_crlf safe_crlf;
434
435 enum branch_track {
436 BRANCH_TRACK_NEVER = 0,
437 BRANCH_TRACK_REMOTE,
438 BRANCH_TRACK_ALWAYS,
439 BRANCH_TRACK_EXPLICIT,
440 };
441
442 extern enum branch_track git_branch_track;
443
444 #define GIT_REPO_VERSION 0
445 extern int repository_format_version;
446 extern int check_repository_format(void);
447
448 #define MTIME_CHANGED 0x0001
449 #define CTIME_CHANGED 0x0002
450 #define OWNER_CHANGED 0x0004
451 #define MODE_CHANGED 0x0008
452 #define INODE_CHANGED 0x0010
453 #define DATA_CHANGED 0x0020
454 #define TYPE_CHANGED 0x0040
455
456 /* Return a statically allocated filename matching the sha1 signature */
457 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
458 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
459 extern char *sha1_file_name(const unsigned char *sha1);
460 extern char *sha1_pack_name(const unsigned char *sha1);
461 extern char *sha1_pack_index_name(const unsigned char *sha1);
462 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
463 extern const unsigned char null_sha1[20];
464 static inline int is_null_sha1(const unsigned char *sha1)
465 {
466 return !memcmp(sha1, null_sha1, 20);
467 }
468 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
469 {
470 return memcmp(sha1, sha2, 20);
471 }
472 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
473 {
474 memcpy(sha_dst, sha_src, 20);
475 }
476 static inline void hashclr(unsigned char *hash)
477 {
478 memset(hash, 0, 20);
479 }
480
481 int git_mkstemp(char *path, size_t n, const char *template);
482
483 /*
484 * NOTE NOTE NOTE!!
485 *
486 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
487 * not be changed. Old repositories have core.sharedrepository written in
488 * numeric format, and therefore these values are preserved for compatibility
489 * reasons.
490 */
491 enum sharedrepo {
492 PERM_UMASK = 0,
493 OLD_PERM_GROUP = 1,
494 OLD_PERM_EVERYBODY = 2,
495 PERM_GROUP = 0660,
496 PERM_EVERYBODY = 0664,
497 };
498 int git_config_perm(const char *var, const char *value);
499 int adjust_shared_perm(const char *path);
500 int safe_create_leading_directories(char *path);
501 char *enter_repo(char *path, int strict);
502 static inline int is_absolute_path(const char *path)
503 {
504 return path[0] == '/';
505 }
506 const char *make_absolute_path(const char *path);
507
508 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
509 extern int sha1_object_info(const unsigned char *, unsigned long *);
510 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
511 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
512 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
513 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
514
515 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
516
517 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
518 size_t bufsize, size_t *bufposn);
519 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
520 extern int move_temp_to_file(const char *tmpfile, const char *filename);
521
522 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
523 extern int has_sha1_file(const unsigned char *sha1);
524
525 extern int has_pack_file(const unsigned char *sha1);
526 extern int has_pack_index(const unsigned char *sha1);
527
528 extern const signed char hexval_table[256];
529 static inline unsigned int hexval(unsigned char c)
530 {
531 return hexval_table[c];
532 }
533
534 /* Convert to/from hex/sha1 representation */
535 #define MINIMUM_ABBREV 4
536 #define DEFAULT_ABBREV 7
537
538 extern int get_sha1(const char *str, unsigned char *sha1);
539 extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
540 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
541 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
542 extern int read_ref(const char *filename, unsigned char *sha1);
543 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
544 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
545 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
546
547 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
548 extern const char *ref_rev_parse_rules[];
549 extern const char *ref_fetch_rules[];
550
551 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
552 extern int validate_headref(const char *ref);
553
554 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
555 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
556 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
557
558 extern void *read_object_with_reference(const unsigned char *sha1,
559 const char *required_type,
560 unsigned long *size,
561 unsigned char *sha1_ret);
562
563 extern struct object *peel_to_type(const char *name, int namelen,
564 struct object *o, enum object_type);
565
566 enum date_mode {
567 DATE_NORMAL = 0,
568 DATE_RELATIVE,
569 DATE_SHORT,
570 DATE_LOCAL,
571 DATE_ISO8601,
572 DATE_RFC2822
573 };
574
575 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
576 int parse_date(const char *date, char *buf, int bufsize);
577 void datestamp(char *buf, int bufsize);
578 unsigned long approxidate(const char *);
579 enum date_mode parse_date_format(const char *format);
580
581 #define IDENT_WARN_ON_NO_NAME 1
582 #define IDENT_ERROR_ON_NO_NAME 2
583 #define IDENT_NO_DATE 4
584 extern const char *git_author_info(int);
585 extern const char *git_committer_info(int);
586 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
587 extern const char *fmt_name(const char *name, const char *email);
588
589 struct checkout {
590 const char *base_dir;
591 int base_dir_len;
592 unsigned force:1,
593 quiet:1,
594 not_new:1,
595 refresh_cache:1;
596 };
597
598 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
599 extern int has_symlink_leading_path(const char *name, char *last_symlink);
600
601 extern struct alternate_object_database {
602 struct alternate_object_database *next;
603 char *name;
604 char base[FLEX_ARRAY]; /* more */
605 } *alt_odb_list;
606 extern void prepare_alt_odb(void);
607
608 struct pack_window {
609 struct pack_window *next;
610 unsigned char *base;
611 off_t offset;
612 size_t len;
613 unsigned int last_used;
614 unsigned int inuse_cnt;
615 };
616
617 extern struct packed_git {
618 struct packed_git *next;
619 struct pack_window *windows;
620 off_t pack_size;
621 const void *index_data;
622 size_t index_size;
623 uint32_t num_objects;
624 int index_version;
625 time_t mtime;
626 int pack_fd;
627 int pack_local;
628 unsigned char sha1[20];
629 /* something like ".git/objects/pack/xxxxx.pack" */
630 char pack_name[FLEX_ARRAY]; /* more */
631 } *packed_git;
632
633 struct pack_entry {
634 off_t offset;
635 unsigned char sha1[20];
636 struct packed_git *p;
637 };
638
639 struct ref {
640 struct ref *next;
641 unsigned char old_sha1[20];
642 unsigned char new_sha1[20];
643 char *symref;
644 unsigned int force:1,
645 merge:1,
646 nonfastforward:1,
647 deletion:1;
648 enum {
649 REF_STATUS_NONE = 0,
650 REF_STATUS_OK,
651 REF_STATUS_REJECT_NONFASTFORWARD,
652 REF_STATUS_REJECT_NODELETE,
653 REF_STATUS_UPTODATE,
654 REF_STATUS_REMOTE_REJECT,
655 REF_STATUS_EXPECTING_REPORT,
656 } status;
657 char *remote_status;
658 struct ref *peer_ref; /* when renaming */
659 char name[FLEX_ARRAY]; /* more */
660 };
661
662 #define REF_NORMAL (1u << 0)
663 #define REF_HEADS (1u << 1)
664 #define REF_TAGS (1u << 2)
665
666 extern struct ref *find_ref_by_name(struct ref *list, const char *name);
667
668 #define CONNECT_VERBOSE (1u << 0)
669 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
670 extern int finish_connect(struct child_process *conn);
671 extern int path_match(const char *path, int nr, char **match);
672 extern int get_ack(int fd, unsigned char *result_sha1);
673 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
674 extern int server_supports(const char *feature);
675
676 extern struct packed_git *parse_pack_index(unsigned char *sha1);
677 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
678 const char *idx_path);
679
680 extern void prepare_packed_git(void);
681 extern void reprepare_packed_git(void);
682 extern void install_packed_git(struct packed_git *pack);
683
684 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
685 struct packed_git *packs);
686
687 extern void pack_report(void);
688 extern int open_pack_index(struct packed_git *);
689 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
690 extern void close_pack_windows(struct packed_git *);
691 extern void unuse_pack(struct pack_window **);
692 extern struct packed_git *add_packed_git(const char *, int, int);
693 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
694 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
695 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
696 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
697 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
698 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
699 extern int matches_pack_name(struct packed_git *p, const char *name);
700
701 /* Dumb servers support */
702 extern int update_server_info(int);
703
704 typedef int (*config_fn_t)(const char *, const char *);
705 extern int git_default_config(const char *, const char *);
706 extern int git_config_from_file(config_fn_t fn, const char *);
707 extern int git_config(config_fn_t fn);
708 extern int git_parse_long(const char *, long *);
709 extern int git_parse_ulong(const char *, unsigned long *);
710 extern int git_config_int(const char *, const char *);
711 extern unsigned long git_config_ulong(const char *, const char *);
712 extern int git_config_bool_or_int(const char *, const char *, int *);
713 extern int git_config_bool(const char *, const char *);
714 extern int git_config_string(const char **, const char *, const char *);
715 extern int git_config_set(const char *, const char *);
716 extern int git_config_set_multivar(const char *, const char *, const char *, int);
717 extern int git_config_rename_section(const char *, const char *);
718 extern const char *git_etc_gitconfig(void);
719 extern int check_repository_format_version(const char *var, const char *value);
720 extern int git_env_bool(const char *, int);
721 extern int git_config_system(void);
722 extern int git_config_global(void);
723 extern int config_error_nonbool(const char *);
724
725 #define MAX_GITNAME (1000)
726 extern char git_default_email[MAX_GITNAME];
727 extern char git_default_name[MAX_GITNAME];
728
729 extern const char *git_commit_encoding;
730 extern const char *git_log_output_encoding;
731
732 /* IO helper functions */
733 extern void maybe_flush_or_die(FILE *, const char *);
734 extern int copy_fd(int ifd, int ofd);
735 extern int copy_file(const char *dst, const char *src, int mode);
736 extern ssize_t read_in_full(int fd, void *buf, size_t count);
737 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
738 extern void write_or_die(int fd, const void *buf, size_t count);
739 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
740 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
741
742 /* pager.c */
743 extern void setup_pager(void);
744 extern const char *pager_program;
745 extern int pager_in_use(void);
746 extern int pager_use_color;
747
748 extern const char *editor_program;
749 extern const char *excludes_file;
750
751 /* base85 */
752 int decode_85(char *dst, const char *line, int linelen);
753 void encode_85(char *buf, const unsigned char *data, int bytes);
754
755 /* alloc.c */
756 extern void *alloc_blob_node(void);
757 extern void *alloc_tree_node(void);
758 extern void *alloc_commit_node(void);
759 extern void *alloc_tag_node(void);
760 extern void *alloc_object_node(void);
761 extern void alloc_report(void);
762
763 /* trace.c */
764 extern void trace_printf(const char *format, ...);
765 extern void trace_argv_printf(const char **argv, const char *format, ...);
766
767 /* convert.c */
768 /* returns 1 if *dst was used */
769 extern int convert_to_git(const char *path, const char *src, size_t len,
770 struct strbuf *dst, enum safe_crlf checksafe);
771 extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
772
773 /* add */
774 void add_files_to_cache(int verbose, const char *prefix, const char **pathspec);
775
776 /* diff.c */
777 extern int diff_auto_refresh_index;
778
779 /* match-trees.c */
780 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
781
782 /*
783 * whitespace rules.
784 * used by both diff and apply
785 */
786 #define WS_TRAILING_SPACE 01
787 #define WS_SPACE_BEFORE_TAB 02
788 #define WS_INDENT_WITH_NON_TAB 04
789 #define WS_CR_AT_EOL 010
790 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
791 extern unsigned whitespace_rule_cfg;
792 extern unsigned whitespace_rule(const char *);
793 extern unsigned parse_whitespace_rule(const char *);
794 extern unsigned check_and_emit_line(const char *line, int len, unsigned ws_rule,
795 FILE *stream, const char *set,
796 const char *reset, const char *ws);
797 extern char *whitespace_error_string(unsigned ws);
798 extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
799
800 /* ls-files */
801 int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
802 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
803 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
804
805 char *alias_lookup(const char *alias);
806
807 #endif /* CACHE_H */