main: introduce --_makeTagEntryReflection-<LANG> option to filter tags

Tmain/common-prelude.d/endwith.expected

@@ -0,0 +1,7 @@
+true
+false
+false
+false
+true
+true
+true

Tmain/common-prelude.d/stdout-expected.txt

@@ -4,6 +4,7 @@ buildstring.ps...0
 chop.ps...0
 dedup.ps...0
 dedup_spaces.ps...0
+endwith.ps...0
 ndup.ps...0
 normalize_spaces.ps...0
 putlast.ps...0

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:90-   |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:90-   |bottom

Tmain/optscript.d/string.expected

@@ -74,3 +74,40 @@ true
 false
 (a.b;c)
 (\(a.b;c\) false ->)
+(--------------- _strrpbrk ---------------)
+x/abc.d|./
+true
+5
+(x/abc.d)
+x/abc.|./
+true
+5
+(x/abc.)
+x.abc/d|./
+true
+5
+(x.abc/d)
+x.abc/|./
+true
+5
+(x.abc/)
+x.abc.d|./
+true
+5
+(x.abc.d)
+x.abc.|./
+true
+5
+(x.abc.)
+abc|./
+false
+(abc)
+|./
+false
+()
+abc|
+false
+(abc)
+|
+false
+()

Units/option-makeTagEntryReflection.d/args.ctags

@@ -0,0 +1,79 @@
+# See #3020 and #3027.
+
+--sort=no
+--extras=+q
+
+--_extradef-Markdown=withfname,appending input filename
+--extras-Markdown=+{withfname}
+
+--_prelude-Markdown={{
+    % You can customize the string combining the original name
+    % and the basen name of input file.
+    /SEP (@) def
+
+    % dict<original-index:int, withfname-index:int>
+    /scope-remapping-table 31 dict def
+
+    % (abc/input.d) dropext => (abc/input)
+    % (abc.d/input) dropext => (abc.d/input)
+    /dropext {
+        (/.) _strrpbrk {
+            % string offset
+            2 copy get ?/ eq {
+                pop
+            } {
+                0 exch 0 string _copyinterval
+            } ifelse
+        } if
+    } def
+
+    % (abc/efg) basename => (efg)
+    /basename {
+        ?/ _strrchr {
+            1 add dup 2 index length exch sub
+            0 string _copyinterval
+        } if
+    } def
+}}
+
+--_sequel-Markdown={{
+    % Fill the scope field of withfname extra tags.
+    scope-remapping-table {
+        % Make the original tag invisible
+        exch dup _markplaceholder
+        :scope dup
+        % withfname-index:int original-scope:int original-scope:int
+        0 eq {
+            pop pop
+        } {
+            % withfname-index:int original-scope:int
+            scope-remapping-table exch get
+            % withfname-index:int withfname-scope:int
+            scope:
+        } ifelse
+    } forall
+}}
+
+--_makeTagEntryReflection-Markdown={{
+    /Markdown.withfname _extraenabled {
+        . :extras {
+            /Markdown.withfname _amember not
+        } {
+            true
+        } ifelse
+        {
+            mark
+            . :name
+            SEP
+            . :input dropext basename
+            _buildstring
+
+            . :kind
+            . _tagloc _tag dup /Markdown.withfname _markextra
+            _commit
+            % Record the pair of original-index:int and withfname-index:int.
+            scope-remapping-table . 3 -1 roll put
+        } if
+
+    } if
+}}

Units/option-makeTagEntryReflection.d/expected.tags

@@ -0,0 +1,7 @@
+ABC@input	input.md	/^# ABC$/;"	c
+DEF@input	input.md	/^## DEF$/;"	s	chapter:ABC@input
+GHI@input	input.md	/^### GHI$/;"	S	section:ABC@input""DEF@input
+HIJ@input	input.md	/^### HIJ$/;"	S	section:ABC@input""DEF@input
+KLM@input	input.md	/^## KLM$/;"	s	chapter:ABC@input
+OPQ@input	input.md	/^# OPQ$/;"	c
+RST@input	input.md	/^### RST$/;"	S	chapter:OPQ@input

Units/option-makeTagEntryReflection.d/input.md

@@ -0,0 +1,13 @@
+# ABC
+
+## DEF
+
+### GHI
+
+### HIJ
+
+## KLM
+
+# OPQ
+
+### RST

dsl/optscript.c

@@ -338,6 +338,7 @@ declop(_strrstr);
 declop(_strchr);
 declop(_strrchr);
 declop(_strpbrk);
+declop(_strrpbrk);
 
 /* Relation, logical, and bit operators
    tested in relalogbit.ps */
@@ -554,6 +555,8 @@ opt_init (void)
 		   "string chr _STRRCHR string false");
 	defop (opt_system_dict, _strpbrk, 2, "string accept _STRPBRK string offset true%"
 		   "string accept _STRPBRK string false");
