1 e67369ac 2018-06-22 stsp /*
 2 e67369ac 2018-06-22 stsp  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
 3 e67369ac 2018-06-22 stsp  *
 4 e67369ac 2018-06-22 stsp  * Permission to use, copy, modify, and distribute this software for any
 5 e67369ac 2018-06-22 stsp  * purpose with or without fee is hereby granted, provided that the above
 6 e67369ac 2018-06-22 stsp  * copyright notice and this permission notice appear in all copies.
 7 e67369ac 2018-06-22 stsp  *
 8 e67369ac 2018-06-22 stsp  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 9 e67369ac 2018-06-22 stsp  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 e67369ac 2018-06-22 stsp  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 e67369ac 2018-06-22 stsp  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 e67369ac 2018-06-22 stsp  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 e67369ac 2018-06-22 stsp  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 e67369ac 2018-06-22 stsp  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 e67369ac 2018-06-22 stsp  */
16 e67369ac 2018-06-22 stsp 
17 392891ce 2022-04-07 stsp typedef const struct got_error *(*got_blame_cb)(void *, int, int,
18 392891ce 2022-04-07 stsp     struct got_commit_object *, struct got_object_id *);
19 392891ce 2022-04-07 stsp 
20 84451b3e 2018-07-10 stsp /*
21 e27a7222 2019-08-14 stsp  * Blame the blob at the specified path in the specified commit and invoke
22 84451b3e 2018-07-10 stsp  * a callback whenever an annotation has been computed for a line.
23 84451b3e 2018-07-10 stsp  *
24 84451b3e 2018-07-10 stsp  * The callback receives the provided void * argument, the total number
25 84451b3e 2018-07-10 stsp  * of lines of the annotated file, a line number, and the ID of the commit
26 84451b3e 2018-07-10 stsp  * which last changed this line.
27 d68a0a7d 2018-07-10 stsp  *
28 d68a0a7d 2018-07-10 stsp  * The callback is invoked for each commit as history is traversed.
29 3bf198ba 2018-07-10 stsp  * If no changes to the file were made in a commit, line number -1 will
30 3bf198ba 2018-07-10 stsp  * be reported.
31 d68a0a7d 2018-07-10 stsp  *
32 d68a0a7d 2018-07-10 stsp  * If the callback returns GOT_ERR_ITER_COMPLETED, the blame operation
33 d68a0a7d 2018-07-10 stsp  * will be aborted and this function returns NULL.
34 d68a0a7d 2018-07-10 stsp  * If the callback returns any other error, the blame operation will be
35 d68a0a7d 2018-07-10 stsp  * aborted and the callback's error is returned from this function.
36 84451b3e 2018-07-10 stsp  */
37 0d8ff7d5 2019-08-14 stsp const struct got_error *got_blame(const char *,
38 4b752015 2022-06-30 stsp     struct got_object_id *, struct got_repository *, enum got_diff_algorithm,
39 e6e73e55 2022-06-30 tracey     got_blame_cb, void *, got_cancel_cb, void *, int, int, FILE *, FILE *);