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
  36 #include "frontends/Application.h"
  37 #include "frontends/alert.h"
  38
  39 #include "mathed/InsetMath.h"
  40 #include "mathed/InsetMathGrid.h"
  41 #include "mathed/InsetMathHull.h"
  42 #include "mathed/MathData.h"
  43 #include "mathed/MathStream.h"
  44 #include "mathed/MathSupport.h"
  45
  46 #include "support/convert.h"
  47 #include "support/debug.h"
  48 #include "support/docstream.h"
  49 #include "support/FileName.h"
  50 #include "support/gettext.h"
  51 #include "support/lassert.h"
  52 #include "support/lstrings.h"
  53
  54 #include "support/regex.h"
  55 #include <map>
  56
  57 using namespace std;
  58 using namespace lyx::support;
  59
  60 namespace lyx {
  61
  62 namespace {
  63
  64 bool parse_bool(docstring & howto)
  65 {
  66         if (howto.empty())
  67                 return false;
  68         docstring var;
  69         howto = split(howto, var, ' ');
  70         return var == "1";
  71 }
  72
  73
  74 class MatchString : public binary_function<Paragraph, pos_type, int>
  75 {
  76 public:
  77         MatchString(docstring const & str, bool cs, bool mw)
  78                 : str(str), case_sens(cs), whole_words(mw)
  79         {}
  80
  81         // returns true if the specified string is at the specified position
  82         // del specifies whether deleted strings in ct mode will be considered
  83         int operator()(Paragraph const & par, pos_type pos, bool del = true) const
  84         {
  85                 return par.find(str, case_sens, whole_words, pos, del);
  86         }
  87
  88 private:
  89         // search string
  90         docstring str;
  91         // case sensitive
  92         bool case_sens;
  93         // match whole words only
  94         bool whole_words;
  95 };
  96
  97
  98 int findForward(DocIterator & cur, MatchString const & match,
  99                 bool find_del = true)
 100 {
 101         for (; cur; cur.forwardChar())
 102                 if (cur.inTexted()) {
 103                         int len = match(cur.paragraph(), cur.pos(), find_del);
 104                         if (len > 0)
 105                                 return len;
 106                 }
 107         return 0;
 108 }
 109
 110
 111 int findBackwards(DocIterator & cur, MatchString const & match,
 112                   bool find_del = true)
 113 {
 114         while (cur) {
 115                 cur.backwardChar();
 116                 if (cur.inTexted()) {
 117                         int len = match(cur.paragraph(), cur.pos(), find_del);
 118                         if (len > 0)
 119                                 return len;
 120                 }
 121         }
 122         return 0;
 123 }
 124
 125
 126 bool searchAllowed(docstring const & str)
 127 {
 128         if (str.empty()) {
 129                 frontend::Alert::error(_("Search error"), _("Search string is empty"));
 130                 return false;
 131         }
 132         return true;
 133 }
 134
 135
 136 bool findOne(BufferView * bv, docstring const & searchstr,
 137              bool case_sens, bool whole, bool forward,
 138              bool find_del = true, bool check_wrap = false)
 139 {
 140         if (!searchAllowed(searchstr))
 141                 return false;
 142
 143         DocIterator cur = forward
 144                 ? bv->cursor().selectionEnd()
 145                 : bv->cursor().selectionBegin();
 146
 147         MatchString const match(searchstr, case_sens, whole);
 148
 149         int match_len = forward
 150                 ? findForward(cur, match, find_del)
 151                 : findBackwards(cur, match, find_del);
 152
 153         if (match_len > 0)
 154                 bv->putSelectionAt(cur, match_len, !forward);
 155         else if (check_wrap) {
 156                 DocIterator cur_orig(bv->cursor());
 157                 docstring q;
 158                 if (forward)
 159                         q = _("End of file reached while searching forward.\n"
 160                           "Continue searching from the beginning?");
 161                 else
 162                         q = _("Beginning of file reached while searching backward.\n"
 163                           "Continue searching from the end?");
 164                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
 165                         q, 0, 1, _("&Yes"), _("&No"));
 166                 if (wrap_answer == 0) {
 167                         if (forward) {
 168                                 bv->cursor().clear();
 169                                 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
 170                         } else {
 171                                 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
 172                                 bv->cursor().backwardPos();
 173                         }
 174                         bv->clearSelection();
 175                         if (findOne(bv, searchstr, case_sens, whole, forward, find_del, false))
 176                                 return true;
 177                 }
 178                 bv->cursor().setCursor(cur_orig);
 179                 return false;
 180         }
 181
 182         return match_len > 0;
 183 }
 184
 185
 186 int replaceAll(BufferView * bv,
 187                docstring const & searchstr, docstring const & replacestr,
 188                bool case_sens, bool whole)
 189 {
 190         Buffer & buf = bv->buffer();
 191
 192         if (!searchAllowed(searchstr) || buf.isReadonly())
 193                 return 0;
 194
 195         DocIterator cur_orig(bv->cursor());
 196
 197         MatchString const match(searchstr, case_sens, whole);
 198         int num = 0;
 199
 200         int const rsize = replacestr.size();
 201         int const ssize = searchstr.size();
 202
 203         Cursor cur(*bv);
 204         cur.setCursor(doc_iterator_begin(&buf));
 205         int match_len = findForward(cur, match, false);
 206         while (match_len > 0) {
 207                 // Backup current cursor position and font.
 208                 pos_type const pos = cur.pos();
 209                 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
 210                 cur.recordUndo();
 211                 int striked = ssize -
 212                         cur.paragraph().eraseChars(pos, pos + match_len,
 213                                                    buf.params().track_changes);
 214                 cur.paragraph().insert(pos, replacestr, font,
 215                                        Change(buf.params().track_changes
 216                                               ? Change::INSERTED
 217                                               : Change::UNCHANGED));
 218                 for (int i = 0; i < rsize + striked; ++i)
 219                         cur.forwardChar();
 220                 ++num;
 221                 match_len = findForward(cur, match, false);
 222         }
 223
 224         bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
 225
 226         cur_orig.fixIfBroken();
 227         bv->setCursor(cur_orig);
 228
 229         return num;
 230 }
 231
 232
 233 // the idea here is that we are going to replace the string that
 234 // is selected IF it is the search string.
 235 // if there is a selection, but it is not the search string, then
 236 // we basically ignore it. (FIXME We ought to replace only within
 237 // the selection.)
 238 // if there is no selection, then:
 239 //  (i) if some search string has been provided, then we find it.
 240 //      (think of how the dialog works when you hit "replace" the
 241 //      first time.)
 242 // (ii) if no search string has been provided, then we treat the
 243 //      word the cursor is in as the search string. (why? i have no
 244 //      idea.) but this only works in text?
 245 //
 246 // returns the number of replacements made (one, if any) and
 247 // whether anything at all was done.
 248 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
 249                            docstring const & replacestr, bool case_sens,
 250                            bool whole, bool forward, bool findnext)
 251 {
 252         Cursor & cur = bv->cursor();
 253         bool found = false;
 254         if (!cur.selection()) {
 255                 // no selection, non-empty search string: find it
 256                 if (!searchstr.empty()) {
 257                         found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
 258                         return make_pair(found, 0);
 259                 }
 260                 // empty search string
 261                 if (!cur.inTexted())
 262                         // bail in math
 263                         return make_pair(false, 0);
 264                 // select current word and treat it as the search string.
 265                 // This causes a minor bug as undo will restore this selection,
 266                 // which the user did not create (#8986).
 267                 cur.innerText()->selectWord(cur, WHOLE_WORD);
 268                 searchstr = cur.selectionAsString(false);
 269         }
 270
 271         // if we still don't have a search string, report the error
 272         // and abort.
 273         if (!searchAllowed(searchstr))
 274                 return make_pair(false, 0);
 275
 276         bool have_selection = cur.selection();
 277         docstring const selected = cur.selectionAsString(false);
 278         bool match =
 279                 case_sens
 280                 ? searchstr == selected
 281                 : compare_no_case(searchstr, selected) == 0;
 282
 283         // no selection or current selection is not search word:
 284         // just find the search word
 285         if (!have_selection || !match) {
 286                 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
 287                 return make_pair(found, 0);
 288         }
 289
 290         // we're now actually ready to replace. if the buffer is
 291         // read-only, we can't, though.
 292         if (bv->buffer().isReadonly())
 293                 return make_pair(false, 0);
 294
 295         cap::replaceSelectionWithString(cur, replacestr);
 296         if (forward) {
 297                 cur.pos() += replacestr.length();
 298                 LASSERT(cur.pos() <= cur.lastpos(),
 299                         cur.pos() = cur.lastpos());
 300         }
 301         if (findnext)
 302                 findOne(bv, searchstr, case_sens, whole, forward, false, findnext);
 303
 304         return make_pair(true, 1);
 305 }
 306
 307 } // namespace
 308
 309
 310 docstring const find2string(docstring const & search,
 311                             bool casesensitive, bool matchword, bool forward)
 312 {
 313         odocstringstream ss;
 314         ss << search << '\n'
 315            << int(casesensitive) << ' '
 316            << int(matchword) << ' '
 317            << int(forward);
 318         return ss.str();
 319 }
 320
 321
 322 docstring const replace2string(docstring const & replace,
 323                                docstring const & search,
 324                                bool casesensitive, bool matchword,
 325                                bool all, bool forward, bool findnext)
 326 {
 327         odocstringstream ss;
 328         ss << replace << '\n'
 329            << search << '\n'
 330            << int(casesensitive) << ' '
 331            << int(matchword) << ' '
 332            << int(all) << ' '
 333            << int(forward) << ' '
 334            << int(findnext);
 335         return ss.str();
 336 }
 337
 338
 339 bool lyxfind(BufferView * bv, FuncRequest const & ev)
 340 {
 341         if (!bv || ev.action() != LFUN_WORD_FIND)
 342                 return false;
 343
 344         //lyxerr << "find called, cmd: " << ev << endl;
 345
 346         // data is of the form
 347         // "<search>
 348         //  <casesensitive> <matchword> <forward>"
 349         docstring search;
 350         docstring howto = split(ev.argument(), search, '\n');
 351
 352         bool casesensitive = parse_bool(howto);
 353         bool matchword     = parse_bool(howto);
 354         bool forward       = parse_bool(howto);
 355
 356         return findOne(bv, search, casesensitive, matchword, forward, true, true);
 357 }
 358
 359
 360 bool lyxreplace(BufferView * bv,
 361                 FuncRequest const & ev, bool has_deleted)
 362 {
 363         if (!bv || ev.action() != LFUN_WORD_REPLACE)
 364                 return false;
 365
 366         // data is of the form
 367         // "<search>
 368         //  <replace>
 369         //  <casesensitive> <matchword> <all> <forward> <findnext>"
 370         docstring search;
 371         docstring rplc;
 372         docstring howto = split(ev.argument(), rplc, '\n');
 373         howto = split(howto, search, '\n');
 374
 375         bool casesensitive = parse_bool(howto);
 376         bool matchword     = parse_bool(howto);
 377         bool all           = parse_bool(howto);
 378         bool forward       = parse_bool(howto);
 379         bool findnext      = howto.empty() ? true : parse_bool(howto);
 380
 381         bool update = false;
 382
 383         if (!has_deleted) {
 384                 int replace_count = 0;
 385                 if (all) {
 386                         replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
 387                         update = replace_count > 0;
 388                 } else {
 389                         pair<bool, int> rv =
 390                                 replaceOne(bv, search, rplc, casesensitive, matchword, forward, findnext);
 391                         update = rv.first;
 392                         replace_count = rv.second;
 393                 }
 394
 395                 Buffer const & buf = bv->buffer();
 396                 if (!update) {
 397                         // emit message signal.
 398                         buf.message(_("String not found."));
 399                 } else {
 400                         if (replace_count == 0) {
 401                                 buf.message(_("String found."));
 402                         } else if (replace_count == 1) {
 403                                 buf.message(_("String has been replaced."));
 404                         } else {
 405                                 docstring const str =
 406                                         bformat(_("%1$d strings have been replaced."), replace_count);
 407                                 buf.message(str);
 408                         }
 409                 }
 410         } else if (findnext) {
 411                 // if we have deleted characters, we do not replace at all, but
 412                 // rather search for the next occurence
 413                 if (findOne(bv, search, casesensitive, matchword, forward, true, findnext))
 414                         update = true;
 415                 else
 416                         bv->message(_("String not found."));
 417         }
 418         return update;
 419 }
 420
 421
 422 bool findNextChange(BufferView * bv, Cursor & cur, bool const check_wrap)
 423 {
 424         for (; cur; cur.forwardPos())
 425                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
 426                         return true;
 427
 428         if (check_wrap) {
 429                 DocIterator cur_orig(bv->cursor());
 430                 docstring q = _("End of file reached while searching forward.\n"
 431                           "Continue searching from the beginning?");
 432                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
 433                         q, 0, 1, _("&Yes"), _("&No"));
 434                 if (wrap_answer == 0) {
 435                         bv->cursor().clear();
 436                         bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
 437                         bv->clearSelection();
 438                         cur.setCursor(bv->cursor().selectionBegin());
 439                         if (findNextChange(bv, cur, false))
 440                                 return true;
 441                 }
 442                 bv->cursor().setCursor(cur_orig);
 443         }
 444
 445         return false;
 446 }
 447
 448
 449 bool findPreviousChange(BufferView * bv, Cursor & cur, bool const check_wrap)
 450 {
 451         for (cur.backwardPos(); cur; cur.backwardPos()) {
 452                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
 453                         return true;
 454         }
 455
 456         if (check_wrap) {
 457                 DocIterator cur_orig(bv->cursor());
 458                 docstring q = _("Beginning of file reached while searching backward.\n"
 459                           "Continue searching from the end?");
 460                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
 461                         q, 0, 1, _("&Yes"), _("&No"));
 462                 if (wrap_answer == 0) {
 463                         bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
 464                         bv->cursor().backwardPos();
 465                         bv->clearSelection();
 466                         cur.setCursor(bv->cursor().selectionBegin());
 467                         if (findPreviousChange(bv, cur, false))
 468                                 return true;
 469                 }
 470                 bv->cursor().setCursor(cur_orig);
 471         }
 472
 473         return false;
 474 }
 475
 476
 477 bool selectChange(Cursor & cur, bool forward)
 478 {
 479         if (!cur.inTexted() || !cur.paragraph().isChanged(cur.pos()))
 480                 return false;
 481         Change ch = cur.paragraph().lookupChange(cur.pos());
 482
 483         CursorSlice tip1 = cur.top();
 484         for (; tip1.pit() < tip1.lastpit() || tip1.pos() < tip1.lastpos(); tip1.forwardPos()) {
 485                 Change ch2 = tip1.paragraph().lookupChange(tip1.pos());
 486                 if (!ch2.isSimilarTo(ch))
 487                         break;
 488         }
 489         CursorSlice tip2 = cur.top();
 490         for (; tip2.pit() > 0 || tip2.pos() > 0;) {
 491                 tip2.backwardPos();
 492                 Change ch2 = tip2.paragraph().lookupChange(tip2.pos());
 493                 if (!ch2.isSimilarTo(ch)) {
 494                         // take a step forward to correctly set the selection
 495                         tip2.forwardPos();
 496                         break;
 497                 }
 498         }
 499         if (forward)
 500                 swap(tip1, tip2);
 501         cur.top() = tip1;
 502         cur.bv().mouseSetCursor(cur, false);
 503         cur.top() = tip2;
 504         cur.bv().mouseSetCursor(cur, true);
 505         return true;
 506 }
 507
 508
 509 namespace {
 510
 511
 512 bool findChange(BufferView * bv, bool forward)
 513 {
 514         Cursor cur(*bv);
 515         cur.setCursor(forward ? bv->cursor().selectionEnd()
 516                       : bv->cursor().selectionBegin());
 517         forward ? findNextChange(bv, cur, true) : findPreviousChange(bv, cur, true);
 518         return selectChange(cur, forward);
 519 }
 520
 521 } // namespace
 522
 523 bool findNextChange(BufferView * bv)
 524 {
 525         return findChange(bv, true);
 526 }
 527
 528
 529 bool findPreviousChange(BufferView * bv)
 530 {
 531         return findChange(bv, false);
 532 }
 533
 534
 535
 536 namespace {
 537
 538 typedef vector<pair<string, string> > Escapes;
 539
 540 /// A map of symbols and their escaped equivalent needed within a regex.
 541 /// @note Beware of order
 542 Escapes const & get_regexp_escapes()
 543 {
 544         typedef std::pair<std::string, std::string> P;
 545
 546         static Escapes escape_map;
 547         if (escape_map.empty()) {
 548                 escape_map.push_back(P("$", "_x_$"));
 549                 escape_map.push_back(P("{", "_x_{"));
 550                 escape_map.push_back(P("}", "_x_}"));
 551                 escape_map.push_back(P("[", "_x_["));
 552                 escape_map.push_back(P("]", "_x_]"));
 553                 escape_map.push_back(P("(", "_x_("));
 554                 escape_map.push_back(P(")", "_x_)"));
 555                 escape_map.push_back(P("+", "_x_+"));
 556                 escape_map.push_back(P("*", "_x_*"));
 557                 escape_map.push_back(P(".", "_x_."));
 558                 escape_map.push_back(P("\\", "(?:\\\\|\\\\backslash)"));
 559                 escape_map.push_back(P("~", "(?:\\\\textasciitilde|\\\\sim)"));
 560                 escape_map.push_back(P("^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
 561                 escape_map.push_back(P("_x_", "\\"));
 562         }
 563         return escape_map;
 564 }
 565
 566 /// A map of lyx escaped strings and their unescaped equivalent.
 567 Escapes const & get_lyx_unescapes()
 568 {
 569         typedef std::pair<std::string, std::string> P;
 570
 571         static Escapes escape_map;
 572         if (escape_map.empty()) {
 573                 escape_map.push_back(P("\\%", "%"));
 574                 escape_map.push_back(P("\\mathcircumflex ", "^"));
 575                 escape_map.push_back(P("\\mathcircumflex", "^"));
 576                 escape_map.push_back(P("\\backslash ", "\\"));
 577                 escape_map.push_back(P("\\backslash", "\\"));
 578                 escape_map.push_back(P("\\\\{", "_x_<"));
 579                 escape_map.push_back(P("\\\\}", "_x_>"));
 580                 escape_map.push_back(P("\\sim ", "~"));
 581                 escape_map.push_back(P("\\sim", "~"));
 582         }
 583         return escape_map;
 584 }
 585
 586 /// A map of escapes turning a regexp matching text to one matching latex.
 587 Escapes const & get_regexp_latex_escapes()
 588 {
 589         typedef std::pair<std::string, std::string> P;
 590
 591         static Escapes escape_map;
 592         if (escape_map.empty()) {
 593                 escape_map.push_back(P("\\\\", "(?:\\\\\\\\|\\\\backslash|\\\\textbackslash\\{\\}|\\\\textbackslash)"));
 594                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash)\\{", "\\\\\\{"));
 595                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash\\\\\\{)\\}", "\\\\\\}"));
 596                 escape_map.push_back(P("\\[", "\\{\\[\\}"));
 597                 escape_map.push_back(P("\\]", "\\{\\]\\}"));
 598                 escape_map.push_back(P("\\^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
 599                 escape_map.push_back(P("%", "\\\\\\%"));
 600                 escape_map.push_back(P("#", "\\\\#"));
 601         }
 602         return escape_map;
 603 }
 604
 605 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
 606  ** the found occurrence were escaped.
 607  **/
 608 string apply_escapes(string s, Escapes const & escape_map)
 609 {
 610         LYXERR(Debug::FIND, "Escaping: '" << s << "'");
 611         Escapes::const_iterator it;
 612         for (it = escape_map.begin(); it != escape_map.end(); ++it) {
 613 //              LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
 614                 unsigned int pos = 0;
 615                 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
 616                         s.replace(pos, it->first.length(), it->second);
 617                         LYXERR(Debug::FIND, "After escape: " << s);
 618                         pos += it->second.length();
 619 //                      LYXERR(Debug::FIND, "pos: " << pos);
 620                 }
 621         }
 622         LYXERR(Debug::FIND, "Escaped : '" << s << "'");
 623         return s;
 624 }
 625
 626
 627 /// Within \regexp{} apply get_lyx_unescapes() only (i.e., preserve regexp semantics of the string),
 628 /// while outside apply get_lyx_unescapes()+get_regexp_escapes().
 629 /// If match_latex is true, then apply regexp_latex_escapes() to \regexp{} contents as well.
 630 string escape_for_regex(string s, bool match_latex)
 631 {
 632         size_t pos = 0;
 633         while (pos < s.size()) {
 634                 size_t new_pos = s.find("\\regexp{", pos);
 635                 if (new_pos == string::npos)
 636                         new_pos = s.size();
 637                 LYXERR(Debug::FIND, "new_pos: " << new_pos);
 638                 string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
 639                 LYXERR(Debug::FIND, "t [lyx]: " << t);
 640                 t = apply_escapes(t, get_regexp_escapes());
 641                 LYXERR(Debug::FIND, "t [rxp]: " << t);
 642                 s.replace(pos, new_pos - pos, t);
 643                 new_pos = pos + t.size();
 644                 LYXERR(Debug::FIND, "Regexp after escaping: " << s);
 645                 LYXERR(Debug::FIND, "new_pos: " << new_pos);
 646                 if (new_pos == s.size())
 647                         break;
 648                 // Might fail if \\endregexp{} is preceeded by unexpected stuff (weird escapes)
 649                 size_t end_pos = s.find("\\endregexp{}}", new_pos + 8);
 650                 LYXERR(Debug::FIND, "end_pos: " << end_pos);
 651                 t = s.substr(new_pos + 8, end_pos - (new_pos + 8));
 652                 LYXERR(Debug::FIND, "t in regexp      : " << t);
 653                 t = apply_escapes(t, get_lyx_unescapes());
 654                 LYXERR(Debug::FIND, "t in regexp [lyx]: " << t);
 655                 if (match_latex) {
 656                         t = apply_escapes(t, get_regexp_latex_escapes());
 657                         LYXERR(Debug::FIND, "t in regexp [ltx]: " << t);
 658                 }
 659                 if (end_pos == s.size()) {
 660                         s.replace(new_pos, end_pos - new_pos, t);
 661                         LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
 662                         break;
 663                 }
 664                 s.replace(new_pos, end_pos + 13 - new_pos, t);
 665                 LYXERR(Debug::FIND, "Regexp after \\regexp{...\\endregexp{}} removal: " << s);
 666                 pos = new_pos + t.size();
 667                 LYXERR(Debug::FIND, "pos: " << pos);
 668         }
 669         return s;
 670 }
 671
 672
 673 /// Wrapper for lyx::regex_replace with simpler interface
 674 bool regex_replace(string const & s, string & t, string const & searchstr,
 675                    string const & replacestr)
 676 {
 677         lyx::regex e(searchstr, regex_constants::ECMAScript);
 678         ostringstream oss;
 679         ostream_iterator<char, char> it(oss);
 680         lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
 681         // tolerate t and s be references to the same variable
 682         bool rv = (s != oss.str());
 683         t = oss.str();
 684         return rv;
 685 }
 686
 687
 688 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
 689  **
 690  ** Verify that closed braces exactly match open braces. This avoids that, for example,
 691  ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
 692  **
 693  ** @param unmatched
 694  ** Number of open braces that must remain open at the end for the verification to succeed.
 695  **/
 696 bool braces_match(string::const_iterator const & beg,
 697                   string::const_iterator const & end,
 698                   int unmatched = 0)
 699 {
 700         int open_pars = 0;
 701         string::const_iterator it = beg;
 702         LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
 703         for (; it != end; ++it) {
 704                 // Skip escaped braces in the count
 705                 if (*it == '\\') {
 706                         ++it;
 707                         if (it == end)
 708                                 break;
 709                 } else if (*it == '{') {
 710                         ++open_pars;
 711                 } else if (*it == '}') {
 712                         if (open_pars == 0) {
 713                                 LYXERR(Debug::FIND, "Found unmatched closed brace");
 714                                 return false;
 715                         } else
 716                                 --open_pars;
 717                 }
 718         }
 719         if (open_pars != unmatched) {
 720                 LYXERR(Debug::FIND, "Found " << open_pars
 721                        << " instead of " << unmatched
 722                        << " unmatched open braces at the end of count");
 723                 return false;
 724         }
 725         LYXERR(Debug::FIND, "Braces match as expected");
 726         return true;
 727 }
 728
 729
 730 /** The class performing a match between a position in the document and the FindAdvOptions.
 731  **/
 732 class MatchStringAdv {
 733 public:
 734         MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
 735
 736         /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
 737          ** constructor as opt.search, under the opt.* options settings.
 738          **
 739          ** @param at_begin
 740          **     If set, then match is searched only against beginning of text starting at cur.
 741          **     If unset, then match is searched anywhere in text starting at cur.
 742          **
 743          ** @return
 744          ** The length of the matching text, or zero if no match was found.
 745          **/
 746         int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
 747
 748 public:
 749         /// buffer
 750         lyx::Buffer * p_buf;
 751         /// first buffer on which search was started
 752         lyx::Buffer * const p_first_buf;
 753         /// options
 754         FindAndReplaceOptions const & opt;
 755
 756 private:
 757         /// Auxiliary find method (does not account for opt.matchword)
 758         int findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
 759
 760         /** Normalize a stringified or latexified LyX paragraph.
 761          **
 762          ** Normalize means:
 763          ** <ul>
 764          **   <li>if search is not casesensitive, then lowercase the string;
 765          **   <li>remove any newline at begin or end of the string;
 766          **   <li>replace any newline in the middle of the string with a simple space;
 767          **   <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
 768          ** </ul>
 769          **
 770          ** @todo Normalization should also expand macros, if the corresponding
 771          ** search option was checked.
 772          **/
 773         string normalize(docstring const & s, bool hack_braces) const;
 774         // normalized string to search
 775         string par_as_string;
 776         // regular expression to use for searching
 777         lyx::regex regexp;
 778         // same as regexp, but prefixed with a ".*"
 779         lyx::regex regexp2;
 780         // leading format material as string
 781         string lead_as_string;
 782         // par_as_string after removal of lead_as_string
 783         string par_as_string_nolead;
 784         // unmatched open braces in the search string/regexp
 785         int open_braces;
 786         // number of (.*?) subexpressions added at end of search regexp for closing
 787         // environments, math mode, styles, etc...
 788         int close_wildcards;
 789         // Are we searching with regular expressions ?
 790         bool use_regexp;
 791 };
 792
 793
 794 static docstring buffer_to_latex(Buffer & buffer)
 795 {
 796         OutputParams runparams(&buffer.params().encoding());
 797         odocstringstream ods;
 798         otexstream os(ods);
 799         runparams.nice = true;
 800         runparams.flavor = OutputParams::LATEX;
 801         runparams.linelen = 100000; //lyxrc.plaintext_linelen;
 802         // No side effect of file copying and image conversion
 803         runparams.dryrun = true;
 804         runparams.for_search = true;
 805         pit_type const endpit = buffer.paragraphs().size();
 806         for (pit_type pit = 0; pit != endpit; ++pit) {
 807                 TeXOnePar(buffer, buffer.text(), pit, os, runparams);
 808                 LYXERR(Debug::FIND, "searchString up to here: " << ods.str());
 809         }
 810         return ods.str();
 811 }
 812
 813
 814 static docstring stringifySearchBuffer(Buffer & buffer, FindAndReplaceOptions const & opt)
 815 {
 816         docstring str;
 817         if (!opt.ignoreformat) {
 818                 str = buffer_to_latex(buffer);
 819         } else {
 820                 OutputParams runparams(&buffer.params().encoding());
 821                 runparams.nice = true;
 822                 runparams.flavor = OutputParams::LATEX;
 823                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
 824                 runparams.dryrun = true;
 825                 runparams.for_search = true;
 826                 for (pos_type pit = pos_type(0); pit < (pos_type)buffer.paragraphs().size(); ++pit) {
 827                         Paragraph const & par = buffer.paragraphs().at(pit);
 828                         LYXERR(Debug::FIND, "Adding to search string: '"
 829                                << par.asString(pos_type(0), par.size(),
 830                                                AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
 831                                                &runparams)
 832                                << "'");
 833                         str += par.asString(pos_type(0), par.size(),
 834                                             AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
 835                                             &runparams);
 836                 }
 837         }
 838         return str;
 839 }
 840
 841
 842 /// Return separation pos between the leading material and the rest
 843 static size_t identifyLeading(string const & s)
 844 {
 845         string t = s;
 846         // @TODO Support \item[text]
 847         // Kornel: Added textsl, textsf, textit, texttt and noun
 848         // + allow to search for colored text too
 849         while (regex_replace(t, t, REGEX_BOS "\\\\(((emph|noun|minisec|text(bf|sl|sf|it|tt))|((textcolor|foreignlanguage)\\{[a-z]+\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)\\{", "")
 850                || regex_replace(t, t, REGEX_BOS "\\$", "")
 851                || regex_replace(t, t, REGEX_BOS "\\\\\\[ ", "")
 852                || regex_replace(t, t, REGEX_BOS " ?\\\\item\\{[a-z]+\\}", "")
 853                || regex_replace(t, t, REGEX_BOS "\\\\begin\\{[a-zA-Z_]*\\*?\\} ", ""))
 854                ;
 855         LYXERR(Debug::FIND, "  after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
 856         return s.find(t);
 857 }
 858
 859 /*
 860  * Given a latexified string, retrieve some handled features
 861  * The features of the regex will later be compared with the features
 862  * of the searched text. If the regex features are not a
 863  * subset of the analized, then, in not format ignoring search
 864  * we can early stop the search in the relevant inset.
 865  */
 866 typedef map<string, bool> Features;
 867
 868 static Features identifyFeatures(string const & s)
 869 {
 870         static regex const feature("\\\\(([a-z]+(\\{([a-z]+)\\}|\\*)?))\\{");
 871         static regex const valid("^(((emph|noun|text(bf|sl|sf|it|tt)|(textcolor|foreignlanguage|item)\\{[a-z]+\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)$");
 872         smatch sub;
 873         bool displ = true;
 874         Features info;
 875
 876         for (sregex_iterator it(s.begin(), s.end(), feature), end; it != end; ++it) {
 877                 sub = *it;
 878                 if (displ) {
 879                         if (sub.str(1).compare("regexp") == 0) {
 880                                 displ = false;
 881                                 continue;
 882                         }
 883                         string token = sub.str(1);
 884                         smatch sub2;
 885                         if (regex_match(token, sub2, valid)) {
 886                                 info[token] = true;
 887                         }
 888                         else {
 889                                 // ignore
 890                         }
 891                 }
 892                 else {
 893                         if (sub.str(1).compare("endregexp") == 0) {
 894                                 displ = true;
 895                                 continue;
 896                         }
 897                 }
 898         }
 899         return(info);
 900 }
 901
 902 /*
 903  * defines values features of a key "\\[a-z]+{"
 904  */
 905 class KeyInfo {
 906  public:
 907   enum KeyType {
 908     isChar,
 909     isSectioning,
 910     isMain,                             /* for \\foreignlanguage */
 911     isRegex,
 912     isMath,
 913     isStandard,
 914     isSize,
 915     invalid,
 916     doRemove,
 917     isList,
 918     isIgnored                           /* to be ignored by creating infos */
 919   };
 920  KeyInfo()
 921    : keytype(invalid),
 922     head(""),
 923     parenthesiscount(1),
 924     disabled(false),
 925     used(false)
 926   {};
 927  KeyInfo(KeyType type, int parcount, bool disable)
 928    : keytype(type),
 929     parenthesiscount(parcount),
 930     disabled(disable),
 931     used(false) {};
 932   KeyType keytype;
 933   string head;
 934   int _tokensize;
 935   int _tokenstart;
 936   int _dataStart;
 937   int _dataEnd;
 938   int parenthesiscount;
 939   bool disabled;
 940   bool used;                            /* by pattern */
 941 };
 942
 943 class Border {
 944  public:
 945  Border(int l=0, int u=0) : low(l), upper(u) {};
 946   int low;
 947   int upper;
 948 };
 949
 950 #define MAXOPENED 30
 951 class Intervall {
 952   bool isPatternString;
 953  public:
 954  Intervall(bool isPattern) : isPatternString(isPattern), ignoreidx(-1), actualdeptindex(0) { depts[0] = 0;};
 955   string par;
 956   int ignoreidx;
 957   int depts[MAXOPENED];
 958   int closes[MAXOPENED];
 959   int actualdeptindex;
 960   Border borders[2*MAXOPENED];
 961   // int previousNotIgnored(int);
 962   int nextNotIgnored(int);
 963   void handleOpenP(int i);
 964   void handleCloseP(int i, bool closingAllowed);
 965   void resetOpenedP(int openPos);
 966   void addIntervall(int upper);
 967   void addIntervall(int low, int upper); /* if explicit */
 968   void setForDefaultLang(int upTo);
 969   int findclosing(int start, int end, char up, char down);
 970   void handleParentheses(int lastpos, bool closingAllowed);
 971   void output(ostringstream &os, int lastpos);
 972   // string show(int lastpos);
 973 };
 974
 975 void Intervall::setForDefaultLang(int upTo)
 976 {
 977   // Enable the use of first token again
 978   if (ignoreidx >= 0) {
 979     if (borders[0].low < upTo)
 980       borders[0].low = upTo;
 981     if (borders[0].upper < upTo)
 982       borders[0].upper = upTo;
 983   }
 984 }
 985
 986 static void checkDepthIndex(int val)
 987 {
 988   static int maxdepthidx = MAXOPENED-2;
 989   if (val > maxdepthidx) {
 990     maxdepthidx = val;
 991     LYXERR0("maxdepthidx now " << val);
 992   }
 993 }
 994
 995 static void checkIgnoreIdx(int val)
 996 {
 997   static int maxignoreidx = 2*MAXOPENED - 4;
 998   if (val > maxignoreidx) {
 999     maxignoreidx = val;
1000     LYXERR0("maxignoreidx now " << val);
1001   }
1002 }
1003
1004 /*
1005  * Expand the region of ignored parts of the input latex string
1006  * The region is only relevant in output()
1007  */
1008 void Intervall::addIntervall(int low, int upper)
1009 {
1010   int idx;
1011   if (low == upper) return;
1012   for (idx = ignoreidx+1; idx > 0; --idx) {
1013     if (low > borders[idx-1].upper) {
1014       break;
1015     }
1016   }
1017   Border br(low, upper);
1018   if (idx > ignoreidx) {
1019     borders[idx] = br;
1020     ignoreidx = idx;
1021     checkIgnoreIdx(ignoreidx);
1022     return;
1023   }
1024   else {
1025     // Expand only if one of the new bound is inside the interwall
1026     // We know here that br.low > borders[idx-1].upper
1027     if (br.upper < borders[idx].low) {
1028       // We have to insert at this pos
1029       for (int i = ignoreidx+1; i > idx; --i) {
1030         borders[i] = borders[i-1];
1031       }
1032       borders[idx] = br;
1033       ignoreidx += 1;
1034       checkIgnoreIdx(ignoreidx);
1035       return;
1036     }
1037     // Here we know, that we are overlapping
1038     if (br.low > borders[idx].low)
1039       br.low = borders[idx].low;
1040     // check what has to be concatenated
1041     int count = 0;
1042     for (int i = idx; i <= ignoreidx; i++) {
1043       if (br.upper >= borders[i].low) {
1044         count++;
1045         if (br.upper < borders[i].upper)
1046           br.upper = borders[i].upper;
1047       }
1048       else {
1049         break;
1050       }
1051     }
1052     // count should be >= 1 here
1053     borders[idx] = br;
1054     if (count > 1) {
1055       for (int i = idx + count; i <= ignoreidx; i++) {
1056         borders[i-count+1] = borders[i];
1057       }
1058       ignoreidx -= count - 1;
1059       return;
1060     }
1061   }
1062 }
1063
1064 void Intervall::handleOpenP(int i)
1065 {
1066   actualdeptindex++;
1067   depts[actualdeptindex] = i+1;
1068   closes[actualdeptindex] = -1;
1069   checkDepthIndex(actualdeptindex);
1070 }
1071
1072 void Intervall::handleCloseP(int i, bool closingAllowed)
1073 {
1074   if (actualdeptindex <= 0) {
1075     if (! closingAllowed)
1076       LYXERR(Debug::FIND, "Bad closing parenthesis in latex");  /* should not happen, but the latex input may be wrong */
1077     // if we are at the very end
1078     addIntervall(i, i+1);
1079   }
1080   else {
1081     closes[actualdeptindex] = i+1;
1082     actualdeptindex--;
1083   }
1084 }
1085
1086 void Intervall::resetOpenedP(int openPos)
1087 {
1088   // Used as initializer for foreignlanguage entry
1089   actualdeptindex = 1;
1090   depts[1] = openPos+1;
1091   closes[1] = -1;
1092 }
1093
1094 #if 0
1095 int Intervall::previousNotIgnored(int start)
1096 {
1097     int idx = 0;                          /* int intervalls */
1098     for (idx = ignoreidx; idx >= 0; --idx) {
1099       if (start > borders[idx].upper)
1100         return start;
1101       if (start >= borders[idx].low)
1102         start = borders[idx].low-1;
1103     }
1104     return start;
1105 }
1106 #endif
1107
1108 int Intervall::nextNotIgnored(int start)
1109 {
1110     int idx = 0;                          /* int intervalls */
1111     for (idx = 0; idx <= ignoreidx; idx++) {
1112       if (start < borders[idx].low)
1113         return start;
1114       if (start < borders[idx].upper)
1115         start = borders[idx].upper;
1116     }
1117     return start;
1118 }
1119
1120 typedef map<string, KeyInfo> KeysMap;
1121 typedef vector< KeyInfo> Entries;
1122 static KeysMap keys = map<string, KeyInfo>();
1123
1124 class IgnoreFormats {
1125   static bool ignoreFamily;
1126   static bool ignoreSeries;
1127   static bool ignoreShape;
1128   static bool ignoreUnderline;
1129   static bool ignoreMarkUp;
1130   static bool ignoreStrikeOut;
1131   static bool ignoreSectioning;
1132   static bool ignoreFrontMatter;
1133   static bool ignoreColor;
1134   static bool ignoreLanguage;
1135  public:
1136   bool getFamily() { return ignoreFamily; };
1137   bool getSeries() { return ignoreSeries; };
1138   bool getShape() { return ignoreShape; };
1139   bool getUnderline() { return ignoreUnderline; };
1140   bool getMarkUp() { return ignoreMarkUp; };
1141   bool getStrikeOut() { return ignoreStrikeOut; };
1142   bool getSectioning() { return ignoreSectioning; };
1143   bool getFrontMatter() { return ignoreFrontMatter; };
1144   bool getColor() { return ignoreColor; };
1145   bool getLanguage() { return ignoreLanguage; };
1146
1147   void setIgnoreFormat(string type, bool value);
1148 };
1149
1150 bool IgnoreFormats::ignoreFamily     = false;
1151 bool IgnoreFormats::ignoreSeries     = false;
1152 bool IgnoreFormats::ignoreShape      = false;
1153 bool IgnoreFormats::ignoreUnderline  = false;
1154 bool IgnoreFormats::ignoreMarkUp     = false;
1155 bool IgnoreFormats::ignoreStrikeOut  = false;
1156 bool IgnoreFormats::ignoreSectioning = false;
1157 bool IgnoreFormats::ignoreFrontMatter= true;
1158 bool IgnoreFormats::ignoreColor      = false;
1159 bool IgnoreFormats::ignoreLanguage   = false;
1160
1161 void IgnoreFormats::setIgnoreFormat(string type, bool value)
1162 {
1163   if (type == "color") {
1164     ignoreColor = value;
1165   }
1166   else if (type == "language") {
1167     ignoreLanguage = value;
1168   }
1169   else if (type == "sectioning") {
1170     ignoreSectioning = value;
1171     ignoreFrontMatter = value;
1172   }
1173   else if (type == "font") {
1174     ignoreSeries = value;
1175     ignoreShape = value;
1176     ignoreFamily = value;
1177   }
1178   else if (type == "series") {
1179     ignoreSeries = value;
1180   }
1181   else if (type == "shape") {
1182     ignoreShape = value;
1183   }
1184   else if (type == "family") {
1185     ignoreFamily = value;
1186   }
1187   else if (type == "markup") {
1188     ignoreMarkUp = value;
1189   }
1190   else if (type == "underline") {
1191     ignoreUnderline = value;
1192   }
1193   else if (type == "strike") {
1194     ignoreStrikeOut = value;
1195   }
1196 }
1197 #pragma GCC diagnostic push
1198 #pragma GCC diagnostic ignored "-Wpragmas"
1199 #pragma GCC diagnostic ignored "-Wunused"
1200 #pragma GCC diagnostic ignored "-Wunused-function"
1201
1202 #ifdef __GNUC__
1203 #define SUPPRESS_NOT_USED_WARN __attribute__ ((unused))
1204 #else
1205 #define SUPPRESS_NOT_USED_WARN
1206 #endif
1207
1208 void SUPPRESS_NOT_USED_WARN setIgnoreFormat(string type, bool value)
1209 {
1210   IgnoreFormats().setIgnoreFormat(type, value);
1211 }
1212 #pragma GCC diagnostic pop
1213
1214 class LatexInfo {
1215  private:
1216   int entidx;
1217   Entries entries;
1218   Intervall interval;
1219   void buildKeys(bool);
1220   void buildEntries(bool);
1221   void makeKey(const string &, KeyInfo, bool isPatternString);
1222   void processRegion(int start, int region_end); /*  remove {} parts */
1223   void removeHead(KeyInfo&, int count=0);
1224   IgnoreFormats f;
1225
1226  public:
1227  LatexInfo(string par, bool isPatternString) : interval(isPatternString) {
1228     interval.par = par;
1229     buildKeys(isPatternString);
1230     entries = vector<KeyInfo>();
1231     buildEntries(isPatternString);
1232   };
1233   int getFirstKey() {
1234     entidx = 0;
1235     if (entries.empty()) {
1236       return (-1);
1237     }
1238     return 0;
1239   };
1240   int getNextKey() {
1241     entidx++;
1242     if (int(entries.size()) > entidx) {
1243       return entidx;
1244     }
1245     else {
1246       return (-1);
1247     }
1248   };
1249   bool setNextKey(int idx) {
1250     if ((idx == entidx) && (entidx >= 0)) {
1251       entidx--;
1252       return true;
1253     }
1254     else
1255       return false;
1256   };
1257   int process(ostringstream &os, KeyInfo &actual);
1258   int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1259   // string show(int lastpos) { return interval.show(lastpos);};
1260   int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1261   KeyInfo &getKeyInfo(int keyinfo) {
1262     static KeyInfo invalidInfo = KeyInfo();
1263     if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1264       return invalidInfo;
1265     else
1266       return entries[keyinfo];
1267   };
1268   void setForDefaultLang(int upTo) {interval.setForDefaultLang(upTo);};
1269 };
1270
1271
1272 int Intervall::findclosing(int start, int end, char up = '{', char down = '}')
1273 {
1274   int skip = 0;
1275   int depth = 0;
1276   for (int i = start; i < end; i += 1 + skip) {
1277     char c;
1278     c = par[i];
1279     skip = 0;
1280     if (c == '\\') skip = 1;
1281     else if (c == up) {
1282       depth++;
1283     }
1284     else if (c == down) {
1285       if (depth == 0) return i;
1286       --depth;
1287     }
1288   }
1289   return end;
1290 }
1291
1292 class MathInfo {
1293   class MathEntry {
1294   public:
1295     string wait;
1296     size_t mathEnd;
1297     size_t mathStart;
1298     size_t mathSize;
1299   };
1300   size_t actualIdx;
1301   vector<MathEntry> entries;
1302  public:
1303   MathInfo() {
1304     actualIdx = 0;
1305   }
1306   void insert(string wait, size_t start, size_t end) {
1307     MathEntry m = MathEntry();
1308     m.wait = wait;
1309     m.mathStart = start;
1310     m.mathEnd = end;
1311     m.mathSize = end - start;
1312     entries.push_back(m);
1313   }
1314   bool evaluating(size_t pos) {
1315     while (actualIdx < entries.size()) {
1316       if (pos < entries[actualIdx].mathStart)
1317         return false;
1318       if (pos < entries[actualIdx].mathEnd)
1319         return true;
1320       actualIdx++;
1321     }
1322     return false;
1323   }
1324   bool empty() { return entries.empty(); };
1325   size_t getEndPos() {
1326     if (entries.empty() || (actualIdx >= entries.size())) {
1327       return 0;
1328     }
1329     return entries[actualIdx].mathEnd;
1330   }
1331   size_t getStartPos() {
1332     if (entries.empty() || (actualIdx >= entries.size())) {
1333       return 100000;                    /*  definitely enough? */
1334     }
1335     return entries[actualIdx].mathStart;
1336   }
1337   size_t getFirstPos() {
1338     actualIdx = 0;
1339     return getStartPos();
1340   }
1341   size_t getSize() {
1342     if (entries.empty() || (actualIdx >= entries.size())) {
1343       return size_t(0);
1344     }
1345     return entries[actualIdx].mathSize;
1346   }
1347   void incrEntry() { actualIdx++; };
1348 };
1349
1350 void LatexInfo::buildEntries(bool isPatternString)
1351 {
1352   static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multiline|align)\\*?)\\}");
1353   static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1354   static bool disableLanguageOverride = false;
1355   smatch sub, submath;
1356   bool evaluatingRegexp = false;
1357   MathInfo mi;
1358   bool evaluatingMath = false;
1359   KeyInfo found;
1360   bool math_end_waiting = false;
1361   size_t math_pos = 10000;
1362   string math_end;
1363
1364   for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1365     submath = *itmath;
1366     if (math_end_waiting) {
1367       size_t pos = submath.position(size_t(0));
1368       if (math_end == "$") {
1369         if ((submath.str(0) == "$") && (interval.par[pos-1] != '\\')) {
1370           mi.insert("$", math_pos, pos + 1);
1371           math_end_waiting = false;
1372         }
1373       }
1374       else if (math_end == "\\]") {
1375         if (submath.str(0) == "\\]") {
1376           mi.insert("\\]", math_pos, pos + 2);
1377           math_end_waiting = false;
1378         }
1379       }
1380       else if ((submath.str(1).compare("end") == 0) &&
1381           (submath.str(2).compare(math_end) == 0)) {
1382         mi.insert(math_end, math_pos, pos + submath.str(0).length());
1383         math_end_waiting = false;
1384       }
1385     }
1386     else {
1387       if (submath.str(1).compare("begin") == 0) {
1388         math_end_waiting = true;
1389         math_end = submath.str(2);
1390         math_pos = submath.position(size_t(0));
1391       }
1392       else if (submath.str(0).compare("\\[") == 0) {
1393         math_end_waiting = true;
1394         math_end = "\\]";
1395         math_pos = submath.position(size_t(0));
1396       }
1397       else if (submath.str(0) == "$") {
1398         size_t pos = submath.position(size_t(0));
1399         if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1400           math_end_waiting = true;
1401           math_end = "$";
1402           math_pos = pos;
1403         }
1404       }
1405     }
1406   }
1407   // Ignore language if there is math somewhere in pattern-string
1408   if (isPatternString) {
1409     if (! mi.empty()) {
1410       // Disable language
1411       keys["foreignlanguage"].disabled = true;
1412       disableLanguageOverride = true;
1413     }
1414     else
1415       disableLanguageOverride = false;
1416   }
1417   else {
1418     if (disableLanguageOverride) {
1419       keys["foreignlanguage"].disabled = true;
1420     }
1421   }
1422   math_pos = mi.getFirstPos();
1423   for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1424     sub = *it;
1425     string key = sub.str(3);
1426     if (key == "") {
1427       if (sub.str(0)[0] == '\\')
1428         key = sub.str(0)[1];
1429       else
1430         key = sub.str(0);
1431     };
1432     if (evaluatingRegexp) {
1433       if (sub.str(1).compare("endregexp") == 0) {
1434         evaluatingRegexp = false;
1435         // found._tokenstart already set
1436         found._dataEnd = sub.position(size_t(0)) + 13;
1437         found._dataStart = found._dataEnd;
1438         found._tokensize = found._dataEnd - found._tokenstart;
1439         found.parenthesiscount = 0;
1440       }
1441     }
1442     else {
1443       if (evaluatingMath) {
1444         if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1445           continue;
1446         evaluatingMath = false;
1447         mi.incrEntry();
1448         math_pos = mi.getStartPos();
1449       }
1450       if (keys.find(key) == keys.end()) {
1451         LYXERR(Debug::FIND, "Found unknown key " << sub.str(0));
1452         continue;
1453       }
1454       found = keys[key];
1455       if (key.compare("regexp") == 0) {
1456         evaluatingRegexp = true;
1457         found._tokenstart = sub.position(size_t(0));
1458         found._tokensize = 0;
1459         continue;
1460       }
1461     }
1462     // Handle the other params of key
1463     if (found.keytype == KeyInfo::isIgnored)
1464       continue;
1465     else if (found.keytype == KeyInfo::isMath) {
1466       if (size_t(sub.position(size_t(0))) == math_pos) {
1467         found = keys[key];
1468         found._tokenstart = sub.position(size_t(0));
1469         found._tokensize = mi.getSize();
1470         found._dataEnd = found._tokenstart + found._tokensize;
1471         found._dataStart = found._dataEnd;
1472         found.parenthesiscount = 0;
1473         evaluatingMath = true;
1474       }
1475       else {
1476         // begin|end of unknown env, discard
1477         found = keys[key];
1478         // discard spaces and '%' before pos(0)
1479         int pos = sub.position(size_t(0));
1480         int count;
1481         for (count = 0; pos - count > 0; count++) {
1482           char c = interval.par[pos-count-1];
1483           if ((c != ' ') && (c != '%'))
1484             break;
1485         }
1486         found.keytype = KeyInfo::doRemove;
1487         found._tokenstart = pos - count;
1488         if (sub.str(1).compare(0, 5, "begin") == 0) {
1489           size_t pos1 = pos + sub.str(0).length();
1490           if (interval.par[pos1] == '[') {
1491             pos1 = interval.findclosing(pos1+1, interval.par.length(), '[', ']')+1;
1492           }
1493           found._dataEnd = interval.findclosing(pos1+1, interval.par.length()) + 1;
1494           found._dataStart = found._dataEnd;
1495         }
1496         else {
1497           found._dataStart = pos + sub.str(0).length();
1498           found._dataEnd = found._dataStart;
1499         }
1500         found._tokensize = count + found._dataEnd - pos;
1501         found.parenthesiscount = 0;
1502         found.disabled = true;
1503       }
1504     }
1505     else if (found.keytype != KeyInfo::isRegex) {
1506       found._tokenstart = sub.position(size_t(0));
1507       if (found.parenthesiscount == 0) {
1508         // Probably to be discarded
1509         char following = interval.par[sub.position(size_t(0)) + sub.str(3).length() + 1];
1510         if (following == ' ')
1511           found.head = "\\" + sub.str(3) + " ";
1512         else if (following == '=') {
1513           // like \uldepth=1000pt
1514           found.head = sub.str(0);
1515         }
1516         else
1517           found.head = "\\" + key;
1518         found._tokensize = found.head.length();
1519         found._dataEnd = found._tokenstart + found._tokensize;
1520         found._dataStart = found._dataEnd;
1521       }
1522       else {
1523         if (found.parenthesiscount == 1) {
1524           found.head = "\\" + key + "{";
1525         }
1526         else if (found.parenthesiscount == 2) {
1527           found.head = sub.str(0) + "{";
1528         }
1529         found._tokensize = found.head.length();
1530         found._dataStart = found._tokenstart + found.head.length();
1531         found._dataEnd = interval.findclosing(found._dataStart, interval.par.length());
1532         if (isPatternString) {
1533           keys[key].used = true;
1534         }
1535       }
1536     }
1537     entries.push_back(found);
1538   }
1539 }
1540
1541 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1542 {
1543   stringstream s(keysstring);
1544   string key;
1545   const char delim = '|';
1546   while (getline(s, key, delim)) {
1547     KeyInfo keyII(keyI);
1548     if (isPatternString) {
1549       keyII.used = false;
1550     }
1551     else if ( !keys[key].used)
1552       keyII.disabled = true;
1553     keys[key] = keyII;
1554   }
1555 }
1556
1557 void LatexInfo::buildKeys(bool isPatternString)
1558 {
1559
1560   static bool keysBuilt = false;
1561   if (keysBuilt && !isPatternString) return;
1562
1563   // Know standard keys with 1 parameter.
1564   // Split is done, if not at start of region
1565   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, f.getFamily()), isPatternString);
1566   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, f.getSeries()), isPatternString);
1567   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, f.getShape()), isPatternString);
1568   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, f.getUnderline()), isPatternString);
1569   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, f.getMarkUp()), isPatternString);
1570   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, f.getStrikeOut()), isPatternString);
1571
1572   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1573           KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1574   makeKey("section*|subsection*|subsubsection*|paragraph*",
1575           KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1576   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1577   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isSectioning, 1, f.getFrontMatter()), isPatternString);
1578   // Regex
1579   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1580
1581   // Split is done, if not at start of region
1582   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, f.getColor()), isPatternString);
1583
1584   // Split is done always.
1585   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, f.getLanguage()), isPatternString);
1586
1587   // Know charaters
1588   // No split
1589   makeKey("backslash|textbackslash|textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 1, false), isPatternString);
1590   // Found in fr/UserGuide.lyx
1591   makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1592
1593   // Known macros to remove (including their parameter)
1594   // No split
1595   makeKey("inputencoding|shortcut|label|ref", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1596
1597   // Macros to remove, but let the parameter survive
1598   // No split
1599   makeKey("url|href|menuitem|footnote|code|index", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1600
1601   // Same effect as previous, parameter will survive (because there is no one anyway)
1602   // No split
1603   makeKey("noindent", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
1604   makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1605   // like ('tiny{}' or '\tiny ' ... }
1606   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, true), isPatternString);
1607
1608   // Survives, like known character
1609   makeKey("lyx|latex|tex", KeyInfo(KeyInfo::isIgnored, 0, false), isPatternString);
1610   makeKey("item", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
1611
1612   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1613   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1614   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1615
1616   makeKey("par|uldepth|ULdepth|protect", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1617
1618   if (isPatternString) {
1619     // Allow the first searched string to rebuild the keys too
1620     keysBuilt = false;
1621   }
1622   else {
1623     // no need to rebuild again
1624     keysBuilt = true;
1625   }
1626 }
1627
1628 /*
1629  * Keep the list of actual opened parentheses actual
1630  * (e.g. depth == 4 means there are 4 '{' not processed yet)
1631  */
1632 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
1633 {
1634   int skip = 0;
1635   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
1636     char c;
1637     c = par[i];
1638     skip = 0;
1639     if (c == '\\') skip = 1;
1640     else if (c == '{') {
1641       handleOpenP(i);
1642     }
1643     else if (c == '}') {
1644       handleCloseP(i, closingAllowed);
1645     }
1646   }
1647 }
1648
1649 #if (0)
1650 string Intervall::show(int lastpos)
1651 {
1652   int idx = 0;                          /* int intervalls */
1653   int count = 0;
1654   string s;
1655   int i = 0;
1656   for (idx = 0; idx <= ignoreidx; idx++) {
1657     while (i < lastpos) {
1658       int printsize;
1659       if (i <= borders[idx].low) {
1660         if (borders[idx].low > lastpos)
1661           printsize = lastpos - i;
1662         else
1663           printsize = borders[idx].low - i;
1664         s += par.substr(i, printsize);
1665         i += printsize;
1666         if (i >= borders[idx].low)
1667           i = borders[idx].upper;
1668       }
1669       else {
1670         i = borders[idx].upper;
1671         break;
1672       }
1673     }
1674   }
1675   if (lastpos > i) {
1676     s += par.substr(i, lastpos-i);
1677   }
1678   return (s);
1679 }
1680 #endif
1681
1682 void Intervall::output(ostringstream &os, int lastpos)
1683 {
1684   // get number of chars to output
1685   int idx = 0;                          /* int intervalls */
1686   int i = 0;
1687   for (idx = 0; idx <= ignoreidx; idx++) {
1688     if (i < lastpos) {
1689       int printsize;
1690       if (i <= borders[idx].low) {
1691         if (borders[idx].low > lastpos)
1692           printsize = lastpos - i;
1693         else
1694           printsize = borders[idx].low - i;
1695         os << par.substr(i, printsize);
1696         i += printsize;
1697         handleParentheses(i, false);
1698         if (i >= borders[idx].low)
1699           i = borders[idx].upper;
1700       }
1701       else {
1702         i = borders[idx].upper;
1703       }
1704     }
1705     else
1706       break;
1707   }
1708   if (lastpos > i) {
1709     os << par.substr(i, lastpos-i);
1710   }
1711   handleParentheses(lastpos, false);
1712   for (int i = actualdeptindex; i > 0; --i) {
1713     os << "}";
1714   }
1715   if (! isPatternString)
1716     os << "\n";
1717   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
1718 }
1719
1720 void LatexInfo::processRegion(int start, int region_end)
1721 {
1722   while (start < region_end) {          /* Let {[} and {]} survive */
1723     if ((interval.par[start] == '{') &&
1724         (interval.par[start+1] != ']') &&
1725         (interval.par[start+1] != '[')) {
1726       // Closing is allowed past the region
1727       int closing = interval.findclosing(start+1, interval.par.length());
1728       interval.addIntervall(start, start+1);
1729       interval.addIntervall(closing, closing+1);
1730     }
1731     start = interval.nextNotIgnored(start+1);
1732   }
1733 }
1734
1735 void LatexInfo::removeHead(KeyInfo &actual, int count)
1736 {
1737   if (actual.parenthesiscount == 0) {
1738     // "{\tiny{} ...}" ==> "{{} ...}"
1739     interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
1740   }
1741   else {
1742     // Remove header hull, that is "\url{abcd}" ==> "abcd"
1743     interval.addIntervall(actual._tokenstart, actual._dataStart);
1744     interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
1745   }
1746 }
1747
1748 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
1749 {
1750   int nextKeyIdx = 0;
1751   switch (actual.keytype)
1752   {
1753     case KeyInfo::isChar: {
1754       nextKeyIdx = getNextKey();
1755       break;
1756     }
1757     case KeyInfo::isSize: {
1758       if (actual.disabled) {
1759         // Allways disabled
1760         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
1761         interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1762         nextKeyIdx = getNextKey();
1763       } else {
1764         // Split on this key if not at start
1765         int start = interval.nextNotIgnored(previousStart);
1766         if (start < actual._tokenstart) {
1767           interval.output(os, actual._tokenstart);
1768           interval.addIntervall(start, actual._tokenstart);
1769         }
1770         // discard entry if at end of actual
1771         nextKeyIdx = process(os, actual);
1772       }
1773       break;
1774     }
1775     case KeyInfo::isStandard: {
1776       if (actual.disabled) {
1777         removeHead(actual);
1778         processRegion(actual._dataStart, actual._dataStart+1);
1779         nextKeyIdx = getNextKey();
1780       } else {
1781         // Split on this key if not at start
1782         int start = interval.nextNotIgnored(previousStart);
1783         if (start < actual._tokenstart) {
1784           interval.output(os, actual._tokenstart);
1785           interval.addIntervall(start, actual._tokenstart);
1786         }
1787         // discard entry if at end of actual
1788         nextKeyIdx = process(os, actual);
1789       }
1790       break;
1791     }
1792     case KeyInfo::doRemove: {
1793       // Remove the key with all parameters and following spaces
1794       size_t pos;
1795       for (pos = actual._dataEnd+1; pos < interval.par.length(); pos++) {
1796         if (interval.par[pos] != ' ')
1797           break;
1798       }
1799       interval.addIntervall(actual._tokenstart, pos);
1800       nextKeyIdx = getNextKey();
1801       break;
1802     }
1803     case KeyInfo::isList: {
1804       // Discard space before _tokenstart
1805       int count;
1806       for (count = 0; count < actual._tokenstart; count++) {
1807         if (interval.par[actual._tokenstart-count-1] != ' ')
1808           break;
1809       }
1810       if (actual.disabled) {
1811         interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
1812       }
1813       else {
1814         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1815       }
1816       // Discard extra parentheses '[]'
1817       if (interval.par[actual._dataEnd+1] == '[') {
1818         int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
1819         if ((interval.par[actual._dataEnd+2] == '{') &&
1820             (interval.par[posdown-1] == '}')) {
1821           interval.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
1822           interval.addIntervall(posdown-1, posdown+1);
1823         }
1824         else {
1825           interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
1826           interval.addIntervall(posdown, posdown+1);
1827         }
1828         int blk = interval.nextNotIgnored(actual._dataEnd+1);
1829         if (blk > posdown) {
1830           // Discard at most 1 space after empty item
1831           int count;
1832           for (count = 0; count < 1; count++) {
1833             if (interval.par[blk+count] != ' ')
1834               break;
1835           }
1836           if (count > 0)
1837             interval.addIntervall(blk, blk+count);
1838         }
1839       }
1840       nextKeyIdx = getNextKey();
1841       break;
1842     }
1843     case KeyInfo::isSectioning: {
1844       // Discard space before _tokenstart
1845       int count;
1846       for (count = 0; count < actual._tokenstart; count++) {
1847         if (interval.par[actual._tokenstart-count-1] != ' ')
1848           break;
1849       }
1850       if (actual.disabled) {
1851         removeHead(actual, count);
1852         nextKeyIdx = getNextKey();
1853       } else {
1854         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1855         nextKeyIdx = process(os, actual);
1856       }
1857       break;
1858     }
1859     case KeyInfo::isMath: {
1860       // Same as regex, use the content unchanged
1861       nextKeyIdx = getNextKey();
1862       break;
1863     }
1864     case KeyInfo::isRegex: {
1865       // DO NOT SPLIT ON REGEX
1866       // Do not disable
1867       nextKeyIdx = getNextKey();
1868       break;
1869     }
1870     case KeyInfo::isIgnored: {
1871       // Treat like a character for now
1872       nextKeyIdx = getNextKey();
1873       break;
1874     }
1875     case KeyInfo::isMain: {
1876       if (actual.disabled) {
1877         removeHead(actual);
1878         if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
1879             (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
1880           // Discard also the space before math-equation
1881           interval.addIntervall(actual._dataStart, actual._dataStart+1);
1882         }
1883         interval.resetOpenedP(actual._dataStart-1);
1884       }
1885       else {
1886         if (actual._tokenstart == 0) {
1887           // for the first (and maybe dummy) language
1888           interval.setForDefaultLang(actual._tokenstart + actual._tokensize);
1889         }
1890         interval.resetOpenedP(actual._dataStart-1);
1891       }
1892       break;
1893     }
1894     case KeyInfo::invalid:
1895       // This cannot happen, already handled
1896       // fall through
1897     default: {
1898       // LYXERR0("Unhandled keytype");
1899       nextKeyIdx = getNextKey();
1900       break;
1901     }
1902   }
1903   return nextKeyIdx;
1904 }
1905
1906 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
1907 {
1908   int end = interval.nextNotIgnored(actual._dataEnd);
1909   int oldStart = actual._dataStart;
1910   int nextKeyIdx = getNextKey();
1911   while (true) {
1912     if ((nextKeyIdx < 0) ||
1913         (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
1914         (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
1915       if (oldStart <= end) {
1916         processRegion(oldStart, end);
1917         oldStart = end+1;
1918       }
1919       break;
1920     }
1921     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
1922
1923     if (nextKey.keytype == KeyInfo::isMain) {
1924       (void) dispatch(os, actual._dataStart, nextKey);
1925       end = nextKey._tokenstart;
1926       break;
1927     }
1928     processRegion(oldStart, nextKey._tokenstart);
1929     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
1930
1931     oldStart = nextKey._dataEnd+1;
1932   }
1933   // now nextKey is either invalid or is outside of actual._dataEnd
1934   // output the remaining and discard myself
1935   if (oldStart <= end) {
1936     processRegion(oldStart, end);
1937   }
1938   if (interval.par[end] == '}') {
1939     end += 1;
1940     // This is the normal case.
1941     // But if using the firstlanguage, the closing may be missing
1942   }
1943   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
1944   int output_end;
1945   if (actual._dataEnd < end)
1946     output_end = interval.nextNotIgnored(actual._dataEnd);
1947   else
1948     output_end = interval.nextNotIgnored(end);
1949   if (interval.nextNotIgnored(actual._dataStart) < output_end)
1950     interval.output(os, output_end);
1951   interval.addIntervall(actual._tokenstart, end);
1952   return nextKeyIdx;
1953 }
1954
1955 string splitOnKnownMacros(string par, bool isPatternString) {
1956   ostringstream os;
1957   LatexInfo li(par, isPatternString);
1958   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
1959   DummyKey.head = "";
1960   DummyKey._tokensize = 0;
1961   DummyKey._tokenstart = 0;
1962   DummyKey._dataStart = 0;
1963   DummyKey._dataEnd = par.length();
1964   DummyKey.disabled = true;
1965   int firstkeyIdx = li.getFirstKey();
1966   string s;
1967   if (firstkeyIdx >= 0) {
1968     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
1969     int nextkeyIdx;
1970     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
1971       // Use dummy firstKey
1972       firstKey = DummyKey;
1973       (void) li.setNextKey(firstkeyIdx);
1974     }
1975     nextkeyIdx = li.process(os, firstKey);
1976     while (nextkeyIdx >= 0) {
1977       // Check for a possible gap between the last
1978       // entry and this one
1979       int datastart = li.nextNotIgnored(firstKey._dataStart);
1980       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
1981       if ((nextKey._tokenstart > datastart)) {
1982         // Handle the gap
1983         firstKey._dataStart = datastart;
1984         firstKey._dataEnd = par.length();
1985         (void) li.setNextKey(nextkeyIdx);
1986         if (firstKey._tokensize > 0) {
1987           // Fake the last opened parenthesis
1988           li.setForDefaultLang(firstKey._tokensize);
1989         }
1990         nextkeyIdx = li.process(os, firstKey);
1991       }
1992       else {
1993         if (nextKey.keytype != KeyInfo::isMain) {
1994           firstKey._dataStart = datastart;
1995           firstKey._dataEnd = nextKey._dataEnd+1;
1996           (void) li.setNextKey(nextkeyIdx);
1997           if (firstKey._tokensize > 0)
1998             li.setForDefaultLang(firstKey._tokensize);
1999           nextkeyIdx = li.process(os, firstKey);
2000         }
2001         else {
2002           nextkeyIdx = li.process(os, nextKey);
2003         }
2004       }
2005     }
2006     // Handle the remaining
2007     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2008     firstKey._dataEnd = par.length();
2009     // Check if ! empty
2010     if ((firstKey._dataStart < firstKey._dataEnd) &&
2011         (par[firstKey._dataStart] != '}')) {
2012       if (firstKey._tokensize > 0)
2013         li.setForDefaultLang(firstKey._tokensize);
2014       (void) li.process(os, firstKey);
2015     }
2016     s = os.str();
2017   }
2018   else
2019     s = par;                            /* no known macros found */
2020   return s;
2021 }
2022
2023 /*
2024  * Try to unify the language specs in the latexified text.
2025  * Resulting modified string is set to "", if
2026  * the searched tex does not contain all the features in the search pattern
2027  */
2028 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2029 {
2030         static Features regex_f;
2031         static int missed = 0;
2032         static bool regex_with_format = false;
2033
2034         int parlen = par.length();
2035
2036         while ((parlen > 0) && (par[parlen-1] == '\n')) {
2037                 parlen--;
2038         }
2039         string result;
2040         if (withformat) {
2041                 // Split the latex input into pieces which
2042                 // can be digested by our search engine
2043                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2044                 result = splitOnKnownMacros(par, isPatternString);
2045                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2046         }
2047         else
2048                 result = par.substr(0, parlen);
2049         if (isPatternString) {
2050                 missed = 0;
2051                 if (withformat) {
2052                         regex_f = identifyFeatures(result);
2053                         string features = "";
2054                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2055                                 string a = it->first;
2056                                 regex_with_format = true;
2057                                 features += " " + a;
2058                                 // LYXERR0("Identified regex format:" << a);
2059                         }
2060                         LYXERR(Debug::FIND, "Identified Features" << features);
2061
2062                 }
2063         } else if (regex_with_format) {
2064                 Features info = identifyFeatures(result);
2065                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2066                         string a = it->first;
2067                         bool b = it->second;
2068                         if (b && ! info[a]) {
2069                                 missed++;
2070                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2071                                 return("");
2072                         }
2073                 }
2074         }
2075         else {
2076                 // LYXERR0("No regex formats");
2077         }
2078         return(result);
2079 }
2080
2081
2082 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2083 static int identifyClosing(string & t)
2084 {
2085         int open_braces = 0;
2086         do {
2087                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2088                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2089                         continue;
2090                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2091                         continue;
2092                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2093                         continue;
2094                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2095                         ++open_braces;
2096                         continue;
2097                 }
2098                 break;
2099         } while (true);
2100         return open_braces;
2101 }
2102
2103
2104 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2105         : p_buf(&buf), p_first_buf(&buf), opt(opt)
2106 {
2107         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2108         docstring const & ds = stringifySearchBuffer(find_buf, opt);
2109         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2110         // When using regexp, braces are hacked already by escape_for_regex()
2111         par_as_string = normalize(ds, !use_regexp);
2112         open_braces = 0;
2113         close_wildcards = 0;
2114
2115         size_t lead_size = 0;
2116         // correct the language settings
2117         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2118         if (opt.ignoreformat) {
2119                 if (!use_regexp) {
2120                         // if par_as_string_nolead were emty,
2121                         // the following call to findAux will always *find* the string
2122                         // in the checked data, and thus always using the slow
2123                         // examining of the current text part.
2124                         par_as_string_nolead = par_as_string;
2125                 }
2126         } else {
2127                 lead_size = identifyLeading(par_as_string);
2128                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2129                 lead_as_string = par_as_string.substr(0, lead_size);
2130                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2131         }
2132
2133         if (!use_regexp) {
2134                 open_braces = identifyClosing(par_as_string);
2135                 identifyClosing(par_as_string_nolead);
2136                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2137                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2138         } else {
2139                 string lead_as_regexp;
2140                 if (lead_size > 0) {
2141                         // @todo No need to search for \regexp{} insets in leading material
2142                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2143                         par_as_string = par_as_string_nolead;
2144                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2145                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2146                 }
2147                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2148                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2149                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2150                 if (
2151                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2152                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2153                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2154                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2155                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2156                         || regex_replace(par_as_string, par_as_string,
2157                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2158                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2159                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2160                         ) {
2161                         ++close_wildcards;
2162                 }
2163                 if (!opt.ignoreformat) {
2164                         // Remove extra '\}' at end
2165                         while ( regex_replace(par_as_string, par_as_string, "(.*)\\\\}$", "$1")) {
2166                                 open_braces++;
2167                         }
2168                         /*
2169                         // save '\.'
2170                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2171                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2172                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2173                         // replace '[^...]' with '[^...\}\{\\]'
2174                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2175                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2176                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2177                         // restore '\.'
2178                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2179                         */
2180                 }
2181                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2182                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2183                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
2184                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2185
2186                 // If entered regexp must match at begin of searched string buffer
2187                 // Kornel: Added parentheses to use $1 for size of the leading string
2188                 string regexp_str;
2189                 string regexp2_str;
2190                 {
2191                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2192                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
2193                         // so the convert has no effect in that case
2194                         for (int i = 8; i > 0; --i) {
2195                                 string orig = "\\\\" + std::to_string(i);
2196                                 string dest = "\\" + std::to_string(i+1);
2197                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
2198                         }
2199                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2200                         regexp2_str = "(" + lead_as_regexp + ").*" + par_as_string;
2201                 }
2202                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2203                 regexp = lyx::regex(regexp_str);
2204
2205                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2206                 regexp2 = lyx::regex(regexp2_str);
2207         }
2208 }
2209
2210
2211 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2212 {
2213         if (at_begin &&
2214                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2215                 return 0;
2216
2217         docstring docstr = stringifyFromForSearch(opt, cur, len);
2218         string str = normalize(docstr, true);
2219         if (!opt.ignoreformat) {
2220                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2221         }
2222         if (str.empty()) return(-1);
2223         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2224         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2225
2226         if (use_regexp) {
2227                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2228                 regex const *p_regexp;
2229                 regex_constants::match_flag_type flags;
2230                 if (at_begin) {
2231                         flags = regex_constants::match_continuous;
2232                         p_regexp = &regexp;
2233                 } else {
2234                         flags = regex_constants::match_default;
2235                         p_regexp = &regexp2;
2236                 }
2237                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2238                 if (re_it == sregex_iterator())
2239                         return 0;
2240                 match_results<string::const_iterator> const & m = *re_it;
2241
2242                 if (0) { // Kornel Benko: DO NOT CHECKK
2243                         // Check braces on the segment that matched the entire regexp expression,
2244                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2245                         if (!braces_match(m[0].first, m[0].second, open_braces))
2246                                 return 0;
2247                 }
2248
2249                 // Check braces on segments that matched all (.*?) subexpressions,
2250                 // except the last "padding" one inserted by lyx.
2251                 for (size_t i = 1; i < m.size() - 1; ++i)
2252                         if (!braces_match(m[i].first, m[i].second, open_braces))
2253                                 return 0;
2254
2255                 // Exclude from the returned match length any length
2256                 // due to close wildcards added at end of regexp
2257                 // and also the length of the leading (e.g. '\emph{')
2258                 //
2259                 // Whole found string, including the leading: m[0].second - m[0].first
2260                 // Size of the leading string: m[1].second - m[1].first
2261                 int leadingsize = 0;
2262                 if (m.size() > 1)
2263                         leadingsize = m[1].second - m[1].first;
2264                 int result;
2265                 for (size_t i = 0; i < m.size(); i++) {
2266                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2267                 }
2268                 if (close_wildcards == 0)
2269                         result = m[0].second - m[0].first;
2270
2271                 else
2272                         result =  m[m.size() - close_wildcards].first - m[0].first;
2273
2274                 if (result > leadingsize)
2275                         result -= leadingsize;
2276                 else
2277                         result = 0;
2278                 return(result);
2279         }
2280
2281         // else !use_regexp: but all code paths above return
2282         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2283                                  << par_as_string << "', str='" << str << "'");
2284         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2285                                  << lead_as_string << "', par_as_string_nolead='"
2286                                  << par_as_string_nolead << "'");
2287
2288         if (at_begin) {
2289                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2290                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2291                 if (str.substr(0, par_as_string.size()) == par_as_string)
2292                         return par_as_string.size();
2293         } else {
2294                 size_t pos = str.find(par_as_string_nolead);
2295                 if (pos != string::npos)
2296                         return par_as_string.size();
2297         }
2298         return 0;
2299 }
2300
2301
2302 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2303 {
2304         int res = findAux(cur, len, at_begin);
2305         LYXERR(Debug::FIND,
2306                "res=" << res << ", at_begin=" << at_begin
2307                << ", matchword=" << opt.matchword
2308                << ", inTexted=" << cur.inTexted());
2309         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2310                 return res;
2311         Paragraph const & par = cur.paragraph();
2312         bool ws_left = (cur.pos() > 0)
2313                 ? par.isWordSeparator(cur.pos() - 1)
2314                 : true;
2315         bool ws_right = (cur.pos() + res < par.size())
2316                 ? par.isWordSeparator(cur.pos() + res)
2317                 : true;
2318         LYXERR(Debug::FIND,
2319                "cur.pos()=" << cur.pos() << ", res=" << res
2320                << ", separ: " << ws_left << ", " << ws_right
2321                << endl);
2322         if (ws_left && ws_right)
2323                 return res;
2324         return 0;
2325 }
2326
2327
2328 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2329 {
2330         string t;
2331         if (! opt.casesensitive)
2332                 t = lyx::to_utf8(lowercase(s));
2333         else
2334                 t = lyx::to_utf8(s);
2335         // Remove \n at begin
2336         while (!t.empty() && t[0] == '\n')
2337                 t = t.substr(1);
2338         // Remove \n at end
2339         while (!t.empty() && t[t.size() - 1] == '\n')
2340                 t = t.substr(0, t.size() - 1);
2341         size_t pos;
2342         // Replace all other \n with spaces
2343         while ((pos = t.find("\n")) != string::npos)
2344                 t.replace(pos, 1, " ");
2345         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
2346         // Kornel: Added textsl, textsf, textit, texttt and noun
2347         // + allow to seach for colored text too
2348         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
2349         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
2350                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2351         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
2352                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2353
2354         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
2355         // FIXME - check what preceeds the brace
2356         if (hack_braces) {
2357                 if (opt.ignoreformat)
2358                         while (regex_replace(t, t, "\\{", "_x_<")
2359                                || regex_replace(t, t, "\\}", "_x_>"))
2360                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2361                 else
2362                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
2363                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
2364                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2365         }
2366
2367         return t;
2368 }
2369
2370
2371 docstring stringifyFromCursor(DocIterator const & cur, int len)
2372 {
2373         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
2374         if (cur.inTexted()) {
2375                 Paragraph const & par = cur.paragraph();
2376                 // TODO what about searching beyond/across paragraph breaks ?
2377                 // TODO Try adding a AS_STR_INSERTS as last arg
2378                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
2379                         int(par.size()) : cur.pos() + len;
2380                 OutputParams runparams(&cur.buffer()->params().encoding());
2381                 runparams.nice = true;
2382                 runparams.flavor = OutputParams::LATEX;
2383                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
2384                 // No side effect of file copying and image conversion
2385                 runparams.dryrun = true;
2386                 LYXERR(Debug::FIND, "Stringifying with cur: "
2387                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
2388                 return par.asString(cur.pos(), end,
2389                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
2390                         &runparams);
2391         } else if (cur.inMathed()) {
2392                 CursorSlice cs = cur.top();
2393                 MathData md = cs.cell();
2394                 MathData::const_iterator it_end =
2395                         (( len == -1 || cs.pos() + len > int(md.size()))
2396                          ? md.end()
2397                          : md.begin() + cs.pos() + len );
2398                 MathData md2;
2399                 for (MathData::const_iterator it = md.begin() + cs.pos();
2400                      it != it_end; ++it)
2401                         md2.push_back(*it);
2402                 docstring s = asString(md2);
2403                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
2404                 return s;
2405         }
2406         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2407         return docstring();
2408 }
2409
2410
2411 /** Computes the LaTeX export of buf starting from cur and ending len positions
2412  * after cur, if len is positive, or at the paragraph or innermost inset end
2413  * if len is -1.
2414  */
2415 docstring latexifyFromCursor(DocIterator const & cur, int len)
2416 {
2417         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
2418         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
2419                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
2420         Buffer const & buf = *cur.buffer();
2421
2422         odocstringstream ods;
2423         otexstream os(ods);
2424         OutputParams runparams(&buf.params().encoding());
2425         runparams.nice = false;
2426         runparams.flavor = OutputParams::LATEX;
2427         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2428         // No side effect of file copying and image conversion
2429         runparams.dryrun = true;
2430         runparams.for_search = true;
2431
2432         if (cur.inTexted()) {
2433                 // @TODO what about searching beyond/across paragraph breaks ?
2434                 pos_type endpos = cur.paragraph().size();
2435                 if (len != -1 && endpos > cur.pos() + len)
2436                         endpos = cur.pos() + len;
2437                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
2438                           string(), cur.pos(), endpos);
2439                 string s = lyx::to_utf8(ods.str());
2440                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
2441                 return(lyx::from_utf8(s));
2442         } else if (cur.inMathed()) {
2443                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
2444                 for (int s = cur.depth() - 1; s >= 0; --s) {
2445                         CursorSlice const & cs = cur[s];
2446                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
2447                                 WriteStream ws(os);
2448                                 cs.asInsetMath()->asHullInset()->header_write(ws);
2449                                 break;
2450                         }
2451                 }
2452
2453                 CursorSlice const & cs = cur.top();
2454                 MathData md = cs.cell();
2455                 MathData::const_iterator it_end =
2456                         ((len == -1 || cs.pos() + len > int(md.size()))
2457                          ? md.end()
2458                          : md.begin() + cs.pos() + len);
2459                 MathData md2;
2460                 for (MathData::const_iterator it = md.begin() + cs.pos();
2461                      it != it_end; ++it)
2462                         md2.push_back(*it);
2463
2464                 ods << asString(md2);
2465                 // Retrieve the math environment type, and add '$' or '$]'
2466                 // or others (\end{equation}) accordingly
2467                 for (int s = cur.depth() - 1; s >= 0; --s) {
2468                         CursorSlice const & cs2 = cur[s];
2469                         InsetMath * inset = cs2.asInsetMath();
2470                         if (inset && inset->asHullInset()) {
2471                                 WriteStream ws(os);
2472                                 inset->asHullInset()->footer_write(ws);
2473                                 break;
2474                         }
2475                 }
2476                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
2477         } else {
2478                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2479         }
2480         return ods.str();
2481 }
2482
2483
2484 /** Finalize an advanced find operation, advancing the cursor to the innermost
2485  ** position that matches, plus computing the length of the matching text to
2486  ** be selected
2487  **/
2488 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
2489 {
2490         // Search the foremost position that matches (avoids find of entire math
2491         // inset when match at start of it)
2492         size_t d;
2493         DocIterator old_cur(cur.buffer());
2494         do {
2495                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
2496                 d = cur.depth();
2497                 old_cur = cur;
2498                 cur.forwardPos();
2499         } while (cur && cur.depth() > d && match(cur) > 0);
2500         cur = old_cur;
2501         if (match(cur) <= 0) return 0;
2502         LYXERR(Debug::FIND, "Ok");
2503
2504         // Compute the match length
2505         int len = 1;
2506         if (cur.pos() + len > cur.lastpos())
2507                 return 0;
2508         LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2509         while (cur.pos() + len <= cur.lastpos() && match(cur, len) <= 0) {
2510                 ++len;
2511                 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2512         }
2513         // Length of matched text (different from len param)
2514         int old_len = match(cur, len);
2515         if (old_len < 0) old_len = 0;
2516         int new_len;
2517         // Greedy behaviour while matching regexps
2518         bool examining = true;
2519         while (examining) {
2520                 examining = false;
2521                 // Kornel: The loop is needed, since it looks like
2522                 // incrementing 'cur.pos()' does not always lead to the following
2523                 // char which we could then match.
2524                 for (int count = 1; count < 5; ++count) {
2525                         if (cur.pos() + len + count > cur.lastpos()) {
2526                                 break;
2527                         }
2528                         new_len = match(cur, len + count);
2529                         if (new_len > old_len) {
2530                                 len += count;
2531                                 old_len = new_len;
2532                                 examining = true;
2533                                 break;
2534                         }
2535                 }
2536         }
2537         return len;
2538 }
2539
2540
2541 /// Finds forward
2542 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
2543 {
2544         if (!cur)
2545                 return 0;
2546         while (!theApp()->longOperationCancelled() && cur) {
2547                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
2548                 int match_len = match(cur, -1, false);
2549                 LYXERR(Debug::FIND, "match_len: " << match_len);
2550                 if (match_len > 0) {
2551                         int match_len_zero_count = 0;
2552                         for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
2553                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
2554                                 int match_len2 = match(cur);
2555                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
2556                                 if (match_len2 > 0) {
2557                                         // Sometimes in finalize we understand it wasn't a match
2558                                         // and we need to continue the outest loop
2559                                         int len = findAdvFinalize(cur, match);
2560                                         if (len > 0) {
2561                                                 return len;
2562                                         }
2563                                 }
2564                                 if (match_len2 >= 0) {
2565                                         if (match_len2 == 0)
2566                                                 match_len_zero_count++;
2567                                         else
2568                                                 match_len_zero_count = 0;
2569                                 }
2570                                 else {
2571                                         if (++match_len_zero_count > 3) {
2572                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
2573                                                 match_len_zero_count = 0;
2574                                         }
2575                                         break;
2576                                 }
2577                         }
2578                         if (!cur)
2579                                 return 0;
2580                 }
2581                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
2582                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
2583                         cur.forwardPar();
2584                 } else {
2585                         // This should exit nested insets, if any, or otherwise undefine the currsor.
2586                         cur.pos() = cur.lastpos();
2587                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
2588                         cur.forwardPos();
2589                 }
2590         }
2591         return 0;
2592 }
2593
2594
2595 /// Find the most backward consecutive match within same paragraph while searching backwards.
2596 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
2597 {
2598         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2599         DocIterator tmp_cur = cur;
2600         int len = findAdvFinalize(tmp_cur, match);
2601         Inset & inset = cur.inset();
2602         for (; cur != cur_begin; cur.backwardPos()) {
2603                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
2604                 DocIterator new_cur = cur;
2605                 new_cur.backwardPos();
2606                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
2607                         break;
2608                 int new_len = findAdvFinalize(new_cur, match);
2609                 if (new_len == len)
2610                         break;
2611                 len = new_len;
2612         }
2613         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
2614         return len;
2615 }
2616
2617
2618 /// Finds backwards
2619 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
2620 {
2621         if (! cur)
2622                 return 0;
2623         // Backup of original position
2624         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2625         if (cur == cur_begin)
2626                 return 0;
2627         cur.backwardPos();
2628         DocIterator cur_orig(cur);
2629         bool pit_changed = false;
2630         do {
2631                 cur.pos() = 0;
2632                 bool found_match = match(cur, -1, false);
2633
2634                 if (found_match) {
2635                         if (pit_changed)
2636                                 cur.pos() = cur.lastpos();
2637                         else
2638                                 cur.pos() = cur_orig.pos();
2639                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
2640                         DocIterator cur_prev_iter;
2641                         do {
2642                                 found_match = match(cur);
2643                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
2644                                        << found_match << ", cur: " << cur);
2645                                 if (found_match)
2646                                         return findMostBackwards(cur, match);
2647
2648                                 // Stop if begin of document reached
2649                                 if (cur == cur_begin)
2650                                         break;
2651                                 cur_prev_iter = cur;
2652                                 cur.backwardPos();
2653                         } while (true);
2654                 }
2655                 if (cur == cur_begin)
2656                         break;
2657                 if (cur.pit() > 0)
2658                         --cur.pit();
2659                 else
2660                         cur.backwardPos();
2661                 pit_changed = true;
2662         } while (!theApp()->longOperationCancelled());
2663         return 0;
2664 }
2665
2666
2667 } // namespace
2668
2669
2670 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
2671                                  DocIterator const & cur, int len)
2672 {
2673         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
2674                 return docstring();
2675         if (!opt.ignoreformat)
2676                 return latexifyFromCursor(cur, len);
2677         else
2678                 return stringifyFromCursor(cur, len);
2679 }
2680
2681
2682 FindAndReplaceOptions::FindAndReplaceOptions(
2683         docstring const & find_buf_name, bool casesensitive,
2684         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
2685         docstring const & repl_buf_name, bool keep_case,
2686         SearchScope scope, SearchRestriction restr)
2687         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
2688           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
2689           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
2690 {
2691 }
2692
2693
2694 namespace {
2695
2696
2697 /** Check if 'len' letters following cursor are all non-lowercase */
2698 static bool allNonLowercase(Cursor const & cur, int len)
2699 {
2700         pos_type beg_pos = cur.selectionBegin().pos();
2701         pos_type end_pos = cur.selectionBegin().pos() + len;
2702         if (len > cur.lastpos() + 1 - beg_pos) {
2703                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
2704                 len = cur.lastpos() + 1 - beg_pos;
2705                 end_pos = beg_pos + len;
2706         }
2707         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
2708                 if (isLowerCase(cur.paragraph().getChar(pos)))
2709                         return false;
2710         return true;
2711 }
2712
2713
2714 /** Check if first letter is upper case and second one is lower case */
2715 static bool firstUppercase(Cursor const & cur)
2716 {
2717         char_type ch1, ch2;
2718         pos_type pos = cur.selectionBegin().pos();
2719         if (pos >= cur.lastpos() - 1) {
2720                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
2721                 return false;
2722         }
2723         ch1 = cur.paragraph().getChar(pos);
2724         ch2 = cur.paragraph().getChar(pos + 1);
2725         bool result = isUpperCase(ch1) && isLowerCase(ch2);
2726         LYXERR(Debug::FIND, "firstUppercase(): "
2727                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
2728                << ch2 << "(" << char(ch2) << ")"
2729                << ", result=" << result << ", cur=" << cur);
2730         return result;
2731 }
2732
2733
2734 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
2735  **
2736  ** \fixme What to do with possible further paragraphs in replace buffer ?
2737  **/
2738 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
2739 {
2740         ParagraphList::iterator pit = buffer.paragraphs().begin();
2741         LASSERT(pit->size() >= 1, /**/);
2742         pos_type right = pos_type(1);
2743         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
2744         right = pit->size();
2745         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
2746 }
2747
2748 } // namespace
2749
2750 ///
2751 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
2752 {
2753         Cursor & cur = bv->cursor();
2754         if (opt.repl_buf_name == docstring()
2755             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
2756             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2757                 return;
2758
2759         DocIterator sel_beg = cur.selectionBegin();
2760         DocIterator sel_end = cur.selectionEnd();
2761         if (&sel_beg.inset() != &sel_end.inset()
2762             || sel_beg.pit() != sel_end.pit()
2763             || sel_beg.idx() != sel_end.idx())
2764                 return;
2765         int sel_len = sel_end.pos() - sel_beg.pos();
2766         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
2767                << ", sel_len: " << sel_len << endl);
2768         if (sel_len == 0)
2769                 return;
2770         LASSERT(sel_len > 0, return);
2771
2772         if (!matchAdv(sel_beg, sel_len))
2773                 return;
2774
2775         // Build a copy of the replace buffer, adapted to the KeepCase option
2776         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
2777         ostringstream oss;
2778         repl_buffer_orig.write(oss);
2779         string lyx = oss.str();
2780         Buffer repl_buffer("", false);
2781         repl_buffer.setUnnamed(true);
2782         LASSERT(repl_buffer.readString(lyx), return);
2783         if (opt.keep_case && sel_len >= 2) {
2784                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
2785                 if (cur.inTexted()) {
2786                         if (firstUppercase(cur))
2787                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
2788                         else if (allNonLowercase(cur, sel_len))
2789                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
2790                 }
2791         }
2792         cap::cutSelection(cur, false);
2793         if (cur.inTexted()) {
2794                 repl_buffer.changeLanguage(
2795                         repl_buffer.language(),
2796                         cur.getFont().language());
2797                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
2798                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
2799                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
2800                                         repl_buffer.params().documentClassPtr(),
2801                                         bv->buffer().errorList("Paste"));
2802                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
2803                 sel_len = repl_buffer.paragraphs().begin()->size();
2804         } else if (cur.inMathed()) {
2805                 odocstringstream ods;
2806                 otexstream os(ods);
2807                 OutputParams runparams(&repl_buffer.params().encoding());
2808                 runparams.nice = false;
2809                 runparams.flavor = OutputParams::LATEX;
2810                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2811                 runparams.dryrun = true;
2812                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
2813                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
2814                 docstring repl_latex = ods.str();
2815                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
2816                 string s;
2817                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
2818                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
2819                 repl_latex = from_utf8(s);
2820                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
2821                 MathData ar(cur.buffer());
2822                 asArray(repl_latex, ar, Parse::NORMAL);
2823                 cur.insert(ar);
2824                 sel_len = ar.size();
2825                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2826         }
2827         if (cur.pos() >= sel_len)
2828                 cur.pos() -= sel_len;
2829         else
2830                 cur.pos() = 0;
2831         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2832         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
2833         bv->processUpdateFlags(Update::Force);
2834 }
2835
2836
2837 /// Perform a FindAdv operation.
2838 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
2839 {
2840         DocIterator cur;
2841         int match_len = 0;
2842
2843         // e.g., when invoking word-findadv from mini-buffer wither with
2844         //       wrong options syntax or before ever opening advanced F&R pane
2845         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2846                 return false;
2847
2848         try {
2849                 MatchStringAdv matchAdv(bv->buffer(), opt);
2850                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
2851                 if (length > 0)
2852                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
2853                 findAdvReplace(bv, opt, matchAdv);
2854                 cur = bv->cursor();
2855                 if (opt.forward)
2856                         match_len = findForwardAdv(cur, matchAdv);
2857                 else
2858                         match_len = findBackwardsAdv(cur, matchAdv);
2859         } catch (...) {
2860                 // This may only be raised by lyx::regex()
2861                 bv->message(_("Invalid regular expression!"));
2862                 return false;
2863         }
2864
2865         if (match_len == 0) {
2866                 bv->message(_("Match not found!"));
2867                 return false;
2868         }
2869
2870         bv->message(_("Match found!"));
2871
2872         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
2873         bv->putSelectionAt(cur, match_len, !opt.forward);
2874
2875         return true;
2876 }
2877
2878
2879 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
2880 {
2881         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
2882            << opt.casesensitive << ' '
2883            << opt.matchword << ' '
2884            << opt.forward << ' '
2885            << opt.expandmacros << ' '
2886            << opt.ignoreformat << ' '
2887            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
2888            << opt.keep_case << ' '
2889            << int(opt.scope) << ' '
2890            << int(opt.restr);
2891
2892         LYXERR(Debug::FIND, "built: " << os.str());
2893
2894         return os;
2895 }
2896
2897
2898 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
2899 {
2900         LYXERR(Debug::FIND, "parsing");
2901         string s;
2902         string line;
2903         getline(is, line);
2904         while (line != "EOSS") {
2905                 if (! s.empty())
2906                         s = s + "\n";
2907                 s = s + line;
2908                 if (is.eof())   // Tolerate malformed request
2909                         break;
2910                 getline(is, line);
2911         }
2912         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
2913         opt.find_buf_name = from_utf8(s);
2914         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
2915         is.get();       // Waste space before replace string
2916         s = "";
2917         getline(is, line);
2918         while (line != "EOSS") {
2919                 if (! s.empty())
2920                         s = s + "\n";
2921                 s = s + line;
2922                 if (is.eof())   // Tolerate malformed request
2923                         break;
2924                 getline(is, line);
2925         }
2926         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
2927         opt.repl_buf_name = from_utf8(s);
2928         is >> opt.keep_case;
2929         int i;
2930         is >> i;
2931         opt.scope = FindAndReplaceOptions::SearchScope(i);
2932         is >> i;
2933         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
2934
2935         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
2936                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
2937                << opt.scope << ' ' << opt.restr);
2938         return is;
2939 }
2940
2941 } // namespace lyx