[*.h,*.c,CMakeLists.txt] Implement async and sync APIs for more libraries ; add tests for this

Author: SamuelMarks

acquire/acquire_checksums.h

@@ -1,90 +1,70 @@
 #ifndef LIBACQUIRE_ACQUIRE_CHECKSUMS_H
 #define LIBACQUIRE_ACQUIRE_CHECKSUMS_H
 
-/**
- * @file acquire_checksums.h
- * @brief Collection of checksum function declarations and interface.
- *
- * This header declares typedefs and functions for computing and verifying
- * various checksum algorithms like crc32c, md5, sha1, etc.
- * Also provides functionality to get checksum function by name.
- *
- * NOTE: Always `#include` this when adding new checksum implementations,
- * to ensure the implementation matches the prototype.
- */
-
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
 
+#include "acquire_handle.h"
 #include "libacquire_export.h"
-#if defined(HAS_STDBOOL) && !defined(bool)
-#include <stdbool.h>
-#else
-#include "acquire_stdbool.h"
-#endif
-#include "acquire_config.h"
-#include "acquire_string_extras.h"
 
 /**
- * @brief Boolean result type alias for checksum validation functions.
+ * @brief Enumeration of supported checksum algorithms.
  */
+enum Checksum {
+  LIBACQUIRE_CRC32C,
+  LIBACQUIRE_SHA256,
+  LIBACQUIRE_SHA512,
+  LIBACQUIRE_UNSUPPORTED_CHECKSUM
+};
 
 /**
- * @brief Verify file using CRC32C checksum.
- *
- * @param filename Path to file.
- * @param hash Expected CRC32C checksum string.
- *
- * @return true if valid.
+ * @brief Converts a string name (e.g., "sha256") to a Checksum enum.
+ * @return The corresponding enum, or LIBACQUIRE_UNSUPPORTED_CHECKSUM.
  */
-extern LIBACQUIRE_EXPORT bool crc32c(const char *filename, const char *hash);
+extern LIBACQUIRE_EXPORT enum Checksum string2checksum(const char *);
+
+/* --- Asynchronous Verification API --- */
 
 /**
- * @brief Verify file using SHA256 checksum.
- *
- * @param filename Path to file.
- * @param hash Expected checksum string.
- *
- * @return true if valid.
+ * @brief Begins an asynchronous checksum verification (non-blocking).
+ * @param handle An initialized acquire handle.
+ * @param filepath The path to the file to verify.
+ * @param algorithm The checksum algorithm to use.
+ * @param expected_hash The expected hexadecimal checksum string.
+ * @return 0 on success, non-zero on failure.
  */
-extern LIBACQUIRE_EXPORT bool sha256(const char *filename, const char *hash);
+extern LIBACQUIRE_EXPORT int
+acquire_verify_async_start(struct acquire_handle *handle, const char *filepath,
+                           enum Checksum algorithm, const char *expected_hash);
 
 /**
- * @brief Verify file using SHA256 checksum.
- *
- * @param filename Path to file.
- * @param hash Expected checksum string.
- *
- * @return true if valid.
+ * @brief Polls the status of an asynchronous verification, processing a chunk.
+ * @param handle The handle for the in-progress operation.
+ * @return The current status of the operation.
  */
-extern LIBACQUIRE_EXPORT bool sha512(const char *filename, const char *hash);
+extern LIBACQUIRE_EXPORT enum acquire_status
+acquire_verify_async_poll(struct acquire_handle *handle);
 
-enum Checksum {
-  LIBACQUIRE_CRC32C,
-  LIBACQUIRE_SHA256,
-  LIBACQUIRE_SHA512,
-  LIBACQUIRE_UNSUPPORTED_CHECKSUM
-};
+/**
+ * @brief Requests cancellation of an asynchronous verification.
+ * @param handle The handle for the operation to be cancelled.
+ */
+extern LIBACQUIRE_EXPORT void
+acquire_verify_async_cancel(struct acquire_handle *handle);
 
-extern LIBACQUIRE_EXPORT enum Checksum string2checksum(const char *);
+/* --- Synchronous Verification API --- */
 
 /**
- * @brief Obtain a pointer to a checksum function by name.
- *
- * Returns a pointer to a function matching the
- * signature of checksum_func_t, or NULL if not found.
- *
- * @param checksum Discriminant from `enum Checksum` representing checksum
- * algorithm
- *
- * @return Function pointer on success; NULL on failure.
+ * @brief Verifies a file's checksum synchronously (blocking).
+ * @return 0 if the checksum matches, -1 on failure or mismatch.
  */
-extern LIBACQUIRE_EXPORT bool (*get_checksum_function(enum Checksum checksum))(
-    const char *, const char *);
-
-#if defined(LIBACQUIRE_IMPLEMENTATION) && defined(CHECKSUM_IMPL)
+extern LIBACQUIRE_EXPORT int acquire_verify_sync(struct acquire_handle *handle,
+                                                 const char *filepath,
+                                                 enum Checksum algorithm,
+                                                 const char *expected_hash);
 
