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