Merge pull request #3560 from masatake/ptags-escseq-in-name-field

masatake · web-flow · commit 80de44f6dd2a · 2022-12-03T11:43:54.000+09:00
readtags: print name fields with escaping as explained in tags(5)
diff --git a/Tmain/readtags-ptags-escaping.d/exit-expected.txt b/Tmain/readtags-ptags-escaping.d/exit-expected.txt
@@ -0,0 +1 @@
+0
diff --git a/Tmain/readtags-ptags-escaping.d/pseudo-input-b_.tags b/Tmain/readtags-ptags-escaping.d/pseudo-input-b_.tags
@@ -0,0 +1,2 @@
+!_PTAG	value\	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/pseudo-input-bb.tags b/Tmain/readtags-ptags-escaping.d/pseudo-input-bb.tags
@@ -0,0 +1,2 @@
+!_PTAG	value\\	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/pseudo-input-bt.tags b/Tmain/readtags-ptags-escaping.d/pseudo-input-bt.tags
@@ -0,0 +1,2 @@
+!_PTAG	value\t	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/pseudo-name-b_.tags b/Tmain/readtags-ptags-escaping.d/pseudo-name-b_.tags
@@ -0,0 +1,2 @@
+!_PTAG\	value	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/pseudo-name-bb.tags b/Tmain/readtags-ptags-escaping.d/pseudo-name-bb.tags
@@ -0,0 +1,2 @@
+!_PTAG\\	value	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/pseudo-name-bt.tags b/Tmain/readtags-ptags-escaping.d/pseudo-name-bt.tags
@@ -0,0 +1,2 @@
+!_PTAG\t	value	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/regular-input-b_.tags b/Tmain/readtags-ptags-escaping.d/regular-input-b_.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag	/path/to/file\	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/regular-input-bb.tags b/Tmain/readtags-ptags-escaping.d/regular-input-bb.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag	/path/to/file\\	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/regular-input-bt.tags b/Tmain/readtags-ptags-escaping.d/regular-input-bt.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag	/path/to/file\t	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/regular-kind-b_.tags b/Tmain/readtags-ptags-escaping.d/regular-kind-b_.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:\
diff --git a/Tmain/readtags-ptags-escaping.d/regular-kind-bb.tags b/Tmain/readtags-ptags-escaping.d/regular-kind-bb.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag	/path/to/file	/^pattern$/;"	kind:\\
diff --git a/Tmain/readtags-ptags-escaping.d/regular-name-b_.tags b/Tmain/readtags-ptags-escaping.d/regular-name-b_.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag\	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/regular-name-bb.tags b/Tmain/readtags-ptags-escaping.d/regular-name-bb.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag\\	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/regular-name-bt.tags b/Tmain/readtags-ptags-escaping.d/regular-name-bt.tags
@@ -0,0 +1,2 @@
+!_PTAG	value	/comment/;"
+regular_tag\t	/path/to/file	/^pattern$/;"	kind:
diff --git a/Tmain/readtags-ptags-escaping.d/run.sh b/Tmain/readtags-ptags-escaping.d/run.sh
@@ -0,0 +1,51 @@
+#!/bin/sh
+
+# Copyright: 2022 Masatake YAMATO
+# License: GPL-2
+
+READTAGS=$3
+#V="valgrind --leak-check=full --track-origins=yes -v"
+V=
+
+. ../utils.sh
+
+if ! [ -x "${READTAGS}" ]; then
+	skip "no readtags"
+fi
+
+# {regular|pseudo}-{field}-{char0{char1}*}.tags
+for t in INIT									\
+			 regular-name-b_.tags				\
+			 regular-name-bb.tags				\
+			 regular-name-bt.tags				\
+			 regular-input-b_.tags				\
+			 regular-input-bb.tags				\
+			 regular-input-bt.tags				\
+			 regular-kind-b_.tags				\
+			 regular-kind-bb.tags				\
+			 pseudo-name-b_.tags				\
+			 pseudo-name-bb.tags				\
+			 pseudo-name-bt.tags				\
+			 pseudo-input-b_.tags				\
+			 pseudo-input-bb.tags				\
+			 pseudo-input-bt.tags				\
+		 ; do
+	case $t in
+		INIT)
+			;;
+		regular-*)
+			echo "# $t"
+			${V} ${READTAGS} -Ee -t $t -l || exit 1
+			echo
+			;;
+		pseudo-*)
+			echo "# $t"
+			${V} ${READTAGS} -Ee -t $t -D || exit 1
+			echo
+			;;
+		*)
+			echo "INTERNAL BUG"
+			exit 1
+			;;
+	esac
+done
diff --git a/Tmain/readtags-ptags-escaping.d/stderr-expected.txt b/Tmain/readtags-ptags-escaping.d/stderr-expected.txt
diff --git a/Tmain/readtags-ptags-escaping.d/stdout-expected.txt b/Tmain/readtags-ptags-escaping.d/stdout-expected.txt
@@ -0,0 +1,42 @@
+# regular-name-b_.tags
+regular_tag\\	/path/to/file	/^pattern$/
+
+# regular-name-bb.tags
+regular_tag\\	/path/to/file	/^pattern$/
+
+# regular-name-bt.tags
+regular_tag\t	/path/to/file	/^pattern$/
+
+# regular-input-b_.tags
+regular_tag	/path/to/file\\	/^pattern$/
+
+# regular-input-bb.tags
+regular_tag	/path/to/file\\\\	/^pattern$/
+
+# regular-input-bt.tags
+regular_tag	/path/to/file\\t	/^pattern$/
+
+# regular-kind-b_.tags
+regular_tag	/path/to/file	/^pattern$/;"	kind:\\
+
+# regular-kind-bb.tags
+regular_tag	/path/to/file	/^pattern$/;"	kind:\\
+
+# pseudo-name-b_.tags
+!_PTAG\\	value	/comment/
+
+# pseudo-name-bb.tags
+!_PTAG\\	value	/comment/
+
+# pseudo-name-bt.tags
+!_PTAG\t	value	/comment/
+
+# pseudo-input-b_.tags
+!_PTAG	value\\	/comment/
+
+# pseudo-input-bb.tags
+!_PTAG	value\\\\	/comment/
+
+# pseudo-input-bt.tags
+!_PTAG	value\\t	/comment/
+
diff --git a/docs/man/ctags-client-tools.7.rst b/docs/man/ctags-client-tools.7.rst
@@ -107,7 +107,7 @@ Options for Pseudo-tags
 
 		!_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/	extras:pseudo
 
