2 * \file GuiCitation.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
7 * \author Kalle Dalheimer
8 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
16 #include "GuiCitation.h"
18 #include "GuiSelectionManager.h"
19 #include "qt_helpers.h"
22 #include "BiblioInfo.h"
23 #include "BufferParams.h"
24 #include "FuncRequest.h"
26 #include "insets/InsetCommand.h"
28 #include "support/debug.h"
29 #include "support/docstring.h"
30 #include "support/gettext.h"
31 #include "support/lstrings.h"
33 #include <QCloseEvent>
43 #include <boost/regex.hpp>
50 using namespace lyx::support;
55 static vector<CiteStyle> citeStyles_;
58 template<typename String>
59 static QStringList to_qstring_list(vector<String> const & v)
63 for (size_t i = 0; i != v.size(); ++i) {
66 qlist.append(lyx::toqstr(v[i]));
72 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
74 vector<lyx::docstring> v;
75 for (int i = 0; i != qlist.size(); ++i) {
76 if (qlist[i].isEmpty())
78 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
84 GuiCitation::GuiCitation(GuiView & lv)
85 : DialogView(lv, "citation", qt_("Citation")),
86 params_(insetCode("citation"))
90 connect(citationStyleCO, SIGNAL(activated(int)),
91 this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
92 connect(fulllistCB, SIGNAL(clicked()),
93 this, SLOT(changed()));
94 connect(forceuppercaseCB, SIGNAL(clicked()),
95 this, SLOT(changed()));
96 connect(textBeforeED, SIGNAL(textChanged(QString)),
97 this, SLOT(changed()));
98 connect(textAfterED, SIGNAL(textChanged(QString)),
99 this, SLOT(changed()));
100 connect(findLE, SIGNAL(returnPressed()),
101 this, SLOT(on_searchPB_clicked()));
102 connect(textBeforeED, SIGNAL(returnPressed()),
103 this, SLOT(on_okPB_clicked()));
104 connect(textAfterED, SIGNAL(returnPressed()),
105 this, SLOT(on_okPB_clicked()));
107 connect(this, SIGNAL(rejected()), this, SLOT(cleanUp()));
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 // FIXME: the sizeHint() for this is _way_ too high
119 infoML->setFixedHeight(60);
123 GuiCitation::~GuiCitation()
125 delete selectionManager;
129 void GuiCitation::cleanUp()
137 void GuiCitation::closeEvent(QCloseEvent * e)
140 DialogView::closeEvent(e);
144 void GuiCitation::applyView()
146 int const choice = max(0, citationStyleCO->currentIndex());
148 bool const full = fulllistCB->isChecked();
149 bool const force = forceuppercaseCB->isChecked();
151 QString const before = textBeforeED->text();
152 QString const after = textAfterED->text();
154 apply(choice, full, force, before, after);
158 void GuiCitation::showEvent(QShowEvent * e)
161 availableLV->setFocus();
162 DialogView::showEvent(e);
166 void GuiCitation::on_okPB_clicked()
174 void GuiCitation::on_cancelPB_clicked()
181 void GuiCitation::on_applyPB_clicked()
187 void GuiCitation::on_restorePB_clicked()
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()
201 if (selectionManager->selectedFocused()) {
202 if (selectedLV->selectionModel()->selectedIndexes().isEmpty())
203 updateInfo(availableLV->currentIndex());
205 updateInfo(selectedLV->currentIndex());
207 if (availableLV->selectionModel()->selectedIndexes().isEmpty())
208 updateInfo(QModelIndex());
210 updateInfo(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()
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(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()
314 fieldsCO->blockSignals(true);
315 int const oldIndex = fieldsCO->currentIndex();
317 QStringList const fields = to_qstring_list(bibInfo().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()
329 entriesCO->blockSignals(true);
330 int const oldIndex = entriesCO->currentIndex();
332 QStringList const entries = to_qstring_list(bibInfo().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(QModelIndex const & idx)
359 if (!idx.isValid() || bibInfo().empty()) {
360 infoML->document()->clear();
364 QString const keytxt = toqstr(
365 bibInfo().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 vector<docstring> const & fields = bibInfo().getFields();
377 if (index <= -1 || index >= int(fields.size()))
378 //either "All Fields" or "Keys" or an invalid value
379 field = from_ascii("");
381 field = fields[index];
384 bool const onlyKeys = index == -1;
386 //"All Entry Types" is first.
387 index = entriesCO->currentIndex() - 1;
388 vector<docstring> const & entries = bibInfo().getEntries();
389 docstring entry_type;
390 if (index < 0 || index >= int(entries.size()))
391 entry_type = from_ascii("");
393 entry_type = entries[index];
395 bool const case_sentitive = caseCB->checkState();
396 bool const reg_exp = regexCB->checkState();
397 findKey(text, onlyKeys, field, entry_type,
398 case_sentitive, reg_exp, reset);
400 //It'd be nice to save and restore the current selection in
401 //availableLV. Currently, we get an automatic reset, since the
408 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
410 findText(findLE->text(), true);
414 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
416 findText(findLE->text(), true);
420 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
422 if (index >= 0 && index < citationStyleCO->count()) {
423 vector<CiteStyle> const & styles = citeStyles_;
424 updateFormatting(styles[index]);
429 void GuiCitation::on_findLE_textChanged(const QString & text)
431 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
432 searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
433 if (!text.isEmpty()) {
435 findText(findLE->text());
438 findText(findLE->text());
442 void GuiCitation::on_searchPB_clicked()
444 findText(findLE->text(), true);
448 void GuiCitation::on_caseCB_stateChanged(int)
450 findText(findLE->text());
454 void GuiCitation::on_regexCB_stateChanged(int)
456 findText(findLE->text());
460 void GuiCitation::on_asTypeCB_stateChanged(int)
462 bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
463 searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
465 findText(findLE->text(), true);
469 void GuiCitation::changed()
475 void GuiCitation::apply(int const choice, bool full, bool force,
476 QString before, QString after)
478 if (cited_keys_.isEmpty())
481 vector<CiteStyle> const & styles = citeStyles_;
482 if (styles[choice] == NOCITE) {
490 s.style = styles[choice];
492 s.forceUpperCase = force;
493 string const command = citationStyleToString(s);
495 params_.setCmdName(command);
496 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
497 params_["before"] = qstring_to_ucs4(before);
498 params_["after"] = qstring_to_ucs4(after);
503 void GuiCitation::clearSelection()
506 selected_model_.setStringList(cited_keys_);
510 void GuiCitation::init()
512 // Make the list of all available bibliography keys
513 all_keys_ = to_qstring_list(bibInfo().getKeys());
514 available_model_.setStringList(all_keys_);
516 // Ditto for the keys cited in this inset
517 QString str = toqstr(params_["key"]);
521 cited_keys_ = str.split(",");
522 selected_model_.setStringList(cited_keys_);
530 void GuiCitation::findKey(QString const & str, bool only_keys,
531 docstring field, docstring entry_type,
532 bool case_sensitive, bool reg_exp, bool reset)
534 // Used for optimisation: store last searched string.
535 static QString last_searched_string;
536 // Used to disable the above optimisation.
537 static bool last_case_sensitive;
538 static bool last_reg_exp;
539 // Reset last_searched_string in case of changed option.
540 if (last_case_sensitive != case_sensitive
541 || last_reg_exp != reg_exp) {
542 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
543 last_searched_string.clear();
545 // save option for next search.
546 last_case_sensitive = case_sensitive;
547 last_reg_exp = reg_exp;
549 Qt::CaseSensitivity qtcase = case_sensitive ?
550 Qt::CaseSensitive: Qt::CaseInsensitive;
552 // If new string (str) contains the last searched one...
554 !last_searched_string.isEmpty() &&
556 str.contains(last_searched_string, qtcase))
557 // ... then only search within already found list.
558 keys = available_model_.stringList();
560 // ... else search all keys.
562 // save searched string for next search.
563 last_searched_string = str;
567 // First, filter by entry_type, which will be faster than
568 // what follows, so we may get to do that on less.
569 vector<docstring> keyVector = to_docstring_vector(keys);
570 filterByEntryType(keyVector, entry_type);
573 result = to_qstring_list(keyVector);
575 result = to_qstring_list(searchKeys(keyVector, only_keys,
576 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
578 available_model_.setStringList(result);
582 QStringList GuiCitation::citationStyles(int sel)
584 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
585 return to_qstring_list(bibInfo().getCiteStrings(key, buffer()));
589 void GuiCitation::setCitedKeys()
591 cited_keys_ = selected_model_.stringList();
595 bool GuiCitation::initialiseParams(string const & data)
597 InsetCommand::string2params("citation", data, params_);
598 CiteEngine const engine = buffer().params().citeEngine();
599 citeStyles_ = citeStyles(engine);
605 void GuiCitation::clearParams()
611 void GuiCitation::filterByEntryType(
612 vector<docstring> & keyVector, docstring entry_type)
614 if (entry_type.empty())
617 vector<docstring>::iterator it = keyVector.begin();
618 vector<docstring>::iterator end = keyVector.end();
620 vector<docstring> result;
621 for (; it != end; ++it) {
622 docstring const key = *it;
623 BiblioInfo::const_iterator cit = bibInfo().find(key);
624 if (cit == bibInfo().end())
626 if (cit->second.entryType() == entry_type)
627 result.push_back(key);
633 CiteEngine GuiCitation::citeEngine() const
635 return buffer().params().citeEngine();
639 // Escape special chars.
640 // All characters are literals except: '.|*?+(){}[]^$\'
641 // These characters are literals when preceded by a "\", which is done here
642 // @todo: This function should be moved to support, and then the test in tests
643 // should be moved there as well.
644 static docstring escape_special_chars(docstring const & expr)
646 // Search for all chars '.|*?+(){}[^$]\'
647 // Note that '[' and '\' must be escaped.
648 // This is a limitation of boost::regex, but all other chars in BREs
649 // are assumed literal.
650 static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
652 // $& is a perl-like expression that expands to all
653 // of the current match
654 // The '$' must be prefixed with the escape character '\' for
655 // boost to treat it as a literal.
656 // Thus, to prefix a matched expression with '\', we use:
658 return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
662 vector<docstring> GuiCitation::searchKeys(
663 vector<docstring> const & keys_to_search, bool only_keys,
664 docstring const & search_expression, docstring field,
665 bool case_sensitive, bool regex)
667 vector<docstring> foundKeys;
669 docstring expr = trim(search_expression);
674 // We must escape special chars in the search_expr so that
675 // it is treated as a simple string by boost::regex.
676 expr = escape_special_chars(expr);
678 boost::regex reg_exp;
680 reg_exp.assign(to_utf8(expr), case_sensitive ?
681 boost::regex_constants::normal : boost::regex_constants::icase);
682 } catch (boost::regex_error & e) {
683 // boost::regex throws an exception if the regular expression is not
685 LYXERR(Debug::GUI, e.what());
686 return vector<docstring>();
689 vector<docstring>::const_iterator it = keys_to_search.begin();
690 vector<docstring>::const_iterator end = keys_to_search.end();
691 for (; it != end; ++it ) {
692 BiblioInfo::const_iterator info = bibInfo().find(*it);
693 if (info == bibInfo().end())
696 BibTeXInfo const & kvm = info->second;
700 else if (field.empty())
701 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
702 else if (kvm.hasField(field))
703 data = to_utf8(kvm.getValueForField(field));
709 if (boost::regex_search(data, reg_exp))
710 foundKeys.push_back(*it);
712 catch (boost::regex_error & e) {
713 LYXERR(Debug::GUI, e.what());
714 return vector<docstring>();
721 void GuiCitation::dispatchParams()
723 std::string const lfun = InsetCommand::params2string("citation", params_);
724 dispatch(FuncRequest(getLfun(), lfun));
728 BiblioInfo const & GuiCitation::bibInfo() const
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 "GuiCitation_moc.cpp"