Implemented #136 (use /// @init in events that contain declarations)

YellowAfterlife · Mar 20, 2021 · c1efffb · c1efffb
1 parent 7bae96f
commit c1efffb
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 1 deletion.
diff --git a/src/ace/AceWrapCommonCompleters.hx b/src/ace/AceWrapCommonCompleters.hx
@@ -170,6 +170,7 @@ class AceWrapCommonCompleters {
 			new AceAutoCompleteItem("implements", jsk, "@implements [{Name}]\nImplement an interface"),
 			new AceAutoCompleteItem("hint", jsk, "(see wiki)\nHint types/variables/methods"),
 			new AceAutoCompleteItem("template", jsk, "@template [{Constraint}] Type\nDeclare type parameters"),
+			new AceAutoCompleteItem("init", jsk, "@init\nMarks a non-Create event as a variable/function source"),
 		];
 		jsDocCompleter = new AceWrapCompleter([], ["comment.meta"], false, gmlOnly);
 		for (ac in jsDocItems) jsDocCompleter.items.push(ac); // we don't want items sorted in this one case

diff --git a/src/parsers/GmlSeeker.hx b/src/parsers/GmlSeeker.hx
@@ -193,7 +193,9 @@ class GmlSeeker {
 		var specTypeInst = GmlLinter.getOption((p) -> p.specTypeInst);
 		var funcsAreGlobal = GmlFileKindTools.functionsAreGlobal(kind);
 		var isObject = Std.is(kind, KGmlEvents);
-		var isCreateEvent = isObject && locals.name == "create";
+		var isCreateEvent = isObject && (locals.name == "create"
+			|| JsTools.rx(~/\/\/\/\s*@init\b/).test(src)
+		);
 		var __objectName:String = null;
 		function getObjectName():String {
 			if (__objectName == null) {

diff --git a/tests/TestGMEditGMS23/TestGMEditGMS23.yyp b/tests/TestGMEditGMS23/TestGMEditGMS23.yyp
diff --git a/tests/TestGMEditGMS23/objects/obj_user_event_init/Create_0.gml b/tests/TestGMEditGMS23/objects/obj_user_event_init/Create_0.gml
@@ -0,0 +1,3 @@
+event_user(0)
+create_func = function(a, b) {}
+create_var = 1;
diff --git a/tests/TestGMEditGMS23/objects/obj_user_event_init/Other_10.gml b/tests/TestGMEditGMS23/objects/obj_user_event_init/Other_10.gml
@@ -0,0 +1,3 @@
+/// @init
+user_func = function(a, b) {}
+user_var = 2;
diff --git a/tests/TestGMEditGMS23/objects/obj_user_event_init/Step_0.gml b/tests/TestGMEditGMS23/objects/obj_user_event_init/Step_0.gml
@@ -0,0 +1,4 @@
+create_func(); ///want_warn
+user_func(); ///want_warn
+create_var++; ///note: should highlight in variable color
+user_var++; ///note: should highlight in variable color
diff --git a/tests/TestGMEditGMS23/objects/obj_user_event_init/obj_user_event_init.yy b/tests/TestGMEditGMS23/objects/obj_user_event_init/obj_user_event_init.yy