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 setFocusProxy(availableLV);
119 // FIXME: the sizeHint() for this is _way_ too high
120 infoML->setFixedHeight(60);
124 GuiCitation::~GuiCitation()
126 delete selectionManager;
130 void GuiCitation::closeEvent(QCloseEvent * e)
133 DialogView::closeEvent(e);
137 void GuiCitation::applyView()
139 int const choice = max(0, citationStyleCO->currentIndex());
141 bool const full = fulllistCB->isChecked();
142 bool const force = forceuppercaseCB->isChecked();
144 QString const before = textBeforeED->text();
145 QString const after = textAfterED->text();
147 apply(choice, full, force, before, after);
151 void GuiCitation::showEvent(QShowEvent * e)
154 availableLV->setFocus();
155 DialogView::showEvent(e);
159 void GuiCitation::on_okPB_clicked()
167 void GuiCitation::on_cancelPB_clicked()
174 void GuiCitation::on_applyPB_clicked()
180 void GuiCitation::on_restorePB_clicked()
186 void GuiCitation::updateControls()
188 BiblioInfo const & bi = bibInfo();
193 // The main point of separating this out is that the fill*() methods
194 // called in update() do not need to be called for INTERNAL updates,
195 // such as when addPB is pressed, as the list of fields, entries, etc,
196 // will not have changed. At the moment, however, the division between
197 // fillStyles() and updateStyle() doesn't lend itself to dividing the
198 // two methods, though they should be divisible.
199 void GuiCitation::updateControls(BiblioInfo const & bi)
201 if (selectionManager->selectedFocused()) {
202 if (selectedLV->selectionModel()->selectedIndexes().isEmpty())
203 updateInfo(bi, availableLV->currentIndex());
205 updateInfo(bi, selectedLV->currentIndex());
207 if (availableLV->selectionModel()->selectedIndexes().isEmpty())
208 updateInfo(bi, QModelIndex());
210 updateInfo(bi, availableLV->currentIndex());
214 textBeforeED->setText(toqstr(params_["before"]));
215 textAfterED->setText(toqstr(params_["after"]));
221 void GuiCitation::updateFormatting(CiteStyle currentStyle)
223 CiteEngine const engine = citeEngine();
224 bool const natbib_engine =
225 engine == ENGINE_NATBIB_AUTHORYEAR ||
226 engine == ENGINE_NATBIB_NUMERICAL;
227 bool const basic_engine = engine == ENGINE_BASIC;
229 bool const haveSelection =
230 selectedLV->model()->rowCount() > 0;
232 bool const isNocite = currentStyle == NOCITE;
234 fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite);
235 forceuppercaseCB->setEnabled(natbib_engine && haveSelection && !isNocite);
236 textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
237 textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
238 textAfterED->setEnabled(haveSelection && !isNocite);
239 textAfterLA->setEnabled(haveSelection && !isNocite);
240 citationStyleCO->setEnabled(haveSelection);
241 citationStyleLA->setEnabled(haveSelection);
245 void GuiCitation::updateStyle()
247 string const & command = params_.getCmdName();
249 // Find the style of the citekeys
250 vector<CiteStyle> const & styles = citeStyles_;
251 CitationStyle const cs = citationStyleFromString(command);
253 vector<CiteStyle>::const_iterator cit =
254 std::find(styles.begin(), styles.end(), cs.style);
256 // restore the latest natbib style
257 if (style_ >= 0 && style_ < citationStyleCO->count())
258 citationStyleCO->setCurrentIndex(style_);
260 citationStyleCO->setCurrentIndex(0);
262 if (cit != styles.end()) {
263 int const i = int(cit - styles.begin());
264 citationStyleCO->setCurrentIndex(i);
265 fulllistCB->setChecked(cs.full);
266 forceuppercaseCB->setChecked(cs.forceUpperCase);
268 fulllistCB->setChecked(false);
269 forceuppercaseCB->setChecked(false);
271 updateFormatting(cs.style);
274 // This one needs to be called whenever citationStyleCO needs
275 // to be updated---and this would be on anything that changes the
276 // selection in selectedLV, or on a general update.
277 void GuiCitation::fillStyles(BiblioInfo const & bi)
279 int const oldIndex = citationStyleCO->currentIndex();
281 citationStyleCO->clear();
283 QStringList selected_keys = selected_model_.stringList();
284 if (selected_keys.empty()) {
285 citationStyleCO->setEnabled(false);
286 citationStyleLA->setEnabled(false);
290 int curr = selectedLV->model()->rowCount() - 1;
294 if (!selectedLV->selectionModel()->selectedIndexes().empty())
295 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
297 QStringList sty = citationStyles(bi, curr);
299 citationStyleCO->setEnabled(!sty.isEmpty());
300 citationStyleLA->setEnabled(!sty.isEmpty());
305 citationStyleCO->insertItems(0, sty);
307 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
308 citationStyleCO->setCurrentIndex(oldIndex);
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(const QModelIndex & 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())));
366 infoML->document()->setPlainText(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_);
531 void GuiCitation::findKey(BiblioInfo const & bi,
532 QString const & str, bool only_keys,
533 docstring field, docstring entry_type,
534 bool case_sensitive, bool reg_exp, bool reset)
536 // Used for optimisation: store last searched string.
537 static QString last_searched_string;
538 // Used to disable the above optimisation.
539 static bool last_case_sensitive;
540 static bool last_reg_exp;
541 // Reset last_searched_string in case of changed option.
542 if (last_case_sensitive != case_sensitive
543 || last_reg_exp != reg_exp) {
544 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
545 last_searched_string.clear();
547 // save option for next search.
548 last_case_sensitive = case_sensitive;
549 last_reg_exp = reg_exp;
551 Qt::CaseSensitivity qtcase = case_sensitive ?
552 Qt::CaseSensitive: Qt::CaseInsensitive;
554 // If new string (str) contains the last searched one...
556 !last_searched_string.isEmpty() &&
558 str.contains(last_searched_string, qtcase))
559 // ... then only search within already found list.
560 keys = available_model_.stringList();
562 // ... else search all keys.
564 // save searched string for next search.
565 last_searched_string = str;
569 // First, filter by entry_type, which will be faster than
570 // what follows, so we may get to do that on less.
571 vector<docstring> keyVector = to_docstring_vector(keys);
572 filterByEntryType(bi, keyVector, entry_type);
575 result = to_qstring_list(keyVector);
577 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
578 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
580 available_model_.setStringList(result);
584 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
586 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
587 return to_qstring_list(bi.getCiteStrings(key, buffer()));
591 void GuiCitation::setCitedKeys()
593 cited_keys_ = selected_model_.stringList();
597 bool GuiCitation::initialiseParams(string const & data)
599 InsetCommand::string2params("citation", data, params_);
600 CiteEngine const engine = buffer().params().citeEngine();
601 citeStyles_ = citeStyles(engine);
607 void GuiCitation::clearParams()
613 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
614 vector<docstring> & keyVector, docstring entry_type)
616 if (entry_type.empty())
619 vector<docstring>::iterator it = keyVector.begin();
620 vector<docstring>::iterator end = keyVector.end();
622 vector<docstring> result;
623 for (; it != end; ++it) {
624 docstring const key = *it;
625 BiblioInfo::const_iterator cit = bi.find(key);
628 if (cit->second.entryType() == entry_type)
629 result.push_back(key);
635 CiteEngine GuiCitation::citeEngine() const
637 return buffer().params().citeEngine();
641 // Escape special chars.
642 // All characters are literals except: '.|*?+(){}[]^$\'
643 // These characters are literals when preceded by a "\", which is done here
644 // @todo: This function should be moved to support, and then the test in tests
645 // should be moved there as well.
646 static docstring escape_special_chars(docstring const & expr)
648 // Search for all chars '.|*?+(){}[^$]\'
649 // Note that '[' and '\' must be escaped.
650 // This is a limitation of boost::regex, but all other chars in BREs
651 // are assumed literal.
652 static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
654 // $& is a perl-like expression that expands to all
655 // of the current match
656 // The '$' must be prefixed with the escape character '\' for
657 // boost to treat it as a literal.
658 // Thus, to prefix a matched expression with '\', we use:
660 return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
664 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
665 vector<docstring> const & keys_to_search, bool only_keys,
666 docstring const & search_expression, docstring field,
667 bool case_sensitive, bool regex)
669 vector<docstring> foundKeys;
671 docstring expr = trim(search_expression);
676 // We must escape special chars in the search_expr so that
677 // it is treated as a simple string by boost::regex.
678 expr = escape_special_chars(expr);
680 boost::regex reg_exp;
682 reg_exp.assign(to_utf8(expr), case_sensitive ?
683 boost::regex_constants::normal : boost::regex_constants::icase);
684 } catch (boost::regex_error & e) {
685 // boost::regex throws an exception if the regular expression is not
687 LYXERR(Debug::GUI, e.what());
688 return vector<docstring>();
691 vector<docstring>::const_iterator it = keys_to_search.begin();
692 vector<docstring>::const_iterator end = keys_to_search.end();
693 for (; it != end; ++it ) {
694 BiblioInfo::const_iterator info = bi.find(*it);
695 if (info == bi.end())
698 BibTeXInfo const & kvm = info->second;
702 else if (field.empty())
703 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
704 else if (kvm.hasField(field))
705 data = to_utf8(kvm[field]);
711 if (boost::regex_search(data, reg_exp))
712 foundKeys.push_back(*it);
714 catch (boost::regex_error & e) {
715 LYXERR(Debug::GUI, e.what());
716 return vector<docstring>();
723 void GuiCitation::dispatchParams()
725 std::string const lfun = InsetCommand::params2string("citation", params_);
726 dispatch(FuncRequest(getLfun(), lfun));
730 BiblioInfo const & GuiCitation::bibInfo() const
732 return buffer().masterBibInfo();
736 void GuiCitation::saveSession() const
738 Dialog::saveSession();
741 sessionKey() + "/regex", regexCB->isChecked());
743 sessionKey() + "/casesensitive", caseCB->isChecked());
745 sessionKey() + "/autofind", asTypeCB->isChecked());
749 void GuiCitation::restoreSession()
751 Dialog::restoreSession();
754 settings.value(sessionKey() + "/regex").toBool());
756 settings.value(sessionKey() + "/casesensitive").toBool());
757 asTypeCB->setChecked(
758 settings.value(sessionKey() + "/autofind").toBool());
762 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
765 } // namespace frontend
768 #include "moc_GuiCitation.cpp"