Merge pull request #3960 from masatake/main--foreign-fields

optlib: allow users to set fields and check extras defined in a foreign language

Author: masatake

Tmain/flags-fielddef-datatype.d/stdout-expected.txt

@@ -1,6 +1,6 @@
 #LETTER NAME         ENABLED LANGUAGE  JSTYPE FIXED OP DESCRIPTION
--       boolfield    no      FIELDTEST --b    no    -- a field having boolean value
+-       boolfield    no      FIELDTEST --b    no    rw a field having boolean value
 -       deffield     no      FIELDTEST s--    no    -- a field that type is not specified
--       intfield     no      FIELDTEST -i-    no    -- a field having integer value
--       strboolfield no      FIELDTEST s-b    no    -- a field having string value or false
--       strfield     no      FIELDTEST s--    no    -- a field having string value
+-       intfield     no      FIELDTEST -i-    no    rw a field having integer value
+-       strboolfield no      FIELDTEST s-b    no    rw a field having string value or false
+-       strfield     no      FIELDTEST s--    no    rw a field having string value

Tmain/list-fielddef-flags.d/stdout-expected.txt

@@ -1,2 +1,2 @@
 #LETTER NAME          DESCRIPTION
--       datatype=TYPE acceaptable datatype of the field ([str]|bool|int|str+bool)
+-       datatype=TYPE acceaptable datatype of the field (str|bool|int|str+bool)

Tmain/list-fields-with-prefix.d/stdout-expected.txt

