fileutils.h

Go to the documentation of this file.

/* 2020-2026 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 herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef QSC_FILEUTILS_H
#define QSC_FILEUTILS_H
 
#include "qsccommon.h"
#include <stdio.h>
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_FILEUTILS_CHUNK_SIZE 128U

#define QSC_FILEUTILS_MAX_LINE_SIZE (1024U * 1024U)

#define QSC_FILEUTILS_MAX_EXTENSION 16U

#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 void qsc_fileutils_flush(FILE* fp);

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, size_t flen);

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