FileResource.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: FileResource
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/File.h>
#include <NDEVR/Dictionary.h>
namespace NDEVR
{
    /**----------------------------------------------------------------------------
    \brief Contains methods for getting information about particular OS directories
        or static program file directories.
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API FileResource
    {
    public:
        enum ProgramFileVars
        {
            e_project_dir
        };
        static Dictionary<String, String> FileEnvVariables;
        static File getExePath();
        static File getSound(const String& sound);
        static File ExeFolder();
        static File OSTempFolder();
        static File OSProgramsFolder();
        static File OSProgramDataFolder();
        static File OSUserDataFolder();
        static File OSDocumentsFolder();
        static File OSDownloadsFolder();
        static File PathToConstResources();
        static File PathToProgramDynamicResources();
        static File PathToUserDynamicResources();
        static File PathToProgramSettings();
        static File PathToUserLibrary();
        static File PathToUserSettings();
        static File PathToProgramModels();
        static File PathToProgramTranslations(bool user_file);
        static void setPathToConstResources(const File& file);
        static void SetPathToProgramDynamicResources(const File& file);
        static void SetPathToUserDynamicResources(const File& file);
        static File ProgramTempPath();
        static File SyncSettingsFolder();
        static Buffer<File> USBDrives();
        static Buffer<File> getMTPDevices();
    protected:
        static File s_path_to_const_resources;
        static File s_path_to_program_dynamic_resources;
        static File s_path_to_user_dynamic_resources;
        static File s_path_to_temp;
        static File s_path_to_app_data;
    };
    template class NDEVR_BASE_API StringStream<FileResource::ProgramFileVars>;
}