diff -r 58ecdaf0b789 -r baf6da1ae288 Plugins/VcsPlugins/vcsGit/GitSubmoduleAddDialog.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Plugins/VcsPlugins/vcsGit/GitSubmoduleAddDialog.py Sun Dec 10 17:42:11 2017 +0100
@@ -0,0 +1,192 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2017 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog to enter the data to add a submodule.
+"""
+
+from __future__ import unicode_literals
+
+from PyQt5.QtCore import pyqtSlot, QUrl
+from PyQt5.QtWidgets import QDialog, QDialogButtonBox
+
+from E5Gui.E5Completers import E5DirCompleter
+from E5Gui import E5FileDialog
+
+from .Ui_GitSubmoduleAddDialog import Ui_GitSubmoduleAddDialog
+from .Config import ConfigGitSchemes
+
+import Utilities
+import Preferences
+import UI.PixmapCache
+
+
+class GitSubmoduleAddDialog(QDialog, Ui_GitSubmoduleAddDialog):
+ """
+ Class implementing a dialog to enter the data to add a submodule.
+ """
+ def __init__(self, vcs, repodir, parent=None):
+ """
+ Constructor
+
+ @param vcs reference to the version control object
+ @type Git
+ @param repodir directory containing the superproject
+ @type str
+ @param parent reference to the parent widget
+ @type QWidget
+ """
+ super(GitSubmoduleAddDialog, self).__init__(parent)
+ self.setupUi(self)
+
+ self.__vcs = vcs
+ self.__repodir = repodir
+
+ self.submoduleDirButton.setIcon(UI.PixmapCache.getIcon("open.png"))
+ self.submoduleUrlButton.setIcon(UI.PixmapCache.getIcon("open.png"))
+ self.submoduleUrlClearHistoryButton.setIcon(
+ UI.PixmapCache.getIcon("editDelete.png"))
+
+ submoduleUrlHistory = self.__vcs.getPlugin().getPreferences(
+ "RepositoryUrlHistory")
+ self.submoduleUrlCombo.addItems(submoduleUrlHistory)
+ self.submoduleUrlCombo.setEditText("")
+
+ self.submoduleUrlDirCompleter = E5DirCompleter(self.submoduleUrlCombo)
+ self.submoduleDirCompleter = E5DirCompleter(self.submoduleDirEdit)
+
+ ipath = Preferences.getMultiProject("Workspace") or \
+ Utilities.getHomeDir()
+ self.__initPaths = [
+ Utilities.fromNativeSeparators(ipath),
+ Utilities.fromNativeSeparators(ipath) + "/",
+ ]
+
+ self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(False)
+
+ msh = self.minimumSizeHint()
+ self.resize(max(self.width(), msh.width()), msh.height())
+
+ @pyqtSlot(str)
+ def on_submoduleUrlCombo_editTextChanged(self, txt):
+ """
+ Private slot to handle changes of the submodule repository URL.
+
+ @param txt current text of the combo box
+ @type str
+ """
+ url = QUrl.fromUserInput(txt)
+ enable = url.isValid() and url.scheme() in ConfigGitSchemes
+ self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(enable)
+
+ self.submoduleUrlButton.setEnabled(url.scheme() == "file" or
+ len(txt) == 0)
+
+ @pyqtSlot()
+ def on_submoduleUrlButton_clicked(self):
+ """
+ Private slot to display a directory selection dialog.
+ """
+ directory = E5FileDialog.getExistingDirectory(
+ self,
+ self.tr("Select Submodule Repository Directory"),
+ self.submoduleUrlCombo.currentText(),
+ E5FileDialog.Options(E5FileDialog.ShowDirsOnly))
+
+ if directory:
+ self.submoduleUrlCombo.setEditText(
+ Utilities.toNativeSeparators(directory))
+
+ @pyqtSlot()
+ def on_submoduleUrlClearHistoryButton_clicked(self):
+ """
+ Private slot to clear the history of entered repository URLs.
+ """
+ currentUrl = self.submoduleUrlCombo.currentText()
+ self.submoduleUrlCombo.clear()
+ self.submoduleUrlCombo.setEditText(currentUrl)
+
+ self.__saveHistory()
+
+ @pyqtSlot()
+ def on_submoduleDirButton_clicked(self):
+ """
+ Private slot to display a directory selection dialog.
+ """
+ directory = E5FileDialog.getExistingDirectory(
+ self,
+ self.tr("Select Submodule Directory"),
+ self.submoduleDirEdit.text(),
+ E5FileDialog.Options(E5FileDialog.ShowDirsOnly))
+
+ if directory:
+ self.submoduleDirEdit.setText(
+ Utilities.toNativeSeparators(directory))
+
+ def getData(self):
+ """
+ Public method to get the entered data.
+
+ @return tuple containing the repository URL, optional branch name,
+ optional logical name, optional submodule path and a flag
+ indicating to enforce the operation
+ @rtype tuple of (str, str, str, str, bool)
+ """
+ self.__saveHistory()
+
+ url = QUrl.fromUserInput(
+ self.submoduleUrlCombo.currentText().replace("\\", "/"))
+ path = self.submoduleDirEdit.text()
+ if path:
+ path = self.__getRelativePath(path)
+
+ return (
+ url.toString(QUrl.None_),
+ self.branchEdit.text(),
+ self.nameEdit.text(),
+ path,
+ self.forceCheckBox.isChecked(),
+ )
+
+ def __saveHistory(self):
+ """
+ Private method to save the repository URL history.
+ """
+ url = self.submoduleUrlCombo.currentText()
+ submoduleUrlHistory = []
+ for index in range(self.submoduleUrlCombo.count()):
+ submoduleUrlHistory.append(self.submoduleUrlCombo.itemText(index))
+ if url not in submoduleUrlHistory:
+ submoduleUrlHistory.insert(0, url)
+
+ # max. list sizes is hard coded to 20 entries
+ newSubmoduleUrlHistory = [url for url in submoduleUrlHistory if url]
+ if len(newSubmoduleUrlHistory) > 20:
+ newSubmoduleUrlHistory = newSubmoduleUrlHistory[:20]
+
+ self.__vcs.getPlugin().setPreferences(
+ "RepositoryUrlHistory", newSubmoduleUrlHistory)
+
+ def __getRelativePath(self, path):
+ """
+ Private method to convert a file path to a relative path.
+
+ @param path file or directory name to convert
+ @type str
+ @return relative path or unchanged path, if path doesn't
+ belong to the project
+ @rtype str
+ """
+ if path == self.__repodir:
+ return ""
+ elif Utilities.normcasepath(Utilities.toNativeSeparators(path))\
+ .startswith(Utilities.normcasepath(
+ Utilities.toNativeSeparators(self.__repodir + "/"))):
+ relpath = path[len(self.__repodir):]
+ if relpath.startswith(("/", "\\")):
+ relpath = relpath[1:]
+ return relpath
+ else:
+ return path
