Merge pull request #3499 from masatake/zsh

masatake · web-flow · commit a29958331756 · 2022-10-16T04:47:59.000+09:00
Zsh: new standalone parser understanding autoload built-in
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-firstline0.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-firstline0.unknown
@@ -0,0 +1 @@
+# -*- mode: sh; eval: (sh-set-shell "zsh") -*-
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-firstline1.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-firstline1.unknown
@@ -0,0 +1,3 @@
+# -*- mode: shell-script; sh-set-shell: zsh -*-
+# Emacs doesn't understand this notation but I found one in
+# https://github.com/neumachen/dotfiles/blob/3e2b04249f852dbdf7dee1e33e518de61031eb04/private_dot_config/exact_zsh/dot_zprofile
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-firstline2.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-firstline2.unknown
@@ -0,0 +1 @@
+# -*- mode: sh; eval: (sh-set-shell "bash") -*-
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-firstline3.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-firstline3.unknown
@@ -0,0 +1,3 @@
+# -*- mode: shell-script; sh-set-shell: bash -*-
+# Emacs doesn't understand this notation but I found one in
+# https://github.com/neumachen/dotfiles/blob/3e2b04249f852dbdf7dee1e33e518de61031eb04/private_dot_config/exact_zsh/dot_zprofile
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-firstline4.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-firstline4.unknown
@@ -0,0 +1 @@
+# -*- mode: sh -*-
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-firstline5.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-firstline5.unknown
@@ -0,0 +1,3 @@
+# -*- mode: shell-script -*-
+# Emacs doesn't understand this notation but I found one in
+# https://github.com/neumachen/dotfiles/blob/3e2b04249f852dbdf7dee1e33e518de61031eb04/private_dot_config/exact_zsh/dot_zprofile
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-lastlist0.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-lastlist0.unknown
@@ -0,0 +1,4 @@
+# Local Variables:
+# mode: sh
+# eval: (sh-set-shell "zsh")
+# End:
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-lastlist1.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-lastlist1.unknown
@@ -0,0 +1,4 @@
+# Local Variables:
+# mode: sh
+# eval: (sh-set-shell "bash")
+# End:
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/input-lastlist2.unknown b/Tmain/emacs-modline-shell-script-zsh.d/input-lastlist2.unknown
@@ -0,0 +1,3 @@
+# Local Variables:
+# mode: sh
+# End:
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/run.sh b/Tmain/emacs-modline-shell-script-zsh.d/run.sh
@@ -0,0 +1,17 @@
+# Copyright: 2022 Masatake YAMATO
+# License: GPL-2
+
+CTAGS=$1
+
+for f in input-firstline0.unknown \
+			 input-firstline1.unknown \
+			 input-firstline2.unknown \
+			 input-firstline3.unknown \
+			 input-firstline4.unknown \
+			 input-firstline5.unknown \
+			 input-lastlist0.unknown  \
+			 input-lastlist1.unknown  \
+			 input-lastlist2.unknown  \
+		 ; do
+	$CTAGS --quiet --options=NONE -G --print-language $f
+done
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/stderr-expected.txt b/Tmain/emacs-modline-shell-script-zsh.d/stderr-expected.txt
diff --git a/Tmain/emacs-modline-shell-script-zsh.d/stdout-expected.txt b/Tmain/emacs-modline-shell-script-zsh.d/stdout-expected.txt
@@ -0,0 +1,9 @@
+input-firstline0.unknown: Zsh
+input-firstline1.unknown: Zsh
+input-firstline2.unknown: Sh
+input-firstline3.unknown: Sh
+input-firstline4.unknown: Sh
+input-firstline5.unknown: Sh
+input-lastlist0.unknown: Zsh
+input-lastlist1.unknown: Sh
+input-lastlist2.unknown: Sh
diff --git a/Tmain/list-aliases.d/stdout-expected.txt b/Tmain/list-aliases.d/stdout-expected.txt
@@ -2,7 +2,6 @@
 sh
 bash
 ksh
