diff options
Diffstat (limited to 'c_implementation/include/libakfs.h')
| -rw-r--r-- | c_implementation/include/libakfs.h | 161 |
1 files changed, 102 insertions, 59 deletions
diff --git a/c_implementation/include/libakfs.h b/c_implementation/include/libakfs.h index 455baa7..e31c5ec 100644 --- a/c_implementation/include/libakfs.h +++ b/c_implementation/include/libakfs.h @@ -129,9 +129,9 @@ char* ak_fs_return_hash_dir(const char*); * Verify that string looks like a SHA512 hash * * param char* string to be checked - * returns boolean + * @return boolean */ -bool ak_fs_verify_input_is_hash(const char*); +bool ak_fs_verify_input_is_hash(const char*, size_t); /** * Unused @@ -142,103 +142,122 @@ int ak_fs_create_dir_for_hash(const char*); * Converts string hash to struct * @param char* Hash as string * @param sha512sum* Pointer to a sha512sum - * @returns int Status of exit + * @return int Status of exit */ int ak_fs_sha512sum_string_to_struct(const char*, sha512sum*); /** * Returns struct from string hash * @param char* Hash as string - * @returns sha512sum* Pointer to a sha512sum + * @return sha512sum* Pointer to a sha512sum */ sha512sum* ak_fs_sha512sum_from_string(char*); /** * Converts hash struct to string + * @param sha512sum* Pointer to a sha512sum + * @param char* Hash as string */ void ak_fs_sha512sum_struct_to_string(const sha512sum*, char*); /** * Opens a map file to an akfs_map_v3 struct + * @param akfs_map_v3* + * @return int */ int ak_fs_map_v3_open_from_file(akfs_map_v3*); /** - * Prints filenames from a map_store - */ -void ak_fs_print_filenames_from_map_store(akfs_map_v3**, size_t); - -/** * Unused */ int ak_fs_map_v3_to_file(akfs_map_v3); /** - * Unused + * Converts a string to an akfs_map_v3 struct + * @param char* + * @param size_t + * @param akfs_map_v3* + * @return int */ int ak_fs_convert_map_v3_string_to_struct(const char *, size_t, akfs_map_v3*); /** - * Unused + * Prints an akfs_map_v3 in struct-like format + * @param akfs_map_v3* */ -void ak_fs_map_v3_print_map_hash(akfs_map_v3*); +void ak_fs_map_v3_print(akfs_map_v3*); /** - * Unused + * Prints an array of akfs_map_v3 in struct-like format + * @param akfs_map_v3* + * @param size_t */ -void ak_fs_map_v3_print_original_hash(akfs_map_v3*); +void ak_fs_maps_v3_print(akfs_map_v3**, size_t); /** - * Unused + * Prints the map hash out of a akfs_map_v3 + * @param akfs_map_v3* */ -void ak_fs_map_v3_print_root_hash(akfs_map_v3*); +void ak_fs_map_v3_print_map_hash(akfs_map_v3*); /** - * Unused + * Prints the original hash out of a akfs_map_v3 + * @param akfs_map_v3* */ -void ak_fs_map_v3_print_filename(akfs_map_v3*); +void ak_fs_map_v3_print_original_hash(akfs_map_v3*); /** - * Unused + * Prints the root hash out of a akfs_map_v3 + * @param akfs_map_v3* */ -void ak_fs_maps_v3_print_filenames(akfs_map_v3**, size_t); - -void ak_fs_map_v3_print_as_json(akfs_map_v3*); +void ak_fs_map_v3_print_root_hash(akfs_map_v3*); /** - * Unused + * Prints the filename out of a akfs_map_v3 + * @param akfs_map_v3* */ -void ak_fs_map_v3_print(akfs_map_v3*); +void ak_fs_map_v3_print_filename(akfs_map_v3*); /** - * Takes an array of sha512sums (maps) and puts it in an array of maps (v3) + * Prints the filenames out of an array of akfs_map_v3 + * @param akfs_map_v3** + * @param size_t */ -int ak_fs_map_v3_resolve_maps(akfs_map_v3**, size_t); +void ak_fs_maps_v3_print_filenames(akfs_map_v3**, size_t); /** - * Unused + * Prints an array of akfs_map_v3 in JSON format + * @param akfs_map_v3** + * @param size_t */ -void ak_fs_print_available_maps(sha512sum**, size_t); +void ak_fs_maps_v3_print_as_json(akfs_map_v3**, size_t); /** - * Unused + * Prints an akfs_map_v3 in JSON format + * @param akfs_map_v3* */ -void ak_fs_maps_v3_print(akfs_map_v3**, size_t); +void ak_fs_map_v3_print_as_json(akfs_map_v3*); /** - * Reads maps_dir and outputs it in an array of sha512sum + * Prints an array of akfs_map_v3 in bif format + * @param akfs_map_v3** + * @param size_t */ -void ak_fs_prepare_available_maps(sha512sum**, size_t); +void ak_fs_maps_v3_print_bif(akfs_map_v3**, size_t); /** - * Unused + * Prints an akfs_map_v3 in bif format + * @param akfs_map_v3* */ -void ak_fs_get_available_maps_from_fs(sha512sum**, size_t); +void ak_fs_map_v3_print_bif(akfs_map_v3*); /** - * Unused + * Takes an array of sha512sums (maps) and puts it in an array of maps (v3) + * @param akfs_map_v3** Pointer to an array of akfs_map_v3 + * @param size_t Length of the array + * @return int Exit code (0 on success) */ -void ak_fs_print_map_all_avail(sha512sum**, size_t); +int ak_fs_maps_v3_resolve(akfs_map_v3**, size_t); /** * Unused @@ -248,20 +267,29 @@ char* ak_fs_sha512sum_struct_read_as_string(const sha512sum *); /** * Unused */ -void ak_fs_init_string(char *, size_t ); +void ak_fs_init_string(char *, size_t); /** - * Unused + * Compares two sha512sum structs + * @param sha512sum* + * @param sha512sum* + * @return bool */ bool ak_fs_sha512sum_compare(const sha512sum*, const sha512sum*); + /** - * Unused + * Checks if an sha512sum struct is NULL + * @param sha512sum* + * @return bool */ bool ak_fs_sha512sum_is_null(const sha512sum*); + /** - * Unused + * Initializes a sha512sum struct + * @param sha512sum* */ void ak_fs_sha512sum_init(sha512sum*); + /** * Unused */ @@ -278,28 +306,44 @@ void ak_fs_map_v3_init(akfs_map_v3*); void ak_fs_maps_v3_init(akfs_map_v3**, size_t); /** - * returns: boolean - * param: akfs_map_v3 + * @param akfs_map_v3 + * @return boolean */ bool ak_fs_map_v3_is_null(akfs_map_v3*); + /** - * Unused + * Gets filename out of the akfs_map_v3 + * @param akfs_map_v3* + * @return pointer to char */ char* ak_fs_map_v3_get_filename(akfs_map_v3*); + /** - * Unused + * Gets map hash out of the akfs_map_v3 + * @param akfs_map_v3 + * @return pointer to sha512sum */ sha512sum* ak_fs_map_v3_get_map_hash(akfs_map_v3*); + /** - * Unused + * Gets root hash out of the akfs_map_v3 + * @param akfs_map_v3 + * @return pointer to sha512sum */ -char* ak_fs_map_v3_get_root_hash(akfs_map_v3*); +sha512sum* ak_fs_map_v3_get_root_hash(akfs_map_v3*); + /** - * Unused + * Gets original hash out of the akfs_map_v3 + * @param akfs_map_v3 + * @return pointer to sha512sum */ -char* ak_fs_map_v3_get_orig_hash(akfs_map_v3*); +sha512sum* ak_fs_map_v3_get_orig_hash(akfs_map_v3*); + /** - * Unused + * Compares two akfs_map_v3 structs + * @param akfs_map_v3* + * @param akfs_map_v3* + * @return bool */ bool ak_fs_map_v3_compare(akfs_map_v3*, akfs_map_v3*); @@ -308,19 +352,12 @@ bool ak_fs_map_v3_compare(akfs_map_v3*, akfs_map_v3*); */ void ak_fs_init_map_v4_store(akfs_map_v4**, size_t); - /** * Unused */ void ak_fs_map_v4_init(akfs_map_v4*); /** - * Initializes an array of sha512sum - */ -void ak_fs_init_map_avail(sha512sum**, size_t); - - -/** * Unused */ bool ak_fs_map_v4_compare(akfs_map_v4*, akfs_map_v4*); @@ -346,17 +383,23 @@ sha512sum* ak_fs_map_v4_get_root_hash(akfs_map_v4*); sha512sum* ak_fs_map_v4_get_orig_hash(akfs_map_v4*); /** - * Returns number of files found in maps fs location + * + * @return size_t Number of files found in maps fs location */ size_t ak_fs_maps_v3_found_in_fs(); /** - * Unused + * Prints a list of the maps (version 3 format) available on the local fs along + * with their root hash and file name. + * + * @return int Status value */ int ak_fs_ls(); /** - * Main function + * Main function for call from other programs + * + * @return int Exit value */ int ak_fs_main(int, char**); |