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 if (cit != styles.end()) {
252 int const i = int(cit - styles.begin());
253 citationStyleCO->setCurrentIndex(i);
254 fulllistCB->setChecked(cs.full);
255 forceuppercaseCB->setChecked(cs.forceUpperCase);
257 fulllistCB->setChecked(false);
258 forceuppercaseCB->setChecked(false);
260 updateFormatting(cs.style);
264 // This one needs to be called whenever citationStyleCO needs
265 // to be updated---and this would be on anything that changes the
266 // selection in selectedLV, or on a general update.
267 void GuiCitation::fillStyles(BiblioInfo const & bi)
269 QStringList selected_keys = selected_model_.stringList();
270 int curr = selectedLV->model()->rowCount() - 1;
272 if (curr < 0 || selected_keys.empty()) {
273 citationStyleCO->clear();
274 citationStyleCO->setEnabled(false);
275 citationStyleLA->setEnabled(false);
279 int const oldIndex = citationStyleCO->currentIndex();
281 if (!selectedLV->selectionModel()->selectedIndexes().empty())
282 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
284 QStringList sty = citationStyles(bi, curr);
285 citationStyleCO->clear();
289 citationStyleCO->setEnabled(false);
290 citationStyleLA->setEnabled(false);
294 citationStyleCO->insertItems(0, sty);
295 citationStyleCO->setEnabled(true);
296 citationStyleLA->setEnabled(true);
298 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
299 citationStyleCO->setCurrentIndex(oldIndex);
303 void GuiCitation::fillFields(BiblioInfo const & bi)
305 fieldsCO->blockSignals(true);
306 int const oldIndex = fieldsCO->currentIndex();
308 QStringList const fields = to_qstring_list(bi.getFields());
309 fieldsCO->insertItem(0, qt_("All fields"));
310 fieldsCO->insertItem(1, qt_("Keys"));
311 fieldsCO->insertItems(2, fields);
312 if (oldIndex != -1 && oldIndex < fieldsCO->count())
313 fieldsCO->setCurrentIndex(oldIndex);
314 fieldsCO->blockSignals(false);
318 void GuiCitation::fillEntries(BiblioInfo const & bi)
320 entriesCO->blockSignals(true);
321 int const oldIndex = entriesCO->currentIndex();
323 QStringList const entries = to_qstring_list(bi.getEntries());
324 entriesCO->insertItem(0, qt_("All entry types"));
325 entriesCO->insertItems(1, entries);
326 if (oldIndex != -1 && oldIndex < entriesCO->count())
327 entriesCO->setCurrentIndex(oldIndex);
328 entriesCO->blockSignals(false);
332 bool GuiCitation::isSelected(QModelIndex const & idx)
334 QString const str = idx.data().toString();
335 return selected_model_.stringList().contains(str);
339 void GuiCitation::setButtons()
341 selectionManager->update();
342 int const srows = selectedLV->model()->rowCount();
343 applyPB->setEnabled(srows > 0);
344 okPB->setEnabled(srows > 0);
348 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
350 if (!idx.isValid() || bi.empty()) {
351 infoML->document()->clear();
355 QString const keytxt = toqstr(
356 bi.getInfo(qstring_to_ucs4(idx.data().toString())));
357 infoML->document()->setPlainText(keytxt);
361 void GuiCitation::findText(QString const & text, bool reset)
363 //"All Fields" and "Keys" are the first two
364 int index = fieldsCO->currentIndex() - 2;
365 BiblioInfo const & bi = bibInfo();
366 vector<docstring> const & fields = bi.getFields();
369 if (index <= -1 || index >= int(fields.size()))
370 //either "All Fields" or "Keys" or an invalid value
371 field = from_ascii("");
373 field = fields[index];
376 bool const onlyKeys = index == -1;
378 //"All Entry Types" is first.
379 index = entriesCO->currentIndex() - 1;
380 vector<docstring> const & entries = bi.getEntries();
381 docstring entry_type;
382 if (index < 0 || index >= int(entries.size()))
383 entry_type = from_ascii("");
385 entry_type = entries[index];
387 bool const case_sentitive = caseCB->checkState();
388 bool const reg_exp = regexCB->checkState();
389 findKey(bi, text, onlyKeys, field, entry_type,
390 case_sentitive, reg_exp, reset);
392 //It'd be nice to save and restore the current selection in
393 //availableLV. Currently, we get an automatic reset, since the
400 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
402 findText(findLE->text(), true);
406 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
408 findText(findLE->text(), true);
412 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
414 if (index >= 0 && index < citationStyleCO->count()) {
415 vector<CiteStyle> const & styles = citeStyles_;
416 updateFormatting(styles[index]);
421 void GuiCitation::on_findLE_textChanged(const QString & text)
423 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
424 searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
425 if (!text.isEmpty()) {
427 findText(findLE->text());
430 findText(findLE->text());
434 void GuiCitation::on_searchPB_clicked()
436 findText(findLE->text(), true);
440 void GuiCitation::on_caseCB_stateChanged(int)
442 findText(findLE->text());
446 void GuiCitation::on_regexCB_stateChanged(int)
448 findText(findLE->text());
452 void GuiCitation::on_asTypeCB_stateChanged(int)
454 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
455 searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
457 findText(findLE->text(), true);
461 void GuiCitation::changed()
467 void GuiCitation::apply(int const choice, bool full, bool force,
468 QString before, QString after)
470 if (cited_keys_.isEmpty())
473 vector<CiteStyle> const & styles = citeStyles_;
474 if (styles[choice] == NOCITE) {
482 s.style = styles[choice];
484 s.forceUpperCase = force;
485 string const command = citationStyleToString(s);
487 params_.setCmdName(command);
488 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
489 params_["before"] = qstring_to_ucs4(before);
490 params_["after"] = qstring_to_ucs4(after);
495 void GuiCitation::clearSelection()
498 selected_model_.setStringList(cited_keys_);
502 void GuiCitation::init()
504 // Make the list of all available bibliography keys
505 BiblioInfo const & bi = bibInfo();
506 all_keys_ = to_qstring_list(bi.getKeys());
507 available_model_.setStringList(all_keys_);
509 // Ditto for the keys cited in this inset
510 QString str = toqstr(params_["key"]);
514 cited_keys_ = str.split(",");
515 selected_model_.setStringList(cited_keys_);
516 if (selected_model_.rowCount()) {
517 selectedLV->blockSignals(true);
518 selectedLV->setFocus();
519 QModelIndex idx = selected_model_.index(0, 0);
520 selectedLV->selectionModel()->select(idx,
521 QItemSelectionModel::ClearAndSelect);
522 selectedLV->blockSignals(false);
524 availableLV->setFocus();
528 // restore the last used natbib style
529 if (style_ >= 0 && style_ < citationStyleCO->count())
530 citationStyleCO->setCurrentIndex(style_);
532 citationStyleCO->setCurrentIndex(0);
536 void GuiCitation::findKey(BiblioInfo const & bi,
537 QString const & str, bool only_keys,
538 docstring field, docstring entry_type,
539 bool case_sensitive, bool reg_exp, bool reset)
541 // Used for optimisation: store last searched string.
542 static QString last_searched_string;
543 // Used to disable the above optimisation.
544 static bool last_case_sensitive;
545 static bool last_reg_exp;
546 // Reset last_searched_string in case of changed option.
547 if (last_case_sensitive != case_sensitive
548 || last_reg_exp != reg_exp) {
549 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
550 last_searched_string.clear();
552 // save option for next search.
553 last_case_sensitive = case_sensitive;
554 last_reg_exp = reg_exp;
556 Qt::CaseSensitivity qtcase = case_sensitive ?
557 Qt::CaseSensitive: Qt::CaseInsensitive;
559 // If new string (str) contains the last searched one...
561 !last_searched_string.isEmpty() &&
563 str.contains(last_searched_string, qtcase))
564 // ... then only search within already found list.
565 keys = available_model_.stringList();
567 // ... else search all keys.
569 // save searched string for next search.
570 last_searched_string = str;
574 // First, filter by entry_type, which will be faster than
575 // what follows, so we may get to do that on less.
576 vector<docstring> keyVector = to_docstring_vector(keys);
577 filterByEntryType(bi, keyVector, entry_type);
580 result = to_qstring_list(keyVector);
582 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
583 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
585 available_model_.setStringList(result);
589 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
591 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
592 return to_qstring_list(bi.getCiteStrings(key, buffer()));
596 void GuiCitation::setCitedKeys()
598 cited_keys_ = selected_model_.stringList();
602 bool GuiCitation::initialiseParams(string const & data)
604 InsetCommand::string2params("citation", data, params_);
605 CiteEngine const engine = buffer().params().citeEngine();
606 citeStyles_ = citeStyles(engine);
612 void GuiCitation::clearParams()
618 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
619 vector<docstring> & keyVector, docstring entry_type)
621 if (entry_type.empty())
624 vector<docstring>::iterator it = keyVector.begin();
625 vector<docstring>::iterator end = keyVector.end();
627 vector<docstring> result;
628 for (; it != end; ++it) {
629 docstring const key = *it;
630 BiblioInfo::const_iterator cit = bi.find(key);
633 if (cit->second.entryType() == entry_type)
634 result.push_back(key);
640 CiteEngine GuiCitation::citeEngine() const
642 return buffer().params().citeEngine();
646 // Escape special chars.
647 // All characters are literals except: '.|*?+(){}[]^$\'
648 // These characters are literals when preceded by a "\", which is done here
649 // @todo: This function should be moved to support, and then the test in tests
650 // should be moved there as well.
651 static docstring escape_special_chars(docstring const & expr)
653 // Search for all chars '.|*?+(){}[^$]\'
654 // Note that '[' and '\' must be escaped.
655 // This is a limitation of boost::regex, but all other chars in BREs
656 // are assumed literal.
657 static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
659 // $& is a perl-like expression that expands to all
660 // of the current match
661 // The '$' must be prefixed with the escape character '\' for
662 // boost to treat it as a literal.
663 // Thus, to prefix a matched expression with '\', we use:
665 return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
669 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
670 vector<docstring> const & keys_to_search, bool only_keys,
671 docstring const & search_expression, docstring field,
672 bool case_sensitive, bool regex)
674 vector<docstring> foundKeys;
676 docstring expr = trim(search_expression);
681 // We must escape special chars in the search_expr so that
682 // it is treated as a simple string by boost::regex.
683 expr = escape_special_chars(expr);
685 boost::regex reg_exp;
687 reg_exp.assign(to_utf8(expr), case_sensitive ?
688 boost::regex_constants::normal : boost::regex_constants::icase);
689 } catch (boost::regex_error & e) {
690 // boost::regex throws an exception if the regular expression is not
692 LYXERR(Debug::GUI, e.what());
693 return vector<docstring>();
696 vector<docstring>::const_iterator it = keys_to_search.begin();
697 vector<docstring>::const_iterator end = keys_to_search.end();
698 for (; it != end; ++it ) {
699 BiblioInfo::const_iterator info = bi.find(*it);
700 if (info == bi.end())
703 BibTeXInfo const & kvm = info->second;
707 else if (field.empty())
708 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
710 data = to_utf8(kvm[field]);
716 if (boost::regex_search(data, reg_exp))
717 foundKeys.push_back(*it);
719 catch (boost::regex_error & e) {
720 LYXERR(Debug::GUI, e.what());
721 return vector<docstring>();
728 void GuiCitation::dispatchParams()
730 std::string const lfun = InsetCommand::params2string("citation", params_);
731 dispatch(FuncRequest(getLfun(), lfun));
735 BiblioInfo const & GuiCitation::bibInfo() const
737 buffer().checkBibInfoCache();
738 return buffer().masterBibInfo();
742 void GuiCitation::saveSession() const
744 Dialog::saveSession();
747 sessionKey() + "/regex", regexCB->isChecked());
749 sessionKey() + "/casesensitive", caseCB->isChecked());
751 sessionKey() + "/autofind", asTypeCB->isChecked());
755 void GuiCitation::restoreSession()
757 Dialog::restoreSession();
760 settings.value(sessionKey() + "/regex").toBool());
762 settings.value(sessionKey() + "/casesensitive").toBool());
763 asTypeCB->setChecked(
764 settings.value(sessionKey() + "/autofind").toBool());
768 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
771 } // namespace frontend
774 #include "moc_GuiCitation.cpp"