Sync with maint

[thirdparty/git.git] / fsck.h

diff --git a/fsck.h b/fsck.h
index b95595ae5fee6c065c4f54ad66ddc0edb8824d37..69cf715e798ce29085b529b88374c5de75e69529 100644 (file)
--- a/fsck.h
+++ b/fsck.h
@@ -27,10 +27,12 @@ typedef int (*fsck_walk_func)(struct object *obj, int type, void *data, struct f
 
 /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
 typedef int (*fsck_error)(struct fsck_options *o,
-       struct object *obj, int type, const char *message);
+                         const struct object_id *oid, enum object_type object_type,
+                         int msg_type, const char *message);
 
 int fsck_error_function(struct fsck_options *o,
-       struct object *obj, int type, const char *message);
+                       const struct object_id *oid, enum object_type object_type,
+                       int msg_type, const char *message);
 
 struct fsck_options {
        fsck_walk_func walk;
@@ -38,7 +40,7 @@ struct fsck_options {
        unsigned strict:1;
        int *msg_type;
        struct oidset skiplist;
-       struct decoration *object_names;
+       kh_oid_map_t *object_names;
 };
 
 #define FSCK_OPTIONS_DEFAULT { NULL, fsck_error_function, 0, NULL, OIDSET_INIT }
@@ -52,7 +54,11 @@ struct fsck_options {
  *    0                everything OK
  */
 int fsck_walk(struct object *obj, void *data, struct fsck_options *options);
-/* If NULL is passed for data, we assume the object is local and read it. */
+
+/*
+ * Blob objects my pass a NULL data pointer, which indicates they are too large
+ * to fit in memory. All other types must pass a real buffer.
+ */
 int fsck_object(struct object *obj, void *data, unsigned long size,
        struct fsck_options *options);
 
@@ -63,4 +69,29 @@ int fsck_object(struct object *obj, void *data, unsigned long size,
  */
 int fsck_finish(struct fsck_options *options);
 
+/*
+ * Subsystem for storing human-readable names for each object.
+ *
+ * If fsck_enable_object_names() has not been called, all other functions are
+ * noops.
+ *
+ * Use fsck_put_object_name() to seed initial names (e.g. from refnames); the
+ * fsck code will extend that while walking trees, etc.
+ *
+ * Use fsck_get_object_name() to get a single name (or NULL if none). Or the
+ * more convenient describe_object(), which always produces an output string
+ * with the oid combined with the name (if any). Note that the return value
+ * points to a rotating array of static buffers, and may be invalidated by a
+ * subsequent call.
+ */
+void fsck_enable_object_names(struct fsck_options *options);
+const char *fsck_get_object_name(struct fsck_options *options,
+                                const struct object_id *oid);
+__attribute__((format (printf,3,4)))
+void fsck_put_object_name(struct fsck_options *options,
+                         const struct object_id *oid,
+                         const char *fmt, ...);
+const char *fsck_describe_object(struct fsck_options *options,
+                                const struct object_id *oid);
+
 #endif