OpenTTD Source 20241224-master-gee860a5c8e
LanguageScanner Class Reference

Scanner to find language files in a GameScript directory. More...

Inheritance diagram for LanguageScanner:
FileScanner

Public Member Functions

 LanguageScanner (GameStrings *gs, const std::string &exclude)
 Initialise.
 
void Scan (const std::string &directory)
 Scan.
 
bool AddFile (const std::string &filename, size_t, const std::string &) override
 Add a file with the given filename.
 

Private Attributes

GameStringsgs
 
std::string exclude
 

Additional Inherited Members

- Protected 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.
 
- Protected Attributes inherited from FileScanner
Subdirectory subdir
 The current sub directory we are searching through.
 

Detailed Description

Scanner to find language files in a GameScript directory.

Definition at line 169 of file game_text.cpp.

Constructor & Destructor Documentation

◆ LanguageScanner()

LanguageScanner::LanguageScanner ( GameStrings gs,
const std::string &  exclude 
)
inline

Initialise.

Definition at line 176 of file game_text.cpp.

Member Function Documentation

◆ AddFile()

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

Add a file with the given filename.

Parameters
filenamethe full path to the file to read
basepath_lengthamount of characters to chop of before to get a filename relative to the search path.
tar_filenamethe name of the tar file the file is read from.
Returns
true if the file is added.

Implements FileScanner.

Definition at line 186 of file game_text.cpp.

References GameStrings::raw_strings, and ReadRawLanguageStrings().

Referenced by LoadTranslations().

◆ Scan()

void LanguageScanner::Scan ( const std::string &  directory)
inline

Scan.

Definition at line 181 of file game_text.cpp.

References FileScanner::Scan().

Referenced by LoadTranslations().

Field Documentation

◆ exclude

std::string LanguageScanner::exclude
private

Definition at line 172 of file game_text.cpp.

◆ gs

GameStrings* LanguageScanner::gs
private

Definition at line 171 of file game_text.cpp.


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