Lua: fill scope fields in tags of function kinds

With the last commit for the Lua parser, "lua: don't include module in function names",
the lua parser degraded in the following aspects.

    test = {}
    test.f = function()
	   pirint "hello"
    end

The original parser can represent the relation between "test" and "f";
the "f" is extracted as "test.f".

With the last commit, the parser cannot represent the relation between
"test" and "f".

To recover the degradation, this change fills the scope fields as following:

   f	iput.lua	/^test.f = function()$/;"	kind:function	scope:unknown:test
   test.f	input.lua	/^test.f = function()$/;"	kind:function	scope:unknown:test	extras:qualified

"test.f" is tagged only when --extras=+q is given.

Far from perfect but better than nothing.
TODO: tagging "test".

Signed-off-by: Masatake YAMATO <[email protected]>

Author: masatake

Tmain/list-roles.d/stdout-expected.txt

@@ -51,6 +51,7 @@ Kconfig        k/kconfig         source             on      kconfig file loaded
 LdScript       i/inputSection    discarded          on      discarded when linking
 LdScript       i/inputSection    mapped             on      mapped to output section
 LdScript       s/symbol          entrypoint         on      entry points
+Lua            X/unknown         referenced         off     referenced somehow
 M4             I/macrofile       included           on      included macro
 M4             I/macrofile       sincluded          on      silently included macro
 M4             d/macro           undef              on      undefined
@@ -142,6 +143,7 @@ Kconfig        k/kconfig         source             on      kconfig file loaded
 LdScript       i/inputSection    discarded          on      discarded when linking
 LdScript       i/inputSection    mapped             on      mapped to output section
 LdScript       s/symbol          entrypoint         on      entry points
+Lua            X/unknown         referenced         off     referenced somehow
 M4             I/macrofile       included           on      included macro
 M4             I/macrofile       sincluded          on      silently included macro
 M4             d/macro           undef              on      undefined

Units/parser-lua.r/lua-broken-nested-tables.d/README

@@ -0,0 +1 @@
+This is a crash test.

Units/parser-lua.r/lua-broken-nested-tables.d/args.ctags

@@ -0,0 +1 @@
+--extras=+q

Units/parser-lua.r/lua-broken-nested-tables.d/input.lua

