citra/src/common/common_paths.h

// Copyright 2013 Dolphin Emulator Project / 2014 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.

#pragma once

// Directory separators, do we need this?
#define DIR_SEP "/"
#define DIR_SEP_CHR '/'

#ifndef MAX_PATH
#define MAX_PATH 260
#endif

// The user data dir
#define ROOT_DIR "."
#define USERDATA_DIR "user"
#ifdef USER_DIR
#define EMU_DATA_DIR USER_DIR
#else
#ifdef _WIN32
#define EMU_DATA_DIR "Citra"
#elif ANDROID
// On Android internal storage is mounted as "/sdcard"
#define SDCARD_DIR "sdcard"
#define EMU_DATA_DIR "citra-emu"
#else
#define EMU_DATA_DIR "citra-emu"
#endif
#endif

// Dirs in both User and Sys
#define EUR_DIR "EUR"
#define USA_DIR "USA"
#define JAP_DIR "JAP"

// Subdirs in the User dir returned by GetUserPath(UserPath::UserDir)
#define CONFIG_DIR "config"
#define CACHE_DIR "cache"
#define SDMC_DIR "sdmc"
#define NAND_DIR "nand"
#define SYSDATA_DIR "sysdata"
#define LOG_DIR "log"
#define CHEATS_DIR "cheats"
#define DLL_DIR "external_dlls"

// Filenames
// Files in the directory returned by GetUserPath(UserPath::LogDir)
#define LOG_FILE "citra_log.txt"

// Files in the directory returned by GetUserPath(UserPath::ConfigDir)
#define EMU_CONFIG "emu.ini"
#define DEBUGGER_CONFIG "debugger.ini"
#define LOGGER_CONFIG "logger.ini"

// Sys files
#define SHARED_FONT "shared_font.bin"
#define AES_KEYS "aes_keys.txt"
#define BOOTROM9 "boot9.bin"
#define SECRET_SECTOR "sector0x96.bin"
License change 2014-12-17 05:38:14 +00:00			`// Copyright 2013 Dolphin Emulator Project / 2014 Citra Emulator Project`
			`// Licensed under GPLv2 or any later version`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00			`// Refer to the license.txt file included.`

Common: Move header guards over to pragma once Also replaced C headers with the C++ equivalent ones 2014-08-17 17:45:50 +00:00			`#pragma once`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00
Added configuration file system. Uses QSettings on citra-qt, and inih on citra-cli. 2014-09-13 00:06:13 +00:00			`// Directory separators, do we need this?`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00			`#define DIR_SEP "/"`
			`#define DIR_SEP_CHR '/'`

removed unneeded dolphin paths code, fixed linker problems with common.lib 2013-09-09 00:42:03 +00:00			`#ifndef MAX_PATH`
Added configuration file system. Uses QSettings on citra-qt, and inih on citra-cli. 2014-09-13 00:06:13 +00:00			`#define MAX_PATH 260`
removed unneeded dolphin paths code, fixed linker problems with common.lib 2013-09-09 00:42:03 +00:00			`#endif`
updated common paths 2013-09-08 17:17:27 +00:00
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00			`// The user data dir`
			`#define ROOT_DIR "."`
Common: Fix logic for setting EMU_DATA_DIR. 2015-03-16 01:22:59 +00:00			`#define USERDATA_DIR "user"`
			`#ifdef USER_DIR`
Sources: Run clang-format on everything. 2016-09-18 00:38:01 +00:00			`#define EMU_DATA_DIR USER_DIR`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00			`#else`
Sources: Run clang-format on everything. 2016-09-18 00:38:01 +00:00			`#ifdef _WIN32`
Move to AppData/Roaming/Citra/ 2016-11-26 21:57:36 +00:00			`#define EMU_DATA_DIR "Citra"`
android: common: Add paths for Android SDCARD_DIR and EMU_DATA_DIR. 2019-07-05 22:54:50 +00:00			`#elif ANDROID`
			`// On Android internal storage is mounted as "/sdcard"`
			`#define SDCARD_DIR "sdcard"`
			`#define EMU_DATA_DIR "citra-emu"`
Sources: Run clang-format on everything. 2016-09-18 00:38:01 +00:00			`#else`
			`#define EMU_DATA_DIR "citra-emu"`
			`#endif`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00			`#endif`

			`// Dirs in both User and Sys`
			`#define EUR_DIR "EUR"`
			`#define USA_DIR "USA"`
			`#define JAP_DIR "JAP"`

