]> git.lyx.org Git - lyx.git/blob - src/lyxfind.cpp
Revert "Comment out unused functions to restore -Werror"
[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 search for colored text too
848         while (regex_replace(t, t, REGEX_BOS "\\\\(((emph|noun|minisec|text(bf|sl|sf|it|tt))|((textcolor|foreignlanguage)\\{[a-z]+\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)\\{", "")
849                || regex_replace(t, t, REGEX_BOS "\\$", "")
850                || regex_replace(t, t, REGEX_BOS "\\\\\\[ ", "")
851                || regex_replace(t, t, REGEX_BOS "\\\\item ", "")
852                || regex_replace(t, t, REGEX_BOS "\\\\begin\\{[a-zA-Z_]*\\*?\\} ", ""))
853                ;
854         LYXERR(Debug::FIND, "  after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
855         return s.find(t);
856 }
857
858 /*
859  * Given a latexified string, retrieve some handled features
860  * The features of the regex will later be compared with the features
861  * of the searched text. If the regex features are not a
862  * subset of the analized, then, in not format ignoring search
863  * we can early stop the search in the relevant inset.
864  */
865 typedef map<string, bool> Features;
866
867 static Features identifyFeatures(string const & s)
868 {
869         static regex const feature("\\\\(([a-z]+(\\{([a-z]+)\\}|\\*)?))\\{");
870         static regex const valid("^(((emph|noun|text(bf|sl|sf|it|tt)|(textcolor|foreignlanguage)\\{[a-z]+\\})|item |(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)$");
871         smatch sub;
872         bool displ = true;
873         Features info;
874
875         for (sregex_iterator it(s.begin(), s.end(), feature), end; it != end; ++it) {
876                 sub = *it;
877                 if (displ) {
878                         if (sub.str(1).compare("regexp") == 0) {
879                                 displ = false;
880                                 continue;
881                         }
882                         string token = sub.str(1);
883                         smatch sub2;
884                         if (regex_match(token, sub2, valid)) {
885                                 info[token] = true;
886                         }
887                         else {
888                                 // ignore
889                         }
890                 }
891                 else {
892                         if (sub.str(1).compare("endregexp") == 0) {
893                                 displ = true;
894                                 continue;
895                         }
896                 }
897         }
898         return(info);
899 }
900
901 /*
902  * defines values features of a key "\\[a-z]+{"
903  */
904 class KeyInfo {
905  public:
906   enum KeyType {
907     isChar,
908     isSectioning,
909     isMain,                             /* for \\foreignlanguage */
910     isRegex,
911     isMath,
912     isStandard,
913     isSize,
914     invalid,
915     doRemove,
916     isIgnored                           /* to be ignored by creating infos */
917   };
918  KeyInfo()
919    : keytype(invalid),
920     head(""),
921     parenthesiscount(1),
922     disabled(false),
923     used(false)
924   {};
925  KeyInfo(KeyType type, int parcount, bool disable)
926    : keytype(type),
927     parenthesiscount(parcount),
928     disabled(disable),
929     used(false) {};
930   KeyType keytype;
931   string head;
932   int _tokensize;
933   int _tokenstart;
934   int _dataStart;
935   int _dataEnd;
936   int parenthesiscount;
937   bool disabled;
938   bool used;                            /* by pattern */
939 };
940
941 class Border {
942  public:
943  Border(int l=0, int u=0) : low(l), upper(u) {};
944   int low;
945   int upper;
946 };
947
948 #define MAXOPENED 30
949 class Intervall {
950  public:
951  Intervall() : ignoreidx(-1), actualdeptindex(0) {};
952   string par;
953   int ignoreidx;
954   int depts[MAXOPENED];
955   int closes[MAXOPENED];
956   int actualdeptindex;
957   Border borders[2*MAXOPENED];
958   // int previousNotIgnored(int);
959   int nextNotIgnored(int);
960   void handleOpenP(int i);
961   void handleCloseP(int i, bool closingAllowed);
962   void resetOpenedP(int openPos);
963   void addIntervall(int upper);
964   void addIntervall(int low, int upper); /* if explicit */
965   void setForDefaultLang(int upTo);
966   int findclosing(int start, int end);
967   void handleParentheses(int lastpos, bool closingAllowed);
968   void output(ostringstream &os, int lastpos);
969   // string show(int lastpos);
970 };
971
972 void Intervall::setForDefaultLang(int upTo)
973 {
974   // Enable the use of first token again
975   if (ignoreidx >= 0) {
976     if (borders[0].low < upTo)
977       borders[0].low = upTo;
978     if (borders[0].upper < upTo)
979       borders[0].upper = upTo;
980   }
981 }
982
983 static void checkDepthIndex(int val)
984 {
985   static int maxdepthidx = MAXOPENED-2;
986   if (val > maxdepthidx) {
987     maxdepthidx = val;
988     LYXERR0("maxdepthidx now " << val);
989   }
990 }
991
992 static void checkIgnoreIdx(int val)
993 {
994   static int maxignoreidx = 2*MAXOPENED - 4;
995   if (val > maxignoreidx) {
996     maxignoreidx = val;
997     LYXERR0("maxignoreidx now " << val);
998   }
999 }
1000
1001 /*
1002  * Expand the region of ignored parts of the input latex string
1003  * The region is only relevant in output()
1004  */
1005 void Intervall::addIntervall(int low, int upper)
1006 {
1007   int idx;
1008   if (low == upper) return;
1009   for (idx = ignoreidx+1; idx > 0; --idx) {
1010     if (low > borders[idx-1].upper) {
1011       break;
1012     }
1013   }
1014   Border br(low, upper);
1015   if (idx > ignoreidx) {
1016     borders[idx] = br;
1017     ignoreidx = idx;
1018     checkIgnoreIdx(ignoreidx);
1019     return;
1020   }
1021   else {
1022     // Expand only if one of the new bound is inside the interwall
1023     // We know here that br.low > borders[idx-1].upper
1024     if (br.upper < borders[idx].low) {
1025       // We have to insert at this pos
1026       for (int i = ignoreidx+1; i > idx; --i) {
1027         borders[i] = borders[i-1];
1028       }
1029       borders[idx] = br;
1030       ignoreidx += 1;
1031       checkIgnoreIdx(ignoreidx);
1032       return;
1033     }
1034     // Here we know, that we are overlapping
1035     if (br.low > borders[idx].low)
1036       br.low = borders[idx].low;
1037     // check what has to be concatenated
1038     int count = 0;
1039     for (int i = idx; i <= ignoreidx; i++) {
1040       if (br.upper >= borders[i].low) {
1041         count++;
1042         if (br.upper < borders[i].upper)
1043           br.upper = borders[i].upper;
1044       }
1045       else {
1046         break;
1047       }
1048     }
1049     // count should be >= 1 here
1050     borders[idx] = br;
1051     if (count > 1) {
1052       for (int i = idx + count; i <= ignoreidx; i++) {
1053         borders[i-count+1] = borders[i];
1054       }
1055       ignoreidx -= count - 1;
1056       return;
1057     }
1058   }
1059 }
1060
1061 void Intervall::handleOpenP(int i)
1062 {
1063   actualdeptindex++;
1064   depts[actualdeptindex] = i+1;
1065   closes[actualdeptindex] = -1;
1066   checkDepthIndex(actualdeptindex);
1067 }
1068
1069 void Intervall::handleCloseP(int i, bool closingAllowed)
1070 {
1071   if (actualdeptindex <= 0) {
1072     if (! closingAllowed)
1073       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1074     // if we are at the very end
1075     addIntervall(i, i+1);
1076   }
1077   else {
1078     closes[actualdeptindex] = i+1;
1079     actualdeptindex--;
1080   }
1081 }
1082
1083 void Intervall::resetOpenedP(int openPos)
1084 {
1085   // Used as initializer for foreignlanguage entry
1086   actualdeptindex = 1;
1087   depts[1] = openPos+1;
1088   closes[1] = -1;
1089 }
1090
1091 #if 0
1092 int Intervall::previousNotIgnored(int start)
1093 {
1094     int idx = 0;                          /* int intervalls */
1095     for (idx = ignoreidx; idx >= 0; --idx) {
1096       if (start > borders[idx].upper)
1097         return(start);
1098       if (start >= borders[idx].low)
1099         start = borders[idx].low-1;
1100     }
1101     return start;
1102 }
1103 #endif
1104
1105 int Intervall::nextNotIgnored(int start)
1106 {
1107     int idx = 0;                          /* int intervalls */
1108     for (idx = 0; idx <= ignoreidx; idx++) {
1109       if (start < borders[idx].low)
1110         return(start);
1111       if (start < borders[idx].upper)
1112         start = borders[idx].upper;
1113     }
1114     return start;
1115 }
1116
1117 typedef map<string, KeyInfo> KeysMap;
1118 typedef vector< KeyInfo> Entries;
1119 static KeysMap keys = map<string, KeyInfo>();
1120
1121 class IgnoreFormats {
1122   static bool ignoreFamily;
1123   static bool ignoreSeries;
1124   static bool ignoreShape;
1125   static bool ignoreUnderline;
1126   static bool ignoreMarkUp;
1127   static bool ignoreStrikeOut;
1128   static bool ignoreSectioning;
1129   static bool ignoreFrontMatter;
1130   static bool ignoreColor;
1131   static bool ignoreLanguage;
1132  public:
1133   bool getFamily() { return ignoreFamily; };
1134   bool getSeries() { return ignoreSeries; };
1135   bool getShape() { return ignoreShape; };
1136   bool getUnderline() { return ignoreUnderline; };
1137   bool getMarkUp() { return ignoreMarkUp; };
1138   bool getStrikeOut() { return ignoreStrikeOut; };
1139   bool getSectioning() { return ignoreSectioning; };
1140   bool getFrontMatter() { return ignoreFrontMatter; };
1141   bool getColor() { return ignoreColor; };
1142   bool getLanguage() { return ignoreLanguage; };
1143
1144   void setIgnoreFormat(string type, bool value);
1145 };
1146
1147 bool IgnoreFormats::ignoreFamily     = false;
1148 bool IgnoreFormats::ignoreSeries     = false;
1149 bool IgnoreFormats::ignoreShape      = false;
1150 bool IgnoreFormats::ignoreUnderline  = false;
1151 bool IgnoreFormats::ignoreMarkUp     = false;
1152 bool IgnoreFormats::ignoreStrikeOut  = false;
1153 bool IgnoreFormats::ignoreSectioning = false;
1154 bool IgnoreFormats::ignoreFrontMatter= true;
1155 bool IgnoreFormats::ignoreColor      = false;
1156 bool IgnoreFormats::ignoreLanguage   = false;
1157
1158 void IgnoreFormats::setIgnoreFormat(string type, bool value)
1159 {
1160   if (type == "color") {
1161     ignoreColor = value;
1162   }
1163   else if (type == "language") {
1164     ignoreLanguage = value;
1165   }
1166   else if (type == "sectioning") {
1167     ignoreSectioning = value;
1168     ignoreFrontMatter = value;
1169   }
1170   else if (type == "font") {
1171     ignoreSeries = value;
1172     ignoreShape = value;
1173     ignoreFamily = value;
1174   }
1175   else if (type == "series") {
1176     ignoreSeries = value;
1177   }
1178   else if (type == "shape") {
1179     ignoreShape = value;
1180   }
1181   else if (type == "family") {
1182     ignoreFamily = value;
1183   }
1184   else if (type == "markup") {
1185     ignoreMarkUp = value;
1186   }
1187   else if (type == "underline") {
1188     ignoreUnderline = value;
1189   }
1190   else if (type == "strike") {
1191     ignoreStrikeOut = value;
1192   }
1193 }
1194
1195 void setIgnoreFormat(string type, bool value)
1196 {
1197   IgnoreFormats().setIgnoreFormat(type, value);
1198 }
1199
1200 class LatexInfo {
1201  private:
1202   int entidx;
1203   Entries entries;
1204   KeyInfo analyze(string key);
1205   Intervall interval;
1206   void buildKeys(bool);
1207   void buildEntries(bool);
1208   void makeKey(const string &, KeyInfo, bool isPatternString);
1209   void processRegion(int start, int region_end); /*  remove {} parts */
1210   void removeHead(KeyInfo&, int count=0);
1211   IgnoreFormats f;
1212
1213  public:
1214   LatexInfo(string par, bool isPatternString) {
1215     interval.par = par;
1216     buildKeys(isPatternString);
1217     entries = vector<KeyInfo>();
1218     buildEntries(isPatternString);
1219   };
1220   int getFirstKey() {
1221     entidx = 0;
1222     if (entries.empty()) {
1223       return (-1);
1224     }
1225     return 0;
1226   };
1227   int getNextKey() {
1228     entidx++;
1229     if (int(entries.size()) > entidx) {
1230       return entidx;
1231     }
1232     else {
1233       return (-1);
1234     }
1235   };
1236   bool setNextKey(int idx) {
1237     if ((idx == entidx) && (entidx >= 0)) {
1238       entidx--;
1239       return true;
1240     }
1241     else
1242       return(false);
1243   };
1244   int process(ostringstream &os, KeyInfo &actual);
1245   int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1246   // string show(int lastpos) { return interval.show(lastpos);};
1247   int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1248   KeyInfo &getKeyInfo(int keyinfo) {
1249     static KeyInfo invalidInfo = KeyInfo();
1250     if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1251       return invalidInfo;
1252     else
1253       return entries[keyinfo];
1254   };
1255   void setForDefaultLang(int upTo) {interval.setForDefaultLang(upTo);};
1256
1257 };
1258
1259
1260 int Intervall::findclosing(int start, int end)
1261 {
1262   int skip = 0;
1263   int depth = 0;
1264   for (int i = start; i < end; i += 1 + skip) {
1265     char c;
1266     c = par[i];
1267     skip = 0;
1268     if (c == '\\') skip = 1;
1269     else if (c == '{') {
1270       depth++;
1271     }
1272     else if (c == '}') {
1273       if (depth == 0) return(i);
1274       --depth;
1275     }
1276   }
1277   return(end);
1278 }
1279
1280 void LatexInfo::buildEntries(bool isPatternString)
1281 {
1282   static regex const rmath("\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multiline|align)\\*?)\\}");
1283   static regex const rkeys("\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1284   smatch sub, submath;
1285   bool evaluatingRegexp = false;
1286   KeyInfo found;
1287   bool math_end_waiting = false;
1288   size_t math_pos = 10000;
1289   int math_size = 0;
1290   int math_end_pos = -1;
1291   string math_end;
1292
1293   for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1294     submath = *itmath;
1295     if (math_end_waiting) {
1296       if ((submath.str(1).compare("end") == 0) &&
1297           (submath.str(2).compare(math_end) == 0)) {
1298         math_size = submath.position(size_t(0)) + submath.str(0).length() - math_pos;
1299         math_end_waiting = false;
1300       }
1301     }
1302     else {
1303       if (submath.str(1).compare("begin") == 0) {
1304         math_end_waiting = true;
1305         math_end = submath.str(2);
1306         math_pos = submath.position(size_t(0));
1307       }
1308     }
1309   }
1310   for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1311     sub = *it;
1312     if (evaluatingRegexp) {
1313       if (sub.str(1).compare("endregexp") == 0) {
1314         evaluatingRegexp = false;
1315         // found._tokenstart already set
1316         found._dataEnd = sub.position(size_t(0)) + 13;
1317         found._dataStart = found._dataEnd;
1318         found._tokensize = found._dataEnd - found._tokenstart;
1319         found.parenthesiscount = 0;
1320       }
1321     }
1322     else {
1323       if (keys.find(sub.str(3)) == keys.end()) {
1324         LYXERR(Debug::FIND, "Found unknown key " << sub.str(0));
1325         continue;
1326       }
1327       found = keys[sub.str(3)];
1328       if (sub.str(3).compare("regexp") == 0) {
1329         evaluatingRegexp = true;
1330         found._tokenstart = sub.position(size_t(0));
1331         found._tokensize = 0;
1332         continue;
1333       }
1334     }
1335     // Handle the other params of key
1336     if (found.keytype == KeyInfo::isIgnored)
1337       continue;
1338     else if (found.keytype == KeyInfo::isMath) {
1339       if (size_t(sub.position(size_t(0))) == math_pos) {
1340         found = keys[sub.str(3)];
1341         found._tokenstart = sub.position(size_t(0));
1342         found._tokensize = math_size;
1343         found._dataEnd = found._tokenstart + found._tokensize;
1344         found._dataStart = found._dataEnd;
1345         found.parenthesiscount = 0;
1346         math_end_pos = found._dataEnd;
1347       }
1348       else
1349         continue;
1350     }
1351     else if (found.keytype != KeyInfo::isRegex) {
1352       found._tokenstart = sub.position(size_t(0));
1353       if (found._tokenstart < math_end_pos) {
1354         // Ignore if we are inside math equation
1355         continue;
1356       }
1357       if (found.parenthesiscount == 0) {
1358         // Probably to be discarded
1359         char following = interval.par[sub.position(size_t(0)) + sub.str(3).length() + 1];
1360         if (following == ' ')
1361           found.head = "\\" + sub.str(3) + " ";
1362         else if (following == '=') {
1363           // like \uldepth=1000pt
1364           found.head = sub.str(0);
1365         }
1366         else
1367           found.head = "\\" + sub.str(3);
1368         found._tokensize = found.head.length();
1369         found._dataEnd = found._tokenstart + found._tokensize;
1370         found._dataStart = found._dataEnd;
1371       }
1372       else {
1373         if (found.parenthesiscount == 1) {
1374           found.head = "\\" + sub.str(3) + "{";
1375         }
1376         else if (found.parenthesiscount == 2) {
1377           found.head = sub.str(0) + "{";
1378           found._tokensize = found.head.length();
1379         }
1380         found._tokensize = found.head.length();
1381         found._dataStart = found._tokenstart + found.head.length();
1382         found._dataEnd = interval.findclosing(found._dataStart, interval.par.length());
1383         if (isPatternString) {
1384           keys[sub.str(3)].used = true;
1385         }
1386       }
1387     }
1388     entries.push_back(found);
1389   }
1390 }
1391
1392 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1393 {
1394   stringstream s(keysstring);
1395   string key;
1396   const char delim = '|';
1397   while (getline(s, key, delim)) {
1398     KeyInfo keyII(keyI);
1399     if (isPatternString) {
1400       keyII.used = false;
1401     }
1402     else if ( !keys[key].used)
1403       keyII.disabled = true;
1404     keys[key] = keyII;
1405   }
1406 }
1407
1408 void LatexInfo::buildKeys(bool isPatternString)
1409 {
1410
1411   static bool keysBuilt = false;
1412   if (keysBuilt && !isPatternString) return;
1413
1414   // Know statdard keys with 1 parameter.
1415   // Split is done, if not at start of region
1416   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, f.getFamily()), isPatternString);
1417   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, f.getSeries()), isPatternString);
1418   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, f.getShape()), isPatternString);
1419   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, f.getUnderline()), isPatternString);
1420   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, f.getMarkUp()), isPatternString);
1421   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, f.getStrikeOut()), isPatternString);
1422
1423   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1424           KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1425   makeKey("section*|subsection*|subsubsection*|paragraph*",
1426           KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1427   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1428   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isSectioning, 1, f.getFrontMatter()), isPatternString);
1429   // Regex
1430   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1431
1432   // Split is done, if not at start of region
1433   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, f.getColor()), isPatternString);
1434
1435   // Split is done always.
1436   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, f.getLanguage()), isPatternString);
1437
1438   // Know charaters
1439   // No split
1440   makeKey("backslash|textbackslash|textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 1, false), isPatternString);
1441
1442   // Known macros to remove (including their parameter)
1443   // No split
1444   makeKey("inputencoding|shortcut", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1445
1446   // Macros to remove, but let the parameter survive
1447   // No split
1448   makeKey("url|href|menuitem|footnote|code", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1449
1450   // Same effect as previous, parameter will survive (because there is no one anyway)
1451   // No split
1452   makeKey("noindent", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
1453   // like ('tiny{}' or '\tiny ' ... }
1454   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, true), isPatternString);
1455
1456   // Survives, like known character
1457   makeKey("lyx", KeyInfo(KeyInfo::isIgnored, 0, false), isPatternString);
1458
1459   makeKey("begin", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1460   makeKey("end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1461
1462   makeKey("par|uldepth|ULdepth", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1463
1464   if (isPatternString) {
1465     // Allow the first searched string to rebuild the keys too
1466     keysBuilt = false;
1467   }
1468   else {
1469     // no need to rebuild again
1470     keysBuilt = true;
1471   }
1472 }
1473
1474 /*
1475  * Keep the list of actual opened parentheses actual
1476  * (e.g. depth == 4 means there are 4 '{' not processed yet)
1477  */
1478 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
1479 {
1480   int skip = 0;
1481   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
1482     char c;
1483     c = par[i];
1484     skip = 0;
1485     if (c == '\\') skip = 1;
1486     else if (c == '{') {
1487       handleOpenP(i);
1488     }
1489     else if (c == '}') {
1490       handleCloseP(i, closingAllowed);
1491     }
1492   }
1493 }
1494
1495 #if (0)
1496 string Intervall::show(int lastpos)
1497 {
1498   int idx = 0;                          /* int intervalls */
1499   int count = 0;
1500   string s;
1501   int i = 0;
1502   for (idx = 0; idx <= ignoreidx; idx++) {
1503     while (i < lastpos) {
1504       int printsize;
1505       if (i <= borders[idx].low) {
1506         if (borders[idx].low > lastpos)
1507           printsize = lastpos - i;
1508         else
1509           printsize = borders[idx].low - i;
1510         s += par.substr(i, printsize);
1511         i += printsize;
1512         if (i >= borders[idx].low)
1513           i = borders[idx].upper;
1514       }
1515       else {
1516         i = borders[idx].upper;
1517         break;
1518       }
1519     }
1520   }
1521   if (lastpos > i) {
1522     s += par.substr(i, lastpos-i);
1523   }
1524   return (s);
1525 }
1526 #endif
1527
1528 void Intervall::output(ostringstream &os, int lastpos)
1529 {
1530   // get number of chars to output
1531   int idx = 0;                          /* int intervalls */
1532   int i = 0;
1533   for (idx = 0; idx <= ignoreidx; idx++) {
1534     if (i < lastpos) {
1535       int printsize;
1536       if (i <= borders[idx].low) {
1537         if (borders[idx].low > lastpos)
1538           printsize = lastpos - i;
1539         else
1540           printsize = borders[idx].low - i;
1541         os << par.substr(i, printsize);
1542         i += printsize;
1543         handleParentheses(i, false);
1544         if (i >= borders[idx].low)
1545           i = borders[idx].upper;
1546       }
1547       else {
1548         i = borders[idx].upper;
1549       }
1550     }
1551     else
1552       break;
1553   }
1554   if (lastpos > i) {
1555     os << par.substr(i, lastpos-i);
1556   }
1557   handleParentheses(lastpos, false);
1558   for (int i = actualdeptindex; i > 0; --i) {
1559     os << "}";
1560   }
1561   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
1562 }
1563
1564 void LatexInfo::processRegion(int start, int region_end)
1565 {
1566   while (start < region_end) {
1567     if (interval.par[start] == '{') {
1568       // Closing is allowed past the region
1569       int closing = interval.findclosing(start+1, interval.par.length());
1570       interval.addIntervall(start, start+1);
1571       interval.addIntervall(closing, closing+1);
1572     }
1573     start = interval.nextNotIgnored(start+1);
1574   }
1575 }
1576
1577 void LatexInfo::removeHead(KeyInfo &actual, int count)
1578 {
1579   if (actual.parenthesiscount == 0) {
1580     // "{\tiny{} ...}" ==> "{{} ...}"
1581     interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
1582   }
1583   else {
1584     // Remove header hull, that is "\url{abcd}" ==> "abcd"
1585     interval.addIntervall(actual._tokenstart, actual._dataStart);
1586     interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
1587   }
1588 }
1589
1590 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
1591 {
1592   int nextKeyIdx;
1593   switch (actual.keytype)
1594     {
1595     case KeyInfo::isChar: {
1596       nextKeyIdx = getNextKey();
1597       break;
1598     }
1599     case KeyInfo::isSize: {
1600       if (actual.disabled) {
1601         // Allways disabled
1602         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
1603         interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1604         nextKeyIdx = getNextKey();
1605       } else {
1606         // Split on this key if not at start
1607         int start = interval.nextNotIgnored(previousStart);
1608         if (start < actual._tokenstart) {
1609           interval.output(os, actual._tokenstart);
1610           interval.addIntervall(start, actual._tokenstart);
1611         }
1612         // discard entry if at end of actual
1613         nextKeyIdx = process(os, actual);
1614       }
1615       break;
1616     }
1617     case KeyInfo::isStandard: {
1618       if (actual.disabled) {
1619         removeHead(actual);
1620         processRegion(actual._dataStart, actual._dataStart+1);
1621         nextKeyIdx = getNextKey();
1622       } else {
1623         // Split on this key if not at start
1624         int start = interval.nextNotIgnored(previousStart);
1625         if (start < actual._tokenstart) {
1626           interval.output(os, actual._tokenstart);
1627           interval.addIntervall(start, actual._tokenstart);
1628         }
1629         // discard entry if at end of actual
1630         nextKeyIdx = process(os, actual);
1631       }
1632       break;
1633     }
1634     case KeyInfo::doRemove: {
1635       // Remove the key with all parameters
1636       interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1637       nextKeyIdx = getNextKey();
1638       break;
1639     }
1640     case KeyInfo::isSectioning: {
1641       // Discard space before _tokenstart
1642       int count;
1643       for (count = 0; count < actual._tokenstart; count++) {
1644         if (interval.par[actual._tokenstart-count-1] != ' ')
1645           break;
1646       }
1647       if (actual.disabled) {
1648         removeHead(actual, count);
1649         nextKeyIdx = getNextKey();
1650       } else {
1651         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1652         nextKeyIdx = process(os, actual);
1653       }
1654       break;
1655     }
1656     case KeyInfo::isMath: {
1657       // Same as regex, use the content unchanged
1658       nextKeyIdx = getNextKey();
1659       break;
1660     }
1661     case KeyInfo::isRegex: {
1662       // DO NOT SPLIT ON REGEX
1663       // Do not disable
1664       nextKeyIdx = getNextKey();
1665       break;
1666     }
1667     case KeyInfo::isIgnored: {
1668       // Treat like a character for now
1669       nextKeyIdx = getNextKey();
1670       break;
1671     }
1672     case KeyInfo::isMain: {
1673       if (actual.disabled) {
1674         removeHead(actual);
1675         interval.resetOpenedP(actual._dataStart-1);
1676       }
1677       else {
1678         if (actual._tokenstart == 0) {
1679           // for the first (and maybe dummy) language
1680           interval.setForDefaultLang(actual._tokenstart + actual._tokensize);
1681         }
1682         interval.resetOpenedP(actual._dataStart-1);
1683       }
1684       break;
1685     }
1686     case KeyInfo::invalid:
1687       // This cannot happen, already handled
1688       // fall through
1689     default: {
1690       // LYXERR0("Unhandled keytype");
1691       nextKeyIdx = getNextKey();
1692       break;
1693     }
1694     }
1695   return(nextKeyIdx);
1696 }
1697
1698 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
1699 {
1700   int end = interval.nextNotIgnored(actual._dataEnd);
1701   int oldStart = actual._dataStart;
1702   int nextKeyIdx = getNextKey();
1703   while (true) {
1704     if ((nextKeyIdx < 0) ||
1705         (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
1706         (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
1707       if (oldStart <= end) {
1708         processRegion(oldStart, end);
1709         oldStart = end+1;
1710       }
1711       break;
1712     }
1713     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
1714
1715     if (nextKey.keytype == KeyInfo::isMain) {
1716       (void) dispatch(os, actual._dataStart, nextKey);
1717       end = nextKey._tokenstart;
1718       break;
1719     }
1720     processRegion(oldStart, nextKey._tokenstart);
1721     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
1722
1723     oldStart = nextKey._dataEnd+1;
1724   }
1725   // now nextKey is either invalid or is outside of actual._dataEnd
1726   // output the remaining and discard myself
1727   if (oldStart <= end) {
1728     processRegion(oldStart, end);
1729   }
1730   if (interval.par[end] == '}') {
1731     end += 1;
1732     // This is the normal case.
1733     // But if using the firstlanguage, the closing may be missing
1734   }
1735   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
1736   int output_end;
1737   if (actual._dataEnd < end)
1738     output_end = interval.nextNotIgnored(actual._dataEnd);
1739   else
1740     output_end = interval.nextNotIgnored(end);
1741   if (interval.nextNotIgnored(actual._dataStart) < output_end)
1742     interval.output(os, output_end);
1743   interval.addIntervall(actual._tokenstart, end);
1744   return nextKeyIdx;
1745 }
1746
1747 string splitOnKnownMacros(string par, bool isPatternString) {
1748   ostringstream os;
1749   LatexInfo li(par, isPatternString);
1750   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
1751   DummyKey.head = "";
1752   DummyKey._tokensize = 0;
1753   DummyKey._tokenstart = 0;
1754   DummyKey._dataStart = 0;
1755   DummyKey._dataEnd = par.length();
1756   DummyKey.disabled = true;
1757   int firstkeyIdx = li.getFirstKey();
1758   string s;
1759   if (firstkeyIdx >= 0) {
1760     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
1761     int nextkeyIdx;
1762     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
1763       // Create dummy firstKey
1764       firstKey = DummyKey;
1765       (void) li.setNextKey(firstkeyIdx);
1766     }
1767     nextkeyIdx = li.process(os, firstKey);
1768     while (nextkeyIdx >= 0) {
1769       // Check for a possible gap between the last
1770       // entry and this one
1771       int datastart = li.nextNotIgnored(firstKey._dataStart);
1772       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
1773       if ((nextKey._tokenstart > datastart)) {
1774         // Handle the gap
1775         firstKey._dataStart = datastart;
1776         firstKey._dataEnd = par.length();
1777         (void) li.setNextKey(nextkeyIdx);
1778         if (firstKey._tokensize > 0)
1779           li.setForDefaultLang(firstKey._tokensize);
1780         // Fake the last opened parenthesis
1781         nextkeyIdx = li.process(os, firstKey);
1782       }
1783       else {
1784         if (nextKey.keytype != KeyInfo::isMain) {
1785           firstKey._dataStart = datastart;
1786           firstKey._dataEnd = nextKey._dataEnd+1;
1787           (void) li.setNextKey(nextkeyIdx);
1788           if (firstKey._tokensize > 0)
1789             li.setForDefaultLang(firstKey._tokensize);
1790           nextkeyIdx = li.process(os, firstKey);
1791         }
1792         else {
1793           nextkeyIdx = li.process(os, nextKey);
1794         }
1795       }
1796     }
1797     // Handle the remaining
1798     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
1799     firstKey._dataEnd = par.length();
1800     if (firstKey._dataStart < firstKey._dataEnd)
1801       (void) li.process(os, firstKey);
1802     s = os.str();
1803   }
1804   else
1805     s = "";                        /* found end */
1806   return s;
1807 }
1808
1809 /*
1810  * Try to unify the language specs in the latexified text.
1811  * Resulting modified string is set to "", if
1812  * the searched tex does not contain all the features in the search pattern
1813  */
1814 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
1815 {
1816         static Features regex_f;
1817         static int missed = 0;
1818         static bool regex_with_format = false;
1819
1820         int parlen = par.length();
1821
1822         while ((parlen > 0) && (par[parlen-1] == '\n')) {
1823                 parlen--;
1824         }
1825         string result;
1826         if (withformat) {
1827                 // Split the latex input into pieces which
1828                 // can be digested by our search engine
1829                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
1830                 result = splitOnKnownMacros(par, isPatternString);
1831                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
1832         }
1833         else
1834                 result = par.substr(0, parlen);
1835         if (isPatternString) {
1836                 missed = 0;
1837                 if (withformat) {
1838                         regex_f = identifyFeatures(result);
1839                         string features = "";
1840                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
1841                                 string a = it->first;
1842                                 regex_with_format = true;
1843                                 features += " " + a;
1844                                 // LYXERR0("Identified regex format:" << a);
1845                         }
1846                         LYXERR(Debug::FIND, "Identified Features" << features);
1847
1848                 }
1849         } else if (regex_with_format) {
1850                 Features info = identifyFeatures(result);
1851                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
1852                         string a = it->first;
1853                         bool b = it->second;
1854                         if (b && ! info[a]) {
1855                                 missed++;
1856                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
1857                                 return("");
1858                         }
1859                 }
1860         }
1861         else {
1862                 // LYXERR0("No regex formats");
1863         }
1864         return(result);
1865 }
1866
1867
1868 // Remove trailing closure of math, macros and environments, so to catch parts of them.
1869 static int identifyClosing(string & t)
1870 {
1871         int open_braces = 0;
1872         do {
1873                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
1874                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
1875                         continue;
1876                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
1877                         continue;
1878                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
1879                         continue;
1880                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
1881                         ++open_braces;
1882                         continue;
1883                 }
1884                 break;
1885         } while (true);
1886         return open_braces;
1887 }
1888
1889
1890 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
1891         : p_buf(&buf), p_first_buf(&buf), opt(opt)
1892 {
1893         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
1894         docstring const & ds = stringifySearchBuffer(find_buf, opt);
1895         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
1896         // When using regexp, braces are hacked already by escape_for_regex()
1897         par_as_string = normalize(ds, !use_regexp);
1898         open_braces = 0;
1899         close_wildcards = 0;
1900
1901         size_t lead_size = 0;
1902         // correct the language settings
1903         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
1904         if (opt.ignoreformat) {
1905                 if (!use_regexp) {
1906                         // if par_as_string_nolead were emty,
1907                         // the following call to findAux will always *find* the string
1908                         // in the checked data, and thus always using the slow
1909                         // examining of the current text part.
1910                         par_as_string_nolead = par_as_string;
1911                 }
1912         } else {
1913                 lead_size = identifyLeading(par_as_string);
1914                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
1915                 lead_as_string = par_as_string.substr(0, lead_size);
1916                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
1917         }
1918
1919         if (!use_regexp) {
1920                 open_braces = identifyClosing(par_as_string);
1921                 identifyClosing(par_as_string_nolead);
1922                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
1923                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
1924         } else {
1925                 string lead_as_regexp;
1926                 if (lead_size > 0) {
1927                         // @todo No need to search for \regexp{} insets in leading material
1928                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
1929                         par_as_string = par_as_string_nolead;
1930                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
1931                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
1932                 }
1933                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
1934                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
1935                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
1936                 if (
1937                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
1938                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
1939                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
1940                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
1941                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
1942                         || regex_replace(par_as_string, par_as_string,
1943                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
1944                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
1945                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
1946                         ) {
1947                         ++close_wildcards;
1948                 }
1949                 if (!opt.ignoreformat) {
1950                         // Remove extra '\}' at end
1951                         while ( regex_replace(par_as_string, par_as_string, "(.*)\\\\}$", "$1")) {
1952                                 open_braces++;
1953                         }
1954                         // save '\.'
1955                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
1956                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
1957                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
1958                         // replace '[^...]' with '[^...\}\{\\]'
1959                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
1960                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
1961                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
1962                         // restore '\.'
1963                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
1964                 }
1965                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
1966                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
1967                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
1968                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
1969
1970                 // If entered regexp must match at begin of searched string buffer
1971                 // Kornel: Added parentheses to use $1 for size of the leading string
1972                 string regexp_str;
1973                 string regexp2_str;
1974                 {
1975                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
1976                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
1977                         // so the convert has no effect in that case
1978                         for (int i = 8; i > 0; --i) {
1979                                 string orig = "\\\\" + std::to_string(i);
1980                                 string dest = "\\" + std::to_string(i+1);
1981                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
1982                         }
1983                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
1984                         regexp2_str = "(" + lead_as_regexp + ").*" + par_as_string;
1985                 }
1986                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
1987                 regexp = lyx::regex(regexp_str);
1988
1989                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
1990                 regexp2 = lyx::regex(regexp2_str);
1991         }
1992 }
1993
1994
1995 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
1996 {
1997         if (at_begin &&
1998                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
1999                 return 0;
2000
2001         docstring docstr = stringifyFromForSearch(opt, cur, len);
2002         string str = normalize(docstr, true);
2003         if (!opt.ignoreformat) {
2004                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2005         }
2006         if (str.empty()) return(-1);
2007         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2008         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2009
2010         if (use_regexp) {
2011                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2012                 regex const *p_regexp;
2013                 regex_constants::match_flag_type flags;
2014                 if (at_begin) {
2015                         flags = regex_constants::match_continuous;
2016                         p_regexp = &regexp;
2017                 } else {
2018                         flags = regex_constants::match_default;
2019                         p_regexp = &regexp2;
2020                 }
2021                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2022                 if (re_it == sregex_iterator())
2023                         return 0;
2024                 match_results<string::const_iterator> const & m = *re_it;
2025
2026                 if (0) { // Kornel Benko: DO NOT CHECKK
2027                         // Check braces on the segment that matched the entire regexp expression,
2028                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2029                         if (!braces_match(m[0].first, m[0].second, open_braces))
2030                                 return 0;
2031                 }
2032
2033                 // Check braces on segments that matched all (.*?) subexpressions,
2034                 // except the last "padding" one inserted by lyx.
2035                 for (size_t i = 1; i < m.size() - 1; ++i)
2036                         if (!braces_match(m[i].first, m[i].second, open_braces))
2037                                 return 0;
2038
2039                 // Exclude from the returned match length any length
2040                 // due to close wildcards added at end of regexp
2041                 // and also the length of the leading (e.g. '\emph{')
2042                 //
2043                 // Whole found string, including the leading: m[0].second - m[0].first
2044                 // Size of the leading string: m[1].second - m[1].first
2045                 int leadingsize = 0;
2046                 if (m.size() > 1)
2047                         leadingsize = m[1].second - m[1].first;
2048                 int result;
2049                 for (size_t i = 0; i < m.size(); i++) {
2050                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2051                 }
2052                 if (close_wildcards == 0)
2053                         result = m[0].second - m[0].first;
2054
2055                 else
2056                         result =  m[m.size() - close_wildcards].first - m[0].first;
2057
2058                 if (result > leadingsize)
2059                         result -= leadingsize;
2060                 else
2061                         result = 0;
2062                 return(result);
2063         }
2064
2065         // else !use_regexp: but all code paths above return
2066         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2067                                  << par_as_string << "', str='" << str << "'");
2068         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2069                                  << lead_as_string << "', par_as_string_nolead='"
2070                                  << par_as_string_nolead << "'");
2071
2072         if (at_begin) {
2073                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2074                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2075                 if (str.substr(0, par_as_string.size()) == par_as_string)
2076                         return par_as_string.size();
2077         } else {
2078                 size_t pos = str.find(par_as_string_nolead);
2079                 if (pos != string::npos)
2080                         return par_as_string.size();
2081         }
2082         return 0;
2083 }
2084
2085
2086 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2087 {
2088         int res = findAux(cur, len, at_begin);
2089         LYXERR(Debug::FIND,
2090                "res=" << res << ", at_begin=" << at_begin
2091                << ", matchword=" << opt.matchword
2092                << ", inTexted=" << cur.inTexted());
2093         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2094                 return res;
2095         Paragraph const & par = cur.paragraph();
2096         bool ws_left = (cur.pos() > 0)
2097                 ? par.isWordSeparator(cur.pos() - 1)
2098                 : true;
2099         bool ws_right = (cur.pos() + res < par.size())
2100                 ? par.isWordSeparator(cur.pos() + res)
2101                 : true;
2102         LYXERR(Debug::FIND,
2103                "cur.pos()=" << cur.pos() << ", res=" << res
2104                << ", separ: " << ws_left << ", " << ws_right
2105                << endl);
2106         if (ws_left && ws_right)
2107                 return res;
2108         return 0;
2109 }
2110
2111
2112 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2113 {
2114         string t;
2115         if (! opt.casesensitive)
2116                 t = lyx::to_utf8(lowercase(s));
2117         else
2118                 t = lyx::to_utf8(s);
2119         // Remove \n at begin
2120         while (!t.empty() && t[0] == '\n')
2121                 t = t.substr(1);
2122         // Remove \n at end
2123         while (!t.empty() && t[t.size() - 1] == '\n')
2124                 t = t.substr(0, t.size() - 1);
2125         size_t pos;
2126         // Replace all other \n with spaces
2127         while ((pos = t.find("\n")) != string::npos)
2128                 t.replace(pos, 1, " ");
2129         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
2130         // Kornel: Added textsl, textsf, textit, texttt and noun
2131         // + allow to seach for colored text too
2132         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
2133         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
2134                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2135         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
2136                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2137
2138         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor)\\{[a-z]+\\}(\\{(\\\\item |\\{\\})?\\})+", ""));
2139         // FIXME - check what preceeds the brace
2140         if (hack_braces) {
2141                 if (opt.ignoreformat)
2142                         while (regex_replace(t, t, "\\{", "_x_<")
2143                                || regex_replace(t, t, "\\}", "_x_>"))
2144                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2145                 else
2146                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
2147                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
2148                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2149         }
2150
2151         return t;
2152 }
2153
2154
2155 docstring stringifyFromCursor(DocIterator const & cur, int len)
2156 {
2157         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
2158         if (cur.inTexted()) {
2159                 Paragraph const & par = cur.paragraph();
2160                 // TODO what about searching beyond/across paragraph breaks ?
2161                 // TODO Try adding a AS_STR_INSERTS as last arg
2162                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
2163                         int(par.size()) : cur.pos() + len;
2164                 OutputParams runparams(&cur.buffer()->params().encoding());
2165                 runparams.nice = true;
2166                 runparams.flavor = OutputParams::LATEX;
2167                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
2168                 // No side effect of file copying and image conversion
2169                 runparams.dryrun = true;
2170                 LYXERR(Debug::FIND, "Stringifying with cur: "
2171                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
2172                 return par.asString(cur.pos(), end,
2173                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
2174                         &runparams);
2175         } else if (cur.inMathed()) {
2176                 docstring s;
2177                 CursorSlice cs = cur.top();
2178                 MathData md = cs.cell();
2179                 MathData::const_iterator it_end =
2180                         (( len == -1 || cs.pos() + len > int(md.size()))
2181                          ? md.end()
2182                          : md.begin() + cs.pos() + len );
2183                 for (MathData::const_iterator it = md.begin() + cs.pos();
2184                      it != it_end; ++it)
2185                         s = s + asString(*it);
2186                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
2187                 return s;
2188         }
2189         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2190         return docstring();
2191 }
2192
2193
2194 /** Computes the LaTeX export of buf starting from cur and ending len positions
2195  * after cur, if len is positive, or at the paragraph or innermost inset end
2196  * if len is -1.
2197  */
2198 docstring latexifyFromCursor(DocIterator const & cur, int len)
2199 {
2200         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
2201         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
2202                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
2203         Buffer const & buf = *cur.buffer();
2204
2205         odocstringstream ods;
2206         otexstream os(ods);
2207         OutputParams runparams(&buf.params().encoding());
2208         runparams.nice = false;
2209         runparams.flavor = OutputParams::LATEX;
2210         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2211         // No side effect of file copying and image conversion
2212         runparams.dryrun = true;
2213         runparams.for_search = true;
2214
2215         if (cur.inTexted()) {
2216                 // @TODO what about searching beyond/across paragraph breaks ?
2217                 pos_type endpos = cur.paragraph().size();
2218                 if (len != -1 && endpos > cur.pos() + len)
2219                         endpos = cur.pos() + len;
2220                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
2221                           string(), cur.pos(), endpos);
2222                 string s = lyx::to_utf8(ods.str());
2223                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
2224                 return(lyx::from_utf8(s));
2225         } else if (cur.inMathed()) {
2226                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
2227                 for (int s = cur.depth() - 1; s >= 0; --s) {
2228                         CursorSlice const & cs = cur[s];
2229                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
2230                                 WriteStream ws(os);
2231                                 cs.asInsetMath()->asHullInset()->header_write(ws);
2232                                 break;
2233                         }
2234                 }
2235
2236                 CursorSlice const & cs = cur.top();
2237                 MathData md = cs.cell();
2238                 MathData::const_iterator it_end =
2239                         ((len == -1 || cs.pos() + len > int(md.size()))
2240                          ? md.end()
2241                          : md.begin() + cs.pos() + len);
2242                 for (MathData::const_iterator it = md.begin() + cs.pos();
2243                      it != it_end; ++it)
2244                         ods << asString(*it);
2245
2246                 // Retrieve the math environment type, and add '$' or '$]'
2247                 // or others (\end{equation}) accordingly
2248                 for (int s = cur.depth() - 1; s >= 0; --s) {
2249                         CursorSlice const & cs2 = cur[s];
2250                         InsetMath * inset = cs2.asInsetMath();
2251                         if (inset && inset->asHullInset()) {
2252                                 WriteStream ws(os);
2253                                 inset->asHullInset()->footer_write(ws);
2254                                 break;
2255                         }
2256                 }
2257                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
2258         } else {
2259                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2260         }
2261         return ods.str();
2262 }
2263
2264
2265 /** Finalize an advanced find operation, advancing the cursor to the innermost
2266  ** position that matches, plus computing the length of the matching text to
2267  ** be selected
2268  **/
2269 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
2270 {
2271         // Search the foremost position that matches (avoids find of entire math
2272         // inset when match at start of it)
2273         size_t d;
2274         DocIterator old_cur(cur.buffer());
2275         do {
2276                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
2277                 d = cur.depth();
2278                 old_cur = cur;
2279                 cur.forwardPos();
2280         } while (cur && cur.depth() > d && match(cur) > 0);
2281         cur = old_cur;
2282         if (match(cur) <= 0) return 0;
2283         LYXERR(Debug::FIND, "Ok");
2284
2285         // Compute the match length
2286         int len = 1;
2287         if (cur.pos() + len > cur.lastpos())
2288                 return 0;
2289         LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2290         while (cur.pos() + len <= cur.lastpos() && match(cur, len) <= 0) {
2291                 ++len;
2292                 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2293         }
2294         // Length of matched text (different from len param)
2295         int old_len = match(cur, len);
2296         if (old_len < 0) old_len = 0;
2297         int new_len;
2298         // Greedy behaviour while matching regexps
2299         while ((new_len = match(cur, len + 1)) > old_len) {
2300                 ++len;
2301                 old_len = new_len;
2302                 LYXERR(Debug::FIND, "verifying   match with len = " << len);
2303         }
2304         return len;
2305 }
2306
2307
2308 /// Finds forward
2309 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
2310 {
2311         if (!cur)
2312                 return 0;
2313         while (!theApp()->longOperationCancelled() && cur) {
2314                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
2315                 int match_len = match(cur, -1, false);
2316                 LYXERR(Debug::FIND, "match_len: " << match_len);
2317                 if (match_len > 0) {
2318                         int match_len_zero_count = 0;
2319                         for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
2320                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
2321                                 int match_len2 = match(cur);
2322                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
2323                                 if (match_len2 > 0) {
2324                                         // Sometimes in finalize we understand it wasn't a match
2325                                         // and we need to continue the outest loop
2326                                         int len = findAdvFinalize(cur, match);
2327                                         if (len > 0) {
2328                                                 return len;
2329                                         }
2330                                 }
2331                                 if (match_len2 >= 0) {
2332                                         if (match_len2 == 0)
2333                                                 match_len_zero_count++;
2334                                         else
2335                                                 match_len_zero_count = 0;
2336                                 }
2337                                 else {
2338                                         if (++match_len_zero_count > 3) {
2339                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
2340                                                 match_len_zero_count = 0;
2341                                         }
2342                                         break;
2343                                 }
2344                         }
2345                         if (!cur)
2346                                 return 0;
2347                 }
2348                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
2349                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
2350                         cur.forwardPar();
2351                 } else {
2352                         // This should exit nested insets, if any, or otherwise undefine the currsor.
2353                         cur.pos() = cur.lastpos();
2354                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
2355                         cur.forwardPos();
2356                 }
2357         }
2358         return 0;
2359 }
2360
2361
2362 /// Find the most backward consecutive match within same paragraph while searching backwards.
2363 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
2364 {
2365         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2366         DocIterator tmp_cur = cur;
2367         int len = findAdvFinalize(tmp_cur, match);
2368         Inset & inset = cur.inset();
2369         for (; cur != cur_begin; cur.backwardPos()) {
2370                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
2371                 DocIterator new_cur = cur;
2372                 new_cur.backwardPos();
2373                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
2374                         break;
2375                 int new_len = findAdvFinalize(new_cur, match);
2376                 if (new_len == len)
2377                         break;
2378                 len = new_len;
2379         }
2380         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
2381         return len;
2382 }
2383
2384
2385 /// Finds backwards
2386 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
2387 {
2388         if (! cur)
2389                 return 0;
2390         // Backup of original position
2391         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2392         if (cur == cur_begin)
2393                 return 0;
2394         cur.backwardPos();
2395         DocIterator cur_orig(cur);
2396         bool pit_changed = false;
2397         do {
2398                 cur.pos() = 0;
2399                 bool found_match = match(cur, -1, false);
2400
2401                 if (found_match) {
2402                         if (pit_changed)
2403                                 cur.pos() = cur.lastpos();
2404                         else
2405                                 cur.pos() = cur_orig.pos();
2406                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
2407                         DocIterator cur_prev_iter;
2408                         do {
2409                                 found_match = match(cur);
2410                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
2411                                        << found_match << ", cur: " << cur);
2412                                 if (found_match)
2413                                         return findMostBackwards(cur, match);
2414
2415                                 // Stop if begin of document reached
2416                                 if (cur == cur_begin)
2417                                         break;
2418                                 cur_prev_iter = cur;
2419                                 cur.backwardPos();
2420                         } while (true);
2421                 }
2422                 if (cur == cur_begin)
2423                         break;
2424                 if (cur.pit() > 0)
2425                         --cur.pit();
2426                 else
2427                         cur.backwardPos();
2428                 pit_changed = true;
2429         } while (!theApp()->longOperationCancelled());
2430         return 0;
2431 }
2432
2433
2434 } // namespace
2435
2436
2437 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
2438                                  DocIterator const & cur, int len)
2439 {
2440         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
2441                 return docstring();
2442         if (!opt.ignoreformat)
2443                 return latexifyFromCursor(cur, len);
2444         else
2445                 return stringifyFromCursor(cur, len);
2446 }
2447
2448
2449 FindAndReplaceOptions::FindAndReplaceOptions(
2450         docstring const & find_buf_name, bool casesensitive,
2451         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
2452         docstring const & repl_buf_name, bool keep_case,
2453         SearchScope scope, SearchRestriction restr)
2454         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
2455           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
2456           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
2457 {
2458 }
2459
2460
2461 namespace {
2462
2463
2464 /** Check if 'len' letters following cursor are all non-lowercase */
2465 static bool allNonLowercase(Cursor const & cur, int len)
2466 {
2467         pos_type beg_pos = cur.selectionBegin().pos();
2468         pos_type end_pos = cur.selectionBegin().pos() + len;
2469         if (len > cur.lastpos() + 1 - beg_pos) {
2470                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
2471                 len = cur.lastpos() + 1 - beg_pos;
2472                 end_pos = beg_pos + len;
2473         }
2474         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
2475                 if (isLowerCase(cur.paragraph().getChar(pos)))
2476                         return false;
2477         return true;
2478 }
2479
2480
2481 /** Check if first letter is upper case and second one is lower case */
2482 static bool firstUppercase(Cursor const & cur)
2483 {
2484         char_type ch1, ch2;
2485         pos_type pos = cur.selectionBegin().pos();
2486         if (pos >= cur.lastpos() - 1) {
2487                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
2488                 return false;
2489         }
2490         ch1 = cur.paragraph().getChar(pos);
2491         ch2 = cur.paragraph().getChar(pos + 1);
2492         bool result = isUpperCase(ch1) && isLowerCase(ch2);
2493         LYXERR(Debug::FIND, "firstUppercase(): "
2494                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
2495                << ch2 << "(" << char(ch2) << ")"
2496                << ", result=" << result << ", cur=" << cur);
2497         return result;
2498 }
2499
2500
2501 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
2502  **
2503  ** \fixme What to do with possible further paragraphs in replace buffer ?
2504  **/
2505 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
2506 {
2507         ParagraphList::iterator pit = buffer.paragraphs().begin();
2508         LASSERT(pit->size() >= 1, /**/);
2509         pos_type right = pos_type(1);
2510         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
2511         right = pit->size();
2512         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
2513 }
2514
2515 } // namespace
2516
2517 ///
2518 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
2519 {
2520         Cursor & cur = bv->cursor();
2521         if (opt.repl_buf_name == docstring()
2522             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
2523             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2524                 return;
2525
2526         DocIterator sel_beg = cur.selectionBegin();
2527         DocIterator sel_end = cur.selectionEnd();
2528         if (&sel_beg.inset() != &sel_end.inset()
2529             || sel_beg.pit() != sel_end.pit()
2530             || sel_beg.idx() != sel_end.idx())
2531                 return;
2532         int sel_len = sel_end.pos() - sel_beg.pos();
2533         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
2534                << ", sel_len: " << sel_len << endl);
2535         if (sel_len == 0)
2536                 return;
2537         LASSERT(sel_len > 0, return);
2538
2539         if (!matchAdv(sel_beg, sel_len))
2540                 return;
2541
2542         // Build a copy of the replace buffer, adapted to the KeepCase option
2543         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
2544         ostringstream oss;
2545         repl_buffer_orig.write(oss);
2546         string lyx = oss.str();
2547         Buffer repl_buffer("", false);
2548         repl_buffer.setUnnamed(true);
2549         LASSERT(repl_buffer.readString(lyx), return);
2550         if (opt.keep_case && sel_len >= 2) {
2551                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
2552                 if (cur.inTexted()) {
2553                         if (firstUppercase(cur))
2554                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
2555                         else if (allNonLowercase(cur, sel_len))
2556                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
2557                 }
2558         }
2559         cap::cutSelection(cur, false);
2560         if (cur.inTexted()) {
2561                 repl_buffer.changeLanguage(
2562                         repl_buffer.language(),
2563                         cur.getFont().language());
2564                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
2565                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
2566                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
2567                                         repl_buffer.params().documentClassPtr(),
2568                                         bv->buffer().errorList("Paste"));
2569                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
2570                 sel_len = repl_buffer.paragraphs().begin()->size();
2571         } else if (cur.inMathed()) {
2572                 odocstringstream ods;
2573                 otexstream os(ods);
2574                 OutputParams runparams(&repl_buffer.params().encoding());
2575                 runparams.nice = false;
2576                 runparams.flavor = OutputParams::LATEX;
2577                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2578                 runparams.dryrun = true;
2579                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
2580                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
2581                 docstring repl_latex = ods.str();
2582                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
2583                 string s;
2584                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
2585                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
2586                 repl_latex = from_utf8(s);
2587                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
2588                 MathData ar(cur.buffer());
2589                 asArray(repl_latex, ar, Parse::NORMAL);
2590                 cur.insert(ar);
2591                 sel_len = ar.size();
2592                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2593         }
2594         if (cur.pos() >= sel_len)
2595                 cur.pos() -= sel_len;
2596         else
2597                 cur.pos() = 0;
2598         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2599         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
2600         bv->processUpdateFlags(Update::Force);
2601 }
2602
2603
2604 /// Perform a FindAdv operation.
2605 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
2606 {
2607         DocIterator cur;
2608         int match_len = 0;
2609
2610         // e.g., when invoking word-findadv from mini-buffer wither with
2611         //       wrong options syntax or before ever opening advanced F&R pane
2612         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2613                 return false;
2614
2615         try {
2616                 MatchStringAdv matchAdv(bv->buffer(), opt);
2617                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
2618                 if (length > 0)
2619                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
2620                 findAdvReplace(bv, opt, matchAdv);
2621                 cur = bv->cursor();
2622                 if (opt.forward)
2623                         match_len = findForwardAdv(cur, matchAdv);
2624                 else
2625                         match_len = findBackwardsAdv(cur, matchAdv);
2626         } catch (...) {
2627                 // This may only be raised by lyx::regex()
2628                 bv->message(_("Invalid regular expression!"));
2629                 return false;
2630         }
2631
2632         if (match_len == 0) {
2633                 bv->message(_("Match not found!"));
2634                 return false;
2635         }
2636
2637         bv->message(_("Match found!"));
2638
2639         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
2640         bv->putSelectionAt(cur, match_len, !opt.forward);
2641
2642         return true;
2643 }
2644
2645
2646 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
2647 {
2648         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
2649            << opt.casesensitive << ' '
2650            << opt.matchword << ' '
2651            << opt.forward << ' '
2652            << opt.expandmacros << ' '
2653            << opt.ignoreformat << ' '
2654            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
2655            << opt.keep_case << ' '
2656            << int(opt.scope) << ' '
2657            << int(opt.restr);
2658
2659         LYXERR(Debug::FIND, "built: " << os.str());
2660
2661         return os;
2662 }
2663
2664
2665 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
2666 {
2667         LYXERR(Debug::FIND, "parsing");
2668         string s;
2669         string line;
2670         getline(is, line);
2671         while (line != "EOSS") {
2672                 if (! s.empty())
2673                         s = s + "\n";
2674                 s = s + line;
2675                 if (is.eof())   // Tolerate malformed request
2676                         break;
2677                 getline(is, line);
2678         }
2679         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
2680         opt.find_buf_name = from_utf8(s);
2681         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
2682         is.get();       // Waste space before replace string
2683         s = "";
2684         getline(is, line);
2685         while (line != "EOSS") {
2686                 if (! s.empty())
2687                         s = s + "\n";
2688                 s = s + line;
2689                 if (is.eof())   // Tolerate malformed request
2690                         break;
2691                 getline(is, line);
2692         }
2693         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
2694         opt.repl_buf_name = from_utf8(s);
2695         is >> opt.keep_case;
2696         int i;
2697         is >> i;
2698         opt.scope = FindAndReplaceOptions::SearchScope(i);
2699         is >> i;
2700         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
2701
2702         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
2703                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
2704                << opt.scope << ' ' << opt.restr);
2705         return is;
2706 }
2707
2708 } // namespace lyx