OpenTTD Source  20241108-master-g80f628063a
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. More...
 
 ~ZlibSaveFilter ()
 Clean up what we allocated.
 
void WriteLoop (uint8_t *p, size_t len, int mode)
 Helper loop for writing the data. More...
 
void Write (uint8_t *buf, size_t size) override
 Write a given number of bytes into the savegame. More...
 
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. More...
 
virtual ~SaveFilter ()
 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< SaveFilterchain
 Chained to the (savegame) filters.
 

Detailed Description

Filter using Zlib compression.

Definition at line 2459 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 2468 of file saveload.cpp.

References SlError().

Member Function Documentation

◆ 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 2514 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 2486 of file saveload.cpp.

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

Referenced by Finish(), and Write().


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