+	defop (opt_system_dict, _strrpbrk, 2, "string accept _STRRPBRK string offset true%"
+		   "string accept _STRRPBRK string false");
 
 	defop (opt_system_dict, exec,           1, "any EXEC -");
 	defop (opt_system_dict, if,             2, "bool proc IF -");
@@ -687,6 +690,12 @@ opt_dict_known_and_get_cstr (EsObject *dict, const char* name, EsObject **val)
 	return dict_op_known_and_get (dict, sym, val);
 }
 
+bool
+opt_dict_known_and_get (EsObject *dict, EsObject *key, EsObject **val)
+{
+	return dict_op_known_and_get (dict, key, val);
+}
+
 bool
 opt_dict_foreach (EsObject *dict, bool (* fn) (EsObject *, EsObject *, void*), void *data)
 {
@@ -3388,7 +3397,7 @@ op__strrchr (OptVM *vm, EsObject *name)
 }
 
 static EsObject*
-op__strpbrk (OptVM *vm, EsObject *name)
+op__strpbrk_common (OptVM *vm, EsObject *name, bool from_tail)
 {
 	EsObject *acceptobj = ptrArrayLast (vm->ostack);
 	EsObject *strobj = ptrArrayItemFromLast (vm->ostack, 1);
@@ -3402,7 +3411,7 @@ op__strpbrk (OptVM *vm, EsObject *name)
 	vString *acceptv = es_pointer_get (acceptobj);
 
 	const char *str = vStringValue (strv);
-	char *p = strpbrk (str, vStringValue (acceptv));
+	char *p = (from_tail? strrpbrk: strpbrk) (str, vStringValue (acceptv));
 	if (p)
 	{
 		int d = p - str;
@@ -3423,6 +3432,18 @@ op__strpbrk (OptVM *vm, EsObject *name)
 	}
 }
 
+static EsObject*
+op__strpbrk (OptVM *vm, EsObject *name)
+{
+	return op__strpbrk_common (vm, name, false);
+}
+
+static EsObject*
+op__strrpbrk (OptVM *vm, EsObject *name)
+{
+	return op__strpbrk_common (vm, name, true);
+}
+
 
 /*
  * Relation, logical, and bit operators

dsl/optscript.h

@@ -53,6 +53,7 @@ unsigned int opt_vm_ostack_count (OptVM *vm);
 
 EsObject *opt_dict_new       (unsigned int size);
 bool      opt_dict_known_and_get_cstr (EsObject *dict, const char* name, EsObject **val);
+bool      opt_dict_known_and_get (EsObject *dict, EsObject *key, EsObject **val);
 bool      opt_dict_foreach   (EsObject *dict, bool (* fn) (EsObject *, EsObject *, void*), void *data);
 void      opt_dict_def       (EsObject *dict, EsObject *sym, EsObject *val);
 bool      opt_dict_undef     (EsObject *dict, EsObject *sym);

main/CommonPrelude.c

@@ -265,4 +265,28 @@ const char ctagsCommonPrelude []=
 "        _foreignreftag\n"
 "    } ifelse\n"
 "} __bddef\n"
+"\n"
+"(string end:string _ENDWITH boolean)\n"
+"/_endwith {\n"
+"    2 copy length exch length exch\n"
+"    % str endstr strlen endstrlen\n"
+"    2 copy\n"
+"    ge {\n"
+"        % str endstr strlen endstrlen\n"
+"        dup 3 1 roll\n"
+"        % str endstr endstrlen strlen endstrlen\n"
+"        sub\n"
+"        % str endstr endstrlen offset\n"
+"        exch\n"
+"        % str endstr offset endstrlen\n"
+"        4 -1 roll\n"
+"        % endstr offset endstrlen str\n"
+"        3 1 roll\n"
+"        % str endstr str offset endstrlen\n"
+"        0 string _copyinterval eq\n"
+"    } {\n"
+"        pop pop pop pop false\n"
+"    } ifelse\n"
+"} __bddef\n"
+"% (input.md) (.md) _endwith ==\n"
 ;

main/dependency.c

@@ -14,6 +14,7 @@
 
 #include "debug.h"
 #include "dependency.h"
+#include "entry.h"
 #include "options.h"
 #include "parse_p.h"
 #include "read.h"
@@ -184,14 +185,18 @@ extern void notifyMakeTagEntry (const tagEntryInfo *tag, int corkIndex)
 {
 	subparser *s;
 
+	/* running optscript code attaching to --makeTagEntryReflection-<LANG> */
+	langType lang = tag->langType;
+	notifyLanguageRegexMakeTagEntry (lang, corkIndex);
+
 	foreachSubparser(s, false)
 	{
+		enterSubparser(s);
 		if (s->makeTagEntryNotify)
-		{
-			enterSubparser(s);
 			s->makeTagEntryNotify (s, tag, corkIndex);
-			leaveSubparser();
-		}
+		/* propagate the event recursively */
+		notifyMakeTagEntry (tag, corkIndex);
+		leaveSubparser();
 	}
 }
 

main/dependency.h

