Merge pull request #4085 from masatake/main--tags-dir

main: error with more friendly and understandable message when "tags" directory exists

Author: masatake

Tmain/errors-if-tags-exits-as-directory.d/exit-expected.txt

@@ -0,0 +1 @@
+1

Tmain/errors-if-tags-exits-as-directory.d/run.sh

@@ -0,0 +1,6 @@
+# Copyright: 2024 Masatake YAMATO
+# License: GPL-2
+
+CTAGS=$1
+
+${CTAGS} --quiet --options=NONE $0

Tmain/errors-if-tags-exits-as-directory.d/stderr-expected.txt

@@ -0,0 +1,2 @@
+ctags: "tags" already exists as a directory; I cannot write tag entries there.
+Remove the directory or specify a file name with -o <tagfile> option.

Tmain/errors-if-tags-exits-as-directory.d/stdout-expected.txt

@@ -0,0 +1,2 @@
+*
+!.gitignore

Tmain/errors-if-tags-exits-as-directory.d/tags/.gitignore

@@ -422,8 +422,17 @@ extern void openTagFile (void)
 	else
 	{
 		bool fileExists;
+		bool directoryExists;
 
 		TagFile.name = eStrdup (Option.tagFileName);
+
+		directoryExists = doesDirectoryExist (TagFile.name);
+		if (directoryExists)
+			error (FATAL,
+				   "\"%s\" already exists as a directory; I cannot write tag entries there.\n"
+				   "Remove the directory or specify a file name with -o <tagfile> option.",
+				   TagFile.name);
+
 		fileExists = doesFileExist (TagFile.name);
 		if (fileExists  &&  ! isTagFile (TagFile.name))
 			error (FATAL,

main/entry.c

@@ -480,6 +480,12 @@ extern void eStatFree (fileStatus *status)
 	}
 }
 
+extern bool doesDirectoryExist (const char *const fileName)
+{
+	fileStatus *status = eStat (fileName);
+	return status->exists && status->isDirectory;
+}
+
 extern bool doesFileExist (const char *const fileName)
 {
 	fileStatus *status = eStat (fileName);

main/routines.c

@@ -86,6 +86,7 @@ extern void setCurrentDirectory (void);
 extern fileStatus *eStat (const char *const fileName);
 extern void eStatFree (fileStatus *status);
 extern bool doesFileExist (const char *const fileName);
+extern bool doesDirectoryExist (const char *const fileName);
 extern bool doesExecutableExist (const char *const fileName);
 extern bool isRecursiveLink (const char* const dirName);
 extern bool isSameFile (const char *const name1, const char *const name2);