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 "BufferView.h"
24 #include "BiblioInfo.h"
25 #include "BufferParams.h"
26 #include "FuncRequest.h"
28 #include "insets/InsetCommand.h"
30 #include "support/debug.h"
31 #include "support/docstring.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
35 #include <QCloseEvent>
45 #include "support/regex.h"
52 using namespace lyx::support;
57 static vector<CiteStyle> citeStyles_;
60 template<typename String>
61 static QStringList to_qstring_list(vector<String> const & v)
65 for (size_t i = 0; i != v.size(); ++i) {
68 qlist.append(lyx::toqstr(v[i]));
74 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
76 vector<lyx::docstring> v;
77 for (int i = 0; i != qlist.size(); ++i) {
78 if (qlist[i].isEmpty())
80 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
86 GuiCitation::GuiCitation(GuiView & lv)
87 : DialogView(lv, "citation", qt_("Citation")),
88 params_(insetCode("citation"))
92 connect(citationStyleCO, SIGNAL(activated(int)),
93 this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
94 connect(fulllistCB, SIGNAL(clicked()),
95 this, SLOT(changed()));
96 connect(forceuppercaseCB, SIGNAL(clicked()),
97 this, SLOT(changed()));
98 connect(textBeforeED, SIGNAL(textChanged(QString)),
99 this, SLOT(changed()));
100 connect(textAfterED, SIGNAL(textChanged(QString)),
101 this, SLOT(changed()));
102 connect(findLE, SIGNAL(returnPressed()),
103 this, SLOT(on_searchPB_clicked()));
104 connect(textBeforeED, SIGNAL(returnPressed()),
105 this, SLOT(on_okPB_clicked()));
106 connect(textAfterED, SIGNAL(returnPressed()),
107 this, SLOT(on_okPB_clicked()));
109 selectionManager = new GuiSelectionManager(availableLV, selectedLV,
110 addPB, deletePB, upPB, downPB, &available_model_, &selected_model_);
111 connect(selectionManager, SIGNAL(selectionChanged()),
112 this, SLOT(setCitedKeys()));
113 connect(selectionManager, SIGNAL(updateHook()),
114 this, SLOT(updateControls()));
115 connect(selectionManager, SIGNAL(okHook()),
116 this, SLOT(on_okPB_clicked()));
118 setFocusProxy(availableLV);
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 = engine == ENGINE_NATBIB;
215 bool const basic_engine = engine == ENGINE_BASIC;
217 bool const haveSelection =
218 selectedLV->model()->rowCount() > 0;
220 bool const isNocite = currentStyle == NOCITE;
222 bool const isCiteyear =
223 currentStyle == CITEYEAR ||
224 currentStyle == CITEYEARPAR;
226 fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite
228 forceuppercaseCB->setEnabled(natbib_engine && haveSelection
229 && !isNocite && !isCiteyear);
230 textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
231 textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
232 textAfterED->setEnabled(haveSelection && !isNocite);
233 textAfterLA->setEnabled(haveSelection && !isNocite);
234 citationStyleCO->setEnabled(haveSelection);
235 citationStyleLA->setEnabled(haveSelection);
239 void GuiCitation::updateStyle()
241 string const & command = params_.getCmdName();
243 // Find the style of the citekeys
244 vector<CiteStyle> const & styles = citeStyles_;
245 CitationStyle const cs = citationStyleFromString(command);
247 vector<CiteStyle>::const_iterator cit =
248 std::find(styles.begin(), styles.end(), cs.style);
250 if (cit != styles.end()) {
251 fulllistCB->setChecked(cs.full);
252 forceuppercaseCB->setChecked(cs.forceUpperCase);
254 // restore the last used natbib style
255 if (style_ >= 0 && style_ < citationStyleCO->count()) {
256 // the necessary update will be performed later
257 citationStyleCO->blockSignals(true);
258 citationStyleCO->setCurrentIndex(style_);
259 citationStyleCO->blockSignals(false);
261 fulllistCB->setChecked(false);
262 forceuppercaseCB->setChecked(false);
264 updateFormatting(cs.style);
268 // This one needs to be called whenever citationStyleCO needs
269 // to be updated---and this would be on anything that changes the
270 // selection in selectedLV, or on a general update.
271 void GuiCitation::fillStyles(BiblioInfo const & bi)
273 QStringList selected_keys = selected_model_.stringList();
274 int curr = selectedLV->model()->rowCount() - 1;
276 if (curr < 0 || selected_keys.empty()) {
277 citationStyleCO->clear();
278 citationStyleCO->setEnabled(false);
279 citationStyleLA->setEnabled(false);
283 if (!selectedLV->selectionModel()->selectedIndexes().empty())
284 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
286 QStringList sty = citationStyles(bi, curr);
290 citationStyleCO->setEnabled(false);
291 citationStyleLA->setEnabled(false);
292 citationStyleCO->clear();
296 citationStyleCO->blockSignals(true);
299 int const oldIndex = citationStyleCO->currentIndex();
300 citationStyleCO->clear();
301 citationStyleCO->insertItems(0, sty);
302 citationStyleCO->setEnabled(true);
303 citationStyleLA->setEnabled(true);
305 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
306 citationStyleCO->setCurrentIndex(oldIndex);
308 citationStyleCO->blockSignals(false);
312 void GuiCitation::fillFields(BiblioInfo const & bi)
314 fieldsCO->blockSignals(true);
315 int const oldIndex = fieldsCO->currentIndex();
317 QStringList const fields = to_qstring_list(bi.getFields());
318 fieldsCO->insertItem(0, qt_("All fields"));
319 fieldsCO->insertItem(1, qt_("Keys"));
320 fieldsCO->insertItems(2, fields);
321 if (oldIndex != -1 && oldIndex < fieldsCO->count())
322 fieldsCO->setCurrentIndex(oldIndex);
323 fieldsCO->blockSignals(false);
327 void GuiCitation::fillEntries(BiblioInfo const & bi)
329 entriesCO->blockSignals(true);
330 int const oldIndex = entriesCO->currentIndex();
332 QStringList const entries = to_qstring_list(bi.getEntries());
333 entriesCO->insertItem(0, qt_("All entry types"));
334 entriesCO->insertItems(1, entries);
335 if (oldIndex != -1 && oldIndex < entriesCO->count())
336 entriesCO->setCurrentIndex(oldIndex);
337 entriesCO->blockSignals(false);
341 bool GuiCitation::isSelected(QModelIndex const & idx)
343 QString const str = idx.data().toString();
344 return selected_model_.stringList().contains(str);
348 void GuiCitation::setButtons()
350 selectionManager->update();
351 int const srows = selectedLV->model()->rowCount();
352 applyPB->setEnabled(srows > 0);
353 okPB->setEnabled(srows > 0);
357 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
359 if (!idx.isValid() || bi.empty()) {
360 infoML->document()->clear();
364 QString const keytxt = toqstr(
365 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), true));
366 infoML->document()->setHtml(keytxt);
370 void GuiCitation::findText(QString const & text, bool reset)
372 //"All Fields" and "Keys" are the first two
373 int index = fieldsCO->currentIndex() - 2;
374 BiblioInfo const & bi = bibInfo();
375 vector<docstring> const & fields = bi.getFields();
378 if (index <= -1 || index >= int(fields.size()))
379 //either "All Fields" or "Keys" or an invalid value
380 field = from_ascii("");
382 field = fields[index];
385 bool const onlyKeys = index == -1;
387 //"All Entry Types" is first.
388 index = entriesCO->currentIndex() - 1;
389 vector<docstring> const & entries = bi.getEntries();
390 docstring entry_type;
391 if (index < 0 || index >= int(entries.size()))
392 entry_type = from_ascii("");
394 entry_type = entries[index];
396 bool const case_sentitive = caseCB->checkState();
397 bool const reg_exp = regexCB->checkState();
398 findKey(bi, text, onlyKeys, field, entry_type,
399 case_sentitive, reg_exp, reset);
401 //It'd be nice to save and restore the current selection in
402 //availableLV. Currently, we get an automatic reset, since the
409 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
411 findText(findLE->text(), true);
415 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
417 findText(findLE->text(), true);
421 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
423 if (index >= 0 && index < citationStyleCO->count()) {
424 vector<CiteStyle> const & styles = citeStyles_;
425 updateFormatting(styles[index]);
430 void GuiCitation::on_findLE_textChanged(const QString & text)
432 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
433 searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
434 if (!text.isEmpty()) {
436 findText(findLE->text());
439 findText(findLE->text());
443 void GuiCitation::on_searchPB_clicked()
445 findText(findLE->text(), true);
449 void GuiCitation::on_caseCB_stateChanged(int)
451 findText(findLE->text());
455 void GuiCitation::on_regexCB_stateChanged(int)
457 findText(findLE->text());
461 void GuiCitation::on_asTypeCB_stateChanged(int)
463 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
464 searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
466 findText(findLE->text(), true);
470 void GuiCitation::changed()
476 void GuiCitation::apply(int const choice, bool full, bool force,
477 QString before, QString after)
479 if (cited_keys_.isEmpty())
482 vector<CiteStyle> const & styles = citeStyles_;
483 if (styles[choice] == NOCITE) {
491 s.style = styles[choice];
493 s.forceUpperCase = force;
494 string const command = citationStyleToString(s);
496 params_.setCmdName(command);
497 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
498 params_["before"] = qstring_to_ucs4(before);
499 params_["after"] = qstring_to_ucs4(after);
504 void GuiCitation::clearSelection()
507 selected_model_.setStringList(cited_keys_);
511 void GuiCitation::init()
513 // Make the list of all available bibliography keys
514 BiblioInfo const & bi = bibInfo();
515 all_keys_ = to_qstring_list(bi.getKeys());
516 available_model_.setStringList(all_keys_);
518 // Ditto for the keys cited in this inset
519 QString str = toqstr(params_["key"]);
523 cited_keys_ = str.split(",");
524 selected_model_.setStringList(cited_keys_);
525 if (selected_model_.rowCount()) {
526 selectedLV->blockSignals(true);
527 selectedLV->setFocus();
528 QModelIndex idx = selected_model_.index(0, 0);
529 selectedLV->selectionModel()->select(idx,
530 QItemSelectionModel::ClearAndSelect);
531 selectedLV->blockSignals(false);
533 // set the style combo appropriately
534 string const & command = params_.getCmdName();
535 vector<CiteStyle> const & styles = citeStyles_;
536 CitationStyle const cs = citationStyleFromString(command);
538 vector<CiteStyle>::const_iterator cit =
539 std::find(styles.begin(), styles.end(), cs.style);
540 if (cit != styles.end()) {
541 int const i = int(cit - styles.begin());
542 // the necessary update will be performed later
543 citationStyleCO->blockSignals(true);
544 citationStyleCO->setCurrentIndex(i);
545 citationStyleCO->blockSignals(false);
548 availableLV->setFocus();
555 void GuiCitation::findKey(BiblioInfo const & bi,
556 QString const & str, bool only_keys,
557 docstring field, docstring entry_type,
558 bool case_sensitive, bool reg_exp, bool reset)
560 // Used for optimisation: store last searched string.
561 static QString last_searched_string;
562 // Used to disable the above optimisation.
563 static bool last_case_sensitive;
564 static bool last_reg_exp;
565 // Reset last_searched_string in case of changed option.
566 if (last_case_sensitive != case_sensitive
567 || last_reg_exp != reg_exp) {
568 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
569 last_searched_string.clear();
571 // save option for next search.
572 last_case_sensitive = case_sensitive;
573 last_reg_exp = reg_exp;
575 Qt::CaseSensitivity qtcase = case_sensitive ?
576 Qt::CaseSensitive: Qt::CaseInsensitive;
578 // If new string (str) contains the last searched one...
580 !last_searched_string.isEmpty() &&
582 str.contains(last_searched_string, qtcase))
583 // ... then only search within already found list.
584 keys = available_model_.stringList();
586 // ... else search all keys.
588 // save searched string for next search.
589 last_searched_string = str;
593 // First, filter by entry_type, which will be faster than
594 // what follows, so we may get to do that on less.
595 vector<docstring> keyVector = to_docstring_vector(keys);
596 filterByEntryType(bi, keyVector, entry_type);
599 result = to_qstring_list(keyVector);
601 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
602 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
604 available_model_.setStringList(result);
608 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
610 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
611 return to_qstring_list(bi.getCiteStrings(key, documentBuffer()));
615 void GuiCitation::setCitedKeys()
617 cited_keys_ = selected_model_.stringList();
621 bool GuiCitation::initialiseParams(string const & data)
623 InsetCommand::string2params(data, params_);
624 CiteEngine const engine = citeEngine();
625 CiteEngineType const engine_type = citeEngineType();
626 citeStyles_ = citeStyles(engine, engine_type);
632 void GuiCitation::clearParams()
638 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
639 vector<docstring> & keyVector, docstring entry_type)
641 if (entry_type.empty())
644 vector<docstring>::iterator it = keyVector.begin();
645 vector<docstring>::iterator end = keyVector.end();
647 vector<docstring> result;
648 for (; it != end; ++it) {
649 docstring const key = *it;
650 BiblioInfo::const_iterator cit = bi.find(key);
653 if (cit->second.entryType() == entry_type)
654 result.push_back(key);
660 CiteEngine GuiCitation::citeEngine() const
662 return documentBuffer().params().citeEngine();
666 CiteEngineType GuiCitation::citeEngineType() const
668 return documentBuffer().params().citeEngineType();
672 // Escape special chars.
673 // All characters are literals except: '.|*?+(){}[]^$\'
674 // These characters are literals when preceded by a "\", which is done here
675 // @todo: This function should be moved to support, and then the test in tests
676 // should be moved there as well.
677 static docstring escape_special_chars(docstring const & expr)
679 // Search for all chars '.|*?+(){}[^$]\'
680 // Note that '[' and '\' must be escaped.
681 // This is a limitation of lyx::regex, but all other chars in BREs
682 // are assumed literal.
683 static const lyx::regex reg("[].|*?+(){}^$\\[\\\\]");
685 // $& is a perl-like expression that expands to all
686 // of the current match
687 // The '$' must be prefixed with the escape character '\' for
688 // boost to treat it as a literal.
689 // Thus, to prefix a matched expression with '\', we use:
691 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
695 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
696 vector<docstring> const & keys_to_search, bool only_keys,
697 docstring const & search_expression, docstring field,
698 bool case_sensitive, bool regex)
700 vector<docstring> foundKeys;
702 docstring expr = trim(search_expression);
707 // We must escape special chars in the search_expr so that
708 // it is treated as a simple string by lyx::regex.
709 expr = escape_special_chars(expr);
713 reg_exp.assign(to_utf8(expr), case_sensitive ?
714 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
715 } catch (lyx::regex_error & e) {
716 // lyx::regex throws an exception if the regular expression is not
718 LYXERR(Debug::GUI, e.what());
719 return vector<docstring>();
722 vector<docstring>::const_iterator it = keys_to_search.begin();
723 vector<docstring>::const_iterator end = keys_to_search.end();
724 for (; it != end; ++it ) {
725 BiblioInfo::const_iterator info = bi.find(*it);
726 if (info == bi.end())
729 BibTeXInfo const & kvm = info->second;
733 else if (field.empty())
734 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
736 data = to_utf8(kvm[field]);
742 if (lyx::regex_search(data, reg_exp))
743 foundKeys.push_back(*it);
745 catch (lyx::regex_error & e) {
746 LYXERR(Debug::GUI, e.what());
747 return vector<docstring>();
754 void GuiCitation::dispatchParams()
756 std::string const lfun = InsetCommand::params2string(params_);
757 dispatch(FuncRequest(getLfun(), lfun));
761 BiblioInfo const & GuiCitation::bibInfo() const
763 Buffer const & buf = documentBuffer();
764 buf.reloadBibInfoCache();
765 return buf.masterBibInfo();
769 void GuiCitation::saveSession() const
771 Dialog::saveSession();
774 sessionKey() + "/regex", regexCB->isChecked());
776 sessionKey() + "/casesensitive", caseCB->isChecked());
778 sessionKey() + "/autofind", asTypeCB->isChecked());
782 void GuiCitation::restoreSession()
784 Dialog::restoreSession();
787 settings.value(sessionKey() + "/regex").toBool());
789 settings.value(sessionKey() + "/casesensitive").toBool());
790 asTypeCB->setChecked(
791 settings.value(sessionKey() + "/autofind").toBool());
795 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
798 } // namespace frontend
801 #include "moc_GuiCitation.cpp"