]> git.lyx.org Git - features.git/blob - src/lyxfind.cpp
Amend(2) 7a03fa6: 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 seach for colored text too
848         while (regex_replace(t, t, REGEX_BOS "\\\\(((emph|noun|text(bf|sl|sf|it|tt))|((textcolor|foreignlanguage)\\{[a-z]+\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part)\\*?)\\{", "")
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)\\*?)$");
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  * Faster search for the related closing parenthesis
903  */
904  static int findclosing(string p, int start, int end)
905 {
906         int skip = 0;
907         int depth = 0;
908         int lastunclosed = start-1;
909         for (int i = start; i < end; i += 1 + skip) {
910                 char c;
911                 c = p[i];
912                 skip = 0;
913                 if (c == '\\') skip = 1;
914                 else if (c == '{') {
915                   depth++;
916                   lastunclosed = i;
917                 }
918                 else if (c == '}') {
919                         if (depth == 0) return(i);
920                         --depth;
921                 }
922         }
923         return(0 - lastunclosed);
924 }
925
926 /*
927  * Discard any info for char sizes for now.
928  */
929 static string removefontinfo(string par)
930 {
931         // Remove fontsizes, inputencoding
932         smatch sub;
933         list <string> fpars;
934         static regex const sizescodings("(\\\\(footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|inputencoding\\{[^\\}]*})(\b|(\\{(\\{\\})?\\})?(%\\n)?))");
935         for (sregex_iterator it(par.begin(), par.end(), sizescodings), end; it != end; ++it) {
936                 sub = *it;
937                 string token = sub.str(1);
938                 fpars.push_back(token);
939         }
940         for (list<string>::const_iterator li = fpars.begin(); li != fpars.end(); ++li) {
941                 string token = *li;
942                 int f;
943                 int firstpos = 0;
944                 int ic; // Position of closing part e.g. '}'
945                 while ((f = par.find(token, firstpos)) >= 0) {
946                         size_t ssize = token.length();
947                         int parcount = 0;       // how many '{}' can be removed
948                         if (f == 0)
949                                 ic = -1;
950                         else {
951                                 if (par[f-1] != '{')
952                                         ic = -1;
953                                 else {
954                                         // here '{' preceedes
955                                         ic = findclosing(par, f + ssize, par.length());
956                                         if (f == 1)
957                                                 parcount = 1;
958                                         else if ((f == 2) && (par[f-2] == '{')) {
959                                                 if ((ic < 0) || (par[ic+1] == '}'))
960                                                         parcount = 2;
961                                                 else
962                                                         parcount = 1;
963                                         } else while (f > parcount + 1) {
964                                                 if (par[f-2-parcount] != '{')
965                                                         break;
966                                                 parcount++;
967                                                 if ((ic > 0) && (par[ic+parcount] != '}'))
968                                                         break;
969                                         }
970                                 }
971                         }
972                         firstpos = f;
973
974                         if (ic < 0)
975                                 ic = par.length() - parcount;
976                         par = par.substr(0, f-parcount) + par.substr(f+ssize, ic+parcount-f-ssize) + par.substr(ic+parcount);
977                 }
978         }
979         return(par);
980 }
981
982 class emptyResult {
983  public:
984   bool isEmpty;
985   int lastPosition;
986  emptyResult(bool empty, int pos) : isEmpty(empty), lastPosition(pos) {};
987 };
988
989 class LangInfo {
990   public:
991     enum Type {
992       Invalid,
993       Valid,
994       LastValid,
995     };
996     Type valid;
997
998     /*LangInfo(LangInfo &orig) :
999         par(orig.par),
1000         maxoffset(orig.maxoffset),
1001         search(orig.search) {valid = Invalid;}
1002     */
1003     LangInfo(string par, string search1 = "", int start = 0, int end = -1)
1004       : par(par),
1005       _tokenend(0),
1006       _dataEnd(0),
1007       actualdeptindex(0),
1008       ignoreidx(-1)
1009       {
1010       valid = Invalid;
1011       _tokenstart = start;
1012       if (end > int(par.length())) {
1013         maxoffset = par.length();
1014       }
1015       else if (end > 0)
1016         maxoffset = end;
1017       else
1018         maxoffset = par.length();
1019       if (!search1.empty())
1020         _search = search1;
1021       regexPossible = false;
1022       size_t tmpreg = par.find("\\regexp{", _tokenstart);
1023       if (tmpreg != string::npos) {
1024         if (tmpreg < maxoffset)
1025           regexPossible = true;
1026       }
1027     }
1028     bool nextInfo();    // of the same type, from the last start in the same reagion
1029     bool firstInfo(string search, int datastart);
1030     void setDataEnd(int value);
1031     void setDataStart(int value);
1032     int getDataStart() { return _dataStart;};
1033     string name() { return _search;};
1034     string lasttoken() { if (valid == Valid) return _foundtoken; else return "";};
1035     int getStart() { return _tokenstart;};
1036     int getTokenEnd() { return _tokenend;};
1037     int getEnd() { return _dataEnd;};
1038     bool isValid() { return (valid == Valid); };
1039     void process(ostringstream &os);
1040     void output(ostringstream &os, int);
1041     void addIntervall(int upper);
1042     void addIntervall(int low, int upper); /* if explicit */
1043     void handleParentheses(int lastpos, bool closingAllowed);
1044     int discardParethesizedInBlock(int start);
1045   private:
1046     string par;
1047     string _search;
1048     string _foundtoken;
1049     int _tokenstart;
1050     int _tokenend;
1051     int _dataStart;
1052     int _dataEnd;
1053     bool atEnd;
1054     size_t maxoffset;
1055     int depts[20];
1056     int closes[20];
1057     int actualdeptindex;
1058     int ignoreIntervalls[10][2];
1059     int ignoreidx;
1060     bool regexPossible;
1061     void adaptIgnoringParts(bool useOld = false);
1062     int nextNotIgnored(int start);
1063     int previousNotIgnored(int start);
1064     bool discarSuperfluousParentheses(int start);
1065     emptyResult checkEmpty(int start, bool atStart);
1066 };
1067
1068 void LangInfo::setDataEnd(int dataend)
1069 {
1070   if (dataend < _tokenend) {
1071     _dataEnd = _tokenend;
1072     LYXERR(Debug::FIND, "Wrong data start, too low");
1073   }
1074   else if (size_t(dataend) > par.length()) {
1075     LYXERR(Debug::FIND, "Wrong data start, too high");
1076     _dataEnd = par.length();
1077   }
1078   else
1079     _dataEnd = dataend;
1080 }
1081
1082 /*
1083  * Try to reuse the ignoring parts from parent
1084  *
1085  */
1086 void LangInfo::adaptIgnoringParts(bool useOld)
1087 {
1088   if (useOld && (ignoreidx >= 0)) {
1089     int idx;
1090     for (idx = 0; idx <= ignoreidx; idx++) {
1091       if (ignoreIntervalls[idx][1] >= _dataStart) {
1092         if (ignoreIntervalls[idx][0] < _dataStart)
1093           ignoreIntervalls[idx][0] = _dataStart;
1094         break;
1095       }
1096     }
1097     if (idx > 0) {
1098       for (int i = 0; i <= ignoreidx - idx; i++) {
1099         ignoreIntervalls[i][0] = ignoreIntervalls[idx+i][0];
1100         ignoreIntervalls[i][1] = ignoreIntervalls[idx+i][1];
1101       }
1102       ignoreidx -= idx;
1103     }
1104   }
1105   else {
1106     ignoreidx = 0;
1107     ignoreIntervalls[ignoreidx][0] = _dataStart;
1108     if ((par[_dataStart] == '{') && (par[_dataStart+1] == '}')) {
1109       // First candidates to be ignored
1110       ignoreIntervalls[ignoreidx][1] = _dataStart+2;
1111     }
1112     else
1113       ignoreIntervalls[ignoreidx][1] = _dataStart;
1114   }
1115 }
1116
1117 void LangInfo::setDataStart(int datastart)
1118 {
1119   bool reUse = true;                    /* Reuse previous ignoring intervalls */
1120   if (datastart < _tokenend) {
1121     _dataStart = _tokenend;
1122     LYXERR(Debug::FIND, "Wrong data start, too low");
1123     reUse = false;
1124   }
1125   else if (size_t(datastart) > par.length()) {
1126     LYXERR(Debug::FIND, "Wrong data start, too high");
1127     _dataStart = par.length();
1128     reUse = false;
1129   }
1130   else
1131     _dataStart = datastart;
1132   LYXERR(Debug::FIND, "found entry at " << _tokenstart);
1133   actualdeptindex = 1;                  /* == Number of open brases */
1134   depts[0] = _dataStart;
1135   closes[0] = -1;
1136   depts[1] = _dataStart;
1137   adaptIgnoringParts(reUse);
1138 }
1139
1140 /*
1141  * Keep the list of actual opened parentheses actual
1142  * (e.g. depth == 4 means there are 4 '{' not processed yet)
1143  */
1144 void LangInfo::handleParentheses(int lastpos, bool closingAllowed)
1145 {
1146   int skip = 0;
1147   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
1148     char c;
1149     c = par[i];
1150     skip = 0;
1151     if (c == '\\') skip = 1;
1152     else if (c == '{') {
1153       actualdeptindex++;
1154       depts[actualdeptindex] = i+1;
1155       closes[actualdeptindex] = -1;
1156     }
1157     else if (c == '}') {
1158       if (actualdeptindex <= 0) {
1159         if (closingAllowed) {
1160           // if we are at the very end
1161           addIntervall(i, i+1);
1162         }
1163         else {
1164           LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should never happen! */
1165         }
1166       }
1167       else {
1168         closes[actualdeptindex] = i+1;
1169         actualdeptindex--;
1170       }
1171     }
1172   }
1173 }
1174
1175 /*
1176  * Expand the region of ignored parts of the input latex string
1177  * The region is only relevant in output()
1178  */
1179 void LangInfo::addIntervall(int low, int upper)
1180 {
1181   int idx;
1182   if (low == upper) return;
1183   for (idx = ignoreidx+1; idx > 0; --idx) {
1184     if (low > ignoreIntervalls[idx-1][1]) {
1185       break;
1186     }
1187   }
1188   if (idx > ignoreidx) {
1189     ignoreIntervalls[idx][0] = low;
1190     ignoreIntervalls[idx][1] = upper;
1191   }
1192   else {
1193     // Expand only if one of the new bounds is inside the interwall
1194     // or
1195     if (((low <= ignoreIntervalls[idx][1]) && (upper >= ignoreIntervalls[idx][1])) ||
1196         ((low <= ignoreIntervalls[idx][0]) && (upper >= ignoreIntervalls[idx][0]))) {
1197       if (low < ignoreIntervalls[idx][0])
1198         ignoreIntervalls[idx][0] = low;
1199       if (upper > ignoreIntervalls[idx][1])
1200         ignoreIntervalls[idx][1] = upper;
1201     }
1202   }
1203   ignoreidx = idx;                      /* because upper is in all cases bigger */
1204 }
1205
1206 void LangInfo::addIntervall(int upper)
1207 {
1208   int low;
1209   if (actualdeptindex >= 0)
1210     low = depts[actualdeptindex];   /*  the position of last unclosed '{' */
1211   else {
1212     LYXERR(Debug::FIND, "Error while checking the position of last open parenthesis");
1213     low = upper;
1214   }
1215   addIntervall(low, upper);
1216 }
1217
1218 int LangInfo::previousNotIgnored(int start)
1219 {
1220     int idx = 0;                          /* int intervalls */
1221     for (idx = ignoreidx; idx >= 0; --idx) {
1222       if (start > ignoreIntervalls[idx][1])
1223         return(start);
1224       if (start >= ignoreIntervalls[idx][0])
1225         start = ignoreIntervalls[idx][0]-1;
1226     }
1227     return start;
1228 }
1229
1230 int LangInfo::nextNotIgnored(int start)
1231 {
1232     int idx = 0;                          /* int intervalls */
1233     for (idx = 0; idx <= ignoreidx; idx++) {
1234       if (start < ignoreIntervalls[idx][0])
1235         return(start);
1236       if (start < ignoreIntervalls[idx][1])
1237         start = ignoreIntervalls[idx][1];
1238     }
1239     return start;
1240 }
1241
1242 void LangInfo::output(ostringstream &os, int lastpos)
1243 {
1244   // get number of chars to output
1245   int idx = 0;                          /* int intervalls */
1246   int count = 0;
1247   for (int i = _dataStart; i < lastpos;) {
1248     if (i <= ignoreIntervalls[idx][0]) {
1249       count += ignoreIntervalls[idx][0] - i;
1250       i = ignoreIntervalls[idx][1];
1251     }
1252     idx++;
1253     if (idx > ignoreidx) {
1254       count += lastpos-i;
1255       break;
1256     }
1257   }
1258   //cout << "Number of output chars would be " << count + actualdeptindex << "\n";
1259   if (count > 0) {
1260     // Now the acual data
1261     os << par.substr(_tokenstart, _tokenend - _tokenstart);
1262     idx = 0;
1263     for (int i = _dataStart; i < lastpos;) {
1264       if (i <= ignoreIntervalls[idx][0]) {
1265         os << par.substr(i, ignoreIntervalls[idx][0] - i);
1266         i = ignoreIntervalls[idx][1];
1267         handleParentheses(ignoreIntervalls[idx][1], false);
1268       }
1269       idx++;
1270       if (idx > ignoreidx) {
1271         if (lastpos > i) {
1272           os << par.substr(i, lastpos-i);
1273         }
1274         break;
1275       }
1276     }
1277     handleParentheses(lastpos, false);
1278     for (int i = actualdeptindex; i > 0; --i)
1279       os << "}";
1280   }
1281   handleParentheses(lastpos, true);     /* extra closings '}' allowed here */
1282 }
1283
1284 bool LangInfo::nextInfo()
1285 {
1286   int start = _tokenstart;
1287
1288   if (valid == Invalid)
1289     _dataEnd = _tokenstart;
1290   else if (valid == LastValid)
1291     return false;
1292   // cout << "Start search at " << _tokenclose << " for \"" << _search << "\n";
1293   size_t foundstart = par.find(_search, _dataEnd);
1294   if (foundstart == string::npos) {
1295     if (valid == Valid)
1296       valid = LastValid;
1297     return false;                      // not found
1298   }
1299   if (foundstart >= maxoffset)
1300     return false;
1301   start = foundstart;
1302   int closelang = findclosing(par, start + _search.length(), maxoffset);
1303   if (closelang < 0)
1304     return false;
1305   if (size_t(closelang) >= maxoffset)
1306     return false;
1307   if (par[closelang] != '}')
1308     return false;
1309   valid = Valid;
1310   _foundtoken = par.substr(start, closelang - start + 2);
1311   _tokenstart = start;
1312   _tokenend = closelang+2;
1313   setDataStart(_tokenend);
1314   closelang = findclosing(par, _dataStart, maxoffset);
1315   if (closelang < 0) {
1316     _dataEnd = maxoffset;
1317     atEnd = true;
1318   }
1319   else {
1320     _dataEnd = closelang;
1321     atEnd = false;
1322   }
1323   return true;
1324 }
1325
1326 bool LangInfo::firstInfo(string search1, int datastart)
1327 {
1328   if (!search1.empty()) {
1329     if (_search.compare(search1) != 0) {
1330       _tokenstart = datastart;
1331       _search = search1;
1332       valid = Invalid;
1333     }
1334     else {
1335       // This is a clone
1336       _tokenstart = datastart;
1337       valid = Invalid;
1338     }
1339   }
1340   return nextInfo();
1341 }
1342
1343 /*
1344  * Return 0 if nothing found
1345  * >0 size of found a known macro
1346  * <0 -size of emmty unknow macro
1347  */
1348 static int checkMacro(string checked)
1349 {
1350   static regex anymacro("(\\\\([a-z]+)(\\{\\})+).*", regex_constants::ECMAScript);
1351   static regex known("(backslash)$", regex_constants::ECMAScript);
1352   cmatch cm;
1353
1354   if (regex_match(checked.c_str(), cm, anymacro)) {
1355     string found2 = cm[2];
1356     if (regex_match(found2, known)) {
1357       return cm[1].second - cm[1].first;
1358     }
1359     else {
1360       return cm[1].first - cm[1].second;
1361     }
1362   }
1363   else
1364     return 0;
1365 }
1366
1367 emptyResult LangInfo::checkEmpty(int start, bool atStartOrigin)
1368 {
1369   emptyResult Result(true, start);
1370
1371   bool atStart = atStartOrigin;
1372   while (start < _dataEnd) {
1373     if (par[start] == '{') {
1374       emptyResult inside = checkEmpty(start+1, atStart);
1375       if (inside.isEmpty) {
1376         if (atStart)
1377           addIntervall(start, inside.lastPosition+1);
1378         else
1379           addIntervall(start+1,inside.lastPosition);
1380       }
1381       else {
1382         // non empty parenthesis
1383         if (atStart) {
1384           addIntervall(start, start+1);
1385           addIntervall(inside.lastPosition, inside.lastPosition+1);
1386         }
1387       }
1388       Result.isEmpty &= inside.isEmpty;
1389       start = inside.lastPosition+1;
1390     }
1391     else if (par[start] == '}') {
1392       Result.lastPosition = start;
1393       return(Result);
1394     }
1395     else if (par[start] == '\\') {
1396       int check = checkMacro(par.substr(start, 20));
1397       if (check > 0) {
1398         // Known char,
1399         start += check;
1400         Result.isEmpty = false;
1401         atStart = false;
1402       }
1403       else if (check == 0) {
1404         // skip next escaped
1405         // or it is \regexp{.*\endregexp{}} which counts as 1 char!
1406         if (regexPossible && (par.compare(start, 8, "\\regexp{") == 0)) {
1407           size_t endreg = par.find("\\endregexp{}}");
1408           if (endreg > size_t(_dataEnd) - 13)
1409             start = _dataEnd;
1410           else
1411             start = endreg + 12;
1412         }
1413         else
1414           start += 2;
1415         Result.isEmpty = false;
1416         atStart = false;
1417       }
1418       else {
1419         // Here follows maybe empty macro?
1420         // discard e.g. '\noun{}', or '\noun{}{}'
1421         addIntervall(start, start - check);
1422         start = start - check;
1423         atStart = atStartOrigin;
1424       }
1425     }
1426     else {
1427       // Normal chars
1428       Result.isEmpty = false;
1429       if (par[start] != ' ')
1430         atStart = false;
1431       else
1432         atStart = atStartOrigin;
1433       start += 1;
1434     }
1435   }
1436   return Result;
1437 }
1438
1439 int LangInfo::discardParethesizedInBlock(int start)
1440 {
1441   if (regexPossible) {
1442     size_t regex_start, regex_end;
1443     regex_start = par.find("\\regexp{", start);
1444     if (regex_start == string::npos)
1445       regexPossible = false;
1446     else if (regex_start >= size_t(_dataEnd))
1447       regexPossible = false;
1448     else {
1449       regex_end = par.find("\\endregexp{}}", regex_start + 8);
1450       if (regex_end == string::npos)
1451         regexPossible = false;
1452       else if (regex_end > size_t(_dataEnd))
1453         regexPossible = false;
1454     }
1455   }
1456   int previous = previousNotIgnored(start-1);
1457   bool atStart =  (par[previous] == '{');
1458   emptyResult inside = checkEmpty(start, atStart);
1459   return inside.lastPosition+1;
1460 }
1461
1462 bool LangInfo::discarSuperfluousParentheses(int start)
1463 {
1464   start = nextNotIgnored(start);
1465   start = discardParethesizedInBlock(start);
1466   while ((par[start] == '{') && (start < _dataEnd)) {
1467     start = discardParethesizedInBlock(start);
1468   }
1469   // It is empty if (par[start] == '}')
1470   return ((start >= _dataEnd) || (par[start] == '}'));
1471 }
1472
1473 void LangInfo::process(ostringstream &os)
1474 {
1475   LangInfo color(*this);
1476   (void) color.firstInfo("\\textcolor{", _dataStart);
1477   while (color.isValid() && (color.getStart() < _dataEnd)) {
1478     bool isEmpty = discarSuperfluousParentheses(color.getDataStart());
1479     if (isEmpty) {
1480       // it is empty, so ignore and go to next color
1481       addIntervall(color.getStart(), color.getEnd()+1);
1482       int start = color.getEnd()+1;
1483       discarSuperfluousParentheses(start);
1484     }
1485     else { // not empty
1486       if (par[color.getStart()-1] != '{') {
1487         // We are not at start
1488         output(os, color.getStart());
1489         addIntervall(color.getStart());
1490       }
1491       // Check if color empty
1492       output(os, color.getEnd()+1);
1493       addIntervall(color.getEnd()+1);
1494       discarSuperfluousParentheses(color.getEnd()+1);
1495     }
1496     color.nextInfo();
1497   }
1498   int start;
1499   if (color.valid == LastValid)
1500     start = color.getEnd()+1;
1501   else {
1502     // Apparently nothing output so far
1503     start = nextNotIgnored(_dataStart);
1504   }
1505   discarSuperfluousParentheses(start);
1506   output(os, _dataEnd);
1507 }
1508
1509 /*
1510  * Called only if the par starts with lang spec
1511  */
1512
1513 string splitForColors(string par) {
1514   ostringstream os;
1515   LangInfo firstLanguage(par, "\\foreignlanguage{");
1516   if (firstLanguage.firstInfo("\\foreignlanguage{", 0)) {
1517     LangInfo nextLanguage(firstLanguage);
1518     if (nextLanguage.firstInfo("\\foreignlanguage{", firstLanguage.getTokenEnd())) {
1519       firstLanguage.setDataEnd(nextLanguage.getStart());
1520     }
1521     else {
1522       int oldend = firstLanguage.getEnd();
1523       firstLanguage.setDataEnd(par.length());
1524       // discard old closing
1525       firstLanguage.addIntervall(oldend, oldend+1);
1526     }
1527     firstLanguage.process(os);
1528     // For the case, that the first language ends unexpected
1529     int lastgapstart = firstLanguage.getEnd()+1;
1530     while (nextLanguage.isValid()) {
1531       nextLanguage.process(os);
1532       // To handle the gap, we need the end of last languuage to start of next
1533       int gapstart = nextLanguage.getEnd()+1;
1534       if (gapstart > lastgapstart)
1535         lastgapstart = gapstart;
1536       int gapend;
1537       nextLanguage.nextInfo();
1538       if (nextLanguage.isValid())
1539         gapend = nextLanguage.getStart();
1540       else
1541         gapend = par.length();
1542       // Now handle the gap, if there is one
1543       if (gapend > gapstart) {
1544         // cout << "Gap found, size = " << gapend - gapstart << "\n";
1545         firstLanguage.setDataEnd(gapend);
1546         firstLanguage.setDataStart(gapstart);
1547         firstLanguage.process(os);
1548         lastgapstart = gapend+1;
1549       }
1550     }
1551     if (size_t(lastgapstart) < par.length()) {
1552       int lastgapend = par.length();
1553       // cout << "Found last gap, size = " << lastgapend - lastgapstart << "\n";
1554       firstLanguage.setDataEnd(lastgapend);
1555       firstLanguage.setDataStart(lastgapstart);
1556       firstLanguage.process(os);
1557     }
1558   }
1559   string s = os.str();
1560   return s;
1561 }
1562
1563 /*
1564  * Try to unify the language specs in the latexified text.
1565  * Resulting modified string is set to "", if
1566  * the searched tex does not contain all the features in the search pattern
1567  */
1568 static string correctlanguagesetting(string par, bool from_regex, bool withformat)
1569 {
1570         static Features regex_f;
1571         static int missed = 0;
1572         static bool regex_with_format = false;
1573
1574         int parlen = par.length();
1575
1576         while ((parlen > 0) && (par[parlen-1] == '\n')) {
1577                 parlen--;
1578         }
1579         string result = removefontinfo(par.substr(0, parlen));
1580         LYXERR(Debug::FIND, "input: \"" << result << "\"");
1581         result = splitForColors(result);
1582         LYXERR(Debug::FIND, "After split: \"" << result << "\"");
1583         bool handle_colors = false;
1584         if (from_regex) {
1585                 missed = 0;
1586                 if (withformat) {
1587                         regex_f = identifyFeatures(result);
1588                         string features = "";
1589                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
1590                                 string a = it->first;
1591                                 regex_with_format = true;
1592                                 if (a.compare(0,10,"textcolor{") == 0)
1593                                   handle_colors = true;
1594                                 features += " " + a;
1595                                 // LYXERR0("Identified regex format:" << a);
1596                         }
1597                         LYXERR(Debug::FIND, "Identified Features" << features);
1598
1599                 }
1600         } else if (regex_with_format) {
1601                 Features info = identifyFeatures(result);
1602                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
1603                         string a = it->first;
1604                         bool b = it->second;
1605                         if (b && ! info[a]) {
1606                                 missed++;
1607                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
1608                                 return("");
1609                         }
1610                         else if (a.compare(0,10,"textcolor{") == 0)
1611                                 handle_colors = true;
1612                 }
1613         }
1614         else {
1615                 // LYXERR0("No regex formats");
1616         }
1617         // remove possible disturbing macros
1618         while (regex_replace(result, result, "\\\\(noindent )", ""))
1619                 ;
1620         // Either not found language spec,or is single and closed spec or empty
1621         // to be removed
1622         // [a-z+]par
1623         static regex const parreg("((\\n)?\\\\[a-z]+par)\\{");
1624
1625         list <string> pars;
1626         smatch sub;
1627         for (sregex_iterator it(result.begin(), result.end(), parreg), end; it != end; ++it) {
1628                 sub = *it;
1629                 string token = sub.str(1);
1630                 pars.push_back(token);
1631         }
1632         for (list<string>::const_iterator li = pars.begin(); li != pars.end(); ++li) {
1633                 string token = *li;
1634                 int ti = result.find(token);
1635                 int tokensize = token.size() + 1;
1636                 if (ti >= 0) {
1637                         int tc = findclosing(result, ti + tokensize, result.size());
1638                         if (tc > 0)
1639                                 result = result.substr(0, ti) + result.substr(ti + tokensize, tc - ti -tokensize) + result.substr(tc+1);
1640
1641                 }
1642         }
1643         if (handle_colors) {
1644           while (regex_replace(result, result, "(\\{\\\\textcolor\\{[a-z]+\\}\\{)\\s*\\{\\}\\s*", "$1"));
1645           while (regex_replace(result, result, "\\{\\\\textcolor\\{[a-z]+\\}\\{\\s*\\}\\s*\\}", ""));
1646         }
1647         return(result);
1648 }
1649
1650
1651 // Remove trailing closure of math, macros and environments, so to catch parts of them.
1652 static int identifyClosing(string & t)
1653 {
1654         int open_braces = 0;
1655         do {
1656                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
1657                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
1658                         continue;
1659                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
1660                         continue;
1661                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
1662                         continue;
1663                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
1664                         ++open_braces;
1665                         continue;
1666                 }
1667                 break;
1668         } while (true);
1669         return open_braces;
1670 }
1671
1672
1673 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
1674         : p_buf(&buf), p_first_buf(&buf), opt(opt)
1675 {
1676         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
1677         docstring const & ds = stringifySearchBuffer(find_buf, opt);
1678         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
1679         // When using regexp, braces are hacked already by escape_for_regex()
1680         par_as_string = normalize(ds, !use_regexp);
1681         open_braces = 0;
1682         close_wildcards = 0;
1683
1684         size_t lead_size = 0;
1685         // correct the language settings
1686         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
1687         if (opt.ignoreformat) {
1688                 if (!use_regexp) {
1689                         // if par_as_string_nolead were emty,
1690                         // the following call to findAux will always *find* the string
1691                         // in the checked data, and thus always using the slow
1692                         // examining of the current text part.
1693                         par_as_string_nolead = par_as_string;
1694                 }
1695         } else {
1696                 lead_size = identifyLeading(par_as_string);
1697                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
1698                 lead_as_string = par_as_string.substr(0, lead_size);
1699                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
1700         }
1701
1702         if (!use_regexp) {
1703                 open_braces = identifyClosing(par_as_string);
1704                 identifyClosing(par_as_string_nolead);
1705                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
1706                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
1707         } else {
1708                 string lead_as_regexp;
1709                 if (lead_size > 0) {
1710                         // @todo No need to search for \regexp{} insets in leading material
1711                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
1712                         par_as_string = par_as_string_nolead;
1713                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
1714                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
1715                 }
1716                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
1717                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
1718                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
1719                 if (
1720                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
1721                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
1722                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
1723                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
1724                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
1725                         || regex_replace(par_as_string, par_as_string,
1726                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
1727                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
1728                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
1729                         ) {
1730                         ++close_wildcards;
1731                 }
1732                 if (!opt.ignoreformat) {
1733                         // Remove extra '\}' at end
1734                         while ( regex_replace(par_as_string, par_as_string, "(.*)\\\\}$", "$1")) {
1735                                 open_braces++;
1736                         }
1737                         // save '\.'
1738                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
1739                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
1740                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
1741                         // replace '[^...]' with '[^...\}\{\\]'
1742                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
1743                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
1744                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
1745                         // restore '\.'
1746                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
1747                 }
1748                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
1749                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
1750                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
1751                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
1752
1753                 // If entered regexp must match at begin of searched string buffer
1754                 // Kornel: Added parentheses to use $1 for size of the leading string
1755                 string regexp_str;
1756                 string regexp2_str;
1757                 {
1758                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
1759                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
1760                         // so the convert has no effect in that case
1761                         for (int i = 8; i > 0; --i) {
1762                                 string orig = "\\\\" + std::to_string(i);
1763                                 string dest = "\\" + std::to_string(i+1);
1764                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
1765                         }
1766                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
1767                         regexp2_str = "(" + lead_as_regexp + ").*" + par_as_string;
1768                 }
1769                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
1770                 regexp = lyx::regex(regexp_str);
1771
1772                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
1773                 regexp2 = lyx::regex(regexp2_str);
1774         }
1775 }
1776
1777
1778 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
1779 {
1780         if (at_begin &&
1781                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
1782                 return 0;
1783
1784         docstring docstr = stringifyFromForSearch(opt, cur, len);
1785         string str = normalize(docstr, true);
1786         if (!opt.ignoreformat) {
1787                 str = removefontinfo(str);
1788                 str = correctlanguagesetting(str, false, false);
1789         }
1790         if (str.empty()) return(-1);
1791         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
1792         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
1793
1794         if (use_regexp) {
1795                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
1796                 regex const *p_regexp;
1797                 regex_constants::match_flag_type flags;
1798                 if (at_begin) {
1799                         flags = regex_constants::match_continuous;
1800                         p_regexp = &regexp;
1801                 } else {
1802                         flags = regex_constants::match_default;
1803                         p_regexp = &regexp2;
1804                 }
1805                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
1806                 if (re_it == sregex_iterator())
1807                         return 0;
1808                 match_results<string::const_iterator> const & m = *re_it;
1809
1810                 if (0) { // Kornel Benko: DO NOT CHECKK
1811                         // Check braces on the segment that matched the entire regexp expression,
1812                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
1813                         if (!braces_match(m[0].first, m[0].second, open_braces))
1814                                 return 0;
1815                 }
1816
1817                 // Check braces on segments that matched all (.*?) subexpressions,
1818                 // except the last "padding" one inserted by lyx.
1819                 for (size_t i = 1; i < m.size() - 1; ++i)
1820                         if (!braces_match(m[i].first, m[i].second, open_braces))
1821                                 return 0;
1822
1823                 // Exclude from the returned match length any length
1824                 // due to close wildcards added at end of regexp
1825                 // and also the length of the leading (e.g. '\emph{')
1826                 //
1827                 // Whole found string, including the leading: m[0].second - m[0].first
1828                 // Size of the leading string: m[1].second - m[1].first
1829                 int leadingsize = 0;
1830                 if (m.size() > 1)
1831                         leadingsize = m[1].second - m[1].first;
1832                 int result;
1833                 for (size_t i = 0; i < m.size(); i++) {
1834                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
1835                 }
1836                 if (close_wildcards == 0)
1837                         result = m[0].second - m[0].first;
1838
1839                 else
1840                         result =  m[m.size() - close_wildcards].first - m[0].first;
1841
1842                 if (result > leadingsize)
1843                         result -= leadingsize;
1844                 else
1845                         result = 0;
1846                 return(result);
1847         }
1848
1849         // else !use_regexp: but all code paths above return
1850         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
1851                                  << par_as_string << "', str='" << str << "'");
1852         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
1853                                  << lead_as_string << "', par_as_string_nolead='"
1854                                  << par_as_string_nolead << "'");
1855
1856         if (at_begin) {
1857                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
1858                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
1859                 if (str.substr(0, par_as_string.size()) == par_as_string)
1860                         return par_as_string.size();
1861         } else {
1862                 size_t pos = str.find(par_as_string_nolead);
1863                 if (pos != string::npos)
1864                         return par_as_string.size();
1865         }
1866         return 0;
1867 }
1868
1869
1870 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
1871 {
1872         int res = findAux(cur, len, at_begin);
1873         LYXERR(Debug::FIND,
1874                "res=" << res << ", at_begin=" << at_begin
1875                << ", matchword=" << opt.matchword
1876                << ", inTexted=" << cur.inTexted());
1877         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
1878                 return res;
1879         Paragraph const & par = cur.paragraph();
1880         bool ws_left = (cur.pos() > 0)
1881                 ? par.isWordSeparator(cur.pos() - 1)
1882                 : true;
1883         bool ws_right = (cur.pos() + res < par.size())
1884                 ? par.isWordSeparator(cur.pos() + res)
1885                 : true;
1886         LYXERR(Debug::FIND,
1887                "cur.pos()=" << cur.pos() << ", res=" << res
1888                << ", separ: " << ws_left << ", " << ws_right
1889                << endl);
1890         if (ws_left && ws_right)
1891                 return res;
1892         return 0;
1893 }
1894
1895
1896 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
1897 {
1898         string t;
1899         if (! opt.casesensitive)
1900                 t = lyx::to_utf8(lowercase(s));
1901         else
1902                 t = lyx::to_utf8(s);
1903         // Remove \n at begin
1904         while (!t.empty() && t[0] == '\n')
1905                 t = t.substr(1);
1906         // Remove \n at end
1907         while (!t.empty() && t[t.size() - 1] == '\n')
1908                 t = t.substr(0, t.size() - 1);
1909         size_t pos;
1910         // Replace all other \n with spaces
1911         while ((pos = t.find("\n")) != string::npos)
1912                 t.replace(pos, 1, " ");
1913         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
1914         // Kornel: Added textsl, textsf, textit, texttt and noun
1915         // + allow to seach for colored text too
1916         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
1917         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
1918                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
1919         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
1920                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
1921
1922         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor)\\{[a-z]+\\}(\\{(\\\\item |\\{\\})?\\})+", ""));
1923         // FIXME - check what preceeds the brace
1924         if (hack_braces) {
1925                 if (opt.ignoreformat)
1926                         while (regex_replace(t, t, "\\{", "_x_<")
1927                                || regex_replace(t, t, "\\}", "_x_>"))
1928                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
1929                 else
1930                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
1931                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
1932                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
1933         }
1934
1935         return t;
1936 }
1937
1938
1939 docstring stringifyFromCursor(DocIterator const & cur, int len)
1940 {
1941         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
1942         if (cur.inTexted()) {
1943                 Paragraph const & par = cur.paragraph();
1944                 // TODO what about searching beyond/across paragraph breaks ?
1945                 // TODO Try adding a AS_STR_INSERTS as last arg
1946                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
1947                         int(par.size()) : cur.pos() + len;
1948                 OutputParams runparams(&cur.buffer()->params().encoding());
1949                 runparams.nice = true;
1950                 runparams.flavor = OutputParams::LATEX;
1951                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
1952                 // No side effect of file copying and image conversion
1953                 runparams.dryrun = true;
1954                 LYXERR(Debug::FIND, "Stringifying with cur: "
1955                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
1956                 return par.asString(cur.pos(), end,
1957                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
1958                         &runparams);
1959         } else if (cur.inMathed()) {
1960                 docstring s;
1961                 CursorSlice cs = cur.top();
1962                 MathData md = cs.cell();
1963                 MathData::const_iterator it_end =
1964                         (( len == -1 || cs.pos() + len > int(md.size()))
1965                          ? md.end()
1966                          : md.begin() + cs.pos() + len );
1967                 for (MathData::const_iterator it = md.begin() + cs.pos();
1968                      it != it_end; ++it)
1969                         s = s + asString(*it);
1970                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
1971                 return s;
1972         }
1973         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
1974         return docstring();
1975 }
1976
1977
1978 /** Computes the LaTeX export of buf starting from cur and ending len positions
1979  * after cur, if len is positive, or at the paragraph or innermost inset end
1980  * if len is -1.
1981  */
1982 docstring latexifyFromCursor(DocIterator const & cur, int len)
1983 {
1984         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
1985         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
1986                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
1987         Buffer const & buf = *cur.buffer();
1988
1989         odocstringstream ods;
1990         otexstream os(ods);
1991         OutputParams runparams(&buf.params().encoding());
1992         runparams.nice = false;
1993         runparams.flavor = OutputParams::LATEX;
1994         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
1995         // No side effect of file copying and image conversion
1996         runparams.dryrun = true;
1997         runparams.for_search = true;
1998
1999         if (cur.inTexted()) {
2000                 // @TODO what about searching beyond/across paragraph breaks ?
2001                 pos_type endpos = cur.paragraph().size();
2002                 if (len != -1 && endpos > cur.pos() + len)
2003                         endpos = cur.pos() + len;
2004                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
2005                           string(), cur.pos(), endpos);
2006                 string s = lyx::to_utf8(ods.str());
2007                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
2008                 return(lyx::from_utf8(s));
2009         } else if (cur.inMathed()) {
2010                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
2011                 for (int s = cur.depth() - 1; s >= 0; --s) {
2012                         CursorSlice const & cs = cur[s];
2013                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
2014                                 WriteStream ws(os);
2015                                 cs.asInsetMath()->asHullInset()->header_write(ws);
2016                                 break;
2017                         }
2018                 }
2019
2020                 CursorSlice const & cs = cur.top();
2021                 MathData md = cs.cell();
2022                 MathData::const_iterator it_end =
2023                         ((len == -1 || cs.pos() + len > int(md.size()))
2024                          ? md.end()
2025                          : md.begin() + cs.pos() + len);
2026                 for (MathData::const_iterator it = md.begin() + cs.pos();
2027                      it != it_end; ++it)
2028                         ods << asString(*it);
2029
2030                 // Retrieve the math environment type, and add '$' or '$]'
2031                 // or others (\end{equation}) accordingly
2032                 for (int s = cur.depth() - 1; s >= 0; --s) {
2033                         CursorSlice const & cs2 = cur[s];
2034                         InsetMath * inset = cs2.asInsetMath();
2035                         if (inset && inset->asHullInset()) {
2036                                 WriteStream ws(os);
2037                                 inset->asHullInset()->footer_write(ws);
2038                                 break;
2039                         }
2040                 }
2041                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
2042         } else {
2043                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2044         }
2045         return ods.str();
2046 }
2047
2048
2049 /** Finalize an advanced find operation, advancing the cursor to the innermost
2050  ** position that matches, plus computing the length of the matching text to
2051  ** be selected
2052  **/
2053 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
2054 {
2055         // Search the foremost position that matches (avoids find of entire math
2056         // inset when match at start of it)
2057         size_t d;
2058         DocIterator old_cur(cur.buffer());
2059         do {
2060                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
2061                 d = cur.depth();
2062                 old_cur = cur;
2063                 cur.forwardPos();
2064         } while (cur && cur.depth() > d && match(cur) > 0);
2065         cur = old_cur;
2066         if (match(cur) <= 0) return 0;
2067         LYXERR(Debug::FIND, "Ok");
2068
2069         // Compute the match length
2070         int len = 1;
2071         if (cur.pos() + len > cur.lastpos())
2072                 return 0;
2073         LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2074         while (cur.pos() + len <= cur.lastpos() && match(cur, len) <= 0) {
2075                 ++len;
2076                 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2077         }
2078         // Length of matched text (different from len param)
2079         int old_len = match(cur, len);
2080         if (old_len < 0) old_len = 0;
2081         int new_len;
2082         // Greedy behaviour while matching regexps
2083         while ((new_len = match(cur, len + 1)) > old_len) {
2084                 ++len;
2085                 old_len = new_len;
2086                 LYXERR(Debug::FIND, "verifying   match with len = " << len);
2087         }
2088         return len;
2089 }
2090
2091
2092 /// Finds forward
2093 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
2094 {
2095         if (!cur)
2096                 return 0;
2097         while (!theApp()->longOperationCancelled() && cur) {
2098                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
2099                 int match_len = match(cur, -1, false);
2100                 LYXERR(Debug::FIND, "match_len: " << match_len);
2101                 if (match_len > 0) {
2102                         int match_len_zero_count = 0;
2103                         for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
2104                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
2105                                 int match_len2 = match(cur);
2106                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
2107                                 if (match_len2 > 0) {
2108                                         // Sometimes in finalize we understand it wasn't a match
2109                                         // and we need to continue the outest loop
2110                                         int len = findAdvFinalize(cur, match);
2111                                         if (len > 0) {
2112                                                 return len;
2113                                         }
2114                                 }
2115                                 if (match_len2 >= 0) {
2116                                         if (match_len2 == 0)
2117                                                 match_len_zero_count++;
2118                                         else
2119                                                 match_len_zero_count = 0;
2120                                 }
2121                                 else {
2122                                         if (++match_len_zero_count > 3) {
2123                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
2124                                                 match_len_zero_count = 0;
2125                                         }
2126                                         break;
2127                                 }
2128                         }
2129                         if (!cur)
2130                                 return 0;
2131                 }
2132                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
2133                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
2134                         cur.forwardPar();
2135                 } else {
2136                         // This should exit nested insets, if any, or otherwise undefine the currsor.
2137                         cur.pos() = cur.lastpos();
2138                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
2139                         cur.forwardPos();
2140                 }
2141         }
2142         return 0;
2143 }
2144
2145
2146 /// Find the most backward consecutive match within same paragraph while searching backwards.
2147 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
2148 {
2149         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2150         DocIterator tmp_cur = cur;
2151         int len = findAdvFinalize(tmp_cur, match);
2152         Inset & inset = cur.inset();
2153         for (; cur != cur_begin; cur.backwardPos()) {
2154                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
2155                 DocIterator new_cur = cur;
2156                 new_cur.backwardPos();
2157                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
2158                         break;
2159                 int new_len = findAdvFinalize(new_cur, match);
2160                 if (new_len == len)
2161                         break;
2162                 len = new_len;
2163         }
2164         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
2165         return len;
2166 }
2167
2168
2169 /// Finds backwards
2170 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
2171 {
2172         if (! cur)
2173                 return 0;
2174         // Backup of original position
2175         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2176         if (cur == cur_begin)
2177                 return 0;
2178         cur.backwardPos();
2179         DocIterator cur_orig(cur);
2180         bool pit_changed = false;
2181         do {
2182                 cur.pos() = 0;
2183                 bool found_match = match(cur, -1, false);
2184
2185                 if (found_match) {
2186                         if (pit_changed)
2187                                 cur.pos() = cur.lastpos();
2188                         else
2189                                 cur.pos() = cur_orig.pos();
2190                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
2191                         DocIterator cur_prev_iter;
2192                         do {
2193                                 found_match = match(cur);
2194                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
2195                                        << found_match << ", cur: " << cur);
2196                                 if (found_match)
2197                                         return findMostBackwards(cur, match);
2198
2199                                 // Stop if begin of document reached
2200                                 if (cur == cur_begin)
2201                                         break;
2202                                 cur_prev_iter = cur;
2203                                 cur.backwardPos();
2204                         } while (true);
2205                 }
2206                 if (cur == cur_begin)
2207                         break;
2208                 if (cur.pit() > 0)
2209                         --cur.pit();
2210                 else
2211                         cur.backwardPos();
2212                 pit_changed = true;
2213         } while (!theApp()->longOperationCancelled());
2214         return 0;
2215 }
2216
2217
2218 } // namespace
2219
2220
2221 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
2222                                  DocIterator const & cur, int len)
2223 {
2224         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
2225                 return docstring();
2226         if (!opt.ignoreformat)
2227                 return latexifyFromCursor(cur, len);
2228         else
2229                 return stringifyFromCursor(cur, len);
2230 }
2231
2232
2233 FindAndReplaceOptions::FindAndReplaceOptions(
2234         docstring const & find_buf_name, bool casesensitive,
2235         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
2236         docstring const & repl_buf_name, bool keep_case,
2237         SearchScope scope, SearchRestriction restr)
2238         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
2239           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
2240           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
2241 {
2242 }
2243
2244
2245 namespace {
2246
2247
2248 /** Check if 'len' letters following cursor are all non-lowercase */
2249 static bool allNonLowercase(Cursor const & cur, int len)
2250 {
2251         pos_type beg_pos = cur.selectionBegin().pos();
2252         pos_type end_pos = cur.selectionBegin().pos() + len;
2253         if (len > cur.lastpos() + 1 - beg_pos) {
2254                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
2255                 len = cur.lastpos() + 1 - beg_pos;
2256                 end_pos = beg_pos + len;
2257         }
2258         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
2259                 if (isLowerCase(cur.paragraph().getChar(pos)))
2260                         return false;
2261         return true;
2262 }
2263
2264
2265 /** Check if first letter is upper case and second one is lower case */
2266 static bool firstUppercase(Cursor const & cur)
2267 {
2268         char_type ch1, ch2;
2269         pos_type pos = cur.selectionBegin().pos();
2270         if (pos >= cur.lastpos() - 1) {
2271                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
2272                 return false;
2273         }
2274         ch1 = cur.paragraph().getChar(pos);
2275         ch2 = cur.paragraph().getChar(pos + 1);
2276         bool result = isUpperCase(ch1) && isLowerCase(ch2);
2277         LYXERR(Debug::FIND, "firstUppercase(): "
2278                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
2279                << ch2 << "(" << char(ch2) << ")"
2280                << ", result=" << result << ", cur=" << cur);
2281         return result;
2282 }
2283
2284
2285 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
2286  **
2287  ** \fixme What to do with possible further paragraphs in replace buffer ?
2288  **/
2289 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
2290 {
2291         ParagraphList::iterator pit = buffer.paragraphs().begin();
2292         LASSERT(pit->size() >= 1, /**/);
2293         pos_type right = pos_type(1);
2294         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
2295         right = pit->size();
2296         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
2297 }
2298
2299 } // namespace
2300
2301 ///
2302 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
2303 {
2304         Cursor & cur = bv->cursor();
2305         if (opt.repl_buf_name == docstring()
2306             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
2307             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2308                 return;
2309
2310         DocIterator sel_beg = cur.selectionBegin();
2311         DocIterator sel_end = cur.selectionEnd();
2312         if (&sel_beg.inset() != &sel_end.inset()
2313             || sel_beg.pit() != sel_end.pit()
2314             || sel_beg.idx() != sel_end.idx())
2315                 return;
2316         int sel_len = sel_end.pos() - sel_beg.pos();
2317         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
2318                << ", sel_len: " << sel_len << endl);
2319         if (sel_len == 0)
2320                 return;
2321         LASSERT(sel_len > 0, return);
2322
2323         if (!matchAdv(sel_beg, sel_len))
2324                 return;
2325
2326         // Build a copy of the replace buffer, adapted to the KeepCase option
2327         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
2328         ostringstream oss;
2329         repl_buffer_orig.write(oss);
2330         string lyx = oss.str();
2331         Buffer repl_buffer("", false);
2332         repl_buffer.setUnnamed(true);
2333         LASSERT(repl_buffer.readString(lyx), return);
2334         if (opt.keep_case && sel_len >= 2) {
2335                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
2336                 if (cur.inTexted()) {
2337                         if (firstUppercase(cur))
2338                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
2339                         else if (allNonLowercase(cur, sel_len))
2340                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
2341                 }
2342         }
2343         cap::cutSelection(cur, false);
2344         if (cur.inTexted()) {
2345                 repl_buffer.changeLanguage(
2346                         repl_buffer.language(),
2347                         cur.getFont().language());
2348                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
2349                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
2350                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
2351                                         repl_buffer.params().documentClassPtr(),
2352                                         bv->buffer().errorList("Paste"));
2353                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
2354                 sel_len = repl_buffer.paragraphs().begin()->size();
2355         } else if (cur.inMathed()) {
2356                 odocstringstream ods;
2357                 otexstream os(ods);
2358                 OutputParams runparams(&repl_buffer.params().encoding());
2359                 runparams.nice = false;
2360                 runparams.flavor = OutputParams::LATEX;
2361                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2362                 runparams.dryrun = true;
2363                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
2364                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
2365                 docstring repl_latex = ods.str();
2366                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
2367                 string s;
2368                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
2369                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
2370                 repl_latex = from_utf8(s);
2371                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
2372                 MathData ar(cur.buffer());
2373                 asArray(repl_latex, ar, Parse::NORMAL);
2374                 cur.insert(ar);
2375                 sel_len = ar.size();
2376                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2377         }
2378         if (cur.pos() >= sel_len)
2379                 cur.pos() -= sel_len;
2380         else
2381                 cur.pos() = 0;
2382         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2383         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
2384         bv->processUpdateFlags(Update::Force);
2385 }
2386
2387
2388 /// Perform a FindAdv operation.
2389 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
2390 {
2391         DocIterator cur;
2392         int match_len = 0;
2393
2394         // e.g., when invoking word-findadv from mini-buffer wither with
2395         //       wrong options syntax or before ever opening advanced F&R pane
2396         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2397                 return false;
2398
2399         try {
2400                 MatchStringAdv matchAdv(bv->buffer(), opt);
2401                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
2402                 if (length > 0)
2403                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
2404                 findAdvReplace(bv, opt, matchAdv);
2405                 cur = bv->cursor();
2406                 if (opt.forward)
2407                         match_len = findForwardAdv(cur, matchAdv);
2408                 else
2409                         match_len = findBackwardsAdv(cur, matchAdv);
2410         } catch (...) {
2411                 // This may only be raised by lyx::regex()
2412                 bv->message(_("Invalid regular expression!"));
2413                 return false;
2414         }
2415
2416         if (match_len == 0) {
2417                 bv->message(_("Match not found!"));
2418                 return false;
2419         }
2420
2421         bv->message(_("Match found!"));
2422
2423         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
2424         bv->putSelectionAt(cur, match_len, !opt.forward);
2425
2426         return true;
2427 }
2428
2429
2430 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
2431 {
2432         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
2433            << opt.casesensitive << ' '
2434            << opt.matchword << ' '
2435            << opt.forward << ' '
2436            << opt.expandmacros << ' '
2437            << opt.ignoreformat << ' '
2438            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
2439            << opt.keep_case << ' '
2440            << int(opt.scope) << ' '
2441            << int(opt.restr);
2442
2443         LYXERR(Debug::FIND, "built: " << os.str());
2444
2445         return os;
2446 }
2447
2448
2449 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
2450 {
2451         LYXERR(Debug::FIND, "parsing");
2452         string s;
2453         string line;
2454         getline(is, line);
2455         while (line != "EOSS") {
2456                 if (! s.empty())
2457                         s = s + "\n";
2458                 s = s + line;
2459                 if (is.eof())   // Tolerate malformed request
2460                         break;
2461                 getline(is, line);
2462         }
2463         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
2464         opt.find_buf_name = from_utf8(s);
2465         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
2466         is.get();       // Waste space before replace string
2467         s = "";
2468         getline(is, line);
2469         while (line != "EOSS") {
2470                 if (! s.empty())
2471                         s = s + "\n";
2472                 s = s + line;
2473                 if (is.eof())   // Tolerate malformed request
2474                         break;
2475                 getline(is, line);
2476         }
2477         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
2478         opt.repl_buf_name = from_utf8(s);
2479         is >> opt.keep_case;
2480         int i;
2481         is >> i;
2482         opt.scope = FindAndReplaceOptions::SearchScope(i);
2483         is >> i;
2484         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
2485
2486         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
2487                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
2488                << opt.scope << ' ' << opt.restr);
2489         return is;
2490 }
2491
2492 } // namespace lyx