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