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 "FuncRequest.h"
30 #include "insets/InsetCommand.h"
32 #include "support/debug.h"
33 #include "support/docstring.h"
34 #include "support/gettext.h"
35 #include "support/lstrings.h"
37 #include <QCloseEvent>
48 #include "support/regex.h"
55 using namespace lyx::support;
61 // I am guessing that it would not hurt to make these private members.
62 static vector<string> citeCmds_;
63 static vector<CitationStyle> citeStyles_;
66 template<typename String>
67 static QStringList to_qstring_list(vector<String> const & v)
71 for (size_t i = 0; i != v.size(); ++i) {
74 qlist.append(lyx::toqstr(v[i]));
80 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
82 vector<lyx::docstring> v;
83 for (int i = 0; i != qlist.size(); ++i) {
84 if (qlist[i].isEmpty())
86 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
92 GuiCitation::GuiCitation(GuiView & lv)
93 : DialogView(lv, "citation", qt_("Citation")),
94 style_(0), params_(insetCode("citation"))
99 filter_ = new FancyLineEdit(this);
100 #if QT_VERSION >= 0x040600
101 filter_->setButtonPixmap(FancyLineEdit::Right, getPixmap("images/", "editclear", "svgz,png"));
102 filter_->setButtonVisible(FancyLineEdit::Right, true);
103 filter_->setButtonToolTip(FancyLineEdit::Right, qt_("Clear text"));
104 filter_->setAutoHideButton(FancyLineEdit::Right, true);
106 #if QT_VERSION >= 0x040700
107 filter_->setPlaceholderText(qt_("All avail. citations"));
110 filterBarL->addWidget(filter_, 0);
111 findKeysLA->setBuddy(filter_);
113 // Add search options as button menu
114 regexp_ = new QAction(qt_("Regular e&xpression"), this);
115 regexp_->setCheckable(true);
116 casesense_ = new QAction(qt_("Case se&nsitive"), this);
117 casesense_->setCheckable(true);
118 instant_ = new QAction(qt_("Search as you &type"), this);
119 instant_->setCheckable(true);
121 QMenu * searchOpts = new QMenu(this);
122 searchOpts->addAction(regexp_);
123 searchOpts->addAction(casesense_);
124 searchOpts->addAction(instant_);
125 searchOptionsPB->setMenu(searchOpts);
127 connect(citationStyleCO, SIGNAL(activated(int)),
128 this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
129 connect(fulllistCB, SIGNAL(clicked()),
130 this, SLOT(changed()));
131 connect(forceuppercaseCB, SIGNAL(clicked()),
132 this, SLOT(changed()));
133 connect(textBeforeED, SIGNAL(textChanged(QString)),
134 this, SLOT(updateStyles()));
135 connect(textAfterED, SIGNAL(textChanged(QString)),
136 this, SLOT(updateStyles()));
137 connect(textBeforeED, SIGNAL(returnPressed()),
138 this, SLOT(on_okPB_clicked()));
139 connect(textAfterED, SIGNAL(returnPressed()),
140 this, SLOT(on_okPB_clicked()));
142 selectionManager = new GuiSelectionManager(availableLV, selectedLV,
143 addPB, deletePB, upPB, downPB, &available_model_, &selected_model_);
144 connect(selectionManager, SIGNAL(selectionChanged()),
145 this, SLOT(setCitedKeys()));
146 connect(selectionManager, SIGNAL(updateHook()),
147 this, SLOT(updateControls()));
148 connect(selectionManager, SIGNAL(okHook()),
149 this, SLOT(on_okPB_clicked()));
151 connect(filter_, SIGNAL(rightButtonClicked()),
152 this, SLOT(resetFilter()));
153 connect(filter_, SIGNAL(textEdited(QString)),
154 this, SLOT(filterChanged(QString)));
155 connect(filter_, SIGNAL(returnPressed()),
156 this, SLOT(filterPressed()));
157 connect(regexp_, SIGNAL(triggered()),
158 this, SLOT(regexChanged()));
159 connect(casesense_, SIGNAL(triggered()),
160 this, SLOT(caseChanged()));
161 connect(instant_, SIGNAL(triggered(bool)),
162 this, SLOT(instantChanged(bool)));
164 setFocusProxy(filter_);
168 GuiCitation::~GuiCitation()
170 delete selectionManager;
174 void GuiCitation::closeEvent(QCloseEvent * e)
177 DialogView::closeEvent(e);
181 void GuiCitation::applyView()
183 int const choice = max(0, citationStyleCO->currentIndex());
185 bool const full = fulllistCB->isChecked();
186 bool const force = forceuppercaseCB->isChecked();
188 QString const before = textBeforeED->text();
189 QString const after = textAfterED->text();
191 applyParams(choice, full, force, before, after);
195 void GuiCitation::showEvent(QShowEvent * e)
198 availableLV->setFocus();
199 DialogView::showEvent(e);
203 void GuiCitation::on_okPB_clicked()
211 void GuiCitation::on_cancelPB_clicked()
218 void GuiCitation::on_applyPB_clicked()
224 void GuiCitation::on_restorePB_clicked()
231 void GuiCitation::updateControls()
233 BiblioInfo const & bi = bibInfo();
238 // The main point of separating this out is that the fill*() methods
239 // called in update() do not need to be called for INTERNAL updates,
240 // such as when addPB is pressed, as the list of fields, entries, etc,
241 // will not have changed.
242 void GuiCitation::updateControls(BiblioInfo const & bi)
244 QModelIndex idx = selectionManager->getSelectedIndex();
246 selectionManager->update();
250 void GuiCitation::updateFormatting(CitationStyle currentStyle)
252 bool const force = currentStyle.forceUpperCase;
253 bool const full = currentStyle.fullAuthorList &&
254 documentBuffer().params().fullAuthorList();
255 bool const textbefore = currentStyle.textBefore;
256 bool const textafter = currentStyle.textAfter;
258 bool const haveSelection =
259 selectedLV->model()->rowCount() > 0;
261 forceuppercaseCB->setEnabled(force && haveSelection);
262 fulllistCB->setEnabled(full && haveSelection);
263 textBeforeED->setEnabled(textbefore && haveSelection);
264 textBeforeLA->setEnabled(textbefore && haveSelection);
265 textAfterED->setEnabled(textafter && haveSelection);
266 textAfterLA->setEnabled(textafter && haveSelection);
267 citationStyleCO->setEnabled(haveSelection);
268 citationStyleLA->setEnabled(haveSelection);
272 // Update the styles for the style combo, citationStyleCO, and mark the
273 // settings as changed. Called upon changing the cited keys (including
274 // merely reordering the keys) or editing the text before/after fields.
275 void GuiCitation::updateStyles()
277 BiblioInfo const & bi = bibInfo();
283 // Update the styles for the style combo, citationStyleCO.
284 void GuiCitation::updateStyles(BiblioInfo const & bi)
286 QStringList selected_keys = selected_model_.stringList();
287 int curr = selectedLV->model()->rowCount() - 1;
289 if (curr < 0 || selected_keys.empty()) {
290 citationStyleCO->clear();
291 citationStyleCO->setEnabled(false);
292 citationStyleLA->setEnabled(false);
296 static const size_t max_length = 80;
297 QStringList sty = citationStyles(bi, max_length);
301 citationStyleCO->setEnabled(false);
302 citationStyleLA->setEnabled(false);
303 citationStyleCO->clear();
307 citationStyleCO->blockSignals(true);
310 int const curindex = citationStyleCO->currentIndex();
311 int const oldIndex = (curindex < 0) ? style_ : curindex;
312 citationStyleCO->clear();
313 citationStyleCO->insertItems(0, sty);
314 citationStyleCO->setEnabled(true);
315 citationStyleLA->setEnabled(true);
317 if (oldIndex != -1 && oldIndex < citationStyleCO->count())
318 citationStyleCO->setCurrentIndex(oldIndex);
320 citationStyleCO->blockSignals(false);
324 void GuiCitation::fillFields(BiblioInfo const & bi)
326 fieldsCO->blockSignals(true);
327 int const oldIndex = fieldsCO->currentIndex();
329 QStringList const fields = to_qstring_list(bi.getFields());
330 fieldsCO->insertItem(0, qt_("All fields"));
331 fieldsCO->insertItem(1, qt_("Keys"));
332 fieldsCO->insertItems(2, fields);
333 if (oldIndex != -1 && oldIndex < fieldsCO->count())
334 fieldsCO->setCurrentIndex(oldIndex);
335 fieldsCO->blockSignals(false);
339 void GuiCitation::fillEntries(BiblioInfo const & bi)
341 entriesCO->blockSignals(true);
342 int const oldIndex = entriesCO->currentIndex();
344 QStringList const entries = to_qstring_list(bi.getEntries());
345 entriesCO->insertItem(0, qt_("All entry types"));
346 entriesCO->insertItems(1, entries);
347 if (oldIndex != -1 && oldIndex < entriesCO->count())
348 entriesCO->setCurrentIndex(oldIndex);
349 entriesCO->blockSignals(false);
353 bool GuiCitation::isSelected(QModelIndex const & idx)
355 QString const str = idx.data().toString();
356 return selected_model_.stringList().contains(str);
360 void GuiCitation::setButtons()
362 int const srows = selectedLV->model()->rowCount();
363 applyPB->setEnabled(srows > 0);
364 okPB->setEnabled(srows > 0);
368 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
370 if (!idx.isValid() || bi.empty()) {
371 infoML->document()->clear();
372 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
376 infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
377 QString const keytxt = toqstr(
378 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), true));
379 infoML->document()->setHtml(keytxt);
383 void GuiCitation::findText(QString const & text, bool reset)
385 //"All Fields" and "Keys" are the first two
386 int index = fieldsCO->currentIndex() - 2;
387 BiblioInfo const & bi = bibInfo();
388 vector<docstring> const & fields = bi.getFields();
391 if (index <= -1 || index >= int(fields.size()))
392 //either "All Fields" or "Keys" or an invalid value
393 field = from_ascii("");
395 field = fields[index];
398 bool const onlyKeys = index == -1;
400 //"All Entry Types" is first.
401 index = entriesCO->currentIndex() - 1;
402 vector<docstring> const & entries = bi.getEntries();
403 docstring entry_type;
404 if (index < 0 || index >= int(entries.size()))
405 entry_type = from_ascii("");
407 entry_type = entries[index];
409 bool const case_sentitive = casesense_->isChecked();
410 bool const reg_exp = regexp_->isChecked();
412 findKey(bi, text, onlyKeys, field, entry_type,
413 case_sentitive, reg_exp, reset);
415 //It'd be nice to save and restore the current selection in
416 //availableLV. Currently, we get an automatic reset, since the
423 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
425 findText(filter_->text(), true);
429 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
431 findText(filter_->text(), true);
435 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
437 if (index >= 0 && index < citationStyleCO->count()) {
438 vector<CitationStyle> const & styles = citeStyles_;
439 updateFormatting(styles[index]);
445 void GuiCitation::filterChanged(const QString & text)
447 if (!text.isEmpty()) {
448 if (instant_->isChecked())
449 findText(filter_->text());
452 findText(filter_->text());
457 void GuiCitation::filterPressed()
459 findText(filter_->text(), true);
463 void GuiCitation::resetFilter()
465 filter_->setText(QString());
466 findText(filter_->text(), true);
470 void GuiCitation::caseChanged()
472 findText(filter_->text());
476 void GuiCitation::regexChanged()
478 findText(filter_->text());
482 void GuiCitation::updateFilterHint()
484 QString const hint = instant_->isChecked() ?
485 qt_("Enter string to filter the list of available citations") :
486 qt_("Enter string to filter the list of available citations and press <Enter>");
487 filter_->setToolTip(hint);
491 void GuiCitation::instantChanged(bool checked)
494 findText(filter_->text(), true);
500 void GuiCitation::changed()
506 void GuiCitation::applyParams(int const choice, bool full, bool force,
507 QString before, QString after)
509 if (cited_keys_.isEmpty())
512 vector<CitationStyle> const & styles = citeStyles_;
514 CitationStyle cs = styles[choice];
521 cs.forceUpperCase &= force;
522 cs.fullAuthorList &= full;
523 string const command = citationStyleToString(cs);
525 params_.setCmdName(command);
526 params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
527 params_["before"] = qstring_to_ucs4(before);
528 params_["after"] = qstring_to_ucs4(after);
533 void GuiCitation::clearSelection()
536 selected_model_.setStringList(cited_keys_);
540 void GuiCitation::init()
542 // Make the list of all available bibliography keys
543 BiblioInfo const & bi = bibInfo();
544 all_keys_ = to_qstring_list(bi.getKeys());
545 available_model_.setStringList(all_keys_);
547 // Ditto for the keys cited in this inset
548 QString str = toqstr(params_["key"]);
552 cited_keys_ = str.split(",");
553 selected_model_.setStringList(cited_keys_);
555 // Initialize the drop downs
559 // Initialize the citation formatting
560 string const & cmd = params_.getCmdName();
561 CitationStyle const cs = citationStyleFromString(cmd);
562 forceuppercaseCB->setChecked(cs.forceUpperCase);
563 fulllistCB->setChecked(cs.fullAuthorList &&
564 documentBuffer().params().fullAuthorList());
565 textBeforeED->setText(toqstr(params_["before"]));
566 textAfterED->setText(toqstr(params_["after"]));
568 // Update the interface
571 if (selected_model_.rowCount()) {
572 selectedLV->blockSignals(true);
573 selectedLV->setFocus();
574 QModelIndex idx = selected_model_.index(0, 0);
575 selectedLV->selectionModel()->select(idx,
576 QItemSelectionModel::ClearAndSelect);
577 selectedLV->blockSignals(false);
579 // Find the citation style
580 vector<string> const & cmds = citeCmds_;
581 vector<string>::const_iterator cit =
582 std::find(cmds.begin(), cmds.end(), cs.cmd);
584 if (cit != cmds.end())
585 i = int(cit - cmds.begin());
587 // Set the style combo appropriately
588 citationStyleCO->blockSignals(true);
589 citationStyleCO->setCurrentIndex(i);
590 citationStyleCO->blockSignals(false);
591 updateFormatting(citeStyles_[i]);
593 availableLV->setFocus();
595 applyPB->setEnabled(false);
596 okPB->setEnabled(false);
600 void GuiCitation::findKey(BiblioInfo const & bi,
601 QString const & str, bool only_keys,
602 docstring field, docstring entry_type,
603 bool case_sensitive, bool reg_exp, bool reset)
606 // This should be moved to a class member.
607 // Used for optimisation: store last searched string.
608 static QString last_searched_string;
609 // Used to disable the above optimisation.
610 static bool last_case_sensitive;
611 static bool last_reg_exp;
612 // Reset last_searched_string in case of changed option.
613 if (last_case_sensitive != case_sensitive
614 || last_reg_exp != reg_exp) {
615 LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
616 last_searched_string.clear();
618 // save option for next search.
619 last_case_sensitive = case_sensitive;
620 last_reg_exp = reg_exp;
622 Qt::CaseSensitivity qtcase = case_sensitive ?
623 Qt::CaseSensitive: Qt::CaseInsensitive;
625 // If new string (str) contains the last searched one...
627 !last_searched_string.isEmpty() &&
629 str.contains(last_searched_string, qtcase))
630 // ... then only search within already found list.
631 keys = available_model_.stringList();
633 // ... else search all keys.
635 // save searched string for next search.
636 last_searched_string = str;
640 // First, filter by entry_type, which will be faster than
641 // what follows, so we may get to do that on less.
642 vector<docstring> keyVector = to_docstring_vector(keys);
643 filterByEntryType(bi, keyVector, entry_type);
646 result = to_qstring_list(keyVector);
648 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
649 qstring_to_ucs4(str), field, case_sensitive, reg_exp));
651 available_model_.setStringList(result);
655 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
657 docstring const before = qstring_to_ucs4(textBeforeED->text());
658 docstring const after = qstring_to_ucs4(textAfterED->text());
659 vector<docstring> const keys = to_docstring_vector(cited_keys_);
660 vector<CitationStyle> styles = citeStyles_;
661 // FIXME: pass a dictionary instead of individual before, after, dialog, etc.
662 vector<docstring> ret = bi.getCiteStrings(keys, styles, documentBuffer(),
663 before, after, from_utf8("dialog"), max_size);
664 return to_qstring_list(ret);
668 void GuiCitation::setCitedKeys()
670 cited_keys_ = selected_model_.stringList();
675 bool GuiCitation::initialiseParams(string const & data)
677 InsetCommand::string2params(data, params_);
678 citeCmds_ = documentBuffer().params().citeCommands();
679 citeStyles_ = documentBuffer().params().citeStyles();
685 void GuiCitation::clearParams()
691 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
692 vector<docstring> & keyVector, docstring entry_type)
694 if (entry_type.empty())
697 vector<docstring>::iterator it = keyVector.begin();
698 vector<docstring>::iterator end = keyVector.end();
700 vector<docstring> result;
701 for (; it != end; ++it) {
702 docstring const key = *it;
703 BiblioInfo::const_iterator cit = bi.find(key);
706 if (cit->second.entryType() == entry_type)
707 result.push_back(key);
713 // Escape special chars.
714 // All characters are literals except: '.|*?+(){}[]^$\'
715 // These characters are literals when preceded by a "\", which is done here
716 // @todo: This function should be moved to support, and then the test in tests
717 // should be moved there as well.
718 static docstring escape_special_chars(docstring const & expr)
720 // Search for all chars '.|*?+(){}[^$]\'
721 // Note that '[', ']', and '\' must be escaped.
722 static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
724 // $& is an ECMAScript format expression that expands to all
725 // of the current match
726 #ifdef LYX_USE_STD_REGEX
727 // To prefix a matched expression with a single literal backslash, we
728 // need to escape it for the C++ compiler and use:
730 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
732 // A backslash in the format string starts an escape sequence in boost.
733 // Thus, to prefix a matched expression with a single literal backslash,
734 // we need to give two backslashes to the regex engine, and escape both
735 // for the C++ compiler and use:
737 return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
742 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
743 vector<docstring> const & keys_to_search, bool only_keys,
744 docstring const & search_expression, docstring field,
745 bool case_sensitive, bool regex)
747 vector<docstring> foundKeys;
749 docstring expr = trim(search_expression);
754 // We must escape special chars in the search_expr so that
755 // it is treated as a simple string by lyx::regex.
756 expr = escape_special_chars(expr);
760 reg_exp.assign(to_utf8(expr), case_sensitive ?
761 lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
762 } catch (lyx::regex_error const & e) {
763 // lyx::regex throws an exception if the regular expression is not
765 LYXERR(Debug::GUI, e.what());
766 return vector<docstring>();
769 vector<docstring>::const_iterator it = keys_to_search.begin();
770 vector<docstring>::const_iterator end = keys_to_search.end();
771 for (; it != end; ++it ) {
772 BiblioInfo::const_iterator info = bi.find(*it);
773 if (info == bi.end())
776 BibTeXInfo const & kvm = info->second;
780 else if (field.empty())
781 data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
783 data = to_utf8(kvm[field]);
789 if (lyx::regex_search(data, reg_exp))
790 foundKeys.push_back(*it);
792 catch (lyx::regex_error const & e) {
793 LYXERR(Debug::GUI, e.what());
794 return vector<docstring>();
801 void GuiCitation::dispatchParams()
803 std::string const lfun = InsetCommand::params2string(params_);
804 dispatch(FuncRequest(getLfun(), lfun));
808 BiblioInfo const & GuiCitation::bibInfo() const
810 Buffer const & buf = documentBuffer();
811 buf.reloadBibInfoCache();
812 return buf.masterBibInfo();
816 void GuiCitation::saveSession() const
818 Dialog::saveSession();
821 sessionKey() + "/regex", regexp_->isChecked());
823 sessionKey() + "/casesensitive", casesense_->isChecked());
825 sessionKey() + "/autofind", instant_->isChecked());
827 sessionKey() + "/citestyle", style_);
831 void GuiCitation::restoreSession()
833 Dialog::restoreSession();
835 regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
836 casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
837 instant_->setChecked(settings.value(sessionKey() + "/autofind").toBool());
838 style_ = settings.value(sessionKey() + "/citestyle").toInt();
843 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
846 } // namespace frontend
849 #include "moc_GuiCitation.cpp"