@@ -0,0 +1,58 @@
+a = {}
+a..b = {}
+a..b..c = function()
+      print "hello"
+end
+a..b..c()
+
+ax = {}
+ax..by = {}
+ax..by..cz = function()
+      print "hello"
+end
+ax..by..cz()
+
+
+.aX = function()
+      print "hello"
+end
+
+.aX.bY = function()
+      print "hello"
+end
+
+.aX.bY( = function()
+      print "hello"
+end
+
+.(aX.bY = function()
+      print "hello"
+end
+
+..aX.bY = function()
+      print "hello"
+end
+
+.aX.bY.cZ. = function()
+      print "hello"
+end
+
+..aX.bY.cZ. = function()
+      print "hello"
+end
+
+.aX.bY.cZ.. = function()
+      print "hello"
+end
+
+.aX.b(Y.cZ.. = function()
+      print "hello"
+end
+
+.aX.(bY.cZ.. = function()
+      print "hello"
+end
+
+.aX(.bY.cZ.. = function()
+      print "hello"
+end

Units/parser-lua.r/lua-function-in-nested-tables.d/args.ctags

@@ -0,0 +1,3 @@
+--sort=no
+--extras=+q
+--fields=-+E

Units/parser-lua.r/lua-function-in-nested-tables.d/expected.tags

@@ -0,0 +1,4 @@
+c	input.lua	/^a.b.c = function()$/;"	f	unknown:a.b
+a.b.c	input.lua	/^a.b.c = function()$/;"	f	unknown:a.b	extras:qualified
+cz	input.lua	/^ax.by.cz = function()$/;"	f	unknown:ax.by
+ax.by.cz	input.lua	/^ax.by.cz = function()$/;"	f	unknown:ax.by	extras:qualified

Units/parser-lua.r/lua-function-in-nested-tables.d/input.lua

@@ -0,0 +1,13 @@
+a = {}
+a.b = {}
+a.b.c = function()
+      print "hello"
+end
+a.b.c()
+
+ax = {}
+ax.by = {}
+ax.by.cz = function()
+      print "hello"
+end
+ax.by.cz()

Units/parser-lua.r/simple.lua.d/expected.tags

@@ -1,3 +1,3 @@
-i_123	input.lua	/^ test.i_123 = function  (x)$/;"	f
-me_12a	input.lua	/^function test.me_12a(one, two)$/;"	f
-me_12b	input.lua	/^function test.me_12b (one, two)$/;"	f
+i_123	input.lua	/^ test.i_123 = function  (x)$/;"	f	unknown:test
+me_12a	input.lua	/^function test.me_12a(one, two)$/;"	f	unknown:test
+me_12b	input.lua	/^function test.me_12b (one, two)$/;"	f	unknown:test

parsers/lua.c

@@ -15,6 +15,7 @@
 #include <string.h>
 
 #include "debug.h"
+#include "entry.h"
 #include "parse.h"
 #include "read.h"
 #include "routines.h"
@@ -24,11 +25,24 @@
 *   DATA DEFINITIONS
 */
 typedef enum {
-	K_FUNCTION
+	K_FUNCTION,
+	K_UNKNOWN,
 } luaKind;
 
+typedef enum {
+	LUA_UNKNOWN_REFERENCED,
+} luaUnknownRole;
+
+static roleDefinition LuaUnknownRoles [] = {
+	{ false, "referenced", "referenced somehow" },
+};
+
 static kindDefinition LuaKinds [] = {
-	{ true, 'f', "function", "functions" }
+	{ true, 'f', "function", "functions" },
+
+	/* `unknown' is a kind just for making FQ tag for functions. */
+	{ false, 'X', "unknown",  "unknown language object",
+	  .referenceOnly = true, ATTACH_ROLES(LuaUnknownRoles) },
 };
 
 /*
@@ -63,6 +77,18 @@ static bool isLuaIdentifier (char c)
 	return (bool) !(isspace(c)  || c == '(' || c == ')' || c == '=' || c == '.' || c == ':');
 }
 
+static void set_scope (int child, int parent)
+{
+	if (parent == CORK_NIL || child == CORK_NIL)
+		return;
+
+	tagEntryInfo *e = getEntryInCorkQueue (child);
+	if (!e)
+		return;
+
+	e->extensionFields.scopeIndex = parent;
+}
+
 static void extract_next_token (const char *begin, const char *end_sentinel, vString *name)
 {
 	if (begin == NULL || end_sentinel == NULL)
@@ -90,10 +116,16 @@ static void extract_next_token (const char *begin, const char *end_sentinel, vSt
 
 	Assert (begin <= end);
 
+	int lastCorkIndx = CORK_NIL;
 	for (const char *c = begin; c <= end; ++c)
 	{
 		if (*c == '.' || *c == ':')
 		{
+			int r = makeSimpleRefTag(name,
+									 K_UNKNOWN, LUA_UNKNOWN_REFERENCED);
+			set_scope(r, lastCorkIndx);
+			lastCorkIndx = r;
+
 			/* Do not include module names in function name */
 			vStringClear (name);
 		}
@@ -108,7 +140,8 @@ static void extract_next_token (const char *begin, const char *end_sentinel, vSt
 		}
 	}
 
-	makeSimpleTag (name, K_FUNCTION);
+	int d = makeSimpleTag (name, K_FUNCTION);
+	set_scope(d, lastCorkIndx);
 	vStringClear (name);
 }
 
@@ -133,12 +166,42 @@ static void extract_prev_token (const char *end, const char *begin_sentinel, vSt
 	while (begin_sentinel <= begin && isLuaIdentifier (*begin))
 		begin--;
 
+	int targetCorkIndex = CORK_NIL;
 	if (end - begin)
 	{
 		vStringNCatS (name, begin + 1, end - begin);
-		makeSimpleTag (name, K_FUNCTION);
+		targetCorkIndex = makeSimpleTag (name, K_FUNCTION);
 		vStringClear (name);
 	}
+
+	if (targetCorkIndex == CORK_NIL || begin_sentinel == begin)
+		return;
+
+	/* Fill the scope field of the function. */
+	end = begin;
+	while (begin_sentinel <= (begin + 1))
+	{
+		bool on_boundary = false;
+		if (begin < begin_sentinel || !isLuaIdentifier (*begin))
+		{
+			if (end - begin)
+			{
+				vStringNCatS (name, begin + 1, end - begin);
+				int r = makeSimpleRefTag (name,
+										  K_UNKNOWN, LUA_UNKNOWN_REFERENCED);
+				set_scope (targetCorkIndex, r);
+				targetCorkIndex = r;
+				vStringClear (name);
+			}
+			if (begin_sentinel <= begin && ! (*begin == ':' || *begin == '.'))
+				break;
+			on_boundary = true;
+		}
+		begin--;
+
+		if(on_boundary)
+			end = begin;
+	}
 }
 
 static void findLuaTags (void)
@@ -188,5 +251,7 @@ extern parserDefinition* LuaParser (void)
 	def->kindCount  = ARRAY_SIZE (LuaKinds);
 	def->extensions = extensions;
 	def->parser     = findLuaTags;
+	def->useCork    = CORK_QUEUE;
+	def->requestAutomaticFQTag = true;
 	return def;
 }