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