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;
42 void GuiLyXFiles::getFiles(QMap<QString, QString> & in, QString const type)
44 // We look for lyx files in the subdirectory dir of
46 // 2) build_lyxdir (if not empty)
48 // in this order. Files with a given sub-hierarchy will
49 // only be listed once.
50 // We also consider i18n subdirectories and store them separately.
54 // The three locations to look at.
55 string const user = addPath(package().user_support().absFileName(), fromqstr(type));
56 string const build = addPath(package().build_support().absFileName(), fromqstr(type));
57 string const system = addPath(package().system_support().absFileName(), fromqstr(type));
59 available_languages_.insert(toqstr("en"), qt_("English"));
61 // Search in the base path
66 for (int i = 0; i < dirs.size(); ++i) {
67 QString const dir = dirs.at(i);
68 QDirIterator it(dir, QDir::Files, QDirIterator::Subdirectories);
69 while (it.hasNext()) {
70 QString fn(QFile(it.next()).fileName());
71 if (!fn.endsWith(getSuffix()))
73 QString relpath = toqstr(makeRelPath(qstring_to_ucs4(fn),
74 qstring_to_ucs4(dir)));
76 int s = relpath.indexOf('/', 0);
77 QString cat = qt_("General");
78 QString localization = "en";
81 cat = relpath.left(s);
82 int sc = relpath.indexOf('/', s + 1);
83 QString const subcat = (sc == -1) ?
84 QString() : relpath.mid(s + 1, sc - s - 1);
85 if (all_languages_.contains(cat)
86 && !all_languages_.contains(dir.right(dir.lastIndexOf('/')))) {
87 QMap<QString, QString>::const_iterator li = all_languages_.find(cat);
88 // Skip i18n dir, but add language to the combo
89 if (!available_languages_.contains(li.key()))
90 available_languages_.insert(li.key(), li.value());
93 if (!subcat.isEmpty())
96 if (!relpaths.contains(relpath)) {
97 relpaths.append(relpath);
98 if (localization == "en")
99 in.insert(relpath, cat);
102 relpath = relpath.mid(relpath.indexOf('/') + 1);
103 QMap<QString, QString> lm;
104 if (localizations_.contains(relpath))
105 lm = localizations_.find(relpath).value();
106 lm.insert(localization, fn);
107 localizations_.insert(relpath, lm);
111 // Find and store GUI language
112 for (auto const & l : guilangs_) {
113 // First try with the full name
114 // `en' files are not in a subdirectory
115 if (available_languages_.contains(toqstr(l))) {
116 guilang_ = toqstr(l);
119 // Then the name without country code
120 string const shortl = token(l, '_', 0);
121 if (available_languages_.contains(toqstr(shortl))) {
122 guilang_ = toqstr(shortl);
129 GuiLyXFiles::GuiLyXFiles(GuiView & lv)
130 : GuiDialog(lv, "lyxfiles", qt_("New File From Template"))
134 // Get all supported languages (by code) in order to exclude those
136 QAbstractItemModel * language_model = guiApp->languageModel();
137 language_model->sort(0);
138 for (int i = 0; i != language_model->rowCount(); ++i) {
139 QModelIndex index = language_model->index(i, 0);
140 Language const * lang =
141 languages.getLanguage(fromqstr(index.data(Qt::UserRole).toString()));
144 QString const code = toqstr(lang->code());
145 if (!all_languages_.contains(code))
146 all_languages_.insert(code, qt_(lang->display()));
147 // Also store code without country code
148 QString const shortcode = code.left(code.indexOf('_'));
149 if (shortcode != code && !all_languages_.contains(shortcode))
150 all_languages_.insert(shortcode, qt_(lang->display()));
153 string lang = getGuiMessages().language();
154 string const language = getEnv("LANGUAGE");
155 if (!language.empty())
156 lang += ":" + language;
157 guilangs_ = getVectorFromString(lang, ":");
160 filter_ = new FancyLineEdit(this);
161 filter_->setButtonPixmap(FancyLineEdit::Right, getPixmap("images/", "editclear", "svgz,png"));
162 filter_->setButtonVisible(FancyLineEdit::Right, true);
163 filter_->setButtonToolTip(FancyLineEdit::Right, qt_("Clear text"));
164 filter_->setAutoHideButton(FancyLineEdit::Right, true);
165 filter_->setPlaceholderText(qt_("All available files"));
166 filter_->setToolTip(qt_("Enter string to filter the list of available files"));
167 #if (QT_VERSION < 0x050000)
168 connect(filter_, SIGNAL(downPressed()),
169 filesLW, SLOT(setFocus()));
171 connect(filter_, &FancyLineEdit::downPressed,
172 filesLW, [=](){ focusAndHighlight(filesLW); });
175 filterBarL->addWidget(filter_, 0);
176 findKeysLA->setBuddy(filter_);
178 connect(buttonBox, SIGNAL(clicked(QAbstractButton *)),
179 this, SLOT(slotButtonBox(QAbstractButton *)));
181 connect(filesLW, SIGNAL(itemClicked(QTreeWidgetItem *, int)),
182 this, SLOT(changed_adaptor()));
183 connect(filesLW, SIGNAL(itemSelectionChanged()),
184 this, SLOT(changed_adaptor()));
185 connect(filter_, SIGNAL(textEdited(QString)),
186 this, SLOT(filterLabels()));
187 connect(filter_, SIGNAL(rightButtonClicked()),
188 this, SLOT(resetFilter()));
190 bc().setPolicy(ButtonPolicy::OkApplyCancelPolicy);
191 bc().setOK(buttonBox->button(QDialogButtonBox::Open));
192 bc().setCancel(buttonBox->button(QDialogButtonBox::Cancel));
194 //filesLW->setViewMode(QListView::ListMode);
195 filesLW->setIconSize(QSize(22, 22));
197 setFocusProxy(filter_);
201 QString const GuiLyXFiles::getSuffix()
203 if (type_ == "bind" || type_ == "ui")
204 return toqstr(".") + type_;
210 bool GuiLyXFiles::translateName() const
212 return (type_ == "templates" || type_ == "examples");
216 void GuiLyXFiles::changed_adaptor()
222 void GuiLyXFiles::on_fileTypeCO_activated(int)
228 void GuiLyXFiles::on_languageCO_activated(int i)
230 savelang_ = languageCO->itemData(i).toString();
231 filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
236 void GuiLyXFiles::on_filesLW_itemDoubleClicked(QTreeWidgetItem * item, int)
238 if (!item->data(0, Qt::UserRole).toString().endsWith(getSuffix()))
239 // not a file (probably a header)
247 void GuiLyXFiles::on_filesLW_itemClicked(QTreeWidgetItem * item, int)
249 QString const data = item->data(0, Qt::UserRole).toString();
251 QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
252 while (i != available_languages_.constEnd()) {
253 if (localizations_.contains(data)
254 && localizations_.find(data).value().contains(i.key()))
255 languageCO->addItem(i.value(), i.key());
258 languageCO->setToolTip(qt_("All available languages of the selected file are displayed here.\n"
259 "The selected language version will be opened."));
260 // Set language combo
261 // first try last setting
262 if (!savelang_.isEmpty()) {
263 int index = languageCO->findData(savelang_);
265 languageCO->setCurrentIndex(index);
266 filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
270 // next, try GUI lang
271 if (!guilang_.isEmpty()) {
272 int index = languageCO->findData(guilang_);
274 languageCO->setCurrentIndex(index);
275 filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
279 // Finally, fall back to English (which should be always there)
280 int index = languageCO->findData(toqstr("en"));
282 languageCO->setCurrentIndex(index);
283 filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
288 void GuiLyXFiles::on_browsePB_pressed()
290 bool const examples = (type_ == "examples");
291 FileDialog dlg(qt_("Select template file"));
292 dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
294 dlg.setButton2(qt_("&Examples"), toqstr(lyxrc.example_path));
296 dlg.setButton2(qt_("&Templates"), toqstr(lyxrc.template_path));
298 FileDialog::Result result = dlg.open(examples ? toqstr(lyxrc.example_path)
299 : toqstr(lyxrc.template_path),
300 QStringList(qt_("LyX Documents (*.lyx)")));
302 if (result.first != FileDialog::Later && !result.second.isEmpty()) {
303 file_ = toqstr(FileName(fromqstr(result.second)).absFileName());
310 void GuiLyXFiles::updateContents()
312 QString type = fileTypeCO->itemData(fileTypeCO->currentIndex()).toString();
313 QMap<QString, QString> files;
315 getFiles(files, type);
316 languageCO->model()->sort(0);
319 QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
320 QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
322 QMap<QString, QString>::const_iterator it = files.constBegin();
324 capfont.setBold(true);
325 while (it != files.constEnd()) {
326 QFileInfo const info = QFileInfo(it.key());
327 QString cat = it.value();
330 if (cat.contains('/')) {
332 cat = catsave.left(catsave.indexOf('/'));
333 subcat = toqstr(translateIfPossible(
334 qstring_to_ucs4(catsave.mid(
335 catsave.indexOf('/') + 1).replace('_', ' '))));
337 cat = toqstr(translateIfPossible(qstring_to_ucs4(cat.replace('_', ' '))));
338 QTreeWidgetItem * catItem = new QTreeWidgetItem();
339 if (!cats.contains(cat)) {
340 catItem->setText(0, cat);
341 catItem->setFont(0, capfont);
342 filesLW->insertTopLevelItem(0, catItem);
343 catItem->setExpanded(true);
346 catItem = filesLW->findItems(cat, Qt::MatchExactly).first();
347 QTreeWidgetItem * item = new QTreeWidgetItem();
348 QString const filename = info.fileName();
349 QString guiname = filename.left(filename.lastIndexOf(getSuffix())).replace('_', ' ');
351 guiname = toqstr(translateIfPossible(qstring_to_ucs4(guiname)));
352 QIcon file_icon = (info.filePath().startsWith(toqstr(package().user_support().absFileName()))) ?
353 user_icon : system_icon;
354 item->setIcon(0, file_icon);
355 item->setData(0, Qt::UserRole, info.filePath());
356 item->setData(0, Qt::DisplayRole, guiname);
357 item->setData(0, Qt::ToolTipRole, info.filePath());
358 if (subcat.isEmpty())
359 catItem->addChild(item);
361 QTreeWidgetItem * subcatItem = new QTreeWidgetItem();
362 if (cats.contains(catsave)) {
363 QList<QTreeWidgetItem *> pcats = filesLW->findItems(cat, Qt::MatchExactly);
364 for (int iit = 0; iit < pcats.size(); ++iit) {
365 for (int cit = 0; cit < pcats.at(iit)->childCount(); ++cit) {
366 if (pcats.at(iit)->child(cit)->text(0) == subcat) {
367 subcatItem = pcats.at(iit)->child(cit);
373 subcatItem->setText(0, subcat);
374 subcatItem->setIcon(0, file_icon);
377 subcatItem->addChild(item);
378 catItem->addChild(subcatItem);
382 filesLW->sortItems(0, Qt::AscendingOrder);
388 void GuiLyXFiles::slotButtonBox(QAbstractButton * button)
390 switch (buttonBox->standardButton(button)) {
391 case QDialogButtonBox::Open:
394 case QDialogButtonBox::Cancel:
403 void GuiLyXFiles::filterLabels()
405 Qt::CaseSensitivity cs = csFindCB->isChecked() ?
406 Qt::CaseSensitive : Qt::CaseInsensitive;
407 QTreeWidgetItemIterator it(filesLW);
410 (*it)->childCount() == 0
411 && !(*it)->text(0).contains(filter_->text(), cs)
418 void GuiLyXFiles::resetFilter()
420 filter_->setText(QString());
424 QString const GuiLyXFiles::getRealPath()
426 QString const relpath = filesLW->currentItem()->data(0, Qt::UserRole).toString();
427 QString const language = languageCO->itemData(languageCO->currentIndex()).toString();
428 if (localizations_.contains(relpath)
429 && localizations_.find(relpath).value().contains(language))
430 return localizations_.find(relpath).value().find(language).value();
435 void GuiLyXFiles::applyView()
437 file_ = getRealPath();
441 bool GuiLyXFiles::isValid()
443 return filesLW->currentItem() && filesLW->currentItem()->isSelected();
447 bool GuiLyXFiles::initialiseParams(string const & type)
449 type_ = type.empty() ? toqstr("templates") : toqstr(type);
455 void GuiLyXFiles::paramsToDialog()
458 if (type_ == "examples" || type_ == "templates") {
459 fileTypeCO->addItem(qt_("Templates"), toqstr("templates"));
460 fileTypeCO->addItem(qt_("Examples"), toqstr("examples"));
461 } else if (type_ == "ui")
462 fileTypeCO->addItem(qt_("User Interface Files"), toqstr("ui"));
463 else if (type_ == "bind")
464 fileTypeCO->addItem(qt_("Key Binding Files"), toqstr("bind"));
466 if (!type_.isEmpty()) {
467 int i = fileTypeCO->findData(type_);
469 fileTypeCO->setCurrentIndex(i);
471 if (type_ == "examples")
472 setTitle(qt_("Open Example File"));
473 else if (type_ == "templates")
474 setTitle(qt_("New File From Template"));
476 setTitle(qt_("Open File"));
478 bc().setValid(isValid());
482 void GuiLyXFiles::dispatchParams()
488 if (type_ == "templates")
490 arg += fromqstr(file_);
491 FuncCode const lfun = getLfun();
493 dispatch(FuncRequest(lfun, arg));
497 FuncCode GuiLyXFiles::getLfun() const
499 if (type_ == "examples")
500 return LFUN_FILE_OPEN;
501 else if (type_ == "templates")
502 return LFUN_BUFFER_NEW_TEMPLATE;
503 return LFUN_NOACTION;
506 Dialog * createGuiLyXFiles(GuiView & lv) { return new GuiLyXFiles(lv); }
509 } // namespace frontend
512 #include "moc_GuiLyXFiles.cpp"