-	If the name of a normal tag in a tag file starts with "!_", a
+	If the name of a regular tag in a tag file starts with "!_", a
 	client tool cannot distinguish whether the tag is a regular-tag or
 	pseudo-tag.  The fields attached with this option help the tool
 	distinguish them.
@@ -494,7 +494,7 @@ A key not starting with ``_`` is mapped to a field of ctags.
 
 A key starting with ``_`` represents meta information of the JSON
 line.  Currently only ``_type`` key is used. If the value for the key
-is ``tag``, the JSON line represents a normal tag. If the value is
+is ``tag``, the JSON line represents a regular tag. If the value is
 ``ptag``, the line represents a pseudo-tag.
 
 The output format can be changed in the
diff --git a/extra-cmds/printtags.c b/extra-cmds/printtags.c
@@ -123,7 +123,8 @@ static void tagsPrintTag (const tagEntry *entry,
 		|| entry->address.pattern == NULL)
 		return;
 	if (pseudoTag)
-		print_str (entry->name, outfp);
+		printValue (entry->name, printingWithEscaping,
+					print_str, print_char, outfp);
 	else if (*entry->name == '!' && printingWithEscaping)
 	{
 		print_str ("\\x21", outfp);
diff --git a/man/ctags-client-tools.7.rst.in b/man/ctags-client-tools.7.rst.in
@@ -107,7 +107,7 @@ Options for Pseudo-tags
 
 		!_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/	extras:pseudo
 
-	If the name of a normal tag in a tag file starts with "!_", a
+	If the name of a regular tag in a tag file starts with "!_", a
 	client tool cannot distinguish whether the tag is a regular-tag or
 	pseudo-tag.  The fields attached with this option help the tool
 	distinguish them.
@@ -494,7 +494,7 @@ A key not starting with ``_`` is mapped to a field of ctags.
 
 A key starting with ``_`` represents meta information of the JSON
 line.  Currently only ``_type`` key is used. If the value for the key
-is ``tag``, the JSON line represents a normal tag. If the value is
+is ``tag``, the JSON line represents a regular tag. If the value is
 ``ptag``, the line represents a pseudo-tag.
 
 The output format can be changed in the

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG value\ /comment/;"`
	`2`	`+regular_tag /path/to/file /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG value\\ /comment/;"`
	`2`	`+regular_tag /path/to/file /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG value\t /comment/;"`
	`2`	`+regular_tag /path/to/file /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG\ value /comment/;"`
	`2`	`+regular_tag /path/to/file /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG\\ value /comment/;"`
	`2`	`+regular_tag /path/to/file /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG\t value /comment/;"`
	`2`	`+regular_tag /path/to/file /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG value /comment/;"`
	`2`	`+regular_tag /path/to/file\ /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG value /comment/;"`
	`2`	`+regular_tag /path/to/file\\ /^pattern$/;" kind:`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+!_PTAG value /comment/;"`
	`2`	`+regular_tag /path/to/file\t /^pattern$/;" kind:`