OpenTTD Source: src/fileio_func.h Source File

OpenTTD Source 14.0-RC3

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 void FioFCloseFile(FILE *f);
17 FILE *FioFOpenFile(const std::string &filename, const char *mode, Subdirectory subdir, size_t *filesize = nullptr);
18 bool FioCheckFileExists(const std::string &filename, Subdirectory subdir);
19 std::string FioFindFullPath(Subdirectory subdir, const std::string &filename);
20 std::string FioGetDirectory(Searchpath sp, Subdirectory subdir);
21 std::string FioFindDirectory(Subdirectory subdir);
22 void FioCreateDirectory(const std::string &name);
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:
39 Subdirectory subdir;
40 public:
42 virtual ~FileScanner() = default;
43
44 uint Scan(const char *extension, Subdirectory sd, bool tars = true, bool recursive = true);
45 uint Scan(const char *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
59 class TarScanner : FileScanner {
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,
70 ALL = BASESET | NEWGRF | AI | SCENARIO | GAME,
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
81 DECLARE_ENUM_AS_BIT_SET(TarScanner::Mode)
82
83 /* Implementation of opendir/readdir/closedir for Windows */
84 #if defined(_WIN32)
85 struct DIR;
86
87 struct dirent { // XXX - only d_name implemented
88 wchar_t *d_name; // name of found file
89 /* little hack which will point to parent DIR struct which will
90 * save us a call to GetFileAttributes if we want information
91 * about the file (for example in function fio_bla) */
92 DIR *dir;
93 };
94
95 DIR *opendir(const wchar_t *path);
96 struct dirent *readdir(DIR *d);
97 int closedir(DIR *d);
98 #else
99 /* Use system-supplied opendir/readdir/closedir functions */
100 # include <sys/types.h>
101 # include <dirent.h>
102 #endif /* defined(_WIN32) */
103
111 inline DIR *ttd_opendir(const char *path)
112 {
113 return opendir(OTTD2FS(path).c_str());
114 }
115
116
118 class FileCloser {
119 FILE *f;
120
121 public:
122 FileCloser(FILE *_f) : f(_f) {}
123 ~FileCloser()
124 {
125 fclose(f);
126 }
127 };
128
130 struct FileDeleter {
131 void operator()(FILE *f)
132 {
133 if (f) fclose(f);
134 }
135 };
136
137 #endif /* FILEIO_FUNC_H */
TarScanner::ALL
@ ALL
Scan for everything.
Definition: fileio_func.h:70
FioFCloseFile
void FioFCloseFile(FILE *f)
Close a file in a safe way.
Definition: fileio.cpp:148
ttd_opendir
DIR * ttd_opendir(const char *path)
A wrapper around opendir() which will convert the string from OPENTTD encoding to that of the filesys...
Definition: fileio_func.h:111
TarScanner::DoScan
uint DoScan(Subdirectory sd)
Perform the scanning of a particular subdirectory.
Definition: fileio.cpp:427
FioCreateDirectory
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:349
Searchpath
Searchpath
Types of searchpaths OpenTTD might use.
Definition: fileio_type.h:132
FileScanner::Scan
uint Scan(const char *extension, Subdirectory sd, bool tars=true, bool recursive=true)
Scan for files with the given extension in the given search path.
Definition: fileio.cpp:1213
FioCheckFileExists
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:126
AppendPathSeparator
void AppendPathSeparator(std::string &buf)
Appends, if necessary, the path separator character to the end of the string.
Definition: fileio.cpp:377
SanitizeFilename
void SanitizeFilename(std::string &filename)
Sanitizes a filename, i.e.
Definition: fileio.cpp:1088
FileCloser
Auto-close a file upon scope exit.
Definition: fileio_func.h:118
FileScanner::AddFile
virtual bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename)=0
Add a file with the given filename.
FileScanner::subdir
Subdirectory subdir
The current sub directory we are searching through.
Definition: fileio_func.h:39
TarScanner::NEWGRF
@ NEWGRF
Scan for non-base sets.
Definition: fileio_func.h:66
ReadFileToMem
std::unique_ptr< char[]> ReadFileToMem(const std::string &filename, size_t &lenp, size_t maxsize)
Load a file into memory.
Definition: fileio.cpp:1110
TarScanner::NONE
@ NONE
Scan nothing.
Definition: fileio_func.h:64
TarScanner::GAME
@ GAME
Scan for game scripts.
Definition: fileio_func.h:69
TarScanner::AddFile
bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename={}) override
Add a file with the given filename.
FileExists
bool FileExists(const std::string &filename)
Test whether the given filename exists.
Definition: fileio.cpp:140
DeterminePaths
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:965
TarScanner::SCENARIO
@ SCENARIO
Scan for scenarios and heightmaps.
Definition: fileio_func.h:68
DIR
Definition: win32.cpp:65
FileScanner::~FileScanner
virtual ~FileScanner()=default
Destruct the proper one...
_personal_dir
std::string _personal_dir
custom directory for personal settings, saves, newgrf, etc.
Definition: fileio.cpp:956
fileio_type.h
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
AI
Main AI class.
Definition: ai.hpp:19
enum_type.hpp
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
FileDeleter
Helper to manage a FILE with a std::unique_ptr.
Definition: fileio_func.h:130
TarScanner
Helper for scanning for files with tar as extension.
Definition: fileio_func.h:59
ExtractTar
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:677
FileScanner
Helper for scanning for files with a given name.
Definition: fileio_func.h:37
TarScanner::BASESET
@ BASESET
Scan for base sets.
Definition: fileio_func.h:65
FioFOpenFile
FILE * 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:263
TarScanner::Mode
Mode
The mode of tar scanning.
Definition: fileio_func.h:63
FioFindFullPath
std::string FioFindFullPath(Subdirectory subdir, const std::string &filename)
Find a path to the filename in one of the search directories.
Definition: fileio.cpp:159
OTTD2FS
std::wstring OTTD2FS(const std::string &name)
Convert from OpenTTD's encoding to a wide string.
Definition: win32.cpp:479
FiosGetScreenshotDir
const char * FiosGetScreenshotDir()
Get the directory for screenshots.
Definition: fios.cpp:597