3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * \author Angus Leeming
9 * \author Jürgen Spitzmüller
11 * Full author contact details are available in file CREDITS.
16 #include "GuiBibtex.h"
19 #include "BufferParams.h"
20 #include "support/debug.h"
21 #include "ui_BibtexAddUi.h"
22 #include "qt_helpers.h"
23 #include "Validator.h"
25 #include "support/gettext.h"
27 #include "ButtonPolicy.h"
29 #include "support/filetools.h" // changeExtension
30 #include "support/lstrings.h"
31 #include "support/FileFilterList.h"
33 #include <QPushButton>
34 #include <QListWidget>
36 #include <QCloseEvent>
40 using namespace lyx::support;
46 GuiBibtex::GuiBibtex(GuiView & lv)
47 : GuiCommand(lv, "bibtex")
51 setViewTitle( _("BibTeX Bibliography"));
53 QDialog::setModal(true);
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(upPB, SIGNAL(clicked()),
64 this, SLOT(upPressed()));
65 connect(downPB, SIGNAL(clicked()),
66 this, SLOT(downPressed()));
67 connect(styleCB, SIGNAL(editTextChanged(QString)),
68 this, SLOT(change_adaptor()));
69 connect(databaseLW, SIGNAL(itemSelectionChanged()),
70 this, SLOT(databaseChanged()));
71 connect(bibtocCB, SIGNAL(clicked()),
72 this, SLOT(change_adaptor()));
73 connect(btPrintCO, SIGNAL(activated(int)),
74 this, SLOT(change_adaptor()));
75 connect(addBibPB, SIGNAL(clicked()),
76 this, SLOT(addPressed()));
78 add_ = new GuiBibtexAddDialog(this);
79 add_bc_.setPolicy(ButtonPolicy::OkCancelPolicy);
80 add_bc_.setOK(add_->addPB);
81 add_bc_.setCancel(add_->closePB);
82 add_bc_.addCheckedLineEdit(add_->bibED, 0);
84 connect(add_->bibED, SIGNAL(textChanged(QString)),
85 this, SLOT(bibEDChanged()));
86 connect(add_->addPB, SIGNAL(clicked()),
87 this, SLOT(addDatabase()));
88 connect(add_->addPB, SIGNAL(clicked()),
89 add_, SLOT(accept()));
90 connect(add_->bibLW, SIGNAL(itemActivated(QListWidgetItem *)),
91 this, SLOT(addDatabase()));
92 connect(add_->bibLW, SIGNAL(itemActivated(QListWidgetItem *)),
93 add_, SLOT(accept()));
94 connect(add_->bibLW, SIGNAL(itemSelectionChanged()),
95 this, SLOT(availableChanged()));
96 connect(add_->browsePB, SIGNAL(clicked()),
97 this, SLOT(browseBibPressed()));
98 connect(add_->closePB, SIGNAL(clicked()),
99 add_, SLOT(reject()));
101 bc().setPolicy(ButtonPolicy::NoRepeatedApplyReadOnlyPolicy);
103 bc().setCancel(closePB);
104 bc().addReadOnly(databaseLW);
105 bc().addReadOnly(stylePB);
106 bc().addReadOnly(styleCB);
107 bc().addReadOnly(bibtocCB);
108 bc().addReadOnly(addBibPB);
109 // Delete/Up/Down are handled with more conditions in
110 // databaseChanged().
112 // Make sure the delete/up/down buttons are disabled if necessary.
117 void GuiBibtex::bibEDChanged()
119 // Indicate to the button controller that the contents have
120 // changed. The actual test of validity is carried out by
121 // the checkedLineEdit.
122 add_bc_.setValid(true);
126 void GuiBibtex::change_adaptor()
132 void GuiBibtex::browsePressed()
134 docstring const file = browseBst(docstring());
138 docstring const filen = from_utf8(changeExtension(to_utf8(file), ""));
139 bool present = false;
140 unsigned int pres = 0;
142 for (int i = 0; i != styleCB->count(); ++i) {
143 if (qstring_to_ucs4(styleCB->itemText(i)) == filen) {
150 styleCB->insertItem(0, toqstr(filen));
152 styleCB->setCurrentIndex(pres);
158 void GuiBibtex::browseBibPressed()
160 docstring const file = trim(browseBib(docstring()));
164 QString const f = toqstr(changeExtension(to_utf8(file), ""));
165 bool present = false;
167 for (int i = 0; i < add_->bibLW->count(); ++i) {
168 if (add_->bibLW->item(i)->text() == f)
173 add_->bibLW->addItem(f);
177 add_->bibED->setText(f);
182 void GuiBibtex::addPressed()
184 add_bc_.setValid(false);
189 void GuiBibtex::addDatabase()
191 int const sel = add_->bibLW->currentRow();
192 docstring const file = trim(qstring_to_ucs4(add_->bibED->text()));
194 if (sel < 0 && file.empty())
197 // Add the selected browser_bib keys to browser_database
198 // multiple selections are possible
199 for (int i = 0; i != add_->bibLW->count(); ++i) {
200 QListWidgetItem * const item = add_->bibLW->item(i);
201 if (add_->bibLW->isItemSelected(item)) {
202 add_->bibLW->setItemSelected(item, false);
203 QList<QListWidgetItem *> matches =
204 databaseLW->findItems(item->text(), Qt::MatchExactly);
205 if (matches.empty()) {
206 QString label = item->text();
207 QListWidgetItem * db = new QListWidgetItem(label);
208 db->setFlags(db->flags() | Qt::ItemIsSelectable
209 | Qt::ItemIsUserCheckable);
210 db->setCheckState(Qt::Checked);
211 databaseLW->addItem(db);
217 add_->bibED->clear();
218 QString const f = toqstr(from_utf8(changeExtension(to_utf8(file), "")));
219 QList<QListWidgetItem *> matches =
220 databaseLW->findItems(f, Qt::MatchExactly);
221 if (matches.empty()) {
222 QListWidgetItem * db = new QListWidgetItem(f);
223 db->setFlags(db->flags() | Qt::ItemIsSelectable
224 | Qt::ItemIsUserCheckable);
225 db->setCheckState(Qt::Checked);
226 databaseLW->addItem(db);
234 void GuiBibtex::deletePressed()
236 QListWidgetItem *cur = databaseLW->takeItem(databaseLW->currentRow());
244 void GuiBibtex::upPressed()
246 int row = databaseLW->currentRow();
247 QListWidgetItem *cur;
248 databaseLW->insertItem(row - 1, cur = databaseLW->takeItem(row));
249 databaseLW->setCurrentItem(cur);
254 void GuiBibtex::downPressed()
256 int row = databaseLW->currentRow();
257 QListWidgetItem *cur;
258 databaseLW->insertItem(row + 1, cur = databaseLW->takeItem(row));
259 databaseLW->setCurrentItem(cur);
264 void GuiBibtex::databaseChanged()
266 deletePB->setEnabled(!isBufferReadonly() && databaseLW->currentRow() != -1);
267 upPB->setEnabled(!isBufferReadonly() && databaseLW->count() > 1 &&
268 databaseLW->currentRow() > 0);
269 downPB->setEnabled(!isBufferReadonly() && databaseLW->count() > 1 &&
270 databaseLW->currentRow() < databaseLW->count() - 1);
274 void GuiBibtex::availableChanged()
276 add_bc_.setValid(true);
280 void GuiBibtex::closeEvent(QCloseEvent *e)
287 void GuiBibtex::updateContents()
289 bool bibtopic = usingBibtopic();
293 docstring bibs = params_["bibfiles"];
294 docstring embs = params_["embed"];
298 while (!bibs.empty()) {
299 bibs = split(bibs, bib, ',');
300 embs = split(embs, emb, ',');
303 QListWidgetItem * db = new QListWidgetItem(toqstr(bib));
304 db->setFlags(db->flags() | Qt::ItemIsSelectable
305 | Qt::ItemIsUserCheckable);
306 db->setCheckState(emb.empty() ? Qt::Unchecked : Qt::Checked);
307 databaseLW->addItem(db);
311 add_->bibLW->clear();
313 vector<string> bib_str;
314 getBibFiles(bib_str);
315 for (vector<string>::const_iterator it = bib_str.begin();
316 it != bib_str.end(); ++it) {
317 string bibItem(changeExtension(*it, ""));
318 add_->bibLW->addItem(toqstr(bibItem));
321 string bibstyle = getStylefile();
323 bibtocCB->setChecked(bibtotoc() && !bibtopic);
324 bibtocCB->setEnabled(!bibtopic);
326 if (!bibtopic && btPrintCO->count() == 3)
327 btPrintCO->removeItem(1);
328 else if (bibtopic && btPrintCO->count() < 3)
329 btPrintCO->insertItem(1, qt_("all uncited references", 0));
331 docstring btprint = params_["btprint"];
333 if ((bibtopic && btprint == "btPrintNotCited") ||
334 (!bibtopic && btprint == "btPrintAll"))
336 else if (bibtopic && btprint == "btPrintAll")
339 btPrintCO->setCurrentIndex(btp);
347 for (vector<string>::const_iterator it = str.begin();
348 it != str.end(); ++it) {
349 string item(changeExtension(*it, ""));
350 if (item == bibstyle)
351 item_nr = int(it - str.begin());
352 styleCB->addItem(toqstr(item));
355 if (item_nr == -1 && !bibstyle.empty()) {
356 styleCB->addItem(toqstr(bibstyle));
357 item_nr = styleCB->count() - 1;
361 styleCB->setCurrentIndex(item_nr);
363 styleCB->clearEditText();
367 void GuiBibtex::applyView()
369 docstring dbs = qstring_to_ucs4(databaseLW->item(0)->text());
370 docstring emb = databaseLW->item(0)->checkState() == Qt::Checked ? _("true") : _("false");
372 unsigned int maxCount = databaseLW->count();
373 for (unsigned int i = 1; i < maxCount; i++) {
375 dbs += qstring_to_ucs4(databaseLW->item(i)->text());
377 emb += databaseLW->item(i)->checkState() == Qt::Checked ? _("true") : _("false");
380 params_["bibfiles"] = dbs;
381 params_["embed"] = emb;
383 docstring const bibstyle = qstring_to_ucs4(styleCB->currentText());
384 bool const bibtotoc = bibtocCB->isChecked();
386 if (bibtotoc && (!bibstyle.empty())) {
387 // both bibtotoc and style
388 params_["options"] = "bibtotoc," + bibstyle;
389 } else if (bibtotoc) {
390 // bibtotoc and no style
391 params_["options"] = from_ascii("bibtotoc");
393 // only style. An empty one is valid, because some
394 // documentclasses have an own \bibliographystyle{}
396 params_["options"] = bibstyle;
399 int btp = btPrintCO->currentIndex();
401 if (usingBibtopic()) {
402 // bibtopic allows three kinds of sections:
403 // 1. sections that include all cited references of the database(s)
404 // 2. sections that include all uncited references of the database(s)
405 // 3. sections that include all references of the database(s), cited or not
408 params_["btprint"] = from_ascii("btPrintCited");
411 params_["btprint"] = from_ascii("btPrintNotCited");
414 params_["btprint"] = from_ascii("btPrintAll");
420 params_["btprint"] = docstring();
424 params_["btprint"] = from_ascii("btPrintAll");
431 bool GuiBibtex::isValid()
433 return databaseLW->count() != 0;
437 docstring const GuiBibtex::browseBib(docstring const & in_name) const
440 docstring const label1 = _("Documents|#o#O");
441 docstring const dir1 = from_utf8(lyxrc.document_path);
442 FileFilterList const filter(_("BibTeX Databases (*.bib)"));
443 return browseRelFile(in_name, from_utf8(bufferFilepath()),
444 _("Select a BibTeX database to add"), filter, false, label1, dir1);
448 docstring const GuiBibtex::browseBst(docstring const & in_name) const
451 docstring const label1 = _("Documents|#o#O");
452 docstring const dir1 = from_utf8(lyxrc.document_path);
453 FileFilterList const filter(_("BibTeX Styles (*.bst)"));
454 return browseRelFile(in_name, from_utf8(bufferFilepath()),
455 _("Select a BibTeX style"), filter, false, label1, dir1);
459 void GuiBibtex::getBibStyles(vector<string> & data) const
463 getTexFileList("bstFiles.lst", data);
464 // test, if we have a valid list, otherwise run rescan
467 getTexFileList("bstFiles.lst", data);
469 vector<string>::iterator it = data.begin();
470 vector<string>::iterator end = data.end();
471 for (; it != end; ++it) {
472 *it = onlyFilename(*it);
474 // sort on filename only (no path)
475 sort(data.begin(), data.end());
479 void GuiBibtex::getBibFiles(vector<string> & data) const
483 getTexFileList("bibFiles.lst", data);
484 // test, if we have a valid list, otherwise run rescan
487 getTexFileList("bibFiles.lst", data);
489 vector<string>::iterator it = data.begin();
490 vector<string>::iterator end = data.end();
491 for (; it != end; ++it) {
492 *it = onlyFilename(*it);
494 // sort on filename only (no path)
495 sort(data.begin(), data.end());
499 void GuiBibtex::rescanBibStyles() const
505 bool GuiBibtex::usingBibtopic() const
507 return buffer().params().use_bibtopic;
511 bool GuiBibtex::bibtotoc() const
513 return prefixIs(to_utf8(params_["options"]), "bibtotoc");
517 string const GuiBibtex::getStylefile() const
519 // the different bibtex packages have (and need) their
520 // own "plain" stylefiles
521 biblio::CiteEngine const engine = buffer().params().getEngine();
522 docstring defaultstyle;
524 case biblio::ENGINE_BASIC:
525 defaultstyle = from_ascii("plain");
527 case biblio::ENGINE_NATBIB_AUTHORYEAR:
528 defaultstyle = from_ascii("plainnat");
530 case biblio::ENGINE_NATBIB_NUMERICAL:
531 defaultstyle = from_ascii("plainnat");
533 case biblio::ENGINE_JURABIB:
534 defaultstyle = from_ascii("jurabib");
538 docstring bst = params_["options"];
541 if (contains(bst, ',')) {
542 docstring bibtotoc = from_ascii("bibtotoc");
543 bst = split(bst, bibtotoc, ',');
548 // propose default style file for new insets
549 // existing insets might have (legally) no bst files
550 // (if the class already provides a style)
551 if (bst.empty() && params_["bibfiles"].empty())
559 Dialog * createGuiBibtex(GuiView & lv) { return new GuiBibtex(lv); }
562 } // namespace frontend
565 #include "GuiBibtex_moc.cpp"