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 QModelIndex idx = selectionManager->getSelectedIndex();
205 textBeforeED->setText(toqstr(params_["before"]));
206 textAfterED->setText(toqstr(params_["after"]));
212 void GuiCitation::updateFormatting(CiteStyle currentStyle)
214 CiteEngine const engine = citeEngine();
215 bool const natbib_engine =
216 engine == ENGINE_NATBIB_AUTHORYEAR ||
217 engine == ENGINE_NATBIB_NUMERICAL;
218 bool const basic_engine = engine == ENGINE_BASIC;
220 bool const haveSelection =
221 selectedLV->model()->rowCount() > 0;
223 bool const isNocite = currentStyle == NOCITE;
225 bool const isCiteyear =
226 currentStyle == CITEYEAR ||
227 currentStyle == CITEYEARPAR;
229 fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite
231 forceuppercaseCB->setEnabled(natbib_engine && haveSelection
232 && !isNocite && !isCiteyear);
233 textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
234 textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
235 textAfterED->setEnabled(haveSelection && !isNocite);
236 textAfterLA->setEnabled(haveSelection && !isNocite);
237 citationStyleCO->setEnabled(haveSelection);
238 citationStyleLA->setEnabled(haveSelection);
242 void GuiCitation::updateStyle()
244 string const & command = params_.getCmdName();
246 // Find the style of the citekeys
247 vector<CiteStyle> const & styles = citeStyles_;
248 CitationStyle const cs = citationStyleFromString(command);
250 vector<CiteStyle>::const_iterator cit =
251 std::find(styles.begin(), styles.end(), cs.style);
253 // restore the latest natbib style
254 if (style_ >= 0 && style_ < citationStyleCO->count())
255 citationStyleCO->setCurrentIndex(style_);
257 citationStyleCO->setCurrentIndex(0);
259 if (cit != styles.end()) {
260 int const i = int(cit - styles.begin());
261 citationStyleCO->setCurrentIndex(i);
262 fulllistCB->setChecked(cs.full);
263 forceuppercaseCB->setChecked(cs.forceUpperCase);
265 fulllistCB->setChecked(false);
266 forceuppercaseCB->setChecked(false);
268 updateFormatting(cs.style);
271 // This one needs to be called whenever citationStyleCO needs
272 // to be updated---and this would be on anything that changes the
273 // selection in selectedLV, or on a general update.
274 void GuiCitation::fillStyles(BiblioInfo const & bi)
276 int const oldIndex = citationStyleCO->currentIndex();
278 citationStyleCO->clear();
280 QStringList selected_keys = selected_model_.stringList();
281 if (selected_keys.empty()) {
282 citationStyleCO->setEnabled(false);
283 citationStyleLA->setEnabled(false);
287 int curr = selectedLV->model()->rowCount() - 1;
291 if (!selectedLV->selectionModel()->selectedIndexes().empty())
292 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
294 QStringList sty = citationStyles(bi, curr);
296 citationStyleCO->setEnabled(!sty.isEmpty());
297 citationStyleLA->setEnabled(!sty.isEmpty());
302 citationStyleCO->insertItems(0, sty);
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_);
528 void GuiCitation::findKey(BiblioInfo const & bi,
529 QString const & str, bool only_keys,
530 docstring field, docstring entry_type,
531 bool case_sensitive, bool reg_exp, bool reset)
533 // Used for optimisation: store last searched string.
534 static QString last_searched_string;
535 // Used to disable the above optimisation.
536 static bool last_case_sensitive;
537 static bool last_reg_exp;
538 // Reset last_searched_string in case of changed option.
539 if (last_case_sensitive != case_sensitive
540 || last_reg_exp != reg_exp) {
541 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
542 last_searched_string.clear();
544 // save option for next search.
545 last_case_sensitive = case_sensitive;
546 last_reg_exp = reg_exp;
548 Qt::CaseSensitivity qtcase = case_sensitive ?
549 Qt::CaseSensitive: Qt::CaseInsensitive;
551 // If new string (str) contains the last searched one...
553 !last_searched_string.isEmpty() &&
555 str.contains(last_searched_string, qtcase))
556 // ... then only search within already found list.
557 keys = available_model_.stringList();
559 // ... else search all keys.
561 // save searched string for next search.
562 last_searched_string = str;
566 // First, filter by entry_type, which will be faster than
567 // what follows, so we may get to do that on less.
568 vector<docstring> keyVector = to_docstring_vector(keys);
569 filterByEntryType(bi, keyVector, entry_type);
572 result = to_qstring_list(keyVector);
574 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
575 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
577 available_model_.setStringList(result);
581 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
583 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
584 return to_qstring_list(bi.getCiteStrings(key, buffer()));
588 void GuiCitation::setCitedKeys()
590 cited_keys_ = selected_model_.stringList();
594 bool GuiCitation::initialiseParams(string const & data)
596 InsetCommand::string2params("citation", data, params_);
597 CiteEngine const engine = buffer().params().citeEngine();
598 citeStyles_ = citeStyles(engine);
604 void GuiCitation::clearParams()
610 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
611 vector<docstring> & keyVector, docstring entry_type)
613 if (entry_type.empty())
616 vector<docstring>::iterator it = keyVector.begin();
617 vector<docstring>::iterator end = keyVector.end();
619 vector<docstring> result;
620 for (; it != end; ++it) {
621 docstring const key = *it;
622 BiblioInfo::const_iterator cit = bi.find(key);
625 if (cit->second.entryType() == entry_type)
626 result.push_back(key);
632 CiteEngine GuiCitation::citeEngine() const
634 return buffer().params().citeEngine();
638 // Escape special chars.
639 // All characters are literals except: '.|*?+(){}[]^$\'
640 // These characters are literals when preceded by a "\", which is done here
641 // @todo: This function should be moved to support, and then the test in tests
642 // should be moved there as well.
643 static docstring escape_special_chars(docstring const & expr)
645 // Search for all chars '.|*?+(){}[^$]\'
646 // Note that '[' and '\' must be escaped.
647 // This is a limitation of boost::regex, but all other chars in BREs
648 // are assumed literal.
649 static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
651 // $& is a perl-like expression that expands to all
652 // of the current match
653 // The '$' must be prefixed with the escape character '\' for
654 // boost to treat it as a literal.
655 // Thus, to prefix a matched expression with '\', we use:
657 return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
661 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
662 vector<docstring> const & keys_to_search, bool only_keys,
663 docstring const & search_expression, docstring field,
664 bool case_sensitive, bool regex)
666 vector<docstring> foundKeys;
668 docstring expr = trim(search_expression);
673 // We must escape special chars in the search_expr so that
674 // it is treated as a simple string by boost::regex.
675 expr = escape_special_chars(expr);
677 boost::regex reg_exp;
679 reg_exp.assign(to_utf8(expr), case_sensitive ?
680 boost::regex_constants::normal : boost::regex_constants::icase);
681 } catch (boost::regex_error & e) {
682 // boost::regex throws an exception if the regular expression is not
684 LYXERR(Debug::GUI, e.what());
685 return vector<docstring>();
688 vector<docstring>::const_iterator it = keys_to_search.begin();
689 vector<docstring>::const_iterator end = keys_to_search.end();
690 for (; it != end; ++it ) {
691 BiblioInfo::const_iterator info = bi.find(*it);
692 if (info == bi.end())
695 BibTeXInfo const & kvm = info->second;
699 else if (field.empty())
700 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
702 data = to_utf8(kvm[field]);
708 if (boost::regex_search(data, reg_exp))
709 foundKeys.push_back(*it);
711 catch (boost::regex_error & e) {
712 LYXERR(Debug::GUI, e.what());
713 return vector<docstring>();
720 void GuiCitation::dispatchParams()
722 std::string const lfun = InsetCommand::params2string("citation", params_);
723 dispatch(FuncRequest(getLfun(), lfun));
727 BiblioInfo const & GuiCitation::bibInfo() const
729 buffer().checkBibInfoCache();
730 return buffer().masterBibInfo();
734 void GuiCitation::saveSession() const
736 Dialog::saveSession();
739 sessionKey() + "/regex", regexCB->isChecked());
741 sessionKey() + "/casesensitive", caseCB->isChecked());
743 sessionKey() + "/autofind", asTypeCB->isChecked());
747 void GuiCitation::restoreSession()
749 Dialog::restoreSession();
752 settings.value(sessionKey() + "/regex").toBool());
754 settings.value(sessionKey() + "/casesensitive").toBool());
755 asTypeCB->setChecked(
756 settings.value(sessionKey() + "/autofind").toBool());
760 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
763 } // namespace frontend
766 #include "moc_GuiCitation.cpp"