folderutils.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_FOLDERUTILS_H
#define QSC_FOLDERUTILS_H
 
#include "common.h"
#include <stdio.h>
 
QSC_CPLUSPLUS_ENABLED_START
 
/* bogus winbase.h error */
QSC_SYSTEM_CONDITION_IGNORE(5105)
 

 
#if defined(QSC_SYSTEM_OS_WINDOWS)
    static const char QSC_FOLDERUTILS_DELIMITER = '\\';
#else
    static const char QSC_FOLDERUTILS_DELIMITER = '/';
#endif

typedef enum
{
    qsc_folderutils_directories_user_app_data = 0x00U,      
    qsc_folderutils_directories_user_desktop = 0x01U,       
    qsc_folderutils_directories_user_documents = 0x02U,     
    qsc_folderutils_directories_user_downloads = 0x03U,     
    qsc_folderutils_directories_user_favourites = 0x04U,    
    qsc_folderutils_directories_user_music = 0x05U,         
    qsc_folderutils_directories_user_pictures = 0x06U,      
    qsc_folderutils_directories_user_programs = 0x07U,      
    qsc_folderutils_directories_user_shortcuts = 0x08U,     
    qsc_folderutils_directories_user_videos = 0x09U         
} qsc_folderutils_directories;

QSC_EXPORT_API void qsc_folderutils_append_delimiter(char path[QSC_SYSTEM_MAX_PATH]);

QSC_EXPORT_API bool qsc_folderutils_create_directory(const char path[QSC_SYSTEM_MAX_PATH]);

QSC_EXPORT_API bool qsc_folderutils_delete_directory(const char path[QSC_SYSTEM_MAX_PATH]);

QSC_EXPORT_API bool qsc_folderutils_directory_exists(const char path[QSC_SYSTEM_MAX_PATH]);

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

QSC_EXPORT_API void qsc_folderutils_get_directory(qsc_folderutils_directories directory, char output[QSC_SYSTEM_MAX_PATH]);

QSC_EXPORT_API bool qsc_folderutils_directory_has_delimiter(const char path[QSC_SYSTEM_MAX_PATH]);
 
#if defined(QSC_DEBUG_MODE)
QSC_EXPORT_API void qsc_folderutils_test(void);
#endif
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif