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 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 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 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) :
1117   isPatternString(isPattern),
1118     ignoreidx(-1),
1119     actualdeptindex(0) { depts[0] = 0; closes[0] = 0;};
1120   string par;
1121   int ignoreidx;
1122   int depts[MAXOPENED];
1123   int closes[MAXOPENED];
1124   int actualdeptindex;
1125   Border borders[2*MAXOPENED];
1126   int previousNotIgnored(int);
1127   int nextNotIgnored(int);
1128   void handleOpenP(int i);
1129   void handleCloseP(int i, bool closingAllowed);
1130   void resetOpenedP(int openPos);
1131   void addIntervall(int upper);
1132   void addIntervall(int low, int upper); /* if explicit */
1133   void removeAccents();
1134   void setForDefaultLang(KeyInfo &defLang);
1135   int findclosing(int start, int end, char up, char down, int repeat);
1136   void handleParentheses(int lastpos, bool closingAllowed);
1137   bool hasTitle;
1138   int isOpeningPar(int pos);
1139   string titleValue;
1140   void output(ostringstream &os, int lastpos);
1141   // string show(int lastpos);
1142 };
1143
1144 int Intervall::isOpeningPar(int pos)
1145 {
1146   if ((pos < 0) || (size_t(pos) >= par.size()))
1147     return 0;
1148   if (par[pos] != '{')
1149     return 0;
1150   if (size_t(pos) + 2 >= par.size())
1151     return 1;
1152   if (par[pos+2] != '}')
1153     return 1;
1154   if (par[pos+1] == '[' || par[pos+1] == ']')
1155     return 3;
1156   return 1;
1157 }
1158
1159 void Intervall::setForDefaultLang(KeyInfo &defLang)
1160 {
1161   // Enable the use of first token again
1162   if (ignoreidx >= 0) {
1163     int value = defLang._tokenstart + defLang._tokensize;
1164     if (value > 0) {
1165       if (borders[0].low < value)
1166         borders[0].low = value;
1167       if (borders[0].upper < value)
1168         borders[0].upper = value;
1169     }
1170   }
1171 }
1172
1173 static void checkDepthIndex(int val)
1174 {
1175   static int maxdepthidx = MAXOPENED-2;
1176   if (val > maxdepthidx) {
1177     maxdepthidx = val;
1178     LYXERR0("maxdepthidx now " << val);
1179   }
1180 }
1181
1182 static void checkIgnoreIdx(int val)
1183 {
1184   static int maxignoreidx = 2*MAXOPENED - 4;
1185   if (val > maxignoreidx) {
1186     maxignoreidx = val;
1187     LYXERR0("maxignoreidx now " << val);
1188   }
1189 }
1190
1191 /*
1192  * Expand the region of ignored parts of the input latex string
1193  * The region is only relevant in output()
1194  */
1195 void Intervall::addIntervall(int low, int upper)
1196 {
1197   int idx;
1198   if (low == upper) return;
1199   for (idx = ignoreidx+1; idx > 0; --idx) {
1200     if (low > borders[idx-1].upper) {
1201       break;
1202     }
1203   }
1204   Border br(low, upper);
1205   if (idx > ignoreidx) {
1206     borders[idx] = br;
1207     ignoreidx = idx;
1208     checkIgnoreIdx(ignoreidx);
1209     return;
1210   }
1211   else {
1212     // Expand only if one of the new bound is inside the interwall
1213     // We know here that br.low > borders[idx-1].upper
1214     if (br.upper < borders[idx].low) {
1215       // We have to insert at this pos
1216       for (int i = ignoreidx+1; i > idx; --i) {
1217         borders[i] = borders[i-1];
1218       }
1219       borders[idx] = br;
1220       ignoreidx += 1;
1221       checkIgnoreIdx(ignoreidx);
1222       return;
1223     }
1224     // Here we know, that we are overlapping
1225     if (br.low > borders[idx].low)
1226       br.low = borders[idx].low;
1227     // check what has to be concatenated
1228     int count = 0;
1229     for (int i = idx; i <= ignoreidx; i++) {
1230       if (br.upper >= borders[i].low) {
1231         count++;
1232         if (br.upper < borders[i].upper)
1233           br.upper = borders[i].upper;
1234       }
1235       else {
1236         break;
1237       }
1238     }
1239     // count should be >= 1 here
1240     borders[idx] = br;
1241     if (count > 1) {
1242       for (int i = idx + count; i <= ignoreidx; i++) {
1243         borders[i-count+1] = borders[i];
1244       }
1245       ignoreidx -= count - 1;
1246       return;
1247     }
1248   }
1249 }
1250
1251 typedef map<string, string> AccentsMap;
1252 static AccentsMap accents = map<string, string>();
1253
1254 static void buildaccent(string n, string param, string values)
1255 {
1256   stringstream s(n);
1257   string name;
1258   const char delim = '|';
1259   while (getline(s, name, delim)) {
1260     size_t start = 0;
1261     for (size_t i = 0; i < param.size(); i++) {
1262       string key = name + "{" + param[i] + "}";
1263       // get the corresponding utf8-value
1264       if ((values[start] & 0xc0) != 0xc0) {
1265         // should not happen, utf8 encoding starts at least with 11xxxxxx
1266         // but value for '\dot{i}' is 'i', which is ascii
1267         if ((values[start] & 0x80) == 0) {
1268           // is ascii
1269           accents[key] = values.substr(start, 1);
1270         }
1271         start++;
1272         continue;
1273       }
1274       for (int j = 1; ;j++) {
1275         if (start + j >= values.size()) {
1276           accents[key] = values.substr(start, j);
1277           start = values.size() - 1;
1278           break;
1279         }
1280         else if ((values[start+j] & 0xc0) != 0x80) {
1281           // This is the first byte of following utf8 char
1282           accents[key] = values.substr(start, j);
1283           start += j;
1284           break;
1285         }
1286       }
1287     }
1288   }
1289 }
1290
1291 static void buildAccentsMap()
1292 {
1293   accents["imath"] = "ı";
1294   accents["i"] = "ı";
1295   accents["jmath"] = "ȷ";
1296   accents["lyxmathsym{ß}"] = "ß";
1297   accents["text{ß}"] = "ß";
1298   accents["ddot{\\imath}"] = "ï";
1299   buildaccent("ddot", "aAeEiIioOuUyY",
1300                       "äÄëËïÏïöÖüÜÿŸ");    // umlaut
1301   buildaccent("dot|.", "cCeEGgIizZaAoObBdDfFyY",
1302                        "ċĊėĖĠġİİżŻȧȦȯȮḃḂḋḊḟḞẏẎ"); // dot{i} can only happen if ignoring case, but there is no lowercase of 'İ'
1303   accents["acute{\\imath}"] = "í";
1304   buildaccent("acute", "aAcCeElLoOnNrRsSuUyYzZiI",
1305                        "áÁćĆéÉĺĹóÓńŃŕŔśŚúÚýÝźŹíÍ");
1306   buildaccent("dacute|H|h", "oOuU", "őŐűŰ");        // double acute
1307   buildaccent("mathring|r", "aAuUwy",
1308                             "åÅůŮẘẙ");  // ring
1309   accents["check{\\imath}"] = "ǐ";
1310   accents["check{\\jmath}"] = "ǰ";
1311   buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTtzZ",
1312                          "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤťžŽ");   // caron
1313   accents["hat{\\imath}"] = "î";
1314   accents["hat{\\jmath}"] = "ĵ";
1315   buildaccent("hat|^", "aAeEiIcCgGhHjJsSwWyYzZoOuU",
1316                        "âÂêÊîÎĉĈĝĜĥĤĵĴŝŜŵŴŷŶẑẐôÔûÛ");       // circ
1317   accents["bar{\\imath}"] = "ī";
1318   buildaccent("bar|=", "aAeEiIoOuUyY",
1319                        "āĀēĒīĪōŌūŪȳȲ");     // macron
1320   accents["tilde{\\imath}"] = "ĩ";
1321   buildaccent("tilde", "aAnNoOiIuU",
1322                        "ãÃñÑõÕĩĨũŨ"); // tilde
1323   accents["breve{\\imath}"] = "ĭ";
1324   buildaccent("breve|u", "aAeEgGiIoOuU",
1325                          "ăĂĕĔğĞĭĬŏŎŭŬ");    // breve
1326   accents["grave{\\imath}"] = "ì";
1327   buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1328                          "àÀèÈìÌòÒùÙǹǸẁẀỳỲ");   // grave
1329   buildaccent("subdot|d", "BbDdHhKkLlMmNnRrSsTtVvWwZzAaEeIiOoUuYy",
1330                           "ḄḅḌḍḤḥḲḳḶḷṂṃṆṇṚṛṢṣṬṭṾṿẈẉẒẓẠạẸẹỊịỌọỤụỴỵ");  // dot below
1331 }
1332
1333 /*
1334  * Created accents in math or regexp environment
1335  * are macros, but we need the utf8 equivalent
1336  */
1337 void Intervall::removeAccents()
1338 {
1339   if (accents.empty())
1340     buildAccentsMap();
1341   static regex const accre("\\\\((.|grave|breve|lyxmathsym|text|ddot|dot|acute|dacute|mathring|check|hat|bar|tilde|subdot)\\{[^\\{\\}]+\\}|(i|imath|jmath)(?![a-zA-Z]))");
1342   smatch sub;
1343   for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1344     sub = *itacc;
1345     string key = sub.str(1);
1346     if (accents.find(key) != accents.end()) {
1347       string val = accents[key];
1348       size_t pos = sub.position(0);
1349       for (size_t i = 0; i < val.size(); i++) {
1350         par[pos+i] = val[i];
1351       }
1352       addIntervall(pos+val.size(), pos + sub.str(0).size());
1353       for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1354         // remove traces of any remaining chars
1355         par[i] = ' ';
1356       }
1357     }
1358     else {
1359       LYXERR0("Not added accent for \"" << key << "\"");
1360     }
1361   }
1362 }
1363
1364 void Intervall::handleOpenP(int i)
1365 {
1366   actualdeptindex++;
1367   depts[actualdeptindex] = i+1;
1368   closes[actualdeptindex] = -1;
1369   checkDepthIndex(actualdeptindex);
1370 }
1371
1372 void Intervall::handleCloseP(int i, bool closingAllowed)
1373 {
1374   if (actualdeptindex <= 0) {
1375     if (! closingAllowed)
1376       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1377     // if we are at the very end
1378     addIntervall(i, i+1);
1379   }
1380   else {
1381     closes[actualdeptindex] = i+1;
1382     actualdeptindex--;
1383   }
1384 }
1385
1386 void Intervall::resetOpenedP(int openPos)
1387 {
1388   // Used as initializer for foreignlanguage entry
1389   actualdeptindex = 1;
1390   depts[1] = openPos+1;
1391   closes[1] = -1;
1392 }
1393
1394 int Intervall::previousNotIgnored(int start)
1395 {
1396     int idx = 0;                          /* int intervalls */
1397     for (idx = ignoreidx; idx >= 0; --idx) {
1398       if (start > borders[idx].upper)
1399         return start;
1400       if (start >= borders[idx].low)
1401         start = borders[idx].low-1;
1402     }
1403     return start;
1404 }
1405
1406 int Intervall::nextNotIgnored(int start)
1407 {
1408     int idx = 0;                          /* int intervalls */
1409     for (idx = 0; idx <= ignoreidx; idx++) {
1410       if (start < borders[idx].low)
1411         return start;
1412       if (start < borders[idx].upper)
1413         start = borders[idx].upper;
1414     }
1415     return start;
1416 }
1417
1418 typedef map<string, KeyInfo> KeysMap;
1419 typedef vector< KeyInfo> Entries;
1420 static KeysMap keys = map<string, KeyInfo>();
1421
1422 class LatexInfo {
1423  private:
1424   int entidx;
1425   Entries entries;
1426   Intervall interval;
1427   void buildKeys(bool);
1428   void buildEntries(bool);
1429   void makeKey(const string &, KeyInfo, bool isPatternString);
1430   void processRegion(int start, int region_end); /*  remove {} parts */
1431   void removeHead(KeyInfo&, int count=0);
1432
1433  public:
1434  LatexInfo(string par, bool isPatternString) : entidx(-1), interval(isPatternString) {
1435     interval.par = par;
1436     interval.hasTitle = false;
1437     interval.titleValue = "";
1438     buildKeys(isPatternString);
1439     entries = vector<KeyInfo>();
1440     buildEntries(isPatternString);
1441   };
1442   int getFirstKey() {
1443     entidx = 0;
1444     if (entries.empty()) {
1445       return (-1);
1446     }
1447     if (entries[0].keytype == KeyInfo::isTitle) {
1448       if (! entries[0].disabled) {
1449         interval.hasTitle = true;
1450         interval.titleValue = entries[0].head;
1451       }
1452       else {
1453         interval.hasTitle = false;
1454         interval.titleValue = "";
1455       }
1456       removeHead(entries[0]);
1457       if (entries.size() > 1)
1458         return (1);
1459       else
1460         return (-1);
1461     }
1462     return 0;
1463   };
1464   int getNextKey() {
1465     entidx++;
1466     if (int(entries.size()) > entidx) {
1467       return entidx;
1468     }
1469     else {
1470       return (-1);
1471     }
1472   };
1473   bool setNextKey(int idx) {
1474     if ((idx == entidx) && (entidx >= 0)) {
1475       entidx--;
1476       return true;
1477     }
1478     else
1479       return false;
1480   };
1481   int find(int start, KeyInfo::KeyType keytype) {
1482     if (start < 0)
1483       return (-1);
1484     int tmpIdx = start;
1485     while (tmpIdx < int(entries.size())) {
1486       if (entries[tmpIdx].keytype == keytype)
1487         return tmpIdx;
1488       tmpIdx++;
1489     }
1490     return(-1);
1491   };
1492   int process(ostringstream &os, KeyInfo &actual);
1493   int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1494   // string show(int lastpos) { return interval.show(lastpos);};
1495   int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1496   KeyInfo &getKeyInfo(int keyinfo) {
1497     static KeyInfo invalidInfo = KeyInfo();
1498     if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1499       return invalidInfo;
1500     else
1501       return entries[keyinfo];
1502   };
1503   void setForDefaultLang(KeyInfo &defLang) {interval.setForDefaultLang(defLang);};
1504   void addIntervall(int low, int up) { interval.addIntervall(low, up); };
1505 };
1506
1507
1508 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1509 {
1510   int skip = 0;
1511   int depth = 0;
1512   repeat--;
1513   for (int i = start; i < end; i += 1 + skip) {
1514     char c;
1515     c = par[i];
1516     skip = 0;
1517     if (c == '\\') skip = 1;
1518     else if (c == up) {
1519       depth++;
1520     }
1521     else if (c == down) {
1522       if (depth == 0) {
1523         if ((repeat <= 0) || (par[i+1] != up))
1524           return i;
1525       }
1526       --depth;
1527     }
1528   }
1529   return end;
1530 }
1531
1532 class MathInfo {
1533   class MathEntry {
1534   public:
1535     string wait;
1536     size_t mathEnd;
1537     size_t mathStart;
1538     size_t mathSize;
1539   };
1540   size_t actualIdx;
1541   vector<MathEntry> entries;
1542  public:
1543   MathInfo() {
1544     actualIdx = 0;
1545   }
1546   void insert(string wait, size_t start, size_t end) {
1547     MathEntry m = MathEntry();
1548     m.wait = wait;
1549     m.mathStart = start;
1550     m.mathEnd = end;
1551     m.mathSize = end - start;
1552     entries.push_back(m);
1553   }
1554   bool empty() { return entries.empty(); };
1555   size_t getEndPos() {
1556     if (entries.empty() || (actualIdx >= entries.size())) {
1557       return 0;
1558     }
1559     return entries[actualIdx].mathEnd;
1560   }
1561   size_t getStartPos() {
1562     if (entries.empty() || (actualIdx >= entries.size())) {
1563       return 100000;                    /*  definitely enough? */
1564     }
1565     return entries[actualIdx].mathStart;
1566   }
1567   size_t getFirstPos() {
1568     actualIdx = 0;
1569     return getStartPos();
1570   }
1571   size_t getSize() {
1572     if (entries.empty() || (actualIdx >= entries.size())) {
1573       return size_t(0);
1574     }
1575     return entries[actualIdx].mathSize;
1576   }
1577   void incrEntry() { actualIdx++; };
1578 };
1579
1580 void LatexInfo::buildEntries(bool isPatternString)
1581 {
1582   static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1583   static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1584   static bool disableLanguageOverride = false;
1585   smatch sub, submath;
1586   bool evaluatingRegexp = false;
1587   MathInfo mi;
1588   bool evaluatingMath = false;
1589   bool evaluatingCode = false;
1590   size_t codeEnd = 0;
1591   bool evaluatingOptional = false;
1592   size_t optionalEnd = 0;
1593   int codeStart = -1;
1594   KeyInfo found;
1595   bool math_end_waiting = false;
1596   size_t math_pos = 10000;
1597   string math_end;
1598
1599   interval.removeAccents();
1600
1601   for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1602     submath = *itmath;
1603     if (math_end_waiting) {
1604       size_t pos = submath.position(size_t(0));
1605       if ((math_end == "$") &&
1606           (submath.str(0) == "$") &&
1607           (interval.par[pos-1] != '\\')) {
1608         mi.insert("$", math_pos, pos + 1);
1609         math_end_waiting = false;
1610       }
1611       else if ((math_end == "\\]") &&
1612                (submath.str(0) == "\\]")) {
1613         mi.insert("\\]", math_pos, pos + 2);
1614         math_end_waiting = false;
1615       }
1616       else if ((submath.str(1).compare("end") == 0) &&
1617           (submath.str(2).compare(math_end) == 0)) {
1618         mi.insert(math_end, math_pos, pos + submath.str(0).length());
1619         math_end_waiting = false;
1620       }
1621       else
1622         continue;
1623     }
1624     else {
1625       if (submath.str(1).compare("begin") == 0) {
1626         math_end_waiting = true;
1627         math_end = submath.str(2);
1628         math_pos = submath.position(size_t(0));
1629       }
1630       else if (submath.str(0).compare("\\[") == 0) {
1631         math_end_waiting = true;
1632         math_end = "\\]";
1633         math_pos = submath.position(size_t(0));
1634       }
1635       else if (submath.str(0) == "$") {
1636         size_t pos = submath.position(size_t(0));
1637         if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1638           math_end_waiting = true;
1639           math_end = "$";
1640           math_pos = pos;
1641         }
1642       }
1643     }
1644   }
1645   // Ignore language if there is math somewhere in pattern-string
1646   if (isPatternString) {
1647     if (! mi.empty()) {
1648       // Disable language
1649       keys["foreignlanguage"].disabled = true;
1650       disableLanguageOverride = true;
1651     }
1652     else
1653       disableLanguageOverride = false;
1654   }
1655   else {
1656     if (disableLanguageOverride) {
1657       keys["foreignlanguage"].disabled = true;
1658     }
1659   }
1660   math_pos = mi.getFirstPos();
1661   for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1662     sub = *it;
1663     string key = sub.str(3);
1664     if (key == "") {
1665       if (sub.str(0)[0] == '\\')
1666         key = sub.str(0)[1];
1667       else {
1668         key = sub.str(0);
1669         if (key == "$") {
1670           size_t k_pos = sub.position(size_t(0));
1671           if ((k_pos > 0) && (interval.par[k_pos - 1] == '\\')) {
1672             // Escaped '$', ignoring
1673             continue;
1674           }
1675         }
1676       }
1677     };
1678     if (evaluatingRegexp) {
1679       if (sub.str(1).compare("endregexp") == 0) {
1680         evaluatingRegexp = false;
1681         // found._tokenstart already set
1682         found._dataEnd = sub.position(size_t(0)) + 13;
1683         found._dataStart = found._dataEnd;
1684         found._tokensize = found._dataEnd - found._tokenstart;
1685         found.parenthesiscount = 0;
1686         found.head = interval.par.substr(found._tokenstart, found._tokensize);
1687       }
1688       else {
1689         continue;
1690       }
1691     }
1692     else {
1693       if (evaluatingMath) {
1694         if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1695           continue;
1696         evaluatingMath = false;
1697         mi.incrEntry();
1698         math_pos = mi.getStartPos();
1699       }
1700       if (keys.find(key) == keys.end()) {
1701         found = KeyInfo(KeyInfo::isStandard, 0, true);
1702         if (isPatternString) {
1703           found.keytype = KeyInfo::isChar;
1704           found.disabled = false;
1705           found.used = true;
1706         }
1707         keys[key] = found;
1708       }
1709       else
1710         found = keys[key];
1711       if (key.compare("regexp") == 0) {
1712         evaluatingRegexp = true;
1713         found._tokenstart = sub.position(size_t(0));
1714         found._tokensize = 0;
1715         continue;
1716       }
1717     }
1718     // Handle the other params of key
1719     if (found.keytype == KeyInfo::isIgnored)
1720       continue;
1721     else if (found.keytype == KeyInfo::isMath) {
1722       if (size_t(sub.position(size_t(0))) == math_pos) {
1723         found = keys[key];
1724         found._tokenstart = sub.position(size_t(0));
1725         found._tokensize = mi.getSize();
1726         found._dataEnd = found._tokenstart + found._tokensize;
1727         found._dataStart = found._dataEnd;
1728         found.parenthesiscount = 0;
1729         found.head = interval.par.substr(found._tokenstart, found._tokensize);
1730         evaluatingMath = true;
1731       }
1732       else {
1733         // begin|end of unknown env, discard
1734         // First handle tables
1735         // longtable|tabular
1736         bool discardComment;
1737         found = keys[key];
1738         found.keytype = KeyInfo::doRemove;
1739         if ((sub.str(5).compare("longtable") == 0) ||
1740             (sub.str(5).compare("tabular") == 0)) {
1741           discardComment = true;        /* '%' */
1742         }
1743         else {
1744           discardComment = false;
1745           static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1746           smatch sub2;
1747           string token = sub.str(5);
1748           if (regex_match(token, sub2, removeArgs)) {
1749             found.keytype = KeyInfo::removeWithArg;
1750           }
1751         }
1752         // discard spaces before pos(0)
1753         int pos = sub.position(size_t(0));
1754         int count;
1755         for (count = 0; pos - count > 0; count++) {
1756           char c = interval.par[pos-count-1];
1757           if (discardComment) {
1758             if ((c != ' ') && (c != '%'))
1759               break;
1760           }
1761           else if (c != ' ')
1762             break;
1763         }
1764         found._tokenstart = pos - count;
1765         if (sub.str(1).compare(0, 5, "begin") == 0) {
1766           size_t pos1 = pos + sub.str(0).length();
1767           if (sub.str(5).compare("cjk") == 0) {
1768             pos1 = interval.findclosing(pos1+1, interval.par.length()) + 1;
1769             if ((interval.par[pos1] == '{') && (interval.par[pos1+1] == '}'))
1770               pos1 += 2;
1771             found.keytype = KeyInfo::isMain;
1772             found._dataStart = pos1;
1773             found._dataEnd = interval.par.length();
1774             found.disabled = keys["foreignlanguage"].disabled;
1775             found.used = keys["foreignlanguage"].used;
1776             found._tokensize = pos1 - found._tokenstart;
1777             found.head = interval.par.substr(found._tokenstart, found._tokensize);
1778           }
1779           else {
1780             // Swallow possible optional params
1781             while (interval.par[pos1] == '[') {
1782               pos1 = interval.findclosing(pos1+1, interval.par.length(), '[', ']')+1;
1783             }
1784             // Swallow also the eventual parameter
1785             if (interval.par[pos1] == '{') {
1786               found._dataEnd = interval.findclosing(pos1+1, interval.par.length()) + 1;
1787             }
1788             else {
1789               found._dataEnd = pos1;
1790             }
1791             found._dataStart = found._dataEnd;
1792             found._tokensize = count + found._dataEnd - pos;
1793             found.parenthesiscount = 0;
1794             found.head = interval.par.substr(found._tokenstart, found._tokensize);
1795             found.disabled = true;
1796           }
1797         }
1798         else {
1799           // Handle "\end{...}"
1800           found._dataStart = pos + sub.str(0).length();
1801           found._dataEnd = found._dataStart;
1802           found._tokensize = count + found._dataEnd - pos;
1803           found.parenthesiscount = 0;
1804           found.head = interval.par.substr(found._tokenstart, found._tokensize);
1805           found.disabled = true;
1806         }
1807       }
1808     }
1809     else if (found.keytype != KeyInfo::isRegex) {
1810       found._tokenstart = sub.position(size_t(0));
1811       if (found.parenthesiscount == 0) {
1812         // Probably to be discarded
1813         size_t following_pos = sub.position(size_t(0)) + sub.str(3).length() + 1;
1814         char following = interval.par[following_pos];
1815         if (following == ' ')
1816           found.head = "\\" + sub.str(3) + " ";
1817         else if (following == '=') {
1818           // like \uldepth=1000pt
1819           found.head = sub.str(0);
1820         }
1821         else
1822           found.head = "\\" + key;
1823         found._tokensize = found.head.length();
1824         found._dataEnd = found._tokenstart + found._tokensize;
1825         found._dataStart = found._dataEnd;
1826       }
1827       else {
1828         int params = found._tokenstart + key.length() + 1;
1829         if (evaluatingOptional) {
1830           if (size_t(found._tokenstart) > optionalEnd) {
1831             evaluatingOptional = false;
1832           }
1833           else {
1834             found.disabled = true;
1835           }
1836         }
1837         int optend = params;
1838         while (interval.par[optend] == '[') {
1839           // discard optional parameters
1840           optend = interval.findclosing(optend+1, interval.par.length(), '[', ']') + 1;
1841         }
1842         if (optend > params) {
1843           key += interval.par.substr(params, optend-params);
1844           evaluatingOptional = true;
1845           optionalEnd = optend;
1846         }
1847         string token = sub.str(5);
1848         int closings = found.parenthesiscount;
1849         if (found.parenthesiscount == 1) {
1850           found.head = "\\" + key + "{";
1851         }
1852         else if (found.parenthesiscount > 1) {
1853           if (token != "") {
1854             found.head = sub.str(0) + "{";
1855             closings = found.parenthesiscount - 1;
1856           }
1857           else {
1858             found.head = "\\" + key + "{";
1859           }
1860         }
1861         found._tokensize = found.head.length();
1862         found._dataStart = found._tokenstart + found.head.length();
1863         if (interval.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
1864           found._dataStart += 15;
1865         }
1866         size_t endpos = interval.findclosing(found._dataStart, interval.par.length(), '{', '}', closings);
1867         if (found.keytype == KeyInfo::isList) {
1868           // Check if it really is list env
1869           static regex const listre("^([a-z]+)$");
1870           smatch sub2;
1871           if (!regex_match(token, sub2, listre)) {
1872             // Change the key of this entry. It is not in a list/item environment
1873             found.keytype = KeyInfo::endArguments;
1874           }
1875         }
1876         if (found.keytype == KeyInfo::noMain) {
1877           evaluatingCode = true;
1878           codeEnd = endpos;
1879           codeStart = found._dataStart;
1880         }
1881         else if (evaluatingCode) {
1882           if (size_t(found._dataStart) > codeEnd)
1883             evaluatingCode = false;
1884           else if (found.keytype == KeyInfo::isMain) {
1885             // Disable this key, treate it as standard
1886             found.keytype = KeyInfo::isStandard;
1887             found.disabled = true;
1888             if ((codeEnd == interval.par.length()) &&
1889                 (found._tokenstart == codeStart)) {
1890               // trickery, because the code inset starts
1891               // with \selectlanguage ...
1892               codeEnd = endpos;
1893               if (entries.size() > 1) {
1894                 entries[entries.size()-1]._dataEnd = codeEnd;
1895               }
1896             }
1897           }
1898         }
1899         if ((endpos == interval.par.length()) &&
1900             (found.keytype == KeyInfo::doRemove)) {
1901           // Missing closing => error in latex-input?
1902           // therefore do not delete remaining data
1903           found._dataStart -= 1;
1904           found._dataEnd = found._dataStart;
1905         }
1906         else
1907           found._dataEnd = endpos;
1908       }
1909       if (isPatternString) {
1910         keys[key].used = true;
1911       }
1912     }
1913     entries.push_back(found);
1914   }
1915 }
1916
1917 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1918 {
1919   stringstream s(keysstring);
1920   string key;
1921   const char delim = '|';
1922   while (getline(s, key, delim)) {
1923     KeyInfo keyII(keyI);
1924     if (isPatternString) {
1925       keyII.used = false;
1926     }
1927     else if ( !keys[key].used)
1928       keyII.disabled = true;
1929     keys[key] = keyII;
1930   }
1931 }
1932
1933 void LatexInfo::buildKeys(bool isPatternString)
1934 {
1935
1936   static bool keysBuilt = false;
1937   if (keysBuilt && !isPatternString) return;
1938
1939   // Known standard keys with 1 parameter.
1940   // Split is done, if not at start of region
1941   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1942   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1943   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1944   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1945   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1946   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1947
1948   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1949           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1950   makeKey("section*|subsection*|subsubsection*|paragraph*",
1951           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1952   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1953   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
1954   // Regex
1955   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1956
1957   // Split is done, if not at start of region
1958   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
1959   makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
1960
1961   // Split is done always.
1962   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
1963
1964   // Known charaters
1965   // No split
1966   makeKey("backslash|textbackslash|slash",  KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1967   makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1968   makeKey("textasciiacute|texemdash",       KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1969   makeKey("dots|ldots",                     KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1970   // Spaces
1971   makeKey("quad|qquad|hfill|dotfill",               KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1972   makeKey("textvisiblespace|nobreakspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1973   makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1974   // Skip
1975   // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1976   // Custom space/skip, remove the content (== length value)
1977   makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
1978   // Found in fr/UserGuide.lyx
1979   makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1980   // quotes
1981   makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1982   makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1983   // Known macros to remove (including their parameter)
1984   // No split
1985   makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1986   makeKey("addtocounter|setlength",                 KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
1987   // handle like standard keys with 1 parameter.
1988   makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
1989
1990   // Macros to remove, but let the parameter survive
1991   // No split
1992   makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1993
1994   // Remove language spec from content of these insets
1995   makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
1996
1997   // Same effect as previous, parameter will survive (because there is no one anyway)
1998   // No split
1999   makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2000   // Remove table decorations
2001   makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
2002   // Discard shape-header.
2003   // For footnote or shortcut too, because of lang settings
2004   // and wrong handling if used 'KeyInfo::noMain'
2005   makeKey("circlepar|diamondpar|heartpar|nutpar",  KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2006   makeKey("trianglerightpar|hexagonpar|starpar",   KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2007   makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2008   makeKey("triangleleftpar|shapepar|dropuppar",    KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2009   makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics",     KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2010   makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2011   // like ('tiny{}' or '\tiny ' ... )
2012   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2013
2014   // Survives, like known character
2015   makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2016   makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2017
2018   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2019   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2020   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2021
2022   makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2023   // Remove RTL/LTR marker
2024   makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2025   makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2026   makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2027   makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2028   makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2029   makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2030   makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2031   if (isPatternString) {
2032     // Allow the first searched string to rebuild the keys too
2033     keysBuilt = false;
2034   }
2035   else {
2036     // no need to rebuild again
2037     keysBuilt = true;
2038   }
2039 }
2040
2041 /*
2042  * Keep the list of actual opened parentheses actual
2043  * (e.g. depth == 4 means there are 4 '{' not processed yet)
2044  */
2045 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2046 {
2047   int skip = 0;
2048   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2049     char c;
2050     c = par[i];
2051     skip = 0;
2052     if (c == '\\') skip = 1;
2053     else if (c == '{') {
2054       handleOpenP(i);
2055     }
2056     else if (c == '}') {
2057       handleCloseP(i, closingAllowed);
2058     }
2059   }
2060 }
2061
2062 #if (0)
2063 string Intervall::show(int lastpos)
2064 {
2065   int idx = 0;                          /* int intervalls */
2066   string s;
2067   int i = 0;
2068   for (idx = 0; idx <= ignoreidx; idx++) {
2069     while (i < lastpos) {
2070       int printsize;
2071       if (i <= borders[idx].low) {
2072         if (borders[idx].low > lastpos)
2073           printsize = lastpos - i;
2074         else
2075           printsize = borders[idx].low - i;
2076         s += par.substr(i, printsize);
2077         i += printsize;
2078         if (i >= borders[idx].low)
2079           i = borders[idx].upper;
2080       }
2081       else {
2082         i = borders[idx].upper;
2083         break;
2084       }
2085     }
2086   }
2087   if (lastpos > i) {
2088     s += par.substr(i, lastpos-i);
2089   }
2090   return (s);
2091 }
2092 #endif
2093
2094 void Intervall::output(ostringstream &os, int lastpos)
2095 {
2096   // get number of chars to output
2097   int idx = 0;                          /* int intervalls */
2098   int i = 0;
2099   int printed = 0;
2100   string startTitle = titleValue;
2101   for (idx = 0; idx <= ignoreidx; idx++) {
2102     if (i < lastpos) {
2103       if (i <= borders[idx].low) {
2104         int printsize;
2105         if (borders[idx].low > lastpos)
2106           printsize = lastpos - i;
2107         else
2108           printsize = borders[idx].low - i;
2109         if (printsize > 0) {
2110           os << startTitle << par.substr(i, printsize);
2111           i += printsize;
2112           printed += printsize;
2113           startTitle = "";
2114         }
2115         handleParentheses(i, false);
2116         if (i >= borders[idx].low)
2117           i = borders[idx].upper;
2118       }
2119       else {
2120         i = borders[idx].upper;
2121       }
2122     }
2123     else
2124       break;
2125   }
2126   if (lastpos > i) {
2127     os << startTitle << par.substr(i, lastpos-i);
2128     printed += lastpos-i;
2129   }
2130   handleParentheses(lastpos, false);
2131   for (int i = actualdeptindex; i > 0; --i) {
2132     os << "}";
2133   }
2134   if (hasTitle && (printed > 0))
2135     os << "}";
2136   if (! isPatternString)
2137     os << "\n";
2138   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2139 }
2140
2141 void LatexInfo::processRegion(int start, int region_end)
2142 {
2143   while (start < region_end) {          /* Let {[} and {]} survive */
2144     int cnt = interval.isOpeningPar(start);
2145     if (cnt == 1) {
2146       // Closing is allowed past the region
2147       int closing = interval.findclosing(start+1, interval.par.length());
2148       interval.addIntervall(start, start+1);
2149       interval.addIntervall(closing, closing+1);
2150     }
2151     else if (cnt == 3)
2152       start += 2;
2153     start = interval.nextNotIgnored(start+1);
2154   }
2155 }
2156
2157 void LatexInfo::removeHead(KeyInfo &actual, int count)
2158 {
2159   if (actual.parenthesiscount == 0) {
2160     // "{\tiny{} ...}" ==> "{{} ...}"
2161     interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2162   }
2163   else {
2164     // Remove header hull, that is "\url{abcd}" ==> "abcd"
2165     interval.addIntervall(actual._tokenstart - count, actual._dataStart);
2166     interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
2167   }
2168 }
2169
2170 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2171 {
2172   int nextKeyIdx = 0;
2173   switch (actual.keytype)
2174   {
2175     case KeyInfo::isTitle: {
2176       removeHead(actual);
2177       nextKeyIdx = getNextKey();
2178       break;
2179     }
2180     case KeyInfo::cleanToStart: {
2181       actual._dataEnd = actual._dataStart;
2182       nextKeyIdx = getNextKey();
2183       // Search for end of arguments
2184       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2185       if (tmpIdx > 0) {
2186         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2187           entries[i].disabled = true;
2188         }
2189         actual._dataEnd = entries[tmpIdx]._dataEnd;
2190       }
2191       while (interval.par[actual._dataEnd] == ' ')
2192         actual._dataEnd++;
2193       interval.addIntervall(0, actual._dataEnd+1);
2194       interval.actualdeptindex = 0;
2195       interval.depts[0] = actual._dataEnd+1;
2196       interval.closes[0] = -1;
2197       break;
2198     }
2199     case KeyInfo::noContent: {          /* char like "\hspace{2cm}" */
2200       if (actual.disabled)
2201         interval.addIntervall(actual._tokenstart, actual._dataEnd);
2202       else
2203         interval.addIntervall(actual._dataStart, actual._dataEnd);
2204     }
2205       // fall through
2206     case KeyInfo::isChar: {
2207       nextKeyIdx = getNextKey();
2208       break;
2209     }
2210     case KeyInfo::isSize: {
2211       if (actual.disabled || (interval.par[actual._dataStart] != '{') || (interval.par[actual._dataStart-1] == ' ')) {
2212         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
2213         interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2214         nextKeyIdx = getNextKey();
2215       } else {
2216         // Here _dataStart points to '{', so correct it
2217         actual._dataStart += 1;
2218         actual._tokensize += 1;
2219         actual.parenthesiscount = 1;
2220         if (interval.par[actual._dataStart] == '}') {
2221           // Determine the end if used like '{\tiny{}...}'
2222           actual._dataEnd = interval.findclosing(actual._dataStart+1, interval.par.length()) + 1;
2223           interval.addIntervall(actual._dataStart, actual._dataStart+1);
2224         }
2225         else {
2226           // Determine the end if used like '\tiny{...}'
2227           actual._dataEnd = interval.findclosing(actual._dataStart, interval.par.length()) + 1;
2228         }
2229         // Split on this key if not at start
2230         int start = interval.nextNotIgnored(previousStart);
2231         if (start < actual._tokenstart) {
2232           interval.output(os, actual._tokenstart);
2233           interval.addIntervall(start, actual._tokenstart);
2234         }
2235         // discard entry if at end of actual
2236         nextKeyIdx = process(os, actual);
2237       }
2238       break;
2239     }
2240     case KeyInfo::endArguments:
2241       // Remove trailing '{}' too
2242       actual._dataStart += 1;
2243       actual._dataEnd += 1;
2244       interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2245       nextKeyIdx = getNextKey();
2246       break;
2247     case KeyInfo::noMain:
2248       // fall through
2249     case KeyInfo::isStandard: {
2250       if (actual.disabled) {
2251         removeHead(actual);
2252         processRegion(actual._dataStart, actual._dataStart+1);
2253         nextKeyIdx = getNextKey();
2254       } else {
2255         // Split on this key if not at datastart of calling entry
2256         int start = interval.nextNotIgnored(previousStart);
2257         if (start < actual._tokenstart) {
2258           interval.output(os, actual._tokenstart);
2259           interval.addIntervall(start, actual._tokenstart);
2260         }
2261         // discard entry if at end of actual
2262         nextKeyIdx = process(os, actual);
2263       }
2264       break;
2265     }
2266     case KeyInfo::removeWithArg: {
2267       nextKeyIdx = getNextKey();
2268       // Search for end of arguments
2269       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2270       if (tmpIdx > 0) {
2271         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2272           entries[i].disabled = true;
2273         }
2274         actual._dataEnd = entries[tmpIdx]._dataEnd;
2275       }
2276       interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2277       break;
2278     }
2279     case KeyInfo::doRemove: {
2280       // Remove the key with all parameters and following spaces
2281       size_t pos;
2282       for (pos = actual._dataEnd+1; pos < interval.par.length(); pos++) {
2283         if ((interval.par[pos] != ' ') && (interval.par[pos] != '%'))
2284           break;
2285       }
2286       interval.addIntervall(actual._tokenstart, pos);
2287       nextKeyIdx = getNextKey();
2288       break;
2289     }
2290     case KeyInfo::isList: {
2291       // Discard space before _tokenstart
2292       int count;
2293       for (count = 0; count < actual._tokenstart; count++) {
2294         if (interval.par[actual._tokenstart-count-1] != ' ')
2295           break;
2296       }
2297       nextKeyIdx = getNextKey();
2298       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2299       if (tmpIdx > 0) {
2300         // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2301         // with arguments
2302         // How else can we catch this one?
2303         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2304           entries[i].disabled = true;
2305         }
2306         actual._dataEnd = entries[tmpIdx]._dataEnd;
2307       }
2308       else if (nextKeyIdx > 0) {
2309         // Ignore any lang entries inside data region
2310         for (int i = nextKeyIdx; i < int(entries.size()) && entries[i]._tokenstart < actual._dataEnd; i++) {
2311           if (entries[i].keytype == KeyInfo::isMain)
2312             entries[i].disabled = true;
2313         }
2314       }
2315       if (actual.disabled) {
2316         interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2317       }
2318       else {
2319         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
2320       }
2321       if (interval.par[actual._dataEnd+1] == '[') {
2322         int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
2323         if ((interval.par[actual._dataEnd+2] == '{') &&
2324             (interval.par[posdown-1] == '}')) {
2325           interval.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2326           interval.addIntervall(posdown-1, posdown+1);
2327         }
2328         else {
2329           interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2330           interval.addIntervall(posdown, posdown+1);
2331         }
2332         int blk = interval.nextNotIgnored(actual._dataEnd+1);
2333         if (blk > posdown) {
2334           // Discard at most 1 space after empty item
2335           int count;
2336           for (count = 0; count < 1; count++) {
2337             if (interval.par[blk+count] != ' ')
2338               break;
2339           }
2340           if (count > 0)
2341             interval.addIntervall(blk, blk+count);
2342         }
2343       }
2344       break;
2345     }
2346     case KeyInfo::isSectioning: {
2347       // Discard spaces before _tokenstart
2348       int count;
2349       int val = actual._tokenstart;
2350       for (count = 0; count < actual._tokenstart;) {
2351         val = interval.previousNotIgnored(val-1);
2352         if (interval.par[val] != ' ')
2353           break;
2354         else {
2355           count = actual._tokenstart - val;
2356         }
2357       }
2358       if (actual.disabled) {
2359         removeHead(actual, count);
2360         nextKeyIdx = getNextKey();
2361       } else {
2362         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
2363         nextKeyIdx = process(os, actual);
2364       }
2365       break;
2366     }
2367     case KeyInfo::isMath: {
2368       // Same as regex, use the content unchanged
2369       nextKeyIdx = getNextKey();
2370       break;
2371     }
2372     case KeyInfo::isRegex: {
2373       // DO NOT SPLIT ON REGEX
2374       // Do not disable
2375       nextKeyIdx = getNextKey();
2376       break;
2377     }
2378     case KeyInfo::isIgnored: {
2379       // Treat like a character for now
2380       nextKeyIdx = getNextKey();
2381       break;
2382     }
2383     case KeyInfo::isMain: {
2384       if (interval.par.substr(actual._dataStart, 2) == "% ")
2385         interval.addIntervall(actual._dataStart, actual._dataStart+2);
2386       if (actual._tokenstart > 0) {
2387         int prev = interval.previousNotIgnored(actual._tokenstart - 1);
2388         if ((prev >= 0) && interval.par[prev] == '%')
2389           interval.addIntervall(prev, prev+1);
2390       }
2391       if (actual.disabled) {
2392         removeHead(actual);
2393         if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
2394             (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
2395           // Discard also the space before math-equation
2396           interval.addIntervall(actual._dataStart, actual._dataStart+1);
2397         }
2398         nextKeyIdx = getNextKey();
2399         // interval.resetOpenedP(actual._dataStart-1);
2400       }
2401       else {
2402         if (actual._tokenstart < 26) {
2403           // for the first (and maybe dummy) language
2404           interval.setForDefaultLang(actual);
2405         }
2406         interval.resetOpenedP(actual._dataStart-1);
2407       }
2408       break;
2409     }
2410     case KeyInfo::invalid:
2411       // This cannot happen, already handled
2412       // fall through
2413     default: {
2414       // LYXERR0("Unhandled keytype");
2415       nextKeyIdx = getNextKey();
2416       break;
2417     }
2418   }
2419   return nextKeyIdx;
2420 }
2421
2422 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
2423 {
2424   int end = interval.nextNotIgnored(actual._dataEnd);
2425   int oldStart = actual._dataStart;
2426   int nextKeyIdx = getNextKey();
2427   while (true) {
2428     if ((nextKeyIdx < 0) ||
2429         (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2430         (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
2431       if (oldStart <= end) {
2432         processRegion(oldStart, end);
2433         oldStart = end+1;
2434       }
2435       break;
2436     }
2437     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2438
2439     if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2440       (void) dispatch(os, actual._dataStart, nextKey);
2441       end = nextKey._tokenstart;
2442       break;
2443     }
2444     processRegion(oldStart, nextKey._tokenstart);
2445     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2446
2447     oldStart = nextKey._dataEnd+1;
2448   }
2449   // now nextKey is either invalid or is outside of actual._dataEnd
2450   // output the remaining and discard myself
2451   if (oldStart <= end) {
2452     processRegion(oldStart, end);
2453   }
2454   if (interval.par[end] == '}') {
2455     end += 1;
2456     // This is the normal case.
2457     // But if using the firstlanguage, the closing may be missing
2458   }
2459   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2460   int output_end;
2461   if (actual._dataEnd < end)
2462     output_end = interval.nextNotIgnored(actual._dataEnd);
2463   else
2464     output_end = interval.nextNotIgnored(end);
2465   if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2466     interval.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2467   }
2468   // Remove possible empty data
2469   int dstart = interval.nextNotIgnored(actual._dataStart);
2470   while (interval.isOpeningPar(dstart) == 1) {
2471     interval.addIntervall(dstart, dstart+1);
2472     int dend = interval.findclosing(dstart+1, output_end);
2473     interval.addIntervall(dend, dend+1);
2474     dstart = interval.nextNotIgnored(dstart+1);
2475   }
2476   if (dstart < output_end)
2477     interval.output(os, output_end);
2478   interval.addIntervall(actual._tokenstart, end);
2479   return nextKeyIdx;
2480 }
2481
2482 string splitOnKnownMacros(string par, bool isPatternString)
2483 {
2484   ostringstream os;
2485   LatexInfo li(par, isPatternString);
2486   // LYXERR0("Berfore split: " << par);
2487   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2488   DummyKey.head = "";
2489   DummyKey._tokensize = 0;
2490   DummyKey._dataStart = 0;
2491   DummyKey._dataEnd = par.length();
2492   DummyKey.disabled = true;
2493   int firstkeyIdx = li.getFirstKey();
2494   string s;
2495   if (firstkeyIdx >= 0) {
2496     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2497     DummyKey._tokenstart = firstKey._tokenstart;
2498     int nextkeyIdx;
2499     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2500       // Use dummy firstKey
2501       firstKey = DummyKey;
2502       (void) li.setNextKey(firstkeyIdx);
2503     }
2504     else {
2505       if (par.substr(firstKey._dataStart, 2) == "% ")
2506         li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2507     }
2508     nextkeyIdx = li.process(os, firstKey);
2509     while (nextkeyIdx >= 0) {
2510       // Check for a possible gap between the last
2511       // entry and this one
2512       int datastart = li.nextNotIgnored(firstKey._dataStart);
2513       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2514       if ((nextKey._tokenstart > datastart)) {
2515         // Handle the gap
2516         firstKey._dataStart = datastart;
2517         firstKey._dataEnd = par.length();
2518         (void) li.setNextKey(nextkeyIdx);
2519         // Fake the last opened parenthesis
2520         li.setForDefaultLang(firstKey);
2521         nextkeyIdx = li.process(os, firstKey);
2522       }
2523       else {
2524         if (nextKey.keytype != KeyInfo::isMain) {
2525           firstKey._dataStart = datastart;
2526           firstKey._dataEnd = nextKey._dataEnd+1;
2527           (void) li.setNextKey(nextkeyIdx);
2528           li.setForDefaultLang(firstKey);
2529           nextkeyIdx = li.process(os, firstKey);
2530         }
2531         else {
2532           nextkeyIdx = li.process(os, nextKey);
2533         }
2534       }
2535     }
2536     // Handle the remaining
2537     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2538     firstKey._dataEnd = par.length();
2539     // Check if ! empty
2540     if ((firstKey._dataStart < firstKey._dataEnd) &&
2541         (par[firstKey._dataStart] != '}')) {
2542       li.setForDefaultLang(firstKey);
2543       (void) li.process(os, firstKey);
2544     }
2545     s = os.str();
2546     if (s.empty()) {
2547       // return string definitelly impossible to match
2548       s = "\\foreignlanguage{ignore}{ }";
2549     }
2550   }
2551   else
2552     s = par;                            /* no known macros found */
2553   // LYXERR0("After split: " << s);
2554   return s;
2555 }
2556
2557 /*
2558  * Try to unify the language specs in the latexified text.
2559  * Resulting modified string is set to "", if
2560  * the searched tex does not contain all the features in the search pattern
2561  */
2562 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2563 {
2564         static Features regex_f;
2565         static int missed = 0;
2566         static bool regex_with_format = false;
2567
2568         int parlen = par.length();
2569
2570         while ((parlen > 0) && (par[parlen-1] == '\n')) {
2571                 parlen--;
2572         }
2573         if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2574                 // Happens to be there in case of description or labeling environment
2575                 parlen--;
2576         }
2577         string result;
2578         if (withformat) {
2579                 // Split the latex input into pieces which
2580                 // can be digested by our search engine
2581                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2582                 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2583                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2584         }
2585         else
2586                 result = par.substr(0, parlen);
2587         if (isPatternString) {
2588                 missed = 0;
2589                 if (withformat) {
2590                         regex_f = identifyFeatures(result);
2591                         string features = "";
2592                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2593                                 string a = it->first;
2594                                 regex_with_format = true;
2595                                 features += " " + a;
2596                                 // LYXERR0("Identified regex format:" << a);
2597                         }
2598                         LYXERR(Debug::FIND, "Identified Features" << features);
2599
2600                 }
2601         } else if (regex_with_format) {
2602                 Features info = identifyFeatures(result);
2603                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2604                         string a = it->first;
2605                         bool b = it->second;
2606                         if (b && ! info[a]) {
2607                                 missed++;
2608                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2609                                 return("");
2610                         }
2611                 }
2612         }
2613         else {
2614                 // LYXERR0("No regex formats");
2615         }
2616         return(result);
2617 }
2618
2619
2620 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2621 static int identifyClosing(string & t)
2622 {
2623         int open_braces = 0;
2624         do {
2625                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2626                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2627                         continue;
2628                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2629                         continue;
2630                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2631                         continue;
2632                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2633                         ++open_braces;
2634                         continue;
2635                 }
2636                 break;
2637         } while (true);
2638         return open_braces;
2639 }
2640
2641 static int num_replaced = 0;
2642 static bool previous_single_replace = true;
2643
2644 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2645         : p_buf(&buf), p_first_buf(&buf), opt(opt)
2646 {
2647         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2648         docstring const & ds = stringifySearchBuffer(find_buf, opt);
2649         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2650         if (opt.replace_all && previous_single_replace) {
2651                 previous_single_replace = false;
2652                 num_replaced = 0;
2653         }
2654         else if (!opt.replace_all) {
2655                 num_replaced = 0;       // count number of replaced strings
2656                 previous_single_replace = true;
2657         }
2658         // When using regexp, braces are hacked already by escape_for_regex()
2659         par_as_string = normalize(ds, !use_regexp);
2660         open_braces = 0;
2661         close_wildcards = 0;
2662
2663         size_t lead_size = 0;
2664         // correct the language settings
2665         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2666         if (opt.ignoreformat) {
2667                 if (!use_regexp) {
2668                         // if par_as_string_nolead were emty,
2669                         // the following call to findAux will always *find* the string
2670                         // in the checked data, and thus always using the slow
2671                         // examining of the current text part.
2672                         par_as_string_nolead = par_as_string;
2673                 }
2674         } else {
2675                 lead_size = identifyLeading(par_as_string);
2676                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2677                 lead_as_string = par_as_string.substr(0, lead_size);
2678                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2679         }
2680
2681         if (!use_regexp) {
2682                 open_braces = identifyClosing(par_as_string);
2683                 identifyClosing(par_as_string_nolead);
2684                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2685                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2686         } else {
2687                 string lead_as_regexp;
2688                 if (lead_size > 0) {
2689                         // @todo No need to search for \regexp{} insets in leading material
2690                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2691                         par_as_string = par_as_string_nolead;
2692                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2693                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2694                 }
2695                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2696                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2697                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2698                 if (
2699                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2700                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2701                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2702                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2703                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2704                         || regex_replace(par_as_string, par_as_string,
2705                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2706                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2707                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2708                         ) {
2709                         ++close_wildcards;
2710                 }
2711                 if (!opt.ignoreformat) {
2712                         // Remove extra '\}' at end if not part of \{\.\}
2713                         size_t lng = par_as_string.size();
2714                         while(lng > 2) {
2715                                 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
2716                                         if (lng >= 6) {
2717                                                 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
2718                                                         break;
2719                                         }
2720                                         lng -= 2;
2721                                         open_braces++;
2722                                 }
2723                                 else
2724                                         break;
2725                         }
2726                         if (lng < par_as_string.size())
2727                                 par_as_string = par_as_string.substr(0,lng);
2728                         /*
2729                         // save '\.'
2730                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2731                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2732                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2733                         // replace '[^...]' with '[^...\}\{\\]'
2734                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2735                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2736                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2737                         // restore '\.'
2738                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2739                         */
2740                 }
2741                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2742                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2743                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
2744                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2745
2746                 // If entered regexp must match at begin of searched string buffer
2747                 // Kornel: Added parentheses to use $1 for size of the leading string
2748                 string regexp_str;
2749                 string regexp2_str;
2750                 {
2751                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2752                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
2753                         // so the convert has no effect in that case
2754                         for (int i = 8; i > 0; --i) {
2755                                 string orig = "\\\\" + std::to_string(i);
2756                                 string dest = "\\" + std::to_string(i+1);
2757                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
2758                         }
2759                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2760                         regexp2_str = "(" + lead_as_regexp + ").*?" + par_as_string;
2761                 }
2762                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2763                 regexp = lyx::regex(regexp_str);
2764
2765                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2766                 regexp2 = lyx::regex(regexp2_str);
2767         }
2768 }
2769
2770
2771 // Count number of characters in string
2772 // {]} ==> 1
2773 // \&  ==> 1
2774 // --- ==> 1
2775 // \\[a-zA-Z]+ ==> 1
2776 static int computeSize(string s, int len)
2777 {
2778         if (len == 0)
2779                 return 0;
2780         int skip = 1;
2781         int count = 0;
2782         for (int i = 0; i < len; i += skip, count++) {
2783                 if (s[i] == '\\') {
2784                         skip = 2;
2785                         if (isalpha(s[i+1])) {
2786                                 for (int j = 2;  i+j < len; j++) {
2787                                         if (! isalpha(s[i+j])) {
2788                                                 if (s[i+j] == ' ')
2789                                                         skip++;
2790                                                 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2791                                                         skip += 2;
2792                                                 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2793                                                         skip++;
2794                                                 break;
2795                                         }
2796                                         skip++;
2797                                 }
2798                         }
2799                 }
2800                 else if (s[i] == '{') {
2801                         if (s[i+1] == '}')
2802                                 skip = 2;
2803                         else
2804                                 skip = 3;
2805                 }
2806                 else if (s[i] == '-') {
2807                         if (s[i+1] == '-') {
2808                                 if (s[i+2] == '-')
2809                                         skip = 3;
2810                                 else
2811                                         skip = 2;
2812                         }
2813                         else
2814                                 skip = 1;
2815                 }
2816                 else {
2817                         skip = 1;
2818                 }
2819         }
2820         return count;
2821 }
2822
2823 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2824 {
2825         MatchResult mres;
2826
2827         if (at_begin &&
2828                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2829                 return mres;
2830
2831         docstring docstr = stringifyFromForSearch(opt, cur, len);
2832         string str = normalize(docstr, true);
2833         if (!opt.ignoreformat) {
2834                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2835         }
2836         if (str.empty()) {
2837                 mres.match_len = -1;
2838                 return mres;
2839         }
2840         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2841         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2842
2843         if (use_regexp) {
2844                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2845                 regex const *p_regexp;
2846                 regex_constants::match_flag_type flags;
2847                 if (at_begin) {
2848                         flags = regex_constants::match_continuous;
2849                         p_regexp = &regexp;
2850                 } else {
2851                         flags = regex_constants::match_default;
2852                         p_regexp = &regexp2;
2853                 }
2854                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2855                 if (re_it == sregex_iterator())
2856                         return mres;
2857                 match_results<string::const_iterator> const & m = *re_it;
2858
2859                 if (0) { // Kornel Benko: DO NOT CHECKK
2860                         // Check braces on the segment that matched the entire regexp expression,
2861                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2862                         if (!braces_match(m[0].first, m[0].second, open_braces))
2863                                 return mres;
2864                 }
2865
2866                 // Check braces on segments that matched all (.*?) subexpressions,
2867                 // except the last "padding" one inserted by lyx.
2868                 for (size_t i = 1; i < m.size() - 1; ++i)
2869                         if (!braces_match(m[i].first, m[i].second, open_braces))
2870                                 return mres;
2871
2872                 // Exclude from the returned match length any length
2873                 // due to close wildcards added at end of regexp
2874                 // and also the length of the leading (e.g. '\emph{}')
2875                 //
2876                 // Whole found string, including the leading: m[0].second - m[0].first
2877                 // Size of the leading string: m[1].second - m[1].first
2878                 int leadingsize = 0;
2879                 if (m.size() > 1)
2880                         leadingsize = m[1].second - m[1].first;
2881                 int result;
2882                 for (size_t i = 0; i < m.size(); i++) {
2883                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2884                 }
2885                 if (close_wildcards == 0)
2886                         result = m[0].second - m[0].first;
2887
2888                 else
2889                         result =  m[m.size() - close_wildcards].first - m[0].first;
2890
2891                 size_t pos = m.position(size_t(0));
2892                 // Ignore last closing characters
2893                 while (result > 0) {
2894                         if (str[pos+result-1] == '}')
2895                                 --result;
2896                         else
2897                                 break;
2898                 }
2899                 if (result > leadingsize)
2900                         result -= leadingsize;
2901                 else
2902                         result = 0;
2903                 mres.match_len = computeSize(str.substr(pos+leadingsize,result), result);
2904                 mres.match2end = str.size() - pos - leadingsize;
2905                 mres.pos = pos+leadingsize;
2906                 return mres;
2907         }
2908
2909         // else !use_regexp: but all code paths above return
2910         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2911                                  << par_as_string << "', str='" << str << "'");
2912         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2913                                  << lead_as_string << "', par_as_string_nolead='"
2914                                  << par_as_string_nolead << "'");
2915
2916         if (at_begin) {
2917                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2918                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2919                 if (str.substr(0, par_as_string.size()) == par_as_string) {
2920                         mres.match_len = par_as_string.size();
2921                         mres.match2end = str.size();
2922                         mres.pos = 0;
2923                         return mres;
2924                 }
2925         } else {
2926                 // Start the search _after_ the leading part
2927                 size_t pos = str.find(par_as_string_nolead, lead_as_string.size());
2928                 if (pos != string::npos) {
2929                         mres.match_len = par_as_string.size();
2930                         mres.match2end = str.size() - pos;
2931                         mres.pos = pos;
2932                         return mres;
2933                 }
2934         }
2935         return mres;
2936 }
2937
2938
2939 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2940 {
2941         MatchResult mres = findAux(cur, len, at_begin);
2942         int res = mres.match_len;
2943         LYXERR(Debug::FIND,
2944                "res=" << res << ", at_begin=" << at_begin
2945                << ", matchword=" << opt.matchword
2946                << ", inTexted=" << cur.inTexted());
2947         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2948                 return mres;
2949         if ((len > 0) && (res < len)) {
2950           mres.match_len = 0;
2951           return mres;
2952         }
2953         Paragraph const & par = cur.paragraph();
2954         bool ws_left = (cur.pos() > 0)
2955                 ? par.isWordSeparator(cur.pos() - 1)
2956                 : true;
2957         bool ws_right = (cur.pos() + len < par.size())
2958                 ? par.isWordSeparator(cur.pos() + len)
2959                 : true;
2960         LYXERR(Debug::FIND,
2961                "cur.pos()=" << cur.pos() << ", res=" << res
2962                << ", separ: " << ws_left << ", " << ws_right
2963                << ", len: " << len
2964                << endl);
2965         if (ws_left && ws_right) {
2966           // Check for word separators inside the found 'word'
2967           for (int i = 0; i < len; i++) {
2968             if (par.isWordSeparator(cur.pos() + i)) {
2969               mres.match_len = 0;
2970               return mres;
2971             }
2972           }
2973           return mres;
2974         }
2975         mres.match_len = 0;
2976         return mres;
2977 }
2978
2979
2980 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2981 {
2982         string t;
2983         if (! opt.casesensitive)
2984                 t = lyx::to_utf8(lowercase(s));
2985         else
2986                 t = lyx::to_utf8(s);
2987         // Remove \n at begin
2988         while (!t.empty() && t[0] == '\n')
2989                 t = t.substr(1);
2990         // Remove \n at end
2991         while (!t.empty() && t[t.size() - 1] == '\n')
2992                 t = t.substr(0, t.size() - 1);
2993         size_t pos;
2994         // Handle all other '\n'
2995         while ((pos = t.find("\n")) != string::npos) {
2996                 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
2997                         // Handle '\\\n'
2998                         if (isAlnumASCII(t[pos+1])) {
2999                                 t.replace(pos-2, 3, " ");
3000                         }
3001                         else {
3002                                 t.replace(pos-2, 3, "");
3003                         }
3004                 }
3005                 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
3006                         // '\n' adjacent to non-alpha-numerics, discard
3007                         t.replace(pos, 1, "");
3008                 }
3009                 else {
3010                         // Replace all other \n with spaces
3011                         t.replace(pos, 1, " ");
3012                 }
3013         }
3014         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
3015         // Kornel: Added textsl, textsf, textit, texttt and noun
3016         // + allow to seach for colored text too
3017         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
3018         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
3019                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3020         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3021                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3022
3023         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3024         // FIXME - check what preceeds the brace
3025         if (hack_braces) {
3026                 if (opt.ignoreformat)
3027                         while (regex_replace(t, t, "\\{", "_x_<")
3028                                || regex_replace(t, t, "\\}", "_x_>"))
3029                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3030                 else
3031                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
3032                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
3033                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3034         }
3035
3036         return t;
3037 }
3038
3039
3040 docstring stringifyFromCursor(DocIterator const & cur, int len)
3041 {
3042         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3043         if (cur.inTexted()) {
3044                 Paragraph const & par = cur.paragraph();
3045                 // TODO what about searching beyond/across paragraph breaks ?
3046                 // TODO Try adding a AS_STR_INSERTS as last arg
3047                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3048                         int(par.size()) : cur.pos() + len;
3049                 // OutputParams runparams(&cur.buffer()->params().encoding());
3050                 OutputParams runparams(encodings.fromLyXName("utf8"));
3051                 runparams.nice = true;
3052                 runparams.flavor = OutputParams::XETEX;
3053                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3054                 // No side effect of file copying and image conversion
3055                 runparams.dryrun = true;
3056                 runparams.for_search = true;
3057                 LYXERR(Debug::FIND, "Stringifying with cur: "
3058                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
3059                 return par.asString(cur.pos(), end,
3060                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3061                         &runparams);
3062         } else if (cur.inMathed()) {
3063                 CursorSlice cs = cur.top();
3064                 MathData md = cs.cell();
3065                 MathData::const_iterator it_end =
3066                         (( len == -1 || cs.pos() + len > int(md.size()))
3067                          ? md.end()
3068                          : md.begin() + cs.pos() + len );
3069                 MathData md2;
3070                 for (MathData::const_iterator it = md.begin() + cs.pos();
3071                      it != it_end; ++it)
3072                         md2.push_back(*it);
3073                 docstring s = asString(md2);
3074                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3075                 return s;
3076         }
3077         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3078         return docstring();
3079 }
3080
3081
3082 /** Computes the LaTeX export of buf starting from cur and ending len positions
3083  * after cur, if len is positive, or at the paragraph or innermost inset end
3084  * if len is -1.
3085  */
3086 docstring latexifyFromCursor(DocIterator const & cur, int len)
3087 {
3088         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3089         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3090                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3091         Buffer const & buf = *cur.buffer();
3092
3093         odocstringstream ods;
3094         otexstream os(ods);
3095         //OutputParams runparams(&buf.params().encoding());
3096         OutputParams runparams(encodings.fromLyXName("utf8"));
3097         runparams.nice = false;
3098         runparams.flavor = OutputParams::XETEX;
3099         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3100         // No side effect of file copying and image conversion
3101         runparams.dryrun = true;
3102         runparams.for_search = true;
3103
3104         if (cur.inTexted()) {
3105                 // @TODO what about searching beyond/across paragraph breaks ?
3106                 pos_type endpos = cur.paragraph().size();
3107                 if (len != -1 && endpos > cur.pos() + len)
3108                         endpos = cur.pos() + len;
3109                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3110                           string(), cur.pos(), endpos);
3111                 string s = lyx::to_utf8(ods.str());
3112                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3113                 return(lyx::from_utf8(s));
3114         } else if (cur.inMathed()) {
3115                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3116                 for (int s = cur.depth() - 1; s >= 0; --s) {
3117                         CursorSlice const & cs = cur[s];
3118                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3119                                 WriteStream ws(os);
3120                                 cs.asInsetMath()->asHullInset()->header_write(ws);
3121                                 break;
3122                         }
3123                 }
3124
3125                 CursorSlice const & cs = cur.top();
3126                 MathData md = cs.cell();
3127                 MathData::const_iterator it_end =
3128                         ((len == -1 || cs.pos() + len > int(md.size()))
3129                          ? md.end()
3130                          : md.begin() + cs.pos() + len);
3131                 MathData md2;
3132                 for (MathData::const_iterator it = md.begin() + cs.pos();
3133                      it != it_end; ++it)
3134                         md2.push_back(*it);
3135
3136                 ods << asString(md2);
3137                 // Retrieve the math environment type, and add '$' or '$]'
3138                 // or others (\end{equation}) accordingly
3139                 for (int s = cur.depth() - 1; s >= 0; --s) {
3140                         CursorSlice const & cs2 = cur[s];
3141                         InsetMath * inset = cs2.asInsetMath();
3142                         if (inset && inset->asHullInset()) {
3143                                 WriteStream ws(os);
3144                                 inset->asHullInset()->footer_write(ws);
3145                                 break;
3146                         }
3147                 }
3148                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3149         } else {
3150                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3151         }
3152         return ods.str();
3153 }
3154
3155
3156 /** Finalize an advanced find operation, advancing the cursor to the innermost
3157  ** position that matches, plus computing the length of the matching text to
3158  ** be selected
3159  **/
3160 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
3161 {
3162         // Search the foremost position that matches (avoids find of entire math
3163         // inset when match at start of it)
3164         size_t d;
3165         DocIterator old_cur(cur.buffer());
3166         do {
3167                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
3168                 d = cur.depth();
3169                 old_cur = cur;
3170                 cur.forwardPos();
3171         } while (cur && cur.depth() > d && match(cur).match_len > 0);
3172         cur = old_cur;
3173         int max_match = match(cur).match_len;     /* match valid only if not searching whole words */
3174         if (max_match <= 0) return 0;
3175         LYXERR(Debug::FIND, "Ok");
3176
3177         // Compute the match length
3178         int len = 1;
3179         if (cur.pos() + len > cur.lastpos())
3180           return 0;
3181         if (match.opt.matchword) {
3182           LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3183           while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3184             ++len;
3185             LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3186           }
3187           // Length of matched text (different from len param)
3188           int old_match = match(cur, len).match_len;
3189           if (old_match < 0)
3190             old_match = 0;
3191           int new_match;
3192           // Greedy behaviour while matching regexps
3193           while ((new_match = match(cur, len + 1).match_len) > old_match) {
3194             ++len;
3195             old_match = new_match;
3196             LYXERR(Debug::FIND, "verifying   match with len = " << len);
3197           }
3198           if (old_match == 0)
3199             len = 0;
3200         }
3201         else {
3202           int minl = 1;
3203           int maxl = cur.lastpos() - cur.pos();
3204           // Greedy behaviour while matching regexps
3205           while (maxl > minl) {
3206             int actual_match = match(cur, len).match_len;
3207             if (actual_match >= max_match) {
3208               // actual_match > max_match _can_ happen,
3209               // if the search area splits
3210               // some following word so that the regex
3211               // (e.g. 'r.*r\b' matches 'r' from the middle of the
3212               // splitted word)
3213               // This means, the len value is too big
3214               maxl = len;
3215               len = (int)((maxl + minl)/2);
3216             }
3217             else {
3218               // (actual_match < max_match)
3219               minl = len + 1;
3220               len = (int)((maxl + minl)/2);
3221             }
3222           }
3223           old_cur = cur;
3224           // Search for real start of matched characters
3225           while (len > 1) {
3226             int actual_match;
3227             do {
3228               cur.forwardPos();
3229             } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3230             if (cur.depth() < old_cur.depth()) {
3231               // Outer inset?
3232               LYXERR0("cur.depth() < old_cur.depth(), this should never happen");
3233               break;
3234             }
3235             if (cur.pos() != old_cur.pos()) {
3236               // OK, forwarded 1 pos in actual inset
3237               actual_match = match(cur, len-1).match_len;
3238               if (actual_match == max_match) {
3239                 // Ha, got it! The shorter selection has the same match length
3240                 len--;
3241                 old_cur = cur;
3242               }
3243               else {
3244                 // OK, the shorter selection matches less chars, revert to previous value
3245                 cur = old_cur;
3246                 break;
3247               }
3248             }
3249             else {
3250               LYXERR0("cur.pos() == old_cur.pos(), this should never happen");
3251               actual_match = match(cur, len).match_len;
3252               if (actual_match == max_match)
3253                 old_cur = cur;
3254             }
3255           }
3256         }
3257         return len;
3258 }
3259
3260
3261 /// Finds forward
3262 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
3263 {
3264         if (!cur)
3265                 return 0;
3266         while (!theApp()->longOperationCancelled() && cur) {
3267                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3268                 MatchResult mres = match(cur, -1, false);
3269                 int match_len = mres.match_len;
3270                 LYXERR(Debug::FIND, "match_len: " << match_len);
3271                 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3272                         LYXERR0("BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3273                         match_len = 0;
3274                 }
3275                 if (match_len > 0) {
3276                         // Try to find the begin of searched string
3277                         int increment = mres.pos/2;
3278                         while (mres.pos > 5 && (increment > 5)) {
3279                                 DocIterator old_cur = cur;
3280                                 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3281                                 }
3282                                 if (! cur || (cur.pit() > old_cur.pit())) {
3283                                         // Are we outside of the paragraph?
3284                                         // This can happen if moving past some UTF8-encoded chars
3285                                         cur = old_cur;
3286                                         increment /= 2;
3287                                 }
3288                                 else {
3289                                         MatchResult mres2 = match(cur, -1, false);
3290                                         if ((mres2.match2end < mres.match2end) ||
3291                                           (mres2.match_len < mres.match_len)) {
3292                                                 cur = old_cur;
3293                                                 increment /= 2;
3294                                         }
3295                                         else {
3296                                                 mres = mres2;
3297                                                 increment -= 2;
3298                                                 if (increment > mres.pos/2)
3299                                                         increment = mres.pos/2;
3300                                         }
3301                                 }
3302                         }
3303                         int match_len_zero_count = 0;
3304                         for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3305                                 if (i++ > 10) {
3306                                         int remaining_len = match(cur, -1, false).match_len;
3307                                         if (remaining_len <= 0) {
3308                                                 // Apparently the searched string is not in the remaining part
3309                                                 break;
3310                                         }
3311                                         else {
3312                                                 i = 0;
3313                                         }
3314                                 }
3315                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3316                                 int match_len3 = match(cur, 1).match_len;
3317                                 if (match_len3 < 0)
3318                                         continue;
3319                                 int match_len2 = match(cur).match_len;
3320                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3321                                 if (match_len2 > 0) {
3322                                         // Sometimes in finalize we understand it wasn't a match
3323                                         // and we need to continue the outest loop
3324                                         int len = findAdvFinalize(cur, match);
3325                                         if (len > 0) {
3326                                                 return len;
3327                                         }
3328                                 }
3329                                 if (match_len2 >= 0) {
3330                                         if (match_len2 == 0)
3331                                                 match_len_zero_count++;
3332                                         else
3333                                                 match_len_zero_count = 0;
3334                                 }
3335                                 else {
3336                                         if (++match_len_zero_count > 3) {
3337                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3338                                                 match_len_zero_count = 0;
3339                                         }
3340                                         break;
3341                                 }
3342                         }
3343                         if (!cur)
3344                                 return 0;
3345                 }
3346                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3347                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3348                         cur.forwardPar();
3349                 } else {
3350                         // This should exit nested insets, if any, or otherwise undefine the currsor.
3351                         cur.pos() = cur.lastpos();
3352                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3353                         cur.forwardPos();
3354                 }
3355         }
3356         return 0;
3357 }
3358
3359
3360 /// Find the most backward consecutive match within same paragraph while searching backwards.
3361 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3362 {
3363         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3364         DocIterator tmp_cur = cur;
3365         int len = findAdvFinalize(tmp_cur, match);
3366         Inset & inset = cur.inset();
3367         for (; cur != cur_begin; cur.backwardPos()) {
3368                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3369                 DocIterator new_cur = cur;
3370                 new_cur.backwardPos();
3371                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3372                         break;
3373                 int new_len = findAdvFinalize(new_cur, match);
3374                 if (new_len == len)
3375                         break;
3376                 len = new_len;
3377         }
3378         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3379         return len;
3380 }
3381
3382
3383 /// Finds backwards
3384 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3385 {
3386         if (! cur)
3387                 return 0;
3388         // Backup of original position
3389         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3390         if (cur == cur_begin)
3391                 return 0;
3392         cur.backwardPos();
3393         DocIterator cur_orig(cur);
3394         bool pit_changed = false;
3395         do {
3396                 cur.pos() = 0;
3397                 bool found_match = (match(cur, -1, false).match_len > 0);
3398
3399                 if (found_match) {
3400                         if (pit_changed)
3401                                 cur.pos() = cur.lastpos();
3402                         else
3403                                 cur.pos() = cur_orig.pos();
3404                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
3405                         DocIterator cur_prev_iter;
3406                         do {
3407                                 found_match = (match(cur).match_len > 0);
3408                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
3409                                        << found_match << ", cur: " << cur);
3410                                 if (found_match)
3411                                         return findMostBackwards(cur, match);
3412
3413                                 // Stop if begin of document reached
3414                                 if (cur == cur_begin)
3415                                         break;
3416                                 cur_prev_iter = cur;
3417                                 cur.backwardPos();
3418                         } while (true);
3419                 }
3420                 if (cur == cur_begin)
3421                         break;
3422                 if (cur.pit() > 0)
3423                         --cur.pit();
3424                 else
3425                         cur.backwardPos();
3426                 pit_changed = true;
3427         } while (!theApp()->longOperationCancelled());
3428         return 0;
3429 }
3430
3431
3432 } // namespace
3433
3434
3435 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
3436                                  DocIterator const & cur, int len)
3437 {
3438         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
3439                 return docstring();
3440         if (!opt.ignoreformat)
3441                 return latexifyFromCursor(cur, len);
3442         else
3443                 return stringifyFromCursor(cur, len);
3444 }
3445
3446
3447 FindAndReplaceOptions::FindAndReplaceOptions(
3448         docstring const & find_buf_name, bool casesensitive,
3449         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
3450         docstring const & repl_buf_name, bool keep_case,
3451         SearchScope scope, SearchRestriction restr, bool replace_all)
3452         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
3453           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
3454           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr), replace_all(replace_all)
3455 {
3456 }
3457
3458
3459 namespace {
3460
3461
3462 /** Check if 'len' letters following cursor are all non-lowercase */
3463 static bool allNonLowercase(Cursor const & cur, int len)
3464 {
3465         pos_type beg_pos = cur.selectionBegin().pos();
3466         pos_type end_pos = cur.selectionBegin().pos() + len;
3467         if (len > cur.lastpos() + 1 - beg_pos) {
3468                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
3469                 len = cur.lastpos() + 1 - beg_pos;
3470                 end_pos = beg_pos + len;
3471         }
3472         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
3473                 if (isLowerCase(cur.paragraph().getChar(pos)))
3474                         return false;
3475         return true;
3476 }
3477
3478
3479 /** Check if first letter is upper case and second one is lower case */
3480 static bool firstUppercase(Cursor const & cur)
3481 {
3482         char_type ch1, ch2;
3483         pos_type pos = cur.selectionBegin().pos();
3484         if (pos >= cur.lastpos() - 1) {
3485                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
3486                 return false;
3487         }
3488         ch1 = cur.paragraph().getChar(pos);
3489         ch2 = cur.paragraph().getChar(pos + 1);
3490         bool result = isUpperCase(ch1) && isLowerCase(ch2);
3491         LYXERR(Debug::FIND, "firstUppercase(): "
3492                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
3493                << ch2 << "(" << char(ch2) << ")"
3494                << ", result=" << result << ", cur=" << cur);
3495         return result;
3496 }
3497
3498
3499 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
3500  **
3501  ** \fixme What to do with possible further paragraphs in replace buffer ?
3502  **/
3503 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
3504 {
3505         ParagraphList::iterator pit = buffer.paragraphs().begin();
3506         LASSERT(pit->size() >= 1, /**/);
3507         pos_type right = pos_type(1);
3508         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
3509         right = pit->size();
3510         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
3511 }
3512
3513 } // namespace
3514
3515 ///
3516 static int findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
3517 {
3518         Cursor & cur = bv->cursor();
3519         if (opt.repl_buf_name == docstring()
3520             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
3521             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3522                 return 0;
3523
3524         DocIterator sel_beg = cur.selectionBegin();
3525         DocIterator sel_end = cur.selectionEnd();
3526         if (&sel_beg.inset() != &sel_end.inset()
3527             || sel_beg.pit() != sel_end.pit()
3528             || sel_beg.idx() != sel_end.idx())
3529                 return 0;
3530         int sel_len = sel_end.pos() - sel_beg.pos();
3531         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
3532                << ", sel_len: " << sel_len << endl);
3533         if (sel_len == 0)
3534                 return 0;
3535         LASSERT(sel_len > 0, return 0);
3536
3537         if (!matchAdv(sel_beg, sel_len).match_len)
3538                 return 0;
3539
3540         // Build a copy of the replace buffer, adapted to the KeepCase option
3541         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
3542         ostringstream oss;
3543         repl_buffer_orig.write(oss);
3544         string lyx = oss.str();
3545         Buffer repl_buffer("", false);
3546         repl_buffer.setUnnamed(true);
3547         LASSERT(repl_buffer.readString(lyx), return 0);
3548         if (opt.keep_case && sel_len >= 2) {
3549                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
3550                 if (cur.inTexted()) {
3551                         if (firstUppercase(cur))
3552                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3553                         else if (allNonLowercase(cur, sel_len))
3554                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3555                 }
3556         }
3557         cap::cutSelection(cur, false);
3558         if (cur.inTexted()) {
3559                 repl_buffer.changeLanguage(
3560                         repl_buffer.language(),
3561                         cur.getFont().language());
3562                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3563                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3564                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3565                                         repl_buffer.params().documentClassPtr(),
3566                                         bv->buffer().errorList("Paste"));
3567                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3568                 sel_len = repl_buffer.paragraphs().begin()->size();
3569         } else if (cur.inMathed()) {
3570                 odocstringstream ods;
3571                 otexstream os(ods);
3572                 // OutputParams runparams(&repl_buffer.params().encoding());
3573                 OutputParams runparams(encodings.fromLyXName("utf8"));
3574                 runparams.nice = false;
3575                 runparams.flavor = OutputParams::XETEX;
3576                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3577                 runparams.dryrun = true;
3578                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3579                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3580                 docstring repl_latex = ods.str();
3581                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3582                 string s;
3583                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3584                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3585                 repl_latex = from_utf8(s);
3586                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3587                 MathData ar(cur.buffer());
3588                 asArray(repl_latex, ar, Parse::NORMAL);
3589                 cur.insert(ar);
3590                 sel_len = ar.size();
3591                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3592         }
3593         if (cur.pos() >= sel_len)
3594                 cur.pos() -= sel_len;
3595         else
3596                 cur.pos() = 0;
3597         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3598         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3599         bv->processUpdateFlags(Update::Force);
3600         return 1;
3601 }
3602
3603
3604 /// Perform a FindAdv operation.
3605 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3606 {
3607         DocIterator cur;
3608         int match_len = 0;
3609
3610         // e.g., when invoking word-findadv from mini-buffer wither with
3611         //       wrong options syntax or before ever opening advanced F&R pane
3612         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3613                 return false;
3614
3615         try {
3616                 MatchStringAdv matchAdv(bv->buffer(), opt);
3617                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3618                 if (length > 0)
3619                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3620                 num_replaced += findAdvReplace(bv, opt, matchAdv);
3621                 cur = bv->cursor();
3622                 if (opt.forward)
3623                         match_len = findForwardAdv(cur, matchAdv);
3624                 else
3625                         match_len = findBackwardsAdv(cur, matchAdv);
3626         } catch (...) {
3627                 // This may only be raised by lyx::regex()
3628                 bv->message(_("Invalid regular expression!"));
3629                 return false;
3630         }
3631
3632         if (match_len == 0) {
3633                 if (num_replaced > 0) {
3634                         switch (num_replaced)
3635                         {
3636                                 case 1:
3637                                         bv->message(_("One match has been replaced."));
3638                                         break;
3639                                 case 2:
3640                                         bv->message(_("Two matches have been replaced."));
3641                                         break;
3642                                 default:
3643                                         bv->message(bformat(_("%1$d matches have been replaced."), num_replaced));
3644                                         break;
3645                         }
3646                         num_replaced = 0;
3647                 }
3648                 else {
3649                         bv->message(_("Match not found."));
3650                 }
3651                 return false;
3652         }
3653
3654         if (num_replaced > 0)
3655                 bv->message(_("Match has been replaced."));
3656         else
3657                 bv->message(_("Match found."));
3658
3659         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3660         bv->putSelectionAt(cur, match_len, !opt.forward);
3661
3662         return true;
3663 }
3664
3665
3666 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3667 {
3668         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3669            << opt.casesensitive << ' '
3670            << opt.matchword << ' '
3671            << opt.forward << ' '
3672            << opt.expandmacros << ' '
3673            << opt.ignoreformat << ' '
3674            << opt.replace_all << ' '
3675            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3676            << opt.keep_case << ' '
3677            << int(opt.scope) << ' '
3678            << int(opt.restr);
3679
3680         LYXERR(Debug::FIND, "built: " << os.str());
3681
3682         return os;
3683 }
3684
3685
3686 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3687 {
3688         LYXERR(Debug::FIND, "parsing");
3689         string s;
3690         string line;
3691         getline(is, line);
3692         while (line != "EOSS") {
3693                 if (! s.empty())
3694                         s = s + "\n";
3695                 s = s + line;
3696                 if (is.eof())   // Tolerate malformed request
3697                         break;
3698                 getline(is, line);
3699         }
3700         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3701         opt.find_buf_name = from_utf8(s);
3702         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.replace_all;
3703         is.get();       // Waste space before replace string
3704         s = "";
3705         getline(is, line);
3706         while (line != "EOSS") {
3707                 if (! s.empty())
3708                         s = s + "\n";
3709                 s = s + line;
3710                 if (is.eof())   // Tolerate malformed request
3711                         break;
3712                 getline(is, line);
3713         }
3714         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3715         opt.repl_buf_name = from_utf8(s);
3716         is >> opt.keep_case;
3717         int i;
3718         is >> i;
3719         opt.scope = FindAndReplaceOptions::SearchScope(i);
3720         is >> i;
3721         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3722
3723         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3724                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3725                << opt.scope << ' ' << opt.restr);
3726         return is;
3727 }
3728
3729 } // namespace lyx