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 "GuiApplication.h"
20 #include "GuiSelectionManager.h"
21 #include "qt_helpers.h"
24 #include "BufferView.h"
25 #include "BiblioInfo.h"
26 #include "BufferParams.h"
27 #include "TextClass.h"
28 #include "FuncRequest.h"
30 #include "insets/InsetCitation.h"
31 #include "insets/InsetCommand.h"
33 #include "support/debug.h"
34 #include "support/docstring.h"
35 #include "support/gettext.h"
36 #include "support/lstrings.h"
38 #include <QCloseEvent>
42 #include <QStandardItemModel>
50 #include "support/regex.h"
57 using namespace lyx::support;
63 // I am guessing that it would not hurt to make these private members.
64 static vector<string> citeCmds_;
65 static vector<CitationStyle> citeStyles_;
68 template<typename String>
69 static QStringList to_qstring_list(vector<String> const & v)
73 for (size_t i = 0; i != v.size(); ++i) {
76 qlist.append(lyx::toqstr(v[i]));
82 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
84 vector<lyx::docstring> v;
85 for (int i = 0; i != qlist.size(); ++i) {
86 if (qlist[i].isEmpty())
88 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
94 GuiCitation::GuiCitation(GuiView & lv)
95 : DialogView(lv, "citation", qt_("Citation")),
96 style_(QString()), params_(insetCode("citation"))
101 filter_ = new FancyLineEdit(this);
102 filter_->setButtonPixmap(FancyLineEdit::Right, getPixmap("images/", "editclear", "svgz,png"));
103 filter_->setButtonVisible(FancyLineEdit::Right, true);
104 filter_->setButtonToolTip(FancyLineEdit::Right, qt_("Clear text"));
105 filter_->setAutoHideButton(FancyLineEdit::Right, true);
106 filter_->setPlaceholderText(qt_("All avail. citations"));
108 filterBarL->addWidget(filter_, 0);
109 findKeysLA->setBuddy(filter_);
111 // Add search options as button menu
112 regexp_ = new QAction(qt_("Regular e&xpression"), this);
113 regexp_->setCheckable(true);
114 casesense_ = new QAction(qt_("Case se&nsitive"), this);
115 casesense_->setCheckable(true);
116 instant_ = new QAction(qt_("Search as you &type"), this);
117 instant_->setCheckable(true);
118 instant_->setChecked(true);
120 QMenu * searchOpts = new QMenu(this);
121 searchOpts->addAction(regexp_);
122 searchOpts->addAction(casesense_);
123 searchOpts->addAction(instant_);
124 searchOptionsPB->setMenu(searchOpts);
126 connect(citationStyleCO, SIGNAL(activated(int)),
127 this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
128 connect(starredCB, SIGNAL(clicked()),
129 this, SLOT(updateStyles()));
130 connect(literalCB, SIGNAL(clicked()),
131 this, SLOT(changed()));
132 connect(forceuppercaseCB, SIGNAL(clicked()),
133 this, SLOT(updateStyles()));
134 connect(textBeforeED, SIGNAL(textChanged(QString)),
135 this, SLOT(updateStyles()));
136 connect(textAfterED, SIGNAL(textChanged(QString)),
137 this, SLOT(updateStyles()));
138 connect(textBeforeED, SIGNAL(returnPressed()),
139 this, SLOT(on_buttonBox_accepted()));
140 connect(textAfterED, SIGNAL(returnPressed()),
141 this, SLOT(on_buttonBox_accepted()));
143 selectionManager = new GuiSelectionManager(this, availableLV, selectedLV,
144 addPB, deletePB, upPB, downPB, &available_model_, &selected_model_, 1);
145 connect(selectionManager, SIGNAL(selectionChanged()),
146 this, SLOT(setCitedKeys()));
147 connect(selectionManager, SIGNAL(updateHook()),
148 this, SLOT(updateControls()));
149 connect(selectionManager, SIGNAL(okHook()),
150 this, SLOT(on_buttonBox_accepted()));
152 connect(filter_, SIGNAL(rightButtonClicked()),
153 this, SLOT(resetFilter()));
154 connect(filter_, SIGNAL(textEdited(QString)),
155 this, SLOT(filterChanged(QString)));
156 connect(filter_, SIGNAL(returnPressed()),
157 this, SLOT(filterPressed()));
158 #if (QT_VERSION < 0x050000)
159 connect(filter_, SIGNAL(downPressed()),
160 availableLV, SLOT(setFocus()));
162 connect(filter_, &FancyLineEdit::downPressed,
163 availableLV, [=](){ focusAndHighlight(availableLV); });
165 connect(regexp_, SIGNAL(triggered()),
166 this, SLOT(regexChanged()));
167 connect(casesense_, SIGNAL(triggered()),
168 this, SLOT(caseChanged()));
169 connect(instant_, SIGNAL(triggered(bool)),
170 this, SLOT(instantChanged(bool)));
172 #if (QT_VERSION < 0x050000)
173 selectedLV->horizontalHeader()->setResizeMode(QHeaderView::Stretch);
175 selectedLV->horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch);
178 selectedLV->setToolTip(qt_("Ordered list of all cited references.\n"
179 "You can reorder, add and remove references with the buttons on the left."));
180 setFocusProxy(filter_);
184 void GuiCitation::closeEvent(QCloseEvent * e)
187 DialogView::closeEvent(e);
191 void GuiCitation::applyView()
193 int const choice = max(0, citationStyleCO->currentIndex());
194 style_ = citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
195 bool const full = starredCB->isChecked();
196 bool const force = forceuppercaseCB->isChecked();
198 QString const before = textBeforeED->text();
199 QString const after = textAfterED->text();
201 applyParams(choice, full, force, before, after);
205 void GuiCitation::showEvent(QShowEvent * e)
207 if (!filter_->text().isEmpty())
209 availableLV->setFocus();
210 DialogView::showEvent(e);
214 void GuiCitation::on_buttonBox_accepted()
222 void GuiCitation::on_buttonBox_rejected()
229 void GuiCitation::on_buttonBox_clicked(QAbstractButton * button)
231 switch (buttonBox->standardButton(button)) {
232 case QDialogButtonBox::Apply:
235 case QDialogButtonBox::Reset:
246 void GuiCitation::on_literalCB_clicked()
248 InsetCitation::last_literal = literalCB->isChecked();
253 void GuiCitation::updateControls()
255 BiblioInfo const & bi = bibInfo();
260 // The main point of separating this out is that the fill*() methods
261 // called in update() do not need to be called for INTERNAL updates,
262 // such as when addPB is pressed, as the list of fields, entries, etc,
263 // will not have changed.
264 void GuiCitation::updateControls(BiblioInfo const & bi)
266 QModelIndex idx = selectionManager->getSelectedIndex(1);
268 int i = citationStyleCO->currentIndex();
269 if (i == -1 || i > int(citeStyles_.size()))
271 updateFormatting(citeStyles_[size_type(i)]);
272 selectionManager->update();
276 void GuiCitation::updateFormatting(CitationStyle const & currentStyle)
278 BufferParams const bp = documentBuffer().params();
279 bool const force = currentStyle.forceUpperCase;
280 bool const starred = currentStyle.hasStarredVersion;
281 bool const full = starred && bp.fullAuthorList();
282 bool const textbefore = currentStyle.textBefore;
283 bool const textafter = currentStyle.textAfter;
285 int const rows = selectedLV->model()->rowCount();
287 bool const qualified = currentStyle.hasQualifiedList
289 || !params_["pretextlist"].empty()
290 || !params_["posttextlist"].empty()
291 || !getPreTexts().empty()
292 || !getPostTexts().empty());
294 selectedLV->horizontalHeader()->setVisible(qualified);
295 selectedLV->setColumnHidden(0, !qualified);
296 selectedLV->setColumnHidden(2, !qualified);
297 bool const haveSelection = rows > 0;
299 textBeforeLA->setText(qt_("General text befo&re:"));
300 textAfterLA->setText(qt_("General &text after:"));
301 textBeforeED->setToolTip(qt_("Text that precedes the whole reference list. "
302 "For text that precedes individual items, "
303 "double-click on the respective entry above."));
304 textAfterLA->setToolTip(qt_("General &text after:"));
305 textAfterED->setToolTip(qt_("Text that follows the whole reference list. "
306 "For text that follows individual items, "
307 "double-click on the respective entry above."));
309 textBeforeLA->setText(qt_("Text befo&re:"));
310 if (textbefore && haveSelection)
311 textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\")"));
313 textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\"), "
314 "if the current citation style supports this."));
315 textAfterLA->setText(qt_("&Text after:"));
316 if (textafter && haveSelection)
317 textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages)"));
319 textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages), "
320 "if the current citation style supports this."));
323 forceuppercaseCB->setEnabled(force && haveSelection);
324 if (force && haveSelection)
325 forceuppercaseCB->setToolTip(qt_("Force upper case in names (\"Del Piero\", not \"del Piero\")."));
327 forceuppercaseCB->setToolTip(qt_("Force upper case in names (\"Del Piero\", not \"del Piero\"), "
328 "if the current citation style supports this."));
329 starredCB->setEnabled(full && haveSelection);
330 textBeforeED->setEnabled(textbefore && haveSelection);
331 textBeforeLA->setEnabled(textbefore && haveSelection);
332 textAfterED->setEnabled(textafter && haveSelection);
333 textAfterLA->setEnabled(textafter && haveSelection);
334 literalCB->setEnabled(textbefore || textafter);
335 citationStyleCO->setEnabled(haveSelection);
336 citationStyleLA->setEnabled(haveSelection);
338 // Check if we have a custom string/tooltip for the starred version
339 if (starred && !currentStyle.stardesc.empty()) {
341 bp.documentClass().getCiteMacro(bp.citeEngineType(), currentStyle.stardesc);
344 guistring = translateIfPossible(from_utf8(val));
345 starredCB->setText(toqstr(guistring));
346 starredCB->setEnabled(haveSelection);
348 if (!currentStyle.startooltip.empty()) {
349 val = bp.documentClass().getCiteMacro(bp.citeEngineType(),
350 currentStyle.startooltip);
352 guistring = translateIfPossible(from_utf8(val));
354 // Tooltip might also be empty
355 starredCB->setToolTip(toqstr(guistring));
357 // This is the default meaning of the starred commands
358 starredCB->setText(qt_("All aut&hors"));
359 if (full && haveSelection)
360 starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\")"));
362 starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\"), "
363 "if the current citation style supports this."));
365 if (availableLV->selectionModel()->selectedIndexes().isEmpty())
366 availableLV->setToolTip(qt_("All references available for citing."));
368 availableLV->setToolTip(qt_("All references available for citing.\n"
369 "To add the selected one, hit Add, press Enter or double-click.\n"
370 "Hit Ctrl-Enter to add and close the dialog."));
371 // With qualified citation lists, it makes sense to add the same key multiple times
372 selectionManager->allowMultiSelection(currentStyle.hasQualifiedList);
376 // Update the styles for the style combo, citationStyleCO, and mark the
377 // settings as changed. Called upon changing the cited keys (including
378 // merely reordering the keys) or editing the text before/after fields.
379 void GuiCitation::updateStyles()
381 BiblioInfo const & bi = bibInfo();
387 // Update the styles for the style combo, citationStyleCO.
388 void GuiCitation::updateStyles(BiblioInfo const & bi)
390 QStringList selected_keys = selectedKeys();
391 int curr = selectedLV->model()->rowCount() - 1;
393 if (curr < 0 || selected_keys.empty()) {
394 citationStyleCO->clear();
395 citationStyleCO->setEnabled(false);
396 citationStyleLA->setEnabled(false);
400 static const size_t max_length = 80;
401 BiblioInfo::CiteStringMap sty = citationStyles(bi, max_length);
405 citationStyleCO->setEnabled(false);
406 citationStyleLA->setEnabled(false);
407 citationStyleCO->clear();
411 citationStyleCO->blockSignals(true);
413 // save old style selection
414 QString const curdata =
415 citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
416 QString const olddata = (curdata.isEmpty()) ? style_ : curdata;
417 citationStyleCO->clear();
418 BiblioInfo::CiteStringMap::const_iterator cit = sty.begin();
419 BiblioInfo::CiteStringMap::const_iterator end = sty.end();
420 for (int ii = 1; cit != end; ++cit, ++ii)
421 citationStyleCO->addItem(toqstr(cit->second), toqstr(cit->first));
422 citationStyleCO->setEnabled(true);
423 citationStyleLA->setEnabled(true);
424 // restore old style selection
425 int const i = citationStyleCO->findData(olddata);
427 citationStyleCO->setCurrentIndex(i);
429 citationStyleCO->blockSignals(false);
433 void GuiCitation::fillFields(BiblioInfo const & bi)
435 fieldsCO->blockSignals(true);
436 int const oldIndex = fieldsCO->currentIndex();
438 QStringList const fields = to_qstring_list(bi.getFields());
439 fieldsCO->insertItem(0, qt_("All fields"));
440 fieldsCO->insertItem(1, qt_("Keys"));
441 fieldsCO->insertItems(2, fields);
442 if (oldIndex != -1 && oldIndex < fieldsCO->count())
443 fieldsCO->setCurrentIndex(oldIndex);
444 fieldsCO->blockSignals(false);
448 void GuiCitation::fillEntries(BiblioInfo const & bi)
450 entriesCO->blockSignals(true);
451 int const oldIndex = entriesCO->currentIndex();
453 QStringList const entries = to_qstring_list(bi.getEntries());
454 entriesCO->insertItem(0, qt_("All entry types"));
455 entriesCO->insertItems(1, entries);
456 if (oldIndex != -1 && oldIndex < entriesCO->count())
457 entriesCO->setCurrentIndex(oldIndex);
458 entriesCO->blockSignals(false);
462 bool GuiCitation::isSelected(QModelIndex const & idx)
464 QString const str = idx.data().toString();
465 return selectedKeys().contains(str);
469 void GuiCitation::setButtons()
471 int const srows = selectedLV->model()->rowCount();
472 buttonBox->button(QDialogButtonBox::Apply)->setEnabled(srows > 0);
473 buttonBox->button(QDialogButtonBox::Ok)->setEnabled(srows > 0);
477 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
479 if (!idx.isValid() || bi.empty()) {
480 infoML->document()->clear();
481 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
485 infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
488 QString const keytxt = toqstr(
489 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), ci));
490 infoML->document()->setHtml(keytxt);
494 void GuiCitation::findText(QString const & text, bool reset)
496 //"All Fields" and "Keys" are the first two
497 int index = fieldsCO->currentIndex() - 2;
498 BiblioInfo const & bi = bibInfo();
499 vector<docstring> const & fields = bi.getFields();
502 if (index <= -1 || index >= int(fields.size()))
503 //either "All Fields" or "Keys" or an invalid value
504 field = from_ascii("");
506 field = fields[size_type(index)];
509 bool const onlyKeys = index == -1;
511 //"All Entry Types" is first.
512 index = entriesCO->currentIndex() - 1;
513 vector<docstring> const & entries = bi.getEntries();
514 docstring entry_type;
515 if (index < 0 || index >= int(entries.size()))
516 entry_type = from_ascii("");
518 entry_type = entries[size_type(index)];
520 bool const case_sentitive = casesense_->isChecked();
521 bool const reg_exp = regexp_->isChecked();
523 findKey(bi, text, onlyKeys, field, entry_type,
524 case_sentitive, reg_exp, reset);
526 //It'd be nice to save and restore the current selection in
527 //availableLV. Currently, we get an automatic reset, since the
534 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
536 findText(filter_->text(), true);
540 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
542 findText(filter_->text(), true);
546 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
548 if (index >= 0 && index < citationStyleCO->count()) {
549 vector<CitationStyle> const & styles = citeStyles_;
550 updateFormatting(styles[size_type(index)]);
556 void GuiCitation::filterChanged(const QString & text)
558 if (!text.isEmpty()) {
559 if (instant_->isChecked())
560 findText(filter_->text());
563 findText(filter_->text());
568 void GuiCitation::filterPressed()
570 findText(filter_->text(), true);
574 void GuiCitation::resetFilter()
576 filter_->setText(QString());
577 findText(filter_->text(), true);
581 void GuiCitation::caseChanged()
583 findText(filter_->text());
587 void GuiCitation::regexChanged()
589 findText(filter_->text());
593 void GuiCitation::updateFilterHint()
595 QString hint = instant_->isChecked() ?
596 qt_("Enter string to filter the list of available citations") :
597 qt_("Enter string to filter the list of available citations and press <Enter>");
598 hint += qt_("\nThe down arrow key will get you into the list of filtered citations.");
599 filter_->setToolTip(hint);
603 void GuiCitation::instantChanged(bool checked)
606 findText(filter_->text(), true);
612 void GuiCitation::changed()
618 void GuiCitation::applyParams(int const choice, bool full, bool force,
619 QString before, QString after)
621 if (cited_keys_.isEmpty())
624 vector<CitationStyle> const & styles = citeStyles_;
626 CitationStyle cs = styles[size_type(choice)];
633 cs.forceUpperCase &= force;
634 cs.hasStarredVersion &= full;
635 string const command = citationStyleToString(cs);
637 params_.setCmdName(command);
638 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
639 params_["before"] = qstring_to_ucs4(before);
640 params_["after"] = qstring_to_ucs4(after);
641 if (cs.hasQualifiedList) {
642 params_["pretextlist"] = getStringFromVector(getPreTexts(), from_ascii("\t"));
643 params_["posttextlist"] = getStringFromVector(getPostTexts(), from_ascii("\t"));
645 params_["literal"] = literalCB->isChecked() ? from_ascii("true") : from_ascii("false");
650 void GuiCitation::clearSelection()
653 setSelectedKeys(cited_keys_);
657 void GuiCitation::setSelectedKeys(QStringList const sl)
659 selected_model_.clear();
660 selected_model_.setColumnCount(3);
662 headers << qt_("Text before")
664 << qt_("Text after");
665 selected_model_.setHorizontalHeaderLabels(headers);
666 selectedLV->setColumnHidden(0, true);
667 selectedLV->setColumnHidden(2, true);
668 selectedLV->verticalHeader()->setVisible(false);
669 selectedLV->horizontalHeader()->setVisible(false);
670 QStringList::const_iterator it = sl.begin();
671 QStringList::const_iterator end = sl.end();
672 for (int i = 0; it != end; ++it, ++i) {
673 QStandardItem * si = new QStandardItem();
677 si->setEditable(false);
678 selected_model_.setItem(i, 1, si);
683 QStringList GuiCitation::selectedKeys()
686 for (int i = 0; i != selected_model_.rowCount(); ++i) {
687 QStandardItem const * item = selected_model_.item(i, 1);
689 res.append(item->text());
695 void GuiCitation::setPreTexts(vector<docstring> const m)
697 for (docstring const & s: m) {
698 QStandardItem * si = new QStandardItem();
700 docstring pre = split(s, key, ' ');
701 si->setData(toqstr(pre));
702 si->setText(toqstr(pre));
703 QModelIndexList qmil =
704 selected_model_.match(selected_model_.index(0, 1),
705 Qt::DisplayRole, toqstr(key), 1,
706 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
708 selected_model_.setItem(qmil.front().row(), 0, si);
713 vector<docstring> GuiCitation::getPreTexts()
715 vector<docstring> res;
716 for (int i = 0; i != selected_model_.rowCount(); ++i) {
717 QStandardItem const * key = selected_model_.item(i, 1);
718 QStandardItem const * pre = selected_model_.item(i, 0);
719 if (key && pre && !key->text().isEmpty() && !pre->text().isEmpty())
720 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(pre->text()));
726 void GuiCitation::setPostTexts(vector<docstring> const m)
728 for (docstring const & s: m) {
729 QStandardItem * si = new QStandardItem();
731 docstring post = split(s, key, ' ');
732 si->setData(toqstr(post));
733 si->setText(toqstr(post));
734 QModelIndexList qmil =
735 selected_model_.match(selected_model_.index(0, 1),
736 Qt::DisplayRole, toqstr(key), 1,
737 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
739 selected_model_.setItem(qmil.front().row(), 2, si);
744 vector<docstring> GuiCitation::getPostTexts()
746 vector<docstring> res;
747 for (int i = 0; i != selected_model_.rowCount(); ++i) {
748 QStandardItem const * key = selected_model_.item(i, 1);
749 QStandardItem const * post = selected_model_.item(i, 2);
750 if (key && post && !key->text().isEmpty() && !post->text().isEmpty())
751 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(post->text()));
757 void GuiCitation::init()
759 // Make the list of all available bibliography keys
760 BiblioInfo const & bi = bibInfo();
761 all_keys_ = to_qstring_list(bi.getKeys());
763 available_model_.setStringList(all_keys_);
765 // Ditto for the keys cited in this inset
766 QString str = toqstr(params_["key"]);
770 cited_keys_ = str.split(",");
771 setSelectedKeys(cited_keys_);
773 // Initialize the drop downs
777 // Initialize the citation formatting
778 string const & cmd = params_.getCmdName();
779 CitationStyle const cs =
780 citationStyleFromString(cmd, documentBuffer().params());
782 forceuppercaseCB->setChecked(cs.forceUpperCase);
783 starredCB->setChecked(cs.hasStarredVersion &&
784 documentBuffer().params().fullAuthorList());
785 textBeforeED->setText(toqstr(params_["before"]));
786 textAfterED->setText(toqstr(params_["after"]));
788 // if this is a new citation, we set the literal checkbox
789 // to its last set value.
790 if (cited_keys_.isEmpty())
791 literalCB->setChecked(InsetCitation::last_literal);
793 literalCB->setChecked(params_["literal"] == "true");
795 setPreTexts(getVectorFromString(params_["pretextlist"], from_ascii("\t")));
796 setPostTexts(getVectorFromString(params_["posttextlist"], from_ascii("\t")));
798 // Update the interface
801 if (selected_model_.rowCount()) {
802 selectedLV->blockSignals(true);
803 selectedLV->setFocus();
804 selectedLV->selectRow(0);
805 selectedLV->blockSignals(false);
807 // Find the citation style
808 vector<string> const & cmds = citeCmds_;
809 vector<string>::const_iterator cit =
810 std::find(cmds.begin(), cmds.end(), cs.name);
812 if (cit != cmds.end())
813 i = int(cit - cmds.begin());
815 // Set the style combo appropriately
816 citationStyleCO->blockSignals(true);
817 citationStyleCO->setCurrentIndex(i);
818 citationStyleCO->blockSignals(false);
819 updateFormatting(citeStyles_[size_type(i)]);
821 availableLV->setFocus();
823 buttonBox->button(QDialogButtonBox::Apply)->setEnabled(false);
824 buttonBox->button(QDialogButtonBox::Ok)->setEnabled(false);
828 void GuiCitation::findKey(BiblioInfo const & bi,
829 QString const & str, bool only_keys,
830 docstring field, docstring entry_type,
831 bool case_sensitive, bool reg_exp, bool reset)
834 // This should be moved to a class member.
835 // Used for optimisation: store last searched string.
836 static QString last_searched_string;
837 // Used to disable the above optimisation.
838 static bool last_case_sensitive;
839 static bool last_reg_exp;
840 // Reset last_searched_string in case of changed option.
841 if (last_case_sensitive != case_sensitive
842 || last_reg_exp != reg_exp) {
843 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
844 last_searched_string.clear();
846 // save option for next search.
847 last_case_sensitive = case_sensitive;
848 last_reg_exp = reg_exp;
850 Qt::CaseSensitivity qtcase = case_sensitive ?
851 Qt::CaseSensitive: Qt::CaseInsensitive;
853 // If new string (str) contains the last searched one...
855 !last_searched_string.isEmpty() &&
857 str.contains(last_searched_string, qtcase))
858 // ... then only search within already found list.
859 keys = available_model_.stringList();
861 // ... else search all keys.
863 // save searched string for next search.
864 last_searched_string = str;
868 // First, filter by entry_type, which will be faster than
869 // what follows, so we may get to do that on less.
870 vector<docstring> keyVector = to_docstring_vector(keys);
871 filterByEntryType(bi, keyVector, entry_type);
874 result = to_qstring_list(keyVector);
876 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
877 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
879 available_model_.setStringList(result);
883 BiblioInfo::CiteStringMap GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
885 vector<docstring> const keys = to_docstring_vector(cited_keys_);
886 vector<CitationStyle> styles = citeStyles_;
887 int ind = citationStyleCO->currentIndex();
890 CitationStyle cs = styles[size_type(ind)];
891 vector<docstring> pretexts = getPreTexts();
892 vector<docstring> posttexts = getPostTexts();
893 bool const qualified = cs.hasQualifiedList
894 && (selectedLV->model()->rowCount() > 1
896 || !posttexts.empty());
897 std::map<docstring, docstring> pres;
898 for (docstring const & s: pretexts) {
900 docstring val = split(s, key, ' ');
903 std::map<docstring, docstring> posts;
904 for (docstring const & s: posttexts) {
906 docstring val = split(s, key, ' ');
910 ci.textBefore = qstring_to_ucs4(textBeforeED->text());
911 ci.textAfter = qstring_to_ucs4(textAfterED->text());
912 ci.forceUpperCase = forceuppercaseCB->isChecked();
913 ci.Starred = starredCB->isChecked();
914 ci.context = CiteItem::Dialog;
915 ci.max_size = max_size;
916 ci.isQualified = qualified;
918 ci.posttexts = posts;
919 BiblioInfo::CiteStringMap ret = bi.getCiteStrings(keys, styles, documentBuffer(), ci);
924 void GuiCitation::setCitedKeys()
926 cited_keys_ = selectedKeys();
931 bool GuiCitation::initialiseParams(string const & sdata)
933 InsetCommand::string2params(sdata, params_);
934 citeCmds_ = documentBuffer().params().citeCommands();
935 citeStyles_ = documentBuffer().params().citeStyles();
941 void GuiCitation::clearParams()
947 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
948 vector<docstring> & keyVector, docstring entry_type)
950 if (entry_type.empty())
953 vector<docstring>::iterator it = keyVector.begin();
954 vector<docstring>::iterator end = keyVector.end();
956 vector<docstring> result;
957 for (; it != end; ++it) {
958 docstring const key = *it;
959 BiblioInfo::const_iterator cit = bi.find(key);
962 if (cit->second.entryType() == entry_type)
963 result.push_back(key);
969 // Escape special chars.
970 // All characters are literals except: '.|*?+(){}[]^$\'
971 // These characters are literals when preceded by a "\", which is done here
972 // @todo: This function should be moved to support, and then the test in tests
973 // should be moved there as well.
974 static docstring escape_special_chars(docstring const & expr)
976 // Search for all chars '.|*?+(){}[^$]\'
977 // Note that '[', ']', and '\' must be escaped.
978 static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
980 // $& is an ECMAScript format expression that expands to all
981 // of the current match
982 #ifdef LYX_USE_STD_REGEX
983 // To prefix a matched expression with a single literal backslash, we
984 // need to escape it for the C++ compiler and use:
986 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
988 // A backslash in the format string starts an escape sequence in boost.
989 // Thus, to prefix a matched expression with a single literal backslash,
990 // we need to give two backslashes to the regex engine, and escape both
991 // for the C++ compiler and use:
993 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
998 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
999 vector<docstring> const & keys_to_search, bool only_keys,
1000 docstring const & search_expression, docstring field,
1001 bool case_sensitive, bool regex)
1003 vector<docstring> foundKeys;
1005 docstring expr = trim(search_expression);
1010 // We must escape special chars in the search_expr so that
1011 // it is treated as a simple string by lyx::regex.
1012 expr = escape_special_chars(expr);
1016 reg_exp.assign(to_utf8(expr), case_sensitive ?
1017 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
1018 } catch (lyx::regex_error const & e) {
1019 // lyx::regex throws an exception if the regular expression is not
1021 LYXERR(Debug::GUI, e.what());
1022 return vector<docstring>();
1025 vector<docstring>::const_iterator it = keys_to_search.begin();
1026 vector<docstring>::const_iterator end = keys_to_search.end();
1027 for (; it != end; ++it ) {
1028 BiblioInfo::const_iterator info = bi.find(*it);
1029 if (info == bi.end())
1032 BibTeXInfo const & kvm = info->second;
1035 sdata = to_utf8(*it);
1036 else if (field.empty())
1037 sdata = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
1039 sdata = to_utf8(kvm[field]);
1045 if (lyx::regex_search(sdata, reg_exp))
1046 foundKeys.push_back(*it);
1048 catch (lyx::regex_error const & e) {
1049 LYXERR(Debug::GUI, e.what());
1050 return vector<docstring>();
1057 void GuiCitation::dispatchParams()
1059 std::string const lfun = InsetCommand::params2string(params_);
1060 dispatch(FuncRequest(getLfun(), lfun));
1064 BiblioInfo const & GuiCitation::bibInfo() const
1066 Buffer const & buf = documentBuffer();
1067 buf.reloadBibInfoCache();
1068 return buf.masterBibInfo();
1072 void GuiCitation::saveSession(QSettings & settings) const
1074 Dialog::saveSession(settings);
1076 sessionKey() + "/regex", regexp_->isChecked());
1078 sessionKey() + "/casesensitive", casesense_->isChecked());
1080 sessionKey() + "/autofind", instant_->isChecked());
1082 sessionKey() + "/citestyle", style_);
1084 sessionKey() + "/literal", InsetCitation::last_literal);
1088 void GuiCitation::restoreSession()
1090 Dialog::restoreSession();
1092 regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
1093 casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
1094 instant_->setChecked(settings.value(sessionKey() + "/autofind", true).toBool());
1095 style_ = settings.value(sessionKey() + "/citestyle").toString();
1096 InsetCitation::last_literal =
1097 settings.value(sessionKey() + "/literal", false).toBool();
1102 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
1105 } // namespace frontend
1108 #include "moc_GuiCitation.cpp"