file_util: Use an enum class for GetUserPath() Instead of using an unsigned int as a parameter and expecting a user to always pass in the correct values, we can just convert the enum into an enum class and use that type as the parameter type instead, which makes the interface more type safe. We also get rid of the bookkeeping "NUM_" element in the enum by just using an unordered map. This function is generally low-frequency in terms of calls (and I'd hope so, considering otherwise would mean we're slamming the disk with IO all the time) so I'd consider this acceptable in this case. 2018-07-21 19:52:42 +00:00			`// Subdirs in the User dir returned by GetUserPath(UserPath::UserDir)`
Sources: Run clang-format on everything. 2016-09-18 00:38:01 +00:00			`#define CONFIG_DIR "config"`
			`#define CACHE_DIR "cache"`
			`#define SDMC_DIR "sdmc"`
			`#define NAND_DIR "nand"`
			`#define SYSDATA_DIR "sysdata"`
Logging: Add customizable logging backends and fmtlib based macros * Change the logging backend to support multiple sinks through the Backend Interface * Add a new set of logging macros to use fmtlib instead. * Qt: Compile as GUI application on windows to make the console hidden by default. Add filter configuration and a button to open log location. * SDL: Migrate to the new logging macros 2018-02-20 00:51:27 +00:00			`#define LOG_DIR "log"`
Add CheatEngine and support for Gateway cheats (#4406) * Add CheatEngine; Add support for Gateway cheats; Add Cheat UI * fix a potential crash on some systems * fix substr with negative length * Add Joker to the NonOp comp handling * Fixup JokerOp * minor fixup in patchop; add todo for nested loops * Add comment for PadState member variable in HID * fix: stol to stoul in parsing cheat file * fix misplaced parsing of values; fix patchop code * add missing break * Make read_func and write_func a template parameter 2018-11-17 01:01:10 +00:00			`#define CHEATS_DIR "cheats"`
FFmpegDL: Added external_dlls folder to user folder AACDecoder: addressed reviews 2018-12-15 20:33:33 +00:00			`#define DLL_DIR "external_dlls"`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00
			`// Filenames`
file_util: Use an enum class for GetUserPath() Instead of using an unsigned int as a parameter and expecting a user to always pass in the correct values, we can just convert the enum into an enum class and use that type as the parameter type instead, which makes the interface more type safe. We also get rid of the bookkeeping "NUM_" element in the enum by just using an unordered map. This function is generally low-frequency in terms of calls (and I'd hope so, considering otherwise would mean we're slamming the disk with IO all the time) so I'd consider this acceptable in this case. 2018-07-21 19:52:42 +00:00			`// Files in the directory returned by GetUserPath(UserPath::LogDir)`
Logging: Add customizable logging backends and fmtlib based macros * Change the logging backend to support multiple sinks through the Backend Interface * Add a new set of logging macros to use fmtlib instead. * Qt: Compile as GUI application on windows to make the console hidden by default. Add filter configuration and a button to open log location. * SDL: Migrate to the new logging macros 2018-02-20 00:51:27 +00:00			`#define LOG_FILE "citra_log.txt"`

file_util: Use an enum class for GetUserPath() Instead of using an unsigned int as a parameter and expecting a user to always pass in the correct values, we can just convert the enum into an enum class and use that type as the parameter type instead, which makes the interface more type safe. We also get rid of the bookkeeping "NUM_" element in the enum by just using an unordered map. This function is generally low-frequency in terms of calls (and I'd hope so, considering otherwise would mean we're slamming the disk with IO all the time) so I'd consider this acceptable in this case. 2018-07-21 19:52:42 +00:00			`// Files in the directory returned by GetUserPath(UserPath::ConfigDir)`
Sources: Run clang-format on everything. 2016-09-18 00:38:01 +00:00			`#define EMU_CONFIG "emu.ini"`
			`#define DEBUGGER_CONFIG "debugger.ini"`
			`#define LOGGER_CONFIG "logger.ini"`
replaced common code with dolphin common 2013-09-05 00:17:46 +00:00
APT_U: Added GetSharedFont service function. 2014-11-26 20:00:51 +00:00			`// Sys files`
Sources: Run clang-format on everything. 2016-09-18 00:38:01 +00:00			`#define SHARED_FONT "shared_font.bin"`
HW: add AES engine & implement AES-CCM 2017-01-01 12:58:02 +00:00			`#define AES_KEYS "aes_keys.txt"`
Load AES keys stored in boot9.bin (#4335) * Load AES keys stored in boot9.bin 2018-10-17 08:13:55 +00:00			`#define BOOTROM9 "boot9.bin"`
Load keys from new3DS native firm 2018-10-17 11:21:02 +00:00			`#define SECRET_SECTOR "sector0x96.bin"`