OpenTTD
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
saveload.cpp File Reference

All actions handling saving and loading goes on in this file. More...

#include "../stdafx.h"
#include "../debug.h"
#include "../station_base.h"
#include "../thread/thread.h"
#include "../town.h"
#include "../network/network.h"
#include "../window_func.h"
#include "../strings_func.h"
#include "../core/endian_func.hpp"
#include "../vehicle_base.h"
#include "../company_func.h"
#include "../date_func.h"
#include "../autoreplace_base.h"
#include "../roadstop_base.h"
#include "../linkgraph/linkgraph.h"
#include "../linkgraph/linkgraphjob.h"
#include "../statusbar_gui.h"
#include "../fileio_func.h"
#include "../gamelog.h"
#include "../string_func.h"
#include "../fios.h"
#include "../error.h"
#include "table/strings.h"
#include "saveload_internal.h"
#include "saveload_filter.h"
#include "../safeguards.h"
#include <lzo/lzo1x.h>
#include <zlib.h>
#include <lzma.h>

Go to the source code of this file.

Data Structures

struct  ReadBuffer
 A buffer for reading (and buffering) savegame data. More...
 
struct  MemoryDumper
 Container for dumping the savegame (quickly) to memory. More...
 
struct  SaveLoadParams
 The saveload struct, containing reader-writer functions, buffer, version, etc. More...
 
struct  FileReader
 Yes, simply reading from a file. More...
 
struct  FileWriter
 Yes, simply writing to a file. More...
 
struct  LZOLoadFilter
 Filter using LZO compression. More...
 
struct  LZOSaveFilter
 Filter using LZO compression. More...
 
struct  NoCompLoadFilter
 Filter without any compression. More...
 
struct  NoCompSaveFilter
 Filter without any compression. More...
 
struct  ZlibLoadFilter
 Filter using Zlib compression. More...
 
struct  ZlibSaveFilter
 Filter using Zlib compression. More...
 
struct  LZMALoadFilter
 Filter without any compression. More...
 
struct  LZMASaveFilter
 Filter using LZMA compression. More...
 
struct  SaveLoadFormat
 The format for a reader/writer type of a savegame. More...
 

Macros

#define FOR_ALL_CHUNK_HANDLERS(ch)
 Iterate over all chunk handlers. More...
 

Typedefs

typedef void(* AsyncSaveFinishProc) ()
 Callback for when the savegame loading is finished.
 

Enumerations

enum  SaveLoadAction {
  SLA_LOAD, SLA_SAVE, SLA_PTRS, SLA_NULL,
  SLA_LOAD_CHECK
}
 What are we currently doing? More...
 
enum  NeedLength { NL_NONE = 0, NL_WANTLENGTH = 1, NL_CALCLENGTH = 2 }
 

Functions

static void SlNullPointers ()
 Null all pointers (convert index -> NULL)
 
void NORETURN SlError (StringID string, const char *extra_msg)
 Error handler. More...
 
void NORETURN SlErrorCorrupt (const char *msg)
 Error handler for corrupt savegames. More...
 
static void SetAsyncSaveFinish (AsyncSaveFinishProc proc)
 Called by save thread to tell we finished saving. More...
 
void ProcessAsyncSaveFinish ()
 Handle async save finishes.
 
byte SlReadByte ()
 Wrapper for reading a byte from the buffer. More...
 
void SlWriteByte (byte b)
 Wrapper for writing a byte to the dumper. More...
 
static int SlReadUint16 ()
 
static uint32 SlReadUint32 ()
 
static uint64 SlReadUint64 ()
 
static void SlWriteUint16 (uint16 v)
 
static void SlWriteUint32 (uint32 v)
 
static void SlWriteUint64 (uint64 x)
 
static void SlSkipBytes (size_t length)
 Read in bytes from the file/data structure but don't do anything with them, discarding them in effect. More...
 
static uint SlReadSimpleGamma ()
 Read in the header descriptor of an object or an array. More...
 
static void SlWriteSimpleGamma (size_t i)
 Write the header descriptor of an object or an array. More...
 
static uint SlGetGammaLength (size_t i)
 Return how many bytes used to encode a gamma value.
 
static uint SlReadSparseIndex ()
 
static void SlWriteSparseIndex (uint index)
 
static uint SlReadArrayLength ()
 
static void SlWriteArrayLength (size_t length)
 
static uint SlGetArrayLength (size_t length)
 
static uint SlCalcConvMemLen (VarType conv)
 Return the size in bytes of a certain type of normal/atomic variable as it appears in memory. More...
 
static byte SlCalcConvFileLen (VarType conv)
 Return the size in bytes of a certain type of normal/atomic variable as it appears in a saved game. More...
 
static size_t SlCalcRefLen ()
 Return the size in bytes of a reference (pointer)
 
void SlSetArrayIndex (uint index)
 
int SlIterateArray ()
 Iterate through the elements of an array and read the whole thing. More...
 
void SlSkipArray ()
 Skip an array or sparse array.
 
void SlSetLength (size_t length)
 Sets the length of either a RIFF object or the number of items in an array. More...
 
static void SlCopyBytes (void *ptr, size_t length)
 Save/Load bytes. More...
 
