src/lyxfind.cpp

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