8 #include "gpg-interface.h"
9 #include "string-list.h"
12 #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
13 #define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
14 #define GENERATION_NUMBER_MAX 0x3FFFFFFF
15 #define GENERATION_NUMBER_ZERO 0
19 struct commit_list
*next
;
23 * The size of this struct matters in full repo walk operations like
24 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
25 * to a commit instead of adding new fields here.
30 struct commit_list
*parents
;
33 * If the commit is loaded from the commit-graph file, then this
34 * member may be NULL. Only access it through get_commit_tree()
35 * or get_commit_tree_oid().
37 struct tree
*maybe_tree
;
43 extern int save_commit_buffer
;
44 extern const char *commit_type
;
46 /* While we can decorate any object with a name, it's only used for commits.. */
47 struct name_decoration
{
48 struct name_decoration
*next
;
50 char name
[FLEX_ARRAY
];
53 enum decoration_type
{
56 DECORATION_REF_REMOTE
,
63 void add_name_decoration(enum decoration_type type
, const char *name
, struct object
*obj
);
64 const struct name_decoration
*get_name_decoration(const struct object
*obj
);
66 struct commit
*lookup_commit(const struct object_id
*oid
);
67 struct commit
*lookup_commit_reference(const struct object_id
*oid
);
68 struct commit
*lookup_commit_reference_gently(const struct object_id
*oid
,
70 struct commit
*lookup_commit_reference_by_name(const char *name
);
73 * Look up object named by "oid", dereference tag as necessary,
74 * get a commit and return it. If "oid" does not dereference to
75 * a commit, use ref_name to report an error and die.
77 struct commit
*lookup_commit_or_die(const struct object_id
*oid
, const char *ref_name
);
79 int parse_commit_buffer(struct commit
*item
, const void *buffer
, unsigned long size
, int check_graph
);
80 int parse_commit_gently(struct commit
*item
, int quiet_on_missing
);
81 static inline int parse_commit(struct commit
*item
)
83 return parse_commit_gently(item
, 0);
85 void parse_commit_or_die(struct commit
*item
);
88 * Associate an object buffer with the commit. The ownership of the
89 * memory is handed over to the commit, and must be free()-able.
91 void set_commit_buffer(struct commit
*, void *buffer
, unsigned long size
);
94 * Get any cached object buffer associated with the commit. Returns NULL
95 * if none. The resulting memory should not be freed.
97 const void *get_cached_commit_buffer(const struct commit
*, unsigned long *size
);
100 * Get the commit's object contents, either from cache or by reading the object
101 * from disk. The resulting memory should not be modified, and must be given
102 * to unuse_commit_buffer when the caller is done.
104 const void *get_commit_buffer(const struct commit
*, unsigned long *size
);
107 * Tell the commit subsytem that we are done with a particular commit buffer.
108 * The commit and buffer should be the input and return value, respectively,
109 * from an earlier call to get_commit_buffer. The buffer may or may not be
110 * freed by this call; callers should not access the memory afterwards.
112 void unuse_commit_buffer(const struct commit
*, const void *buffer
);
115 * Free any cached object buffer associated with the commit.
117 void free_commit_buffer(struct commit
*);
119 struct tree
*get_commit_tree(const struct commit
*);
120 struct object_id
*get_commit_tree_oid(const struct commit
*);
123 * Disassociate any cached object buffer from the commit, but do not free it.
124 * The buffer (or NULL, if none) is returned.
126 const void *detach_commit_buffer(struct commit
*, unsigned long *sizep
);
128 /* Find beginning and length of commit subject. */
129 int find_commit_subject(const char *commit_buffer
, const char **subject
);
131 struct commit_list
*commit_list_insert(struct commit
*item
,
132 struct commit_list
**list
);
133 struct commit_list
**commit_list_append(struct commit
*commit
,
134 struct commit_list
**next
);
135 unsigned commit_list_count(const struct commit_list
*l
);
136 struct commit_list
*commit_list_insert_by_date(struct commit
*item
,
137 struct commit_list
**list
);
138 void commit_list_sort_by_date(struct commit_list
**list
);
140 /* Shallow copy of the input list */
141 struct commit_list
*copy_commit_list(struct commit_list
*list
);
143 void free_commit_list(struct commit_list
*list
);
145 struct rev_info
; /* in revision.h, it circularly uses enum cmit_fmt */
147 extern int has_non_ascii(const char *text
);
148 extern const char *logmsg_reencode(const struct commit
*commit
,
149 char **commit_encoding
,
150 const char *output_encoding
);
151 extern const char *skip_blank_lines(const char *msg
);
153 /** Removes the first commit from a list sorted by date, and adds all
156 struct commit
*pop_most_recent_commit(struct commit_list
**list
,
159 struct commit
*pop_commit(struct commit_list
**stack
);
161 void clear_commit_marks(struct commit
*commit
, unsigned int mark
);
162 void clear_commit_marks_many(int nr
, struct commit
**commit
, unsigned int mark
);
165 enum rev_sort_order
{
166 REV_SORT_IN_GRAPH_ORDER
= 0,
167 REV_SORT_BY_COMMIT_DATE
,
168 REV_SORT_BY_AUTHOR_DATE
172 * Performs an in-place topological sort of list supplied.
174 * invariant of resulting list is:
175 * a reachable from b => ord(b) < ord(a)
176 * sort_order further specifies:
177 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
179 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
181 void sort_in_topological_order(struct commit_list
**, enum rev_sort_order
);
183 struct commit_graft
{
184 struct object_id oid
;
185 int nr_parent
; /* < 0 if shallow commit */
186 struct object_id parent
[FLEX_ARRAY
]; /* more */
188 typedef int (*each_commit_graft_fn
)(const struct commit_graft
*, void *);
190 struct commit_graft
*read_graft_line(struct strbuf
*line
);
191 int register_commit_graft(struct commit_graft
*, int);
192 struct commit_graft
*lookup_commit_graft(const struct object_id
*oid
);
194 extern struct commit_list
*get_merge_bases(struct commit
*rev1
, struct commit
*rev2
);
195 extern struct commit_list
*get_merge_bases_many(struct commit
*one
, int n
, struct commit
**twos
);
196 extern struct commit_list
*get_octopus_merge_bases(struct commit_list
*in
);
198 /* To be used only when object flags after this call no longer matter */
199 extern struct commit_list
*get_merge_bases_many_dirty(struct commit
*one
, int n
, struct commit
**twos
);
201 /* largest positive number a signed 32-bit integer can contain */
202 #define INFINITE_DEPTH 0x7fffffff
206 extern int register_shallow(const struct object_id
*oid
);
207 extern int unregister_shallow(const struct object_id
*oid
);
208 extern int for_each_commit_graft(each_commit_graft_fn
, void *);
209 extern int is_repository_shallow(void);
210 extern struct commit_list
*get_shallow_commits(struct object_array
*heads
,
211 int depth
, int shallow_flag
, int not_shallow_flag
);
212 extern struct commit_list
*get_shallow_commits_by_rev_list(
213 int ac
, const char **av
, int shallow_flag
, int not_shallow_flag
);
214 extern void set_alternate_shallow_file(const char *path
, int override
);
215 extern int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
216 const struct oid_array
*extra
);
217 extern void setup_alternate_shallow(struct lock_file
*shallow_lock
,
218 const char **alternate_shallow_file
,
219 const struct oid_array
*extra
);
220 extern const char *setup_temporary_shallow(const struct oid_array
*extra
);
221 extern void advertise_shallow_grafts(int);
223 struct shallow_info
{
224 struct oid_array
*shallow
;
226 int *theirs
, nr_theirs
;
227 struct oid_array
*ref
;
229 /* for receive-pack */
230 uint32_t **used_shallow
;
231 int *need_reachability_test
;
234 struct commit
**commits
;
238 extern void prepare_shallow_info(struct shallow_info
*, struct oid_array
*);
239 extern void clear_shallow_info(struct shallow_info
*);
240 extern void remove_nonexistent_theirs_shallow(struct shallow_info
*);
241 extern void assign_shallow_commits_to_refs(struct shallow_info
*info
,
244 extern int delayed_reachability_test(struct shallow_info
*si
, int c
);
245 extern void prune_shallow(int show_only
);
246 extern struct trace_key trace_shallow
;
248 int is_descendant_of(struct commit
*, struct commit_list
*);
249 int in_merge_bases(struct commit
*, struct commit
*);
250 int in_merge_bases_many(struct commit
*, int, struct commit
**);
252 extern int interactive_add(int argc
, const char **argv
, const char *prefix
, int patch
);
253 extern int run_add_interactive(const char *revision
, const char *patch_mode
,
254 const struct pathspec
*pathspec
);
257 * Takes a list of commits and returns a new list where those
258 * have been removed that can be reached from other commits in
259 * the list. It is useful for, e.g., reducing the commits
260 * randomly thrown at the git-merge command and removing
261 * redundant commits that the user shouldn't have given to it.
263 * This function destroys the STALE bit of the commit objects'
266 extern struct commit_list
*reduce_heads(struct commit_list
*heads
);
269 * Like `reduce_heads()`, except it replaces the list. Use this
270 * instead of `foo = reduce_heads(foo);` to avoid memory leaks.
272 extern void reduce_heads_replace(struct commit_list
**heads
);
274 struct commit_extra_header
{
275 struct commit_extra_header
*next
;
281 extern void append_merge_tag_headers(struct commit_list
*parents
,
282 struct commit_extra_header
***tail
);
284 extern int commit_tree(const char *msg
, size_t msg_len
,
285 const struct object_id
*tree
,
286 struct commit_list
*parents
, struct object_id
*ret
,
287 const char *author
, const char *sign_commit
);
289 extern int commit_tree_extended(const char *msg
, size_t msg_len
,
290 const struct object_id
*tree
,
291 struct commit_list
*parents
,
292 struct object_id
*ret
, const char *author
,
293 const char *sign_commit
,
294 struct commit_extra_header
*);
296 extern struct commit_extra_header
*read_commit_extra_headers(struct commit
*, const char **);
298 extern void free_commit_extra_headers(struct commit_extra_header
*extra
);
301 * Search the commit object contents given by "msg" for the header "key".
302 * Returns a pointer to the start of the header contents, or NULL. The length
303 * of the header, up to the first newline, is returned via out_len.
305 * Note that some headers (like mergetag) may be multi-line. It is the caller's
306 * responsibility to parse further in this case!
308 extern const char *find_commit_header(const char *msg
, const char *key
,
311 /* Find the end of the log message, the right place for a new trailer. */
312 extern int ignore_non_trailer(const char *buf
, size_t len
);
314 typedef int (*each_mergetag_fn
)(struct commit
*commit
, struct commit_extra_header
*extra
,
317 extern int for_each_mergetag(each_mergetag_fn fn
, struct commit
*commit
, void *data
);
319 struct merge_remote_desc
{
320 struct object
*obj
; /* the named object, could be a tag */
321 char name
[FLEX_ARRAY
];
323 extern struct merge_remote_desc
*merge_remote_util(struct commit
*);
324 extern void set_merge_remote_desc(struct commit
*commit
,
325 const char *name
, struct object
*obj
);
328 * Given "name" from the command line to merge, find the commit object
329 * and return it, while storing merge_remote_desc in its ->util field,
330 * to allow callers to tell if we are told to merge a tag.
332 struct commit
*get_merge_parent(const char *name
);
334 extern int parse_signed_commit(const struct commit
*commit
,
335 struct strbuf
*message
, struct strbuf
*signature
);
336 extern int remove_signature(struct strbuf
*buf
);
339 * Check the signature of the given commit. The result of the check is stored
340 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
341 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
342 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
343 * sig->signer and sig->key.
345 extern int check_commit_signature(const struct commit
*commit
, struct signature_check
*sigc
);
347 int compare_commits_by_commit_date(const void *a_
, const void *b_
, void *unused
);
348 int compare_commits_by_gen_then_commit_date(const void *a_
, const void *b_
, void *unused
);
350 LAST_ARG_MUST_BE_NULL
351 extern int run_commit_hook(int editor_is_used
, const char *index_file
, const char *name
, ...);
353 #endif /* COMMIT_H */