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