src/lyxfind.cpp

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