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(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()));
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);
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()));
97 bc().setPolicy(ButtonPolicy::NoRepeatedApplyReadOnlyPolicy);
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);
109 void GuiBibtex::bibEDChanged()
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);
118 void GuiBibtex::change_adaptor()
124 void GuiBibtex::browsePressed()
126 docstring const file = browseBst(docstring());
130 docstring const filen = from_utf8(changeExtension(to_utf8(file), ""));
131 bool present = false;
132 unsigned int pres = 0;
134 for (int i = 0; i != styleCB->count(); ++i) {
135 if (qstring_to_ucs4(styleCB->itemText(i)) == filen) {
142 styleCB->insertItem(0, toqstr(filen));
144 styleCB->setCurrentIndex(pres);
150 void GuiBibtex::browseBibPressed()
152 docstring const file = trim(browseBib(docstring()));
156 QString const f = toqstr(changeExtension(to_utf8(file), ""));
157 bool present = false;
159 for (int i = 0; i < add_->bibLW->count(); ++i) {
160 if (add_->bibLW->item(i)->text() == f)
165 add_->bibLW->addItem(f);
169 add_->bibED->setText(f);
174 void GuiBibtex::addPressed()
176 add_bc_.setValid(false);
181 void GuiBibtex::addDatabase()
183 int const sel = add_->bibLW->currentRow();
184 docstring const file = trim(qstring_to_ucs4(add_->bibED->text()));
186 if (sel < 0 && file.empty())
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);
198 databaseLW->addItem(item->text());
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);
208 databaseLW->addItem(f);
215 void GuiBibtex::deletePressed()
217 databaseLW->takeItem(databaseLW->currentRow());
223 void GuiBibtex::databaseChanged()
225 deletePB->setEnabled(!isBufferReadonly() && databaseLW->currentRow() != -1);
229 void GuiBibtex::availableChanged()
231 add_bc_.setValid(true);
235 void GuiBibtex::closeEvent(QCloseEvent *e)
242 void GuiBibtex::updateContents()
244 bool bibtopic = usingBibtopic();
248 docstring bibs = params_["bibfiles"];
251 while (!bibs.empty()) {
252 bibs = split(bibs, bib, ',');
255 databaseLW->addItem(toqstr(bib));
258 add_->bibLW->clear();
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));
268 string bibstyle = getStylefile();
270 bibtocCB->setChecked(bibtotoc() && !bibtopic);
271 bibtocCB->setEnabled(!bibtopic);
273 docstring btprint = params_["btprint"];
275 if (btprint == "btPrintNotCited")
277 else if (btprint == "btPrintAll")
280 btPrintCO->setCurrentIndex(btp);
281 btPrintCO->setEnabled(bibtopic);
289 for (vector<string>::const_iterator it = str.begin();
290 it != str.end(); ++it) {
291 string item(changeExtension(*it, ""));
292 if (item == bibstyle)
293 item_nr = int(it - str.begin());
294 styleCB->addItem(toqstr(item));
297 if (item_nr == -1 && !bibstyle.empty()) {
298 styleCB->addItem(toqstr(bibstyle));
299 item_nr = styleCB->count() - 1;
303 styleCB->setCurrentIndex(item_nr);
305 styleCB->clearEditText();
309 void GuiBibtex::applyView()
311 docstring dbs = qstring_to_ucs4(databaseLW->item(0)->text());
313 unsigned int maxCount = databaseLW->count();
314 for (unsigned int i = 1; i < maxCount; i++) {
316 dbs += qstring_to_ucs4(databaseLW->item(i)->text());
319 params_["bibfiles"] = dbs;
321 docstring const bibstyle = qstring_to_ucs4(styleCB->currentText());
322 bool const bibtotoc = bibtocCB->isChecked();
324 if (bibtotoc && (!bibstyle.empty())) {
325 // both bibtotoc and style
326 params_["options"] = "bibtotoc," + bibstyle;
327 } else if (bibtotoc) {
328 // bibtotoc and no style
329 params_["options"] = from_ascii("bibtotoc");
331 // only style. An empty one is valid, because some
332 // documentclasses have an own \bibliographystyle{}
334 params_["options"] = bibstyle;
337 // bibtopic allows three kinds of sections:
338 // 1. sections that include all cited references of the database(s)
339 // 2. sections that include all uncited references of the database(s)
340 // 3. sections that include all references of the database(s), cited or not
341 int btp = btPrintCO->currentIndex();
345 params_["btprint"] = from_ascii("btPrintCited");
348 params_["btprint"] = from_ascii("btPrintNotCited");
351 params_["btprint"] = from_ascii("btPrintAll");
355 if (!usingBibtopic())
356 params_["btprint"] = docstring();
360 bool GuiBibtex::isValid()
362 return databaseLW->count() != 0;
366 docstring const GuiBibtex::browseBib(docstring const & in_name) const
369 docstring const label1 = _("Documents|#o#O");
370 docstring const dir1 = from_utf8(lyxrc.document_path);
371 FileFilterList const filter(_("BibTeX Databases (*.bib)"));
372 return browseRelFile(in_name, from_utf8(bufferFilepath()),
373 _("Select a BibTeX database to add"), filter, false, label1, dir1);
377 docstring const GuiBibtex::browseBst(docstring const & in_name) const
380 docstring const label1 = _("Documents|#o#O");
381 docstring const dir1 = from_utf8(lyxrc.document_path);
382 FileFilterList const filter(_("BibTeX Styles (*.bst)"));
383 return browseRelFile(in_name, from_utf8(bufferFilepath()),
384 _("Select a BibTeX style"), filter, false, label1, dir1);
388 void GuiBibtex::getBibStyles(vector<string> & data) const
392 getTexFileList("bstFiles.lst", data);
393 // test, if we have a valid list, otherwise run rescan
396 getTexFileList("bstFiles.lst", data);
398 vector<string>::iterator it = data.begin();
399 vector<string>::iterator end = data.end();
400 for (; it != end; ++it) {
401 *it = onlyFilename(*it);
403 // sort on filename only (no path)
404 sort(data.begin(), data.end());
408 void GuiBibtex::getBibFiles(vector<string> & data) const
412 getTexFileList("bibFiles.lst", data);
413 // test, if we have a valid list, otherwise run rescan
416 getTexFileList("bibFiles.lst", data);
418 vector<string>::iterator it = data.begin();
419 vector<string>::iterator end = data.end();
420 for (; it != end; ++it) {
421 *it = onlyFilename(*it);
423 // sort on filename only (no path)
424 sort(data.begin(), data.end());
428 void GuiBibtex::rescanBibStyles() const
434 bool GuiBibtex::usingBibtopic() const
436 return buffer().params().use_bibtopic;
440 bool GuiBibtex::bibtotoc() const
442 return prefixIs(to_utf8(params_["options"]), "bibtotoc");
446 string const GuiBibtex::getStylefile() const
448 // the different bibtex packages have (and need) their
449 // own "plain" stylefiles
450 biblio::CiteEngine const engine = buffer().params().getEngine();
451 docstring defaultstyle;
453 case biblio::ENGINE_BASIC:
454 defaultstyle = from_ascii("plain");
456 case biblio::ENGINE_NATBIB_AUTHORYEAR:
457 defaultstyle = from_ascii("plainnat");
459 case biblio::ENGINE_NATBIB_NUMERICAL:
460 defaultstyle = from_ascii("plainnat");
462 case biblio::ENGINE_JURABIB:
463 defaultstyle = from_ascii("jurabib");
467 docstring bst = params_["options"];
470 if (contains(bst, ',')) {
471 docstring bibtotoc = from_ascii("bibtotoc");
472 bst = split(bst, bibtotoc, ',');
477 // propose default style file for new insets
478 // existing insets might have (legally) no bst files
479 // (if the class already provides a style)
480 if (bst.empty() && params_["bibfiles"].empty())
488 Dialog * createGuiBibtex(GuiView & lv) { return new GuiBibtex(lv); }
491 } // namespace frontend
494 #include "GuiBibtex_moc.cpp"