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{}" parts
 948                 string t = to_utf8(str);
 949                 while (regex_replace(t, t, "\\\\text\\{([^\\}]*)\\}", "$1"));
 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["lyxmathsym{ß}"] = "ß";
1324   accents["text{ß}"] = "ß";
1325   accents["ddot{\\imath}"] = "ï";
1326   buildaccent("ddot", "aAeEhHiIioOtuUwWxXyY",
1327                       "äÄëËḧḦïÏïöÖẗüÜẅẄẍẌÿŸ");       // umlaut
1328   buildaccent("dot|.", "aAbBcCdDeEfFGghHIimMnNoOpPrRsStTwWxXyYzZ",
1329                        "ȧȦḃḂċĊḋḊėĖḟḞĠġḣḢİİṁṀṅṄȯȮṗṖṙṘṡṠṫṪẇẆẋẊẏẎżŻ");   // dot{i} can only happen if ignoring case, but there is no lowercase of 'İ'
1330   accents["acute{\\imath}"] = "í";
1331   buildaccent("acute", "aAcCeEgGkKlLmMoOnNpPrRsSuUwWyYzZiI",
1332                        "áÁćĆéÉǵǴḱḰĺĹḿḾóÓńŃṕṔŕŔśŚúÚẃẂýÝźŹíÍ");
1333   buildaccent("dacute|H|h", "oOuU", "őŐűŰ");        // double acute
1334   buildaccent("mathring|r", "aAuUwy",
1335                             "åÅůŮẘẙ");  // ring
1336   accents["check{\\imath}"] = "ǐ";
1337   accents["check{\\jmath}"] = "ǰ";
1338   buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTtzZ",
1339                          "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤťžŽ");   // caron
1340   accents["hat{\\imath}"] = "î";
1341   accents["hat{\\jmath}"] = "ĵ";
1342   buildaccent("hat|^", "aAcCeEgGhHiIjJoOsSuUwWyYzZ",
1343                        "âÂĉĈêÊĝĜĥĤîÎĵĴôÔŝŜûÛŵŴŷŶẑẐ");       // circ
1344   accents["bar{\\imath}"] = "ī";
1345   buildaccent("bar|=", "aAeEiIoOuUyY",
1346                        "āĀēĒīĪōŌūŪȳȲ");     // macron
1347   accents["tilde{\\imath}"] = "ĩ";
1348   buildaccent("tilde", "aAeEiInNoOuUvVyY",
1349                        "ãÃẽẼĩĨñÑõÕũŨṽṼỹỸ");       // tilde
1350   accents["breve{\\imath}"] = "ĭ";
1351   buildaccent("breve|u", "aAeEgGiIoOuU",
1352                          "ăĂĕĔğĞĭĬŏŎŭŬ");   // breve
1353   accents["grave{\\imath}"] = "ì";
1354   buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1355                          "àÀèÈìÌòÒùÙǹǸẁẀỳỲ");       // grave
1356   buildaccent("subdot|d", "BbDdHhKkLlMmNnRrSsTtVvWwZzAaEeIiOoUuYy",
1357                           "ḄḅḌḍḤḥḲḳḶḷṂṃṆṇṚṛṢṣṬṭṾṿẈẉẒẓẠạẸẹỊịỌọỤụỴỵ");        // dot below
1358   buildaccent("ogonek|k", "AaEeIiUuOo",
1359                           "ĄąĘęĮįŲųǪǫ");      // ogonek
1360   buildaccent("cedilla|c", "CcGgKkLlNnRrSsTtEeDdHh",
1361                            "ÇçĢĢĶķĻļŅņŖŗŞşŢţȨȩḐḑḨḩ"); // cedilla
1362   buildaccent("subring|textsubring", "Aa",
1363                                      "Ḁḁ"); // subring
1364   buildaccent("subhat|textsubcircum", "DdEeLlNnTtUu",
1365                                       "ḒḓḘḙḼḽṊṋṰṱṶṷ");  // subcircum
1366   buildaccent("subtilde|textsubtilde", "EeIiUu",
1367                                        "ḚḛḬḭṴṵ");   // subtilde
1368   accents["dgrave{\\imath}"] = "ȉ";
1369   accents["textdoublegrave{\\i}"] = "ȉ";
1370   buildaccent("dgrave|textdoublegrave", "AaEeIiOoRrUu",
1371                                         "ȀȁȄȅȈȉȌȍȐȑȔȕ"); // double grave
1372   accents["rcap{\\imath}"] = "ȉ";
1373   accents["textroundcap{\\i}"] = "ȉ";
1374   buildaccent("rcap|textroundcap", "AaEeIiOoRrUu",
1375                                    "ȂȃȆȇȊȋȎȏȒȓȖȗ"); // inverted breve
1376   buildaccent("slashed", "oO",
1377                          "øØ"); // slashed
1378 }
1379
1380 /*
1381  * Created accents in math or regexp environment
1382  * are macros, but we need the utf8 equivalent
1383  */
1384 void Intervall::removeAccents()
1385 {
1386   if (accents.empty())
1387     buildAccentsMap();
1388   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]))");
1389   smatch sub;
1390   for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1391     sub = *itacc;
1392     string key = sub.str(1);
1393     if (accents.find(key) != accents.end()) {
1394       string val = accents[key];
1395       size_t pos = sub.position(size_t(0));
1396       for (size_t i = 0; i < val.size(); i++) {
1397         par[pos+i] = val[i];
1398       }
1399       // Remove possibly following space too
1400       if (par[pos+sub.str(0).size()] == ' ')
1401         addIntervall(pos+val.size(), pos + sub.str(0).size()+1);
1402       else
1403         addIntervall(pos+val.size(), pos + sub.str(0).size());
1404       for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1405         // remove traces of any remaining chars
1406         par[i] = ' ';
1407       }
1408     }
1409     else {
1410       LYXERR(Debug::INFO, "Not added accent for \"" << key << "\"");
1411     }
1412   }
1413 }
1414
1415 void Intervall::handleOpenP(int i)
1416 {
1417   actualdeptindex++;
1418   depts[actualdeptindex] = i+1;
1419   closes[actualdeptindex] = -1;
1420   checkDepthIndex(actualdeptindex);
1421 }
1422
1423 void Intervall::handleCloseP(int i, bool closingAllowed)
1424 {
1425   if (actualdeptindex <= 0) {
1426     if (! closingAllowed)
1427       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1428     // if we are at the very end
1429     addIntervall(i, i+1);
1430   }
1431   else {
1432     closes[actualdeptindex] = i+1;
1433     actualdeptindex--;
1434   }
1435 }
1436
1437 void Intervall::resetOpenedP(int openPos)
1438 {
1439   // Used as initializer for foreignlanguage entry
1440   actualdeptindex = 1;
1441   depts[1] = openPos+1;
1442   closes[1] = -1;
1443 }
1444
1445 int Intervall::previousNotIgnored(int start) const
1446 {
1447     int idx = 0;                          /* int intervalls */
1448     for (idx = ignoreidx; idx >= 0; --idx) {
1449       if (start > borders[idx].upper)
1450         return start;
1451       if (start >= borders[idx].low)
1452         start = borders[idx].low-1;
1453     }
1454     return start;
1455 }
1456
1457 int Intervall::nextNotIgnored(int start) const
1458 {
1459     int idx = 0;                          /* int intervalls */
1460     for (idx = 0; idx <= ignoreidx; idx++) {
1461       if (start < borders[idx].low)
1462         return start;
1463       if (start < borders[idx].upper)
1464         start = borders[idx].upper;
1465     }
1466     return start;
1467 }
1468
1469 typedef map<string, KeyInfo> KeysMap;
1470 typedef vector< KeyInfo> Entries;
1471 static KeysMap keys = map<string, KeyInfo>();
1472
1473 class LatexInfo {
1474  private:
1475   int entidx_;
1476   Entries entries_;
1477   Intervall interval_;
1478   void buildKeys(bool);
1479   void buildEntries(bool);
1480   void makeKey(const string &, KeyInfo, bool isPatternString);
1481   void processRegion(int start, int region_end); /*  remove {} parts */
1482   void removeHead(KeyInfo const &, int count=0);
1483
1484  public:
1485  LatexInfo(string const & par, bool isPatternString)
1486          : entidx_(-1), interval_(isPatternString, par)
1487   {
1488     buildKeys(isPatternString);
1489     entries_ = vector<KeyInfo>();
1490     buildEntries(isPatternString);
1491   };
1492   int getFirstKey() {
1493     entidx_ = 0;
1494     if (entries_.empty()) {
1495       return -1;
1496     }
1497     if (entries_[0].keytype == KeyInfo::isTitle) {
1498       interval_.hasTitle = true;
1499       if (! entries_[0].disabled) {
1500         interval_.titleValue = entries_[0].head;
1501       }
1502       else {
1503         interval_.titleValue = "";
1504       }
1505       removeHead(entries_[0]);
1506       if (entries_.size() > 1)
1507         return 1;
1508       else
1509         return -1;
1510     }
1511     return 0;
1512   };
1513   int getNextKey() {
1514     entidx_++;
1515     if (int(entries_.size()) > entidx_) {
1516       return entidx_;
1517     }
1518     else {
1519       return -1;
1520     }
1521   };
1522   bool setNextKey(int idx) {
1523     if ((idx == entidx_) && (entidx_ >= 0)) {
1524       entidx_--;
1525       return true;
1526     }
1527     else
1528       return false;
1529   };
1530   int find(int start, KeyInfo::KeyType keytype) const {
1531     if (start < 0)
1532       return -1;
1533     int tmpIdx = start;
1534     while (tmpIdx < int(entries_.size())) {
1535       if (entries_[tmpIdx].keytype == keytype)
1536         return tmpIdx;
1537       tmpIdx++;
1538     }
1539     return -1;
1540   };
1541   int process(ostringstream & os, KeyInfo const & actual);
1542   int dispatch(ostringstream & os, int previousStart, KeyInfo & actual);
1543   // string show(int lastpos) { return interval.show(lastpos);};
1544   int nextNotIgnored(int start) { return interval_.nextNotIgnored(start);};
1545   KeyInfo &getKeyInfo(int keyinfo) {
1546     static KeyInfo invalidInfo = KeyInfo();
1547     if ((keyinfo < 0) || ( keyinfo >= int(entries_.size())))
1548       return invalidInfo;
1549     else
1550       return entries_[keyinfo];
1551   };
1552   void setForDefaultLang(KeyInfo const & defLang) {interval_.setForDefaultLang(defLang);};
1553   void addIntervall(int low, int up) { interval_.addIntervall(low, up); };
1554 };
1555
1556
1557 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1558 {
1559   int skip = 0;
1560   int depth = 0;
1561   for (int i = start; i < end; i += 1 + skip) {
1562     char c;
1563     c = par[i];
1564     skip = 0;
1565     if (c == '\\') skip = 1;
1566     else if (c == up) {
1567       depth++;
1568     }
1569     else if (c == down) {
1570       if (depth == 0) {
1571         repeat--;
1572         if ((repeat <= 0) || (par[i+1] != up))
1573           return i;
1574       }
1575       --depth;
1576     }
1577   }
1578   return end;
1579 }
1580
1581 class MathInfo {
1582   class MathEntry {
1583   public:
1584     string wait;
1585     size_t mathEnd;
1586     size_t mathStart;
1587     size_t mathSize;
1588   };
1589   size_t actualIdx_;
1590   vector<MathEntry> entries_;
1591  public:
1592   MathInfo() {
1593     actualIdx_ = 0;
1594   }
1595   void insert(string const & wait, size_t start, size_t end) {
1596     MathEntry m = MathEntry();
1597     m.wait = wait;
1598     m.mathStart = start;
1599     m.mathEnd = end;
1600     m.mathSize = end - start;
1601     entries_.push_back(m);
1602   }
1603   bool empty() const { return entries_.empty(); };
1604   size_t getEndPos() const {
1605     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1606       return 0;
1607     }
1608     return entries_[actualIdx_].mathEnd;
1609   }
1610   size_t getStartPos() const {
1611     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1612       return 100000;                    /*  definitely enough? */
1613     }
1614     return entries_[actualIdx_].mathStart;
1615   }
1616   size_t getFirstPos() {
1617     actualIdx_ = 0;
1618     return getStartPos();
1619   }
1620   size_t getSize() const {
1621     if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1622       return size_t(0);
1623     }
1624     return entries_[actualIdx_].mathSize;
1625   }
1626   void incrEntry() { actualIdx_++; };
1627 };
1628
1629 void LatexInfo::buildEntries(bool isPatternString)
1630 {
1631   static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1632   static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1633   static bool disableLanguageOverride = false;
1634   smatch sub, submath;
1635   bool evaluatingRegexp = false;
1636   MathInfo mi;
1637   bool evaluatingMath = false;
1638   bool evaluatingCode = false;
1639   size_t codeEnd = 0;
1640   bool evaluatingOptional = false;
1641   size_t optionalEnd = 0;
1642   int codeStart = -1;
1643   KeyInfo found;
1644   bool math_end_waiting = false;
1645   size_t math_pos = 10000;
1646   string math_end;
1647
1648   interval_.removeAccents();
1649
1650   for (sregex_iterator itmath(interval_.par.begin(), interval_.par.end(), rmath), end; itmath != end; ++itmath) {
1651     submath = *itmath;
1652     if (math_end_waiting) {
1653       size_t pos = submath.position(size_t(0));
1654       if ((math_end == "$") &&
1655           (submath.str(0) == "$") &&
1656           (interval_.par[pos-1] != '\\')) {
1657         mi.insert("$", math_pos, pos + 1);
1658         math_end_waiting = false;
1659       }
1660       else if ((math_end == "\\]") &&
1661                (submath.str(0) == "\\]")) {
1662         mi.insert("\\]", math_pos, pos + 2);
1663         math_end_waiting = false;
1664       }
1665       else if ((submath.str(1).compare("end") == 0) &&
1666           (submath.str(2).compare(math_end) == 0)) {
1667         mi.insert(math_end, math_pos, pos + submath.str(0).length());
1668         math_end_waiting = false;
1669       }
1670       else
1671         continue;
1672     }
1673     else {
1674       if (submath.str(1).compare("begin") == 0) {
1675         math_end_waiting = true;
1676         math_end = submath.str(2);
1677         math_pos = submath.position(size_t(0));
1678       }
1679       else if (submath.str(0).compare("\\[") == 0) {
1680         math_end_waiting = true;
1681         math_end = "\\]";
1682         math_pos = submath.position(size_t(0));
1683       }
1684       else if (submath.str(0) == "$") {
1685         size_t pos = submath.position(size_t(0));
1686         if ((pos == 0) || (interval_.par[pos-1] != '\\')) {
1687           math_end_waiting = true;
1688           math_end = "$";
1689           math_pos = pos;
1690         }
1691       }
1692     }
1693   }
1694   // Ignore language if there is math somewhere in pattern-string
1695   if (isPatternString) {
1696     if (! mi.empty()) {
1697       // Disable language
1698       keys["foreignlanguage"].disabled = true;
1699       disableLanguageOverride = true;
1700     }
1701     else
1702       disableLanguageOverride = false;
1703   }
1704   else {
1705     if (disableLanguageOverride) {
1706       keys["foreignlanguage"].disabled = true;
1707     }
1708   }
1709   math_pos = mi.getFirstPos();
1710   for (sregex_iterator it(interval_.par.begin(), interval_.par.end(), rkeys), end; it != end; ++it) {
1711     sub = *it;
1712     string key = sub.str(3);
1713     if (key == "") {
1714       if (sub.str(0)[0] == '\\')
1715         key = sub.str(0)[1];
1716       else {
1717         key = sub.str(0);
1718         if (key == "$") {
1719           size_t k_pos = sub.position(size_t(0));
1720           if ((k_pos > 0) && (interval_.par[k_pos - 1] == '\\')) {
1721             // Escaped '$', ignoring
1722             continue;
1723           }
1724         }
1725       }
1726     };
1727     if (keys.find(key) != keys.end()) {
1728       if (keys[key].keytype == KeyInfo::headRemove) {
1729         KeyInfo found1 = keys[key];
1730         found1.disabled = true;
1731         found1.head = "\\" + key + "{";
1732         found1._tokenstart = sub.position(size_t(0));
1733         found1._tokensize = found1.head.length();
1734         found1._dataStart = found1._tokenstart + found1.head.length();
1735         int endpos = interval_.findclosing(found1._dataStart, interval_.par.length(), '{', '}', 1);
1736         found1._dataEnd = endpos;
1737         removeHead(found1);
1738         continue;
1739       }
1740     }
1741     if (evaluatingRegexp) {
1742       if (sub.str(1).compare("endregexp") == 0) {
1743         evaluatingRegexp = false;
1744         // found._tokenstart already set
1745         found._dataEnd = sub.position(size_t(0)) + 13;
1746         found._dataStart = found._dataEnd;
1747         found._tokensize = found._dataEnd - found._tokenstart;
1748         found.parenthesiscount = 0;
1749         found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1750       }
1751       else {
1752         continue;
1753       }
1754     }
1755     else {
1756       if (evaluatingMath) {
1757         if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1758           continue;
1759         evaluatingMath = false;
1760         mi.incrEntry();
1761         math_pos = mi.getStartPos();
1762       }
1763       if (keys.find(key) == keys.end()) {
1764         found = KeyInfo(KeyInfo::isStandard, 0, true);
1765         if (isPatternString) {
1766           found.keytype = KeyInfo::isChar;
1767           found.disabled = false;
1768           found.used = true;
1769         }
1770         keys[key] = found;
1771       }
1772       else
1773         found = keys[key];
1774       if (key.compare("regexp") == 0) {
1775         evaluatingRegexp = true;
1776         found._tokenstart = sub.position(size_t(0));
1777         found._tokensize = 0;
1778         continue;
1779       }
1780     }
1781     // Handle the other params of key
1782     if (found.keytype == KeyInfo::isIgnored)
1783       continue;
1784     else if (found.keytype == KeyInfo::isMath) {
1785       if (size_t(sub.position(size_t(0))) == math_pos) {
1786         found = keys[key];
1787         found._tokenstart = sub.position(size_t(0));
1788         found._tokensize = mi.getSize();
1789         found._dataEnd = found._tokenstart + found._tokensize;
1790         found._dataStart = found._dataEnd;
1791         found.parenthesiscount = 0;
1792         found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1793         evaluatingMath = true;
1794       }
1795       else {
1796         // begin|end of unknown env, discard
1797         // First handle tables
1798         // longtable|tabular
1799         bool discardComment;
1800         found = keys[key];
1801         found.keytype = KeyInfo::doRemove;
1802         if ((sub.str(5).compare("longtable") == 0) ||
1803             (sub.str(5).compare("tabular") == 0)) {
1804           discardComment = true;        /* '%' */
1805         }
1806         else {
1807           discardComment = false;
1808           static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1809           smatch sub2;
1810           string token = sub.str(5);
1811           if (regex_match(token, sub2, removeArgs)) {
1812             found.keytype = KeyInfo::removeWithArg;
1813           }
1814         }
1815         // discard spaces before pos(0)
1816         int pos = sub.position(size_t(0));
1817         int count;
1818         for (count = 0; pos - count > 0; count++) {
1819           char c = interval_.par[pos-count-1];
1820           if (discardComment) {
1821             if ((c != ' ') && (c != '%'))
1822               break;
1823           }
1824           else if (c != ' ')
1825             break;
1826         }
1827         found._tokenstart = pos - count;
1828         if (sub.str(1).compare(0, 5, "begin") == 0) {
1829           size_t pos1 = pos + sub.str(0).length();
1830           if (sub.str(5).compare("cjk") == 0) {
1831             pos1 = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1832             if ((interval_.par[pos1] == '{') && (interval_.par[pos1+1] == '}'))
1833               pos1 += 2;
1834             found.keytype = KeyInfo::isMain;
1835             found._dataStart = pos1;
1836             found._dataEnd = interval_.par.length();
1837             found.disabled = keys["foreignlanguage"].disabled;
1838             found.used = keys["foreignlanguage"].used;
1839             found._tokensize = pos1 - found._tokenstart;
1840             found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1841           }
1842           else {
1843             // Swallow possible optional params
1844             while (interval_.par[pos1] == '[') {
1845               pos1 = interval_.findclosing(pos1+1, interval_.par.length(), '[', ']')+1;
1846             }
1847             // Swallow also the eventual parameter
1848             if (interval_.par[pos1] == '{') {
1849               found._dataEnd = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1850             }
1851             else {
1852               found._dataEnd = pos1;
1853             }
1854             found._dataStart = found._dataEnd;
1855             found._tokensize = count + found._dataEnd - pos;
1856             found.parenthesiscount = 0;
1857             found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1858             found.disabled = true;
1859           }
1860         }
1861         else {
1862           // Handle "\end{...}"
1863           found._dataStart = pos + sub.str(0).length();
1864           found._dataEnd = found._dataStart;
1865           found._tokensize = count + found._dataEnd - pos;
1866           found.parenthesiscount = 0;
1867           found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1868           found.disabled = true;
1869         }
1870       }
1871     }
1872     else if (found.keytype != KeyInfo::isRegex) {
1873       found._tokenstart = sub.position(size_t(0));
1874       if (found.parenthesiscount == 0) {
1875         // Probably to be discarded
1876         size_t following_pos = sub.position(size_t(0)) + sub.str(3).length() + 1;
1877         char following = interval_.par[following_pos];
1878         if (following == ' ')
1879           found.head = "\\" + sub.str(3) + " ";
1880         else if (following == '=') {
1881           // like \uldepth=1000pt
1882           found.head = sub.str(0);
1883         }
1884         else
1885           found.head = "\\" + key;
1886         found._tokensize = found.head.length();
1887         found._dataEnd = found._tokenstart + found._tokensize;
1888         found._dataStart = found._dataEnd;
1889       }
1890       else {
1891         int params = found._tokenstart + key.length() + 1;
1892         if (evaluatingOptional) {
1893           if (size_t(found._tokenstart) > optionalEnd) {
1894             evaluatingOptional = false;
1895           }
1896           else {
1897             found.disabled = true;
1898           }
1899         }
1900         int optend = params;
1901         while (interval_.par[optend] == '[') {
1902           // discard optional parameters
1903           optend = interval_.findclosing(optend+1, interval_.par.length(), '[', ']') + 1;
1904         }
1905         if (optend > params) {
1906           key += interval_.par.substr(params, optend-params);
1907           evaluatingOptional = true;
1908           optionalEnd = optend;
1909         }
1910         string token = sub.str(5);
1911         int closings = found.parenthesiscount;
1912         if (found.parenthesiscount == 1) {
1913           found.head = "\\" + key + "{";
1914         }
1915         else if (found.parenthesiscount > 1) {
1916           if (token != "") {
1917             found.head = sub.str(0) + "{";
1918             closings = found.parenthesiscount - 1;
1919           }
1920           else {
1921             found.head = "\\" + key + "{";
1922           }
1923         }
1924         found._tokensize = found.head.length();
1925         found._dataStart = found._tokenstart + found.head.length();
1926         if (found.keytype == KeyInfo::doRemove) {
1927           int endpar = 2 + interval_.findclosing(found._dataStart, interval_.par.length(), '{', '}', closings);
1928           found._dataStart = endpar;
1929           found._tokensize = found._dataStart - found._tokenstart;
1930           closings = 0;
1931         }
1932         if (interval_.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
1933           found._dataStart += 15;
1934         }
1935         size_t endpos;
1936         if (closings < 1)
1937           endpos = found._dataStart - 1;
1938         else
1939           endpos = interval_.findclosing(found._dataStart, interval_.par.length(), '{', '}', closings);
1940         if (found.keytype == KeyInfo::isList) {
1941           // Check if it really is list env
1942           static regex const listre("^([a-z]+)$");
1943           smatch sub2;
1944           if (!regex_match(token, sub2, listre)) {
1945             // Change the key of this entry. It is not in a list/item environment
1946             found.keytype = KeyInfo::endArguments;
1947           }
1948         }
1949         if (found.keytype == KeyInfo::noMain) {
1950           evaluatingCode = true;
1951           codeEnd = endpos;
1952           codeStart = found._dataStart;
1953         }
1954         else if (evaluatingCode) {
1955           if (size_t(found._dataStart) > codeEnd)
1956             evaluatingCode = false;
1957           else if (found.keytype == KeyInfo::isMain) {
1958             // Disable this key, treate it as standard
1959             found.keytype = KeyInfo::isStandard;
1960             found.disabled = true;
1961             if ((codeEnd == interval_.par.length()) &&
1962                 (found._tokenstart == codeStart)) {
1963               // trickery, because the code inset starts
1964               // with \selectlanguage ...
1965               codeEnd = endpos;
1966               if (entries_.size() > 1) {
1967                 entries_[entries_.size()-1]._dataEnd = codeEnd;
1968               }
1969             }
1970           }
1971         }
1972         if ((endpos == interval_.par.length()) &&
1973             (found.keytype == KeyInfo::doRemove)) {
1974           // Missing closing => error in latex-input?
1975           // therefore do not delete remaining data
1976           found._dataStart -= 1;
1977           found._dataEnd = found._dataStart;
1978         }
1979         else
1980           found._dataEnd = endpos;
1981       }
1982       if (isPatternString) {
1983         keys[key].used = true;
1984       }
1985     }
1986     entries_.push_back(found);
1987   }
1988 }
1989
1990 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1991 {
1992   stringstream s(keysstring);
1993   string key;
1994   const char delim = '|';
1995   while (getline(s, key, delim)) {
1996     KeyInfo keyII(keyI);
1997     if (isPatternString) {
1998       keyII.used = false;
1999     }
2000     else if ( !keys[key].used)
2001       keyII.disabled = true;
2002     keys[key] = keyII;
2003   }
2004 }
2005
2006 void LatexInfo::buildKeys(bool isPatternString)
2007 {
2008
2009   static bool keysBuilt = false;
2010   if (keysBuilt && !isPatternString) return;
2011
2012   // Keys to ignore in any case
2013   makeKey("text|textcyrillic|lyxmathsym", KeyInfo(KeyInfo::headRemove, 1, true), true);
2014   // Known standard keys with 1 parameter.
2015   // Split is done, if not at start of region
2016   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
2017   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
2018   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
2019   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
2020   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
2021   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
2022
2023   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
2024           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
2025   makeKey("section*|subsection*|subsubsection*|paragraph*",
2026           KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
2027   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
2028   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
2029   // Regex
2030   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
2031
2032   // Split is done, if not at start of region
2033   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
2034   makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
2035
2036   // Split is done always.
2037   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
2038
2039   // Known charaters
2040   // No split
2041   makeKey("backslash|textbackslash|slash",  KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2042   makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2043   makeKey("textasciiacute|texemdash",       KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2044   makeKey("dots|ldots",                     KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2045   // Spaces
2046   makeKey("quad|qquad|hfill|dotfill",               KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2047   makeKey("textvisiblespace|nobreakspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2048   makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2049   makeKey("thickspace|medspace|thinspace",          KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2050   // Skip
2051   // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2052   // Custom space/skip, remove the content (== length value)
2053   makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
2054   // Found in fr/UserGuide.lyx
2055   makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2056   // quotes
2057   makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2058   makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2059   // Known macros to remove (including their parameter)
2060   // No split
2061   makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
2062   makeKey("addtocounter|setlength",                 KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
2063   // handle like standard keys with 1 parameter.
2064   makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
2065
2066   // Ignore deleted text
2067   makeKey("lyxdeleted", KeyInfo(KeyInfo::doRemove, 3, false), isPatternString);
2068   // but preserve added text
2069   makeKey("lyxadded", KeyInfo(KeyInfo::doRemove, 2, false), isPatternString);
2070
2071   // Macros to remove, but let the parameter survive
2072   // No split
2073   makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2074
2075   // Remove language spec from content of these insets
2076   makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
2077
2078   // Same effect as previous, parameter will survive (because there is no one anyway)
2079   // No split
2080   makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2081   // Remove table decorations
2082   makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
2083   // Discard shape-header.
2084   // For footnote or shortcut too, because of lang settings
2085   // and wrong handling if used 'KeyInfo::noMain'
2086   makeKey("circlepar|diamondpar|heartpar|nutpar",  KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2087   makeKey("trianglerightpar|hexagonpar|starpar",   KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2088   makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2089   makeKey("triangleleftpar|shapepar|dropuppar",    KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2090   makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics",     KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2091   makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2092   // like ('tiny{}' or '\tiny ' ... )
2093   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2094
2095   // Survives, like known character
2096   makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2097   makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2098
2099   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2100   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2101   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2102
2103   makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2104   // Remove RTL/LTR marker
2105   makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2106   makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2107   makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2108   makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2109   makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2110   makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2111   makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2112   if (isPatternString) {
2113     // Allow the first searched string to rebuild the keys too
2114     keysBuilt = false;
2115   }
2116   else {
2117     // no need to rebuild again
2118     keysBuilt = true;
2119   }
2120 }
2121
2122 /*
2123  * Keep the list of actual opened parentheses actual
2124  * (e.g. depth == 4 means there are 4 '{' not processed yet)
2125  */
2126 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2127 {
2128   int skip = 0;
2129   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2130     char c;
2131     c = par[i];
2132     skip = 0;
2133     if (c == '\\') skip = 1;
2134     else if (c == '{') {
2135       handleOpenP(i);
2136     }
2137     else if (c == '}') {
2138       handleCloseP(i, closingAllowed);
2139     }
2140   }
2141 }
2142
2143 #if (0)
2144 string Intervall::show(int lastpos)
2145 {
2146   int idx = 0;                          /* int intervalls */
2147   string s;
2148   int i = 0;
2149   for (idx = 0; idx <= ignoreidx; idx++) {
2150     while (i < lastpos) {
2151       int printsize;
2152       if (i <= borders[idx].low) {
2153         if (borders[idx].low > lastpos)
2154           printsize = lastpos - i;
2155         else
2156           printsize = borders[idx].low - i;
2157         s += par.substr(i, printsize);
2158         i += printsize;
2159         if (i >= borders[idx].low)
2160           i = borders[idx].upper;
2161       }
2162       else {
2163         i = borders[idx].upper;
2164         break;
2165       }
2166     }
2167   }
2168   if (lastpos > i) {
2169     s += par.substr(i, lastpos-i);
2170   }
2171   return s;
2172 }
2173 #endif
2174
2175 void Intervall::output(ostringstream &os, int lastpos)
2176 {
2177   // get number of chars to output
2178   int idx = 0;                          /* int intervalls */
2179   int i = 0;
2180   int printed = 0;
2181   string startTitle = titleValue;
2182   for (idx = 0; idx <= ignoreidx; idx++) {
2183     if (i < lastpos) {
2184       if (i <= borders[idx].low) {
2185         int printsize;
2186         if (borders[idx].low > lastpos)
2187           printsize = lastpos - i;
2188         else
2189           printsize = borders[idx].low - i;
2190         if (printsize > 0) {
2191           os << startTitle << par.substr(i, printsize);
2192           i += printsize;
2193           printed += printsize;
2194           startTitle = "";
2195         }
2196         handleParentheses(i, false);
2197         if (i >= borders[idx].low)
2198           i = borders[idx].upper;
2199       }
2200       else {
2201         i = borders[idx].upper;
2202       }
2203     }
2204     else
2205       break;
2206   }
2207   if (lastpos > i) {
2208     os << startTitle << par.substr(i, lastpos-i);
2209     printed += lastpos-i;
2210   }
2211   handleParentheses(lastpos, false);
2212   int startindex;
2213   if (keys["foreignlanguage"].disabled)
2214     startindex = actualdeptindex-langcount;
2215   else
2216     startindex = actualdeptindex;
2217   for (int i = startindex; i > 0; --i) {
2218     os << "}";
2219   }
2220   if (hasTitle && (printed > 0))
2221     os << "}";
2222   if (! isPatternString_)
2223     os << "\n";
2224   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2225 }
2226
2227 void LatexInfo::processRegion(int start, int region_end)
2228 {
2229   while (start < region_end) {          /* Let {[} and {]} survive */
2230     int cnt = interval_.isOpeningPar(start);
2231     if (cnt == 1) {
2232       // Closing is allowed past the region
2233       int closing = interval_.findclosing(start+1, interval_.par.length());
2234       interval_.addIntervall(start, start+1);
2235       interval_.addIntervall(closing, closing+1);
2236     }
2237     else if (cnt == 3)
2238       start += 2;
2239     start = interval_.nextNotIgnored(start+1);
2240   }
2241 }
2242
2243 void LatexInfo::removeHead(KeyInfo const & actual, int count)
2244 {
2245   if (actual.parenthesiscount == 0) {
2246     // "{\tiny{} ...}" ==> "{{} ...}"
2247     interval_.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2248   }
2249   else {
2250     // Remove header hull, that is "\url{abcd}" ==> "abcd"
2251     interval_.addIntervall(actual._tokenstart - count, actual._dataStart);
2252     interval_.addIntervall(actual._dataEnd, actual._dataEnd+1);
2253   }
2254 }
2255
2256 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2257 {
2258   int nextKeyIdx = 0;
2259   switch (actual.keytype)
2260   {
2261     case KeyInfo::isTitle: {
2262       removeHead(actual);
2263       nextKeyIdx = getNextKey();
2264       break;
2265     }
2266     case KeyInfo::cleanToStart: {
2267       actual._dataEnd = actual._dataStart;
2268       nextKeyIdx = getNextKey();
2269       // Search for end of arguments
2270       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2271       if (tmpIdx > 0) {
2272         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2273           entries_[i].disabled = true;
2274         }
2275         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2276       }
2277       while (interval_.par[actual._dataEnd] == ' ')
2278         actual._dataEnd++;
2279       interval_.addIntervall(0, actual._dataEnd+1);
2280       interval_.actualdeptindex = 0;
2281       interval_.depts[0] = actual._dataEnd+1;
2282       interval_.closes[0] = -1;
2283       break;
2284     }
2285     case KeyInfo::noContent: {          /* char like "\hspace{2cm}" */
2286       if (actual.disabled)
2287         interval_.addIntervall(actual._tokenstart, actual._dataEnd);
2288       else
2289         interval_.addIntervall(actual._dataStart, actual._dataEnd);
2290     }
2291       // fall through
2292     case KeyInfo::isChar: {
2293       nextKeyIdx = getNextKey();
2294       break;
2295     }
2296     case KeyInfo::isSize: {
2297       if (actual.disabled || (interval_.par[actual._dataStart] != '{') || (interval_.par[actual._dataStart-1] == ' ')) {
2298         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
2299         interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2300         nextKeyIdx = getNextKey();
2301       } else {
2302         // Here _dataStart points to '{', so correct it
2303         actual._dataStart += 1;
2304         actual._tokensize += 1;
2305         actual.parenthesiscount = 1;
2306         if (interval_.par[actual._dataStart] == '}') {
2307           // Determine the end if used like '{\tiny{}...}'
2308           actual._dataEnd = interval_.findclosing(actual._dataStart+1, interval_.par.length()) + 1;
2309           interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2310         }
2311         else {
2312           // Determine the end if used like '\tiny{...}'
2313           actual._dataEnd = interval_.findclosing(actual._dataStart, interval_.par.length()) + 1;
2314         }
2315         // Split on this key if not at start
2316         int start = interval_.nextNotIgnored(previousStart);
2317         if (start < actual._tokenstart) {
2318           interval_.output(os, actual._tokenstart);
2319           interval_.addIntervall(start, actual._tokenstart);
2320         }
2321         // discard entry if at end of actual
2322         nextKeyIdx = process(os, actual);
2323       }
2324       break;
2325     }
2326     case KeyInfo::endArguments: {
2327       // Remove trailing '{}' too
2328       actual._dataStart += 1;
2329       actual._dataEnd += 1;
2330       interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2331       nextKeyIdx = getNextKey();
2332       break;
2333     }
2334     case KeyInfo::noMain:
2335       // fall through
2336     case KeyInfo::isStandard: {
2337       if (actual.disabled) {
2338         removeHead(actual);
2339         processRegion(actual._dataStart, actual._dataStart+1);
2340         nextKeyIdx = getNextKey();
2341       } else {
2342         // Split on this key if not at datastart of calling entry
2343         int start = interval_.nextNotIgnored(previousStart);
2344         if (start < actual._tokenstart) {
2345           interval_.output(os, actual._tokenstart);
2346           interval_.addIntervall(start, actual._tokenstart);
2347         }
2348         // discard entry if at end of actual
2349         nextKeyIdx = process(os, actual);
2350       }
2351       break;
2352     }
2353     case KeyInfo::removeWithArg: {
2354       nextKeyIdx = getNextKey();
2355       // Search for end of arguments
2356       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2357       if (tmpIdx > 0) {
2358         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2359           entries_[i].disabled = true;
2360         }
2361         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2362       }
2363       interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2364       break;
2365     }
2366     case KeyInfo::doRemove: {
2367       // Remove the key with all parameters and following spaces
2368       size_t pos;
2369       for (pos = actual._dataEnd+1; pos < interval_.par.length(); pos++) {
2370         if ((interval_.par[pos] != ' ') && (interval_.par[pos] != '%'))
2371           break;
2372       }
2373       // Remove also enclosing parentheses [] and {}
2374       int numpars = 0;
2375       int spaces = 0;
2376       while (actual._tokenstart > numpars) {
2377         if (pos+numpars >= interval_.par.size())
2378           break;
2379         else if (interval_.par[pos+numpars] == ']' && interval_.par[actual._tokenstart-numpars-1] == '[')
2380           numpars++;
2381         else if (interval_.par[pos+numpars] == '}' && interval_.par[actual._tokenstart-numpars-1] == '{')
2382           numpars++;
2383         else
2384           break;
2385       }
2386       if (numpars > 0) {
2387         if (interval_.par[pos+numpars] == ' ')
2388           spaces++;
2389       }
2390
2391       interval_.addIntervall(actual._tokenstart-numpars, pos+numpars+spaces);
2392       nextKeyIdx = getNextKey();
2393       break;
2394     }
2395     case KeyInfo::isList: {
2396       // Discard space before _tokenstart
2397       int count;
2398       for (count = 0; count < actual._tokenstart; count++) {
2399         if (interval_.par[actual._tokenstart-count-1] != ' ')
2400           break;
2401       }
2402       nextKeyIdx = getNextKey();
2403       int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2404       if (tmpIdx > 0) {
2405         // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2406         // with arguments
2407         // How else can we catch this one?
2408         for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2409           entries_[i].disabled = true;
2410         }
2411         actual._dataEnd = entries_[tmpIdx]._dataEnd;
2412       }
2413       else if (nextKeyIdx > 0) {
2414         // Ignore any lang entries inside data region
2415         for (int i = nextKeyIdx; i < int(entries_.size()) && entries_[i]._tokenstart < actual._dataEnd; i++) {
2416           if (entries_[i].keytype == KeyInfo::isMain)
2417             entries_[i].disabled = true;
2418         }
2419       }
2420       if (actual.disabled) {
2421         interval_.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2422       }
2423       else {
2424         interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2425       }
2426       if (interval_.par[actual._dataEnd+1] == '[') {
2427         int posdown = interval_.findclosing(actual._dataEnd+2, interval_.par.length(), '[', ']');
2428         if ((interval_.par[actual._dataEnd+2] == '{') &&
2429             (interval_.par[posdown-1] == '}')) {
2430           interval_.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2431           interval_.addIntervall(posdown-1, posdown+1);
2432         }
2433         else {
2434           interval_.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2435           interval_.addIntervall(posdown, posdown+1);
2436         }
2437         int blk = interval_.nextNotIgnored(actual._dataEnd+1);
2438         if (blk > posdown) {
2439           // Discard at most 1 space after empty item
2440           int count;
2441           for (count = 0; count < 1; count++) {
2442             if (interval_.par[blk+count] != ' ')
2443               break;
2444           }
2445           if (count > 0)
2446             interval_.addIntervall(blk, blk+count);
2447         }
2448       }
2449       break;
2450     }
2451     case KeyInfo::isSectioning: {
2452       // Discard spaces before _tokenstart
2453       int count;
2454       int val = actual._tokenstart;
2455       for (count = 0; count < actual._tokenstart;) {
2456         val = interval_.previousNotIgnored(val-1);
2457         if (val < 0 || interval_.par[val] != ' ')
2458           break;
2459         else {
2460           count = actual._tokenstart - val;
2461         }
2462       }
2463       if (actual.disabled) {
2464         removeHead(actual, count);
2465         nextKeyIdx = getNextKey();
2466       } else {
2467         interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2468         nextKeyIdx = process(os, actual);
2469       }
2470       break;
2471     }
2472     case KeyInfo::isMath: {
2473       // Same as regex, use the content unchanged
2474       nextKeyIdx = getNextKey();
2475       break;
2476     }
2477     case KeyInfo::isRegex: {
2478       // DO NOT SPLIT ON REGEX
2479       // Do not disable
2480       nextKeyIdx = getNextKey();
2481       break;
2482     }
2483     case KeyInfo::isIgnored: {
2484       // Treat like a character for now
2485       nextKeyIdx = getNextKey();
2486       break;
2487     }
2488     case KeyInfo::isMain: {
2489       if (interval_.par.substr(actual._dataStart, 2) == "% ")
2490         interval_.addIntervall(actual._dataStart, actual._dataStart+2);
2491       if (actual._tokenstart > 0) {
2492         int prev = interval_.previousNotIgnored(actual._tokenstart - 1);
2493         if ((prev >= 0) && interval_.par[prev] == '%')
2494           interval_.addIntervall(prev, prev+1);
2495       }
2496       if (actual.disabled) {
2497         removeHead(actual);
2498         interval_.langcount++;
2499         if ((interval_.par.substr(actual._dataStart, 3) == " \\[") ||
2500             (interval_.par.substr(actual._dataStart, 8) == " \\begin{")) {
2501           // Discard also the space before math-equation
2502           interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2503         }
2504         nextKeyIdx = getNextKey();
2505         // interval.resetOpenedP(actual._dataStart-1);
2506       }
2507       else {
2508         if (actual._tokenstart < 26) {
2509           // for the first (and maybe dummy) language
2510           interval_.setForDefaultLang(actual);
2511         }
2512         interval_.resetOpenedP(actual._dataStart-1);
2513       }
2514       break;
2515     }
2516     case KeyInfo::invalid:
2517     case KeyInfo::headRemove:
2518       // These two cases cannot happen, already handled
2519       // fall through
2520     default: {
2521       // LYXERR(Debug::INFO, "Unhandled keytype");
2522       nextKeyIdx = getNextKey();
2523       break;
2524     }
2525   }
2526   return nextKeyIdx;
2527 }
2528
2529 int LatexInfo::process(ostringstream & os, KeyInfo const & actual )
2530 {
2531   int end = interval_.nextNotIgnored(actual._dataEnd);
2532   int oldStart = actual._dataStart;
2533   int nextKeyIdx = getNextKey();
2534   while (true) {
2535     if ((nextKeyIdx < 0) ||
2536         (entries_[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2537         (entries_[nextKeyIdx].keytype == KeyInfo::invalid)) {
2538       if (oldStart <= end) {
2539         processRegion(oldStart, end);
2540         oldStart = end+1;
2541       }
2542       break;
2543     }
2544     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2545
2546     if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2547       (void) dispatch(os, actual._dataStart, nextKey);
2548       end = nextKey._tokenstart;
2549       break;
2550     }
2551     processRegion(oldStart, nextKey._tokenstart);
2552     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2553
2554     oldStart = nextKey._dataEnd+1;
2555   }
2556   // now nextKey is either invalid or is outside of actual._dataEnd
2557   // output the remaining and discard myself
2558   if (oldStart <= end) {
2559     processRegion(oldStart, end);
2560   }
2561   if (interval_.par.size() > (size_t) end && interval_.par[end] == '}') {
2562     end += 1;
2563     // This is the normal case.
2564     // But if using the firstlanguage, the closing may be missing
2565   }
2566   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2567   int output_end;
2568   if (actual._dataEnd < end)
2569     output_end = interval_.nextNotIgnored(actual._dataEnd);
2570   else
2571     output_end = interval_.nextNotIgnored(end);
2572   if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2573     interval_.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2574   }
2575   // Remove possible empty data
2576   int dstart = interval_.nextNotIgnored(actual._dataStart);
2577   while (interval_.isOpeningPar(dstart) == 1) {
2578     interval_.addIntervall(dstart, dstart+1);
2579     int dend = interval_.findclosing(dstart+1, output_end);
2580     interval_.addIntervall(dend, dend+1);
2581     dstart = interval_.nextNotIgnored(dstart+1);
2582   }
2583   if (dstart < output_end)
2584     interval_.output(os, output_end);
2585   interval_.addIntervall(actual._tokenstart, end);
2586   return nextKeyIdx;
2587 }
2588
2589 string splitOnKnownMacros(string par, bool isPatternString)
2590 {
2591   ostringstream os;
2592   LatexInfo li(par, isPatternString);
2593   // LYXERR(Debug::INFO, "Berfore split: " << par);
2594   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2595   DummyKey.head = "";
2596   DummyKey._tokensize = 0;
2597   DummyKey._dataStart = 0;
2598   DummyKey._dataEnd = par.length();
2599   DummyKey.disabled = true;
2600   int firstkeyIdx = li.getFirstKey();
2601   string s;
2602   if (firstkeyIdx >= 0) {
2603     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2604     DummyKey._tokenstart = firstKey._tokenstart;
2605     int nextkeyIdx;
2606     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2607       // Use dummy firstKey
2608       firstKey = DummyKey;
2609       (void) li.setNextKey(firstkeyIdx);
2610     }
2611     else {
2612       if (par.substr(firstKey._dataStart, 2) == "% ")
2613         li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2614     }
2615     nextkeyIdx = li.process(os, firstKey);
2616     while (nextkeyIdx >= 0) {
2617       // Check for a possible gap between the last
2618       // entry and this one
2619       int datastart = li.nextNotIgnored(firstKey._dataStart);
2620       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2621       if ((nextKey._tokenstart > datastart)) {
2622         // Handle the gap
2623         firstKey._dataStart = datastart;
2624         firstKey._dataEnd = par.length();
2625         (void) li.setNextKey(nextkeyIdx);
2626         // Fake the last opened parenthesis
2627         li.setForDefaultLang(firstKey);
2628         nextkeyIdx = li.process(os, firstKey);
2629       }
2630       else {
2631         if (nextKey.keytype != KeyInfo::isMain) {
2632           firstKey._dataStart = datastart;
2633           firstKey._dataEnd = nextKey._dataEnd+1;
2634           (void) li.setNextKey(nextkeyIdx);
2635           li.setForDefaultLang(firstKey);
2636           nextkeyIdx = li.process(os, firstKey);
2637         }
2638         else {
2639           nextkeyIdx = li.process(os, nextKey);
2640         }
2641       }
2642     }
2643     // Handle the remaining
2644     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2645     firstKey._dataEnd = par.length();
2646     // Check if ! empty
2647     if ((firstKey._dataStart < firstKey._dataEnd) &&
2648         (par[firstKey._dataStart] != '}')) {
2649       li.setForDefaultLang(firstKey);
2650       (void) li.process(os, firstKey);
2651     }
2652     s = os.str();
2653     if (s.empty()) {
2654       // return string definitelly impossible to match
2655       s = "\\foreignlanguage{ignore}{ }";
2656     }
2657   }
2658   else
2659     s = par;                            /* no known macros found */
2660   // LYXERR(Debug::INFO, "After split: " << s);
2661   return s;
2662 }
2663
2664 /*
2665  * Try to unify the language specs in the latexified text.
2666  * Resulting modified string is set to "", if
2667  * the searched tex does not contain all the features in the search pattern
2668  */
2669 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2670 {
2671         static Features regex_f;
2672         static int missed = 0;
2673         static bool regex_with_format = false;
2674
2675         int parlen = par.length();
2676
2677         while ((parlen > 0) && (par[parlen-1] == '\n')) {
2678                 parlen--;
2679         }
2680         if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2681                 // Happens to be there in case of description or labeling environment
2682                 parlen--;
2683         }
2684         string result;
2685         if (withformat) {
2686                 // Split the latex input into pieces which
2687                 // can be digested by our search engine
2688                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2689                 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2690                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2691         }
2692         else
2693                 result = par.substr(0, parlen);
2694         if (isPatternString) {
2695                 missed = 0;
2696                 if (withformat) {
2697                         regex_f = identifyFeatures(result);
2698                         string features = "";
2699                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2700                                 string a = it->first;
2701                                 regex_with_format = true;
2702                                 features += " " + a;
2703                                 // LYXERR(Debug::INFO, "Identified regex format:" << a);
2704                         }
2705                         LYXERR(Debug::FIND, "Identified Features" << features);
2706
2707                 }
2708         } else if (regex_with_format) {
2709                 Features info = identifyFeatures(result);
2710                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2711                         string a = it->first;
2712                         bool b = it->second;
2713                         if (b && ! info[a]) {
2714                                 missed++;
2715                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2716                                 return "";
2717                         }
2718                 }
2719         }
2720         else {
2721                 // LYXERR(Debug::INFO, "No regex formats");
2722         }
2723         return result;
2724 }
2725
2726
2727 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2728 static int identifyClosing(string & t)
2729 {
2730         int open_braces = 0;
2731         do {
2732                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2733                 if (regex_replace(t, t, "(.*[^\\\\])\\$$", "$1"))
2734                         continue;
2735                 if (regex_replace(t, t, "(.*[^\\\\])\\\\\\]$", "$1"))
2736                         continue;
2737                 if (regex_replace(t, t, "(.*[^\\\\])\\\\end\\{[a-zA-Z_]*\\*?\\}$", "$1"))
2738                         continue;
2739                 if (regex_replace(t, t, "(.*[^\\\\])\\}$", "$1")) {
2740                         ++open_braces;
2741                         continue;
2742                 }
2743                 break;
2744         } while (true);
2745         return open_braces;
2746 }
2747
2748 static int num_replaced = 0;
2749 static bool previous_single_replace = true;
2750
2751 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2752         : p_buf(&buf), p_first_buf(&buf), opt(opt)
2753 {
2754         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2755         docstring const & ds = stringifySearchBuffer(find_buf, opt);
2756         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2757         if (opt.replace_all && previous_single_replace) {
2758                 previous_single_replace = false;
2759                 num_replaced = 0;
2760         }
2761         else if (!opt.replace_all) {
2762                 num_replaced = 0;       // count number of replaced strings
2763                 previous_single_replace = true;
2764         }
2765         // When using regexp, braces are hacked already by escape_for_regex()
2766         par_as_string = normalize(ds, !use_regexp);
2767         open_braces = 0;
2768         close_wildcards = 0;
2769
2770         size_t lead_size = 0;
2771         // correct the language settings
2772         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2773         if (opt.ignoreformat) {
2774                 if (!use_regexp) {
2775                         // if par_as_string_nolead were emty,
2776                         // the following call to findAux will always *find* the string
2777                         // in the checked data, and thus always using the slow
2778                         // examining of the current text part.
2779                         par_as_string_nolead = par_as_string;
2780                 }
2781         } else {
2782                 lead_size = identifyLeading(par_as_string);
2783                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2784                 lead_as_string = par_as_string.substr(0, lead_size);
2785                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2786         }
2787
2788         if (!use_regexp) {
2789                 open_braces = identifyClosing(par_as_string);
2790                 identifyClosing(par_as_string_nolead);
2791                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2792                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2793         } else {
2794                 string lead_as_regexp;
2795                 if (lead_size > 0) {
2796                         // @todo No need to search for \regexp{} insets in leading material
2797                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2798                         par_as_string = par_as_string_nolead;
2799                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2800                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2801                 }
2802                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2803                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2804                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2805                 if (
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 '\\\]' ('\]' has been escaped by escape_for_regex)
2809                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2810                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2811                         || regex_replace(par_as_string, par_as_string,
2812                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2813                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2814                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2815                         ) {
2816                         ++close_wildcards;
2817                 }
2818                 if (!opt.ignoreformat) {
2819                         // Remove extra '\}' at end if not part of \{\.\}
2820                         size_t lng = par_as_string.size();
2821                         while(lng > 2) {
2822                                 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
2823                                         if (lng >= 6) {
2824                                                 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
2825                                                         break;
2826                                         }
2827                                         lng -= 2;
2828                                         open_braces++;
2829                                 }
2830         else
2831                                         break;
2832 }
2833                         if (lng < par_as_string.size())
2834                                 par_as_string = par_as_string.substr(0,lng);
2835                         /*
2836                         // save '\.'
2837                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2838                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2839                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2840                         // replace '[^...]' with '[^...\}\{\\]'
2841                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2842                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2843                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2844                         // restore '\.'
2845                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2846                         */
2847                 }
2848                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2849                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2850                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
2851                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2852
2853                 // If entered regexp must match at begin of searched string buffer
2854                 // Kornel: Added parentheses to use $1 for size of the leading string
2855                 string regexp_str;
2856                 string regexp2_str;
2857                 {
2858                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2859                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
2860                         // so the convert has no effect in that case
2861                         for (int i = 8; i > 0; --i) {
2862                                 string orig = "\\\\" + std::to_string(i);
2863                                 string dest = "\\" + std::to_string(i+1);
2864                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
2865                         }
2866                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2867                         regexp2_str = "(" + lead_as_regexp + ").*?" + par_as_string;
2868                 }
2869                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2870                 regexp = regex(regexp_str);
2871
2872                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2873                 regexp2 = regex(regexp2_str);
2874         }
2875 }
2876
2877
2878 // Count number of characters in string
2879 // {]} ==> 1
2880 // \&  ==> 1
2881 // --- ==> 1
2882 // \\[a-zA-Z]+ ==> 1
2883 static int computeSize(string s, int len)
2884 {
2885         if (len == 0)
2886                 return 0;
2887         int skip = 1;
2888         int count = 0;
2889         for (int i = 0; i < len; i += skip, count++) {
2890                 if (s[i] == '\\') {
2891                         skip = 2;
2892                         if (isalpha(s[i+1])) {
2893                                 for (int j = 2;  i+j < len; j++) {
2894                                         if (! isalpha(s[i+j])) {
2895                                                 if (s[i+j] == ' ')
2896                                                         skip++;
2897                                                 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2898                                                         skip += 2;
2899                                                 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2900                                                         skip++;
2901                                                 break;
2902                                         }
2903                                         skip++;
2904                                 }
2905                         }
2906                 }
2907                 else if (s[i] == '{') {
2908                         if (s[i+1] == '}')
2909                                 skip = 2;
2910                         else
2911                                 skip = 3;
2912                 }
2913                 else if (s[i] == '-') {
2914                         if (s[i+1] == '-') {
2915                                 if (s[i+2] == '-')
2916                                         skip = 3;
2917                                 else
2918                                         skip = 2;
2919                         }
2920                         else
2921                                 skip = 1;
2922                 }
2923                 else {
2924                         skip = 1;
2925                 }
2926         }
2927         return count;
2928 }
2929
2930 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2931 {
2932         MatchResult mres;
2933
2934         if (at_begin &&
2935                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2936                 return mres;
2937
2938         docstring docstr = stringifyFromForSearch(opt, cur, len);
2939         string str = normalize(docstr, true);
2940         if (!opt.ignoreformat) {
2941                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2942         }
2943         if (str.empty()) {
2944                 mres.match_len = -1;
2945                 return mres;
2946         }
2947         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2948         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2949
2950         if (use_regexp) {
2951                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2952                 regex const *p_regexp;
2953                 regex_constants::match_flag_type flags;
2954                 if (at_begin) {
2955                         flags = regex_constants::match_continuous;
2956                         p_regexp = &regexp;
2957                 } else {
2958                         flags = regex_constants::match_default;
2959                         p_regexp = &regexp2;
2960                 }
2961                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2962                 if (re_it == sregex_iterator())
2963                         return mres;
2964                 match_results<string::const_iterator> const & m = *re_it;
2965
2966                 if (0) { // Kornel Benko: DO NOT CHECKK
2967                         // Check braces on the segment that matched the entire regexp expression,
2968                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2969                         if (!braces_match(m[0].first, m[0].second, open_braces))
2970                                 return mres;
2971                 }
2972
2973                 // Check braces on segments that matched all (.*?) subexpressions,
2974                 // except the last "padding" one inserted by lyx.
2975                 for (size_t i = 1; i < m.size() - 1; ++i)
2976                         if (!braces_match(m[i].first, m[i].second, open_braces))
2977                                 return mres;
2978
2979                 // Exclude from the returned match length any length
2980                 // due to close wildcards added at end of regexp
2981                 // and also the length of the leading (e.g. '\emph{}')
2982                 //
2983                 // Whole found string, including the leading: m[0].second - m[0].first
2984                 // Size of the leading string: m[1].second - m[1].first
2985                 int leadingsize = 0;
2986                 if (m.size() > 1)
2987                         leadingsize = m[1].second - m[1].first;
2988                 int result;
2989                 for (size_t i = 0; i < m.size(); i++) {
2990                         LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2991                 }
2992                 if (close_wildcards == 0)
2993                         result = m[0].second - m[0].first;
2994
2995                 else
2996                         result =  m[m.size() - close_wildcards].first - m[0].first;
2997
2998                 size_t pos = m.position(size_t(0));
2999                 // Ignore last closing characters
3000                 while (result > 0) {
3001                         if (str[pos+result-1] == '}')
3002                                 --result;
3003                         else
3004                                 break;
3005                 }
3006                 if (result > leadingsize)
3007                         result -= leadingsize;
3008                 else
3009                         result = 0;
3010                 mres.match_len = computeSize(str.substr(pos+leadingsize,result), result);
3011                 mres.match2end = str.size() - pos - leadingsize;
3012                 mres.pos = pos+leadingsize;
3013                 return mres;
3014         }
3015
3016         // else !use_regexp: but all code paths above return
3017         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
3018                                  << par_as_string << "', str='" << str << "'");
3019         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
3020                                  << lead_as_string << "', par_as_string_nolead='"
3021                                  << par_as_string_nolead << "'");
3022
3023         if (at_begin) {
3024                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
3025                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
3026                 if (str.substr(0, par_as_string.size()) == par_as_string) {
3027                         mres.match_len = par_as_string.size();
3028                         mres.match2end = str.size();
3029                         mres.pos = 0;
3030                         return mres;
3031                 }
3032         } else {
3033                 // Start the search _after_ the leading part
3034                 size_t pos = str.find(par_as_string_nolead, lead_as_string.size());
3035                 if (pos != string::npos) {
3036                         mres.match_len = par_as_string.size();
3037                         mres.match2end = str.size() - pos;
3038                         mres.pos = pos;
3039                         return mres;
3040                 }
3041         }
3042         return mres;
3043 }
3044
3045
3046 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
3047 {
3048         MatchResult mres = findAux(cur, len, at_begin);
3049         int res = mres.match_len;
3050         LYXERR(Debug::FIND,
3051                "res=" << res << ", at_begin=" << at_begin
3052                << ", matchword=" << opt.matchword
3053                << ", inTexted=" << cur.inTexted());
3054         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
3055                 return mres;
3056         if ((len > 0) && (res < len)) {
3057           mres.match_len = 0;
3058           return mres;
3059         }
3060         Paragraph const & par = cur.paragraph();
3061         bool ws_left = (cur.pos() > 0)
3062                 ? par.isWordSeparator(cur.pos() - 1)
3063                 : true;
3064         bool ws_right;
3065         if (len < 0)
3066                 ws_right = true;
3067         else {
3068                 ws_right = (cur.pos() + len < par.size())
3069                 ? par.isWordSeparator(cur.pos() + len)
3070                 : true;
3071         }
3072         LYXERR(Debug::FIND,
3073                "cur.pos()=" << cur.pos() << ", res=" << res
3074                << ", separ: " << ws_left << ", " << ws_right
3075                << ", len: " << len
3076                << endl);
3077         if (ws_left && ws_right) {
3078           // Check for word separators inside the found 'word'
3079           for (int i = 0; i < len; i++) {
3080             if (par.isWordSeparator(cur.pos() + i)) {
3081               mres.match_len = 0;
3082               return mres;
3083             }
3084           }
3085           return mres;
3086         }
3087         mres.match_len = 0;
3088         return mres;
3089 }
3090
3091
3092 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
3093 {
3094         string t;
3095         if (! opt.casesensitive)
3096                 t = lyx::to_utf8(lowercase(s));
3097         else
3098                 t = lyx::to_utf8(s);
3099         // Remove \n at begin
3100         while (!t.empty() && t[0] == '\n')
3101                 t = t.substr(1);
3102         // Remove \n at end
3103         while (!t.empty() && t[t.size() - 1] == '\n')
3104                 t = t.substr(0, t.size() - 1);
3105         size_t pos;
3106         // Handle all other '\n'
3107         while ((pos = t.find("\n")) != string::npos) {
3108                 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
3109                         // Handle '\\\n'
3110                         if (isAlnumASCII(t[pos+1])) {
3111                                 t.replace(pos-2, 3, " ");
3112                         }
3113                         else {
3114                                 t.replace(pos-2, 3, "");
3115                         }
3116                 }
3117                 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
3118                         // '\n' adjacent to non-alpha-numerics, discard
3119                         t.replace(pos, 1, "");
3120                 }
3121                 else {
3122                         // Replace all other \n with spaces
3123                         t.replace(pos, 1, " ");
3124                 }
3125         }
3126         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
3127         // Kornel: Added textsl, textsf, textit, texttt and noun
3128         // + allow to seach for colored text too
3129         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
3130         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
3131                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3132         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3133                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3134
3135         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3136         // FIXME - check what preceeds the brace
3137         if (hack_braces) {
3138                 if (opt.ignoreformat)
3139                         while (regex_replace(t, t, "\\{", "_x_<")
3140                                || regex_replace(t, t, "\\}", "_x_>"))
3141                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3142                 else
3143                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
3144                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
3145                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3146         }
3147
3148         return t;
3149 }
3150
3151
3152 docstring stringifyFromCursor(DocIterator const & cur, int len)
3153 {
3154         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3155         if (cur.inTexted()) {
3156                 Paragraph const & par = cur.paragraph();
3157                 // TODO what about searching beyond/across paragraph breaks ?
3158                 // TODO Try adding a AS_STR_INSERTS as last arg
3159                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3160                         int(par.size()) : cur.pos() + len;
3161                 // OutputParams runparams(&cur.buffer()->params().encoding());
3162                 OutputParams runparams(encodings.fromLyXName("utf8"));
3163                 runparams.nice = true;
3164                 runparams.flavor = Flavor::XeTeX;
3165                 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3166                 // No side effect of file copying and image conversion
3167                 runparams.dryrun = true;
3168                 runparams.for_search = true;
3169                 LYXERR(Debug::FIND, "Stringifying with cur: "
3170                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
3171                 return par.asString(cur.pos(), end,
3172                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3173                         &runparams);
3174         } else if (cur.inMathed()) {
3175                 CursorSlice cs = cur.top();
3176                 MathData md = cs.cell();
3177                 MathData::const_iterator it_end =
3178                         (( len == -1 || cs.pos() + len > int(md.size()))
3179                          ? md.end()
3180                          : md.begin() + cs.pos() + len );
3181                 MathData md2;
3182                 for (MathData::const_iterator it = md.begin() + cs.pos();
3183                      it != it_end; ++it)
3184                         md2.push_back(*it);
3185                 docstring s = asString(md2);
3186                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3187                 return s;
3188         }
3189         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3190         return docstring();
3191 }
3192
3193
3194 /** Computes the LaTeX export of buf starting from cur and ending len positions
3195  * after cur, if len is positive, or at the paragraph or innermost inset end
3196  * if len is -1.
3197  */
3198 docstring latexifyFromCursor(DocIterator const & cur, int len)
3199 {
3200         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3201         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3202                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3203         Buffer const & buf = *cur.buffer();
3204
3205         odocstringstream ods;
3206         otexstream os(ods);
3207         //OutputParams runparams(&buf.params().encoding());
3208         OutputParams runparams(encodings.fromLyXName("utf8"));
3209         runparams.nice = false;
3210         runparams.flavor = Flavor::XeTeX;
3211         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3212         // No side effect of file copying and image conversion
3213         runparams.dryrun = true;
3214         runparams.for_search = true;
3215
3216         if (cur.inTexted()) {
3217                 // @TODO what about searching beyond/across paragraph breaks ?
3218                 pos_type endpos = cur.paragraph().size();
3219                 if (len != -1 && endpos > cur.pos() + len)
3220                         endpos = cur.pos() + len;
3221                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3222                           string(), cur.pos(), endpos);
3223                 string s = lyx::to_utf8(ods.str());
3224                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3225                 return(lyx::from_utf8(s));
3226         } else if (cur.inMathed()) {
3227                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3228                 for (int s = cur.depth() - 1; s >= 0; --s) {
3229                         CursorSlice const & cs = cur[s];
3230                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3231                                 WriteStream ws(os);
3232                                 cs.asInsetMath()->asHullInset()->header_write(ws);
3233                                 break;
3234                         }
3235                 }
3236
3237                 CursorSlice const & cs = cur.top();
3238                 MathData md = cs.cell();
3239                 MathData::const_iterator it_end =
3240                         ((len == -1 || cs.pos() + len > int(md.size()))
3241                          ? md.end()
3242                          : md.begin() + cs.pos() + len);
3243                 MathData md2;
3244                 for (MathData::const_iterator it = md.begin() + cs.pos();
3245                      it != it_end; ++it)
3246                         md2.push_back(*it);
3247
3248                 ods << asString(md2);
3249                 // Retrieve the math environment type, and add '$' or '$]'
3250                 // or others (\end{equation}) accordingly
3251                 for (int s = cur.depth() - 1; s >= 0; --s) {
3252                         CursorSlice const & cs2 = cur[s];
3253                         InsetMath * inset = cs2.asInsetMath();
3254                         if (inset && inset->asHullInset()) {
3255                                 WriteStream ws(os);
3256                                 inset->asHullInset()->footer_write(ws);
3257                                 break;
3258                         }
3259                 }
3260                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3261         } else {
3262                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3263         }
3264         return ods.str();
3265 }
3266
3267
3268 /** Finalize an advanced find operation, advancing the cursor to the innermost
3269  ** position that matches, plus computing the length of the matching text to
3270  ** be selected
3271  **/
3272 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
3273 {
3274         // Search the foremost position that matches (avoids find of entire math
3275         // inset when match at start of it)
3276         size_t d;
3277         DocIterator old_cur(cur.buffer());
3278         do {
3279                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
3280                 d = cur.depth();
3281                 old_cur = cur;
3282                 cur.forwardPos();
3283         } while (cur && cur.depth() > d && match(cur).match_len > 0);
3284         cur = old_cur;
3285         int max_match = match(cur).match_len;     /* match valid only if not searching whole words */
3286         if (max_match <= 0) return 0;
3287         LYXERR(Debug::FIND, "Ok");
3288
3289         // Compute the match length
3290         int len = 1;
3291         if (cur.pos() + len > cur.lastpos())
3292           return 0;
3293         if (match.opt.matchword) {
3294           LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3295           while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3296             ++len;
3297             LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3298           }
3299           // Length of matched text (different from len param)
3300           int old_match = match(cur, len).match_len;
3301           if (old_match < 0)
3302             old_match = 0;
3303           int new_match;
3304           // Greedy behaviour while matching regexps
3305           while ((new_match = match(cur, len + 1).match_len) > old_match) {
3306             ++len;
3307             old_match = new_match;
3308             LYXERR(Debug::FIND, "verifying   match with len = " << len);
3309           }
3310           if (old_match == 0)
3311             len = 0;
3312         }
3313         else {
3314           int minl = 1;
3315           int maxl = cur.lastpos() - cur.pos();
3316           // Greedy behaviour while matching regexps
3317           while (maxl > minl) {
3318             int actual_match = match(cur, len).match_len;
3319             if (actual_match >= max_match) {
3320               // actual_match > max_match _can_ happen,
3321               // if the search area splits
3322               // some following word so that the regex
3323               // (e.g. 'r.*r\b' matches 'r' from the middle of the
3324               // splitted word)
3325               // This means, the len value is too big
3326               maxl = len;
3327               len = (int)((maxl + minl)/2);
3328             }
3329             else {
3330               // (actual_match < max_match)
3331               minl = len + 1;
3332               len = (int)((maxl + minl)/2);
3333             }
3334           }
3335           old_cur = cur;
3336           // Search for real start of matched characters
3337           while (len > 1) {
3338             int actual_match;
3339             do {
3340               cur.forwardPos();
3341             } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3342             if (cur.depth() < old_cur.depth()) {
3343               // Outer inset?
3344               LYXERR(Debug::INFO, "cur.depth() < old_cur.depth(), this should never happen");
3345               break;
3346             }
3347             if (cur.pos() != old_cur.pos()) {
3348               // OK, forwarded 1 pos in actual inset
3349               actual_match = match(cur, len-1).match_len;
3350               if (actual_match == max_match) {
3351                 // Ha, got it! The shorter selection has the same match length
3352                 len--;
3353                 old_cur = cur;
3354               }
3355               else {
3356                 // OK, the shorter selection matches less chars, revert to previous value
3357                 cur = old_cur;
3358                 break;
3359               }
3360             }
3361             else {
3362               LYXERR(Debug::INFO, "cur.pos() == old_cur.pos(), this should never happen");
3363               actual_match = match(cur, len).match_len;
3364               if (actual_match == max_match)
3365                 old_cur = cur;
3366             }
3367           }
3368         }
3369         return len;
3370 }
3371
3372
3373 /// Finds forward
3374 int findForwardAdv(DocIterator & cur, MatchStringAdv const & match)
3375 {
3376         if (!cur)
3377                 return 0;
3378         while (!theApp()->longOperationCancelled() && cur) {
3379                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3380                 MatchResult mres = match(cur, -1, false);
3381                 int match_len = mres.match_len;
3382                 LYXERR(Debug::FIND, "match_len: " << match_len);
3383                 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3384                         LYXERR(Debug::INFO, "BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3385                         match_len = 0;
3386                 }
3387                 if (match_len > 0) {
3388                         // Try to find the begin of searched string
3389                         int increment = mres.pos/2;
3390                         while (mres.pos > 5 && (increment > 5)) {
3391                                 DocIterator old_cur = cur;
3392                                 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3393                                 }
3394                                 if (! cur || (cur.pit() > old_cur.pit())) {
3395                                         // Are we outside of the paragraph?
3396                                         // This can happen if moving past some UTF8-encoded chars
3397                                         cur = old_cur;
3398                                         increment /= 2;
3399                                 }
3400                                 else {
3401                                         MatchResult mres2 = match(cur, -1, false);
3402                                         if ((mres2.match2end < mres.match2end) ||
3403                                           (mres2.match_len < mres.match_len)) {
3404                                                 cur = old_cur;
3405                                                 increment /= 2;
3406                                         }
3407                                         else {
3408                                                 mres = mres2;
3409                                                 increment -= 2;
3410                                                 if (increment > mres.pos/2)
3411                                                         increment = mres.pos/2;
3412                                         }
3413                                 }
3414                         }
3415                         int match_len_zero_count = 0;
3416                         for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3417                                 if (i++ > 10) {
3418                                         int remaining_len = match(cur, -1, false).match_len;
3419                                         if (remaining_len <= 0) {
3420                                                 // Apparently the searched string is not in the remaining part
3421                                                 break;
3422                                         }
3423                                         else {
3424                                                 i = 0;
3425                                         }
3426                                 }
3427                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3428                                 int match_len3 = match(cur, 1).match_len;
3429                                 if (match_len3 < 0)
3430                                         continue;
3431                                 int match_len2 = match(cur).match_len;
3432                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3433                                 if (match_len2 > 0) {
3434                                         // Sometimes in finalize we understand it wasn't a match
3435                                         // and we need to continue the outest loop
3436                                         int len = findAdvFinalize(cur, match);
3437                                         if (len > 0) {
3438                                                 return len;
3439                                         }
3440                                 }
3441                                 if (match_len2 >= 0) {
3442                                         if (match_len2 == 0)
3443                                                 match_len_zero_count++;
3444                                         else
3445                                                 match_len_zero_count = 0;
3446                                 }
3447                                 else {
3448                                         if (++match_len_zero_count > 3) {
3449                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3450                                         }
3451                                         break;
3452                                 }
3453                         }
3454                         if (!cur)
3455                                 return 0;
3456                 }
3457                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3458                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3459                         cur.forwardPar();
3460                 } else {
3461                         // This should exit nested insets, if any, or otherwise undefine the currsor.
3462                         cur.pos() = cur.lastpos();
3463                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3464                         cur.forwardPos();
3465                 }
3466         }
3467         return 0;
3468 }
3469
3470
3471 /// Find the most backward consecutive match within same paragraph while searching backwards.
3472 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3473 {
3474         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3475         DocIterator tmp_cur = cur;
3476         int len = findAdvFinalize(tmp_cur, match);
3477         Inset & inset = cur.inset();
3478         for (; cur != cur_begin; cur.backwardPos()) {
3479                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3480                 DocIterator new_cur = cur;
3481                 new_cur.backwardPos();
3482                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3483                         break;
3484                 int new_len = findAdvFinalize(new_cur, match);
3485                 if (new_len == len)
3486                         break;
3487                 len = new_len;
3488         }
3489         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3490         return len;
3491 }
3492
3493
3494 /// Finds backwards
3495 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3496 {
3497         if (! cur)
3498                 return 0;
3499         // Backup of original position
3500         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3501         if (cur == cur_begin)
3502                 return 0;
3503         cur.backwardPos();
3504         DocIterator cur_orig(cur);
3505         bool pit_changed = false;
3506         do {
3507                 cur.pos() = 0;
3508                 bool found_match = (match(cur, -1, false).match_len > 0);
3509
3510                 if (found_match) {
3511                         if (pit_changed)
3512                                 cur.pos() = cur.lastpos();
3513                         else
3514                                 cur.pos() = cur_orig.pos();
3515                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
3516                         DocIterator cur_prev_iter;
3517                         do {
3518                                 found_match = (match(cur).match_len > 0);
3519                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
3520                                        << found_match << ", cur: " << cur);
3521                                 if (found_match)
3522                                         return findMostBackwards(cur, match);
3523
3524                                 // Stop if begin of document reached
3525                                 if (cur == cur_begin)
3526                                         break;
3527                                 cur_prev_iter = cur;
3528                                 cur.backwardPos();
3529                         } while (true);
3530                 }
3531                 if (cur == cur_begin)
3532                         break;
3533                 if (cur.pit() > 0)
3534                         --cur.pit();
3535                 else
3536                         cur.backwardPos();
3537                 pit_changed = true;
3538         } while (!theApp()->longOperationCancelled());
3539         return 0;
3540 }
3541
3542
3543 } // namespace
3544
3545
3546 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
3547                                  DocIterator const & cur, int len)
3548 {
3549         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
3550                 return docstring();
3551         if (!opt.ignoreformat)
3552                 return latexifyFromCursor(cur, len);
3553         else
3554                 return stringifyFromCursor(cur, len);
3555 }
3556
3557
3558 FindAndReplaceOptions::FindAndReplaceOptions(
3559         docstring const & _find_buf_name, bool _casesensitive,
3560         bool _matchword, bool _forward, bool _expandmacros, bool _ignoreformat,
3561         docstring const & _repl_buf_name, bool _keep_case,
3562         SearchScope _scope, SearchRestriction _restr, bool _replace_all)
3563         : find_buf_name(_find_buf_name), casesensitive(_casesensitive), matchword(_matchword),
3564           forward(_forward), expandmacros(_expandmacros), ignoreformat(_ignoreformat),
3565           repl_buf_name(_repl_buf_name), keep_case(_keep_case), scope(_scope), restr(_restr), replace_all(_replace_all)
3566 {
3567 }
3568
3569
3570 namespace {
3571
3572
3573 /** Check if 'len' letters following cursor are all non-lowercase */
3574 static bool allNonLowercase(Cursor const & cur, int len)
3575 {
3576         pos_type beg_pos = cur.selectionBegin().pos();
3577         pos_type end_pos = cur.selectionBegin().pos() + len;
3578         if (len > cur.lastpos() + 1 - beg_pos) {
3579                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
3580                 len = cur.lastpos() + 1 - beg_pos;
3581                 end_pos = beg_pos + len;
3582         }
3583         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
3584                 if (isLowerCase(cur.paragraph().getChar(pos)))
3585                         return false;
3586         return true;
3587 }
3588
3589
3590 /** Check if first letter is upper case and second one is lower case */
3591 static bool firstUppercase(Cursor const & cur)
3592 {
3593         char_type ch1, ch2;
3594         pos_type pos = cur.selectionBegin().pos();
3595         if (pos >= cur.lastpos() - 1) {
3596                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
3597                 return false;
3598         }
3599         ch1 = cur.paragraph().getChar(pos);
3600         ch2 = cur.paragraph().getChar(pos + 1);
3601         bool result = isUpperCase(ch1) && isLowerCase(ch2);
3602         LYXERR(Debug::FIND, "firstUppercase(): "
3603                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
3604                << ch2 << "(" << char(ch2) << ")"
3605                << ", result=" << result << ", cur=" << cur);
3606         return result;
3607 }
3608
3609
3610 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
3611  **
3612  ** \fixme What to do with possible further paragraphs in replace buffer ?
3613  **/
3614 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
3615 {
3616         ParagraphList::iterator pit = buffer.paragraphs().begin();
3617         LASSERT(!pit->empty(), /**/);
3618         pos_type right = pos_type(1);
3619         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
3620         right = pit->size();
3621         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
3622 }
3623
3624 } // namespace
3625
3626 ///
3627 static int findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
3628 {
3629         Cursor & cur = bv->cursor();
3630         if (opt.repl_buf_name.empty()
3631             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
3632             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3633                 return 0;
3634
3635         DocIterator sel_beg = cur.selectionBegin();
3636         DocIterator sel_end = cur.selectionEnd();
3637         if (&sel_beg.inset() != &sel_end.inset()
3638             || sel_beg.pit() != sel_end.pit()
3639             || sel_beg.idx() != sel_end.idx())
3640                 return 0;
3641         int sel_len = sel_end.pos() - sel_beg.pos();
3642         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
3643                << ", sel_len: " << sel_len << endl);
3644         if (sel_len == 0)
3645                 return 0;
3646         LASSERT(sel_len > 0, return 0);
3647
3648         if (!matchAdv(sel_beg, sel_len).match_len)
3649                 return 0;
3650
3651         // Build a copy of the replace buffer, adapted to the KeepCase option
3652         Buffer const & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
3653         ostringstream oss;
3654         repl_buffer_orig.write(oss);
3655         string lyx = oss.str();
3656         Buffer repl_buffer("", false);
3657         repl_buffer.setUnnamed(true);
3658         LASSERT(repl_buffer.readString(lyx), return 0);
3659         if (opt.keep_case && sel_len >= 2) {
3660                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
3661                 if (cur.inTexted()) {
3662                         if (firstUppercase(cur))
3663                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3664                         else if (allNonLowercase(cur, sel_len))
3665                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3666                 }
3667         }
3668         cap::cutSelection(cur, false);
3669         if (cur.inTexted()) {
3670                 repl_buffer.changeLanguage(
3671                         repl_buffer.language(),
3672                         cur.getFont().language());
3673                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3674                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3675                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3676                                         repl_buffer.params().documentClassPtr(),
3677                                         bv->buffer().errorList("Paste"));
3678                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3679                 sel_len = repl_buffer.paragraphs().begin()->size();
3680         } else if (cur.inMathed()) {
3681                 odocstringstream ods;
3682                 otexstream os(ods);
3683                 // OutputParams runparams(&repl_buffer.params().encoding());
3684                 OutputParams runparams(encodings.fromLyXName("utf8"));
3685                 runparams.nice = false;
3686                 runparams.flavor = Flavor::XeTeX;
3687                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3688                 runparams.dryrun = true;
3689                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3690                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3691                 docstring repl_latex = ods.str();
3692                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3693                 string s;
3694                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3695                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3696                 repl_latex = from_utf8(s);
3697                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3698                 MathData ar(cur.buffer());
3699                 asArray(repl_latex, ar, Parse::NORMAL);
3700                 cur.insert(ar);
3701                 sel_len = ar.size();
3702                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3703         }
3704         if (cur.pos() >= sel_len)
3705                 cur.pos() -= sel_len;
3706         else
3707                 cur.pos() = 0;
3708         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3709         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3710         bv->processUpdateFlags(Update::Force);
3711         return 1;
3712 }
3713
3714
3715 /// Perform a FindAdv operation.
3716 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3717 {
3718         DocIterator cur;
3719         int match_len = 0;
3720
3721         // e.g., when invoking word-findadv from mini-buffer wither with
3722         //       wrong options syntax or before ever opening advanced F&R pane
3723         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3724                 return false;
3725
3726         try {
3727                 MatchStringAdv matchAdv(bv->buffer(), opt);
3728                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3729                 if (length > 0)
3730                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3731                 num_replaced += findAdvReplace(bv, opt, matchAdv);
3732                 cur = bv->cursor();
3733                 if (opt.forward)
3734                         match_len = findForwardAdv(cur, matchAdv);
3735                 else
3736                         match_len = findBackwardsAdv(cur, matchAdv);
3737         } catch (...) {
3738                 // This may only be raised by lyx::regex()
3739                 bv->message(_("Invalid regular expression!"));
3740                 return false;
3741         }
3742
3743         if (match_len == 0) {
3744                 if (num_replaced > 0) {
3745                         switch (num_replaced)
3746                         {
3747                                 case 1:
3748                                         bv->message(_("One match has been replaced."));
3749                                         break;
3750                                 case 2:
3751                                         bv->message(_("Two matches have been replaced."));
3752                                         break;
3753                                 default:
3754                                         bv->message(bformat(_("%1$d matches have been replaced."), num_replaced));
3755                                         break;
3756                         }
3757                         num_replaced = 0;
3758                 }
3759                 else {
3760                         bv->message(_("Match not found."));
3761                 }
3762                 return false;
3763         }
3764
3765         if (num_replaced > 0)
3766                 bv->message(_("Match has been replaced."));
3767         else
3768                 bv->message(_("Match found."));
3769
3770         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3771         bv->putSelectionAt(cur, match_len, !opt.forward);
3772
3773         return true;
3774 }
3775
3776
3777 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3778 {
3779         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3780            << opt.casesensitive << ' '
3781            << opt.matchword << ' '
3782            << opt.forward << ' '
3783            << opt.expandmacros << ' '
3784            << opt.ignoreformat << ' '
3785            << opt.replace_all << ' '
3786            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3787            << opt.keep_case << ' '
3788            << int(opt.scope) << ' '
3789            << int(opt.restr);
3790
3791         LYXERR(Debug::FIND, "built: " << os.str());
3792
3793         return os;
3794 }
3795
3796
3797 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3798 {
3799         LYXERR(Debug::FIND, "parsing");
3800         string s;
3801         string line;
3802         getline(is, line);
3803         while (line != "EOSS") {
3804                 if (! s.empty())
3805                         s = s + "\n";
3806                 s = s + line;
3807                 if (is.eof())   // Tolerate malformed request
3808                         break;
3809                 getline(is, line);
3810         }
3811         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3812         opt.find_buf_name = from_utf8(s);
3813         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.replace_all;
3814         is.get();       // Waste space before replace string
3815         s = "";
3816         getline(is, line);
3817         while (line != "EOSS") {
3818                 if (! s.empty())
3819                         s = s + "\n";
3820                 s = s + line;
3821                 if (is.eof())   // Tolerate malformed request
3822                         break;
3823                 getline(is, line);
3824         }
3825         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3826         opt.repl_buf_name = from_utf8(s);
3827         is >> opt.keep_case;
3828         int i;
3829         is >> i;
3830         opt.scope = FindAndReplaceOptions::SearchScope(i);
3831         is >> i;
3832         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3833
3834         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3835                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3836                << opt.scope << ' ' << opt.restr);
3837         return is;
3838 }
3839
3840 } // namespace lyx