Modification to support binary relocation when the FILESDIR macro is a relative path.

nlebedenco · nlebedenco · commit 9ea5b9ba7df5 · 2024-03-31T17:41:41.000-04:00
A second macro BINDIR can be used in combination to indicate an optional binary folder where the program is installed (e.g. the bin part from /usr/bin). When FILESDIR is a relative path, the computed files dir will be the concatenation of the executable parent path [- BINDIR>] + <FILESDIR>. If FILESDIR is an absolute path, it is used unmodified. This is a possible solution to danmar#4424.
diff --git a/cli/CMakeLists.txt b/cli/CMakeLists.txt
@@ -73,14 +73,14 @@ install(TARGETS cppcheck
     COMPONENT applications)
 
 install(FILES ${addons}
-   DESTINATION ${FILESDIR}/addons
+   DESTINATION ${FULL_FILESDIR}/addons
    COMPONENT headers)
 
 install(FILES ${cfgs}
-   DESTINATION ${FILESDIR}/cfg
+   DESTINATION ${FULL_FILESDIR}/cfg
    COMPONENT headers)
 
 install(FILES ${platforms}
-   DESTINATION ${FILESDIR}/platforms
+   DESTINATION ${FULL_FILESDIR}/platforms
    COMPONENT headers)
 
diff --git a/cli/cmdlineparser.cpp b/cli/cmdlineparser.cpp
@@ -1743,9 +1743,11 @@ bool CmdLineParser::loadLibraries(Settings& settings)
     if (!tryLoadLibrary(settings.library, settings.exename, "std.cfg")) {
         const std::string msg("Failed to load std.cfg. Your Cppcheck installation is broken, please re-install.");
 #ifdef FILESDIR
+        const std::string filesdir = Path::getOptionalFilesDirPath(settings.exename);
+        const std::string location = filesdir.empty() ? Path::fromNativeSeparators(Path::getPathFromFilename(settings.exename)) : filesdir;
         const std::string details("The Cppcheck binary was compiled with FILESDIR set to \""
                                   FILESDIR "\" and will therefore search for "
-                                  "std.cfg in " FILESDIR "/cfg.");
+                                  "std.cfg in " + location + "/cfg.");
 #else
         const std::string cfgfolder(Path::fromNativeSeparators(Path::getPathFromFilename(settings.exename)) + "cfg");
         const std::string details("The Cppcheck binary was compiled without FILESDIR set. Either the "
diff --git a/cmake/compilerDefinitions.cmake b/cmake/compilerDefinitions.cmake
@@ -55,3 +55,10 @@ endif()
 
 file(TO_CMAKE_PATH ${FILESDIR} _filesdir)
 add_definitions(-DFILESDIR="${_filesdir}")
+
+cmake_path(NORMAL_PATH CMAKE_INSTALL_FULL_BINDIR OUTPUT_VARIABLE _bindir)
+cmake_path(NORMAL_PATH CMAKE_INSTALL_PREFIX OUTPUT_VARIABLE _prefix)
+if (NOT "${_bindir}" EQUAL "${_prefix}")
+    cmake_path(RELATIVE_PATH CMAKE_INSTALL_FULL_BINDIR BASE_DIRECTORY "${CMAKE_INSTALL_PREFIX}" OUTPUT_VARIABLE _bindir)
+    add_definitions(-DBINDIR="${_bindir}")
+endif ()
diff --git a/cmake/options.cmake b/cmake/options.cmake
@@ -20,7 +20,7 @@ option(ANALYZE_DATAFLOW     "Clang dynamic analyzer: general dynamic dataflow an
 option(WARNINGS_ARE_ERRORS  "Treat warnings as errors"                                      OFF)
 
 set(USE_MATCHCOMPILER "Auto" CACHE STRING "Usage of match compiler")
-set_property(CACHE USE_MATCHCOMPILER PROPERTY STRINGS Auto Off On Verify) 
+set_property(CACHE USE_MATCHCOMPILER PROPERTY STRINGS Auto Off On Verify)
 if (USE_MATCHCOMPILER STREQUAL "Auto")
     if (NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
         set(USE_MATCHCOMPILER_OPT "On")
@@ -77,5 +77,10 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 
-set(FILESDIR                       ${CMAKE_INSTALL_PREFIX}/share/${PROJECT_NAME} CACHE STRING "Cppcheck files directory")
+set(FILESDIR                       share/${PROJECT_NAME} CACHE STRING "Cppcheck files directory")
 
+if (IS_ABSOLUTE "${FILESDIR}")
+    set(FULL_FILESDIR "${FILESDIR}")
+else()
+    set(FULL_FILESDIR "${CMAKE_INSTALL_PREFIX}/${FILESDIR}")
+endif()
diff --git a/gui/common.cpp b/gui/common.cpp
@@ -85,3 +85,23 @@ QString getDataDir()
         return appPath.left(appPath.indexOf("/cppcheck/", 0, Qt::CaseInsensitive) + 9);
     return appPath;
 }
+
+QString getFilesDir()
+{
+    QString filesdir;
+#ifdef FILESDIR
+    filesdir = FILESDIR;
+    if (!filesdir.isEmpty()) {
+        if (QFileInfo(filesdir).isRelative()) {
+            filesdir = QApplication::applicationDirPath();
+            #ifdef BINDIR
+                if (filesdir.endsWith("/" BINDIR)) {
+                    filesdir = filesdir.left(filesdir.lastIndexOf("/" BINDIR));
+                }
+            #endif
+            filesdir += "/" FILESDIR;
+        }
+    }
+#endif
+    return filesdir;
+}
diff --git a/gui/common.h b/gui/common.h
@@ -151,5 +151,10 @@ QString toFilterString(const QMap<QString,QString>& filters, bool addAllSupporte
  */
 QString getDataDir();
 
+/*
+ * Get files dir. If FILESDIR is not defined then it will return empty.
+ */
+QString getFilesDir();
+
 /// @}
 #endif
diff --git a/gui/helpdialog.cpp b/gui/helpdialog.cpp
@@ -60,9 +60,11 @@ static QString getHelpFile()
           << (QApplication::applicationDirPath() + "/help")
           << QApplication::applicationDirPath();
 #ifdef FILESDIR
-    const QString filesdir = FILESDIR;
-    paths << (filesdir + "/help")
-          << filesdir;
+    const QString filesdir = getFilesDir();
+    if (!filesdir.isEmpty()) {
+        paths << (filesdir + "/help")
+              << filesdir;
+    }
 #endif
     for (const QString &p: paths) {
         QString filename = p + "/online-help.qhc";
diff --git a/gui/mainwindow.cpp b/gui/mainwindow.cpp
@@ -845,7 +845,7 @@ Library::Error MainWindow::loadLibrary(Library *library, const QString &filename
 
 #ifdef FILESDIR
     // Try to load the library from FILESDIR/cfg..
-    const QString filesdir = FILESDIR;
+    const QString filesdir = getFilesDir();
     if (!filesdir.isEmpty()) {
         ret = library->load(nullptr, (filesdir+"/cfg/"+filename).toLatin1());
         if (ret.errorcode != Library::ErrorCode::FILE_NOT_FOUND)
diff --git a/gui/projectfile.cpp b/gui/projectfile.cpp
@@ -1122,11 +1122,13 @@ QString ProjectFile::getAddonFilePath(QString filesDir, const QString &addon)
         filesDir += "/";
 
     QStringList searchPaths;
-    searchPaths << filesDir << (filesDir + "addons/") << (filesDir + "../addons/")
+    searchPaths << filesDir << (filesDir + "addons/") << (filesDir + "../addons/");
 #ifdef FILESDIR
-        << (QLatin1String(FILESDIR) + "/addons/")
+        const QString extra = getFilesDir();
+        if (!extra.isEmpty()) {
+            searchPaths << (QLatin1String(extra) + "/addons/");
+        }
 #endif
-    ;
 
     for (const QString& path : searchPaths) {
         QString f = path + addon + ".py";
diff --git a/gui/projectfiledialog.cpp b/gui/projectfiledialog.cpp
@@ -124,8 +124,10 @@ ProjectFileDialog::ProjectFileDialog(ProjectFile *projectFile, bool premium, QWi
     QStringList searchPaths;
     searchPaths << appPath << appPath + "/cfg" << inf.canonicalPath();
 #ifdef FILESDIR
-    if (FILESDIR[0])
-        searchPaths << FILESDIR << FILESDIR "/cfg";
+    const QString filesDir = getFilesDir();
+    if(!filesDir.isEmpty()) {
+        searchPaths << filesDir << filesDir "/cfg";
+    }
 #endif
     if (!datadir.isEmpty())
         searchPaths << datadir << datadir + "/cfg";
diff --git a/lib/addoninfo.cpp b/lib/addoninfo.cpp
@@ -38,10 +38,13 @@ static std::string getFullPath(const std::string &fileName, const std::string &e
         return exepath + "addons/" + fileName;
 
 #ifdef FILESDIR
-    if (Path::isFile(FILESDIR + ("/" + fileName)))
-        return FILESDIR + ("/" + fileName);
-    if (Path::isFile(FILESDIR + ("/addons/" + fileName)))
-        return FILESDIR + ("/addons/" + fileName);
+    const std::string filesdir = Path::getOptionalFilesDirPath(exename);
+    if (!filesdir.empty()) {
+        if (Path::isFile(FILESDIR + ("/" + fileName)))
+            return FILESDIR + ("/" + fileName);
+        if (Path::isFile(FILESDIR + ("/addons/" + fileName)))
+            return FILESDIR + ("/addons/" + fileName);
+    }
 #endif
     return "";
 }
diff --git a/lib/library.cpp b/lib/library.cpp
@@ -102,7 +102,10 @@ Library::Error Library::load(const char exename[], const char path[])
 
         std::list<std::string> cfgfolders;
 #ifdef FILESDIR
-        cfgfolders.emplace_back(FILESDIR "/cfg");
+        const std::string filesdir = Path::getOptionalFilesDirPath(Path::fromNativeSeparators(Path::getCurrentExecutablePath(exename)));
+        if (!filesdir.empty()) {
+            cfgfolders.emplace_back(filesdir + "/cfg");
+        }
 #endif
         if (exename) {
             const std::string exepath(Path::fromNativeSeparators(Path::getPathFromFilename(Path::getCurrentExecutablePath(exename))));
diff --git a/lib/path.cpp b/lib/path.cpp
@@ -291,3 +291,27 @@ std::string Path::join(const std::string& path1, const std::string& path2) {
         return path2;
     return ((path1.back() == '/') ? path1 : (path1 + "/")) + path2;
 }
+
+std::string Path::getOptionalFilesDirPath(const std::string &exename)
+{
+    std::string filesdir;
+#ifdef FILESDIR
+    filesdir = FILESDIR;
+    if (!filesdir.empty()) {
+        if (!Path::isAbsolute(filesdir)) {
+            filesdir = Path::fromNativeSeparators(Path::getPathFromFilename(exename));
+            #ifdef BINDIR
+                std::string bindir = BINDIR;
+                if (!bindir.empty()) {
+                    if (bindir.back() != '/')
+                        bindir += '/';
+                    if (filesdir.size() >= bindir.size() && std::equal(bindir.rbegin(), bindir.rend(), filesdir.rbegin()))
+                        filesdir.erase(filesdir.size() - bindir.size());
+                }
+            #endif
+            filesdir += FILESDIR;
+        }
+    }
+#endif
+    return filesdir;
+}
diff --git a/lib/path.h b/lib/path.h
@@ -198,8 +198,15 @@ class CPPCHECKLIB Path {
      * join 2 paths with '/' separators
      */
     static std::string join(const std::string& path1, const std::string& path2);
+
+    /*
+     * Get files dir. If FILESDIR is not defined then it will return empty.
+     */
+    static std::string getOptionalFilesDirPath(const std::string &exename);
 };
 
+
+
 /// @}
 //---------------------------------------------------------------------------
 #endif // pathH
diff --git a/lib/platform.cpp b/lib/platform.cpp
@@ -205,11 +205,11 @@ bool Platform::loadFromFile(const char exename[], const std::string &filename, b
         filenames.push_back(Path::getPathFromFilename(Path::fromNativeSeparators(exename)) + "platforms/" + filename + ".xml");
     }
 #ifdef FILESDIR
-    std::string filesdir = FILESDIR;
-    if (!filesdir.empty() && filesdir[filesdir.size()-1] != '/')
-        filesdir += '/';
-    filenames.push_back(filesdir + ("platforms/" + filename));
-    filenames.push_back(filesdir + ("platforms/" + filename + ".xml"));
+    std::string filesdir = Path::getOptionalFilesDirPath(Path::fromNativeSeparators(Path::getCurrentExecutablePath(exename)));
+    if (!filesdir.empty()) {
+        filenames.push_back(filesdir + ("/platforms/" + filename));
+        filenames.push_back(filesdir + ("/platforms/" + filename + ".xml"));
+    }
 #endif
 
     // open file..
diff --git a/lib/settings.cpp b/lib/settings.cpp
@@ -46,8 +46,11 @@ std::string Settings::loadCppcheckCfg()
     static const std::string cfgFilename = "cppcheck.cfg";
     std::string fileName;
 #ifdef FILESDIR
-    if (Path::isFile(Path::join(FILESDIR, cfgFilename)))
-        fileName = Path::join(FILESDIR, cfgFilename);
+    const std::string filesdir = Path::getOptionalFilesDirPath(exename);
+    if (!filesdir.empty()) {
+        if (Path::isFile(Path::join(filesdir, cfgFilename)))
+            fileName = Path::join(filesdir, cfgFilename);
+    }
 #endif
     // cppcheck-suppress knownConditionTrueFalse
     if (fileName.empty()) {
