AuroraRuntime/Include/Aurora/IO/FS/Resources.hpp

/***
    Copyright (C) 2021 J Reece Wilson (a/k/a "Reece"). All rights reserved.

    File: Resources.hpp
    Date: 2021-6-10
    Author: Reece
***/
#pragma once

namespace Aurora::IO::FS
{
    /**
     * @brief Provides an application specific storage path for sharing data amongst Aurora applications sharing the same branding info (defer to the init structure)
    */
    AUKN_SYM bool GetSystemDomain(AuString &path);

    /**
     * @brief Provides an application specific storage path for local application data, isolated for your Aurora application brand info (defer to the init structure)
    */
    AUKN_SYM bool GetProfileDomain(AuString &path);


    AUKN_SYM bool GetSystemResourcePath(const AuString &fileName, AuString &path);

    /**
     * @brief Pulls the application directory as defined by the operating system standard file system hierarchy
    */
    AUKN_SYM bool GetAppData(AuString &path);

    /**
     * @brief Pulls the users home directory, untouched 
    */
    AUKN_SYM bool GetUserHome(AuString &path);

    /**
     * @brief Global application data that requires no special permissions to access
    */
    AUKN_SYM bool GetWritableAppdata(AuString &path);
    
    /**
     * @brief Global application data that requires special permissions to access, usually configured by a system account during installation
    */
    AUKN_SYM bool GetRootAppdata(AuString &path);
}