src/gui/fspathedit.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2016 Eugene Shalygin
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #include "fspathedit.h"
  30
  31 #include <memory>
  32 #include <stdexcept>
  33
  34 #include <QAction>
  35 #include <QApplication>
  36 #include <QCoreApplication>
  37 #include <QFileDialog>
  38 #include <QHBoxLayout>
  39 #include <QStyle>
  40 #include <QToolButton>
  41
  42 #include "base/utils/fs.h"
  43 #include "fspathedit_p.h"
  44
  45 namespace
  46 {
  47     struct TrStringWithComment
  48     {
  49         const char *source = nullptr;
  50         const char *comment = nullptr;
  51
  52         QString tr() const
  53         {
  54             return QCoreApplication::translate("FileSystemPathEdit", source, comment);
  55         }
  56     };
  57
  58     constexpr TrStringWithComment browseButtonBriefText =
  59         QT_TRANSLATE_NOOP3("FileSystemPathEdit", "...", "Launch file dialog button text (brief)");
  60     constexpr TrStringWithComment browseButtonFullText =
  61         QT_TRANSLATE_NOOP3("FileSystemPathEdit", "&Browse...", "Launch file dialog button text (full)");
  62     constexpr TrStringWithComment defaultDialogCaptionForFile =
  63         QT_TRANSLATE_NOOP3("FileSystemPathEdit", "Choose a file", "Caption for file open/save dialog");
  64     constexpr TrStringWithComment defaultDialogCaptionForDirectory =
  65         QT_TRANSLATE_NOOP3("FileSystemPathEdit", "Choose a folder", "Caption for directory open dialog");
  66 }
  67
  68 class FileSystemPathEdit::FileSystemPathEditPrivate
  69 {
  70     Q_DECLARE_PUBLIC(FileSystemPathEdit)
  71     Q_DISABLE_COPY_MOVE(FileSystemPathEditPrivate)
  72
  73 private:
  74     FileSystemPathEditPrivate(FileSystemPathEdit *q, Private::IFileEditorWithCompletion *editor);
  75
  76     void modeChanged();
  77     void browseActionTriggered();
  78     QString dialogCaptionOrDefault() const;
  79
  80     FileSystemPathEdit *q_ptr = nullptr;
  81     std::unique_ptr<Private::IFileEditorWithCompletion> m_editor;
  82     QAction *m_browseAction = nullptr;
  83     QToolButton *m_browseBtn = nullptr;
  84     QString m_fileNameFilter;
  85     Mode m_mode = FileSystemPathEdit::Mode::FileOpen;
  86     Path m_lastSignaledPath;
  87     QString m_dialogCaption;
  88     Private::FileSystemPathValidator *m_validator = nullptr;
  89 };
  90
  91 FileSystemPathEdit::FileSystemPathEditPrivate::FileSystemPathEditPrivate(
  92                         FileSystemPathEdit *q, Private::IFileEditorWithCompletion *editor)
  93     : q_ptr {q}
  94     , m_editor {editor}
  95     , m_browseAction {new QAction(QApplication::style()->standardIcon(QStyle::SP_DirOpenIcon), browseButtonFullText.tr(), q)}
  96     , m_browseBtn {new QToolButton(q)}
  97     , m_fileNameFilter {tr("Any file") + u" (*)"}
  98     , m_validator {new Private::FileSystemPathValidator(q)}
  99 {
 100     m_browseAction->setIconText(browseButtonBriefText.tr());
 101     m_browseAction->setShortcut(Qt::CTRL | Qt::Key_B);
 102     m_browseAction->setToolTip(browseButtonFullText.tr().remove(u'&'));
 103
 104     m_browseBtn->setDefaultAction(m_browseAction);
 105
 106     m_validator->setStrictMode(false);
 107
 108     m_editor->setBrowseAction(m_browseAction);
 109     m_editor->setValidator(m_validator);
 110
 111     modeChanged();
 112 }
 113
 114 void FileSystemPathEdit::FileSystemPathEditPrivate::browseActionTriggered()
 115 {
 116     Q_Q(FileSystemPathEdit);
 117
 118     const Path currentDirectory = (m_mode == FileSystemPathEdit::Mode::DirectoryOpen) || (m_mode == FileSystemPathEdit::Mode::DirectorySave)
 119             ? q->selectedPath()
 120             : q->selectedPath().parentPath();
 121     const Path initialDirectory = currentDirectory.isAbsolute() ? currentDirectory : (Utils::Fs::homePath() / currentDirectory);
 122
 123     QString filter = q->fileNameFilter();
 124     QString newPath;
 125     switch (m_mode)
 126     {
 127     case FileSystemPathEdit::Mode::FileOpen:
 128         newPath = QFileDialog::getOpenFileName(q, dialogCaptionOrDefault(), initialDirectory.data(), filter);
 129         break;
 130     case FileSystemPathEdit::Mode::FileSave:
 131         newPath = QFileDialog::getSaveFileName(q, dialogCaptionOrDefault(), initialDirectory.data(), filter, &filter);
 132         break;
 133     case FileSystemPathEdit::Mode::DirectoryOpen:
 134     case FileSystemPathEdit::Mode::DirectorySave:
 135         newPath = QFileDialog::getExistingDirectory(q, dialogCaptionOrDefault(),
 136                                 initialDirectory.data(), QFileDialog::ShowDirsOnly);
 137         break;
 138     case FileSystemPathEdit::Mode::ReadOnly:
 139         throw std::logic_error("Not supported");
 140     default:
 141         throw std::logic_error("Unknown FileSystemPathEdit mode");
 142     }
 143
 144     if (!newPath.isEmpty())
 145         q->setSelectedPath(Path(newPath));
 146 }
 147
 148 QString FileSystemPathEdit::FileSystemPathEditPrivate::dialogCaptionOrDefault() const
 149 {
 150     if (!m_dialogCaption.isEmpty())
 151         return m_dialogCaption;
 152
 153     switch (m_mode)
 154     {
 155     case FileSystemPathEdit::Mode::FileOpen:
 156     case FileSystemPathEdit::Mode::FileSave:
 157         return defaultDialogCaptionForFile.tr();
 158     case FileSystemPathEdit::Mode::DirectoryOpen:
 159     case FileSystemPathEdit::Mode::DirectorySave:
 160         return defaultDialogCaptionForDirectory.tr();
 161     case FileSystemPathEdit::Mode::ReadOnly:
 162         throw std::logic_error("Not supported");
 163     default:
 164         throw std::logic_error("Unknown FileSystemPathEdit mode");
 165     }
 166 }
 167
 168 void FileSystemPathEdit::FileSystemPathEditPrivate::modeChanged()
 169 {
 170     m_browseBtn->setVisible(m_mode != FileSystemPathEdit::Mode::ReadOnly);
 171     m_editor->completeDirectoriesOnly((m_mode == FileSystemPathEdit::Mode::DirectoryOpen) || (m_mode == FileSystemPathEdit::Mode::DirectorySave));
 172
 173     m_validator->setExistingOnly((m_mode == FileSystemPathEdit::Mode::FileOpen) || (m_mode == FileSystemPathEdit::Mode::DirectoryOpen) || (m_mode == FileSystemPathEdit::Mode::ReadOnly));
 174     m_validator->setFilesOnly((m_mode == FileSystemPathEdit::Mode::FileOpen) || (m_mode == FileSystemPathEdit::Mode::FileSave));
 175     m_validator->setDirectoriesOnly((m_mode == FileSystemPathEdit::Mode::DirectoryOpen) || (m_mode == FileSystemPathEdit::Mode::DirectorySave));
 176     m_validator->setCheckReadPermission((m_mode == FileSystemPathEdit::Mode::FileOpen) || (m_mode == FileSystemPathEdit::Mode::DirectoryOpen) || (m_mode == FileSystemPathEdit::Mode::ReadOnly));
 177     m_validator->setCheckWritePermission((m_mode == FileSystemPathEdit::Mode::FileSave) || (m_mode == FileSystemPathEdit::Mode::DirectorySave));
 178 }
 179
 180 FileSystemPathEdit::FileSystemPathEdit(Private::IFileEditorWithCompletion *editor, QWidget *parent)
 181     : QWidget(parent)
 182     , d_ptr(new FileSystemPathEditPrivate(this, editor))
 183 {
 184     Q_D(FileSystemPathEdit);
 185     editor->widget()->setParent(this);
 186
 187     setFocusProxy(editor->widget());
 188     // required, otherwise the button cannot be selected via keyboard tab
 189     setTabOrder(editor->widget(), d_ptr->m_browseBtn);
 190
 191     auto *layout = new QHBoxLayout(this);
 192     layout->setContentsMargins(0, 0, 0, 0);
 193     layout->addWidget(editor->widget());
 194     layout->addWidget(d->m_browseBtn);
 195
 196     connect(d->m_browseAction, &QAction::triggered, this, [this]() { this->d_func()->browseActionTriggered(); });
 197 }
 198
 199 FileSystemPathEdit::~FileSystemPathEdit()
 200 {
 201     delete d_ptr;
 202 }
 203
 204 Path FileSystemPathEdit::selectedPath() const
 205 {
 206     return Path(editWidgetText());
 207 }
 208
 209 void FileSystemPathEdit::setSelectedPath(const Path &val)
 210 {
 211     Q_D(FileSystemPathEdit);
 212
 213     const QString nativePath = val.toString();
 214     setEditWidgetText(nativePath);
 215     d->m_editor->widget()->setToolTip(nativePath);
 216 }
 217
 218 QString FileSystemPathEdit::fileNameFilter() const
 219 {
 220     Q_D(const FileSystemPathEdit);
 221     return d->m_fileNameFilter;
 222 }
 223
 224 void FileSystemPathEdit::setFileNameFilter(const QString &val)
 225 {
 226     Q_D(FileSystemPathEdit);
 227     d->m_fileNameFilter = val;
 228
 229 #if 0
 230     // QFileSystemModel applies name filters to directories too.
 231     // To use the filters we have to subclass QFileSystemModel and skip directories while filtering
 232     // extract file masks
 233     const int openBracePos = val.indexOf(u'(');
 234     const int closeBracePos = val.indexOf(u')', (openBracePos + 1));
 235     if ((openBracePos > 0) && (closeBracePos > 0) && (closeBracePos > openBracePos + 2))
 236     {
 237         QString filterString = val.mid(openBracePos + 1, closeBracePos - openBracePos - 1);
 238         if (filterString == u"*")
 239         {        // no filters
 240             d->m_editor->setFilenameFilters({});
 241         }
 242         else
 243         {
 244             QStringList filters = filterString.split(u' ', Qt::SkipEmptyParts);
 245             d->m_editor->setFilenameFilters(filters);
 246         }
 247     }
 248     else
 249     {
 250         d->m_editor->setFilenameFilters({});
 251     }
 252 #endif
 253 }
 254
 255 Path FileSystemPathEdit::placeholder() const
 256 {
 257     Q_D(const FileSystemPathEdit);
 258     return d->m_editor->placeholder();
 259 }
 260
 261 void FileSystemPathEdit::setPlaceholder(const Path &val)
 262 {
 263     Q_D(FileSystemPathEdit);
 264     d->m_editor->setPlaceholder(val);
 265 }
 266
 267 bool FileSystemPathEdit::briefBrowseButtonCaption() const
 268 {
 269     Q_D(const FileSystemPathEdit);
 270     return d->m_browseBtn->text() == browseButtonBriefText.tr();
 271 }
 272
 273 void FileSystemPathEdit::setBriefBrowseButtonCaption(bool brief)
 274 {
 275     Q_D(FileSystemPathEdit);
 276     d->m_browseBtn->setText(brief ? browseButtonBriefText.tr() : browseButtonFullText.tr());
 277 }
 278
 279 void FileSystemPathEdit::onPathEdited()
 280 {
 281     Q_D(FileSystemPathEdit);
 282
 283     const Path newPath = selectedPath();
 284     if (newPath != d->m_lastSignaledPath)
 285     {
 286         emit selectedPathChanged(newPath);
 287         d->m_lastSignaledPath = newPath;
 288         d->m_editor->widget()->setToolTip(editWidgetText());
 289     }
 290 }
 291
 292 FileSystemPathEdit::Mode FileSystemPathEdit::mode() const
 293 {
 294     Q_D(const FileSystemPathEdit);
 295     return d->m_mode;
 296 }
 297
 298 void FileSystemPathEdit::setMode(const Mode mode)
 299 {
 300     Q_D(FileSystemPathEdit);
 301     d->m_mode = mode;
 302     d->modeChanged();
 303 }
 304
 305 QString FileSystemPathEdit::dialogCaption() const
 306 {
 307     Q_D(const FileSystemPathEdit);
 308     return d->m_dialogCaption;
 309 }
 310
 311 void FileSystemPathEdit::setDialogCaption(const QString &caption)
 312 {
 313     Q_D(FileSystemPathEdit);
 314     d->m_dialogCaption = caption;
 315 }
 316
 317 QWidget *FileSystemPathEdit::editWidgetImpl() const
 318 {
 319     Q_D(const FileSystemPathEdit);
 320     return d->m_editor->widget();
 321 }
 322
 323 // ------------------------- FileSystemPathLineEdit ----------------------
 324 FileSystemPathLineEdit::FileSystemPathLineEdit(QWidget *parent)
 325     : FileSystemPathEdit(new WidgetType(), parent)
 326 {
 327     connect(editWidget<WidgetType>(), &QLineEdit::editingFinished, this, &FileSystemPathLineEdit::onPathEdited);
 328     connect(editWidget<WidgetType>(), &QLineEdit::textChanged, this, &FileSystemPathLineEdit::onPathEdited);
 329 }
 330
 331 QString FileSystemPathLineEdit::editWidgetText() const
 332 {
 333     return editWidget<WidgetType>()->text();
 334 }
 335
 336 void FileSystemPathLineEdit::clear()
 337 {
 338     editWidget<WidgetType>()->clear();
 339 }
 340
 341 void FileSystemPathLineEdit::setEditWidgetText(const QString &text)
 342 {
 343     editWidget<WidgetType>()->setText(text);
 344 }
 345
 346 // ----------------------- FileSystemPathComboEdit -----------------------
 347 FileSystemPathComboEdit::FileSystemPathComboEdit(QWidget *parent)
 348     : FileSystemPathEdit(new WidgetType(), parent)
 349 {
 350     editWidget<WidgetType>()->setEditable(true);
 351     connect(editWidget<WidgetType>(), &QComboBox::currentTextChanged, this, &FileSystemPathComboEdit::onPathEdited);
 352     connect(editWidget<WidgetType>()->lineEdit(), &QLineEdit::editingFinished, this, &FileSystemPathComboEdit::onPathEdited);
 353 }
 354
 355 void FileSystemPathComboEdit::clear()
 356 {
 357     editWidget<WidgetType>()->clear();
 358 }
 359
 360 int FileSystemPathComboEdit::count() const
 361 {
 362     return editWidget<WidgetType>()->count();
 363 }
 364
 365 Path FileSystemPathComboEdit::item(int index) const
 366 {
 367     return Path(editWidget<WidgetType>()->itemText(index));
 368 }
 369
 370 void FileSystemPathComboEdit::addItem(const Path &path)
 371 {
 372     editWidget<WidgetType>()->addItem(path.toString());
 373 }
 374
 375 void FileSystemPathComboEdit::insertItem(int index, const Path &path)
 376 {
 377     editWidget<WidgetType>()->insertItem(index, path.toString());
 378 }
 379
 380 int FileSystemPathComboEdit::currentIndex() const
 381 {
 382     return editWidget<WidgetType>()->currentIndex();
 383 }
 384
 385 void FileSystemPathComboEdit::setCurrentIndex(int index)
 386 {
 387     editWidget<WidgetType>()->setCurrentIndex(index);
 388 }
 389
 390 int FileSystemPathComboEdit::maxVisibleItems() const
 391 {
 392     return editWidget<WidgetType>()->maxVisibleItems();
 393 }
 394
 395 void FileSystemPathComboEdit::setMaxVisibleItems(int maxItems)
 396 {
 397     editWidget<WidgetType>()->setMaxVisibleItems(maxItems);
 398 }
 399
 400 QString FileSystemPathComboEdit::editWidgetText() const
 401 {
 402     return editWidget<WidgetType>()->currentText();
 403 }
 404
 405 void FileSystemPathComboEdit::setEditWidgetText(const QString &text)
 406 {
 407     editWidget<WidgetType>()->setCurrentText(text);
 408 }