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 "LyXToolBox.h"
22 #include "qt_helpers.h"
25 #include "BufferView.h"
26 #include "BiblioInfo.h"
27 #include "BufferParams.h"
28 #include "TextClass.h"
29 #include "FuncRequest.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_(0), 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_okPB_clicked()));
140 connect(textAfterED, SIGNAL(returnPressed()),
141 this, SLOT(on_okPB_clicked()));
143 selectionManager = new GuiSelectionManager(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_okPB_clicked()));
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 connect(regexp_, SIGNAL(triggered()),
159 this, SLOT(regexChanged()));
160 connect(casesense_, SIGNAL(triggered()),
161 this, SLOT(caseChanged()));
162 connect(instant_, SIGNAL(triggered(bool)),
163 this, SLOT(instantChanged(bool)));
165 #if (QT_VERSION < 0x050000)
166 selectedLV->horizontalHeader()->setResizeMode(QHeaderView::Stretch);
168 selectedLV->horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch);
171 setFocusProxy(filter_);
175 GuiCitation::~GuiCitation()
177 delete selectionManager;
181 void GuiCitation::closeEvent(QCloseEvent * e)
184 DialogView::closeEvent(e);
188 void GuiCitation::applyView()
190 int const choice = max(0, citationStyleCO->currentIndex());
192 bool const full = starredCB->isChecked();
193 bool const force = forceuppercaseCB->isChecked();
195 QString const before = textBeforeED->text();
196 QString const after = textAfterED->text();
198 applyParams(choice, full, force, before, after);
202 void GuiCitation::showEvent(QShowEvent * e)
205 availableLV->setFocus();
206 DialogView::showEvent(e);
210 void GuiCitation::on_okPB_clicked()
218 void GuiCitation::on_cancelPB_clicked()
225 void GuiCitation::on_applyPB_clicked()
231 void GuiCitation::on_restorePB_clicked()
238 void GuiCitation::updateControls()
240 BiblioInfo const & bi = bibInfo();
245 // The main point of separating this out is that the fill*() methods
246 // called in update() do not need to be called for INTERNAL updates,
247 // such as when addPB is pressed, as the list of fields, entries, etc,
248 // will not have changed.
249 void GuiCitation::updateControls(BiblioInfo const & bi)
251 QModelIndex idx = selectionManager->getSelectedIndex(1);
253 selectionManager->update();
257 void GuiCitation::updateFormatting(CitationStyle currentStyle)
259 BufferParams const bp = documentBuffer().params();
260 bool const force = currentStyle.forceUpperCase;
261 bool const starred = currentStyle.hasStarredVersion;
262 bool const full = starred && bp.fullAuthorList();
263 bool const textbefore = currentStyle.textBefore;
264 bool const textafter = currentStyle.textAfter;
266 int const rows = selectedLV->model()->rowCount();
268 bool const qualified = currentStyle.hasQualifiedList
270 || !params_["pretextlist"].empty()
271 || !params_["posttextlist"].empty());
272 selectedLV->horizontalHeader()->setVisible(qualified);
273 selectedLV->setColumnHidden(0, !qualified);
274 selectedLV->setColumnHidden(2, !qualified);
276 textBeforeLA->setText(qt_("General text befo&re:"));
277 textAfterLA->setText(qt_("General &text after:"));
278 textBeforeED->setToolTip(qt_("Text that precedes the whole reference list. "
279 "For text that precedes individual items, double-click on the respective entry above."));
280 textAfterLA->setToolTip(qt_("General &text after:"));
281 textAfterED->setToolTip(qt_("Text that follows the whole reference list. "
282 "For text that follows individual items, double-click on the respective entry above."));
284 textBeforeLA->setText(qt_("Text befo&re:"));
285 textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\")"));
286 textAfterLA->setText(qt_("&Text after:"));
287 textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages)"));
290 bool const haveSelection = rows > 0;
292 forceuppercaseCB->setEnabled(force && haveSelection);
293 starredCB->setEnabled(full && haveSelection);
294 textBeforeED->setEnabled(textbefore && haveSelection);
295 textBeforeLA->setEnabled(textbefore && haveSelection);
296 textAfterED->setEnabled(textafter && haveSelection);
297 textAfterLA->setEnabled(textafter && haveSelection);
298 citationStyleCO->setEnabled(haveSelection);
299 citationStyleLA->setEnabled(haveSelection);
301 // Check if we have a custom string/tooltip for the starred version
302 if (starred && !currentStyle.stardesc.empty()) {
304 bp.documentClass().getCiteMacro(bp.citeEngineType(), currentStyle.stardesc);
307 guistring = translateIfPossible(from_utf8(val));
308 starredCB->setText(toqstr(guistring));
309 starredCB->setEnabled(haveSelection);
311 if (!currentStyle.startooltip.empty()) {
312 val = bp.documentClass().getCiteMacro(bp.citeEngineType(),
313 currentStyle.startooltip);
315 guistring = translateIfPossible(from_utf8(val));
317 // Tooltip might also be empty
318 starredCB->setToolTip(toqstr(guistring));
320 // This is the default meaning of the starred commands
321 starredCB->setText(qt_("All aut&hors"));
322 starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\")"));
327 // Update the styles for the style combo, citationStyleCO, and mark the
328 // settings as changed. Called upon changing the cited keys (including
329 // merely reordering the keys) or editing the text before/after fields.
330 void GuiCitation::updateStyles()
332 BiblioInfo const & bi = bibInfo();
338 // Update the styles for the style combo, citationStyleCO.
339 void GuiCitation::updateStyles(BiblioInfo const & bi)
341 QStringList selected_keys = selectedKeys();
342 int curr = selectedLV->model()->rowCount() - 1;
344 if (curr < 0 || selected_keys.empty()) {
345 citationStyleCO->clear();
346 citationStyleCO->setEnabled(false);
347 citationStyleLA->setEnabled(false);
351 static const size_t max_length = 80;
352 QStringList sty = citationStyles(bi, max_length);
356 citationStyleCO->setEnabled(false);
357 citationStyleLA->setEnabled(false);
358 citationStyleCO->clear();
362 citationStyleCO->blockSignals(true);
365 int const curindex = citationStyleCO->currentIndex();
366 int const oldIndex = (curindex < 0) ? style_ : curindex;
367 citationStyleCO->clear();
368 citationStyleCO->insertItems(0, sty);
369 citationStyleCO->setEnabled(true);
370 citationStyleLA->setEnabled(true);
372 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
373 citationStyleCO->setCurrentIndex(oldIndex);
375 citationStyleCO->blockSignals(false);
379 void GuiCitation::fillFields(BiblioInfo const & bi)
381 fieldsCO->blockSignals(true);
382 int const oldIndex = fieldsCO->currentIndex();
384 QStringList const fields = to_qstring_list(bi.getFields());
385 fieldsCO->insertItem(0, qt_("All fields"));
386 fieldsCO->insertItem(1, qt_("Keys"));
387 fieldsCO->insertItems(2, fields);
388 if (oldIndex != -1 && oldIndex < fieldsCO->count())
389 fieldsCO->setCurrentIndex(oldIndex);
390 fieldsCO->blockSignals(false);
394 void GuiCitation::fillEntries(BiblioInfo const & bi)
396 entriesCO->blockSignals(true);
397 int const oldIndex = entriesCO->currentIndex();
399 QStringList const entries = to_qstring_list(bi.getEntries());
400 entriesCO->insertItem(0, qt_("All entry types"));
401 entriesCO->insertItems(1, entries);
402 if (oldIndex != -1 && oldIndex < entriesCO->count())
403 entriesCO->setCurrentIndex(oldIndex);
404 entriesCO->blockSignals(false);
408 bool GuiCitation::isSelected(QModelIndex const & idx)
410 QString const str = idx.data().toString();
411 return selectedKeys().contains(str);
415 void GuiCitation::setButtons()
417 int const srows = selectedLV->model()->rowCount();
418 applyPB->setEnabled(srows > 0);
419 okPB->setEnabled(srows > 0);
423 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
425 if (!idx.isValid() || bi.empty()) {
426 infoML->document()->clear();
427 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
431 infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
434 QString const keytxt = toqstr(
435 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), ci));
436 infoML->document()->setHtml(keytxt);
440 void GuiCitation::findText(QString const & text, bool reset)
442 //"All Fields" and "Keys" are the first two
443 int index = fieldsCO->currentIndex() - 2;
444 BiblioInfo const & bi = bibInfo();
445 vector<docstring> const & fields = bi.getFields();
448 if (index <= -1 || index >= int(fields.size()))
449 //either "All Fields" or "Keys" or an invalid value
450 field = from_ascii("");
452 field = fields[index];
455 bool const onlyKeys = index == -1;
457 //"All Entry Types" is first.
458 index = entriesCO->currentIndex() - 1;
459 vector<docstring> const & entries = bi.getEntries();
460 docstring entry_type;
461 if (index < 0 || index >= int(entries.size()))
462 entry_type = from_ascii("");
464 entry_type = entries[index];
466 bool const case_sentitive = casesense_->isChecked();
467 bool const reg_exp = regexp_->isChecked();
469 findKey(bi, text, onlyKeys, field, entry_type,
470 case_sentitive, reg_exp, reset);
472 //It'd be nice to save and restore the current selection in
473 //availableLV. Currently, we get an automatic reset, since the
480 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
482 findText(filter_->text(), true);
486 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
488 findText(filter_->text(), true);
492 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
494 if (index >= 0 && index < citationStyleCO->count()) {
495 vector<CitationStyle> const & styles = citeStyles_;
496 updateFormatting(styles[index]);
502 void GuiCitation::filterChanged(const QString & text)
504 if (!text.isEmpty()) {
505 if (instant_->isChecked())
506 findText(filter_->text());
509 findText(filter_->text());
514 void GuiCitation::filterPressed()
516 findText(filter_->text(), true);
520 void GuiCitation::resetFilter()
522 filter_->setText(QString());
523 findText(filter_->text(), true);
527 void GuiCitation::caseChanged()
529 findText(filter_->text());
533 void GuiCitation::regexChanged()
535 findText(filter_->text());
539 void GuiCitation::updateFilterHint()
541 QString const hint = instant_->isChecked() ?
542 qt_("Enter string to filter the list of available citations") :
543 qt_("Enter string to filter the list of available citations and press <Enter>");
544 filter_->setToolTip(hint);
548 void GuiCitation::instantChanged(bool checked)
551 findText(filter_->text(), true);
557 void GuiCitation::changed()
563 void GuiCitation::applyParams(int const choice, bool full, bool force,
564 QString before, QString after)
566 if (cited_keys_.isEmpty())
569 vector<CitationStyle> const & styles = citeStyles_;
571 CitationStyle cs = styles[choice];
578 cs.forceUpperCase &= force;
579 cs.hasStarredVersion &= full;
580 string const command = citationStyleToString(cs);
582 params_.setCmdName(command);
583 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
584 params_["before"] = qstring_to_ucs4(before);
585 params_["after"] = qstring_to_ucs4(after);
586 if (cs.hasQualifiedList) {
587 params_["pretextlist"] = getStringFromVector(getPreTexts(), from_ascii("\t"));
588 params_["posttextlist"] = getStringFromVector(getPostTexts(), from_ascii("\t"));
590 params_["literal"] = literalCB->isChecked() ? from_ascii("true") : from_ascii("false");
595 void GuiCitation::clearSelection()
598 setSelectedKeys(cited_keys_);
602 void GuiCitation::setSelectedKeys(QStringList const sl)
604 selected_model_.clear();
605 selected_model_.setColumnCount(3);
607 headers << qt_("Text before")
609 << qt_("Text after");
610 selected_model_.setHorizontalHeaderLabels(headers);
611 selectedLV->setColumnHidden(0, true);
612 selectedLV->setColumnHidden(2, true);
613 selectedLV->verticalHeader()->setVisible(false);
614 selectedLV->horizontalHeader()->setVisible(false);
615 QStringList::const_iterator it = sl.begin();
616 QStringList::const_iterator end = sl.end();
617 for (int i = 0; it != end; ++it, ++i) {
618 QStandardItem * si = new QStandardItem();
622 si->setEditable(false);
623 selected_model_.setItem(i, 1, si);
628 QStringList GuiCitation::selectedKeys()
631 for (int i = 0; i != selected_model_.rowCount(); ++i) {
632 QStandardItem const * item = selected_model_.item(i, 1);
634 res.append(item->text());
640 void GuiCitation::setPreTexts(vector<docstring> const m)
642 for (docstring const & s: m) {
643 QStandardItem * si = new QStandardItem();
645 docstring pre = split(s, key, ' ');
646 si->setData(toqstr(pre));
647 si->setText(toqstr(pre));
648 QModelIndexList qmil =
649 selected_model_.match(selected_model_.index(0, 1),
650 Qt::DisplayRole, toqstr(key), 1,
651 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
653 selected_model_.setItem(qmil.front().row(), 0, si);
658 vector<docstring> GuiCitation::getPreTexts()
660 vector<docstring> res;
661 for (int i = 0; i != selected_model_.rowCount(); ++i) {
662 QStandardItem const * key = selected_model_.item(i, 1);
663 QStandardItem const * pre = selected_model_.item(i, 0);
664 if (key && pre && !key->text().isEmpty() && !pre->text().isEmpty())
665 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(pre->text()));
671 void GuiCitation::setPostTexts(vector<docstring> const m)
673 for (docstring const & s: m) {
674 QStandardItem * si = new QStandardItem();
676 docstring post = split(s, key, ' ');
677 si->setData(toqstr(post));
678 si->setText(toqstr(post));
679 QModelIndexList qmil =
680 selected_model_.match(selected_model_.index(0, 1),
681 Qt::DisplayRole, toqstr(key), 1,
682 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
684 selected_model_.setItem(qmil.front().row(), 2, si);
689 vector<docstring> GuiCitation::getPostTexts()
691 vector<docstring> res;
692 for (int i = 0; i != selected_model_.rowCount(); ++i) {
693 QStandardItem const * key = selected_model_.item(i, 1);
694 QStandardItem const * post = selected_model_.item(i, 2);
696 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(post->text()));
702 void GuiCitation::init()
704 // Make the list of all available bibliography keys
705 BiblioInfo const & bi = bibInfo();
706 all_keys_ = to_qstring_list(bi.getKeys());
708 available_model_.setStringList(all_keys_);
710 // Ditto for the keys cited in this inset
711 QString str = toqstr(params_["key"]);
715 cited_keys_ = str.split(",");
716 setSelectedKeys(cited_keys_);
718 // Initialize the drop downs
722 // Initialize the citation formatting
723 string const & cmd = params_.getCmdName();
724 CitationStyle const cs =
725 citationStyleFromString(cmd, documentBuffer().params());
727 forceuppercaseCB->setChecked(cs.forceUpperCase);
728 starredCB->setChecked(cs.hasStarredVersion &&
729 documentBuffer().params().fullAuthorList());
730 textBeforeED->setText(toqstr(params_["before"]));
731 textAfterED->setText(toqstr(params_["after"]));
732 literalCB->setChecked(params_["literal"] == "true");
734 setPreTexts(getVectorFromString(params_["pretextlist"], from_ascii("\t")));
735 setPostTexts(getVectorFromString(params_["posttextlist"], from_ascii("\t")));
737 // Update the interface
740 if (selected_model_.rowCount()) {
741 selectedLV->blockSignals(true);
742 selectedLV->setFocus();
743 selectedLV->selectRow(0);
744 selectedLV->blockSignals(false);
746 // Find the citation style
747 vector<string> const & cmds = citeCmds_;
748 vector<string>::const_iterator cit =
749 std::find(cmds.begin(), cmds.end(), cs.name);
751 if (cit != cmds.end())
752 i = int(cit - cmds.begin());
754 // Set the style combo appropriately
755 citationStyleCO->blockSignals(true);
756 citationStyleCO->setCurrentIndex(i);
757 citationStyleCO->blockSignals(false);
758 updateFormatting(citeStyles_[i]);
760 availableLV->setFocus();
762 applyPB->setEnabled(false);
763 okPB->setEnabled(false);
767 void GuiCitation::findKey(BiblioInfo const & bi,
768 QString const & str, bool only_keys,
769 docstring field, docstring entry_type,
770 bool case_sensitive, bool reg_exp, bool reset)
773 // This should be moved to a class member.
774 // Used for optimisation: store last searched string.
775 static QString last_searched_string;
776 // Used to disable the above optimisation.
777 static bool last_case_sensitive;
778 static bool last_reg_exp;
779 // Reset last_searched_string in case of changed option.
780 if (last_case_sensitive != case_sensitive
781 || last_reg_exp != reg_exp) {
782 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
783 last_searched_string.clear();
785 // save option for next search.
786 last_case_sensitive = case_sensitive;
787 last_reg_exp = reg_exp;
789 Qt::CaseSensitivity qtcase = case_sensitive ?
790 Qt::CaseSensitive: Qt::CaseInsensitive;
792 // If new string (str) contains the last searched one...
794 !last_searched_string.isEmpty() &&
796 str.contains(last_searched_string, qtcase))
797 // ... then only search within already found list.
798 keys = available_model_.stringList();
800 // ... else search all keys.
802 // save searched string for next search.
803 last_searched_string = str;
807 // First, filter by entry_type, which will be faster than
808 // what follows, so we may get to do that on less.
809 vector<docstring> keyVector = to_docstring_vector(keys);
810 filterByEntryType(bi, keyVector, entry_type);
813 result = to_qstring_list(keyVector);
815 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
816 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
818 available_model_.setStringList(result);
822 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
824 vector<docstring> const keys = to_docstring_vector(cited_keys_);
825 vector<CitationStyle> styles = citeStyles_;
826 int ind = citationStyleCO->currentIndex();
829 CitationStyle cs = styles[ind];
830 vector<docstring> pretexts = getPreTexts();
831 vector<docstring> posttexts = getPostTexts();
832 bool const qualified = cs.hasQualifiedList
833 && (selectedLV->model()->rowCount() > 1
835 || !posttexts.empty());
836 std::map<docstring, docstring> pres;
837 for (docstring const & s: pretexts) {
839 docstring val = split(s, key, ' ');
842 std::map<docstring, docstring> posts;
843 for (docstring const & s: posttexts) {
845 docstring val = split(s, key, ' ');
849 ci.textBefore = qstring_to_ucs4(textBeforeED->text());
850 ci.textAfter = qstring_to_ucs4(textAfterED->text());
851 ci.forceUpperCase = forceuppercaseCB->isChecked();
852 ci.Starred = starredCB->isChecked();
853 ci.context = CiteItem::Dialog;
854 ci.max_size = max_size;
855 ci.isQualified = qualified;
857 ci.posttexts = posts;
858 vector<docstring> ret = bi.getCiteStrings(keys, styles, documentBuffer(), ci);
859 return to_qstring_list(ret);
863 void GuiCitation::setCitedKeys()
865 cited_keys_ = selectedKeys();
870 bool GuiCitation::initialiseParams(string const & data)
872 InsetCommand::string2params(data, params_);
873 citeCmds_ = documentBuffer().params().citeCommands();
874 citeStyles_ = documentBuffer().params().citeStyles();
880 void GuiCitation::clearParams()
886 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
887 vector<docstring> & keyVector, docstring entry_type)
889 if (entry_type.empty())
892 vector<docstring>::iterator it = keyVector.begin();
893 vector<docstring>::iterator end = keyVector.end();
895 vector<docstring> result;
896 for (; it != end; ++it) {
897 docstring const key = *it;
898 BiblioInfo::const_iterator cit = bi.find(key);
901 if (cit->second.entryType() == entry_type)
902 result.push_back(key);
908 // Escape special chars.
909 // All characters are literals except: '.|*?+(){}[]^$\'
910 // These characters are literals when preceded by a "\", which is done here
911 // @todo: This function should be moved to support, and then the test in tests
912 // should be moved there as well.
913 static docstring escape_special_chars(docstring const & expr)
915 // Search for all chars '.|*?+(){}[^$]\'
916 // Note that '[', ']', and '\' must be escaped.
917 static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
919 // $& is an ECMAScript format expression that expands to all
920 // of the current match
921 #ifdef LYX_USE_STD_REGEX
922 // To prefix a matched expression with a single literal backslash, we
923 // need to escape it for the C++ compiler and use:
925 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
927 // A backslash in the format string starts an escape sequence in boost.
928 // Thus, to prefix a matched expression with a single literal backslash,
929 // we need to give two backslashes to the regex engine, and escape both
930 // for the C++ compiler and use:
932 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
937 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
938 vector<docstring> const & keys_to_search, bool only_keys,
939 docstring const & search_expression, docstring field,
940 bool case_sensitive, bool regex)
942 vector<docstring> foundKeys;
944 docstring expr = trim(search_expression);
949 // We must escape special chars in the search_expr so that
950 // it is treated as a simple string by lyx::regex.
951 expr = escape_special_chars(expr);
955 reg_exp.assign(to_utf8(expr), case_sensitive ?
956 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
957 } catch (lyx::regex_error const & e) {
958 // lyx::regex throws an exception if the regular expression is not
960 LYXERR(Debug::GUI, e.what());
961 return vector<docstring>();
964 vector<docstring>::const_iterator it = keys_to_search.begin();
965 vector<docstring>::const_iterator end = keys_to_search.end();
966 for (; it != end; ++it ) {
967 BiblioInfo::const_iterator info = bi.find(*it);
968 if (info == bi.end())
971 BibTeXInfo const & kvm = info->second;
975 else if (field.empty())
976 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
978 data = to_utf8(kvm[field]);
984 if (lyx::regex_search(data, reg_exp))
985 foundKeys.push_back(*it);
987 catch (lyx::regex_error const & e) {
988 LYXERR(Debug::GUI, e.what());
989 return vector<docstring>();
996 void GuiCitation::dispatchParams()
998 std::string const lfun = InsetCommand::params2string(params_);
999 dispatch(FuncRequest(getLfun(), lfun));
1003 BiblioInfo const & GuiCitation::bibInfo() const
1005 Buffer const & buf = documentBuffer();
1006 buf.reloadBibInfoCache();
1007 return buf.masterBibInfo();
1011 void GuiCitation::saveSession() const
1013 Dialog::saveSession();
1016 sessionKey() + "/regex", regexp_->isChecked());
1018 sessionKey() + "/casesensitive", casesense_->isChecked());
1020 sessionKey() + "/autofind", instant_->isChecked());
1022 sessionKey() + "/citestyle", style_);
1026 void GuiCitation::restoreSession()
1028 Dialog::restoreSession();
1030 regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
1031 casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
1032 instant_->setChecked(settings.value(sessionKey() + "/autofind").toBool());
1033 style_ = settings.value(sessionKey() + "/citestyle").toInt();
1038 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
1041 } // namespace frontend
1044 #include "moc_GuiCitation.cpp"