OpenTTD
Public Member Functions | Data Fields
StringReader Struct Reference

Helper for reading strings. More...

#include <strgen.h>

Inheritance diagram for StringReader:
FileStringReader StringListReader

Public Member Functions

 StringReader (StringData &data, const char *file, bool master, bool translation)
 Prepare reading.
virtual ~StringReader ()
 Make sure the right reader gets freed.
void HandleString (char *str)
virtual char * ReadLine (char *buffer, const char *last)=0
 Read a single line from the source of strings.
virtual void HandlePragma (char *str)
 Handle the pragma of the file.
virtual void ParseFile ()
 Start parsing the file.

Data Fields

StringDatadata
 The data to fill during reading.
const char * file
 The file we are reading.
bool master
 Are we reading the master file?
bool translation
 Are we reading a translation, implies !master. However, the base translation will have this false.

Detailed Description

Helper for reading strings.

Definition at line 62 of file strgen.h.

Constructor & Destructor Documentation

StringReader::StringReader ( StringData data,
const char *  file,
bool  master,
bool  translation 
)

Prepare reading.

Parameters
dataThe data to fill during reading.
fileThe file we are reading.
masterAre we reading the master file?
translationAre we reading a translation?

Definition at line 588 of file strgen_base.cpp.

StringReader::~StringReader ( )
virtual

Make sure the right reader gets freed.

Definition at line 594 of file strgen_base.cpp.

References file, and free().

Member Function Documentation

void StringReader::HandlePragma ( char *  str)
virtual

Handle the pragma of the file.

Parameters
strThe pragma string to parse.

Reimplemented in FileStringReader.

Definition at line 799 of file strgen_base.cpp.

References _plural_forms, lengthof, and LanguagePackHeader::plural_form.

virtual char* StringReader::ReadLine ( char *  buffer,
const char *  last 
)
pure virtual

Read a single line from the source of strings.

Parameters
bufferThe buffer to read the data in to.
lastThe last element in the buffer.
Returns
The buffer, or NULL if at the end of the file.

Implemented in StringListReader, and FileStringReader.

Referenced by ParseFile().


The documentation for this struct was generated from the following files: