src/frontends/qt4/GuiCitation.cpp

   1
   2 /**
   3  * \file GuiCitation.cpp
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  * \author Kalle Dalheimer
   9  * \author Abdelrazak Younes
  10  * \author Richard Heck
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "GuiCitation.h"
  18
  19 #include "GuiApplication.h"
  20 #include "GuiSelectionManager.h"
  21 #include "LyXToolBox.h"
  22 #include "qt_helpers.h"
  23
  24 #include "Buffer.h"
  25 #include "BufferView.h"
  26 #include "BiblioInfo.h"
  27 #include "BufferParams.h"
  28 #include "FuncRequest.h"
  29
  30 #include "insets/InsetCommand.h"
  31
  32 #include "support/debug.h"
  33 #include "support/docstring.h"
  34 #include "support/gettext.h"
  35 #include "support/lstrings.h"
  36
  37 #include <QCloseEvent>
  38 #include <QMenu>
  39 #include <QSettings>
  40 #include <QShowEvent>
  41 #include <QVariant>
  42
  43 #include <vector>
  44 #include <string>
  45
  46 #undef KeyPress
  47
  48 #include "support/regex.h"
  49
  50 #include <algorithm>
  51 #include <string>
  52 #include <vector>
  53
  54 using namespace std;
  55 using namespace lyx::support;
  56
  57 namespace lyx {
  58 namespace frontend {
  59
  60 // FIXME THREAD
  61 // I am guessing that it would not hurt to make these private members.
  62 static vector<string> citeCmds_;
  63 static vector<CitationStyle> citeStyles_;
  64
  65
  66 template<typename String>
  67 static QStringList to_qstring_list(vector<String> const & v)
  68 {
  69         QStringList qlist;
  70
  71         for (size_t i = 0; i != v.size(); ++i) {
  72                 if (v[i].empty())
  73                         continue;
  74                 qlist.append(lyx::toqstr(v[i]));
  75         }
  76         return qlist;
  77 }
  78
  79
  80 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
  81 {
  82         vector<lyx::docstring> v;
  83         for (int i = 0; i != qlist.size(); ++i) {
  84                 if (qlist[i].isEmpty())
  85                         continue;
  86                 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
  87         }
  88         return v;
  89 }
  90
  91
  92 GuiCitation::GuiCitation(GuiView & lv)
  93         : DialogView(lv, "citation", qt_("Citation")),
  94           style_(0), params_(insetCode("citation"))
  95 {
  96         setupUi(this);
  97
  98         // The filter bar
  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);
 105 #endif
 106 #if QT_VERSION >= 0x040700
 107         filter_->setPlaceholderText(qt_("All avail. citations"));
 108 #endif
 109
 110         filterBarL->addWidget(filter_, 0);
 111         findKeysLA->setBuddy(filter_);
 112
 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);
 120
 121         QMenu * searchOpts = new QMenu(this);
 122         searchOpts->addAction(regexp_);
 123         searchOpts->addAction(casesense_);
 124         searchOpts->addAction(instant_);
 125         searchOptionsPB->setMenu(searchOpts);
 126
 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()));
 141
 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()));
 150
 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)));
 163
 164         setFocusProxy(filter_);
 165 }
 166
 167
 168 GuiCitation::~GuiCitation()
 169 {
 170         delete selectionManager;
 171 }
 172
 173
 174 void GuiCitation::closeEvent(QCloseEvent * e)
 175 {
 176         clearSelection();
 177         DialogView::closeEvent(e);
 178 }
 179
 180
 181 void GuiCitation::applyView()
 182 {
 183         int const choice = max(0, citationStyleCO->currentIndex());
 184         style_ = choice;
 185         bool const full  = fulllistCB->isChecked();
 186         bool const force = forceuppercaseCB->isChecked();
 187
 188         QString const before = textBeforeED->text();
 189         QString const after = textAfterED->text();
 190
 191         applyParams(choice, full, force, before, after);
 192 }
 193
 194
 195 void GuiCitation::showEvent(QShowEvent * e)
 196 {
 197         filter_->clear();
 198         availableLV->setFocus();
 199         DialogView::showEvent(e);
 200 }
 201
 202
 203 void GuiCitation::on_okPB_clicked()
 204 {
 205         applyView();
 206         clearSelection();
 207         hide();
 208 }
 209
 210
 211 void GuiCitation::on_cancelPB_clicked()
 212 {
 213         clearSelection();
 214         hide();
 215 }
 216
 217
 218 void GuiCitation::on_applyPB_clicked()
 219 {
 220         applyView();
 221 }
 222
 223
 224 void GuiCitation::on_restorePB_clicked()
 225 {
 226         init();
 227         updateFilterHint();
 228 }
 229
 230
 231 void GuiCitation::updateControls()
 232 {
 233         BiblioInfo const & bi = bibInfo();
 234         updateControls(bi);
 235 }
 236
 237
 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)
 243 {
 244         QModelIndex idx = selectionManager->getSelectedIndex();
 245         updateInfo(bi, idx);
 246         selectionManager->update();
 247 }
 248
 249
 250 void GuiCitation::updateFormatting(CitationStyle currentStyle)
 251 {
 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;
 257
 258         bool const haveSelection =
 259                 selectedLV->model()->rowCount() > 0;
 260
 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);
 269 }
 270
 271
 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()
 276 {
 277         BiblioInfo const & bi = bibInfo();
 278         updateStyles(bi);
 279         changed();
 280 }
 281
 282
 283 // Update the styles for the style combo, citationStyleCO.
 284 void GuiCitation::updateStyles(BiblioInfo const & bi)
 285 {
 286         QStringList selected_keys = selected_model_.stringList();
 287         int curr = selectedLV->model()->rowCount() - 1;
 288
 289         if (curr < 0 || selected_keys.empty()) {
 290                 citationStyleCO->clear();
 291                 citationStyleCO->setEnabled(false);
 292                 citationStyleLA->setEnabled(false);
 293                 return;
 294         }
 295
 296         static const size_t max_length = 80;
 297         QStringList sty = citationStyles(bi, max_length);
 298
 299         if (sty.isEmpty()) {
 300                 // some error
 301                 citationStyleCO->setEnabled(false);
 302                 citationStyleLA->setEnabled(false);
 303                 citationStyleCO->clear();
 304                 return;
 305         }
 306
 307         citationStyleCO->blockSignals(true);
 308
 309         // save old index
 310         int const oldIndex = citationStyleCO->currentIndex();
 311         citationStyleCO->clear();
 312         citationStyleCO->insertItems(0, sty);
 313         citationStyleCO->setEnabled(true);
 314         citationStyleLA->setEnabled(true);
 315         // restore old index
 316         if (oldIndex != -1 && oldIndex < citationStyleCO->count())
 317                 citationStyleCO->setCurrentIndex(oldIndex);
 318
 319         citationStyleCO->blockSignals(false);
 320 }
 321
 322
 323 void GuiCitation::fillFields(BiblioInfo const & bi)
 324 {
 325         fieldsCO->blockSignals(true);
 326         int const oldIndex = fieldsCO->currentIndex();
 327         fieldsCO->clear();
 328         QStringList const fields = to_qstring_list(bi.getFields());
 329         fieldsCO->insertItem(0, qt_("All fields"));
 330         fieldsCO->insertItem(1, qt_("Keys"));
 331         fieldsCO->insertItems(2, fields);
 332         if (oldIndex != -1 && oldIndex < fieldsCO->count())
 333                 fieldsCO->setCurrentIndex(oldIndex);
 334         fieldsCO->blockSignals(false);
 335 }
 336
 337
 338 void GuiCitation::fillEntries(BiblioInfo const & bi)
 339 {
 340         entriesCO->blockSignals(true);
 341         int const oldIndex = entriesCO->currentIndex();
 342         entriesCO->clear();
 343         QStringList const entries = to_qstring_list(bi.getEntries());
 344         entriesCO->insertItem(0, qt_("All entry types"));
 345         entriesCO->insertItems(1, entries);
 346         if (oldIndex != -1 && oldIndex < entriesCO->count())
 347                 entriesCO->setCurrentIndex(oldIndex);
 348         entriesCO->blockSignals(false);
 349 }
 350
 351
 352 bool GuiCitation::isSelected(QModelIndex const & idx)
 353 {
 354         QString const str = idx.data().toString();
 355         return selected_model_.stringList().contains(str);
 356 }
 357
 358
 359 void GuiCitation::setButtons()
 360 {
 361         int const srows = selectedLV->model()->rowCount();
 362         applyPB->setEnabled(srows > 0);
 363         okPB->setEnabled(srows > 0);
 364 }
 365
 366
 367 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
 368 {
 369         if (!idx.isValid() || bi.empty()) {
 370                 infoML->document()->clear();
 371                 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
 372                 return;
 373         }
 374
 375         infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
 376         QString const keytxt = toqstr(
 377                 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), true));
 378         infoML->document()->setHtml(keytxt);
 379 }
 380
 381
 382 void GuiCitation::findText(QString const & text, bool reset)
 383 {
 384         //"All Fields" and "Keys" are the first two
 385         int index = fieldsCO->currentIndex() - 2;
 386         BiblioInfo const & bi = bibInfo();
 387         vector<docstring> const & fields = bi.getFields();
 388         docstring field;
 389
 390         if (index <= -1 || index >= int(fields.size()))
 391                 //either "All Fields" or "Keys" or an invalid value
 392                 field = from_ascii("");
 393         else
 394                 field = fields[index];
 395
 396         //Was it "Keys"?
 397         bool const onlyKeys = index == -1;
 398
 399         //"All Entry Types" is first.
 400         index = entriesCO->currentIndex() - 1;
 401         vector<docstring> const & entries = bi.getEntries();
 402         docstring entry_type;
 403         if (index < 0 || index >= int(entries.size()))
 404                 entry_type = from_ascii("");
 405         else
 406                 entry_type = entries[index];
 407
 408         bool const case_sentitive = casesense_->isChecked();
 409         bool const reg_exp = regexp_->isChecked();
 410
 411         findKey(bi, text, onlyKeys, field, entry_type,
 412                        case_sentitive, reg_exp, reset);
 413         //FIXME
 414         //It'd be nice to save and restore the current selection in
 415         //availableLV. Currently, we get an automatic reset, since the
 416         //model is reset.
 417
 418         updateControls(bi);
 419 }
 420
 421
 422 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
 423 {
 424         findText(filter_->text(), true);
 425 }
 426
 427
 428 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
 429 {
 430         findText(filter_->text(), true);
 431 }
 432
 433
 434 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
 435 {
 436         if (index >= 0 && index < citationStyleCO->count()) {
 437                 vector<CitationStyle> const & styles = citeStyles_;
 438                 updateFormatting(styles[index]);
 439                 changed();
 440         }
 441 }
 442
 443
 444 void GuiCitation::filterChanged(const QString & text)
 445 {
 446         if (!text.isEmpty()) {
 447                 if (instant_->isChecked())
 448                         findText(filter_->text());
 449                 return;
 450         }
 451         findText(filter_->text());
 452         filter_->setFocus();
 453 }
 454
 455
 456 void GuiCitation::filterPressed()
 457 {
 458         findText(filter_->text(), true);
 459 }
 460
 461
 462 void GuiCitation::resetFilter()
 463 {
 464         filter_->setText(QString());
 465         findText(filter_->text(), true);
 466 }
 467
 468
 469 void GuiCitation::caseChanged()
 470 {
 471         findText(filter_->text());
 472 }
 473
 474
 475 void GuiCitation::regexChanged()
 476 {
 477         findText(filter_->text());
 478 }
 479
 480
 481 void GuiCitation::updateFilterHint()
 482 {
 483         QString const hint = instant_->isChecked() ?
 484                 qt_("Enter string to filter the list of available citations") :
 485                 qt_("Enter string to filter the list of available citations and press <Enter>");
 486         filter_->setToolTip(hint);
 487 }
 488
 489
 490 void GuiCitation::instantChanged(bool checked)
 491 {
 492         if (checked)
 493                 findText(filter_->text(), true);
 494
 495         updateFilterHint();
 496 }
 497
 498
 499 void GuiCitation::changed()
 500 {
 501         setButtons();
 502 }
 503
 504
 505 void GuiCitation::applyParams(int const choice, bool full, bool force,
 506         QString before, QString after)
 507 {
 508         if (cited_keys_.isEmpty())
 509                 return;
 510
 511         vector<CitationStyle> const & styles = citeStyles_;
 512
 513         CitationStyle cs = styles[choice];
 514
 515         if (!cs.textBefore)
 516                 before.clear();
 517         if (!cs.textAfter)
 518                 after.clear();
 519
 520         cs.forceUpperCase &= force;
 521         cs.fullAuthorList &= full;
 522         string const command = citationStyleToString(cs);
 523
 524         params_.setCmdName(command);
 525         params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
 526         params_["before"] = qstring_to_ucs4(before);
 527         params_["after"] = qstring_to_ucs4(after);
 528         dispatchParams();
 529 }
 530
 531
 532 void GuiCitation::clearSelection()
 533 {
 534         cited_keys_.clear();
 535         selected_model_.setStringList(cited_keys_);
 536 }
 537
 538
 539 void GuiCitation::init()
 540 {
 541         // Make the list of all available bibliography keys
 542         BiblioInfo const & bi = bibInfo();
 543         all_keys_ = to_qstring_list(bi.getKeys());
 544         available_model_.setStringList(all_keys_);
 545
 546         // Ditto for the keys cited in this inset
 547         QString str = toqstr(params_["key"]);
 548         if (str.isEmpty())
 549                 cited_keys_.clear();
 550         else
 551                 cited_keys_ = str.split(",");
 552         selected_model_.setStringList(cited_keys_);
 553
 554         // Initialize the drop downs
 555         fillEntries(bi);
 556         fillFields(bi);
 557
 558         // Initialize the citation formatting
 559         string const & cmd = params_.getCmdName();
 560         CitationStyle const cs = citationStyleFromString(cmd);
 561         forceuppercaseCB->setChecked(cs.forceUpperCase);
 562         fulllistCB->setChecked(cs.fullAuthorList &&
 563                 documentBuffer().params().fullAuthorList());
 564         textBeforeED->setText(toqstr(params_["before"]));
 565         textAfterED->setText(toqstr(params_["after"]));
 566
 567         // Update the interface
 568         updateControls(bi);
 569         updateStyles(bi);
 570         if (selected_model_.rowCount()) {
 571                 selectedLV->blockSignals(true);
 572                 selectedLV->setFocus();
 573                 QModelIndex idx = selected_model_.index(0, 0);
 574                 selectedLV->selectionModel()->select(idx,
 575                                 QItemSelectionModel::ClearAndSelect);
 576                 selectedLV->blockSignals(false);
 577
 578                 // Find the citation style
 579                 vector<string> const & cmds = citeCmds_;
 580                 vector<string>::const_iterator cit =
 581                         std::find(cmds.begin(), cmds.end(), cs.cmd);
 582                 int i = 0;
 583                 if (cit != cmds.end())
 584                         i = int(cit - cmds.begin());
 585
 586                 // Set the style combo appropriately
 587                 citationStyleCO->blockSignals(true);
 588                 citationStyleCO->setCurrentIndex(i);
 589                 citationStyleCO->blockSignals(false);
 590                 updateFormatting(citeStyles_[i]);
 591         } else
 592                 availableLV->setFocus();
 593
 594         applyPB->setEnabled(false);
 595         okPB->setEnabled(false);
 596 }
 597
 598
 599 void GuiCitation::findKey(BiblioInfo const & bi,
 600         QString const & str, bool only_keys,
 601         docstring field, docstring entry_type,
 602         bool case_sensitive, bool reg_exp, bool reset)
 603 {
 604         // FIXME THREAD
 605         // This should be moved to a class member.
 606         // Used for optimisation: store last searched string.
 607         static QString last_searched_string;
 608         // Used to disable the above optimisation.
 609         static bool last_case_sensitive;
 610         static bool last_reg_exp;
 611         // Reset last_searched_string in case of changed option.
 612         if (last_case_sensitive != case_sensitive
 613                 || last_reg_exp != reg_exp) {
 614                         LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
 615                 last_searched_string.clear();
 616         }
 617         // save option for next search.
 618         last_case_sensitive = case_sensitive;
 619         last_reg_exp = reg_exp;
 620
 621         Qt::CaseSensitivity qtcase = case_sensitive ?
 622                         Qt::CaseSensitive: Qt::CaseInsensitive;
 623         QStringList keys;
 624         // If new string (str) contains the last searched one...
 625         if (!reset &&
 626                 !last_searched_string.isEmpty() &&
 627                 str.size() > 1 &&
 628                 str.contains(last_searched_string, qtcase))
 629                 // ... then only search within already found list.
 630                 keys = available_model_.stringList();
 631         else
 632                 // ... else search all keys.
 633                 keys = all_keys_;
 634         // save searched string for next search.
 635         last_searched_string = str;
 636
 637         QStringList result;
 638
 639         // First, filter by entry_type, which will be faster than
 640         // what follows, so we may get to do that on less.
 641         vector<docstring> keyVector = to_docstring_vector(keys);
 642         filterByEntryType(bi, keyVector, entry_type);
 643
 644         if (str.isEmpty())
 645                 result = to_qstring_list(keyVector);
 646         else
 647                 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
 648                         qstring_to_ucs4(str), field, case_sensitive, reg_exp));
 649
 650         available_model_.setStringList(result);
 651 }
 652
 653
 654 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
 655 {
 656         docstring const before = qstring_to_ucs4(textBeforeED->text());
 657         docstring const after = qstring_to_ucs4(textAfterED->text());
 658         vector<docstring> const keys = to_docstring_vector(cited_keys_);
 659         vector<CitationStyle> styles = citeStyles_;
 660         // FIXME: pass a dictionary instead of individual before, after, dialog, etc.
 661         vector<docstring> ret = bi.getCiteStrings(keys, styles, documentBuffer(),
 662                 before, after, from_utf8("dialog"), max_size);
 663         return to_qstring_list(ret);
 664 }
 665
 666
 667 void GuiCitation::setCitedKeys()
 668 {
 669         cited_keys_ = selected_model_.stringList();
 670         updateStyles();
 671 }
 672
 673
 674 bool GuiCitation::initialiseParams(string const & data)
 675 {
 676         InsetCommand::string2params(data, params_);
 677         citeCmds_ = documentBuffer().params().citeCommands();
 678         citeStyles_ = documentBuffer().params().citeStyles();
 679         init();
 680         return true;
 681 }
 682
 683
 684 void GuiCitation::clearParams()
 685 {
 686         params_.clear();
 687 }
 688
 689
 690 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
 691         vector<docstring> & keyVector, docstring entry_type)
 692 {
 693         if (entry_type.empty())
 694                 return;
 695
 696         vector<docstring>::iterator it = keyVector.begin();
 697         vector<docstring>::iterator end = keyVector.end();
 698
 699         vector<docstring> result;
 700         for (; it != end; ++it) {
 701                 docstring const key = *it;
 702                 BiblioInfo::const_iterator cit = bi.find(key);
 703                 if (cit == bi.end())
 704                         continue;
 705                 if (cit->second.entryType() == entry_type)
 706                         result.push_back(key);
 707         }
 708         keyVector = result;
 709 }
 710
 711
 712 // Escape special chars.
 713 // All characters are literals except: '.|*?+(){}[]^$\'
 714 // These characters are literals when preceded by a "\", which is done here
 715 // @todo: This function should be moved to support, and then the test in tests
 716 //        should be moved there as well.
 717 static docstring escape_special_chars(docstring const & expr)
 718 {
 719         // Search for all chars '.|*?+(){}[^$]\'
 720         // Note that '[', ']', and '\' must be escaped.
 721         static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
 722
 723         // $& is an ECMAScript format expression that expands to all
 724         // of the current match
 725 #ifdef LYX_USE_STD_REGEX
 726         // To prefix a matched expression with a single literal backslash, we
 727         // need to escape it for the C++ compiler and use:
 728         // FIXME: UNICODE
 729         return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
 730 #else
 731         // A backslash in the format string starts an escape sequence in boost.
 732         // Thus, to prefix a matched expression with a single literal backslash,
 733         // we need to give two backslashes to the regex engine, and escape both
 734         // for the C++ compiler and use:
 735         // FIXME: UNICODE
 736         return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
 737 #endif
 738 }
 739
 740
 741 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
 742         vector<docstring> const & keys_to_search, bool only_keys,
 743         docstring const & search_expression, docstring field,
 744         bool case_sensitive, bool regex)
 745 {
 746         vector<docstring> foundKeys;
 747
 748         docstring expr = trim(search_expression);
 749         if (expr.empty())
 750                 return foundKeys;
 751
 752         if (!regex)
 753                 // We must escape special chars in the search_expr so that
 754                 // it is treated as a simple string by lyx::regex.
 755                 expr = escape_special_chars(expr);
 756
 757         lyx::regex reg_exp;
 758         try {
 759                 reg_exp.assign(to_utf8(expr), case_sensitive ?
 760                         lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
 761         } catch (lyx::regex_error const & e) {
 762                 // lyx::regex throws an exception if the regular expression is not
 763                 // valid.
 764                 LYXERR(Debug::GUI, e.what());
 765                 return vector<docstring>();
 766         }
 767
 768         vector<docstring>::const_iterator it = keys_to_search.begin();
 769         vector<docstring>::const_iterator end = keys_to_search.end();
 770         for (; it != end; ++it ) {
 771                 BiblioInfo::const_iterator info = bi.find(*it);
 772                 if (info == bi.end())
 773                         continue;
 774
 775                 BibTeXInfo const & kvm = info->second;
 776                 string data;
 777                 if (only_keys)
 778                         data = to_utf8(*it);
 779                 else if (field.empty())
 780                         data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
 781                 else
 782                         data = to_utf8(kvm[field]);
 783
 784                 if (data.empty())
 785                         continue;
 786
 787                 try {
 788                         if (lyx::regex_search(data, reg_exp))
 789                                 foundKeys.push_back(*it);
 790                 }
 791                 catch (lyx::regex_error const & e) {
 792                         LYXERR(Debug::GUI, e.what());
 793                         return vector<docstring>();
 794                 }
 795         }
 796         return foundKeys;
 797 }
 798
 799
 800 void GuiCitation::dispatchParams()
 801 {
 802         std::string const lfun = InsetCommand::params2string(params_);
 803         dispatch(FuncRequest(getLfun(), lfun));
 804 }
 805
 806
 807 BiblioInfo const & GuiCitation::bibInfo() const
 808 {
 809         Buffer const & buf = documentBuffer();
 810         buf.reloadBibInfoCache();
 811         return buf.masterBibInfo();
 812 }
 813
 814
 815 void GuiCitation::saveSession() const
 816 {
 817         Dialog::saveSession();
 818         QSettings settings;
 819         settings.setValue(
 820                 sessionKey() + "/regex", regexp_->isChecked());
 821         settings.setValue(
 822                 sessionKey() + "/casesensitive", casesense_->isChecked());
 823         settings.setValue(
 824                 sessionKey() + "/autofind", instant_->isChecked());
 825 }
 826
 827
 828 void GuiCitation::restoreSession()
 829 {
 830         Dialog::restoreSession();
 831         QSettings settings;
 832         regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
 833         casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
 834         instant_->setChecked(settings.value(sessionKey() + "/autofind").toBool());
 835         updateFilterHint();
 836 }
 837
 838
 839 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
 840
 841
 842 } // namespace frontend
 843 } // namespace lyx
 844
 845 #include "moc_GuiCitation.cpp"
 846