OpenTTD Source  20241108-master-g80f628063a
fileio_func.h
Go to the documentation of this file.
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 
10 #ifndef FILEIO_FUNC_H
11 #define FILEIO_FUNC_H
12 
13 #include "core/enum_type.hpp"
14 #include "fileio_type.h"
15 
16 std::optional<FileHandle> FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize = nullptr);
17 bool FioCheckFileExists(const std::string &filename, Subdirectory subdir);
18 std::string FioFindFullPath(Subdirectory subdir, const std::string &filename);
19 std::string FioGetDirectory(Searchpath sp, Subdirectory subdir);
20 std::string FioFindDirectory(Subdirectory subdir);
21 void FioCreateDirectory(const std::string &name);
22 bool FioRemove(const std::string &filename);
23 
24 const char *FiosGetScreenshotDir();
25 
26 void SanitizeFilename(std::string &filename);
27 void AppendPathSeparator(std::string &buf);
28 void DeterminePaths(const char *exe, bool only_local_path);
29 std::unique_ptr<char[]> ReadFileToMem(const std::string &filename, size_t &lenp, size_t maxsize);
30 bool FileExists(const std::string &filename);
31 bool ExtractTar(const std::string &tar_filename, Subdirectory subdir);
32 
33 extern std::string _personal_dir;
34 extern std::vector<Searchpath> _valid_searchpaths;
35 
37 class FileScanner {
38 protected:
40 public:
42  virtual ~FileScanner() = default;
43 
44  uint Scan(std::string_view extension, Subdirectory sd, bool tars = true, bool recursive = true);
45  uint Scan(std::string_view extension, const std::string &directory, bool recursive = true);
46 
55  virtual bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) = 0;
56 };
57 
60  uint DoScan(Subdirectory sd);
61 public:
63  enum Mode {
64  NONE = 0,
65  BASESET = 1 << 0,
66  NEWGRF = 1 << 1,
67  AI = 1 << 2,
68  SCENARIO = 1 << 3,
69  GAME = 1 << 4,
71  };
72 
73  bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename = {}) override;
74 
75  bool AddFile(Subdirectory sd, const std::string &filename);
76 
78  static uint DoScan(TarScanner::Mode mode);
79 };
80 
82 
83 #endif /* FILEIO_FUNC_H */
Main AI class.
Definition: ai.hpp:19
Helper for scanning for files with a given name.
Definition: fileio_func.h:37
uint Scan(std::string_view extension, Subdirectory sd, bool tars=true, bool recursive=true)
Scan for files with the given extension in the given search path.
Definition: fileio.cpp:1114
virtual ~FileScanner()=default
Destruct the proper one...
virtual bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename)=0
Add a file with the given filename.
Subdirectory subdir
The current sub directory we are searching through.
Definition: fileio_func.h:39
Helper for scanning for files with tar as extension.
Definition: fileio_func.h:59
uint DoScan(Subdirectory sd)
Perform the scanning of a particular subdirectory.
Definition: fileio.cpp:375
Mode
The mode of tar scanning.
Definition: fileio_func.h:63
@ NEWGRF
Scan for non-base sets.
Definition: fileio_func.h:66
@ BASESET
Scan for base sets.
Definition: fileio_func.h:65
@ NONE
Scan nothing.
Definition: fileio_func.h:64
@ GAME
Scan for game scripts.
Definition: fileio_func.h:69
@ SCENARIO
Scan for scenarios and heightmaps.
Definition: fileio_func.h:68
@ ALL
Scan for everything.
Definition: fileio_func.h:70
bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename={}) override
Add a file with the given filename.
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Type (helpers) for enums.
std::string FioFindFullPath(Subdirectory subdir, const std::string &filename)
Find a path to the filename in one of the search directories.
Definition: fileio.cpp:144
bool ExtractTar(const std::string &tar_filename, Subdirectory subdir)
Extract the tar with the given filename in the directory where the tar resides.
Definition: fileio.cpp:590
void DeterminePaths(const char *exe, bool only_local_path)
Acquire the base paths (personal dir and game data dir), fill all other paths (save dir,...
Definition: fileio.cpp:878
bool FioRemove(const std::string &filename)
Remove a file.
Definition: fileio.cpp:328
void SanitizeFilename(std::string &filename)
Sanitizes a filename, i.e.
Definition: fileio.cpp:1003
void AppendPathSeparator(std::string &buf)
Appends, if necessary, the path separator character to the end of the string.
Definition: fileio.cpp:346
std::string _personal_dir
custom directory for personal settings, saves, newgrf, etc.
Definition: fileio.cpp:869
std::optional< FileHandle > FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize=nullptr)
Opens a OpenTTD file somewhere in a personal or global directory.
Definition: fileio.cpp:242
const char * FiosGetScreenshotDir()
Get the directory for screenshots.
Definition: fios.cpp:602
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:121
void FioCreateDirectory(const std::string &name)
Create a directory with the given name If the parent directory does not exist, it will try to create ...
Definition: fileio.cpp:316
bool FileExists(const std::string &filename)
Test whether the given filename exists.
Definition: fileio.cpp:132
std::unique_ptr< char[]> ReadFileToMem(const std::string &filename, size_t &lenp, size_t maxsize)
Load a file into memory.
Definition: fileio.cpp:1025
Types for Standard In/Out file operations.
Searchpath
Types of searchpaths OpenTTD might use.
Definition: fileio_type.h:139
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:115