commit-reach.h

   1 #ifndef COMMIT_REACH_H
   2 #define COMMIT_REACH_H
   3
   4 #include "commit.h"
   5 #include "commit-slab.h"
   6
   7 struct commit_list;
   8 struct ref_filter;
   9 struct object_id;
  10 struct object_array;
  11
  12 struct commit_list *repo_get_merge_bases(struct repository *r,
  13                                          struct commit *rev1,
  14                                          struct commit *rev2);
  15 struct commit_list *repo_get_merge_bases_many(struct repository *r,
  16                                               struct commit *one, int n,
  17                                               struct commit **twos);
  18 /* To be used only when object flags after this call no longer matter */
  19 struct commit_list *repo_get_merge_bases_many_dirty(struct repository *r,
  20                                                     struct commit *one, int n,
  21                                                     struct commit **twos);
  22
  23 struct commit_list *get_octopus_merge_bases(struct commit_list *in);
  24
  25 int repo_is_descendant_of(struct repository *r,
  26                           struct commit *commit,
  27                           struct commit_list *with_commit);
  28 int repo_in_merge_bases(struct repository *r,
  29                         struct commit *commit,
  30                         struct commit *reference);
  31 int repo_in_merge_bases_many(struct repository *r,
  32                              struct commit *commit,
  33                              int nr_reference, struct commit **reference,
  34                              int ignore_missing_commits);
  35
  36 /*
  37  * Takes a list of commits and returns a new list where those
  38  * have been removed that can be reached from other commits in
  39  * the list. It is useful for, e.g., reducing the commits
  40  * randomly thrown at the git-merge command and removing
  41  * redundant commits that the user shouldn't have given to it.
  42  *
  43  * This function destroys the STALE bit of the commit objects'
  44  * flags.
  45  */
  46 struct commit_list *reduce_heads(struct commit_list *heads);
  47
  48 /*
  49  * Like `reduce_heads()`, except it replaces the list. Use this
  50  * instead of `foo = reduce_heads(foo);` to avoid memory leaks.
  51  */
  52 void reduce_heads_replace(struct commit_list **heads);
  53
  54 int ref_newer(const struct object_id *new_oid, const struct object_id *old_oid);
  55
  56 /*
  57  * Unknown has to be "0" here, because that's the default value for
  58  * contains_cache slab entries that have not yet been assigned.
  59  */
  60 enum contains_result {
  61         CONTAINS_UNKNOWN = 0,
  62         CONTAINS_NO,
  63         CONTAINS_YES
  64 };
  65
  66 define_commit_slab(contains_cache, enum contains_result);
  67
  68 int commit_contains(struct ref_filter *filter, struct commit *commit,
  69                     struct commit_list *list, struct contains_cache *cache);
  70
  71 /*
  72  * Determine if every commit in 'from' can reach at least one commit
  73  * that is marked with 'with_flag'. As we traverse, use 'assign_flag'
  74  * as a marker for commits that are already visited. Do not walk
  75  * commits with date below 'min_commit_date' or generation below
  76  * 'min_generation'.
  77  */
  78 int can_all_from_reach_with_flag(struct object_array *from,
  79                                  unsigned int with_flag,
  80                                  unsigned int assign_flag,
  81                                  time_t min_commit_date,
  82                                  timestamp_t min_generation);
  83 int can_all_from_reach(struct commit_list *from, struct commit_list *to,
  84                        int commit_date_cutoff);
  85
  86
  87 /*
  88  * Return a list of commits containing the commits in the 'to' array
  89  * that are reachable from at least one commit in the 'from' array.
  90  * Also add the given 'flag' to each of the commits in the returned list.
  91  *
  92  * This method uses the PARENT1 and PARENT2 flags during its operation,
  93  * so be sure these flags are not set before calling the method.
  94  */
  95 struct commit_list *get_reachable_subset(struct commit **from, int nr_from,
  96                                          struct commit **to, int nr_to,
  97                                          unsigned int reachable_flag);
  98
  99 struct ahead_behind_count {
 100         /**
 101          * As input, the *_index members indicate which positions in
 102          * the 'tips' array correspond to the tip and base of this
 103          * comparison.
 104          */
 105         size_t tip_index;
 106         size_t base_index;
 107
 108         /**
 109          * These values store the computed counts for each side of the
 110          * symmetric difference:
 111          *
 112          * 'ahead' stores the number of commits reachable from the tip
 113          * and not reachable from the base.
 114          *
 115          * 'behind' stores the number of commits reachable from the base
 116          * and not reachable from the tip.
 117          */
 118         unsigned int ahead;
 119         unsigned int behind;
 120 };
 121
 122 /*
 123  * Given an array of commits and an array of ahead_behind_count pairs,
 124  * compute the ahead/behind counts for each pair.
 125  */
 126 void ahead_behind(struct repository *r,
 127                   struct commit **commits, size_t commits_nr,
 128                   struct ahead_behind_count *counts, size_t counts_nr);
 129
 130 /*
 131  * For all tip commits, add 'mark' to their flags if and only if they
 132  * are reachable from one of the commits in 'bases'.
 133  */
 134 void tips_reachable_from_bases(struct repository *r,
 135                                struct commit_list *bases,
 136                                struct commit **tips, size_t tips_nr,
 137                                int mark);
 138
 139 #endif