TerraformVariables: new parser

This parser doesn't have its own kinds.
Instead, this parser emits Terraform parser's "variable"
kind tags with "assigned" role.

ref. https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files

Signed-off-by: Masatake YAMATO <yamato@redhat.com>

Tmain/list-map-extensions.d/stdout-expected.txt

@@ -1,9 +1,9 @@
 ## all|grep LdScript
-#LANGUAGE         EXTENSION
-LdScript          lds
-LdScript          scr
-LdScript          ld
-LdScript          ldi
+#LANGUAGE           EXTENSION
+LdScript            lds
+LdScript            scr
+LdScript            ld
+LdScript            ldi
 ## LdScript
 #EXTENSION
 lds

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

@@ -102,6 +102,7 @@ SystemdUnit    u/unit            RequiredBy         on      referred in Required
 SystemdUnit    u/unit            Requires           on      referred in Requires key
 SystemdUnit    u/unit            WantedBy           on      referred in WantedBy key
 SystemdUnit    u/unit            Wants              on      referred in Wants key
+Terraform      v/variable        assigned           on      assigned in Variable Definitions (.tfvars) files
 Tex            e/environment     used               off     environment usage introduced by \begin{MyEnv}
 Tex            i/xinput          bibliography       on      bibliography (.bib) file
 Tex            i/xinput          included           on      external input file specified with \include
@@ -221,6 +222,7 @@ SystemdUnit    u/unit            RequiredBy         on      referred in Required
 SystemdUnit    u/unit            Requires           on      referred in Requires key
 SystemdUnit    u/unit            WantedBy           on      referred in WantedBy key
 SystemdUnit    u/unit            Wants              on      referred in Wants key
+Terraform      v/variable        assigned           on      assigned in Variable Definitions (.tfvars) files
 Tex            e/environment     used               off     environment usage introduced by \begin{MyEnv}
 Tex            i/xinput          bibliography       on      bibliography (.bib) file
 Tex            i/xinput          included           on      external input file specified with \include

Units/parser-terraform.r/simple-terraform.d/args.ctags

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

Units/parser-terraform.r/simple-terraform.d/expected.tags

