OpenTTD Source 20260206-master-g4d4e37dbf1
ZlibSaveFilter Struct Reference

Filter using Zlib compression. More...

Inheritance diagram for ZlibSaveFilter:
SaveFilter

Public Member Functions

 ZlibSaveFilter (std::shared_ptr< SaveFilter > chain, uint8_t compression_level)
 Initialise this filter.
 ~ZlibSaveFilter () override
 Clean up what we allocated.
void WriteLoop (uint8_t *p, size_t len, int mode)
 Helper loop for writing the data.
void Write (uint8_t *buf, size_t size) override
 Write a given number of bytes into the savegame.
void Finish () override
 Prepare everything to finish writing the savegame.
Public Member Functions inherited from SaveFilter
 SaveFilter (std::shared_ptr< SaveFilter > chain)
 Initialise this filter.
virtual ~SaveFilter ()=default
 Make sure the writers are properly closed.

Data Fields

z_stream z {}
 Stream state we are writing to.
uint8_t fwrite_buf [MEMORY_CHUNK_SIZE]
 Buffer for writing to the file.
Data Fields inherited from SaveFilter
std::shared_ptr< SaveFilter > chain
 Chained to the (savegame) filters.

Detailed Description

Filter using Zlib compression.

Definition at line 2606 of file saveload.cpp.

Constructor & Destructor Documentation

◆ ZlibSaveFilter()

ZlibSaveFilter::ZlibSaveFilter ( std::shared_ptr< SaveFilter > chain,
uint8_t compression_level )
inline

Initialise this filter.

Parameters
chainThe next filter in this chain.
compression_levelThe requested level of compression.

Definition at line 2615 of file saveload.cpp.

References SaveFilter::chain, SaveFilter::SaveFilter(), and SlError().

◆ ~ZlibSaveFilter()

ZlibSaveFilter::~ZlibSaveFilter ( )
inlineoverride

Clean up what we allocated.

Definition at line 2621 of file saveload.cpp.

Member Function Documentation

◆ Finish()

void ZlibSaveFilter::Finish ( )
inlineoverridevirtual

Prepare everything to finish writing the savegame.

Reimplemented from SaveFilter.

Definition at line 2665 of file saveload.cpp.

References SaveFilter::chain, and WriteLoop().

◆ Write()

void ZlibSaveFilter::Write ( uint8_t * buf,
size_t len )
inlineoverridevirtual

Write a given number of bytes into the savegame.

Parameters
bufThe bytes to write.
lenThe number of bytes to write.

Implements SaveFilter.

Definition at line 2660 of file saveload.cpp.

References WriteLoop().

◆ WriteLoop()

void ZlibSaveFilter::WriteLoop ( uint8_t * p,
size_t len,
int mode )
inline

Helper loop for writing the data.

Parameters
pThe bytes to write.
lenAmount of bytes to write.
modeMode for deflate.

For the poor next soul who sees many valgrind warnings of the "Conditional jump or move depends on uninitialised value(s)" kind: According to the author of zlib it is not a bug and it won't be fixed. http://groups.google.com/group/comp.compression/browse_thread/thread/b154b8def8c2a3ef/cdf9b8729ce17ee2 [Mark Adler, Feb 24 2004, 'zlib-1.2.1 valgrind warnings' in the newsgroup comp.compression]

Definition at line 2632 of file saveload.cpp.

References SaveFilter::chain, and SlError().

Referenced by Finish(), and Write().

Field Documentation

◆ fwrite_buf

uint8_t ZlibSaveFilter::fwrite_buf[MEMORY_CHUNK_SIZE]

Buffer for writing to the file.

Definition at line 2608 of file saveload.cpp.

◆ z

z_stream ZlibSaveFilter::z {}

Stream state we are writing to.

Definition at line 2607 of file saveload.cpp.

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