lregex: provide the way to intercept a parser making a tag

TODO:
- write about the new option in docs/optlib.rst.
- add --_makeTagEntryNotification-<LANG>={{...}}.

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

Author: masatake

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 exch . exch 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

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

@@ -2153,6 +2153,14 @@ extern void notifyRegexInputEnd (struct lregexControlBlock *lcb)
 	fillEndLineFieldOfUpperScopes (lcb, endline);
 }
 
+extern void notifyRegexMakeTagEntry (struct lregexControlBlock *lcb,
+									 int corkIndex)
+{
+	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

@@ -103,6 +103,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,"  --_makeTagEnryReflection-<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>]"},
@@ -3348,6 +3350,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

@@ -4070,6 +4070,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;
@@ -5364,6 +5369,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;