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 "qt_helpers.h"
  22
  23 #include "Buffer.h"
  24 #include "BufferView.h"
  25 #include "BiblioInfo.h"
  26 #include "BufferParams.h"
  27 #include "TextClass.h"
  28 #include "FuncRequest.h"
  29
  30 #include "insets/InsetCitation.h"
  31 #include "insets/InsetCommand.h"
  32
  33 #include "support/debug.h"
  34 #include "support/docstring.h"
  35 #include "support/gettext.h"
  36 #include "support/lstrings.h"
  37
  38 #include <QCloseEvent>
  39 #include <QMenu>
  40 #include <QSettings>
  41 #include <QShowEvent>
  42 #include <QStandardItemModel>
  43 #include <QVariant>
  44
  45 #include <vector>
  46 #include <string>
  47
  48 #undef KeyPress
  49
  50 #include "support/regex.h"
  51
  52 #include <algorithm>
  53 #include <string>
  54 #include <vector>
  55
  56 using namespace std;
  57 using namespace lyx::support;
  58
  59 namespace lyx {
  60 namespace frontend {
  61
  62 // FIXME THREAD
  63 // I am guessing that it would not hurt to make these private members.
  64 static vector<string> citeCmds_;
  65 static vector<CitationStyle> citeStyles_;
  66
  67
  68 template<typename String>
  69 static QStringList to_qstring_list(vector<String> const & v)
  70 {
  71         QStringList qlist;
  72
  73         for (size_t i = 0; i != v.size(); ++i) {
  74                 if (v[i].empty())
  75                         continue;
  76                 qlist.append(lyx::toqstr(v[i]));
  77         }
  78         return qlist;
  79 }
  80
  81
  82 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
  83 {
  84         vector<lyx::docstring> v;
  85         for (int i = 0; i != qlist.size(); ++i) {
  86                 if (qlist[i].isEmpty())
  87                         continue;
  88                 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
  89         }
  90         return v;
  91 }
  92
  93
  94 GuiCitation::GuiCitation(GuiView & lv)
  95         : DialogView(lv, "citation", qt_("Citation")),
  96           style_(QString()), params_(insetCode("citation"))
  97 {
  98         setupUi(this);
  99
 100         // The filter bar
 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"));
 107
 108         filterBarL->addWidget(filter_, 0);
 109         findKeysLA->setBuddy(filter_);
 110
 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);
 119
 120         QMenu * searchOpts = new QMenu(this);
 121         searchOpts->addAction(regexp_);
 122         searchOpts->addAction(casesense_);
 123         searchOpts->addAction(instant_);
 124         searchOptionsPB->setMenu(searchOpts);
 125
 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()));
 142
 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()));
 151
 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()));
 161 #else
 162         connect(filter_, &FancyLineEdit::downPressed,
 163                 availableLV, [=](){ focusAndHighlight(availableLV); });
 164 #endif
 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)));
 171
 172 #if (QT_VERSION < 0x050000)
 173         selectedLV->horizontalHeader()->setResizeMode(QHeaderView::Stretch);
 174 #else
 175         selectedLV->horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch);
 176 #endif
 177
 178         selectedLV->setToolTip(qt_("Ordered list of all cited references.\n"
 179                                    "You can reorder, add and remove references with the buttons on the left."));
 180         setFocusProxy(filter_);
 181 }
 182
 183
 184 void GuiCitation::closeEvent(QCloseEvent * e)
 185 {
 186         clearSelection();
 187         DialogView::closeEvent(e);
 188 }
 189
 190
 191 void GuiCitation::applyView()
 192 {
 193         int const choice = max(0, citationStyleCO->currentIndex());
 194         style_ = citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
 195         bool const full  = starredCB->isChecked();
 196         bool const force = forceuppercaseCB->isChecked();
 197
 198         QString const before = textBeforeED->text();
 199         QString const after = textAfterED->text();
 200
 201         applyParams(choice, full, force, before, after);
 202 }
 203
 204
 205 void GuiCitation::showEvent(QShowEvent * e)
 206 {
 207         if (!filter_->text().isEmpty())
 208                 filterPressed();
 209         availableLV->setFocus();
 210         DialogView::showEvent(e);
 211 }
 212
 213
 214 void GuiCitation::on_okPB_clicked()
 215 {
 216         applyView();
 217         clearSelection();
 218         hide();
 219 }
 220
 221
 222 void GuiCitation::on_cancelPB_clicked()
 223 {
 224         clearSelection();
 225         hide();
 226 }
 227
 228
 229 void GuiCitation::on_applyPB_clicked()
 230 {
 231         applyView();
 232 }
 233
 234
 235 void GuiCitation::on_restorePB_clicked()
 236 {
 237         init();
 238         updateFilterHint();
 239         filterPressed();
 240 }
 241
 242
 243 void GuiCitation::on_literalCB_clicked()
 244 {
 245         InsetCitation::last_literal = literalCB->isChecked();
 246         changed();
 247 }
 248
 249
 250 void GuiCitation::updateControls()
 251 {
 252         BiblioInfo const & bi = bibInfo();
 253         updateControls(bi);
 254 }
 255
 256
 257 // The main point of separating this out is that the fill*() methods
 258 // called in update() do not need to be called for INTERNAL updates,
 259 // such as when addPB is pressed, as the list of fields, entries, etc,
 260 // will not have changed.
 261 void GuiCitation::updateControls(BiblioInfo const & bi)
 262 {
 263         QModelIndex idx = selectionManager->getSelectedIndex(1);
 264         updateInfo(bi, idx);
 265         int i = citationStyleCO->currentIndex();
 266         if (i == -1 || i > int(citeStyles_.size()))
 267                 i = 0;
 268         updateFormatting(citeStyles_[i]);
 269         selectionManager->update();
 270 }
 271
 272
 273 void GuiCitation::updateFormatting(CitationStyle const & currentStyle)
 274 {
 275         BufferParams const bp = documentBuffer().params();
 276         bool const force = currentStyle.forceUpperCase;
 277         bool const starred = currentStyle.hasStarredVersion;
 278         bool const full = starred && bp.fullAuthorList();
 279         bool const textbefore = currentStyle.textBefore;
 280         bool const textafter = currentStyle.textAfter;
 281
 282         int const rows = selectedLV->model()->rowCount();
 283
 284         bool const qualified = currentStyle.hasQualifiedList
 285                 && (rows > 1
 286                     || !params_["pretextlist"].empty()
 287                     || !params_["posttextlist"].empty()
 288                     || !getPreTexts().empty()
 289                     || !getPostTexts().empty());
 290
 291         selectedLV->horizontalHeader()->setVisible(qualified);
 292         selectedLV->setColumnHidden(0, !qualified);
 293         selectedLV->setColumnHidden(2, !qualified);
 294         bool const haveSelection = rows > 0;
 295         if (qualified) {
 296                 textBeforeLA->setText(qt_("General text befo&re:"));
 297                 textAfterLA->setText(qt_("General &text after:"));
 298                 textBeforeED->setToolTip(qt_("Text that precedes the whole reference list. "
 299                                              "For text that precedes individual items, "
 300                                              "double-click on the respective entry above."));
 301                 textAfterLA->setToolTip(qt_("General &text after:"));
 302                 textAfterED->setToolTip(qt_("Text that follows the whole reference list. "
 303                                              "For text that follows individual items, "
 304                                              "double-click on the respective entry above."));
 305         } else {
 306                 textBeforeLA->setText(qt_("Text befo&re:"));
 307                 if (textbefore && haveSelection)
 308                         textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\")"));
 309                 else
 310                         textBeforeED->setToolTip(qt_("Text that precedes the reference (e.g., \"cf.\"), "
 311                                                      "if the current citation style supports this."));
 312                 textAfterLA->setText(qt_("&Text after:"));
 313                 if (textafter && haveSelection)
 314                         textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages)"));
 315                 else
 316                         textAfterED->setToolTip(qt_("Text that follows the reference (e.g., pages), "
 317                                                     "if the current citation style supports this."));
 318         }
 319
 320         forceuppercaseCB->setEnabled(force && haveSelection);
 321         if (force && haveSelection)
 322                 forceuppercaseCB->setToolTip(qt_("Force upper case in names (\"Del Piero\", not \"del Piero\")."));
 323         else
 324                 forceuppercaseCB->setToolTip(qt_("Force upper case in names (\"Del Piero\", not \"del Piero\"), "
 325                                              "if the current citation style supports this."));
 326         starredCB->setEnabled(full && haveSelection);
 327         textBeforeED->setEnabled(textbefore && haveSelection);
 328         textBeforeLA->setEnabled(textbefore && haveSelection);
 329         textAfterED->setEnabled(textafter && haveSelection);
 330         textAfterLA->setEnabled(textafter && haveSelection);
 331         literalCB->setEnabled(textbefore || textafter);
 332         citationStyleCO->setEnabled(haveSelection);
 333         citationStyleLA->setEnabled(haveSelection);
 334
 335         // Check if we have a custom string/tooltip for the starred version
 336         if (starred && !currentStyle.stardesc.empty()) {
 337                 string val =
 338                         bp.documentClass().getCiteMacro(bp.citeEngineType(), currentStyle.stardesc);
 339                 docstring guistring;
 340                 if (!val.empty()) {
 341                         guistring = translateIfPossible(from_utf8(val));
 342                         starredCB->setText(toqstr(guistring));
 343                         starredCB->setEnabled(haveSelection);
 344                 }
 345                 if (!currentStyle.startooltip.empty()) {
 346                         val = bp.documentClass().getCiteMacro(bp.citeEngineType(),
 347                                                               currentStyle.startooltip);
 348                         if (!val.empty())
 349                                 guistring = translateIfPossible(from_utf8(val));
 350                 }
 351                 // Tooltip might also be empty
 352                 starredCB->setToolTip(toqstr(guistring));
 353         } else {
 354                 // This is the default meaning of the starred commands
 355                 starredCB->setText(qt_("All aut&hors"));
 356                 if (full && haveSelection)
 357                         starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\")"));
 358                 else
 359                         starredCB->setToolTip(qt_("Always list all authors (rather than using \"et al.\"), "
 360                                                   "if the current citation style supports this."));
 361         }
 362         if (availableLV->selectionModel()->selectedIndexes().isEmpty())
 363                 availableLV->setToolTip(qt_("All references available for citing."));
 364         else
 365                 availableLV->setToolTip(qt_("All references available for citing.\n"
 366                                             "To add the selected one, hit Add, press Enter or double-click.\n"
 367                                             "Hit Ctrl-Enter to add and close the dialog."));
 368 }
 369
 370
 371 // Update the styles for the style combo, citationStyleCO, and mark the
 372 // settings as changed. Called upon changing the cited keys (including
 373 // merely reordering the keys) or editing the text before/after fields.
 374 void GuiCitation::updateStyles()
 375 {
 376         BiblioInfo const & bi = bibInfo();
 377         updateStyles(bi);
 378         changed();
 379 }
 380
 381
 382 // Update the styles for the style combo, citationStyleCO.
 383 void GuiCitation::updateStyles(BiblioInfo const & bi)
 384 {
 385         QStringList selected_keys = selectedKeys();
 386         int curr = selectedLV->model()->rowCount() - 1;
 387
 388         if (curr < 0 || selected_keys.empty()) {
 389                 last_chosen_style_ =
 390                         citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
 391                 citationStyleCO->clear();
 392                 citationStyleCO->setEnabled(false);
 393                 citationStyleLA->setEnabled(false);
 394                 return;
 395         }
 396
 397         static const size_t max_length = 80;
 398         BiblioInfo::CiteStringMap sty = citationStyles(bi, max_length);
 399
 400         if (sty.empty()) {
 401                 // some error
 402                 citationStyleCO->setEnabled(false);
 403                 citationStyleLA->setEnabled(false);
 404                 citationStyleCO->clear();
 405                 return;
 406         }
 407
 408         citationStyleCO->blockSignals(true);
 409
 410         // save old style selection
 411         QString const curdata =
 412                 citationStyleCO->itemData(citationStyleCO->currentIndex()).toString();
 413         QString const olddata = (curdata.isEmpty()) ?
 414                 (last_chosen_style_.isEmpty() ? style_ : last_chosen_style_): curdata;
 415         // reset this
 416         last_chosen_style_.clear();
 417         citationStyleCO->clear();
 418         BiblioInfo::CiteStringMap::const_iterator cit = sty.begin();
 419         BiblioInfo::CiteStringMap::const_iterator end = sty.end();
 420         for (int ii = 1; cit != end; ++cit, ++ii)
 421                 citationStyleCO->addItem(toqstr(cit->second), toqstr(cit->first));
 422         citationStyleCO->setEnabled(true);
 423         citationStyleLA->setEnabled(true);
 424         // restore old style selection
 425         int const i = citationStyleCO->findData(olddata);
 426         if (i != -1)
 427                 citationStyleCO->setCurrentIndex(i);
 428
 429         citationStyleCO->blockSignals(false);
 430 }
 431
 432
 433 void GuiCitation::fillFields(BiblioInfo const & bi)
 434 {
 435         fieldsCO->blockSignals(true);
 436         int const oldIndex = fieldsCO->currentIndex();
 437         fieldsCO->clear();
 438         QStringList const fields = to_qstring_list(bi.getFields());
 439         fieldsCO->insertItem(0, qt_("All fields"));
 440         fieldsCO->insertItem(1, qt_("Keys"));
 441         fieldsCO->insertItems(2, fields);
 442         if (oldIndex != -1 && oldIndex < fieldsCO->count())
 443                 fieldsCO->setCurrentIndex(oldIndex);
 444         fieldsCO->blockSignals(false);
 445 }
 446
 447
 448 void GuiCitation::fillEntries(BiblioInfo const & bi)
 449 {
 450         entriesCO->blockSignals(true);
 451         int const oldIndex = entriesCO->currentIndex();
 452         entriesCO->clear();
 453         QStringList const entries = to_qstring_list(bi.getEntries());
 454         entriesCO->insertItem(0, qt_("All entry types"));
 455         entriesCO->insertItems(1, entries);
 456         if (oldIndex != -1 && oldIndex < entriesCO->count())
 457                 entriesCO->setCurrentIndex(oldIndex);
 458         entriesCO->blockSignals(false);
 459 }
 460
 461
 462 bool GuiCitation::isSelected(QModelIndex const & idx)
 463 {
 464         QString const str = idx.data().toString();
 465         return selectedKeys().contains(str);
 466 }
 467
 468
 469 void GuiCitation::setButtons()
 470 {
 471         int const srows = selectedLV->model()->rowCount();
 472         applyPB->setEnabled(srows > 0);
 473         okPB->setEnabled(srows > 0);
 474 }
 475
 476
 477 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
 478 {
 479         if (!idx.isValid() || bi.empty()) {
 480                 infoML->document()->clear();
 481                 infoML->setToolTip(qt_("Displays a sketchy preview if a citation is selected above"));
 482                 return;
 483         }
 484
 485         infoML->setToolTip(qt_("Sketchy preview of the selected citation"));
 486         CiteItem ci;
 487         ci.richtext = true;
 488         QString const keytxt = toqstr(
 489                 bi.getInfo(qstring_to_ucs4(idx.data().toString()), documentBuffer(), ci));
 490         infoML->document()->setHtml(keytxt);
 491 }
 492
 493
 494 void GuiCitation::findText(QString const & text, bool reset)
 495 {
 496         //"All Fields" and "Keys" are the first two
 497         int index = fieldsCO->currentIndex() - 2;
 498         BiblioInfo const & bi = bibInfo();
 499         vector<docstring> const & fields = bi.getFields();
 500         docstring field;
 501
 502         if (index <= -1 || index >= int(fields.size()))
 503                 //either "All Fields" or "Keys" or an invalid value
 504                 field = from_ascii("");
 505         else
 506                 field = fields[index];
 507
 508         //Was it "Keys"?
 509         bool const onlyKeys = index == -1;
 510
 511         //"All Entry Types" is first.
 512         index = entriesCO->currentIndex() - 1;
 513         vector<docstring> const & entries = bi.getEntries();
 514         docstring entry_type;
 515         if (index < 0 || index >= int(entries.size()))
 516                 entry_type = from_ascii("");
 517         else
 518                 entry_type = entries[index];
 519
 520         bool const case_sentitive = casesense_->isChecked();
 521         bool const reg_exp = regexp_->isChecked();
 522
 523         findKey(bi, text, onlyKeys, field, entry_type,
 524                        case_sentitive, reg_exp, reset);
 525         //FIXME
 526         //It'd be nice to save and restore the current selection in
 527         //availableLV. Currently, we get an automatic reset, since the
 528         //model is reset.
 529
 530         updateControls(bi);
 531 }
 532
 533
 534 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
 535 {
 536         findText(filter_->text(), true);
 537 }
 538
 539
 540 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
 541 {
 542         findText(filter_->text(), true);
 543 }
 544
 545
 546 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
 547 {
 548         if (index >= 0 && index < citationStyleCO->count()) {
 549                 vector<CitationStyle> const & styles = citeStyles_;
 550                 updateFormatting(styles[index]);
 551                 changed();
 552         }
 553 }
 554
 555
 556 void GuiCitation::filterChanged(const QString & text)
 557 {
 558         if (!text.isEmpty()) {
 559                 if (instant_->isChecked())
 560                         findText(filter_->text());
 561                 return;
 562         }
 563         findText(filter_->text());
 564         filter_->setFocus();
 565 }
 566
 567
 568 void GuiCitation::filterPressed()
 569 {
 570         findText(filter_->text(), true);
 571 }
 572
 573
 574 void GuiCitation::resetFilter()
 575 {
 576         filter_->setText(QString());
 577         findText(filter_->text(), true);
 578 }
 579
 580
 581 void GuiCitation::caseChanged()
 582 {
 583         findText(filter_->text());
 584 }
 585
 586
 587 void GuiCitation::regexChanged()
 588 {
 589         findText(filter_->text());
 590 }
 591
 592
 593 void GuiCitation::updateFilterHint()
 594 {
 595         QString hint = instant_->isChecked() ?
 596                 qt_("Enter string to filter the list of available citations") :
 597                 qt_("Enter string to filter the list of available citations and press <Enter>");
 598         hint += qt_("\nThe down arrow key will get you into the list of filtered citations.");
 599         filter_->setToolTip(hint);
 600 }
 601
 602
 603 void GuiCitation::instantChanged(bool checked)
 604 {
 605         if (checked)
 606                 findText(filter_->text(), true);
 607
 608         updateFilterHint();
 609 }
 610
 611
 612 void GuiCitation::changed()
 613 {
 614         setButtons();
 615 }
 616
 617
 618 void GuiCitation::applyParams(int const choice, bool full, bool force,
 619         QString before, QString after)
 620 {
 621         if (cited_keys_.isEmpty())
 622                 return;
 623
 624         vector<CitationStyle> const & styles = citeStyles_;
 625
 626         CitationStyle cs = styles[choice];
 627
 628         if (!cs.textBefore)
 629                 before.clear();
 630         if (!cs.textAfter)
 631                 after.clear();
 632
 633         cs.forceUpperCase &= force;
 634         cs.hasStarredVersion &= full;
 635         string const command = citationStyleToString(cs);
 636
 637         params_.setCmdName(command);
 638         params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
 639         params_["before"] = qstring_to_ucs4(before);
 640         params_["after"] = qstring_to_ucs4(after);
 641         if (cs.hasQualifiedList) {
 642                 params_["pretextlist"] = getStringFromVector(getPreTexts(), from_ascii("\t"));
 643                 params_["posttextlist"] = getStringFromVector(getPostTexts(), from_ascii("\t"));
 644         }
 645         params_["literal"] = literalCB->isChecked() ? from_ascii("true") : from_ascii("false");
 646         dispatchParams();
 647 }
 648
 649
 650 void GuiCitation::clearSelection()
 651 {
 652         cited_keys_.clear();
 653         setSelectedKeys(cited_keys_);
 654 }
 655
 656
 657 void GuiCitation::setSelectedKeys(QStringList const sl)
 658 {
 659         selected_model_.clear();
 660         selected_model_.setColumnCount(3);
 661         QStringList headers;
 662         headers << qt_("Text before")
 663                 << qt_("Cite key")
 664                 << qt_("Text after");
 665         selected_model_.setHorizontalHeaderLabels(headers);
 666         selectedLV->setColumnHidden(0, true);
 667         selectedLV->setColumnHidden(2, true);
 668         selectedLV->verticalHeader()->setVisible(false);
 669         selectedLV->horizontalHeader()->setVisible(false);
 670         QStringList::const_iterator it  = sl.begin();
 671         QStringList::const_iterator end = sl.end();
 672         for (int i = 0; it != end; ++it, ++i) {
 673                 QStandardItem * si = new QStandardItem();
 674                 si->setData(*it);
 675                 si->setText(*it);
 676                 si->setToolTip(*it);
 677                 si->setEditable(false);
 678                 selected_model_.setItem(i, 1, si);
 679         }
 680 }
 681
 682
 683 QStringList GuiCitation::selectedKeys()
 684 {
 685         QStringList res;
 686         for (int i = 0; i != selected_model_.rowCount(); ++i) {
 687                 QStandardItem const * item = selected_model_.item(i, 1);
 688                 if (item)
 689                         res.append(item->text());
 690         }
 691         return res;
 692 }
 693
 694
 695 void GuiCitation::setPreTexts(vector<docstring> const m)
 696 {
 697         for (docstring const & s: m) {
 698                 QStandardItem * si = new QStandardItem();
 699                 docstring key;
 700                 docstring pre = split(s, key, ' ');
 701                 si->setData(toqstr(pre));
 702                 si->setText(toqstr(pre));
 703                 QModelIndexList qmil =
 704                                 selected_model_.match(selected_model_.index(0, 1),
 705                                                      Qt::DisplayRole, toqstr(key), 1,
 706                                                      Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
 707                 if (!qmil.empty())
 708                         selected_model_.setItem(qmil.front().row(), 0, si);
 709         }
 710 }
 711
 712
 713 vector<docstring> GuiCitation::getPreTexts()
 714 {
 715         vector<docstring> res;
 716         for (int i = 0; i != selected_model_.rowCount(); ++i) {
 717                 QStandardItem const * key = selected_model_.item(i, 1);
 718                 QStandardItem const * pre = selected_model_.item(i, 0);
 719                 if (key && pre && !key->text().isEmpty() && !pre->text().isEmpty())
 720                         res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(pre->text()));
 721         }
 722         return res;
 723 }
 724
 725
 726 void GuiCitation::setPostTexts(vector<docstring> const m)
 727 {
 728         for (docstring const & s: m) {
 729                 QStandardItem * si = new QStandardItem();
 730                 docstring key;
 731                 docstring post = split(s, key, ' ');
 732                 si->setData(toqstr(post));
 733                 si->setText(toqstr(post));
 734                 QModelIndexList qmil =
 735                                 selected_model_.match(selected_model_.index(0, 1),
 736                                                      Qt::DisplayRole, toqstr(key), 1,
 737                                                      Qt::MatchFlags(Qt::MatchExactly | Qt::MatchWrap));
 738                 if (!qmil.empty())
 739                         selected_model_.setItem(qmil.front().row(), 2, si);
 740         }
 741 }
 742
 743
 744 vector<docstring> GuiCitation::getPostTexts()
 745 {
 746         vector<docstring> res;
 747         for (int i = 0; i != selected_model_.rowCount(); ++i) {
 748                 QStandardItem const * key = selected_model_.item(i, 1);
 749                 QStandardItem const * post = selected_model_.item(i, 2);
 750                 if (key && post && !key->text().isEmpty() && !post->text().isEmpty())
 751                         res.push_back(qstring_to_ucs4(key->text()) + " " + qstring_to_ucs4(post->text()));
 752         }
 753         return res;
 754 }
 755
 756
 757 void GuiCitation::init()
 758 {
 759         // Make the list of all available bibliography keys
 760         BiblioInfo const & bi = bibInfo();
 761         all_keys_ = to_qstring_list(bi.getKeys());
 762
 763         available_model_.setStringList(all_keys_);
 764
 765         // Ditto for the keys cited in this inset
 766         QString str = toqstr(params_["key"]);
 767         if (str.isEmpty())
 768                 cited_keys_.clear();
 769         else
 770                 cited_keys_ = str.split(",");
 771         setSelectedKeys(cited_keys_);
 772
 773         // Initialize the drop downs
 774         fillEntries(bi);
 775         fillFields(bi);
 776
 777         // Initialize the citation formatting
 778         string const & cmd = params_.getCmdName();
 779         CitationStyle const cs =
 780                 citationStyleFromString(cmd, documentBuffer().params());
 781
 782         forceuppercaseCB->setChecked(cs.forceUpperCase);
 783         starredCB->setChecked(cs.hasStarredVersion &&
 784                 documentBuffer().params().fullAuthorList());
 785         textBeforeED->setText(toqstr(params_["before"]));
 786         textAfterED->setText(toqstr(params_["after"]));
 787
 788         // if this is a new citation, we set the literal checkbox
 789         // to its last set value.
 790         if (cited_keys_.isEmpty())
 791                 literalCB->setChecked(InsetCitation::last_literal);
 792         else
 793                 literalCB->setChecked(params_["literal"] == "true");
 794
 795         setPreTexts(getVectorFromString(params_["pretextlist"], from_ascii("\t")));
 796         setPostTexts(getVectorFromString(params_["posttextlist"], from_ascii("\t")));
 797
 798         // Update the interface
 799         updateControls(bi);
 800         updateStyles(bi);
 801         if (selected_model_.rowCount()) {
 802                 selectedLV->blockSignals(true);
 803                 selectedLV->setFocus();
 804                 selectedLV->selectRow(0);
 805                 selectedLV->blockSignals(false);
 806
 807                 // Find the citation style
 808                 vector<string> const & cmds = citeCmds_;
 809                 vector<string>::const_iterator cit =
 810                         std::find(cmds.begin(), cmds.end(), cs.name);
 811                 int i = 0;
 812                 if (cit != cmds.end())
 813                         i = int(cit - cmds.begin());
 814
 815                 // Set the style combo appropriately
 816                 citationStyleCO->blockSignals(true);
 817                 citationStyleCO->setCurrentIndex(i);
 818                 citationStyleCO->blockSignals(false);
 819                 updateFormatting(citeStyles_[i]);
 820         } else
 821                 availableLV->setFocus();
 822
 823         applyPB->setEnabled(false);
 824         okPB->setEnabled(false);
 825 }
 826
 827
 828 void GuiCitation::findKey(BiblioInfo const & bi,
 829         QString const & str, bool only_keys,
 830         docstring field, docstring entry_type,
 831         bool case_sensitive, bool reg_exp, bool reset)
 832 {
 833         // FIXME THREAD
 834         // This should be moved to a class member.
 835         // Used for optimisation: store last searched string.
 836         static QString last_searched_string;
 837         // Used to disable the above optimisation.
 838         static bool last_case_sensitive;
 839         static bool last_reg_exp;
 840         // Reset last_searched_string in case of changed option.
 841         if (last_case_sensitive != case_sensitive
 842                 || last_reg_exp != reg_exp) {
 843                         LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
 844                 last_searched_string.clear();
 845         }
 846         // save option for next search.
 847         last_case_sensitive = case_sensitive;
 848         last_reg_exp = reg_exp;
 849
 850         Qt::CaseSensitivity qtcase = case_sensitive ?
 851                         Qt::CaseSensitive: Qt::CaseInsensitive;
 852         QStringList keys;
 853         // If new string (str) contains the last searched one...
 854         if (!reset &&
 855                 !last_searched_string.isEmpty() &&
 856                 str.size() > 1 &&
 857                 str.contains(last_searched_string, qtcase))
 858                 // ... then only search within already found list.
 859                 keys = available_model_.stringList();
 860         else
 861                 // ... else search all keys.
 862                 keys = all_keys_;
 863         // save searched string for next search.
 864         last_searched_string = str;
 865
 866         QStringList result;
 867
 868         // First, filter by entry_type, which will be faster than
 869         // what follows, so we may get to do that on less.
 870         vector<docstring> keyVector = to_docstring_vector(keys);
 871         filterByEntryType(bi, keyVector, entry_type);
 872
 873         if (str.isEmpty())
 874                 result = to_qstring_list(keyVector);
 875         else
 876                 result = to_qstring_list(searchKeys(bi, keyVector, only_keys,
 877                         qstring_to_ucs4(str), field, case_sensitive, reg_exp));
 878
 879         available_model_.setStringList(result);
 880 }
 881
 882
 883 BiblioInfo::CiteStringMap GuiCitation::citationStyles(BiblioInfo const & bi, size_t max_size)
 884 {
 885         vector<docstring> const keys = to_docstring_vector(cited_keys_);
 886         vector<CitationStyle> styles = citeStyles_;
 887         int ind = citationStyleCO->currentIndex();
 888         if (ind == -1)
 889                 ind = 0;
 890         CitationStyle cs = styles[ind];
 891         vector<docstring> pretexts = getPreTexts();
 892         vector<docstring> posttexts = getPostTexts();
 893         bool const qualified = cs.hasQualifiedList
 894                 && (selectedLV->model()->rowCount() > 1
 895                     || !pretexts.empty()
 896                     || !posttexts.empty());
 897         std::map<docstring, docstring> pres;
 898         for (docstring const & s: pretexts) {
 899                 docstring key;
 900                 docstring val = split(s, key, ' ');
 901                 pres[key] = val;
 902         }
 903         std::map<docstring, docstring> posts;
 904         for (docstring const & s: posttexts) {
 905                 docstring key;
 906                 docstring val = split(s, key, ' ');
 907                 posts[key] = val;
 908         }
 909         CiteItem ci;
 910         ci.textBefore = qstring_to_ucs4(textBeforeED->text());
 911         ci.textAfter = qstring_to_ucs4(textAfterED->text());
 912         ci.forceUpperCase = forceuppercaseCB->isChecked();
 913         ci.Starred = starredCB->isChecked();
 914         ci.context = CiteItem::Dialog;
 915         ci.max_size = max_size;
 916         ci.isQualified = qualified;
 917         ci.pretexts = pres;
 918         ci.posttexts = posts;
 919         BiblioInfo::CiteStringMap ret = bi.getCiteStrings(keys, styles, documentBuffer(), ci);
 920         return ret;
 921 }
 922
 923
 924 void GuiCitation::setCitedKeys()
 925 {
 926         cited_keys_ = selectedKeys();
 927         updateStyles();
 928 }
 929
 930
 931 bool GuiCitation::initialiseParams(string const & data)
 932 {
 933         InsetCommand::string2params(data, params_);
 934         citeCmds_ = documentBuffer().params().citeCommands();
 935         citeStyles_ = documentBuffer().params().citeStyles();
 936         init();
 937         return true;
 938 }
 939
 940
 941 void GuiCitation::clearParams()
 942 {
 943         params_.clear();
 944 }
 945
 946
 947 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
 948         vector<docstring> & keyVector, docstring entry_type)
 949 {
 950         if (entry_type.empty())
 951                 return;
 952
 953         vector<docstring>::iterator it = keyVector.begin();
 954         vector<docstring>::iterator end = keyVector.end();
 955
 956         vector<docstring> result;
 957         for (; it != end; ++it) {
 958                 docstring const key = *it;
 959                 BiblioInfo::const_iterator cit = bi.find(key);
 960                 if (cit == bi.end())
 961                         continue;
 962                 if (cit->second.entryType() == entry_type)
 963                         result.push_back(key);
 964         }
 965         keyVector = result;
 966 }
 967
 968
 969 // Escape special chars.
 970 // All characters are literals except: '.|*?+(){}[]^$\'
 971 // These characters are literals when preceded by a "\", which is done here
 972 // @todo: This function should be moved to support, and then the test in tests
 973 //        should be moved there as well.
 974 static docstring escape_special_chars(docstring const & expr)
 975 {
 976         // Search for all chars '.|*?+(){}[^$]\'
 977         // Note that '[', ']', and '\' must be escaped.
 978         static const lyx::regex reg("[.|*?+(){}^$\\[\\]\\\\]");
 979
 980         // $& is an ECMAScript format expression that expands to all
 981         // of the current match
 982 #ifdef LYX_USE_STD_REGEX
 983         // To prefix a matched expression with a single literal backslash, we
 984         // need to escape it for the C++ compiler and use:
 985         // FIXME: UNICODE
 986         return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\$&")));
 987 #else
 988         // A backslash in the format string starts an escape sequence in boost.
 989         // Thus, to prefix a matched expression with a single literal backslash,
 990         // we need to give two backslashes to the regex engine, and escape both
 991         // for the C++ compiler and use:
 992         // FIXME: UNICODE
 993         return from_utf8(lyx::regex_replace(to_utf8(expr), reg, string("\\\\$&")));
 994 #endif
 995 }
 996
 997
 998 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,
 999         vector<docstring> const & keys_to_search, bool only_keys,
1000         docstring const & search_expression, docstring field,
1001         bool case_sensitive, bool regex)
1002 {
1003         vector<docstring> foundKeys;
1004
1005         docstring expr = trim(search_expression);
1006         if (expr.empty())
1007                 return foundKeys;
1008
1009         if (!regex)
1010                 // We must escape special chars in the search_expr so that
1011                 // it is treated as a simple string by lyx::regex.
1012                 expr = escape_special_chars(expr);
1013
1014         lyx::regex reg_exp;
1015         try {
1016                 reg_exp.assign(to_utf8(expr), case_sensitive ?
1017                         lyx::regex_constants::ECMAScript : lyx::regex_constants::icase);
1018         } catch (lyx::regex_error const & e) {
1019                 // lyx::regex throws an exception if the regular expression is not
1020                 // valid.
1021                 LYXERR(Debug::GUI, e.what());
1022                 return vector<docstring>();
1023         }
1024
1025         vector<docstring>::const_iterator it = keys_to_search.begin();
1026         vector<docstring>::const_iterator end = keys_to_search.end();
1027         for (; it != end; ++it ) {
1028                 BiblioInfo::const_iterator info = bi.find(*it);
1029                 if (info == bi.end())
1030                         continue;
1031
1032                 BibTeXInfo const & kvm = info->second;
1033                 string data;
1034                 if (only_keys)
1035                         data = to_utf8(*it);
1036                 else if (field.empty())
1037                         data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
1038                 else
1039                         data = to_utf8(kvm[field]);
1040
1041                 if (data.empty())
1042                         continue;
1043
1044                 try {
1045                         if (lyx::regex_search(data, reg_exp))
1046                                 foundKeys.push_back(*it);
1047                 }
1048                 catch (lyx::regex_error const & e) {
1049                         LYXERR(Debug::GUI, e.what());
1050                         return vector<docstring>();
1051                 }
1052         }
1053         return foundKeys;
1054 }
1055
1056
1057 void GuiCitation::dispatchParams()
1058 {
1059         std::string const lfun = InsetCommand::params2string(params_);
1060         dispatch(FuncRequest(getLfun(), lfun));
1061 }
1062
1063
1064 BiblioInfo const & GuiCitation::bibInfo() const
1065 {
1066         Buffer const & buf = documentBuffer();
1067         buf.reloadBibInfoCache();
1068         return buf.masterBibInfo();
1069 }
1070
1071
1072 void GuiCitation::saveSession(QSettings & settings) const
1073 {
1074         Dialog::saveSession(settings);
1075         settings.setValue(
1076                 sessionKey() + "/regex", regexp_->isChecked());
1077         settings.setValue(
1078                 sessionKey() + "/casesensitive", casesense_->isChecked());
1079         settings.setValue(
1080                 sessionKey() + "/autofind", instant_->isChecked());
1081         settings.setValue(
1082                 sessionKey() + "/citestyle", style_);
1083         settings.setValue(
1084                 sessionKey() + "/literal", InsetCitation::last_literal);
1085 }
1086
1087
1088 void GuiCitation::restoreSession()
1089 {
1090         Dialog::restoreSession();
1091         QSettings settings;
1092         regexp_->setChecked(settings.value(sessionKey() + "/regex").toBool());
1093         casesense_->setChecked(settings.value(sessionKey() + "/casesensitive").toBool());
1094         instant_->setChecked(settings.value(sessionKey() + "/autofind", true).toBool());
1095         style_ = settings.value(sessionKey() + "/citestyle").toString();
1096         InsetCitation::last_literal =
1097                 settings.value(sessionKey() + "/literal", false).toBool();
1098         updateFilterHint();
1099 }
1100
1101
1102 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
1103
1104
1105 } // namespace frontend
1106 } // namespace lyx
1107
1108 #include "moc_GuiCitation.cpp"
1109