@@ -31,23 +31,24 @@ x       UCTAGSxpath          no      NONE             s--    no    -- xpath for
 -       UCTAGShowImported    no      Go               s--    no    -- how the package is imported ("inline" for `.' or "init" for `_')
 -       UCTAGSpackage        yes     Go               s--    no    -- the real package specified by the package name
 -       UCTAGSpackageName    yes     Go               s--    no    -- the name for referring the package
--       UCTAGSimplements     yes     Inko             s--    no    -- Trait being implemented
+-       UCTAGSimplements     yes     Inko             s--    no    rw Trait being implemented
 -       UCTAGSassignment     yes     LdScript         s--    no    -- how a value is assigned to the symbol
 -       UCTAGSdefiner        yes     Lisp             s--    no    -- the name of the function or macro that defines the unknown/Y-kind object
 -       UCTAGSsectionMarker  no      Markdown         s--    no    -- character used for declaring section(#, ##, =, or -)
 -       UCTAGSwrapping       yes     Moose            s--    no    -- how a wrapper wrapping the method (around, after, or before)
 -       UCTAGSlangid         yes     NSIS             s--    no    -- language identifier specified in (License)LangString commands
 -       UCTAGScategory       yes     ObjectiveC       s--    no    -- category attached to the class
 -       UCTAGSprotocols      yes     ObjectiveC       s--    no    -- protocols that the class (or category) confirms to
--       UCTAGShome           yes     Passwd           s--    no    -- home directory
--       UCTAGSshell          yes     Passwd           s--    no    -- login shell
+-       UCTAGShome           yes     Passwd           s--    no    rw home directory
+-       UCTAGSshell          yes     Passwd           s--    no    rw login shell
 -       UCTAGSdecorators     no      Python           s--    no    -- decorators on functions and classes
 -       UCTAGSnameref        yes     Python           s--    no    -- the original name for the tag
 -       UCTAGSassignmentop   no      R                s--    no    -- operator for assignment
 -       UCTAGSconstructor    yes     R                s--    no    -- function used for making value assigned to the nameattr tag
 -       UCTAGSoverline       no      ReStructuredText --b    no    -- whether using overline & underline for declaring section
 -       UCTAGSsectionMarker  no      ReStructuredText s--    no    -- character used for declaring section
 -       UCTAGSmixin          yes     Ruby             s--    no    -- how the class or module is mixed in (mixin:HOW:MODULE)
+-       UCTAGSmodule         yes     SCSS             s--    no    rw the name of module behind the namespace
 -       UCTAGSdefiner        yes     Scheme           s--    no    -- the name of the function or macro that defines the unknown/Y-kind object
 -       UCTAGSparameter      no      SystemVerilog    --b    no    -- parameter whose value can be overridden.
 -       UCTAGStarget         yes     Thrift           s--    no    -- the target language specified at "namespace"

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

@@ -49,23 +49,24 @@ z	kind	no	NONE	s--	no	r-	[tags output] prepend "kind:" to k/ (or K/) field outpu
 -	howImported	no	Go	s--	no	--	how the package is imported ("inline" for `.' or "init" for `_')
 -	package	yes	Go	s--	no	--	the real package specified by the package name
 -	packageName	yes	Go	s--	no	--	the name for referring the package
--	implements	yes	Inko	s--	no	--	Trait being implemented
+-	implements	yes	Inko	s--	no	rw	Trait being implemented
 -	assignment	yes	LdScript	s--	no	--	how a value is assigned to the symbol
 -	definer	yes	Lisp	s--	no	--	the name of the function or macro that defines the unknown/Y-kind object
 -	sectionMarker	no	Markdown	s--	no	--	character used for declaring section(#, ##, =, or -)
 -	wrapping	yes	Moose	s--	no	--	how a wrapper wrapping the method (around, after, or before)
 -	langid	yes	NSIS	s--	no	--	language identifier specified in (License)LangString commands
 -	category	yes	ObjectiveC	s--	no	--	category attached to the class
 -	protocols	yes	ObjectiveC	s--	no	--	protocols that the class (or category) confirms to
--	home	yes	Passwd	s--	no	--	home directory
--	shell	yes	Passwd	s--	no	--	login shell
+-	home	yes	Passwd	s--	no	rw	home directory
+-	shell	yes	Passwd	s--	no	rw	login shell
 -	decorators	no	Python	s--	no	--	decorators on functions and classes
 -	nameref	yes	Python	s--	no	--	the original name for the tag
 -	assignmentop	no	R	s--	no	--	operator for assignment
 -	constructor	yes	R	s--	no	--	function used for making value assigned to the nameattr tag
 -	overline	no	ReStructuredText	--b	no	--	whether using overline & underline for declaring section
 -	sectionMarker	no	ReStructuredText	s--	no	--	character used for declaring section
 -	mixin	yes	Ruby	s--	no	--	how the class or module is mixed in (mixin:HOW:MODULE)
+-	module	yes	SCSS	s--	no	rw	the name of module behind the namespace
 -	definer	yes	Scheme	s--	no	--	the name of the function or macro that defines the unknown/Y-kind object
 -	parameter	no	SystemVerilog	--b	no	--	parameter whose value can be overridden.
 -	target	yes	Thrift	s--	no	--	the target language specified at "namespace"

Tmain/optscript.d/error-undefined-if-if.expected

@@ -4,4 +4,4 @@ top|   |bottom
 Execution stack:
 top|   a   {a}   --if--   {true {a} if}   --if--   |bottom
 Dictionary stack:
-top|   -dict:1-   -dict:89-   |bottom
+top|   -dict:1-   -dict:91-   |bottom

Tmain/optscript.d/error-undefined-if.expected

@@ -4,4 +4,4 @@ top|   |bottom
 Execution stack:
 top|   a   {a}   --if--   |bottom
 Dictionary stack:
-top|   -dict:1-   -dict:89-   |bottom
+top|   -dict:1-   -dict:91-   |bottom

Tmain/parser-specific-fields-for-foreign-lang-in-json.d/input.unknownx

@@ -0,0 +1,10 @@
+public func foo(n, m);
+protected func bar(n);
+private func baz(n,...);
+STR:strset@iamowner
+STR:setsetempty@
+STR:notset
+Y:iamowner2=tagme2
+Z:tagme-z@iamowner-z
+eset:a
+enoset:b

Tmain/parser-specific-fields-for-foreign-lang-in-json.d/knownz.ctags

@@ -0,0 +1,12 @@
+--langdef=knownz
+--kinddef-knownz=m,mark,makers
+
+--_fielddef-knownz=owner,the owner of the markers{datatype=str}
+
+--_fielddef-knownz=len,the length of owner string{datatype=int}
+--fields-knownz=+{len}
+--_fielddef-knownz=lenplus,the length of owner string + 1{datatype=int}
+--fields-knownz=+{lenplus}
+
+--_fielddef-knownz=exported,whether the marker is exported or not{datatype=bool}
+--fields-knownz=+{exported}

Tmain/parser-specific-fields-for-foreign-lang-in-json.d/run.sh

@@ -0,0 +1,19 @@
+# Copyright: 2025 Masatake YAMATO
+# License: GPL-2
+
+. ../utils.sh
+
+CTAGS=$1
+
+V=
+# V=valgrind
+
+is_feature_available "${CTAGS}" json
+
+echo "# output: json"
+${V} ${CTAGS} --options=NONE --options=./knownz.ctags --sort=no --options=./unknownx.ctags \
+	 --fields=+l \
+	 --fields-unknownx=+'{protection}{signature}' \
+	 --fields-knownz=+'{owner}' \
+	 --output-format=json \
+	 -o - input.unknownx

Tmain/parser-specific-fields-for-foreign-lang-in-json.d/stderr-expected.txt

@@ -0,0 +1 @@
+ctags: Notice: No options will be read from files or environment