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)
145 void GuiCitation::applyView()
147 int const choice = max(0, citationStyleCO->currentIndex());
149 bool const full = fulllistCB->isChecked();
150 bool const force = forceuppercaseCB->isChecked();
152 QString const before = textBeforeED->text();
153 QString const after = textAfterED->text();
155 apply(choice, full, force, before, after);
159 void GuiCitation::showEvent(QShowEvent * e)
162 availableLV->setFocus();
163 DialogView::showEvent(e);
167 void GuiCitation::on_okPB_clicked()
175 void GuiCitation::on_cancelPB_clicked()
182 void GuiCitation::on_applyPB_clicked()
188 void GuiCitation::on_restorePB_clicked()
194 // The main point of separating this out is that the fill*() methods
195 // called in update() do not need to be called for INTERNAL updates,
196 // such as when addPB is pressed, as the list of fields, entries, etc,
197 // will not have changed. At the moment, however, the division between
198 // fillStyles() and updateStyle() doesn't lend itself to dividing the
199 // two methods, though they should be divisible.
200 void GuiCitation::updateControls()
202 if (selectionManager->selectedFocused()) {
203 if (selectedLV->selectionModel()->selectedIndexes().isEmpty())
204 updateInfo(availableLV->currentIndex());
206 updateInfo(selectedLV->currentIndex());
208 if (availableLV->selectionModel()->selectedIndexes().isEmpty())
209 updateInfo(QModelIndex());
211 updateInfo(availableLV->currentIndex());
215 textBeforeED->setText(toqstr(params_["before"]));
216 textAfterED->setText(toqstr(params_["after"]));
222 void GuiCitation::updateFormatting(CiteStyle currentStyle)
224 CiteEngine const engine = citeEngine();
225 bool const natbib_engine =
226 engine == ENGINE_NATBIB_AUTHORYEAR ||
227 engine == ENGINE_NATBIB_NUMERICAL;
228 bool const basic_engine = engine == ENGINE_BASIC;
230 bool const haveSelection =
231 selectedLV->model()->rowCount() > 0;
233 bool const isNocite = currentStyle == NOCITE;
235 fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite);
236 forceuppercaseCB->setEnabled(natbib_engine && haveSelection && !isNocite);
237 textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
238 textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
239 textAfterED->setEnabled(haveSelection && !isNocite);
240 textAfterLA->setEnabled(haveSelection && !isNocite);
241 citationStyleCO->setEnabled(haveSelection);
242 citationStyleLA->setEnabled(haveSelection);
246 void GuiCitation::updateStyle()
248 string const & command = params_.getCmdName();
250 // Find the style of the citekeys
251 vector<CiteStyle> const & styles = citeStyles_;
252 CitationStyle const cs = citationStyleFromString(command);
254 vector<CiteStyle>::const_iterator cit =
255 std::find(styles.begin(), styles.end(), cs.style);
257 // restore the latest natbib style
258 if (style_ >= 0 && style_ < citationStyleCO->count())
259 citationStyleCO->setCurrentIndex(style_);
261 citationStyleCO->setCurrentIndex(0);
263 if (cit != styles.end()) {
264 int const i = int(cit - styles.begin());
265 citationStyleCO->setCurrentIndex(i);
266 fulllistCB->setChecked(cs.full);
267 forceuppercaseCB->setChecked(cs.forceUpperCase);
269 fulllistCB->setChecked(false);
270 forceuppercaseCB->setChecked(false);
272 updateFormatting(cs.style);
275 // This one needs to be called whenever citationStyleCO needs
276 // to be updated---and this would be on anything that changes the
277 // selection in selectedLV, or on a general update.
278 void GuiCitation::fillStyles()
280 int const oldIndex = citationStyleCO->currentIndex();
282 citationStyleCO->clear();
284 QStringList selected_keys = selected_model_.stringList();
285 if (selected_keys.empty()) {
286 citationStyleCO->setEnabled(false);
287 citationStyleLA->setEnabled(false);
291 int curr = selectedLV->model()->rowCount() - 1;
295 if (!selectedLV->selectionModel()->selectedIndexes().empty())
296 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
298 QStringList sty = citationStyles(curr);
300 citationStyleCO->setEnabled(!sty.isEmpty());
301 citationStyleLA->setEnabled(!sty.isEmpty());
306 citationStyleCO->insertItems(0, sty);
308 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
309 citationStyleCO->setCurrentIndex(oldIndex);
313 void GuiCitation::fillFields()
315 fieldsCO->blockSignals(true);
316 int const oldIndex = fieldsCO->currentIndex();
318 QStringList const fields = to_qstring_list(bibInfo().getFields());
319 fieldsCO->insertItem(0, qt_("All Fields"));
320 fieldsCO->insertItem(1, qt_("Keys"));
321 fieldsCO->insertItems(2, fields);
322 if (oldIndex != -1 && oldIndex < fieldsCO->count())
323 fieldsCO->setCurrentIndex(oldIndex);
324 fieldsCO->blockSignals(false);
328 void GuiCitation::fillEntries()
330 entriesCO->blockSignals(true);
331 int const oldIndex = entriesCO->currentIndex();
333 QStringList const entries = to_qstring_list(bibInfo().getEntries());
334 entriesCO->insertItem(0, qt_("All Entry Types"));
335 entriesCO->insertItems(1, entries);
336 if (oldIndex != -1 && oldIndex < entriesCO->count())
337 entriesCO->setCurrentIndex(oldIndex);
338 entriesCO->blockSignals(false);
342 bool GuiCitation::isSelected(const QModelIndex & idx)
344 QString const str = idx.data().toString();
345 return selected_model_.stringList().contains(str);
349 void GuiCitation::setButtons()
351 selectionManager->update();
352 int const srows = selectedLV->model()->rowCount();
353 applyPB->setEnabled(srows > 0);
354 okPB->setEnabled(srows > 0);
358 void GuiCitation::updateInfo(QModelIndex const & idx)
360 if (!idx.isValid() || bibInfo().empty()) {
361 infoML->document()->clear();
365 QString const keytxt = toqstr(
366 bibInfo().getInfo(qstring_to_ucs4(idx.data().toString())));
367 infoML->document()->setPlainText(keytxt);
371 void GuiCitation::findText(QString const & text, bool reset)
373 //"All Fields" and "Keys" are the first two
374 int index = fieldsCO->currentIndex() - 2;
375 vector<docstring> const & fields = bibInfo().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 = bibInfo().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(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 all_keys_ = to_qstring_list(bibInfo().getKeys());
515 available_model_.setStringList(all_keys_);
517 // Ditto for the keys cited in this inset
518 QString str = toqstr(params_["key"]);
522 cited_keys_ = str.split(",");
523 selected_model_.setStringList(cited_keys_);
531 void GuiCitation::findKey(QString const & str, bool only_keys,
532 docstring field, docstring entry_type,
533 bool case_sensitive, bool reg_exp, bool reset)
535 // Used for optimisation: store last searched string.
536 static QString last_searched_string;
537 // Used to disable the above optimisation.
538 static bool last_case_sensitive;
539 static bool last_reg_exp;
540 // Reset last_searched_string in case of changed option.
541 if (last_case_sensitive != case_sensitive
542 || last_reg_exp != reg_exp) {
543 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
544 last_searched_string.clear();
546 // save option for next search.
547 last_case_sensitive = case_sensitive;
548 last_reg_exp = reg_exp;
550 Qt::CaseSensitivity qtcase = case_sensitive ?
551 Qt::CaseSensitive: Qt::CaseInsensitive;
553 // If new string (str) contains the last searched one...
555 !last_searched_string.isEmpty() &&
557 str.contains(last_searched_string, qtcase))
558 // ... then only search within already found list.
559 keys = available_model_.stringList();
561 // ... else search all keys.
563 // save searched string for next search.
564 last_searched_string = str;
568 // First, filter by entry_type, which will be faster than
569 // what follows, so we may get to do that on less.
570 vector<docstring> keyVector = to_docstring_vector(keys);
571 filterByEntryType(keyVector, entry_type);
574 result = to_qstring_list(keyVector);
576 result = to_qstring_list(searchKeys(keyVector, only_keys,
577 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
579 available_model_.setStringList(result);
583 QStringList GuiCitation::citationStyles(int sel)
585 docstring const key = qstring_to_ucs4(cited_keys_[sel]);
586 return to_qstring_list(bibInfo().getCiteStrings(key, buffer()));
590 void GuiCitation::setCitedKeys()
592 cited_keys_ = selected_model_.stringList();
596 bool GuiCitation::initialiseParams(string const & data)
598 InsetCommand::string2params("citation", data, params_);
599 CiteEngine const engine = buffer().params().citeEngine();
600 citeStyles_ = citeStyles(engine);
606 void GuiCitation::clearParams()
612 void GuiCitation::filterByEntryType(
613 vector<docstring> & keyVector, docstring entry_type)
615 if (entry_type.empty())
618 vector<docstring>::iterator it = keyVector.begin();
619 vector<docstring>::iterator end = keyVector.end();
621 vector<docstring> result;
622 for (; it != end; ++it) {
623 docstring const key = *it;
624 BiblioInfo::const_iterator cit = bibInfo().find(key);
625 if (cit == bibInfo().end())
627 if (cit->second.entryType() == entry_type)
628 result.push_back(key);
634 CiteEngine GuiCitation::citeEngine() const
636 return buffer().params().citeEngine();
640 // Escape special chars.
641 // All characters are literals except: '.|*?+(){}[]^$\'
642 // These characters are literals when preceded by a "\", which is done here
643 // @todo: This function should be moved to support, and then the test in tests
644 // should be moved there as well.
645 static docstring escape_special_chars(docstring const & expr)
647 // Search for all chars '.|*?+(){}[^$]\'
648 // Note that '[' and '\' must be escaped.
649 // This is a limitation of boost::regex, but all other chars in BREs
650 // are assumed literal.
651 static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
653 // $& is a perl-like expression that expands to all
654 // of the current match
655 // The '$' must be prefixed with the escape character '\' for
656 // boost to treat it as a literal.
657 // Thus, to prefix a matched expression with '\', we use:
659 return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
663 vector<docstring> GuiCitation::searchKeys(
664 vector<docstring> const & keys_to_search, bool only_keys,
665 docstring const & search_expression, docstring field,
666 bool case_sensitive, bool regex)
668 vector<docstring> foundKeys;
670 docstring expr = trim(search_expression);
675 // We must escape special chars in the search_expr so that
676 // it is treated as a simple string by boost::regex.
677 expr = escape_special_chars(expr);
679 boost::regex reg_exp;
681 reg_exp.assign(to_utf8(expr), case_sensitive ?
682 boost::regex_constants::normal : boost::regex_constants::icase);
683 } catch (boost::regex_error & e) {
684 // boost::regex throws an exception if the regular expression is not
686 LYXERR(Debug::GUI, e.what());
687 return vector<docstring>();
690 vector<docstring>::const_iterator it = keys_to_search.begin();
691 vector<docstring>::const_iterator end = keys_to_search.end();
692 for (; it != end; ++it ) {
693 BiblioInfo::const_iterator info = bibInfo().find(*it);
694 if (info == bibInfo().end())
697 BibTeXInfo const & kvm = info->second;
701 else if (field.empty())
702 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
703 else if (kvm.hasField(field))
704 data = to_utf8(kvm.getValueForField(field));
710 if (boost::regex_search(data, reg_exp))
711 foundKeys.push_back(*it);
713 catch (boost::regex_error & e) {
714 LYXERR(Debug::GUI, e.what());
715 return vector<docstring>();
722 void GuiCitation::dispatchParams()
724 std::string const lfun = InsetCommand::params2string("citation", params_);
725 dispatch(FuncRequest(getLfun(), lfun));
729 BiblioInfo const & GuiCitation::bibInfo() const
731 return buffer().masterBibInfo();
735 void GuiCitation::saveSession() const
737 Dialog::saveSession();
740 sessionKey() + "/regex", regexCB->isChecked());
742 sessionKey() + "/casesensitive", caseCB->isChecked());
744 sessionKey() + "/autofind", asTypeCB->isChecked());
748 void GuiCitation::restoreSession()
750 Dialog::restoreSession();
753 settings.value(sessionKey() + "/regex").toBool());
755 settings.value(sessionKey() + "/casesensitive").toBool());
756 asTypeCB->setChecked(
757 settings.value(sessionKey() + "/autofind").toBool());
761 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
764 } // namespace frontend
767 #include "GuiCitation_moc.cpp"