@@ -43,4 +43,9 @@ struct sSlaveParser {
 	slaveParser *next;
 };
 
+/* These are for CPreProcessor.
+ * Don't use in the other parsers. */
+extern void notifyInputStart (void);
+extern void notifyInputEnd   (void);
+
 #endif	/* CTAGS_MAIN_DEPENDENCY_H */

main/lregex.c

@@ -2249,6 +2249,17 @@ extern void notifyRegexInputEnd (struct lregexControlBlock *lcb)
 	fillEndLineFieldOfUpperScopes (lcb, endline);
 }
 
+extern void notifyRegexMakeTagEntry (struct lregexControlBlock *lcb,
+									 int corkIndex)
+{
+	if (ptrArrayCount (lcb->hook[SCRIPT_HOOK_MAKE_TAG_ENTRY_REFLECTION]) > 0)
+	{
+		optscriptSetup (optvm, lcb->local_dict, corkIndex);
+		scriptEvalHook (optvm, lcb, SCRIPT_HOOK_MAKE_TAG_ENTRY_REFLECTION);
+		optscriptTeardown (optvm, lcb->local_dict);
+	}
+}
+
 extern void findRegexTagsMainloop (int (* driver)(void))
 {
 	/* merely read all lines of the file */

main/lregex_p.h

@@ -107,6 +107,7 @@ extern bool matchMultitableRegex (struct lregexControlBlock *lcb, const vString*
 
 extern void notifyRegexInputStart (struct lregexControlBlock *lcb);
 extern void notifyRegexInputEnd (struct lregexControlBlock *lcb);
+extern void notifyRegexMakeTagEntry (struct lregexControlBlock *lcb, int corkIndex);
 
 extern void addRegexTable (struct lregexControlBlock *lcb, const char *name);
 extern void extendRegexTable (struct lregexControlBlock *lcb, const char *src, const char *dist);

main/options.c

@@ -378,6 +378,8 @@ static optionDescription LongOptionDescription [] = {
  {1,1,"       Define new extra for <LANG>. --extras-<LANG>=+{name} enables it."},
  {1,1,"  --_fielddef-<LANG>=<name>,<description>"},
  {1,1,"       Define new field for <LANG>."},
+ {1,1,"  --_makeTagEntryReflection-<LANG>={{ optscript-code }}"},
+ {1,1,"       Specify code run when <LANG> parser makes a tag."},
  {1,1,"  --_mtable-extend-<LANG>=disttable+srctable."},
  {1,1,"       Copy patterns of a regex table to another regex table."},
  {1,1,"  --_mtable-regex-<LANG>=<table>/<line_pattern>/<name_pattern>/[<flags>]"},
@@ -3363,6 +3365,8 @@ static void processLongOption (
 		;
 	else if (processSequelOption (option, parameter))
 		;
+	else if (processMakeTagEntryReflectionOption (option, parameter))
+		;
 	else if (processPretendOption (option, parameter))
 		;
 	else if (processRolesOption (option, parameter))

main/options_p.h

@@ -177,6 +177,7 @@ extern bool processRoledefOption (const char *const option, const char *const pa
 extern bool processScopesepOption (const char *const option, const char *const parameter);
 extern bool processPreludeOption (const char *const option, const char *const parameter);
 extern bool processSequelOption (const char *const option, const char *const parameter);
+extern bool processMakeTagEntryReflectionOption (const char *const option, const char *const parameter);
 extern bool processPretendOption (const char *const option, const char *const parameter);
 extern bool processRolesOption (const char *const option, const char *const parameter);
 

main/parse.c

@@ -4110,6 +4110,11 @@ extern void notifyLanguageRegexInputEnd (langType language)
 	notifyRegexInputEnd(pobj->lregexControlBlock);
 }
 
+extern void notifyLanguageRegexMakeTagEntry (langType language, int corkIndex)
+{
+	notifyRegexMakeTagEntry((LanguageTable + language)->lregexControlBlock, corkIndex);
+}
+
 static unsigned int parserCorkFlags (parserDefinition *parser)
 {
 	subparser *tmp;
@@ -5418,6 +5423,11 @@ extern bool processSequelOption (const char *const option, const char *const par
 	return processHookOption (option, parameter, "_sequel-", SCRIPT_HOOK_SEQUEL);
 }
 
+extern bool processMakeTagEntryReflectionOption (const char *const option, const char *const parameter)
+{
+	return processHookOption (option, parameter, "_makeTagEntryReflection-", SCRIPT_HOOK_MAKE_TAG_ENTRY_REFLECTION);
+}
+
 extern bool processPretendOption (const char *const option, const char *const parameter)
 {
 	langType new_language, old_language;

main/parse.h

@@ -74,6 +74,7 @@ typedef enum {
 enum scriptHook {
 	SCRIPT_HOOK_PRELUDE,
 	SCRIPT_HOOK_SEQUEL,
+	SCRIPT_HOOK_MAKE_TAG_ENTRY_REFLECTION,
 	SCRIPT_HOOK_MAX,
 };