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