fix(fgdpp): add support for modifiers in entity keyvalues, implement strata fgd extension

Author: craftablescience

include/fgdpp/fgdpp.h

@@ -24,6 +24,7 @@ class FGD {
 		struct Field {
 			std::string_view name;
 			std::string_view valueType;
+			std::string_view modifier;
 			std::string_view displayName;
 			std::string_view valueDefault;
 			std::string_view description;
@@ -36,6 +37,7 @@ class FGD {
 			};
 
 			std::string_view name;
+			std::string_view modifier;
 			std::string_view displayName;
 			std::string_view valueDefault;
 			std::string_view description;
@@ -51,6 +53,9 @@ class FGD {
 			};
 
 			std::string_view name;
+			std::string_view modifier;
+			std::string_view displayName;
+			std::string_view description;
 			std::vector<Flag> flags;
 		};
 

src/fgdpp/fgdpp.cpp

@@ -184,6 +184,14 @@ void readEntityIO(BufferStreamReadOnly& stream, BufferStream& backing, FGD::Enti
 	parser::text::eatWhitespaceAndSingleLineComments(stream);
 }
 
+[[nodiscard]] std::string_view readEntityFieldModifier(BufferStreamReadOnly& stream, BufferStream& backing) {
+	parser::text::eatWhitespace(stream);
+	if (stream.peek<char>() != ':' && stream.peek<char>() != '=') {
+		return parser::text::readUnquotedStringToBuffer(stream, backing);
+	}
+	return "";
+}
+
 void readEntityKeyValue(BufferStreamReadOnly& stream, BufferStream& backing, FGD::Entity& entity) {
 	// Key and value type (looks like "key(valueType)", or "input key(valueType)" for i/o)
 	auto name = parser::text::readUnquotedStringToBuffer(stream, backing, "(", parser::text::NO_ESCAPE_SEQUENCES);
@@ -205,6 +213,7 @@ void readEntityKeyValue(BufferStreamReadOnly& stream, BufferStream& backing, FGD
 	if (string::iequals(valueType, "choices")) {
 		auto& field = entity.fieldsWithChoices.emplace_back();
 		field.name = name;
+		field.modifier = ::readEntityFieldModifier(stream, backing);
 
 		if (::tryToEatSeparator(stream, ':')) {
 			field.displayName = ::readFGDString(stream, backing);
@@ -238,6 +247,17 @@ void readEntityKeyValue(BufferStreamReadOnly& stream, BufferStream& backing, FGD
 	} else if (string::iequals(valueType, "flags")) {
 		auto& field = entity.fieldsWithFlags.emplace_back();
 		field.name = name;
+		field.modifier = ::readEntityFieldModifier(stream, backing);
+
+		if (::tryToEatSeparator(stream, ':')) {
+			field.displayName = ::readFGDString(stream, backing);
+			parser::text::eatWhitespaceAndSingleLineComments(stream);
+		}
+
+		if (::tryToEatSeparator(stream, ':')) {
+			field.description = ::readFGDString(stream, backing);
+			parser::text::eatWhitespaceAndSingleLineComments(stream);
+		}
 
 		if (!::tryToEatSeparator(stream, '=') || !::tryToEatSeparator(stream, '[')) {
 			throw parser::text::syntax_error{INVALID_SYNTAX_MSG};
@@ -246,7 +266,7 @@ void readEntityKeyValue(BufferStreamReadOnly& stream, BufferStream& backing, FGD
 
 		while (stream.peek<char>() != ']') {
 			auto& flag = field.flags.emplace_back();
-			flag.value = parser::text::readUnquotedStringToBuffer(stream, backing, parser::text::NO_ESCAPE_SEQUENCES);
+			flag.value = ::readFGDString(stream, backing);
 
 			if (!::tryToEatSeparator(stream, ':')) {
 				continue;
@@ -256,7 +276,7 @@ void readEntityKeyValue(BufferStreamReadOnly& stream, BufferStream& backing, FGD
 			if (!::tryToEatSeparator(stream, ':')) {
 				continue;
 			}
-			flag.enabledByDefault = parser::text::readUnquotedStringToBuffer(stream, backing, parser::text::NO_ESCAPE_SEQUENCES);
+			flag.enabledByDefault = ::readFGDString(stream, backing);
 
 			if (!::tryToEatSeparator(stream, ':')) {
 				continue;
@@ -268,6 +288,7 @@ void readEntityKeyValue(BufferStreamReadOnly& stream, BufferStream& backing, FGD
 		auto& field = entity.fields.emplace_back();
 		field.name = name;
 		field.valueType = valueType;
+		field.modifier = ::readEntityFieldModifier(stream, backing);
 		field.displayName = "";
 		field.valueDefault = "";
 		field.description = "";

test/res/fgdpp/ideal.fgd

@@ -10,11 +10,11 @@
         "An entity that can be linked to another door and create a passage between them dynamically.\n" +
         "This is a separate line!"
 [
-        portal1(int)
+        portal1(int) readonly
         portal2(int) : "Portal 2"
         portal3(int) : "Portal 3" : "0"
-        portal4(int) : "Portal 4" : "0" : "This is the wonderful world of Portal " +
-                                          "4"
+        portal4(int) report : "Portal 4" : "0" : "This is the wonderful world of Portal " +
+                                                 "4"
 
         input portalInput1(string)
         input portalInput2(string) : "Portal Input 2"
@@ -31,7 +31,7 @@
             8 : "nothing"            : 1
         ]
 
-        model(choices) : "Model used" : "models/something02.mdl" =
+        model(choices) readonly : "Model used" : "models/something02.mdl" =
         [
             "models/something01.mdl" : "something"
             "models/something02.mdl" : "something else (default)"
@@ -51,6 +51,14 @@
         ]
 
         output portalOutput3(string) : "Portal Output 3"
+
+        effects(flags) : "Effects" : "These sure are effects" =
+        [
+                0: "None" : 0
+                1: "Always, very expensive!" : 0
+                2: "Bright, dynamic light at entity origin" : 0
+                4: "Dim, dynamic light at entity origin" : 0
+        ]
 ]
 
 @MaterialExclusion