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 "support/regex.h"
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. That is, we should
197 // not have to call fillStyles() every time through here.
198 void GuiCitation::updateControls(BiblioInfo const & bi)
200 QModelIndex idx = selectionManager->getSelectedIndex();
204 textBeforeED->setText(toqstr(params_["before"]));
205 textAfterED->setText(toqstr(params_["after"]));
211 void GuiCitation::updateFormatting(CiteStyle currentStyle)
213 CiteEngine const engine = citeEngine();
214 bool const natbib_engine =
215 engine == ENGINE_NATBIB_AUTHORYEAR ||
216 engine == ENGINE_NATBIB_NUMERICAL;
217 bool const basic_engine = engine == ENGINE_BASIC;
219 bool const haveSelection =
220 selectedLV->model()->rowCount() > 0;
222 bool const isNocite = currentStyle == NOCITE;
224 bool const isCiteyear =
225 currentStyle == CITEYEAR ||
226 currentStyle == CITEYEARPAR;
228 fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite
230 forceuppercaseCB->setEnabled(natbib_engine && haveSelection
231 && !isNocite && !isCiteyear);
232 textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
233 textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
234 textAfterED->setEnabled(haveSelection && !isNocite);
235 textAfterLA->setEnabled(haveSelection && !isNocite);
236 citationStyleCO->setEnabled(haveSelection);
237 citationStyleLA->setEnabled(haveSelection);
241 void GuiCitation::updateStyle()
243 string const & command = params_.getCmdName();
245 // Find the style of the citekeys
246 vector<CiteStyle> const & styles = citeStyles_;
247 CitationStyle const cs = citationStyleFromString(command);
249 vector<CiteStyle>::const_iterator cit =
250 std::find(styles.begin(), styles.end(), cs.style);
252 if (cit != styles.end()) {
253 fulllistCB->setChecked(cs.full);
254 forceuppercaseCB->setChecked(cs.forceUpperCase);
256 // restore the last used natbib style
257 if (style_ >= 0 && style_ < citationStyleCO->count()) {
258 // the necessary update will be performed later
259 citationStyleCO->blockSignals(true);
260 citationStyleCO->setCurrentIndex(style_);
261 citationStyleCO->blockSignals(false);
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 if (!selectedLV->selectionModel()->selectedIndexes().empty())
286 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
288 QStringList sty = citationStyles(bi, curr);
292 citationStyleCO->setEnabled(false);
293 citationStyleLA->setEnabled(false);
294 citationStyleCO->clear();
298 citationStyleCO->blockSignals(true);
301 int const oldIndex = citationStyleCO->currentIndex();
302 citationStyleCO->clear();
303 citationStyleCO->insertItems(0, sty);
304 citationStyleCO->setEnabled(true);
305 citationStyleLA->setEnabled(true);
307 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
308 citationStyleCO->setCurrentIndex(oldIndex);
310 citationStyleCO->blockSignals(false);
314 void GuiCitation::fillFields(BiblioInfo const & bi)
316 fieldsCO->blockSignals(true);
317 int const oldIndex = fieldsCO->currentIndex();
319 QStringList const fields = to_qstring_list(bi.getFields());
320 fieldsCO->insertItem(0, qt_("All fields"));
321 fieldsCO->insertItem(1, qt_("Keys"));
322 fieldsCO->insertItems(2, fields);
323 if (oldIndex != -1 && oldIndex < fieldsCO->count())
324 fieldsCO->setCurrentIndex(oldIndex);
325 fieldsCO->blockSignals(false);
329 void GuiCitation::fillEntries(BiblioInfo const & bi)
331 entriesCO->blockSignals(true);
332 int const oldIndex = entriesCO->currentIndex();
334 QStringList const entries = to_qstring_list(bi.getEntries());
335 entriesCO->insertItem(0, qt_("All entry types"));
336 entriesCO->insertItems(1, entries);
337 if (oldIndex != -1 && oldIndex < entriesCO->count())
338 entriesCO->setCurrentIndex(oldIndex);
339 entriesCO->blockSignals(false);
343 bool GuiCitation::isSelected(QModelIndex const & idx)
345 QString const str = idx.data().toString();
346 return selected_model_.stringList().contains(str);
350 void GuiCitation::setButtons()
352 selectionManager->update();
353 int const srows = selectedLV->model()->rowCount();
354 applyPB->setEnabled(srows > 0);
355 okPB->setEnabled(srows > 0);
359 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
361 if (!idx.isValid() || bi.empty()) {
362 infoML->document()->clear();
366 QString const keytxt = toqstr(
367 bi.getInfo(qstring_to_ucs4(idx.data().toString()), buffer(), true));
368 infoML->document()->setHtml(keytxt);
372 void GuiCitation::findText(QString const & text, bool reset)
374 //"All Fields" and "Keys" are the first two
375 int index = fieldsCO->currentIndex() - 2;
376 BiblioInfo const & bi = bibInfo();
377 vector<docstring> const & fields = bi.getFields();
380 if (index <= -1 || index >= int(fields.size()))
381 //either "All Fields" or "Keys" or an invalid value
382 field = from_ascii("");
384 field = fields[index];
387 bool const onlyKeys = index == -1;
389 //"All Entry Types" is first.
390 index = entriesCO->currentIndex() - 1;
391 vector<docstring> const & entries = bi.getEntries();
392 docstring entry_type;
393 if (index < 0 || index >= int(entries.size()))
394 entry_type = from_ascii("");
396 entry_type = entries[index];
398 bool const case_sentitive = caseCB->checkState();
399 bool const reg_exp = regexCB->checkState();
400 findKey(bi, text, onlyKeys, field, entry_type,
401 case_sentitive, reg_exp, reset);
403 //It'd be nice to save and restore the current selection in
404 //availableLV. Currently, we get an automatic reset, since the
411 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
413 findText(findLE->text(), true);
417 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
419 findText(findLE->text(), true);
423 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
425 if (index >= 0 && index < citationStyleCO->count()) {
426 vector<CiteStyle> const & styles = citeStyles_;
427 updateFormatting(styles[index]);
432 void GuiCitation::on_findLE_textChanged(const QString & text)
434 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
435 searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
436 if (!text.isEmpty()) {
438 findText(findLE->text());
441 findText(findLE->text());
445 void GuiCitation::on_searchPB_clicked()
447 findText(findLE->text(), true);
451 void GuiCitation::on_caseCB_stateChanged(int)
453 findText(findLE->text());
457 void GuiCitation::on_regexCB_stateChanged(int)
459 findText(findLE->text());
463 void GuiCitation::on_asTypeCB_stateChanged(int)
465 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
466 searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
468 findText(findLE->text(), true);
472 void GuiCitation::changed()
478 void GuiCitation::apply(int const choice, bool full, bool force,
479 QString before, QString after)
481 if (cited_keys_.isEmpty())
484 vector<CiteStyle> const & styles = citeStyles_;
485 if (styles[choice] == NOCITE) {
493 s.style = styles[choice];
495 s.forceUpperCase = force;
496 string const command = citationStyleToString(s);
498 params_.setCmdName(command);
499 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
500 params_["before"] = qstring_to_ucs4(before);
501 params_["after"] = qstring_to_ucs4(after);
506 void GuiCitation::clearSelection()
509 selected_model_.setStringList(cited_keys_);
513 void GuiCitation::init()
515 // Make the list of all available bibliography keys
516 BiblioInfo const & bi = bibInfo();
517 all_keys_ = to_qstring_list(bi.getKeys());
518 available_model_.setStringList(all_keys_);
520 // Ditto for the keys cited in this inset
521 QString str = toqstr(params_["key"]);
525 cited_keys_ = str.split(",");
526 selected_model_.setStringList(cited_keys_);
527 if (selected_model_.rowCount()) {
528 selectedLV->blockSignals(true);
529 selectedLV->setFocus();
530 QModelIndex idx = selected_model_.index(0, 0);
531 selectedLV->selectionModel()->select(idx,
532 QItemSelectionModel::ClearAndSelect);
533 selectedLV->blockSignals(false);
535 // set the style combo appropriately
536 string const & command = params_.getCmdName();
537 vector<CiteStyle> const & styles = citeStyles_;
538 CitationStyle const cs = citationStyleFromString(command);
540 vector<CiteStyle>::const_iterator cit =
541 std::find(styles.begin(), styles.end(), cs.style);
542 if (cit != styles.end()) {
543 int const i = int(cit - styles.begin());
544 // the necessary update will be performed later
545 citationStyleCO->blockSignals(true);
546 citationStyleCO->setCurrentIndex(i);
547 citationStyleCO->blockSignals(false);
550 availableLV->setFocus();
557 void GuiCitation::findKey(BiblioInfo const & bi,
558 QString const & str, bool only_keys,
559 docstring field, docstring entry_type,
560 bool case_sensitive, bool reg_exp, bool reset)
562 // Used for optimisation: store last searched string.
563 static QString last_searched_string;
564 // Used to disable the above optimisation.
565 static bool last_case_sensitive;
566 static bool last_reg_exp;
567 // Reset last_searched_string in case of changed option.
568 if (last_case_sensitive != case_sensitive
569 || last_reg_exp != reg_exp) {
570 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
571 last_searched_string.clear();
573 // save option for next search.
574 last_case_sensitive = case_sensitive;
575 last_reg_exp = reg_exp;
577 Qt::CaseSensitivity qtcase = case_sensitive ?
578 Qt::CaseSensitive: Qt::CaseInsensitive;
580 // If new string (str) contains the last searched one...
582 !last_searched_string.isEmpty() &&
584 str.contains(last_searched_string, qtcase))
585 // ... then only search within already found list.
586 keys = available_model_.stringList();
588 // ... else search all keys.
590 // save searched string for next search.
591 last_searched_string = str;
595 // First, filter by entry_type, which will be faster than
596 // what follows, so we may get to do that on less.
597 vector<docstring> keyVector = to_docstring_vector(keys);
598 filterByEntryType(bi, keyVector, entry_type);
601 result = to_qstring_list(keyVector);
603 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
604 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
606 available_model_.setStringList(result);
610 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
612 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
613 return to_qstring_list(bi.getCiteStrings(key, buffer()));
617 void GuiCitation::setCitedKeys()
619 cited_keys_ = selected_model_.stringList();
623 bool GuiCitation::initialiseParams(string const & data)
625 InsetCommand::string2params("citation", data, params_);
626 CiteEngine const engine = buffer().params().citeEngine();
627 citeStyles_ = citeStyles(engine);
633 void GuiCitation::clearParams()
639 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
640 vector<docstring> & keyVector, docstring entry_type)
642 if (entry_type.empty())
645 vector<docstring>::iterator it = keyVector.begin();
646 vector<docstring>::iterator end = keyVector.end();
648 vector<docstring> result;
649 for (; it != end; ++it) {
650 docstring const key = *it;
651 BiblioInfo::const_iterator cit = bi.find(key);
654 if (cit->second.entryType() == entry_type)
655 result.push_back(key);
661 CiteEngine GuiCitation::citeEngine() const
663 return buffer().params().citeEngine();
667 // Escape special chars.
668 // All characters are literals except: '.|*?+(){}[]^$\'
669 // These characters are literals when preceded by a "\", which is done here
670 // @todo: This function should be moved to support, and then the test in tests
671 // should be moved there as well.
672 static docstring escape_special_chars(docstring const & expr)
674 // Search for all chars '.|*?+(){}[^$]\'
675 // Note that '[' and '\' must be escaped.
676 // This is a limitation of lyx::regex, but all other chars in BREs
677 // are assumed literal.
678 static const lyx::regex reg("[].|*?+(){}^$\\[\\\\]");
680 // $& is a perl-like expression that expands to all
681 // of the current match
682 // The '$' must be prefixed with the escape character '\' for
683 // boost to treat it as a literal.
684 // Thus, to prefix a matched expression with '\', we use:
686 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
690 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
691 vector<docstring> const & keys_to_search, bool only_keys,
692 docstring const & search_expression, docstring field,
693 bool case_sensitive, bool regex)
695 vector<docstring> foundKeys;
697 docstring expr = trim(search_expression);
702 // We must escape special chars in the search_expr so that
703 // it is treated as a simple string by lyx::regex.
704 expr = escape_special_chars(expr);
708 reg_exp.assign(to_utf8(expr), case_sensitive ?
709 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
710 } catch (lyx::regex_error & e) {
711 // lyx::regex throws an exception if the regular expression is not
713 LYXERR(Debug::GUI, e.what());
714 return vector<docstring>();
717 vector<docstring>::const_iterator it = keys_to_search.begin();
718 vector<docstring>::const_iterator end = keys_to_search.end();
719 for (; it != end; ++it ) {
720 BiblioInfo::const_iterator info = bi.find(*it);
721 if (info == bi.end())
724 BibTeXInfo const & kvm = info->second;
728 else if (field.empty())
729 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
731 data = to_utf8(kvm[field]);
737 if (lyx::regex_search(data, reg_exp))
738 foundKeys.push_back(*it);
740 catch (lyx::regex_error & e) {
741 LYXERR(Debug::GUI, e.what());
742 return vector<docstring>();
749 void GuiCitation::dispatchParams()
751 std::string const lfun = InsetCommand::params2string("citation", params_);
752 dispatch(FuncRequest(getLfun(), lfun));
756 BiblioInfo const & GuiCitation::bibInfo() const
758 buffer().checkBibInfoCache();
759 return buffer().masterBibInfo();
763 void GuiCitation::saveSession() const
765 Dialog::saveSession();
768 sessionKey() + "/regex", regexCB->isChecked());
770 sessionKey() + "/casesensitive", caseCB->isChecked());
772 sessionKey() + "/autofind", asTypeCB->isChecked());
776 void GuiCitation::restoreSession()
778 Dialog::restoreSession();
781 settings.value(sessionKey() + "/regex").toBool());
783 settings.value(sessionKey() + "/casesensitive").toBool());
784 asTypeCB->setChecked(
785 settings.value(sessionKey() + "/autofind").toBool());
789 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
792 } // namespace frontend
795 #include "moc_GuiCitation.cpp"