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