summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--projects/openttd_vs100.vcxproj1
-rw-r--r--projects/openttd_vs100.vcxproj.filters3
-rw-r--r--projects/openttd_vs80.vcproj4
-rw-r--r--projects/openttd_vs90.vcproj4
-rw-r--r--source.list1
-rw-r--r--src/saveload/saveload.cpp127
-rw-r--r--src/saveload/saveload.h2
-rw-r--r--src/saveload/saveload_filter.h107
8 files changed, 156 insertions, 93 deletions
diff --git a/projects/openttd_vs100.vcxproj b/projects/openttd_vs100.vcxproj
index 384c5db4a..69360a650 100644
--- a/projects/openttd_vs100.vcxproj
+++ b/projects/openttd_vs100.vcxproj
@@ -734,6 +734,7 @@
<ClCompile Include="..\src\saveload\order_sl.cpp" />
<ClCompile Include="..\src\saveload\saveload.cpp" />
<ClInclude Include="..\src\saveload\saveload.h" />
+ <ClInclude Include="..\src\saveload\saveload_filter.h" />
<ClInclude Include="..\src\saveload\saveload_internal.h" />
<ClCompile Include="..\src\saveload\signs_sl.cpp" />
<ClCompile Include="..\src\saveload\station_sl.cpp" />
diff --git a/projects/openttd_vs100.vcxproj.filters b/projects/openttd_vs100.vcxproj.filters
index f84eff72e..fd904c1da 100644
--- a/projects/openttd_vs100.vcxproj.filters
+++ b/projects/openttd_vs100.vcxproj.filters
@@ -1422,6 +1422,9 @@
<ClInclude Include="..\src\saveload\saveload.h">
<Filter>Save/Load handlers</Filter>
</ClInclude>
+ <ClInclude Include="..\src\saveload\saveload_filter.h">
+ <Filter>Save/Load handlers</Filter>
+ </ClInclude>
<ClInclude Include="..\src\saveload\saveload_internal.h">
<Filter>Save/Load handlers</Filter>
</ClInclude>
diff --git a/projects/openttd_vs80.vcproj b/projects/openttd_vs80.vcproj
index 3119c59c0..92813dee4 100644
--- a/projects/openttd_vs80.vcproj
+++ b/projects/openttd_vs80.vcproj
@@ -2231,6 +2231,10 @@
>
</File>
<File
+ RelativePath=".\..\src\saveload\saveload_filter.h"
+ >
+ </File>
+ <File
RelativePath=".\..\src\saveload\saveload_internal.h"
>
</File>
diff --git a/projects/openttd_vs90.vcproj b/projects/openttd_vs90.vcproj
index 3503a555c..f04386b15 100644
--- a/projects/openttd_vs90.vcproj
+++ b/projects/openttd_vs90.vcproj
@@ -2228,6 +2228,10 @@
>
</File>
<File
+ RelativePath=".\..\src\saveload\saveload_filter.h"
+ >
+ </File>
+ <File
RelativePath=".\..\src\saveload\saveload_internal.h"
>
</File>
diff --git a/source.list b/source.list
index 2d0728073..efcf33830 100644
--- a/source.list
+++ b/source.list
@@ -492,6 +492,7 @@ saveload/oldloader_sl.cpp
saveload/order_sl.cpp
saveload/saveload.cpp
saveload/saveload.h
+saveload/saveload_filter.h
saveload/saveload_internal.h
saveload/signs_sl.cpp
saveload/station_sl.cpp
diff --git a/src/saveload/saveload.cpp b/src/saveload/saveload.cpp
index 635d05072..d196dd3fd 100644
--- a/src/saveload/saveload.cpp
+++ b/src/saveload/saveload.cpp
@@ -46,6 +46,7 @@
#include "table/strings.h"
#include "saveload_internal.h"
+#include "saveload_filter.h"
/*
* Previous savegame versions, the trunk revision where they were
@@ -246,43 +247,6 @@ enum NeedLength {
/** Save in chunks of 128 KiB. */
static const size_t MEMORY_CHUNK_SIZE = 128 * 1024;
-/** Interface for filtering a savegame till it is loaded. */
-struct LoadFilter {
- /** Chained to the (savegame) filters. */
- LoadFilter *chain;
-
- /**
- * Initialise this filter.
- * @param chain The next filter in this chain.
- */
- LoadFilter(LoadFilter *chain) : chain(chain)
- {
- }
-
- /** Make sure the writers are properly closed. */
- virtual ~LoadFilter()
- {
- delete this->chain;
- }
-
- /**
- * Read a given number of bytes from the savegame.
- * @param buf The bytes to read.
- * @param len The number of bytes to read.
- * @return The number of actually read bytes.
- */
- virtual size_t Read(byte *buf, size_t len) = 0;
-
- /**
- * Reset this filter to read from the beginning of the file.
- */
- virtual void Reset()
- {
- this->chain->Reset();
- }
-};
-
-
/** A buffer for reading (and buffering) savegame data. */
struct ReadBuffer {
byte buf[MEMORY_CHUNK_SIZE]; ///< Buffer we're going to read from.
@@ -324,62 +288,6 @@ struct ReadBuffer {
};
-/**
- * Instantiator for a load filter.
- * @param chain The next filter in this chain.
- * @tparam T The type of load filter to create.
- */
-template <typename T> LoadFilter *CreateLoadFilter(LoadFilter *chain)
-{
- return new T(chain);
-}
-
-/** Interface for filtering a savegame till it is written. */
-struct SaveFilter {
- /** Chained to the (savegame) filters. */
- SaveFilter *chain;
-
- /**
- * Initialise this filter.
- * @param chain The next filter in this chain.
- */
- SaveFilter(SaveFilter *chain) : chain(chain)
- {
- }
-
- /** Make sure the writers are properly closed. */
- virtual ~SaveFilter()
- {
- delete this->chain;
- }
-
- /**
- * Write a given number of bytes into the savegame.
- * @param buf The bytes to write.
- * @param len The number of bytes to write.
- */
- virtual void Write(byte *buf, size_t len) = 0;
-
- /**
- * Prepare everything to finish writing the savegame.
- */
- virtual void Finish()
- {
- if (this->chain != NULL) this->chain->Finish();
- }
-};
-
-/**
- * Instantiator for a save filter.
- * @param chain The next filter in this chain.
- * @param compression_level The requested level of compression.
- * @tparam T The type of save filter to create.
- */
-template <typename T> SaveFilter *CreateSaveFilter(SaveFilter *chain, byte compression_level)
-{
- return new T(chain, compression_level);
-}
-
/** Container for dumping the savegame (quickly) to memory. */
struct MemoryDumper {
AutoFreeSmallVector<byte *, 16> blocks; ///< Buffer with blocks of allocated memory.
@@ -2518,6 +2426,23 @@ static SaveOrLoadResult DoSave(SaveFilter *writer, bool threaded)
}
/**
+ * Save the game using a (writer) filter.
+ * @param writer The filter to write the savegame to.
+ * @param threaded Whether to try to perform the saving asynchroniously.
+ * @return Return the result of the action. #SL_OK or #SL_ERROR
+ */
+SaveOrLoadResult SaveWithFilter(SaveFilter *writer, bool threaded)
+{
+ try {
+ _sl.action = SLA_SAVE;
+ return DoSave(writer, threaded);
+ } catch (...) {
+ ClearSaveLoadState();
+ return SL_ERROR;
+ }
+}
+
+/**
* Actually perform the loading of a "non-old" savegame.
* @param reader The filter to read the savegame from.
* @param load_check Whether to perform the checking ("preview") or actually load the game.
@@ -2660,6 +2585,22 @@ static SaveOrLoadResult DoLoad(LoadFilter *reader, bool load_check)
}
/**
+ * Load the game using a (reader) filter.
+ * @param reader The filter to read the savegame from.
+ * @return Return the result of the action. #SL_OK or #SL_REINIT ("unload" the game)
+ */
+SaveOrLoadResult LoadWithFilter(LoadFilter *reader)
+{
+ try {
+ _sl.action = SLA_LOAD;
+ return DoLoad(reader, false);
+ } catch (...) {
+ ClearSaveLoadState();
+ return SL_REINIT;
+ }
+}
+
+/**
* Main Save or Load function where the high-level saveload functions are
* handled. It opens the savegame, selects format and checks versions
* @param filename The name of the savegame being created/loaded
diff --git a/src/saveload/saveload.h b/src/saveload/saveload.h
index ddf6b6dc5..f9d191467 100644
--- a/src/saveload/saveload.h
+++ b/src/saveload/saveload.h
@@ -55,6 +55,8 @@ SaveOrLoadResult SaveOrLoad(const char *filename, int mode, Subdirectory sb, boo
void WaitTillSaved();
void DoExitSave();
+SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded);
+SaveOrLoadResult LoadWithFilter(struct LoadFilter *reader);
typedef void ChunkSaveLoadProc();
typedef void AutolengthProc(void *arg);
diff --git a/src/saveload/saveload_filter.h b/src/saveload/saveload_filter.h
new file mode 100644
index 000000000..0cb5c8695
--- /dev/null
+++ b/src/saveload/saveload_filter.h
@@ -0,0 +1,107 @@
+/* $Id$ */
+
+/*
+ * This file is part of OpenTTD.
+ * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
+ * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file saveload_filter.h Declaration of filters used for saving and loading savegames. */
+
+#ifndef SAVELOAD_FILTER_H
+#define SAVELOAD_FILTER_H
+
+/** Interface for filtering a savegame till it is loaded. */
+struct LoadFilter {
+ /** Chained to the (savegame) filters. */
+ LoadFilter *chain;
+
+ /**
+ * Initialise this filter.
+ * @param chain The next filter in this chain.
+ */
+ LoadFilter(LoadFilter *chain) : chain(chain)
+ {
+ }
+
+ /** Make sure the writers are properly closed. */
+ virtual ~LoadFilter()
+ {
+ delete this->chain;
+ }
+
+ /**
+ * Read a given number of bytes from the savegame.
+ * @param buf The bytes to read.
+ * @param len The number of bytes to read.
+ * @return The number of actually read bytes.
+ */
+ virtual size_t Read(byte *buf, size_t len) = 0;
+
+ /**
+ * Reset this filter to read from the beginning of the file.
+ */
+ virtual void Reset()
+ {
+ this->chain->Reset();
+ }
+};
+
+/**
+ * Instantiator for a load filter.
+ * @param chain The next filter in this chain.
+ * @tparam T The type of load filter to create.
+ */
+template <typename T> LoadFilter *CreateLoadFilter(LoadFilter *chain)
+{
+ return new T(chain);
+}
+
+/** Interface for filtering a savegame till it is written. */
+struct SaveFilter {
+ /** Chained to the (savegame) filters. */
+ SaveFilter *chain;
+
+ /**
+ * Initialise this filter.
+ * @param chain The next filter in this chain.
+ */
+ SaveFilter(SaveFilter *chain) : chain(chain)
+ {
+ }
+
+ /** Make sure the writers are properly closed. */
+ virtual ~SaveFilter()
+ {
+ delete this->chain;
+ }
+
+ /**
+ * Write a given number of bytes into the savegame.
+ * @param buf The bytes to write.
+ * @param len The number of bytes to write.
+ */
+ virtual void Write(byte *buf, size_t len) = 0;
+
+ /**
+ * Prepare everything to finish writing the savegame.
+ */
+ virtual void Finish()
+ {
+ if (this->chain != NULL) this->chain->Finish();
+ }
+};
+
+/**
+ * Instantiator for a save filter.
+ * @param chain The next filter in this chain.
+ * @param compression_level The requested level of compression.
+ * @tparam T The type of save filter to create.
+ */
+template <typename T> SaveFilter *CreateSaveFilter(SaveFilter *chain, byte compression_level)
+{
+ return new T(chain, compression_level);
+}
+
+#endif /* SAVELOAD_FILTER_H */
generated by cgit v1.2.3-70-g09d2 (git 2.47.1) at 2024-12-14 17:25:17 +0000