]> git.lyx.org Git - lyx.git/blob - src/lyxfind.cpp
FindAdv: Amend b21c8b21: Expand the list for handled latin characters
[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           accents[key] = values.substr(start, j);
1272           start = values.size() - 1;
1273           break;
1274         }
1275         else if ((values[start+j] & 0xc0) == 0xc0) {
1276           // This is the first byte of following utf8 char
1277           accents[key] = values.substr(start, j);
1278           start += j;
1279           break;
1280         }
1281       }
1282     }
1283   }
1284 }
1285
1286 static void buildAccentsMap()
1287 {
1288   accents["imath"] = "ı";
1289   accents["i"] = "ı";
1290   accents["jmath"] = "ȷ";
1291   accents["lyxmathsym{ß}"] = "ß";
1292   accents["ddot{\\imath}"] = "ï";
1293   buildaccent("ddot", "aAeEiIoOuUyY",
1294                       "äÄëËïÏöÖüÜÿŸ");      // umlaut
1295   buildaccent("dot|.", "cCeEgGiIzZaAoObBdDfFyY",
1296                        "ċĊėĖġĠiİżŻȧȦȯȮḃḂḋḊḟḞẏẎ");
1297   accents["acute{\\imath}"] = "í";
1298   buildaccent("acute", "aAcCeElLoOnNrRsSuUyYzZiI",
1299                        "áÁćĆéÉĺĹóÓńŃŕŔśŚúÚýÝźŹíÍ");
1300   buildaccent("dacute|H|h", "oOuU", "őŐűŰ");        // double acute
1301   buildaccent("mathring|r", "uU", "ůŮ");
1302   accents["check{\\imath}"] = "ǐ";
1303   accents["check{\\jmath}"] = "ǰ";
1304   buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTzZ",
1305                          "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤžŽ");     // caron
1306   accents["hat{\\imath}"] = "î";
1307   accents["hat{\\jmath}"] = "ĵ";
1308   buildaccent("hat|^", "aAeEiIcCgGhHjJsSwWyYzZoOuU",
1309                        "âÂêÊîÎĉĈĝĜĥĤĵĴŝŜŵŴŷŶẑẐôÔûÛ");       // circ
1310   accents["bar{\\imath}"] = "ī";
1311   buildaccent("bar|=", "aAeEiIoOuUyY",
1312                        "āĀēĒīĪōŌūŪȳȲ");     // macron
1313   accents["tilde{\\imath}"] = "ĩ";
1314   buildaccent("tilde", "aAnNoOiIuU",
1315                        "ãÃñÑõÕĩĨũŨ"); // tilde
1316   accents["breve{\\imath}"] = "ĭ";
1317   buildaccent("breve|u", "aAeEgGiIoOuU",
1318                          "ăĂĕĔğĞĭĬŏŎŭŬ");    // breve
1319   accents["grave{\\imath}"] = "ì";
1320   buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1321                          "àÀèÈìÌòÒùÙǹǸẁẀỳỲ");                // grave
1322 }
1323
1324 /*
1325  * Created accents in math or regexp environment
1326  * are macros, but we need the utf8 equivalent
1327  */
1328 void Intervall::removeAccents()
1329 {
1330   if (accents.empty())
1331     buildAccentsMap();
1332   static regex const accre("\\\\((.|grave|breve|u|lyxmathsym|ddot|dot|acute|dacute|mathring|check|hat|bar|tilde)\\{[^\\{\\}]+\\}|i|imath|jmath)");
1333   smatch sub;
1334   for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1335     sub = *itacc;
1336     string key = sub.str(1);
1337     if (accents.find(key) != accents.end()) {
1338       string val = accents[key];
1339       size_t pos = sub.position(0);
1340       for (size_t i = 0; i < val.size(); i++) {
1341         par[pos+i] = val[i];
1342       }
1343       addIntervall(pos+val.size(), pos + sub.str(0).size());
1344       for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1345         // remove any remaining parentheses
1346         par[i] = ' ';
1347       }
1348     }
1349     else {
1350       LYXERR0("Not added accent for \"" << key << "\"");
1351     }
1352   }
1353 }
1354
1355 void Intervall::handleOpenP(int i)
1356 {
1357   actualdeptindex++;
1358   depts[actualdeptindex] = i+1;
1359   closes[actualdeptindex] = -1;
1360   checkDepthIndex(actualdeptindex);
1361 }
1362
1363 void Intervall::handleCloseP(int i, bool closingAllowed)
1364 {
1365   if (actualdeptindex <= 0) {
1366     if (! closingAllowed)
1367       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1368     // if we are at the very end
1369     addIntervall(i, i+1);
1370   }
1371   else {
1372     closes[actualdeptindex] = i+1;
1373     actualdeptindex--;
1374   }
1375 }
1376
1377 void Intervall::resetOpenedP(int openPos)
1378 {
1379   // Used as initializer for foreignlanguage entry
1380   actualdeptindex = 1;
1381   depts[1] = openPos+1;
1382   closes[1] = -1;
1383 }
1384
1385 int Intervall::previousNotIgnored(int start)
1386 {
1387     int idx = 0;                          /* int intervalls */
1388     for (idx = ignoreidx; idx >= 0; --idx) {
1389       if (start > borders[idx].upper)
1390         return start;
1391       if (start >= borders[idx].low)
1392         start = borders[idx].low-1;
1393     }
1394     return start;
1395 }
1396
1397 int Intervall::nextNotIgnored(int start)
1398 {
1399     int idx = 0;                          /* int intervalls */
1400     for (idx = 0; idx <= ignoreidx; idx++) {
1401       if (start < borders[idx].low)
1402         return start;
1403       if (start < borders[idx].upper)
1404         start = borders[idx].upper;
1405     }
1406     return start;
1407 }
1408
1409 typedef map<string, KeyInfo> KeysMap;
1410 typedef vector< KeyInfo> Entries;
1411 static KeysMap keys = map<string, KeyInfo>();
1412
1413 class LatexInfo {
1414  private:
1415   int entidx;
1416   Entries entries;
1417   Intervall interval;
1418   void buildKeys(bool);
1419   void buildEntries(bool);
1420   void makeKey(const string &, KeyInfo, bool isPatternString);
1421   void processRegion(int start, int region_end); /*  remove {} parts */
1422   void removeHead(KeyInfo&, int count=0);
1423
1424  public:
1425  LatexInfo(string par, bool isPatternString) : entidx(-1), interval(isPatternString) {
1426     interval.par = par;
1427     interval.hasTitle = false;
1428     interval.titleValue = "";
1429     buildKeys(isPatternString);
1430     entries = vector<KeyInfo>();
1431     buildEntries(isPatternString);
1432   };
1433   int getFirstKey() {
1434     entidx = 0;
1435     if (entries.empty()) {
1436       return (-1);
1437     }
1438     if (entries[0].keytype == KeyInfo::isTitle) {
1439       if (! entries[0].disabled) {
1440         interval.hasTitle = true;
1441         interval.titleValue = entries[0].head;
1442       }
1443       else {
1444         interval.hasTitle = false;
1445         interval.titleValue = "";
1446       }
1447       removeHead(entries[0]);
1448       if (entries.size() > 1)
1449         return (1);
1450       else
1451         return (-1);
1452     }
1453     return 0;
1454   };
1455   int getNextKey() {
1456     entidx++;
1457     if (int(entries.size()) > entidx) {
1458       return entidx;
1459     }
1460     else {
1461       return (-1);
1462     }
1463   };
1464   bool setNextKey(int idx) {
1465     if ((idx == entidx) && (entidx >= 0)) {
1466       entidx--;
1467       return true;
1468     }
1469     else
1470       return false;
1471   };
1472   int find(int start, KeyInfo::KeyType keytype) {
1473     if (start < 0)
1474       return (-1);
1475     int tmpIdx = start;
1476     while (tmpIdx < int(entries.size())) {
1477       if (entries[tmpIdx].keytype == keytype)
1478         return tmpIdx;
1479       tmpIdx++;
1480     }
1481     return(-1);
1482   };
1483   int process(ostringstream &os, KeyInfo &actual);
1484   int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1485   // string show(int lastpos) { return interval.show(lastpos);};
1486   int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1487   KeyInfo &getKeyInfo(int keyinfo) {
1488     static KeyInfo invalidInfo = KeyInfo();
1489     if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1490       return invalidInfo;
1491     else
1492       return entries[keyinfo];
1493   };
1494   void setForDefaultLang(KeyInfo &defLang) {interval.setForDefaultLang(defLang);};
1495   void addIntervall(int low, int up) { interval.addIntervall(low, up); };
1496 };
1497
1498
1499 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1500 {
1501   int skip = 0;
1502   int depth = 0;
1503   repeat--;
1504   for (int i = start; i < end; i += 1 + skip) {
1505     char c;
1506     c = par[i];
1507     skip = 0;
1508     if (c == '\\') skip = 1;
1509     else if (c == up) {
1510       depth++;
1511     }
1512     else if (c == down) {
1513       if (depth == 0) {
1514         if ((repeat <= 0) || (par[i+1] != up))
1515           return i;
1516       }
1517       --depth;
1518     }
1519   }
1520   return end;
1521 }
1522
1523 class MathInfo {
1524   class MathEntry {
1525   public:
1526     string wait;
1527     size_t mathEnd;
1528     size_t mathStart;
1529     size_t mathSize;
1530   };
1531   size_t actualIdx;
1532   vector<MathEntry> entries;
1533  public:
1534   MathInfo() {
1535     actualIdx = 0;
1536   }
1537   void insert(string wait, size_t start, size_t end) {
1538     MathEntry m = MathEntry();
1539     m.wait = wait;
1540     m.mathStart = start;
1541     m.mathEnd = end;
1542     m.mathSize = end - start;
1543     entries.push_back(m);
1544   }
1545   bool empty() { return entries.empty(); };
1546   size_t getEndPos() {
1547     if (entries.empty() || (actualIdx >= entries.size())) {
1548       return 0;
1549     }
1550     return entries[actualIdx].mathEnd;
1551   }
1552   size_t getStartPos() {
1553     if (entries.empty() || (actualIdx >= entries.size())) {
1554       return 100000;                    /*  definitely enough? */
1555     }
1556     return entries[actualIdx].mathStart;
1557   }
1558   size_t getFirstPos() {
1559     actualIdx = 0;
1560     return getStartPos();
1561   }
1562   size_t getSize() {
1563     if (entries.empty() || (actualIdx >= entries.size())) {
1564       return size_t(0);
1565     }
1566     return entries[actualIdx].mathSize;
1567   }
1568   void incrEntry() { actualIdx++; };
1569 };
1570
1571 void LatexInfo::buildEntries(bool isPatternString)
1572 {
1573   static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1574   static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1575   static bool disableLanguageOverride = false;
1576   smatch sub, submath;
1577   bool evaluatingRegexp = false;
1578   MathInfo mi;
1579   bool evaluatingMath = false;
1580   bool evaluatingCode = false;
1581   size_t codeEnd = 0;
1582   bool evaluatingOptional = false;
1583   size_t optionalEnd = 0;
1584   int codeStart = -1;
1585   KeyInfo found;
1586   bool math_end_waiting = false;
1587   size_t math_pos = 10000;
1588   string math_end;
1589
1590   interval.removeAccents();
1591
1592   for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1593     submath = *itmath;
1594     if (math_end_waiting) {
1595       size_t pos = submath.position(size_t(0));
1596       if ((math_end == "$") &&
1597           (submath.str(0) == "$") &&
1598           (interval.par[pos-1] != '\\')) {
1599         mi.insert("$", math_pos, pos + 1);
1600         math_end_waiting = false;
1601       }
1602       else if ((math_end == "\\]") &&
1603                (submath.str(0) == "\\]")) {
1604         mi.insert("\\]", math_pos, pos + 2);
1605         math_end_waiting = false;
1606       }
1607       else if ((submath.str(1).compare("end") == 0) &&
1608           (submath.str(2).compare(math_end) == 0)) {
1609         mi.insert(math_end, math_pos, pos + submath.str(0).length());
1610         math_end_waiting = false;
1611       }
1612       else
1613         continue;
1614     }
1615     else {
1616       if (submath.str(1).compare("begin") == 0) {
1617         math_end_waiting = true;
1618         math_end = submath.str(2);
1619         math_pos = submath.position(size_t(0));
1620       }
1621       else if (submath.str(0).compare("\\[") == 0) {
1622         math_end_waiting = true;
1623         math_end = "\\]";
1624         math_pos = submath.position(size_t(0));
1625       }
1626       else if (submath.str(0) == "$") {
1627         size_t pos = submath.position(size_t(0));
1628         if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1629           math_end_waiting = true;
1630           math_end = "$";
1631           math_pos = pos;
1632         }
1633       }
1634     }
1635   }
1636   // Ignore language if there is math somewhere in pattern-string
1637   if (isPatternString) {
1638     if (! mi.empty()) {
1639       // Disable language
1640       keys["foreignlanguage"].disabled = true;
1641       disableLanguageOverride = true;
1642     }
1643     else
1644       disableLanguageOverride = false;
1645   }
1646   else {
1647     if (disableLanguageOverride) {
1648       keys["foreignlanguage"].disabled = true;
1649     }
1650   }
1651   math_pos = mi.getFirstPos();
1652   for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1653     sub = *it;
1654     string key = sub.str(3);
1655     if (key == "") {
1656       if (sub.str(0)[0] == '\\')
1657         key = sub.str(0)[1];
1658       else {
1659         key = sub.str(0);
1660         if (key == "$") {
1661           size_t k_pos = sub.position(size_t(0));
1662           if ((k_pos > 0) && (interval.par[k_pos - 1] == '\\')) {
1663             // Escaped '$', ignoring
1664             continue;
1665           }
1666         }
1667       }
1668     };
1669     if (evaluatingRegexp) {
1670       if (sub.str(1).compare("endregexp") == 0) {
1671         evaluatingRegexp = false;
1672         // found._tokenstart already set
1673         found._dataEnd = sub.position(size_t(0)) + 13;
1674         found._dataStart = found._dataEnd;
1675         found._tokensize = found._dataEnd - found._tokenstart;
1676         found.parenthesiscount = 0;
1677         found.head = interval.par.substr(found._tokenstart, found._tokensize);
1678       }
1679       else {
1680         continue;
1681       }
1682     }
1683     else {
1684       if (evaluatingMath) {
1685         if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1686           continue;
1687         evaluatingMath = false;
1688         mi.incrEntry();
1689         math_pos = mi.getStartPos();
1690       }
1691       if (keys.find(key) == keys.end()) {
1692         found = KeyInfo(KeyInfo::isStandard, 0, true);
1693         if (isPatternString) {
1694           found.keytype = KeyInfo::isChar;
1695           found.disabled = false;
1696           found.used = true;
1697         }
1698         keys[key] = found;
1699       }
1700       else
1701         found = keys[key];
1702       if (key.compare("regexp") == 0) {
1703         evaluatingRegexp = true;
1704         found._tokenstart = sub.position(size_t(0));
1705         found._tokensize = 0;
1706         continue;
1707       }
1708     }
1709     // Handle the other params of key
1710     if (found.keytype == KeyInfo::isIgnored)
1711       continue;
1712     else if (found.keytype == KeyInfo::isMath) {
1713       if (size_t(sub.position(size_t(0))) == math_pos) {
1714         found = keys[key];
1715         found._tokenstart = sub.position(size_t(0));
1716         found._tokensize = mi.getSize();
1717         found._dataEnd = found._tokenstart + found._tokensize;
1718         found._dataStart = found._dataEnd;
1719         found.parenthesiscount = 0;
1720         found.head = interval.par.substr(found._tokenstart, found._tokensize);
1721         evaluatingMath = true;
1722       }
1723       else {
1724         // begin|end of unknown env, discard
1725         // First handle tables
1726         // longtable|tabular
1727         bool discardComment;
1728         found = keys[key];
1729         found.keytype = KeyInfo::doRemove;
1730         if ((sub.str(5).compare("longtable") == 0) ||
1731             (sub.str(5).compare("tabular") == 0)) {
1732           discardComment = true;        /* '%' */
1733         }
1734         else {
1735           discardComment = false;
1736           static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1737           smatch sub2;
1738           string token = sub.str(5);
1739           if (regex_match(token, sub2, removeArgs)) {
1740             found.keytype = KeyInfo::removeWithArg;
1741           }
1742         }
1743         // discard spaces before pos(0)
1744         int pos = sub.position(size_t(0));
1745         int count;
1746         for (count = 0; pos - count > 0; count++) {
1747           char c = interval.par[pos-count-1];
1748           if (discardComment) {
1749             if ((c != ' ') && (c != '%'))
1750               break;
1751           }
1752           else if (c != ' ')
1753             break;
1754         }
1755         found._tokenstart = pos - count;
1756         if (sub.str(1).compare(0, 5, "begin") == 0) {
1757           size_t pos1 = pos + sub.str(0).length();
1758           if (sub.str(5).compare("cjk") == 0) {
1759             pos1 = interval.findclosing(pos1+1, interval.par.length()) + 1;
1760             if ((interval.par[pos1] == '{') && (interval.par[pos1+1] == '}'))
1761               pos1 += 2;
1762             found.keytype = KeyInfo::isMain;
1763             found._dataStart = pos1;
1764             found._dataEnd = interval.par.length();
1765             found.disabled = keys["foreignlanguage"].disabled;
1766             found.used = keys["foreignlanguage"].used;
1767             found._tokensize = pos1 - found._tokenstart;
1768             found.head = interval.par.substr(found._tokenstart, found._tokensize);
1769           }
1770           else {
1771             // Swallow possible optional params
1772             while (interval.par[pos1] == '[') {
1773               pos1 = interval.findclosing(pos1+1, interval.par.length(), '[', ']')+1;
1774             }
1775             // Swallow also the eventual parameter
1776             if (interval.par[pos1] == '{') {
1777               found._dataEnd = interval.findclosing(pos1+1, interval.par.length()) + 1;
1778             }
1779             else {
1780               found._dataEnd = pos1;
1781             }
1782             found._dataStart = found._dataEnd;
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         else {
1790           // Handle "\end{...}"
1791           found._dataStart = pos + sub.str(0).length();
1792           found._dataEnd = found._dataStart;
1793           found._tokensize = count + found._dataEnd - pos;
1794           found.parenthesiscount = 0;
1795           found.head = interval.par.substr(found._tokenstart, found._tokensize);
1796           found.disabled = true;
1797         }
1798       }
1799     }
1800     else if (found.keytype != KeyInfo::isRegex) {
1801       found._tokenstart = sub.position(size_t(0));
1802       if (found.parenthesiscount == 0) {
1803         // Probably to be discarded
1804         size_t following_pos = sub.position(size_t(0)) + sub.str(3).length() + 1;
1805         char following = interval.par[following_pos];
1806         if (following == ' ')
1807           found.head = "\\" + sub.str(3) + " ";
1808         else if (following == '=') {
1809           // like \uldepth=1000pt
1810           found.head = sub.str(0);
1811         }
1812         else
1813           found.head = "\\" + key;
1814         found._tokensize = found.head.length();
1815         found._dataEnd = found._tokenstart + found._tokensize;
1816         found._dataStart = found._dataEnd;
1817       }
1818       else {
1819         int params = found._tokenstart + key.length() + 1;
1820         if (evaluatingOptional) {
1821           if (size_t(found._tokenstart) > optionalEnd) {
1822             evaluatingOptional = false;
1823           }
1824           else {
1825             found.disabled = true;
1826           }
1827         }
1828         int optend = params;
1829         while (interval.par[optend] == '[') {
1830           // discard optional parameters
1831           optend = interval.findclosing(optend+1, interval.par.length(), '[', ']') + 1;
1832         }
1833         if (optend > params) {
1834           key += interval.par.substr(params, optend-params);
1835           evaluatingOptional = true;
1836           optionalEnd = optend;
1837         }
1838         string token = sub.str(5);
1839         int closings = found.parenthesiscount;
1840         if (found.parenthesiscount == 1) {
1841           found.head = "\\" + key + "{";
1842         }
1843         else if (found.parenthesiscount > 1) {
1844           if (token != "") {
1845             found.head = sub.str(0) + "{";
1846             closings = found.parenthesiscount - 1;
1847           }
1848           else {
1849             found.head = "\\" + key + "{";
1850           }
1851         }
1852         found._tokensize = found.head.length();
1853         found._dataStart = found._tokenstart + found.head.length();
1854         if (interval.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
1855           found._dataStart += 15;
1856         }
1857         size_t endpos = interval.findclosing(found._dataStart, interval.par.length(), '{', '}', closings);
1858         if (found.keytype == KeyInfo::isList) {
1859           // Check if it really is list env
1860           static regex const listre("^([a-z]+)$");
1861           smatch sub2;
1862           if (!regex_match(token, sub2, listre)) {
1863             // Change the key of this entry. It is not in a list/item environment
1864             found.keytype = KeyInfo::endArguments;
1865           }
1866         }
1867         if (found.keytype == KeyInfo::noMain) {
1868           evaluatingCode = true;
1869           codeEnd = endpos;
1870           codeStart = found._dataStart;
1871         }
1872         else if (evaluatingCode) {
1873           if (size_t(found._dataStart) > codeEnd)
1874             evaluatingCode = false;
1875           else if (found.keytype == KeyInfo::isMain) {
1876             // Disable this key, treate it as standard
1877             found.keytype = KeyInfo::isStandard;
1878             found.disabled = true;
1879             if ((codeEnd == interval.par.length()) &&
1880                 (found._tokenstart == codeStart)) {
1881               // trickery, because the code inset starts
1882               // with \selectlanguage ...
1883               codeEnd = endpos;
1884               if (entries.size() > 1) {
1885                 entries[entries.size()-1]._dataEnd = codeEnd;
1886               }
1887             }
1888           }
1889         }
1890         if ((endpos == interval.par.length()) &&
1891             (found.keytype == KeyInfo::doRemove)) {
1892           // Missing closing => error in latex-input?
1893           // therefore do not delete remaining data
1894           found._dataStart -= 1;
1895           found._dataEnd = found._dataStart;
1896         }
1897         else
1898           found._dataEnd = endpos;
1899       }
1900       if (isPatternString) {
1901         keys[key].used = true;
1902       }
1903     }
1904     entries.push_back(found);
1905   }
1906 }
1907
1908 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1909 {
1910   stringstream s(keysstring);
1911   string key;
1912   const char delim = '|';
1913   while (getline(s, key, delim)) {
1914     KeyInfo keyII(keyI);
1915     if (isPatternString) {
1916       keyII.used = false;
1917     }
1918     else if ( !keys[key].used)
1919       keyII.disabled = true;
1920     keys[key] = keyII;
1921   }
1922 }
1923
1924 void LatexInfo::buildKeys(bool isPatternString)
1925 {
1926
1927   static bool keysBuilt = false;
1928   if (keysBuilt && !isPatternString) return;
1929
1930   // Known standard keys with 1 parameter.
1931   // Split is done, if not at start of region
1932   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1933   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1934   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1935   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1936   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1937   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1938
1939   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1940           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1941   makeKey("section*|subsection*|subsubsection*|paragraph*",
1942           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1943   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1944   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
1945   // Regex
1946   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1947
1948   // Split is done, if not at start of region
1949   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
1950   makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
1951
1952   // Split is done always.
1953   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
1954
1955   // Known charaters
1956   // No split
1957   makeKey("backslash|textbackslash|slash",  KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1958   makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1959   makeKey("textasciiacute|texemdash",       KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1960   makeKey("dots|ldots",                     KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1961   // Spaces
1962   makeKey("quad|qquad|hfill|dotfill",               KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1963   makeKey("textvisiblespace|nobreakspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1964   makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1965   // Skip
1966   // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1967   // Custom space/skip, remove the content (== length value)
1968   makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
1969   // Found in fr/UserGuide.lyx
1970   makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1971   // quotes
1972   makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1973   makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1974   // Known macros to remove (including their parameter)
1975   // No split
1976   makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1977   makeKey("addtocounter|setlength",                 KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
1978   // handle like standard keys with 1 parameter.
1979   makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
1980
1981   // Macros to remove, but let the parameter survive
1982   // No split
1983   makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1984
1985   // Remove language spec from content of these insets
1986   makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
1987
1988   // Same effect as previous, parameter will survive (because there is no one anyway)
1989   // No split
1990   makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
1991   // Remove table decorations
1992   makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1993   // Discard shape-header.
1994   // For footnote or shortcut too, because of lang settings
1995   // and wrong handling if used 'KeyInfo::noMain'
1996   makeKey("circlepar|diamondpar|heartpar|nutpar",  KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1997   makeKey("trianglerightpar|hexagonpar|starpar",   KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1998   makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1999   makeKey("triangleleftpar|shapepar|dropuppar",    KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2000   makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics",     KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2001   makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2002   // like ('tiny{}' or '\tiny ' ... )
2003   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2004
2005   // Survives, like known character
2006   makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2007   makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2008
2009   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2010   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2011   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2012
2013   makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2014   // Remove RTL/LTR marker
2015   makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2016   makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2017   makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2018   makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2019   makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2020   makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2021   makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2022   if (isPatternString) {
2023     // Allow the first searched string to rebuild the keys too
2024     keysBuilt = false;
2025   }
2026   else {
2027     // no need to rebuild again
2028     keysBuilt = true;
2029   }
2030 }
2031
2032 /*
2033  * Keep the list of actual opened parentheses actual
2034  * (e.g. depth == 4 means there are 4 '{' not processed yet)
2035  */
2036 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2037 {
2038   int skip = 0;
2039   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2040     char c;
2041     c = par[i];
2042     skip = 0;
2043     if (c == '\\') skip = 1;
2044     else if (c == '{') {
2045       handleOpenP(i);
2046     }
2047     else if (c == '}') {
2048       handleCloseP(i, closingAllowed);
2049     }
2050   }
2051 }
2052
2053 #if (0)
2054 string Intervall::show(int lastpos)
2055 {
2056   int idx = 0;                          /* int intervalls */
2057   string s;
2058   int i = 0;
2059   for (idx = 0; idx <= ignoreidx; idx++) {
2060     while (i < lastpos) {
2061       int printsize;
2062       if (i <= borders[idx].low) {
2063         if (borders[idx].low > lastpos)
2064           printsize = lastpos - i;
2065         else
2066           printsize = borders[idx].low - i;
2067         s += par.substr(i, printsize);
2068         i += printsize;
2069         if (i >= borders[idx].low)
2070           i = borders[idx].upper;
2071       }
2072       else {
2073         i = borders[idx].upper;
2074         break;
2075       }
2076     }
2077   }
2078   if (lastpos > i) {
2079     s += par.substr(i, lastpos-i);
2080   }
2081   return (s);
2082 }
2083 #endif
2084
2085 void Intervall::output(ostringstream &os, int lastpos)
2086 {
2087   // get number of chars to output
2088   int idx = 0;                          /* int intervalls */
2089   int i = 0;
2090   int printed = 0;
2091   string startTitle = titleValue;
2092   for (idx = 0; idx <= ignoreidx; idx++) {
2093     if (i < lastpos) {
2094       if (i <= borders[idx].low) {
2095         int printsize;
2096         if (borders[idx].low > lastpos)
2097           printsize = lastpos - i;
2098         else
2099           printsize = borders[idx].low - i;
2100         if (printsize > 0) {
2101           os << startTitle << par.substr(i, printsize);
2102           i += printsize;
2103           printed += printsize;
2104           startTitle = "";
2105         }
2106         handleParentheses(i, false);
2107         if (i >= borders[idx].low)
2108           i = borders[idx].upper;
2109       }
2110       else {
2111         i = borders[idx].upper;
2112       }
2113     }
2114     else
2115       break;
2116   }
2117   if (lastpos > i) {
2118     os << startTitle << par.substr(i, lastpos-i);
2119     printed += lastpos-i;
2120   }
2121   handleParentheses(lastpos, false);
2122   for (int i = actualdeptindex; i > 0; --i) {
2123     os << "}";
2124   }
2125   if (hasTitle && (printed > 0))
2126     os << "}";
2127   if (! isPatternString)
2128     os << "\n";
2129   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2130 }
2131
2132 void LatexInfo::processRegion(int start, int region_end)
2133 {
2134   while (start < region_end) {          /* Let {[} and {]} survive */
2135     int cnt = interval.isOpeningPar(start);
2136     if (cnt == 1) {
2137       // Closing is allowed past the region
2138       int closing = interval.findclosing(start+1, interval.par.length());
2139       interval.addIntervall(start, start+1);
2140       interval.addIntervall(closing, closing+1);
2141     }
2142     else if (cnt == 3)
2143       start += 2;
2144     start = interval.nextNotIgnored(start+1);
2145   }
2146 }
2147
2148 void LatexInfo::removeHead(KeyInfo &actual, int count)
2149 {
2150   if (actual.parenthesiscount == 0) {
2151     // "{\tiny{} ...}" ==> "{{} ...}"
2152     interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2153   }
2154   else {
2155     // Remove header hull, that is "\url{abcd}" ==> "abcd"
2156     interval.addIntervall(actual._tokenstart - count, actual._dataStart);
2157     interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
2158   }
2159 }
2160
2161 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2162 {
2163   int nextKeyIdx = 0;
2164   switch (actual.keytype)
2165   {
2166     case KeyInfo::isTitle: {
2167       removeHead(actual);
2168       nextKeyIdx = getNextKey();
2169       break;
2170     }
2171     case KeyInfo::cleanToStart: {
2172       actual._dataEnd = actual._dataStart;
2173       nextKeyIdx = getNextKey();
2174       // Search for end of arguments
2175       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2176       if (tmpIdx > 0) {
2177         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2178           entries[i].disabled = true;
2179         }
2180         actual._dataEnd = entries[tmpIdx]._dataEnd;
2181       }
2182       while (interval.par[actual._dataEnd] == ' ')
2183         actual._dataEnd++;
2184       interval.addIntervall(0, actual._dataEnd+1);
2185       interval.actualdeptindex = 0;
2186       interval.depts[0] = actual._dataEnd+1;
2187       interval.closes[0] = -1;
2188       break;
2189     }
2190     case KeyInfo::noContent: {          /* char like "\hspace{2cm}" */
2191       if (actual.disabled)
2192         interval.addIntervall(actual._tokenstart, actual._dataEnd);
2193       else
2194         interval.addIntervall(actual._dataStart, actual._dataEnd);
2195     }
2196       // fall through
2197     case KeyInfo::isChar: {
2198       nextKeyIdx = getNextKey();
2199       break;
2200     }
2201     case KeyInfo::isSize: {
2202       if (actual.disabled || (interval.par[actual._dataStart] != '{') || (interval.par[actual._dataStart-1] == ' ')) {
2203         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
2204         interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2205         nextKeyIdx = getNextKey();
2206       } else {
2207         // Here _dataStart points to '{', so correct it
2208         actual._dataStart += 1;
2209         actual._tokensize += 1;
2210         actual.parenthesiscount = 1;
2211         if (interval.par[actual._dataStart] == '}') {
2212           // Determine the end if used like '{\tiny{}...}'
2213           actual._dataEnd = interval.findclosing(actual._dataStart+1, interval.par.length()) + 1;
2214           interval.addIntervall(actual._dataStart, actual._dataStart+1);
2215         }
2216         else {
2217           // Determine the end if used like '\tiny{...}'
2218           actual._dataEnd = interval.findclosing(actual._dataStart, interval.par.length()) + 1;
2219         }
2220         // Split on this key if not at start
2221         int start = interval.nextNotIgnored(previousStart);
2222         if (start < actual._tokenstart) {
2223           interval.output(os, actual._tokenstart);
2224           interval.addIntervall(start, actual._tokenstart);
2225         }
2226         // discard entry if at end of actual
2227         nextKeyIdx = process(os, actual);
2228       }
2229       break;
2230     }
2231     case KeyInfo::endArguments:
2232       // Remove trailing '{}' too
2233       actual._dataStart += 1;
2234       actual._dataEnd += 1;
2235       interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2236       nextKeyIdx = getNextKey();
2237       break;
2238     case KeyInfo::noMain:
2239       // fall through
2240     case KeyInfo::isStandard: {
2241       if (actual.disabled) {
2242         removeHead(actual);
2243         processRegion(actual._dataStart, actual._dataStart+1);
2244         nextKeyIdx = getNextKey();
2245       } else {
2246         // Split on this key if not at datastart of calling entry
2247         int start = interval.nextNotIgnored(previousStart);
2248         if (start < actual._tokenstart) {
2249           interval.output(os, actual._tokenstart);
2250           interval.addIntervall(start, actual._tokenstart);
2251         }
2252         // discard entry if at end of actual
2253         nextKeyIdx = process(os, actual);
2254       }
2255       break;
2256     }
2257     case KeyInfo::removeWithArg: {
2258       nextKeyIdx = getNextKey();
2259       // Search for end of arguments
2260       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2261       if (tmpIdx > 0) {
2262         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2263           entries[i].disabled = true;
2264         }
2265         actual._dataEnd = entries[tmpIdx]._dataEnd;
2266       }
2267       interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2268       break;
2269     }
2270     case KeyInfo::doRemove: {
2271       // Remove the key with all parameters and following spaces
2272       size_t pos;
2273       for (pos = actual._dataEnd+1; pos < interval.par.length(); pos++) {
2274         if ((interval.par[pos] != ' ') && (interval.par[pos] != '%'))
2275           break;
2276       }
2277       interval.addIntervall(actual._tokenstart, pos);
2278       nextKeyIdx = getNextKey();
2279       break;
2280     }
2281     case KeyInfo::isList: {
2282       // Discard space before _tokenstart
2283       int count;
2284       for (count = 0; count < actual._tokenstart; count++) {
2285         if (interval.par[actual._tokenstart-count-1] != ' ')
2286           break;
2287       }
2288       nextKeyIdx = getNextKey();
2289       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2290       if (tmpIdx > 0) {
2291         // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2292         // with arguments
2293         // How else can we catch this one?
2294         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2295           entries[i].disabled = true;
2296         }
2297         actual._dataEnd = entries[tmpIdx]._dataEnd;
2298       }
2299       else if (nextKeyIdx > 0) {
2300         // Ignore any lang entries inside data region
2301         for (int i = nextKeyIdx; i < int(entries.size()) && entries[i]._tokenstart < actual._dataEnd; i++) {
2302           if (entries[i].keytype == KeyInfo::isMain)
2303             entries[i].disabled = true;
2304         }
2305       }
2306       if (actual.disabled) {
2307         interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2308       }
2309       else {
2310         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
2311       }
2312       if (interval.par[actual._dataEnd+1] == '[') {
2313         int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
2314         if ((interval.par[actual._dataEnd+2] == '{') &&
2315             (interval.par[posdown-1] == '}')) {
2316           interval.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2317           interval.addIntervall(posdown-1, posdown+1);
2318         }
2319         else {
2320           interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2321           interval.addIntervall(posdown, posdown+1);
2322         }
2323         int blk = interval.nextNotIgnored(actual._dataEnd+1);
2324         if (blk > posdown) {
2325           // Discard at most 1 space after empty item
2326           int count;
2327           for (count = 0; count < 1; count++) {
2328             if (interval.par[blk+count] != ' ')
2329               break;
2330           }
2331           if (count > 0)
2332             interval.addIntervall(blk, blk+count);
2333         }
2334       }
2335       break;
2336     }
2337     case KeyInfo::isSectioning: {
2338       // Discard spaces before _tokenstart
2339       int count;
2340       int val = actual._tokenstart;
2341       for (count = 0; count < actual._tokenstart;) {
2342         val = interval.previousNotIgnored(val-1);
2343         if (interval.par[val] != ' ')
2344           break;
2345         else {
2346           count = actual._tokenstart - val;
2347         }
2348       }
2349       if (actual.disabled) {
2350         removeHead(actual, count);
2351         nextKeyIdx = getNextKey();
2352       } else {
2353         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
2354         nextKeyIdx = process(os, actual);
2355       }
2356       break;
2357     }
2358     case KeyInfo::isMath: {
2359       // Same as regex, use the content unchanged
2360       nextKeyIdx = getNextKey();
2361       break;
2362     }
2363     case KeyInfo::isRegex: {
2364       // DO NOT SPLIT ON REGEX
2365       // Do not disable
2366       nextKeyIdx = getNextKey();
2367       break;
2368     }
2369     case KeyInfo::isIgnored: {
2370       // Treat like a character for now
2371       nextKeyIdx = getNextKey();
2372       break;
2373     }
2374     case KeyInfo::isMain: {
2375       if (interval.par.substr(actual._dataStart, 2) == "% ")
2376         interval.addIntervall(actual._dataStart, actual._dataStart+2);
2377       if (actual._tokenstart > 0) {
2378         int prev = interval.previousNotIgnored(actual._tokenstart - 1);
2379         if ((prev >= 0) && interval.par[prev] == '%')
2380           interval.addIntervall(prev, prev+1);
2381       }
2382       if (actual.disabled) {
2383         removeHead(actual);
2384         if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
2385             (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
2386           // Discard also the space before math-equation
2387           interval.addIntervall(actual._dataStart, actual._dataStart+1);
2388         }
2389         nextKeyIdx = getNextKey();
2390         // interval.resetOpenedP(actual._dataStart-1);
2391       }
2392       else {
2393         if (actual._tokenstart < 26) {
2394           // for the first (and maybe dummy) language
2395           interval.setForDefaultLang(actual);
2396         }
2397         interval.resetOpenedP(actual._dataStart-1);
2398       }
2399       break;
2400     }
2401     case KeyInfo::invalid:
2402       // This cannot happen, already handled
2403       // fall through
2404     default: {
2405       // LYXERR0("Unhandled keytype");
2406       nextKeyIdx = getNextKey();
2407       break;
2408     }
2409   }
2410   return nextKeyIdx;
2411 }
2412
2413 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
2414 {
2415   int end = interval.nextNotIgnored(actual._dataEnd);
2416   int oldStart = actual._dataStart;
2417   int nextKeyIdx = getNextKey();
2418   while (true) {
2419     if ((nextKeyIdx < 0) ||
2420         (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2421         (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
2422       if (oldStart <= end) {
2423         processRegion(oldStart, end);
2424         oldStart = end+1;
2425       }
2426       break;
2427     }
2428     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2429
2430     if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2431       (void) dispatch(os, actual._dataStart, nextKey);
2432       end = nextKey._tokenstart;
2433       break;
2434     }
2435     processRegion(oldStart, nextKey._tokenstart);
2436     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2437
2438     oldStart = nextKey._dataEnd+1;
2439   }
2440   // now nextKey is either invalid or is outside of actual._dataEnd
2441   // output the remaining and discard myself
2442   if (oldStart <= end) {
2443     processRegion(oldStart, end);
2444   }
2445   if (interval.par[end] == '}') {
2446     end += 1;
2447     // This is the normal case.
2448     // But if using the firstlanguage, the closing may be missing
2449   }
2450   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2451   int output_end;
2452   if (actual._dataEnd < end)
2453     output_end = interval.nextNotIgnored(actual._dataEnd);
2454   else
2455     output_end = interval.nextNotIgnored(end);
2456   if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2457     interval.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2458   }
2459   // Remove possible empty data
2460   int dstart = interval.nextNotIgnored(actual._dataStart);
2461   while (interval.isOpeningPar(dstart) == 1) {
2462     interval.addIntervall(dstart, dstart+1);
2463     int dend = interval.findclosing(dstart+1, output_end);
2464     interval.addIntervall(dend, dend+1);
2465     dstart = interval.nextNotIgnored(dstart+1);
2466   }
2467   if (dstart < output_end)
2468     interval.output(os, output_end);
2469   interval.addIntervall(actual._tokenstart, end);
2470   return nextKeyIdx;
2471 }
2472
2473 string splitOnKnownMacros(string par, bool isPatternString)
2474 {
2475   ostringstream os;
2476   LatexInfo li(par, isPatternString);
2477   // LYXERR0("Berfore split: " << par);
2478   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2479   DummyKey.head = "";
2480   DummyKey._tokensize = 0;
2481   DummyKey._dataStart = 0;
2482   DummyKey._dataEnd = par.length();
2483   DummyKey.disabled = true;
2484   int firstkeyIdx = li.getFirstKey();
2485   string s;
2486   if (firstkeyIdx >= 0) {
2487     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2488     DummyKey._tokenstart = firstKey._tokenstart;
2489     int nextkeyIdx;
2490     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2491       // Use dummy firstKey
2492       firstKey = DummyKey;
2493       (void) li.setNextKey(firstkeyIdx);
2494     }
2495     else {
2496       if (par.substr(firstKey._dataStart, 2) == "% ")
2497         li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2498     }
2499     nextkeyIdx = li.process(os, firstKey);
2500     while (nextkeyIdx >= 0) {
2501       // Check for a possible gap between the last
2502       // entry and this one
2503       int datastart = li.nextNotIgnored(firstKey._dataStart);
2504       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2505       if ((nextKey._tokenstart > datastart)) {
2506         // Handle the gap
2507         firstKey._dataStart = datastart;
2508         firstKey._dataEnd = par.length();
2509         (void) li.setNextKey(nextkeyIdx);
2510         // Fake the last opened parenthesis
2511         li.setForDefaultLang(firstKey);
2512         nextkeyIdx = li.process(os, firstKey);
2513       }
2514       else {
2515         if (nextKey.keytype != KeyInfo::isMain) {
2516           firstKey._dataStart = datastart;
2517           firstKey._dataEnd = nextKey._dataEnd+1;
2518           (void) li.setNextKey(nextkeyIdx);
2519           li.setForDefaultLang(firstKey);
2520           nextkeyIdx = li.process(os, firstKey);
2521         }
2522         else {
2523           nextkeyIdx = li.process(os, nextKey);
2524         }
2525       }
2526     }
2527     // Handle the remaining
2528     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2529     firstKey._dataEnd = par.length();
2530     // Check if ! empty
2531     if ((firstKey._dataStart < firstKey._dataEnd) &&
2532         (par[firstKey._dataStart] != '}')) {
2533       li.setForDefaultLang(firstKey);
2534       (void) li.process(os, firstKey);
2535     }
2536     s = os.str();
2537     if (s.empty()) {
2538       // return string definitelly impossible to match
2539       s = "\\foreignlanguage{ignore}{ }";
2540     }
2541   }
2542   else
2543     s = par;                            /* no known macros found */
2544   // LYXERR0("After split: " << s);
2545   return s;
2546 }
2547
2548 /*
2549  * Try to unify the language specs in the latexified text.
2550  * Resulting modified string is set to "", if
2551  * the searched tex does not contain all the features in the search pattern
2552  */
2553 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2554 {
2555         static Features regex_f;
2556         static int missed = 0;
2557         static bool regex_with_format = false;
2558
2559         int parlen = par.length();
2560
2561         while ((parlen > 0) && (par[parlen-1] == '\n')) {
2562                 parlen--;
2563         }
2564         if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2565                 // Happens to be there in case of description or labeling environment
2566                 parlen--;
2567         }
2568         string result;
2569         if (withformat) {
2570                 // Split the latex input into pieces which
2571                 // can be digested by our search engine
2572                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2573                 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2574                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2575         }
2576         else
2577                 result = par.substr(0, parlen);
2578         if (isPatternString) {
2579                 missed = 0;
2580                 if (withformat) {
2581                         regex_f = identifyFeatures(result);
2582                         string features = "";
2583                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2584                                 string a = it->first;
2585                                 regex_with_format = true;
2586                                 features += " " + a;
2587                                 // LYXERR0("Identified regex format:" << a);
2588                         }
2589                         LYXERR(Debug::FIND, "Identified Features" << features);
2590
2591                 }
2592         } else if (regex_with_format) {
2593                 Features info = identifyFeatures(result);
2594                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2595                         string a = it->first;
2596                         bool b = it->second;
2597                         if (b && ! info[a]) {
2598                                 missed++;
2599                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2600                                 return("");
2601                         }
2602                 }
2603         }
2604         else {
2605                 // LYXERR0("No regex formats");
2606         }
2607         return(result);
2608 }
2609
2610
2611 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2612 static int identifyClosing(string & t)
2613 {
2614         int open_braces = 0;
2615         do {
2616                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2617                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2618                         continue;
2619                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2620                         continue;
2621                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2622                         continue;
2623                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2624                         ++open_braces;
2625                         continue;
2626                 }
2627                 break;
2628         } while (true);
2629         return open_braces;
2630 }
2631
2632
2633 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2634         : p_buf(&buf), p_first_buf(&buf), opt(opt)
2635 {
2636         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2637         docstring const & ds = stringifySearchBuffer(find_buf, opt);
2638         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2639         // When using regexp, braces are hacked already by escape_for_regex()
2640         par_as_string = normalize(ds, !use_regexp);
2641         open_braces = 0;
2642         close_wildcards = 0;
2643
2644         size_t lead_size = 0;
2645         // correct the language settings
2646         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2647         if (opt.ignoreformat) {
2648                 if (!use_regexp) {
2649                         // if par_as_string_nolead were emty,
2650                         // the following call to findAux will always *find* the string
2651                         // in the checked data, and thus always using the slow
2652                         // examining of the current text part.
2653                         par_as_string_nolead = par_as_string;
2654                 }
2655         } else {
2656                 lead_size = identifyLeading(par_as_string);
2657                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2658                 lead_as_string = par_as_string.substr(0, lead_size);
2659                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2660         }
2661
2662         if (!use_regexp) {
2663                 open_braces = identifyClosing(par_as_string);
2664                 identifyClosing(par_as_string_nolead);
2665                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2666                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2667         } else {
2668                 string lead_as_regexp;
2669                 if (lead_size > 0) {
2670                         // @todo No need to search for \regexp{} insets in leading material
2671                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2672                         par_as_string = par_as_string_nolead;
2673                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2674                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2675                 }
2676                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2677                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2678                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2679                 if (
2680                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2681                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2682                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2683                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2684                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2685                         || regex_replace(par_as_string, par_as_string,
2686                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2687                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2688                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2689                         ) {
2690                         ++close_wildcards;
2691                 }
2692                 if (!opt.ignoreformat) {
2693                         // Remove extra '\}' at end if not part of \{\.\}
2694                         size_t lng = par_as_string.size();
2695                         while(lng > 2) {
2696                                 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
2697                                         if (lng >= 6) {
2698                                                 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
2699                                                         break;
2700                                         }
2701                                         lng -= 2;
2702                                         open_braces++;
2703                                 }
2704                                 else
2705                                         break;
2706                         }
2707                         if (lng < par_as_string.size())
2708                                 par_as_string = par_as_string.substr(0,lng);
2709                         /*
2710                         // save '\.'
2711                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2712                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2713                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2714                         // replace '[^...]' with '[^...\}\{\\]'
2715                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2716                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2717                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2718                         // restore '\.'
2719                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2720                         */
2721                 }
2722                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2723                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2724                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
2725                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2726
2727                 // If entered regexp must match at begin of searched string buffer
2728                 // Kornel: Added parentheses to use $1 for size of the leading string
2729                 string regexp_str;
2730                 string regexp2_str;
2731                 {
2732                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2733                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
2734                         // so the convert has no effect in that case
2735                         for (int i = 8; i > 0; --i) {
2736                                 string orig = "\\\\" + std::to_string(i);
2737                                 string dest = "\\" + std::to_string(i+1);
2738                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
2739                         }
2740                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2741                         regexp2_str = "(" + lead_as_regexp + ").*?" + par_as_string;
2742                 }
2743                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2744                 regexp = lyx::regex(regexp_str);
2745
2746                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2747                 regexp2 = lyx::regex(regexp2_str);
2748         }
2749 }
2750
2751
2752 // Count number of characters in string
2753 // {]} ==> 1
2754 // \&  ==> 1
2755 // --- ==> 1
2756 // \\[a-zA-Z]+ ==> 1
2757 static int computeSize(string s, int len)
2758 {
2759         if (len == 0)
2760                 return 0;
2761         int skip = 1;
2762         int count = 0;
2763         for (int i = 0; i < len; i += skip, count++) {
2764                 if (s[i] == '\\') {
2765                         skip = 2;
2766                         if (isalpha(s[i+1])) {
2767                                 for (int j = 2;  i+j < len; j++) {
2768                                         if (! isalpha(s[i+j])) {
2769                                                 if (s[i+j] == ' ')
2770                                                         skip++;
2771                                                 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2772                                                         skip += 2;
2773                                                 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2774                                                         skip++;
2775                                                 break;
2776                                         }
2777                                         skip++;
2778                                 }
2779                         }
2780                 }
2781                 else if (s[i] == '{') {
2782                         if (s[i+1] == '}')
2783                                 skip = 2;
2784                         else
2785                                 skip = 3;
2786                 }
2787                 else if (s[i] == '-') {
2788                         if (s[i+1] == '-') {
2789                                 if (s[i+2] == '-')
2790                                         skip = 3;
2791                                 else
2792                                         skip = 2;
2793                         }
2794                         else
2795                                 skip = 1;
2796                 }
2797                 else {
2798                         skip = 1;
2799                 }
2800         }
2801         return count;
2802 }
2803
2804 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2805 {
2806         MatchResult mres;
2807
2808         if (at_begin &&
2809                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2810                 return mres;
2811
2812         docstring docstr = stringifyFromForSearch(opt, cur, len);
2813         string str = normalize(docstr, true);
2814         if (!opt.ignoreformat) {
2815                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2816         }
2817         if (str.empty()) {
2818                 mres.match_len = -1;
2819                 return mres;
2820         }
2821         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2822         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2823
2824         if (use_regexp) {
2825                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2826                 regex const *p_regexp;
2827                 regex_constants::match_flag_type flags;
2828                 if (at_begin) {
2829                         flags = regex_constants::match_continuous;
2830                         p_regexp = &regexp;
2831                 } else {
2832                         flags = regex_constants::match_default;
2833                         p_regexp = &regexp2;
2834                 }
2835                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2836                 if (re_it == sregex_iterator())
2837                         return mres;
2838                 match_results<string::const_iterator> const & m = *re_it;
2839
2840                 if (0) { // Kornel Benko: DO NOT CHECKK
2841                         // Check braces on the segment that matched the entire regexp expression,
2842                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2843                         if (!braces_match(m[0].first, m[0].second, open_braces))
2844                                 return mres;
2845                 }
2846
2847                 // Check braces on segments that matched all (.*?) subexpressions,
2848                 // except the last "padding" one inserted by lyx.
2849                 for (size_t i = 1; i < m.size() - 1; ++i)
2850                         if (!braces_match(m[i].first, m[i].second, open_braces))
2851                                 return mres;
2852
2853                 // Exclude from the returned match length any length
2854                 // due to close wildcards added at end of regexp
2855                 // and also the length of the leading (e.g. '\emph{')
2856                 //
2857                 // Whole found string, including the leading: m[0].second - m[0].first
2858                 // Size of the leading string: m[1].second - m[1].first
2859                 int leadingsize = 0;
2860                 if (m.size() > 1)
2861                         leadingsize = m[1].second - m[1].first;
2862                 int result;
2863                 for (size_t i = 0; i < m.size(); i++) {
2864                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2865                 }
2866                 if (close_wildcards == 0)
2867                         result = m[0].second - m[0].first;
2868
2869                 else
2870                         result =  m[m.size() - close_wildcards].first - m[0].first;
2871
2872                 size_t pos = m.position(size_t(0));
2873                 // Ignore last closing characters
2874                 while (result > 0) {
2875                         if (str[pos+result-1] == '}')
2876                                 --result;
2877                         else
2878                                 break;
2879                 }
2880                 if (result > leadingsize)
2881                         result -= leadingsize;
2882                 else
2883                         result = 0;
2884                 mres.match_len = computeSize(str.substr(pos+leadingsize,result), result);
2885                 mres.match2end = str.size() - pos - leadingsize;
2886                 mres.pos = pos+leadingsize;
2887                 return mres;
2888         }
2889
2890         // else !use_regexp: but all code paths above return
2891         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2892                                  << par_as_string << "', str='" << str << "'");
2893         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2894                                  << lead_as_string << "', par_as_string_nolead='"
2895                                  << par_as_string_nolead << "'");
2896
2897         if (at_begin) {
2898                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2899                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2900                 if (str.substr(0, par_as_string.size()) == par_as_string) {
2901                         mres.match_len = par_as_string.size();
2902                         mres.match2end = str.size();
2903                         mres.pos = 0;
2904                         return mres;
2905                 }
2906         } else {
2907                 size_t pos = str.find(par_as_string_nolead);
2908                 if (pos != string::npos) {
2909                         mres.match_len = par_as_string.size();
2910                         mres.match2end = str.size() - pos;
2911                         mres.pos = pos;
2912                         return mres;
2913                 }
2914         }
2915         return mres;
2916 }
2917
2918
2919 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2920 {
2921         MatchResult mres = findAux(cur, len, at_begin);
2922         int res = mres.match_len;
2923         LYXERR(Debug::FIND,
2924                "res=" << res << ", at_begin=" << at_begin
2925                << ", matchword=" << opt.matchword
2926                << ", inTexted=" << cur.inTexted());
2927         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2928                 return mres;
2929         if ((len > 0) && (res < len)) {
2930           mres.match_len = 0;
2931           return mres;
2932         }
2933         Paragraph const & par = cur.paragraph();
2934         bool ws_left = (cur.pos() > 0)
2935                 ? par.isWordSeparator(cur.pos() - 1)
2936                 : true;
2937         bool ws_right = (cur.pos() + len < par.size())
2938                 ? par.isWordSeparator(cur.pos() + len)
2939                 : true;
2940         LYXERR(Debug::FIND,
2941                "cur.pos()=" << cur.pos() << ", res=" << res
2942                << ", separ: " << ws_left << ", " << ws_right
2943                << ", len: " << len
2944                << endl);
2945         if (ws_left && ws_right) {
2946           // Check for word separators inside the found 'word'
2947           for (int i = 0; i < len; i++) {
2948             if (par.isWordSeparator(cur.pos() + i)) {
2949               mres.match_len = 0;
2950               return mres;
2951             }
2952           }
2953           return mres;
2954         }
2955         mres.match_len = 0;
2956         return mres;
2957 }
2958
2959
2960 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2961 {
2962         string t;
2963         if (! opt.casesensitive)
2964                 t = lyx::to_utf8(lowercase(s));
2965         else
2966                 t = lyx::to_utf8(s);
2967         // Remove \n at begin
2968         while (!t.empty() && t[0] == '\n')
2969                 t = t.substr(1);
2970         // Remove \n at end
2971         while (!t.empty() && t[t.size() - 1] == '\n')
2972                 t = t.substr(0, t.size() - 1);
2973         size_t pos;
2974         // Handle all other '\n'
2975         while ((pos = t.find("\n")) != string::npos) {
2976                 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
2977                         // Handle '\\\n'
2978                         if (isAlnumASCII(t[pos+1])) {
2979                                 t.replace(pos-2, 3, " ");
2980                         }
2981                         else {
2982                                 t.replace(pos-2, 3, "");
2983                         }
2984                 }
2985                 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
2986                         // '\n' adjacent to non-alpha-numerics, discard
2987                         t.replace(pos, 1, "");
2988                 }
2989                 else {
2990                         // Replace all other \n with spaces
2991                         t.replace(pos, 1, " ");
2992                 }
2993         }
2994         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
2995         // Kornel: Added textsl, textsf, textit, texttt and noun
2996         // + allow to seach for colored text too
2997         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
2998         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
2999                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3000         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3001                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3002
3003         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3004         // FIXME - check what preceeds the brace
3005         if (hack_braces) {
3006                 if (opt.ignoreformat)
3007                         while (regex_replace(t, t, "\\{", "_x_<")
3008                                || regex_replace(t, t, "\\}", "_x_>"))
3009                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3010                 else
3011                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
3012                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
3013                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3014         }
3015
3016         return t;
3017 }
3018
3019
3020 docstring stringifyFromCursor(DocIterator const & cur, int len)
3021 {
3022         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3023         if (cur.inTexted()) {
3024                 Paragraph const & par = cur.paragraph();
3025                 // TODO what about searching beyond/across paragraph breaks ?
3026                 // TODO Try adding a AS_STR_INSERTS as last arg
3027                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3028                         int(par.size()) : cur.pos() + len;
3029                 // OutputParams runparams(&cur.buffer()->params().encoding());
3030                 OutputParams runparams(encodings.fromLyXName("utf8"));
3031                 runparams.nice = true;
3032                 runparams.flavor = OutputParams::XETEX;
3033                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3034                 // No side effect of file copying and image conversion
3035                 runparams.dryrun = true;
3036                 runparams.for_search = true;
3037                 LYXERR(Debug::FIND, "Stringifying with cur: "
3038                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
3039                 return par.asString(cur.pos(), end,
3040                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3041                         &runparams);
3042         } else if (cur.inMathed()) {
3043                 CursorSlice cs = cur.top();
3044                 MathData md = cs.cell();
3045                 MathData::const_iterator it_end =
3046                         (( len == -1 || cs.pos() + len > int(md.size()))
3047                          ? md.end()
3048                          : md.begin() + cs.pos() + len );
3049                 MathData md2;
3050                 for (MathData::const_iterator it = md.begin() + cs.pos();
3051                      it != it_end; ++it)
3052                         md2.push_back(*it);
3053                 docstring s = asString(md2);
3054                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3055                 return s;
3056         }
3057         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3058         return docstring();
3059 }
3060
3061
3062 /** Computes the LaTeX export of buf starting from cur and ending len positions
3063  * after cur, if len is positive, or at the paragraph or innermost inset end
3064  * if len is -1.
3065  */
3066 docstring latexifyFromCursor(DocIterator const & cur, int len)
3067 {
3068         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3069         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3070                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3071         Buffer const & buf = *cur.buffer();
3072
3073         odocstringstream ods;
3074         otexstream os(ods);
3075         //OutputParams runparams(&buf.params().encoding());
3076         OutputParams runparams(encodings.fromLyXName("utf8"));
3077         runparams.nice = false;
3078         runparams.flavor = OutputParams::XETEX;
3079         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3080         // No side effect of file copying and image conversion
3081         runparams.dryrun = true;
3082         runparams.for_search = true;
3083
3084         if (cur.inTexted()) {
3085                 // @TODO what about searching beyond/across paragraph breaks ?
3086                 pos_type endpos = cur.paragraph().size();
3087                 if (len != -1 && endpos > cur.pos() + len)
3088                         endpos = cur.pos() + len;
3089                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3090                           string(), cur.pos(), endpos);
3091                 string s = lyx::to_utf8(ods.str());
3092                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3093                 return(lyx::from_utf8(s));
3094         } else if (cur.inMathed()) {
3095                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3096                 for (int s = cur.depth() - 1; s >= 0; --s) {
3097                         CursorSlice const & cs = cur[s];
3098                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3099                                 WriteStream ws(os);
3100                                 cs.asInsetMath()->asHullInset()->header_write(ws);
3101                                 break;
3102                         }
3103                 }
3104
3105                 CursorSlice const & cs = cur.top();
3106                 MathData md = cs.cell();
3107                 MathData::const_iterator it_end =
3108                         ((len == -1 || cs.pos() + len > int(md.size()))
3109                          ? md.end()
3110                          : md.begin() + cs.pos() + len);
3111                 MathData md2;
3112                 for (MathData::const_iterator it = md.begin() + cs.pos();
3113                      it != it_end; ++it)
3114                         md2.push_back(*it);
3115
3116                 ods << asString(md2);
3117                 // Retrieve the math environment type, and add '$' or '$]'
3118                 // or others (\end{equation}) accordingly
3119                 for (int s = cur.depth() - 1; s >= 0; --s) {
3120                         CursorSlice const & cs2 = cur[s];
3121                         InsetMath * inset = cs2.asInsetMath();
3122                         if (inset && inset->asHullInset()) {
3123                                 WriteStream ws(os);
3124                                 inset->asHullInset()->footer_write(ws);
3125                                 break;
3126                         }
3127                 }
3128                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3129         } else {
3130                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3131         }
3132         return ods.str();
3133 }
3134
3135
3136 /** Finalize an advanced find operation, advancing the cursor to the innermost
3137  ** position that matches, plus computing the length of the matching text to
3138  ** be selected
3139  **/
3140 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
3141 {
3142         // Search the foremost position that matches (avoids find of entire math
3143         // inset when match at start of it)
3144         size_t d;
3145         DocIterator old_cur(cur.buffer());
3146         do {
3147                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
3148                 d = cur.depth();
3149                 old_cur = cur;
3150                 cur.forwardPos();
3151         } while (cur && cur.depth() > d && match(cur).match_len > 0);
3152         cur = old_cur;
3153         int max_match = match(cur).match_len;     /* match valid only if not searching whole words */
3154         if (max_match <= 0) return 0;
3155         LYXERR(Debug::FIND, "Ok");
3156
3157         // Compute the match length
3158         int len = 1;
3159         if (cur.pos() + len > cur.lastpos())
3160           return 0;
3161         if (match.opt.matchword) {
3162           LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3163           while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3164             ++len;
3165             LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3166           }
3167           // Length of matched text (different from len param)
3168           int old_match = match(cur, len).match_len;
3169           if (old_match < 0)
3170             old_match = 0;
3171           int new_match;
3172           // Greedy behaviour while matching regexps
3173           while ((new_match = match(cur, len + 1).match_len) > old_match) {
3174             ++len;
3175             old_match = new_match;
3176             LYXERR(Debug::FIND, "verifying   match with len = " << len);
3177           }
3178           if (old_match == 0)
3179             len = 0;
3180         }
3181         else {
3182           int minl = 1;
3183           int maxl = cur.lastpos() - cur.pos();
3184           // Greedy behaviour while matching regexps
3185           while (maxl > minl) {
3186             int actual_match = match(cur, len).match_len;
3187             if (actual_match >= max_match) {
3188               // actual_match > max_match _can_ happen,
3189               // if the search area splits
3190               // some following word so that the regex
3191               // (e.g. 'r.*r\b' matches 'r' from the middle of the
3192               // splitted word)
3193               // This means, the len value is too big
3194               maxl = len;
3195               len = (int)((maxl + minl)/2);
3196             }
3197             else {
3198               // (actual_match < max_match)
3199               minl = len + 1;
3200               len = (int)((maxl + minl)/2);
3201             }
3202           }
3203           old_cur = cur;
3204           // Search for real start of matched characters
3205           while (len > 1) {
3206             int actual_match;
3207             do {
3208               cur.forwardPos();
3209             } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3210             if (cur.depth() < old_cur.depth()) {
3211               // Outer inset?
3212               LYXERR0("cur.depth() < old_cur.depth(), this should never happen");
3213               break;
3214             }
3215             if (cur.pos() != old_cur.pos()) {
3216               // OK, forwarded 1 pos in actual inset
3217               actual_match = match(cur, len-1).match_len;
3218               if (actual_match == max_match) {
3219                 // Ha, got it! The shorter selection has the same match length
3220                 len--;
3221                 old_cur = cur;
3222               }
3223               else {
3224                 // OK, the shorter selection matches less chars, revert to previous value
3225                 cur = old_cur;
3226                 break;
3227               }
3228             }
3229             else {
3230               LYXERR0("cur.pos() == old_cur.pos(), this should never happen");
3231               actual_match = match(cur, len).match_len;
3232               if (actual_match == max_match)
3233                 old_cur = cur;
3234             }
3235           }
3236         }
3237         return len;
3238 }
3239
3240
3241 /// Finds forward
3242 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
3243 {
3244         if (!cur)
3245                 return 0;
3246         while (!theApp()->longOperationCancelled() && cur) {
3247                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3248                 MatchResult mres = match(cur, -1, false);
3249                 int match_len = mres.match_len;
3250                 LYXERR(Debug::FIND, "match_len: " << match_len);
3251                 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3252                         LYXERR0("BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3253                         match_len = 0;
3254                 }
3255                 if (match_len > 0) {
3256                         // Try to find the begin of searched string
3257                         int increment = mres.pos/2;
3258                         while (mres.pos > 5 && (increment > 5)) {
3259                                 DocIterator old_cur = cur;
3260                                 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3261                                 }
3262                                 if (! cur || (cur.pit() > old_cur.pit())) {
3263                                         // Are we outside of the paragraph?
3264                                         // This can happen if moving past some UTF8-encoded chars
3265                                         cur = old_cur;
3266                                         increment /= 2;
3267                                 }
3268                                 else {
3269                                         MatchResult mres2 = match(cur, -1, false);
3270                                         if ((mres2.match2end < mres.match2end) ||
3271                                           (mres2.match_len < mres.match_len)) {
3272                                                 cur = old_cur;
3273                                                 increment /= 2;
3274                                         }
3275                                         else {
3276                                                 mres = mres2;
3277                                                 increment -= 2;
3278                                                 if (increment > mres.pos/2)
3279                                                         increment = mres.pos/2;
3280                                         }
3281                                 }
3282                         }
3283                         int match_len_zero_count = 0;
3284                         for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3285                                 if (i++ > 10) {
3286                                         int remaining_len = match(cur, -1, false).match_len;
3287                                         if (remaining_len <= 0) {
3288                                                 // Apparently the searched string is not in the remaining part
3289                                                 break;
3290                                         }
3291                                         else {
3292                                                 i = 0;
3293                                         }
3294                                 }
3295                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3296                                 int match_len3 = match(cur, 1).match_len;
3297                                 if (match_len3 < 0)
3298                                         continue;
3299                                 int match_len2 = match(cur).match_len;
3300                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3301                                 if (match_len2 > 0) {
3302                                         // Sometimes in finalize we understand it wasn't a match
3303                                         // and we need to continue the outest loop
3304                                         int len = findAdvFinalize(cur, match);
3305                                         if (len > 0) {
3306                                                 return len;
3307                                         }
3308                                 }
3309                                 if (match_len2 >= 0) {
3310                                         if (match_len2 == 0)
3311                                                 match_len_zero_count++;
3312                                         else
3313                                                 match_len_zero_count = 0;
3314                                 }
3315                                 else {
3316                                         if (++match_len_zero_count > 3) {
3317                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3318                                                 match_len_zero_count = 0;
3319                                         }
3320                                         break;
3321                                 }
3322                         }
3323                         if (!cur)
3324                                 return 0;
3325                 }
3326                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3327                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3328                         cur.forwardPar();
3329                 } else {
3330                         // This should exit nested insets, if any, or otherwise undefine the currsor.
3331                         cur.pos() = cur.lastpos();
3332                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3333                         cur.forwardPos();
3334                 }
3335         }
3336         return 0;
3337 }
3338
3339
3340 /// Find the most backward consecutive match within same paragraph while searching backwards.
3341 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3342 {
3343         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3344         DocIterator tmp_cur = cur;
3345         int len = findAdvFinalize(tmp_cur, match);
3346         Inset & inset = cur.inset();
3347         for (; cur != cur_begin; cur.backwardPos()) {
3348                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3349                 DocIterator new_cur = cur;
3350                 new_cur.backwardPos();
3351                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3352                         break;
3353                 int new_len = findAdvFinalize(new_cur, match);
3354                 if (new_len == len)
3355                         break;
3356                 len = new_len;
3357         }
3358         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3359         return len;
3360 }
3361
3362
3363 /// Finds backwards
3364 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3365 {
3366         if (! cur)
3367                 return 0;
3368         // Backup of original position
3369         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3370         if (cur == cur_begin)
3371                 return 0;
3372         cur.backwardPos();
3373         DocIterator cur_orig(cur);
3374         bool pit_changed = false;
3375         do {
3376                 cur.pos() = 0;
3377                 bool found_match = (match(cur, -1, false).match_len > 0);
3378
3379                 if (found_match) {
3380                         if (pit_changed)
3381                                 cur.pos() = cur.lastpos();
3382                         else
3383                                 cur.pos() = cur_orig.pos();
3384                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
3385                         DocIterator cur_prev_iter;
3386                         do {
3387                                 found_match = (match(cur).match_len > 0);
3388                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
3389                                        << found_match << ", cur: " << cur);
3390                                 if (found_match)
3391                                         return findMostBackwards(cur, match);
3392
3393                                 // Stop if begin of document reached
3394                                 if (cur == cur_begin)
3395                                         break;
3396                                 cur_prev_iter = cur;
3397                                 cur.backwardPos();
3398                         } while (true);
3399                 }
3400                 if (cur == cur_begin)
3401                         break;
3402                 if (cur.pit() > 0)
3403                         --cur.pit();
3404                 else
3405                         cur.backwardPos();
3406                 pit_changed = true;
3407         } while (!theApp()->longOperationCancelled());
3408         return 0;
3409 }
3410
3411
3412 } // namespace
3413
3414
3415 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
3416                                  DocIterator const & cur, int len)
3417 {
3418         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
3419                 return docstring();
3420         if (!opt.ignoreformat)
3421                 return latexifyFromCursor(cur, len);
3422         else
3423                 return stringifyFromCursor(cur, len);
3424 }
3425
3426
3427 FindAndReplaceOptions::FindAndReplaceOptions(
3428         docstring const & find_buf_name, bool casesensitive,
3429         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
3430         docstring const & repl_buf_name, bool keep_case,
3431         SearchScope scope, SearchRestriction restr)
3432         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
3433           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
3434           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
3435 {
3436 }
3437
3438
3439 namespace {
3440
3441
3442 /** Check if 'len' letters following cursor are all non-lowercase */
3443 static bool allNonLowercase(Cursor const & cur, int len)
3444 {
3445         pos_type beg_pos = cur.selectionBegin().pos();
3446         pos_type end_pos = cur.selectionBegin().pos() + len;
3447         if (len > cur.lastpos() + 1 - beg_pos) {
3448                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
3449                 len = cur.lastpos() + 1 - beg_pos;
3450                 end_pos = beg_pos + len;
3451         }
3452         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
3453                 if (isLowerCase(cur.paragraph().getChar(pos)))
3454                         return false;
3455         return true;
3456 }
3457
3458
3459 /** Check if first letter is upper case and second one is lower case */
3460 static bool firstUppercase(Cursor const & cur)
3461 {
3462         char_type ch1, ch2;
3463         pos_type pos = cur.selectionBegin().pos();
3464         if (pos >= cur.lastpos() - 1) {
3465                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
3466                 return false;
3467         }
3468         ch1 = cur.paragraph().getChar(pos);
3469         ch2 = cur.paragraph().getChar(pos + 1);
3470         bool result = isUpperCase(ch1) && isLowerCase(ch2);
3471         LYXERR(Debug::FIND, "firstUppercase(): "
3472                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
3473                << ch2 << "(" << char(ch2) << ")"
3474                << ", result=" << result << ", cur=" << cur);
3475         return result;
3476 }
3477
3478
3479 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
3480  **
3481  ** \fixme What to do with possible further paragraphs in replace buffer ?
3482  **/
3483 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
3484 {
3485         ParagraphList::iterator pit = buffer.paragraphs().begin();
3486         LASSERT(pit->size() >= 1, /**/);
3487         pos_type right = pos_type(1);
3488         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
3489         right = pit->size();
3490         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
3491 }
3492
3493 } // namespace
3494
3495 ///
3496 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
3497 {
3498         Cursor & cur = bv->cursor();
3499         if (opt.repl_buf_name == docstring()
3500             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
3501             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3502                 return;
3503
3504         DocIterator sel_beg = cur.selectionBegin();
3505         DocIterator sel_end = cur.selectionEnd();
3506         if (&sel_beg.inset() != &sel_end.inset()
3507             || sel_beg.pit() != sel_end.pit()
3508             || sel_beg.idx() != sel_end.idx())
3509                 return;
3510         int sel_len = sel_end.pos() - sel_beg.pos();
3511         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
3512                << ", sel_len: " << sel_len << endl);
3513         if (sel_len == 0)
3514                 return;
3515         LASSERT(sel_len > 0, return);
3516
3517         if (!matchAdv(sel_beg, sel_len).match_len)
3518                 return;
3519
3520         // Build a copy of the replace buffer, adapted to the KeepCase option
3521         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
3522         ostringstream oss;
3523         repl_buffer_orig.write(oss);
3524         string lyx = oss.str();
3525         Buffer repl_buffer("", false);
3526         repl_buffer.setUnnamed(true);
3527         LASSERT(repl_buffer.readString(lyx), return);
3528         if (opt.keep_case && sel_len >= 2) {
3529                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
3530                 if (cur.inTexted()) {
3531                         if (firstUppercase(cur))
3532                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3533                         else if (allNonLowercase(cur, sel_len))
3534                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3535                 }
3536         }
3537         cap::cutSelection(cur, false);
3538         if (cur.inTexted()) {
3539                 repl_buffer.changeLanguage(
3540                         repl_buffer.language(),
3541                         cur.getFont().language());
3542                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3543                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3544                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3545                                         repl_buffer.params().documentClassPtr(),
3546                                         bv->buffer().errorList("Paste"));
3547                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3548                 sel_len = repl_buffer.paragraphs().begin()->size();
3549         } else if (cur.inMathed()) {
3550                 odocstringstream ods;
3551                 otexstream os(ods);
3552                 // OutputParams runparams(&repl_buffer.params().encoding());
3553                 OutputParams runparams(encodings.fromLyXName("utf8"));
3554                 runparams.nice = false;
3555                 runparams.flavor = OutputParams::XETEX;
3556                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3557                 runparams.dryrun = true;
3558                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3559                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3560                 docstring repl_latex = ods.str();
3561                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3562                 string s;
3563                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3564                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3565                 repl_latex = from_utf8(s);
3566                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3567                 MathData ar(cur.buffer());
3568                 asArray(repl_latex, ar, Parse::NORMAL);
3569                 cur.insert(ar);
3570                 sel_len = ar.size();
3571                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3572         }
3573         if (cur.pos() >= sel_len)
3574                 cur.pos() -= sel_len;
3575         else
3576                 cur.pos() = 0;
3577         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3578         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3579         bv->processUpdateFlags(Update::Force);
3580 }
3581
3582
3583 /// Perform a FindAdv operation.
3584 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3585 {
3586         DocIterator cur;
3587         int match_len = 0;
3588
3589         // e.g., when invoking word-findadv from mini-buffer wither with
3590         //       wrong options syntax or before ever opening advanced F&R pane
3591         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3592                 return false;
3593
3594         try {
3595                 MatchStringAdv matchAdv(bv->buffer(), opt);
3596                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3597                 if (length > 0)
3598                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3599                 findAdvReplace(bv, opt, matchAdv);
3600                 cur = bv->cursor();
3601                 if (opt.forward)
3602                         match_len = findForwardAdv(cur, matchAdv);
3603                 else
3604                         match_len = findBackwardsAdv(cur, matchAdv);
3605         } catch (...) {
3606                 // This may only be raised by lyx::regex()
3607                 bv->message(_("Invalid regular expression!"));
3608                 return false;
3609         }
3610
3611         if (match_len == 0) {
3612                 bv->message(_("Match not found!"));
3613                 return false;
3614         }
3615
3616         bv->message(_("Match found!"));
3617
3618         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3619         bv->putSelectionAt(cur, match_len, !opt.forward);
3620
3621         return true;
3622 }
3623
3624
3625 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3626 {
3627         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3628            << opt.casesensitive << ' '
3629            << opt.matchword << ' '
3630            << opt.forward << ' '
3631            << opt.expandmacros << ' '
3632            << opt.ignoreformat << ' '
3633            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3634            << opt.keep_case << ' '
3635            << int(opt.scope) << ' '
3636            << int(opt.restr);
3637
3638         LYXERR(Debug::FIND, "built: " << os.str());
3639
3640         return os;
3641 }
3642
3643
3644 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3645 {
3646         LYXERR(Debug::FIND, "parsing");
3647         string s;
3648         string line;
3649         getline(is, line);
3650         while (line != "EOSS") {
3651                 if (! s.empty())
3652                         s = s + "\n";
3653                 s = s + line;
3654                 if (is.eof())   // Tolerate malformed request
3655                         break;
3656                 getline(is, line);
3657         }
3658         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3659         opt.find_buf_name = from_utf8(s);
3660         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
3661         is.get();       // Waste space before replace string
3662         s = "";
3663         getline(is, line);
3664         while (line != "EOSS") {
3665                 if (! s.empty())
3666                         s = s + "\n";
3667                 s = s + line;
3668                 if (is.eof())   // Tolerate malformed request
3669                         break;
3670                 getline(is, line);
3671         }
3672         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3673         opt.repl_buf_name = from_utf8(s);
3674         is >> opt.keep_case;
3675         int i;
3676         is >> i;
3677         opt.scope = FindAndReplaceOptions::SearchScope(i);
3678         is >> i;
3679         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3680
3681         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3682                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3683                << opt.scope << ' ' << opt.restr);
3684         return is;
3685 }
3686
3687 } // namespace lyx