src/fios.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 fios.h Declarations for savegames operations */
  11
  12 #ifndef FIOS_H
  13 #define FIOS_H
  14
  15 #include "gfx_type.h"
  16 #include "company_base.h"
  17 #include "newgrf_config.h"
  18 #include "network/core/tcp_content.h"
  19
  20
  21 /** Special values for save-load window for the data parameter of #InvalidateWindowData. */
  22 enum SaveLoadInvalidateWindowData {
  23         SLIWD_RESCAN_FILES,          ///< Rescan all files (when changed directory, ...)
  24         SLIWD_SELECTION_CHANGES,     ///< File selection has changed (user click, ...)
  25         SLIWD_FILTER_CHANGES,        ///< The filename filter has changed (via the editbox)
  26 };
  27
  28 typedef SmallMap<uint, CompanyProperties *> CompanyPropertiesMap;
  29
  30 /**
  31  * Container for loading in mode SL_LOAD_CHECK.
  32  */
  33 struct LoadCheckData {
  34         bool checkable;     ///< True if the savegame could be checked by SL_LOAD_CHECK. (Old savegames are not checkable.)
  35         StringID error;     ///< Error message from loading. INVALID_STRING_ID if no error.
  36         char *error_data;   ///< Data to pass to SetDParamStr when displaying #error.
  37
  38         uint32 map_size_x, map_size_y;
  39         Date current_date;
  40
  41         GameSettings settings;
  42
  43         CompanyPropertiesMap companies;               ///< Company information.
  44
  45         GRFConfig *grfconfig;                         ///< NewGrf configuration from save.
  46         GRFListCompatibility grf_compatibility;       ///< Summary state of NewGrfs, whether missing files or only compatible found.
  47
  48         struct LoggedAction *gamelog_action;          ///< Gamelog actions
  49         uint gamelog_actions;                         ///< Number of gamelog actions
  50
  51         LoadCheckData() : error_data(nullptr), grfconfig(nullptr),
  52                         grf_compatibility(GLC_NOT_FOUND), gamelog_action(nullptr), gamelog_actions(0)
  53         {
  54                 this->Clear();
  55         }
  56
  57         /**
  58          * Don't leak memory at program exit
  59          */
  60         ~LoadCheckData()
  61         {
  62                 this->Clear();
  63         }
  64
  65         /**
  66          * Check whether loading the game resulted in errors.
  67          * @return true if errors were encountered.
  68          */
  69         bool HasErrors()
  70         {
  71                 return this->checkable && this->error != INVALID_STRING_ID;
  72         }
  73
  74         /**
  75          * Check whether the game uses any NewGrfs.
  76          * @return true if NewGrfs are used.
  77          */
  78         bool HasNewGrfs()
  79         {
  80                 return this->checkable && this->error == INVALID_STRING_ID && this->grfconfig != nullptr;
  81         }
  82
  83         void Clear();
  84 };
  85
  86 extern LoadCheckData _load_check_data;
  87
  88
  89 enum FileSlots {
  90         /**
  91          * Slot used for the GRF scanning and such.
  92          * This slot is used for all temporary accesses to files when scanning/testing files,
  93          * and thus cannot be used for files, which are continuously accessed during a game.
  94          */
  95         CONFIG_SLOT    =  0,
  96         /** Slot for the sound. */
  97         SOUND_SLOT     =  1,
  98         /** First slot usable for (New)GRFs used during the game. */
  99         FIRST_GRF_SLOT =  2,
 100         /** Maximum number of slots. */
 101         MAX_FILE_SLOTS = 128,
 102 };
 103
 104 /** Deals with finding savegames */
 105 struct FiosItem {
 106         FiosType type;
 107         uint64 mtime;
 108         char title[64];
 109         char name[MAX_PATH];
 110 };
 111
 112 /** List of file information. */
 113 class FileList {
 114 public:
 115         ~FileList();
 116
 117         /**
 118          * Construct a new entry in the file list.
 119          * @return Pointer to the new items to be initialized.
 120          */
 121         inline FiosItem *Append()
 122         {
 123                 /*C++17: return &*/ this->files.emplace_back();
 124                 return &this->files.back();
 125         }
 126
 127         /**
 128          * Get the number of files in the list.
 129          * @return The number of files stored in the list.
 130          */
 131         inline size_t Length() const
 132         {
 133                 return this->files.size();
 134         }
 135
 136         /**
 137          * Get a pointer to the first file information.
 138          * @return Address of the first file information.
 139          */
 140         inline const FiosItem *Begin() const
 141         {
 142                 return this->files.data();
 143         }
 144
 145         /**
 146          * Get a pointer behind the last file information.
 147          * @return Address behind the last file information.
 148          */
 149         inline const FiosItem *End() const
 150         {
 151                 return this->Begin() + this->Length();
 152         }
 153
 154         /**
 155          * Get a pointer to the indicated file information. File information must exist.
 156          * @return Address of the indicated existing file information.
 157          */
 158         inline const FiosItem *Get(size_t index) const
 159         {
 160                 return this->files.data() + index;
 161         }
 162
 163         /**
 164          * Get a pointer to the indicated file information. File information must exist.
 165          * @return Address of the indicated existing file information.
 166          */
 167         inline FiosItem *Get(size_t index)
 168         {
 169                 return this->files.data() + index;
 170         }
 171
 172         inline const FiosItem &operator[](size_t index) const
 173         {
 174                 return this->files[index];
 175         }
 176
 177         /**
 178          * Get a reference to the indicated file information. File information must exist.
 179          * @return The requested file information.
 180          */
 181         inline FiosItem &operator[](size_t index)
 182         {
 183                 return this->files[index];
 184         }
 185
 186         /** Remove all items from the list. */
 187         inline void Clear()
 188         {
 189                 this->files.clear();
 190         }
 191
 192         /** Compact the list down to the smallest block size boundary. */
 193         inline void Compact()
 194         {
 195                 this->files.shrink_to_fit();
 196         }
 197
 198         void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop);
 199         const FiosItem *FindItem(const char *file);
 200
 201         std::vector<FiosItem> files; ///< The list of files.
 202 };
 203
 204 enum SortingBits {
 205         SORT_ASCENDING  = 0,
 206         SORT_DESCENDING = 1,
 207         SORT_BY_DATE    = 0,
 208         SORT_BY_NAME    = 2
 209 };
 210 DECLARE_ENUM_AS_BIT_SET(SortingBits)
 211
 212 /* Variables to display file lists */
 213 extern SortingBits _savegame_sort_order;
 214
 215 void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop);
 216
 217 void FiosGetSavegameList(SaveLoadOperation fop, FileList &file_list);
 218 void FiosGetScenarioList(SaveLoadOperation fop, FileList &file_list);
 219 void FiosGetHeightmapList(SaveLoadOperation fop, FileList &file_list);
 220
 221 const char *FiosBrowseTo(const FiosItem *item);
 222
 223 StringID FiosGetDescText(const char **path, uint64 *total_free);
 224 bool FiosDelete(const char *name);
 225 void FiosMakeHeightmapName(char *buf, const char *name, const char *last);
 226 void FiosMakeSavegameName(char *buf, const char *name, const char *last);
 227
 228 FiosType FiosGetSavegameListCallback(SaveLoadOperation fop, const char *file, const char *ext, char *title, const char *last);
 229
 230 int CDECL CompareFiosItems(const FiosItem *a, const FiosItem *b);
 231
 232 #endif /* FIOS_H */