VCS: Add a way to filter out files/directories that belong to a VCS

Change-Id: I4dcbe6242cfe327e3b72d3dd550309be45e326a9
Reviewed-by: Orgad Shaneh <orgads@gmail.com>

src/plugins/bazaar/bazaarclient.cpp

@@ -32,6 +32,8 @@
 #include <vcsbase/vcsoutputwindow.h>
 #include <vcsbase/vcsbaseeditorparameterwidget.h>
 
+#include <utils/hostosinfo.h>
+
 #include <QDir>
 #include <QFileInfo>
 #include <QTextStream>
@@ -171,6 +173,12 @@ VcsBaseEditorWidget *BazaarClient::annotate(
                                    QStringList(extraOptions) << QLatin1String("--long"));
 }
 
+bool BazaarClient::isVcsDirectory(const FileName &fileName) const
+{
+    return fileName.toFileInfo().isDir()
+            && fileName.fileName().compare(Constants::BAZAARREPO, HostOsInfo::fileNameCaseSensitivity());
+}
+
 QString BazaarClient::findTopLevelForFile(const QFileInfo &file) const
 {
     const QString repositoryCheckFile =

src/plugins/bazaar/bazaarclient.h

@@ -52,6 +52,7 @@ public:
     VcsBase::VcsBaseEditorWidget *annotate(
             const QString &workingDir, const QString &file, const QString &revision = QString(),
             int lineNumber = -1, const QStringList &extraOptions = QStringList());
+    bool isVcsDirectory(const Utils::FileName &fileName) const;
     QString findTopLevelForFile(const QFileInfo &file) const;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const;
 

src/plugins/bazaar/bazaarcontrol.cpp

@@ -52,6 +52,11 @@ Core::Id BazaarControl::id() const
     return Core::Id(VcsBase::Constants::VCS_ID_BAZAAR);
 }
 
+bool BazaarControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    return m_bazaarClient->isVcsDirectory(fileName);
+}
+
 bool BazaarControl::managesDirectory(const QString &directory, QString *topLevel) const
 {
     QFileInfo dir(directory);

src/plugins/bazaar/bazaarcontrol.h

@@ -48,6 +48,8 @@ public:
     QString displayName() const final;
     Core::Id id() const final;
 
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
+
     bool managesDirectory(const QString &filename, QString *topLevel = 0) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;
     bool isConfigured() const final;

src/plugins/clearcase/clearcasecontrol.cpp

@@ -49,6 +49,12 @@ Core::Id ClearCaseControl::id() const
     return Constants::VCS_ID_CLEARCASE;
 }
 
