]> git.lyx.org Git - features.git/blob - src/lyxfind.cpp
FindAdv: Allow regex searches at start of paragraph
[features.git] / src / lyxfind.cpp
1 /**
2  * \file lyxfind.cpp
3  * This file is part of LyX, the document processor.
4  * License details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author John Levon
8  * \author Jürgen Vigna
9  * \author Alfredo Braunstein
10  * \author Tommaso Cucinotta
11  * \author Kornel Benko
12  *
13  * Full author contact details are available in file CREDITS.
14  */
15
16 #include <config.h>
17
18 #include "lyxfind.h"
19
20 #include "Buffer.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "BufferView.h"
24 #include "Changes.h"
25 #include "Cursor.h"
26 #include "CutAndPaste.h"
27 #include "FuncRequest.h"
28 #include "LyX.h"
29 #include "output_latex.h"
30 #include "OutputParams.h"
31 #include "Paragraph.h"
32 #include "Text.h"
33 #include "Encoding.h"
34
35 #include "frontends/Application.h"
36 #include "frontends/alert.h"
37
38 #include "mathed/InsetMath.h"
39 #include "mathed/InsetMathHull.h"
40 #include "mathed/MathData.h"
41 #include "mathed/MathStream.h"
42 #include "mathed/MathSupport.h"
43
44 #include "support/debug.h"
45 #include "support/docstream.h"
46 #include "support/FileName.h"
47 #include "support/gettext.h"
48 #include "support/lassert.h"
49 #include "support/lstrings.h"
50 #include "support/textutils.h"
51
52 #include <map>
53 #include <regex>
54
55 //#define ResultsDebug
56 #define USE_QT_FOR_SEARCH
57 #if defined(USE_QT_FOR_SEARCH)
58         #include <QtCore>       // sets QT_VERSION
59         #if (QT_VERSION >= 0x050000)
60                 #include <QRegularExpression>
61                 #define QTSEARCH 1
62         #else
63                 #define QTSEARCH 0
64         #endif
65 #else
66         #define QTSEARCH 0
67 #endif
68
69 using namespace std;
70 using namespace lyx::support;
71
72 namespace lyx {
73
74
75 // Helper class for deciding what should be ignored
76 class IgnoreFormats {
77  public:
78         ///
79         IgnoreFormats() = default;
80         ///
81         bool getFamily() const { return ignoreFamily_; }
82         ///
83         bool getSeries() const { return ignoreSeries_; }
84         ///
85         bool getShape() const { return ignoreShape_; }
86         ///
87         bool getUnderline() const { return ignoreUnderline_; }
88         ///
89         bool getMarkUp() const { return ignoreMarkUp_; }
90         ///
91         bool getStrikeOut() const { return ignoreStrikeOut_; }
92         ///
93         bool getSectioning() const { return ignoreSectioning_; }
94         ///
95         bool getFrontMatter() const { return ignoreFrontMatter_; }
96         ///
97         bool getColor() const { return ignoreColor_; }
98         ///
99         bool getLanguage() const { return ignoreLanguage_; }
100         ///
101         void setIgnoreFormat(string const & type, bool value);
102
103 private:
104         ///
105         bool ignoreFamily_ = false;
106         ///
107         bool ignoreSeries_ = false;
108         ///
109         bool ignoreShape_ = false;
110         ///
111         bool ignoreUnderline_ = false;
112         ///
113         bool ignoreMarkUp_ = false;
114         ///
115         bool ignoreStrikeOut_ = false;
116         ///
117         bool ignoreSectioning_ = false;
118         ///
119         bool ignoreFrontMatter_ = false;
120         ///
121         bool ignoreColor_ = false;
122         ///
123         bool ignoreLanguage_ = false;
124 };
125
126
127 void IgnoreFormats::setIgnoreFormat(string const & type, bool value)
128 {
129         if (type == "color") {
130                 ignoreColor_ = value;
131         }
132         else if (type == "language") {
133                 ignoreLanguage_ = value;
134         }
135         else if (type == "sectioning") {
136                 ignoreSectioning_ = value;
137                 ignoreFrontMatter_ = value;
138         }
139         else if (type == "font") {
140                 ignoreSeries_ = value;
141                 ignoreShape_ = value;
142                 ignoreFamily_ = value;
143         }
144         else if (type == "series") {
145                 ignoreSeries_ = value;
146         }
147         else if (type == "shape") {
148                 ignoreShape_ = value;
149         }
150         else if (type == "family") {
151                 ignoreFamily_ = value;
152         }
153         else if (type == "markup") {
154                 ignoreMarkUp_ = value;
155         }
156         else if (type == "underline") {
157                 ignoreUnderline_ = value;
158         }
159         else if (type == "strike") {
160                 ignoreStrikeOut_ = value;
161         }
162 }
163
164 // The global variable that can be changed from outside
165 IgnoreFormats ignoreFormats;
166
167
168 void setIgnoreFormat(string const & type, bool value)
169 {
170   ignoreFormats.setIgnoreFormat(type, value);
171 }
172
173
174 namespace {
175
176 bool parse_bool(docstring & howto)
177 {
178         if (howto.empty())
179                 return false;
180         docstring var;
181         howto = split(howto, var, ' ');
182         return var == "1";
183 }
184
185
186 class MatchString
187 {
188 public:
189         MatchString(docstring const & s, bool cs, bool mw)
190                 : str(s), case_sens(cs), whole_words(mw)
191         {}
192
193         // returns true if the specified string is at the specified position
194         // del specifies whether deleted strings in ct mode will be considered
195         int operator()(Paragraph const & par, pos_type pos, bool del = true) const
196         {
197                 return par.find(str, case_sens, whole_words, pos, del);
198         }
199
200 private:
201         // search string
202         docstring str;
203         // case sensitive
204         bool case_sens;
205         // match whole words only
206         bool whole_words;
207 };
208
209
210 int findForward(DocIterator & cur, MatchString const & match,
211                 bool find_del = true)
212 {
213         for (; cur; cur.forwardChar())
214                 if (cur.inTexted()) {
215                         int len = match(cur.paragraph(), cur.pos(), find_del);
216                         if (len > 0)
217                                 return len;
218                 }
219         return 0;
220 }
221
222
223 int findBackwards(DocIterator & cur, MatchString const & match,
224                   bool find_del = true)
225 {
226         while (cur) {
227                 cur.backwardChar();
228                 if (cur.inTexted()) {
229                         int len = match(cur.paragraph(), cur.pos(), find_del);
230                         if (len > 0)
231                                 return len;
232                 }
233         }
234         return 0;
235 }
236
237
238 bool searchAllowed(docstring const & str)
239 {
240         if (str.empty()) {
241                 frontend::Alert::error(_("Search error"), _("Search string is empty"));
242                 return false;
243         }
244         return true;
245 }
246
247
248 bool findOne(BufferView * bv, docstring const & searchstr,
249              bool case_sens, bool whole, bool forward,
250              bool find_del = true, bool check_wrap = false)
251 {
252         if (!searchAllowed(searchstr))
253                 return false;
254
255         DocIterator cur = forward
256                 ? bv->cursor().selectionEnd()
257                 : bv->cursor().selectionBegin();
258
259         MatchString const match(searchstr, case_sens, whole);
260
261         int match_len = forward
262                 ? findForward(cur, match, find_del)
263                 : findBackwards(cur, match, find_del);
264
265         if (match_len > 0)
266                 bv->putSelectionAt(cur, match_len, !forward);
267         else if (check_wrap) {
268                 DocIterator cur_orig(bv->cursor());
269                 docstring q;
270                 if (forward)
271                         q = _("End of file reached while searching forward.\n"
272                           "Continue searching from the beginning?");
273                 else
274                         q = _("Beginning of file reached while searching backward.\n"
275                           "Continue searching from the end?");
276                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
277                         q, 0, 1, _("&Yes"), _("&No"));
278                 if (wrap_answer == 0) {
279                         if (forward) {
280                                 bv->cursor().clear();
281                                 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
282                         } else {
283                                 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
284                                 bv->cursor().backwardPos();
285                         }
286                         bv->clearSelection();
287                         if (findOne(bv, searchstr, case_sens, whole, forward, find_del, false))
288                                 return true;
289                 }
290                 bv->cursor().setCursor(cur_orig);
291                 return false;
292         }
293
294         return match_len > 0;
295 }
296
297
298 int replaceAll(BufferView * bv,
299                docstring const & searchstr, docstring const & replacestr,
300                bool case_sens, bool whole)
301 {
302         Buffer & buf = bv->buffer();
303
304         if (!searchAllowed(searchstr) || buf.isReadonly())
305                 return 0;
306
307         DocIterator cur_orig(bv->cursor());
308
309         MatchString const match(searchstr, case_sens, whole);
310         int num = 0;
311
312         int const rsize = replacestr.size();
313         int const ssize = searchstr.size();
314
315         Cursor cur(*bv);
316         cur.setCursor(doc_iterator_begin(&buf));
317         int match_len = findForward(cur, match, false);
318         while (match_len > 0) {
319                 // Backup current cursor position and font.
320                 pos_type const pos = cur.pos();
321                 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
322                 cur.recordUndo();
323                 int striked = ssize -
324                         cur.paragraph().eraseChars(pos, pos + match_len,
325                                                    buf.params().track_changes);
326                 cur.paragraph().insert(pos, replacestr, font,
327                                        Change(buf.params().track_changes
328                                               ? Change::INSERTED
329                                               : Change::UNCHANGED));
330                 for (int i = 0; i < rsize + striked; ++i)
331                         cur.forwardChar();
332                 ++num;
333                 match_len = findForward(cur, match, false);
334         }
335
336         bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
337
338         cur_orig.fixIfBroken();
339         bv->setCursor(cur_orig);
340
341         return num;
342 }
343
344
345 // the idea here is that we are going to replace the string that
346 // is selected IF it is the search string.
347 // if there is a selection, but it is not the search string, then
348 // we basically ignore it. (FIXME We ought to replace only within
349 // the selection.)
350 // if there is no selection, then:
351 //  (i) if some search string has been provided, then we find it.
352 //      (think of how the dialog works when you hit "replace" the
353 //      first time.)
354 // (ii) if no search string has been provided, then we treat the
355 //      word the cursor is in as the search string. (why? i have no
356 //      idea.) but this only works in text?
357 //
358 // returns the number of replacements made (one, if any) and
359 // whether anything at all was done.
360 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
361                            docstring const & replacestr, bool case_sens,
362                            bool whole, bool forward, bool findnext)
363 {
364         Cursor & cur = bv->cursor();
365         if (!cur.selection()) {
366                 // no selection, non-empty search string: find it
367                 if (!searchstr.empty()) {
368                         bool const found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
369                         return make_pair(found, 0);
370                 }
371                 // empty search string
372                 if (!cur.inTexted())
373                         // bail in math
374                         return make_pair(false, 0);
375                 // select current word and treat it as the search string.
376                 // This causes a minor bug as undo will restore this selection,
377                 // which the user did not create (#8986).
378                 cur.innerText()->selectWord(cur, WHOLE_WORD);
379                 searchstr = cur.selectionAsString(false);
380         }
381
382         // if we still don't have a search string, report the error
383         // and abort.
384         if (!searchAllowed(searchstr))
385                 return make_pair(false, 0);
386
387         bool have_selection = cur.selection();
388         docstring const selected = cur.selectionAsString(false);
389         bool match =
390                 case_sens
391                 ? searchstr == selected
392                 : compare_no_case(searchstr, selected) == 0;
393
394         // no selection or current selection is not search word:
395         // just find the search word
396         if (!have_selection || !match) {
397                 bool const found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
398                 return make_pair(found, 0);
399         }
400
401         // we're now actually ready to replace. if the buffer is
402         // read-only, we can't, though.
403         if (bv->buffer().isReadonly())
404                 return make_pair(false, 0);
405
406         cap::replaceSelectionWithString(cur, replacestr);
407         if (forward) {
408                 cur.pos() += replacestr.length();
409                 LASSERT(cur.pos() <= cur.lastpos(),
410                         cur.pos() = cur.lastpos());
411         }
412         if (findnext)
413                 findOne(bv, searchstr, case_sens, whole, forward, false, findnext);
414
415         return make_pair(true, 1);
416 }
417
418 } // namespace
419
420
421 docstring const find2string(docstring const & search,
422                             bool casesensitive, bool matchword, bool forward)
423 {
424         odocstringstream ss;
425         ss << search << '\n'
426            << int(casesensitive) << ' '
427            << int(matchword) << ' '
428            << int(forward);
429         return ss.str();
430 }
431
432
433 docstring const replace2string(docstring const & replace,
434                                docstring const & search,
435                                bool casesensitive, bool matchword,
436                                bool all, bool forward, bool findnext)
437 {
438         odocstringstream ss;
439         ss << replace << '\n'
440            << search << '\n'
441            << int(casesensitive) << ' '
442            << int(matchword) << ' '
443            << int(all) << ' '
444            << int(forward) << ' '
445            << int(findnext);
446         return ss.str();
447 }
448
449
450 bool lyxfind(BufferView * bv, FuncRequest const & ev)
451 {
452         if (!bv || ev.action() != LFUN_WORD_FIND)
453                 return false;
454
455         //lyxerr << "find called, cmd: " << ev << endl;
456
457         // data is of the form
458         // "<search>
459         //  <casesensitive> <matchword> <forward>"
460         docstring search;
461         docstring howto = split(ev.argument(), search, '\n');
462
463         bool casesensitive = parse_bool(howto);
464         bool matchword     = parse_bool(howto);
465         bool forward       = parse_bool(howto);
466
467         return findOne(bv, search, casesensitive, matchword, forward, true, true);
468 }
469
470
471 bool lyxreplace(BufferView * bv,
472                 FuncRequest const & ev, bool has_deleted)
473 {
474         if (!bv || ev.action() != LFUN_WORD_REPLACE)
475                 return false;
476
477         // data is of the form
478         // "<search>
479         //  <replace>
480         //  <casesensitive> <matchword> <all> <forward> <findnext>"
481         docstring search;
482         docstring rplc;
483         docstring howto = split(ev.argument(), rplc, '\n');
484         howto = split(howto, search, '\n');
485
486         bool casesensitive = parse_bool(howto);
487         bool matchword     = parse_bool(howto);
488         bool all           = parse_bool(howto);
489         bool forward       = parse_bool(howto);
490         bool findnext      = howto.empty() ? true : parse_bool(howto);
491
492         bool update = false;
493
494         if (!has_deleted) {
495                 int replace_count = 0;
496                 if (all) {
497                         replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
498                         update = replace_count > 0;
499                 } else {
500                         pair<bool, int> rv =
501                                 replaceOne(bv, search, rplc, casesensitive, matchword, forward, findnext);
502                         update = rv.first;
503                         replace_count = rv.second;
504                 }
505
506                 Buffer const & buf = bv->buffer();
507                 if (!update) {
508                         // emit message signal.
509                         buf.message(_("String not found."));
510                 } else {
511                         if (replace_count == 0) {
512                                 buf.message(_("String found."));
513                         } else if (replace_count == 1) {
514                                 buf.message(_("String has been replaced."));
515                         } else {
516                                 docstring const str =
517                                         bformat(_("%1$d strings have been replaced."), replace_count);
518                                 buf.message(str);
519                         }
520                 }
521         } else if (findnext) {
522                 // if we have deleted characters, we do not replace at all, but
523                 // rather search for the next occurence
524                 if (findOne(bv, search, casesensitive, matchword, forward, true, findnext))
525                         update = true;
526                 else
527                         bv->message(_("String not found."));
528         }
529         return update;
530 }
531
532
533 bool findNextChange(BufferView * bv, Cursor & cur, bool const check_wrap)
534 {
535         for (; cur; cur.forwardPos())
536                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
537                         return true;
538
539         if (check_wrap) {
540                 DocIterator cur_orig(bv->cursor());
541                 docstring q = _("End of file reached while searching forward.\n"
542                           "Continue searching from the beginning?");
543                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
544                         q, 0, 1, _("&Yes"), _("&No"));
545                 if (wrap_answer == 0) {
546                         bv->cursor().clear();
547                         bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
548                         bv->clearSelection();
549                         cur.setCursor(bv->cursor().selectionBegin());
550                         if (findNextChange(bv, cur, false))
551                                 return true;
552                 }
553                 bv->cursor().setCursor(cur_orig);
554         }
555
556         return false;
557 }
558
559
560 bool findPreviousChange(BufferView * bv, Cursor & cur, bool const check_wrap)
561 {
562         for (cur.backwardPos(); cur; cur.backwardPos()) {
563                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
564                         return true;
565         }
566
567         if (check_wrap) {
568                 DocIterator cur_orig(bv->cursor());
569                 docstring q = _("Beginning of file reached while searching backward.\n"
570                           "Continue searching from the end?");
571                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
572                         q, 0, 1, _("&Yes"), _("&No"));
573                 if (wrap_answer == 0) {
574                         bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
575                         bv->cursor().backwardPos();
576                         bv->clearSelection();
577                         cur.setCursor(bv->cursor().selectionBegin());
578                         if (findPreviousChange(bv, cur, false))
579                                 return true;
580                 }
581                 bv->cursor().setCursor(cur_orig);
582         }
583
584         return false;
585 }
586
587
588 bool selectChange(Cursor & cur, bool forward)
589 {
590         if (!cur.inTexted() || !cur.paragraph().isChanged(cur.pos()))
591                 return false;
592         Change ch = cur.paragraph().lookupChange(cur.pos());
593
594         CursorSlice tip1 = cur.top();
595         for (; tip1.pit() < tip1.lastpit() || tip1.pos() < tip1.lastpos(); tip1.forwardPos()) {
596                 Change ch2 = tip1.paragraph().lookupChange(tip1.pos());
597                 if (!ch2.isSimilarTo(ch))
598                         break;
599         }
600         CursorSlice tip2 = cur.top();
601         for (; tip2.pit() > 0 || tip2.pos() > 0;) {
602                 tip2.backwardPos();
603                 Change ch2 = tip2.paragraph().lookupChange(tip2.pos());
604                 if (!ch2.isSimilarTo(ch)) {
605                         // take a step forward to correctly set the selection
606                         tip2.forwardPos();
607                         break;
608                 }
609         }
610         if (forward)
611                 swap(tip1, tip2);
612         cur.top() = tip1;
613         cur.bv().mouseSetCursor(cur, false);
614         cur.top() = tip2;
615         cur.bv().mouseSetCursor(cur, true);
616         return true;
617 }
618
619
620 namespace {
621
622
623 bool findChange(BufferView * bv, bool forward)
624 {
625         Cursor cur(*bv);
626         cur.setCursor(forward ? bv->cursor().selectionEnd()
627                       : bv->cursor().selectionBegin());
628         forward ? findNextChange(bv, cur, true) : findPreviousChange(bv, cur, true);
629         return selectChange(cur, forward);
630 }
631
632 } // namespace
633
634 bool findNextChange(BufferView * bv)
635 {
636         return findChange(bv, true);
637 }
638
639
640 bool findPreviousChange(BufferView * bv)
641 {
642         return findChange(bv, false);
643 }
644
645
646
647 namespace {
648
649 typedef vector<pair<string, string> > Escapes;
650
651 /// A map of symbols and their escaped equivalent needed within a regex.
652 /// @note Beware of order
653 Escapes const & get_regexp_escapes()
654 {
655         typedef std::pair<std::string, std::string> P;
656
657         static Escapes escape_map;
658         if (escape_map.empty()) {
659                 escape_map.push_back(P("$", "_x_$"));
660                 escape_map.push_back(P("{", "_x_{"));
661                 escape_map.push_back(P("}", "_x_}"));
662                 escape_map.push_back(P("[", "_x_["));
663                 escape_map.push_back(P("]", "_x_]"));
664                 escape_map.push_back(P("(", "_x_("));
665                 escape_map.push_back(P(")", "_x_)"));
666                 escape_map.push_back(P("+", "_x_+"));
667                 escape_map.push_back(P("*", "_x_*"));
668                 escape_map.push_back(P(".", "_x_."));
669                 escape_map.push_back(P("\\", "(?:\\\\|\\\\backslash)"));
670                 escape_map.push_back(P("~", "(?:\\\\textasciitilde|\\\\sim)"));
671                 escape_map.push_back(P("^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
672                 escape_map.push_back(P("_x_", "\\"));
673         }
674         return escape_map;
675 }
676
677 /// A map of lyx escaped strings and their unescaped equivalent.
678 Escapes const & get_lyx_unescapes()
679 {
680         typedef std::pair<std::string, std::string> P;
681
682         static Escapes escape_map;
683         if (escape_map.empty()) {
684                 escape_map.push_back(P("\\%", "%"));
685                 escape_map.push_back(P("\\{", "{"));
686                 escape_map.push_back(P("\\}", "}"));
687                 escape_map.push_back(P("\\mathcircumflex ", "^"));
688                 escape_map.push_back(P("\\mathcircumflex", "^"));
689                 escape_map.push_back(P("\\backslash ", "\\"));
690                 escape_map.push_back(P("\\backslash", "\\"));
691                 escape_map.push_back(P("\\sim ", "~"));
692                 escape_map.push_back(P("\\sim", "~"));
693         }
694         return escape_map;
695 }
696
697 /// A map of escapes turning a regexp matching text to one matching latex.
698 Escapes const & get_regexp_latex_escapes()
699 {
700         typedef std::pair<std::string, std::string> P;
701
702         static Escapes escape_map;
703         if (escape_map.empty()) {
704                 escape_map.push_back(P("\\\\", "(?:\\\\\\\\|\\\\backslash|\\\\textbackslash\\{\\}|\\\\textbackslash)"));
705                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash)\\{", "\\\\\\{"));
706                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash\\\\\\{)\\}", "\\\\\\}"));
707                 escape_map.push_back(P("\\[", "\\{\\[\\}"));
708                 escape_map.push_back(P("\\]", "\\{\\]\\}"));
709                 escape_map.push_back(P("\\^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
710                 escape_map.push_back(P("%", "\\\\\\%"));
711                 escape_map.push_back(P("#", "\\\\#"));
712         }
713         return escape_map;
714 }
715
716 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
717  ** the found occurrence were escaped.
718  **/
719 string apply_escapes(string s, Escapes const & escape_map)
720 {
721         LYXERR(Debug::FIND, "Escaping: '" << s << "'");
722         Escapes::const_iterator it;
723         for (it = escape_map.begin(); it != escape_map.end(); ++it) {
724 //              LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
725                 unsigned int pos = 0;
726                 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
727                         s.replace(pos, it->first.length(), it->second);
728                         LYXERR(Debug::FIND, "After escape: " << s);
729                         pos += it->second.length();
730 //                      LYXERR(Debug::FIND, "pos: " << pos);
731                 }
732         }
733         LYXERR(Debug::FIND, "Escaped : '" << s << "'");
734         return s;
735 }
736
737
738 /// Within \regexp{} apply get_lyx_unescapes() only (i.e., preserve regexp semantics of the string),
739 /// while outside apply get_lyx_unescapes()+get_regexp_escapes().
740 /// If match_latex is true, then apply regexp_latex_escapes() to \regexp{} contents as well.
741 string escape_for_regex(string s, bool match_latex)
742 {
743         size_t pos = 0;
744         while (pos < s.size()) {
745                 size_t new_pos = s.find("\\regexp{", pos);
746                 if (new_pos == string::npos)
747                         new_pos = s.size();
748                 string t;
749                 if (new_pos > pos) {
750                         // outside regexp
751                         LYXERR(Debug::FIND, "new_pos: " << new_pos);
752                         t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
753                         LYXERR(Debug::FIND, "t [lyx]: " << t);
754                         t = apply_escapes(t, get_regexp_escapes());
755                         LYXERR(Debug::FIND, "t [rxp]: " << t);
756                         s.replace(pos, new_pos - pos, t);
757                         new_pos = pos + t.size();
758                         LYXERR(Debug::FIND, "Regexp after escaping: " << s);
759                         LYXERR(Debug::FIND, "new_pos: " << new_pos);
760                         if (new_pos == s.size())
761                                 break;
762                 }
763                 // Might fail if \\endregexp{} is preceeded by unexpected stuff (weird escapes)
764                 size_t end_pos = s.find("\\endregexp{}}", new_pos + 8);
765                 LYXERR(Debug::FIND, "end_pos: " << end_pos);
766                 t = s.substr(new_pos + 8, end_pos - (new_pos + 8));
767                 LYXERR(Debug::FIND, "t in regexp      : " << t);
768                 t = apply_escapes(t, get_lyx_unescapes());
769                 LYXERR(Debug::FIND, "t in regexp after unescapes [lyx]: " << t);
770                 if (match_latex) {
771                         t = apply_escapes(t, get_regexp_latex_escapes());
772                         LYXERR(Debug::FIND, "t in regexp after latex_escapes [ltx]: " << t);
773                 }
774                 if (end_pos == s.size()) {
775                         s.replace(new_pos, end_pos - new_pos, t);
776                         LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
777                         break;
778                 }
779                 s.replace(new_pos, end_pos + 13 - new_pos, t);
780                 LYXERR(Debug::FIND, "Regexp after \\regexp{...\\endregexp{}} removal: " << s);
781                 pos = new_pos + t.size();
782                 LYXERR(Debug::FIND, "pos: " << pos);
783         }
784         return s;
785 }
786
787
788 /// Wrapper for lyx::regex_replace with simpler interface
789 bool regex_replace(string const & s, string & t, string const & searchstr,
790                    string const & replacestr)
791 {
792         regex e(searchstr, regex_constants::ECMAScript);
793         ostringstream oss;
794         ostream_iterator<char, char> it(oss);
795         regex_replace(it, s.begin(), s.end(), e, replacestr);
796         // tolerate t and s be references to the same variable
797         bool rv = (s != oss.str());
798         t = oss.str();
799         return rv;
800 }
801
802 #if 0
803 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
804  **
805  ** Verify that closed braces exactly match open braces. This avoids that, for example,
806  ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
807  **
808  ** @param unmatched
809  ** Number of open braces that must remain open at the end for the verification to succeed.
810  **/
811 #if QTSEARCH
812 bool braces_match(QString const & beg,
813                   int unmatched = 0)
814 #else
815 bool braces_match(string const & beg,
816                 int unmatched = 0)
817 #endif
818 {
819         int open_pars = 0;
820 #if QTSEARCH
821         LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << beg.toStdString() << "'");
822 #else
823         LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << beg << "'");
824 #endif
825         int lastidx = beg.size();
826         for (int i=0; i < lastidx; ++i) {
827                 // Skip escaped braces in the count
828 #if QTSEARCH
829                 QChar c = beg.at(i);
830 #else
831                 char c = beg.at(i);
832 #endif
833                 if (c == '\\') {
834                         ++i;
835                         if (i >= lastidx)
836                                 break;
837                 } else if (c == '{') {
838                         ++open_pars;
839                 } else if (c == '}') {
840                         if (open_pars == 0) {
841                                 LYXERR(Debug::FIND, "Found unmatched closed brace");
842                                 return false;
843                         } else
844                                 --open_pars;
845                 }
846         }
847         if (open_pars != unmatched) {
848                 LYXERR(Debug::FIND, "Found " << open_pars
849                        << " instead of " << unmatched
850                        << " unmatched open braces at the end of count");
851                 return false;
852         }
853         LYXERR(Debug::FIND, "Braces match as expected");
854         return true;
855 }
856 #endif
857
858 class MatchResult {
859 public:
860         enum range {
861                 newIsTooFar,
862                 newIsBetter,
863                 newIsInvalid
864         };
865         int match_len;
866         int match_prefix;
867         int match2end;
868         int pos;
869         int leadsize;
870         int pos_len;
871         vector <string> result = vector <string>();
872         MatchResult(int len = 0): match_len(len),match_prefix(0),match2end(0), pos(0),leadsize(0),pos_len(-1) {};
873 };
874
875 static MatchResult::range interpretMatch(MatchResult &oldres, MatchResult &newres)
876 {
877   int range = oldres.match_len;
878   if (range < 2) range = 2;
879   if (newres.match2end < oldres.match2end - oldres.match_len)
880     return MatchResult::newIsTooFar;
881   if (newres.match_len < oldres.match_len)
882     return MatchResult::newIsTooFar;
883   if ((newres.match_len == oldres.match_len) &&
884       (newres.match2end < oldres.match2end + range) &&
885       (newres.match2end > oldres.match2end - range)) {
886     return MatchResult::newIsBetter;
887   }
888   return MatchResult::newIsInvalid;
889 }
890
891 /** The class performing a match between a position in the document and the FindAdvOptions.
892  **/
893
894 class MatchStringAdv {
895 public:
896         MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions & opt);
897
898         /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
899          ** constructor as opt.search, under the opt.* options settings.
900          **
901          ** @param at_begin
902          **     If set, then match is searched only against beginning of text starting at cur.
903          **     If unset, then match is searched anywhere in text starting at cur.
904          **
905          ** @return
906          ** The length of the matching text, or zero if no match was found.
907          **/
908         MatchResult operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
909 #if QTSEARCH
910         bool regexIsValid;
911         string regexError;
912 #endif
913
914 public:
915         /// buffer
916         lyx::Buffer * p_buf;
917         /// first buffer on which search was started
918         lyx::Buffer * const p_first_buf;
919         /// options
920         FindAndReplaceOptions const & opt;
921
922 private:
923         /// Auxiliary find method (does not account for opt.matchword)
924         MatchResult findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
925         void CreateRegexp(FindAndReplaceOptions const & opt, string regexp_str, string regexp2_str, string par_as_string = "");
926
927         /** Normalize a stringified or latexified LyX paragraph.
928          **
929          ** Normalize means:
930          ** <ul>
931          **   <li>if search is not casesensitive, then lowercase the string;
932          **   <li>remove any newline at begin or end of the string;
933          **   <li>replace any newline in the middle of the string with a simple space;
934          **   <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
935          ** </ul>
936          **
937          ** @todo Normalization should also expand macros, if the corresponding
938          ** search option was checked.
939          **/
940         string normalize(docstring const & s) const;
941         // normalized string to search
942         string par_as_string;
943         // regular expression to use for searching
944         // regexp2 is same as regexp, but prefixed with a ".*?"
945 #if QTSEARCH
946         QRegularExpression regexp;
947         QRegularExpression regexp2;
948 #else
949         regex regexp;
950         regex regexp2;
951 #endif
952         // leading format material as string
953         string lead_as_string;
954         // par_as_string after removal of lead_as_string
955         string par_as_string_nolead;
956         // unmatched open braces in the search string/regexp
957         int open_braces;
958         // number of (.*?) subexpressions added at end of search regexp for closing
959         // environments, math mode, styles, etc...
960         int close_wildcards;
961 public:
962         // Are we searching with regular expressions ?
963         bool use_regexp;
964         static int valid_matches;
965         static vector <string> matches;
966         void FillResults(MatchResult &found_mr);
967 };
968
969 int MatchStringAdv::valid_matches = 0;
970 vector <string> MatchStringAdv::matches = vector <string>(10);
971
972 void MatchStringAdv::FillResults(MatchResult &found_mr)
973 {
974   if (found_mr.match_len > 0) {
975     valid_matches = found_mr.result.size();
976     for (size_t i = 0; i < found_mr.result.size(); i++)
977       matches[i] = found_mr.result[i];
978   }
979   else
980     valid_matches = 0;
981 }
982
983 static docstring buffer_to_latex(Buffer & buffer)
984 {
985         //OutputParams runparams(&buffer.params().encoding());
986         OutputParams runparams(encodings.fromLyXName("utf8"));
987         odocstringstream ods;
988         otexstream os(ods);
989         runparams.nice = true;
990         runparams.flavor = Flavor::XeTeX;
991         runparams.linelen = 10000; //lyxrc.plaintext_linelen;
992         // No side effect of file copying and image conversion
993         runparams.dryrun = true;
994         runparams.for_search = true;
995         pit_type const endpit = buffer.paragraphs().size();
996         for (pit_type pit = 0; pit != endpit; ++pit) {
997                 TeXOnePar(buffer, buffer.text(), pit, os, runparams);
998                 LYXERR(Debug::FIND, "searchString up to here: " << ods.str());
999         }
1000         return ods.str();
1001 }
1002
1003
1004 static docstring stringifySearchBuffer(Buffer & buffer, FindAndReplaceOptions const & opt)
1005 {
1006         docstring str;
1007         if (!opt.ignoreformat) {
1008                 str = buffer_to_latex(buffer);
1009         } else {
1010                 // OutputParams runparams(&buffer.params().encoding());
1011                 OutputParams runparams(encodings.fromLyXName("utf8"));
1012                 runparams.nice = true;
1013                 runparams.flavor = Flavor::XeTeX;
1014                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
1015                 runparams.dryrun = true;
1016                 runparams.for_search = true;
1017                 for (pos_type pit = pos_type(0); pit < (pos_type)buffer.paragraphs().size(); ++pit) {
1018                         Paragraph const & par = buffer.paragraphs().at(pit);
1019                         LYXERR(Debug::FIND, "Adding to search string: '"
1020                                << par.asString(pos_type(0), par.size(),
1021                                                AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
1022                                                &runparams)
1023                                << "'");
1024                         str += par.asString(pos_type(0), par.size(),
1025                                             AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
1026                                             &runparams);
1027                 }
1028                 // Even in ignore-format we have to remove "\text{}, \lyxmathsym{}" parts
1029                 string t = to_utf8(str);
1030                 while (regex_replace(t, t, "\\\\(text|lyxmathsym)\\{([^\\}]*)\\}", "$2"));
1031                 str = from_utf8(t);
1032         }
1033         return str;
1034 }
1035
1036
1037 /// Return separation pos between the leading material and the rest
1038 static size_t identifyLeading(string const & s)
1039 {
1040         string t = s;
1041         // @TODO Support \item[text]
1042         // Kornel: Added textsl, textsf, textit, texttt and noun
1043         // + allow to search for colored text too
1044         while (regex_replace(t, t, "^\\\\(("
1045                              "(author|title|subtitle|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|"
1046                                "lyxaddress|lyxrightaddress|"
1047                                "footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|"
1048                                "emph|noun|minisec|text(bf|md|sl|sf|it|tt))|"
1049                              "((textcolor|foreignlanguage|latexenvironment)\\{[a-z]+\\*?\\})|"
1050                              "(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)\\{", "")
1051                || regex_replace(t, t, "^\\$", "")
1052                || regex_replace(t, t, "^\\\\\\[", "")
1053                || regex_replace(t, t, "^ ?\\\\item\\{[a-z]+\\}", "")
1054                || regex_replace(t, t, "^\\\\begin\\{[a-zA-Z_]*\\*?\\}", ""))
1055                ;
1056         LYXERR(Debug::FIND, "  after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
1057         return s.find(t);
1058 }
1059
1060 /*
1061  * Given a latexified string, retrieve some handled features
1062  * The features of the regex will later be compared with the features
1063  * of the searched text. If the regex features are not a
1064  * subset of the analized, then, in not format ignoring search
1065  * we can early stop the search in the relevant inset.
1066  */
1067 typedef map<string, bool> Features;
1068
1069 static Features identifyFeatures(string const & s)
1070 {
1071         static regex const feature("\\\\(([a-zA-Z]+(\\{([a-z]+\\*?)\\}|\\*)?))\\{");
1072         static regex const valid("^("
1073                 "("
1074                         "(footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|"
1075                                 "emph|noun|text(bf|md|sl|sf|it|tt)|"
1076                                 "(textcolor|foreignlanguage|item|listitem|latexenvironment)\\{[a-z]+\\*?\\})|"
1077                         "(u|uu)line|(s|x)out|uwave|"
1078                         "(sub|extra)?title|author|subject|publishers|dedication|(upper|lower)titleback|lyx(right)?address)|"
1079                 "((sub)?(((sub)?section)|paragraph)|part|chapter|lyxslide)\\*?)$");
1080         smatch sub;
1081         bool displ = true;
1082         Features info;
1083
1084         for (sregex_iterator it(s.begin(), s.end(), feature), end; it != end; ++it) {
1085                 sub = *it;
1086                 if (displ) {
1087                         if (sub.str(1).compare("regexp") == 0) {
1088                                 displ = false;
1089                                 continue;
1090                         }
1091                         string token = sub.str(1);
1092                         smatch sub2;
1093                         if (regex_match(token, sub2, valid)) {
1094                                 info[token] = true;
1095                         }
1096                         else {
1097                                 // ignore
1098                         }
1099                 }
1100                 else {
1101                         if (sub.str(1).compare("endregexp") == 0) {
1102                                 displ = true;
1103                                 continue;
1104                         }
1105                 }
1106         }
1107         return info;
1108 }
1109
1110 /*
1111  * defines values features of a key "\\[a-z]+{"
1112  */
1113 class KeyInfo {
1114  public:
1115   enum KeyType {
1116     /* Char type with content discarded
1117      * like \hspace{1cm} */
1118     noContent,
1119     /* Char, like \backslash */
1120     isChar,
1121     /* replace starting backslash with '#' */
1122     isText,
1123     /* \part, \section*, ... */
1124     isSectioning,
1125     /* title, author etc */
1126     isTitle,
1127     /* \foreignlanguage{ngerman}, ... */
1128     isMain,
1129     /* inside \code{}
1130      * to discard language in content */
1131     noMain,
1132     isRegex,
1133     /* \begin{eqnarray}...\end{eqnarray}, ... $...$ */
1134     isMath,
1135     /* fonts, colors, markups, ... */
1136     isStandard,
1137     /* footnotesize, ... large, ...
1138      * Ignore all of them */
1139     isSize,
1140     invalid,
1141     /* inputencoding, ...
1142      * Discard also content, because they do not help in search */
1143     doRemove,
1144     /* twocolumns, ...
1145      * like remove, but also all arguments */
1146     removeWithArg,
1147     /* item, listitem */
1148     isList,
1149     /* tex, latex, ... like isChar */
1150     isIgnored,
1151     /* like \lettrine[lines=5]{}{} */
1152     cleanToStart,
1153     // like isStandard, but always remove head
1154     headRemove,
1155     /* End of arguments marker for lettrine,
1156      * so that they can be ignored */
1157     endArguments
1158   };
1159  KeyInfo() = default;
1160  KeyInfo(KeyType type, int parcount, bool disable)
1161    : keytype(type),
1162     parenthesiscount(parcount),
1163     disabled(disable) {}
1164   KeyType keytype = invalid;
1165   string head;
1166   int _tokensize = -1;
1167   int _tokenstart = -1;
1168   int _dataStart = -1;
1169   int _dataEnd = -1;
1170   int parenthesiscount = 1;
1171   bool disabled = false;
1172   bool used = false;                    /* by pattern */
1173 };
1174
1175 class Border {
1176  public:
1177  Border(int l=0, int u=0) : low(l), upper(u) {};
1178   int low;
1179   int upper;
1180 };
1181
1182 #define MAXOPENED 30
1183 class Intervall {
1184   bool isPatternString_;
1185 public:
1186   explicit Intervall(bool isPattern, string const & p) :
1187         isPatternString_(isPattern), par(p), ignoreidx(-1), actualdeptindex(0),
1188         hasTitle(false), langcount(0)
1189   {
1190     depts[0] = 0;
1191     closes[0] = 0;
1192   }
1193
1194   string par;
1195   int ignoreidx;
1196   static vector<Border> borders;
1197   int depts[MAXOPENED];
1198   int closes[MAXOPENED];
1199   int actualdeptindex;
1200   int previousNotIgnored(int) const;
1201   int nextNotIgnored(int) const;
1202   void handleOpenP(int i);
1203   void handleCloseP(int i, bool closingAllowed);
1204   void resetOpenedP(int openPos);
1205   void addIntervall(int upper);
1206   void addIntervall(int low, int upper); /* if explicit */
1207   void removeAccents();
1208   void setForDefaultLang(KeyInfo const & defLang) const;
1209   int findclosing(int start, int end, char up, char down, int repeat);
1210   void handleParentheses(int lastpos, bool closingAllowed);
1211   bool hasTitle;
1212   int langcount;        // Number of disabled language specs up to current position in actual interval
1213   int isOpeningPar(int pos) const;
1214   string titleValue;
1215   void output(ostringstream &os, int lastpos);
1216   // string show(int lastpos);
1217 };
1218
1219 vector<Border> Intervall::borders = vector<Border>(30);
1220
1221 int Intervall::isOpeningPar(int pos) const
1222 {
1223   if ((pos < 0) || (size_t(pos) >= par.size()))
1224     return 0;
1225   if (par[pos] != '{')
1226     return 0;
1227   if (size_t(pos) + 2 >= par.size())
1228     return 1;
1229   if (par[pos+2] != '}')
1230     return 1;
1231   if (par[pos+1] == '[' || par[pos+1] == ']')
1232     return 3;
1233   return 1;
1234 }
1235
1236 void Intervall::setForDefaultLang(KeyInfo const & defLang) const
1237 {
1238   // Enable the use of first token again
1239   if (ignoreidx >= 0) {
1240     int value = defLang._tokenstart + defLang._tokensize;
1241     int borderidx = 0;
1242     if (hasTitle) {
1243       borderidx = 1;
1244     }
1245     if (value > 0) {
1246       if (borders[borderidx].low < value)
1247         borders[borderidx].low = value;
1248       if (borders[borderidx].upper < value)
1249         borders[borderidx].upper = value;
1250     }
1251   }
1252 }
1253
1254 static void checkDepthIndex(int val)
1255 {
1256   static int maxdepthidx = MAXOPENED-2;
1257   static int lastmaxdepth = 0;
1258   if (val > lastmaxdepth) {
1259     LYXERR(Debug::INFO, "Depth reached " << val);
1260     lastmaxdepth = val;
1261   }
1262   if (val > maxdepthidx) {
1263     maxdepthidx = val;
1264     LYXERR(Debug::INFO, "maxdepthidx now " << val);
1265   }
1266 }
1267
1268 #if 0
1269 // Not needed, because borders are now dynamically expanded
1270 static void checkIgnoreIdx(int val)
1271 {
1272   static int lastmaxignore = -1;
1273   if ((lastmaxignore < val) && (size_t(val+1) >= borders.size())) {
1274     LYXERR(Debug::INFO, "IgnoreIdx reached " << val);
1275     lastmaxignore = val;
1276   }
1277 }
1278 #endif
1279
1280 /*
1281  * Expand the region of ignored parts of the input latex string
1282  * The region is only relevant in output()
1283  */
1284 void Intervall::addIntervall(int low, int upper)
1285 {
1286   int idx;
1287   if (low == upper) return;
1288   for (idx = ignoreidx+1; idx > 0; --idx) {
1289     if (low > borders[idx-1].upper) {
1290       break;
1291     }
1292   }
1293   Border br(low, upper);
1294   if (idx > ignoreidx) {
1295     if (borders.size() <= size_t(idx)) {
1296       borders.push_back(br);
1297     }
1298     else {
1299       borders[idx] = br;
1300     }
1301     ignoreidx = idx;
1302     // checkIgnoreIdx(ignoreidx);
1303     return;
1304   }
1305   else {
1306     // Expand only if one of the new bound is inside the interwall
1307     // We know here that br.low > borders[idx-1].upper
1308     if (br.upper < borders[idx].low) {
1309       // We have to insert at this pos
1310       if (size_t(ignoreidx+1) >= borders.size()) {
1311         borders.push_back(borders[ignoreidx]);
1312       }
1313       else {
1314         borders[ignoreidx+1] = borders[ignoreidx];
1315       }
1316       for (int i = ignoreidx; i > idx; --i) {
1317         borders[i] = borders[i-1];
1318       }
1319       borders[idx] = br;
1320       ignoreidx += 1;
1321       // checkIgnoreIdx(ignoreidx);
1322       return;
1323     }
1324     // Here we know, that we are overlapping
1325     if (br.low > borders[idx].low)
1326       br.low = borders[idx].low;
1327     // check what has to be concatenated
1328     int count = 0;
1329     for (int i = idx; i <= ignoreidx; i++) {
1330       if (br.upper >= borders[i].low) {
1331         count++;
1332         if (br.upper < borders[i].upper)
1333           br.upper = borders[i].upper;
1334       }
1335       else {
1336         break;
1337       }
1338     }
1339     // count should be >= 1 here
1340     borders[idx] = br;
1341     if (count > 1) {
1342       for (int i = idx + count; i <= ignoreidx; i++) {
1343         borders[i-count+1] = borders[i];
1344       }
1345       ignoreidx -= count - 1;
1346       return;
1347     }
1348   }
1349 }
1350
1351 typedef map<string, string> AccentsMap;
1352 static AccentsMap accents = map<string, string>();
1353
1354 static void buildaccent(string n, string param, string values)
1355 {
1356   stringstream s(n);
1357   string name;
1358   const char delim = '|';
1359   while (getline(s, name, delim)) {
1360     size_t start = 0;
1361     for (char c : param) {
1362       string key = name + "{" + c + "}";
1363       // get the corresponding utf8-value
1364       if ((values[start] & 0xc0) != 0xc0) {
1365         // should not happen, utf8 encoding starts at least with 11xxxxxx
1366         // but value for '\dot{i}' is 'i', which is ascii
1367         if ((values[start] & 0x80) == 0) {
1368           // is ascii
1369           accents[key] = values.substr(start, 1);
1370           // LYXERR(Debug::INFO, "" << key << "=" << accents[key]);
1371         }
1372         start++;
1373         continue;
1374       }
1375       for (int j = 1; ;j++) {
1376         if (start + j >= values.size()) {
1377           accents[key] = values.substr(start, j);
1378           start = values.size() - 1;
1379           break;
1380         }
1381         else if ((values[start+j] & 0xc0) != 0x80) {
1382           // This is the first byte of following utf8 char
1383           accents[key] = values.substr(start, j);
1384           start += j;
1385           // LYXERR(Debug::INFO, "" << key << "=" << accents[key]);
1386           break;
1387         }
1388       }
1389     }
1390   }
1391 }
1392
1393 // Helper function
1394 static string getutf8(unsigned uchar)
1395 {
1396         #define maxc 5
1397         string ret = string();
1398         char c[maxc] = {0};
1399         if (uchar <= 0x7f) {
1400                 c[maxc-1] = uchar & 0x7f;
1401         }
1402         else {
1403                 unsigned char rest = 0x40;
1404                 unsigned char first = 0x80;
1405                 int start = maxc-1;
1406                 for (int i = start; i >=0; --i) {
1407                         if (uchar < rest) {
1408                                 c[i] = first + uchar;
1409                                 break;
1410                         }
1411                         c[i] = 0x80 | (uchar &  0x3f);
1412                         uchar >>= 6;
1413                         rest >>= 1;
1414                         first >>= 1;
1415                         first |= 0x80;
1416                 }
1417         }
1418         for (int i = 0; i < maxc; i++) {
1419                 if (c[i] == 0) continue;
1420                 ret += c[i];
1421         }
1422         return(ret);
1423 }
1424
1425 static void buildAccentsMap()
1426 {
1427   accents["imath"] = "ı";
1428   accents["i"] = "ı";
1429   accents["jmath"] = "ȷ";
1430   accents["cdot"] = "·";
1431   accents["guillemotright"] = "»";
1432   accents["guillemotleft"] = "«";
1433   accents["hairspace"]     = getutf8(0xf0000);  // select from free unicode plane 15
1434   accents["thinspace"]     = getutf8(0xf0002);  // and used _only_ by findadv
1435   accents["negthinspace"]  = getutf8(0xf0003);  // to omit backslashed latex macros
1436   accents["medspace"]      = getutf8(0xf0004);  // See https://en.wikipedia.org/wiki/Private_Use_Areas
1437   accents["negmedspace"]   = getutf8(0xf0005);
1438   accents["thickspace"]    = getutf8(0xf0006);
1439   accents["negthickspace"] = getutf8(0xf0007);
1440   accents["lyx"]           = getutf8(0xf0010);  // Used logos
1441   accents["LyX"]           = getutf8(0xf0010);
1442   accents["tex"]           = getutf8(0xf0011);
1443   accents["TeX"]           = getutf8(0xf0011);
1444   accents["latex"]         = getutf8(0xf0012);
1445   accents["LaTeX"]         = getutf8(0xf0012);
1446   accents["latexe"]        = getutf8(0xf0013);
1447   accents["LaTeXe"]        = getutf8(0xf0013);
1448   accents["lyxarrow"]      = getutf8(0xf0020);
1449   accents["backslash lyx"]           = getutf8(0xf0010);        // Used logos inserted with starting \backslash
1450   accents["backslash LyX"]           = getutf8(0xf0010);
1451   accents["backslash tex"]           = getutf8(0xf0011);
1452   accents["backslash TeX"]           = getutf8(0xf0011);
1453   accents["backslash latex"]         = getutf8(0xf0012);
1454   accents["backslash LaTeX"]         = getutf8(0xf0012);
1455   accents["backslash latexe"]        = getutf8(0xf0013);
1456   accents["backslash LaTeXe"]        = getutf8(0xf0013);
1457   accents["backslash lyxarrow"]      = getutf8(0xf0020);
1458   accents["ddot{\\imath}"] = "ï";
1459   buildaccent("ddot", "aAeEhHiIioOtuUwWxXyY",
1460                       "äÄëËḧḦïÏïöÖẗüÜẅẄẍẌÿŸ");       // umlaut
1461   buildaccent("dot|.", "aAbBcCdDeEfFGghHIimMnNoOpPrRsStTwWxXyYzZ",
1462                        "ȧȦḃḂċĊḋḊėĖḟḞĠġḣḢİİṁṀṅṄȯȮṗṖṙṘṡṠṫṪẇẆẋẊẏẎżŻ");   // dot{i} can only happen if ignoring case, but there is no lowercase of 'İ'
1463   accents["acute{\\imath}"] = "í";
1464   buildaccent("acute", "aAcCeEgGkKlLmMoOnNpPrRsSuUwWyYzZiI",
1465                        "áÁćĆéÉǵǴḱḰĺĹḿḾóÓńŃṕṔŕŔśŚúÚẃẂýÝźŹíÍ");
1466   buildaccent("dacute|H|h", "oOuU", "őŐűŰ");        // double acute
1467   buildaccent("mathring|r", "aAuUwy",
1468                             "åÅůŮẘẙ");  // ring
1469   accents["check{\\imath}"] = "ǐ";
1470   accents["check{\\jmath}"] = "ǰ";
1471   buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTtzZ",
1472                          "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤťžŽ");   // caron
1473   accents["hat{\\imath}"] = "î";
1474   accents["hat{\\jmath}"] = "ĵ";
1475   buildaccent("hat|^", "aAcCeEgGhHiIjJoOsSuUwWyYzZ",
1476                        "âÂĉĈêÊĝĜĥĤîÎĵĴôÔŝŜûÛŵŴŷŶẑẐ");       // circ
1477   accents["bar{\\imath}"] = "ī";
1478   buildaccent("bar|=", "aAeEiIoOuUyY",
1479                        "āĀēĒīĪōŌūŪȳȲ");     // macron
1480   accents["tilde{\\imath}"] = "ĩ";
1481   buildaccent("tilde", "aAeEiInNoOuUvVyY",
1482                        "ãÃẽẼĩĨñÑõÕũŨṽṼỹỸ");       // tilde
1483   accents["breve{\\imath}"] = "ĭ";
1484   buildaccent("breve|u", "aAeEgGiIoOuU",
1485                          "ăĂĕĔğĞĭĬŏŎŭŬ");   // breve
1486   accents["grave{\\imath}"] = "ì";
1487   buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1488                          "àÀèÈìÌòÒùÙǹǸẁẀỳỲ");       // grave
1489   buildaccent("subdot|d", "BbDdHhKkLlMmNnRrSsTtVvWwZzAaEeIiOoUuYy",
1490                           "ḄḅḌḍḤḥḲḳḶḷṂṃṆṇṚṛṢṣṬṭṾṿẈẉẒẓẠạẸẹỊịỌọỤụỴỵ");        // dot below
1491   buildaccent("ogonek|k", "AaEeIiUuOo",
1492                           "ĄąĘęĮįŲųǪǫ");      // ogonek
1493   buildaccent("cedilla|c", "CcGgKkLlNnRrSsTtEeDdHh",
1494                            "ÇçĢģĶķĻļŅņŖŗŞşŢţȨȩḐḑḨḩ"); // cedilla
1495   buildaccent("subring|textsubring", "Aa",
1496                                      "Ḁḁ"); // subring
1497   buildaccent("subhat|textsubcircum", "DdEeLlNnTtUu",
1498                                       "ḒḓḘḙḼḽṊṋṰṱṶṷ");  // subcircum
1499   buildaccent("subtilde|textsubtilde", "EeIiUu",
1500                                        "ḚḛḬḭṴṵ");   // subtilde
1501   accents["dgrave{\\imath}"] = "ȉ";
1502   accents["textdoublegrave{\\i}"] = "ȉ";
1503   buildaccent("dgrave|textdoublegrave", "AaEeIiOoRrUu",
1504                                         "ȀȁȄȅȈȉȌȍȐȑȔȕ"); // double grave
1505   accents["rcap{\\imath}"] = "ȉ";
1506   accents["textroundcap{\\i}"] = "ȉ";
1507   buildaccent("rcap|textroundcap", "AaEeIiOoRrUu",
1508                                    "ȂȃȆȇȊȋȎȏȒȓȖȗ"); // inverted breve
1509   buildaccent("slashed", "oO",
1510                          "øØ"); // slashed
1511 }
1512
1513 /*
1514  * Created accents in math or regexp environment
1515  * are macros, but we need the utf8 equivalent
1516  */
1517 void Intervall::removeAccents()
1518 {
1519   if (accents.empty())
1520     buildAccentsMap();
1521   static regex const accre("\\\\(([\\S]|grave|breve|ddot|dot|acute|dacute|mathring|check|hat|bar|tilde|subdot|ogonek|"
1522          "cedilla|subring|textsubring|subhat|textsubcircum|subtilde|textsubtilde|dgrave|textdoublegrave|rcap|textroundcap|slashed)\\{[^\\{\\}]+\\}"
1523       "|((i|imath|jmath|cdot|[a-z]+space)|((backslash )?([lL]y[xX]|[tT]e[xX]|[lL]a[tT]e[xX]e?|lyxarrow))|guillemot(left|right))(?![a-zA-Z]))");
1524   smatch sub;
1525   for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1526     sub = *itacc;
1527     string key = sub.str(1);
1528     if (accents.find(key) != accents.end()) {
1529       string val = accents[key];
1530       size_t pos = sub.position(size_t(0));
1531       for (size_t i = 0; i < val.size(); i++) {
1532         par[pos+i] = val[i];
1533       }
1534       // Remove possibly following space too
1535       if (par[pos+sub.str(0).size()] == ' ')
1536         addIntervall(pos+val.size(), pos + sub.str(0).size()+1);
1537       else
1538         addIntervall(pos+val.size(), pos + sub.str(0).size());
1539       for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1540         // remove traces of any remaining chars
1541         par[i] = ' ';
1542       }
1543     }
1544     else {
1545       LYXERR(Debug::INFO, "Not added accent for \"" << key << "\"");
1546     }
1547   }
1548 }
1549
1550 void Intervall::handleOpenP(int i)
1551 {
1552   actualdeptindex++;
1553   depts[actualdeptindex] = i+1;
1554   closes[actualdeptindex] = -1;
1555   checkDepthIndex(actualdeptindex);
1556 }
1557
1558 void Intervall::handleCloseP(int i, bool closingAllowed)
1559 {
1560   if (actualdeptindex <= 0) {
1561     if (! closingAllowed)
1562       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1563     // if we are at the very end
1564     addIntervall(i, i+1);
1565   }
1566   else {
1567     closes[actualdeptindex] = i+1;
1568     actualdeptindex--;
1569   }
1570 }
1571
1572 void Intervall::resetOpenedP(int openPos)
1573 {
1574   // Used as initializer for foreignlanguage entry
1575   actualdeptindex = 1;
1576   depts[1] = openPos+1;
1577   closes[1] = -1;
1578 }
1579
1580 int Intervall::previousNotIgnored(int start) const
1581 {
1582     int idx = 0;                          /* int intervalls */
1583     for (idx = ignoreidx; idx >= 0; --idx) {
1584       if (start > borders[idx].upper)
1585         return start;
1586       if (start >= borders[idx].low)
1587         start = borders[idx].low-1;
1588     }
1589     return start;
1590 }
1591
1592 int Intervall::nextNotIgnored(int start) const
1593 {
1594     int idx = 0;                          /* int intervalls */
1595     for (idx = 0; idx <= ignoreidx; idx++) {
1596       if (start < borders[idx].low)
1597         return start;
1598       if (start < borders[idx].upper)
1599         start = borders[idx].upper;
1600     }
1601     return start;
1602 }
1603
1604 typedef map<string, KeyInfo> KeysMap;
1605 typedef vector< KeyInfo> Entries;
1606 static KeysMap keys = map<string, KeyInfo>();
1607
1608 class LatexInfo {
1609  private:
1610   int entidx_;
1611   Entries entries_;
1612   Intervall interval_;
1613   void buildKeys(bool);
1614   void buildEntries(bool);
1615   void makeKey(const string &, KeyInfo, bool isPatternString);
1616   void processRegion(int start, int region_end); /*  remove {} parts */
1617   void removeHead(KeyInfo const &, int count=0);
1618
1619  public:
1620  LatexInfo(string const & par, bool isPatternString)
1621          : entidx_(-1), interval_(isPatternString, par)
1622   {
1623     buildKeys(isPatternString);
1624     entries_ = vector<KeyInfo>();
1625     buildEntries(isPatternString);
1626   };
1627   int getFirstKey() {
1628     entidx_ = 0;
1629     if (entries_.empty()) {
1630       return -1;
1631     }
1632     if (entries_[0].keytype == KeyInfo::isTitle) {
1633       interval_.hasTitle = true;
1634       if (! entries_[0].disabled) {
1635         interval_.titleValue = entries_[0].head;
1636       }
1637       else {
1638         interval_.titleValue = "";
1639       }
1640       removeHead(entries_[0]);
1641       if (entries_.size() > 1)
1642         return 1;
1643       else
1644         return -1;
1645     }
1646     return 0;
1647   };
1648   int getNextKey() {
1649     entidx_++;
1650     if (int(entries_.size()) > entidx_) {
1651       return entidx_;
1652     }
1653     else {
1654       return -1;
1655     }
1656   };
1657   bool setNextKey(int idx) {
1658     if ((idx == entidx_) && (entidx_ >= 0)) {
1659       entidx_--;
1660       return true;
1661     }
1662     else
1663       return false;
1664   };
1665   int find(int start, KeyInfo::KeyType keytype) const {
1666     if (start < 0)
1667       return -1;
1668     int tmpIdx = start;
1669     while (tmpIdx < int(entries_.size())) {
1670       if (entries_[tmpIdx].keytype == keytype)
1671         return tmpIdx;
1672       tmpIdx++;
1673     }
1674     return -1;
1675   };
1676   int process(ostringstream & os, KeyInfo const & actual);
1677   int dispatch(ostringstream & os, int previousStart, KeyInfo & actual);
1678   // string show(int lastpos) { return interval.show(lastpos);};
1679   int nextNotIgnored(int start) { return interval_.nextNotIgnored(start);};
1680   KeyInfo &getKeyInfo(int keyinfo) {
1681     static KeyInfo invalidInfo = KeyInfo();
1682     if ((keyinfo < 0) || ( keyinfo >= int(entries_.size())))
1683       return invalidInfo;
1684     else
1685       return entries_[keyinfo];
1686   };
1687   void setForDefaultLang(KeyInfo const & defLang) {interval_.setForDefaultLang(defLang);};
1688   void addIntervall(int low, int up) { interval_.addIntervall(low, up); };
1689 };
1690
1691
1692 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1693 {
1694   int skip = 0;
1695   int depth = 0;
1696   for (int i = start; i < end; i += 1 + skip) {
1697     char c;
1698     c = par[i];
1699     skip = 0;
1700     if (c == '\\') skip = 1;
1701     else if (c == up) {
1702       depth++;
1703     }
1704     else if (c == down) {
1705       if (depth == 0) {
1706         repeat--;
1707         if ((repeat <= 0) || (par[i+1] != up))
1708           return i;
1709       }
1710       --depth;
1711     }
1712   }
1713   return end;
1714 }
1715
1716 class MathInfo {
1717   class MathEntry {
1718   public:
1719     string wait;
1720     size_t mathEnd;
1721     size_t mathStart;
1722     size_t mathSize;
1723   };
1724   size_t actualIdx_;
1725   vector<MathEntry> entries_;
1726  public:
1727   MathInfo() {
1728     actualIdx_ = 0;
1729   }
1730   void insert(string const & wait, size_t start, size_t end) {
1731     MathEntry m = MathEntry();
1732     m.wait = wait;
1733     m.mathStart = start;
1734     m.mathEnd = end;
1735     m.mathSize = end - start;
1736     entries_.push_back(m);
1737   }
1738   bool empty() const { return entries_.empty(); };
1739   size_t getEndPos() const {
1740     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1741       return 0;
1742     }
1743     return entries_[actualIdx_].mathEnd;
1744   }
1745   size_t getStartPos() const {
1746     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1747       return 100000;                    /*  definitely enough? */
1748     }
1749     return entries_[actualIdx_].mathStart;
1750   }
1751   size_t getFirstPos() {
1752     actualIdx_ = 0;
1753     return getStartPos();
1754   }
1755   size_t getSize() const {
1756     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1757       return size_t(0);
1758     }
1759     return entries_[actualIdx_].mathSize;
1760   }
1761   void incrEntry() { actualIdx_++; };
1762 };
1763
1764 void LatexInfo::buildEntries(bool isPatternString)
1765 {
1766   static regex const rmath("(\\\\)*(\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\})");
1767   static regex const rkeys("(\\\\)*(\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?)))");
1768   static bool disableLanguageOverride = false;
1769   smatch sub, submath;
1770   bool evaluatingRegexp = false;
1771   MathInfo mi;
1772   bool evaluatingMath = false;
1773   bool evaluatingCode = false;
1774   size_t codeEnd = 0;
1775   bool evaluatingOptional = false;
1776   size_t optionalEnd = 0;
1777   int codeStart = -1;
1778   KeyInfo found;
1779   bool math_end_waiting = false;
1780   size_t math_pos = 10000;
1781   string math_end;
1782   static vector<string> usedText = vector<string>();
1783
1784   interval_.removeAccents();
1785
1786   for (sregex_iterator itmath(interval_.par.begin(), interval_.par.end(), rmath), end; itmath != end; ++itmath) {
1787     submath = *itmath;
1788     if ((submath.position(2) - submath.position(0)) %2 == 1) {
1789       // prefixed by odd count of '\\'
1790       continue;
1791     }
1792     if (math_end_waiting) {
1793       size_t pos = submath.position(size_t(2));
1794       if ((math_end == "$") &&
1795           (submath.str(2) == "$")) {
1796         mi.insert("$", math_pos, pos + 1);
1797         math_end_waiting = false;
1798       }
1799       else if ((math_end == "\\]") &&
1800                (submath.str(2) == "\\]")) {
1801         mi.insert("\\]", math_pos, pos + 2);
1802         math_end_waiting = false;
1803       }
1804       else if ((submath.str(3).compare("end") == 0) &&
1805           (submath.str(4).compare(math_end) == 0)) {
1806         mi.insert(math_end, math_pos, pos + submath.str(2).length());
1807         math_end_waiting = false;
1808       }
1809       else
1810         continue;
1811     }
1812     else {
1813       if (submath.str(3).compare("begin") == 0) {
1814         math_end_waiting = true;
1815         math_end = submath.str(4);
1816         math_pos = submath.position(size_t(2));
1817       }
1818       else if (submath.str(2).compare("\\[") == 0) {
1819         math_end_waiting = true;
1820         math_end = "\\]";
1821         math_pos = submath.position(size_t(2));
1822       }
1823       else if (submath.str(2) == "$") {
1824         size_t pos = submath.position(size_t(2));
1825         math_end_waiting = true;
1826         math_end = "$";
1827         math_pos = pos;
1828       }
1829     }
1830   }
1831   // Ignore language if there is math somewhere in pattern-string
1832   if (isPatternString) {
1833     for (auto s: usedText) {
1834       // Remove entries created in previous search runs
1835       keys.erase(s);
1836     }
1837     usedText = vector<string>();
1838     if (! mi.empty()) {
1839       // Disable language
1840       keys["foreignlanguage"].disabled = true;
1841       disableLanguageOverride = true;
1842     }
1843     else
1844       disableLanguageOverride = false;
1845   }
1846   else {
1847     if (disableLanguageOverride) {
1848       keys["foreignlanguage"].disabled = true;
1849     }
1850   }
1851   math_pos = mi.getFirstPos();
1852   for (sregex_iterator it(interval_.par.begin(), interval_.par.end(), rkeys), end; it != end; ++it) {
1853     sub = *it;
1854     if ((sub.position(2) - sub.position(0)) %2 == 1) {
1855       // prefixed by odd count of '\\'
1856       continue;
1857     }
1858     string key = sub.str(5);
1859     if (key == "") {
1860       if (sub.str(2)[0] == '\\')
1861         key = sub.str(2)[1];
1862       else {
1863         key = sub.str(2);
1864       }
1865     }
1866     if (keys.find(key) != keys.end()) {
1867       if (keys[key].keytype == KeyInfo::headRemove) {
1868         KeyInfo found1 = keys[key];
1869         found1.disabled = true;
1870         found1.head = "\\" + key + "{";
1871         found1._tokenstart = sub.position(size_t(2));
1872         found1._tokensize = found1.head.length();
1873         found1._dataStart = found1._tokenstart + found1.head.length();
1874         int endpos = interval_.findclosing(found1._dataStart, interval_.par.length(), '{', '}', 1);
1875         found1._dataEnd = endpos;
1876         removeHead(found1);
1877         continue;
1878       }
1879     }
1880     if (evaluatingRegexp) {
1881       if (sub.str(3).compare("endregexp") == 0) {
1882         evaluatingRegexp = false;
1883         // found._tokenstart already set
1884         found._dataEnd = sub.position(size_t(2)) + 13;
1885         found._dataStart = found._dataEnd;
1886         found._tokensize = found._dataEnd - found._tokenstart;
1887         found.parenthesiscount = 0;
1888         found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1889       }
1890       else {
1891         continue;
1892       }
1893     }
1894     else {
1895       if (evaluatingMath) {
1896         if (size_t(sub.position(size_t(2))) < mi.getEndPos())
1897           continue;
1898         evaluatingMath = false;
1899         mi.incrEntry();
1900         math_pos = mi.getStartPos();
1901       }
1902       if (keys.find(key) == keys.end()) {
1903         found = KeyInfo(KeyInfo::isStandard, 0, true);
1904         LYXERR(Debug::INFO, "Undefined key " << key << " ==> will be used as text");
1905         found = KeyInfo(KeyInfo::isText, 0, false);
1906         if (isPatternString) {
1907           found.keytype = KeyInfo::isChar;
1908           found.disabled = false;
1909           found.used = true;
1910         }
1911         keys[key] = found;
1912         usedText.push_back(key);
1913       }
1914       else
1915         found = keys[key];
1916       if (key.compare("regexp") == 0) {
1917         evaluatingRegexp = true;
1918         found._tokenstart = sub.position(size_t(2));
1919         found._tokensize = 0;
1920         continue;
1921       }
1922     }
1923     // Handle the other params of key
1924     if (found.keytype == KeyInfo::isIgnored)
1925       continue;
1926     else if (found.keytype == KeyInfo::isMath) {
1927       if (size_t(sub.position(size_t(2))) == math_pos) {
1928         found = keys[key];
1929         found._tokenstart = sub.position(size_t(2));
1930         found._tokensize = mi.getSize();
1931         found._dataEnd = found._tokenstart + found._tokensize;
1932         found._dataStart = found._dataEnd;
1933         found.parenthesiscount = 0;
1934         found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1935         evaluatingMath = true;
1936       }
1937       else {
1938         // begin|end of unknown env, discard
1939         // First handle tables
1940         // longtable|tabular
1941         bool discardComment;
1942         found = keys[key];
1943         found.keytype = KeyInfo::doRemove;
1944         if ((sub.str(7).compare("longtable") == 0) ||
1945             (sub.str(7).compare("tabular") == 0)) {
1946           discardComment = true;        /* '%' */
1947         }
1948         else {
1949           discardComment = false;
1950           static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1951           smatch sub2;
1952           string token = sub.str(7);
1953           if (regex_match(token, sub2, removeArgs)) {
1954             found.keytype = KeyInfo::removeWithArg;
1955           }
1956         }
1957         // discard spaces before pos(2)
1958         int pos = sub.position(size_t(2));
1959         int count;
1960         for (count = 0; pos - count > 0; count++) {
1961           char c = interval_.par[pos-count-1];
1962           if (discardComment) {
1963             if ((c != ' ') && (c != '%'))
1964               break;
1965           }
1966           else if (c != ' ')
1967             break;
1968         }
1969         found._tokenstart = pos - count;
1970         if (sub.str(3).compare(0, 5, "begin") == 0) {
1971           size_t pos1 = pos + sub.str(2).length();
1972           if (sub.str(7).compare("cjk") == 0) {
1973             pos1 = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1974             if ((interval_.par[pos1] == '{') && (interval_.par[pos1+1] == '}'))
1975               pos1 += 2;
1976             found.keytype = KeyInfo::isMain;
1977             found._dataStart = pos1;
1978             found._dataEnd = interval_.par.length();
1979             found.disabled = keys["foreignlanguage"].disabled;
1980             found.used = keys["foreignlanguage"].used;
1981             found._tokensize = pos1 - found._tokenstart;
1982             found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1983           }
1984           else {
1985             // Swallow possible optional params
1986             while (interval_.par[pos1] == '[') {
1987               pos1 = interval_.findclosing(pos1+1, interval_.par.length(), '[', ']')+1;
1988             }
1989             // Swallow also the eventual parameter
1990             if (interval_.par[pos1] == '{') {
1991               found._dataEnd = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1992             }
1993             else {
1994               found._dataEnd = pos1;
1995             }
1996             found._dataStart = found._dataEnd;
1997             found._tokensize = count + found._dataEnd - pos;
1998             found.parenthesiscount = 0;
1999             found.head = interval_.par.substr(found._tokenstart, found._tokensize);
2000             found.disabled = true;
2001           }
2002         }
2003         else {
2004           // Handle "\end{...}"
2005           found._dataStart = pos + sub.str(2).length();
2006           found._dataEnd = found._dataStart;
2007           found._tokensize = count + found._dataEnd - pos;
2008           found.parenthesiscount = 0;
2009           found.head = interval_.par.substr(found._tokenstart, found._tokensize);
2010           found.disabled = true;
2011         }
2012       }
2013     }
2014     else if (found.keytype != KeyInfo::isRegex) {
2015       found._tokenstart = sub.position(size_t(2));
2016       if (found.parenthesiscount == 0) {
2017         // Probably to be discarded
2018         size_t following_pos = sub.position(size_t(2)) + sub.str(5).length() + 1;
2019         char following = interval_.par[following_pos];
2020         if (following == ' ')
2021           found.head = "\\" + sub.str(5) + " ";
2022         else if (following == '=') {
2023           // like \uldepth=1000pt
2024           found.head = sub.str(2);
2025         }
2026         else
2027           found.head = "\\" + key;
2028         found._tokensize = found.head.length();
2029         found._dataEnd = found._tokenstart + found._tokensize;
2030         found._dataStart = found._dataEnd;
2031       }
2032       else {
2033         int params = found._tokenstart + key.length() + 1;
2034         if (evaluatingOptional) {
2035           if (size_t(found._tokenstart) > optionalEnd) {
2036             evaluatingOptional = false;
2037           }
2038           else {
2039             found.disabled = true;
2040           }
2041         }
2042         int optend = params;
2043         while (interval_.par[optend] == '[') {
2044           // discard optional parameters
2045           optend = interval_.findclosing(optend+1, interval_.par.length(), '[', ']') + 1;
2046         }
2047         if (optend > params) {
2048           key += interval_.par.substr(params, optend-params);
2049           evaluatingOptional = true;
2050           optionalEnd = optend;
2051         }
2052         string token = sub.str(7);
2053         int closings;
2054         if (interval_.par[optend] != '{') {
2055           closings = 0;
2056           found.parenthesiscount = 0;
2057           found.head = "\\" + key;
2058         }
2059         else
2060           closings = found.parenthesiscount;
2061         if (found.parenthesiscount == 1) {
2062           found.head = "\\" + key + "{";
2063         }
2064         else if (found.parenthesiscount > 1) {
2065           if (token != "") {
2066             found.head = sub.str(2) + "{";
2067             closings = found.parenthesiscount - 1;
2068           }
2069           else {
2070             found.head = "\\" + key + "{";
2071           }
2072         }
2073         found._tokensize = found.head.length();
2074         found._dataStart = found._tokenstart + found.head.length();
2075         if (found.keytype == KeyInfo::doRemove) {
2076           if (closings > 0) {
2077             size_t endpar = 2 + interval_.findclosing(found._dataStart, interval_.par.length(), '{', '}', closings);
2078             if (endpar >= interval_.par.length())
2079               found._dataStart = interval_.par.length();
2080             else
2081               found._dataStart = endpar;
2082             found._tokensize = found._dataStart - found._tokenstart;
2083           }
2084           else {
2085             found._dataStart = found._tokenstart + found._tokensize;
2086           } 
2087           closings = 0;
2088         }
2089         if (interval_.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
2090           found._dataStart += 15;
2091         }
2092         size_t endpos;
2093         if (closings < 1)
2094           endpos = found._dataStart - 1;
2095         else
2096           endpos = interval_.findclosing(found._dataStart, interval_.par.length(), '{', '}', closings);
2097         if (found.keytype == KeyInfo::isList) {
2098           // Check if it really is list env
2099           static regex const listre("^([a-z]+)$");
2100           smatch sub2;
2101           if (!regex_match(token, sub2, listre)) {
2102             // Change the key of this entry. It is not in a list/item environment
2103             found.keytype = KeyInfo::endArguments;
2104           }
2105         }
2106         if (found.keytype == KeyInfo::noMain) {
2107           evaluatingCode = true;
2108           codeEnd = endpos;
2109           codeStart = found._dataStart;
2110         }
2111         else if (evaluatingCode) {
2112           if (size_t(found._dataStart) > codeEnd)
2113             evaluatingCode = false;
2114           else if (found.keytype == KeyInfo::isMain) {
2115             // Disable this key, treate it as standard
2116             found.keytype = KeyInfo::isStandard;
2117             found.disabled = true;
2118             if ((codeEnd +1 >= interval_.par.length()) &&
2119                 (found._tokenstart == codeStart)) {
2120               // trickery, because the code inset starts
2121               // with \selectlanguage ...
2122               codeEnd = endpos;
2123               if (entries_.size() > 1) {
2124                 entries_[entries_.size()-1]._dataEnd = codeEnd;
2125               }
2126             }
2127           }
2128         }
2129         if ((endpos == interval_.par.length()) &&
2130             (found.keytype == KeyInfo::doRemove)) {
2131           // Missing closing => error in latex-input?
2132           // therefore do not delete remaining data
2133           found._dataStart -= 1;
2134           found._dataEnd = found._dataStart;
2135         }
2136         else
2137           found._dataEnd = endpos;
2138       }
2139       if (isPatternString) {
2140         keys[key].used = true;
2141       }
2142     }
2143     entries_.push_back(found);
2144   }
2145 }
2146
2147 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
2148 {
2149   stringstream s(keysstring);
2150   string key;
2151   const char delim = '|';
2152   while (getline(s, key, delim)) {
2153     KeyInfo keyII(keyI);
2154     if (isPatternString) {
2155       keyII.used = false;
2156     }
2157     else if ( !keys[key].used)
2158       keyII.disabled = true;
2159     keys[key] = keyII;
2160   }
2161 }
2162
2163 void LatexInfo::buildKeys(bool isPatternString)
2164 {
2165
2166   static bool keysBuilt = false;
2167   if (keysBuilt && !isPatternString) return;
2168
2169   // Keys to ignore in any case
2170   makeKey("text|textcyrillic|lyxmathsym", KeyInfo(KeyInfo::headRemove, 1, true), true);
2171   // Known standard keys with 1 parameter.
2172   // Split is done, if not at start of region
2173   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
2174   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
2175   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
2176   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
2177   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
2178   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
2179
2180   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
2181           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
2182   makeKey("section*|subsection*|subsubsection*|paragraph*",
2183           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
2184   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
2185   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
2186   // Regex
2187   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
2188
2189   // Split is done, if not at start of region
2190   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
2191   makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
2192
2193   // Split is done always.
2194   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
2195
2196   // Known charaters
2197   // No split
2198   makeKey("backslash|textbackslash|slash",  KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2199   makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2200   makeKey("textasciiacute|texemdash",       KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2201   makeKey("dots|ldots",                     KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2202   // Spaces
2203   makeKey("quad|qquad|hfill|dotfill",               KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2204   makeKey("textvisiblespace|nobreakspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2205   makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2206   makeKey("thickspace|medspace|thinspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2207   // Skip
2208   // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2209   // Custom space/skip, remove the content (== length value)
2210   makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
2211   // Found in fr/UserGuide.lyx
2212   makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2213   // quotes
2214   makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2215   makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2216   // Known macros to remove (including their parameter)
2217   // No split
2218   makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
2219   makeKey("addtocounter|setlength",                 KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
2220   // handle like standard keys with 1 parameter.
2221   makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
2222
2223   // Ignore deleted text
2224   makeKey("lyxdeleted", KeyInfo(KeyInfo::doRemove, 3, false), isPatternString);
2225   // but preserve added text
2226   makeKey("lyxadded", KeyInfo(KeyInfo::doRemove, 2, false), isPatternString);
2227
2228   // Macros to remove, but let the parameter survive
2229   // No split
2230   makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2231
2232   // Remove language spec from content of these insets
2233   makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
2234
2235   // Same effect as previous, parameter will survive (because there is no one anyway)
2236   // No split
2237   makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2238   // Remove table decorations
2239   makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
2240   // Discard shape-header.
2241   // For footnote or shortcut too, because of lang settings
2242   // and wrong handling if used 'KeyInfo::noMain'
2243   makeKey("circlepar|diamondpar|heartpar|nutpar",  KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2244   makeKey("trianglerightpar|hexagonpar|starpar",   KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2245   makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2246   makeKey("triangleleftpar|shapepar|dropuppar",    KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2247   makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics",     KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2248   makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2249   // like ('tiny{}' or '\tiny ' ... )
2250   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2251
2252   // Survives, like known character
2253   // makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2254   makeKey("tableofcontents", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2255   makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2256
2257   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2258   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2259   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2260
2261   makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2262   // Remove RTL/LTR marker
2263   makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2264   makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2265   makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2266   makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2267   makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2268   makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2269   makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2270   if (isPatternString) {
2271     // Allow the first searched string to rebuild the keys too
2272     keysBuilt = false;
2273   }
2274   else {
2275     // no need to rebuild again
2276     keysBuilt = true;
2277   }
2278 }
2279
2280 /*
2281  * Keep the list of actual opened parentheses actual
2282  * (e.g. depth == 4 means there are 4 '{' not processed yet)
2283  */
2284 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2285 {
2286   int skip = 0;
2287   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2288     char c;
2289     c = par[i];
2290     skip = 0;
2291     if (c == '\\') skip = 1;
2292     else if (c == '{') {
2293       handleOpenP(i);
2294     }
2295     else if (c == '}') {
2296       handleCloseP(i, closingAllowed);
2297     }
2298   }
2299 }
2300
2301 #if (0)
2302 string Intervall::show(int lastpos)
2303 {
2304   int idx = 0;                          /* int intervalls */
2305   string s;
2306   int i = 0;
2307   for (idx = 0; idx <= ignoreidx; idx++) {
2308     while (i < lastpos) {
2309       int printsize;
2310       if (i <= borders[idx].low) {
2311         if (borders[idx].low > lastpos)
2312           printsize = lastpos - i;
2313         else
2314           printsize = borders[idx].low - i;
2315         s += par.substr(i, printsize);
2316         i += printsize;
2317         if (i >= borders[idx].low)
2318           i = borders[idx].upper;
2319       }
2320       else {
2321         i = borders[idx].upper;
2322         break;
2323       }
2324     }
2325   }
2326   if (lastpos > i) {
2327     s += par.substr(i, lastpos-i);
2328   }
2329   return s;
2330 }
2331 #endif
2332
2333 void Intervall::output(ostringstream &os, int lastpos)
2334 {
2335   // get number of chars to output
2336   int idx = 0;                          /* int intervalls */
2337   int i = 0;
2338   int printed = 0;
2339   string startTitle = titleValue;
2340   for (idx = 0; idx <= ignoreidx; idx++) {
2341     if (i < lastpos) {
2342       if (i <= borders[idx].low) {
2343         int printsize;
2344         if (borders[idx].low > lastpos)
2345           printsize = lastpos - i;
2346         else
2347           printsize = borders[idx].low - i;
2348         if (printsize > 0) {
2349           os << startTitle << par.substr(i, printsize);
2350           i += printsize;
2351           printed += printsize;
2352           startTitle = "";
2353         }
2354         handleParentheses(i, false);
2355         if (i >= borders[idx].low)
2356           i = borders[idx].upper;
2357       }
2358       else {
2359         i = borders[idx].upper;
2360       }
2361     }
2362     else
2363       break;
2364   }
2365   if (lastpos > i) {
2366     os << startTitle << par.substr(i, lastpos-i);
2367     printed += lastpos-i;
2368   }
2369   handleParentheses(lastpos, false);
2370   int startindex;
2371   if (keys["foreignlanguage"].disabled)
2372     startindex = actualdeptindex-langcount;
2373   else
2374     startindex = actualdeptindex;
2375   for (int i = startindex; i > 0; --i) {
2376     os << "}";
2377   }
2378   if (hasTitle && (printed > 0))
2379     os << "}";
2380   if (! isPatternString_)
2381     os << "\n";
2382   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2383 }
2384
2385 void LatexInfo::processRegion(int start, int region_end)
2386 {
2387   while (start < region_end) {          /* Let {[} and {]} survive */
2388     int cnt = interval_.isOpeningPar(start);
2389     if (cnt == 1) {
2390       // Closing is allowed past the region
2391       int closing = interval_.findclosing(start+1, interval_.par.length());
2392       interval_.addIntervall(start, start+1);
2393       interval_.addIntervall(closing, closing+1);
2394     }
2395     else if (cnt == 3)
2396       start += 2;
2397     start = interval_.nextNotIgnored(start+1);
2398   }
2399 }
2400
2401 void LatexInfo::removeHead(KeyInfo const & actual, int count)
2402 {
2403   if (actual.parenthesiscount == 0) {
2404     // "{\tiny{} ...}" ==> "{{} ...}"
2405     interval_.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2406   }
2407   else {
2408     // Remove header hull, that is "\url{abcd}" ==> "abcd"
2409     interval_.addIntervall(actual._tokenstart - count, actual._dataStart);
2410     interval_.addIntervall(actual._dataEnd, actual._dataEnd+1);
2411   }
2412 }
2413
2414 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2415 {
2416   int nextKeyIdx = 0;
2417   switch (actual.keytype)
2418   {
2419     case KeyInfo::isTitle: {
2420       removeHead(actual);
2421       nextKeyIdx = getNextKey();
2422       break;
2423     }
2424     case KeyInfo::cleanToStart: {
2425       actual._dataEnd = actual._dataStart;
2426       nextKeyIdx = getNextKey();
2427       // Search for end of arguments
2428       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2429       if (tmpIdx > 0) {
2430         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2431           entries_[i].disabled = true;
2432         }
2433         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2434       }
2435       while (interval_.par[actual._dataEnd] == ' ')
2436         actual._dataEnd++;
2437       interval_.addIntervall(0, actual._dataEnd+1);
2438       interval_.actualdeptindex = 0;
2439       interval_.depts[0] = actual._dataEnd+1;
2440       interval_.closes[0] = -1;
2441       break;
2442     }
2443     case KeyInfo::isText:
2444       interval_.par[actual._tokenstart] = '#';
2445       //interval_.addIntervall(actual._tokenstart, actual._tokenstart+1);
2446       nextKeyIdx = getNextKey();
2447       break;
2448     case KeyInfo::noContent: {          /* char like "\hspace{2cm}" */
2449       if (actual.disabled)
2450         interval_.addIntervall(actual._tokenstart, actual._dataEnd);
2451       else
2452         interval_.addIntervall(actual._dataStart, actual._dataEnd);
2453     }
2454       // fall through
2455     case KeyInfo::isChar: {
2456       nextKeyIdx = getNextKey();
2457       break;
2458     }
2459     case KeyInfo::isSize: {
2460       if (actual.disabled || (interval_.par[actual._dataStart] != '{') || (interval_.par[actual._dataStart-1] == ' ')) {
2461         if (actual.parenthesiscount == 0)
2462           interval_.addIntervall(actual._tokenstart, actual._dataEnd);
2463         else {
2464           interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2465         }
2466         nextKeyIdx = getNextKey();
2467       } else {
2468         // Here _dataStart points to '{', so correct it
2469         actual._dataStart += 1;
2470         actual._tokensize += 1;
2471         actual.parenthesiscount = 1;
2472         if (interval_.par[actual._dataStart] == '}') {
2473           // Determine the end if used like '{\tiny{}...}'
2474           actual._dataEnd = interval_.findclosing(actual._dataStart+1, interval_.par.length()) + 1;
2475           interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2476         }
2477         else {
2478           // Determine the end if used like '\tiny{...}'
2479           actual._dataEnd = interval_.findclosing(actual._dataStart, interval_.par.length()) + 1;
2480         }
2481         // Split on this key if not at start
2482         int start = interval_.nextNotIgnored(previousStart);
2483         if (start < actual._tokenstart) {
2484           interval_.output(os, actual._tokenstart);
2485           interval_.addIntervall(start, actual._tokenstart);
2486         }
2487         // discard entry if at end of actual
2488         nextKeyIdx = process(os, actual);
2489       }
2490       break;
2491     }
2492     case KeyInfo::endArguments: {
2493       // Remove trailing '{}' too
2494       actual._dataStart += 1;
2495       actual._dataEnd += 1;
2496       interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2497       nextKeyIdx = getNextKey();
2498       break;
2499     }
2500     case KeyInfo::noMain:
2501       // fall through
2502     case KeyInfo::isStandard: {
2503       if (actual.disabled) {
2504         removeHead(actual);
2505         processRegion(actual._dataStart, actual._dataStart+1);
2506         nextKeyIdx = getNextKey();
2507       } else {
2508         // Split on this key if not at datastart of calling entry
2509         int start = interval_.nextNotIgnored(previousStart);
2510         if (start < actual._tokenstart) {
2511           interval_.output(os, actual._tokenstart);
2512           interval_.addIntervall(start, actual._tokenstart);
2513         }
2514         // discard entry if at end of actual
2515         nextKeyIdx = process(os, actual);
2516       }
2517       break;
2518     }
2519     case KeyInfo::removeWithArg: {
2520       nextKeyIdx = getNextKey();
2521       // Search for end of arguments
2522       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2523       if (tmpIdx > 0) {
2524         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2525           entries_[i].disabled = true;
2526         }
2527         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2528       }
2529       interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2530       break;
2531     }
2532     case KeyInfo::doRemove: {
2533       // Remove the key with all parameters and following spaces
2534       size_t pos;
2535       for (pos = actual._dataEnd+1; pos < interval_.par.length(); pos++) {
2536         if ((interval_.par[pos] != ' ') && (interval_.par[pos] != '%'))
2537           break;
2538       }
2539       // Remove also enclosing parentheses [] and {}
2540       int numpars = 0;
2541       int spaces = 0;
2542       while (actual._tokenstart > numpars) {
2543         if (pos+numpars >= interval_.par.size())
2544           break;
2545         else if (interval_.par[pos+numpars] == ']' && interval_.par[actual._tokenstart-numpars-1] == '[')
2546           numpars++;
2547         else if (interval_.par[pos+numpars] == '}' && interval_.par[actual._tokenstart-numpars-1] == '{')
2548           numpars++;
2549         else
2550           break;
2551       }
2552       if (numpars > 0) {
2553         if (interval_.par[pos+numpars] == ' ')
2554           spaces++;
2555       }
2556
2557       interval_.addIntervall(actual._tokenstart-numpars, pos+numpars+spaces);
2558       nextKeyIdx = getNextKey();
2559       break;
2560     }
2561     case KeyInfo::isList: {
2562       // Discard space before _tokenstart
2563       int count;
2564       for (count = 0; count < actual._tokenstart; count++) {
2565         if (interval_.par[actual._tokenstart-count-1] != ' ')
2566           break;
2567       }
2568       nextKeyIdx = getNextKey();
2569       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2570       if (tmpIdx > 0) {
2571         // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2572         // with arguments
2573         // How else can we catch this one?
2574         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2575           entries_[i].disabled = true;
2576         }
2577         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2578       }
2579       else if (nextKeyIdx > 0) {
2580         // Ignore any lang entries inside data region
2581         for (int i = nextKeyIdx; i < int(entries_.size()) && entries_[i]._tokenstart < actual._dataEnd; i++) {
2582           if (entries_[i].keytype == KeyInfo::isMain)
2583             entries_[i].disabled = true;
2584         }
2585       }
2586       if (actual.disabled) {
2587         interval_.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2588       }
2589       else {
2590         interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2591       }
2592       if (interval_.par[actual._dataEnd+1] == '[') {
2593         int posdown = interval_.findclosing(actual._dataEnd+2, interval_.par.length(), '[', ']');
2594         if ((interval_.par[actual._dataEnd+2] == '{') &&
2595             (interval_.par[posdown-1] == '}')) {
2596           interval_.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2597           interval_.addIntervall(posdown-1, posdown+1);
2598         }
2599         else {
2600           interval_.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2601           interval_.addIntervall(posdown, posdown+1);
2602         }
2603         int blk = interval_.nextNotIgnored(actual._dataEnd+1);
2604         if (blk > posdown) {
2605           // Discard at most 1 space after empty item
2606           int count;
2607           for (count = 0; count < 1; count++) {
2608             if (interval_.par[blk+count] != ' ')
2609               break;
2610           }
2611           if (count > 0)
2612             interval_.addIntervall(blk, blk+count);
2613         }
2614       }
2615       break;
2616     }
2617     case KeyInfo::isSectioning: {
2618       // Discard spaces before _tokenstart
2619       int count;
2620       int val = actual._tokenstart;
2621       for (count = 0; count < actual._tokenstart;) {
2622         val = interval_.previousNotIgnored(val-1);
2623         if (val < 0 || interval_.par[val] != ' ')
2624           break;
2625         else {
2626           count = actual._tokenstart - val;
2627         }
2628       }
2629       if (actual.disabled) {
2630         removeHead(actual, count);
2631         nextKeyIdx = getNextKey();
2632       } else {
2633         interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2634         nextKeyIdx = process(os, actual);
2635       }
2636       break;
2637     }
2638     case KeyInfo::isMath: {
2639       // Same as regex, use the content unchanged
2640       nextKeyIdx = getNextKey();
2641       break;
2642     }
2643     case KeyInfo::isRegex: {
2644       // DO NOT SPLIT ON REGEX
2645       // Do not disable
2646       nextKeyIdx = getNextKey();
2647       break;
2648     }
2649     case KeyInfo::isIgnored: {
2650       // Treat like a character for now
2651       nextKeyIdx = getNextKey();
2652       break;
2653     }
2654     case KeyInfo::isMain: {
2655       if (interval_.par.substr(actual._dataStart, 2) == "% ")
2656         interval_.addIntervall(actual._dataStart, actual._dataStart+2);
2657       if (actual._tokenstart > 0) {
2658         int prev = interval_.previousNotIgnored(actual._tokenstart - 1);
2659         if ((prev >= 0) && interval_.par[prev] == '%')
2660           interval_.addIntervall(prev, prev+1);
2661       }
2662       if (actual.disabled) {
2663         removeHead(actual);
2664         interval_.langcount++;
2665         if ((interval_.par.substr(actual._dataStart, 3) == " \\[") ||
2666             (interval_.par.substr(actual._dataStart, 8) == " \\begin{")) {
2667           // Discard also the space before math-equation
2668           interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2669         }
2670         nextKeyIdx = getNextKey();
2671         // interval.resetOpenedP(actual._dataStart-1);
2672       }
2673       else {
2674         if (actual._tokenstart < 26) {
2675           // for the first (and maybe dummy) language
2676           interval_.setForDefaultLang(actual);
2677         }
2678         interval_.resetOpenedP(actual._dataStart-1);
2679       }
2680       break;
2681     }
2682     case KeyInfo::invalid:
2683     case KeyInfo::headRemove:
2684       // These two cases cannot happen, already handled
2685       // fall through
2686     default: {
2687       // LYXERR(Debug::INFO, "Unhandled keytype");
2688       nextKeyIdx = getNextKey();
2689       break;
2690     }
2691   }
2692   return nextKeyIdx;
2693 }
2694
2695 int LatexInfo::process(ostringstream & os, KeyInfo const & actual )
2696 {
2697   int end = interval_.nextNotIgnored(actual._dataEnd);
2698   int oldStart = actual._dataStart;
2699   int nextKeyIdx = getNextKey();
2700   while (true) {
2701     if ((nextKeyIdx < 0) ||
2702         (entries_[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2703         (entries_[nextKeyIdx].keytype == KeyInfo::invalid)) {
2704       if (oldStart <= end) {
2705         processRegion(oldStart, end);
2706         oldStart = end+1;
2707       }
2708       break;
2709     }
2710     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2711
2712     if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2713       (void) dispatch(os, actual._dataStart, nextKey);
2714       end = nextKey._tokenstart;
2715       break;
2716     }
2717     processRegion(oldStart, nextKey._tokenstart);
2718     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2719
2720     oldStart = nextKey._dataEnd+1;
2721   }
2722   // now nextKey is either invalid or is outside of actual._dataEnd
2723   // output the remaining and discard myself
2724   if (oldStart <= end) {
2725     processRegion(oldStart, end);
2726   }
2727   if (interval_.par.size() > (size_t) end && interval_.par[end] == '}') {
2728     end += 1;
2729     // This is the normal case.
2730     // But if using the firstlanguage, the closing may be missing
2731   }
2732   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2733   int output_end;
2734   if (actual._dataEnd < end)
2735     output_end = interval_.nextNotIgnored(actual._dataEnd);
2736   else if (interval_.par.size() > (size_t) end)
2737     output_end = interval_.nextNotIgnored(end);
2738   else
2739     output_end = interval_.par.size();
2740   if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2741     interval_.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2742   }
2743   // Remove possible empty data
2744   int dstart = interval_.nextNotIgnored(actual._dataStart);
2745   while (interval_.isOpeningPar(dstart) == 1) {
2746     interval_.addIntervall(dstart, dstart+1);
2747     int dend = interval_.findclosing(dstart+1, output_end);
2748     interval_.addIntervall(dend, dend+1);
2749     dstart = interval_.nextNotIgnored(dstart+1);
2750   }
2751   if (dstart < output_end)
2752     interval_.output(os, output_end);
2753   interval_.addIntervall(actual._tokenstart, end);
2754   return nextKeyIdx;
2755 }
2756
2757 string splitOnKnownMacros(string par, bool isPatternString)
2758 {
2759   ostringstream os;
2760   LatexInfo li(par, isPatternString);
2761   // LYXERR(Debug::INFO, "Berfore split: " << par);
2762   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2763   DummyKey.head = "";
2764   DummyKey._tokensize = 0;
2765   DummyKey._dataStart = 0;
2766   DummyKey._dataEnd = par.length();
2767   DummyKey.disabled = true;
2768   int firstkeyIdx = li.getFirstKey();
2769   string s;
2770   if (firstkeyIdx >= 0) {
2771     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2772     DummyKey._tokenstart = firstKey._tokenstart;
2773     int nextkeyIdx;
2774     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2775       // Use dummy firstKey
2776       firstKey = DummyKey;
2777       (void) li.setNextKey(firstkeyIdx);
2778     }
2779     else {
2780       if (par.substr(firstKey._dataStart, 2) == "% ")
2781         li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2782     }
2783     nextkeyIdx = li.process(os, firstKey);
2784     while (nextkeyIdx >= 0) {
2785       // Check for a possible gap between the last
2786       // entry and this one
2787       int datastart = li.nextNotIgnored(firstKey._dataStart);
2788       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2789       if ((nextKey._tokenstart > datastart)) {
2790         // Handle the gap
2791         firstKey._dataStart = datastart;
2792         firstKey._dataEnd = par.length();
2793         (void) li.setNextKey(nextkeyIdx);
2794         // Fake the last opened parenthesis
2795         li.setForDefaultLang(firstKey);
2796         nextkeyIdx = li.process(os, firstKey);
2797       }
2798       else {
2799         if (nextKey.keytype != KeyInfo::isMain) {
2800           firstKey._dataStart = datastart;
2801           firstKey._dataEnd = nextKey._dataEnd+1;
2802           (void) li.setNextKey(nextkeyIdx);
2803           li.setForDefaultLang(firstKey);
2804           nextkeyIdx = li.process(os, firstKey);
2805         }
2806         else {
2807           nextkeyIdx = li.process(os, nextKey);
2808         }
2809       }
2810     }
2811     // Handle the remaining
2812     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2813     firstKey._dataEnd = par.length();
2814     // Check if ! empty
2815     if ((firstKey._dataStart < firstKey._dataEnd) &&
2816         (par[firstKey._dataStart] != '}')) {
2817       li.setForDefaultLang(firstKey);
2818       (void) li.process(os, firstKey);
2819     }
2820     s = os.str();
2821     if (s.empty()) {
2822       // return string definitelly impossible to match
2823       s = "\\foreignlanguage{ignore}{ }";
2824     }
2825   }
2826   else
2827     s = par;                            /* no known macros found */
2828   // LYXERR(Debug::INFO, "After split: " << s);
2829   return s;
2830 }
2831
2832 /*
2833  * Try to unify the language specs in the latexified text.
2834  * Resulting modified string is set to "", if
2835  * the searched tex does not contain all the features in the search pattern
2836  */
2837 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2838 {
2839         static Features regex_f;
2840         static int missed = 0;
2841         static bool regex_with_format = false;
2842
2843         int parlen = par.length();
2844
2845         while ((parlen > 0) && (par[parlen-1] == '\n')) {
2846                 parlen--;
2847         }
2848         if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2849                 // Happens to be there in case of description or labeling environment
2850                 parlen--;
2851         }
2852         string result;
2853         if (withformat) {
2854                 // Split the latex input into pieces which
2855                 // can be digested by our search engine
2856                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2857                 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2858                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2859         }
2860         else
2861                 result = par.substr(0, parlen);
2862         if (isPatternString) {
2863                 missed = 0;
2864                 if (withformat) {
2865                         regex_f = identifyFeatures(result);
2866                         string features = "";
2867                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2868                                 string a = it->first;
2869                                 regex_with_format = true;
2870                                 features += " " + a;
2871                                 // LYXERR(Debug::INFO, "Identified regex format:" << a);
2872                         }
2873                         LYXERR(Debug::FIND, "Identified Features" << features);
2874
2875                 }
2876         } else if (regex_with_format) {
2877                 Features info = identifyFeatures(result);
2878                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2879                         string a = it->first;
2880                         bool b = it->second;
2881                         if (b && ! info[a]) {
2882                                 missed++;
2883                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2884                                 return "";
2885                         }
2886                 }
2887         }
2888         else {
2889                 // LYXERR(Debug::INFO, "No regex formats");
2890         }
2891         return result;
2892 }
2893
2894
2895 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2896 static int identifyClosing(string & t)
2897 {
2898         int open_braces = 0;
2899         do {
2900                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2901                 if (regex_replace(t, t, "(.*[^\\\\])\\$$", "$1"))
2902                         continue;
2903                 if (regex_replace(t, t, "(.*[^\\\\])\\\\\\]$", "$1"))
2904                         continue;
2905                 if (regex_replace(t, t, "(.*[^\\\\])\\\\end\\{[a-zA-Z_]*\\*?\\}$", "$1"))
2906                         continue;
2907                 if (regex_replace(t, t, "(.*[^\\\\])\\}$", "$1")) {
2908                         ++open_braces;
2909                         continue;
2910                 }
2911                 break;
2912         } while (true);
2913         return open_braces;
2914 }
2915
2916 static int num_replaced = 0;
2917 static bool previous_single_replace = true;
2918
2919 void MatchStringAdv::CreateRegexp(FindAndReplaceOptions const & opt, string regexp_str, string regexp2_str, string par_as_string)
2920 {
2921 #if QTSEARCH
2922         // Handle \w properly
2923         QRegularExpression::PatternOptions popts = QRegularExpression::UseUnicodePropertiesOption | QRegularExpression::MultilineOption;
2924         if (! opt.casesensitive) {
2925                 popts |= QRegularExpression::CaseInsensitiveOption;
2926         }
2927         regexp = QRegularExpression(QString::fromStdString(regexp_str), popts);
2928         regexp2 = QRegularExpression(QString::fromStdString(regexp2_str), popts);
2929         regexError = "";
2930         if (regexp.isValid() && regexp2.isValid()) {
2931                 regexIsValid = true;
2932                 // Check '{', '}' pairs inside the regex
2933                 int balanced = 0;
2934                 int skip = 1;
2935                 for (unsigned i = 0; i < par_as_string.size(); i+= skip) {
2936                         char c = par_as_string[i];
2937                         if (c == '\\') {
2938                                 skip = 2;
2939                                 continue;
2940                         }
2941                         if (c == '{')
2942                                 balanced++;
2943                         else if (c == '}') {
2944                                 balanced--;
2945                                 if (balanced < 0)
2946                                         break;
2947                                 }
2948                                 skip = 1;
2949                         }
2950                 if (balanced != 0) {
2951                         regexIsValid = false;
2952                         regexError = "Unbalanced curly brackets in regexp \"" + regexp_str + "\"";
2953                 }
2954         }
2955         else {
2956                 regexIsValid = false;
2957                 if (!regexp.isValid())
2958                         regexError += "Invalid regexp \"" + regexp_str + "\", error = " + regexp.errorString().toStdString();
2959                 else
2960                         regexError += "Invalid regexp2 \"" + regexp2_str + "\", error = " + regexp2.errorString().toStdString();
2961         }
2962 #else
2963         if (opt.casesensitive) {
2964                 regexp = regex(regexp_str);
2965                 regexp2 = regex(regexp2_str);
2966         }
2967         else {
2968                 regexp = regex(regexp_str, std::regex_constants::icase);
2969                 regexp2 = regex(regexp2_str, std::regex_constants::icase);
2970         }
2971 #endif
2972 }
2973
2974 static void modifyRegexForMatchWord(string &t)
2975 {
2976         string s("");
2977         regex wordre("(\\\\)*((\\.|\\\\b))");
2978         size_t lastpos = 0;
2979         smatch sub;
2980         for (sregex_iterator it(t.begin(), t.end(), wordre), end; it != end; ++it) {
2981                 sub = *it;
2982                 if ((sub.position(2) - sub.position(0)) % 2 == 1) {
2983                         continue;
2984                 }
2985                 else if (sub.str(2) == "\\\\b")
2986                         return;
2987                 if (lastpos < (size_t) sub.position(2))
2988                         s += t.substr(lastpos, sub.position(2) - lastpos);
2989                 s += "\\S";
2990                 lastpos = sub.position(2) + sub.length(2);
2991         }
2992         if (lastpos == 0)
2993                 return;
2994         else if (lastpos < t.length())
2995                 s += t.substr(lastpos, t.length() - lastpos);
2996       t = "\\b" + s + "\\b";
2997 }
2998
2999 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions & opt)
3000         : p_buf(&buf), p_first_buf(&buf), opt(opt)
3001 {
3002         static std::regex specialChars { R"([-[\]{}()*+?.,\^$|#\s\\])" };
3003         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
3004         docstring const & ds = stringifySearchBuffer(find_buf, opt);
3005         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
3006         if (opt.replace_all && previous_single_replace) {
3007                 previous_single_replace = false;
3008                 num_replaced = 0;
3009         }
3010         else if (!opt.replace_all) {
3011                 num_replaced = 0;       // count number of replaced strings
3012                 previous_single_replace = true;
3013         }
3014         // When using regexp, braces are hacked already by escape_for_regex()
3015         par_as_string = normalize(ds);
3016         open_braces = 0;
3017         close_wildcards = 0;
3018
3019         size_t lead_size = 0;
3020         // correct the language settings
3021         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
3022         if (!use_regexp) {
3023                 identifyClosing(par_as_string); // Removes math closings ($, ], ...) at end of string
3024                 if (opt.ignoreformat) {
3025                         lead_size = 0;
3026                 }
3027                 else {
3028                         lead_size = identifyLeading(par_as_string);
3029                 }
3030                 lead_as_string = par_as_string.substr(0, lead_size);
3031                 string lead_as_regex_string = std::regex_replace(lead_as_string, specialChars,  R"(\$&)" );
3032                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
3033                 string par_as_regex_string_nolead = std::regex_replace(par_as_string_nolead, specialChars,  R"(\$&)" );
3034                 /* Handle whole words too in this case
3035                 */
3036                 if (opt.matchword) {
3037                         par_as_regex_string_nolead = "\\b" + par_as_regex_string_nolead + "\\b";
3038                         opt.matchword = false;
3039                 }
3040                 string regexp_str = "(" + lead_as_regex_string + ")()" + par_as_regex_string_nolead;
3041                 string regexp2_str = "(" + lead_as_regex_string + ")(.*?)" + par_as_regex_string_nolead;
3042                 CreateRegexp(opt, regexp_str, regexp2_str);
3043                 use_regexp = true;
3044                 return;
3045         }
3046
3047         if (!opt.ignoreformat) {
3048                 lead_size = identifyLeading(par_as_string);
3049                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
3050                 lead_as_string = par_as_string.substr(0, lead_size);
3051                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
3052         }
3053
3054         // Here we are using regexp
3055         LASSERT(use_regexp, /**/);
3056         {
3057                 string lead_as_regexp;
3058                 if (lead_size > 0) {
3059                         lead_as_regexp = std::regex_replace(par_as_string.substr(0, lead_size), specialChars,  R"(\$&)" );
3060                         par_as_string = par_as_string_nolead;
3061                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
3062                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
3063                 }
3064                 LYXERR(Debug::FIND, "par_as_string before escape_for_regex() is '" << par_as_string << "'");
3065                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
3066                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
3067                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
3068                 if (
3069                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
3070                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
3071                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
3072                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
3073                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
3074                         || regex_replace(par_as_string, par_as_string,
3075                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
3076                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
3077                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
3078                         ) {
3079                         ++close_wildcards;
3080                 }
3081                 if (!opt.ignoreformat) {
3082                         // Remove extra '\}' at end if not part of \{\.\}
3083                         size_t lng = par_as_string.size();
3084                         while(lng > 2) {
3085                                 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
3086                                         if (lng >= 6) {
3087                                                 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
3088                                                         break;
3089                                         }
3090                                         lng -= 2;
3091                                         open_braces++;
3092                                 }
3093                                 else
3094                                         break;
3095                         }
3096                         if (lng < par_as_string.size())
3097                                 par_as_string = par_as_string.substr(0,lng);
3098                         if ((lng > 0) && (par_as_string[0] == '^')) {
3099                                 par_as_string = par_as_string.substr(1);
3100                                 --lng;
3101                                 opt.matchstart = true;
3102                         }
3103                 }
3104                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
3105                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
3106                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
3107                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
3108
3109                 // If entered regexp must match at begin of searched string buffer
3110                 // Kornel: Added parentheses to use $1 for size of the leading string
3111                 string regexp_str;
3112                 string regexp2_str;
3113                 {
3114                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
3115                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
3116                         // so the convert has no effect in that case
3117                         for (int i = 7; i > 0; --i) {
3118                                 string orig = "\\\\" + std::to_string(i);
3119                                 string dest = "\\" + std::to_string(i+2);
3120                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
3121                         }
3122                         /* opt.matchword is ignored if using regex
3123                           so expanding par_as_string with "\\b" seems appropriate here
3124                           if regex contains for instance '.*' or '.+'
3125                           1.) Nothing to do, if 'par_as_string' contains "\\b" already.
3126                               (Means, that the user knows how to handle whole words
3127                           2.) else replace '.' with "\\S" and wrap the regex with "\\b"
3128                         */
3129                         if (opt.matchword) {
3130                                 modifyRegexForMatchWord(par_as_string);
3131                                 opt.matchword = false;
3132                         }
3133                         regexp_str = "(" + lead_as_regexp + ")()" + par_as_string;
3134                         regexp2_str = "(" + lead_as_regexp + ")(.*?)" + par_as_string;
3135                 }
3136                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
3137                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
3138                 CreateRegexp(opt, regexp_str, regexp2_str, par_as_string);
3139         }
3140 }
3141
3142 #if 0
3143 // Count number of characters in string
3144 // {]} ==> 1
3145 // \&  ==> 1
3146 // --- ==> 1
3147 // \\[a-zA-Z]+ ==> 1
3148 #if QTSEARCH
3149 static int computeSize(QStringRef s, int len)
3150 #define isLyxAlpha(arg) arg.isLetter()
3151 #else
3152 static int computeSize(string s, int len)
3153 #define isLyxAlpha(arg) isalpha(arg)
3154 #endif
3155 {
3156         if (len == 0)
3157                 return 0;
3158         int skip = 1;
3159         int count = 0;
3160         for (int i = 0; i < len; i += skip, count++) {
3161                 if (s.at(i) == '\\') {
3162                         skip = 2;
3163                         if (i + 1 < len && isLyxAlpha(s.at(i+1))) {
3164                                 for (int j = 2;  i+j < len; j++) {
3165                                         if (! isLyxAlpha(s.at(i+j))) {
3166                                                 if (s.at(i+j) == ' ')
3167                                                         skip++;
3168                                                 else if (s.at(i+j) == '{') {
3169                                                         if (i+j+1 < len && s.at(i+j+1) == '}')
3170                                                                 skip += 2;
3171                                                         else if (i + j + 1 >= len)
3172                                                                 skip++;
3173                                                 }
3174                                                 break;
3175                                         }
3176                                         skip++;
3177                                 }
3178                         }
3179                 }
3180                 else if (s.at(i) == '{') {
3181                         if (i + 1 < len && s.at(i+1) == '}')
3182                                 skip = 2;
3183                         else
3184                                 skip = 3;
3185                 }
3186                 else if (s.at(i) == '-') {
3187                         if (i+1 < len && s.at(i+1) == '-') {
3188                                 if (i + 2 < len && s.at(i+2) == '-')
3189                                         skip = 3;
3190                                 else
3191                                         skip = 2;
3192                         }
3193                         else
3194                                 skip = 1;
3195                 }
3196                 else {
3197                         skip = 1;
3198                 }
3199         }
3200         return count;
3201 }
3202 #endif
3203
3204 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
3205 {
3206         MatchResult mres;
3207
3208         if (at_begin &&
3209                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
3210                 return mres;
3211
3212         docstring docstr = stringifyFromForSearch(opt, cur, len);
3213         string str;
3214         if (use_regexp || opt.casesensitive)
3215                 str = normalize(docstr);
3216         else
3217                 str = normalize(lowercase(docstr));
3218         if (!opt.ignoreformat) {
3219                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
3220         }
3221         if (str.empty()) {
3222                 mres.match_len = -1;
3223                 return mres;
3224         }
3225         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
3226         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
3227
3228         if (use_regexp) {
3229                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
3230 #if QTSEARCH
3231                 QString qstr = QString::fromStdString(str);
3232                 QRegularExpression const *p_regexp;
3233                 QRegularExpression::MatchType flags = QRegularExpression::NormalMatch;
3234                 if (at_begin) {
3235                         p_regexp = &regexp;
3236                 } else {
3237                         p_regexp = &regexp2;
3238                 }
3239                 QRegularExpressionMatch match = p_regexp->match(qstr, 0, flags);
3240                 if (!match.hasMatch())
3241                         return mres;
3242 #else
3243                 regex const *p_regexp;
3244                 regex_constants::match_flag_type flags;
3245                 if (at_begin) {
3246                         flags = regex_constants::match_continuous;
3247                         p_regexp = &regexp;
3248                 } else {
3249                         flags = regex_constants::match_default;
3250                         p_regexp = &regexp2;
3251                 }
3252                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
3253                 if (re_it == sregex_iterator())
3254                         return mres;
3255                 match_results<string::const_iterator> const & m = *re_it;
3256 #endif
3257                 // Whole found string, including the leading
3258                 // std: m[0].second - m[0].first
3259                 // Qt: match.capturedEnd(0) - match.capturedStart(0)
3260                 //
3261                 // Size of the leading string
3262                 // std: m[1].second - m[1].first
3263                 // Qt: match.capturedEnd(1) - match.capturedStart(1)
3264                 int leadingsize = 0;
3265 #if QTSEARCH
3266                 if (match.lastCapturedIndex() > 0) {
3267                         leadingsize = match.capturedEnd(1) - match.capturedStart(1);
3268                 }
3269
3270 #else
3271                 if (m.size() > 2) {
3272                         leadingsize = m[1].second - m[1].first;
3273                 }
3274 #endif
3275 #if QTSEARCH
3276                 mres.match_prefix = match.capturedEnd(2) - match.capturedStart(2);
3277                 mres.match_len = match.capturedEnd(0) - match.capturedEnd(2);
3278                 // because of different number of closing at end of string
3279                 // we have to 'unify' the length of the post-match.
3280                 // Done by ignoring closing parenthesis and linefeeds at string end
3281                 int matchend = match.capturedEnd(0);
3282                 while (mres.match_len > 0) {
3283                   QChar c = qstr.at(matchend - 1);
3284                   if ((c == '\n') || (c == '}') || (c == '{')) {
3285                     mres.match_len--;
3286                     matchend--;
3287                   }
3288                   else
3289                     break;
3290                 }
3291                 size_t strsize = qstr.size();
3292                 while (strsize > (size_t) match.capturedEnd(0)) {
3293                         QChar c = qstr.at(strsize-1);
3294                         if ((c == '\n') || (c == '}')) {
3295                                 --strsize;
3296                         }
3297                         else
3298                                 break;
3299                 }
3300                 // LYXERR0(qstr.toStdString());
3301                 mres.match2end = strsize - matchend;
3302                 mres.pos = match.capturedStart(2);
3303 #else
3304                 mres.match_prefix = m[2].second - m[2].first;
3305                 mres.match_len = m[0].second - m[2].second;
3306                 // ignore closing parenthesis and linefeeds at string end
3307                 size_t strend = m[0].second - m[0].first;
3308                 int matchend = strend;
3309                 while (mres.match_len > 0) {
3310                   char c = str.at(matchend - 1);
3311                   if ((c == '\n') || (c == '}') || (c == '{')) {
3312                     mres.match_len--;
3313                     matchend--;
3314                   }
3315                   else
3316                     break;
3317                 }
3318                 size_t strsize = str.size();
3319                 while (strsize > strend) {
3320                         if ((str.at(strsize-1) == '}') || (str.at(strsize-1) == '\n')) {
3321                                 --strsize;
3322                         }
3323                         else
3324                                 break;
3325                 }
3326                 // LYXERR0(str);
3327                 mres.match2end = strsize - matchend;
3328                 mres.pos = m[2].first - m[0].first;;
3329 #endif
3330                 if (mres.match2end < 0)
3331                   mres.match_len = 0;
3332                 mres.leadsize = leadingsize;
3333 #if QTSEARCH
3334                 if (mres.match_len > 0) {
3335                   string a0 = match.captured(0).mid(mres.pos + mres.match_prefix, mres.match_len).toStdString();
3336                   mres.result.push_back(a0);
3337                   for (int i = 3; i <= match.lastCapturedIndex(); i++) {
3338                     mres.result.push_back(match.captured(i).toStdString());
3339                   }
3340                 }
3341 #else
3342                 if (mres.match_len > 0) {
3343                   string a0 = m[0].str().substr(mres.pos + mres.match_prefix, mres.match_len);
3344                   mres.result.push_back(a0);
3345                   for (size_t i = 3; i < m.size(); i++) {
3346                     mres.result.push_back(m[i]);
3347                   }
3348                 }
3349 #endif
3350                 return mres;
3351         }
3352
3353         // else !use_regexp: but all code paths above return
3354         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
3355                                  << par_as_string << "', str='" << str << "'");
3356         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
3357                                  << lead_as_string << "', par_as_string_nolead='"
3358                                  << par_as_string_nolead << "'");
3359
3360         if (at_begin) {
3361                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
3362                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
3363                 if (str.substr(0, par_as_string.size()) == par_as_string) {
3364                         mres.match_len = par_as_string.size();
3365                         mres.match2end = str.size();
3366                         mres.pos = 0;
3367                         return mres;
3368                 }
3369         } else {
3370                 // Start the search _after_ the leading part
3371                 size_t pos = str.find(par_as_string_nolead, lead_as_string.size());
3372                 if (pos != string::npos) {
3373                         mres.match_len = par_as_string.size();
3374                         mres.match2end = str.size() - pos;
3375                         mres.pos = pos;
3376                         return mres;
3377                 }
3378         }
3379         return mres;
3380 }
3381
3382
3383 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
3384 {
3385         MatchResult mres = findAux(cur, len, at_begin);
3386         int res = mres.match_len;
3387         LYXERR(Debug::FIND,
3388                "res=" << res << ", at_begin=" << at_begin
3389                << ", matchstart=" << opt.matchstart
3390                << ", inTexted=" << cur.inTexted());
3391         if (opt.matchstart) {
3392                 if (cur.pos() != 0)
3393                         mres.match_len = 0;
3394                 else if (mres.match_prefix > 0)
3395                         mres.match_len = 0;
3396                 return mres;
3397         }
3398         else
3399                 return mres;
3400         /* DEAD CODE follows
3401         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
3402                 return mres;
3403         if ((len > 0) && (res < len)) {
3404           mres.match_len = 0;
3405           return mres;
3406         }
3407         Paragraph const & par = cur.paragraph();
3408         bool ws_left = (cur.pos() > 0)
3409                 ? par.isWordSeparator(cur.pos() - 1)
3410                 : true;
3411         bool ws_right;
3412         if (len < 0)
3413                 ws_right = true;
3414         else {
3415                 ws_right = (cur.pos() + len < par.size())
3416                 ? par.isWordSeparator(cur.pos() + len)
3417                 : true;
3418         }
3419         LYXERR(Debug::FIND,
3420                "cur.pos()=" << cur.pos() << ", res=" << res
3421                << ", separ: " << ws_left << ", " << ws_right
3422                << ", len: " << len
3423                << endl);
3424         if (ws_left && ws_right) {
3425           // Check for word separators inside the found 'word'
3426           for (int i = 0; i < len; i++) {
3427             if (par.isWordSeparator(cur.pos() + i)) {
3428               mres.match_len = 0;
3429               return mres;
3430             }
3431           }
3432           return mres;
3433         }
3434         mres.match_len = 0;
3435         return mres;
3436         */
3437 }
3438
3439 #if 0
3440 static bool simple_replace(string &t, string from, string to)
3441 {
3442   regex repl("(\\\\)*(" + from + ")");
3443   string s("");
3444   size_t lastpos = 0;
3445   smatch sub;
3446   for (sregex_iterator it(t.begin(), t.end(), repl), end; it != end; ++it) {
3447     sub = *it;
3448     if ((sub.position(2) - sub.position(0)) % 2 == 1)
3449       continue;
3450     if (lastpos < (size_t) sub.position(2))
3451       s += t.substr(lastpos, sub.position(2) - lastpos);
3452     s += to;
3453     lastpos = sub.position(2) + sub.length(2);
3454   }
3455   if (lastpos == 0)
3456     return false;
3457   else if (lastpos < t.length())
3458     s += t.substr(lastpos, t.length() - lastpos);
3459   t = s;
3460   return true;
3461 }
3462 #endif
3463
3464 string MatchStringAdv::normalize(docstring const & s) const
3465 {
3466         string t;
3467         t = lyx::to_utf8(s);
3468         // Remove \n at begin
3469         while (!t.empty() && t[0] == '\n')
3470                 t = t.substr(1);
3471         // Remove \n at end
3472         while (!t.empty() && t[t.size() - 1] == '\n')
3473                 t = t.substr(0, t.size() - 1);
3474         size_t pos;
3475         // Handle all other '\n'
3476         while ((pos = t.find("\n")) != string::npos) {
3477                 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
3478                         // Handle '\\\n'
3479                         if (isAlnumASCII(t[pos+1])) {
3480                                 t.replace(pos-2, 3, " ");
3481                         }
3482                         else {
3483                                 t.replace(pos-2, 3, "");
3484                         }
3485                 }
3486                 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
3487                         // '\n' adjacent to non-alpha-numerics, discard
3488                         t.replace(pos, 1, "");
3489                 }
3490                 else {
3491                         // Replace all other \n with spaces
3492                         t.replace(pos, 1, " ");
3493                 }
3494         }
3495         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
3496         // Kornel: Added textsl, textsf, textit, texttt and noun
3497         // + allow to seach for colored text too
3498         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
3499         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
3500                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3501         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3502                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3503         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3504
3505         return t;
3506 }
3507
3508
3509 docstring stringifyFromCursor(DocIterator const & cur, int len)
3510 {
3511         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3512         if (cur.inTexted()) {
3513                 Paragraph const & par = cur.paragraph();
3514                 // TODO what about searching beyond/across paragraph breaks ?
3515                 // TODO Try adding a AS_STR_INSERTS as last arg
3516                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3517                         int(par.size()) : cur.pos() + len;
3518                 // OutputParams runparams(&cur.buffer()->params().encoding());
3519                 OutputParams runparams(encodings.fromLyXName("utf8"));
3520                 runparams.nice = true;
3521                 runparams.flavor = Flavor::XeTeX;
3522                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3523                 // No side effect of file copying and image conversion
3524                 runparams.dryrun = true;
3525                 runparams.for_search = true;
3526                 LYXERR(Debug::FIND, "Stringifying with cur: "
3527                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
3528                 return par.asString(cur.pos(), end,
3529                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3530                         &runparams);
3531         } else if (cur.inMathed()) {
3532                 CursorSlice cs = cur.top();
3533                 MathData md = cs.cell();
3534                 MathData::const_iterator it_end =
3535                         (( len == -1 || cs.pos() + len > int(md.size()))
3536                          ? md.end()
3537                          : md.begin() + cs.pos() + len );
3538                 MathData md2;
3539                 for (MathData::const_iterator it = md.begin() + cs.pos();
3540                      it != it_end; ++it)
3541                         md2.push_back(*it);
3542                 docstring s = asString(md2);
3543                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3544                 return s;
3545         }
3546         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3547         return docstring();
3548 }
3549
3550
3551 /** Computes the LaTeX export of buf starting from cur and ending len positions
3552  * after cur, if len is positive, or at the paragraph or innermost inset end
3553  * if len is -1.
3554  */
3555 docstring latexifyFromCursor(DocIterator const & cur, int len)
3556 {
3557         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3558         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3559                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3560         Buffer const & buf = *cur.buffer();
3561
3562         odocstringstream ods;
3563         otexstream os(ods);
3564         //OutputParams runparams(&buf.params().encoding());
3565         OutputParams runparams(encodings.fromLyXName("utf8"));
3566         runparams.nice = false;
3567         runparams.flavor = Flavor::XeTeX;
3568         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3569         // No side effect of file copying and image conversion
3570         runparams.dryrun = true;
3571         runparams.for_search = true;
3572
3573         if (cur.inTexted()) {
3574                 // @TODO what about searching beyond/across paragraph breaks ?
3575                 pos_type endpos = cur.paragraph().size();
3576                 if (len != -1 && endpos > cur.pos() + len)
3577                         endpos = cur.pos() + len;
3578                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3579                           string(), cur.pos(), endpos);
3580                 string s = lyx::to_utf8(ods.str());
3581                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3582                 return(lyx::from_utf8(s));
3583         } else if (cur.inMathed()) {
3584                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3585                 for (int s = cur.depth() - 1; s >= 0; --s) {
3586                         CursorSlice const & cs = cur[s];
3587                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3588                                 TeXMathStream ws(os);
3589                                 cs.asInsetMath()->asHullInset()->header_write(ws);
3590                                 break;
3591                         }
3592                 }
3593
3594                 CursorSlice const & cs = cur.top();
3595                 MathData md = cs.cell();
3596                 MathData::const_iterator it_end =
3597                         ((len == -1 || cs.pos() + len > int(md.size()))
3598                          ? md.end()
3599                          : md.begin() + cs.pos() + len);
3600                 MathData md2;
3601                 for (MathData::const_iterator it = md.begin() + cs.pos();
3602                      it != it_end; ++it)
3603                         md2.push_back(*it);
3604
3605                 ods << asString(md2);
3606                 // Retrieve the math environment type, and add '$' or '$]'
3607                 // or others (\end{equation}) accordingly
3608                 for (int s = cur.depth() - 1; s >= 0; --s) {
3609                         CursorSlice const & cs2 = cur[s];
3610                         InsetMath * inset = cs2.asInsetMath();
3611                         if (inset && inset->asHullInset()) {
3612                                 TeXMathStream ws(os);
3613                                 inset->asHullInset()->footer_write(ws);
3614                                 break;
3615                         }
3616                 }
3617                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3618         } else {
3619                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3620         }
3621         return ods.str();
3622 }
3623
3624 #if defined(ResultsDebug)
3625 // Debugging output
3626 static void displayMResult(MatchResult &mres, int increment)
3627 {
3628   LYXERR0( "pos: " << mres.pos << " increment " << increment);
3629   LYXERR0( "leadsize: " << mres.leadsize);
3630   LYXERR0( "match_len: " << mres.match_len);
3631   LYXERR0( "match_prefix: " << mres.match_prefix);
3632   LYXERR0( "match2end: " << mres.match2end);
3633   LYXERR0( "pos_len: " << mres.pos_len);        // Set in finalize
3634   for (size_t i = 0; i < mres.result.size(); i++)
3635     LYXERR0( "Match " << i << " = \"" << mres.result[i] << "\"");
3636 }
3637         #define displayMres(s,i) displayMResult(s,i);
3638 #else
3639         #define displayMres(s,i)
3640 #endif
3641
3642 static bool findAdvForwardInnermost(DocIterator & cur)
3643 {
3644         size_t d;
3645         DocIterator old_cur(cur.buffer());
3646         int forwardCount = 0;
3647         do {
3648                 d = cur.depth();
3649                 old_cur = cur;
3650                 cur.forwardPos();
3651                 if (!cur) {
3652                         break;
3653                 }
3654                 if (cur.depth() > d) {
3655                         forwardCount++;
3656                         continue;
3657                 }
3658                 if (cur.depth() == d)
3659                         break;
3660         } while(1);
3661         cur = old_cur;
3662         if (forwardCount > 0) {
3663                 LYXERR(Debug::FIND, "Forwarded " << forwardCount << " step(s) (searching for innermost match)");
3664                 return true;;
3665         }
3666         else
3667                 return false;
3668 }
3669
3670 /** Finalize an advanced find operation, advancing the cursor to the innermost
3671  ** position that matches, plus computing the length of the matching text to
3672  ** be selected
3673  ** Return the cur.pos() difference between start and end of found match
3674  **/
3675 MatchResult &findAdvFinalize(DocIterator & cur, MatchStringAdv const & match, MatchResult const & expected = MatchResult(-1))
3676 {
3677         // Search the foremost position that matches (avoids find of entire math
3678         // inset when match at start of it)
3679         DocIterator old_cur(cur.buffer());
3680         MatchResult mres;
3681         static MatchResult fail = MatchResult();
3682         static MatchResult max_match;
3683         // If (prefix_len > 0) means that forwarding 1 position will remove the complete entry
3684         // Happens with e.g. hyperlinks
3685         // either one sees "http://www.bla.bla" or nothing
3686         // so the search for "www" gives prefix_len = 7 (== sizeof("http://")
3687         // and although we search for only 3 chars, we find the whole hyperlink inset
3688         bool at_begin = (expected.match_prefix == 0);
3689         if (findAdvForwardInnermost(cur)) {
3690                 mres = match(cur, -1, at_begin);
3691                 displayMres(mres, 0);
3692                 if (expected.match_len > 0) {
3693                         if (mres.match_len < expected.match_len)
3694                                 return fail;
3695                 }
3696                 else {
3697                         if (mres.match_len <= 0)
3698                                 return fail;
3699                 }
3700                 max_match = mres.match_len;
3701         }
3702         else if (expected.match_len < 0) {
3703                 mres = match(cur);      /* match valid only if not searching whole words */
3704                 displayMres(mres, 0);
3705                 max_match = mres;
3706         }
3707         else {
3708                 max_match = expected;
3709         }
3710         if (max_match.match_len <= 0) return fail;
3711         LYXERR(Debug::FIND, "Ok");
3712
3713         // Compute the match length
3714         int len = 1;
3715         if (cur.pos() + len > cur.lastpos())
3716           return fail;
3717         // regexp should use \w+, \S+, or \b(some string)\b
3718         // to search for whole words
3719         if (match.opt.matchword && !match.use_regexp) {
3720           LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3721           while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3722             ++len;
3723             LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3724           }
3725           // Length of matched text (different from len param)
3726           static MatchResult old_match = match(cur, len, at_begin);
3727           if (old_match.match_len < 0)
3728             old_match = fail;
3729           MatchResult new_match;
3730           // Greedy behaviour while matching regexps
3731           while ((new_match = match(cur, len + 1, at_begin)).match_len > old_match.match_len) {
3732             ++len;
3733             old_match = new_match;
3734             LYXERR(Debug::FIND, "verifying   match with len = " << len);
3735           }
3736           return old_match;
3737         }
3738         else {
3739           int minl = 1;
3740           int maxl = cur.lastpos() - cur.pos();
3741           // Greedy behaviour while matching regexps
3742           while (maxl > minl) {
3743             MatchResult mres2;
3744             mres2 = match(cur, len, at_begin);
3745             displayMres(mres2, len);
3746             int actual_match = mres2.match_len;
3747             if (actual_match >= max_match.match_len) {
3748               // actual_match > max_match _can_ happen,
3749               // if the search area splits
3750               // some following word so that the regex
3751               // (e.g. 'r.*r\b' matches 'r' from the middle of the
3752               // splitted word)
3753               // This means, the len value is too big
3754               maxl = len;
3755               if (maxl - minl < 4)
3756                 len = (int)((maxl + minl)/2);
3757               else
3758                 len = (int)(minl + (maxl - minl + 3)/4);
3759             }
3760             else {
3761               // (actual_match < max_match)
3762               minl = len + 1;
3763               len = (int)((maxl + minl)/2);
3764             }
3765           }
3766           old_cur = cur;
3767           // Search for real start of matched characters
3768           while (len > 1) {
3769             MatchResult actual_match;
3770             do {
3771               cur.forwardPos();
3772             } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3773             if (cur.depth() < old_cur.depth()) {
3774               // Outer inset?
3775               LYXERR(Debug::INFO, "cur.depth() < old_cur.depth(), this should never happen");
3776               break;
3777             }
3778             if (cur.pos() != old_cur.pos()) {
3779               // OK, forwarded 1 pos in actual inset
3780               actual_match = match(cur, len-1, at_begin);
3781               if (actual_match.match_len == max_match.match_len) {
3782                 // Ha, got it! The shorter selection has the same match length
3783                 len--;
3784                 old_cur = cur;
3785               }
3786               else {
3787                 // OK, the shorter selection matches less chars, revert to previous value
3788                 cur = old_cur;
3789                 break;
3790               }
3791             }
3792             else {
3793               LYXERR(Debug::INFO, "cur.pos() == old_cur.pos(), this should never happen");
3794               actual_match = match(cur, len, at_begin);
3795               if (actual_match.match_len == max_match.match_len) {
3796                 old_cur = cur;
3797                 max_match = actual_match;
3798               }
3799             }
3800           }
3801           if (len == 0)
3802             return fail;
3803           else {
3804             max_match.pos_len = len;
3805             return max_match;
3806           }
3807         }
3808 }
3809
3810 /// Finds forward
3811 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
3812 {
3813         if (!cur)
3814                 return 0;
3815         while (!theApp()->longOperationCancelled() && cur) {
3816                 (void) findAdvForwardInnermost(cur);
3817                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3818                 MatchResult mres = match(cur, -1, false);
3819                 displayMres(mres,-1)
3820                 int match_len = mres.match_len;
3821                 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3822                         LYXERR(Debug::INFO, "BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3823                         match_len = 0;
3824                 }
3825                 if (match_len > 0) {
3826                         // Try to find the begin of searched string
3827                         int increment;
3828                         int firstInvalid = 100000;
3829                         if (mres.match_prefix + mres.pos - mres.leadsize > 1)
3830                           increment = (mres.match_prefix + mres.pos - mres.leadsize + 1)*3/4;
3831                         else
3832                           increment = 10;
3833                         LYXERR(Debug::FIND, "Set increment to " << increment);
3834                         while (increment > 0) {
3835                                 DocIterator old_cur = cur;
3836                                 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3837                                 }
3838                                 if (! cur || (cur.pit() > old_cur.pit())) {
3839                                         // Are we outside of the paragraph?
3840                                         // This can happen if moving past some UTF8-encoded chars
3841                                         cur = old_cur;
3842                                         increment /= 2;
3843                                 }
3844                                 else {
3845                                         MatchResult mres2 = match(cur, -1, false);
3846                                         displayMres(mres2,increment)
3847                                         switch (interpretMatch(mres, mres2)) {
3848                                         case MatchResult::newIsTooFar:
3849                                           // behind the expected match
3850                                           firstInvalid = increment;
3851                                           cur = old_cur;
3852                                           increment /= 2;
3853                                           break;
3854                                         case MatchResult::newIsBetter:
3855                                           // not reached ye, but cur.pos()+increment is bettert
3856                                           mres = mres2;
3857                                           firstInvalid -= increment;
3858                                           if (increment > firstInvalid*3/4)
3859                                             increment = firstInvalid*3/4;
3860                                           if ((mres2.pos == mres2.leadsize) && (increment >= mres2.match_prefix)) {
3861                                             if (increment >= mres2.match_prefix)
3862                                               increment = (mres2.match_prefix+1)*3/4;
3863                                           }
3864                                           break;
3865                                         default:
3866                                           // Todo@
3867                                           // Handle not like MatchResult::newIsTooFar
3868                                           // LYXERR0( "Something is wrong: Increment = " << increment << " match_prefix = " << mres.match_prefix);
3869                                           firstInvalid--;
3870                                           increment = increment*3/4;
3871                                           cur = old_cur;
3872                                           break;
3873                                         }
3874                                 }
3875                         }
3876                         // LYXERR0("Leaving first loop");
3877                         {
3878                           LYXERR(Debug::FIND, "Finalizing 1");
3879                           MatchResult found_match = findAdvFinalize(cur, match, mres);
3880                           if (found_match.match_len > 0) {
3881                             LASSERT(found_match.pos_len > 0, /**/);
3882                             match.FillResults(found_match);
3883                             return found_match.pos_len;
3884                           }
3885                           else {
3886                             // try next possible match
3887                             cur.forwardPos();
3888                             continue;
3889                           }
3890                         }
3891                         // The following code is newer reached
3892                         // but parts of it may be needed in future
3893                         int match_len_zero_count = 0;
3894                         MatchResult mres3;
3895                         for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3896                                 if (i++ > 3) {
3897                                         mres3 = match(cur, -1, false);
3898                                         displayMres(mres3, 1)
3899                                         int remaining_len = mres3.match_len;
3900                                         if (remaining_len <= 0) {
3901                                                 // Apparently the searched string is not in the remaining part
3902                                                 break;
3903                                         }
3904                                         else {
3905                                                 i = 0;
3906                                         }
3907                                 }
3908                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3909                                 mres3 = match(cur, 1);
3910                                 displayMres(mres3, 1)
3911                                 int match_len3 = mres3.match_len;
3912                                 if (match_len3 < 0)
3913                                         continue;
3914                                 mres3 = match(cur);
3915                                 displayMres(mres3, 1)
3916                                 int match_len2 = mres3.match_len;
3917                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3918                                 if (match_len2 > 0) {
3919                                         // Sometimes in finalize we understand it wasn't a match
3920                                         // and we need to continue the outest loop
3921                                         LYXERR(Debug::FIND, "Finalizing 2");
3922                                         MatchResult mres4 = findAdvFinalize(cur, match, mres.match_len);
3923                                         if (mres4.match_len > 0) {
3924                                                 match.FillResults(mres4);
3925                                                 LASSERT(mres4.pos_len > 0, /**/);
3926                                                 return mres4.pos_len;
3927                                         }
3928                                 }
3929                                 if (match_len2 > 0)
3930                                         match_len_zero_count = 0;
3931                                 else if (match_len2 == 0)
3932                                         match_len_zero_count++;
3933                                 if (match_len2 < 0) {
3934                                         if (++match_len_zero_count > 3) {
3935                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3936                                         }
3937                                         break;
3938                                 }
3939                         }
3940                         if (!cur)
3941                                 return 0;
3942                 }
3943                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3944                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3945                         cur.forwardPar();
3946                 } else {
3947                         // This should exit nested insets, if any, or otherwise undefine the currsor.
3948                         cur.pos() = cur.lastpos();
3949                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3950                         cur.forwardPos();
3951                 }
3952         }
3953         return 0;
3954 }
3955
3956
3957 /// Find the most backward consecutive match within same paragraph while searching backwards.
3958 MatchResult &findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3959 {
3960         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3961         DocIterator tmp_cur = cur;
3962         static MatchResult mr = findAdvFinalize(tmp_cur, match, MatchResult(-1));
3963         Inset & inset = cur.inset();
3964         for (; cur != cur_begin; cur.backwardPos()) {
3965                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3966                 DocIterator new_cur = cur;
3967                 new_cur.backwardPos();
3968                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3969                         break;
3970                 MatchResult new_mr = findAdvFinalize(new_cur, match, MatchResult(-1));
3971                 if (new_mr.match_len == mr.match_len)
3972                         break;
3973                 mr = new_mr;
3974         }
3975         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3976         return mr;
3977 }
3978
3979
3980 /// Finds backwards
3981 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3982 {
3983         if (! cur)
3984                 return 0;
3985         // Backup of original position
3986         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3987         if (cur == cur_begin)
3988                 return 0;
3989         cur.backwardPos();
3990         DocIterator cur_orig(cur);
3991         bool pit_changed = false;
3992         do {
3993                 cur.pos() = 0;
3994                 bool found_match = (match(cur, -1, false).match_len > 0);
3995
3996                 if (found_match) {
3997                         if (pit_changed)
3998                                 cur.pos() = cur.lastpos();
3999                         else
4000                                 cur.pos() = cur_orig.pos();
4001                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
4002                         DocIterator cur_prev_iter;
4003                         do {
4004                                 found_match = (match(cur).match_len > 0);
4005                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
4006                                        << found_match << ", cur: " << cur);
4007                                 if (found_match) {
4008                                         MatchResult found_mr = findMostBackwards(cur, match);
4009                                         match.FillResults(found_mr);
4010                                         LASSERT(found_mr.pos_len > 0, /**/);
4011                                         return found_mr.pos_len;
4012                                 }
4013
4014                                 // Stop if begin of document reached
4015                                 if (cur == cur_begin)
4016                                         break;
4017                                 cur_prev_iter = cur;
4018                                 cur.backwardPos();
4019                         } while (true);
4020                 }
4021                 if (cur == cur_begin)
4022                         break;
4023                 if (cur.pit() > 0)
4024                         --cur.pit();
4025                 else
4026                         cur.backwardPos();
4027                 pit_changed = true;
4028         } while (!theApp()->longOperationCancelled());
4029         return 0;
4030 }
4031
4032
4033 } // namespace
4034
4035
4036 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
4037                                  DocIterator const & cur, int len)
4038 {
4039         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
4040                 return docstring();
4041         if (!opt.ignoreformat)
4042                 return latexifyFromCursor(cur, len);
4043         else
4044                 return stringifyFromCursor(cur, len);
4045 }
4046
4047
4048 FindAndReplaceOptions::FindAndReplaceOptions(
4049         docstring const & _find_buf_name, bool _casesensitive,
4050         bool _matchword, bool _forward, bool _expandmacros, bool _ignoreformat,
4051         docstring const & _repl_buf_name, bool _keep_case,
4052         SearchScope _scope, SearchRestriction _restr, bool _replace_all)
4053         : find_buf_name(_find_buf_name), casesensitive(_casesensitive), matchword(_matchword),
4054           forward(_forward), expandmacros(_expandmacros), ignoreformat(_ignoreformat),
4055           repl_buf_name(_repl_buf_name), keep_case(_keep_case), scope(_scope), restr(_restr), replace_all(_replace_all)
4056 {
4057 }
4058
4059
4060 namespace {
4061
4062
4063 /** Check if 'len' letters following cursor are all non-lowercase */
4064 static bool allNonLowercase(Cursor const & cur, int len)
4065 {
4066         pos_type beg_pos = cur.selectionBegin().pos();
4067         pos_type end_pos = cur.selectionBegin().pos() + len;
4068         if (len > cur.lastpos() + 1 - beg_pos) {
4069                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
4070                 len = cur.lastpos() + 1 - beg_pos;
4071                 end_pos = beg_pos + len;
4072         }
4073         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
4074                 if (isLowerCase(cur.paragraph().getChar(pos)))
4075                         return false;
4076         return true;
4077 }
4078
4079
4080 /** Check if first letter is upper case and second one is lower case */
4081 static bool firstUppercase(Cursor const & cur)
4082 {
4083         char_type ch1, ch2;
4084         pos_type pos = cur.selectionBegin().pos();
4085         if (pos >= cur.lastpos() - 1) {
4086                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
4087                 return false;
4088         }
4089         ch1 = cur.paragraph().getChar(pos);
4090         ch2 = cur.paragraph().getChar(pos + 1);
4091         bool result = isUpperCase(ch1) && isLowerCase(ch2);
4092         LYXERR(Debug::FIND, "firstUppercase(): "
4093                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
4094                << ch2 << "(" << char(ch2) << ")"
4095                << ", result=" << result << ", cur=" << cur);
4096         return result;
4097 }
4098
4099
4100 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
4101  **
4102  ** \fixme What to do with possible further paragraphs in replace buffer ?
4103  **/
4104 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
4105 {
4106         ParagraphList::iterator pit = buffer.paragraphs().begin();
4107         LASSERT(!pit->empty(), /**/);
4108         pos_type right = pos_type(1);
4109         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
4110         right = pit->size();
4111         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
4112 }
4113 } // namespace
4114
4115 #if 1
4116 static bool replaceMatches(string &t, int maxmatchnum, vector <string> const & replacements)
4117 {
4118   // Should replace the string "$" + std::to_string(matchnum) with replacement
4119   // if the char '$' is not prefixed with odd number of char '\\'
4120   static regex const rematch("(\\\\)*(\\$\\$([0-9]))");
4121   string s;
4122   size_t lastpos = 0;
4123   smatch sub;
4124   for (sregex_iterator it(t.begin(), t.end(), rematch), end; it != end; ++it) {
4125     sub = *it;
4126     if ((sub.position(2) - sub.position(0)) % 2 == 1)
4127       continue;
4128     int num = stoi(sub.str(3), nullptr, 10);
4129     if (num >= maxmatchnum)
4130       continue;
4131     if (lastpos < (size_t) sub.position(2))
4132       s += t.substr(lastpos, sub.position(2) - lastpos);
4133     s += replacements[num];
4134     lastpos = sub.position(2) + sub.length(2);
4135   }
4136   if (lastpos == 0)
4137     return false;
4138   else if (lastpos < t.length())
4139     s += t.substr(lastpos, t.length() - lastpos);
4140   t = s;
4141   return true;
4142 }
4143 #endif
4144
4145 ///
4146 static int findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
4147 {
4148         Cursor & cur = bv->cursor();
4149         if (opt.repl_buf_name.empty()
4150             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
4151             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
4152                 return 0;
4153
4154         DocIterator sel_beg = cur.selectionBegin();
4155         DocIterator sel_end = cur.selectionEnd();
4156         if (&sel_beg.inset() != &sel_end.inset()
4157             || sel_beg.pit() != sel_end.pit()
4158             || sel_beg.idx() != sel_end.idx())
4159                 return 0;
4160         int sel_len = sel_end.pos() - sel_beg.pos();
4161         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
4162                << ", sel_len: " << sel_len << endl);
4163         if (sel_len == 0)
4164                 return 0;
4165         LASSERT(sel_len > 0, return 0);
4166
4167         if (!matchAdv(sel_beg, sel_len).match_len)
4168                 return 0;
4169
4170         // Build a copy of the replace buffer, adapted to the KeepCase option
4171         Buffer const & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
4172         ostringstream oss;
4173         repl_buffer_orig.write(oss);
4174         string lyx = oss.str();
4175         if (matchAdv.valid_matches > 0) {
4176           replaceMatches(lyx, matchAdv.valid_matches, matchAdv.matches);
4177         }
4178         Buffer repl_buffer("", false);
4179         repl_buffer.setUnnamed(true);
4180         LASSERT(repl_buffer.readString(lyx), return 0);
4181         if (opt.keep_case && sel_len >= 2) {
4182                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
4183                 if (cur.inTexted()) {
4184                         if (firstUppercase(cur))
4185                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
4186                         else if (allNonLowercase(cur, sel_len))
4187                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
4188                 }
4189         }
4190         cap::cutSelection(cur, false);
4191         if (cur.inTexted()) {
4192                 repl_buffer.changeLanguage(
4193                         repl_buffer.language(),
4194                         cur.getFont().language());
4195                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
4196                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
4197                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
4198                                         repl_buffer.params().documentClassPtr(),
4199                                         bv->buffer().errorList("Paste"));
4200                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
4201                 sel_len = repl_buffer.paragraphs().begin()->size();
4202         } else if (cur.inMathed()) {
4203                 odocstringstream ods;
4204                 otexstream os(ods);
4205                 // OutputParams runparams(&repl_buffer.params().encoding());
4206                 OutputParams runparams(encodings.fromLyXName("utf8"));
4207                 runparams.nice = false;
4208                 runparams.flavor = Flavor::XeTeX;
4209                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
4210                 runparams.dryrun = true;
4211                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
4212                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
4213                 docstring repl_latex = ods.str();
4214                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
4215                 string s;
4216                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
4217                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
4218                 repl_latex = from_utf8(s);
4219                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
4220                 MathData ar(cur.buffer());
4221                 asArray(repl_latex, ar, Parse::NORMAL);
4222                 cur.insert(ar);
4223                 sel_len = ar.size();
4224                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
4225         }
4226         if (cur.pos() >= sel_len)
4227                 cur.pos() -= sel_len;
4228         else
4229                 cur.pos() = 0;
4230         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
4231         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
4232         bv->processUpdateFlags(Update::Force);
4233         return 1;
4234 }
4235
4236
4237 /// Perform a FindAdv operation.
4238 bool findAdv(BufferView * bv, FindAndReplaceOptions & opt)
4239 {
4240         DocIterator cur;
4241         int pos_len = 0;
4242
4243         // e.g., when invoking word-findadv from mini-buffer wither with
4244         //       wrong options syntax or before ever opening advanced F&R pane
4245         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
4246                 return false;
4247
4248         try {
4249                 MatchStringAdv matchAdv(bv->buffer(), opt);
4250 #if QTSEARCH
4251                 if (!matchAdv.regexIsValid) {
4252                         bv->message(lyx::from_utf8(matchAdv.regexError));
4253                         return(false);
4254                 }
4255 #endif
4256                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
4257                 if (length > 0)
4258                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
4259                 num_replaced += findAdvReplace(bv, opt, matchAdv);
4260                 cur = bv->cursor();
4261                 if (opt.forward)
4262                         pos_len = findForwardAdv(cur, matchAdv);
4263                 else
4264                         pos_len = findBackwardsAdv(cur, matchAdv);
4265         } catch (exception & ex) {
4266                 bv->message(from_utf8(ex.what()));
4267                 return false;
4268         }
4269
4270         if (pos_len == 0) {
4271                 if (num_replaced > 0) {
4272                         switch (num_replaced)
4273                         {
4274                                 case 1:
4275                                         bv->message(_("One match has been replaced."));
4276                                         break;
4277                                 case 2:
4278                                         bv->message(_("Two matches have been replaced."));
4279                                         break;
4280                                 default:
4281                                         bv->message(bformat(_("%1$d matches have been replaced."), num_replaced));
4282                                         break;
4283                         }
4284                         num_replaced = 0;
4285                 }
4286                 else {
4287                         bv->message(_("Match not found."));
4288                 }
4289                 return false;
4290         }
4291
4292         if (num_replaced > 0)
4293                 bv->message(_("Match has been replaced."));
4294         else
4295                 bv->message(_("Match found."));
4296
4297         if (cur.pos() + pos_len > cur.lastpos()) {
4298                 // Prevent crash in bv->putSelectionAt()
4299                 // Should never happen, maybe LASSERT() here?
4300                 pos_len = cur.lastpos() - cur.pos();
4301         }
4302         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << pos_len);
4303         bv->putSelectionAt(cur, pos_len, !opt.forward);
4304
4305         return true;
4306 }
4307
4308
4309 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
4310 {
4311         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
4312            << opt.casesensitive << ' '
4313            << opt.matchword << ' '
4314            << opt.forward << ' '
4315            << opt.expandmacros << ' '
4316            << opt.ignoreformat << ' '
4317            << opt.replace_all << ' '
4318            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
4319            << opt.keep_case << ' '
4320            << int(opt.scope) << ' '
4321            << int(opt.restr);
4322
4323         LYXERR(Debug::FIND, "built: " << os.str());
4324
4325         return os;
4326 }
4327
4328
4329 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
4330 {
4331         LYXERR(Debug::FIND, "parsing");
4332         string s;
4333         string line;
4334         getline(is, line);
4335         while (line != "EOSS") {
4336                 if (! s.empty())
4337                         s = s + "\n";
4338                 s = s + line;
4339                 if (is.eof())   // Tolerate malformed request
4340                         break;
4341                 getline(is, line);
4342         }
4343         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
4344         opt.find_buf_name = from_utf8(s);
4345         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.replace_all;
4346         is.get();       // Waste space before replace string
4347         s = "";
4348         getline(is, line);
4349         while (line != "EOSS") {
4350                 if (! s.empty())
4351                         s = s + "\n";
4352                 s = s + line;
4353                 if (is.eof())   // Tolerate malformed request
4354                         break;
4355                 getline(is, line);
4356         }
4357         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
4358         opt.repl_buf_name = from_utf8(s);
4359         is >> opt.keep_case;
4360         int i;
4361         is >> i;
4362         opt.scope = FindAndReplaceOptions::SearchScope(i);
4363         is >> i;
4364         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
4365
4366         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
4367                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
4368                << opt.scope << ' ' << opt.restr);
4369         return is;
4370 }
4371
4372 } // namespace lyx