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