+bool ClearCaseControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    Q_UNUSED(fileName);
+    return false; // ClearCase has no files/directories littering the sources
+}
+
 bool ClearCaseControl::isConfigured() const
 {
 #ifdef WITH_TESTS

src/plugins/clearcase/clearcasecontrol.h

@@ -42,6 +42,8 @@ public:
     QString displayName() const final;
     Core::Id id() const final;
 
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
+
     bool managesDirectory(const QString &directory, QString *topLevel = 0) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;
 

src/plugins/coreplugin/iversioncontrol.h

@@ -92,6 +92,17 @@ public:
     virtual QString displayName() const = 0;
     virtual Id id() const = 0;
 
+    /*!
+     * \brief isVcsFileOrDirectory
+     * \param fileName
+     * \return True if filename is a file or directory that is maintained by the
+     * version control system.
+     *
+     * It will return true only for exact matches of the name, not for e.g. files in a
+     * directory owned by the version control system (e.g. .git/control).
+     */
+    virtual bool isVcsFileOrDirectory(const Utils::FileName &fileName) const = 0;
+
     /*!
      * Returns whether files in this directory should be managed with this
      * version control.
@@ -232,6 +243,9 @@ public:
     { }
     ~TestVersionControl();
 
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final
+    { Q_UNUSED(fileName); return false; }
+
     void setManagedDirectories(const QHash<QString, QString> &dirs);
     void setManagedFiles(const QSet<QString> &files);
 

src/plugins/cvs/cvscontrol.cpp

@@ -33,6 +33,7 @@
 #include <vcsbase/vcscommand.h>
 
 #include <utils/fileutils.h>
+#include <utils/hostosinfo.h>
 #include <utils/qtcassert.h>
 
 #include <QFileInfo>
@@ -54,6 +55,12 @@ Core::Id CvsControl::id() const
     return Core::Id(VcsBase::Constants::VCS_ID_CVS);
 }
 
+bool CvsControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    return fileName.toFileInfo().isDir()
+            && fileName.fileName().compare("CVS", Utils::HostOsInfo::fileNameCaseSensitivity());
+}
+
 bool CvsControl::isConfigured() const
 {
     const Utils::FileName binary = m_plugin->client()->vcsBinary();

src/plugins/cvs/cvscontrol.h

@@ -42,6 +42,8 @@ public:
     QString displayName() const final;
     Core::Id id() const final;
 
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
+
     bool managesDirectory(const QString &directory, QString *topLevel = 0) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;
 

src/plugins/git/gitversioncontrol.cpp

@@ -30,6 +30,8 @@
 #include <vcsbase/vcsbaseconstants.h>
 #include <vcsbase/vcscommand.h>
 
+#include <utils/hostosinfo.h>
+
 #include <QFileInfo>
 #include <QProcessEnvironment>
 
@@ -74,6 +76,12 @@ Core::Id GitVersionControl::id() const
     return Core::Id(VcsBase::Constants::VCS_ID_GIT);
 }
 
+bool GitVersionControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    return fileName.toFileInfo().isDir()
+            && fileName.fileName().compare(".git", Utils::HostOsInfo::fileNameCaseSensitivity());
+}
+
 bool GitVersionControl::isConfigured() const
 {
     return !m_client->vcsBinary().isEmpty();

src/plugins/git/gitversioncontrol.h

@@ -42,6 +42,8 @@ public:
     QString displayName() const final;
     Core::Id id() const final;
 
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
+
     bool managesDirectory(const QString &directory, QString *topLevel) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;
 

src/plugins/mercurial/mercurialclient.cpp

@@ -33,6 +33,7 @@
 #include <vcsbase/vcsbaseeditorparameterwidget.h>
 #include <utils/synchronousprocess.h>
 #include <utils/fileutils.h>
+#include <utils/hostosinfo.h>
 #include <utils/qtcassert.h>
 
 #include <QDateTime>
@@ -333,6 +334,12 @@ void MercurialClient::revertAll(const QString &workingDir, const QString &revisi
                              QStringList(extraOptions) << QLatin1String("--all"));
 }
 
+bool MercurialClient::isVcsDirectory(const FileName &fileName) const
+{
+    return fileName.toFileInfo().isDir()
+            && fileName.fileName().compare(Constants::MERCURIALREPO, HostOsInfo::fileNameCaseSensitivity());
+}
+
 void MercurialClient::view(const QString &source, const QString &id,
                            const QStringList &extraOptions)
 {

src/plugins/mercurial/mercurialclient.h

@@ -70,6 +70,7 @@ public:
     void revertAll(const QString &workingDir, const QString &revision = QString(),
                    const QStringList &extraOptions = QStringList()) override;
 
+    bool isVcsDirectory(const Utils::FileName &fileName) const;
     QString findTopLevelForFile(const QFileInfo &file) const override;
 
 public slots:

src/plugins/mercurial/mercurialcontrol.cpp

@@ -78,6 +78,11 @@ Core::Id MercurialControl::id() const
     return Core::Id(VcsBase::Constants::VCS_ID_MERCURIAL);
 }
 
+bool MercurialControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    return mercurialClient->isVcsDirectory(fileName);
+}
+
 bool MercurialControl::managesDirectory(const QString &directory, QString *topLevel) const
 {
     QFileInfo dir(directory);

src/plugins/mercurial/mercurialcontrol.h

@@ -47,6 +47,8 @@ public:
 
     QString displayName() const final;
     Core::Id id() const final;
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
+
     bool managesDirectory(const QString &filename, QString *topLevel = 0) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;
     bool isConfigured() const final;

src/plugins/perforce/perforceversioncontrol.cpp

@@ -49,6 +49,12 @@ Core::Id PerforceVersionControl::id() const
     return Core::Id(VcsBase::Constants::VCS_ID_PERFORCE);
 }
 
+bool PerforceVersionControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    Q_UNUSED(fileName);
+    return false; // Perforce does not seem to litter its files into the source tree.
+}
+
 bool PerforceVersionControl::isConfigured() const
 {
     const QString binary = m_plugin->settings().p4BinaryPath();

src/plugins/perforce/perforceversioncontrol.h

@@ -41,6 +41,7 @@ public:
     QString displayName() const final;
     Core::Id id() const final;
 
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
     bool managesDirectory(const QString &directory, QString *topLevel = 0) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;
 

src/plugins/subversion/subversioncontrol.cpp

@@ -77,6 +77,11 @@ Core::Id SubversionControl::id() const
     return Core::Id(VcsBase::Constants::VCS_ID_SUBVERSION);
 }
 
+bool SubversionControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
+{
+    return m_plugin->isVcsDirectory(fileName);
+}
+
 bool SubversionControl::isConfigured() const
 {
     const Utils::FileName binary = m_plugin->client()->vcsBinary();

src/plugins/subversion/subversioncontrol.h

@@ -40,6 +40,7 @@ public:
     explicit SubversionControl(SubversionPlugin *plugin);
     QString displayName() const final;
     Core::Id id() const final;
+    bool isVcsFileOrDirectory(const Utils::FileName &fileName) const final;
 
     bool managesDirectory(const QString &directory, QString *topLevel = 0) const final;
     bool managesFile(const QString &workingDirectory, const QString &fileName) const final;

src/plugins/subversion/subversionplugin.cpp

@@ -54,6 +54,7 @@
 #include <coreplugin/locator/commandlocator.h>
 #include <coreplugin/messagemanager.h>
 
+#include <utils/algorithm.h>
 #include <utils/fileutils.h>
 #include <utils/hostosinfo.h>
 #include <utils/mimetypes/mimedatabase.h>
@@ -408,6 +409,15 @@ bool SubversionPlugin::initialize(const QStringList & /*arguments */, QString *e
     return true;
 }
 
+bool SubversionPlugin::isVcsDirectory(const FileName &fileName)
+{
+    const QString baseName = fileName.fileName();
+    return fileName.toFileInfo().isDir()
+            && contains(m_svnDirectories, [baseName](const QString &s) {
+        return baseName.compare(s, HostOsInfo::fileNameCaseSensitivity());
+    });
+}
+
 SubversionClient *SubversionPlugin::client() const
 {
     QTC_CHECK(m_client);

src/plugins/subversion/subversionplugin.h

@@ -73,6 +73,8 @@ public:
 
     bool initialize(const QStringList &arguments, QString *errorMessage);
 
+    bool isVcsDirectory(const Utils::FileName &fileName);
+
     SubversionClient *client() const;
 
     SubversionSubmitEditor *openSubversionSubmitEditor(const QString &fileName);