list-objects-filter.h

   1 #ifndef LIST_OBJECTS_FILTER_H
   2 #define LIST_OBJECTS_FILTER_H
   3
   4 /*
   5  * During list-object traversal we allow certain objects to be
   6  * filtered (omitted) from the result.  The active filter uses
   7  * these result values to guide list-objects.
   8  *
   9  * _ZERO      : Do nothing with the object at this time.  It may
  10  *              be revisited if it appears in another place in
  11  *              the tree or in another commit during the overall
  12  *              traversal.
  13  *
  14  * _MARK_SEEN : Mark this object as "SEEN" in the object flags.
  15  *              This will prevent it from being revisited during
  16  *              the remainder of the traversal.  This DOES NOT
  17  *              imply that it will be included in the results.
  18  *
  19  * _DO_SHOW   : Show this object in the results (call show() on it).
  20  *              In general, objects should only be shown once, but
  21  *              this result DOES NOT imply that we mark it SEEN.
  22  *
  23  * Most of the time, you want the combination (_MARK_SEEN | _DO_SHOW)
  24  * but they can be used independently, such as when sparse-checkout
  25  * pattern matching is being applied.
  26  *
  27  * A _MARK_SEEN without _DO_SHOW can be called a hard-omit -- the
  28  * object is not shown and will never be reconsidered (unless a
  29  * previous iteration has already shown it).
  30  *
  31  * A _DO_SHOW without _MARK_SEEN can be used, for example, to
  32  * include a directory, but then revisit it to selectively include
  33  * or omit objects within it.
  34  *
  35  * A _ZERO can be called a provisional-omit -- the object is NOT shown,
  36  * but *may* be revisited (if the object appears again in the traversal).
  37  * Therefore, it will be omitted from the results *unless* a later
  38  * iteration causes it to be shown.
  39  */
  40 enum list_objects_filter_result {
  41         LOFR_ZERO      = 0,
  42         LOFR_MARK_SEEN = 1<<0,
  43         LOFR_DO_SHOW   = 1<<1,
  44 };
  45
  46 enum list_objects_filter_situation {
  47         LOFS_BEGIN_TREE,
  48         LOFS_END_TREE,
  49         LOFS_BLOB
  50 };
  51
  52 typedef enum list_objects_filter_result (*filter_object_fn)(
  53         enum list_objects_filter_situation filter_situation,
  54         struct object *obj,
  55         const char *pathname,
  56         const char *filename,
  57         void *filter_data);
  58
  59 typedef void (*filter_free_fn)(void *filter_data);
  60
  61 /*
  62  * Constructor for the set of defined list-objects filters.
  63  * Returns a generic "void *filter_data".
  64  *
  65  * The returned "filter_fn" will be used by traverse_commit_list()
  66  * to filter the results.
  67  *
  68  * The returned "filter_free_fn" is a destructor for the
  69  * filter_data.
  70  */
  71 void *list_objects_filter__init(
  72         struct oidset *omitted,
  73         struct list_objects_filter_options *filter_options,
  74         filter_object_fn *filter_fn,
  75         filter_free_fn *filter_free_fn);
  76
  77 #endif /* LIST_OBJECTS_FILTER_H */