src/fileio_type.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file fileio_type.h Types for Standard In/Out file operations */
  11
  12 #ifndef FILEIO_TYPE_H
  13 #define FILEIO_TYPE_H
  14
  15 #include "core/enum_type.hpp"
  16
  17 /**
  18  * The different kinds of subdirectories OpenTTD uses
  19  */
  20 enum Subdirectory {
  21         BASE_DIR,      ///< Base directory for all subdirectories
  22         SAVE_DIR,      ///< Base directory for all savegames
  23         AUTOSAVE_DIR,  ///< Subdirectory of save for autosaves
  24         SCENARIO_DIR,  ///< Base directory for all scenarios
  25         HEIGHTMAP_DIR, ///< Subdirectory of scenario for heightmaps
  26         OLD_GM_DIR,    ///< Old subdirectory for the music
  27         OLD_DATA_DIR,  ///< Old subdirectory for the data.
  28         BASESET_DIR,   ///< Subdirectory for all base data (base sets, intro game)
  29         NEWGRF_DIR,    ///< Subdirectory for all NewGRFs
  30         LANG_DIR,      ///< Subdirectory for all translation files
  31         AI_DIR,        ///< Subdirectory for all %AI files
  32         AI_LIBRARY_DIR,///< Subdirectory for all %AI libraries
  33         GAME_DIR,      ///< Subdirectory for all game scripts
  34         GAME_LIBRARY_DIR, ///< Subdirectory for all GS libraries
  35         SCREENSHOT_DIR,   ///< Subdirectory for all screenshots
  36         NUM_SUBDIRS,   ///< Number of subdirectories
  37         NO_DIRECTORY,  ///< A path without any base directory
  38 };
  39
  40 /**
  41  * Types of searchpaths OpenTTD might use
  42  */
  43 enum Searchpath {
  44         SP_FIRST_DIR,
  45         SP_WORKING_DIR = SP_FIRST_DIR, ///< Search in the working directory
  46 #if defined(WITH_XDG_BASEDIR) && defined(WITH_PERSONAL_DIR)
  47         SP_PERSONAL_DIR_XDG,           ///< Search in the personal directory from the XDG specification
  48 #endif
  49         SP_PERSONAL_DIR,               ///< Search in the personal directory
  50         SP_SHARED_DIR,                 ///< Search in the shared directory, like 'Shared Files' under Windows
  51         SP_BINARY_DIR,                 ///< Search in the directory where the binary resides
  52         SP_INSTALLATION_DIR,           ///< Search in the installation directory
  53         SP_APPLICATION_BUNDLE_DIR,     ///< Search within the application bundle
  54         SP_AUTODOWNLOAD_DIR,           ///< Search within the autodownload directory
  55         NUM_SEARCHPATHS
  56 };
  57
  58 DECLARE_POSTFIX_INCREMENT(Searchpath)
  59
  60 #endif /* FILEIO_TYPE_H */