fileutils.h

Go to the documentation of this file.

/*
 * 2025 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE: This software and all accompanying materials are the exclusive 
 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
 * The intellectual and technical concepts contained within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef QSC_FILEUTILS_H
#define QSC_FILEUTILS_H
 
#include "common.h"
#include <stdio.h>
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_FILEUTILS_CHUNK_SIZE 4096ULL

#define QSC_FILEUTILS_MAX_EXTENSION 16ULL

#define QSC_FILEUTILS_MAX_FILENAME QSC_SYSTEM_MAX_PATH

#define QSC_FILEUTILS_MAX_PATH QSC_SYSTEM_MAX_PATH
 
#if defined(QSC_SYSTEM_OS_WINDOWS)
    static const char QSC_FILEUTILS_DIRECTORY_SEPERATOR[] = "\\";
#else
    static const char QSC_FILEUTILS_DIRECTORY_SEPERATOR[] = "/";
#endif

typedef enum
{
    qsc_fileutils_access_exists  = 0x00U,       
#if defined(QSC_SYSTEM_OS_WINDOWS)
    qsc_fileutils_access_read    = 0x01U,       
    qsc_fileutils_access_write   = 0x02U,       
    qsc_fileutils_access_execute = 0x03U,        
#else
    qsc_fileutils_access_read    = 0x04U,       
    qsc_fileutils_access_write   = 0x02U,       
    qsc_fileutils_access_execute = 0x06U        
#endif
} qsc_fileutils_access_rights;

typedef enum
{
    qsc_fileutils_mode_none = 0x00U,            
    qsc_fileutils_mode_read = 0x01U,            
    qsc_fileutils_mode_read_update = 0x02U,     
    qsc_fileutils_mode_write = 0x03U,           
    qsc_fileutils_mode_write_update = 0x04U,    
    qsc_fileutils_mode_append = 0x05U,          
    qsc_fileutils_mode_append_update = 0x06U    
} qsc_fileutils_mode;

QSC_EXPORT_API bool qsc_fileutils_append_to_file(const char* fpath, const char* stream, size_t length);

QSC_EXPORT_API size_t qsc_fileutils_copy_file_to_object(const char* fpath, void* obj, size_t length);

QSC_EXPORT_API size_t qsc_fileutils_copy_file_to_stream(const char* fpath, char* stream, size_t length);

QSC_EXPORT_API bool qsc_fileutils_copy_object_to_file(const char* fpath, const void* obj, size_t length);

QSC_EXPORT_API bool qsc_fileutils_copy_stream_to_file(const char* fpath, const char* stream, size_t length);

QSC_EXPORT_API bool qsc_fileutils_create(const char* fpath);

QSC_EXPORT_API bool qsc_fileutils_delete(const char* fpath);

QSC_EXPORT_API bool qsc_fileutils_erase(const char* fpath);

QSC_EXPORT_API bool qsc_fileutils_file_copy(const char* inpath, const char* outpath);

QSC_EXPORT_API bool qsc_fileutils_get_access(const char* fpath, qsc_fileutils_access_rights level);

QSC_EXPORT_API size_t qsc_fileutils_get_directory(char* directory, size_t dirlen, const char* fpath);

QSC_EXPORT_API size_t qsc_fileutils_get_extension(char* extension, size_t extlen, const char* fpath);

QSC_EXPORT_API size_t qsc_fileutils_get_name(char* name, size_t namelen, const char* fpath);

QSC_EXPORT_API int64_t qsc_fileutils_get_line(char** line, size_t* length, FILE* fp);

QSC_EXPORT_API size_t qsc_fileutils_get_size(const char* fpath);

QSC_EXPORT_API bool qsc_fileutils_get_working_directory(char* fpath);

QSC_EXPORT_API size_t qsc_fileutils_list_files(char* result, size_t reslen, const char* directory);

QSC_EXPORT_API void qsc_fileutils_close(FILE* fp);

QSC_EXPORT_API bool qsc_fileutils_exists(const char* fpath);

QSC_EXPORT_API FILE* qsc_fileutils_open(const char* fpath, qsc_fileutils_mode mode, bool binary);

QSC_EXPORT_API size_t qsc_fileutils_read(char* output, size_t otplen, size_t position, FILE* fp);

QSC_EXPORT_API size_t qsc_fileutils_safe_read(const char* fpath, size_t position, char* output, size_t length);

QSC_EXPORT_API size_t qsc_fileutils_safe_write(const char* fpath, size_t position, const char* input, size_t length);

QSC_EXPORT_API bool qsc_fileutils_seekto(FILE* fp, size_t position);

QSC_EXPORT_API int64_t qsc_fileutils_read_line(const char* fpath, char* buffer, size_t buflen, size_t linenum);

QSC_EXPORT_API bool qsc_fileutils_truncate_file(FILE* fp, size_t length);

QSC_EXPORT_API bool qsc_fileutils_valid_path(const char* fpath);

QSC_EXPORT_API size_t qsc_fileutils_write(const char* input, size_t inplen, size_t position, FILE* fp);

QSC_EXPORT_API bool qsc_fileutils_write_line(const char* fpath, const char* input, size_t inplen);

QSC_EXPORT_API void qsc_fileutils_zeroise(const char* fpath);

#if defined(QSC_DEBUG_MODE)
QSC_EXPORT_API void qsc_fileutils_test(const char* fpath);
#endif
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif