Merge pull request #3594 from masatake/output-versioning

main: output versioning and shorten output mode for --version

Tmain/extras-field-for-pseudo-tags.d/run.sh

@@ -11,6 +11,7 @@ run_ctags()
 			 --pseudo-tags=-TAG_PROGRAM_VERSION \
 			 --pseudo-tags=-TAG_PROC_CWD \
 			 --pseudo-tags=-TAG_PARSER_VERSION \
+			 --pseudo-tags=-TAG_OUTPUT_VERSION \
 			 $@ \
 			 -o - input.c
 }

Tmain/input-encoding-option.d/run.sh

@@ -20,6 +20,7 @@ if ${CTAGS} --quiet --options=NONE --list-features | grep -q iconv; then
 	      --pseudo-tags=-TAG_FIELD_DESCRIPTION \
 	      --pseudo-tags=-TAG_ROLE_DESCRIPTION \
 	      --pseudo-tags=-TAG_PARSER_VERSION \
+	      --pseudo-tags=-TAG_OUTPUT_VERSION \
 	      --input-encoding=utf-8 --input-encoding-java=shift_jis --input-encoding-javascript=euc-jp \
 	      -o ${BUILDDIR}/tags \
 	      input.js input.java ; then

Tmain/interactive-mode.d/run.sh

@@ -9,43 +9,42 @@ is_feature_available ${CTAGS} interactive
 # It seems that the output format is slightly different between libjansson versions
 s()
 {
-	sed -e s/':"'/': "'/g
+	sed -e s/':"'/': "'/g | jdropver
 }
 
 CTAGS="$CTAGS --options=NONE"
-NV="--pseudo-tags=-TAG_PROGRAM_VERSION"
 
 echo identification message on startup
 echo =======================================
-${CTAGS} --_interactive $NV < /dev/null |s
+${CTAGS} --_interactive < /dev/null |s
 
 echo
 echo error on invalid command
 echo =======================================
-echo '{"command":"foobar"}' | ${CTAGS} --_interactive $NV |s
+echo '{"command":"foobar"}' | ${CTAGS} --_interactive |s
 
 echo
 echo error on missing arguments
 echo =======================================
-echo '{"command":"generate-tags"}' | ${CTAGS} --_interactive $NV |s
+echo '{"command":"generate-tags"}' | ${CTAGS} --_interactive |s
 
 echo
 echo error on invalid file
 echo =======================================
-echo '{"command":"generate-tags", "filename":"test.foo"}' | ${CTAGS} --_interactive $NV |s
+echo '{"command":"generate-tags", "filename":"test.foo"}' | ${CTAGS} --_interactive |s
 
 echo
 echo generate tags from file
 echo =======================================
-echo '{"command":"generate-tags", "filename":"test.rb"}' | ${CTAGS} --_interactive $NV |s
+echo '{"command":"generate-tags", "filename":"test.rb"}' | ${CTAGS} --_interactive |s
 
 echo
 echo process multiple commands
 echo =======================================
 (
   echo '{"command":"generate-tags", "filename":"test.rb"}'
   echo '{"command":"generate-tags", "filename":"test.c"}'
-) | ${CTAGS} --_interactive $NV |s
+) | ${CTAGS} --_interactive |s
 
 echo
 echo generate tags from data
@@ -54,4 +53,4 @@ size=$(filesize test.rb)
 (
   echo '{"command":"generate-tags", "filename":"foobar.rb", "size":'$size'}'
   cat test.rb
-) | ${CTAGS} --_interactive $NV |s
+) | ${CTAGS} --_interactive |s

Tmain/interactive-notice-output.d/run.sh

@@ -8,7 +8,7 @@ CTAGS=$1
 # It seems that the output format is slightly different between libjansson versions
 s()
 {
-	sed -e s/':"'/': "'/g
+	sed -e s/':"'/': "'/g | jdropver
 }
 
 if is_feature_available ${CTAGS} json; then

Tmain/interactive-option-write-to-file.d/run.sh

@@ -11,12 +11,11 @@ is_feature_available ${CTAGS} interactive
 # It seems that the output format is slightly different between libjansson versions
 s()
 {
-	sed -e s/':"'/': "'/g
+	sed -e s/':"'/': "'/g | jdropver
 }
 
 O=/tmp/ctags-tmain-$$.txt
 
-echo '{"command":"generate-tags", "filename":"test.rb"}' | ${CTAGS} --quiet --options=NONE --_interactive -o ${O} \
-																	--pseudo-tags=-TAG_PROGRAM_VERSION |s
+echo '{"command":"generate-tags", "filename":"test.rb"}' | ${CTAGS} --quiet --options=NONE --_interactive -o ${O} |s
 
 rm -f ${O}

Tmain/json-output-format.d/run.sh

@@ -12,6 +12,7 @@ if is_feature_available "${CTAGS}" json; then
 	run_with_format json --languages=+man --fields="*"-T --extras='*'
     } | cat \
 		| grep -v TAG_PROGRAM_VERSION \
+		| grep -v TAG_OUTPUT_VERSION  \
 		| grep -v TAG_OUTPUT_FILESEP  \
 		| grep -v TAG_PROC_CWD
 fi

Tmain/list-pseudo-tags.d/stdout-expected.txt

@@ -9,6 +9,7 @@ TAG_KIND_SEPARATOR        off     the separators used in kinds
 TAG_OUTPUT_EXCMD          on      the excmd: number, pattern, mixed, or combine
 TAG_OUTPUT_FILESEP        on      the separator used in file name (slash or backslash)
 TAG_OUTPUT_MODE           on      the output mode: u-ctags or e-ctags
+TAG_OUTPUT_VERSION        on      the version of the output interface (current.age)
 TAG_PARSER_VERSION        on      the version of the parser (current.age)
 TAG_PATTERN_LENGTH_LIMIT  on      the limit of pattern length
 TAG_PROC_CWD              on      the current working directory of the tags generator

Tmain/output-encoding-option.d/run.sh

@@ -13,12 +13,13 @@ if ${CTAGS} --quiet --options=NONE --list-features | grep -q iconv; then
   check_encoding euc-jp
   if ${CTAGS}  --quiet --options=NONE \
 	       --pseudo-tags=-TAG_PROC_CWD \
-		   --pseudo-tags=-TAG_PROGRAM_VERSION \
+	       --pseudo-tags=-TAG_PROGRAM_VERSION \
 	       --pseudo-tags=-TAG_KIND_DESCRIPTION \
 	       --pseudo-tags=-TAG_FIELD_DESCRIPTION \
 	       --pseudo-tags=-TAG_EXTRA_DESCRIPTION \
 	       --pseudo-tags=-TAG_ROLE_DESCRIPTION \
 	       --pseudo-tags=-TAG_PARSER_VERSION \
+	       --pseudo-tags=-TAG_OUTPUT_VERSION \
 	       --output-encoding=shift_jis --input-encoding=utf-8 --input-encoding-javascript=euc-jp \
 	       -o ${BUILDDIR}/tags \
 	       input.js input.java ; then

Tmain/ptag-kind-sep.d/run.sh

@@ -18,4 +18,5 @@ ${CTAGS} --quiet --options=NONE -o - \
 	 --pseudo-tags=-TAG_EXTRA_DESCRIPTION \
 	 --pseudo-tags=-TAG_ROLE_DESCRIPTION \
 	 --pseudo-tags=-TAG_PARSER_VERSION \
+	 --pseudo-tags=-TAG_OUTPUT_VERSION \
 	 input.php

Tmain/sandbox-crash.d/run.sh

@@ -14,7 +14,8 @@ is_feature_available ${CTAGS} '!' gcov
 {
     echo '{"command":"generate-tags", "filename":"input.ctst", "size": 1}'
     echo 'P'
-} | $CTAGS --quiet --options=NONE  --language-force=CTagsSelfTest --_interactive=sandbox \
-		   --pseudo-tags=-TAG_PROGRAM_VERSION
-
-exit $?
+} | $CTAGS --quiet --options=NONE  --language-force=CTagsSelfTest --_interactive=sandbox > /tmp/ctags-Tmain-$$
+r=$?
+jdropver < /tmp/ctags-Tmain-$$
+rm /tmp/ctags-Tmain-$$
+exit $r

Tmain/sandbox-default-req.d/run.sh

@@ -14,7 +14,8 @@ is_feature_available ${CTAGS} '!' gcov
     echo '{"command":"generate-tags", "filename":"input.c", "size": -1}'
     echo '{"command":"generate-tags", "filename":"input.el", "size": 16}'
     echo '(defun foo () 0)'
-} | $CTAGS --quiet --options=NONE  --_interactive=sandbox \
-		   --pseudo-tags=-TAG_PROGRAM_VERSION
-
-exit $?
+} | $CTAGS --quiet --options=NONE  --_interactive=sandbox > /tmp/ctags-Tmain-$$
+r=$?
+jdropver < /tmp/ctags-Tmain-$$
+rm /tmp/ctags-Tmain-$$
+exit $r

Tmain/sandbox-no-eager-guessing.d/run.sh

@@ -13,7 +13,8 @@ is_feature_available ${CTAGS} '!' gcov
 {
     echo '{"command":"generate-tags", "filename":"input.unknown", "size": 44}'
     echo '/* -*- c -*- */ int main(void) { return 0; }'
-} | $CTAGS --quiet --options=NONE --_interactive=sandbox \
-		   --pseudo-tags=-TAG_PROGRAM_VERSION
-
-exit $?
+} | $CTAGS --quiet --options=NONE --_interactive=sandbox > /tmp/ctags-Tmain-$$
+r=$?
+jdropver < /tmp/ctags-Tmain-$$
+rm /tmp/ctags-Tmain-$$
+exit $r

Tmain/sandbox-with-eager-guessing.d/run.sh

@@ -13,7 +13,8 @@ is_feature_available ${CTAGS} '!' gcov
 {
     echo '{"command":"generate-tags", "filename":"input.unknown", "size": 44}'
     echo '/* -*- c -*- */ int main(void) { return 0; }'
-} | $CTAGS --quiet --options=NONE  -G --_interactive=sandbox \
-		   --pseudo-tags=-TAG_PROGRAM_VERSION
-
-exit $?
+} | $CTAGS --quiet --options=NONE  -G --_interactive=sandbox > /tmp/ctags-Tmain-$$
+r=$?
+jdropver < /tmp/ctags-Tmain-$$
+rm /tmp/ctags-Tmain-$$
+exit $r

Tmain/sandbox.d/run.sh

@@ -13,7 +13,8 @@ is_feature_available ${CTAGS} '!' gcov
 {
     echo '{"command":"generate-tags", "filename":"input.c", "size": 28}'
     echo 'int main(void) { return 0; }'
-} | $CTAGS --quiet --options=NONE  --_interactive=sandbox \
-		   --pseudo-tags=-TAG_PROGRAM_VERSION
-
-exit $?
+} | $CTAGS --quiet --options=NONE  --_interactive=sandbox > /tmp/ctags-Tmain-$$
+r=$?
+jdropver < /tmp/ctags-Tmain-$$
+rm /tmp/ctags-Tmain-$$
+exit $r

Tmain/utils.sh

@@ -143,3 +143,8 @@ check_encoding()
 	fi
 	skip "iconv doesn't know about the encoding: $1"
 }
+
+jdropver()
+{
+	sed -e 's/, "version": "5.9.0"//'
+}

docs/man/ctags-client-tools.7.rst

@@ -220,6 +220,18 @@ for using notable ones.
 ``TAG_OUTPUT_MODE`` (new in Universal Ctags)
 	TBW
 
+``TAG_OUTPUT_VERSION`` (new in Universal Ctags 6.0)
+    Indicates the language-common interface version of the output::
+
+	  !_TAG_OUTPUT_VERSION	{current}.{age}	/.../
+
+	The public interface includes common fields, common extras,
+	pseudo tags.
+
+	The maintainer of Universal Ctags may update the numbers,
+	"{current}" and "{age}" in the same manner as explained
+	in ``TAG_PARSER_VERSION``.
+
 ``TAG_PARSER_VERSION`` (new in Universal Ctags 6.0)
 	Indicates the interface version of the parser::
 

docs/man/ctags-json-output.5.rst

@@ -95,7 +95,7 @@ For an example, the value for ``pattern`` field of ctags takes a string or a boo
 VERSIONS
 --------
 
-Cnages since "0.0"
+Change since "0.0"
 ~~~~~~~~~~~~~~~~~~
 
 * New key ``kindName`` for ``TAG_ROLE_DESCRIPTION`` pseudo tag

docs/man/ctags.1.rst

@@ -1327,11 +1327,13 @@ Miscellaneous Options
 ``-V``
 	Equivalent to ``--verbose``.
 
-``--version[=<language>]``
+``--version[=<language>|NONE]``
 	Prints a version identifier for ctags to standard
 	output, and then exits. This is guaranteed to always contain the string
-	"Universal Ctags". See also the description for ``TAG_PROGRAM_VERSION`` in
-	:ref:`ctags-client-tools(7) <ctags-client-tools(7)>`.
+	"Universal Ctags". See also the description for ``TAG_PROGRAM_VERSION``
+	and ``TAG_OUTPUT_VERSION`` in :ref:`ctags-client-tools(7) <ctags-client-tools(7)>`.
+
+	If ``NONE`` is given, prints the version identifier in a simplified way.
 
 	If *<language>* is given, print the version identifier for the parser
 	for *<language>*. See also the description for ``TAG_PARSER_VERSION`` in

main/ctags.h

@@ -21,7 +21,7 @@
    of ctags or readtags commands, increment VERSION.
    Removing a parameter of a parser is part of incompatible change
    for the CLI.
-   When OUTPUT_VERSOIN_AGE set to 0, increment VERSION. Set REVISION
+   When OUTPUT_VERSION_AGE set to 0, increment VERSION. Set REVISION
    and PATCH to 0.
    For changing setting versionAge member of a parser, increment
    VERSION. Set REVISION and PATCH to 0.
@@ -30,8 +30,8 @@
    For uppper compatible changes for the CLI,
    increment REVISION.
    Adding a new parameter to a parser is an uppper compatible change.
-   When incrementing OUTPUT_VERSOIN_CURRENT but not setting
-   OUTPUT_VERSOIN_AGE to 0, increment REVISION.
+   When incrementing OUTPUT_VERSION_CURRENT but not setting
+   OUTPUT_VERSION_AGE to 0, increment REVISION.
    For changing increment versionCurrent member of a parser but not
    setting versionAge to 0, increment REVISION.
    When changing REVISION, set PATCH to 0.
@@ -48,6 +48,26 @@
 #define PROGRAM_COPYRIGHT "Copyright (C) 2015-2022"
 #define AUTHOR_NAME       "Universal Ctags Team"
 
+/* The concept of CURRENT and AGE is taken from libtool.
+ * However, we deleted REVISION in libtool when importing
+ * the concept of versioning from libtool.
+ *
+ * If common fields, common extras, pseudo tags have been added,
+ * removed or changed since last release, increment CURRENT.
+ * If they have been added since last release, increment AGE.
+ * If they have been removed since last release, set AGE to 0
+ *
+ * From the command line of ctags, you can see the version
+ * information with --version and --version=NONE.
+ *
+ * In the tags file, !_TAGS_OUTPUT_VERSION shows the the version.
+ *
+ * Chaning for the command line interface, and implementation changes
+ * like bug fixes don't affect the CURRENT an AGE.
+ */
+#define OUTPUT_VERSION_CURRENT 0
+#define OUTPUT_VERSION_AGE 0
+
 /*
  * Constant
  */

main/main.c

@@ -59,7 +59,6 @@
 #include "options_p.h"
 #include "optscript.h"
 #include "parse_p.h"
-#include "ptag_p.h"
 #include "read_p.h"
 #include "routines_p.h"
 #include "stats_p.h"
@@ -416,16 +415,7 @@ void interactiveLoop (cookedArgs *args CTAGS_ATTR_UNUSED, void *user)
 	char buffer[1024];
 	json_t *request;
 
-	if (isPtagEnabled(PTAG_PROGRAM_NAME))
-	{
-		if (isPtagEnabled(PTAG_PROGRAM_VERSION))
-			fputs ("{\"_type\": \"program\", \"name\": \"" PROGRAM_NAME "\", \"version\": \"" PROGRAM_VERSION "\"}\n", stdout);
-		else
-			fputs ("{\"_type\": \"program\", \"name\": \"" PROGRAM_NAME "\"}\n", stdout);
-	}
-	else if (isPtagEnabled(PTAG_PROGRAM_VERSION))
-		fputs ("{\"_type\": \"program\", \"version\": \"" PROGRAM_VERSION "\"}\n", stdout);
-
+	fputs ("{\"_type\": \"program\", \"name\": \"" PROGRAM_NAME "\", \"version\": \"" PROGRAM_VERSION "\"}\n", stdout);
 	fflush (stdout);
 
 	while (fgets (buffer, sizeof(buffer), stdin))

main/options.c

@@ -1614,6 +1614,8 @@ static void printProgramIdentification (void)
 
 	printf ("  Compiled: %s, %s\n", __DATE__, __TIME__);
 	printf ("  URL: %s\n", PROGRAM_URL);
+	printf ("  Output version: %d.%d\n",
+			OUTPUT_VERSION_CURRENT, OUTPUT_VERSION_AGE);
 
 	printFeatureList ();
 }
@@ -2685,6 +2687,14 @@ static void processVersionOption (
 {
 	if (parameter == NULL || *parameter == '\0')
 		printProgramIdentification ();
+	else if (strcmp (parameter, RSV_NONE) == 0)
+	{
+		printf("ctags: %s\n", PROGRAM_VERSION);
+		if (! ((ctags_repoinfo == NULL)
+			   || (strcmp (ctags_repoinfo, PROGRAM_VERSION) == 0)))
+			printf("repoinfo: %s\n", ctags_repoinfo);
+		printf("output: %d.%d\n", OUTPUT_VERSION_CURRENT, OUTPUT_VERSION_AGE);
+	}
 	else
 	{
 		langType language = getNamedLanguage (parameter, 0);