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