size_t SlGetFieldLength ()
 Get the length of the current object.
 
int64 ReadValue (const void *ptr, VarType conv)
 Return a signed-long version of the value of a setting. More...
 
void WriteValue (void *ptr, VarType conv, int64 val)
 Write the value of a setting. More...
 
static void SlSaveLoadConv (void *ptr, VarType conv)
 Handle all conversion and typechecking of variables here. More...
 
static size_t SlCalcNetStringLen (const char *ptr, size_t length)
 Calculate the net length of a string. More...
 
static size_t SlCalcStringLen (const void *ptr, size_t length, VarType conv)
 Calculate the gross length of the string that it will occupy in the savegame. More...
 
static void SlString (void *ptr, size_t length, VarType conv)
 Save/Load a string. More...
 
static size_t SlCalcArrayLen (size_t length, VarType conv)
 Return the size in bytes of a certain type of atomic array. More...
 
void SlArray (void *array, size_t length, VarType conv)
 Save/Load an array. More...
 
static size_t ReferenceToInt (const void *obj, SLRefType rt)
 Pointers cannot be saved to a savegame, so this functions gets the index of the item, and if not available, it hussles with pointers (looks really bad :() Remember that a NULL item has value 0, and all indices have +1, so vehicle 0 is saved as index 1. More...
 
static void * IntToReference (size_t index, SLRefType rt)
 Pointers cannot be loaded from a savegame, so this function gets the index from the savegame and returns the appropriate pointer from the already loaded base. More...
 
static size_t SlCalcListLen (const void *list)
 Return the size in bytes of a list. More...
 
static void SlList (void *list, SLRefType conv)
 Save/Load a list. More...
 
static bool SlIsObjectValidInSavegame (const SaveLoad *sld)
 Are we going to save this object or not?
 
static bool SlSkipVariableOnLoad (const SaveLoad *sld)
 Are we going to load this variable when loading a savegame or not? More...
 
size_t SlCalcObjLength (const void *object, const SaveLoad *sld)
 Calculate the size of an object. More...
 
size_t SlCalcObjMemberLength (const void *object, const SaveLoad *sld)
 
static bool IsVariableSizeRight (const SaveLoad *sld)
 Check whether the variable size of the variable in the saveload configuration matches with the actual variable size. More...
 
bool SlObjectMember (void *ptr, const SaveLoad *sld)
 
void SlObject (void *object, const SaveLoad *sld)
 Main SaveLoad function. More...
 
void SlGlobList (const SaveLoadGlobVarList *sldg)
 Save or Load (a list of) global variables. More...
 
void SlAutolength (AutolengthProc *proc, void *arg)
 Do something of which I have no idea what it is :P. More...
 
static void SlLoadChunk (const ChunkHandler *ch)
 Load a chunk of data (eg vehicles, stations, etc.) More...
 
static void SlLoadCheckChunk (const ChunkHandler *ch)
 Load a chunk of data for checking savegames. More...
 
static void SlStubSaveProc2 (void *arg)
 Stub Chunk handlers to only calculate length and do nothing else. More...
 
static void SlStubSaveProc ()
 Stub Chunk handlers to only calculate length and do nothing else. More...
 
static void SlSaveChunk (const ChunkHandler *ch)
 Save a chunk of data (eg. More...
 
static void SlSaveChunks ()
 Save all chunks.
 
static const ChunkHandlerSlFindChunkHandler (uint32 id)
 Find the ChunkHandler that will be used for processing the found chunk in the savegame or in memory. More...
 
static void SlLoadChunks ()
 Load all chunks.
 
static void SlLoadCheckChunks ()
 Load all chunks for savegame checking.
 
static void SlFixPointers ()
 Fix all pointers (convert index -> pointer)
 
static const SaveLoadFormatGetSavegameFormat (char *s, byte *compression_level)
 Return the savegameformat of the game. More...
 
void InitializeGame (uint size_x, uint size_y, bool reset_date, bool reset_settings)
 
bool AfterLoadGame ()
 Perform a (large) amount of savegame conversion magic in order to load older savegames and to fill the caches for various purposes. More...
 
bool LoadOldSaveGame (const char *file)
 
static void ClearSaveLoadState ()
 Clear/free saveload state.
 
static void SaveFileStart ()
 Update the gui accordingly when starting saving and set locks on saveload. More...
 
static void SaveFileDone ()
 Update the gui accordingly when saving is done and release locks on saveload. More...
 
void SetSaveLoadError (StringID str)
 Set the error message from outside of the actual loading/saving of the game (AfterLoadGame and friends)
 
const char * GetSaveLoadErrorString ()
 Get the string representation of the error message.
 
static void SaveFileError ()
 Show a gui message when saving has failed.
 
static SaveOrLoadResult SaveFileToDisk (bool threaded)
 We have written the whole game into memory, _memory_savegame, now find and appropriate compressor and start writing to file.
 
static void SaveFileToDiskThread (void *arg)
 Thread run function for saving the file to disk. More...
 
void WaitTillSaved ()
 
static SaveOrLoadResult DoSave (SaveFilter *writer, bool threaded)
 Actually perform the saving of the savegame. More...
 
SaveOrLoadResult SaveWithFilter (SaveFilter *writer, bool threaded)
 Save the game using a (writer) filter. More...
 
static SaveOrLoadResult DoLoad (LoadFilter *reader, bool load_check)
 Actually perform the loading of a "non-old" savegame. More...
 
SaveOrLoadResult LoadWithFilter (LoadFilter *reader)
 Load the game using a (reader) filter. More...
 
SaveOrLoadResult SaveOrLoad (const char *filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded)
 Main Save or Load function where the high-level saveload functions are handled. More...
 
void DoExitSave ()
 Do a save when exiting the game (_settings_client.gui.autosave_on_exit)
 
void GenerateDefaultSaveName (char *buf, const char *last)
 Fill the buffer with the default name for a savegame or screenshot. More...
 

Variables

const uint16 SAVEGAME_VERSION = 197
 Current savegame version of OpenTTD.
 
SavegameType _savegame_type
 type of savegame we are loading
 
FileToSaveLoad _file_to_saveload
 File to save or load in the openttd loop.
 
uint32 _ttdp_version
 version of TTDP savegame (if applicable)
 
uint16 _sl_version
 the major savegame version identifier
 
byte _sl_minor_version
 the minor savegame version, DO NOT USE!
 
char _savegame_format [8]
 how to compress savegames
 
bool _do_autosave
 are we doing an autosave at the moment?
 
static const size_t MEMORY_CHUNK_SIZE = 128 * 1024
 Save in chunks of 128 KiB. More...
 
static SaveLoadParams _sl
 Parameters used for/at saveload.
 
const ChunkHandler _gamelog_chunk_handlers []
 
const ChunkHandler _map_chunk_handlers []
 
const ChunkHandler _misc_chunk_handlers []
 
const ChunkHandler _name_chunk_handlers []
 
const ChunkHandler _cheat_chunk_handlers []
 
const ChunkHandler _setting_chunk_handlers []
 
const ChunkHandler _company_chunk_handlers []
 
const ChunkHandler _engine_chunk_handlers []
 
const ChunkHandler _veh_chunk_handlers []
 
const ChunkHandler _waypoint_chunk_handlers []
 
const ChunkHandler _depot_chunk_handlers []
 
const ChunkHandler _order_chunk_handlers []
 
const ChunkHandler _town_chunk_handlers []
 
const ChunkHandler _sign_chunk_handlers []
 
const ChunkHandler _station_chunk_handlers []
 
const ChunkHandler _industry_chunk_handlers []
 
const ChunkHandler _economy_chunk_handlers []
 
const ChunkHandler _subsidy_chunk_handlers []
 
const ChunkHandler _cargomonitor_chunk_handlers []
 
const ChunkHandler _goal_chunk_handlers []
 
const ChunkHandler _story_page_chunk_handlers []
 
const ChunkHandler _ai_chunk_handlers []
 
const ChunkHandler _game_chunk_handlers []
 
const ChunkHandler _animated_tile_chunk_handlers []
 
const ChunkHandler _newgrf_chunk_handlers []
 
const ChunkHandler _group_chunk_handlers []
 
const ChunkHandler _cargopacket_chunk_handlers []
 
const ChunkHandler _autoreplace_chunk_handlers []
 
const ChunkHandler _labelmaps_chunk_handlers []
 
const ChunkHandler _linkgraph_chunk_handlers []
 
const ChunkHandler _airport_chunk_handlers []
 
const ChunkHandler _object_chunk_handlers []
 
const ChunkHandler _persistent_storage_chunk_handlers []
 
static const ChunkHandler *const _chunk_handlers []
 Array of all chunks in a savegame, NULL terminated. More...
 
static AsyncSaveFinishProc _async_save_finish = NULL
 Callback to call when the savegame loading is finished.
 
static ThreadObject_save_thread
 The thread we're using to compress and write a savegame.
 
static size_t _next_offs
 
static ChunkSaveLoadProc * _stub_save_proc
 Stub Chunk handlers to only calculate length and do nothing else. More...
 
static const uint LZO_BUFFER_SIZE = 8192
 Buffer size for the LZO compressor.
 
static const lzma_stream _lzma_init = LZMA_STREAM_INIT
 Have a copy of an initialised LZMA stream. More...
 
static const SaveLoadFormat _saveload_formats []
 The different saveload formats known/understood by OpenTTD. More...
 

Detailed Description

All actions handling saving and loading goes on in this file.

The general actions are as follows for saving a game (loading is analogous):

  1. initialize the writer by creating a temporary memory-buffer for it
  2. go through all to-be saved elements, each 'chunk' (ChunkHandler) prefixed by a label
  3. use their description array (SaveLoad) to know what elements to save and in what version of the game it was active (used when loading)
  4. write all data byte-by-byte to the temporary buffer so it is endian-safe
  5. when the buffer is full; flush it to the output (eg save to file) (_sl.buf, _sl.bufp, _sl.bufe)
  6. repeat this until everything is done, and flush any remaining output to file

Definition in file saveload.cpp.

Macro Definition Documentation

◆ FOR_ALL_CHUNK_HANDLERS

#define FOR_ALL_CHUNK_HANDLERS (   ch)
Value:
for (const ChunkHandler * const *chsc = _chunk_handlers; *chsc != NULL; chsc++) \
for (const ChunkHandler *ch = *chsc; ch != NULL; ch = (ch->flags & CH_LAST) ? NULL : ch + 1)
Handlers and description of chunk.
Definition: saveload.h:66
static const ChunkHandler *const _chunk_handlers[]
Array of all chunks in a savegame, NULL terminated.
Definition: saveload.cpp:456
Last chunk in this array.
Definition: saveload.h:104

Iterate over all chunk handlers.

Parameters
chthe chunk handler iterator

Definition at line 497 of file saveload.cpp.

Referenced by SlFindChunkHandler(), SlFixPointers(), SlNullPointers(), and SlSaveChunks().

Enumeration Type Documentation

◆ NeedLength

enum NeedLength
Enumerator
NL_NONE 

not working in NeedLength mode

NL_WANTLENGTH 

writing length and data

NL_CALCLENGTH 

need to calculate the length

Definition at line 289 of file saveload.cpp.

◆ SaveLoadAction

What are we currently doing?

Enumerator
SLA_LOAD 

loading

SLA_SAVE 

saving

SLA_PTRS 

fixing pointers

SLA_NULL 

null all pointers (on loading error)

SLA_LOAD_CHECK 

partial loading into _load_check_data

Definition at line 281 of file saveload.cpp.

Function Documentation

◆ AfterLoadGame()

bool AfterLoadGame ( )

Perform a (large) amount of savegame conversion magic in order to load older savegames and to fill the caches for various purposes.

Returns
True iff conversion went without a problem.

Definition at line 526 of file afterload.cpp.

References MapSize(), and SetSignalHandlers().

◆ DoLoad()

static SaveOrLoadResult DoLoad ( LoadFilter reader,
bool  load_check 
)
static

Actually perform the loading of a "non-old" savegame.

Parameters
readerThe filter to read the savegame from.
load_checkWhether to perform the checking ("preview") or actually load the game.
Returns
Return the result of the action. SL_OK or SL_REINIT ("unload" the game)

Definition at line 2632 of file saveload.cpp.

References _load_check_data, _saveload_formats, _sl_minor_version, _sl_version, LoadCheckData::checkable, LoadCheckData::Clear(), DEBUG, endof, SaveLoadParams::lf, LoadFilter::Read(), ReadBuffer::reader, LoadFilter::Reset(), and SlError().

Referenced by LoadWithFilter().

◆ DoSave()

static SaveOrLoadResult DoSave ( SaveFilter writer,
bool  threaded 
)
static

Actually perform the saving of the savegame.

General tactics is to first save the game to memory, then write it to file using the writer, either in threaded mode if possible, or single-threaded.

Parameters
writerThe filter to write the savegame to.
threadedWhether to try to perform the saving asynchronously.
Returns
Return the result of the action. SL_OK or SL_ERROR

Definition at line 2584 of file saveload.cpp.

Referenced by SaveWithFilter().

◆ GenerateDefaultSaveName()

void GenerateDefaultSaveName ( char *  buf,
const char *  last 
)

Fill the buffer with the default name for a savegame or screenshot.

Parameters
bufthe buffer to write to.
lastthe last element in the buffer.

Definition at line 2885 of file saveload.cpp.

References _local_company, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID().

Referenced by SaveLoadWindow::GenerateFileName().

◆ GetSavegameFormat()

static const SaveLoadFormat* GetSavegameFormat ( char *  s,
byte *  compression_level 
)
static

Return the savegameformat of the game.

Whether it was created with ZLIB compression uncompressed, or another type

Parameters
sName of the savegame format. If NULL it picks the first available one
compression_levelOutput for telling what compression level we want.
Returns
Pointer to SaveLoadFormat struct giving all characteristics of this type of savegame

Definition at line 2394 of file saveload.cpp.

References Clamp(), SaveLoadFormat::default_compression, endof, SaveLoadFormat::init_write, lastof, SaveLoadFormat::name, SetDParamStr(), ShowErrorMessage(), StrEmpty(), and WL_CRITICAL.

Referenced by SaveFileToDisk().

◆ IntToReference()

static void* IntToReference ( size_t  index,
SLRefType  rt 
)
static

Pointers cannot be loaded from a savegame, so this function gets the index from the savegame and returns the appropriate pointer from the already loaded base.

Remember that an index of 0 is a NULL pointer so all indices are +1 so vehicle 0 is saved as 1.

Parameters
indexThe index that is being converted to a pointer
rtSLRefType type of the object the pointer is sought of
Returns
Return the index converted to a pointer of any type

Definition at line 1274 of file saveload.cpp.

◆ IsVariableSizeRight()

static bool IsVariableSizeRight ( const SaveLoad sld)
static

Check whether the variable size of the variable in the saveload configuration matches with the actual variable size.

Parameters
sldThe saveload configuration to test.

Definition at line 1496 of file saveload.cpp.

References SaveLoad::cmd, SaveLoad::conv, GetVarMemType(), and SL_VAR.

◆ LoadWithFilter()

SaveOrLoadResult LoadWithFilter ( LoadFilter reader)

Load the game using a (reader) filter.

Parameters
readerThe filter to read the savegame from.
Returns
Return the result of the action. SL_OK or SL_REINIT ("unload" the game)

Definition at line 2770 of file saveload.cpp.

References SaveLoadParams::action, ClearSaveLoadState(), DoLoad(), SL_REINIT, and SLA_LOAD.

◆ ReadValue()

int64 ReadValue ( const void *  ptr,
VarType  conv 
)

Return a signed-long version of the value of a setting.

Parameters
ptrpointer to the variable
convtype of variable, can be a non-clean type, eg one with other flags because it is parsed
Returns
returns the value of the pointer-setting

Definition at line 946 of file saveload.cpp.

References GetVarMemType().

Referenced by GetVariableAddress().

◆ ReferenceToInt()

static size_t ReferenceToInt ( const void *  obj,
SLRefType  rt 
)
static

Pointers cannot be saved to a savegame, so this functions gets the index of the item, and if not available, it hussles with pointers (looks really bad :() Remember that a NULL item has value 0, and all indices have +1, so vehicle 0 is saved as index 1.

Parameters
objThe object that we want to get the index of
rtSLRefType type of the object the index is being sought of
Returns
Return the pointer converted to an index of the type pointed to

Definition at line 1241 of file saveload.cpp.

◆ SaveFileDone()

static void SaveFileDone ( )
static

Update the gui accordingly when saving is done and release locks on saveload.

Definition at line 2480 of file saveload.cpp.

Referenced by SaveFileError().

◆ SaveFileStart()

static void SaveFileStart ( )
static

Update the gui accordingly when starting saving and set locks on saveload.

Also turn off fast-forward cause with that saving takes Aaaaages

Definition at line 2469 of file saveload.cpp.

References SaveLoadParams::ff_state.

◆ SaveFileToDiskThread()

static void SaveFileToDiskThread ( void *  arg)
static

Thread run function for saving the file to disk.

Definition at line 2559 of file saveload.cpp.

References SaveFileToDisk().

◆ SaveOrLoad()

SaveOrLoadResult SaveOrLoad ( const char *  filename,
SaveLoadOperation  fop,
DetailedFileType  dft,
Subdirectory  sb,
bool  threaded 
)

Main Save or Load function where the high-level saveload functions are handled.

It opens the savegame, selects format and checks versions

Parameters
filenameThe name of the savegame being created/loaded
modeSave or load mode. Load can also be a TTD(Patch) game. Use #SL_LOAD, #SL_OLD_LOAD, #SL_LOAD_CHECK, or #SL_SAVE.
sbThe sub directory to save the savegame in
threadedTrue when threaded saving is allowed
Returns
Return the result of the action. SL_OK, SL_ERROR, or SL_REINIT ("unload" the game)

Definition at line 2790 of file saveload.cpp.

References _do_autosave, DFT_GAME_FILE, INVALID_STRING_ID, SaveLoadParams::saveinprogress, ShowErrorMessage(), SL_OK, SLO_SAVE, and WL_ERROR.

Referenced by DEF_CONSOLE_CMD(), DoExitSave(), and CrashLog::WriteSavegame().

◆ SaveWithFilter()

SaveOrLoadResult SaveWithFilter ( SaveFilter writer,
bool  threaded 
)

Save the game using a (writer) filter.

Parameters
writerThe filter to write the savegame to.
threadedWhether to try to perform the saving asynchronously.
Returns
Return the result of the action. SL_OK or SL_ERROR

Definition at line 2615 of file saveload.cpp.

References SaveLoadParams::action, ClearSaveLoadState(), DoSave(), SL_ERROR, and SLA_SAVE.

◆ SetAsyncSaveFinish()

static void SetAsyncSaveFinish ( AsyncSaveFinishProc  proc)
static

Called by save thread to tell we finished saving.

Parameters
procThe callback to call when saving is done.

Definition at line 575 of file saveload.cpp.

◆ SlArray()

void SlArray ( void *  array,
size_t  length,
VarType  conv 
)

Save/Load an array.

Parameters
arrayThe array being manipulated
lengthThe length of the array in elements
convVarType type of the atomic array (int, byte, uint64, etc.)

Definition at line 1186 of file saveload.cpp.

References _sl_version, SaveLoadParams::action, SaveLoadParams::need_length, NL_CALCLENGTH, NL_NONE, SLA_NULL, SLA_PTRS, SLA_SAVE, SlCalcArrayLen(), and SlSetLength().

Referenced by Load_ANIT(), Load_NAME(), ScriptInstance::LoadObjects(), Save_ANIT(), and ScriptInstance::SaveObject().

◆ SlAutolength()

void SlAutolength ( AutolengthProc *  proc,
void *  arg 
)

Do something of which I have no idea what it is :P.

Parameters
procThe callback procedure that is called
argThe variable that will be used for the callback procedure

Definition at line 1640 of file saveload.cpp.

Referenced by SlStubSaveProc().

◆ SlCalcArrayLen()

static size_t SlCalcArrayLen ( size_t  length,
VarType  conv 
)
inlinestatic

Return the size in bytes of a certain type of atomic array.

Parameters
lengthThe length of the array counted in elements
convVarType type of the variable that is used in calculating the size

Definition at line 1175 of file saveload.cpp.

References SlCalcConvFileLen().

Referenced by SlArray().

◆ SlCalcConvFileLen()

static byte SlCalcConvFileLen ( VarType  conv)
inlinestatic

Return the size in bytes of a certain type of normal/atomic variable as it appears in a saved game.

See VarTypes

Parameters
convVarType type of variable that is used for calculating the size
Returns
Return the size of this type in bytes

Definition at line 802 of file saveload.cpp.

References GB().

Referenced by SlCalcArrayLen().

◆ SlCalcConvMemLen()

static uint SlCalcConvMemLen ( VarType  conv)
inlinestatic

Return the size in bytes of a certain type of normal/atomic variable as it appears in memory.

See VarTypes

Parameters
convVarType type of variable that is used for calculating the size
Returns
Return the size of this type in bytes

Definition at line 778 of file saveload.cpp.

References GB(), SLE_VAR_STR, SLE_VAR_STRB, SLE_VAR_STRBQ, and SLE_VAR_STRQ.

Referenced by SlSkipVariableOnLoad().

◆ SlCalcListLen()

static size_t SlCalcListLen ( const void *  list)
inlinestatic

Return the size in bytes of a list.

Parameters
listThe std::list to find the size of

Definition at line 1349 of file saveload.cpp.

References IsSavegameVersionBefore().

Referenced by SlList().

◆ SlCalcNetStringLen()

static size_t SlCalcNetStringLen ( const char *  ptr,
size_t  length 
)
inlinestatic

Calculate the net length of a string.

This is in almost all cases just strlen(), but if the string is not properly terminated, we'll resort to the maximum length of the buffer.

Parameters
ptrpointer to the stringbuffer
lengthmaximum length of the string (buffer). If -1 we don't care about a maximum length, but take string length as it is.
Returns
return the net length of the string

Definition at line 1053 of file saveload.cpp.

References min().

◆ SlCalcObjLength()

size_t SlCalcObjLength ( const void *  object,
const SaveLoad sld 
)

Calculate the size of an object.

Parameters
objectto be measured
sldThe SaveLoad description of the object so we know how to manipulate it
Returns
size of given object

Definition at line 1448 of file saveload.cpp.

References SaveLoad::cmd.

Referenced by SlObject().

◆ SlCalcStringLen()

static size_t SlCalcStringLen ( const void *  ptr,
size_t  length,
VarType  conv 
)
inlinestatic

Calculate the gross length of the string that it will occupy in the savegame.

This includes the real length, returned by SlCalcNetStringLen and the length that the index will occupy.

Parameters
ptrpointer to the stringbuffer
lengthmaximum length of the string (buffer size, etc.)
convtype of data been used
Returns
return the gross length of the string

Definition at line 1068 of file saveload.cpp.

References GetVarMemType().

◆ SlCopyBytes()

static void SlCopyBytes ( void *  ptr,
size_t  length 
)
static

Save/Load bytes.

These do not need to be converted to Little/Big Endian so directly write them or read them to/from file

Parameters
ptrThe source or destination of the object being manipulated
lengthnumber of bytes this fast CopyBytes lasts

Definition at line 917 of file saveload.cpp.

References SaveLoadParams::action, SLA_LOAD, SLA_LOAD_CHECK, SLA_SAVE, SlReadByte(), and SlWriteByte().

◆ SlError()

void NORETURN SlError ( StringID  string,
const char *  extra_msg 
)

Error handler.

Sets everything up to show an error message and to clean up the mess of a partial savegame load.

Parameters
stringThe translatable error message to show.
extra_msgAn extra error message coming from one of the APIs.
Note
This function does never return as it throws an exception to break out of all the saveload code.

Definition at line 533 of file saveload.cpp.

References _load_check_data, SaveLoadParams::action, LoadCheckData::error, LoadCheckData::error_data, SaveLoadParams::error_str, SaveLoadParams::extra_msg, free(), SLA_LOAD, SLA_LOAD_CHECK, SLA_PTRS, SlNullPointers(), and stredup().

Referenced by DoLoad(), PacketWriter::Finish(), LZMALoadFilter::LZMALoadFilter(), LZMASaveFilter::LZMASaveFilter(), LZOLoadFilter::LZOLoadFilter(), LZOSaveFilter::LZOSaveFilter(), LZMALoadFilter::Read(), SlErrorCorrupt(), PacketWriter::Write(), FileWriter::Write(), ZlibSaveFilter::WriteLoop(), LZMASaveFilter::WriteLoop(), ZlibLoadFilter::ZlibLoadFilter(), and ZlibSaveFilter::ZlibSaveFilter().

◆ SlErrorCorrupt()

void NORETURN SlErrorCorrupt ( const char *  msg)

Error handler for corrupt savegames.

Sets everything up to show the error message and to clean up the mess of a partial savegame load.

Parameters
msgLocation the corruption has been spotted.
Note
This function does never return as it throws an exception to break out of all the saveload code.

Definition at line 561 of file saveload.cpp.

References SlError().

Referenced by Load_CHTS(), Load_ITBL(), Load_NAME(), Load_NewGRFMapping(), ReadBuffer::ReadBuffer(), SetWaterClassDependingOnSurroundings(), and SlReadSimpleGamma().

◆ SlFindChunkHandler()

static const ChunkHandler* SlFindChunkHandler ( uint32  id)
static

Find the ChunkHandler that will be used for processing the found chunk in the savegame or in memory.

Parameters
idthe chunk in question
Returns
returns the appropriate chunkhandler

Definition at line 1837 of file saveload.cpp.

References FOR_ALL_CHUNK_HANDLERS.

◆ SlGlobList()

void SlGlobList ( const SaveLoadGlobVarList sldg)

Save or Load (a list of) global variables.

Parameters
sldgThe global variable that is being loaded or saved

Definition at line 1630 of file saveload.cpp.

References SlObject().

Referenced by LoadSave_IBLD().

◆ SlIterateArray()

int SlIterateArray ( )

Iterate through the elements of an array and read the whole thing.

Returns
The index of the object, or -1 if we have reached the end of current block

Definition at line 828 of file saveload.cpp.

Referenced by Load_CAPA(), Load_ITBL(), Load_LGRJ(), Load_LGRP(), Load_NAME(), Load_NewGRFMapping(), Load_PSAC(), Load_SIGN(), LoadDelivery(), LoadPickup(), and SlSkipArray().

◆ SlList()

static void SlList ( void *  list,
SLRefType  conv 
)
static

Save/Load a list.

Parameters
listThe list being manipulated
convSLRefType type of the list (Vehicle *, Station *, etc)

Definition at line 1365 of file saveload.cpp.

References SaveLoadParams::action, SaveLoadParams::need_length, NL_CALCLENGTH, NL_NONE, SLA_SAVE, SlCalcListLen(), and SlSetLength().

◆ SlLoadCheckChunk()

static void SlLoadCheckChunk ( const ChunkHandler ch)
static

Load a chunk of data for checking savegames.

If the chunkhandler is NULL, the chunk is skipped.

Parameters
chThe chunkhandler that will be used for the operation

Definition at line 1707 of file saveload.cpp.

References SaveLoadParams::block_mode, SaveLoadParams::obj_len, and SlReadByte().

◆ SlLoadChunk()

static void SlLoadChunk ( const ChunkHandler ch)
static

Load a chunk of data (eg vehicles, stations, etc.)

Parameters
chThe chunkhandler that will be used for the operation

Definition at line 1667 of file saveload.cpp.

References SaveLoadParams::block_mode, SaveLoadParams::obj_len, and SlReadByte().

◆ SlObject()

void SlObject ( void *  object,
const SaveLoad sld 
)

◆ SlReadByte()

byte SlReadByte ( )

Wrapper for reading a byte from the buffer.

Returns
The read byte.

Definition at line 605 of file saveload.cpp.

References SaveLoadParams::reader.

Referenced by Load_CHTS(), SlCopyBytes(), SlLoadCheckChunk(), SlLoadChunk(), SlReadSimpleGamma(), and SlSkipBytes().

◆ SlReadSimpleGamma()

static uint SlReadSimpleGamma ( )
static

Read in the header descriptor of an object or an array.

If the highest bit is set (7), then the index is bigger than 127 elements, so use the next byte to read in the real value. The actual value is then both bytes added with the first shifted 8 bits to the left, and dropping the highest bit (which only indicated a big index). x = ((x & 0x7F) << 8) + SlReadByte();

Returns
Return the value of the index

Definition at line 675 of file saveload.cpp.

References HasBit(), SlErrorCorrupt(), and SlReadByte().

◆ SlSaveChunk()

static void SlSaveChunk ( const ChunkHandler ch)
static

Save a chunk of data (eg.

vehicles, stations, etc.). Each chunk is prefixed by an ID identifying it, followed by data, and terminator where appropriate

Parameters
chThe chunkhandler that will be used for the operation

Definition at line 1783 of file saveload.cpp.

Referenced by SlSaveChunks().

◆ SlSaveLoadConv()

static void SlSaveLoadConv ( void *  ptr,
VarType  conv 
)
static

Handle all conversion and typechecking of variables here.

In the case of saving, read in the actual value from the struct and then write them to file, endian safely. Loading a value goes exactly the opposite way

Parameters
ptrThe object being filled/read
convVarType type of the current element of the struct

Definition at line 996 of file saveload.cpp.

References SaveLoadParams::action, and SLA_SAVE.

◆ SlSetLength()

void SlSetLength ( size_t  length)

Sets the length of either a RIFF object or the number of items in an array.

This lets us load an object or an array of arbitrary size

Parameters
lengthThe length of the sought object/array

Definition at line 873 of file saveload.cpp.

Referenced by Save_ANIT(), Save_CHTS(), SlArray(), SlList(), and SlObject().

◆ SlSkipBytes()

static void SlSkipBytes ( size_t  length)
inlinestatic

Read in bytes from the file/data structure but don't do anything with them, discarding them in effect.

Parameters
lengthThe amount of bytes that is being treated this way

Definition at line 661 of file saveload.cpp.

References SlReadByte().

Referenced by SlSkipArray(), and SlSkipVariableOnLoad().

◆ SlSkipVariableOnLoad()

static bool SlSkipVariableOnLoad ( const SaveLoad sld)
inlinestatic

Are we going to load this variable when loading a savegame or not?

Note
If the variable is skipped it is skipped in the savegame bytestream itself as well, so there is no need to skip it somewhere else

Definition at line 1432 of file saveload.cpp.

References _network_server, _networking, SaveLoadParams::action, SaveLoad::conv, SaveLoad::length, SLA_SAVE, SlCalcConvMemLen(), SLF_NO_NETWORK_SYNC, and SlSkipBytes().

◆ SlString()

static void SlString ( void *  ptr,
size_t  length,
VarType  conv 
)
static

Save/Load a string.

Parameters
ptrthe string being manipulated
lengthof the string (full length)
convmust be SLE_FILE_STRING

Definition at line 1097 of file saveload.cpp.

References SaveLoadParams::action, GetVarMemType(), and SLA_SAVE.

◆ SlStubSaveProc()

static void SlStubSaveProc ( )
static

Stub Chunk handlers to only calculate length and do nothing else.

Call SlAutoLenth with our stub save proc that will eventually call the intended chunk handler.

Definition at line 1773 of file saveload.cpp.

References SlAutolength(), and SlStubSaveProc2().

◆ SlStubSaveProc2()

static void SlStubSaveProc2 ( void *  arg)
inlinestatic

Stub Chunk handlers to only calculate length and do nothing else.

Actually call the intended chunk handler.

Parameters
argignored parameter.

Definition at line 1763 of file saveload.cpp.

References _stub_save_proc.

Referenced by SlStubSaveProc().

◆ SlWriteByte()

void SlWriteByte ( byte  b)

Wrapper for writing a byte to the dumper.

Parameters
bThe byte to write.

Definition at line 614 of file saveload.cpp.

References SaveLoadParams::dumper, and MemoryDumper::WriteByte().

Referenced by Save_CHTS(), and SlCopyBytes().

◆ SlWriteSimpleGamma()

static void SlWriteSimpleGamma ( size_t  i)
static

Write the header descriptor of an object or an array.

If the element is bigger than 127, use 2 bytes for saving and use the highest byte of the first written one as a notice that the length consists of 2 bytes, etc.. like this: 0xxxxxxx 10xxxxxx xxxxxxxx 110xxxxx xxxxxxxx xxxxxxxx 1110xxxx xxxxxxxx xxxxxxxx xxxxxxxx 11110— xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx We could extend the scheme ad infinum to support arbitrarily large chunks, but as sizeof(size_t) == 4 is still very common we don't support anything above 32 bits. That's why in the last case the 3 most significant bits are unused.

Parameters
iIndex being written

Definition at line 717 of file saveload.cpp.

◆ WriteValue()

void WriteValue ( void *  ptr,
VarType  conv,
int64  val 
)

Write the value of a setting.

Parameters
ptrpointer to the variable
convtype of variable, can be a non-clean type, eg with other flags. It is parsed upon read
valthe new value being given to the variable

Definition at line 970 of file saveload.cpp.

References GetVarMemType().

Referenced by GetVariableAddress().

Variable Documentation

◆ _chunk_handlers

const ChunkHandler* const _chunk_handlers[]
static

Array of all chunks in a savegame, NULL terminated.

Definition at line 456 of file saveload.cpp.

◆ _lzma_init

const lzma_stream _lzma_init = LZMA_STREAM_INIT
static

Have a copy of an initialised LZMA stream.

We need this as it's impossible to "re"-assign LZMA_STREAM_INIT to a variable in some compilers, i.e. LZMA_STREAM_INIT can't be used to set something. This var has to be used instead.

Definition at line 2234 of file saveload.cpp.

◆ _saveload_formats

const SaveLoadFormat _saveload_formats[]
static
Initial value:
= {
{"lzo", TO_BE32X('OTTD'), CreateLoadFilter<LZOLoadFilter>, CreateSaveFilter<LZOSaveFilter>, 0, 0, 0},
{"none", TO_BE32X('OTTN'), CreateLoadFilter<NoCompLoadFilter>, CreateSaveFilter<NoCompSaveFilter>, 0, 0, 0},
{"zlib", TO_BE32X('OTTZ'), CreateLoadFilter<ZlibLoadFilter>, CreateSaveFilter<ZlibSaveFilter>, 0, 6, 9},
{"lzma", TO_BE32X('OTTX'), CreateLoadFilter<LZMALoadFilter>, CreateSaveFilter<LZMASaveFilter>, 0, 2, 9},
}

The different saveload formats known/understood by OpenTTD.

Definition at line 2358 of file saveload.cpp.

Referenced by DoLoad().

◆ _stub_save_proc

ChunkSaveLoadProc* _stub_save_proc
static

Stub Chunk handlers to only calculate length and do nothing else.

The intended chunk handler that should be called.

Definition at line 1756 of file saveload.cpp.

Referenced by SlStubSaveProc2().

◆ MEMORY_CHUNK_SIZE

const size_t MEMORY_CHUNK_SIZE = 128 * 1024
static