universal-ctags · masatake · Apr 24, 2018 · Apr 23, 2018
diff --git a/Tmain/input-encoding-option.d/tags-expected.txt b/Tmain/input-encoding-option.d/tags-expected.txt
@@ -1,6 +1,7 @@
 !_TAG_FILE_ENCODING	UTF-8	//
-!_TAG_FILE_FORMAT	3	/extended format with meta character escaping/
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
 !_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
 !_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
 !_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
 !_TAG_PROGRAM_URL	https://ctags.io/	/official site/

diff --git a/Tmain/list-pseudo-tags.d/stdout-expected.txt b/Tmain/list-pseudo-tags.d/stdout-expected.txt
@@ -4,6 +4,7 @@ TAG_FILE_FORMAT       on      the version of tags file format
 TAG_FILE_SORTED       on      how tags are sorted
 TAG_KIND_DESCRIPTION  off     the letters, names and descriptions of kinds in a parser
 TAG_KIND_SEPARATOR    off     the separators used in kinds
+TAG_OUTPUT_MODE       on      the output mode: u-ctags or e-ctags
 TAG_PROGRAM_AUTHOR    on      the author of this ctags implementation
 TAG_PROGRAM_NAME      on      the name of this ctags implementation
 TAG_PROGRAM_URL       on      the official site URL of this ctags implementation

diff --git a/Tmain/output-encoding-option.d/tags-expected.txt b/Tmain/output-encoding-option.d/tags-expected.txt
@@ -1,6 +1,7 @@
 !_TAG_FILE_ENCODING	cp932	//
-!_TAG_FILE_FORMAT	3	/extended format with meta character escaping/
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
 !_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
 !_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
 !_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
 !_TAG_PROGRAM_URL	https://ctags.io/	/official site/

diff --git a/Tmain/output-format-option.d/run.sh b/Tmain/output-format-option.d/run.sh
@@ -5,6 +5,6 @@ CTAGS=$1
 
 . ../utils.sh
 
-run_with_format ctags
+run_with_format u-ctags
 run_with_format etags
 run_with_format xref
diff --git a/Tmain/output-format-option.d/stdout-expected.txt b/Tmain/output-format-option.d/stdout-expected.txt
@@ -1,4 +1,4 @@
-# ctags
+# u-ctags
 main	input.c	/^main(void)$/;"	f	typeref:typename:int
 # etags
 

diff --git a/Tmain/output-input-field-with-no-escape.d/run.sh b/Tmain/output-input-field-with-no-escape.d/run.sh
@@ -12,9 +12,9 @@ if ! ( echo '#define foo' > 'a\b.c' ) 2> /dev/null; then
 fi
 
 echo '# u-ctags'
-${CTAGS} --options=NONE --pseudo-tags=TAG_FILE_FORMAT --extras=+p --format=3 -o - 'a\b.c'
+${CTAGS} --options=NONE --pseudo-tags=TAG_OUTPUT_MODE --extras=+p --output-format=u-ctags -o - 'a\b.c'
 
 echo '# e-ctags'
-${CTAGS} --options=NONE --pseudo-tags=TAG_FILE_FORMAT --extras=+p --format=2 -o - 'a\b.c'
+${CTAGS} --options=NONE --pseudo-tags=TAG_OUTPUT_MODE --extras=+p --output-format=e-ctags -o - 'a\b.c'
 
 rm 'a\b.c'
diff --git a/Tmain/output-input-field-with-no-escape.d/stdout-expected.txt b/Tmain/output-input-field-with-no-escape.d/stdout-expected.txt
@@ -1,6 +1,6 @@
 # u-ctags
-!_TAG_FILE_FORMAT	3	/extended format with meta character escaping/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
 foo	a\\b.c	/^#define foo$/;"	d	file:
 # e-ctags
-!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_OUTPUT_MODE	e-ctags	/u-ctags or e-ctags/
 foo	a\b.c	/^#define foo$/;"	d	file:
diff --git a/Tmain/ptag-kind-desc.d/stdout-expected.txt b/Tmain/ptag-kind-desc.d/stdout-expected.txt
@@ -1,17 +1,19 @@
 # BUILTIN
-!_TAG_FILE_FORMAT	3	/extended format with meta character escaping/
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
 !_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
 !_TAG_KIND_DESCRIPTION!Sh	a,alias	/aliases/
 !_TAG_KIND_DESCRIPTION!Sh	f,function	/functions/
 !_TAG_KIND_DESCRIPTION!Sh	h,heredoc	/label for here document/
 !_TAG_KIND_DESCRIPTION!Sh	s,script	/script files/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
 !_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
 !_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
 !_TAG_PROGRAM_URL	https://ctags.io/	/official site/
 # REGEX
-!_TAG_FILE_FORMAT	3	/extended format with meta character escaping/
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
 !_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
 !_TAG_KIND_DESCRIPTION!foo	k,kind	/kinds/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
 !_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
 !_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
 !_TAG_PROGRAM_URL	https://ctags.io/	/official site/
diff --git a/Tmain/tags-pseudo-tags.d/stdout-expected.txt b/Tmain/tags-pseudo-tags.d/stdout-expected.txt
@@ -1,5 +1,5 @@
 !_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
