fileio_type.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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef FILEIO_TYPE_H
#define FILEIO_TYPE_H
 
#include "core/enum_type.hpp"
 
enum AbstractFileType : uint8_t {
  FT_NONE,      
  FT_SAVEGAME,  
  FT_SCENARIO,  
  FT_HEIGHTMAP, 
  FT_TOWN_DATA, 
 
  FT_INVALID = 7, 
  FT_NUMBITS = 3, 
  FT_MASK = (1 << FT_NUMBITS) - 1, 
};
 
enum DetailedFileType : uint8_t {
  /* Save game and scenario files. */
  DFT_OLD_GAME_FILE, 
  DFT_GAME_FILE,     
 
  /* Heightmap files. */
  DFT_HEIGHTMAP_BMP, 
  DFT_HEIGHTMAP_PNG, 
 
  /* Town data files. */
  DFT_TOWN_DATA_JSON,  
 
  /* fios 'files' */
  DFT_FIOS_DRIVE,  
  DFT_FIOS_PARENT, 
  DFT_FIOS_DIR,    
  DFT_FIOS_DIRECT, 
 
  DFT_END,         
 
  DFT_INVALID = 255, 
};
 
enum SaveLoadOperation : uint8_t {
  SLO_CHECK,   
  SLO_LOAD,    
  SLO_SAVE,    
 
  SLO_INVALID, 
};
 
#define MAKE_FIOS_TYPE(abstract, detailed) ((abstract) | ((detailed) << FT_NUMBITS))
 
enum FiosType : uint16_t {
  FIOS_TYPE_DRIVE  = MAKE_FIOS_TYPE(FT_NONE, DFT_FIOS_DRIVE),
  FIOS_TYPE_PARENT = MAKE_FIOS_TYPE(FT_NONE, DFT_FIOS_PARENT),
  FIOS_TYPE_DIR    = MAKE_FIOS_TYPE(FT_NONE, DFT_FIOS_DIR),
  FIOS_TYPE_DIRECT = MAKE_FIOS_TYPE(FT_NONE, DFT_FIOS_DIRECT),
 
  FIOS_TYPE_FILE         = MAKE_FIOS_TYPE(FT_SAVEGAME, DFT_GAME_FILE),
  FIOS_TYPE_OLDFILE      = MAKE_FIOS_TYPE(FT_SAVEGAME, DFT_OLD_GAME_FILE),
  FIOS_TYPE_SCENARIO     = MAKE_FIOS_TYPE(FT_SCENARIO, DFT_GAME_FILE),
  FIOS_TYPE_OLD_SCENARIO = MAKE_FIOS_TYPE(FT_SCENARIO, DFT_OLD_GAME_FILE),
  FIOS_TYPE_PNG          = MAKE_FIOS_TYPE(FT_HEIGHTMAP, DFT_HEIGHTMAP_PNG),
  FIOS_TYPE_BMP          = MAKE_FIOS_TYPE(FT_HEIGHTMAP, DFT_HEIGHTMAP_BMP),
  FIOS_TYPE_JSON         = MAKE_FIOS_TYPE(FT_TOWN_DATA, DFT_TOWN_DATA_JSON),
 
  FIOS_TYPE_INVALID = MAKE_FIOS_TYPE(FT_INVALID, DFT_INVALID),
};
 
#undef MAKE_FIOS_TYPE
 
inline AbstractFileType GetAbstractFileType(FiosType fios_type)
{
  return static_cast<AbstractFileType>(static_cast<uint>(fios_type) & FT_MASK);
}
 
inline DetailedFileType GetDetailedFileType(FiosType fios_type)
{
  return static_cast<DetailedFileType>(fios_type >> FT_NUMBITS);
}
 
enum Subdirectory : uint8_t {
  BASE_DIR,      
  SAVE_DIR,      
  AUTOSAVE_DIR,  
  SCENARIO_DIR,  
  HEIGHTMAP_DIR, 
  OLD_GM_DIR,    
  OLD_DATA_DIR,  
  BASESET_DIR,   
  NEWGRF_DIR,    
  LANG_DIR,      
  AI_DIR,        
  AI_LIBRARY_DIR,
  GAME_DIR,      
  GAME_LIBRARY_DIR, 
  SCREENSHOT_DIR,   
  SOCIAL_INTEGRATION_DIR, 
  DOCS_DIR,      
  NUM_SUBDIRS,   
  NO_DIRECTORY,  
};
 
enum Searchpath : uint8_t {
  SP_FIRST_DIR,
  SP_WORKING_DIR = SP_FIRST_DIR, 
#ifdef USE_XDG
  SP_PERSONAL_DIR_XDG,           
#endif
  SP_PERSONAL_DIR,               
  SP_SHARED_DIR,                 
  SP_BINARY_DIR,                 
  SP_INSTALLATION_DIR,           
  SP_APPLICATION_BUNDLE_DIR,     
  SP_AUTODOWNLOAD_DIR,           
  SP_AUTODOWNLOAD_PERSONAL_DIR,  
  SP_AUTODOWNLOAD_PERSONAL_DIR_XDG, 
  NUM_SEARCHPATHS
};
 
DECLARE_INCREMENT_DECREMENT_OPERATORS(Searchpath)
 
class FileHandle {
public:
  static std::optional<FileHandle> Open(const std::string &filename, const std::string &mode);
 
  inline void Close() { this->f.reset(); }
 
  inline operator FILE *()
  {
    assert(this->f != nullptr);
    return this->f.get();
  }
 
private:
  struct FileDeleter {
    void operator ()(FILE *f)
    {
      if (f != nullptr) fclose(f);
    }
  };
 
  std::unique_ptr<FILE, FileDeleter> f;
 
  FileHandle(FILE *f) : f(f) { assert(this->f != nullptr); }
};
 
/* Ensure has_value() is used consistently. */
template <> constexpr std::optional<FileHandle>::operator bool() const noexcept = delete;
 
#endif /* FILEIO_TYPE_H */