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 int i = citationStyleCO->currentIndex();
256 updateFormatting(citeStyles_[i]);
257 selectionManager->update();
261 void GuiCitation::updateFormatting(CitationStyle currentStyle)
263 BufferParams const bp = documentBuffer().params();
264 bool const force = currentStyle.forceUpperCase;
265 bool const starred = currentStyle.hasStarredVersion;
266 bool const full = starred && bp.fullAuthorList();
267 bool const textbefore = currentStyle.textBefore;
268 bool const textafter = currentStyle.textAfter;
270 int const rows = selectedLV->model()->rowCount();
272 bool const qualified = currentStyle.hasQualifiedList
274 || !params_["pretextlist"].empty()
275 || !params_["posttextlist"].empty());
276 selectedLV->horizontalHeader()->setVisible(qualified);
277 selectedLV->setColumnHidden(0, !qualified);
278 selectedLV->setColumnHidden(2, !qualified);
280 textBeforeLA->setText(qt_("General text befo&re:"));
281 textAfterLA->setText(qt_("General &text after:"));
282 textBeforeED->setToolTip(qt_("Text that precedes the whole reference list. "
283 "For text that precedes individual items, double-click on the respective entry above."));
284 textAfterLA->setToolTip(qt_("General &text after:"));
285 textAfterED->setToolTip(qt_("Text that follows the whole reference list. "
286 "For text that follows individual items, double-click on the respective entry above."));
288 textBeforeLA->setText(qt_("Text befo&re:"));
289 textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\")"));
290 textAfterLA->setText(qt_("&Text after:"));
291 textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages)"));
294 bool const haveSelection = rows > 0;
296 forceuppercaseCB->setEnabled(force && haveSelection);
297 starredCB->setEnabled(full && haveSelection);
298 textBeforeED->setEnabled(textbefore && haveSelection);
299 textBeforeLA->setEnabled(textbefore && haveSelection);
300 textAfterED->setEnabled(textafter && haveSelection);
301 textAfterLA->setEnabled(textafter && haveSelection);
302 citationStyleCO->setEnabled(haveSelection);
303 citationStyleLA->setEnabled(haveSelection);
305 // Check if we have a custom string/tooltip for the starred version
306 if (starred && !currentStyle.stardesc.empty()) {
308 bp.documentClass().getCiteMacro(bp.citeEngineType(), currentStyle.stardesc);
311 guistring = translateIfPossible(from_utf8(val));
312 starredCB->setText(toqstr(guistring));
313 starredCB->setEnabled(haveSelection);
315 if (!currentStyle.startooltip.empty()) {
316 val = bp.documentClass().getCiteMacro(bp.citeEngineType(),
317 currentStyle.startooltip);
319 guistring = translateIfPossible(from_utf8(val));
321 // Tooltip might also be empty
322 starredCB->setToolTip(toqstr(guistring));
324 // This is the default meaning of the starred commands
325 starredCB->setText(qt_("All aut&hors"));
326 starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\")"));
331 // Update the styles for the style combo, citationStyleCO, and mark the
332 // settings as changed. Called upon changing the cited keys (including
333 // merely reordering the keys) or editing the text before/after fields.
334 void GuiCitation::updateStyles()
336 BiblioInfo const & bi = bibInfo();
342 // Update the styles for the style combo, citationStyleCO.
343 void GuiCitation::updateStyles(BiblioInfo const & bi)
345 QStringList selected_keys = selectedKeys();
346 int curr = selectedLV->model()->rowCount() - 1;
348 if (curr < 0 || selected_keys.empty()) {
349 citationStyleCO->clear();
350 citationStyleCO->setEnabled(false);
351 citationStyleLA->setEnabled(false);
355 static const size_t max_length = 80;
356 QStringList sty = citationStyles(bi, max_length);
360 citationStyleCO->setEnabled(false);
361 citationStyleLA->setEnabled(false);
362 citationStyleCO->clear();
366 citationStyleCO->blockSignals(true);
369 int const curindex = citationStyleCO->currentIndex();
370 int const oldIndex = (curindex < 0) ? style_ : curindex;
371 citationStyleCO->clear();
372 citationStyleCO->insertItems(0, sty);
373 citationStyleCO->setEnabled(true);
374 citationStyleLA->setEnabled(true);
376 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
377 citationStyleCO->setCurrentIndex(oldIndex);
379 citationStyleCO->blockSignals(false);
383 void GuiCitation::fillFields(BiblioInfo const & bi)
385 fieldsCO->blockSignals(true);
386 int const oldIndex = fieldsCO->currentIndex();
388 QStringList const fields = to_qstring_list(bi.getFields());
389 fieldsCO->insertItem(0, qt_("All fields"));
390 fieldsCO->insertItem(1, qt_("Keys"));
391 fieldsCO->insertItems(2, fields);
392 if (oldIndex != -1 && oldIndex < fieldsCO->count())
393 fieldsCO->setCurrentIndex(oldIndex);
394 fieldsCO->blockSignals(false);
398 void GuiCitation::fillEntries(BiblioInfo const & bi)
400 entriesCO->blockSignals(true);
401 int const oldIndex = entriesCO->currentIndex();
403 QStringList const entries = to_qstring_list(bi.getEntries());
404 entriesCO->insertItem(0, qt_("All entry types"));
405 entriesCO->insertItems(1, entries);
406 if (oldIndex != -1 && oldIndex < entriesCO->count())
407 entriesCO->setCurrentIndex(oldIndex);
408 entriesCO->blockSignals(false);
412 bool GuiCitation::isSelected(QModelIndex const & idx)
414 QString const str = idx.data().toString();
415 return selectedKeys().contains(str);
419 void GuiCitation::setButtons()
421 int const srows = selectedLV->model()->rowCount();
422 applyPB->setEnabled(srows > 0);
423 okPB->setEnabled(srows > 0);
427 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
429 if (!idx.isValid() || bi.empty()) {
430 infoML->document()->clear();
431 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
435 infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
438 QString const keytxt = toqstr(
439 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), ci));
440 infoML->document()->setHtml(keytxt);
444 void GuiCitation::findText(QString const & text, bool reset)
446 //"All Fields" and "Keys" are the first two
447 int index = fieldsCO->currentIndex() - 2;
448 BiblioInfo const & bi = bibInfo();
449 vector<docstring> const & fields = bi.getFields();
452 if (index <= -1 || index >= int(fields.size()))
453 //either "All Fields" or "Keys" or an invalid value
454 field = from_ascii("");
456 field = fields[index];
459 bool const onlyKeys = index == -1;
461 //"All Entry Types" is first.
462 index = entriesCO->currentIndex() - 1;
463 vector<docstring> const & entries = bi.getEntries();
464 docstring entry_type;
465 if (index < 0 || index >= int(entries.size()))
466 entry_type = from_ascii("");
468 entry_type = entries[index];
470 bool const case_sentitive = casesense_->isChecked();
471 bool const reg_exp = regexp_->isChecked();
473 findKey(bi, text, onlyKeys, field, entry_type,
474 case_sentitive, reg_exp, reset);
476 //It'd be nice to save and restore the current selection in
477 //availableLV. Currently, we get an automatic reset, since the
484 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
486 findText(filter_->text(), true);
490 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
492 findText(filter_->text(), true);
496 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
498 if (index >= 0 && index < citationStyleCO->count()) {
499 vector<CitationStyle> const & styles = citeStyles_;
500 updateFormatting(styles[index]);
506 void GuiCitation::filterChanged(const QString & text)
508 if (!text.isEmpty()) {
509 if (instant_->isChecked())
510 findText(filter_->text());
513 findText(filter_->text());
518 void GuiCitation::filterPressed()
520 findText(filter_->text(), true);
524 void GuiCitation::resetFilter()
526 filter_->setText(QString());
527 findText(filter_->text(), true);
531 void GuiCitation::caseChanged()
533 findText(filter_->text());
537 void GuiCitation::regexChanged()
539 findText(filter_->text());
543 void GuiCitation::updateFilterHint()
545 QString const hint = instant_->isChecked() ?
546 qt_("Enter string to filter the list of available citations") :
547 qt_("Enter string to filter the list of available citations and press <Enter>");
548 filter_->setToolTip(hint);
552 void GuiCitation::instantChanged(bool checked)
555 findText(filter_->text(), true);
561 void GuiCitation::changed()
567 void GuiCitation::applyParams(int const choice, bool full, bool force,
568 QString before, QString after)
570 if (cited_keys_.isEmpty())
573 vector<CitationStyle> const & styles = citeStyles_;
575 CitationStyle cs = styles[choice];
582 cs.forceUpperCase &= force;
583 cs.hasStarredVersion &= full;
584 string const command = citationStyleToString(cs);
586 params_.setCmdName(command);
587 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
588 params_["before"] = qstring_to_ucs4(before);
589 params_["after"] = qstring_to_ucs4(after);
590 if (cs.hasQualifiedList) {
591 params_["pretextlist"] = getStringFromVector(getPreTexts(), from_ascii("\t"));
592 params_["posttextlist"] = getStringFromVector(getPostTexts(), from_ascii("\t"));
594 params_["literal"] = literalCB->isChecked() ? from_ascii("true") : from_ascii("false");
599 void GuiCitation::clearSelection()
602 setSelectedKeys(cited_keys_);
606 void GuiCitation::setSelectedKeys(QStringList const sl)
608 selected_model_.clear();
609 selected_model_.setColumnCount(3);
611 headers << qt_("Text before")
613 << qt_("Text after");
614 selected_model_.setHorizontalHeaderLabels(headers);
615 selectedLV->setColumnHidden(0, true);
616 selectedLV->setColumnHidden(2, true);
617 selectedLV->verticalHeader()->setVisible(false);
618 selectedLV->horizontalHeader()->setVisible(false);
619 QStringList::const_iterator it = sl.begin();
620 QStringList::const_iterator end = sl.end();
621 for (int i = 0; it != end; ++it, ++i) {
622 QStandardItem * si = new QStandardItem();
626 si->setEditable(false);
627 selected_model_.setItem(i, 1, si);
632 QStringList GuiCitation::selectedKeys()
635 for (int i = 0; i != selected_model_.rowCount(); ++i) {
636 QStandardItem const * item = selected_model_.item(i, 1);
638 res.append(item->text());
644 void GuiCitation::setPreTexts(vector<docstring> const m)
646 for (docstring const & s: m) {
647 QStandardItem * si = new QStandardItem();
649 docstring pre = split(s, key, ' ');
650 si->setData(toqstr(pre));
651 si->setText(toqstr(pre));
652 QModelIndexList qmil =
653 selected_model_.match(selected_model_.index(0, 1),
654 Qt::DisplayRole, toqstr(key), 1,
655 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
657 selected_model_.setItem(qmil.front().row(), 0, si);
662 vector<docstring> GuiCitation::getPreTexts()
664 vector<docstring> res;
665 for (int i = 0; i != selected_model_.rowCount(); ++i) {
666 QStandardItem const * key = selected_model_.item(i, 1);
667 QStandardItem const * pre = selected_model_.item(i, 0);
668 if (key && pre && !key->text().isEmpty() && !pre->text().isEmpty())
669 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(pre->text()));
675 void GuiCitation::setPostTexts(vector<docstring> const m)
677 for (docstring const & s: m) {
678 QStandardItem * si = new QStandardItem();
680 docstring post = split(s, key, ' ');
681 si->setData(toqstr(post));
682 si->setText(toqstr(post));
683 QModelIndexList qmil =
684 selected_model_.match(selected_model_.index(0, 1),
685 Qt::DisplayRole, toqstr(key), 1,
686 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
688 selected_model_.setItem(qmil.front().row(), 2, si);
693 vector<docstring> GuiCitation::getPostTexts()
695 vector<docstring> res;
696 for (int i = 0; i != selected_model_.rowCount(); ++i) {
697 QStandardItem const * key = selected_model_.item(i, 1);
698 QStandardItem const * post = selected_model_.item(i, 2);
700 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(post->text()));
706 void GuiCitation::init()
708 // Make the list of all available bibliography keys
709 BiblioInfo const & bi = bibInfo();
710 all_keys_ = to_qstring_list(bi.getKeys());
712 available_model_.setStringList(all_keys_);
714 // Ditto for the keys cited in this inset
715 QString str = toqstr(params_["key"]);
719 cited_keys_ = str.split(",");
720 setSelectedKeys(cited_keys_);
722 // Initialize the drop downs
726 // Initialize the citation formatting
727 string const & cmd = params_.getCmdName();
728 CitationStyle const cs =
729 citationStyleFromString(cmd, documentBuffer().params());
731 forceuppercaseCB->setChecked(cs.forceUpperCase);
732 starredCB->setChecked(cs.hasStarredVersion &&
733 documentBuffer().params().fullAuthorList());
734 textBeforeED->setText(toqstr(params_["before"]));
735 textAfterED->setText(toqstr(params_["after"]));
736 literalCB->setChecked(params_["literal"] == "true");
738 setPreTexts(getVectorFromString(params_["pretextlist"], from_ascii("\t")));
739 setPostTexts(getVectorFromString(params_["posttextlist"], from_ascii("\t")));
741 // Update the interface
744 if (selected_model_.rowCount()) {
745 selectedLV->blockSignals(true);
746 selectedLV->setFocus();
747 selectedLV->selectRow(0);
748 selectedLV->blockSignals(false);
750 // Find the citation style
751 vector<string> const & cmds = citeCmds_;
752 vector<string>::const_iterator cit =
753 std::find(cmds.begin(), cmds.end(), cs.name);
755 if (cit != cmds.end())
756 i = int(cit - cmds.begin());
758 // Set the style combo appropriately
759 citationStyleCO->blockSignals(true);
760 citationStyleCO->setCurrentIndex(i);
761 citationStyleCO->blockSignals(false);
762 updateFormatting(citeStyles_[i]);
764 availableLV->setFocus();
766 applyPB->setEnabled(false);
767 okPB->setEnabled(false);
771 void GuiCitation::findKey(BiblioInfo const & bi,
772 QString const & str, bool only_keys,
773 docstring field, docstring entry_type,
774 bool case_sensitive, bool reg_exp, bool reset)
777 // This should be moved to a class member.
778 // Used for optimisation: store last searched string.
779 static QString last_searched_string;
780 // Used to disable the above optimisation.
781 static bool last_case_sensitive;
782 static bool last_reg_exp;
783 // Reset last_searched_string in case of changed option.
784 if (last_case_sensitive != case_sensitive
785 || last_reg_exp != reg_exp) {
786 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
787 last_searched_string.clear();
789 // save option for next search.
790 last_case_sensitive = case_sensitive;
791 last_reg_exp = reg_exp;
793 Qt::CaseSensitivity qtcase = case_sensitive ?
794 Qt::CaseSensitive: Qt::CaseInsensitive;
796 // If new string (str) contains the last searched one...
798 !last_searched_string.isEmpty() &&
800 str.contains(last_searched_string, qtcase))
801 // ... then only search within already found list.
802 keys = available_model_.stringList();
804 // ... else search all keys.
806 // save searched string for next search.
807 last_searched_string = str;
811 // First, filter by entry_type, which will be faster than
812 // what follows, so we may get to do that on less.
813 vector<docstring> keyVector = to_docstring_vector(keys);
814 filterByEntryType(bi, keyVector, entry_type);
817 result = to_qstring_list(keyVector);
819 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
820 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
822 available_model_.setStringList(result);
826 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
828 vector<docstring> const keys = to_docstring_vector(cited_keys_);
829 vector<CitationStyle> styles = citeStyles_;
830 int ind = citationStyleCO->currentIndex();
833 CitationStyle cs = styles[ind];
834 vector<docstring> pretexts = getPreTexts();
835 vector<docstring> posttexts = getPostTexts();
836 bool const qualified = cs.hasQualifiedList
837 && (selectedLV->model()->rowCount() > 1
839 || !posttexts.empty());
840 std::map<docstring, docstring> pres;
841 for (docstring const & s: pretexts) {
843 docstring val = split(s, key, ' ');
846 std::map<docstring, docstring> posts;
847 for (docstring const & s: posttexts) {
849 docstring val = split(s, key, ' ');
853 ci.textBefore = qstring_to_ucs4(textBeforeED->text());
854 ci.textAfter = qstring_to_ucs4(textAfterED->text());
855 ci.forceUpperCase = forceuppercaseCB->isChecked();
856 ci.Starred = starredCB->isChecked();
857 ci.context = CiteItem::Dialog;
858 ci.max_size = max_size;
859 ci.isQualified = qualified;
861 ci.posttexts = posts;
862 vector<docstring> ret = bi.getCiteStrings(keys, styles, documentBuffer(), ci);
863 return to_qstring_list(ret);
867 void GuiCitation::setCitedKeys()
869 cited_keys_ = selectedKeys();
874 bool GuiCitation::initialiseParams(string const & data)
876 InsetCommand::string2params(data, params_);
877 citeCmds_ = documentBuffer().params().citeCommands();
878 citeStyles_ = documentBuffer().params().citeStyles();
884 void GuiCitation::clearParams()
890 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
891 vector<docstring> & keyVector, docstring entry_type)
893 if (entry_type.empty())
896 vector<docstring>::iterator it = keyVector.begin();
897 vector<docstring>::iterator end = keyVector.end();
899 vector<docstring> result;
900 for (; it != end; ++it) {
901 docstring const key = *it;
902 BiblioInfo::const_iterator cit = bi.find(key);
905 if (cit->second.entryType() == entry_type)
906 result.push_back(key);
912 // Escape special chars.
913 // All characters are literals except: '.|*?+(){}[]^$\'
914 // These characters are literals when preceded by a "\", which is done here
915 // @todo: This function should be moved to support, and then the test in tests
916 // should be moved there as well.
917 static docstring escape_special_chars(docstring const & expr)
919 // Search for all chars '.|*?+(){}[^$]\'
920 // Note that '[', ']', and '\' must be escaped.
921 static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
923 // $& is an ECMAScript format expression that expands to all
924 // of the current match
925 #ifdef LYX_USE_STD_REGEX
926 // To prefix a matched expression with a single literal backslash, we
927 // need to escape it for the C++ compiler and use:
929 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
931 // A backslash in the format string starts an escape sequence in boost.
932 // Thus, to prefix a matched expression with a single literal backslash,
933 // we need to give two backslashes to the regex engine, and escape both
934 // for the C++ compiler and use:
936 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
941 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
942 vector<docstring> const & keys_to_search, bool only_keys,
943 docstring const & search_expression, docstring field,
944 bool case_sensitive, bool regex)
946 vector<docstring> foundKeys;
948 docstring expr = trim(search_expression);
953 // We must escape special chars in the search_expr so that
954 // it is treated as a simple string by lyx::regex.
955 expr = escape_special_chars(expr);
959 reg_exp.assign(to_utf8(expr), case_sensitive ?
960 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
961 } catch (lyx::regex_error const & e) {
962 // lyx::regex throws an exception if the regular expression is not
964 LYXERR(Debug::GUI, e.what());
965 return vector<docstring>();
968 vector<docstring>::const_iterator it = keys_to_search.begin();
969 vector<docstring>::const_iterator end = keys_to_search.end();
970 for (; it != end; ++it ) {
971 BiblioInfo::const_iterator info = bi.find(*it);
972 if (info == bi.end())
975 BibTeXInfo const & kvm = info->second;
979 else if (field.empty())
980 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
982 data = to_utf8(kvm[field]);
988 if (lyx::regex_search(data, reg_exp))
989 foundKeys.push_back(*it);
991 catch (lyx::regex_error const & e) {
992 LYXERR(Debug::GUI, e.what());
993 return vector<docstring>();
1000 void GuiCitation::dispatchParams()
1002 std::string const lfun = InsetCommand::params2string(params_);
1003 dispatch(FuncRequest(getLfun(), lfun));
1007 BiblioInfo const & GuiCitation::bibInfo() const
1009 Buffer const & buf = documentBuffer();
1010 buf.reloadBibInfoCache();
1011 return buf.masterBibInfo();
1015 void GuiCitation::saveSession() const
1017 Dialog::saveSession();
1020 sessionKey() + "/regex", regexp_->isChecked());
1022 sessionKey() + "/casesensitive", casesense_->isChecked());
1024 sessionKey() + "/autofind", instant_->isChecked());
1026 sessionKey() + "/citestyle", style_);
1030 void GuiCitation::restoreSession()
1032 Dialog::restoreSession();
1034 regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
1035 casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
1036 instant_->setChecked(settings.value(sessionKey() + "/autofind").toBool());
1037 style_ = settings.value(sessionKey() + "/citestyle").toInt();
1042 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
1045 } // namespace frontend
1048 #include "moc_GuiCitation.cpp"