-zsh
 ash
 dash
 shell-script
diff --git a/Tmain/list-roles.d/stdout-expected.txt b/Tmain/list-roles.d/stdout-expected.txt
@@ -111,6 +111,10 @@ Vera           d/macro           undef              on      undefined
 Vera           h/header          local              on      local header
 Vera           h/header          system             on      system header
 Verilog        m/module          decl               on      declaring instances
+Zsh            f/function        autoloaded         on      function name passed to autoload built-in command
+Zsh            h/heredoc         endmarker          on      end marker
+Zsh            s/script          autoloaded         on      autoloaded
+Zsh            s/script          loaded             on      loaded
 
 #
 # all.*
@@ -224,6 +228,10 @@ Vera           d/macro           undef              on      undefined
 Vera           h/header          local              on      local header
 Vera           h/header          system             on      system header
 Verilog        m/module          decl               on      declaring instances
+Zsh            f/function        autoloaded         on      function name passed to autoload built-in command
+Zsh            h/heredoc         endmarker          on      end marker
+Zsh            s/script          autoloaded         on      autoloaded
+Zsh            s/script          loaded             on      loaded
 
 #
 # C.*
diff --git a/Units/main-guessing.r/nolang-modeline-zsh-autoload.d/expected.tags b/Units/main-guessing.r/nolang-modeline-zsh-autoload.d/expected.tags
@@ -1 +1 @@
-_ctags	input.nolang	/^_ctags() {$/;"	f	language:Sh
+_ctags	input.nolang	/^_ctags() {$/;"	f	language:Zsh
diff --git a/Units/main-guessing.r/nolang-modeline-zsh-compdef.d/expected.tags b/Units/main-guessing.r/nolang-modeline-zsh-compdef.d/expected.tags
@@ -1 +1 @@
-_ctags	input.nolang	/^_ctags() {$/;"	f	language:Sh
+_ctags	input.nolang	/^_ctags() {$/;"	f	language:Zsh
diff --git a/Units/parser-zsh.r/autoload.d/args.ctags b/Units/parser-zsh.r/autoload.d/args.ctags
@@ -0,0 +1,3 @@
+--sort=no
+--fields=+rK
+--extras=+r
diff --git a/Units/parser-zsh.r/autoload.d/expected.tags b/Units/parser-zsh.r/autoload.d/expected.tags
@@ -0,0 +1,25 @@
+func	input.zsh	/^autoload func$/;"	script	roles:autoloaded
+func	input.zsh	/^autoload func$/;"	function	roles:autoloaded
+kfun	input.zsh	/^autoload -z kfun$/;"	script	roles:autoloaded
+kfun	input.zsh	/^autoload -z kfun$/;"	function	roles:autoloaded
+zfun	input.zsh	/^autoload -k zfun$/;"	script	roles:autoloaded
+zfun	input.zsh	/^autoload -k zfun$/;"	function	roles:autoloaded
+f0	input.zsh	/^autoload f0 f1 f2$/;"	script	roles:autoloaded
+f0	input.zsh	/^autoload f0 f1 f2$/;"	function	roles:autoloaded
+f1	input.zsh	/^autoload f0 f1 f2$/;"	script	roles:autoloaded
+f1	input.zsh	/^autoload f0 f1 f2$/;"	function	roles:autoloaded
+f2	input.zsh	/^autoload f0 f1 f2$/;"	script	roles:autoloaded
+f2	input.zsh	/^autoload f0 f1 f2$/;"	function	roles:autoloaded
+/path0/A/pf0	input.zsh	/^autoload \/path0\/A\/pf0 \/path1\/B\/pf1$/;"	script	roles:autoloaded
+pf0	input.zsh	/^autoload \/path0\/A\/pf0 \/path1\/B\/pf1$/;"	function	roles:autoloaded
+/path1/B/pf1	input.zsh	/^autoload \/path0\/A\/pf0 \/path1\/B\/pf1$/;"	script	roles:autoloaded
+pf1	input.zsh	/^autoload \/path0\/A\/pf0 \/path1\/B\/pf1$/;"	function	roles:autoloaded
+/path3/pf3	input.zsh	/^autoload \/path3\/pf3 f3$/;"	script	roles:autoloaded
+pf3	input.zsh	/^autoload \/path3\/pf3 f3$/;"	function	roles:autoloaded
+f3	input.zsh	/^autoload \/path3\/pf3 f3$/;"	script	roles:autoloaded
+f3	input.zsh	/^autoload \/path3\/pf3 f3$/;"	function	roles:autoloaded
+foo	input.zsh	/^foo()$/;"	function	roles:def
+g0	input.zsh	/^autoload +x g0 g1$/;"	script	roles:autoloaded
+g0	input.zsh	/^autoload +x g0 g1$/;"	function	roles:autoloaded
+g1	input.zsh	/^autoload +x g0 g1$/;"	script	roles:autoloaded
+g1	input.zsh	/^autoload +x g0 g1$/;"	function	roles:autoloaded
diff --git a/Units/parser-zsh.r/autoload.d/input.zsh b/Units/parser-zsh.r/autoload.d/input.zsh
@@ -0,0 +1,13 @@
+autoload func
+autoload -z kfun
+autoload -k zfun
+autoload f0 f1 f2
+autoload /path0/A/pf0 /path1/B/pf1
+autoload /path3/pf3 f3
+
+foo()
+{
+    autoload -X
+}
+
+autoload +x g0 g1
diff --git a/docs/news.rst b/docs/news.rst
@@ -484,6 +484,7 @@ The following parsers have been added:
 * Yaml *libyaml*
 * YumRepo
 * Zephir
+* Zsh
 
 See :ref:`optlib` for details on *optlib*.
 Libxml2 is required to use the parser(s) marked with *libxml*.
diff --git a/main/keyword.c b/main/keyword.c
@@ -274,3 +274,32 @@ extern void addKeywordGroup (const struct keywordGroup *const groupdef,
 		addKeyword (groupdef->keywords[i], language, groupdef->value);
 	}
 }
+
+extern void addDialectalKeywords (const struct dialectalKeyword *const dkeywords,
+								  size_t nDkeyword,
+								  langType language,
+								  const char **dialectMap,
+								  size_t nMap)
+{
+	int dialect = -1;
+	const char *name = getLanguageName (language);
+
+	Assert(name);
+
+	for (size_t i = 0; i < nMap; i++)
+	{
+		if (strcmp(dialectMap[i], name) == 0)
+		{
+			dialect = i;
+			break;
+		}
+	}
+	Assert (dialect != -1);
+
+	for (size_t i = 0; i < nDkeyword; i++)
+	{
+		const struct dialectalKeyword *p = dkeywords + i;
+		if (p->isValid[dialect])
+			addKeyword (p->keyword, language, p->value);
+	}
+}
diff --git a/main/keyword.h b/main/keyword.h
@@ -38,4 +38,24 @@ struct keywordGroup {
 
 extern void addKeywordGroup (const struct keywordGroup *const groupdef,
 							 langType language);
+
+/*
+* DIALECTAL KEYWROD API
+*/
+#define MAX_DIALECTS 10
+struct dialectalKeyword {
+	const char *keyword;
+	int value;
+
+	/* If this keyword is valid for Nth dialect,
+	   isValid[N] should be 1; else 0. */
+	bool isValid [MAX_DIALECTS];
+};
+
+extern void addDialectalKeywords (const struct dialectalKeyword *const dkeywords,
+								  size_t nDkeyword,
+								  langType language,
+								  const char **dialectMap,
+								  size_t nMap);
+
 #endif  /* CTAGS_MAIN_KEYWORD_H */
diff --git a/main/parse.c b/main/parse.c
@@ -783,6 +783,24 @@ static vString* extractInterpreter (MIO* input)
 	return interpreter;
 }
 
+static bool isShellZsh (const char *p)
+{
+	p = strstr (p, "sh-set-shell");
+	if (!p)
+		return false;
+	p += strlen("sh-set-shell");
+
+	if (*p == ':')
+		p++;
+	while (isspace ((int) *p))
+		p++;
+
+	if (strncmp (p, "\"zsh\"", 5) == 0
+		|| strncmp (p, "zsh", 3) == 0)
+		return true;
+	return false;
+}
+
 static vString* determineEmacsModeAtFirstLine (const char* const line)
 {
 	vString* mode = vStringNew ();
@@ -803,6 +821,11 @@ static vString* determineEmacsModeAtFirstLine (const char* const line)
 			;  /* no-op */
 		for ( ;  *p != '\0'  &&  isLanguageNameChar ((int) *p)  ;  ++p)
 			vStringPut (mode, (int) *p);
+
+		if ((strcmp(vStringValue (mode), "sh") == 0
+			 || strcmp(vStringValue (mode), "shell-script") == 0)
+			&& isShellZsh (p))
+			vStringCopyS (mode, "Zsh");
 	}
 	else
 	{
@@ -852,6 +875,7 @@ static vString* determineEmacsModeAtEOF (MIO* const fp)
 	bool headerFound = false;
 	const char* p;
 	vString* mode = vStringNew ();
+	bool is_shell_mode = false;
 
 	while ((line = readLineRaw (vLine, fp)) != NULL)
 	{
@@ -865,11 +889,22 @@ static vString* determineEmacsModeAtEOF (MIO* const fp)
 				;  /* no-op */
 			for ( ;  *p != '\0'  &&  isLanguageNameChar ((int) *p)  ;  ++p)
 				vStringPut (mode, (int) *p);
+
+			is_shell_mode = ((strcasecmp (vStringValue (mode), "sh") == 0
+								 || strcasecmp (vStringValue (mode), "shell-script") == 0));
 		}
 		else if (headerFound && (p = strstr(line, "End:")))
 			headerFound = false;
 		else if (strstr (line, "Local Variables:"))
 			headerFound = true;
+		else if (is_shell_mode && (p = strstr (line, "sh-set-shell")))
+		{
+			p += strlen("sh-set-shell");
+			while (isspace ((int) *p))
+				p++;
+			if (strncmp (p, "\"zsh\"", 5) == 0)
+				vStringCopyS (mode, "Zsh");
+		}
 	}
 	vStringDelete (vLine);
 	return mode;
diff --git a/main/parsers_p.h b/main/parsers_p.h
@@ -184,6 +184,7 @@
 	WindResParser, \
 	YACCParser, \
 	YumRepoParser, \
-	ZephirParser
+	ZephirParser, \
+	ZshParser
 
 #endif  /* CTAGS_MAIN_PARSERS_H */
diff --git a/parsers/sh.c b/parsers/sh.c

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# -- mode: sh; eval: (sh-set-shell "zsh") --`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# -- mode: shell-script; sh-set-shell: zsh --`
	`2`	`+# Emacs doesn't understand this notation but I found one in`
	`3`	`+# https://github.com/neumachen/dotfiles/blob/3e2b04249f852dbdf7dee1e33e518de61031eb04/private_dot_config/exact_zsh/dot_zprofile`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# -- mode: sh; eval: (sh-set-shell "bash") --`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# -- mode: shell-script --`
	`2`	`+# Emacs doesn't understand this notation but I found one in`
	`3`	`+# https://github.com/neumachen/dotfiles/blob/3e2b04249f852dbdf7dee1e33e518de61031eb04/private_dot_config/exact_zsh/dot_zprofile`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Local Variables:`
	`2`	`+# mode: sh`
	`3`	`+# End:`