fix

Author: danmar

gui/manualtest/projectfiledialog.md

@@ -4,6 +4,20 @@
 Some manual testing in the project file dialog interface
 
 
+## Test: Relative paths
+
+Ticket: #14983
+
+1. Configure files/paths in project folder:
+ * import a projectfile
+ * add include paths in project folder
+ * exclude file/folder
+
+2. Save project
+
+EXPECTED: Relative paths should be used in the XML
+
+
 ## Test: Platform file pic8.xml
 
 Ticket: #14489

gui/projectfile.cpp

@@ -751,9 +751,7 @@ void ProjectFile::setCheckPaths(const QStringList &paths)
 
 void ProjectFile::setExcludedPaths(const QStringList &paths)
 {
-    mExcludedPaths.clear();
-    for (const QString &path : paths)
-        mExcludedPaths << (QFileInfo(path).isAbsolute() ? getRelativePath(path) : path);
+    mExcludedPaths = paths;
 }
 
 void ProjectFile::setLibraries(const QStringList &libraries)
@@ -1199,7 +1197,7 @@ QString ProjectFile::getRelativePath(const QString &absolutePath) const
 {
     const QDir dir(QFileInfo(mFilename).absolutePath());
     const QString relativePath(dir.relativeFilePath(absolutePath));
-    if (relativePath.startsWith("../.."))
+    if (relativePath.startsWith("../../..") || absolutePath.length() < relativePath.length())
         return absolutePath;
     return relativePath;
 }

gui/projectfiledialog.cpp

@@ -888,7 +888,9 @@ void ProjectFileDialog::addExcludeFile()
     QMap<QString,QString> filters;
     filters[tr("Source files")] = "*.c *.cpp";
     filters[tr("All files")] = "*.*";
-    addExcludePath(QFileDialog::getOpenFileName(this, tr("Exclude file"), dir.canonicalPath(), toFilterString(filters)));
+    QString fileName = QFileDialog::getOpenFileName(this, tr("Exclude file"), dir.canonicalPath(), toFilterString(filters));
+    if (!fileName.isEmpty())
+        addExcludePath(mProjectFile->getRelativePath(fileName));
 }
 
 void ProjectFileDialog::editExcludePath()

gui/test/projectfile/testprojectfile.cpp

@@ -214,31 +214,44 @@ void TestProjectFile::emptyUserInclude() const
     QCOMPARE(settings.userIncludes.size(), 0);
 }
 
-// Absolute path is made relative when it does not require walking up more than 2 parent folders
-void TestProjectFile::setExcludedPathsRelative() const
+// Absolute path is made relative when it does not require walking up more than 3 parent folders
+void TestProjectFile::getRelativePathRelative() const
 {
     ProjectFile projectFile;
-    projectFile.setFilename("/some/path/123.cppcheck");
-    projectFile.setExcludedPaths(QStringList() << "/some/externals/foo.cpp");
-    QCOMPARE(projectFile.getExcludedPaths()[0], QString("../externals/foo.cpp"));
+    projectFile.setFilename("/some/path/sub/123.cppcheck");
+    QCOMPARE(projectFile.getRelativePath("/some/path/externals/foo.cpp"), QString("../externals/foo.cpp"));
 }
 
-// Absolute path is kept as-is when making it relative would require walking up more than 2 parent folders
-void TestProjectFile::setExcludedPathsTooFarUp() const
+// Absolute path is made relative even when it requires walking up 2 parent folders
+void TestProjectFile::getRelativePathTwoUp() const
 {
     ProjectFile projectFile;
-    projectFile.setFilename("/some/path/123.cppcheck");
-    projectFile.setExcludedPaths(QStringList() << "/other/deep/foo.cpp");
-    QCOMPARE(projectFile.getExcludedPaths()[0], QString("/other/deep/foo.cpp"));
+    projectFile.setFilename("/some/path/sub/123.cppcheck");
+    QCOMPARE(projectFile.getRelativePath("/some/externals/foo.cpp"), QString("../../externals/foo.cpp"));
 }
 
-// Paths that are already relative are kept unchanged
-void TestProjectFile::setExcludedPathsAlreadyRelative() const
+// Absolute path is kept as-is when making it relative would require walking up more than 3 parent folders
+void TestProjectFile::getRelativePathTooFarUp() const
 {
     ProjectFile projectFile;
-    projectFile.setFilename("/some/path/123.cppcheck");
-    projectFile.setExcludedPaths(QStringList() << "gui/temp/");
-    QCOMPARE(projectFile.getExcludedPaths()[0], QString("gui/temp/"));
+    projectFile.setFilename("/some/path/sub/123.cppcheck");
+    QCOMPARE(projectFile.getRelativePath("/other/deep/foo.cpp"), QString("/other/deep/foo.cpp"));
+}
+
+// Absolute path in a subfolder of the project path is made relative without walking up at all
+void TestProjectFile::getRelativePathSubfolder() const
+{
+    ProjectFile projectFile;
+    projectFile.setFilename("/some/path/sub/123.cppcheck");
+    QCOMPARE(projectFile.getRelativePath("/some/path/sub/src/file1.c"), QString("src/file1.c"));
+}
+
+// Absolute path is kept as-is when it is shorter than the relative path, even if it does not require walking up 3 or more parent folders
+void TestProjectFile::getRelativePathAbsoluteShorter() const
+{
+    ProjectFile projectFile;
+    projectFile.setFilename("/ab/path/sub/123.cppcheck");
+    QCOMPARE(projectFile.getRelativePath("/ab/foo.cpp"), QString("/ab/foo.cpp"));
 }
 
 QTEST_MAIN(TestProjectFile)

gui/test/projectfile/testprojectfile.h

@@ -39,7 +39,9 @@ private slots:
 
     void emptyUserInclude() const;
 
-    void setExcludedPathsRelative() const;
-    void setExcludedPathsTooFarUp() const;
-    void setExcludedPathsAlreadyRelative() const;
+    void getRelativePathRelative() const;
+    void getRelativePathTwoUp() const;
+    void getRelativePathTooFarUp() const;
+    void getRelativePathSubfolder() const;
+    void getRelativePathAbsoluteShorter() const;
 };