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 "support/debug.h"
  21 #include "ui_BibtexAddUi.h"
  22 #include "qt_helpers.h"
  23 #include "Validator.h"
  24 #include "LyXRC.h"
  25 #include "support/gettext.h"
  26
  27 #include "ButtonPolicy.h"
  28
  29 #include "support/filetools.h" // changeExtension
  30 #include "support/lstrings.h"
  31 #include "support/FileFilterList.h"
  32
  33 #include <QPushButton>
  34 #include <QListWidget>
  35 #include <QCheckBox>
  36 #include <QCloseEvent>
  37 #include <QLineEdit>
  38
  39 using namespace std;
  40 using namespace lyx::support;
  41
  42 namespace lyx {
  43 namespace frontend {
  44
  45
  46 GuiBibtex::GuiBibtex(GuiView & lv)
  47         : GuiCommand(lv, "bibtex")
  48 {
  49         setupUi(this);
  50
  51         setViewTitle( _("BibTeX Bibliography"));
  52
  53         QDialog::setModal(true);
  54
  55         connect(okPB, SIGNAL(clicked()),
  56                 this, SLOT(slotOK()));
  57         connect(closePB, SIGNAL(clicked()),
  58                 this, SLOT(slotClose()));
  59         connect(stylePB, SIGNAL(clicked()),
  60                 this, SLOT(browsePressed()));
  61         connect(deletePB, SIGNAL(clicked()),
  62                 this, SLOT(deletePressed()));
  63         connect(styleCB, SIGNAL(editTextChanged(QString)),
  64                 this, SLOT(change_adaptor()));
  65         connect(databaseLW, SIGNAL(itemSelectionChanged()),
  66                 this, SLOT(databaseChanged()));
  67         connect(bibtocCB, SIGNAL(clicked()),
  68                 this, SLOT(change_adaptor()));
  69         connect(btPrintCO, SIGNAL(activated(int)),
  70                 this, SLOT(change_adaptor()));
  71         connect(addBibPB, SIGNAL(clicked()),
  72                 this, SLOT(addPressed()));
  73
  74         add_ = new GuiBibtexAddDialog(this);
  75         add_bc_.setPolicy(ButtonPolicy::OkCancelPolicy);
  76         add_bc_.setOK(add_->addPB);
  77         add_bc_.setCancel(add_->closePB);
  78         add_bc_.addCheckedLineEdit(add_->bibED, 0);
  79
  80         connect(add_->bibED, SIGNAL(textChanged(QString)),
  81                 this, SLOT(bibEDChanged()));
  82         connect(add_->addPB, SIGNAL(clicked()),
  83                 this, SLOT(addDatabase()));
  84         connect(add_->addPB, SIGNAL(clicked()),
  85                 add_, SLOT(accept()));
  86         connect(add_->bibLW, SIGNAL(itemActivated(QListWidgetItem *)),
  87                 this, SLOT(addDatabase()));
  88         connect(add_->bibLW, SIGNAL(itemActivated(QListWidgetItem *)),
  89                 add_, SLOT(accept()));
  90         connect(add_->bibLW, SIGNAL(itemSelectionChanged()),
  91                 this, SLOT(availableChanged()));
  92         connect(add_->browsePB, SIGNAL(clicked()),
  93                 this, SLOT(browseBibPressed()));
  94         connect(add_->closePB, SIGNAL(clicked()),
  95                 add_, SLOT(reject()));
  96
  97         bc().setPolicy(ButtonPolicy::NoRepeatedApplyReadOnlyPolicy);
  98         bc().setOK(okPB);
  99         bc().setCancel(closePB);
 100         bc().addReadOnly(databaseLW);
 101         bc().addReadOnly(stylePB);
 102         bc().addReadOnly(styleCB);
 103         bc().addReadOnly(bibtocCB);
 104         bc().addReadOnly(addBibPB);
 105         bc().addReadOnly(deletePB);
 106 }
 107
 108
 109 void GuiBibtex::bibEDChanged()
 110 {
 111         // Indicate to the button controller that the contents have
 112         // changed. The actual test of validity is carried out by
 113         // the checkedLineEdit.
 114         add_bc_.setValid(true);
 115 }
 116
 117
 118 void GuiBibtex::change_adaptor()
 119 {
 120         changed();
 121 }
 122
 123
 124 void GuiBibtex::browsePressed()
 125 {
 126         docstring const file = browseBst(docstring());
 127
 128         if (!file.empty()) {
 129                 // FIXME UNICODE
 130                 docstring const filen = from_utf8(changeExtension(to_utf8(file), ""));
 131                 bool present = false;
 132                 unsigned int pres = 0;
 133
 134                 for (int i = 0; i != styleCB->count(); ++i) {
 135                         if (qstring_to_ucs4(styleCB->itemText(i)) == filen) {
 136                                 present = true;
 137                                 pres = i;
 138                         }
 139                 }
 140
 141                 if (!present)
 142                         styleCB->insertItem(0, toqstr(filen));
 143
 144                 styleCB->setCurrentIndex(pres);
 145                 changed();
 146         }
 147 }
 148
 149
 150 void GuiBibtex::browseBibPressed()
 151 {
 152         docstring const file = trim(browseBib(docstring()));
 153
 154         if (!file.empty()) {
 155                 // FIXME UNICODE
 156                 QString const f = toqstr(changeExtension(to_utf8(file), ""));
 157                 bool present = false;
 158
 159                 for (int i = 0; i < add_->bibLW->count(); ++i) {
 160                         if (add_->bibLW->item(i)->text() == f)
 161                                 present = true;
 162                 }
 163
 164                 if (!present) {
 165                         add_->bibLW->addItem(f);
 166                         changed();
 167                 }
 168
 169                 add_->bibED->setText(f);
 170         }
 171 }
 172
 173
 174 void GuiBibtex::addPressed()
 175 {
 176         add_bc_.setValid(false);
 177         add_->exec();
 178 }
 179
 180
 181 void GuiBibtex::addDatabase()
 182 {
 183         int const sel = add_->bibLW->currentRow();
 184         docstring const file = trim(qstring_to_ucs4(add_->bibED->text()));
 185
 186         if (sel < 0 && file.empty())
 187                 return;
 188
 189         // Add the selected browser_bib keys to browser_database
 190         // multiple selections are possible
 191         for (int i = 0; i != add_->bibLW->count(); ++i) {
 192                 QListWidgetItem * const item = add_->bibLW->item(i);
 193                 if (add_->bibLW->isItemSelected(item)) {
 194                         add_->bibLW->setItemSelected(item, false);
 195                         QList<QListWidgetItem *> matches =
 196                                 databaseLW->findItems(item->text(), Qt::MatchExactly);
 197                         if (matches.empty())
 198                                 databaseLW->addItem(item->text());
 199                 }
 200         }
 201
 202         if (!file.empty()) {
 203                 add_->bibED->clear();
 204                 QString const f = toqstr(from_utf8(changeExtension(to_utf8(file), "")));
 205                 QList<QListWidgetItem *> matches =
 206                         databaseLW->findItems(f, Qt::MatchExactly);
 207                 if (matches.empty())
 208                         databaseLW->addItem(f);
 209         }
 210
 211         changed();
 212 }
 213
 214
 215 void GuiBibtex::deletePressed()
 216 {
 217         databaseLW->takeItem(databaseLW->currentRow());
 218         changed();
 219 }
 220
 221
 222
 223 void GuiBibtex::databaseChanged()
 224 {
 225         deletePB->setEnabled(!isBufferReadonly() && databaseLW->currentRow() != -1);
 226 }
 227
 228
 229 void GuiBibtex::availableChanged()
 230 {
 231         add_bc_.setValid(true);
 232 }
 233
 234
 235 void GuiBibtex::closeEvent(QCloseEvent *e)
 236 {
 237         slotClose();
 238         e->accept();
 239 }
 240
 241
 242 void GuiBibtex::updateContents()
 243 {
 244         bool bibtopic = usingBibtopic();
 245
 246         databaseLW->clear();
 247
 248         docstring bibs = params_["bibfiles"];
 249         docstring bib;
 250
 251         while (!bibs.empty()) {
 252                 bibs = split(bibs, bib, ',');
 253                 bib = trim(bib);
 254                 if (!bib.empty())
 255                         databaseLW->addItem(toqstr(bib));
 256         }
 257
 258         add_->bibLW->clear();
 259
 260         vector<string> bib_str;
 261         getBibFiles(bib_str);
 262         for (vector<string>::const_iterator it = bib_str.begin();
 263                 it != bib_str.end(); ++it) {
 264                 string bibItem(changeExtension(*it, ""));
 265                 add_->bibLW->addItem(toqstr(bibItem));
 266         }
 267
 268         string bibstyle = getStylefile();
 269
 270         bibtocCB->setChecked(bibtotoc() && !bibtopic);
 271         bibtocCB->setEnabled(!bibtopic);
 272
 273         if (!bibtopic && btPrintCO->count() == 3)
 274                 btPrintCO->removeItem(1);
 275         else if (bibtopic && btPrintCO->count() < 3)
 276                 btPrintCO->insertItem(1, qt_("all uncited references", 0));
 277
 278         docstring btprint = params_["btprint"];
 279         int btp = 0;
 280         if ((bibtopic && btprint == "btPrintNotCited") ||
 281            (!bibtopic && btprint == "btPrintAll"))
 282                 btp = 1;
 283         else if (bibtopic && btprint == "btPrintAll")
 284                 btp = 2;
 285
 286         btPrintCO->setCurrentIndex(btp);
 287
 288         styleCB->clear();
 289
 290         int item_nr(-1);
 291
 292         vector<string> str;
 293         getBibStyles(str);
 294         for (vector<string>::const_iterator it = str.begin();
 295                 it != str.end(); ++it) {
 296                 string item(changeExtension(*it, ""));
 297                 if (item == bibstyle)
 298                         item_nr = int(it - str.begin());
 299                 styleCB->addItem(toqstr(item));
 300         }
 301
 302         if (item_nr == -1 && !bibstyle.empty()) {
 303                 styleCB->addItem(toqstr(bibstyle));
 304                 item_nr = styleCB->count() - 1;
 305         }
 306
 307         if (item_nr != -1)
 308                 styleCB->setCurrentIndex(item_nr);
 309         else
 310                 styleCB->clearEditText();
 311 }
 312
 313
 314 void GuiBibtex::applyView()
 315 {
 316         docstring dbs = qstring_to_ucs4(databaseLW->item(0)->text());
 317
 318         unsigned int maxCount = databaseLW->count();
 319         for (unsigned int i = 1; i < maxCount; i++) {
 320                 dbs += ',';
 321                 dbs += qstring_to_ucs4(databaseLW->item(i)->text());
 322         }
 323
 324         params_["bibfiles"] = dbs;
 325
 326         docstring const bibstyle = qstring_to_ucs4(styleCB->currentText());
 327         bool const bibtotoc = bibtocCB->isChecked();
 328
 329         if (bibtotoc && (!bibstyle.empty())) {
 330                 // both bibtotoc and style
 331                 params_["options"] = "bibtotoc," + bibstyle;
 332         } else if (bibtotoc) {
 333                 // bibtotoc and no style
 334                 params_["options"] = from_ascii("bibtotoc");
 335         } else {
 336                 // only style. An empty one is valid, because some
 337                 // documentclasses have an own \bibliographystyle{}
 338                 // command!
 339                 params_["options"] = bibstyle;
 340         }
 341
 342         int btp = btPrintCO->currentIndex();
 343
 344         if (usingBibtopic()) {
 345                 // bibtopic allows three kinds of sections:
 346                 // 1. sections that include all cited references of the database(s)
 347                 // 2. sections that include all uncited references of the database(s)
 348                 // 3. sections that include all references of the database(s), cited or not
 349                 switch (btp) {
 350                 case 0:
 351                         params_["btprint"] = from_ascii("btPrintCited");
 352                         break;
 353                 case 1:
 354                         params_["btprint"] = from_ascii("btPrintNotCited");
 355                         break;
 356                 case 2:
 357                         params_["btprint"] = from_ascii("btPrintAll");
 358                         break;
 359                 }
 360         } else {
 361                 switch (btp) {
 362                 case 0:
 363                         params_["btprint"] = docstring();
 364                         break;
 365                 case 1:
 366                         // use \nocite{*}
 367                         params_["btprint"] = from_ascii("btPrintAll");
 368                         break;
 369                 }
 370         }
 371 }
 372
 373
 374 bool GuiBibtex::isValid()
 375 {
 376         return databaseLW->count() != 0;
 377 }
 378
 379
 380 docstring const GuiBibtex::browseBib(docstring const & in_name) const
 381 {
 382         // FIXME UNICODE
 383         docstring const label1 = _("Documents|#o#O");
 384         docstring const dir1 = from_utf8(lyxrc.document_path);
 385         FileFilterList const filter(_("BibTeX Databases (*.bib)"));
 386         return browseRelFile(in_name, from_utf8(bufferFilepath()),
 387                 _("Select a BibTeX database to add"), filter, false, label1, dir1);
 388 }
 389
 390
 391 docstring const GuiBibtex::browseBst(docstring const & in_name) const
 392 {
 393         // FIXME UNICODE
 394         docstring const label1 = _("Documents|#o#O");
 395         docstring const dir1 = from_utf8(lyxrc.document_path);
 396         FileFilterList const filter(_("BibTeX Styles (*.bst)"));
 397         return browseRelFile(in_name, from_utf8(bufferFilepath()),
 398                 _("Select a BibTeX style"), filter, false, label1, dir1);
 399 }
 400
 401
 402 void GuiBibtex::getBibStyles(vector<string> & data) const
 403 {
 404         data.clear();
 405
 406         getTexFileList("bstFiles.lst", data);
 407         // test, if we have a valid list, otherwise run rescan
 408         if (data.empty()) {
 409                 rescanBibStyles();
 410                 getTexFileList("bstFiles.lst", data);
 411         }
 412         vector<string>::iterator it  = data.begin();
 413         vector<string>::iterator end = data.end();
 414         for (; it != end; ++it) {
 415                 *it = onlyFilename(*it);
 416         }
 417         // sort on filename only (no path)
 418         sort(data.begin(), data.end());
 419 }
 420
 421
 422 void GuiBibtex::getBibFiles(vector<string> & data) const
 423 {
 424         data.clear();
 425
 426         getTexFileList("bibFiles.lst", data);
 427         // test, if we have a valid list, otherwise run rescan
 428         if (data.empty()) {
 429                 rescanBibStyles();
 430                 getTexFileList("bibFiles.lst", data);
 431         }
 432         vector<string>::iterator it  = data.begin();
 433         vector<string>::iterator end = data.end();
 434         for (; it != end; ++it) {
 435                 *it = onlyFilename(*it);
 436         }
 437         // sort on filename only (no path)
 438         sort(data.begin(), data.end());
 439 }
 440
 441
 442 void GuiBibtex::rescanBibStyles() const
 443 {
 444         rescanTexStyles();
 445 }
 446
 447
 448 bool GuiBibtex::usingBibtopic() const
 449 {
 450         return buffer().params().use_bibtopic;
 451 }
 452
 453
 454 bool GuiBibtex::bibtotoc() const
 455 {
 456         return prefixIs(to_utf8(params_["options"]), "bibtotoc");
 457 }
 458
 459
 460 string const GuiBibtex::getStylefile() const
 461 {
 462         // the different bibtex packages have (and need) their
 463         // own "plain" stylefiles
 464         biblio::CiteEngine const engine = buffer().params().getEngine();
 465         docstring defaultstyle;
 466         switch (engine) {
 467         case biblio::ENGINE_BASIC:
 468                 defaultstyle = from_ascii("plain");
 469                 break;
 470         case biblio::ENGINE_NATBIB_AUTHORYEAR:
 471                 defaultstyle = from_ascii("plainnat");
 472                 break;
 473         case biblio::ENGINE_NATBIB_NUMERICAL:
 474                 defaultstyle = from_ascii("plainnat");
 475                 break;
 476         case biblio::ENGINE_JURABIB:
 477                 defaultstyle = from_ascii("jurabib");
 478                 break;
 479         }
 480
 481         docstring bst = params_["options"];
 482         if (bibtotoc()){
 483                 // bibstyle exists?
 484                 if (contains(bst, ',')) {
 485                         docstring bibtotoc = from_ascii("bibtotoc");
 486                         bst = split(bst, bibtotoc, ',');
 487                 } else
 488                         bst.erase();
 489         }
 490
 491         // propose default style file for new insets
 492         // existing insets might have (legally) no bst files
 493         // (if the class already provides a style)
 494         if (bst.empty() && params_["bibfiles"].empty())
 495                 bst = defaultstyle;
 496
 497         // FIXME UNICODE
 498         return to_utf8(bst);
 499 }
 500
 501
 502 Dialog * createGuiBibtex(GuiView & lv) { return new GuiBibtex(lv); }
 503
 504
 505 } // namespace frontend
 506 } // namespace lyx
 507
 508 #include "GuiBibtex_moc.cpp"