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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef FILEIO_TYPE_H
#define FILEIO_TYPE_H
 
#include "core/enum_type.hpp"
#include "misc/autorelease.hpp"

enum class AbstractFileType : uint8_t {
  None, 
  Savegame, 
  Scenario, 
  Heightmap, 
  TownData, 
 
  Invalid = 7, 
};

enum class DetailedFileType : uint8_t {
  /* Save game and scenario files. */
  OldGameFile, 
  GameFile, 
 
  /* Heightmap files. */
  HeightmapBmp, 
  HeightmapPng, 
 
  /* Town data files. */
  TownDataJson, 
 
  /* fios 'files' */
  FiosDrive, 
  FiosParent, 
  FiosDirectory, 
  FiosDirect, 
 
  End, 
 
  Invalid = 255, 
};

enum class SaveLoadOperation : uint8_t {
  Check, 
  Load, 
  Save, 
 
  Invalid, 
};

struct FiosType {
  AbstractFileType abstract; 
  DetailedFileType detailed; 
 
  constexpr bool operator==(const FiosType &) const noexcept = default;
};
 
constexpr FiosType FIOS_TYPE_DRIVE{AbstractFileType::None, DetailedFileType::FiosDrive};
constexpr FiosType FIOS_TYPE_PARENT{AbstractFileType::None, DetailedFileType::FiosParent};
constexpr FiosType FIOS_TYPE_DIR{AbstractFileType::None, DetailedFileType::FiosDirectory};
constexpr FiosType FIOS_TYPE_DIRECT{AbstractFileType::None, DetailedFileType::FiosDirect};
 
constexpr FiosType FIOS_TYPE_FILE{AbstractFileType::Savegame, DetailedFileType::GameFile};
constexpr FiosType FIOS_TYPE_OLDFILE{AbstractFileType::Savegame, DetailedFileType::OldGameFile};
constexpr FiosType FIOS_TYPE_SCENARIO{AbstractFileType::Scenario, DetailedFileType::GameFile};
constexpr FiosType FIOS_TYPE_OLD_SCENARIO{AbstractFileType::Scenario, DetailedFileType::OldGameFile};
constexpr FiosType FIOS_TYPE_PNG{AbstractFileType::Heightmap, DetailedFileType::HeightmapPng};
constexpr FiosType FIOS_TYPE_BMP{AbstractFileType::Heightmap, DetailedFileType::HeightmapBmp};
constexpr FiosType FIOS_TYPE_JSON{AbstractFileType::TownData, DetailedFileType::TownDataJson};
 
constexpr FiosType FIOS_TYPE_INVALID{AbstractFileType::Invalid, DetailedFileType::Invalid};

enum class Subdirectory : uint8_t {
  Base, 
  Save, 
  Autosave, 
  Scenario, 
  Heightmap, 
  OldGm, 
  OldData, 
  Baseset, 
  NewGrf, 
  Lang, 
  Ai, 
  AiLibrary, 
  Gs, 
  GsLibrary, 
  Screenshot, 
  SocialIntegration, 
  Docs, 
  End, 
  None, 
};

enum class Searchpath : uint8_t {
  Begin, 
  WorkingDir = Searchpath::Begin, 
#ifdef USE_XDG
  PersonalDirXdg, 
#endif
  PersonalDir, 
  SharedDir, 
  BinaryDir, 
  InstallationDir, 
  ApplicationBundleDir, 
  AutodownloadDir, 
  AutodownloadPersonalDir,
  AutodownloadPersonalDirXdg, 
  End, 
};
 
DECLARE_INCREMENT_DECREMENT_OPERATORS(Searchpath)
 
class FileHandle {
public:
  static std::optional<FileHandle> Open(const std::string &filename, std::string_view mode);

  static std::optional<FileHandle> Open(std::string_view filename, std::string_view mode) { return FileHandle::Open(std::string{filename}, mode); }
 
  inline void Close() { this->f.reset(); }
 
  inline operator FILE *()
  {
    assert(this->f != nullptr);
    return this->f.get();
  }
 
private:
  AutoRelease<FILE, fclose> 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 */