native_fs.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares native filesystem helper routines.
 */
 
#ifndef PHAROS_NATIVE_FS_H
#define PHAROS_NATIVE_FS_H
 
#include <stddef.h>
#include <stdlib.h>
 
/** @name Filesystem helpers
 * @{
 */
/**
 * @brief Creates a directory path and any missing parent directories.
 * @param path Directory path to ensure exists.
 * @return 0 on success, or a non-zero status code on failure.
 */
int ensure_directory(const char *path);
/**
 * @brief Copies one file as binary data.
 * @param source_path Path to the source file.
 * @param target_path Path to the destination file.
 * @return 0 on success, or a non-zero status code on failure.
 */
int copy_file_binary(const char *source_path, const char *target_path);
/**
 * @brief Recursively copies one directory tree into another location.
 * @param source_dir Source directory to copy.
 * @param target_dir Destination directory to populate.
 * @return 0 on success, or a non-zero status code on failure.
 */
int copy_directory_recursive(const char *source_dir, const char *target_dir);
/**
 * @brief Recursively removes a directory tree.
 * @param target_dir Directory tree to remove.
 * @return 0 on success, or a non-zero status code on failure.
 */
int remove_directory_recursive(const char *target_dir);
/**
 * @brief Writes a text buffer to a file path.
 * @param path Destination file path.
 * @param content Text content to write.
 * @return 0 on success, or a non-zero status code on failure.
 */
int write_text_file(const char *path, const char *content);
 
/**
 * @brief Reads the full content of a binary file into a heap-allocated buffer.
 * @param path File path to read.
 * @param out_size Receives the byte count (may be NULL).
 * @return Newly allocated buffer with NUL terminator, or NULL on failure.
 */
unsigned char *read_file_bytes_dup_runtime(const char *path, size_t *out_size);
 
/**
 * @brief Writes a binary byte range to a file, creating parent directories as needed.
 * @param path Destination file path.
 * @param data Bytes to write.
 * @param length Number of bytes to write.
 * @return 0 on success, non-zero on failure.
 */
int write_binary_file_runtime(const char *path, const unsigned char *data, size_t length);
 
/** @} */
#endif