+#if defined(LIBACQUIRE_IMPLEMENTATION) && defined(LIBACQUIRE_CHECKSUMS_IMPL)
 enum Checksum string2checksum(const char *const s) {
   if (s == NULL)
     return LIBACQUIRE_UNSUPPORTED_CHECKSUM;
@@ -97,26 +77,10 @@ enum Checksum string2checksum(const char *const s) {
   else
     return LIBACQUIRE_UNSUPPORTED_CHECKSUM;
 }
-
-bool (*get_checksum_function(enum Checksum checksum))(const char *,
-                                                      const char *) {
-  switch (checksum) {
-  case LIBACQUIRE_CRC32C:
-    return crc32c;
-  case LIBACQUIRE_SHA256:
-    return sha256;
-  case LIBACQUIRE_SHA512:
-    return sha512;
-  case LIBACQUIRE_UNSUPPORTED_CHECKSUM:
-  default:
-    return NULL;
-  }
-}
-
-#endif /* defined(LIBACQUIRE_IMPLEMENTATION) && defined(CHECKSUM_IMPL) */
+#endif /* defined(LIBACQUIRE_IMPLEMENTATION) &&                                \
+          defined(LIBACQUIRE_CHECKSUMS_IMPL) */
 
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
-
-#endif /* ! LIBACQUIRE_ACQUIRE_CHECKSUMS_H */
+#endif /* !LIBACQUIRE_ACQUIRE_CHECKSUMS_H */

acquire/acquire_extract.h

@@ -1,16 +1,6 @@
-/* acquire/acquire_extract.h */
 #ifndef LIBACQUIRE_ACQUIRE_EXTRACT_H
 #define LIBACQUIRE_ACQUIRE_EXTRACT_H
 
-/**
- * @file acquire_extract.h
- * @brief Public API for synchronous and asynchronous archive extraction.
- *
- * This module provides a handle-based API for both blocking and non-blocking
- * archive extraction. The archive format is detected automatically by the
- * backend (e.g., libarchive).
- */
-
 #include "acquire_handle.h"
 #include "libacquire_export.h"
 
@@ -22,40 +12,19 @@ extern "C" {
 
 /**
  * @brief Begins an asynchronous extraction (non-blocking).
- *
- * This function initializes the extraction process. The actual work happens
- * during calls to `acquire_extract_async_poll`.
- *
- * @param handle An initialized acquire handle.
- * @param archive_path The path to the source archive file (e.g., .zip,
- * .tar.gz).
- * @param dest_path The directory to extract files into.
- * @return 0 on success, non-zero on failure.
  */
 extern LIBACQUIRE_EXPORT int
 acquire_extract_async_start(struct acquire_handle *handle,
                             const char *archive_path, const char *dest_path);
 
 /**
- * @brief Polls the status of an asynchronous extraction, processing one entry.
- *
- * In a non-blocking application, this should be called repeatedly until it
- * no longer returns `ACQUIRE_IN_PROGRESS`. Each call processes one file or
- * directory entry from the archive.
- *
- * @param handle The handle for the in-progress operation.
- * @return The current status of the operation.
+ * @brief Polls the status of an asynchronous extraction.
  */
 extern LIBACQUIRE_EXPORT enum acquire_status
 acquire_extract_async_poll(struct acquire_handle *handle);
 
 /**
  * @brief Requests cancellation of an asynchronous extraction.
- *
- * The cancellation will be processed on the next call to
- * `acquire_extract_async_poll`.
- *
- * @param handle The handle for the operation to be cancelled.
  */
 extern LIBACQUIRE_EXPORT void
 acquire_extract_async_cancel(struct acquire_handle *handle);
@@ -64,48 +33,12 @@ acquire_extract_async_cancel(struct acquire_handle *handle);
 
 /**
  * @brief Extracts an archive synchronously (blocking).
- *
- * This is a helper function that wraps the asynchronous API, calling `poll`
- * in a loop until the operation is complete.
- *
- * @param handle An initialized acquire handle.
- * @param archive_path The path to the source archive file.
- * @param dest_path The directory to extract files into.
- * @return 0 on success, non-zero on failure. Details can be retrieved from the
- * handle.
  */
 extern LIBACQUIRE_EXPORT int acquire_extract_sync(struct acquire_handle *handle,
                                                   const char *archive_path,
                                                   const char *dest_path);
 
-/* --- Deprecated Symbols --- */
-
-/**
- * @deprecated This enum is no longer used in the public API and will be
- * removed in a future version. Archive format is now auto-detected.
- */
-enum Archive {
-  LIBACQUIRE_ZIP,
-  LIBACQUIRE_INFER,
-  LIBACQUIRE_UNSUPPORTED_ARCHIVE
-};
-
-/**
- * @deprecated This function is no longer needed for the public API and will be
- * removed in a future version.
- */
-extern LIBACQUIRE_EXPORT enum Archive extension2archive(const char *extension);
-
-/**
- * @deprecated This function is deprecated in favor of `acquire_extract_sync`.
- * It will be removed in a future version.
- */
-extern LIBACQUIRE_EXPORT int extract_archive(enum Archive archive,
-                                             const char *archive_filepath,
-                                             const char *output_folder);
-
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
-
 #endif /* !LIBACQUIRE_ACQUIRE_EXTRACT_H */