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