OpenTTD Source: OutputStore Class Reference

OpenTTD Source 14.0-RC3

Public Member Functions | Private Types | Private Member Functions | Private Attributes
OutputStore Class Reference

Temporarily store output. More...

## Public Member Functions
void | Clear ()
| Clear the temporary storage.
void | Add (const char *text, size_t length=0)
| Add text to the output storage. More...
void | Write (FILE *out_fp) const
| Write all stored output to the output stream. More...

## Private Types
typedef std::vector< OutputBuffer > | OutputBufferVector
| Vector type for output buffers.

## Private Member Functions
bool | BufferHasRoom () const
| Does the buffer have room without adding a new OutputBuffer block? More...

## Private Attributes
OutputBufferVector | output_buffer
| Vector of blocks containing the stored output.

## Detailed Description

Temporarily store output.

Definition at line 87 of file settingsgen.cpp.

## Member Function Documentation

## ◆ Add()

void OutputStore::Add | ( | const char * | text,
|  | size_t | length = `0`
| ) |  |
| inline

Add text to the output storage.

Parameters

  text | Text to store.
  length | Length of the text in bytes, `0` means 'length of the string'.

Definition at line 105 of file settingsgen.cpp.

References OutputBuffer::Add(), BufferHasRoom(), OutputBuffer::Clear(), and output_buffer.

Referenced by DumpGroup(), and DumpLine().

## ◆ BufferHasRoom()

bool OutputStore::BufferHasRoom | ( |  | ) | const
| inlineprivate

Does the buffer have room without adding a new OutputBuffer block?

Returns
  `true` if room is available, else `false`.

Definition at line 139 of file settingsgen.cpp.

References output_buffer.

Referenced by Add().

## ◆ Write()

void OutputStore::Write | ( | FILE * | out_fp | ) | const
| inline

Write all stored output to the output stream.

Parameters

  out_fp | Stream to write the data to.

Definition at line 127 of file settingsgen.cpp.

References output_buffer.

Referenced by main().

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

- src/settingsgen/settingsgen.cpp