fsck_walk(): optionally name objects on the go
[git/git.git] / fsck.h
CommitLineData
355885d5
MK
1#ifndef GIT_FSCK_H
2#define GIT_FSCK_H
3
ba002f3b
MK
4#define FSCK_ERROR 1
5#define FSCK_WARN 2
efaba7cc 6#define FSCK_IGNORE 3
ba002f3b 7
22410549
JS
8struct fsck_options;
9
0282f4dc
JS
10void fsck_set_msg_type(struct fsck_options *options,
11 const char *msg_id, const char *msg_type);
12void fsck_set_msg_types(struct fsck_options *options, const char *values);
5d477a33 13int is_valid_msg_type(const char *msg_id, const char *msg_type);
0282f4dc 14
355885d5
MK
15/*
16 * callback function for fsck_walk
17 * type is the expected type of the object or OBJ_ANY
18 * the return value is:
19 * 0 everything OK
20 * <0 error signaled and abort
21 * >0 error signaled and do not abort
22 */
22410549 23typedef int (*fsck_walk_func)(struct object *obj, int type, void *data, struct fsck_options *options);
355885d5 24
ba002f3b 25/* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
c99ba492 26typedef int (*fsck_error)(struct object *obj, int type, const char *message);
ba002f3b 27
c99ba492 28int fsck_error_function(struct object *obj, int type, const char *message);
d6ffc8d7 29
22410549
JS
30struct fsck_options {
31 fsck_walk_func walk;
32 fsck_error error_func;
33 unsigned strict:1;
0282f4dc 34 int *msg_type;
cd94c6f9 35 struct sha1_array *skiplist;
7b35efd7 36 struct decoration *object_names;
22410549
JS
37};
38
0282f4dc
JS
39#define FSCK_OPTIONS_DEFAULT { NULL, fsck_error_function, 0, NULL }
40#define FSCK_OPTIONS_STRICT { NULL, fsck_error_function, 1, NULL }
22410549 41
355885d5
MK
42/* descend in all linked child objects
43 * the return value is:
44 * -1 error in processing the object
45 * <0 return value of the callback, which lead to an abort
3ea3c215 46 * >0 return value of the first signaled error >0 (in the case of no other errors)
355885d5
MK
47 * 0 everything OK
48 */
22410549 49int fsck_walk(struct object *obj, void *data, struct fsck_options *options);
90a398bb
JS
50/* If NULL is passed for data, we assume the object is local and read it. */
51int fsck_object(struct object *obj, void *data, unsigned long size,
22410549 52 struct fsck_options *options);
355885d5
MK
53
54#endif