* \author Angus Leeming
* \author Kalle Dalheimer
* \author Abdelrazak Younes
- * \author Richard Heck (adapted to QSelectionManager)
+ * \author Richard Heck
*
* Full author contact details are available in file CREDITS.
*/
#include "GuiCitation.h"
+#include "support/debug.h"
+#include "support/gettext.h"
#include "qt_helpers.h"
+#include "Buffer.h"
+#include "BufferParams.h"
#include "support/lstrings.h"
#include "support/docstring.h"
-#include "debug.h"
+#include "insets/InsetCommand.h"
#include <vector>
#include <string>
-using std::vector;
-using std::string;
+#include <QCloseEvent>
+#include <QShowEvent>
+#undef KeyPress
-template<typename String> static QStringList to_qstring_list(vector<String> const & v)
+#include <boost/regex.hpp>
+
+#include <algorithm>
+#include <string>
+#include <vector>
+
+using namespace std;
+using namespace lyx::support;
+
+namespace lyx {
+namespace frontend {
+
+static vector<biblio::CiteStyle> citeStyles_;
+
+
+template<typename String>
+static QStringList to_qstring_list(vector<String> const & v)
{
QStringList qlist;
}
-static vector<lyx::docstring> const to_docstring_vector(QStringList const & qlist)
+static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
{
vector<lyx::docstring> v;
for (int i = 0; i != qlist.size(); ++i) {
}
-namespace lyx {
-namespace frontend {
+GuiCitation::GuiCitation(GuiView & lv)
+ : GuiCommand(lv, "citation", qt_("Citation"))
+{
+ setupUi(this);
+
+ connect(citationStyleCO, SIGNAL(activated(int)),
+ this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
+ connect(fulllistCB, SIGNAL(clicked()),
+ this, SLOT(changed()));
+ connect(forceuppercaseCB, SIGNAL(clicked()),
+ this, SLOT(changed()));
+ connect(textBeforeED, SIGNAL(textChanged(QString)),
+ this, SLOT(changed()));
+ connect(textAfterED, SIGNAL(textChanged(QString)),
+ this, SLOT(changed()));
+ connect(clearPB, SIGNAL(clicked()),
+ findLE, SLOT(clear()));
+ connect(this, SIGNAL(rejected()), this, SLOT(cleanUp()));
+
+ selectionManager = new GuiSelectionManager(availableLV, selectedLV,
+ addPB, deletePB, upPB, downPB, available(), selected());
+ connect(selectionManager, SIGNAL(selectionChanged()),
+ this, SLOT(setCitedKeys()));
+ connect(selectionManager, SIGNAL(updateHook()),
+ this, SLOT(updateDialog()));
+ connect(selectionManager, SIGNAL(okHook()),
+ this, SLOT(on_okPB_clicked()));
+
+ bc().setPolicy(ButtonPolicy::NoRepeatedApplyReadOnlyPolicy);
+}
-GuiCitation::GuiCitation(Dialog & parent)
- : ControlCitation(parent)
+void GuiCitation::cleanUp()
{
+ clearSelection();
+ clearParams();
+ close();
}
-void GuiCitation::apply(int const choice, bool const full, bool const force,
- QString before, QString after)
+void GuiCitation::closeEvent(QCloseEvent * e)
{
- if (cited_keys_.isEmpty())
+ clearSelection();
+ clearParams();
+ e->accept();
+}
+
+
+void GuiCitation::applyView()
+{
+ int const choice = max(0, citationStyleCO->currentIndex());
+ style_ = choice;
+ bool const full = fulllistCB->isChecked();
+ bool const force = forceuppercaseCB->isChecked();
+
+ QString const before = textBeforeED->text();
+ QString const after = textAfterED->text();
+
+ apply(choice, full, force, before, after);
+}
+
+
+void GuiCitation::showEvent(QShowEvent * e)
+{
+ init();
+ findLE->clear();
+ availableLV->setFocus();
+ GuiDialog::showEvent(e);
+}
+
+
+void GuiCitation::on_okPB_clicked()
+{
+ applyView();
+ clearSelection();
+ hide();
+}
+
+
+void GuiCitation::on_cancelPB_clicked()
+{
+ clearSelection();
+ hide();
+}
+
+
+void GuiCitation::on_applyPB_clicked()
+{
+ applyView();
+}
+
+
+void GuiCitation::on_restorePB_clicked()
+{
+ init();
+ updateView();
+}
+
+
+void GuiCitation::updateView()
+{
+ init();
+ fillFields();
+ fillEntries();
+ updateDialog();
+}
+
+
+// The main point of separating this out is that the fill*() methods
+// called in update() do not need to be called for INTERNAL updates,
+// such as when addPB is pressed, as the list of fields, entries, etc,
+// will not have changed. At the moment, however, the division between
+// fillStyles() and updateStyle() doesn't lend itself to dividing the
+// two methods, though they should be divisible.
+void GuiCitation::updateDialog()
+{
+ if (selectionManager->selectedFocused()) {
+ if (selectedLV->selectionModel()->selectedIndexes().isEmpty())
+ updateInfo(availableLV->currentIndex());
+ else
+ updateInfo(selectedLV->currentIndex());
+ } else {
+ if (availableLV->selectionModel()->selectedIndexes().isEmpty())
+ updateInfo(QModelIndex());
+ else
+ updateInfo(availableLV->currentIndex());
+ }
+ setButtons();
+
+ textBeforeED->setText(textBefore());
+ textAfterED->setText(textAfter());
+ fillStyles();
+ updateStyle();
+}
+
+
+void GuiCitation::updateFormatting(biblio::CiteStyle currentStyle)
+{
+ biblio::CiteEngine const engine = getEngine();
+ bool const natbib_engine =
+ engine == biblio::ENGINE_NATBIB_AUTHORYEAR ||
+ engine == biblio::ENGINE_NATBIB_NUMERICAL;
+ bool const basic_engine = engine == biblio::ENGINE_BASIC;
+
+ bool const haveSelection =
+ selectedLV->model()->rowCount() > 0;
+
+ bool const isNocite = currentStyle == biblio::NOCITE;
+
+ fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite);
+ forceuppercaseCB->setEnabled(natbib_engine && haveSelection && !isNocite);
+ textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
+ textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
+ textAfterED->setEnabled(haveSelection && !isNocite);
+ textAfterLA->setEnabled(haveSelection && !isNocite);
+ citationStyleCO->setEnabled(haveSelection);
+ citationStyleLA->setEnabled(haveSelection);
+}
+
+
+void GuiCitation::updateStyle()
+{
+ string const & command = params_.getCmdName();
+
+ // Find the style of the citekeys
+ vector<biblio::CiteStyle> const & styles = citeStyles_;
+ biblio::CitationStyle const cs(command);
+
+ vector<biblio::CiteStyle>::const_iterator cit =
+ std::find(styles.begin(), styles.end(), cs.style);
+
+ // restore the latest natbib style
+ if (style_ >= 0 && style_ < citationStyleCO->count())
+ citationStyleCO->setCurrentIndex(style_);
+ else
+ citationStyleCO->setCurrentIndex(0);
+
+ if (cit != styles.end()) {
+ int const i = int(cit - styles.begin());
+ citationStyleCO->setCurrentIndex(i);
+ fulllistCB->setChecked(cs.full);
+ forceuppercaseCB->setChecked(cs.forceUCase);
+ } else {
+ fulllistCB->setChecked(false);
+ forceuppercaseCB->setChecked(false);
+ }
+ updateFormatting(cs.style);
+}
+
+//This one needs to be called whenever citationStyleCO needs
+//to be updated---and this would be on anything that changes the
+//selection in selectedLV, or on a general update.
+void GuiCitation::fillStyles()
+{
+ int const oldIndex = citationStyleCO->currentIndex();
+
+ citationStyleCO->clear();
+
+ QStringList selected_keys = selected()->stringList();
+ if (selected_keys.empty()) {
+ citationStyleCO->setEnabled(false);
+ citationStyleLA->setEnabled(false);
return;
+ }
+
+ int curr = selectedLV->model()->rowCount() - 1;
+ if (curr < 0)
+ return;
+
+ if (!selectedLV->selectionModel()->selectedIndexes().empty())
+ curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
+
+ QStringList sty = citationStyles(curr);
+
+ citationStyleCO->setEnabled(!sty.isEmpty());
+ citationStyleLA->setEnabled(!sty.isEmpty());
+
+ if (sty.isEmpty())
+ return;
+
+ citationStyleCO->insertItems(0, sty);
+
+ if (oldIndex != -1 && oldIndex < citationStyleCO->count())
+ citationStyleCO->setCurrentIndex(oldIndex);
+}
+
+
+void GuiCitation::fillFields()
+{
+ fieldsCO->blockSignals(true);
+ int const oldIndex = fieldsCO->currentIndex();
+ fieldsCO->clear();
+ QStringList const & fields = getFieldsAsQStringList();
+ fieldsCO->insertItem(0, qt_("All Fields"));
+ fieldsCO->insertItem(1, qt_("Keys"));
+ fieldsCO->insertItems(2, fields);
+ if (oldIndex != -1 && oldIndex < fieldsCO->count())
+ fieldsCO->setCurrentIndex(oldIndex);
+ fieldsCO->blockSignals(false);
+}
+
+
+void GuiCitation::fillEntries()
+{
+ entriesCO->blockSignals(true);
+ int const oldIndex = entriesCO->currentIndex();
+ entriesCO->clear();
+ QStringList const & entries = getEntriesAsQStringList();
+ entriesCO->insertItem(0, qt_("All Entry Types"));
+ entriesCO->insertItems(1, entries);
+ if (oldIndex != -1 && oldIndex < entriesCO->count())
+ entriesCO->setCurrentIndex(oldIndex);
+ entriesCO->blockSignals(false);
+}
+
+
+bool GuiCitation::isSelected(const QModelIndex & idx)
+{
+ QString const str = idx.data().toString();
+ return selected()->stringList().contains(str);
+}
+
+
+void GuiCitation::setButtons()
+{
+ selectionManager->update();
+ int const srows = selectedLV->model()->rowCount();
+ applyPB->setEnabled(srows > 0);
+ okPB->setEnabled(srows > 0);
+}
+
+
+void GuiCitation::updateInfo(QModelIndex const & idx)
+{
+ if (idx.isValid()) {
+ QString const keytxt = getKeyInfo(idx.data().toString());
+ infoML->document()->setPlainText(keytxt);
+ } else
+ infoML->document()->clear();
+}
+
+
+void GuiCitation::findText(QString const & text, bool reset)
+{
+ //"All Fields" and "Keys" are the first two
+ int index = fieldsCO->currentIndex() - 2;
+ vector<docstring> const & fields = availableFields();
+ docstring field;
+
+ if (index <= -1 || index >= int(fields.size()))
+ //either "All Fields" or "Keys" or an invalid value
+ field = from_ascii("");
+ else
+ field = fields[index];
+
+ //Was it "Keys"?
+ bool const onlyKeys = index == -1;
+
+ //"All Entry Types" is first.
+ index = entriesCO->currentIndex() - 1;
+ vector<docstring> const & entries = availableEntries();
+ docstring entry_type;
+ if (index < 0 || index >= int(entries.size()))
+ entry_type = from_ascii("");
+ else
+ entry_type = entries[index];
+
+ bool const case_sentitive = caseCB->checkState();
+ bool const reg_exp = regexCB->checkState();
+ findKey(text, onlyKeys, field, entry_type,
+ case_sentitive, reg_exp, reset);
+ //FIXME
+ //It'd be nice to save and restore the current selection in
+ //availableLV. Currently, we get an automatic reset, since the
+ //model is reset.
+
+ updateDialog();
+}
+
+
+void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
+{
+ findText(findLE->text(), true);
+}
+
+
+void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
+{
+ findText(findLE->text(), true);
+}
+
+
+void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
+{
+ if (index >= 0 && index < citationStyleCO->count()) {
+ vector<biblio::CiteStyle> const & styles = citeStyles_;
+ updateFormatting(styles[index]);
+ }
+}
+
+
+void GuiCitation::on_findLE_textChanged(const QString & text)
+{
+ clearPB->setDisabled(text.isEmpty());
+ if (text.isEmpty())
+ findLE->setFocus();
+ findText(text);
+}
- vector<biblio::CiteStyle> const & styles =
- ControlCitation::getCiteStyles();
+void GuiCitation::on_caseCB_stateChanged(int)
+{
+ findText(findLE->text());
+}
+
+
+void GuiCitation::on_regexCB_stateChanged(int)
+{
+ findText(findLE->text());
+}
+
+
+void GuiCitation::changed()
+{
+ setButtons();
+}
+
+
+void GuiCitation::apply(int const choice, bool full, bool force,
+ QString before, QString after)
+{
+ if (cited_keys_.isEmpty())
+ return;
+
+ vector<biblio::CiteStyle> const & styles = citeStyles_;
+ if (styles[choice] == biblio::NOCITE) {
+ full = false;
+ force = false;
+ before.clear();
+ after.clear();
+ }
+
string const command =
biblio::CitationStyle(styles[choice], full, force)
.asLatexStr();
- params().setCmdName(command);
- params()["key"] = qstring_to_ucs4(cited_keys_.join(","));
- params()["before"] = qstring_to_ucs4(before);
- params()["after"] = qstring_to_ucs4(after);
+ params_.setCmdName(command);
+ params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
+ params_["before"] = qstring_to_ucs4(before);
+ params_["after"] = qstring_to_ucs4(after);
dispatchParams();
}
QString GuiCitation::textBefore()
{
- return toqstr(params()["before"]);
+ return toqstr(params_["before"]);
}
QString GuiCitation::textAfter()
{
- return toqstr(params()["after"]);
-}
-
-
-bool GuiCitation::initialiseParams(std::string const & data)
-{
- if (!ControlCitation::initialiseParams(data))
- return false;
- init();
- return true;
+ return toqstr(params_["after"]);
}
available_model_.setStringList(all_keys_);
// Ditto for the keys cited in this inset
- QString str = toqstr(params()["key"]);
+ QString str = toqstr(params_["key"]);
if (str.isEmpty())
cited_keys_.clear();
else
void GuiCitation::findKey(QString const & str, bool only_keys,
- docstring field, docstring entryType,
+ docstring field, docstring entry_type,
bool case_sensitive, bool reg_exp, bool reset)
{
// Used for optimisation: store last searched string.
// Reset last_searched_string in case of changed option.
if (last_case_sensitive != case_sensitive
|| last_reg_exp != reg_exp) {
- LYXERR(Debug::GUI) << "GuiCitation::findKey: optimisation disabled!" << std::endl;
+ LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
last_searched_string.clear();
}
// save option for next search.
QStringList result;
- //First, filter by entryType, which will be faster than
- //what follows, so we may get to do that on less.
+ // First, filter by entry_type, which will be faster than
+ // what follows, so we may get to do that on less.
vector<docstring> keyVector = to_docstring_vector(keys);
- filterByEntryType(keyVector, entryType);
+ filterByEntryType(keyVector, entry_type);
if (str.isEmpty())
result = to_qstring_list(keyVector);
}
-QStringList GuiCitation::getFieldsAsQStringList() {
+QStringList GuiCitation::getFieldsAsQStringList()
+{
return to_qstring_list(availableFields());
}
-QStringList GuiCitation::getEntriesAsQStringList() {
+QStringList GuiCitation::getEntriesAsQStringList()
+{
return to_qstring_list(availableEntries());
}
QStringList GuiCitation::citationStyles(int sel)
{
docstring const key = qstring_to_ucs4(cited_keys_[sel]);
- return to_qstring_list(getCiteStrings(key));
+ return to_qstring_list(bibkeysInfo_.getCiteStrings(key, buffer()));
}
return toqstr(getInfo(qstring_to_ucs4(sel)));
}
+
void GuiCitation::setCitedKeys()
{
cited_keys_ = selected_model_.stringList();
}
+bool GuiCitation::initialiseParams(string const & data)
+{
+ InsetCommandMailer::string2params(lfun_name_, data, params_);
+
+ biblio::CiteEngine const engine = buffer().params().getEngine();
+
+ bibkeysInfo_.fillWithBibKeys(&buffer());
+
+ citeStyles_ = biblio::getCiteStyles(engine);
+
+ return true;
+}
+
+
+void GuiCitation::clearParams()
+{
+ params_.clear();
+ bibkeysInfo_.clear();
+}
+
+
+vector<docstring> const GuiCitation::availableKeys() const
+{
+ return bibkeysInfo_.getKeys();
+}
+
+
+vector<docstring> const GuiCitation::availableFields() const
+{
+ return bibkeysInfo_.getFields();
+}
+
+
+vector<docstring> const GuiCitation::availableEntries() const
+{
+ return bibkeysInfo_.getEntries();
+}
+
+
+void GuiCitation::filterByEntryType(
+ vector<docstring> & keyVector, docstring entry_type)
+{
+ if (entry_type.empty())
+ return;
+
+ vector<docstring>::iterator it = keyVector.begin();
+ vector<docstring>::iterator end = keyVector.end();
+
+ vector<docstring> result;
+ for (; it != end; ++it) {
+ docstring const key = *it;
+ BiblioInfo::const_iterator cit = bibkeysInfo_.find(key);
+ if (cit == bibkeysInfo_.end())
+ continue;
+ if (cit->second.entryType() == entry_type)
+ result.push_back(key);
+ }
+ keyVector = result;
+}
+
+
+biblio::CiteEngine GuiCitation::getEngine() const
+{
+ return buffer().params().getEngine();
+}
+
+
+docstring GuiCitation::getInfo(docstring const & key) const
+{
+ if (bibkeysInfo_.empty())
+ return docstring();
+
+ return bibkeysInfo_.getInfo(key);
+}
+
+
+// Escape special chars.
+// All characters are literals except: '.|*?+(){}[]^$\'
+// These characters are literals when preceded by a "\", which is done here
+// @todo: This function should be moved to support, and then the test in tests
+// should be moved there as well.
+static docstring escape_special_chars(docstring const & expr)
+{
+ // Search for all chars '.|*?+(){}[^$]\'
+ // Note that '[' and '\' must be escaped.
+ // This is a limitation of boost::regex, but all other chars in BREs
+ // are assumed literal.
+ static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
+
+ // $& is a perl-like expression that expands to all
+ // of the current match
+ // The '$' must be prefixed with the escape character '\' for
+ // boost to treat it as a literal.
+ // Thus, to prefix a matched expression with '\', we use:
+ // FIXME: UNICODE
+ return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
+}
+
+
+vector<docstring> GuiCitation::searchKeys(
+ vector<docstring> const & keys_to_search, bool only_keys,
+ docstring const & search_expression, docstring field,
+ bool case_sensitive, bool regex)
+{
+ vector<docstring> foundKeys;
+
+ docstring expr = trim(search_expression);
+ if (expr.empty())
+ return foundKeys;
+
+ if (!regex)
+ // We must escape special chars in the search_expr so that
+ // it is treated as a simple string by boost::regex.
+ expr = escape_special_chars(expr);
+
+ boost::regex reg_exp;
+ try {
+ reg_exp.assign(to_utf8(expr), case_sensitive ?
+ boost::regex_constants::normal : boost::regex_constants::icase);
+ } catch (boost::regex_error & e) {
+ // boost::regex throws an exception if the regular expression is not
+ // valid.
+ LYXERR(Debug::GUI, e.what());
+ return vector<docstring>();
+ }
+
+ vector<docstring>::const_iterator it = keys_to_search.begin();
+ vector<docstring>::const_iterator end = keys_to_search.end();
+ for (; it != end; ++it ) {
+ BiblioInfo::const_iterator info = bibkeysInfo_.find(*it);
+ if (info == bibkeysInfo_.end())
+ continue;
+
+ BibTeXInfo const & kvm = info->second;
+ string data;
+ if (only_keys)
+ data = to_utf8(*it);
+ else if (field.empty())
+ data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
+ else if (kvm.hasField(field))
+ data = to_utf8(kvm.getValueForField(field));
+
+ if (data.empty())
+ continue;
+
+ try {
+ if (boost::regex_search(data, reg_exp))
+ foundKeys.push_back(*it);
+ }
+ catch (boost::regex_error & e) {
+ LYXERR(Debug::GUI, e.what());
+ return vector<docstring>();
+ }
+ }
+ return foundKeys;
+}
+
+
+Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
+
+
} // namespace frontend
} // namespace lyx
+
+#include "GuiCitation_moc.cpp"
+
projects / lyx.git / blobdiff