TclOO: introduce "forceUse" parameter

The original code expects the pattern `namespace import oo' in input.
The pattern is used for detecting whether TclOO is used in the input file.
However, there can be a case that the pattern is not appeared though
the input file uses TclOO:

   namespace import oo::*
   source input.tcl

To allow users to handle the none-self-contained case manually, this
change introduces the parameter `--param-TclOO.forceUse=1`.  If the
parameter is set, the parser runs as if 'namespace import oo::*' is
specified at the head of input files.

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

Author: masatake

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

@@ -1,10 +1,11 @@
 # ALL
-#LANGUAGE      NAME    DESCRIPTION
-CPreProcessor  _expand expand macros if their definitions are in the current C/C++/CUDA input file (true or [false])
-CPreProcessor  define  define replacement for an identifier (name(params,...)=definition)
-CPreProcessor  if0     examine code within "#if 0" branch (true or [false])
-CPreProcessor  ignore  a token to be specially handled
-Fypp           guest   parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
+#LANGUAGE      NAME     DESCRIPTION
+CPreProcessor  _expand  expand macros if their definitions are in the current C/C++/CUDA input file (true or [false])
+CPreProcessor  define   define replacement for an identifier (name(params,...)=definition)
+CPreProcessor  if0      examine code within "#if 0" branch (true or [false])
+CPreProcessor  ignore   a token to be specially handled
+Fypp           guest    parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
+TclOO          forceUse enable the parser even when `oo' namespace is not specified in the input (true or [false])
 
 # ALL MACHINABLE
 #LANGUAGE	NAME	DESCRIPTION
@@ -13,13 +14,15 @@ CPreProcessor	define	define replacement for an identifier (name(params,...)=defi
 CPreProcessor	if0	examine code within "#if 0" branch (true or [false])
 CPreProcessor	ignore	a token to be specially handled
 Fypp	guest	parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
+TclOO	forceUse	enable the parser even when `oo' namespace is not specified in the input (true or [false])
 
 # ALL MACHINABLE NOHEADER
 CPreProcessor	_expand	expand macros if their definitions are in the current C/C++/CUDA input file (true or [false])
 CPreProcessor	define	define replacement for an identifier (name(params,...)=definition)
 CPreProcessor	if0	examine code within "#if 0" branch (true or [false])
 CPreProcessor	ignore	a token to be specially handled
 Fypp	guest	parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
+TclOO	forceUse	enable the parser even when `oo' namespace is not specified in the input (true or [false])
 
 # CPP
 #NAME    DESCRIPTION

Units/parser-tcloo.r/force-use.d/args.ctags

@@ -0,0 +1,3 @@
+--sort=no
+--param-TclOO.forceUse=1
+--fields=+{language}

Units/parser-tcloo.r/force-use.d/expected.tags

@@ -0,0 +1,3 @@
+X	input.tcl	/^class create X {$/;"	c	language:TclOO
+add	input.tcl	/^    method add v {$/;"	m	language:TclOO	class:X
+doSomething	input.tcl	/^    }; method doSomething {v} {$/;"	m	language:TclOO	class:X

Units/parser-tcloo.r/force-use.d/input.tcl

@@ -0,0 +1,11 @@
+# Assume this source file is loaded from
+# another source file:
+# 
+#   namespace import oo::*
+#   source input.tcl
+#
+class create X {
+    method add v {
+    }; method doSomething {v} {
+    }
+}

parsers/tcloo.c

@@ -8,6 +8,7 @@
 
 #include "general.h"  /* must always come first */
 #include "tcl.h"
+#include "param.h"
 #include "parse.h"
 #include "entry.h"
 #include "tokeninfo.h"
@@ -35,6 +36,8 @@ static kindDefinition TclOOKinds[] = {
 	  ATTACH_SEPARATORS(TclOOGenericSeparators) },
 };
 
+static bool tclooForceUse;
+
 static void parseMethod (tokenInfo *token, int owner)
 {
 	tokenRead (token);
@@ -141,7 +144,7 @@ static void inputStart (subparser *s)
 {
 	struct tclooSubparser *tcloo = (struct tclooSubparser *)s;
 
-	tcloo->foundTclOONamespaceImported = false;
+	tcloo->foundTclOONamespaceImported = tclooForceUse;
 }
 
 static struct tclooSubparser tclooSubparser = {
@@ -160,6 +163,19 @@ static void findTclOOTags(void)
 	scheduleRunningBaseparser (RUN_DEFAULT_SUBPARSERS);
 }
 
+static void tclooForceUseParamHandler (const langType language CTAGS_ATTR_UNUSED,
+									  const char *name, const char *arg)
+{
+	tclooForceUse = paramParserBool (arg, tclooForceUse, name, "parameter");
+}
+
+static parameterHandlerTable TclOOParameterHandlerTable [] = {
+	{ .name = "forceUse",
+	  .desc = "enable the parser even when `oo' namespace is not specified in the input (true or [false])" ,
+	  .handleParameter = tclooForceUseParamHandler,
+	},
+};
+
 extern parserDefinition* TclOOParser (void)
 {
 	parserDefinition* const def = parserNew("TclOO");
@@ -178,5 +194,8 @@ extern parserDefinition* TclOOParser (void)
 	def->useCork = CORK_QUEUE;
 	def->requestAutomaticFQTag = true;
 
+	def->parameterHandlerTable = TclOOParameterHandlerTable;
+	def->parameterHandlerCount = ARRAY_SIZE(TclOOParameterHandlerTable);
+
 	return def;
 }