FiosFileScanner Class Reference

Scanner to scan for a particular type of FIOS file. More...

Inheritance diagram for FiosFileScanner:

Public Member Functions
	FiosFileScanner (SaveLoadOperation fop, FiosGetTypeAndNameProc *callback_proc, FileList &file_list)
	Create the scanner.
bool	AddFile (const std::string &filename, size_t basepath_length, const std::string &tar_filename) override
	Try to add a fios item set with the given filename.
Public Member Functions inherited from FileScanner
virtual	~FileScanner ()=default
	Destruct the proper one...
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.
uint	Scan (std::string_view extension, const std::string &directory, bool recursive=true)
	Scan for files with the given extension in the given search path.

Private Attributes
SaveLoadOperation	fop
	The kind of file we are looking for.
FiosGetTypeAndNameProc *	callback_proc
	Callback to check whether the file may be added.
FileList &	file_list
	Destination of the found files.

Additional Inherited Members
Protected Attributes inherited from FileScanner
Subdirectory	subdir
	The current sub directory we are searching through.

Detailed Description

Scanner to scan for a particular type of FIOS file.

Definition at line 258 of file fios.cpp.

Constructor & Destructor Documentation

FiosFileScanner()

FiosFileScanner::FiosFileScanner ( SaveLoadOperation  fop, FiosGetTypeAndNameProc *  callback_proc, FileList &  file_list  )

inline

Create the scanner.

Parameters

fop	Purpose of collecting the list.
callback_proc	The function that is called where you need to do the filtering.
file_list	Destination of the found files.

Definition at line 269 of file fios.cpp.

Member Function Documentation

AddFile()

bool FiosFileScanner::AddFile ( const std::string &  filename, size_t  basepath_length, const std::string &  tar_filename  )

overridevirtual

Try to add a fios item set with the given filename.

Parameters

filename

the full path to the file to read

Returns

true if the file is added.

Implements FileScanner.

Definition at line 281 of file fios.cpp.

References callback_proc, file_list, fop, OTTD2FS(), and StrMakeValid().

Field Documentation

callback_proc

FiosGetTypeAndNameProc* FiosFileScanner::callback_proc

private

Callback to check whether the file may be added.

Definition at line 260 of file fios.cpp.

Referenced by AddFile().

file_list

FileList& FiosFileScanner::file_list

private

Destination of the found files.

Definition at line 261 of file fios.cpp.

Referenced by AddFile().

fop

SaveLoadOperation FiosFileScanner::fop

private

The kind of file we are looking for.

Definition at line 259 of file fios.cpp.

Referenced by AddFile().

---

The documentation for this class was generated from the following file:

• src/fios.cpp