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