lyx_mirror/src/frontends/qt4/GuiCitation.cpp

797 lines
20 KiB
C++
Raw Normal View History

/**
* \file GuiCitation.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
* \author Kalle Dalheimer
* \author Abdelrazak Younes
* \author Richard Heck
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "GuiCitation.h"
#include "GuiSelectionManager.h"
#include "qt_helpers.h"
#include "Buffer.h"
#include "BufferView.h"
#include "BiblioInfo.h"
#include "BufferParams.h"
#include "FuncRequest.h"
#include "insets/InsetCommand.h"
#include "support/debug.h"
#include "support/docstring.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include <QCloseEvent>
#include <QSettings>
#include <QShowEvent>
#include <QVariant>
#include <vector>
#include <string>
#undef KeyPress
#include "support/regex.h"
#include <algorithm>
#include <string>
#include <vector>
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace frontend {
// FIXME THREAD
// I am guessing that it would not hurt to make these private members.
static vector<string> citeCmds_;
static vector<CitationStyle> citeStyles_;
template<typename String>
static QStringList to_qstring_list(vector<String> const & v)
{
QStringList qlist;
for (size_t i = 0; i != v.size(); ++i) {
if (v[i].empty())
continue;
qlist.append(lyx::toqstr(v[i]));
}
return qlist;
}
static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
{
vector<lyx::docstring> v;
for (int i = 0; i != qlist.size(); ++i) {
if (qlist[i].isEmpty())
continue;
v.push_back(lyx::qstring_to_ucs4(qlist[i]));
}
return v;
}
GuiCitation::GuiCitation(GuiView & lv)
: DialogView(lv, "citation", qt_("Citation")),
params_(insetCode("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(updateStyles()));
connect(textAfterED, SIGNAL(textChanged(QString)),
this, SLOT(updateStyles()));
connect(findLE, SIGNAL(returnPressed()),
this, SLOT(on_searchPB_clicked()));
connect(textBeforeED, SIGNAL(returnPressed()),
this, SLOT(on_okPB_clicked()));
connect(textAfterED, SIGNAL(returnPressed()),
this, SLOT(on_okPB_clicked()));
selectionManager = new GuiSelectionManager(availableLV, selectedLV,
addPB, deletePB, upPB, downPB, &available_model_, &selected_model_);
connect(selectionManager, SIGNAL(selectionChanged()),
this, SLOT(setCitedKeys()));
connect(selectionManager, SIGNAL(updateHook()),
this, SLOT(updateControls()));
connect(selectionManager, SIGNAL(okHook()),
this, SLOT(on_okPB_clicked()));
setFocusProxy(availableLV);
}
GuiCitation::~GuiCitation()
{
delete selectionManager;
}
void GuiCitation::closeEvent(QCloseEvent * e)
{
clearSelection();
DialogView::closeEvent(e);
}
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();
applyParams(choice, full, force, before, after);
}
void GuiCitation::showEvent(QShowEvent * e)
{
findLE->clear();
availableLV->setFocus();
DialogView::showEvent(e);
}
void GuiCitation::on_citationTB_currentChanged(int i)
{
if (i == 0)
findLE->setFocus();
else if (citationStyleCO->isEnabled())
citationStyleCO->setFocus();
else
textAfterED->setFocus();
}
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();
}
void GuiCitation::updateControls()
{
BiblioInfo const & bi = bibInfo();
updateControls(bi);
}
// 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.
void GuiCitation::updateControls(BiblioInfo const & bi)
{
QModelIndex idx = selectionManager->getSelectedIndex();
updateInfo(bi, idx);
selectionManager->update();
}
void GuiCitation::updateFormatting(CitationStyle currentStyle)
{
bool const force = currentStyle.forceUpperCase;
bool const full = currentStyle.fullAuthorList &&
documentBuffer().params().fullAuthorList();
bool const textbefore = currentStyle.textBefore;
bool const textafter = currentStyle.textAfter;
bool const haveSelection =
selectedLV->model()->rowCount() > 0;
forceuppercaseCB->setEnabled(force && haveSelection);
fulllistCB->setEnabled(full && haveSelection);
textBeforeED->setEnabled(textbefore && haveSelection);
textBeforeLA->setEnabled(textbefore && haveSelection);
textAfterED->setEnabled(textafter && haveSelection);
textAfterLA->setEnabled(textafter && haveSelection);
citationStyleCO->setEnabled(haveSelection);
citationStyleLA->setEnabled(haveSelection);
}
// Update the styles for the style combo, citationStyleCO, and mark the
// settings as changed. Called upon changing the cited keys (including
// merely reordering the keys) or editing the text before/after fields.
void GuiCitation::updateStyles()
{
BiblioInfo const & bi = bibInfo();
updateStyles(bi);
changed();
}
// Update the styles for the style combo, citationStyleCO.
void GuiCitation::updateStyles(BiblioInfo const & bi)
{
QStringList selected_keys = selected_model_.stringList();
int curr = selectedLV->model()->rowCount() - 1;
if (curr < 0 || selected_keys.empty()) {
citationStyleCO->clear();
citationStyleCO->setEnabled(false);
citationStyleLA->setEnabled(false);
return;
}
static const size_t max_length = 80;
QStringList sty = citationStyles(bi, max_length);
if (sty.isEmpty()) {
// some error
citationStyleCO->setEnabled(false);
citationStyleLA->setEnabled(false);
citationStyleCO->clear();
return;
}
citationStyleCO->blockSignals(true);
// save old index
int const oldIndex = citationStyleCO->currentIndex();
citationStyleCO->clear();
citationStyleCO->insertItems(0, sty);
citationStyleCO->setEnabled(true);
citationStyleLA->setEnabled(true);
// restore old index
if (oldIndex != -1 && oldIndex < citationStyleCO->count())
citationStyleCO->setCurrentIndex(oldIndex);
citationStyleCO->blockSignals(false);
}
void GuiCitation::fillFields(BiblioInfo const & bi)
{
fieldsCO->blockSignals(true);
int const oldIndex = fieldsCO->currentIndex();
fieldsCO->clear();
QStringList const fields = to_qstring_list(bi.getFields());
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(BiblioInfo const & bi)
{
entriesCO->blockSignals(true);
int const oldIndex = entriesCO->currentIndex();
entriesCO->clear();
QStringList const entries = to_qstring_list(bi.getEntries());
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(QModelIndex const & idx)
{
QString const str = idx.data().toString();
return selected_model_.stringList().contains(str);
}
void GuiCitation::setButtons()
{
int const srows = selectedLV->model()->rowCount();
applyPB->setEnabled(srows > 0);
okPB->setEnabled(srows > 0);
}
void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
{
if (!idx.isValid() || bi.empty()) {
infoML->document()->clear();
return;
}
QString const keytxt = toqstr(
bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), true));
infoML->document()->setHtml(keytxt);
}
void GuiCitation::findText(QString const & text, bool reset)
{
//"All Fields" and "Keys" are the first two
int index = fieldsCO->currentIndex() - 2;
BiblioInfo const & bi = bibInfo();
vector<docstring> const & fields = bi.getFields();
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 = bi.getEntries();
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(bi, 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.
updateControls(bi);
}
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<CitationStyle> const & styles = citeStyles_;
updateFormatting(styles[index]);
changed();
}
}
void GuiCitation::on_findLE_textChanged(const QString & text)
{
bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
if (!text.isEmpty()) {
if (searchAsWeGo)
findText(findLE->text());
return;
}
findText(findLE->text());
findLE->setFocus();
}
void GuiCitation::on_searchPB_clicked()
{
findText(findLE->text(), true);
}
void GuiCitation::on_caseCB_stateChanged(int)
{
findText(findLE->text());
}
void GuiCitation::on_regexCB_stateChanged(int)
{
findText(findLE->text());
}
void GuiCitation::on_asTypeCB_stateChanged(int)
{
bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
if (searchAsWeGo)
findText(findLE->text(), true);
}
void GuiCitation::changed()
{
setButtons();
}
void GuiCitation::applyParams(int const choice, bool full, bool force,
QString before, QString after)
{
if (cited_keys_.isEmpty())
return;
vector<CitationStyle> const & styles = citeStyles_;
CitationStyle cs = styles[choice];
if (!cs.textBefore)
before.clear();
if (!cs.textAfter)
after.clear();
cs.forceUpperCase &= force;
cs.fullAuthorList &= full;
string const command = citationStyleToString(cs);
params_.setCmdName(command);
params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
params_["before"] = qstring_to_ucs4(before);
params_["after"] = qstring_to_ucs4(after);
dispatchParams();
}
void GuiCitation::clearSelection()
{
cited_keys_.clear();
selected_model_.setStringList(cited_keys_);
}
void GuiCitation::init()
{
// Make the list of all available bibliography keys
BiblioInfo const & bi = bibInfo();
all_keys_ = to_qstring_list(bi.getKeys());
available_model_.setStringList(all_keys_);
// Ditto for the keys cited in this inset
QString str = toqstr(params_["key"]);
if (str.isEmpty())
cited_keys_.clear();
else
cited_keys_ = str.split(",");
selected_model_.setStringList(cited_keys_);
// Initialize the drop downs
fillEntries(bi);
fillFields(bi);
// Initialize the citation formatting
string const & cmd = params_.getCmdName();
CitationStyle const cs = citationStyleFromString(cmd);
forceuppercaseCB->setChecked(cs.forceUpperCase);
fulllistCB->setChecked(cs.fullAuthorList &&
documentBuffer().params().fullAuthorList());
textBeforeED->setText(toqstr(params_["before"]));
textAfterED->setText(toqstr(params_["after"]));
// Update the interface
updateControls(bi);
updateStyles(bi);
if (selected_model_.rowCount()) {
selectedLV->blockSignals(true);
selectedLV->setFocus();
QModelIndex idx = selected_model_.index(0, 0);
selectedLV->selectionModel()->select(idx,
QItemSelectionModel::ClearAndSelect);
selectedLV->blockSignals(false);
// Find the citation style
vector<string> const & cmds = citeCmds_;
vector<string>::const_iterator cit =
std::find(cmds.begin(), cmds.end(), cs.cmd);
int i = 0;
if (cit != cmds.end())
i = int(cit - cmds.begin());
// Set the style combo appropriately
citationStyleCO->blockSignals(true);
citationStyleCO->setCurrentIndex(i);
citationStyleCO->blockSignals(false);
updateFormatting(citeStyles_[i]);
} else
availableLV->setFocus();
applyPB->setEnabled(false);
okPB->setEnabled(false);
}
void GuiCitation::findKey(BiblioInfo const & bi,
QString const & str, bool only_keys,
docstring field, docstring entry_type,
bool case_sensitive, bool reg_exp, bool reset)
{
// FIXME THREAD
// Used for optimisation: store last searched string.
static QString last_searched_string;
// Used to disable the above optimisation.
static bool last_case_sensitive;
static bool last_reg_exp;
// 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!");
last_searched_string.clear();
}
// save option for next search.
last_case_sensitive = case_sensitive;
last_reg_exp = reg_exp;
Qt::CaseSensitivity qtcase = case_sensitive ?
Qt::CaseSensitive: Qt::CaseInsensitive;
QStringList keys;
// If new string (str) contains the last searched one...
if (!reset &&
!last_searched_string.isEmpty() &&
str.size() > 1 &&
str.contains(last_searched_string, qtcase))
// ... then only search within already found list.
keys = available_model_.stringList();
else
// ... else search all keys.
keys = all_keys_;
// save searched string for next search.
last_searched_string = str;
QStringList result;
// 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(bi, keyVector, entry_type);
if (str.isEmpty())
result = to_qstring_list(keyVector);
else
result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
qstring_to_ucs4(str), field, case_sensitive, reg_exp));
available_model_.setStringList(result);
}
QStringList GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
{
docstring const before = qstring_to_ucs4(textBeforeED->text());
docstring const after = qstring_to_ucs4(textAfterED->text());
vector<docstring> const keys = to_docstring_vector(cited_keys_);
vector<CitationStyle> styles = citeStyles_;
// FIXME: pass a dictionary instead of individual before, after, dialog, etc.
vector<docstring> ret = bi.getCiteStrings(keys, styles, documentBuffer(),
before, after, from_utf8("dialog"), max_size);
return to_qstring_list(ret);
}
void GuiCitation::setCitedKeys()
{
cited_keys_ = selected_model_.stringList();
updateStyles();
}
bool GuiCitation::initialiseParams(string const & data)
{
InsetCommand::string2params(data, params_);
citeCmds_ = documentBuffer().params().citeCommands();
citeStyles_ = documentBuffer().params().citeStyles();
init();
return true;
}
void GuiCitation::clearParams()
{
params_.clear();
}
void GuiCitation::filterByEntryType(BiblioInfo const & bi,
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 = bi.find(key);
if (cit == bi.end())
continue;
if (cit->second.entryType() == entry_type)
result.push_back(key);
}
keyVector = result;
}
// 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.
static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
// $& is an ECMAScript format expression that expands to all
// of the current match
#if defined(LYX_USE_CXX11) && defined(LYX_USE_STD_REGEX)
// To prefix a matched expression with a single literal backslash, we
// need to escape it for the C++ compiler and use:
// FIXME: UNICODE
return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
#else
// A backslash in the format string starts an escape sequence in boost.
// Thus, to prefix a matched expression with a single literal backslash,
// we need to give two backslashes to the regex engine, and escape both
// for the C++ compiler and use:
// FIXME: UNICODE
return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
#endif
}
vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
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 lyx::regex.
expr = escape_special_chars(expr);
lyx::regex reg_exp;
try {
reg_exp.assign(to_utf8(expr), case_sensitive ?
lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
2012-09-17 08:01:26 +00:00
} catch (lyx::regex_error const & e) {
// lyx::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 = bi.find(*it);
if (info == bi.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
data = to_utf8(kvm[field]);
if (data.empty())
continue;
try {
if (lyx::regex_search(data, reg_exp))
foundKeys.push_back(*it);
}
2012-09-17 08:01:26 +00:00
catch (lyx::regex_error const & e) {
LYXERR(Debug::GUI, e.what());
return vector<docstring>();
}
}
return foundKeys;
}
void GuiCitation::dispatchParams()
{
std::string const lfun = InsetCommand::params2string(params_);
dispatch(FuncRequest(getLfun(), lfun));
}
BiblioInfo const & GuiCitation::bibInfo() const
{
Buffer const & buf = documentBuffer();
buf.reloadBibInfoCache();
return buf.masterBibInfo();
}
void GuiCitation::saveSession() const
{
Dialog::saveSession();
QSettings settings;
settings.setValue(
sessionKey() + "/regex", regexCB->isChecked());
settings.setValue(
sessionKey() + "/casesensitive", caseCB->isChecked());
settings.setValue(
sessionKey() + "/autofind", asTypeCB->isChecked());
}
void GuiCitation::restoreSession()
{
Dialog::restoreSession();
QSettings settings;
regexCB->setChecked(
settings.value(sessionKey() + "/regex").toBool());
caseCB->setChecked(
settings.value(sessionKey() + "/casesensitive").toBool());
asTypeCB->setChecked(
settings.value(sessionKey() + "/autofind").toBool());
}
Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
} // namespace frontend
} // namespace lyx
#include "moc_GuiCitation.cpp"