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_okPB_clicked()));
140 connect(textAfterED, SIGNAL(returnPressed()),
141 this, SLOT(on_okPB_clicked()));
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_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 #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 setFocusProxy(filter_);
182 void GuiCitation::closeEvent(QCloseEvent * e)
185 DialogView::closeEvent(e);
189 void GuiCitation::applyView()
191 int const choice = max(0, citationStyleCO->currentIndex());
192 style_ = citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
193 bool const full = starredCB->isChecked();
194 bool const force = forceuppercaseCB->isChecked();
196 QString const before = textBeforeED->text();
197 QString const after = textAfterED->text();
199 applyParams(choice, full, force, before, after);
203 void GuiCitation::showEvent(QShowEvent * e)
206 availableLV->setFocus();
207 DialogView::showEvent(e);
211 void GuiCitation::on_okPB_clicked()
219 void GuiCitation::on_cancelPB_clicked()
226 void GuiCitation::on_applyPB_clicked()
232 void GuiCitation::on_restorePB_clicked()
240 void GuiCitation::on_literalCB_clicked()
242 InsetCitation::last_literal = literalCB->isChecked();
247 void GuiCitation::updateControls()
249 BiblioInfo const & bi = bibInfo();
254 // The main point of separating this out is that the fill*() methods
255 // called in update() do not need to be called for INTERNAL updates,
256 // such as when addPB is pressed, as the list of fields, entries, etc,
257 // will not have changed.
258 void GuiCitation::updateControls(BiblioInfo const & bi)
260 QModelIndex idx = selectionManager->getSelectedIndex(1);
262 int i = citationStyleCO->currentIndex();
263 if (i == -1 || i > int(citeStyles_.size()))
265 updateFormatting(citeStyles_[i]);
266 selectionManager->update();
270 void GuiCitation::updateFormatting(CitationStyle const & currentStyle)
272 BufferParams const bp = documentBuffer().params();
273 bool const force = currentStyle.forceUpperCase;
274 bool const starred = currentStyle.hasStarredVersion;
275 bool const full = starred && bp.fullAuthorList();
276 bool const textbefore = currentStyle.textBefore;
277 bool const textafter = currentStyle.textAfter;
279 int const rows = selectedLV->model()->rowCount();
281 bool const qualified = currentStyle.hasQualifiedList
283 || !params_["pretextlist"].empty()
284 || !params_["posttextlist"].empty());
285 selectedLV->horizontalHeader()->setVisible(qualified);
286 selectedLV->setColumnHidden(0, !qualified);
287 selectedLV->setColumnHidden(2, !qualified);
288 bool const haveSelection = rows > 0;
290 textBeforeLA->setText(qt_("General text befo&re:"));
291 textAfterLA->setText(qt_("General &text after:"));
292 textBeforeED->setToolTip(qt_("Text that precedes the whole reference list. "
293 "For text that precedes individual items, "
294 "double-click on the respective entry above."));
295 textAfterLA->setToolTip(qt_("General &text after:"));
296 textAfterED->setToolTip(qt_("Text that follows the whole reference list. "
297 "For text that follows individual items, "
298 "double-click on the respective entry above."));
300 textBeforeLA->setText(qt_("Text befo&re:"));
301 if (textbefore && haveSelection)
302 textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\")"));
304 textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\"), "
305 "if the current citation style supports this."));
306 textAfterLA->setText(qt_("&Text after:"));
307 if (textafter && haveSelection)
308 textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages)"));
310 textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages), "
311 "if the current citation style supports this."));
314 forceuppercaseCB->setEnabled(force && haveSelection);
315 if (force && haveSelection)
316 forceuppercaseCB->setToolTip(qt_("Force upper case in names (\"Del Piero\", not \"del Piero\")."));
318 forceuppercaseCB->setToolTip(qt_("Force upper case in names (\"Del Piero\", not \"del Piero\"), "
319 "if the current citation style supports this."));
320 starredCB->setEnabled(full && haveSelection);
321 textBeforeED->setEnabled(textbefore && haveSelection);
322 textBeforeLA->setEnabled(textbefore && haveSelection);
323 textAfterED->setEnabled(textafter && haveSelection);
324 textAfterLA->setEnabled(textafter && haveSelection);
325 literalCB->setEnabled(textbefore || textafter);
326 citationStyleCO->setEnabled(haveSelection);
327 citationStyleLA->setEnabled(haveSelection);
329 // Check if we have a custom string/tooltip for the starred version
330 if (starred && !currentStyle.stardesc.empty()) {
332 bp.documentClass().getCiteMacro(bp.citeEngineType(), currentStyle.stardesc);
335 guistring = translateIfPossible(from_utf8(val));
336 starredCB->setText(toqstr(guistring));
337 starredCB->setEnabled(haveSelection);
339 if (!currentStyle.startooltip.empty()) {
340 val = bp.documentClass().getCiteMacro(bp.citeEngineType(),
341 currentStyle.startooltip);
343 guistring = translateIfPossible(from_utf8(val));
345 // Tooltip might also be empty
346 starredCB->setToolTip(toqstr(guistring));
348 // This is the default meaning of the starred commands
349 starredCB->setText(qt_("All aut&hors"));
350 if (full && haveSelection)
351 starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\")"));
353 starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\"), "
354 "if the current citation style supports this."));
359 // Update the styles for the style combo, citationStyleCO, and mark the
360 // settings as changed. Called upon changing the cited keys (including
361 // merely reordering the keys) or editing the text before/after fields.
362 void GuiCitation::updateStyles()
364 BiblioInfo const & bi = bibInfo();
370 // Update the styles for the style combo, citationStyleCO.
371 void GuiCitation::updateStyles(BiblioInfo const & bi)
373 QStringList selected_keys = selectedKeys();
374 int curr = selectedLV->model()->rowCount() - 1;
376 if (curr < 0 || selected_keys.empty()) {
377 citationStyleCO->clear();
378 citationStyleCO->setEnabled(false);
379 citationStyleLA->setEnabled(false);
383 static const size_t max_length = 80;
384 BiblioInfo::CiteStringMap sty = citationStyles(bi, max_length);
388 citationStyleCO->setEnabled(false);
389 citationStyleLA->setEnabled(false);
390 citationStyleCO->clear();
394 citationStyleCO->blockSignals(true);
396 // save old style selection
397 QString const curdata =
398 citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
399 QString const olddata = (curdata.isEmpty()) ? style_ : curdata;
400 citationStyleCO->clear();
401 BiblioInfo::CiteStringMap::const_iterator cit = sty.begin();
402 BiblioInfo::CiteStringMap::const_iterator end = sty.end();
403 for (int ii = 1; cit != end; ++cit, ++ii)
404 citationStyleCO->addItem(toqstr(cit->second), toqstr(cit->first));
405 citationStyleCO->setEnabled(true);
406 citationStyleLA->setEnabled(true);
407 // restore old style selection
408 int const i = citationStyleCO->findData(olddata);
410 citationStyleCO->setCurrentIndex(i);
412 citationStyleCO->blockSignals(false);
416 void GuiCitation::fillFields(BiblioInfo const & bi)
418 fieldsCO->blockSignals(true);
419 int const oldIndex = fieldsCO->currentIndex();
421 QStringList const fields = to_qstring_list(bi.getFields());
422 fieldsCO->insertItem(0, qt_("All fields"));
423 fieldsCO->insertItem(1, qt_("Keys"));
424 fieldsCO->insertItems(2, fields);
425 if (oldIndex != -1 && oldIndex < fieldsCO->count())
426 fieldsCO->setCurrentIndex(oldIndex);
427 fieldsCO->blockSignals(false);
431 void GuiCitation::fillEntries(BiblioInfo const & bi)
433 entriesCO->blockSignals(true);
434 int const oldIndex = entriesCO->currentIndex();
436 QStringList const entries = to_qstring_list(bi.getEntries());
437 entriesCO->insertItem(0, qt_("All entry types"));
438 entriesCO->insertItems(1, entries);
439 if (oldIndex != -1 && oldIndex < entriesCO->count())
440 entriesCO->setCurrentIndex(oldIndex);
441 entriesCO->blockSignals(false);
445 bool GuiCitation::isSelected(QModelIndex const & idx)
447 QString const str = idx.data().toString();
448 return selectedKeys().contains(str);
452 void GuiCitation::setButtons()
454 int const srows = selectedLV->model()->rowCount();
455 applyPB->setEnabled(srows > 0);
456 okPB->setEnabled(srows > 0);
460 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
462 if (!idx.isValid() || bi.empty()) {
463 infoML->document()->clear();
464 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
468 infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
471 QString const keytxt = toqstr(
472 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), ci));
473 infoML->document()->setHtml(keytxt);
477 void GuiCitation::findText(QString const & text, bool reset)
479 //"All Fields" and "Keys" are the first two
480 int index = fieldsCO->currentIndex() - 2;
481 BiblioInfo const & bi = bibInfo();
482 vector<docstring> const & fields = bi.getFields();
485 if (index <= -1 || index >= int(fields.size()))
486 //either "All Fields" or "Keys" or an invalid value
487 field = from_ascii("");
489 field = fields[index];
492 bool const onlyKeys = index == -1;
494 //"All Entry Types" is first.
495 index = entriesCO->currentIndex() - 1;
496 vector<docstring> const & entries = bi.getEntries();
497 docstring entry_type;
498 if (index < 0 || index >= int(entries.size()))
499 entry_type = from_ascii("");
501 entry_type = entries[index];
503 bool const case_sentitive = casesense_->isChecked();
504 bool const reg_exp = regexp_->isChecked();
506 findKey(bi, text, onlyKeys, field, entry_type,
507 case_sentitive, reg_exp, reset);
509 //It'd be nice to save and restore the current selection in
510 //availableLV. Currently, we get an automatic reset, since the
517 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
519 findText(filter_->text(), true);
523 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
525 findText(filter_->text(), true);
529 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
531 if (index >= 0 && index < citationStyleCO->count()) {
532 vector<CitationStyle> const & styles = citeStyles_;
533 updateFormatting(styles[index]);
539 void GuiCitation::filterChanged(const QString & text)
541 if (!text.isEmpty()) {
542 if (instant_->isChecked())
543 findText(filter_->text());
546 findText(filter_->text());
551 void GuiCitation::filterPressed()
553 findText(filter_->text(), true);
557 void GuiCitation::resetFilter()
559 filter_->setText(QString());
560 findText(filter_->text(), true);
564 void GuiCitation::caseChanged()
566 findText(filter_->text());
570 void GuiCitation::regexChanged()
572 findText(filter_->text());
576 void GuiCitation::updateFilterHint()
578 QString const hint = instant_->isChecked() ?
579 qt_("Enter string to filter the list of available citations") :
580 qt_("Enter string to filter the list of available citations and press <Enter>");
581 filter_->setToolTip(hint);
585 void GuiCitation::instantChanged(bool checked)
588 findText(filter_->text(), true);
594 void GuiCitation::changed()
600 void GuiCitation::applyParams(int const choice, bool full, bool force,
601 QString before, QString after)
603 if (cited_keys_.isEmpty())
606 vector<CitationStyle> const & styles = citeStyles_;
608 CitationStyle cs = styles[choice];
615 cs.forceUpperCase &= force;
616 cs.hasStarredVersion &= full;
617 string const command = citationStyleToString(cs);
619 params_.setCmdName(command);
620 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
621 params_["before"] = qstring_to_ucs4(before);
622 params_["after"] = qstring_to_ucs4(after);
623 if (cs.hasQualifiedList) {
624 params_["pretextlist"] = getStringFromVector(getPreTexts(), from_ascii("\t"));
625 params_["posttextlist"] = getStringFromVector(getPostTexts(), from_ascii("\t"));
627 params_["literal"] = literalCB->isChecked() ? from_ascii("true") : from_ascii("false");
632 void GuiCitation::clearSelection()
635 setSelectedKeys(cited_keys_);
639 void GuiCitation::setSelectedKeys(QStringList const sl)
641 selected_model_.clear();
642 selected_model_.setColumnCount(3);
644 headers << qt_("Text before")
646 << qt_("Text after");
647 selected_model_.setHorizontalHeaderLabels(headers);
648 selectedLV->setColumnHidden(0, true);
649 selectedLV->setColumnHidden(2, true);
650 selectedLV->verticalHeader()->setVisible(false);
651 selectedLV->horizontalHeader()->setVisible(false);
652 QStringList::const_iterator it = sl.begin();
653 QStringList::const_iterator end = sl.end();
654 for (int i = 0; it != end; ++it, ++i) {
655 QStandardItem * si = new QStandardItem();
659 si->setEditable(false);
660 selected_model_.setItem(i, 1, si);
665 QStringList GuiCitation::selectedKeys()
668 for (int i = 0; i != selected_model_.rowCount(); ++i) {
669 QStandardItem const * item = selected_model_.item(i, 1);
671 res.append(item->text());
677 void GuiCitation::setPreTexts(vector<docstring> const m)
679 for (docstring const & s: m) {
680 QStandardItem * si = new QStandardItem();
682 docstring pre = split(s, key, ' ');
683 si->setData(toqstr(pre));
684 si->setText(toqstr(pre));
685 QModelIndexList qmil =
686 selected_model_.match(selected_model_.index(0, 1),
687 Qt::DisplayRole, toqstr(key), 1,
688 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
690 selected_model_.setItem(qmil.front().row(), 0, si);
695 vector<docstring> GuiCitation::getPreTexts()
697 vector<docstring> res;
698 for (int i = 0; i != selected_model_.rowCount(); ++i) {
699 QStandardItem const * key = selected_model_.item(i, 1);
700 QStandardItem const * pre = selected_model_.item(i, 0);
701 if (key && pre && !key->text().isEmpty() && !pre->text().isEmpty())
702 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(pre->text()));
708 void GuiCitation::setPostTexts(vector<docstring> const m)
710 for (docstring const & s: m) {
711 QStandardItem * si = new QStandardItem();
713 docstring post = split(s, key, ' ');
714 si->setData(toqstr(post));
715 si->setText(toqstr(post));
716 QModelIndexList qmil =
717 selected_model_.match(selected_model_.index(0, 1),
718 Qt::DisplayRole, toqstr(key), 1,
719 Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
721 selected_model_.setItem(qmil.front().row(), 2, si);
726 vector<docstring> GuiCitation::getPostTexts()
728 vector<docstring> res;
729 for (int i = 0; i != selected_model_.rowCount(); ++i) {
730 QStandardItem const * key = selected_model_.item(i, 1);
731 QStandardItem const * post = selected_model_.item(i, 2);
733 res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(post->text()));
739 void GuiCitation::init()
741 // Make the list of all available bibliography keys
742 BiblioInfo const & bi = bibInfo();
743 all_keys_ = to_qstring_list(bi.getKeys());
745 available_model_.setStringList(all_keys_);
747 // Ditto for the keys cited in this inset
748 QString str = toqstr(params_["key"]);
752 cited_keys_ = str.split(",");
753 setSelectedKeys(cited_keys_);
755 // Initialize the drop downs
759 // Initialize the citation formatting
760 string const & cmd = params_.getCmdName();
761 CitationStyle const cs =
762 citationStyleFromString(cmd, documentBuffer().params());
764 forceuppercaseCB->setChecked(cs.forceUpperCase);
765 starredCB->setChecked(cs.hasStarredVersion &&
766 documentBuffer().params().fullAuthorList());
767 textBeforeED->setText(toqstr(params_["before"]));
768 textAfterED->setText(toqstr(params_["after"]));
770 // if this is a new citation, we set the literal checkbox
771 // to its last set value.
772 if (cited_keys_.isEmpty())
773 literalCB->setChecked(InsetCitation::last_literal);
775 literalCB->setChecked(params_["literal"] == "true");
777 setPreTexts(getVectorFromString(params_["pretextlist"], from_ascii("\t")));
778 setPostTexts(getVectorFromString(params_["posttextlist"], from_ascii("\t")));
780 // Update the interface
783 if (selected_model_.rowCount()) {
784 selectedLV->blockSignals(true);
785 selectedLV->setFocus();
786 selectedLV->selectRow(0);
787 selectedLV->blockSignals(false);
789 // Find the citation style
790 vector<string> const & cmds = citeCmds_;
791 vector<string>::const_iterator cit =
792 std::find(cmds.begin(), cmds.end(), cs.name);
794 if (cit != cmds.end())
795 i = int(cit - cmds.begin());
797 // Set the style combo appropriately
798 citationStyleCO->blockSignals(true);
799 citationStyleCO->setCurrentIndex(i);
800 citationStyleCO->blockSignals(false);
801 updateFormatting(citeStyles_[i]);
803 availableLV->setFocus();
805 applyPB->setEnabled(false);
806 okPB->setEnabled(false);
810 void GuiCitation::findKey(BiblioInfo const & bi,
811 QString const & str, bool only_keys,
812 docstring field, docstring entry_type,
813 bool case_sensitive, bool reg_exp, bool reset)
816 // This should be moved to a class member.
817 // Used for optimisation: store last searched string.
818 static QString last_searched_string;
819 // Used to disable the above optimisation.
820 static bool last_case_sensitive;
821 static bool last_reg_exp;
822 // Reset last_searched_string in case of changed option.
823 if (last_case_sensitive != case_sensitive
824 || last_reg_exp != reg_exp) {
825 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
826 last_searched_string.clear();
828 // save option for next search.
829 last_case_sensitive = case_sensitive;
830 last_reg_exp = reg_exp;
832 Qt::CaseSensitivity qtcase = case_sensitive ?
833 Qt::CaseSensitive: Qt::CaseInsensitive;
835 // If new string (str) contains the last searched one...
837 !last_searched_string.isEmpty() &&
839 str.contains(last_searched_string, qtcase))
840 // ... then only search within already found list.
841 keys = available_model_.stringList();
843 // ... else search all keys.
845 // save searched string for next search.
846 last_searched_string = str;
850 // First, filter by entry_type, which will be faster than
851 // what follows, so we may get to do that on less.
852 vector<docstring> keyVector = to_docstring_vector(keys);
853 filterByEntryType(bi, keyVector, entry_type);
856 result = to_qstring_list(keyVector);
858 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
859 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
861 available_model_.setStringList(result);
865 BiblioInfo::CiteStringMap GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
867 vector<docstring> const keys = to_docstring_vector(cited_keys_);
868 vector<CitationStyle> styles = citeStyles_;
869 int ind = citationStyleCO->currentIndex();
872 CitationStyle cs = styles[ind];
873 vector<docstring> pretexts = getPreTexts();
874 vector<docstring> posttexts = getPostTexts();
875 bool const qualified = cs.hasQualifiedList
876 && (selectedLV->model()->rowCount() > 1
878 || !posttexts.empty());
879 std::map<docstring, docstring> pres;
880 for (docstring const & s: pretexts) {
882 docstring val = split(s, key, ' ');
885 std::map<docstring, docstring> posts;
886 for (docstring const & s: posttexts) {
888 docstring val = split(s, key, ' ');
892 ci.textBefore = qstring_to_ucs4(textBeforeED->text());
893 ci.textAfter = qstring_to_ucs4(textAfterED->text());
894 ci.forceUpperCase = forceuppercaseCB->isChecked();
895 ci.Starred = starredCB->isChecked();
896 ci.context = CiteItem::Dialog;
897 ci.max_size = max_size;
898 ci.isQualified = qualified;
900 ci.posttexts = posts;
901 BiblioInfo::CiteStringMap ret = bi.getCiteStrings(keys, styles, documentBuffer(), ci);
906 void GuiCitation::setCitedKeys()
908 cited_keys_ = selectedKeys();
913 bool GuiCitation::initialiseParams(string const & sdata)
915 InsetCommand::string2params(sdata, params_);
916 citeCmds_ = documentBuffer().params().citeCommands();
917 citeStyles_ = documentBuffer().params().citeStyles();
923 void GuiCitation::clearParams()
929 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
930 vector<docstring> & keyVector, docstring entry_type)
932 if (entry_type.empty())
935 vector<docstring>::iterator it = keyVector.begin();
936 vector<docstring>::iterator end = keyVector.end();
938 vector<docstring> result;
939 for (; it != end; ++it) {
940 docstring const key = *it;
941 BiblioInfo::const_iterator cit = bi.find(key);
944 if (cit->second.entryType() == entry_type)
945 result.push_back(key);
951 // Escape special chars.
952 // All characters are literals except: '.|*?+(){}[]^$\'
953 // These characters are literals when preceded by a "\", which is done here
954 // @todo: This function should be moved to support, and then the test in tests
955 // should be moved there as well.
956 static docstring escape_special_chars(docstring const & expr)
958 // Search for all chars '.|*?+(){}[^$]\'
959 // Note that '[', ']', and '\' must be escaped.
960 static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
962 // $& is an ECMAScript format expression that expands to all
963 // of the current match
964 #ifdef LYX_USE_STD_REGEX
965 // To prefix a matched expression with a single literal backslash, we
966 // need to escape it for the C++ compiler and use:
968 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
970 // A backslash in the format string starts an escape sequence in boost.
971 // Thus, to prefix a matched expression with a single literal backslash,
972 // we need to give two backslashes to the regex engine, and escape both
973 // for the C++ compiler and use:
975 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
980 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
981 vector<docstring> const & keys_to_search, bool only_keys,
982 docstring const & search_expression, docstring field,
983 bool case_sensitive, bool regex)
985 vector<docstring> foundKeys;
987 docstring expr = trim(search_expression);
992 // We must escape special chars in the search_expr so that
993 // it is treated as a simple string by lyx::regex.
994 expr = escape_special_chars(expr);
998 reg_exp.assign(to_utf8(expr), case_sensitive ?
999 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
1000 } catch (lyx::regex_error const & e) {
1001 // lyx::regex throws an exception if the regular expression is not
1003 LYXERR(Debug::GUI, e.what());
1004 return vector<docstring>();
1007 vector<docstring>::const_iterator it = keys_to_search.begin();
1008 vector<docstring>::const_iterator end = keys_to_search.end();
1009 for (; it != end; ++it ) {
1010 BiblioInfo::const_iterator info = bi.find(*it);
1011 if (info == bi.end())
1014 BibTeXInfo const & kvm = info->second;
1017 sdata = to_utf8(*it);
1018 else if (field.empty())
1019 sdata = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
1021 sdata = to_utf8(kvm[field]);
1027 if (lyx::regex_search(sdata, reg_exp))
1028 foundKeys.push_back(*it);
1030 catch (lyx::regex_error const & e) {
1031 LYXERR(Debug::GUI, e.what());
1032 return vector<docstring>();
1039 void GuiCitation::dispatchParams()
1041 std::string const lfun = InsetCommand::params2string(params_);
1042 dispatch(FuncRequest(getLfun(), lfun));
1046 BiblioInfo const & GuiCitation::bibInfo() const
1048 Buffer const & buf = documentBuffer();
1049 buf.reloadBibInfoCache();
1050 return buf.masterBibInfo();
1054 void GuiCitation::saveSession(QSettings & settings) const
1056 Dialog::saveSession(settings);
1058 sessionKey() + "/regex", regexp_->isChecked());
1060 sessionKey() + "/casesensitive", casesense_->isChecked());
1062 sessionKey() + "/autofind", instant_->isChecked());
1064 sessionKey() + "/citestyle", style_);
1066 sessionKey() + "/literal", InsetCitation::last_literal);
1070 void GuiCitation::restoreSession()
1072 Dialog::restoreSession();
1074 regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
1075 casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
1076 instant_->setChecked(settings.value(sessionKey() + "/autofind", true).toBool());
1077 style_ = settings.value(sessionKey() + "/citestyle").toString();
1078 InsetCitation::last_literal =
1079 settings.value(sessionKey() + "/literal", false).toBool();
1084 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
1087 } // namespace frontend
1090 #include "moc_GuiCitation.cpp"