2 * \file GuiLyXFiles.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Jürgen Spitzmüller
8 * Full author contact details are available in file CREDITS.
13 #include "GuiLyXFiles.h"
14 #include "GuiApplication.h"
15 #include "qt_helpers.h"
17 #include "FileDialog.h"
18 #include "FuncRequest.h"
22 #include "support/environment.h"
23 #include "support/gettext.h"
24 #include "support/lstrings.h"
25 #include "support/Messages.h"
26 #include "support/qstring_helpers.h"
27 #include "support/Package.h"
30 #include <QDirIterator>
31 #include <QTreeWidget>
34 using namespace lyx::support;
41 QString const guiString(QString const & in)
43 // recode specially encoded chars in file names (URL encoding and underbar)
44 return QString::fromUtf8(QByteArray::fromPercentEncoding(in.toUtf8())).replace('_', ' ');
50 QMap<QString, QString> GuiLyXFiles::getFiles()
52 QMap<QString, QString> result;
53 // We look for lyx files in the subdirectory dir of
55 // 2) build_lyxdir (if not empty)
57 // in this order. Files with a given sub-hierarchy will
58 // only be listed once.
59 // We also consider i18n subdirectories and store them separately.
63 // The three locations to look at.
64 string const user = addPath(package().user_support().absFileName(), fromqstr(type_));
65 string const build = addPath(package().build_support().absFileName(), fromqstr(type_));
66 string const system = addPath(package().system_support().absFileName(), fromqstr(type_));
68 available_languages_.insert(toqstr("en"), qt_("English"));
70 QString const type = fileTypeCO->itemData(fileTypeCO->currentIndex()).toString();
72 // Search in the base paths
73 if (type == "all" || type == "user")
75 if (type == "all" || type == "system")
79 for (int i = 0; i < dirs.size(); ++i) {
80 QString const & dir = dirs.at(i);
81 QDirIterator it(dir, QDir::Files, QDirIterator::Subdirectories);
82 while (it.hasNext()) {
83 QString fn(QFile(it.next()).fileName());
84 if (!fn.endsWith(getSuffix()))
86 QString relpath = toqstr(makeRelPath(qstring_to_ucs4(fn),
87 qstring_to_ucs4(dir)));
89 int s = relpath.indexOf('/', 0);
90 QString cat = qt_("General");
91 QString localization = "en";
94 cat = relpath.left(s);
95 if (all_languages_.contains(cat)
96 && !all_languages_.contains(dir.right(dir.lastIndexOf('/')))) {
97 QMap<QString, QString>::const_iterator li = all_languages_.find(cat);
98 // Skip i18n dir, but add language to the combo
99 if (!available_languages_.contains(li.key()))
100 available_languages_.insert(li.key(), li.value());
102 int sc = relpath.indexOf('/', s + 1);
103 cat = (sc == -1) ? qt_("General") : relpath.mid(s + 1, sc - s - 1);
107 int sc = relpath.indexOf('/', s + 1);
108 QString const subcat = (sc == -1) ?
109 QString() : relpath.mid(s + 1, sc - s - 1);
110 if (!subcat.isEmpty())
114 if (!relpaths.contains(relpath)) {
115 relpaths.append(relpath);
116 if (localization != "en")
118 relpath = relpath.mid(relpath.indexOf('/') + 1);
119 result.insert(relpath, cat);
121 QMap<QString, QString> lm;
122 if (localizations_.contains(relpath))
123 lm = localizations_.find(relpath).value();
124 lm.insert(localization, fn);
125 localizations_.insert(relpath, lm);
129 // Find and store GUI language
130 for (auto const & l : guilangs_) {
131 // First try with the full name
132 // `en' files are not in a subdirectory
133 if (available_languages_.contains(toqstr(l))) {
134 guilang_ = toqstr(l);
137 // Then the name without country code
138 string const shortl = token(l, '_', 0);
139 if (available_languages_.contains(toqstr(shortl))) {
140 guilang_ = toqstr(shortl);
144 // pre-fill the language combo (it will be updated once an item
147 QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
148 while (i != available_languages_.constEnd()) {
149 languageCO->addItem(i.value(), i.key());
157 GuiLyXFiles::GuiLyXFiles(GuiView & lv)
158 : GuiDialog(lv, "lyxfiles", qt_("New File From Template"))
162 // Get all supported languages (by code) in order to exclude those
164 QAbstractItemModel * language_model = guiApp->languageModel();
165 language_model->sort(0);
166 for (int i = 0; i != language_model->rowCount(); ++i) {
167 QModelIndex index = language_model->index(i, 0);
168 Language const * lang =
169 languages.getLanguage(fromqstr(index.data(Qt::UserRole).toString()));
172 QString const code = toqstr(lang->code());
173 if (!all_languages_.contains(code))
174 all_languages_.insert(code, qt_(lang->display()));
175 // Also store code without country code
176 QString const shortcode = code.left(code.indexOf('_'));
177 if (shortcode != code && !all_languages_.contains(shortcode))
178 all_languages_.insert(shortcode, qt_(lang->display()));
181 string lang = getGuiMessages().language();
182 string const language = getEnv("LANGUAGE");
183 if (!language.empty())
184 lang += ":" + language;
185 guilangs_ = getVectorFromString(lang, ":");
188 filter_ = new FancyLineEdit(this);
189 filter_->setClearButton(true);
190 filter_->setPlaceholderText(qt_("All available files"));
191 filter_->setToolTip(qt_("Enter string to filter the list of available files"));
192 connect(filter_, &FancyLineEdit::downPressed,
193 filesLW, [this](){ focusAndHighlight(filesLW); });
195 filterBarL->addWidget(filter_, 0);
196 findKeysLA->setBuddy(filter_);
198 connect(buttonBox, SIGNAL(clicked(QAbstractButton *)),
199 this, SLOT(slotButtonBox(QAbstractButton *)));
201 connect(filesLW, SIGNAL(itemClicked(QTreeWidgetItem *, int)),
202 this, SLOT(fileSelectionChanged()));
203 connect(filesLW, SIGNAL(itemSelectionChanged()),
204 this, SLOT(fileSelectionChanged()));
205 connect(filter_, SIGNAL(textEdited(QString)),
206 this, SLOT(filterLabels()));
207 connect(filter_, SIGNAL(rightButtonClicked()),
208 this, SLOT(resetFilter()));
210 bc().setPolicy(ButtonPolicy::OkApplyCancelPolicy);
211 bc().setOK(buttonBox->button(QDialogButtonBox::Open));
212 bc().setCancel(buttonBox->button(QDialogButtonBox::Cancel));
214 //filesLW->setViewMode(QListView::ListMode);
215 filesLW->setIconSize(QSize(22, 22));
217 QIcon user_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-user")
218 : getPixmap("images/", "lyxfiles-user", "svgz,png"));
219 QIcon system_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-system")
220 : getPixmap("images/", "lyxfiles-system", "svgz,png"));
221 fileTypeCO->addItem(qt_("User and System Files"), toqstr("all"));
222 fileTypeCO->addItem(user_icon, qt_("User Files Only"), toqstr("user"));
223 fileTypeCO->addItem(system_icon, qt_("System Files Only"), toqstr("system"));
225 setFocusProxy(filter_);
229 QString const GuiLyXFiles::getSuffix()
231 if (type_ == "bind" || type_ == "ui")
232 return toqstr(".") + type_;
233 else if (type_ == "kbd")
240 bool GuiLyXFiles::translateName() const
242 return (type_ == "templates" || type_ == "examples");
246 void GuiLyXFiles::fileSelectionChanged()
248 if (!filesLW->currentItem()
249 || !filesLW->currentItem()->data(0, Qt::UserRole).toString().endsWith(getSuffix())) {
250 // not a file (probably a header)
251 bc().setValid(false);
258 void GuiLyXFiles::on_fileTypeCO_activated(int)
264 void GuiLyXFiles::on_languageCO_activated(int i)
266 savelang_ = languageCO->itemData(i).toString();
267 if (!filesLW->currentItem())
270 filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
275 void GuiLyXFiles::on_filesLW_itemDoubleClicked(QTreeWidgetItem * item, int)
277 if (!item || !item->data(0, Qt::UserRole).toString().endsWith(getSuffix())) {
278 // not a file (probably a header)
279 bc().setValid(false);
288 void GuiLyXFiles::on_filesLW_itemClicked(QTreeWidgetItem * item, int)
291 bc().setValid(false);
295 QString const data = item->data(0, Qt::UserRole).toString();
296 if (!data.endsWith(getSuffix())) {
297 // not a file (probably a header)
298 bc().setValid(false);
303 QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
304 while (i != available_languages_.constEnd()) {
305 if (localizations_.contains(data)
306 && localizations_.find(data).value().contains(i.key()))
307 languageCO->addItem(i.value(), i.key());
311 QString const realpath = getRealPath();
312 filesLW->currentItem()->setData(0, Qt::ToolTipRole, realpath);
313 QIcon user_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-user")
314 : getPixmap("images/", "lyxfiles-user", "svgz,png"));
315 QIcon system_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-system")
316 : getPixmap("images/", "lyxfiles-system", "svgz,png"));
317 QIcon file_icon = (realpath.startsWith(toqstr(package().user_support().absFileName()))) ?
318 user_icon : system_icon;
319 item->setIcon(0, file_icon);
323 void GuiLyXFiles::setLanguage()
325 // Enable language selection only if there is a selection.
326 bool const item_selected = filesLW->currentItem();
327 bool const language_alternatives = languageCO->count() > 1;
328 languageCO->setEnabled(item_selected && language_alternatives);
329 languageLA->setEnabled(item_selected && language_alternatives);
330 if (item_selected && language_alternatives)
331 languageCO->setToolTip(qt_("All available languages of the selected file are displayed here.\n"
332 "The selected language version will be opened."));
333 else if (item_selected)
334 languageCO->setToolTip(qt_("No alternative language versions available for the selected file."));
336 languageCO->setToolTip(qt_("If alternative languages are available for a given file,\n"
337 "they can be chosen here if a file is selected."));
338 // first try last setting
339 if (!savelang_.isEmpty()) {
340 int index = languageCO->findData(savelang_);
342 languageCO->setCurrentIndex(index);
346 // next, try GUI lang
347 if (!guilang_.isEmpty()) {
348 int index = languageCO->findData(guilang_);
350 languageCO->setCurrentIndex(index);
354 // Finally, fall back to English (which should be always there)
355 int index = languageCO->findData(toqstr("en"));
357 languageCO->setCurrentIndex(index);
362 void GuiLyXFiles::on_browsePB_pressed()
364 QString path1 = toqstr(lyxrc.document_path);
365 QString path2 = toqstr(lyxrc.example_path);
366 QString title = qt_("Select example file");
367 QString filter = qt_("LyX Documents (*.lyx)");
368 QString b1 = qt_("D&ocuments");
369 QString b2 = qt_("&Examples");
371 if (type_ == "templates") {
372 path2 = toqstr(lyxrc.template_path);
373 title = qt_("Select template file");
374 b1 = qt_("D&ocuments");
375 b2 = qt_("&Templates");
377 else if (type_ != "examples") {
378 path1 = toqstr(addName(package().user_support().absFileName(), fromqstr(type_)));
379 path2 = toqstr(addName(package().system_support().absFileName(), fromqstr(type_)));
380 b1 = qt_("&User files");
381 b2 = qt_("&System files");
384 title = qt_("Chose UI file");
385 filter = qt_("LyX UI Files (*.ui)");
387 if (type_ == "bind") {
388 title = qt_("Chose bind file");
389 filter = qt_("LyX Bind Files (*.bind)");
391 if (type_ == "kbd") {
392 title = qt_("Chose keyboard map");
393 filter = qt_("LyX Keymap Files (*.kmap)");
396 FileDialog dlg(title);
397 dlg.setButton1(b1, path1);
398 dlg.setButton2(b2, path2);
400 FileDialog::Result result = dlg.open(path2, QStringList(filter));
402 if (result.first != FileDialog::Later && !result.second.isEmpty()) {
403 file_ = toqstr(FileName(fromqstr(result.second)).absFileName());
410 void GuiLyXFiles::updateContents()
413 QMap<QString, QString> files = getFiles();
414 languageCO->model()->sort(0);
418 QIcon user_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-user")
419 : getPixmap("images/", "lyxfiles-user", "svgz,png"));
420 QIcon system_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-system")
421 : getPixmap("images/", "lyxfiles-system", "svgz,png"));
422 QIcon user_folder_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-user-folder")
423 : getPixmap("images/", "lyxfiles-user-folder", "svgz,png"));
424 QIcon system_folder_icon(guiApp ? guiApp->getScaledPixmap("images/", "lyxfiles-system-folder")
425 : getPixmap("images/", "lyxfiles-system-folder", "svgz,png"));
428 QMap<QString, QString>::const_iterator it = files.constBegin();
430 capfont.setBold(true);
431 while (it != files.constEnd()) {
432 QFileInfo const info = QFileInfo(it.key());
433 QString const realpath = getRealPath(it.key());
434 QString cat = it.value();
437 if (cat.contains('/')) {
439 cat = catsave.left(catsave.indexOf('/'));
440 subcat = toqstr(translateIfPossible(
441 qstring_to_ucs4(guiString(catsave.mid(catsave.indexOf('/') + 1)))));
443 cat = toqstr(translateIfPossible(qstring_to_ucs4(guiString(cat))));
444 QTreeWidgetItem * catItem;
445 if (!cats.contains(cat)) {
446 catItem = new QTreeWidgetItem();
447 catItem->setText(0, cat);
448 catItem->setFont(0, capfont);
449 filesLW->insertTopLevelItem(0, catItem);
450 catItem->setExpanded(true);
453 catItem = filesLW->findItems(cat, Qt::MatchExactly).first();
454 QTreeWidgetItem * item = new QTreeWidgetItem();
455 QString const filename = info.fileName();
456 QString guiname = filename.left(filename.lastIndexOf(getSuffix())).replace('_', ' ');
457 // Special case: defaults.lyx
458 if (type_ == "templates" && guiname == "defaults")
459 guiname = qt_("Default Template");
460 else if (translateName())
461 guiname = toqstr(translateIfPossible(qstring_to_ucs4(guiString(guiname))));
462 bool const user = realpath.startsWith(toqstr(package().user_support().absFileName()));
463 QIcon file_icon = user ? user_icon : system_icon;
464 item->setIcon(0, file_icon);
465 item->setData(0, Qt::UserRole, it.key());
466 item->setData(0, Qt::DisplayRole, guiname);
467 item->setData(0, Qt::ToolTipRole, realpath);
468 if (subcat.isEmpty())
469 catItem->addChild(item);
471 QTreeWidgetItem * subcatItem = nullptr;
472 if (cats.contains(catsave)) {
473 QList<QTreeWidgetItem *> pcats = filesLW->findItems(cat, Qt::MatchExactly);
474 for (auto const & pcat : pcats) {
475 for (int cit = 0; cit < pcat->childCount(); ++cit) {
476 if (pcat->child(cit)->text(0) == subcat) {
477 subcatItem = pcat->child(cit);
484 subcatItem = new QTreeWidgetItem();
485 subcatItem->setText(0, subcat);
486 file_icon = user ? user_folder_icon : system_folder_icon;
487 subcatItem->setIcon(0, file_icon);
490 subcatItem->addChild(item);
491 catItem->addChild(subcatItem);
495 filesLW->sortItems(0, Qt::AscendingOrder);
501 void GuiLyXFiles::slotButtonBox(QAbstractButton * button)
503 switch (buttonBox->standardButton(button)) {
504 case QDialogButtonBox::Open:
507 case QDialogButtonBox::Cancel:
516 void GuiLyXFiles::filterLabels()
518 Qt::CaseSensitivity cs = csFindCB->isChecked() ?
519 Qt::CaseSensitive : Qt::CaseInsensitive;
520 // Collect "active" categories (containing entries
521 // that match the filter)
522 QVector<QTreeWidgetItem*> activeCats;
523 QTreeWidgetItemIterator it(filesLW);
525 if ((*it)->childCount() > 0) {
526 // Unhide parents (will be hidden
527 // below if necessary)
528 (*it)->setHidden(false);
532 bool const match = (*it)->text(0).contains(filter_->text(), cs);
534 // Register parents of matched entries
535 // so we don't hide those later.
536 QTreeWidgetItem * twi = *it;
540 activeCats << twi->parent();
541 // ascend further up if possible
545 (*it)->setHidden(!match);
548 // Iterate through parents once more
549 // to hide empty categories
550 it = QTreeWidgetItemIterator(filesLW);
552 if ((*it)->childCount() == 0) {
556 (*it)->setHidden(!activeCats.contains(*it));
562 void GuiLyXFiles::resetFilter()
564 filter_->setText(QString());
568 QString const GuiLyXFiles::getRealPath(QString relpath)
570 if (relpath.isEmpty() && filesLW->currentItem() != nullptr)
571 relpath = filesLW->currentItem()->data(0, Qt::UserRole).toString();
572 QString const language = languageCO->itemData(languageCO->currentIndex()).toString();
573 if (localizations_.contains(relpath)) {
574 if (localizations_.find(relpath).value().contains(language))
575 return localizations_.find(relpath).value().find(language).value();
576 else if (localizations_.find(relpath).value().contains(guilang_))
577 return localizations_.find(relpath).value().find(guilang_).value();
578 else if (localizations_.find(relpath).value().contains(toqstr("en")))
579 return localizations_.find(relpath).value().find(toqstr("en")).value();
585 void GuiLyXFiles::applyView()
587 file_ = getRealPath();
591 bool GuiLyXFiles::isValid()
593 return filesLW->currentItem() && filesLW->currentItem()->isSelected();
597 bool GuiLyXFiles::initialiseParams(string const & type)
599 type_ = type.empty() ? toqstr("templates") : toqstr(type);
605 void GuiLyXFiles::passParams(string const & data)
607 initialiseParams(data);
612 void GuiLyXFiles::selectItem(QString const & item)
614 /* Using an intermediary variable flags is needed up to at least
615 * Qt 5.5 because of a subtle namespace issue. See:
616 * https://stackoverflow.com/questions/10755058/qflags-enum-type-conversion-fails-all-of-a-sudden
618 Qt::MatchFlags const flags(Qt::MatchExactly|Qt::MatchRecursive);
619 QList<QTreeWidgetItem *> twi = filesLW->findItems(item, flags);
621 twi.first()->setSelected(true);
625 void GuiLyXFiles::paramsToDialog()
627 if (type_ == "examples")
628 setTitle(qt_("Open Example File"));
629 else if (type_ == "templates")
630 setTitle(qt_("New File From Template"));
632 setTitle(qt_("Open File"));
634 bc().setValid(isValid());
638 void GuiLyXFiles::dispatchParams()
644 if (type_ == "templates")
646 arg += quoteName(fromqstr(file_));
647 FuncCode const lfun = getLfun();
649 if (lfun == LFUN_NOACTION)
653 dispatch(FuncRequest(lfun, arg));
657 FuncCode GuiLyXFiles::getLfun() const
659 if (type_ == "examples")
660 return LFUN_FILE_OPEN;
661 else if (type_ == "templates")
662 return LFUN_BUFFER_NEW_TEMPLATE;
663 return LFUN_NOACTION;
667 } // namespace frontend
670 #include "moc_GuiLyXFiles.cpp"