]> git.lyx.org Git - lyx.git/blob - src/lyxfind.cpp
4c8386c3bae4a864c9fe9234afd2977314d6ca72
[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 #include "Encoding.h"
36
37 #include "frontends/Application.h"
38 #include "frontends/alert.h"
39
40 #include "mathed/InsetMath.h"
41 #include "mathed/InsetMathGrid.h"
42 #include "mathed/InsetMathHull.h"
43 #include "mathed/MathData.h"
44 #include "mathed/MathStream.h"
45 #include "mathed/MathSupport.h"
46
47 #include "support/convert.h"
48 #include "support/debug.h"
49 #include "support/docstream.h"
50 #include "support/FileName.h"
51 #include "support/gettext.h"
52 #include "support/lassert.h"
53 #include "support/lstrings.h"
54
55 #include "support/regex.h"
56 #include "support/textutils.h"
57 #include <map>
58
59 using namespace std;
60 using namespace lyx::support;
61
62 namespace lyx {
63
64
65 // Helper class for deciding what should be ignored
66 class IgnoreFormats {
67  public:
68         ///
69         IgnoreFormats()
70                 : ignoreFamily_(false), ignoreSeries_(false),
71                   ignoreShape_(false), ignoreUnderline_(false),
72                   ignoreMarkUp_(false), ignoreStrikeOut_(false),
73                   ignoreSectioning_(false), ignoreFrontMatter_(false),
74                   ignoreColor_(false), ignoreLanguage_(false) {}
75         ///
76         bool getFamily() { return ignoreFamily_; };
77         ///
78         bool getSeries() { return ignoreSeries_; };
79         ///
80         bool getShape() { return ignoreShape_; };
81         ///
82         bool getUnderline() { return ignoreUnderline_; };
83         ///
84         bool getMarkUp() { return ignoreMarkUp_; };
85         ///
86         bool getStrikeOut() { return ignoreStrikeOut_; };
87         ///
88         bool getSectioning() { return ignoreSectioning_; };
89         ///
90         bool getFrontMatter() { return ignoreFrontMatter_; };
91         ///
92         bool getColor() { return ignoreColor_; };
93         ///
94         bool getLanguage() { return ignoreLanguage_; };
95         ///
96         void setIgnoreFormat(string const & type, bool value);
97
98 private:
99         ///
100         bool ignoreFamily_;
101         ///
102         bool ignoreSeries_;
103         ///
104         bool ignoreShape_;
105         ///
106         bool ignoreUnderline_;
107         ///
108         bool ignoreMarkUp_;
109         ///
110         bool ignoreStrikeOut_;
111         ///
112         bool ignoreSectioning_;
113         ///
114         bool ignoreFrontMatter_;
115         ///
116         bool ignoreColor_;
117         ///
118         bool ignoreLanguage_;
119 };
120
121
122 void IgnoreFormats::setIgnoreFormat(string const & type, bool value)
123 {
124         if (type == "color") {
125                 ignoreColor_ = value;
126         }
127         else if (type == "language") {
128                 ignoreLanguage_ = value;
129         }
130         else if (type == "sectioning") {
131                 ignoreSectioning_ = value;
132                 ignoreFrontMatter_ = value;
133         }
134         else if (type == "font") {
135                 ignoreSeries_ = value;
136                 ignoreShape_ = value;
137                 ignoreFamily_ = value;
138         }
139         else if (type == "series") {
140                 ignoreSeries_ = value;
141         }
142         else if (type == "shape") {
143                 ignoreShape_ = value;
144         }
145         else if (type == "family") {
146                 ignoreFamily_ = value;
147         }
148         else if (type == "markup") {
149                 ignoreMarkUp_ = value;
150         }
151         else if (type == "underline") {
152                 ignoreUnderline_ = value;
153         }
154         else if (type == "strike") {
155                 ignoreStrikeOut_ = value;
156         }
157 }
158
159 // The global variable that can be changed from outside
160 IgnoreFormats ignoreFormats;
161
162
163 void setIgnoreFormat(string const & type, bool value)
164 {
165   ignoreFormats.setIgnoreFormat(type, value);
166 }
167
168
169 namespace {
170
171 bool parse_bool(docstring & howto)
172 {
173         if (howto.empty())
174                 return false;
175         docstring var;
176         howto = split(howto, var, ' ');
177         return var == "1";
178 }
179
180
181 class MatchString : public binary_function<Paragraph, pos_type, int>
182 {
183 public:
184         MatchString(docstring const & str, bool cs, bool mw)
185                 : str(str), case_sens(cs), whole_words(mw)
186         {}
187
188         // returns true if the specified string is at the specified position
189         // del specifies whether deleted strings in ct mode will be considered
190         int operator()(Paragraph const & par, pos_type pos, bool del = true) const
191         {
192                 return par.find(str, case_sens, whole_words, pos, del);
193         }
194
195 private:
196         // search string
197         docstring str;
198         // case sensitive
199         bool case_sens;
200         // match whole words only
201         bool whole_words;
202 };
203
204
205 int findForward(DocIterator & cur, MatchString const & match,
206                 bool find_del = true)
207 {
208         for (; cur; cur.forwardChar())
209                 if (cur.inTexted()) {
210                         int len = match(cur.paragraph(), cur.pos(), find_del);
211                         if (len > 0)
212                                 return len;
213                 }
214         return 0;
215 }
216
217
218 int findBackwards(DocIterator & cur, MatchString const & match,
219                   bool find_del = true)
220 {
221         while (cur) {
222                 cur.backwardChar();
223                 if (cur.inTexted()) {
224                         int len = match(cur.paragraph(), cur.pos(), find_del);
225                         if (len > 0)
226                                 return len;
227                 }
228         }
229         return 0;
230 }
231
232
233 bool searchAllowed(docstring const & str)
234 {
235         if (str.empty()) {
236                 frontend::Alert::error(_("Search error"), _("Search string is empty"));
237                 return false;
238         }
239         return true;
240 }
241
242
243 bool findOne(BufferView * bv, docstring const & searchstr,
244              bool case_sens, bool whole, bool forward,
245              bool find_del = true, bool check_wrap = false)
246 {
247         if (!searchAllowed(searchstr))
248                 return false;
249
250         DocIterator cur = forward
251                 ? bv->cursor().selectionEnd()
252                 : bv->cursor().selectionBegin();
253
254         MatchString const match(searchstr, case_sens, whole);
255
256         int match_len = forward
257                 ? findForward(cur, match, find_del)
258                 : findBackwards(cur, match, find_del);
259
260         if (match_len > 0)
261                 bv->putSelectionAt(cur, match_len, !forward);
262         else if (check_wrap) {
263                 DocIterator cur_orig(bv->cursor());
264                 docstring q;
265                 if (forward)
266                         q = _("End of file reached while searching forward.\n"
267                           "Continue searching from the beginning?");
268                 else
269                         q = _("Beginning of file reached while searching backward.\n"
270                           "Continue searching from the end?");
271                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
272                         q, 0, 1, _("&Yes"), _("&No"));
273                 if (wrap_answer == 0) {
274                         if (forward) {
275                                 bv->cursor().clear();
276                                 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
277                         } else {
278                                 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
279                                 bv->cursor().backwardPos();
280                         }
281                         bv->clearSelection();
282                         if (findOne(bv, searchstr, case_sens, whole, forward, find_del, false))
283                                 return true;
284                 }
285                 bv->cursor().setCursor(cur_orig);
286                 return false;
287         }
288
289         return match_len > 0;
290 }
291
292
293 int replaceAll(BufferView * bv,
294                docstring const & searchstr, docstring const & replacestr,
295                bool case_sens, bool whole)
296 {
297         Buffer & buf = bv->buffer();
298
299         if (!searchAllowed(searchstr) || buf.isReadonly())
300                 return 0;
301
302         DocIterator cur_orig(bv->cursor());
303
304         MatchString const match(searchstr, case_sens, whole);
305         int num = 0;
306
307         int const rsize = replacestr.size();
308         int const ssize = searchstr.size();
309
310         Cursor cur(*bv);
311         cur.setCursor(doc_iterator_begin(&buf));
312         int match_len = findForward(cur, match, false);
313         while (match_len > 0) {
314                 // Backup current cursor position and font.
315                 pos_type const pos = cur.pos();
316                 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
317                 cur.recordUndo();
318                 int striked = ssize -
319                         cur.paragraph().eraseChars(pos, pos + match_len,
320                                                    buf.params().track_changes);
321                 cur.paragraph().insert(pos, replacestr, font,
322                                        Change(buf.params().track_changes
323                                               ? Change::INSERTED
324                                               : Change::UNCHANGED));
325                 for (int i = 0; i < rsize + striked; ++i)
326                         cur.forwardChar();
327                 ++num;
328                 match_len = findForward(cur, match, false);
329         }
330
331         bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
332
333         cur_orig.fixIfBroken();
334         bv->setCursor(cur_orig);
335
336         return num;
337 }
338
339
340 // the idea here is that we are going to replace the string that
341 // is selected IF it is the search string.
342 // if there is a selection, but it is not the search string, then
343 // we basically ignore it. (FIXME We ought to replace only within
344 // the selection.)
345 // if there is no selection, then:
346 //  (i) if some search string has been provided, then we find it.
347 //      (think of how the dialog works when you hit "replace" the
348 //      first time.)
349 // (ii) if no search string has been provided, then we treat the
350 //      word the cursor is in as the search string. (why? i have no
351 //      idea.) but this only works in text?
352 //
353 // returns the number of replacements made (one, if any) and
354 // whether anything at all was done.
355 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
356                            docstring const & replacestr, bool case_sens,
357                            bool whole, bool forward, bool findnext)
358 {
359         Cursor & cur = bv->cursor();
360         bool found = false;
361         if (!cur.selection()) {
362                 // no selection, non-empty search string: find it
363                 if (!searchstr.empty()) {
364                         found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
365                         return make_pair(found, 0);
366                 }
367                 // empty search string
368                 if (!cur.inTexted())
369                         // bail in math
370                         return make_pair(false, 0);
371                 // select current word and treat it as the search string.
372                 // This causes a minor bug as undo will restore this selection,
373                 // which the user did not create (#8986).
374                 cur.innerText()->selectWord(cur, WHOLE_WORD);
375                 searchstr = cur.selectionAsString(false);
376         }
377
378         // if we still don't have a search string, report the error
379         // and abort.
380         if (!searchAllowed(searchstr))
381                 return make_pair(false, 0);
382
383         bool have_selection = cur.selection();
384         docstring const selected = cur.selectionAsString(false);
385         bool match =
386                 case_sens
387                 ? searchstr == selected
388                 : compare_no_case(searchstr, selected) == 0;
389
390         // no selection or current selection is not search word:
391         // just find the search word
392         if (!have_selection || !match) {
393                 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
394                 return make_pair(found, 0);
395         }
396
397         // we're now actually ready to replace. if the buffer is
398         // read-only, we can't, though.
399         if (bv->buffer().isReadonly())
400                 return make_pair(false, 0);
401
402         cap::replaceSelectionWithString(cur, replacestr);
403         if (forward) {
404                 cur.pos() += replacestr.length();
405                 LASSERT(cur.pos() <= cur.lastpos(),
406                         cur.pos() = cur.lastpos());
407         }
408         if (findnext)
409                 findOne(bv, searchstr, case_sens, whole, forward, false, findnext);
410
411         return make_pair(true, 1);
412 }
413
414 } // namespace
415
416
417 docstring const find2string(docstring const & search,
418                             bool casesensitive, bool matchword, bool forward)
419 {
420         odocstringstream ss;
421         ss << search << '\n'
422            << int(casesensitive) << ' '
423            << int(matchword) << ' '
424            << int(forward);
425         return ss.str();
426 }
427
428
429 docstring const replace2string(docstring const & replace,
430                                docstring const & search,
431                                bool casesensitive, bool matchword,
432                                bool all, bool forward, bool findnext)
433 {
434         odocstringstream ss;
435         ss << replace << '\n'
436            << search << '\n'
437            << int(casesensitive) << ' '
438            << int(matchword) << ' '
439            << int(all) << ' '
440            << int(forward) << ' '
441            << int(findnext);
442         return ss.str();
443 }
444
445
446 bool lyxfind(BufferView * bv, FuncRequest const & ev)
447 {
448         if (!bv || ev.action() != LFUN_WORD_FIND)
449                 return false;
450
451         //lyxerr << "find called, cmd: " << ev << endl;
452
453         // data is of the form
454         // "<search>
455         //  <casesensitive> <matchword> <forward>"
456         docstring search;
457         docstring howto = split(ev.argument(), search, '\n');
458
459         bool casesensitive = parse_bool(howto);
460         bool matchword     = parse_bool(howto);
461         bool forward       = parse_bool(howto);
462
463         return findOne(bv, search, casesensitive, matchword, forward, true, true);
464 }
465
466
467 bool lyxreplace(BufferView * bv,
468                 FuncRequest const & ev, bool has_deleted)
469 {
470         if (!bv || ev.action() != LFUN_WORD_REPLACE)
471                 return false;
472
473         // data is of the form
474         // "<search>
475         //  <replace>
476         //  <casesensitive> <matchword> <all> <forward> <findnext>"
477         docstring search;
478         docstring rplc;
479         docstring howto = split(ev.argument(), rplc, '\n');
480         howto = split(howto, search, '\n');
481
482         bool casesensitive = parse_bool(howto);
483         bool matchword     = parse_bool(howto);
484         bool all           = parse_bool(howto);
485         bool forward       = parse_bool(howto);
486         bool findnext      = howto.empty() ? true : parse_bool(howto);
487
488         bool update = false;
489
490         if (!has_deleted) {
491                 int replace_count = 0;
492                 if (all) {
493                         replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
494                         update = replace_count > 0;
495                 } else {
496                         pair<bool, int> rv =
497                                 replaceOne(bv, search, rplc, casesensitive, matchword, forward, findnext);
498                         update = rv.first;
499                         replace_count = rv.second;
500                 }
501
502                 Buffer const & buf = bv->buffer();
503                 if (!update) {
504                         // emit message signal.
505                         buf.message(_("String not found."));
506                 } else {
507                         if (replace_count == 0) {
508                                 buf.message(_("String found."));
509                         } else if (replace_count == 1) {
510                                 buf.message(_("String has been replaced."));
511                         } else {
512                                 docstring const str =
513                                         bformat(_("%1$d strings have been replaced."), replace_count);
514                                 buf.message(str);
515                         }
516                 }
517         } else if (findnext) {
518                 // if we have deleted characters, we do not replace at all, but
519                 // rather search for the next occurence
520                 if (findOne(bv, search, casesensitive, matchword, forward, true, findnext))
521                         update = true;
522                 else
523                         bv->message(_("String not found."));
524         }
525         return update;
526 }
527
528
529 bool findNextChange(BufferView * bv, Cursor & cur, bool const check_wrap)
530 {
531         for (; cur; cur.forwardPos())
532                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
533                         return true;
534
535         if (check_wrap) {
536                 DocIterator cur_orig(bv->cursor());
537                 docstring q = _("End of file reached while searching forward.\n"
538                           "Continue searching from the beginning?");
539                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
540                         q, 0, 1, _("&Yes"), _("&No"));
541                 if (wrap_answer == 0) {
542                         bv->cursor().clear();
543                         bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
544                         bv->clearSelection();
545                         cur.setCursor(bv->cursor().selectionBegin());
546                         if (findNextChange(bv, cur, false))
547                                 return true;
548                 }
549                 bv->cursor().setCursor(cur_orig);
550         }
551
552         return false;
553 }
554
555
556 bool findPreviousChange(BufferView * bv, Cursor & cur, bool const check_wrap)
557 {
558         for (cur.backwardPos(); cur; cur.backwardPos()) {
559                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
560                         return true;
561         }
562
563         if (check_wrap) {
564                 DocIterator cur_orig(bv->cursor());
565                 docstring q = _("Beginning of file reached while searching backward.\n"
566                           "Continue searching from the end?");
567                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
568                         q, 0, 1, _("&Yes"), _("&No"));
569                 if (wrap_answer == 0) {
570                         bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
571                         bv->cursor().backwardPos();
572                         bv->clearSelection();
573                         cur.setCursor(bv->cursor().selectionBegin());
574                         if (findPreviousChange(bv, cur, false))
575                                 return true;
576                 }
577                 bv->cursor().setCursor(cur_orig);
578         }
579
580         return false;
581 }
582
583
584 bool selectChange(Cursor & cur, bool forward)
585 {
586         if (!cur.inTexted() || !cur.paragraph().isChanged(cur.pos()))
587                 return false;
588         Change ch = cur.paragraph().lookupChange(cur.pos());
589
590         CursorSlice tip1 = cur.top();
591         for (; tip1.pit() < tip1.lastpit() || tip1.pos() < tip1.lastpos(); tip1.forwardPos()) {
592                 Change ch2 = tip1.paragraph().lookupChange(tip1.pos());
593                 if (!ch2.isSimilarTo(ch))
594                         break;
595         }
596         CursorSlice tip2 = cur.top();
597         for (; tip2.pit() > 0 || tip2.pos() > 0;) {
598                 tip2.backwardPos();
599                 Change ch2 = tip2.paragraph().lookupChange(tip2.pos());
600                 if (!ch2.isSimilarTo(ch)) {
601                         // take a step forward to correctly set the selection
602                         tip2.forwardPos();
603                         break;
604                 }
605         }
606         if (forward)
607                 swap(tip1, tip2);
608         cur.top() = tip1;
609         cur.bv().mouseSetCursor(cur, false);
610         cur.top() = tip2;
611         cur.bv().mouseSetCursor(cur, true);
612         return true;
613 }
614
615
616 namespace {
617
618
619 bool findChange(BufferView * bv, bool forward)
620 {
621         Cursor cur(*bv);
622         cur.setCursor(forward ? bv->cursor().selectionEnd()
623                       : bv->cursor().selectionBegin());
624         forward ? findNextChange(bv, cur, true) : findPreviousChange(bv, cur, true);
625         return selectChange(cur, forward);
626 }
627
628 } // namespace
629
630 bool findNextChange(BufferView * bv)
631 {
632         return findChange(bv, true);
633 }
634
635
636 bool findPreviousChange(BufferView * bv)
637 {
638         return findChange(bv, false);
639 }
640
641
642
643 namespace {
644
645 typedef vector<pair<string, string> > Escapes;
646
647 /// A map of symbols and their escaped equivalent needed within a regex.
648 /// @note Beware of order
649 Escapes const & get_regexp_escapes()
650 {
651         typedef std::pair<std::string, std::string> P;
652
653         static Escapes escape_map;
654         if (escape_map.empty()) {
655                 escape_map.push_back(P("$", "_x_$"));
656                 escape_map.push_back(P("{", "_x_{"));
657                 escape_map.push_back(P("}", "_x_}"));
658                 escape_map.push_back(P("[", "_x_["));
659                 escape_map.push_back(P("]", "_x_]"));
660                 escape_map.push_back(P("(", "_x_("));
661                 escape_map.push_back(P(")", "_x_)"));
662                 escape_map.push_back(P("+", "_x_+"));
663                 escape_map.push_back(P("*", "_x_*"));
664                 escape_map.push_back(P(".", "_x_."));
665                 escape_map.push_back(P("\\", "(?:\\\\|\\\\backslash)"));
666                 escape_map.push_back(P("~", "(?:\\\\textasciitilde|\\\\sim)"));
667                 escape_map.push_back(P("^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
668                 escape_map.push_back(P("_x_", "\\"));
669         }
670         return escape_map;
671 }
672
673 /// A map of lyx escaped strings and their unescaped equivalent.
674 Escapes const & get_lyx_unescapes()
675 {
676         typedef std::pair<std::string, std::string> P;
677
678         static Escapes escape_map;
679         if (escape_map.empty()) {
680                 escape_map.push_back(P("\\%", "%"));
681                 escape_map.push_back(P("\\mathcircumflex ", "^"));
682                 escape_map.push_back(P("\\mathcircumflex", "^"));
683                 escape_map.push_back(P("\\backslash ", "\\"));
684                 escape_map.push_back(P("\\backslash", "\\"));
685                 escape_map.push_back(P("\\\\{", "_x_<"));
686                 escape_map.push_back(P("\\\\}", "_x_>"));
687                 escape_map.push_back(P("\\sim ", "~"));
688                 escape_map.push_back(P("\\sim", "~"));
689         }
690         return escape_map;
691 }
692
693 /// A map of escapes turning a regexp matching text to one matching latex.
694 Escapes const & get_regexp_latex_escapes()
695 {
696         typedef std::pair<std::string, std::string> P;
697
698         static Escapes escape_map;
699         if (escape_map.empty()) {
700                 escape_map.push_back(P("\\\\", "(?:\\\\\\\\|\\\\backslash|\\\\textbackslash\\{\\}|\\\\textbackslash)"));
701                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash)\\{", "\\\\\\{"));
702                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash\\\\\\{)\\}", "\\\\\\}"));
703                 escape_map.push_back(P("\\[", "\\{\\[\\}"));
704                 escape_map.push_back(P("\\]", "\\{\\]\\}"));
705                 escape_map.push_back(P("\\^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
706                 escape_map.push_back(P("%", "\\\\\\%"));
707                 escape_map.push_back(P("#", "\\\\#"));
708         }
709         return escape_map;
710 }
711
712 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
713  ** the found occurrence were escaped.
714  **/
715 string apply_escapes(string s, Escapes const & escape_map)
716 {
717         LYXERR(Debug::FIND, "Escaping: '" << s << "'");
718         Escapes::const_iterator it;
719         for (it = escape_map.begin(); it != escape_map.end(); ++it) {
720 //              LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
721                 unsigned int pos = 0;
722                 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
723                         s.replace(pos, it->first.length(), it->second);
724                         LYXERR(Debug::FIND, "After escape: " << s);
725                         pos += it->second.length();
726 //                      LYXERR(Debug::FIND, "pos: " << pos);
727                 }
728         }
729         LYXERR(Debug::FIND, "Escaped : '" << s << "'");
730         return s;
731 }
732
733
734 /// Within \regexp{} apply get_lyx_unescapes() only (i.e., preserve regexp semantics of the string),
735 /// while outside apply get_lyx_unescapes()+get_regexp_escapes().
736 /// If match_latex is true, then apply regexp_latex_escapes() to \regexp{} contents as well.
737 string escape_for_regex(string s, bool match_latex)
738 {
739         size_t pos = 0;
740         while (pos < s.size()) {
741                 size_t new_pos = s.find("\\regexp{", pos);
742                 if (new_pos == string::npos)
743                         new_pos = s.size();
744                 string t;
745                 if (new_pos > pos) {
746                         LYXERR(Debug::FIND, "new_pos: " << new_pos);
747                         t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
748                         LYXERR(Debug::FIND, "t [lyx]: " << t);
749                         t = apply_escapes(t, get_regexp_escapes());
750                         LYXERR(Debug::FIND, "t [rxp]: " << t);
751                         s.replace(pos, new_pos - pos, t);
752                         new_pos = pos + t.size();
753                         LYXERR(Debug::FIND, "Regexp after escaping: " << s);
754                         LYXERR(Debug::FIND, "new_pos: " << new_pos);
755                         if (new_pos == s.size())
756                                 break;
757                 }
758                 // Might fail if \\endregexp{} is preceeded by unexpected stuff (weird escapes)
759                 size_t end_pos = s.find("\\endregexp{}}", new_pos + 8);
760                 LYXERR(Debug::FIND, "end_pos: " << end_pos);
761                 t = s.substr(new_pos + 8, end_pos - (new_pos + 8));
762                 LYXERR(Debug::FIND, "t in regexp      : " << t);
763                 t = apply_escapes(t, get_lyx_unescapes());
764                 LYXERR(Debug::FIND, "t in regexp [lyx]: " << t);
765                 if (match_latex) {
766                         t = apply_escapes(t, get_regexp_latex_escapes());
767                         LYXERR(Debug::FIND, "t in regexp [ltx]: " << t);
768                 }
769                 if (end_pos == s.size()) {
770                         s.replace(new_pos, end_pos - new_pos, t);
771                         LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
772                         break;
773                 }
774                 s.replace(new_pos, end_pos + 13 - new_pos, t);
775                 LYXERR(Debug::FIND, "Regexp after \\regexp{...\\endregexp{}} removal: " << s);
776                 pos = new_pos + t.size();
777                 LYXERR(Debug::FIND, "pos: " << pos);
778         }
779         return s;
780 }
781
782
783 /// Wrapper for lyx::regex_replace with simpler interface
784 bool regex_replace(string const & s, string & t, string const & searchstr,
785                    string const & replacestr)
786 {
787         lyx::regex e(searchstr, regex_constants::ECMAScript);
788         ostringstream oss;
789         ostream_iterator<char, char> it(oss);
790         lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
791         // tolerate t and s be references to the same variable
792         bool rv = (s != oss.str());
793         t = oss.str();
794         return rv;
795 }
796
797
798 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
799  **
800  ** Verify that closed braces exactly match open braces. This avoids that, for example,
801  ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
802  **
803  ** @param unmatched
804  ** Number of open braces that must remain open at the end for the verification to succeed.
805  **/
806 bool braces_match(string::const_iterator const & beg,
807                   string::const_iterator const & end,
808                   int unmatched = 0)
809 {
810         int open_pars = 0;
811         string::const_iterator it = beg;
812         LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
813         for (; it != end; ++it) {
814                 // Skip escaped braces in the count
815                 if (*it == '\\') {
816                         ++it;
817                         if (it == end)
818                                 break;
819                 } else if (*it == '{') {
820                         ++open_pars;
821                 } else if (*it == '}') {
822                         if (open_pars == 0) {
823                                 LYXERR(Debug::FIND, "Found unmatched closed brace");
824                                 return false;
825                         } else
826                                 --open_pars;
827                 }
828         }
829         if (open_pars != unmatched) {
830                 LYXERR(Debug::FIND, "Found " << open_pars
831                        << " instead of " << unmatched
832                        << " unmatched open braces at the end of count");
833                 return false;
834         }
835         LYXERR(Debug::FIND, "Braces match as expected");
836         return true;
837 }
838
839
840 class MatchResult {
841 public:
842         int match_len;
843         int match2end;
844         int pos;
845         MatchResult(): match_len(0),match2end(0), pos(0) {};
846 };
847
848 /** The class performing a match between a position in the document and the FindAdvOptions.
849  **/
850 class MatchStringAdv {
851 public:
852         MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
853
854         /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
855          ** constructor as opt.search, under the opt.* options settings.
856          **
857          ** @param at_begin
858          **     If set, then match is searched only against beginning of text starting at cur.
859          **     If unset, then match is searched anywhere in text starting at cur.
860          **
861          ** @return
862          ** The length of the matching text, or zero if no match was found.
863          **/
864         MatchResult operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
865
866 public:
867         /// buffer
868         lyx::Buffer * p_buf;
869         /// first buffer on which search was started
870         lyx::Buffer * const p_first_buf;
871         /// options
872         FindAndReplaceOptions const & opt;
873
874 private:
875         /// Auxiliary find method (does not account for opt.matchword)
876         MatchResult findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
877
878         /** Normalize a stringified or latexified LyX paragraph.
879          **
880          ** Normalize means:
881          ** <ul>
882          **   <li>if search is not casesensitive, then lowercase the string;
883          **   <li>remove any newline at begin or end of the string;
884          **   <li>replace any newline in the middle of the string with a simple space;
885          **   <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
886          ** </ul>
887          **
888          ** @todo Normalization should also expand macros, if the corresponding
889          ** search option was checked.
890          **/
891         string normalize(docstring const & s, bool hack_braces) const;
892         // normalized string to search
893         string par_as_string;
894         // regular expression to use for searching
895         lyx::regex regexp;
896         // same as regexp, but prefixed with a ".*?"
897         lyx::regex regexp2;
898         // leading format material as string
899         string lead_as_string;
900         // par_as_string after removal of lead_as_string
901         string par_as_string_nolead;
902         // unmatched open braces in the search string/regexp
903         int open_braces;
904         // number of (.*?) subexpressions added at end of search regexp for closing
905         // environments, math mode, styles, etc...
906         int close_wildcards;
907         // Are we searching with regular expressions ?
908         bool use_regexp;
909 };
910
911
912 static docstring buffer_to_latex(Buffer & buffer)
913 {
914         //OutputParams runparams(&buffer.params().encoding());
915         OutputParams runparams(encodings.fromLyXName("utf8"));
916         odocstringstream ods;
917         otexstream os(ods);
918         runparams.nice = true;
919         runparams.flavor = OutputParams::XETEX;
920         runparams.linelen = 10000; //lyxrc.plaintext_linelen;
921         // No side effect of file copying and image conversion
922         runparams.dryrun = true;
923         runparams.for_search = true;
924         pit_type const endpit = buffer.paragraphs().size();
925         for (pit_type pit = 0; pit != endpit; ++pit) {
926                 TeXOnePar(buffer, buffer.text(), pit, os, runparams);
927                 LYXERR(Debug::FIND, "searchString up to here: " << ods.str());
928         }
929         return ods.str();
930 }
931
932
933 static docstring stringifySearchBuffer(Buffer & buffer, FindAndReplaceOptions const & opt)
934 {
935         docstring str;
936         if (!opt.ignoreformat) {
937                 str = buffer_to_latex(buffer);
938         } else {
939                 // OutputParams runparams(&buffer.params().encoding());
940                 OutputParams runparams(encodings.fromLyXName("utf8"));
941                 runparams.nice = true;
942                 runparams.flavor = OutputParams::XETEX;
943                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
944                 runparams.dryrun = true;
945                 runparams.for_search = true;
946                 for (pos_type pit = pos_type(0); pit < (pos_type)buffer.paragraphs().size(); ++pit) {
947                         Paragraph const & par = buffer.paragraphs().at(pit);
948                         LYXERR(Debug::FIND, "Adding to search string: '"
949                                << par.asString(pos_type(0), par.size(),
950                                                AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
951                                                &runparams)
952                                << "'");
953                         str += par.asString(pos_type(0), par.size(),
954                                             AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
955                                             &runparams);
956                 }
957         }
958         return str;
959 }
960
961
962 /// Return separation pos between the leading material and the rest
963 static size_t identifyLeading(string const & s)
964 {
965         string t = s;
966         // @TODO Support \item[text]
967         // Kornel: Added textsl, textsf, textit, texttt and noun
968         // + allow to search for colored text too
969         while (regex_replace(t, t, REGEX_BOS "\\\\(((footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|emph|noun|minisec|text(bf|md|sl|sf|it|tt))|((textcolor|foreignlanguage|latexenvironment)\\{[a-z]+\\*?\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)\\{", "")
970                || regex_replace(t, t, REGEX_BOS "\\$", "")
971                || regex_replace(t, t, REGEX_BOS "\\\\\\[ ", "")
972                || regex_replace(t, t, REGEX_BOS " ?\\\\item\\{[a-z]+\\}", "")
973                || regex_replace(t, t, REGEX_BOS "\\\\begin\\{[a-zA-Z_]*\\*?\\} ", ""))
974                ;
975         LYXERR(Debug::FIND, "  after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
976         return s.find(t);
977 }
978
979 /*
980  * Given a latexified string, retrieve some handled features
981  * The features of the regex will later be compared with the features
982  * of the searched text. If the regex features are not a
983  * subset of the analized, then, in not format ignoring search
984  * we can early stop the search in the relevant inset.
985  */
986 typedef map<string, bool> Features;
987
988 static Features identifyFeatures(string const & s)
989 {
990         static regex const feature("\\\\(([a-zA-Z]+(\\{([a-z]+\\*?)\\}|\\*)?))\\{");
991         static regex const valid("^("
992                 "("
993                         "(footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|"
994                                 "emph|noun|text(bf|md|sl|sf|it|tt)|"
995                                 "(textcolor|foreignlanguage|item|listitem|latexenvironment)\\{[a-z]+\\*?\\})|"
996                         "(u|uu)line|(s|x)out|uwave|"
997                         "(sub|extra)?title|author|subject|publishers|dedication|(upper|lower)titleback|lyx(right)?address)|"
998                 "((sub)?(((sub)?section)|paragraph)|part|chapter|lyxslide)\\*?)$");
999         smatch sub;
1000         bool displ = true;
1001         Features info;
1002
1003         for (sregex_iterator it(s.begin(), s.end(), feature), end; it != end; ++it) {
1004                 sub = *it;
1005                 if (displ) {
1006                         if (sub.str(1).compare("regexp") == 0) {
1007                                 displ = false;
1008                                 continue;
1009                         }
1010                         string token = sub.str(1);
1011                         smatch sub2;
1012                         if (regex_match(token, sub2, valid)) {
1013                                 info[token] = true;
1014                         }
1015                         else {
1016                                 // ignore
1017                         }
1018                 }
1019                 else {
1020                         if (sub.str(1).compare("endregexp") == 0) {
1021                                 displ = true;
1022                                 continue;
1023                         }
1024                 }
1025         }
1026         return info;
1027 }
1028
1029 /*
1030  * defines values features of a key "\\[a-z]+{"
1031  */
1032 class KeyInfo {
1033  public:
1034   enum KeyType {
1035     /* Char type with content discarded
1036      * like \hspace{1cm} */
1037     noContent,
1038     /* Char, like \backslash */
1039     isChar,
1040     /* \part, \section*, ... */
1041     isSectioning,
1042     /* title, author etc */
1043     isTitle,
1044     /* \foreignlanguage{ngerman}, ... */
1045     isMain,
1046     /* inside \code{}
1047      * to discard language in content */
1048     noMain,
1049     isRegex,
1050     /* \begin{eqnarray}...\end{eqnarray}, ... $...$ */
1051     isMath,
1052     /* fonts, colors, markups, ... */
1053     isStandard,
1054     /* footnotesize, ... large, ...
1055      * Ignore all of them */
1056     isSize,
1057     invalid,
1058     /* inputencoding, ...
1059      * Discard also content, because they do not help in search */
1060     doRemove,
1061     /* twocolumns, ...
1062      * like remove, but also all arguments */
1063     removeWithArg,
1064     /* item, listitem */
1065     isList,
1066     /* tex, latex, ... like isChar */
1067     isIgnored,
1068     /* like \lettrine[lines=5]{}{} */
1069     cleanToStart,
1070     /* End of arguments marker for lettrine,
1071      * so that they can be ignored */
1072     endArguments
1073   };
1074  KeyInfo()
1075    : keytype(invalid),
1076     head(""),
1077     _tokensize(-1),
1078     _tokenstart(-1),
1079     _dataStart(-1),
1080     _dataEnd(-1),
1081     parenthesiscount(1),
1082     disabled(false),
1083     used(false)
1084   {};
1085  KeyInfo(KeyType type, int parcount, bool disable)
1086    : keytype(type),
1087     _tokensize(-1),
1088     _tokenstart(-1),
1089     _dataStart(-1),
1090     _dataEnd(-1),
1091     parenthesiscount(parcount),
1092     disabled(disable),
1093     used(false) {};
1094   KeyType keytype;
1095   string head;
1096   int _tokensize;
1097   int _tokenstart;
1098   int _dataStart;
1099   int _dataEnd;
1100   int parenthesiscount;
1101   bool disabled;
1102   bool used;                            /* by pattern */
1103 };
1104
1105 class Border {
1106  public:
1107  Border(int l=0, int u=0) : low(l), upper(u) {};
1108   int low;
1109   int upper;
1110 };
1111
1112 #define MAXOPENED 30
1113 class Intervall {
1114   bool isPatternString_;
1115 public:
1116   explicit Intervall(bool isPattern, string const & p) :
1117         isPatternString_(isPattern), par(p), ignoreidx(-1), actualdeptindex(0),
1118         hasTitle(false)
1119   {
1120     depts[0] = 0;
1121     closes[0] = 0;
1122   }
1123
1124   string par;
1125   int ignoreidx;
1126   static vector<Border> borders;
1127   int depts[MAXOPENED];
1128   int closes[MAXOPENED];
1129   int actualdeptindex;
1130   int previousNotIgnored(int);
1131   int nextNotIgnored(int);
1132   void handleOpenP(int i);
1133   void handleCloseP(int i, bool closingAllowed);
1134   void resetOpenedP(int openPos);
1135   void addIntervall(int upper);
1136   void addIntervall(int low, int upper); /* if explicit */
1137   void removeAccents();
1138   void setForDefaultLang(KeyInfo &defLang);
1139   int findclosing(int start, int end, char up, char down, int repeat);
1140   void handleParentheses(int lastpos, bool closingAllowed);
1141   bool hasTitle;
1142   int isOpeningPar(int pos);
1143   string titleValue;
1144   void output(ostringstream &os, int lastpos);
1145   // string show(int lastpos);
1146 };
1147
1148 vector<Border> Intervall::borders = vector<Border>(30);
1149
1150 int Intervall::isOpeningPar(int pos)
1151 {
1152   if ((pos < 0) || (size_t(pos) >= par.size()))
1153     return 0;
1154   if (par[pos] != '{')
1155     return 0;
1156   if (size_t(pos) + 2 >= par.size())
1157     return 1;
1158   if (par[pos+2] != '}')
1159     return 1;
1160   if (par[pos+1] == '[' || par[pos+1] == ']')
1161     return 3;
1162   return 1;
1163 }
1164
1165 void Intervall::setForDefaultLang(KeyInfo &defLang)
1166 {
1167   // Enable the use of first token again
1168   if (ignoreidx >= 0) {
1169     int value = defLang._tokenstart + defLang._tokensize;
1170     if (value > 0) {
1171       if (borders[0].low < value)
1172         borders[0].low = value;
1173       if (borders[0].upper < value)
1174         borders[0].upper = value;
1175     }
1176   }
1177 }
1178
1179 static void checkDepthIndex(int val)
1180 {
1181   static int maxdepthidx = MAXOPENED-2;
1182   static int lastmaxdepth = 0;
1183   if (val > lastmaxdepth) {
1184     LYXERR0("Depth reached " << val);
1185     lastmaxdepth = val;
1186   }
1187   if (val > maxdepthidx) {
1188     maxdepthidx = val;
1189     LYXERR0("maxdepthidx now " << val);
1190   }
1191 }
1192
1193 #if 0
1194 // Not needed, because borders are now dynamically expanded
1195 static void checkIgnoreIdx(int val)
1196 {
1197   static int lastmaxignore = -1;
1198   if ((lastmaxignore < val) && (size_t(val+1) >= borders.size())) {
1199     LYXERR0("IgnoreIdx reached " << val);
1200     lastmaxignore = val;
1201   }
1202 }
1203 #endif
1204
1205 /*
1206  * Expand the region of ignored parts of the input latex string
1207  * The region is only relevant in output()
1208  */
1209 void Intervall::addIntervall(int low, int upper)
1210 {
1211   int idx;
1212   if (low == upper) return;
1213   for (idx = ignoreidx+1; idx > 0; --idx) {
1214     if (low > borders[idx-1].upper) {
1215       break;
1216     }
1217   }
1218   Border br(low, upper);
1219   if (idx > ignoreidx) {
1220     if (borders.size() <= size_t(idx)) {
1221       borders.push_back(br);
1222     }
1223     else {
1224       borders[idx] = br;
1225     }
1226     ignoreidx = idx;
1227     // checkIgnoreIdx(ignoreidx);
1228     return;
1229   }
1230   else {
1231     // Expand only if one of the new bound is inside the interwall
1232     // We know here that br.low > borders[idx-1].upper
1233     if (br.upper < borders[idx].low) {
1234       // We have to insert at this pos
1235       if (size_t(ignoreidx+1) >= borders.size()) {
1236         borders.push_back(borders[ignoreidx]);
1237       }
1238       else {
1239         borders[ignoreidx+1] = borders[ignoreidx];
1240       }
1241       for (int i = ignoreidx; i > idx; --i) {
1242         borders[i] = borders[i-1];
1243       }
1244       borders[idx] = br;
1245       ignoreidx += 1;
1246       // checkIgnoreIdx(ignoreidx);
1247       return;
1248     }
1249     // Here we know, that we are overlapping
1250     if (br.low > borders[idx].low)
1251       br.low = borders[idx].low;
1252     // check what has to be concatenated
1253     int count = 0;
1254     for (int i = idx; i <= ignoreidx; i++) {
1255       if (br.upper >= borders[i].low) {
1256         count++;
1257         if (br.upper < borders[i].upper)
1258           br.upper = borders[i].upper;
1259       }
1260       else {
1261         break;
1262       }
1263     }
1264     // count should be >= 1 here
1265     borders[idx] = br;
1266     if (count > 1) {
1267       for (int i = idx + count; i <= ignoreidx; i++) {
1268         borders[i-count+1] = borders[i];
1269       }
1270       ignoreidx -= count - 1;
1271       return;
1272     }
1273   }
1274 }
1275
1276 typedef map<string, string> AccentsMap;
1277 static AccentsMap accents = map<string, string>();
1278
1279 static void buildaccent(string n, string param, string values)
1280 {
1281   stringstream s(n);
1282   string name;
1283   const char delim = '|';
1284   while (getline(s, name, delim)) {
1285     size_t start = 0;
1286     for (size_t i = 0; i < param.size(); i++) {
1287       string key = name + "{" + param[i] + "}";
1288       // get the corresponding utf8-value
1289       if ((values[start] & 0xc0) != 0xc0) {
1290         // should not happen, utf8 encoding starts at least with 11xxxxxx
1291         // but value for '\dot{i}' is 'i', which is ascii
1292         if ((values[start] & 0x80) == 0) {
1293           // is ascii
1294           accents[key] = values.substr(start, 1);
1295           // LYXERR0("" << key << "=" << accents[key]);
1296         }
1297         start++;
1298         continue;
1299       }
1300       for (int j = 1; ;j++) {
1301         if (start + j >= values.size()) {
1302           accents[key] = values.substr(start, j);
1303           start = values.size() - 1;
1304           break;
1305         }
1306         else if ((values[start+j] & 0xc0) != 0x80) {
1307           // This is the first byte of following utf8 char
1308           accents[key] = values.substr(start, j);
1309           start += j;
1310           // LYXERR0("" << key << "=" << accents[key]);
1311           break;
1312         }
1313       }
1314     }
1315   }
1316 }
1317
1318 static void buildAccentsMap()
1319 {
1320   accents["imath"] = "ı";
1321   accents["i"] = "ı";
1322   accents["jmath"] = "ȷ";
1323   accents["lyxmathsym{ß}"] = "ß";
1324   accents["text{ß}"] = "ß";
1325   accents["ddot{\\imath}"] = "ï";
1326   buildaccent("ddot", "aAeEhHiIioOtuUwWxXyY",
1327                       "äÄëËḧḦïÏïöÖẗüÜẅẄẍẌÿŸ");       // umlaut
1328   buildaccent("dot|.", "aAbBcCdDeEfFGghHIimMnNoOpPrRsStTwWxXyYzZ",
1329                        "ȧȦḃḂċĊḋḊėĖḟḞĠġḣḢİİṁṀṅṄȯȮṗṖṙṘṡṠṫṪẇẆẋẊẏẎżŻ");   // dot{i} can only happen if ignoring case, but there is no lowercase of 'İ'
1330   accents["acute{\\imath}"] = "í";
1331   buildaccent("acute", "aAcCeEgGkKlLmMoOnNpPrRsSuUwWyYzZiI",
1332                        "áÁćĆéÉǵǴḱḰĺĹḿḾóÓńŃṕṔŕŔśŚúÚẃẂýÝźŹíÍ");
1333   buildaccent("dacute|H|h", "oOuU", "őŐűŰ");        // double acute
1334   buildaccent("mathring|r", "aAuUwy",
1335                             "åÅůŮẘẙ");  // ring
1336   accents["check{\\imath}"] = "ǐ";
1337   accents["check{\\jmath}"] = "ǰ";
1338   buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTtzZ",
1339                          "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤťžŽ");   // caron
1340   accents["hat{\\imath}"] = "î";
1341   accents["hat{\\jmath}"] = "ĵ";
1342   buildaccent("hat|^", "aAcCeEgGhHiIjJoOsSuUwWyYzZ",
1343                        "âÂĉĈêÊĝĜĥĤîÎĵĴôÔŝŜûÛŵŴŷŶẑẐ");       // circ
1344   accents["bar{\\imath}"] = "ī";
1345   buildaccent("bar|=", "aAeEiIoOuUyY",
1346                        "āĀēĒīĪōŌūŪȳȲ");     // macron
1347   accents["tilde{\\imath}"] = "ĩ";
1348   buildaccent("tilde", "aAeEiInNoOuUvVyY",
1349                        "ãÃẽẼĩĨñÑõÕũŨṽṼỹỸ");       // tilde
1350   accents["breve{\\imath}"] = "ĭ";
1351   buildaccent("breve|u", "aAeEgGiIoOuU",
1352                          "ăĂĕĔğĞĭĬŏŎŭŬ");   // breve
1353   accents["grave{\\imath}"] = "ì";
1354   buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1355                          "àÀèÈìÌòÒùÙǹǸẁẀỳỲ");       // grave
1356   buildaccent("subdot|d", "BbDdHhKkLlMmNnRrSsTtVvWwZzAaEeIiOoUuYy",
1357                           "ḄḅḌḍḤḥḲḳḶḷṂṃṆṇṚṛṢṣṬṭṾṿẈẉẒẓẠạẸẹỊịỌọỤụỴỵ");        // dot below
1358   buildaccent("ogonek|k", "AaEeIiUuOo",
1359                           "ĄąĘęĮįŲųǪǫ");      // ogonek
1360   buildaccent("cedilla|c", "CcGgKkLlNnRrSsTtEeDdHh",
1361                            "ÇçĢĢĶķĻļŅņŖŗŞşŢţȨȩḐḑḨḩ"); // cedilla
1362   buildaccent("subring|textsubring", "Aa",
1363                                      "Ḁḁ"); // subring
1364   buildaccent("subhat|textsubcircum", "DdEeLlNnTtUu",
1365                                       "ḒḓḘḙḼḽṊṋṰṱṶṷ");  // subcircum
1366   buildaccent("subtilde|textsubtilde", "EeIiUu",
1367                                        "ḚḛḬḭṴṵ");   // subtilde
1368   accents["dgrave{\\imath}"] = "ȉ";
1369   accents["textdoublegrave{\\i}"] = "ȉ";
1370   buildaccent("dgrave|textdoublegrave", "AaEeIiOoRrUu",
1371                                         "ȀȁȄȅȈȉȌȍȐȑȔȕ"); // double grave
1372   accents["rcap{\\imath}"] = "ȉ";
1373   accents["textroundcap{\\i}"] = "ȉ";
1374   buildaccent("rcap|textroundcap", "AaEeIiOoRrUu",
1375                                    "ȂȃȆȇȊȋȎȏȒȓȖȗ"); // inverted breve
1376   buildaccent("slashed", "oO",
1377                          "øØ"); // slashed
1378 }
1379
1380 /*
1381  * Created accents in math or regexp environment
1382  * are macros, but we need the utf8 equivalent
1383  */
1384 void Intervall::removeAccents()
1385 {
1386   if (accents.empty())
1387     buildAccentsMap();
1388   static regex const accre("\\\\(([\\S]|grave|breve|lyxmathsym|text|ddot|dot|acute|dacute|mathring|check|hat|bar|tilde|subdot|ogonek|cedilla|subring|textsubring|subhat|textsubcircum|subtilde|textsubtilde|dgrave|textdoublegrave|rcap|textroundcap|slashed)\\{[^\\{\\}]+\\}|(i|imath|jmath)(?![a-zA-Z]))");
1389   smatch sub;
1390   for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1391     sub = *itacc;
1392     string key = sub.str(1);
1393     if (accents.find(key) != accents.end()) {
1394       string val = accents[key];
1395       size_t pos = sub.position(size_t(0));
1396       for (size_t i = 0; i < val.size(); i++) {
1397         par[pos+i] = val[i];
1398       }
1399       addIntervall(pos+val.size(), pos + sub.str(0).size());
1400       for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1401         // remove traces of any remaining chars
1402         par[i] = ' ';
1403       }
1404     }
1405     else {
1406       LYXERR0("Not added accent for \"" << key << "\"");
1407     }
1408   }
1409 }
1410
1411 void Intervall::handleOpenP(int i)
1412 {
1413   actualdeptindex++;
1414   depts[actualdeptindex] = i+1;
1415   closes[actualdeptindex] = -1;
1416   checkDepthIndex(actualdeptindex);
1417 }
1418
1419 void Intervall::handleCloseP(int i, bool closingAllowed)
1420 {
1421   if (actualdeptindex <= 0) {
1422     if (! closingAllowed)
1423       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1424     // if we are at the very end
1425     addIntervall(i, i+1);
1426   }
1427   else {
1428     closes[actualdeptindex] = i+1;
1429     actualdeptindex--;
1430   }
1431 }
1432
1433 void Intervall::resetOpenedP(int openPos)
1434 {
1435   // Used as initializer for foreignlanguage entry
1436   actualdeptindex = 1;
1437   depts[1] = openPos+1;
1438   closes[1] = -1;
1439 }
1440
1441 int Intervall::previousNotIgnored(int start)
1442 {
1443     int idx = 0;                          /* int intervalls */
1444     for (idx = ignoreidx; idx >= 0; --idx) {
1445       if (start > borders[idx].upper)
1446         return start;
1447       if (start >= borders[idx].low)
1448         start = borders[idx].low-1;
1449     }
1450     return start;
1451 }
1452
1453 int Intervall::nextNotIgnored(int start)
1454 {
1455     int idx = 0;                          /* int intervalls */
1456     for (idx = 0; idx <= ignoreidx; idx++) {
1457       if (start < borders[idx].low)
1458         return start;
1459       if (start < borders[idx].upper)
1460         start = borders[idx].upper;
1461     }
1462     return start;
1463 }
1464
1465 typedef map<string, KeyInfo> KeysMap;
1466 typedef vector< KeyInfo> Entries;
1467 static KeysMap keys = map<string, KeyInfo>();
1468
1469 class LatexInfo {
1470  private:
1471   int entidx_;
1472   Entries entries_;
1473   Intervall interval_;
1474   void buildKeys(bool);
1475   void buildEntries(bool);
1476   void makeKey(const string &, KeyInfo, bool isPatternString);
1477   void processRegion(int start, int region_end); /*  remove {} parts */
1478   void removeHead(KeyInfo&, int count=0);
1479
1480  public:
1481  LatexInfo(string const & par, bool isPatternString)
1482          : entidx_(-1), interval_(isPatternString, par)
1483   {
1484     buildKeys(isPatternString);
1485     entries_ = vector<KeyInfo>();
1486     buildEntries(isPatternString);
1487   };
1488   int getFirstKey() {
1489     entidx_ = 0;
1490     if (entries_.empty()) {
1491       return -1;
1492     }
1493     if (entries_[0].keytype == KeyInfo::isTitle) {
1494       if (! entries_[0].disabled) {
1495         interval_.hasTitle = true;
1496         interval_.titleValue = entries_[0].head;
1497       }
1498       else {
1499         interval_.hasTitle = false;
1500         interval_.titleValue = "";
1501       }
1502       removeHead(entries_[0]);
1503       if (entries_.size() > 1)
1504         return 1;
1505       else
1506         return -1;
1507     }
1508     return 0;
1509   };
1510   int getNextKey() {
1511     entidx_++;
1512     if (int(entries_.size()) > entidx_) {
1513       return entidx_;
1514     }
1515     else {
1516       return -1;
1517     }
1518   };
1519   bool setNextKey(int idx) {
1520     if ((idx == entidx_) && (entidx_ >= 0)) {
1521       entidx_--;
1522       return true;
1523     }
1524     else
1525       return false;
1526   };
1527   int find(int start, KeyInfo::KeyType keytype) {
1528     if (start < 0)
1529       return -1;
1530     int tmpIdx = start;
1531     while (tmpIdx < int(entries_.size())) {
1532       if (entries_[tmpIdx].keytype == keytype)
1533         return tmpIdx;
1534       tmpIdx++;
1535     }
1536     return -1;
1537   };
1538   int process(ostringstream &os, KeyInfo &actual);
1539   int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1540   // string show(int lastpos) { return interval.show(lastpos);};
1541   int nextNotIgnored(int start) { return interval_.nextNotIgnored(start);};
1542   KeyInfo &getKeyInfo(int keyinfo) {
1543     static KeyInfo invalidInfo = KeyInfo();
1544     if ((keyinfo < 0) || ( keyinfo >= int(entries_.size())))
1545       return invalidInfo;
1546     else
1547       return entries_[keyinfo];
1548   };
1549   void setForDefaultLang(KeyInfo &defLang) {interval_.setForDefaultLang(defLang);};
1550   void addIntervall(int low, int up) { interval_.addIntervall(low, up); };
1551 };
1552
1553
1554 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1555 {
1556   int skip = 0;
1557   int depth = 0;
1558   repeat--;
1559   for (int i = start; i < end; i += 1 + skip) {
1560     char c;
1561     c = par[i];
1562     skip = 0;
1563     if (c == '\\') skip = 1;
1564     else if (c == up) {
1565       depth++;
1566     }
1567     else if (c == down) {
1568       if (depth == 0) {
1569         if ((repeat <= 0) || (par[i+1] != up))
1570           return i;
1571       }
1572       --depth;
1573     }
1574   }
1575   return end;
1576 }
1577
1578 class MathInfo {
1579   class MathEntry {
1580   public:
1581     string wait;
1582     size_t mathEnd;
1583     size_t mathStart;
1584     size_t mathSize;
1585   };
1586   size_t actualIdx_;
1587   vector<MathEntry> entries_;
1588  public:
1589   MathInfo() {
1590     actualIdx_ = 0;
1591   }
1592   void insert(string const & wait, size_t start, size_t end) {
1593     MathEntry m = MathEntry();
1594     m.wait = wait;
1595     m.mathStart = start;
1596     m.mathEnd = end;
1597     m.mathSize = end - start;
1598     entries_.push_back(m);
1599   }
1600   bool empty() { return entries_.empty(); };
1601   size_t getEndPos() {
1602     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1603       return 0;
1604     }
1605     return entries_[actualIdx_].mathEnd;
1606   }
1607   size_t getStartPos() {
1608     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1609       return 100000;                    /*  definitely enough? */
1610     }
1611     return entries_[actualIdx_].mathStart;
1612   }
1613   size_t getFirstPos() {
1614     actualIdx_ = 0;
1615     return getStartPos();
1616   }
1617   size_t getSize() {
1618     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1619       return size_t(0);
1620     }
1621     return entries_[actualIdx_].mathSize;
1622   }
1623   void incrEntry() { actualIdx_++; };
1624 };
1625
1626 void LatexInfo::buildEntries(bool isPatternString)
1627 {
1628   static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1629   static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1630   static bool disableLanguageOverride = false;
1631   smatch sub, submath;
1632   bool evaluatingRegexp = false;
1633   MathInfo mi;
1634   bool evaluatingMath = false;
1635   bool evaluatingCode = false;
1636   size_t codeEnd = 0;
1637   bool evaluatingOptional = false;
1638   size_t optionalEnd = 0;
1639   int codeStart = -1;
1640   KeyInfo found;
1641   bool math_end_waiting = false;
1642   size_t math_pos = 10000;
1643   string math_end;
1644
1645   interval_.removeAccents();
1646
1647   for (sregex_iterator itmath(interval_.par.begin(), interval_.par.end(), rmath), end; itmath != end; ++itmath) {
1648     submath = *itmath;
1649     if (math_end_waiting) {
1650       size_t pos = submath.position(size_t(0));
1651       if ((math_end == "$") &&
1652           (submath.str(0) == "$") &&
1653           (interval_.par[pos-1] != '\\')) {
1654         mi.insert("$", math_pos, pos + 1);
1655         math_end_waiting = false;
1656       }
1657       else if ((math_end == "\\]") &&
1658                (submath.str(0) == "\\]")) {
1659         mi.insert("\\]", math_pos, pos + 2);
1660         math_end_waiting = false;
1661       }
1662       else if ((submath.str(1).compare("end") == 0) &&
1663           (submath.str(2).compare(math_end) == 0)) {
1664         mi.insert(math_end, math_pos, pos + submath.str(0).length());
1665         math_end_waiting = false;
1666       }
1667       else
1668         continue;
1669     }
1670     else {
1671       if (submath.str(1).compare("begin") == 0) {
1672         math_end_waiting = true;
1673         math_end = submath.str(2);
1674         math_pos = submath.position(size_t(0));
1675       }
1676       else if (submath.str(0).compare("\\[") == 0) {
1677         math_end_waiting = true;
1678         math_end = "\\]";
1679         math_pos = submath.position(size_t(0));
1680       }
1681       else if (submath.str(0) == "$") {
1682         size_t pos = submath.position(size_t(0));
1683         if ((pos == 0) || (interval_.par[pos-1] != '\\')) {
1684           math_end_waiting = true;
1685           math_end = "$";
1686           math_pos = pos;
1687         }
1688       }
1689     }
1690   }
1691   // Ignore language if there is math somewhere in pattern-string
1692   if (isPatternString) {
1693     if (! mi.empty()) {
1694       // Disable language
1695       keys["foreignlanguage"].disabled = true;
1696       disableLanguageOverride = true;
1697     }
1698     else
1699       disableLanguageOverride = false;
1700   }
1701   else {
1702     if (disableLanguageOverride) {
1703       keys["foreignlanguage"].disabled = true;
1704     }
1705   }
1706   math_pos = mi.getFirstPos();
1707   for (sregex_iterator it(interval_.par.begin(), interval_.par.end(), rkeys), end; it != end; ++it) {
1708     sub = *it;
1709     string key = sub.str(3);
1710     if (key == "") {
1711       if (sub.str(0)[0] == '\\')
1712         key = sub.str(0)[1];
1713       else {
1714         key = sub.str(0);
1715         if (key == "$") {
1716           size_t k_pos = sub.position(size_t(0));
1717           if ((k_pos > 0) && (interval_.par[k_pos - 1] == '\\')) {
1718             // Escaped '$', ignoring
1719             continue;
1720           }
1721         }
1722       }
1723     };
1724     if (evaluatingRegexp) {
1725       if (sub.str(1).compare("endregexp") == 0) {
1726         evaluatingRegexp = false;
1727         // found._tokenstart already set
1728         found._dataEnd = sub.position(size_t(0)) + 13;
1729         found._dataStart = found._dataEnd;
1730         found._tokensize = found._dataEnd - found._tokenstart;
1731         found.parenthesiscount = 0;
1732         found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1733       }
1734       else {
1735         continue;
1736       }
1737     }
1738     else {
1739       if (evaluatingMath) {
1740         if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1741           continue;
1742         evaluatingMath = false;
1743         mi.incrEntry();
1744         math_pos = mi.getStartPos();
1745       }
1746       if (keys.find(key) == keys.end()) {
1747         found = KeyInfo(KeyInfo::isStandard, 0, true);
1748         if (isPatternString) {
1749           found.keytype = KeyInfo::isChar;
1750           found.disabled = false;
1751           found.used = true;
1752         }
1753         keys[key] = found;
1754       }
1755       else
1756         found = keys[key];
1757       if (key.compare("regexp") == 0) {
1758         evaluatingRegexp = true;
1759         found._tokenstart = sub.position(size_t(0));
1760         found._tokensize = 0;
1761         continue;
1762       }
1763     }
1764     // Handle the other params of key
1765     if (found.keytype == KeyInfo::isIgnored)
1766       continue;
1767     else if (found.keytype == KeyInfo::isMath) {
1768       if (size_t(sub.position(size_t(0))) == math_pos) {
1769         found = keys[key];
1770         found._tokenstart = sub.position(size_t(0));
1771         found._tokensize = mi.getSize();
1772         found._dataEnd = found._tokenstart + found._tokensize;
1773         found._dataStart = found._dataEnd;
1774         found.parenthesiscount = 0;
1775         found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1776         evaluatingMath = true;
1777       }
1778       else {
1779         // begin|end of unknown env, discard
1780         // First handle tables
1781         // longtable|tabular
1782         bool discardComment;
1783         found = keys[key];
1784         found.keytype = KeyInfo::doRemove;
1785         if ((sub.str(5).compare("longtable") == 0) ||
1786             (sub.str(5).compare("tabular") == 0)) {
1787           discardComment = true;        /* '%' */
1788         }
1789         else {
1790           discardComment = false;
1791           static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1792           smatch sub2;
1793           string token = sub.str(5);
1794           if (regex_match(token, sub2, removeArgs)) {
1795             found.keytype = KeyInfo::removeWithArg;
1796           }
1797         }
1798         // discard spaces before pos(0)
1799         int pos = sub.position(size_t(0));
1800         int count;
1801         for (count = 0; pos - count > 0; count++) {
1802           char c = interval_.par[pos-count-1];
1803           if (discardComment) {
1804             if ((c != ' ') && (c != '%'))
1805               break;
1806           }
1807           else if (c != ' ')
1808             break;
1809         }
1810         found._tokenstart = pos - count;
1811         if (sub.str(1).compare(0, 5, "begin") == 0) {
1812           size_t pos1 = pos + sub.str(0).length();
1813           if (sub.str(5).compare("cjk") == 0) {
1814             pos1 = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1815             if ((interval_.par[pos1] == '{') && (interval_.par[pos1+1] == '}'))
1816               pos1 += 2;
1817             found.keytype = KeyInfo::isMain;
1818             found._dataStart = pos1;
1819             found._dataEnd = interval_.par.length();
1820             found.disabled = keys["foreignlanguage"].disabled;
1821             found.used = keys["foreignlanguage"].used;
1822             found._tokensize = pos1 - found._tokenstart;
1823             found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1824           }
1825           else {
1826             // Swallow possible optional params
1827             while (interval_.par[pos1] == '[') {
1828               pos1 = interval_.findclosing(pos1+1, interval_.par.length(), '[', ']')+1;
1829             }
1830             // Swallow also the eventual parameter
1831             if (interval_.par[pos1] == '{') {
1832               found._dataEnd = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1833             }
1834             else {
1835               found._dataEnd = pos1;
1836             }
1837             found._dataStart = found._dataEnd;
1838             found._tokensize = count + found._dataEnd - pos;
1839             found.parenthesiscount = 0;
1840             found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1841             found.disabled = true;
1842           }
1843         }
1844         else {
1845           // Handle "\end{...}"
1846           found._dataStart = pos + sub.str(0).length();
1847           found._dataEnd = found._dataStart;
1848           found._tokensize = count + found._dataEnd - pos;
1849           found.parenthesiscount = 0;
1850           found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1851           found.disabled = true;
1852         }
1853       }
1854     }
1855     else if (found.keytype != KeyInfo::isRegex) {
1856       found._tokenstart = sub.position(size_t(0));
1857       if (found.parenthesiscount == 0) {
1858         // Probably to be discarded
1859         size_t following_pos = sub.position(size_t(0)) + sub.str(3).length() + 1;
1860         char following = interval_.par[following_pos];
1861         if (following == ' ')
1862           found.head = "\\" + sub.str(3) + " ";
1863         else if (following == '=') {
1864           // like \uldepth=1000pt
1865           found.head = sub.str(0);
1866         }
1867         else
1868           found.head = "\\" + key;
1869         found._tokensize = found.head.length();
1870         found._dataEnd = found._tokenstart + found._tokensize;
1871         found._dataStart = found._dataEnd;
1872       }
1873       else {
1874         int params = found._tokenstart + key.length() + 1;
1875         if (evaluatingOptional) {
1876           if (size_t(found._tokenstart) > optionalEnd) {
1877             evaluatingOptional = false;
1878           }
1879           else {
1880             found.disabled = true;
1881           }
1882         }
1883         int optend = params;
1884         while (interval_.par[optend] == '[') {
1885           // discard optional parameters
1886           optend = interval_.findclosing(optend+1, interval_.par.length(), '[', ']') + 1;
1887         }
1888         if (optend > params) {
1889           key += interval_.par.substr(params, optend-params);
1890           evaluatingOptional = true;
1891           optionalEnd = optend;
1892         }
1893         string token = sub.str(5);
1894         int closings = found.parenthesiscount;
1895         if (found.parenthesiscount == 1) {
1896           found.head = "\\" + key + "{";
1897         }
1898         else if (found.parenthesiscount > 1) {
1899           if (token != "") {
1900             found.head = sub.str(0) + "{";
1901             closings = found.parenthesiscount - 1;
1902           }
1903           else {
1904             found.head = "\\" + key + "{";
1905           }
1906         }
1907         found._tokensize = found.head.length();
1908         found._dataStart = found._tokenstart + found.head.length();
1909         if (interval_.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
1910           found._dataStart += 15;
1911         }
1912         size_t endpos = interval_.findclosing(found._dataStart, interval_.par.length(), '{', '}', closings);
1913         if (found.keytype == KeyInfo::isList) {
1914           // Check if it really is list env
1915           static regex const listre("^([a-z]+)$");
1916           smatch sub2;
1917           if (!regex_match(token, sub2, listre)) {
1918             // Change the key of this entry. It is not in a list/item environment
1919             found.keytype = KeyInfo::endArguments;
1920           }
1921         }
1922         if (found.keytype == KeyInfo::noMain) {
1923           evaluatingCode = true;
1924           codeEnd = endpos;
1925           codeStart = found._dataStart;
1926         }
1927         else if (evaluatingCode) {
1928           if (size_t(found._dataStart) > codeEnd)
1929             evaluatingCode = false;
1930           else if (found.keytype == KeyInfo::isMain) {
1931             // Disable this key, treate it as standard
1932             found.keytype = KeyInfo::isStandard;
1933             found.disabled = true;
1934             if ((codeEnd == interval_.par.length()) &&
1935                 (found._tokenstart == codeStart)) {
1936               // trickery, because the code inset starts
1937               // with \selectlanguage ...
1938               codeEnd = endpos;
1939               if (entries_.size() > 1) {
1940                 entries_[entries_.size()-1]._dataEnd = codeEnd;
1941               }
1942             }
1943           }
1944         }
1945         if ((endpos == interval_.par.length()) &&
1946             (found.keytype == KeyInfo::doRemove)) {
1947           // Missing closing => error in latex-input?
1948           // therefore do not delete remaining data
1949           found._dataStart -= 1;
1950           found._dataEnd = found._dataStart;
1951         }
1952         else
1953           found._dataEnd = endpos;
1954       }
1955       if (isPatternString) {
1956         keys[key].used = true;
1957       }
1958     }
1959     entries_.push_back(found);
1960   }
1961 }
1962
1963 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1964 {
1965   stringstream s(keysstring);
1966   string key;
1967   const char delim = '|';
1968   while (getline(s, key, delim)) {
1969     KeyInfo keyII(keyI);
1970     if (isPatternString) {
1971       keyII.used = false;
1972     }
1973     else if ( !keys[key].used)
1974       keyII.disabled = true;
1975     keys[key] = keyII;
1976   }
1977 }
1978
1979 void LatexInfo::buildKeys(bool isPatternString)
1980 {
1981
1982   static bool keysBuilt = false;
1983   if (keysBuilt && !isPatternString) return;
1984
1985   // Known standard keys with 1 parameter.
1986   // Split is done, if not at start of region
1987   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1988   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1989   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1990   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1991   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1992   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1993
1994   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1995           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1996   makeKey("section*|subsection*|subsubsection*|paragraph*",
1997           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1998   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1999   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
2000   // Regex
2001   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
2002
2003   // Split is done, if not at start of region
2004   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
2005   makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
2006
2007   // Split is done always.
2008   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
2009
2010   // Known charaters
2011   // No split
2012   makeKey("backslash|textbackslash|slash",  KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2013   makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2014   makeKey("textasciiacute|texemdash",       KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2015   makeKey("dots|ldots",                     KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2016   // Spaces
2017   makeKey("quad|qquad|hfill|dotfill",               KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2018   makeKey("textvisiblespace|nobreakspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2019   makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2020   // Skip
2021   // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2022   // Custom space/skip, remove the content (== length value)
2023   makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
2024   // Found in fr/UserGuide.lyx
2025   makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2026   // quotes
2027   makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2028   makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2029   // Known macros to remove (including their parameter)
2030   // No split
2031   makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
2032   makeKey("addtocounter|setlength",                 KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
2033   // handle like standard keys with 1 parameter.
2034   makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
2035
2036   // Macros to remove, but let the parameter survive
2037   // No split
2038   makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2039
2040   // Remove language spec from content of these insets
2041   makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
2042
2043   // Same effect as previous, parameter will survive (because there is no one anyway)
2044   // No split
2045   makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2046   // Remove table decorations
2047   makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
2048   // Discard shape-header.
2049   // For footnote or shortcut too, because of lang settings
2050   // and wrong handling if used 'KeyInfo::noMain'
2051   makeKey("circlepar|diamondpar|heartpar|nutpar",  KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2052   makeKey("trianglerightpar|hexagonpar|starpar",   KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2053   makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2054   makeKey("triangleleftpar|shapepar|dropuppar",    KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2055   makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics",     KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2056   makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2057   // like ('tiny{}' or '\tiny ' ... )
2058   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2059
2060   // Survives, like known character
2061   makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2062   makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2063
2064   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2065   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2066   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2067
2068   makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2069   // Remove RTL/LTR marker
2070   makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2071   makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2072   makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2073   makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2074   makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2075   makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2076   makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2077   if (isPatternString) {
2078     // Allow the first searched string to rebuild the keys too
2079     keysBuilt = false;
2080   }
2081   else {
2082     // no need to rebuild again
2083     keysBuilt = true;
2084   }
2085 }
2086
2087 /*
2088  * Keep the list of actual opened parentheses actual
2089  * (e.g. depth == 4 means there are 4 '{' not processed yet)
2090  */
2091 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2092 {
2093   int skip = 0;
2094   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2095     char c;
2096     c = par[i];
2097     skip = 0;
2098     if (c == '\\') skip = 1;
2099     else if (c == '{') {
2100       handleOpenP(i);
2101     }
2102     else if (c == '}') {
2103       handleCloseP(i, closingAllowed);
2104     }
2105   }
2106 }
2107
2108 #if (0)
2109 string Intervall::show(int lastpos)
2110 {
2111   int idx = 0;                          /* int intervalls */
2112   string s;
2113   int i = 0;
2114   for (idx = 0; idx <= ignoreidx; idx++) {
2115     while (i < lastpos) {
2116       int printsize;
2117       if (i <= borders[idx].low) {
2118         if (borders[idx].low > lastpos)
2119           printsize = lastpos - i;
2120         else
2121           printsize = borders[idx].low - i;
2122         s += par.substr(i, printsize);
2123         i += printsize;
2124         if (i >= borders[idx].low)
2125           i = borders[idx].upper;
2126       }
2127       else {
2128         i = borders[idx].upper;
2129         break;
2130       }
2131     }
2132   }
2133   if (lastpos > i) {
2134     s += par.substr(i, lastpos-i);
2135   }
2136   return s;
2137 }
2138 #endif
2139
2140 void Intervall::output(ostringstream &os, int lastpos)
2141 {
2142   // get number of chars to output
2143   int idx = 0;                          /* int intervalls */
2144   int i = 0;
2145   int printed = 0;
2146   string startTitle = titleValue;
2147   for (idx = 0; idx <= ignoreidx; idx++) {
2148     if (i < lastpos) {
2149       if (i <= borders[idx].low) {
2150         int printsize;
2151         if (borders[idx].low > lastpos)
2152           printsize = lastpos - i;
2153         else
2154           printsize = borders[idx].low - i;
2155         if (printsize > 0) {
2156           os << startTitle << par.substr(i, printsize);
2157           i += printsize;
2158           printed += printsize;
2159           startTitle = "";
2160         }
2161         handleParentheses(i, false);
2162         if (i >= borders[idx].low)
2163           i = borders[idx].upper;
2164       }
2165       else {
2166         i = borders[idx].upper;
2167       }
2168     }
2169     else
2170       break;
2171   }
2172   if (lastpos > i) {
2173     os << startTitle << par.substr(i, lastpos-i);
2174     printed += lastpos-i;
2175   }
2176   handleParentheses(lastpos, false);
2177   for (int i = actualdeptindex; i > 0; --i) {
2178     os << "}";
2179   }
2180   if (hasTitle && (printed > 0))
2181     os << "}";
2182   if (! isPatternString_)
2183     os << "\n";
2184   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2185 }
2186
2187 void LatexInfo::processRegion(int start, int region_end)
2188 {
2189   while (start < region_end) {          /* Let {[} and {]} survive */
2190     int cnt = interval_.isOpeningPar(start);
2191     if (cnt == 1) {
2192       // Closing is allowed past the region
2193       int closing = interval_.findclosing(start+1, interval_.par.length());
2194       interval_.addIntervall(start, start+1);
2195       interval_.addIntervall(closing, closing+1);
2196     }
2197     else if (cnt == 3)
2198       start += 2;
2199     start = interval_.nextNotIgnored(start+1);
2200   }
2201 }
2202
2203 void LatexInfo::removeHead(KeyInfo &actual, int count)
2204 {
2205   if (actual.parenthesiscount == 0) {
2206     // "{\tiny{} ...}" ==> "{{} ...}"
2207     interval_.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2208   }
2209   else {
2210     // Remove header hull, that is "\url{abcd}" ==> "abcd"
2211     interval_.addIntervall(actual._tokenstart - count, actual._dataStart);
2212     interval_.addIntervall(actual._dataEnd, actual._dataEnd+1);
2213   }
2214 }
2215
2216 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2217 {
2218   int nextKeyIdx = 0;
2219   switch (actual.keytype)
2220   {
2221     case KeyInfo::isTitle: {
2222       removeHead(actual);
2223       nextKeyIdx = getNextKey();
2224       break;
2225     }
2226     case KeyInfo::cleanToStart: {
2227       actual._dataEnd = actual._dataStart;
2228       nextKeyIdx = getNextKey();
2229       // Search for end of arguments
2230       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2231       if (tmpIdx > 0) {
2232         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2233           entries_[i].disabled = true;
2234         }
2235         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2236       }
2237       while (interval_.par[actual._dataEnd] == ' ')
2238         actual._dataEnd++;
2239       interval_.addIntervall(0, actual._dataEnd+1);
2240       interval_.actualdeptindex = 0;
2241       interval_.depts[0] = actual._dataEnd+1;
2242       interval_.closes[0] = -1;
2243       break;
2244     }
2245     case KeyInfo::noContent: {          /* char like "\hspace{2cm}" */
2246       if (actual.disabled)
2247         interval_.addIntervall(actual._tokenstart, actual._dataEnd);
2248       else
2249         interval_.addIntervall(actual._dataStart, actual._dataEnd);
2250     }
2251       // fall through
2252     case KeyInfo::isChar: {
2253       nextKeyIdx = getNextKey();
2254       break;
2255     }
2256     case KeyInfo::isSize: {
2257       if (actual.disabled || (interval_.par[actual._dataStart] != '{') || (interval_.par[actual._dataStart-1] == ' ')) {
2258         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
2259         interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2260         nextKeyIdx = getNextKey();
2261       } else {
2262         // Here _dataStart points to '{', so correct it
2263         actual._dataStart += 1;
2264         actual._tokensize += 1;
2265         actual.parenthesiscount = 1;
2266         if (interval_.par[actual._dataStart] == '}') {
2267           // Determine the end if used like '{\tiny{}...}'
2268           actual._dataEnd = interval_.findclosing(actual._dataStart+1, interval_.par.length()) + 1;
2269           interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2270         }
2271         else {
2272           // Determine the end if used like '\tiny{...}'
2273           actual._dataEnd = interval_.findclosing(actual._dataStart, interval_.par.length()) + 1;
2274         }
2275         // Split on this key if not at start
2276         int start = interval_.nextNotIgnored(previousStart);
2277         if (start < actual._tokenstart) {
2278           interval_.output(os, actual._tokenstart);
2279           interval_.addIntervall(start, actual._tokenstart);
2280         }
2281         // discard entry if at end of actual
2282         nextKeyIdx = process(os, actual);
2283       }
2284       break;
2285     }
2286     case KeyInfo::endArguments:
2287       // Remove trailing '{}' too
2288       actual._dataStart += 1;
2289       actual._dataEnd += 1;
2290       interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2291       nextKeyIdx = getNextKey();
2292       break;
2293     case KeyInfo::noMain:
2294       // fall through
2295     case KeyInfo::isStandard: {
2296       if (actual.disabled) {
2297         removeHead(actual);
2298         processRegion(actual._dataStart, actual._dataStart+1);
2299         nextKeyIdx = getNextKey();
2300       } else {
2301         // Split on this key if not at datastart of calling entry
2302         int start = interval_.nextNotIgnored(previousStart);
2303         if (start < actual._tokenstart) {
2304           interval_.output(os, actual._tokenstart);
2305           interval_.addIntervall(start, actual._tokenstart);
2306         }
2307         // discard entry if at end of actual
2308         nextKeyIdx = process(os, actual);
2309       }
2310       break;
2311     }
2312     case KeyInfo::removeWithArg: {
2313       nextKeyIdx = getNextKey();
2314       // Search for end of arguments
2315       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2316       if (tmpIdx > 0) {
2317         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2318           entries_[i].disabled = true;
2319         }
2320         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2321       }
2322       interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2323       break;
2324     }
2325     case KeyInfo::doRemove: {
2326       // Remove the key with all parameters and following spaces
2327       size_t pos;
2328       for (pos = actual._dataEnd+1; pos < interval_.par.length(); pos++) {
2329         if ((interval_.par[pos] != ' ') && (interval_.par[pos] != '%'))
2330           break;
2331       }
2332       interval_.addIntervall(actual._tokenstart, pos);
2333       nextKeyIdx = getNextKey();
2334       break;
2335     }
2336     case KeyInfo::isList: {
2337       // Discard space before _tokenstart
2338       int count;
2339       for (count = 0; count < actual._tokenstart; count++) {
2340         if (interval_.par[actual._tokenstart-count-1] != ' ')
2341           break;
2342       }
2343       nextKeyIdx = getNextKey();
2344       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2345       if (tmpIdx > 0) {
2346         // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2347         // with arguments
2348         // How else can we catch this one?
2349         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2350           entries_[i].disabled = true;
2351         }
2352         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2353       }
2354       else if (nextKeyIdx > 0) {
2355         // Ignore any lang entries inside data region
2356         for (int i = nextKeyIdx; i < int(entries_.size()) && entries_[i]._tokenstart < actual._dataEnd; i++) {
2357           if (entries_[i].keytype == KeyInfo::isMain)
2358             entries_[i].disabled = true;
2359         }
2360       }
2361       if (actual.disabled) {
2362         interval_.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2363       }
2364       else {
2365         interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2366       }
2367       if (interval_.par[actual._dataEnd+1] == '[') {
2368         int posdown = interval_.findclosing(actual._dataEnd+2, interval_.par.length(), '[', ']');
2369         if ((interval_.par[actual._dataEnd+2] == '{') &&
2370             (interval_.par[posdown-1] == '}')) {
2371           interval_.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2372           interval_.addIntervall(posdown-1, posdown+1);
2373         }
2374         else {
2375           interval_.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2376           interval_.addIntervall(posdown, posdown+1);
2377         }
2378         int blk = interval_.nextNotIgnored(actual._dataEnd+1);
2379         if (blk > posdown) {
2380           // Discard at most 1 space after empty item
2381           int count;
2382           for (count = 0; count < 1; count++) {
2383             if (interval_.par[blk+count] != ' ')
2384               break;
2385           }
2386           if (count > 0)
2387             interval_.addIntervall(blk, blk+count);
2388         }
2389       }
2390       break;
2391     }
2392     case KeyInfo::isSectioning: {
2393       // Discard spaces before _tokenstart
2394       int count;
2395       int val = actual._tokenstart;
2396       for (count = 0; count < actual._tokenstart;) {
2397         val = interval_.previousNotIgnored(val-1);
2398         if (interval_.par[val] != ' ')
2399           break;
2400         else {
2401           count = actual._tokenstart - val;
2402         }
2403       }
2404       if (actual.disabled) {
2405         removeHead(actual, count);
2406         nextKeyIdx = getNextKey();
2407       } else {
2408         interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2409         nextKeyIdx = process(os, actual);
2410       }
2411       break;
2412     }
2413     case KeyInfo::isMath: {
2414       // Same as regex, use the content unchanged
2415       nextKeyIdx = getNextKey();
2416       break;
2417     }
2418     case KeyInfo::isRegex: {
2419       // DO NOT SPLIT ON REGEX
2420       // Do not disable
2421       nextKeyIdx = getNextKey();
2422       break;
2423     }
2424     case KeyInfo::isIgnored: {
2425       // Treat like a character for now
2426       nextKeyIdx = getNextKey();
2427       break;
2428     }
2429     case KeyInfo::isMain: {
2430       if (interval_.par.substr(actual._dataStart, 2) == "% ")
2431         interval_.addIntervall(actual._dataStart, actual._dataStart+2);
2432       if (actual._tokenstart > 0) {
2433         int prev = interval_.previousNotIgnored(actual._tokenstart - 1);
2434         if ((prev >= 0) && interval_.par[prev] == '%')
2435           interval_.addIntervall(prev, prev+1);
2436       }
2437       if (actual.disabled) {
2438         removeHead(actual);
2439         if ((interval_.par.substr(actual._dataStart, 3) == " \\[") ||
2440             (interval_.par.substr(actual._dataStart, 8) == " \\begin{")) {
2441           // Discard also the space before math-equation
2442           interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2443         }
2444         nextKeyIdx = getNextKey();
2445         // interval.resetOpenedP(actual._dataStart-1);
2446       }
2447       else {
2448         if (actual._tokenstart < 26) {
2449           // for the first (and maybe dummy) language
2450           interval_.setForDefaultLang(actual);
2451         }
2452         interval_.resetOpenedP(actual._dataStart-1);
2453       }
2454       break;
2455     }
2456     case KeyInfo::invalid:
2457       // This cannot happen, already handled
2458       // fall through
2459     default: {
2460       // LYXERR0("Unhandled keytype");
2461       nextKeyIdx = getNextKey();
2462       break;
2463     }
2464   }
2465   return nextKeyIdx;
2466 }
2467
2468 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
2469 {
2470   int end = interval_.nextNotIgnored(actual._dataEnd);
2471   int oldStart = actual._dataStart;
2472   int nextKeyIdx = getNextKey();
2473   while (true) {
2474     if ((nextKeyIdx < 0) ||
2475         (entries_[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2476         (entries_[nextKeyIdx].keytype == KeyInfo::invalid)) {
2477       if (oldStart <= end) {
2478         processRegion(oldStart, end);
2479         oldStart = end+1;
2480       }
2481       break;
2482     }
2483     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2484
2485     if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2486       (void) dispatch(os, actual._dataStart, nextKey);
2487       end = nextKey._tokenstart;
2488       break;
2489     }
2490     processRegion(oldStart, nextKey._tokenstart);
2491     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2492
2493     oldStart = nextKey._dataEnd+1;
2494   }
2495   // now nextKey is either invalid or is outside of actual._dataEnd
2496   // output the remaining and discard myself
2497   if (oldStart <= end) {
2498     processRegion(oldStart, end);
2499   }
2500   if (interval_.par[end] == '}') {
2501     end += 1;
2502     // This is the normal case.
2503     // But if using the firstlanguage, the closing may be missing
2504   }
2505   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2506   int output_end;
2507   if (actual._dataEnd < end)
2508     output_end = interval_.nextNotIgnored(actual._dataEnd);
2509   else
2510     output_end = interval_.nextNotIgnored(end);
2511   if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2512     interval_.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2513   }
2514   // Remove possible empty data
2515   int dstart = interval_.nextNotIgnored(actual._dataStart);
2516   while (interval_.isOpeningPar(dstart) == 1) {
2517     interval_.addIntervall(dstart, dstart+1);
2518     int dend = interval_.findclosing(dstart+1, output_end);
2519     interval_.addIntervall(dend, dend+1);
2520     dstart = interval_.nextNotIgnored(dstart+1);
2521   }
2522   if (dstart < output_end)
2523     interval_.output(os, output_end);
2524   interval_.addIntervall(actual._tokenstart, end);
2525   return nextKeyIdx;
2526 }
2527
2528 string splitOnKnownMacros(string par, bool isPatternString)
2529 {
2530   ostringstream os;
2531   LatexInfo li(par, isPatternString);
2532   // LYXERR0("Berfore split: " << par);
2533   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2534   DummyKey.head = "";
2535   DummyKey._tokensize = 0;
2536   DummyKey._dataStart = 0;
2537   DummyKey._dataEnd = par.length();
2538   DummyKey.disabled = true;
2539   int firstkeyIdx = li.getFirstKey();
2540   string s;
2541   if (firstkeyIdx >= 0) {
2542     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2543     DummyKey._tokenstart = firstKey._tokenstart;
2544     int nextkeyIdx;
2545     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2546       // Use dummy firstKey
2547       firstKey = DummyKey;
2548       (void) li.setNextKey(firstkeyIdx);
2549     }
2550     else {
2551       if (par.substr(firstKey._dataStart, 2) == "% ")
2552         li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2553     }
2554     nextkeyIdx = li.process(os, firstKey);
2555     while (nextkeyIdx >= 0) {
2556       // Check for a possible gap between the last
2557       // entry and this one
2558       int datastart = li.nextNotIgnored(firstKey._dataStart);
2559       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2560       if ((nextKey._tokenstart > datastart)) {
2561         // Handle the gap
2562         firstKey._dataStart = datastart;
2563         firstKey._dataEnd = par.length();
2564         (void) li.setNextKey(nextkeyIdx);
2565         // Fake the last opened parenthesis
2566         li.setForDefaultLang(firstKey);
2567         nextkeyIdx = li.process(os, firstKey);
2568       }
2569       else {
2570         if (nextKey.keytype != KeyInfo::isMain) {
2571           firstKey._dataStart = datastart;
2572           firstKey._dataEnd = nextKey._dataEnd+1;
2573           (void) li.setNextKey(nextkeyIdx);
2574           li.setForDefaultLang(firstKey);
2575           nextkeyIdx = li.process(os, firstKey);
2576         }
2577         else {
2578           nextkeyIdx = li.process(os, nextKey);
2579         }
2580       }
2581     }
2582     // Handle the remaining
2583     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2584     firstKey._dataEnd = par.length();
2585     // Check if ! empty
2586     if ((firstKey._dataStart < firstKey._dataEnd) &&
2587         (par[firstKey._dataStart] != '}')) {
2588       li.setForDefaultLang(firstKey);
2589       (void) li.process(os, firstKey);
2590     }
2591     s = os.str();
2592     if (s.empty()) {
2593       // return string definitelly impossible to match
2594       s = "\\foreignlanguage{ignore}{ }";
2595     }
2596   }
2597   else
2598     s = par;                            /* no known macros found */
2599   // LYXERR0("After split: " << s);
2600   return s;
2601 }
2602
2603 /*
2604  * Try to unify the language specs in the latexified text.
2605  * Resulting modified string is set to "", if
2606  * the searched tex does not contain all the features in the search pattern
2607  */
2608 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2609 {
2610         static Features regex_f;
2611         static int missed = 0;
2612         static bool regex_with_format = false;
2613
2614         int parlen = par.length();
2615
2616         while ((parlen > 0) && (par[parlen-1] == '\n')) {
2617                 parlen--;
2618         }
2619         if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2620                 // Happens to be there in case of description or labeling environment
2621                 parlen--;
2622         }
2623         string result;
2624         if (withformat) {
2625                 // Split the latex input into pieces which
2626                 // can be digested by our search engine
2627                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2628                 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2629                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2630         }
2631         else
2632                 result = par.substr(0, parlen);
2633         if (isPatternString) {
2634                 missed = 0;
2635                 if (withformat) {
2636                         regex_f = identifyFeatures(result);
2637                         string features = "";
2638                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2639                                 string a = it->first;
2640                                 regex_with_format = true;
2641                                 features += " " + a;
2642                                 // LYXERR0("Identified regex format:" << a);
2643                         }
2644                         LYXERR(Debug::FIND, "Identified Features" << features);
2645
2646                 }
2647         } else if (regex_with_format) {
2648                 Features info = identifyFeatures(result);
2649                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2650                         string a = it->first;
2651                         bool b = it->second;
2652                         if (b && ! info[a]) {
2653                                 missed++;
2654                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2655                                 return "";
2656                         }
2657                 }
2658         }
2659         else {
2660                 // LYXERR0("No regex formats");
2661         }
2662         return result;
2663 }
2664
2665
2666 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2667 static int identifyClosing(string & t)
2668 {
2669         int open_braces = 0;
2670         do {
2671                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2672                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2673                         continue;
2674                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2675                         continue;
2676                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2677                         continue;
2678                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2679                         ++open_braces;
2680                         continue;
2681                 }
2682                 break;
2683         } while (true);
2684         return open_braces;
2685 }
2686
2687 static int num_replaced = 0;
2688 static bool previous_single_replace = true;
2689
2690 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2691         : p_buf(&buf), p_first_buf(&buf), opt(opt)
2692 {
2693         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2694         docstring const & ds = stringifySearchBuffer(find_buf, opt);
2695         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2696         if (opt.replace_all && previous_single_replace) {
2697                 previous_single_replace = false;
2698                 num_replaced = 0;
2699         }
2700         else if (!opt.replace_all) {
2701                 num_replaced = 0;       // count number of replaced strings
2702                 previous_single_replace = true;
2703         }
2704         // When using regexp, braces are hacked already by escape_for_regex()
2705         par_as_string = normalize(ds, !use_regexp);
2706         open_braces = 0;
2707         close_wildcards = 0;
2708
2709         size_t lead_size = 0;
2710         // correct the language settings
2711         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2712         if (opt.ignoreformat) {
2713                 if (!use_regexp) {
2714                         // if par_as_string_nolead were emty,
2715                         // the following call to findAux will always *find* the string
2716                         // in the checked data, and thus always using the slow
2717                         // examining of the current text part.
2718                         par_as_string_nolead = par_as_string;
2719                 }
2720         } else {
2721                 lead_size = identifyLeading(par_as_string);
2722                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2723                 lead_as_string = par_as_string.substr(0, lead_size);
2724                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2725         }
2726
2727         if (!use_regexp) {
2728                 open_braces = identifyClosing(par_as_string);
2729                 identifyClosing(par_as_string_nolead);
2730                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2731                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2732         } else {
2733                 string lead_as_regexp;
2734                 if (lead_size > 0) {
2735                         // @todo No need to search for \regexp{} insets in leading material
2736                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2737                         par_as_string = par_as_string_nolead;
2738                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2739                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2740                 }
2741                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2742                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2743                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2744                 if (
2745                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2746                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2747                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2748                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2749                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2750                         || regex_replace(par_as_string, par_as_string,
2751                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2752                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2753                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2754                         ) {
2755                         ++close_wildcards;
2756                 }
2757                 if (!opt.ignoreformat) {
2758                         // Remove extra '\}' at end if not part of \{\.\}
2759                         size_t lng = par_as_string.size();
2760                         while(lng > 2) {
2761                                 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
2762                                         if (lng >= 6) {
2763                                                 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
2764                                                         break;
2765                                         }
2766                                         lng -= 2;
2767                                         open_braces++;
2768                                 }
2769                                 else
2770                                         break;
2771                         }
2772                         if (lng < par_as_string.size())
2773                                 par_as_string = par_as_string.substr(0,lng);
2774                         /*
2775                         // save '\.'
2776                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2777                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2778                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2779                         // replace '[^...]' with '[^...\}\{\\]'
2780                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2781                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2782                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2783                         // restore '\.'
2784                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2785                         */
2786                 }
2787                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2788                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2789                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
2790                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2791
2792                 // If entered regexp must match at begin of searched string buffer
2793                 // Kornel: Added parentheses to use $1 for size of the leading string
2794                 string regexp_str;
2795                 string regexp2_str;
2796                 {
2797                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2798                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
2799                         // so the convert has no effect in that case
2800                         for (int i = 8; i > 0; --i) {
2801                                 string orig = "\\\\" + std::to_string(i);
2802                                 string dest = "\\" + std::to_string(i+1);
2803                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
2804                         }
2805                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2806                         regexp2_str = "(" + lead_as_regexp + ").*?" + par_as_string;
2807                 }
2808                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2809                 regexp = lyx::regex(regexp_str);
2810
2811                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2812                 regexp2 = lyx::regex(regexp2_str);
2813         }
2814 }
2815
2816
2817 // Count number of characters in string
2818 // {]} ==> 1
2819 // \&  ==> 1
2820 // --- ==> 1
2821 // \\[a-zA-Z]+ ==> 1
2822 static int computeSize(string s, int len)
2823 {
2824         if (len == 0)
2825                 return 0;
2826         int skip = 1;
2827         int count = 0;
2828         for (int i = 0; i < len; i += skip, count++) {
2829                 if (s[i] == '\\') {
2830                         skip = 2;
2831                         if (isalpha(s[i+1])) {
2832                                 for (int j = 2;  i+j < len; j++) {
2833                                         if (! isalpha(s[i+j])) {
2834                                                 if (s[i+j] == ' ')
2835                                                         skip++;
2836                                                 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2837                                                         skip += 2;
2838                                                 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2839                                                         skip++;
2840                                                 break;
2841                                         }
2842                                         skip++;
2843                                 }
2844                         }
2845                 }
2846                 else if (s[i] == '{') {
2847                         if (s[i+1] == '}')
2848                                 skip = 2;
2849                         else
2850                                 skip = 3;
2851                 }
2852                 else if (s[i] == '-') {
2853                         if (s[i+1] == '-') {
2854                                 if (s[i+2] == '-')
2855                                         skip = 3;
2856                                 else
2857                                         skip = 2;
2858                         }
2859                         else
2860                                 skip = 1;
2861                 }
2862                 else {
2863                         skip = 1;
2864                 }
2865         }
2866         return count;
2867 }
2868
2869 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2870 {
2871         MatchResult mres;
2872
2873         if (at_begin &&
2874                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2875                 return mres;
2876
2877         docstring docstr = stringifyFromForSearch(opt, cur, len);
2878         string str = normalize(docstr, true);
2879         if (!opt.ignoreformat) {
2880                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2881         }
2882         if (str.empty()) {
2883                 mres.match_len = -1;
2884                 return mres;
2885         }
2886         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2887         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2888
2889         if (use_regexp) {
2890                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2891                 regex const *p_regexp;
2892                 regex_constants::match_flag_type flags;
2893                 if (at_begin) {
2894                         flags = regex_constants::match_continuous;
2895                         p_regexp = &regexp;
2896                 } else {
2897                         flags = regex_constants::match_default;
2898                         p_regexp = &regexp2;
2899                 }
2900                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2901                 if (re_it == sregex_iterator())
2902                         return mres;
2903                 match_results<string::const_iterator> const & m = *re_it;
2904
2905                 if (0) { // Kornel Benko: DO NOT CHECKK
2906                         // Check braces on the segment that matched the entire regexp expression,
2907                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2908                         if (!braces_match(m[0].first, m[0].second, open_braces))
2909                                 return mres;
2910                 }
2911
2912                 // Check braces on segments that matched all (.*?) subexpressions,
2913                 // except the last "padding" one inserted by lyx.
2914                 for (size_t i = 1; i < m.size() - 1; ++i)
2915                         if (!braces_match(m[i].first, m[i].second, open_braces))
2916                                 return mres;
2917
2918                 // Exclude from the returned match length any length
2919                 // due to close wildcards added at end of regexp
2920                 // and also the length of the leading (e.g. '\emph{}')
2921                 //
2922                 // Whole found string, including the leading: m[0].second - m[0].first
2923                 // Size of the leading string: m[1].second - m[1].first
2924                 int leadingsize = 0;
2925                 if (m.size() > 1)
2926                         leadingsize = m[1].second - m[1].first;
2927                 int result;
2928                 for (size_t i = 0; i < m.size(); i++) {
2929                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2930                 }
2931                 if (close_wildcards == 0)
2932                         result = m[0].second - m[0].first;
2933
2934                 else
2935                         result =  m[m.size() - close_wildcards].first - m[0].first;
2936
2937                 size_t pos = m.position(size_t(0));
2938                 // Ignore last closing characters
2939                 while (result > 0) {
2940                         if (str[pos+result-1] == '}')
2941                                 --result;
2942                         else
2943                                 break;
2944                 }
2945                 if (result > leadingsize)
2946                         result -= leadingsize;
2947                 else
2948                         result = 0;
2949                 mres.match_len = computeSize(str.substr(pos+leadingsize,result), result);
2950                 mres.match2end = str.size() - pos - leadingsize;
2951                 mres.pos = pos+leadingsize;
2952                 return mres;
2953         }
2954
2955         // else !use_regexp: but all code paths above return
2956         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2957                                  << par_as_string << "', str='" << str << "'");
2958         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2959                                  << lead_as_string << "', par_as_string_nolead='"
2960                                  << par_as_string_nolead << "'");
2961
2962         if (at_begin) {
2963                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2964                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2965                 if (str.substr(0, par_as_string.size()) == par_as_string) {
2966                         mres.match_len = par_as_string.size();
2967                         mres.match2end = str.size();
2968                         mres.pos = 0;
2969                         return mres;
2970                 }
2971         } else {
2972                 // Start the search _after_ the leading part
2973                 size_t pos = str.find(par_as_string_nolead, lead_as_string.size());
2974                 if (pos != string::npos) {
2975                         mres.match_len = par_as_string.size();
2976                         mres.match2end = str.size() - pos;
2977                         mres.pos = pos;
2978                         return mres;
2979                 }
2980         }
2981         return mres;
2982 }
2983
2984
2985 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2986 {
2987         MatchResult mres = findAux(cur, len, at_begin);
2988         int res = mres.match_len;
2989         LYXERR(Debug::FIND,
2990                "res=" << res << ", at_begin=" << at_begin
2991                << ", matchword=" << opt.matchword
2992                << ", inTexted=" << cur.inTexted());
2993         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2994                 return mres;
2995         if ((len > 0) && (res < len)) {
2996           mres.match_len = 0;
2997           return mres;
2998         }
2999         Paragraph const & par = cur.paragraph();
3000         bool ws_left = (cur.pos() > 0)
3001                 ? par.isWordSeparator(cur.pos() - 1)
3002                 : true;
3003         bool ws_right = (cur.pos() + len < par.size())
3004                 ? par.isWordSeparator(cur.pos() + len)
3005                 : true;
3006         LYXERR(Debug::FIND,
3007                "cur.pos()=" << cur.pos() << ", res=" << res
3008                << ", separ: " << ws_left << ", " << ws_right
3009                << ", len: " << len
3010                << endl);
3011         if (ws_left && ws_right) {
3012           // Check for word separators inside the found 'word'
3013           for (int i = 0; i < len; i++) {
3014             if (par.isWordSeparator(cur.pos() + i)) {
3015               mres.match_len = 0;
3016               return mres;
3017             }
3018           }
3019           return mres;
3020         }
3021         mres.match_len = 0;
3022         return mres;
3023 }
3024
3025
3026 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
3027 {
3028         string t;
3029         if (! opt.casesensitive)
3030                 t = lyx::to_utf8(lowercase(s));
3031         else
3032                 t = lyx::to_utf8(s);
3033         // Remove \n at begin
3034         while (!t.empty() && t[0] == '\n')
3035                 t = t.substr(1);
3036         // Remove \n at end
3037         while (!t.empty() && t[t.size() - 1] == '\n')
3038                 t = t.substr(0, t.size() - 1);
3039         size_t pos;
3040         // Handle all other '\n'
3041         while ((pos = t.find("\n")) != string::npos) {
3042                 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
3043                         // Handle '\\\n'
3044                         if (isAlnumASCII(t[pos+1])) {
3045                                 t.replace(pos-2, 3, " ");
3046                         }
3047                         else {
3048                                 t.replace(pos-2, 3, "");
3049                         }
3050                 }
3051                 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
3052                         // '\n' adjacent to non-alpha-numerics, discard
3053                         t.replace(pos, 1, "");
3054                 }
3055                 else {
3056                         // Replace all other \n with spaces
3057                         t.replace(pos, 1, " ");
3058                 }
3059         }
3060         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
3061         // Kornel: Added textsl, textsf, textit, texttt and noun
3062         // + allow to seach for colored text too
3063         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
3064         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
3065                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3066         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3067                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3068
3069         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3070         // FIXME - check what preceeds the brace
3071         if (hack_braces) {
3072                 if (opt.ignoreformat)
3073                         while (regex_replace(t, t, "\\{", "_x_<")
3074                                || regex_replace(t, t, "\\}", "_x_>"))
3075                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3076                 else
3077                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
3078                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
3079                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3080         }
3081
3082         return t;
3083 }
3084
3085
3086 docstring stringifyFromCursor(DocIterator const & cur, int len)
3087 {
3088         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3089         if (cur.inTexted()) {
3090                 Paragraph const & par = cur.paragraph();
3091                 // TODO what about searching beyond/across paragraph breaks ?
3092                 // TODO Try adding a AS_STR_INSERTS as last arg
3093                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3094                         int(par.size()) : cur.pos() + len;
3095                 // OutputParams runparams(&cur.buffer()->params().encoding());
3096                 OutputParams runparams(encodings.fromLyXName("utf8"));
3097                 runparams.nice = true;
3098                 runparams.flavor = OutputParams::XETEX;
3099                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3100                 // No side effect of file copying and image conversion
3101                 runparams.dryrun = true;
3102                 runparams.for_search = true;
3103                 LYXERR(Debug::FIND, "Stringifying with cur: "
3104                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
3105                 return par.asString(cur.pos(), end,
3106                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3107                         &runparams);
3108         } else if (cur.inMathed()) {
3109                 CursorSlice cs = cur.top();
3110                 MathData md = cs.cell();
3111                 MathData::const_iterator it_end =
3112                         (( len == -1 || cs.pos() + len > int(md.size()))
3113                          ? md.end()
3114                          : md.begin() + cs.pos() + len );
3115                 MathData md2;
3116                 for (MathData::const_iterator it = md.begin() + cs.pos();
3117                      it != it_end; ++it)
3118                         md2.push_back(*it);
3119                 docstring s = asString(md2);
3120                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3121                 return s;
3122         }
3123         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3124         return docstring();
3125 }
3126
3127
3128 /** Computes the LaTeX export of buf starting from cur and ending len positions
3129  * after cur, if len is positive, or at the paragraph or innermost inset end
3130  * if len is -1.
3131  */
3132 docstring latexifyFromCursor(DocIterator const & cur, int len)
3133 {
3134         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3135         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3136                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3137         Buffer const & buf = *cur.buffer();
3138
3139         odocstringstream ods;
3140         otexstream os(ods);
3141         //OutputParams runparams(&buf.params().encoding());
3142         OutputParams runparams(encodings.fromLyXName("utf8"));
3143         runparams.nice = false;
3144         runparams.flavor = OutputParams::XETEX;
3145         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3146         // No side effect of file copying and image conversion
3147         runparams.dryrun = true;
3148         runparams.for_search = true;
3149
3150         if (cur.inTexted()) {
3151                 // @TODO what about searching beyond/across paragraph breaks ?
3152                 pos_type endpos = cur.paragraph().size();
3153                 if (len != -1 && endpos > cur.pos() + len)
3154                         endpos = cur.pos() + len;
3155                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3156                           string(), cur.pos(), endpos);
3157                 string s = lyx::to_utf8(ods.str());
3158                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3159                 return(lyx::from_utf8(s));
3160         } else if (cur.inMathed()) {
3161                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3162                 for (int s = cur.depth() - 1; s >= 0; --s) {
3163                         CursorSlice const & cs = cur[s];
3164                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3165                                 WriteStream ws(os);
3166                                 cs.asInsetMath()->asHullInset()->header_write(ws);
3167                                 break;
3168                         }
3169                 }
3170
3171                 CursorSlice const & cs = cur.top();
3172                 MathData md = cs.cell();
3173                 MathData::const_iterator it_end =
3174                         ((len == -1 || cs.pos() + len > int(md.size()))
3175                          ? md.end()
3176                          : md.begin() + cs.pos() + len);
3177                 MathData md2;
3178                 for (MathData::const_iterator it = md.begin() + cs.pos();
3179                      it != it_end; ++it)
3180                         md2.push_back(*it);
3181
3182                 ods << asString(md2);
3183                 // Retrieve the math environment type, and add '$' or '$]'
3184                 // or others (\end{equation}) accordingly
3185                 for (int s = cur.depth() - 1; s >= 0; --s) {
3186                         CursorSlice const & cs2 = cur[s];
3187                         InsetMath * inset = cs2.asInsetMath();
3188                         if (inset && inset->asHullInset()) {
3189                                 WriteStream ws(os);
3190                                 inset->asHullInset()->footer_write(ws);
3191                                 break;
3192                         }
3193                 }
3194                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3195         } else {
3196                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3197         }
3198         return ods.str();
3199 }
3200
3201
3202 /** Finalize an advanced find operation, advancing the cursor to the innermost
3203  ** position that matches, plus computing the length of the matching text to
3204  ** be selected
3205  **/
3206 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
3207 {
3208         // Search the foremost position that matches (avoids find of entire math
3209         // inset when match at start of it)
3210         size_t d;
3211         DocIterator old_cur(cur.buffer());
3212         do {
3213                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
3214                 d = cur.depth();
3215                 old_cur = cur;
3216                 cur.forwardPos();
3217         } while (cur && cur.depth() > d && match(cur).match_len > 0);
3218         cur = old_cur;
3219         int max_match = match(cur).match_len;     /* match valid only if not searching whole words */
3220         if (max_match <= 0) return 0;
3221         LYXERR(Debug::FIND, "Ok");
3222
3223         // Compute the match length
3224         int len = 1;
3225         if (cur.pos() + len > cur.lastpos())
3226           return 0;
3227         if (match.opt.matchword) {
3228           LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3229           while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3230             ++len;
3231             LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3232           }
3233           // Length of matched text (different from len param)
3234           int old_match = match(cur, len).match_len;
3235           if (old_match < 0)
3236             old_match = 0;
3237           int new_match;
3238           // Greedy behaviour while matching regexps
3239           while ((new_match = match(cur, len + 1).match_len) > old_match) {
3240             ++len;
3241             old_match = new_match;
3242             LYXERR(Debug::FIND, "verifying   match with len = " << len);
3243           }
3244           if (old_match == 0)
3245             len = 0;
3246         }
3247         else {
3248           int minl = 1;
3249           int maxl = cur.lastpos() - cur.pos();
3250           // Greedy behaviour while matching regexps
3251           while (maxl > minl) {
3252             int actual_match = match(cur, len).match_len;
3253             if (actual_match >= max_match) {
3254               // actual_match > max_match _can_ happen,
3255               // if the search area splits
3256               // some following word so that the regex
3257               // (e.g. 'r.*r\b' matches 'r' from the middle of the
3258               // splitted word)
3259               // This means, the len value is too big
3260               maxl = len;
3261               len = (int)((maxl + minl)/2);
3262             }
3263             else {
3264               // (actual_match < max_match)
3265               minl = len + 1;
3266               len = (int)((maxl + minl)/2);
3267             }
3268           }
3269           old_cur = cur;
3270           // Search for real start of matched characters
3271           while (len > 1) {
3272             int actual_match;
3273             do {
3274               cur.forwardPos();
3275             } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3276             if (cur.depth() < old_cur.depth()) {
3277               // Outer inset?
3278               LYXERR0("cur.depth() < old_cur.depth(), this should never happen");
3279               break;
3280             }
3281             if (cur.pos() != old_cur.pos()) {
3282               // OK, forwarded 1 pos in actual inset
3283               actual_match = match(cur, len-1).match_len;
3284               if (actual_match == max_match) {
3285                 // Ha, got it! The shorter selection has the same match length
3286                 len--;
3287                 old_cur = cur;
3288               }
3289               else {
3290                 // OK, the shorter selection matches less chars, revert to previous value
3291                 cur = old_cur;
3292                 break;
3293               }
3294             }
3295             else {
3296               LYXERR0("cur.pos() == old_cur.pos(), this should never happen");
3297               actual_match = match(cur, len).match_len;
3298               if (actual_match == max_match)
3299                 old_cur = cur;
3300             }
3301           }
3302         }
3303         return len;
3304 }
3305
3306
3307 /// Finds forward
3308 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
3309 {
3310         if (!cur)
3311                 return 0;
3312         while (!theApp()->longOperationCancelled() && cur) {
3313                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3314                 MatchResult mres = match(cur, -1, false);
3315                 int match_len = mres.match_len;
3316                 LYXERR(Debug::FIND, "match_len: " << match_len);
3317                 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3318                         LYXERR0("BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3319                         match_len = 0;
3320                 }
3321                 if (match_len > 0) {
3322                         // Try to find the begin of searched string
3323                         int increment = mres.pos/2;
3324                         while (mres.pos > 5 && (increment > 5)) {
3325                                 DocIterator old_cur = cur;
3326                                 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3327                                 }
3328                                 if (! cur || (cur.pit() > old_cur.pit())) {
3329                                         // Are we outside of the paragraph?
3330                                         // This can happen if moving past some UTF8-encoded chars
3331                                         cur = old_cur;
3332                                         increment /= 2;
3333                                 }
3334                                 else {
3335                                         MatchResult mres2 = match(cur, -1, false);
3336                                         if ((mres2.match2end < mres.match2end) ||
3337                                           (mres2.match_len < mres.match_len)) {
3338                                                 cur = old_cur;
3339                                                 increment /= 2;
3340                                         }
3341                                         else {
3342                                                 mres = mres2;
3343                                                 increment -= 2;
3344                                                 if (increment > mres.pos/2)
3345                                                         increment = mres.pos/2;
3346                                         }
3347                                 }
3348                         }
3349                         int match_len_zero_count = 0;
3350                         for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3351                                 if (i++ > 10) {
3352                                         int remaining_len = match(cur, -1, false).match_len;
3353                                         if (remaining_len <= 0) {
3354                                                 // Apparently the searched string is not in the remaining part
3355                                                 break;
3356                                         }
3357                                         else {
3358                                                 i = 0;
3359                                         }
3360                                 }
3361                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3362                                 int match_len3 = match(cur, 1).match_len;
3363                                 if (match_len3 < 0)
3364                                         continue;
3365                                 int match_len2 = match(cur).match_len;
3366                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3367                                 if (match_len2 > 0) {
3368                                         // Sometimes in finalize we understand it wasn't a match
3369                                         // and we need to continue the outest loop
3370                                         int len = findAdvFinalize(cur, match);
3371                                         if (len > 0) {
3372                                                 return len;
3373                                         }
3374                                 }
3375                                 if (match_len2 >= 0) {
3376                                         if (match_len2 == 0)
3377                                                 match_len_zero_count++;
3378                                         else
3379                                                 match_len_zero_count = 0;
3380                                 }
3381                                 else {
3382                                         if (++match_len_zero_count > 3) {
3383                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3384                                                 match_len_zero_count = 0;
3385                                         }
3386                                         break;
3387                                 }
3388                         }
3389                         if (!cur)
3390                                 return 0;
3391                 }
3392                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3393                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3394                         cur.forwardPar();
3395                 } else {
3396                         // This should exit nested insets, if any, or otherwise undefine the currsor.
3397                         cur.pos() = cur.lastpos();
3398                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3399                         cur.forwardPos();
3400                 }
3401         }
3402         return 0;
3403 }
3404
3405
3406 /// Find the most backward consecutive match within same paragraph while searching backwards.
3407 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3408 {
3409         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3410         DocIterator tmp_cur = cur;
3411         int len = findAdvFinalize(tmp_cur, match);
3412         Inset & inset = cur.inset();
3413         for (; cur != cur_begin; cur.backwardPos()) {
3414                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3415                 DocIterator new_cur = cur;
3416                 new_cur.backwardPos();
3417                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3418                         break;
3419                 int new_len = findAdvFinalize(new_cur, match);
3420                 if (new_len == len)
3421                         break;
3422                 len = new_len;
3423         }
3424         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3425         return len;
3426 }
3427
3428
3429 /// Finds backwards
3430 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3431 {
3432         if (! cur)
3433                 return 0;
3434         // Backup of original position
3435         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3436         if (cur == cur_begin)
3437                 return 0;
3438         cur.backwardPos();
3439         DocIterator cur_orig(cur);
3440         bool pit_changed = false;
3441         do {
3442                 cur.pos() = 0;
3443                 bool found_match = (match(cur, -1, false).match_len > 0);
3444
3445                 if (found_match) {
3446                         if (pit_changed)
3447                                 cur.pos() = cur.lastpos();
3448                         else
3449                                 cur.pos() = cur_orig.pos();
3450                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
3451                         DocIterator cur_prev_iter;
3452                         do {
3453                                 found_match = (match(cur).match_len > 0);
3454                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
3455                                        << found_match << ", cur: " << cur);
3456                                 if (found_match)
3457                                         return findMostBackwards(cur, match);
3458
3459                                 // Stop if begin of document reached
3460                                 if (cur == cur_begin)
3461                                         break;
3462                                 cur_prev_iter = cur;
3463                                 cur.backwardPos();
3464                         } while (true);
3465                 }
3466                 if (cur == cur_begin)
3467                         break;
3468                 if (cur.pit() > 0)
3469                         --cur.pit();
3470                 else
3471                         cur.backwardPos();
3472                 pit_changed = true;
3473         } while (!theApp()->longOperationCancelled());
3474         return 0;
3475 }
3476
3477
3478 } // namespace
3479
3480
3481 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
3482                                  DocIterator const & cur, int len)
3483 {
3484         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
3485                 return docstring();
3486         if (!opt.ignoreformat)
3487                 return latexifyFromCursor(cur, len);
3488         else
3489                 return stringifyFromCursor(cur, len);
3490 }
3491
3492
3493 FindAndReplaceOptions::FindAndReplaceOptions(
3494         docstring const & find_buf_name, bool casesensitive,
3495         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
3496         docstring const & repl_buf_name, bool keep_case,
3497         SearchScope scope, SearchRestriction restr, bool replace_all)
3498         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
3499           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
3500           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr), replace_all(replace_all)
3501 {
3502 }
3503
3504
3505 namespace {
3506
3507
3508 /** Check if 'len' letters following cursor are all non-lowercase */
3509 static bool allNonLowercase(Cursor const & cur, int len)
3510 {
3511         pos_type beg_pos = cur.selectionBegin().pos();
3512         pos_type end_pos = cur.selectionBegin().pos() + len;
3513         if (len > cur.lastpos() + 1 - beg_pos) {
3514                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
3515                 len = cur.lastpos() + 1 - beg_pos;
3516                 end_pos = beg_pos + len;
3517         }
3518         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
3519                 if (isLowerCase(cur.paragraph().getChar(pos)))
3520                         return false;
3521         return true;
3522 }
3523
3524
3525 /** Check if first letter is upper case and second one is lower case */
3526 static bool firstUppercase(Cursor const & cur)
3527 {
3528         char_type ch1, ch2;
3529         pos_type pos = cur.selectionBegin().pos();
3530         if (pos >= cur.lastpos() - 1) {
3531                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
3532                 return false;
3533         }
3534         ch1 = cur.paragraph().getChar(pos);
3535         ch2 = cur.paragraph().getChar(pos + 1);
3536         bool result = isUpperCase(ch1) && isLowerCase(ch2);
3537         LYXERR(Debug::FIND, "firstUppercase(): "
3538                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
3539                << ch2 << "(" << char(ch2) << ")"
3540                << ", result=" << result << ", cur=" << cur);
3541         return result;
3542 }
3543
3544
3545 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
3546  **
3547  ** \fixme What to do with possible further paragraphs in replace buffer ?
3548  **/
3549 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
3550 {
3551         ParagraphList::iterator pit = buffer.paragraphs().begin();
3552         LASSERT(pit->size() >= 1, /**/);
3553         pos_type right = pos_type(1);
3554         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
3555         right = pit->size();
3556         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
3557 }
3558
3559 } // namespace
3560
3561 ///
3562 static int findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
3563 {
3564         Cursor & cur = bv->cursor();
3565         if (opt.repl_buf_name == docstring()
3566             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
3567             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3568                 return 0;
3569
3570         DocIterator sel_beg = cur.selectionBegin();
3571         DocIterator sel_end = cur.selectionEnd();
3572         if (&sel_beg.inset() != &sel_end.inset()
3573             || sel_beg.pit() != sel_end.pit()
3574             || sel_beg.idx() != sel_end.idx())
3575                 return 0;
3576         int sel_len = sel_end.pos() - sel_beg.pos();
3577         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
3578                << ", sel_len: " << sel_len << endl);
3579         if (sel_len == 0)
3580                 return 0;
3581         LASSERT(sel_len > 0, return 0);
3582
3583         if (!matchAdv(sel_beg, sel_len).match_len)
3584                 return 0;
3585
3586         // Build a copy of the replace buffer, adapted to the KeepCase option
3587         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
3588         ostringstream oss;
3589         repl_buffer_orig.write(oss);
3590         string lyx = oss.str();
3591         Buffer repl_buffer("", false);
3592         repl_buffer.setUnnamed(true);
3593         LASSERT(repl_buffer.readString(lyx), return 0);
3594         if (opt.keep_case && sel_len >= 2) {
3595                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
3596                 if (cur.inTexted()) {
3597                         if (firstUppercase(cur))
3598                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3599                         else if (allNonLowercase(cur, sel_len))
3600                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3601                 }
3602         }
3603         cap::cutSelection(cur, false);
3604         if (cur.inTexted()) {
3605                 repl_buffer.changeLanguage(
3606                         repl_buffer.language(),
3607                         cur.getFont().language());
3608                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3609                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3610                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3611                                         repl_buffer.params().documentClassPtr(),
3612                                         bv->buffer().errorList("Paste"));
3613                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3614                 sel_len = repl_buffer.paragraphs().begin()->size();
3615         } else if (cur.inMathed()) {
3616                 odocstringstream ods;
3617                 otexstream os(ods);
3618                 // OutputParams runparams(&repl_buffer.params().encoding());
3619                 OutputParams runparams(encodings.fromLyXName("utf8"));
3620                 runparams.nice = false;
3621                 runparams.flavor = OutputParams::XETEX;
3622                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3623                 runparams.dryrun = true;
3624                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3625                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3626                 docstring repl_latex = ods.str();
3627                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3628                 string s;
3629                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3630                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3631                 repl_latex = from_utf8(s);
3632                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3633                 MathData ar(cur.buffer());
3634                 asArray(repl_latex, ar, Parse::NORMAL);
3635                 cur.insert(ar);
3636                 sel_len = ar.size();
3637                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3638         }
3639         if (cur.pos() >= sel_len)
3640                 cur.pos() -= sel_len;
3641         else
3642                 cur.pos() = 0;
3643         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3644         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3645         bv->processUpdateFlags(Update::Force);
3646         return 1;
3647 }
3648
3649
3650 /// Perform a FindAdv operation.
3651 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3652 {
3653         DocIterator cur;
3654         int match_len = 0;
3655
3656         // e.g., when invoking word-findadv from mini-buffer wither with
3657         //       wrong options syntax or before ever opening advanced F&R pane
3658         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3659                 return false;
3660
3661         try {
3662                 MatchStringAdv matchAdv(bv->buffer(), opt);
3663                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3664                 if (length > 0)
3665                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3666                 num_replaced += findAdvReplace(bv, opt, matchAdv);
3667                 cur = bv->cursor();
3668                 if (opt.forward)
3669                         match_len = findForwardAdv(cur, matchAdv);
3670                 else
3671                         match_len = findBackwardsAdv(cur, matchAdv);
3672         } catch (...) {
3673                 // This may only be raised by lyx::regex()
3674                 bv->message(_("Invalid regular expression!"));
3675                 return false;
3676         }
3677
3678         if (match_len == 0) {
3679                 if (num_replaced > 0) {
3680                         switch (num_replaced)
3681                         {
3682                                 case 1:
3683                                         bv->message(_("One match has been replaced."));
3684                                         break;
3685                                 case 2:
3686                                         bv->message(_("Two matches have been replaced."));
3687                                         break;
3688                                 default:
3689                                         bv->message(bformat(_("%1$d matches have been replaced."), num_replaced));
3690                                         break;
3691                         }
3692                         num_replaced = 0;
3693                 }
3694                 else {
3695                         bv->message(_("Match not found."));
3696                 }
3697                 return false;
3698         }
3699
3700         if (num_replaced > 0)
3701                 bv->message(_("Match has been replaced."));
3702         else
3703                 bv->message(_("Match found."));
3704
3705         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3706         bv->putSelectionAt(cur, match_len, !opt.forward);
3707
3708         return true;
3709 }
3710
3711
3712 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3713 {
3714         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3715            << opt.casesensitive << ' '
3716            << opt.matchword << ' '
3717            << opt.forward << ' '
3718            << opt.expandmacros << ' '
3719            << opt.ignoreformat << ' '
3720            << opt.replace_all << ' '
3721            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3722            << opt.keep_case << ' '
3723            << int(opt.scope) << ' '
3724            << int(opt.restr);
3725
3726         LYXERR(Debug::FIND, "built: " << os.str());
3727
3728         return os;
3729 }
3730
3731
3732 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3733 {
3734         LYXERR(Debug::FIND, "parsing");
3735         string s;
3736         string line;
3737         getline(is, line);
3738         while (line != "EOSS") {
3739                 if (! s.empty())
3740                         s = s + "\n";
3741                 s = s + line;
3742                 if (is.eof())   // Tolerate malformed request
3743                         break;
3744                 getline(is, line);
3745         }
3746         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3747         opt.find_buf_name = from_utf8(s);
3748         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.replace_all;
3749         is.get();       // Waste space before replace string
3750         s = "";
3751         getline(is, line);
3752         while (line != "EOSS") {
3753                 if (! s.empty())
3754                         s = s + "\n";
3755                 s = s + line;
3756                 if (is.eof())   // Tolerate malformed request
3757                         break;
3758                 getline(is, line);
3759         }
3760         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3761         opt.repl_buf_name = from_utf8(s);
3762         is >> opt.keep_case;
3763         int i;
3764         is >> i;
3765         opt.scope = FindAndReplaceOptions::SearchScope(i);
3766         is >> i;
3767         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3768
3769         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3770                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3771                << opt.scope << ' ' << opt.restr);
3772         return is;
3773 }
3774
3775 } // namespace lyx