OpenTTD Source: HeaderWriter Struct Reference

OpenTTD Source 13.2.1

Public Member Functions
HeaderWriter Struct Referenceabstract

Base class for writing the header, i.e. More...

`#include <strgen.h>`

Inheritance diagram for HeaderWriter:

## Public Member Functions
virtual void | WriteStringID (const char *name, int stringid)=0
| Write the string ID. More...
virtual void | Finalise (const StringData &data)=0
| Finalise writing the file. More...
virtual | ~HeaderWriter ()
| Especially destroy the subclasses.
void | WriteHeader (const StringData &data)
| Write the header information. More...

## Detailed Description

Base class for writing the header, i.e.

the STR_XXX to numeric value.

Definition at line 91 of file strgen.h.

## Member Function Documentation

## ◆ Finalise()

virtual void HeaderWriter::Finalise | ( | const StringData & | data | ) |
| pure virtual

Finalise writing the file.

Parameters

  data | The data about the string.

Implemented in HeaderFileWriter, and StringNameWriter.

## ◆ WriteHeader()

void HeaderWriter::WriteHeader | ( | const StringData & | data | ) |

Write the header information.

Parameters

  data | The data about the string.

Definition at line 850 of file strgen_base.cpp.

References StringData::max_strings, LangString::name, StringData::strings, and WriteStringID().

## ◆ WriteStringID()

virtual void HeaderWriter::WriteStringID | ( | const char * | name,
|  | int | stringid
| ) |  |
| pure virtual

Write the string ID.

Parameters

  name | The name of the string.
  stringid | The ID of the string.

Implemented in HeaderFileWriter, and StringNameWriter.

Referenced by WriteHeader().

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

- src/strgen/strgen.h
- src/strgen/strgen_base.cpp