refactor: Rewrite AMF and property behavior logic to use smart pointers, references, and string_views over raw pointers and std::string& (#1452)

* Rewrite AMF and behavior logic to use smart pointers, references, and string_views over raw pointers and std::string&

* fix m_BehaviorID initialization

* Fix BlockDefinition member naming

* remove redundant reset()s

* Replace UB forward template declarations with header include

* remove unneeded comment

* remove non-const ref getters

* simplify default behavior id initialization

* Fix invalidated use of Getter to set a value

* Update AddStripMessage.cpp - change push_back to emplace_back

* fix pointer to ref conversion mistake (should not have directly grabbed from the other branch commit)

* deref

* VERY experimental testing of forward declaration of templates - probably will revert

* Revert changes (as expected)

* Update BlockDefinition.h - remove extraneous semicolons

* Update BlockDefinition.h - remove linebreak

* Update Amf3.h member naming scheme

* fix duplicated code

* const iterators

* const pointers

* reviving this branch

* update read switch cases

Author: jadebenn

.editorconfig

@@ -73,4 +73,4 @@ cpp_space_around_assignment_operator=insert
 cpp_space_pointer_reference_alignment=left
 cpp_space_around_ternary_operator=insert
 cpp_wrap_preserve_blocks=one_liners
-cpp_indent_comment=fasle
+cpp_indent_comment=false

dCommon/AMFDeserialize.cpp

@@ -9,73 +9,54 @@
  * AMF3 Deserializer written by EmosewaMC
  */
 
-AMFBaseValue* AMFDeserialize::Read(RakNet::BitStream& inStream) {
-	AMFBaseValue* returnValue = nullptr;
+std::unique_ptr<AMFBaseValue> AMFDeserialize::Read(RakNet::BitStream& inStream) {
 	// Read in the value type from the bitStream
 	eAmf marker;
 	inStream.Read(marker);
 	// Based on the typing, create the value associated with that and return the base value class
 	switch (marker) {
-	case eAmf::Undefined: {
-		returnValue = new AMFBaseValue();
-		break;
-	}
-
-	case eAmf::Null: {
-		returnValue = new AMFNullValue();
-		break;
-	}
-
-	case eAmf::False: {
-		returnValue = new AMFBoolValue(false);
-		break;
-	}
-
-	case eAmf::True: {
-		returnValue = new AMFBoolValue(true);
-		break;
-	}
-
-	case eAmf::Integer: {
-		returnValue = ReadAmfInteger(inStream);
-		break;
-	}
-
-	case eAmf::Double: {
-		returnValue = ReadAmfDouble(inStream);
-		break;
-	}
-
-	case eAmf::String: {
-		returnValue = ReadAmfString(inStream);
-		break;
-	}
-
-	case eAmf::Array: {
-		returnValue = ReadAmfArray(inStream);
-		break;
-	}
+	case eAmf::Undefined:
+		return std::make_unique<AMFBaseValue>();
+	case eAmf::Null:
+		return std::make_unique<AMFNullValue>();
+	case eAmf::False:
+		return std::make_unique<AMFBoolValue>(false);
+	case eAmf::True:
+		return std::make_unique<AMFBoolValue>(true);
+	case eAmf::Integer:
+		return ReadAmfInteger(inStream);
+	case eAmf::Double:
+		return ReadAmfDouble(inStream);
+	case eAmf::String:
+		return ReadAmfString(inStream);
+	case eAmf::Array:
+		return ReadAmfArray(inStream);
 
 	// These values are unimplemented in the live client and will remain unimplemented
 	// unless someone modifies the client to allow serializing of these values.
 	case eAmf::XMLDoc:
+		[[fallthrough]];
 	case eAmf::Date:
+		[[fallthrough]];
 	case eAmf::Object:
+		[[fallthrough]];
 	case eAmf::XML:
+		[[fallthrough]];
 	case eAmf::ByteArray:
+		[[fallthrough]];
 	case eAmf::VectorInt:
+		[[fallthrough]];
 	case eAmf::VectorUInt:
+		[[fallthrough]];
 	case eAmf::VectorDouble:
+		[[fallthrough]];
 	case eAmf::VectorObject:
-	case eAmf::Dictionary: {
+		[[fallthrough]];
+	case eAmf::Dictionary:
 		throw marker;
-		break;
-	}
 	default:
 		throw std::invalid_argument("Invalid AMF3 marker" + std::to_string(static_cast<int32_t>(marker)));
-		break;
 	}
-	return returnValue;
 }
 
 uint32_t AMFDeserialize::ReadU29(RakNet::BitStream& inStream) {
@@ -118,14 +99,14 @@ const std::string AMFDeserialize::ReadString(RakNet::BitStream& inStream) {
 	}
 }
 
-AMFBaseValue* AMFDeserialize::ReadAmfDouble(RakNet::BitStream& inStream) {
+std::unique_ptr<AMFDoubleValue> AMFDeserialize::ReadAmfDouble(RakNet::BitStream& inStream) {
 	double value;
 	inStream.Read<double>(value);
-	return new AMFDoubleValue(value);
+	return std::make_unique<AMFDoubleValue>(value);
 }
 
-AMFBaseValue* AMFDeserialize::ReadAmfArray(RakNet::BitStream& inStream) {
-	auto arrayValue = new AMFArrayValue();
+std::unique_ptr<AMFArrayValue> AMFDeserialize::ReadAmfArray(RakNet::BitStream& inStream) {
+	auto arrayValue = std::make_unique<AMFArrayValue>();
 
 	// Read size of dense array
 	const auto sizeOfDenseArray = (ReadU29(inStream) >> 1);
@@ -143,10 +124,10 @@ AMFBaseValue* AMFDeserialize::ReadAmfArray(RakNet::BitStream& inStream) {
 	return arrayValue;
 }
 
-AMFBaseValue* AMFDeserialize::ReadAmfString(RakNet::BitStream& inStream) {
-	return new AMFStringValue(ReadString(inStream));
+std::unique_ptr<AMFStringValue> AMFDeserialize::ReadAmfString(RakNet::BitStream& inStream) {
+	return std::make_unique<AMFStringValue>(ReadString(inStream));
 }
 
-AMFBaseValue* AMFDeserialize::ReadAmfInteger(RakNet::BitStream& inStream) {
-	return new AMFIntValue(ReadU29(inStream));
+std::unique_ptr<AMFIntValue> AMFDeserialize::ReadAmfInteger(RakNet::BitStream& inStream) {
+	return std::make_unique<AMFIntValue>(ReadU29(inStream)); // NOTE: NARROWING CONVERSION FROM UINT TO INT. IS THIS INTENDED?
 }

dCommon/AMFDeserialize.h

@@ -1,12 +1,12 @@
 #pragma once
 
+#include "Amf3.h"
 #include "BitStream.h"
 
+#include <memory>
 #include <vector>
 #include <string>
 
-class AMFBaseValue;
-
 class AMFDeserialize {
 public:
 	/**
@@ -15,7 +15,7 @@ class AMFDeserialize {
 	 * @param inStream inStream to read value from.
 	 * @return Returns an AMFValue with all the information from the bitStream in it.
 	 */
-	AMFBaseValue* Read(RakNet::BitStream& inStream);
+	std::unique_ptr<AMFBaseValue> Read(RakNet::BitStream& inStream);
 private:
 	/**
 	 * @brief Private method to read a U29 integer from a bitstream
@@ -39,31 +39,31 @@ class AMFDeserialize {
 	 * @param inStream bitStream to read data from
 	 * @return Double value represented as an AMFValue
 	 */
-	AMFBaseValue* ReadAmfDouble(RakNet::BitStream& inStream);
+	static std::unique_ptr<AMFDoubleValue> ReadAmfDouble(RakNet::BitStream& inStream);
 
 	/**
 	 * @brief Read an AMFArray from a bitStream
 	 *
 	 * @param inStream bitStream to read data from
 	 * @return Array value represented as an AMFValue
 	 */
-	AMFBaseValue* ReadAmfArray(RakNet::BitStream& inStream);
+	std::unique_ptr<AMFArrayValue> ReadAmfArray(RakNet::BitStream& inStream);
 
 	/**
 	 * @brief Read an AMFString from a bitStream
 	 *
 	 * @param inStream bitStream to read data from
 	 * @return String value represented as an AMFValue
 	 */
-	AMFBaseValue* ReadAmfString(RakNet::BitStream& inStream);
+	std::unique_ptr<AMFStringValue> ReadAmfString(RakNet::BitStream& inStream);
 
 	/**
 	 * @brief Read an AMFInteger from a bitStream
 	 *
 	 * @param inStream bitStream to read data from
 	 * @return Integer value represented as an AMFValue
 	 */
-	AMFBaseValue* ReadAmfInteger(RakNet::BitStream& inStream);
+	static std::unique_ptr<AMFIntValue> ReadAmfInteger(RakNet::BitStream& inStream);
 
 	/**
 	 * List of strings read so far saved to be read by reference.