-!_TAG_FILE_FORMAT	3	/extended format with meta character escaping/
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
 !_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
 !_TAG_KIND_SEPARATOR!PHP	::	/*a/
 !_TAG_KIND_SEPARATOR!PHP	::	/*c/
@@ -19,6 +19,7 @@
 !_TAG_KIND_SEPARATOR!PHP	\\	/nn/
 !_TAG_KIND_SEPARATOR!PHP	\\	/nt/
 !_TAG_KIND_SEPARATOR!PHP	\\	/nv/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
 !_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
 !_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
 !_TAG_PROGRAM_URL	https://ctags.io/	/official site/
diff --git a/Tmain/xref-ptag-in-list-extras.d/run.sh b/Tmain/xref-ptag-in-list-extras.d/run.sh
@@ -6,13 +6,13 @@ CTAGS=$1
 O=/tmp/ctags-tmain-$$
 
 echo '#' tags regular file
-"${CTAGS}" --options=NONE --output-format=ctags -o $O --list-extras | grep pseudo
+"${CTAGS}" --options=NONE --output-format=u-ctags -o $O --list-extras | grep pseudo
 
 echo '#' tags -
-"${CTAGS}" --options=NONE --output-format=ctags -o - --list-extras | grep pseudo
+"${CTAGS}" --options=NONE --output-format=u-ctags -o - --list-extras | grep pseudo
 
 echo '#' tags NOTHING
-"${CTAGS}" --options=NONE --output-format=ctags --list-extras | grep pseudo
+"${CTAGS}" --options=NONE --output-format=u-ctags --list-extras | grep pseudo
 
 echo '#' xref regular file
 "${CTAGS}" --options=NONE --output-format=xref -o $O --list-extras | grep pseudo

diff --git a/Units/parser-php.r/php-full-qualified-tags-no-esc.d/args.ctags b/Units/parser-php.r/php-full-qualified-tags-no-esc.d/args.ctags
@@ -1,2 +1,4 @@
---extras=+q
---format=2
+--extras=+qp
+--output-format=e-ctags
+--pseudo-tags=TAG_OUTPUT_MODE
+
diff --git a/Units/parser-php.r/php-full-qualified-tags-no-esc.d/expected.tags b/Units/parser-php.r/php-full-qualified-tags-no-esc.d/expected.tags
@@ -1,3 +1,4 @@
+!_TAG_OUTPUT_MODE	e-ctags	/u-ctags or e-ctags/
 __construct	input.php	/^    public function __construct() {$/;"	f	class:foo\bar
 bar	input.php	/^class bar {$/;"	c	namespace:foo
 foo	input.php	/^namespace foo;$/;"	n

diff --git a/configure.ac b/configure.ac
@@ -54,9 +54,8 @@ AH_VERBATIM([DEFAULT_FILE_FORMAT], [
 /* Define this as desired.
  * 1:  Original ctags format
  * 2:  Extended ctags format with extension flags in EX-style comment.
- * 3:  Use backslash for escaping meta characters like tab
  */
-#define DEFAULT_FILE_FORMAT	3
+#define DEFAULT_FILE_FORMAT	2
 ])
 AH_TEMPLATE([CASE_INSENSITIVE_FILENAMES],
 	[Define this label if your system uses case-insensitive file names])
@@ -170,7 +169,7 @@ AC_ARG_ENABLE(etags,
 AC_ARG_ENABLE(extended-format,
 	[AS_HELP_STRING([--disable-extended-format],
 		[disable extension flags; use original ctags file format only])],
-	AC_DEFINE(DEFAULT_FILE_FORMAT, 1), AC_DEFINE(DEFAULT_FILE_FORMAT, 3))
+	AC_DEFINE(DEFAULT_FILE_FORMAT, 1), AC_DEFINE(DEFAULT_FILE_FORMAT, 2))
 
 AC_ARG_ENABLE(external-sort,
 	[AS_HELP_STRING([--disable-external-sort],

diff --git a/docs/format.rst b/docs/format.rst
@@ -485,10 +485,10 @@ Compatible output and weakness
 
 .. NOT REVIEWED YET
 
-Default behavior (``--format=3`` option) has the
-exceptions.  In other hand, with ``--format=2`` option
+Default behavior (``--output-format=u-ctags`` option) has the
+exceptions.  In other hand, with ``--output-format=e-ctags`` option
 ctags has no exception; Universal-ctags command may use the same file
-format as Exuberant-ctags. However, ``--format=2`` throws
+format as Exuberant-ctags. However, ``--output-format=e-ctags`` throws
 away a tag entry which name includes a space or a tab
-character. ``TAG_FILE_FORMAT`` pseudo tag tells which format is
+character. ``TAG_OUTPUT_MODE`` pseudo tag tells which format is
 used when ctags generating tags file.
diff --git a/docs/news.rst b/docs/news.rst
@@ -921,23 +921,6 @@ Changes to the tags file format
 ---------------------------------------------------------------------
 
 
-
-version 3 format for handling meta characters in tag entry
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. REVIEWED
-
-To allow recording names including tab characters and other control
-characters in a tag file, version 3 of the file format extends version
-2 with extra escape sequences.
-
-You can use ``--format=2`` to keep compatibility with the output of
-Exuberant-ctags; however, this version of the format cannot record
-names which include tab characters.
-
-See also :ref:`Compatible output and weakness <compat-output>`.
-
-
 Truncating the pattern for long input lines
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 To prevent generating overly large tags files, a pattern field is
@@ -1227,6 +1210,15 @@ The third line means `\\` is used when for combining a namespace item
 Of course, ctags uses the more specific line when choosing a
 separator; the third line has higher priority than the first.
 
+``TAG_OUTPUT_MODE``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. NOT REVIEWED YET
+
+This pseudo tag represents output mode: u-ctags or e-ctags.
+
+See also :ref:`Compatible output and weakness <compat-output>`.
+
 .. _parser-own-fields:
 
 Parser own fields

diff --git a/main/entry.h b/main/entry.h
@@ -31,7 +31,6 @@
 */
 #define WHOLE_FILE  -1L
 #define includeExtensionFlags()         (Option.tagFileFormat > 1)
-#define escapeMetacharacters()          (Option.tagFileFormat > 2)
 
 /*
 *   DATA DECLARATIONS