Merge branch 'bn/config-doc-tt-varnames'
[git] / fsck.h
1 #ifndef GIT_FSCK_H
2 #define GIT_FSCK_H
3
4 #define FSCK_ERROR 1
5 #define FSCK_WARN 2
6 #define FSCK_IGNORE 3
7
8 struct fsck_options;
9
10 void fsck_set_msg_type(struct fsck_options *options,
11                 const char *msg_id, const char *msg_type);
12 void fsck_set_msg_types(struct fsck_options *options, const char *values);
13 int is_valid_msg_type(const char *msg_id, const char *msg_type);
14
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  */
23 typedef int (*fsck_walk_func)(struct object *obj, int type, void *data, struct fsck_options *options);
24
25 /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
26 typedef int (*fsck_error)(struct object *obj, int type, const char *message);
27
28 int fsck_error_function(struct object *obj, int type, const char *message);
29
30 struct fsck_options {
31         fsck_walk_func walk;
32         fsck_error error_func;
33         unsigned strict:1;
34         int *msg_type;
35         struct sha1_array *skiplist;
36 };
37
38 #define FSCK_OPTIONS_DEFAULT { NULL, fsck_error_function, 0, NULL }
39 #define FSCK_OPTIONS_STRICT { NULL, fsck_error_function, 1, NULL }
40
41 /* descend in all linked child objects
42  * the return value is:
43  *    -1        error in processing the object
44  *    <0        return value of the callback, which lead to an abort
45  *    >0        return value of the first signaled error >0 (in the case of no other errors)
46  *    0         everything OK
47  */
48 int fsck_walk(struct object *obj, void *data, struct fsck_options *options);
49 /* If NULL is passed for data, we assume the object is local and read it. */
50 int fsck_object(struct object *obj, void *data, unsigned long size,
51         struct fsck_options *options);
52
53 #endif