fixed #13990/#13991 - reworked platform lookup (#7639)

- provide a list of paths to look into to the platform loading
- look relative to project file first (fixes #13990)
- do not look into CWD for each path provided (fixes #13991)

Author: firewave

cli/cmdlineparser.cpp

@@ -394,7 +394,10 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
     std::string platform;
     char defaultSign = '\0';
 
-    std::vector<std::string> lookupPaths{argv[0]};
+    std::vector<std::string> lookupPaths{
+        Path::getCurrentPath(), // TODO: do we want to look in CWD?
+        Path::getPathFromFilename(argv[0])
+    };
 
     bool executorAuto = true;
 
@@ -1160,7 +1163,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
                     platform = project.guiProject.platform;
 
                 // look for external files relative to project first
-                lookupPaths.insert(lookupPaths.cbegin(), projectFile);
+                lookupPaths.insert(lookupPaths.cbegin(), Path::getPathFromFilename(projectFile));
 
                 const auto& projectFileGui = project.guiProject.projectFile;
                 if (!projectFileGui.empty()) {

gui/mainwindow.cpp

@@ -1154,8 +1154,11 @@ bool MainWindow::getCppcheckSettings(Settings& settings, Suppressions& supprs)
 
         const QString platform = mProjectFile->getPlatform();
         if (platform.endsWith(".xml")) {
-            const QString applicationFilePath = QCoreApplication::applicationFilePath();
-            settings.platform.loadFromFile(applicationFilePath.toStdString().c_str(), platform.toStdString());
+            const std::vector<std::string> paths = {
+                Path::getCurrentPath(), // TODO: do we want to look in CWD?
+                QCoreApplication::applicationFilePath().toStdString(),
+            };
+            settings.platform.loadFromFile(paths, platform.toStdString());
         } else {
             for (int i = Platform::Type::Native; i <= Platform::Type::Unix64; i++) {
                 const auto p = static_cast<Platform::Type>(i);

gui/projectfiledialog.cpp

@@ -208,8 +208,12 @@ ProjectFileDialog::ProjectFileDialog(ProjectFile *projectFile, bool premium, QWi
         for (const QFileInfo& item : dir.entryInfoList()) {
             const QString platformFile = item.fileName();
 
+            const std::vector<std::string> paths = {
+                Path::getCurrentPath(), // TODO: do we want to look in CWD?
+                applicationFilePath.toStdString(),
+            };
             Platform plat2;
-            if (!plat2.loadFromFile(applicationFilePath.toStdString().c_str(), platformFile.toStdString()))
+            if (!plat2.loadFromFile(paths, platformFile.toStdString()))
                 continue;
 
             if (platformFiles.indexOf(platformFile) == -1)

lib/platform.cpp

@@ -155,27 +155,19 @@ bool Platform::set(const std::string& platformstr, std::string& errstr, const st
         errstr = "unrecognized platform: '" + platformstr + "' (no lookup).";
         return false;
     }
-    else {
-        bool found = false;
-        for (const std::string& path : paths) {
-            if (debug)
-                std::cout << "looking for platform '" + platformstr + "' relative to '" + path + "'" << std::endl;
-            if (loadFromFile(path.c_str(), platformstr, debug)) {
-                found = true;
-                break;
-            }
-        }
-        if (!found) {
-            errstr = "unrecognized platform: '" + platformstr + "'.";
-            return false;
-        }
+    else if (!loadFromFile(paths, platformstr, debug)) {
+        errstr = "unrecognized platform: '" + platformstr + "'.";
+        return false;
     }
 
     return true;
 }
 
-bool Platform::loadFromFile(const char exename[], const std::string &filename, bool debug)
+bool Platform::loadFromFile(const std::vector<std::string>& paths, const std::string &filename, bool debug)
 {
+    if (debug)
+        std::cout << "looking for platform '" + filename + "'" << std::endl;
+
     const bool is_abs_path = Path::isAbsolute(filename);
 
     std::string fullfilename(filename);
@@ -185,20 +177,33 @@ bool Platform::loadFromFile(const char exename[], const std::string &filename, b
         fullfilename += ".xml";
 
     // TODO: use native separators
-    std::vector<std::string> filenames{
-        fullfilename,
-    };
-    if (!is_abs_path) {
-        filenames.push_back("platforms/" + fullfilename);
-        if (exename && (std::string::npos != Path::fromNativeSeparators(exename).find('/'))) {
-            filenames.push_back(Path::getPathFromFilename(Path::fromNativeSeparators(exename)) + fullfilename);
-            filenames.push_back(Path::getPathFromFilename(Path::fromNativeSeparators(exename)) + "platforms/" + fullfilename);
+    std::vector<std::string> filenames;
+    if (is_abs_path)
+    {
+        filenames.push_back(fullfilename);
+    }
+    else {
+        // TODO: drop duplicated paths
+        for (const std::string& path : paths)
+        {
+            if (path.empty())
+                continue; // TODO: error out instead?
+
+            std::string ppath = Path::fromNativeSeparators(path);
+            if (ppath.back() != '/')
+                ppath += '/';
+            // TODO: look in platforms first?
+            filenames.push_back(ppath + fullfilename);
+            filenames.push_back(ppath + "platforms/" + fullfilename);
         }
 #ifdef FILESDIR
         std::string filesdir = FILESDIR;
-        if (!filesdir.empty() && filesdir[filesdir.size()-1] != '/')
-            filesdir += '/';
-        filenames.push_back(filesdir + ("platforms/" + fullfilename));
+        if (!filesdir.empty()) {
+            if (filesdir.back() != '/')
+                filesdir += '/';
+            // TODO: look in filesdir?
+            filenames.push_back(filesdir + "platforms/" + fullfilename);
+        }
 #endif
     }
 

lib/platform.h

@@ -44,6 +44,7 @@ namespace tinyxml2 {
  * @brief Platform settings
  */
 class CPPCHECKLIB Platform {
+    friend class TestPlatform;
 private:
     static long long min_value(std::uint8_t bit) {
         assert(bit > 0);
@@ -78,6 +79,9 @@ class CPPCHECKLIB Platform {
 
     /** provides list of defines specified by the limit.h/climits includes */
     std::string getLimitsDefines(bool c99) const;
+
+    /** load platform from xml document, primarily for testing */
+    bool loadFromXmlDocument(const tinyxml2::XMLDocument *doc);
 public:
     Platform();
 
@@ -150,15 +154,13 @@ class CPPCHECKLIB Platform {
 
     /**
      * load platform file
-     * @param exename application path
+     * @param paths the additional paths to look into
      * @param filename platform filename
      * @param debug log verbose information about the lookup
      * @return returns true if file was loaded successfully
      */
-    bool loadFromFile(const char exename[], const std::string &filename, bool debug = false);
+    bool loadFromFile(const std::vector<std::string>& paths, const std::string &filename, bool debug = false);
 
-    /** load platform from xml document, primarily for testing */
-    bool loadFromXmlDocument(const tinyxml2::XMLDocument *doc);
 
     /**
      * @brief Returns true if platform type is Windows