]> git.lyx.org Git - lyx.git/blob - src/frontends/qt4/GuiCitation.cpp
* fix spelling in comments to please John.
[lyx.git] / 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 "GuiSelectionManager.h"
20 #include "qt_helpers.h"
21
22 #include "Buffer.h"
23 #include "BiblioInfo.h"
24 #include "BufferParams.h"
25 #include "FuncRequest.h"
26
27 #include "insets/InsetCommand.h"
28
29 #include "support/debug.h"
30 #include "support/docstring.h"
31 #include "support/gettext.h"
32 #include "support/lstrings.h"
33
34 #include <QCloseEvent>
35 #include <QSettings>
36 #include <QShowEvent>
37 #include <QVariant>
38
39 #include <vector>
40 #include <string>
41
42 #undef KeyPress
43
44 #include <boost/regex.hpp>
45
46 #include <algorithm>
47 #include <string>
48 #include <vector>
49
50 using namespace std;
51 using namespace lyx::support;
52
53 namespace lyx {
54 namespace frontend {
55
56 static vector<CiteStyle> citeStyles_;
57
58
59 template<typename String>
60 static QStringList to_qstring_list(vector<String> const & v)
61 {
62         QStringList qlist;
63
64         for (size_t i = 0; i != v.size(); ++i) {
65                 if (v[i].empty())
66                         continue;
67                 qlist.append(lyx::toqstr(v[i]));
68         }
69         return qlist;
70 }
71
72
73 static vector<lyx::docstring> to_docstring_vector(QStringList const & qlist)
74 {
75         vector<lyx::docstring> v;
76         for (int i = 0; i != qlist.size(); ++i) {
77                 if (qlist[i].isEmpty())
78                         continue;
79                 v.push_back(lyx::qstring_to_ucs4(qlist[i]));
80         }
81         return v;
82 }
83
84
85 GuiCitation::GuiCitation(GuiView & lv)
86         : DialogView(lv, "citation", qt_("Citation")),
87           params_(insetCode("citation"))
88 {
89         setupUi(this);
90
91         connect(citationStyleCO, SIGNAL(activated(int)),
92                 this, SLOT(on_citationStyleCO_currentIndexChanged(int)));
93         connect(fulllistCB, SIGNAL(clicked()),
94                 this, SLOT(changed()));
95         connect(forceuppercaseCB, SIGNAL(clicked()),
96                 this, SLOT(changed()));
97         connect(textBeforeED, SIGNAL(textChanged(QString)),
98                 this, SLOT(changed()));
99         connect(textAfterED, SIGNAL(textChanged(QString)),
100                 this, SLOT(changed()));
101         connect(findLE, SIGNAL(returnPressed()), 
102                 this, SLOT(on_searchPB_clicked()));
103         connect(textBeforeED, SIGNAL(returnPressed()),
104                 this, SLOT(on_okPB_clicked()));
105         connect(textAfterED, SIGNAL(returnPressed()),
106                 this, SLOT(on_okPB_clicked()));
107
108         selectionManager = new GuiSelectionManager(availableLV, selectedLV, 
109                         addPB, deletePB, upPB, downPB, &available_model_, &selected_model_);
110         connect(selectionManager, SIGNAL(selectionChanged()),
111                 this, SLOT(setCitedKeys()));
112         connect(selectionManager, SIGNAL(updateHook()),
113                 this, SLOT(updateControls()));
114         connect(selectionManager, SIGNAL(okHook()),
115                 this, SLOT(on_okPB_clicked()));
116
117         setFocusProxy(availableLV);
118
119         // FIXME: the sizeHint() for this is _way_ too high
120         infoML->setFixedHeight(60);
121 }
122
123
124 GuiCitation::~GuiCitation()
125 {
126         delete selectionManager;
127 }
128
129
130 void GuiCitation::closeEvent(QCloseEvent * e)
131 {
132         clearSelection();
133         DialogView::closeEvent(e);
134 }
135
136
137 void GuiCitation::applyView()
138 {
139         int const choice = max(0, citationStyleCO->currentIndex());
140         style_ = choice;
141         bool const full  = fulllistCB->isChecked();
142         bool const force = forceuppercaseCB->isChecked();
143
144         QString const before = textBeforeED->text();
145         QString const after = textAfterED->text();
146
147         apply(choice, full, force, before, after);
148 }
149
150
151 void GuiCitation::showEvent(QShowEvent * e)
152 {
153         findLE->clear();
154         availableLV->setFocus();
155         DialogView::showEvent(e);
156 }
157
158
159 void GuiCitation::on_okPB_clicked()
160 {
161         applyView();
162         clearSelection();
163         hide();
164 }
165
166
167 void GuiCitation::on_cancelPB_clicked()
168 {
169         clearSelection();
170         hide();
171 }
172
173
174 void GuiCitation::on_applyPB_clicked()
175 {
176         applyView();
177 }
178
179
180 void GuiCitation::on_restorePB_clicked()
181 {
182         init();
183 }
184
185
186 void GuiCitation::updateControls()
187 {
188         BiblioInfo const & bi = bibInfo();
189         updateControls(bi);
190 }
191
192
193 // The main point of separating this out is that the fill*() methods
194 // called in update() do not need to be called for INTERNAL updates,
195 // such as when addPB is pressed, as the list of fields, entries, etc,
196 // will not have changed. At the moment, however, the division between
197 // fillStyles() and updateStyle() doesn't lend itself to dividing the
198 // two methods, though they should be divisible.
199 void GuiCitation::updateControls(BiblioInfo const & bi)
200 {
201         if (selectionManager->selectedFocused()) { 
202                 if (selectedLV->selectionModel()->selectedIndexes().isEmpty())
203                         updateInfo(bi, availableLV->currentIndex());
204                 else
205                         updateInfo(bi, selectedLV->currentIndex());
206         } else {
207                 if (availableLV->selectionModel()->selectedIndexes().isEmpty())
208                         updateInfo(bi, QModelIndex());
209                 else
210                         updateInfo(bi, availableLV->currentIndex());
211         }
212         setButtons();
213
214         textBeforeED->setText(toqstr(params_["before"]));
215         textAfterED->setText(toqstr(params_["after"]));
216         fillStyles(bi);
217         updateStyle();
218 }
219
220
221 void GuiCitation::updateFormatting(CiteStyle currentStyle)
222 {
223         CiteEngine const engine = citeEngine();
224         bool const natbib_engine =
225                 engine == ENGINE_NATBIB_AUTHORYEAR ||
226                 engine == ENGINE_NATBIB_NUMERICAL;
227         bool const basic_engine = engine == ENGINE_BASIC;
228
229         bool const haveSelection = 
230                 selectedLV->model()->rowCount() > 0;
231
232         bool const isNocite = currentStyle == NOCITE;
233
234         bool const isCiteyear =
235                 currentStyle == CITEYEAR ||
236                 currentStyle == CITEYEARPAR;
237
238         fulllistCB->setEnabled(natbib_engine && haveSelection && !isNocite
239                 && !isCiteyear);
240         forceuppercaseCB->setEnabled(natbib_engine && haveSelection
241                 && !isNocite && !isCiteyear);
242         textBeforeED->setEnabled(!basic_engine && haveSelection && !isNocite);
243         textBeforeLA->setEnabled(!basic_engine && haveSelection && !isNocite);
244         textAfterED->setEnabled(haveSelection && !isNocite);
245         textAfterLA->setEnabled(haveSelection && !isNocite);
246         citationStyleCO->setEnabled(haveSelection);
247         citationStyleLA->setEnabled(haveSelection);
248 }
249
250
251 void GuiCitation::updateStyle()
252 {
253         string const & command = params_.getCmdName();
254
255         // Find the style of the citekeys
256         vector<CiteStyle> const & styles = citeStyles_;
257         CitationStyle const cs = citationStyleFromString(command);
258
259         vector<CiteStyle>::const_iterator cit =
260                 std::find(styles.begin(), styles.end(), cs.style);
261
262         // restore the latest natbib style
263         if (style_ >= 0 && style_ < citationStyleCO->count())
264                 citationStyleCO->setCurrentIndex(style_);
265         else
266                 citationStyleCO->setCurrentIndex(0);
267
268         if (cit != styles.end()) {
269                 int const i = int(cit - styles.begin());
270                 citationStyleCO->setCurrentIndex(i);
271                 fulllistCB->setChecked(cs.full);
272                 forceuppercaseCB->setChecked(cs.forceUpperCase);
273         } else {
274                 fulllistCB->setChecked(false);
275                 forceuppercaseCB->setChecked(false);
276         }
277         updateFormatting(cs.style);
278 }
279
280 // This one needs to be called whenever citationStyleCO needs
281 // to be updated---and this would be on anything that changes the
282 // selection in selectedLV, or on a general update.
283 void GuiCitation::fillStyles(BiblioInfo const & bi)
284 {
285         int const oldIndex = citationStyleCO->currentIndex();
286
287         citationStyleCO->clear();
288
289         QStringList selected_keys = selected_model_.stringList();
290         if (selected_keys.empty()) {
291                 citationStyleCO->setEnabled(false);
292                 citationStyleLA->setEnabled(false);
293                 return;
294         }
295
296         int curr = selectedLV->model()->rowCount() - 1;
297         if (curr < 0)
298                 return;
299
300         if (!selectedLV->selectionModel()->selectedIndexes().empty())
301                 curr = selectedLV->selectionModel()->selectedIndexes()[0].row();
302
303         QStringList sty = citationStyles(bi, curr);
304
305         citationStyleCO->setEnabled(!sty.isEmpty());
306         citationStyleLA->setEnabled(!sty.isEmpty());
307
308         if (sty.isEmpty())
309                 return;
310
311         citationStyleCO->insertItems(0, sty);
312
313         if (oldIndex != -1 && oldIndex < citationStyleCO->count())
314                 citationStyleCO->setCurrentIndex(oldIndex);
315 }
316
317
318 void GuiCitation::fillFields(BiblioInfo const & bi)
319 {
320         fieldsCO->blockSignals(true);
321         int const oldIndex = fieldsCO->currentIndex();
322         fieldsCO->clear();
323         QStringList const fields = to_qstring_list(bi.getFields());
324         fieldsCO->insertItem(0, qt_("All fields"));
325         fieldsCO->insertItem(1, qt_("Keys"));
326         fieldsCO->insertItems(2, fields);
327         if (oldIndex != -1 && oldIndex < fieldsCO->count())
328                 fieldsCO->setCurrentIndex(oldIndex);
329         fieldsCO->blockSignals(false);
330 }
331
332
333 void GuiCitation::fillEntries(BiblioInfo const & bi)
334 {
335         entriesCO->blockSignals(true);
336         int const oldIndex = entriesCO->currentIndex();
337         entriesCO->clear();
338         QStringList const entries = to_qstring_list(bi.getEntries());
339         entriesCO->insertItem(0, qt_("All entry types"));
340         entriesCO->insertItems(1, entries);
341         if (oldIndex != -1 && oldIndex < entriesCO->count())
342                 entriesCO->setCurrentIndex(oldIndex);
343         entriesCO->blockSignals(false);
344 }
345
346
347 bool GuiCitation::isSelected(const QModelIndex & idx)
348 {
349         QString const str = idx.data().toString();
350         return selected_model_.stringList().contains(str);
351 }
352
353
354 void GuiCitation::setButtons()
355 {
356         selectionManager->update();
357         int const srows = selectedLV->model()->rowCount();
358         applyPB->setEnabled(srows > 0);
359         okPB->setEnabled(srows > 0);
360 }
361
362
363 void GuiCitation::updateInfo(BiblioInfo const & bi, QModelIndex const & idx)
364 {
365         if (!idx.isValid() || bi.empty()) {
366                 infoML->document()->clear();
367                 return;
368         }
369
370         QString const keytxt = toqstr(
371                 bi.getInfo(qstring_to_ucs4(idx.data().toString())));
372         infoML->document()->setPlainText(keytxt);
373 }
374
375
376 void GuiCitation::findText(QString const & text, bool reset)
377 {
378         //"All Fields" and "Keys" are the first two
379         int index = fieldsCO->currentIndex() - 2; 
380         BiblioInfo const & bi = bibInfo();
381         vector<docstring> const & fields = bi.getFields();
382         docstring field;
383         
384         if (index <= -1 || index >= int(fields.size()))
385                 //either "All Fields" or "Keys" or an invalid value
386                 field = from_ascii("");
387         else
388                 field = fields[index];
389         
390         //Was it "Keys"?
391         bool const onlyKeys = index == -1;
392         
393         //"All Entry Types" is first.
394         index = entriesCO->currentIndex() - 1; 
395         vector<docstring> const & entries = bi.getEntries();
396         docstring entry_type;
397         if (index < 0 || index >= int(entries.size()))
398                 entry_type = from_ascii("");
399         else 
400                 entry_type = entries[index];
401         
402         bool const case_sentitive = caseCB->checkState();
403         bool const reg_exp = regexCB->checkState();
404         findKey(bi, text, onlyKeys, field, entry_type, 
405                        case_sentitive, reg_exp, reset);
406         //FIXME
407         //It'd be nice to save and restore the current selection in 
408         //availableLV. Currently, we get an automatic reset, since the
409         //model is reset.
410         
411         updateControls(bi);
412 }
413
414
415 void GuiCitation::on_fieldsCO_currentIndexChanged(int /*index*/)
416 {
417         findText(findLE->text(), true);
418 }
419
420
421 void GuiCitation::on_entriesCO_currentIndexChanged(int /*index*/)
422 {
423         findText(findLE->text(), true);
424 }
425
426
427 void GuiCitation::on_citationStyleCO_currentIndexChanged(int index)
428 {
429         if (index >= 0 && index < citationStyleCO->count()) {
430                 vector<CiteStyle> const & styles = citeStyles_;
431                 updateFormatting(styles[index]);
432         }
433 }
434
435
436 void GuiCitation::on_findLE_textChanged(const QString & text)
437 {
438         bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
439         searchPB->setDisabled(text.isEmpty() || searchAsWeGo);
440         if (!text.isEmpty()) {
441                 if (searchAsWeGo)
442                         findText(findLE->text());
443                 return;
444         }
445         findText(findLE->text());
446         findLE->setFocus();
447 }
448
449 void GuiCitation::on_searchPB_clicked()
450 {
451         findText(findLE->text(), true);
452 }
453
454
455 void GuiCitation::on_caseCB_stateChanged(int)
456 {
457         findText(findLE->text());
458 }
459
460
461 void GuiCitation::on_regexCB_stateChanged(int)
462 {
463         findText(findLE->text());
464 }
465
466
467 void GuiCitation::on_asTypeCB_stateChanged(int)
468 {
469         bool const searchAsWeGo = (asTypeCB->checkState() == Qt::Checked);
470         searchPB->setDisabled(findLE->text().isEmpty() || searchAsWeGo);
471         if (searchAsWeGo)
472                 findText(findLE->text(), true);
473 }
474
475
476 void GuiCitation::changed()
477 {
478         setButtons();
479 }
480
481
482 void GuiCitation::apply(int const choice, bool full, bool force,
483         QString before, QString after)
484 {
485         if (cited_keys_.isEmpty())
486                 return;
487
488         vector<CiteStyle> const & styles = citeStyles_;
489         if (styles[choice] == NOCITE) {
490                 full = false;
491                 force = false;
492                 before.clear();
493                 after.clear();
494         }
495         
496         CitationStyle s;
497         s.style = styles[choice];
498         s.full = full;
499         s.forceUpperCase = force;
500         string const command = citationStyleToString(s);
501
502         params_.setCmdName(command);
503         params_["key"] = qstring_to_ucs4(cited_keys_.join(","));
504         params_["before"] = qstring_to_ucs4(before);
505         params_["after"] = qstring_to_ucs4(after);
506         dispatchParams();
507 }
508
509
510 void GuiCitation::clearSelection()
511 {
512         cited_keys_.clear();
513         selected_model_.setStringList(cited_keys_);
514 }
515
516
517 void GuiCitation::init()
518 {
519         // Make the list of all available bibliography keys
520         BiblioInfo const & bi = bibInfo();
521         all_keys_ = to_qstring_list(bi.getKeys());
522         available_model_.setStringList(all_keys_);
523
524         // Ditto for the keys cited in this inset
525         QString str = toqstr(params_["key"]);
526         if (str.isEmpty())
527                 cited_keys_.clear();
528         else
529                 cited_keys_ = str.split(",");
530         selected_model_.setStringList(cited_keys_);
531         fillFields(bi);
532         fillEntries(bi);
533         updateControls(bi);
534 }
535
536
537 void GuiCitation::findKey(BiblioInfo const & bi,
538         QString const & str, bool only_keys,
539         docstring field, docstring entry_type,
540         bool case_sensitive, bool reg_exp, bool reset)
541 {
542         // Used for optimisation: store last searched string.
543         static QString last_searched_string;
544         // Used to disable the above optimisation.
545         static bool last_case_sensitive;
546         static bool last_reg_exp;
547         // Reset last_searched_string in case of changed option.
548         if (last_case_sensitive != case_sensitive
549                 || last_reg_exp != reg_exp) {
550                         LYXERR(Debug::GUI, "GuiCitation::findKey: optimisation disabled!");
551                 last_searched_string.clear();
552         }
553         // save option for next search.
554         last_case_sensitive = case_sensitive;
555         last_reg_exp = reg_exp;
556
557         Qt::CaseSensitivity qtcase = case_sensitive ?
558                         Qt::CaseSensitive: Qt::CaseInsensitive;
559         QStringList keys;
560         // If new string (str) contains the last searched one...
561         if (!reset &&
562                 !last_searched_string.isEmpty() &&
563                 str.size() > 1 &&
564                 str.contains(last_searched_string, qtcase))
565                 // ... then only search within already found list.
566                 keys = available_model_.stringList();
567         else
568                 // ... else search all keys.
569                 keys = all_keys_;
570         // save searched string for next search.
571         last_searched_string = str;
572
573         QStringList result;
574         
575         // First, filter by entry_type, which will be faster than 
576         // what follows, so we may get to do that on less.
577         vector<docstring> keyVector = to_docstring_vector(keys);
578         filterByEntryType(bi, keyVector, entry_type);
579         
580         if (str.isEmpty())
581                 result = to_qstring_list(keyVector);
582         else
583                 result = to_qstring_list(searchKeys(bi, keyVector, only_keys, 
584                         qstring_to_ucs4(str), field, case_sensitive, reg_exp));
585         
586         available_model_.setStringList(result);
587 }
588
589
590 QStringList GuiCitation::citationStyles(BiblioInfo const & bi, int sel)
591 {
592         docstring const key = qstring_to_ucs4(cited_keys_[sel]);
593         return to_qstring_list(bi.getCiteStrings(key, buffer()));
594 }
595
596
597 void GuiCitation::setCitedKeys() 
598 {
599         cited_keys_ = selected_model_.stringList();
600 }
601
602
603 bool GuiCitation::initialiseParams(string const & data)
604 {
605         InsetCommand::string2params("citation", data, params_);
606         CiteEngine const engine = buffer().params().citeEngine();
607         citeStyles_ = citeStyles(engine);
608         init();
609         return true;
610 }
611
612
613 void GuiCitation::clearParams()
614 {
615         params_.clear();
616 }
617
618
619 void GuiCitation::filterByEntryType(BiblioInfo const & bi,
620         vector<docstring> & keyVector, docstring entry_type) 
621 {
622         if (entry_type.empty())
623                 return;
624         
625         vector<docstring>::iterator it = keyVector.begin();
626         vector<docstring>::iterator end = keyVector.end();
627
628         vector<docstring> result;
629         for (; it != end; ++it) {
630                 docstring const key = *it;
631                 BiblioInfo::const_iterator cit = bi.find(key);
632                 if (cit == bi.end())
633                         continue;
634                 if (cit->second.entryType() == entry_type)
635                         result.push_back(key);
636         }
637         keyVector = result;
638 }
639
640
641 CiteEngine GuiCitation::citeEngine() const
642 {
643         return buffer().params().citeEngine();
644 }
645
646
647 // Escape special chars.
648 // All characters are literals except: '.|*?+(){}[]^$\'
649 // These characters are literals when preceded by a "\", which is done here
650 // @todo: This function should be moved to support, and then the test in tests
651 //        should be moved there as well.
652 static docstring escape_special_chars(docstring const & expr)
653 {
654         // Search for all chars '.|*?+(){}[^$]\'
655         // Note that '[' and '\' must be escaped.
656         // This is a limitation of boost::regex, but all other chars in BREs
657         // are assumed literal.
658         static const boost::regex reg("[].|*?+(){}^$\\[\\\\]");
659
660         // $& is a perl-like expression that expands to all
661         // of the current match
662         // The '$' must be prefixed with the escape character '\' for
663         // boost to treat it as a literal.
664         // Thus, to prefix a matched expression with '\', we use:
665         // FIXME: UNICODE
666         return from_utf8(boost::regex_replace(to_utf8(expr), reg, "\\\\$&"));
667 }
668
669
670 vector<docstring> GuiCitation::searchKeys(BiblioInfo const & bi,        
671         vector<docstring> const & keys_to_search, bool only_keys,
672         docstring const & search_expression, docstring field,
673         bool case_sensitive, bool regex)
674 {
675         vector<docstring> foundKeys;
676
677         docstring expr = trim(search_expression);
678         if (expr.empty())
679                 return foundKeys;
680
681         if (!regex)
682                 // We must escape special chars in the search_expr so that
683                 // it is treated as a simple string by boost::regex.
684                 expr = escape_special_chars(expr);
685
686         boost::regex reg_exp;
687         try {
688                 reg_exp.assign(to_utf8(expr), case_sensitive ?
689                         boost::regex_constants::normal : boost::regex_constants::icase);
690         } catch (boost::regex_error & e) {
691                 // boost::regex throws an exception if the regular expression is not
692                 // valid.
693                 LYXERR(Debug::GUI, e.what());
694                 return vector<docstring>();
695         }
696
697         vector<docstring>::const_iterator it = keys_to_search.begin();
698         vector<docstring>::const_iterator end = keys_to_search.end();
699         for (; it != end; ++it ) {
700                 BiblioInfo::const_iterator info = bi.find(*it);
701                 if (info == bi.end())
702                         continue;
703                 
704                 BibTeXInfo const & kvm = info->second;
705                 string data;
706                 if (only_keys)
707                         data = to_utf8(*it);
708                 else if (field.empty())
709                         data = to_utf8(*it) + ' ' + to_utf8(kvm.allData());
710                 else 
711                         data = to_utf8(kvm[field]);
712                 
713                 if (data.empty())
714                         continue;
715
716                 try {
717                         if (boost::regex_search(data, reg_exp))
718                                 foundKeys.push_back(*it);
719                 }
720                 catch (boost::regex_error & e) {
721                         LYXERR(Debug::GUI, e.what());
722                         return vector<docstring>();
723                 }
724         }
725         return foundKeys;
726 }
727
728
729 void GuiCitation::dispatchParams()
730 {
731         std::string const lfun = InsetCommand::params2string("citation", params_);
732         dispatch(FuncRequest(getLfun(), lfun));
733 }
734
735
736 BiblioInfo const & GuiCitation::bibInfo() const
737 {
738         buffer().checkBibInfoCache();
739         return buffer().masterBibInfo();
740 }
741
742
743 void GuiCitation::saveSession() const
744 {
745         Dialog::saveSession();
746         QSettings settings;
747         settings.setValue(
748                 sessionKey() + "/regex", regexCB->isChecked());
749         settings.setValue(
750                 sessionKey() + "/casesensitive", caseCB->isChecked());
751         settings.setValue(
752                 sessionKey() + "/autofind", asTypeCB->isChecked());
753 }
754
755
756 void GuiCitation::restoreSession()
757 {
758         Dialog::restoreSession();
759         QSettings settings;
760         regexCB->setChecked(
761                 settings.value(sessionKey() + "/regex").toBool());
762         caseCB->setChecked(
763                 settings.value(sessionKey() + "/casesensitive").toBool());
764         asTypeCB->setChecked(
765                 settings.value(sessionKey() + "/autofind").toBool());
766 }
767
768
769 Dialog * createGuiCitation(GuiView & lv) { return new GuiCitation(lv); }
770
771
772 } // namespace frontend
773 } // namespace lyx
774
775 #include "moc_GuiCitation.cpp"
776