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