src/frontends/qt4/GuiBibtex.cpp

   1 /**
   2  * \file GuiBibtex.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Herbert Voß
   8  * \author Angus Leeming
   9  * \author Jürgen Spitzmüller
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "GuiBibtex.h"
  17
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "CiteEnginesList.h"
  21 #include "FuncRequest.h"
  22 #include "LyXRC.h"
  23 #include "qt_helpers.h"
  24 #include "Validator.h"
  25
  26 #include "ui_BibtexAddUi.h"
  27
  28 #include "ButtonPolicy.h"
  29
  30 #include "frontends/alert.h"
  31
  32 #include "insets/InsetBibtex.h"
  33
  34 #include "support/debug.h"
  35 #include "support/ExceptionMessage.h"
  36 #include "support/FileName.h"
  37 #include "support/filetools.h" // changeExtension
  38 #include "support/gettext.h"
  39 #include "support/lstrings.h"
  40
  41 #include <QPushButton>
  42 #include <QListWidget>
  43 #include <QCheckBox>
  44 #include <QLineEdit>
  45
  46 using namespace std;
  47 using namespace lyx::support;
  48
  49 namespace lyx {
  50 namespace frontend {
  51
  52
  53 GuiBibtex::GuiBibtex(GuiView & lv)
  54         : GuiDialog(lv, "bibtex", qt_("BibTeX Bibliography")),
  55           params_(insetCode("bibtex"))
  56 {
  57         setupUi(this);
  58
  59         QDialog::setModal(true);
  60
  61         connect(okPB, SIGNAL(clicked()),
  62                 this, SLOT(slotOK()));
  63         connect(closePB, SIGNAL(clicked()),
  64                 this, SLOT(slotClose()));
  65         connect(stylePB, SIGNAL(clicked()),
  66                 this, SLOT(browsePressed()));
  67         connect(deletePB, SIGNAL(clicked()),
  68                 this, SLOT(deletePressed()));
  69         connect(upPB, SIGNAL(clicked()),
  70                 this, SLOT(upPressed()));
  71         connect(downPB, SIGNAL(clicked()),
  72                 this, SLOT(downPressed()));
  73         connect(styleCB, SIGNAL(editTextChanged(QString)),
  74                 this, SLOT(change_adaptor()));
  75         connect(databaseLW, SIGNAL(currentItemChanged(QListWidgetItem *, QListWidgetItem *)),
  76                 this, SLOT(databaseChanged()));
  77         connect(bibtocCB, SIGNAL(clicked()),
  78                 this, SLOT(change_adaptor()));
  79         connect(btPrintCO, SIGNAL(activated(int)),
  80                 this, SLOT(change_adaptor()));
  81         connect(addBibPB, SIGNAL(clicked()),
  82                 this, SLOT(addPressed()));
  83         connect(rescanPB, SIGNAL(clicked()),
  84                 this, SLOT(rescanClicked()));
  85         connect(biblatexOptsLE, SIGNAL(textChanged(QString)),
  86                 this, SLOT(change_adaptor()));
  87
  88         add_ = new GuiBibtexAddDialog(this);
  89         add_bc_.setPolicy(ButtonPolicy::OkCancelPolicy);
  90         add_bc_.setOK(add_->addPB);
  91         add_bc_.setCancel(add_->closePB);
  92         add_bc_.addCheckedLineEdit(add_->bibED, 0);
  93
  94         connect(add_->bibED, SIGNAL(textChanged(QString)),
  95                 this, SLOT(bibEDChanged()));
  96         connect(add_->addPB, SIGNAL(clicked()),
  97                 this, SLOT(addDatabase()));
  98         connect(add_->addPB, SIGNAL(clicked()),
  99                 add_, SLOT(accept()));
 100         connect(add_->rescanPB, SIGNAL(clicked()),
 101                 this, SLOT(rescanClicked()));
 102         connect(add_->bibLW, SIGNAL(itemActivated(QListWidgetItem *)),
 103                 this, SLOT(addDatabase()));
 104         connect(add_->bibLW, SIGNAL(itemActivated(QListWidgetItem *)),
 105                 add_, SLOT(accept()));
 106         connect(add_->bibLW, SIGNAL(currentItemChanged(QListWidgetItem *, QListWidgetItem *)),
 107                 this, SLOT(availableChanged()));
 108         connect(add_->browsePB, SIGNAL(clicked()),
 109                 this, SLOT(browseBibPressed()));
 110         connect(add_->closePB, SIGNAL(clicked()),
 111                 add_, SLOT(reject()));
 112
 113         add_->bibLW->setToolTip(formatToolTip(qt_("This list consists of all databases that are indexed by LaTeX and thus are found without a file path. "
 114                                     "This is usually everything in the bib/ subdirectory of LaTeX's texmf tree. "
 115                                     "If you want to reuse your own database, this is the place you should store it.")));
 116
 117         bc().setPolicy(ButtonPolicy::NoRepeatedApplyReadOnlyPolicy);
 118         bc().setOK(okPB);
 119         bc().setCancel(closePB);
 120         bc().addReadOnly(databaseLW);
 121         bc().addReadOnly(stylePB);
 122         bc().addReadOnly(styleCB);
 123         bc().addReadOnly(bibtocCB);
 124         bc().addReadOnly(addBibPB);
 125         // Delete/Up/Down are handled with more conditions in
 126         // databaseChanged().
 127
 128         // Make sure the delete/up/down buttons are disabled if necessary.
 129         databaseChanged();
 130 }
 131
 132
 133 void GuiBibtex::bibEDChanged()
 134 {
 135         // Indicate to the button controller that the contents have
 136         // changed. The actual test of validity is carried out by
 137         // the checkedLineEdit.
 138         add_bc_.setValid(true);
 139 }
 140
 141
 142 void GuiBibtex::change_adaptor()
 143 {
 144         changed();
 145 }
 146
 147
 148 void GuiBibtex::browsePressed()
 149 {
 150         QString const file = browseBst(QString());
 151
 152         if (file.isEmpty())
 153                 return;
 154
 155         QString const filen = changeExtension(file, "");
 156         bool present = false;
 157         unsigned int pres = 0;
 158
 159         for (int i = 0; i != styleCB->count(); ++i) {
 160                 if (styleCB->itemText(i) == filen) {
 161                         present = true;
 162                         pres = i;
 163                 }
 164         }
 165
 166         if (!present)
 167                 styleCB->insertItem(0, filen);
 168
 169         styleCB->setCurrentIndex(pres);
 170         changed();
 171 }
 172
 173
 174 void GuiBibtex::browseBibPressed()
 175 {
 176         QString const file = browseBib(QString()).trimmed();
 177
 178         if (file.isEmpty())
 179                 return;
 180
 181         QString const f = changeExtension(file, "");
 182         bool present = false;
 183
 184         for (int i = 0; i < add_->bibLW->count(); ++i) {
 185                 if (add_->bibLW->item(i)->text() == f)
 186                         present = true;
 187         }
 188
 189         if (!present) {
 190                 add_->bibLW->addItem(f);
 191                 changed();
 192         }
 193
 194         add_->bibED->setText(f);
 195 }
 196
 197
 198 void GuiBibtex::addPressed()
 199 {
 200         add_bc_.setValid(false);
 201         add_->exec();
 202 }
 203
 204
 205 void GuiBibtex::addDatabase()
 206 {
 207         int const sel = add_->bibLW->currentRow();
 208         QString const file = add_->bibED->text().trimmed();
 209
 210         if (sel < 0 && file.isEmpty())
 211                 return;
 212
 213         // Add the selected browser_bib keys to browser_database
 214         // multiple selections are possible
 215         for (int i = 0; i != add_->bibLW->count(); ++i) {
 216                 QListWidgetItem * const item = add_->bibLW->item(i);
 217                 if (add_->bibLW->isItemSelected(item)) {
 218                         add_->bibLW->setItemSelected(item, false);
 219                         QList<QListWidgetItem *> matches =
 220                                 databaseLW->findItems(item->text(), Qt::MatchExactly);
 221                         if (matches.empty()) {
 222                                 QString label = item->text();
 223                                 QListWidgetItem * db = new QListWidgetItem(label);
 224                                 db->setFlags(db->flags() | Qt::ItemIsSelectable);
 225                                 databaseLW->addItem(db);
 226                         }
 227                 }
 228         }
 229
 230         if (!file.isEmpty()) {
 231                 add_->bibED->clear();
 232                 QString const f = changeExtension(file, "");
 233                 QList<QListWidgetItem *> matches =
 234                         databaseLW->findItems(f, Qt::MatchExactly);
 235                 if (matches.empty()) {
 236                         QListWidgetItem * db = new QListWidgetItem(f);
 237                         db->setFlags(db->flags() | Qt::ItemIsSelectable);
 238                         databaseLW->addItem(db);
 239                 }
 240         }
 241
 242         databaseChanged();
 243         changed();
 244 }
 245
 246
 247 void GuiBibtex::deletePressed()
 248 {
 249         QListWidgetItem *cur = databaseLW->takeItem(databaseLW->currentRow());
 250         if (cur) {
 251                 delete cur;
 252                 databaseChanged();
 253                 changed();
 254         }
 255 }
 256
 257
 258 void GuiBibtex::upPressed()
 259 {
 260         int row = databaseLW->currentRow();
 261         QListWidgetItem *cur = databaseLW->takeItem(row);
 262         databaseLW->insertItem(row - 1, cur);
 263         databaseLW->setCurrentItem(cur);
 264         changed();
 265 }
 266
 267
 268 void GuiBibtex::downPressed()
 269 {
 270         int row = databaseLW->currentRow();
 271         QListWidgetItem *cur = databaseLW->takeItem(row);
 272         databaseLW->insertItem(row + 1, cur);
 273         databaseLW->setCurrentItem(cur);
 274         changed();
 275 }
 276
 277
 278 void GuiBibtex::rescanClicked()
 279 {
 280         rescanBibStyles();
 281         updateContents();
 282 }
 283
 284
 285 void GuiBibtex::databaseChanged()
 286 {
 287         bool readOnly = isBufferReadonly();
 288         int count = databaseLW->count();
 289         int row = databaseLW->currentRow();
 290         deletePB->setEnabled(!readOnly && row != -1);
 291         upPB->setEnabled(!readOnly && count > 1 && row > 0);
 292         downPB->setEnabled(!readOnly && count > 1 && row < count - 1);
 293 }
 294
 295
 296 void GuiBibtex::availableChanged()
 297 {
 298         add_bc_.setValid(true);
 299 }
 300
 301
 302 void GuiBibtex::updateContents()
 303 {
 304         bool bibtopic = usingBibtopic();
 305         bool biblatex = usingBiblatex();
 306
 307         if (biblatex)
 308                 setTitle(qt_("Biblatex Bibliography"));
 309         else
 310                 setTitle(qt_("BibTeX Bibliography"));
 311
 312         databaseLW->clear();
 313
 314         docstring bibs = params_["bibfiles"];
 315         docstring bib;
 316
 317         while (!bibs.empty()) {
 318                 bibs = split(bibs, bib, ',');
 319                 bib = trim(bib);
 320                 if (!bib.empty()) {
 321                         QListWidgetItem * db = new QListWidgetItem(toqstr(bib));
 322                         db->setFlags(db->flags() | Qt::ItemIsSelectable);
 323                         databaseLW->addItem(db);
 324                 }
 325         }
 326
 327         add_->bibLW->clear();
 328
 329         QStringList bibfiles = bibFiles();
 330         for (int i = 0; i != bibfiles.count(); ++i)
 331                 add_->bibLW->addItem(changeExtension(bibfiles[i], ""));
 332
 333         QString const bibstyle = styleFile();
 334
 335         bibtocCB->setChecked(bibtotoc() && !bibtopic);
 336         bibtocCB->setEnabled(!bibtopic);
 337
 338         btPrintCO->clear();
 339         btPrintCO->addItem(qt_("all cited references"), toqstr("btPrintCited"));
 340         if (bibtopic)
 341                 btPrintCO->addItem(qt_("all uncited references"), toqstr("btPrintNotCited"));
 342         btPrintCO->addItem(qt_("all references"), toqstr("btPrintAll"));
 343         if (usingBiblatex() && !buffer().masterParams().multibib.empty())
 344                 btPrintCO->addItem(qt_("all reference units"), toqstr("bibbysection"));
 345
 346         docstring btprint = params_["btprint"];
 347         if (btprint.empty())
 348                 // default
 349                 btprint = from_ascii("btPrintCited");
 350         btPrintCO->setCurrentIndex(btPrintCO->findData(toqstr(btprint)));
 351
 352         // Only useful for biblatex
 353         biblatexOptsLA->setVisible(biblatex);
 354         biblatexOptsLE->setVisible(biblatex);
 355
 356         // only useful for BibTeX
 357         styleCB->setVisible(!biblatex);
 358         styleLA->setVisible(!biblatex);
 359         stylePB->setVisible(!biblatex);
 360
 361         if (!biblatex) {
 362                 styleCB->clear();
 363
 364                 int item_nr = -1;
 365
 366                 QStringList const str = bibStyles();
 367                 for (int i = 0; i != str.count(); ++i) {
 368                         QString item = changeExtension(str[i], "");
 369                         if (item == bibstyle)
 370                                 item_nr = i;
 371                         styleCB->addItem(item);
 372                 }
 373
 374                 if (item_nr == -1 && !bibstyle.isEmpty()) {
 375                         styleCB->addItem(bibstyle);
 376                         item_nr = styleCB->count() - 1;
 377                 }
 378
 379
 380                 if (item_nr != -1)
 381                         styleCB->setCurrentIndex(item_nr);
 382                 else
 383                         styleCB->clearEditText();
 384         } else
 385                 biblatexOptsLE->setText(toqstr(params_["biblatexopts"]));
 386 }
 387
 388
 389 void GuiBibtex::applyView()
 390 {
 391         docstring dbs;
 392
 393         unsigned int maxCount = databaseLW->count();
 394         for (unsigned int i = 0; i < maxCount; i++) {
 395                 if (i != 0)
 396                         dbs += ',';
 397                 QString item = databaseLW->item(i)->text();
 398                 docstring bibfile = qstring_to_ucs4(item);
 399                 dbs += bibfile;
 400         }
 401
 402         params_["bibfiles"] = dbs;
 403
 404         docstring const bibstyle = qstring_to_ucs4(styleCB->currentText());
 405         bool const bibtotoc = bibtocCB->isChecked();
 406
 407         if (bibtotoc && !bibstyle.empty()) {
 408                 // both bibtotoc and style
 409                 params_["options"] = "bibtotoc," + bibstyle;
 410         } else if (bibtotoc) {
 411                 // bibtotoc and no style
 412                 params_["options"] = from_ascii("bibtotoc");
 413         } else {
 414                 // only style. An empty one is valid, because some
 415                 // documentclasses have an own \bibliographystyle{}
 416                 // command!
 417                 params_["options"] = bibstyle;
 418         }
 419
 420         params_["biblatexopts"] = qstring_to_ucs4(biblatexOptsLE->text());
 421
 422         params_["btprint"] = qstring_to_ucs4(btPrintCO->itemData(btPrintCO->currentIndex()).toString());
 423 }
 424
 425
 426 bool GuiBibtex::isValid()
 427 {
 428         return databaseLW->count() != 0;
 429 }
 430
 431
 432 QString GuiBibtex::browseBib(QString const & in_name) const
 433 {
 434         QString const label1 = qt_("Documents|#o#O");
 435         QString const dir1 = toqstr(lyxrc.document_path);
 436         QStringList const filter(qt_("BibTeX Databases (*.bib)"));
 437         return browseRelToParent(in_name, bufferFilePath(),
 438                 qt_("Select a BibTeX database to add"), filter, false, label1, dir1);
 439 }
 440
 441
 442 QString GuiBibtex::browseBst(QString const & in_name) const
 443 {
 444         QString const label1 = qt_("Documents|#o#O");
 445         QString const dir1 = toqstr(lyxrc.document_path);
 446         QStringList const filter(qt_("BibTeX Styles (*.bst)"));
 447         return browseRelToParent(in_name, bufferFilePath(),
 448                 qt_("Select a BibTeX style"), filter, false, label1, dir1);
 449 }
 450
 451
 452 QStringList GuiBibtex::bibStyles() const
 453 {
 454         QStringList data = texFileList("bstFiles.lst");
 455         // test whether we have a valid list, otherwise run rescan
 456         if (data.isEmpty()) {
 457                 rescanBibStyles();
 458                 data = texFileList("bstFiles.lst");
 459         }
 460         for (int i = 0; i != data.size(); ++i)
 461                 data[i] = onlyFileName(data[i]);
 462         // sort on filename only (no path)
 463         data.sort();
 464         return data;
 465 }
 466
 467
 468 QStringList GuiBibtex::bibFiles() const
 469 {
 470         QStringList data = texFileList("bibFiles.lst");
 471         // test whether we have a valid list, otherwise run rescan
 472         if (data.isEmpty()) {
 473                 rescanBibStyles();
 474                 data = texFileList("bibFiles.lst");
 475         }
 476         for (int i = 0; i != data.size(); ++i)
 477                 data[i] = onlyFileName(data[i]);
 478         // sort on filename only (no path)
 479         data.sort();
 480         return data;
 481 }
 482
 483
 484 void GuiBibtex::rescanBibStyles() const
 485 {
 486         if (usingBiblatex())
 487                 rescanTexStyles("bib");
 488         else
 489                 rescanTexStyles("bst bib");
 490 }
 491
 492
 493 bool GuiBibtex::usingBibtopic() const
 494 {
 495         return buffer().params().useBibtopic();
 496 }
 497
 498
 499 bool GuiBibtex::bibtotoc() const
 500 {
 501         return prefixIs(to_utf8(params_["options"]), "bibtotoc");
 502 }
 503
 504
 505 bool GuiBibtex::usingBiblatex() const
 506 {
 507         return buffer().masterBuffer()->params().useBiblatex();
 508 }
 509
 510
 511 QString GuiBibtex::styleFile() const
 512 {
 513         // the different bibtex packages have (and need) their
 514         // own "plain" stylefiles
 515         QString defaultstyle = toqstr(buffer().params().defaultBiblioStyle());
 516
 517         QString bst = toqstr(params_["options"]);
 518         if (bibtotoc()){
 519                 // bibstyle exists?
 520                 int pos = bst.indexOf(',');
 521                 if (pos != -1) {
 522                         // FIXME: check
 523                         // docstring bibtotoc = from_ascii("bibtotoc");
 524                         // bst = split(bst, bibtotoc, ',');
 525                         bst = bst.mid(pos + 1);
 526                 } else {
 527                         bst.clear();
 528                 }
 529         }
 530
 531         // propose default style file for new insets
 532         // existing insets might have (legally) no bst files
 533         // (if the class already provides a style)
 534         if (bst.isEmpty() && params_["bibfiles"].empty())
 535                 bst = defaultstyle;
 536
 537         return bst;
 538 }
 539
 540
 541 bool GuiBibtex::initialiseParams(std::string const & data)
 542 {
 543         InsetCommand::string2params(data, params_);
 544         return true;
 545 }
 546
 547
 548 void GuiBibtex::dispatchParams()
 549 {
 550         std::string const lfun = InsetCommand::params2string(params_);
 551         dispatch(FuncRequest(getLfun(), lfun));
 552 }
 553
 554
 555
 556 Dialog * createGuiBibtex(GuiView & lv) { return new GuiBibtex(lv); }
 557
 558
 559 } // namespace frontend
 560 } // namespace lyx
 561
 562 #include "moc_GuiBibtex.cpp"