src/lyxfind.cpp

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