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"
19 #include "BufferParams.h"
20 #include "FuncRequest.h"
24 #include "support/environment.h"
25 #include "support/filetools.h"
26 #include "support/gettext.h"
27 #include "support/lstrings.h"
28 #include "support/Messages.h"
29 #include "support/qstring_helpers.h"
30 #include "support/Package.h"
32 #include <QDirIterator>
33 #include <QTreeWidget>
36 using namespace lyx::support;
43 QString const guiString(QString in)
45 // recode specially encoded chars in file names
46 return in.replace('_', ' ').replace("%26", "&").replace("%28", "(").replace("%29", ")");
52 QMap<QString, QString> GuiLyXFiles::getFiles()
54 QMap<QString, QString> result;
55 // We look for lyx files in the subdirectory dir of
57 // 2) build_lyxdir (if not empty)
59 // in this order. Files with a given sub-hierarchy will
60 // only be listed once.
61 // We also consider i18n subdirectories and store them separately.
65 // The three locations to look at.
66 string const user = addPath(package().user_support().absFileName(), fromqstr(type_));
67 string const build = addPath(package().build_support().absFileName(), fromqstr(type_));
68 string const system = addPath(package().system_support().absFileName(), fromqstr(type_));
70 available_languages_.insert(toqstr("en"), qt_("English"));
72 QString const type = fileTypeCO->itemData(fileTypeCO->currentIndex()).toString();
74 // Search in the base paths
75 if (type == "all" || type == "user")
77 if (type == "all" || type == "system")
81 for (int i = 0; i < dirs.size(); ++i) {
82 QString const dir = dirs.at(i);
83 QDirIterator it(dir, QDir::Files, QDirIterator::Subdirectories);
84 while (it.hasNext()) {
85 QString fn(QFile(it.next()).fileName());
86 if (!fn.endsWith(getSuffix()))
88 QString relpath = toqstr(makeRelPath(qstring_to_ucs4(fn),
89 qstring_to_ucs4(dir)));
91 int s = relpath.indexOf('/', 0);
92 QString cat = qt_("General");
93 QString localization = "en";
96 cat = relpath.left(s);
97 if (all_languages_.contains(cat)
98 && !all_languages_.contains(dir.right(dir.lastIndexOf('/')))) {
99 QMap<QString, QString>::const_iterator li = all_languages_.find(cat);
100 // Skip i18n dir, but add language to the combo
101 if (!available_languages_.contains(li.key()))
102 available_languages_.insert(li.key(), li.value());
104 int sc = relpath.indexOf('/', s + 1);
105 cat = (sc == -1) ? qt_("General") : relpath.mid(s + 1, sc - s - 1);
109 int sc = relpath.indexOf('/', s + 1);
110 QString const subcat = (sc == -1) ?
111 QString() : relpath.mid(s + 1, sc - s - 1);
112 if (!subcat.isEmpty())
116 if (!relpaths.contains(relpath)) {
117 relpaths.append(relpath);
118 if (localization != "en")
120 relpath = relpath.mid(relpath.indexOf('/') + 1);
121 result.insert(relpath, cat);
123 QMap<QString, QString> lm;
124 if (localizations_.contains(relpath))
125 lm = localizations_.find(relpath).value();
126 lm.insert(localization, fn);
127 localizations_.insert(relpath, lm);
131 // Find and store GUI language
132 for (auto const & l : guilangs_) {
133 // First try with the full name
134 // `en' files are not in a subdirectory
135 if (available_languages_.contains(toqstr(l))) {
136 guilang_ = toqstr(l);
139 // Then the name without country code
140 string const shortl = token(l, '_', 0);
141 if (available_languages_.contains(toqstr(shortl))) {
142 guilang_ = toqstr(shortl);
146 // pre-fill the language combo (it will be updated once an item
149 languageCO->addItem(qt_("English"), toqstr("en"));
150 QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
151 while (i != available_languages_.constEnd()) {
152 languageCO->addItem(i.value(), i.key());
156 languageLA->setText(qt_("Preferred &Language:"));
161 GuiLyXFiles::GuiLyXFiles(GuiView & lv)
162 : GuiDialog(lv, "lyxfiles", qt_("New File From Template"))
166 // Get all supported languages (by code) in order to exclude those
168 QAbstractItemModel * language_model = guiApp->languageModel();
169 language_model->sort(0);
170 for (int i = 0; i != language_model->rowCount(); ++i) {
171 QModelIndex index = language_model->index(i, 0);
172 Language const * lang =
173 languages.getLanguage(fromqstr(index.data(Qt::UserRole).toString()));
176 QString const code = toqstr(lang->code());
177 if (!all_languages_.contains(code))
178 all_languages_.insert(code, qt_(lang->display()));
179 // Also store code without country code
180 QString const shortcode = code.left(code.indexOf('_'));
181 if (shortcode != code && !all_languages_.contains(shortcode))
182 all_languages_.insert(shortcode, qt_(lang->display()));
185 string lang = getGuiMessages().language();
186 string const language = getEnv("LANGUAGE");
187 if (!language.empty())
188 lang += ":" + language;
189 guilangs_ = getVectorFromString(lang, ":");
192 filter_ = new FancyLineEdit(this);
193 filter_->setButtonPixmap(FancyLineEdit::Right, getPixmap("images/", "editclear", "svgz,png"));
194 filter_->setButtonVisible(FancyLineEdit::Right, true);
195 filter_->setButtonToolTip(FancyLineEdit::Right, qt_("Clear text"));
196 filter_->setAutoHideButton(FancyLineEdit::Right, true);
197 filter_->setPlaceholderText(qt_("All available files"));
198 filter_->setToolTip(qt_("Enter string to filter the list of available files"));
199 #if (QT_VERSION < 0x050000)
200 connect(filter_, SIGNAL(downPressed()),
201 filesLW, SLOT(setFocus()));
203 connect(filter_, &FancyLineEdit::downPressed,
204 filesLW, [=](){ focusAndHighlight(filesLW); });
207 filterBarL->addWidget(filter_, 0);
208 findKeysLA->setBuddy(filter_);
210 connect(buttonBox, SIGNAL(clicked(QAbstractButton *)),
211 this, SLOT(slotButtonBox(QAbstractButton *)));
213 connect(filesLW, SIGNAL(itemClicked(QTreeWidgetItem *, int)),
214 this, SLOT(changed_adaptor()));
215 connect(filesLW, SIGNAL(itemSelectionChanged()),
216 this, SLOT(changed_adaptor()));
217 connect(filter_, SIGNAL(textEdited(QString)),
218 this, SLOT(filterLabels()));
219 connect(filter_, SIGNAL(rightButtonClicked()),
220 this, SLOT(resetFilter()));
222 bc().setPolicy(ButtonPolicy::OkApplyCancelPolicy);
223 bc().setOK(buttonBox->button(QDialogButtonBox::Open));
224 bc().setCancel(buttonBox->button(QDialogButtonBox::Cancel));
226 //filesLW->setViewMode(QListView::ListMode);
227 filesLW->setIconSize(QSize(22, 22));
229 QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
230 QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
231 fileTypeCO->addItem(qt_("User and System Files"), toqstr("all"));
232 fileTypeCO->addItem(user_icon, qt_("User Files Only"), toqstr("user"));
233 fileTypeCO->addItem(system_icon, qt_("System Files Only"), toqstr("system"));
235 setFocusProxy(filter_);
239 QString const GuiLyXFiles::getSuffix()
241 if (type_ == "bind" || type_ == "ui")
242 return toqstr(".") + type_;
248 bool GuiLyXFiles::translateName() const
250 return (type_ == "templates" || type_ == "examples");
254 void GuiLyXFiles::changed_adaptor()
260 void GuiLyXFiles::on_fileTypeCO_activated(int)
266 void GuiLyXFiles::on_languageCO_activated(int i)
268 savelang_ = languageCO->itemData(i).toString();
269 if (!filesLW->currentItem())
272 filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
277 void GuiLyXFiles::on_filesLW_itemDoubleClicked(QTreeWidgetItem * item, int)
279 if (!item->data(0, Qt::UserRole).toString().endsWith(getSuffix()))
280 // not a file (probably a header)
288 void GuiLyXFiles::on_filesLW_itemClicked(QTreeWidgetItem * item, int)
290 QString const data = item->data(0, Qt::UserRole).toString();
291 if (!data.endsWith(getSuffix()))
292 // not a file (probably a header)
296 QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
297 while (i != available_languages_.constEnd()) {
298 if (localizations_.contains(data)
299 && localizations_.find(data).value().contains(i.key()))
300 languageCO->addItem(i.value(), i.key());
303 languageLA->setText(qt_("File &Language:"));
304 languageCO->setToolTip(qt_("All available languages of the selected file are displayed here.\n"
305 "The selected language version will be opened."));
307 QString const realpath = getRealPath();
308 filesLW->currentItem()->setData(0, Qt::ToolTipRole, realpath);
309 QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
310 QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
311 QIcon file_icon = (realpath.startsWith(toqstr(package().user_support().absFileName()))) ?
312 user_icon : system_icon;
313 item->setIcon(0, file_icon);
317 void GuiLyXFiles::setLanguage()
319 // first try last setting
320 if (!savelang_.isEmpty()) {
321 int index = languageCO->findData(savelang_);
323 languageCO->setCurrentIndex(index);
327 // next, try GUI lang
328 if (!guilang_.isEmpty()) {
329 int index = languageCO->findData(guilang_);
331 languageCO->setCurrentIndex(index);
335 // Finally, fall back to English (which should be always there)
336 int index = languageCO->findData(toqstr("en"));
338 languageCO->setCurrentIndex(index);
343 void GuiLyXFiles::on_browsePB_pressed()
345 bool const examples = (type_ == "examples");
346 FileDialog dlg(qt_("Select template file"));
347 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
349 dlg.setButton2(qt_("&Examples"), toqstr(lyxrc.example_path));
351 dlg.setButton2(qt_("&Templates"), toqstr(lyxrc.template_path));
353 FileDialog::Result result = dlg.open(examples ? toqstr(lyxrc.example_path)
354 : toqstr(lyxrc.template_path),
355 QStringList(qt_("LyX Documents (*.lyx)")));
357 if (result.first != FileDialog::Later && !result.second.isEmpty()) {
358 file_ = toqstr(FileName(fromqstr(result.second)).absFileName());
365 void GuiLyXFiles::updateContents()
368 QMap<QString, QString> files = getFiles();
369 languageCO->model()->sort(0);
372 QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
373 QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
375 QMap<QString, QString>::const_iterator it = files.constBegin();
377 capfont.setBold(true);
378 while (it != files.constEnd()) {
379 QFileInfo const info = QFileInfo(it.key());
380 QString const realpath = getRealPath(it.key());
381 QString cat = it.value();
384 if (cat.contains('/')) {
386 cat = catsave.left(catsave.indexOf('/'));
387 subcat = toqstr(translateIfPossible(
388 qstring_to_ucs4(guiString(catsave.mid(catsave.indexOf('/') + 1)))));
390 cat = toqstr(translateIfPossible(qstring_to_ucs4(guiString(cat))));
391 QTreeWidgetItem * catItem = new QTreeWidgetItem();
392 if (!cats.contains(cat)) {
393 catItem->setText(0, cat);
394 catItem->setFont(0, capfont);
395 filesLW->insertTopLevelItem(0, catItem);
396 catItem->setExpanded(true);
399 catItem = filesLW->findItems(cat, Qt::MatchExactly).first();
400 QTreeWidgetItem * item = new QTreeWidgetItem();
401 QString const filename = info.fileName();
402 QString guiname = filename.left(filename.lastIndexOf(getSuffix())).replace('_', ' ');
404 guiname = toqstr(translateIfPossible(qstring_to_ucs4(guiString(guiname))));
405 QIcon file_icon = (realpath.startsWith(toqstr(package().user_support().absFileName()))) ?
406 user_icon : system_icon;
407 item->setIcon(0, file_icon);
408 item->setData(0, Qt::UserRole, it.key());
409 item->setData(0, Qt::DisplayRole, guiname);
410 item->setData(0, Qt::ToolTipRole, realpath);
411 if (subcat.isEmpty())
412 catItem->addChild(item);
414 QTreeWidgetItem * subcatItem = new QTreeWidgetItem();
415 if (cats.contains(catsave)) {
416 QList<QTreeWidgetItem *> pcats = filesLW->findItems(cat, Qt::MatchExactly);
417 for (int iit = 0; iit < pcats.size(); ++iit) {
418 for (int cit = 0; cit < pcats.at(iit)->childCount(); ++cit) {
419 if (pcats.at(iit)->child(cit)->text(0) == subcat) {
420 subcatItem = pcats.at(iit)->child(cit);
426 subcatItem->setText(0, subcat);
427 subcatItem->setIcon(0, file_icon);
430 subcatItem->addChild(item);
431 catItem->addChild(subcatItem);
435 filesLW->sortItems(0, Qt::AscendingOrder);
441 void GuiLyXFiles::slotButtonBox(QAbstractButton * button)
443 switch (buttonBox->standardButton(button)) {
444 case QDialogButtonBox::Open:
447 case QDialogButtonBox::Cancel:
456 void GuiLyXFiles::filterLabels()
458 Qt::CaseSensitivity cs = csFindCB->isChecked() ?
459 Qt::CaseSensitive : Qt::CaseInsensitive;
460 QTreeWidgetItemIterator it(filesLW);
463 (*it)->childCount() == 0
464 && !(*it)->text(0).contains(filter_->text(), cs)
471 void GuiLyXFiles::resetFilter()
473 filter_->setText(QString());
477 QString const GuiLyXFiles::getRealPath(QString relpath)
479 if (relpath.isEmpty())
480 relpath = filesLW->currentItem()->data(0, Qt::UserRole).toString();
481 QString const language = languageCO->itemData(languageCO->currentIndex()).toString();
482 if (localizations_.contains(relpath)) {
483 if (localizations_.find(relpath).value().contains(language))
484 return localizations_.find(relpath).value().find(language).value();
485 else if (localizations_.find(relpath).value().contains(guilang_))
486 return localizations_.find(relpath).value().find(guilang_).value();
487 else if (localizations_.find(relpath).value().contains(toqstr("en")))
488 return localizations_.find(relpath).value().find(toqstr("en")).value();
494 void GuiLyXFiles::applyView()
496 file_ = getRealPath();
500 bool GuiLyXFiles::isValid()
502 return filesLW->currentItem() && filesLW->currentItem()->isSelected();
506 bool GuiLyXFiles::initialiseParams(string const & type)
508 type_ = type.empty() ? toqstr("templates") : toqstr(type);
514 void GuiLyXFiles::paramsToDialog()
516 if (type_ == "examples")
517 setTitle(qt_("Open Example File"));
518 else if (type_ == "templates")
519 setTitle(qt_("New File From Template"));
521 setTitle(qt_("Open File"));
523 bc().setValid(isValid());
527 void GuiLyXFiles::dispatchParams()
533 if (type_ == "templates")
535 arg += fromqstr(file_);
536 FuncCode const lfun = getLfun();
538 dispatch(FuncRequest(lfun, arg));
542 FuncCode GuiLyXFiles::getLfun() const
544 if (type_ == "examples")
545 return LFUN_FILE_OPEN;
546 else if (type_ == "templates")
547 return LFUN_BUFFER_NEW_TEMPLATE;
548 return LFUN_NOACTION;
551 Dialog * createGuiLyXFiles(GuiView & lv) { return new GuiLyXFiles(lv); }
554 } // namespace frontend
557 #include "moc_GuiLyXFiles.cpp"