mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Cleanup: Adjust comments for the Subdirectory enum

pull/12611/head
Sadie del Solar 2024-05-01 13:51:30 -07:00
parent ee7df74fa1
commit 4c8c67b8b5
2 changed files with 43 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/fileio.cpp
View File

@ -38,23 +38,24 @@ extern std::string _config_file;
extern std::string _highscore_file; extern std::string _highscore_file;
static const char * const _subdirs[] = { static const char * const _subdirs[] = {
"", "", ///< BASE_DIR
"save" PATHSEP, "save" PATHSEP, ///< SAVE_DIR
"save" PATHSEP "autosave" PATHSEP, "save" PATHSEP "autosave" PATHSEP, ///< AUTOSAVE_DIR
"scenario" PATHSEP, "scenario" PATHSEP, ///< SCENARIO_DIR
"scenario" PATHSEP "heightmap" PATHSEP, "scenario" PATHSEP "heightmap" PATHSEP, ///< HEIGHTMAP_DIR
"gm" PATHSEP, "gm" PATHSEP, ///< OLD_GM_DIR
"data" PATHSEP, "data" PATHSEP, ///< OLD_DATA_DIR
"baseset" PATHSEP, "baseset" PATHSEP, ///< BASESET_DIR
"newgrf" PATHSEP, "newgrf" PATHSEP, ///< NEWGRF_DIR
"lang" PATHSEP, "lang" PATHSEP, ///< LANG_DIR
"ai" PATHSEP, "ai" PATHSEP, ///< AI_DIR
"ai" PATHSEP "library" PATHSEP, "ai" PATHSEP "library" PATHSEP, ///< AI_LIBRARY_DIR
"game" PATHSEP, "game" PATHSEP, ///< GAME_DIR
"game" PATHSEP "library" PATHSEP, "game" PATHSEP "library" PATHSEP, ///< GAME_LIBRARY_DIR
"screenshot" PATHSEP, "screenshot" PATHSEP, ///< SCREENSHOT_DIR
"social_integration" PATHSEP, "social_integration" PATHSEP, ///< SOCIAL_INTEGRATION_DIR
}; };
// This should line up with the "Subdirectory" enum defined in fileio_type.h
static_assert(lengthof(_subdirs) == NUM_SUBDIRS); static_assert(lengthof(_subdirs) == NUM_SUBDIRS);
/** /**

52
src/fileio_type.h
View File

@ -109,24 +109,24 @@ inline DetailedFileType GetDetailedFileType(FiosType fios_type)
* The different kinds of subdirectories OpenTTD uses * The different kinds of subdirectories OpenTTD uses
*/ */
enum Subdirectory { enum Subdirectory {
BASE_DIR, ///< Base directory for all subdirectories BASE_DIR, ///< Base directory for all subdirectories
SAVE_DIR, ///< Base directory for all savegames SAVE_DIR, ///< Base directory for all savegames
AUTOSAVE_DIR, ///< Subdirectory of save for autosaves AUTOSAVE_DIR, ///< Subdirectory of save for autosaves
SCENARIO_DIR, ///< Base directory for all scenarios SCENARIO_DIR, ///< Base directory for all scenarios
HEIGHTMAP_DIR, ///< Subdirectory of scenario for heightmaps HEIGHTMAP_DIR, ///< Subdirectory of scenario for heightmaps
OLD_GM_DIR, ///< Old subdirectory for the music OLD_GM_DIR, ///< Old subdirectory for the music
OLD_DATA_DIR, ///< Old subdirectory for the data. OLD_DATA_DIR, ///< Old subdirectory for the data.
BASESET_DIR, ///< Subdirectory for all base data (base sets, intro game) BASESET_DIR, ///< Subdirectory for all base data (base sets, intro game)
NEWGRF_DIR, ///< Subdirectory for all NewGRFs NEWGRF_DIR, ///< Subdirectory for all NewGRFs
LANG_DIR, ///< Subdirectory for all translation files LANG_DIR, ///< Subdirectory for all translation files
AI_DIR, ///< Subdirectory for all %AI files AI_DIR, ///< Subdirectory for all %AI files
AI_LIBRARY_DIR,///< Subdirectory for all %AI libraries AI_LIBRARY_DIR, ///< Subdirectory for all %AI libraries
GAME_DIR, ///< Subdirectory for all game scripts GAME_DIR, ///< Subdirectory for all game scripts
GAME_LIBRARY_DIR, ///< Subdirectory for all GS libraries GAME_LIBRARY_DIR, ///< Subdirectory for all GS libraries
SCREENSHOT_DIR, ///< Subdirectory for all screenshots SCREENSHOT_DIR, ///< Subdirectory for all screenshots
SOCIAL_INTEGRATION_DIR, ///< Subdirectory for all social integration plugins SOCIAL_INTEGRATION_DIR, ///< Subdirectory for all social integration plugins
NUM_SUBDIRS, ///< Number of subdirectories NUM_SUBDIRS, ///< Number of subdirectories
NO_DIRECTORY, ///< A path without any base directory NO_DIRECTORY, ///< A path without any base directory
}; };
/** /**
@ -134,17 +134,17 @@ enum Subdirectory {
*/ */
enum Searchpath : unsigned { enum Searchpath : unsigned {
SP_FIRST_DIR, SP_FIRST_DIR,
SP_WORKING_DIR = SP_FIRST_DIR, ///< Search in the working directory SP_WORKING_DIR = SP_FIRST_DIR, ///< Search in the working directory
#ifdef USE_XDG #ifdef USE_XDG
SP_PERSONAL_DIR_XDG, ///< Search in the personal directory from the XDG specification SP_PERSONAL_DIR_XDG, ///< Search in the personal directory from the XDG specification
#endif #endif
SP_PERSONAL_DIR, ///< Search in the personal directory SP_PERSONAL_DIR, ///< Search in the personal directory
SP_SHARED_DIR, ///< Search in the shared directory, like 'Shared Files' under Windows SP_SHARED_DIR, ///< Search in the shared directory, like 'Shared Files' under Windows
SP_BINARY_DIR, ///< Search in the directory where the binary resides SP_BINARY_DIR, ///< Search in the directory where the binary resides
SP_INSTALLATION_DIR, ///< Search in the installation directory SP_INSTALLATION_DIR, ///< Search in the installation directory
SP_APPLICATION_BUNDLE_DIR, ///< Search within the application bundle SP_APPLICATION_BUNDLE_DIR, ///< Search within the application bundle
SP_AUTODOWNLOAD_DIR, ///< Search within the autodownload directory SP_AUTODOWNLOAD_DIR, ///< Search within the autodownload directory
SP_AUTODOWNLOAD_PERSONAL_DIR, ///< Search within the autodownload directory located in the personal directory SP_AUTODOWNLOAD_PERSONAL_DIR, ///< Search within the autodownload directory located in the personal directory
SP_AUTODOWNLOAD_PERSONAL_DIR_XDG, ///< Search within the autodownload directory located in the personal directory (XDG variant) SP_AUTODOWNLOAD_PERSONAL_DIR_XDG, ///< Search within the autodownload directory located in the personal directory (XDG variant)
NUM_SEARCHPATHS NUM_SEARCHPATHS
}; };