@@ -1,6 +1,7 @@
-aws	input.tf	/^provider "aws" {$/;"	p
-events_bus_name	input.tf	/^variable "events_bus_name" {$/;"	v
-example_events_bus	input.tf	/^resource "aws_cloudwatch_event_bus" "example_events_bus" {$/;"	r
-database	input.tf	/^module "database" {$/;"	m
-example_database_password	input.tf	/^data "aws_ssm_parameter" "example_database_password" {$/;"	d
-password	input.tf	/^output "password" {$/;"	o
+aws	input.tf	/^provider "aws" {$/;"	p	language:Terraform	roles:def
+events_bus_name	input.tf	/^variable "events_bus_name" {$/;"	v	language:Terraform	roles:def
+example_events_bus	input.tf	/^resource "aws_cloudwatch_event_bus" "example_events_bus" {$/;"	r	language:Terraform	roles:def
+database	input.tf	/^module "database" {$/;"	m	language:Terraform	roles:def
+example_database_password	input.tf	/^data "aws_ssm_parameter" "example_database_password" {$/;"	d	language:Terraform	roles:def
+password	input.tf	/^output "password" {$/;"	o	language:Terraform	roles:def
+events_bus_name	input-0.tfvars	/^events_bus_name = "hyper-connector"$/;"	v	language:Terraform	roles:assigned

Units/parser-terraform.r/simple-terraform.d/input-0.tfvars

@@ -0,0 +1 @@
+events_bus_name = "hyper-connector"

docs/news.rst

@@ -475,6 +475,7 @@ The following parsers have been added:
 * SVG *libxml*
 * TclOO (see :ref:`The new Tcl parser <tcl>`)
 * Terraform (HCL) *optlib*
+* TerraformVariables *optlib*
 * Thrift *peg/packcc*
 * TTCN
 * Txt2tags

main/parsers_p.h

@@ -173,6 +173,7 @@
 	TclParser, \
 	TclOOParser, \
 	TerraformParser, \
+	TerraformVariablesParser, \
 	TexParser, \
 	TexBeamerParser, \
 	TTCNParser, \

optlib/terraform.c

@@ -27,6 +27,9 @@ extern parserDefinition* TerraformParser (void)
 		NULL
 	};
 
+	static roleDefinition TerraformVariableRoleTable [] = {
+		{ true, "assigned", "assigned in Variable Definitions (.tfvars) files" },
+	};
 	static kindDefinition TerraformKindTable [] = {
 		{
 		  true, 'r', "resource", "resources",
@@ -36,6 +39,7 @@ extern parserDefinition* TerraformParser (void)
 		},
 		{
 		  true, 'v', "variable", "variables",
+		  ATTACH_ROLES(TerraformVariableRoleTable),
 		},
 		{
 		  true, 'p', "provider", "providers",

optlib/terraform.ctags

@@ -24,13 +24,19 @@
 #
 # Another notable thing is that this parser doesn't skip /* block comments */.
 #
+# .tfvars files relates code are moved to TerraformVariables parser.
+#
 --langdef=Terraform
 
 --map-Terraform=+.tf
 
 --kinddef-Terraform=r,resource,resources
 --kinddef-Terraform=d,data,data
+
 --kinddef-Terraform=v,variable,variables
+# See https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files
+--_roledef-Terraform.v=assigned,assigned in Variable Definitions (.tfvars) files
+
 --kinddef-Terraform=p,provider,providers
 --kinddef-Terraform=m,module,modules
 --kinddef-Terraform=o,output,output

optlib/terraformvariables.c

@@ -0,0 +1,56 @@
+/*
+ * Generated by ./misc/optlib2c from optlib/terraformvariables.ctags, Don't edit this manually.
+ */
+#include "general.h"
+#include "parse.h"
+#include "routines.h"
+#include "field.h"
+#include "xtag.h"
+#include "dependency.h"
+
+
+static void initializeTerraformVariablesParser (const langType language CTAGS_ATTR_UNUSED)
+{
+}
+
+extern parserDefinition* TerraformVariablesParser (void)
+{
+	static const char *const extensions [] = {
+		"tfvars",
+		NULL
+	};
+
+	static const char *const aliases [] = {
+		NULL
+	};
+
+	static const char *const patterns [] = {
+		NULL
+	};
+
+	static tagRegexTable TerraformVariablesTagRegexTable [] = {
+		{"^([a-z0-9_]+)[[:space:]]*=", "\\1",
+		"v", "{_role=assigned}{_language=Terraform}", NULL, false},
+	};
+
+	static parserDependency TerraformVariablesDependencies [] = {
+		[0] = { DEPTYPE_FOREIGNER, "Terraform", NULL },
+	};
+
+	parserDefinition* const def = parserNew ("TerraformVariables");
+
+	def->versionCurrent= 0;
+	def->versionAge    = 0;
+	def->enabled       = true;
+	def->extensions    = extensions;
+	def->patterns      = patterns;
+	def->aliases       = aliases;
+	def->method        = METHOD_NOT_CRAFTED|METHOD_REGEX;
+	def->tagRegexTable = TerraformVariablesTagRegexTable;
+	def->tagRegexCount = ARRAY_SIZE(TerraformVariablesTagRegexTable);
+	def->dependencies    = TerraformVariablesDependencies;
+	def->dependencyCount = ARRAY_SIZE(TerraformVariablesDependencies);
+	def->initialize    = initializeTerraformVariablesParser;
+
+	return def;
+}

optlib/terraformvariables.ctags

@@ -0,0 +1,20 @@
+#
+#  Copyright (c) 2021, Julio Tain Sueiras
+#  Copyright (c) 2023 Masatake YAMATO
+#  Copyright (c) 2023 Red Hat, Inc.
+#
+#  This source code is released for free distribution under the terms of the
+#  GNU General Public License version 2 or (at your option) any later version.
+#
+#  The regex pattern is derrived from
+#  - https://github.com/juliosueiras/vim-terraform-completion/blob/master/ctags/terraform.ctags
+#
+#  This module contains functions to extract language objects for Terraform from
+#  Terraform Variable Definitions (.tfvars) files.
+#  See: https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files
+#
+--langdef=TerraformVariables{_foreignLanguage=Terraform}
+
+--map-TerraformVariables=+.tfvars
+
+--regex-TerraformVariables=/^([a-z0-9_]+)[[:space:]]*=/\1/v/{_role=assigned}{_language=Terraform}

source.mak

@@ -245,6 +245,7 @@ OPTLIB2C_INPUT = \
 	optlib/scss.ctags			\
 	optlib/systemtap.ctags			\
 	optlib/terraform.ctags			\
+	optlib/terraformvariables.ctags		\
 	optlib/yacc.ctags			\
 	\
 	$(NULL)

win32/ctags_vs2013.vcxproj

@@ -252,6 +252,7 @@
     <ClCompile Include="..\optlib\scss.c" />
     <ClCompile Include="..\optlib\systemtap.c" />
     <ClCompile Include="..\optlib\terraform.c" />
+    <ClCompile Include="..\optlib\terraformvariables.c" />
     <ClCompile Include="..\optlib\yacc.c" />
     <ClCompile Include="..\parsers\abaqus.c" />
     <ClCompile Include="..\parsers\abc.c" />

win32/ctags_vs2013.vcxproj.filters

@@ -279,6 +279,9 @@
     <ClCompile Include="..\optlib\terraform.c">
       <Filter>Source Files\optlib</Filter>
     </ClCompile>
+    <ClCompile Include="..\optlib\terraformvariables.c">
+      <Filter>Source Files\optlib</Filter>
+    </ClCompile>
     <ClCompile Include="..\optlib\yacc.c">
       <Filter>Source Files\optlib</Filter>
     </ClCompile>