3 * \file GuiCitation.cpp
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
8 * \author Kalle Dalheimer
9 * \author Abdelrazak Younes
10 * \author Richard Heck
12 * Full author contact details are available in file CREDITS.
17 #include "GuiCitation.h"
19 #include "GuiSelectionManager.h"
20 #include "qt_helpers.h"
23 #include "BiblioInfo.h"
24 #include "BufferParams.h"
25 #include "FuncRequest.h"
27 #include "insets/InsetCommand.h"
29 #include "support/debug.h"
30 #include "support/docstring.h"
31 #include "support/gettext.h"
32 #include "support/lstrings.h"
34 #include <QCloseEvent>
44 #include <boost/regex.hpp>
51 using namespace lyx::support;
56 static vector<CiteStyle> citeStyles_;
59 template<typename String>
60 static QStringList to_qstring_list(vector<String> const & v)
64 for (size_t i = 0; i != v.size(); ++i) {
67 qlist.append(lyx::toqstr(v[i]));
73 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
75 vector<lyx::docstring> v;
76 for (int i = 0; i != qlist.size(); ++i) {
77 if (qlist[i].isEmpty())
79 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
85 GuiCitation::GuiCitation(GuiView & lv)
86 : DialogView(lv, "citation", qt_("Citation")),
87 params_(insetCode("citation"))
91 connect(citationStyleCO, SIGNAL(activated(int)),
92 this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
93 connect(fulllistCB, SIGNAL(clicked()),
94 this, SLOT(changed()));
95 connect(forceuppercaseCB, SIGNAL(clicked()),
96 this, SLOT(changed()));
97 connect(textBeforeED, SIGNAL(textChanged(QString)),
98 this, SLOT(changed()));
99 connect(textAfterED, SIGNAL(textChanged(QString)),
100 this, SLOT(changed()));
101 connect(findLE, SIGNAL(returnPressed()),
102 this, SLOT(on_searchPB_clicked()));
103 connect(textBeforeED, SIGNAL(returnPressed()),
104 this, SLOT(on_okPB_clicked()));
105 connect(textAfterED, SIGNAL(returnPressed()),
106 this, SLOT(on_okPB_clicked()));
108 selectionManager = new GuiSelectionManager(availableLV, selectedLV,
109 addPB, deletePB, upPB, downPB, &available_model_, &selected_model_);
110 connect(selectionManager, SIGNAL(selectionChanged()),
111 this, SLOT(setCitedKeys()));
112 connect(selectionManager, SIGNAL(updateHook()),
113 this, SLOT(updateControls()));
114 connect(selectionManager, SIGNAL(okHook()),
115 this, SLOT(on_okPB_clicked()));
117 // FIXME: the sizeHint() for this is _way_ too high
118 infoML->setFixedHeight(60);
122 GuiCitation::~GuiCitation()
124 delete selectionManager;
128 void GuiCitation::closeEvent(QCloseEvent * e)
131 DialogView::closeEvent(e);
135 void GuiCitation::applyView()
137 int const choice = max(0, citationStyleCO->currentIndex());
139 bool const full = fulllistCB->isChecked();
140 bool const force = forceuppercaseCB->isChecked();
142 QString const before = textBeforeED->text();
143 QString const after = textAfterED->text();
145 apply(choice, full, force, before, after);
149 void GuiCitation::showEvent(QShowEvent * e)
152 availableLV->setFocus();
153 DialogView::showEvent(e);
157 void GuiCitation::on_okPB_clicked()
165 void GuiCitation::on_cancelPB_clicked()
172 void GuiCitation::on_applyPB_clicked()
178 void GuiCitation::on_restorePB_clicked()
184 void GuiCitation::updateControls()
186 BiblioInfo const & bi = bibInfo();
191 // The main point of separating this out is that the fill*() methods
192 // called in update() do not need to be called for INTERNAL updates,
193 // such as when addPB is pressed, as the list of fields, entries, etc,
194 // will not have changed. At the moment, however, the division between
195 // fillStyles() and updateStyle() doesn't lend itself to dividing the
196 // two methods, though they should be divisible.
197 void GuiCitation::updateControls(BiblioInfo const & bi)
199 QModelIndex idx = selectionManager->getSelectedIndex();
203 textBeforeED->setText(toqstr(params_["before"]));
204 textAfterED->setText(toqstr(params_["after"]));
210 void GuiCitation::updateFormatting(CiteStyle currentStyle)
212 CiteEngine const engine = citeEngine();
213 bool const natbib_engine =
214 engine == ENGINE_NATBIB_AUTHORYEAR ||
215 engine == ENGINE_NATBIB_NUMERICAL;
216 bool const basic_engine = engine == ENGINE_BASIC;
218 bool const haveSelection =
219 selectedLV->model()->rowCount() > 0;
221 bool const isNocite = currentStyle == NOCITE;
223 bool const isCiteyear =
224 currentStyle == CITEYEAR ||
225 currentStyle == CITEYEARPAR;
227 fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite
229 forceuppercaseCB->setEnabled(natbib_engine && haveSelection
230 && !isNocite && !isCiteyear);
231 textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
232 textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
233 textAfterED->setEnabled(haveSelection && !isNocite);
234 textAfterLA->setEnabled(haveSelection && !isNocite);
235 citationStyleCO->setEnabled(haveSelection);
236 citationStyleLA->setEnabled(haveSelection);
240 void GuiCitation::updateStyle()
242 string const & command = params_.getCmdName();
244 // Find the style of the citekeys
245 vector<CiteStyle> const & styles = citeStyles_;
246 CitationStyle const cs = citationStyleFromString(command);
248 vector<CiteStyle>::const_iterator cit =
249 std::find(styles.begin(), styles.end(), cs.style);
251 // restore the latest natbib style
252 if (style_ >= 0 && style_ < citationStyleCO->count())
253 citationStyleCO->setCurrentIndex(style_);
255 citationStyleCO->setCurrentIndex(0);
257 if (cit != styles.end()) {
258 int const i = int(cit - styles.begin());
259 citationStyleCO->setCurrentIndex(i);
260 fulllistCB->setChecked(cs.full);
261 forceuppercaseCB->setChecked(cs.forceUpperCase);
263 fulllistCB->setChecked(false);
264 forceuppercaseCB->setChecked(false);
266 updateFormatting(cs.style);
270 // This one needs to be called whenever citationStyleCO needs
271 // to be updated---and this would be on anything that changes the
272 // selection in selectedLV, or on a general update.
273 void GuiCitation::fillStyles(BiblioInfo const & bi)
275 QStringList selected_keys = selected_model_.stringList();
276 int curr = selectedLV->model()->rowCount() - 1;
278 if (curr < 0 || selected_keys.empty()) {
279 citationStyleCO->clear();
280 citationStyleCO->setEnabled(false);
281 citationStyleLA->setEnabled(false);
285 int const oldIndex = citationStyleCO->currentIndex();
287 if (!selectedLV->selectionModel()->selectedIndexes().empty())
288 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
290 QStringList sty = citationStyles(bi, curr);
291 citationStyleCO->clear();
295 citationStyleCO->setEnabled(false);
296 citationStyleLA->setEnabled(false);
300 citationStyleCO->insertItems(0, sty);
301 citationStyleCO->setEnabled(true);
302 citationStyleLA->setEnabled(true);
304 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
305 citationStyleCO->setCurrentIndex(oldIndex);
309 void GuiCitation::fillFields(BiblioInfo const & bi)
311 fieldsCO->blockSignals(true);
312 int const oldIndex = fieldsCO->currentIndex();
314 QStringList const fields = to_qstring_list(bi.getFields());
315 fieldsCO->insertItem(0, qt_("All fields"));
316 fieldsCO->insertItem(1, qt_("Keys"));
317 fieldsCO->insertItems(2, fields);
318 if (oldIndex != -1 && oldIndex < fieldsCO->count())
319 fieldsCO->setCurrentIndex(oldIndex);
320 fieldsCO->blockSignals(false);
324 void GuiCitation::fillEntries(BiblioInfo const & bi)
326 entriesCO->blockSignals(true);
327 int const oldIndex = entriesCO->currentIndex();
329 QStringList const entries = to_qstring_list(bi.getEntries());
330 entriesCO->insertItem(0, qt_("All entry types"));
331 entriesCO->insertItems(1, entries);
332 if (oldIndex != -1 && oldIndex < entriesCO->count())
333 entriesCO->setCurrentIndex(oldIndex);
334 entriesCO->blockSignals(false);
338 bool GuiCitation::isSelected(QModelIndex const & idx)
340 QString const str = idx.data().toString();
341 return selected_model_.stringList().contains(str);
345 void GuiCitation::setButtons()
347 selectionManager->update();
348 int const srows = selectedLV->model()->rowCount();
349 applyPB->setEnabled(srows > 0);
350 okPB->setEnabled(srows > 0);
354 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
356 if (!idx.isValid() || bi.empty()) {
357 infoML->document()->clear();
361 QString const keytxt = toqstr(
362 bi.getInfo(qstring_to_ucs4(idx.data().toString())));
363 infoML->document()->setPlainText(keytxt);
367 void GuiCitation::findText(QString const & text, bool reset)
369 //"All Fields" and "Keys" are the first two
370 int index = fieldsCO->currentIndex() - 2;
371 BiblioInfo const & bi = bibInfo();
372 vector<docstring> const & fields = bi.getFields();
375 if (index <= -1 || index >= int(fields.size()))
376 //either "All Fields" or "Keys" or an invalid value
377 field = from_ascii("");
379 field = fields[index];
382 bool const onlyKeys = index == -1;
384 //"All Entry Types" is first.
385 index = entriesCO->currentIndex() - 1;
386 vector<docstring> const & entries = bi.getEntries();
387 docstring entry_type;
388 if (index < 0 || index >= int(entries.size()))
389 entry_type = from_ascii("");
391 entry_type = entries[index];
393 bool const case_sentitive = caseCB->checkState();
394 bool const reg_exp = regexCB->checkState();
395 findKey(bi, text, onlyKeys, field, entry_type,
396 case_sentitive, reg_exp, reset);
398 //It'd be nice to save and restore the current selection in
399 //availableLV. Currently, we get an automatic reset, since the
406 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
408 findText(findLE->text(), true);
412 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
414 findText(findLE->text(), true);
418 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
420 if (index >= 0 && index < citationStyleCO->count()) {
421 vector<CiteStyle> const & styles = citeStyles_;
422 updateFormatting(styles[index]);
427 void GuiCitation::on_findLE_textChanged(const QString & text)
429 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
430 searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
431 if (!text.isEmpty()) {
433 findText(findLE->text());
436 findText(findLE->text());
440 void GuiCitation::on_searchPB_clicked()
442 findText(findLE->text(), true);
446 void GuiCitation::on_caseCB_stateChanged(int)
448 findText(findLE->text());
452 void GuiCitation::on_regexCB_stateChanged(int)
454 findText(findLE->text());
458 void GuiCitation::on_asTypeCB_stateChanged(int)
460 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
461 searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
463 findText(findLE->text(), true);
467 void GuiCitation::changed()
473 void GuiCitation::apply(int const choice, bool full, bool force,
474 QString before, QString after)
476 if (cited_keys_.isEmpty())
479 vector<CiteStyle> const & styles = citeStyles_;
480 if (styles[choice] == NOCITE) {
488 s.style = styles[choice];
490 s.forceUpperCase = force;
491 string const command = citationStyleToString(s);
493 params_.setCmdName(command);
494 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
495 params_["before"] = qstring_to_ucs4(before);
496 params_["after"] = qstring_to_ucs4(after);
501 void GuiCitation::clearSelection()
504 selected_model_.setStringList(cited_keys_);
508 void GuiCitation::init()
510 // Make the list of all available bibliography keys
511 BiblioInfo const & bi = bibInfo();
512 all_keys_ = to_qstring_list(bi.getKeys());
513 available_model_.setStringList(all_keys_);
515 // Ditto for the keys cited in this inset
516 QString str = toqstr(params_["key"]);
520 cited_keys_ = str.split(",");
521 selected_model_.setStringList(cited_keys_);
522 if (selected_model_.rowCount()) {
523 selectedLV->blockSignals(true);
524 selectedLV->setFocus();
525 QModelIndex idx = selected_model_.index(0, 0);
526 selectedLV->selectionModel()->select(idx,
527 QItemSelectionModel::ClearAndSelect);
528 selectedLV->blockSignals(false);
530 availableLV->setFocus();
537 void GuiCitation::findKey(BiblioInfo const & bi,
538 QString const & str, bool only_keys,
539 docstring field, docstring entry_type,
540 bool case_sensitive, bool reg_exp, bool reset)
542 // Used for optimisation: store last searched string.
543 static QString last_searched_string;
544 // Used to disable the above optimisation.
545 static bool last_case_sensitive;
546 static bool last_reg_exp;
547 // Reset last_searched_string in case of changed option.
548 if (last_case_sensitive != case_sensitive
549 || last_reg_exp != reg_exp) {
550 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
551 last_searched_string.clear();
553 // save option for next search.
554 last_case_sensitive = case_sensitive;
555 last_reg_exp = reg_exp;
557 Qt::CaseSensitivity qtcase = case_sensitive ?
558 Qt::CaseSensitive: Qt::CaseInsensitive;
560 // If new string (str) contains the last searched one...
562 !last_searched_string.isEmpty() &&
564 str.contains(last_searched_string, qtcase))
565 // ... then only search within already found list.
566 keys = available_model_.stringList();
568 // ... else search all keys.
570 // save searched string for next search.
571 last_searched_string = str;
575 // First, filter by entry_type, which will be faster than
576 // what follows, so we may get to do that on less.
577 vector<docstring> keyVector = to_docstring_vector(keys);
578 filterByEntryType(bi, keyVector, entry_type);
581 result = to_qstring_list(keyVector);
583 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
584 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
586 available_model_.setStringList(result);
590 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
592 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
593 return to_qstring_list(bi.getCiteStrings(key, buffer()));
597 void GuiCitation::setCitedKeys()
599 cited_keys_ = selected_model_.stringList();
603 bool GuiCitation::initialiseParams(string const & data)
605 InsetCommand::string2params("citation", data, params_);
606 CiteEngine const engine = buffer().params().citeEngine();
607 citeStyles_ = citeStyles(engine);
613 void GuiCitation::clearParams()
619 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
620 vector<docstring> & keyVector, docstring entry_type)
622 if (entry_type.empty())
625 vector<docstring>::iterator it = keyVector.begin();
626 vector<docstring>::iterator end = keyVector.end();
628 vector<docstring> result;
629 for (; it != end; ++it) {
630 docstring const key = *it;
631 BiblioInfo::const_iterator cit = bi.find(key);
634 if (cit->second.entryType() == entry_type)
635 result.push_back(key);
641 CiteEngine GuiCitation::citeEngine() const
643 return buffer().params().citeEngine();
647 // Escape special chars.
648 // All characters are literals except: '.|*?+(){}[]^$\'
649 // These characters are literals when preceded by a "\", which is done here
650 // @todo: This function should be moved to support, and then the test in tests
651 // should be moved there as well.
652 static docstring escape_special_chars(docstring const & expr)
654 // Search for all chars '.|*?+(){}[^$]\'
655 // Note that '[' and '\' must be escaped.
656 // This is a limitation of boost::regex, but all other chars in BREs
657 // are assumed literal.
658 static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
660 // $& is a perl-like expression that expands to all
661 // of the current match
662 // The '$' must be prefixed with the escape character '\' for
663 // boost to treat it as a literal.
664 // Thus, to prefix a matched expression with '\', we use:
666 return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
670 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
671 vector<docstring> const & keys_to_search, bool only_keys,
672 docstring const & search_expression, docstring field,
673 bool case_sensitive, bool regex)
675 vector<docstring> foundKeys;
677 docstring expr = trim(search_expression);
682 // We must escape special chars in the search_expr so that
683 // it is treated as a simple string by boost::regex.
684 expr = escape_special_chars(expr);
686 boost::regex reg_exp;
688 reg_exp.assign(to_utf8(expr), case_sensitive ?
689 boost::regex_constants::normal : boost::regex_constants::icase);
690 } catch (boost::regex_error & e) {
691 // boost::regex throws an exception if the regular expression is not
693 LYXERR(Debug::GUI, e.what());
694 return vector<docstring>();
697 vector<docstring>::const_iterator it = keys_to_search.begin();
698 vector<docstring>::const_iterator end = keys_to_search.end();
699 for (; it != end; ++it ) {
700 BiblioInfo::const_iterator info = bi.find(*it);
701 if (info == bi.end())
704 BibTeXInfo const & kvm = info->second;
708 else if (field.empty())
709 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
711 data = to_utf8(kvm[field]);
717 if (boost::regex_search(data, reg_exp))
718 foundKeys.push_back(*it);
720 catch (boost::regex_error & e) {
721 LYXERR(Debug::GUI, e.what());
722 return vector<docstring>();
729 void GuiCitation::dispatchParams()
731 std::string const lfun = InsetCommand::params2string("citation", params_);
732 dispatch(FuncRequest(getLfun(), lfun));
736 BiblioInfo const & GuiCitation::bibInfo() const
738 buffer().checkBibInfoCache();
739 return buffer().masterBibInfo();
743 void GuiCitation::saveSession() const
745 Dialog::saveSession();
748 sessionKey() + "/regex", regexCB->isChecked());
750 sessionKey() + "/casesensitive", caseCB->isChecked());
752 sessionKey() + "/autofind", asTypeCB->isChecked());
756 void GuiCitation::restoreSession()
758 Dialog::restoreSession();
761 settings.value(sessionKey() + "/regex").toBool());
763 settings.value(sessionKey() + "/casesensitive").toBool());
764 asTypeCB->setChecked(
765 settings.value(sessionKey() + "/autofind").toBool());
769 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
772 } // namespace frontend
775 #include "moc_GuiCitation.cpp"