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