fileio_func.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_FUNC_H
#define FILEIO_FUNC_H
 
#include "core/enum_type.hpp"
#include "fileio_type.h"
 
void FioFCloseFile(FILE *f);
FILE *FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize = nullptr);
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir);
std::string FioFindFullPath(Subdirectory subdir, const std::string &filename);
std::string FioGetDirectory(Searchpath sp, Subdirectory subdir);
std::string FioFindDirectory(Subdirectory subdir);
void FioCreateDirectory(const std::string &name);
 
const char *FiosGetScreenshotDir();
 
void SanitizeFilename(std::string &filename);
void AppendPathSeparator(std::string &buf);
void DeterminePaths(const char *exe, bool only_local_path);
std::unique_ptr<char[]> ReadFileToMem(const std::string &filename, size_t &lenp, size_t maxsize);
bool FileExists(const std::string &filename);
bool ExtractTar(const std::string &tar_filename, Subdirectory subdir);
 
extern std::string _personal_dir; 
extern std::vector<Searchpath> _valid_searchpaths;
 
class FileScanner {
protected:
  Subdirectory subdir; 
public:
  virtual ~FileScanner() = default;
 
  uint Scan(const char *extension, Subdirectory sd, bool tars = true, bool recursive = true);
  uint Scan(const char *extension, const std::string &directory, bool recursive = true);
 
  virtual bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) = 0;
};
 
class TarScanner : FileScanner {
  uint DoScan(Subdirectory sd);
public:
  enum Mode {
    NONE     = 0,      
    BASESET  = 1 << 0, 
    NEWGRF   = 1 << 1, 
    AI       = 1 << 2, 
    SCENARIO = 1 << 3, 
    GAME     = 1 << 4, 
    ALL      = BASESET | NEWGRF | AI | SCENARIO | GAME, 
  };
 
  bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename = {}) override;
 
  bool AddFile(Subdirectory sd, const std::string &filename);
 
  static uint DoScan(TarScanner::Mode mode);
};
 
DECLARE_ENUM_AS_BIT_SET(TarScanner::Mode)
 
/* Implementation of opendir/readdir/closedir for Windows */
#if defined(_WIN32)
struct DIR;
 
struct dirent { // XXX - only d_name implemented
  wchar_t *d_name; // name of found file
  /* little hack which will point to parent DIR struct which will
   * save us a call to GetFileAttributes if we want information
   * about the file (for example in function fio_bla) */
  DIR *dir;
};
 
DIR *opendir(const wchar_t *path);
struct dirent *readdir(DIR *d);
int closedir(DIR *d);
#else
/* Use system-supplied opendir/readdir/closedir functions */
# include <sys/types.h>
# include <dirent.h>
#endif /* defined(_WIN32) */
 
inline DIR *ttd_opendir(const char *path)
{
  return opendir(OTTD2FS(path).c_str());
}
 
 
class FileCloser {
  FILE *f;
 
public:
  FileCloser(FILE *_f) : f(_f) {}
  ~FileCloser()
  {
    fclose(f);
  }
};
 
struct FileDeleter {
  void operator()(FILE *f)
  {
    if (f) fclose(f);
  }
};
 
#endif /* FILEIO_FUNC_H */