1sha1-array API 2============== 3 4The sha1-array API provides storage and manipulation of sets of SHA-1 5identifiers. The emphasis is on storage and processing efficiency, 6making them suitable for large lists. Note that the ordering of items is 7not preserved over some operations. 8 9Data Structures 10--------------- 11 12`struct sha1_array`:: 13 14 A single array of SHA-1 hashes. This should be initialized by 15 assignment from `SHA1_ARRAY_INIT`. The `sha1` member contains 16 the actual data. The `nr` member contains the number of items in 17 the set. The `alloc` and `sorted` members are used internally, 18 and should not be needed by API callers. 19 20Functions 21--------- 22 23`sha1_array_append`:: 24 Add an item to the set. The sha1 will be placed at the end of 25 the array (but note that some operations below may lose this 26 ordering). 27 28`sha1_array_lookup`:: 29 Perform a binary search of the array for a specific sha1. 30 If found, returns the offset (in number of elements) of the 31 sha1. If not found, returns a negative integer. If the array is 32 not sorted, this function has the side effect of sorting it. 33 34`sha1_array_clear`:: 35 Free all memory associated with the array and return it to the 36 initial, empty state. 37 38`sha1_array_for_each_unique`:: 39 Efficiently iterate over each unique element of the list, 40 executing the callback function for each one. If the array is 41 not sorted, this function has the side effect of sorting it. If 42 the callback returns a non-zero value, the iteration ends 43 immediately and the callback's return is propagated; otherwise, 44 0 is returned. 45 46Examples 47-------- 48 49----------------------------------------- 50int print_callback(const unsigned char sha1[20], 51 void *data) 52{ 53 printf("%s\n", sha1_to_hex(sha1)); 54 return 0; /* always continue */ 55} 56 57void some_func(void) 58{ 59 struct sha1_array hashes = SHA1_ARRAY_INIT; 60 unsigned char sha1[20]; 61 62 /* Read objects into our set */ 63 while (read_object_from_stdin(sha1)) 64 sha1_array_append(&hashes, sha1); 65 66 /* Check if some objects are in our set */ 67 while (read_object_from_stdin(sha1)) { 68 if (sha1_array_lookup(&hashes, sha1) >= 0) 69 printf("it's in there!\n"); 70 71 /* 72 * Print the unique set of objects. We could also have 73 * avoided adding duplicate objects in the first place, 74 * but we would end up re-sorting the array repeatedly. 75 * Instead, this will sort once and then skip duplicates 76 * in linear time. 77 */ 78 sha1_array_for_each_unique(&hashes, print_callback, NULL); 79} 80-----------------------------------------