Merge pull request #3289 from masatake/basic--decl

Basic: extract declarations as reference tags (partially derived from #3276)

Author: masatake

.gitignore

@@ -49,6 +49,7 @@ depcomp
 gdb-backtrace.txt
 install-sh
 libctags.a
+libutil.a
 Makefile.in
 mini-geany
 mini-geany.exe

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

@@ -16,6 +16,7 @@ Automake       d/directory       ltlibrary          on      directory for LTLIBR
 Automake       d/directory       man                on      directory for MANS primary
 Automake       d/directory       program            on      directory for PROGRAMS primary
 Automake       d/directory       script             on      directory for SCRIPTS primary
+Basic          f/function        decl               on      declared
 C              d/macro           condition          off     used in part of #if/#ifdef/#elif conditions
 C              d/macro           undef              on      undefined
 C              h/header          local              on      local header
@@ -120,6 +121,7 @@ Automake       d/directory       ltlibrary          on      directory for LTLIBR
 Automake       d/directory       man                on      directory for MANS primary
 Automake       d/directory       program            on      directory for PROGRAMS primary
 Automake       d/directory       script             on      directory for SCRIPTS primary
+Basic          f/function        decl               on      declared
 C              d/macro           condition          off     used in part of #if/#ifdef/#elif conditions
 C              d/macro           undef              on      undefined
 C              h/header          local              on      local header

Units/parser-basic.r/freebasic-decls.d/args.ctags

@@ -0,0 +1,3 @@
+--sort=no
+--fields=+rE
+--extras=+r

Units/parser-basic.r/freebasic-decls.d/expected.tags

@@ -0,0 +1,21 @@
+curses	input.bas	/^namespace curses 'public use this$/;"	n	roles:def
+win	input.bas	/^		type win as curses.curses_priv._win_st$/;"	t	namespace:curses	roles:def
+_Init	input.bas	/^		declare	function	_Init	alias "initscr" () as win ptr$/;"	f	namespace:curses	roles:decl	extras:reference
+GetMaxX	input.bas	/^		declare	function	GetMaxX alias	"getmaxx" (byval as win ptr) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+GetMaxY	input.bas	/^		declare	function	GetMaxY alias "getmaxy"	(byval as win ptr) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+CreateWindow	input.bas	/^		declare	function	CreateWindow alias "newwin" (byval as integer, byval as integer, byval as int/;"	f	namespace:curses	roles:decl	extras:reference
+CreateSubWindow	input.bas	/^		declare	function	CreateSubWindow alias "subwin" (byval as win ptr, byval as integer, byval as /;"	f	namespace:curses	roles:decl	extras:reference
+GetChar	input.bas	/^		declare function	GetChar alias "getch" () as UByte$/;"	f	namespace:curses	roles:decl	extras:reference
+CBreak	input.bas	/^		declare function	CBreak alias "cbreak" () as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+EreaseTerm	input.bas	/^		declare function	EreaseTerm alias "erase" () as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+ClearTerm	input.bas	/^		declare function	ClearTerm alias "clear" () as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+EreaseWindow	input.bas	/^		declare function EreaseWindow alias "werase" (byval as win ptr) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+ClearWindow	input.bas	/^		declare function ClearWindow alias "wclear" (byval as win ptr) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+DeleteWindow	input.bas	/^		declare function DeleteWindow alias "delwin" (byval as win ptr) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+_Exit	input.bas	/^		declare function _Exit alias "endwin" () as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+RefresTerm	input.bas	/^		declare function RefresTerm alias "refresh" () as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+RefreshWindow	input.bas	/^		declare function RefreshWindow alias "wrefresh" (byval as win ptr) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+PrintTerm	input.bas	/^		declare function PrintTerm  alias "printw" (byval as zstring ptr, ... ) as integer$/;"	f	namespace:curses	roles:decl	extras:reference
+PrintWindow	input.bas	/^		declare function PrintWindow alias "wprintw" (byval as win ptr, byval as zstring ptr, ... ) as/;"	f	namespace:curses	roles:decl	extras:reference
+SetCursorPositionTerm	input.bas	/^		declare function SetCursorPositionTerm alias "move" (byval as integer,byval as integer) as int/;"	f	namespace:curses	roles:decl	extras:reference
+SetCursorPositionWindow	input.bas	/^		declare function SetCursorPositionWindow alias "wmove" (byval as win ptr, byval as integer, by/;"	f	namespace:curses	roles:decl	extras:reference

Units/parser-basic.r/freebasic-decls.d/input.bas

@@ -0,0 +1,34 @@
+' Taken from https://termbin.com/x9wo submitted by @Glog78
+namespace curses 'public use this
+	#include "curses_priv.bi"
+	#inclib "curses"
+
+	extern "c"
+
+		type win as curses.curses_priv._win_st
+
+		declare	function	_Init	alias "initscr" () as win ptr
+		declare	function	GetMaxX alias	"getmaxx" (byval as win ptr) as integer
+		declare	function	GetMaxY alias "getmaxy"	(byval as win ptr) as integer
+		declare	function	CreateWindow alias "newwin" (byval as integer, byval as integer, byval as integer, byval as integer) as win
+		declare	function	CreateSubWindow alias "subwin" (byval as win ptr, byval as integer, byval as integer, byval as integer, byval as integer) as win ptr
+		declare function	GetChar alias "getch" () as UByte
+		declare function	CBreak alias "cbreak" () as integer
+		declare function	EreaseTerm alias "erase" () as integer
+		declare function	ClearTerm alias "clear" () as integer
+		declare function EreaseWindow alias "werase" (byval as win ptr) as integer
+		declare function ClearWindow alias "wclear" (byval as win ptr) as integer
+		declare function DeleteWindow alias "delwin" (byval as win ptr) as integer
+		declare function _Exit alias "endwin" () as integer
+		declare function RefresTerm alias "refresh" () as integer
+		declare function RefreshWindow alias "wrefresh" (byval as win ptr) as integer
+		declare function PrintTerm  alias "printw" (byval as zstring ptr, ... ) as integer
+		declare function PrintWindow alias "wprintw" (byval as win ptr, byval as zstring ptr, ... ) as integer
+		declare function SetCursorPositionTerm alias "move" (byval as integer,byval as integer) as integer
+		declare function SetCursorPositionWindow alias "wmove" (byval as win ptr, byval as integer, byval as integer) as integer
+
+	end extern
+
+end namespace 'curses
+
+' vim: bs=2 sw=2 ss=2 ts=2 nu noet ft=basic

parsers/basic.c

@@ -41,9 +41,18 @@ typedef enum {
 	K_NAMESPACE,
 } BasicKind;
 
+typedef enum {
+	BASIC_FUNCTION_DECL,
+} basciFunctionRole;
+
+static roleDefinition BasicFunctionRoles [] = {
+	{ true, "decl", "declared" },
+};
+
 static kindDefinition BasicKinds[] = {
 	{true, 'c', "constant", "constants"},
-	{true, 'f', "function", "functions"},
+	{true, 'f', "function", "functions",
+	 .referenceOnly = false, ATTACH_ROLES(BasicFunctionRoles)},
 	{true, 'l', "label", "labels"},
 	{true, 't', "type", "types"},
 	{true, 'v', "variable", "variables"},
@@ -63,6 +72,7 @@ enum eKeywordID {
 	KEYWORD_NAMESPACE,
 	KEYWORD_END,
 	KEYWORD_ACCESS,
+	KEYWORD_DECLARE,
 };
 typedef int keywordId; /* to allow KEYWORD_NONE */
 
@@ -82,6 +92,7 @@ static const keywordTable BasicKeywordTable[] = {
 	{"enum", KEYWORD_ENUM},
 	{"namespace", KEYWORD_NAMESPACE},
 	{"end", KEYWORD_END},
+	{"declare", KEYWORD_DECLARE},
 
 	/* blitzbasic, purebasic */
 	{"global", KEYWORD_VARIABLE},
@@ -123,11 +134,15 @@ struct BasicKeywordAttr {
 	[KEYWORD_ACCESS] = {
 		.kind = KIND_GHOST_INDEX,
 	},
+	[KEYWORD_DECLARE] = {
+		.kind = KIND_GHOST_INDEX,
+	},
 };
 
 struct matchState {
 	const char *access;
 	bool end;
+	bool declaration;
 };
 
 static int currentScope;
@@ -214,15 +229,20 @@ static bool isIdentChar (char c)
 	return c && !isspace (c) && c != '(' && c != ',' && c != '=';
 }
 
-static int makeBasicTag (vString *name, int kindIndex)
+static int makeBasicRefTag (vString *name, int kindIndex, int roleIndex)
 {
-	int r = makeSimpleTag (name, kindIndex);
+	int r = makeSimpleRefTag (name, kindIndex, roleIndex);
 	tagEntryInfo *e = getEntryInCorkQueue (r);
 	if (e)
 		e->extensionFields.scopeIndex = currentScope;
 	return r;
 }
 
+static int makeBasicTag (vString *name, int kindIndex)
+{
+	return makeBasicRefTag (name, kindIndex, ROLE_DEFINITION_INDEX);
+}
+
 /* Match the name of a dim or const starting at pos. */
 static void extract_dim (char const *pos, BasicKind kind)
 {
@@ -298,7 +318,13 @@ static int extract_name (char const *pos, BasicKind kind, struct matchState *sta
 	vString *name = vStringNew ();
 	for (; isIdentChar (*pos); pos++)
 		vStringPut (name, *pos);
-	r = makeBasicTag (name, kind);
+	if (state && state->declaration)
+	{
+		if (kind == K_FUNCTION)
+			r = makeBasicRefTag (name, kind, BASIC_FUNCTION_DECL);
+	}
+	else
+		r = makeBasicTag (name, kind);
 	vStringDelete (name);
 
 	tagEntryInfo *e = getEntryInCorkQueue (r);
@@ -313,6 +339,7 @@ static void match_state_reset (struct matchState *state)
 {
 	state->access = NULL;
 	state->end = false;
+	state->declaration =false;
 }
 
 static bool match_keyword (const char **cp, vString *buf,
@@ -346,6 +373,12 @@ static bool match_keyword (const char **cp, vString *buf,
 		*cp = p;
 		return true;
 	}
+	else if (kw == KEYWORD_DECLARE)
+	{
+		state->declaration = true;
+		*cp = p;
+		return true;
+	}
 
 	int kind = keywordToKind (kw);
 	int index = CORK_NIL;

peg/.gitignore

@@ -1,2 +1,3 @@
 varlink.[ch]
 kotlin.[ch]
+thrift.[ch]