src/fios.h

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