src/frontends/qt4/GuiLyXFiles.cpp

   1 /**
   2  * \file GuiLyXFiles.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Spitzmüller
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "GuiLyXFiles.h"
  14 #include "GuiApplication.h"
  15 #include "qt_helpers.h"
  16
  17 #include "FileDialog.h"
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "FuncRequest.h"
  21 #include "Language.h"
  22 #include "LyXRC.h"
  23
  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"
  31
  32 #include <QDirIterator>
  33 #include <QFileIconProvider>
  34 #include <QTreeWidget>
  35
  36 using namespace std;
  37 using namespace lyx::support;
  38
  39 namespace lyx {
  40 namespace frontend {
  41
  42
  43 void GuiLyXFiles::getFiles(QMap<QString, QString> & in, QString const type)
  44 {
  45         // We look for lyx files in the subdirectory dir of
  46         //   1) user_lyxdir
  47         //   2) build_lyxdir (if not empty)
  48         //   3) system_lyxdir
  49         // in this order. Files with a given sub-hierarchy will
  50         // only be listed once.
  51         // We also consider i18n subdirectories and prefer them.
  52         QStringList dirs;
  53         QStringList relpaths;
  54
  55         // The three locations to look at.
  56         string const user = addPath(package().user_support().absFileName(), fromqstr(type));
  57         string const build = addPath(package().build_support().absFileName(), fromqstr(type));
  58         string const system = addPath(package().system_support().absFileName(), fromqstr(type));
  59
  60         // First, query the current language subdir (except for English)
  61         QString const lang = languageCO->itemData(languageCO->currentIndex()).toString();
  62         if (!lang.startsWith("en")) {
  63                 // First try with the full code
  64                 dirs << toqstr(addPath(user, fromqstr(lang)));
  65                 dirs << toqstr(addPath(build, fromqstr(lang)));
  66                 dirs << toqstr(addPath(system, fromqstr(lang)));
  67                 // Then the name without country code
  68                 QString const shortl = lang.left(lang.indexOf('_'));
  69                 if (shortl != lang) {
  70                         dirs << toqstr(addPath(user, fromqstr(shortl)));
  71                         dirs << toqstr(addPath(build, fromqstr(shortl)));
  72                         dirs << toqstr(addPath(system, fromqstr(shortl)));
  73                 }
  74         }
  75
  76         // Next, search in the base path
  77         dirs << toqstr(user)
  78              << toqstr(build)
  79              << toqstr(system);
  80
  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()))
  87                                 continue;
  88                         QString const relpath = toqstr(makeRelPath(qstring_to_ucs4(fn),
  89                                                                    qstring_to_ucs4(dir)));
  90                         // <cat>/
  91                         int s = relpath.indexOf('/', 0);
  92                         QString cat = qt_("General");
  93                         if (s != -1) {
  94                                 // <cat>/<subcat>/
  95                                 cat = relpath.left(s);
  96                                 int sc = relpath.indexOf('/', s + 1);
  97                                 QString const subcat = (sc == -1) ?
  98                                                         QString() : relpath.mid(s + 1, sc - s - 1);
  99                                 if (langcodes_.contains(cat)
 100                                     && !langcodes_.contains(dir.right(dir.lastIndexOf('/'))))
 101                                         // Skip i18n dir
 102                                         continue;
 103                                 if (!subcat.isEmpty())
 104                                         cat += '/' + subcat;
 105                         }
 106                         if (!relpaths.contains(relpath)) {
 107                                 relpaths.append(relpath);
 108                                 in.insert(fn, cat);
 109                         }
 110                 }
 111         }
 112 }
 113
 114
 115 GuiLyXFiles::GuiLyXFiles(GuiView & lv)
 116         : GuiDialog(lv, "lyxfiles", qt_("New File From Template"))
 117 {
 118         setupUi(this);
 119
 120         // Get all supported languages (by code) in order to exclude those
 121         // dirs later.
 122         QAbstractItemModel * language_model = guiApp->languageModel();
 123         language_model->sort(0);
 124         for (int i = 0; i != language_model->rowCount(); ++i) {
 125                 QModelIndex index = language_model->index(i, 0);
 126                 Language const * lang =
 127                         languages.getLanguage(fromqstr(index.data(Qt::UserRole).toString()));
 128                 if (!lang)
 129                         continue;
 130                 string const code = lang->code();
 131                 languageCO->addItem(qt_(lang->display()), toqstr(code));
 132                 langcodes_ << toqstr(code);
 133                 // Also store code without country code
 134                 string const shortcode = token(code, '_', 0);
 135                 if (shortcode != code)
 136                         langcodes_ << toqstr(shortcode);
 137         }
 138         // Preset to GUI language
 139         string lang = getGuiMessages().language();
 140         string const language = getEnv("LANGUAGE");
 141         if (!language.empty())
 142                 lang += ":" + language;
 143
 144         for (auto const & l : getVectorFromString(lang, ":")) {
 145                 // First try with the full name
 146                 // `en' files are not in a subdirectory
 147                 int i = languageCO->findData(toqstr(l));
 148                 if (i != -1) {
 149                         languageCO->setCurrentIndex(i);
 150                         break;
 151                 }
 152                 // Then the name without country code
 153                 string const shortl = token(l, '_', 0);
 154                 i = languageCO->findData(toqstr(l));
 155                 if (i != -1) {
 156                         languageCO->setCurrentIndex(i);
 157                         break;
 158                 }
 159         }
 160
 161         // The filter bar
 162         filter_ = new FancyLineEdit(this);
 163         filter_->setButtonPixmap(FancyLineEdit::Right, getPixmap("images/", "editclear", "svgz,png"));
 164         filter_->setButtonVisible(FancyLineEdit::Right, true);
 165         filter_->setButtonToolTip(FancyLineEdit::Right, qt_("Clear text"));
 166         filter_->setAutoHideButton(FancyLineEdit::Right, true);
 167         filter_->setPlaceholderText(qt_("All available files"));
 168         filter_->setToolTip(qt_("Enter string to filter the list of available files"));
 169 #if (QT_VERSION < 0x050000)
 170         connect(filter_, SIGNAL(downPressed()),
 171                 filesLW, SLOT(setFocus()));
 172 #else
 173         connect(filter_, &FancyLineEdit::downPressed,
 174                 filesLW, [=](){ focusAndHighlight(filesLW); });
 175 #endif
 176
 177         filterBarL->addWidget(filter_, 0);
 178         findKeysLA->setBuddy(filter_);
 179
 180         connect(buttonBox, SIGNAL(clicked(QAbstractButton *)),
 181                 this, SLOT(slotButtonBox(QAbstractButton *)));
 182
 183         connect(filesLW, SIGNAL(itemClicked(QTreeWidgetItem *, int)),
 184                 this, SLOT(changed_adaptor()));
 185         connect(filesLW, SIGNAL(itemSelectionChanged()),
 186                 this, SLOT(changed_adaptor()));
 187         connect(filter_, SIGNAL(textEdited(QString)),
 188                 this, SLOT(filterLabels()));
 189         connect(filter_, SIGNAL(rightButtonClicked()),
 190                 this, SLOT(resetFilter()));
 191
 192         bc().setPolicy(ButtonPolicy::OkApplyCancelPolicy);
 193         bc().setOK(buttonBox->button(QDialogButtonBox::Open));
 194         bc().setCancel(buttonBox->button(QDialogButtonBox::Cancel));
 195
 196         //filesLW->setViewMode(QListView::ListMode);
 197         filesLW->setIconSize(QSize(22, 22));
 198
 199         setFocusProxy(filter_);
 200 }
 201
 202
 203 QString const GuiLyXFiles::getSuffix()
 204 {
 205         if (type_ == "bind" || type_ == "ui")
 206                 return toqstr(".") + type_;
 207
 208         return ".lyx";
 209 }
 210
 211
 212 bool GuiLyXFiles::translateName() const
 213 {
 214         return (type_ == "templates" || type_ == "examples");
 215 }
 216
 217
 218 void GuiLyXFiles::changed_adaptor()
 219 {
 220         changed();
 221 }
 222
 223
 224 void GuiLyXFiles::on_fileTypeCO_activated(int)
 225 {
 226         updateContents();
 227 }
 228
 229
 230 void GuiLyXFiles::on_languageCO_activated(int)
 231 {
 232         updateContents();
 233 }
 234
 235
 236 void GuiLyXFiles::on_filesLW_itemDoubleClicked(QTreeWidgetItem * item, int)
 237 {
 238         if (!item->data(0, Qt::UserRole).toString().endsWith(getSuffix()))
 239                 // not a file (probably a header)
 240                 return;
 241
 242         applyView();
 243         dispatchParams();
 244         close();
 245 }
 246
 247
 248 void GuiLyXFiles::on_browsePB_pressed()
 249 {
 250         bool const examples = (type_ == "examples");
 251         FileDialog dlg(qt_("Select template file"));
 252         dlg.setButton1(qt_("D&ocuments"), toqstr(lyxrc.document_path));
 253         if (examples)
 254                 dlg.setButton2(qt_("&Examples"), toqstr(lyxrc.example_path));
 255         else
 256                 dlg.setButton2(qt_("&Templates"), toqstr(lyxrc.template_path));
 257
 258         FileDialog::Result result = dlg.open(examples ? toqstr(lyxrc.example_path)
 259                                                       : toqstr(lyxrc.template_path),
 260                                  QStringList(qt_("LyX Documents (*.lyx)")));
 261
 262         if (result.first != FileDialog::Later && !result.second.isEmpty()) {
 263                 file_ = toqstr(FileName(fromqstr(result.second)).absFileName());
 264                 dispatchParams();
 265                 close();
 266         }
 267 }
 268
 269
 270 void GuiLyXFiles::updateContents()
 271 {
 272         QString type = fileTypeCO->itemData(fileTypeCO->currentIndex()).toString();
 273         QMap<QString, QString> files;
 274         getFiles(files, type);
 275
 276         filesLW->clear();
 277         QFileIconProvider iconprovider;
 278         QStringList cats;
 279         QMap<QString, QString>::const_iterator it = files.constBegin();
 280         QFont capfont;
 281         capfont.setBold(true);
 282         while (it != files.constEnd()) {
 283                 QFileInfo const info = QFileInfo(it.key());
 284                 QString cat = it.value();
 285                 QString subcat;
 286                 QString catsave;
 287                 if (cat.contains('/')) {
 288                         catsave = cat;
 289                         cat = catsave.left(catsave.indexOf('/'));
 290                         subcat = toqstr(translateIfPossible(
 291                                         qstring_to_ucs4(catsave.mid(
 292                                                 catsave.indexOf('/') + 1).replace('_', ' '))));
 293                 }
 294                 cat =  toqstr(translateIfPossible(qstring_to_ucs4(cat.replace('_', ' '))));
 295                 QTreeWidgetItem * catItem = new QTreeWidgetItem();
 296                 if (!cats.contains(cat)) {
 297                         catItem->setText(0, cat);
 298                         catItem->setFont(0, capfont);
 299                         filesLW->insertTopLevelItem(0, catItem);
 300                         catItem->setExpanded(true);
 301                         cats << cat;
 302                 } else
 303                         catItem = filesLW->findItems(cat, Qt::MatchExactly).first();
 304                 QTreeWidgetItem * item = new QTreeWidgetItem();
 305                 QString const filename = info.fileName();
 306                 QString guiname = filename.left(filename.lastIndexOf(getSuffix())).replace('_', ' ');
 307                 if (translateName())
 308                         guiname = toqstr(translateIfPossible(qstring_to_ucs4(guiname)));
 309                 item->setIcon(0, iconprovider.icon(info));
 310                 item->setData(0, Qt::UserRole, info.filePath());
 311                 item->setData(0, Qt::DisplayRole, guiname);
 312                 item->setData(0, Qt::ToolTipRole, info.filePath());
 313                 if (subcat.isEmpty())
 314                         catItem->addChild(item);
 315                 else {
 316                         QTreeWidgetItem * subcatItem = new QTreeWidgetItem();
 317                         if (cats.contains(catsave)) {
 318                                 QList<QTreeWidgetItem *> pcats = filesLW->findItems(cat, Qt::MatchExactly);
 319                                 for (int iit = 0; iit < pcats.size(); ++iit) {
 320                                         for (int cit = 0; cit < pcats.at(iit)->childCount(); ++cit) {
 321                                                 if (pcats.at(iit)->child(cit)->text(0) == subcat) {
 322                                                         subcatItem = pcats.at(iit)->child(cit);
 323                                                         break;
 324                                                 }
 325                                         }
 326                                 }
 327                         } else {
 328                                 subcatItem->setText(0, subcat);
 329                                 cats << catsave;
 330                         }
 331                         subcatItem->addChild(item);
 332                         catItem->addChild(subcatItem);
 333                 }
 334                 ++it;
 335         }
 336         filesLW->sortItems(0, Qt::AscendingOrder);
 337         // redo filter
 338         filterLabels();
 339 }
 340
 341
 342 void GuiLyXFiles::slotButtonBox(QAbstractButton * button)
 343 {
 344         switch (buttonBox->standardButton(button)) {
 345         case QDialogButtonBox::Open:
 346                 slotOK();
 347                 break;
 348         case QDialogButtonBox::Cancel:
 349                 slotClose();
 350                 break;
 351         default:
 352                 break;
 353         }
 354 }
 355
 356
 357 void GuiLyXFiles::filterLabels()
 358 {
 359         Qt::CaseSensitivity cs = csFindCB->isChecked() ?
 360                 Qt::CaseSensitive : Qt::CaseInsensitive;
 361         QTreeWidgetItemIterator it(filesLW);
 362         while (*it) {
 363                 (*it)->setHidden(
 364                         (*it)->childCount() == 0
 365                         && !(*it)->text(0).contains(filter_->text(), cs)
 366                 );
 367                 ++it;
 368         }
 369 }
 370
 371
 372 void GuiLyXFiles::resetFilter()
 373 {
 374         filter_->setText(QString());
 375         filterLabels();
 376 }
 377
 378
 379 void GuiLyXFiles::applyView()
 380 {
 381         file_ = filesLW->currentItem()->data(0, Qt::UserRole).toString();
 382 }
 383
 384
 385 bool GuiLyXFiles::isValid()
 386 {
 387         return filesLW->currentItem() && filesLW->currentItem()->isSelected();
 388 }
 389
 390
 391 bool GuiLyXFiles::initialiseParams(string const & type)
 392 {
 393         type_ = type.empty() ? toqstr("templates") : toqstr(type);
 394         paramsToDialog();
 395         return true;
 396 }
 397
 398
 399 void GuiLyXFiles::paramsToDialog()
 400 {
 401         fileTypeCO->clear();
 402         if (type_ == "examples" || type_ == "templates") {
 403                 fileTypeCO->addItem(qt_("Templates"), toqstr("templates"));
 404                 fileTypeCO->addItem(qt_("Examples"), toqstr("examples"));
 405         } else if (type_ == "ui")
 406                 fileTypeCO->addItem(qt_("User Interface Files"), toqstr("ui"));
 407         else if (type_ == "bind")
 408                 fileTypeCO->addItem(qt_("Key Binding Files"), toqstr("bind"));
 409
 410         if (!type_.isEmpty()) {
 411                 int i = fileTypeCO->findData(type_);
 412                 if (i != -1)
 413                         fileTypeCO->setCurrentIndex(i);
 414         }
 415         if (type_ == "examples")
 416                 setTitle(qt_("Open Example File"));
 417         else if (type_ == "templates")
 418                 setTitle(qt_("New File From Template"));
 419         else
 420                 setTitle(qt_("Open File"));
 421
 422         bc().setValid(isValid());
 423 }
 424
 425
 426 void GuiLyXFiles::dispatchParams()
 427 {
 428         if (file_.isEmpty())
 429                 return;
 430
 431         string arg;
 432         if (type_ == "templates")
 433                 arg = "newfile ";
 434         arg += fromqstr(file_);
 435         FuncCode const lfun = getLfun();
 436
 437         dispatch(FuncRequest(lfun, arg));
 438 }
 439
 440
 441 FuncCode GuiLyXFiles::getLfun() const
 442 {
 443         if (type_ == "examples")
 444                 return LFUN_FILE_OPEN;
 445         else if (type_ == "templates")
 446                 return LFUN_BUFFER_NEW_TEMPLATE;
 447         return LFUN_NOACTION;
 448 }
 449
 450 Dialog * createGuiLyXFiles(GuiView & lv) { return new GuiLyXFiles(lv); }
 451
 452
 453 } // namespace frontend
 454 } // namespace lyx
 455
 456 #include "moc_GuiLyXFiles.cpp"