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