fios.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef FIOS_H
#define FIOS_H
 
#include "gfx_type.h"
#include "company_base.h"
#include "newgrf_config.h"
#include "gamelog.h"
#include "network/core/tcp_content_type.h"
#include "timer/timer_game_calendar.h"
 

enum SaveLoadInvalidateWindowData : uint8_t {
  SLIWD_RESCAN_FILES,          
  SLIWD_SELECTION_CHANGES,     
  SLIWD_FILTER_CHANGES,        
};
 
using CompanyPropertiesMap = std::map<uint, std::unique_ptr<CompanyProperties>>;

struct LoadCheckData {
  bool checkable = false; 
  StringID error{}; 
  std::string error_msg{}; 
 
  uint32_t map_size_x = 0;
  uint32_t map_size_y = 0;
  TimerGameCalendar::Date current_date{};
 
  LandscapeType landscape{}; 
  TimerGameCalendar::Year starting_year{}; 
 
  CompanyPropertiesMap companies{}; 
 
  GRFConfigList grfconfig{}; 
  GRFListCompatibility grf_compatibility = GLC_NOT_FOUND; 
 
  Gamelog gamelog{}; 
 
  LoadCheckData() {}

  bool HasErrors()
  {
    return this->checkable && this->error != INVALID_STRING_ID;
  }

  bool HasNewGrfs()
  {
    return this->checkable && this->error == INVALID_STRING_ID && !this->grfconfig.empty();
  }
 
  void Clear();
};
 
extern LoadCheckData _load_check_data;

struct FiosItem {
  FiosType type;
  int64_t mtime;
  EncodedString title;
  std::string name;
  bool operator< (const FiosItem &other) const;
};

class FileList : public std::vector<FiosItem> {
public:
  void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop, bool show_dirs);
  const FiosItem *FindItem(std::string_view file);
};
 
enum SortingBits : uint8_t {
  SORT_ASCENDING  = 0,
  SORT_DESCENDING = 1,
  SORT_BY_DATE    = 0,
  SORT_BY_NAME    = 2
};
DECLARE_ENUM_AS_BIT_SET(SortingBits)
 
/* Variables to display file lists */
extern SortingBits _savegame_sort_order;
 
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop);
 
void FiosGetSavegameList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
void FiosGetScenarioList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
void FiosGetHeightmapList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
void FiosGetTownDataList(SaveLoadOperation fop, bool show_dirs, FileList &file_list);
 
bool FiosBrowseTo(const FiosItem *item);
 
std::string FiosGetCurrentPath();
std::optional<uint64_t> FiosGetDiskFreeSpace(const std::string &path);
std::string FiosMakeHeightmapName(std::string_view name);
std::string FiosMakeSavegameName(std::string_view name);
 
std::tuple<FiosType, std::string> FiosGetSavegameListCallback(SaveLoadOperation fop, std::string_view file, std::string_view ext);
std::tuple<FiosType, std::string> FiosGetScenarioListCallback(SaveLoadOperation fop, std::string_view file, std::string_view ext);
std::tuple<FiosType, std::string> FiosGetHeightmapListCallback(SaveLoadOperation fop, std::string_view file, std::string_view ext);
 
void ScanScenarios();
std::optional<std::string_view> FindScenario(const ContentInfo &ci, bool md5sum);

struct FiosNumberedSaveName {
  FiosNumberedSaveName(const std::string &prefix);
  std::string Filename();
  std::string Extension();
private:
  std::string prefix;
  int number;
};
 
#endif /* FIOS_H */