cpp/openttd-patchpack/source Changeset - r25696:265cb5def15f

Changeset - r25696:265cb5def15f

Parent rev.

Child rev.

[Not reviewed]

master

0 2 0

Patric Stout - 3 years ago 2021-06-15 09:59:38
truebrain@openttd.org

Codechange: use SL_NULL if you want to store null-bytes or load to nothing

Using SL_ARR for this gives us a bit of trouble later on, where we
add a length-field to SL_ARR. This of course is not the intention
of SLE_CONDNULL. So better seperate it.

2 files changed with 31 insertions and 30 deletions:

src/saveload/saveload.cpp

src/saveload/saveload.h

0 comments (0 inline, 0 general)

src/saveload/saveload.cpp

➞

Show inline comments

@@ @@ -1422,39 +1422,27 @@ size_t SlCalcObjLength(const void *objec @@
+}
 size_t SlCalcObjMemberLength(const void *object, const SaveLoad &sld)
+{
 	assert(_sl.action == SLA_SAVE);
 	if (!SlIsObjectValidInSavegame(sld)) return 0;
 	switch (sld.cmd) {
 		case SL_VAR:
 		case SL_REF:
 		case SL_ARR:
 		case SL_STR:
 		case SL_REFLIST:
 		case SL_DEQUE:
 		case SL_STDSTR:
 			/* CONDITIONAL saveload types depend on the savegame version */
 			if (!SlIsObjectValidInSavegame(sld)) break;
 			switch (sld.cmd) {
 				case SL_VAR: return SlCalcConvFileLen(sld.conv);
 				case SL_REF: return SlCalcRefLen();
 				case SL_ARR: return SlCalcArrayLen(sld.length, sld.conv);
 				case SL_STR: return SlCalcStringLen(GetVariableAddress(object, sld), sld.length, sld.conv);
 				case SL_REFLIST: return SlCalcRefListLen(GetVariableAddress(object, sld), sld.conv);
 				case SL_DEQUE: return SlCalcDequeLen(GetVariableAddress(object, sld), sld.conv);
 				case SL_STDSTR: return SlCalcStdStringLen(GetVariableAddress(object, sld));
 				default: NOT_REACHED();
+			}
 			break;
 		case SL_VAR: return SlCalcConvFileLen(sld.conv);
 		case SL_REF: return SlCalcRefLen();
 		case SL_ARR: return SlCalcArrayLen(sld.length, sld.conv);
 		case SL_STR: return SlCalcStringLen(GetVariableAddress(object, sld), sld.length, sld.conv);
 		case SL_REFLIST: return SlCalcRefListLen(GetVariableAddress(object, sld), sld.conv);
 		case SL_DEQUE: return SlCalcDequeLen(GetVariableAddress(object, sld), sld.conv);
 		case SL_STDSTR: return SlCalcStdStringLen(GetVariableAddress(object, sld));
 		case SL_SAVEBYTE: return 1; // a byte is logically of size 1
 		case SL_NULL: return SlCalcConvFileLen(sld.conv) * sld.length;
 		case SL_STRUCT:
 		case SL_STRUCTLIST: {
 			if (!SlIsObjectValidInSavegame(sld)) break;
 			NeedLength old_need_length = _sl.need_length;
 			size_t old_obj_len = _sl.obj_len;
 			_sl.need_length = NL_CALCLENGTH;
 			_sl.obj_len = 0;
@@ @@ -1470,12 +1458,13 @@ size_t SlCalcObjMemberLength(const void @@
 			if (sld.cmd == SL_STRUCT) {
 				length += SlGetArrayLength(1);
+			}
 			return length;
+		}
 		default: NOT_REACHED();
+	}
 	return 0;
+}
 /**
@@ @@ -1527,24 +1516,23 @@ size_t SlCalcObjMemberLength(const void @@
+}
 static bool SlObjectMember(void *object, const SaveLoad &sld)
+{
 	assert(IsVariableSizeRight(sld));
 	if (!SlIsObjectValidInSavegame(sld)) return false;
 	VarType conv = GB(sld.conv, 0, 8);
 	switch (sld.cmd) {
 		case SL_VAR:
 		case SL_REF:
 		case SL_ARR:
 		case SL_STR:
 		case SL_REFLIST:
 		case SL_DEQUE:
 		case SL_STDSTR: {
 			/* CONDITIONAL saveload types depend on the savegame version */
 			if (!SlIsObjectValidInSavegame(sld)) return false;
 			void *ptr = GetVariableAddress(object, sld);
 			switch (sld.cmd) {
 				case SL_VAR: SlSaveLoadConv(ptr, conv); break;
 				case SL_REF: SlSaveLoadRef(ptr, conv); break;
 				case SL_ARR: SlArray(ptr, sld.length, conv); break;
@@ @@ -1571,16 +1559,28 @@ static bool SlObjectMember(void *object, @@
 				case SLA_NULL: break;
 				default: NOT_REACHED();
+			}
 			break;
+		}
 		case SL_NULL: {
 			assert(GetVarMemType(sld.conv) == SLE_VAR_NULL);
 			switch (_sl.action) {
 				case SLA_LOAD_CHECK:
 				case SLA_LOAD: SlSkipBytes(SlCalcConvFileLen(sld.conv) * sld.length); break;
 				case SLA_SAVE: for (int i = 0; i < SlCalcConvFileLen(sld.conv) * sld.length; i++) SlWriteByte(0); break;
 				case SLA_PTRS:
 				case SLA_NULL: break;
 				default: NOT_REACHED();
+			}
 			break;
+		}
 		case SL_STRUCT:
 		case SL_STRUCTLIST:
 			if (!SlIsObjectValidInSavegame(sld)) return false;
 			switch (_sl.action) {
 				case SLA_SAVE: {
 					if (sld.cmd == SL_STRUCT) {
 						/* Store in the savegame if this struct was written or not. */
 						SlSetStructListLength(SlCalcObjMemberLength(object, sld) > SlGetArrayLength(1) ? 1 : 0);
+					}

src/saveload/saveload.h

➞

Show inline comments

@@ @@ -570,12 +570,13 @@ enum SaveLoadType : byte { @@
 	SL_REFLIST     =  4, ///< Save/load a list of #SL_REF elements.
 	SL_DEQUE       =  5, ///< Save/load a deque of #SL_VAR elements.
 	SL_STDSTR      =  6, ///< Save/load a \c std::string.
 	SL_STRUCT      =  7, ///< Save/load a struct.
 	SL_STRUCTLIST  =  8, ///< Save/load a list of structs.
 	SL_SAVEBYTE    =  9, ///< Save (but not load) a byte.
 	SL_NULL        = 10, ///< Save null-bytes and load to nowhere.
 };
 typedef void *SaveLoadAddrProc(void *base, size_t extra);
 /** SaveLoad type struct. Do NOT use this directly but use the SLE_ macros defined just below! */
 struct SaveLoad {
@@ @@ -734,13 +735,13 @@ struct SaveLoad { @@
 /**
  * Empty space in some savegame versions.
  * @param length Length of the empty space.
  * @param from   First savegame version that has the empty space.
  * @param to     Last savegame version that has the empty space.
  */
-#define SLE_CONDNULL(length, from, to) {SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL, length, from, to, 0, nullptr, 0, nullptr}
+#define SLE_CONDNULL(length, from, to) {SL_NULL, SLE_FILE_U8 | SLE_VAR_NULL, length, from, to, 0, nullptr, 0, nullptr}
 /**
  * Only write byte during saving; never read it during loading.
  * When using SLE_SAVEBYTE you will have to read this byte before the table
  * this is in is read. This also means SLE_SAVEBYTE can only be used at the
  * top of a chunk.
@@ @@ -892,13 +893,13 @@ struct SaveLoad { @@
 /**
  * Empty global space in some savegame versions.
  * @param length Length of the empty space.
  * @param from   First savegame version that has the empty space.
  * @param to     Last savegame version that has the empty space.
  */
-#define SLEG_CONDNULL(length, from, to) {SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL, length, from, to, 0, nullptr, 0, nullptr}
+#define SLEG_CONDNULL(length, from, to) {SL_NULL, SLE_FILE_U8 | SLE_VAR_NULL, length, from, to, 0, nullptr, 0, nullptr}
 /**
  * Checks whether the savegame is below \a major.\a minor.
  * @param major Major number of the version to check against.
  * @param minor Minor number of the version to check against. If \a minor is 0 or not specified, only the major number is checked.
  * @return Savegame version is earlier than the specified version.

0 comments (0 inline, 0 general)