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) {};
 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
1273 int Intervall::findclosing(int start, int end, char up = '{', char down = '}')
1274 {
1275   int skip = 0;
1276   int depth = 0;
1277   for (int i = start; i < end; i += 1 + skip) {
1278     char c;
1279     c = par[i];
1280     skip = 0;
1281     if (c == '\\') skip = 1;
1282     else if (c == up) {
1283       depth++;
1284     }
1285     else if (c == down) {
1286       if (depth == 0) return(i);
1287       --depth;
1288     }
1289   }
1290   return(end);
1291 }
1292
1293 class MathInfo {
1294   class MathEntry {
1295   public:
1296     string wait;
1297     size_t mathEnd;
1298     size_t mathStart;
1299     size_t mathSize;
1300   };
1301   size_t actualIdx;
1302   vector<MathEntry> entries;
1303  public:
1304   MathInfo() {
1305     actualIdx = 0;
1306   }
1307   void insert(string wait, size_t start, size_t end) {
1308     MathEntry m = MathEntry();
1309     m.wait = wait;
1310     m.mathStart = start;
1311     m.mathEnd = end;
1312     m.mathSize = end - start;
1313     entries.push_back(m);
1314   }
1315   bool evaluating(size_t pos) {
1316     while (actualIdx < entries.size()) {
1317       if (pos < entries[actualIdx].mathStart)
1318         return false;
1319       if (pos < entries[actualIdx].mathEnd)
1320         return true;
1321       actualIdx++;
1322     }
1323     return false;
1324   }
1325   bool empty() { return(entries.empty()); };
1326   size_t getEndPos() {
1327     if (entries.empty() || (actualIdx >= entries.size())) {
1328       return 0;
1329     }
1330     return entries[actualIdx].mathEnd;
1331   }
1332   size_t getStartPos() {
1333     if (entries.empty() || (actualIdx >= entries.size())) {
1334       return 100000;                    /*  definitely enough? */
1335     }
1336     return entries[actualIdx].mathStart;
1337   }
1338   size_t getFirstPos() {
1339     actualIdx = 0;
1340     return getStartPos();
1341   }
1342   size_t getSize() {
1343     if (entries.empty() || (actualIdx >= entries.size())) {
1344       return size_t(0);
1345     }
1346     return entries[actualIdx].mathSize;
1347   }
1348   void incrEntry() { actualIdx++; };
1349 };
1350
1351 void LatexInfo::buildEntries(bool isPatternString)
1352 {
1353   static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multiline|align)\\*?)\\}");
1354   static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1355   static bool disableLanguageOverride = false;
1356   smatch sub, submath;
1357   bool evaluatingRegexp = false;
1358   MathInfo mi;
1359   bool evaluatingMath = false;
1360   KeyInfo found;
1361   bool math_end_waiting = false;
1362   size_t math_pos = 10000;
1363   string math_end;
1364
1365   for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1366     submath = *itmath;
1367     if (math_end_waiting) {
1368       size_t pos = submath.position(size_t(0));
1369       if (math_end == "$") {
1370         if ((submath.str(0) == "$") && (interval.par[pos-1] != '\\')) {
1371           mi.insert("$", math_pos, pos + 1);
1372           math_end_waiting = false;
1373         }
1374       }
1375       else if (math_end == "\\]") {
1376         if (submath.str(0) == "\\]") {
1377           mi.insert("\\]", math_pos, pos + 2);
1378           math_end_waiting = false;
1379         }
1380       }
1381       else if ((submath.str(1).compare("end") == 0) &&
1382           (submath.str(2).compare(math_end) == 0)) {
1383         mi.insert(math_end, math_pos, pos + submath.str(0).length());
1384         math_end_waiting = false;
1385       }
1386     }
1387     else {
1388       if (submath.str(1).compare("begin") == 0) {
1389         math_end_waiting = true;
1390         math_end = submath.str(2);
1391         math_pos = submath.position(size_t(0));
1392       }
1393       else if (submath.str(0).compare("\\[") == 0) {
1394         math_end_waiting = true;
1395         math_end = "\\]";
1396         math_pos = submath.position(size_t(0));
1397       }
1398       else if (submath.str(0) == "$") {
1399         size_t pos = submath.position(size_t(0));
1400         if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1401           math_end_waiting = true;
1402           math_end = "$";
1403           math_pos = pos;
1404         }
1405       }
1406     }
1407   }
1408   // Ignore language if there is math somewhere in pattern-string
1409   if (isPatternString) {
1410     if (! mi.empty()) {
1411       // Disable language
1412       keys["foreignlanguage"].disabled = true;
1413       disableLanguageOverride = true;
1414     }
1415     else
1416       disableLanguageOverride = false;
1417   }
1418   else {
1419     if (disableLanguageOverride) {
1420       keys["foreignlanguage"].disabled = true;
1421     }
1422   }
1423   math_pos = mi.getFirstPos();
1424   for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1425     sub = *it;
1426     string key = sub.str(3);
1427     if (key == "") {
1428       if (sub.str(0)[0] == '\\')
1429         key = sub.str(0)[1];
1430       else
1431         key = sub.str(0);
1432     };
1433     if (evaluatingRegexp) {
1434       if (sub.str(1).compare("endregexp") == 0) {
1435         evaluatingRegexp = false;
1436         // found._tokenstart already set
1437         found._dataEnd = sub.position(size_t(0)) + 13;
1438         found._dataStart = found._dataEnd;
1439         found._tokensize = found._dataEnd - found._tokenstart;
1440         found.parenthesiscount = 0;
1441       }
1442     }
1443     else {
1444       if (evaluatingMath) {
1445         if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1446           continue;
1447         evaluatingMath = false;
1448         mi.incrEntry();
1449         math_pos = mi.getStartPos();
1450       }
1451       if (keys.find(key) == keys.end()) {
1452         LYXERR(Debug::FIND, "Found unknown key " << sub.str(0));
1453         continue;
1454       }
1455       found = keys[key];
1456       if (key.compare("regexp") == 0) {
1457         evaluatingRegexp = true;
1458         found._tokenstart = sub.position(size_t(0));
1459         found._tokensize = 0;
1460         continue;
1461       }
1462     }
1463     // Handle the other params of key
1464     if (found.keytype == KeyInfo::isIgnored)
1465       continue;
1466     else if (found.keytype == KeyInfo::isMath) {
1467       if (size_t(sub.position(size_t(0))) == math_pos) {
1468         found = keys[key];
1469         found._tokenstart = sub.position(size_t(0));
1470         found._tokensize = mi.getSize();
1471         found._dataEnd = found._tokenstart + found._tokensize;
1472         found._dataStart = found._dataEnd;
1473         found.parenthesiscount = 0;
1474         evaluatingMath = true;
1475       }
1476       else
1477         continue;
1478     }
1479     else if (found.keytype != KeyInfo::isRegex) {
1480       found._tokenstart = sub.position(size_t(0));
1481       if (found.parenthesiscount == 0) {
1482         // Probably to be discarded
1483         char following = interval.par[sub.position(size_t(0)) + sub.str(3).length() + 1];
1484         if (following == ' ')
1485           found.head = "\\" + sub.str(3) + " ";
1486         else if (following == '=') {
1487           // like \uldepth=1000pt
1488           found.head = sub.str(0);
1489         }
1490         else
1491           found.head = "\\" + key;
1492         found._tokensize = found.head.length();
1493         found._dataEnd = found._tokenstart + found._tokensize;
1494         found._dataStart = found._dataEnd;
1495       }
1496       else {
1497         if (found.parenthesiscount == 1) {
1498           found.head = "\\" + key + "{";
1499         }
1500         else if (found.parenthesiscount == 2) {
1501           found.head = sub.str(0) + "{";
1502         }
1503         found._tokensize = found.head.length();
1504         found._dataStart = found._tokenstart + found.head.length();
1505         found._dataEnd = interval.findclosing(found._dataStart, interval.par.length());
1506         if (isPatternString) {
1507           keys[key].used = true;
1508         }
1509       }
1510     }
1511     entries.push_back(found);
1512   }
1513 }
1514
1515 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1516 {
1517   stringstream s(keysstring);
1518   string key;
1519   const char delim = '|';
1520   while (getline(s, key, delim)) {
1521     KeyInfo keyII(keyI);
1522     if (isPatternString) {
1523       keyII.used = false;
1524     }
1525     else if ( !keys[key].used)
1526       keyII.disabled = true;
1527     keys[key] = keyII;
1528   }
1529 }
1530
1531 void LatexInfo::buildKeys(bool isPatternString)
1532 {
1533
1534   static bool keysBuilt = false;
1535   if (keysBuilt && !isPatternString) return;
1536
1537   // Know standard keys with 1 parameter.
1538   // Split is done, if not at start of region
1539   makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, f.getFamily()), isPatternString);
1540   makeKey("textbf",               KeyInfo(KeyInfo::isStandard, 1, f.getSeries()), isPatternString);
1541   makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, f.getShape()), isPatternString);
1542   makeKey("uuline|uline|uwave",   KeyInfo(KeyInfo::isStandard, 1, f.getUnderline()), isPatternString);
1543   makeKey("emph|noun",            KeyInfo(KeyInfo::isStandard, 1, f.getMarkUp()), isPatternString);
1544   makeKey("sout|xout",            KeyInfo(KeyInfo::isStandard, 1, f.getStrikeOut()), isPatternString);
1545
1546   makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1547           KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1548   makeKey("section*|subsection*|subsubsection*|paragraph*",
1549           KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1550   makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, f.getSectioning()), isPatternString);
1551   makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isSectioning, 1, f.getFrontMatter()), isPatternString);
1552   // Regex
1553   makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1554
1555   // Split is done, if not at start of region
1556   makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, f.getColor()), isPatternString);
1557
1558   // Split is done always.
1559   makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, f.getLanguage()), isPatternString);
1560
1561   // Know charaters
1562   // No split
1563   makeKey("backslash|textbackslash|textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 1, false), isPatternString);
1564
1565   // Known macros to remove (including their parameter)
1566   // No split
1567   makeKey("inputencoding|shortcut|label|ref", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1568
1569   // Macros to remove, but let the parameter survive
1570   // No split
1571   makeKey("url|href|menuitem|footnote|code", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1572
1573   // Same effect as previous, parameter will survive (because there is no one anyway)
1574   // No split
1575   makeKey("noindent", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
1576   // like ('tiny{}' or '\tiny ' ... }
1577   makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, true), isPatternString);
1578
1579   // Survives, like known character
1580   makeKey("lyx|latex|tex", KeyInfo(KeyInfo::isIgnored, 0, false), isPatternString);
1581   makeKey("item", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
1582
1583   makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1584   makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1585   makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1586
1587   makeKey("par|uldepth|ULdepth|protect", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1588
1589   if (isPatternString) {
1590     // Allow the first searched string to rebuild the keys too
1591     keysBuilt = false;
1592   }
1593   else {
1594     // no need to rebuild again
1595     keysBuilt = true;
1596   }
1597 }
1598
1599 /*
1600  * Keep the list of actual opened parentheses actual
1601  * (e.g. depth == 4 means there are 4 '{' not processed yet)
1602  */
1603 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
1604 {
1605   int skip = 0;
1606   for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
1607     char c;
1608     c = par[i];
1609     skip = 0;
1610     if (c == '\\') skip = 1;
1611     else if (c == '{') {
1612       handleOpenP(i);
1613     }
1614     else if (c == '}') {
1615       handleCloseP(i, closingAllowed);
1616     }
1617   }
1618 }
1619
1620 #if (0)
1621 string Intervall::show(int lastpos)
1622 {
1623   int idx = 0;                          /* int intervalls */
1624   int count = 0;
1625   string s;
1626   int i = 0;
1627   for (idx = 0; idx <= ignoreidx; idx++) {
1628     while (i < lastpos) {
1629       int printsize;
1630       if (i <= borders[idx].low) {
1631         if (borders[idx].low > lastpos)
1632           printsize = lastpos - i;
1633         else
1634           printsize = borders[idx].low - i;
1635         s += par.substr(i, printsize);
1636         i += printsize;
1637         if (i >= borders[idx].low)
1638           i = borders[idx].upper;
1639       }
1640       else {
1641         i = borders[idx].upper;
1642         break;
1643       }
1644     }
1645   }
1646   if (lastpos > i) {
1647     s += par.substr(i, lastpos-i);
1648   }
1649   return (s);
1650 }
1651 #endif
1652
1653 void Intervall::output(ostringstream &os, int lastpos)
1654 {
1655   // get number of chars to output
1656   int idx = 0;                          /* int intervalls */
1657   int i = 0;
1658   for (idx = 0; idx <= ignoreidx; idx++) {
1659     if (i < lastpos) {
1660       int printsize;
1661       if (i <= borders[idx].low) {
1662         if (borders[idx].low > lastpos)
1663           printsize = lastpos - i;
1664         else
1665           printsize = borders[idx].low - i;
1666         os << par.substr(i, printsize);
1667         i += printsize;
1668         handleParentheses(i, false);
1669         if (i >= borders[idx].low)
1670           i = borders[idx].upper;
1671       }
1672       else {
1673         i = borders[idx].upper;
1674       }
1675     }
1676     else
1677       break;
1678   }
1679   if (lastpos > i) {
1680     os << par.substr(i, lastpos-i);
1681   }
1682   handleParentheses(lastpos, false);
1683   for (int i = actualdeptindex; i > 0; --i) {
1684     os << "}";
1685   }
1686   if (! isPatternString)
1687     os << "\n";
1688   handleParentheses(lastpos, true); /* extra closings '}' allowed here */
1689 }
1690
1691 void LatexInfo::processRegion(int start, int region_end)
1692 {
1693   while (start < region_end) {          /* Let {[} and {]} survive */
1694     if ((interval.par[start] == '{') &&
1695         (interval.par[start+1] != ']') &&
1696         (interval.par[start+1] != '[')) {
1697       // Closing is allowed past the region
1698       int closing = interval.findclosing(start+1, interval.par.length());
1699       interval.addIntervall(start, start+1);
1700       interval.addIntervall(closing, closing+1);
1701     }
1702     start = interval.nextNotIgnored(start+1);
1703   }
1704 }
1705
1706 void LatexInfo::removeHead(KeyInfo &actual, int count)
1707 {
1708   if (actual.parenthesiscount == 0) {
1709     // "{\tiny{} ...}" ==> "{{} ...}"
1710     interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
1711   }
1712   else {
1713     // Remove header hull, that is "\url{abcd}" ==> "abcd"
1714     interval.addIntervall(actual._tokenstart, actual._dataStart);
1715     interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
1716   }
1717 }
1718
1719 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
1720 {
1721   int nextKeyIdx = 0;
1722   switch (actual.keytype)
1723   {
1724     case KeyInfo::isChar: {
1725       nextKeyIdx = getNextKey();
1726       break;
1727     }
1728     case KeyInfo::isSize: {
1729       if (actual.disabled) {
1730         // Allways disabled
1731         processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
1732         interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1733         nextKeyIdx = getNextKey();
1734       } else {
1735         // Split on this key if not at start
1736         int start = interval.nextNotIgnored(previousStart);
1737         if (start < actual._tokenstart) {
1738           interval.output(os, actual._tokenstart);
1739           interval.addIntervall(start, actual._tokenstart);
1740         }
1741         // discard entry if at end of actual
1742         nextKeyIdx = process(os, actual);
1743       }
1744       break;
1745     }
1746     case KeyInfo::isStandard: {
1747       if (actual.disabled) {
1748         removeHead(actual);
1749         processRegion(actual._dataStart, actual._dataStart+1);
1750         nextKeyIdx = getNextKey();
1751       } else {
1752         // Split on this key if not at start
1753         int start = interval.nextNotIgnored(previousStart);
1754         if (start < actual._tokenstart) {
1755           interval.output(os, actual._tokenstart);
1756           interval.addIntervall(start, actual._tokenstart);
1757         }
1758         // discard entry if at end of actual
1759         nextKeyIdx = process(os, actual);
1760       }
1761       break;
1762     }
1763     case KeyInfo::doRemove: {
1764       // Remove the key with all parameters
1765       interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1766       nextKeyIdx = getNextKey();
1767       break;
1768     }
1769     case KeyInfo::isList: {
1770       // Discard space before _tokenstart
1771       int count;
1772       for (count = 0; count < actual._tokenstart; count++) {
1773         if (interval.par[actual._tokenstart-count-1] != ' ')
1774           break;
1775       }
1776       if (actual.disabled) {
1777         interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
1778       }
1779       else {
1780         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1781       }
1782       // Discard extra parentheses '[]'
1783       if (interval.par[actual._dataEnd+1] == '[') {
1784         int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
1785         interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
1786         interval.addIntervall(posdown, posdown+1);
1787       }
1788       nextKeyIdx = getNextKey();
1789       break;
1790     }
1791     case KeyInfo::isSectioning: {
1792       // Discard space before _tokenstart
1793       int count;
1794       for (count = 0; count < actual._tokenstart; count++) {
1795         if (interval.par[actual._tokenstart-count-1] != ' ')
1796           break;
1797       }
1798       if (actual.disabled) {
1799         removeHead(actual, count);
1800         nextKeyIdx = getNextKey();
1801       } else {
1802         interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1803         nextKeyIdx = process(os, actual);
1804       }
1805       break;
1806     }
1807     case KeyInfo::isMath: {
1808       // Same as regex, use the content unchanged
1809       nextKeyIdx = getNextKey();
1810       break;
1811     }
1812     case KeyInfo::isRegex: {
1813       // DO NOT SPLIT ON REGEX
1814       // Do not disable
1815       nextKeyIdx = getNextKey();
1816       break;
1817     }
1818     case KeyInfo::isIgnored: {
1819       // Treat like a character for now
1820       nextKeyIdx = getNextKey();
1821       break;
1822     }
1823     case KeyInfo::isMain: {
1824       if (actual.disabled) {
1825         removeHead(actual);
1826         if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
1827             (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
1828           // Discard also the space before math-equation
1829           interval.addIntervall(actual._dataStart, actual._dataStart+1);
1830         }
1831         interval.resetOpenedP(actual._dataStart-1);
1832       }
1833       else {
1834         if (actual._tokenstart == 0) {
1835           // for the first (and maybe dummy) language
1836           interval.setForDefaultLang(actual._tokenstart + actual._tokensize);
1837         }
1838         interval.resetOpenedP(actual._dataStart-1);
1839       }
1840       break;
1841     }
1842     case KeyInfo::invalid:
1843       // This cannot happen, already handled
1844       // fall through
1845     default: {
1846       // LYXERR0("Unhandled keytype");
1847       nextKeyIdx = getNextKey();
1848       break;
1849     }
1850   }
1851   return(nextKeyIdx);
1852 }
1853
1854 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
1855 {
1856   int end = interval.nextNotIgnored(actual._dataEnd);
1857   int oldStart = actual._dataStart;
1858   int nextKeyIdx = getNextKey();
1859   while (true) {
1860     if ((nextKeyIdx < 0) ||
1861         (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
1862         (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
1863       if (oldStart <= end) {
1864         processRegion(oldStart, end);
1865         oldStart = end+1;
1866       }
1867       break;
1868     }
1869     KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
1870
1871     if (nextKey.keytype == KeyInfo::isMain) {
1872       (void) dispatch(os, actual._dataStart, nextKey);
1873       end = nextKey._tokenstart;
1874       break;
1875     }
1876     processRegion(oldStart, nextKey._tokenstart);
1877     nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
1878
1879     oldStart = nextKey._dataEnd+1;
1880   }
1881   // now nextKey is either invalid or is outside of actual._dataEnd
1882   // output the remaining and discard myself
1883   if (oldStart <= end) {
1884     processRegion(oldStart, end);
1885   }
1886   if (interval.par[end] == '}') {
1887     end += 1;
1888     // This is the normal case.
1889     // But if using the firstlanguage, the closing may be missing
1890   }
1891   // get minimum of 'end' and  'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
1892   int output_end;
1893   if (actual._dataEnd < end)
1894     output_end = interval.nextNotIgnored(actual._dataEnd);
1895   else
1896     output_end = interval.nextNotIgnored(end);
1897   if (interval.nextNotIgnored(actual._dataStart) < output_end)
1898     interval.output(os, output_end);
1899   interval.addIntervall(actual._tokenstart, end);
1900   return nextKeyIdx;
1901 }
1902
1903 string splitOnKnownMacros(string par, bool isPatternString) {
1904   ostringstream os;
1905   LatexInfo li(par, isPatternString);
1906   KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
1907   DummyKey.head = "";
1908   DummyKey._tokensize = 0;
1909   DummyKey._tokenstart = 0;
1910   DummyKey._dataStart = 0;
1911   DummyKey._dataEnd = par.length();
1912   DummyKey.disabled = true;
1913   int firstkeyIdx = li.getFirstKey();
1914   string s;
1915   if (firstkeyIdx >= 0) {
1916     KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
1917     int nextkeyIdx;
1918     if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
1919       // Use dummy firstKey
1920       firstKey = DummyKey;
1921       (void) li.setNextKey(firstkeyIdx);
1922     }
1923     nextkeyIdx = li.process(os, firstKey);
1924     while (nextkeyIdx >= 0) {
1925       // Check for a possible gap between the last
1926       // entry and this one
1927       int datastart = li.nextNotIgnored(firstKey._dataStart);
1928       KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
1929       if ((nextKey._tokenstart > datastart)) {
1930         // Handle the gap
1931         firstKey._dataStart = datastart;
1932         firstKey._dataEnd = par.length();
1933         (void) li.setNextKey(nextkeyIdx);
1934         if (firstKey._tokensize > 0) {
1935           // Fake the last opened parenthesis
1936           li.setForDefaultLang(firstKey._tokensize);
1937         }
1938         nextkeyIdx = li.process(os, firstKey);
1939       }
1940       else {
1941         if (nextKey.keytype != KeyInfo::isMain) {
1942           firstKey._dataStart = datastart;
1943           firstKey._dataEnd = nextKey._dataEnd+1;
1944           (void) li.setNextKey(nextkeyIdx);
1945           if (firstKey._tokensize > 0)
1946             li.setForDefaultLang(firstKey._tokensize);
1947           nextkeyIdx = li.process(os, firstKey);
1948         }
1949         else {
1950           nextkeyIdx = li.process(os, nextKey);
1951         }
1952       }
1953     }
1954     // Handle the remaining
1955     firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
1956     firstKey._dataEnd = par.length();
1957     if (firstKey._dataStart < firstKey._dataEnd)
1958       (void) li.process(os, firstKey);
1959     s = os.str();
1960   }
1961   else
1962     s = par;                            /* no known macros found */
1963   return s;
1964 }
1965
1966 /*
1967  * Try to unify the language specs in the latexified text.
1968  * Resulting modified string is set to "", if
1969  * the searched tex does not contain all the features in the search pattern
1970  */
1971 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
1972 {
1973         static Features regex_f;
1974         static int missed = 0;
1975         static bool regex_with_format = false;
1976
1977         int parlen = par.length();
1978
1979         while ((parlen > 0) && (par[parlen-1] == '\n')) {
1980                 parlen--;
1981         }
1982         string result;
1983         if (withformat) {
1984                 // Split the latex input into pieces which
1985                 // can be digested by our search engine
1986                 LYXERR(Debug::FIND, "input: \"" << par << "\"");
1987                 result = splitOnKnownMacros(par, isPatternString);
1988                 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
1989         }
1990         else
1991                 result = par.substr(0, parlen);
1992         if (isPatternString) {
1993                 missed = 0;
1994                 if (withformat) {
1995                         regex_f = identifyFeatures(result);
1996                         string features = "";
1997                         for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
1998                                 string a = it->first;
1999                                 regex_with_format = true;
2000                                 features += " " + a;
2001                                 // LYXERR0("Identified regex format:" << a);
2002                         }
2003                         LYXERR(Debug::FIND, "Identified Features" << features);
2004
2005                 }
2006         } else if (regex_with_format) {
2007                 Features info = identifyFeatures(result);
2008                 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2009                         string a = it->first;
2010                         bool b = it->second;
2011                         if (b && ! info[a]) {
2012                                 missed++;
2013                                 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2014                                 return("");
2015                         }
2016                 }
2017         }
2018         else {
2019                 // LYXERR0("No regex formats");
2020         }
2021         return(result);
2022 }
2023
2024
2025 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2026 static int identifyClosing(string & t)
2027 {
2028         int open_braces = 0;
2029         do {
2030                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2031                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2032                         continue;
2033                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2034                         continue;
2035                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2036                         continue;
2037                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2038                         ++open_braces;
2039                         continue;
2040                 }
2041                 break;
2042         } while (true);
2043         return open_braces;
2044 }
2045
2046
2047 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2048         : p_buf(&buf), p_first_buf(&buf), opt(opt)
2049 {
2050         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2051         docstring const & ds = stringifySearchBuffer(find_buf, opt);
2052         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2053         // When using regexp, braces are hacked already by escape_for_regex()
2054         par_as_string = normalize(ds, !use_regexp);
2055         open_braces = 0;
2056         close_wildcards = 0;
2057
2058         size_t lead_size = 0;
2059         // correct the language settings
2060         par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2061         if (opt.ignoreformat) {
2062                 if (!use_regexp) {
2063                         // if par_as_string_nolead were emty,
2064                         // the following call to findAux will always *find* the string
2065                         // in the checked data, and thus always using the slow
2066                         // examining of the current text part.
2067                         par_as_string_nolead = par_as_string;
2068                 }
2069         } else {
2070                 lead_size = identifyLeading(par_as_string);
2071                 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2072                 lead_as_string = par_as_string.substr(0, lead_size);
2073                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2074         }
2075
2076         if (!use_regexp) {
2077                 open_braces = identifyClosing(par_as_string);
2078                 identifyClosing(par_as_string_nolead);
2079                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2080                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2081         } else {
2082                 string lead_as_regexp;
2083                 if (lead_size > 0) {
2084                         // @todo No need to search for \regexp{} insets in leading material
2085                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2086                         par_as_string = par_as_string_nolead;
2087                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2088                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2089                 }
2090                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2091                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2092                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2093                 if (
2094                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2095                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2096                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2097                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2098                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2099                         || regex_replace(par_as_string, par_as_string,
2100                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2101                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2102                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2103                         ) {
2104                         ++close_wildcards;
2105                 }
2106                 if (!opt.ignoreformat) {
2107                         // Remove extra '\}' at end
2108                         while ( regex_replace(par_as_string, par_as_string, "(.*)\\\\}$", "$1")) {
2109                                 open_braces++;
2110                         }
2111                         /*
2112                         // save '\.'
2113                         regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2114                         // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2115                         regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2116                         // replace '[^...]' with '[^...\}\{\\]'
2117                         regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2118                         regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2119                         regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2120                         // restore '\.'
2121                         regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2122                         */
2123                 }
2124                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2125                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2126                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
2127                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2128
2129                 // If entered regexp must match at begin of searched string buffer
2130                 // Kornel: Added parentheses to use $1 for size of the leading string
2131                 string regexp_str;
2132                 string regexp2_str;
2133                 {
2134                         // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2135                         // Unfortunately is '\1', '\2', etc not working for strings with extra format
2136                         // so the convert has no effect in that case
2137                         for (int i = 8; i > 0; --i) {
2138                                 string orig = "\\\\" + std::to_string(i);
2139                                 string dest = "\\" + std::to_string(i+1);
2140                                 while (regex_replace(par_as_string, par_as_string, orig, dest));
2141                         }
2142                         regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2143                         regexp2_str = "(" + lead_as_regexp + ").*" + par_as_string;
2144                 }
2145                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2146                 regexp = lyx::regex(regexp_str);
2147
2148                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2149                 regexp2 = lyx::regex(regexp2_str);
2150         }
2151 }
2152
2153
2154 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2155 {
2156         if (at_begin &&
2157                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2158                 return 0;
2159
2160         docstring docstr = stringifyFromForSearch(opt, cur, len);
2161         string str = normalize(docstr, true);
2162         if (!opt.ignoreformat) {
2163                 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2164         }
2165         if (str.empty()) return(-1);
2166         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
2167         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2168
2169         if (use_regexp) {
2170                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2171                 regex const *p_regexp;
2172                 regex_constants::match_flag_type flags;
2173                 if (at_begin) {
2174                         flags = regex_constants::match_continuous;
2175                         p_regexp = &regexp;
2176                 } else {
2177                         flags = regex_constants::match_default;
2178                         p_regexp = &regexp2;
2179                 }
2180                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2181                 if (re_it == sregex_iterator())
2182                         return 0;
2183                 match_results<string::const_iterator> const & m = *re_it;
2184
2185                 if (0) { // Kornel Benko: DO NOT CHECKK
2186                         // Check braces on the segment that matched the entire regexp expression,
2187                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
2188                         if (!braces_match(m[0].first, m[0].second, open_braces))
2189                                 return 0;
2190                 }
2191
2192                 // Check braces on segments that matched all (.*?) subexpressions,
2193                 // except the last "padding" one inserted by lyx.
2194                 for (size_t i = 1; i < m.size() - 1; ++i)
2195                         if (!braces_match(m[i].first, m[i].second, open_braces))
2196                                 return 0;
2197
2198                 // Exclude from the returned match length any length
2199                 // due to close wildcards added at end of regexp
2200                 // and also the length of the leading (e.g. '\emph{')
2201                 //
2202                 // Whole found string, including the leading: m[0].second - m[0].first
2203                 // Size of the leading string: m[1].second - m[1].first
2204                 int leadingsize = 0;
2205                 if (m.size() > 1)
2206                         leadingsize = m[1].second - m[1].first;
2207                 int result;
2208                 for (size_t i = 0; i < m.size(); i++) {
2209                   LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2210                 }
2211                 if (close_wildcards == 0)
2212                         result = m[0].second - m[0].first;
2213
2214                 else
2215                         result =  m[m.size() - close_wildcards].first - m[0].first;
2216
2217                 if (result > leadingsize)
2218                         result -= leadingsize;
2219                 else
2220                         result = 0;
2221                 return(result);
2222         }
2223
2224         // else !use_regexp: but all code paths above return
2225         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2226                                  << par_as_string << "', str='" << str << "'");
2227         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2228                                  << lead_as_string << "', par_as_string_nolead='"
2229                                  << par_as_string_nolead << "'");
2230
2231         if (at_begin) {
2232                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2233                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2234                 if (str.substr(0, par_as_string.size()) == par_as_string)
2235                         return par_as_string.size();
2236         } else {
2237                 size_t pos = str.find(par_as_string_nolead);
2238                 if (pos != string::npos)
2239                         return par_as_string.size();
2240         }
2241         return 0;
2242 }
2243
2244
2245 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2246 {
2247         int res = findAux(cur, len, at_begin);
2248         LYXERR(Debug::FIND,
2249                "res=" << res << ", at_begin=" << at_begin
2250                << ", matchword=" << opt.matchword
2251                << ", inTexted=" << cur.inTexted());
2252         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2253                 return res;
2254         Paragraph const & par = cur.paragraph();
2255         bool ws_left = (cur.pos() > 0)
2256                 ? par.isWordSeparator(cur.pos() - 1)
2257                 : true;
2258         bool ws_right = (cur.pos() + res < par.size())
2259                 ? par.isWordSeparator(cur.pos() + res)
2260                 : true;
2261         LYXERR(Debug::FIND,
2262                "cur.pos()=" << cur.pos() << ", res=" << res
2263                << ", separ: " << ws_left << ", " << ws_right
2264                << endl);
2265         if (ws_left && ws_right)
2266                 return res;
2267         return 0;
2268 }
2269
2270
2271 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2272 {
2273         string t;
2274         if (! opt.casesensitive)
2275                 t = lyx::to_utf8(lowercase(s));
2276         else
2277                 t = lyx::to_utf8(s);
2278         // Remove \n at begin
2279         while (!t.empty() && t[0] == '\n')
2280                 t = t.substr(1);
2281         // Remove \n at end
2282         while (!t.empty() && t[t.size() - 1] == '\n')
2283                 t = t.substr(0, t.size() - 1);
2284         size_t pos;
2285         // Replace all other \n with spaces
2286         while ((pos = t.find("\n")) != string::npos)
2287                 t.replace(pos, 1, " ");
2288         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
2289         // Kornel: Added textsl, textsf, textit, texttt and noun
2290         // + allow to seach for colored text too
2291         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
2292         while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
2293                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2294         while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
2295                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2296
2297         while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
2298         // FIXME - check what preceeds the brace
2299         if (hack_braces) {
2300                 if (opt.ignoreformat)
2301                         while (regex_replace(t, t, "\\{", "_x_<")
2302                                || regex_replace(t, t, "\\}", "_x_>"))
2303                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2304                 else
2305                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
2306                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
2307                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2308         }
2309
2310         return t;
2311 }
2312
2313
2314 docstring stringifyFromCursor(DocIterator const & cur, int len)
2315 {
2316         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
2317         if (cur.inTexted()) {
2318                 Paragraph const & par = cur.paragraph();
2319                 // TODO what about searching beyond/across paragraph breaks ?
2320                 // TODO Try adding a AS_STR_INSERTS as last arg
2321                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
2322                         int(par.size()) : cur.pos() + len;
2323                 OutputParams runparams(&cur.buffer()->params().encoding());
2324                 runparams.nice = true;
2325                 runparams.flavor = OutputParams::LATEX;
2326                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
2327                 // No side effect of file copying and image conversion
2328                 runparams.dryrun = true;
2329                 LYXERR(Debug::FIND, "Stringifying with cur: "
2330                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
2331                 return par.asString(cur.pos(), end,
2332                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
2333                         &runparams);
2334         } else if (cur.inMathed()) {
2335                 CursorSlice cs = cur.top();
2336                 MathData md = cs.cell();
2337                 MathData::const_iterator it_end =
2338                         (( len == -1 || cs.pos() + len > int(md.size()))
2339                          ? md.end()
2340                          : md.begin() + cs.pos() + len );
2341                 MathData md2;
2342                 for (MathData::const_iterator it = md.begin() + cs.pos();
2343                      it != it_end; ++it)
2344                         md2.push_back(*it);
2345                 docstring s = asString(md2);
2346                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
2347                 return s;
2348         }
2349         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2350         return docstring();
2351 }
2352
2353
2354 /** Computes the LaTeX export of buf starting from cur and ending len positions
2355  * after cur, if len is positive, or at the paragraph or innermost inset end
2356  * if len is -1.
2357  */
2358 docstring latexifyFromCursor(DocIterator const & cur, int len)
2359 {
2360         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
2361         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
2362                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
2363         Buffer const & buf = *cur.buffer();
2364
2365         odocstringstream ods;
2366         otexstream os(ods);
2367         OutputParams runparams(&buf.params().encoding());
2368         runparams.nice = false;
2369         runparams.flavor = OutputParams::LATEX;
2370         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2371         // No side effect of file copying and image conversion
2372         runparams.dryrun = true;
2373         runparams.for_search = true;
2374
2375         if (cur.inTexted()) {
2376                 // @TODO what about searching beyond/across paragraph breaks ?
2377                 pos_type endpos = cur.paragraph().size();
2378                 if (len != -1 && endpos > cur.pos() + len)
2379                         endpos = cur.pos() + len;
2380                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
2381                           string(), cur.pos(), endpos);
2382                 string s = lyx::to_utf8(ods.str());
2383                 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
2384                 return(lyx::from_utf8(s));
2385         } else if (cur.inMathed()) {
2386                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
2387                 for (int s = cur.depth() - 1; s >= 0; --s) {
2388                         CursorSlice const & cs = cur[s];
2389                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
2390                                 WriteStream ws(os);
2391                                 cs.asInsetMath()->asHullInset()->header_write(ws);
2392                                 break;
2393                         }
2394                 }
2395
2396                 CursorSlice const & cs = cur.top();
2397                 MathData md = cs.cell();
2398                 MathData::const_iterator it_end =
2399                         ((len == -1 || cs.pos() + len > int(md.size()))
2400                          ? md.end()
2401                          : md.begin() + cs.pos() + len);
2402                 MathData md2;
2403                 for (MathData::const_iterator it = md.begin() + cs.pos();
2404                      it != it_end; ++it)
2405                         md2.push_back(*it);
2406
2407                 ods << asString(md2);
2408                 // Retrieve the math environment type, and add '$' or '$]'
2409                 // or others (\end{equation}) accordingly
2410                 for (int s = cur.depth() - 1; s >= 0; --s) {
2411                         CursorSlice const & cs2 = cur[s];
2412                         InsetMath * inset = cs2.asInsetMath();
2413                         if (inset && inset->asHullInset()) {
2414                                 WriteStream ws(os);
2415                                 inset->asHullInset()->footer_write(ws);
2416                                 break;
2417                         }
2418                 }
2419                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
2420         } else {
2421                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2422         }
2423         return ods.str();
2424 }
2425
2426
2427 /** Finalize an advanced find operation, advancing the cursor to the innermost
2428  ** position that matches, plus computing the length of the matching text to
2429  ** be selected
2430  **/
2431 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
2432 {
2433         // Search the foremost position that matches (avoids find of entire math
2434         // inset when match at start of it)
2435         size_t d;
2436         DocIterator old_cur(cur.buffer());
2437         do {
2438                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
2439                 d = cur.depth();
2440                 old_cur = cur;
2441                 cur.forwardPos();
2442         } while (cur && cur.depth() > d && match(cur) > 0);
2443         cur = old_cur;
2444         if (match(cur) <= 0) return 0;
2445         LYXERR(Debug::FIND, "Ok");
2446
2447         // Compute the match length
2448         int len = 1;
2449         if (cur.pos() + len > cur.lastpos())
2450                 return 0;
2451         LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2452         while (cur.pos() + len <= cur.lastpos() && match(cur, len) <= 0) {
2453                 ++len;
2454                 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2455         }
2456         // Length of matched text (different from len param)
2457         int old_len = match(cur, len);
2458         if (old_len < 0) old_len = 0;
2459         int new_len;
2460         // Greedy behaviour while matching regexps
2461         bool examining = true;
2462         int lastvalidlen = len;
2463         while (examining) {
2464                 examining = false;
2465                 // Kornel: The loop is needed, since it looks like
2466                 // incrementing 'cur.pos()' does not always lead to the following
2467                 // char which we could then match.
2468                 for (int count = 1; count < 5; ++count) {
2469                         if (cur.pos() + len + count > cur.lastpos()) {
2470                                 break;
2471                         }
2472                         new_len = match(cur, len + count);
2473                         if (new_len > old_len) {
2474                                 len += count;
2475                                 old_len = new_len;
2476                                 examining = true;
2477                                 break;
2478                         }
2479                         else if (new_len == old_len)
2480                                 lastvalidlen = len+count;
2481                 }
2482         }
2483         if (lastvalidlen == len + 1) {
2484                 // Kornel:  Don't know, why this is important
2485                 // All I can see, is that sometimes the last char
2486                 // is outside of a match although it should be inside
2487                 len++;
2488         }
2489         return len;
2490 }
2491
2492
2493 /// Finds forward
2494 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
2495 {
2496         if (!cur)
2497                 return 0;
2498         while (!theApp()->longOperationCancelled() && cur) {
2499                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
2500                 int match_len = match(cur, -1, false);
2501                 LYXERR(Debug::FIND, "match_len: " << match_len);
2502                 if (match_len > 0) {
2503                         int match_len_zero_count = 0;
2504                         for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
2505                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
2506                                 int match_len2 = match(cur);
2507                                 LYXERR(Debug::FIND, "match_len2: " << match_len2);
2508                                 if (match_len2 > 0) {
2509                                         // Sometimes in finalize we understand it wasn't a match
2510                                         // and we need to continue the outest loop
2511                                         int len = findAdvFinalize(cur, match);
2512                                         if (len > 0) {
2513                                                 return len;
2514                                         }
2515                                 }
2516                                 if (match_len2 >= 0) {
2517                                         if (match_len2 == 0)
2518                                                 match_len_zero_count++;
2519                                         else
2520                                                 match_len_zero_count = 0;
2521                                 }
2522                                 else {
2523                                         if (++match_len_zero_count > 3) {
2524                                                 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
2525                                                 match_len_zero_count = 0;
2526                                         }
2527                                         break;
2528                                 }
2529                         }
2530                         if (!cur)
2531                                 return 0;
2532                 }
2533                 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
2534                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
2535                         cur.forwardPar();
2536                 } else {
2537                         // This should exit nested insets, if any, or otherwise undefine the currsor.
2538                         cur.pos() = cur.lastpos();
2539                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
2540                         cur.forwardPos();
2541                 }
2542         }
2543         return 0;
2544 }
2545
2546
2547 /// Find the most backward consecutive match within same paragraph while searching backwards.
2548 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
2549 {
2550         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2551         DocIterator tmp_cur = cur;
2552         int len = findAdvFinalize(tmp_cur, match);
2553         Inset & inset = cur.inset();
2554         for (; cur != cur_begin; cur.backwardPos()) {
2555                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
2556                 DocIterator new_cur = cur;
2557                 new_cur.backwardPos();
2558                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
2559                         break;
2560                 int new_len = findAdvFinalize(new_cur, match);
2561                 if (new_len == len)
2562                         break;
2563                 len = new_len;
2564         }
2565         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
2566         return len;
2567 }
2568
2569
2570 /// Finds backwards
2571 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
2572 {
2573         if (! cur)
2574                 return 0;
2575         // Backup of original position
2576         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2577         if (cur == cur_begin)
2578                 return 0;
2579         cur.backwardPos();
2580         DocIterator cur_orig(cur);
2581         bool pit_changed = false;
2582         do {
2583                 cur.pos() = 0;
2584                 bool found_match = match(cur, -1, false);
2585
2586                 if (found_match) {
2587                         if (pit_changed)
2588                                 cur.pos() = cur.lastpos();
2589                         else
2590                                 cur.pos() = cur_orig.pos();
2591                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
2592                         DocIterator cur_prev_iter;
2593                         do {
2594                                 found_match = match(cur);
2595                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
2596                                        << found_match << ", cur: " << cur);
2597                                 if (found_match)
2598                                         return findMostBackwards(cur, match);
2599
2600                                 // Stop if begin of document reached
2601                                 if (cur == cur_begin)
2602                                         break;
2603                                 cur_prev_iter = cur;
2604                                 cur.backwardPos();
2605                         } while (true);
2606                 }
2607                 if (cur == cur_begin)
2608                         break;
2609                 if (cur.pit() > 0)
2610                         --cur.pit();
2611                 else
2612                         cur.backwardPos();
2613                 pit_changed = true;
2614         } while (!theApp()->longOperationCancelled());
2615         return 0;
2616 }
2617
2618
2619 } // namespace
2620
2621
2622 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
2623                                  DocIterator const & cur, int len)
2624 {
2625         if (cur.pos() < 0 || cur.pos() > cur.lastpos())
2626                 return docstring();
2627         if (!opt.ignoreformat)
2628                 return latexifyFromCursor(cur, len);
2629         else
2630                 return stringifyFromCursor(cur, len);
2631 }
2632
2633
2634 FindAndReplaceOptions::FindAndReplaceOptions(
2635         docstring const & find_buf_name, bool casesensitive,
2636         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
2637         docstring const & repl_buf_name, bool keep_case,
2638         SearchScope scope, SearchRestriction restr)
2639         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
2640           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
2641           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
2642 {
2643 }
2644
2645
2646 namespace {
2647
2648
2649 /** Check if 'len' letters following cursor are all non-lowercase */
2650 static bool allNonLowercase(Cursor const & cur, int len)
2651 {
2652         pos_type beg_pos = cur.selectionBegin().pos();
2653         pos_type end_pos = cur.selectionBegin().pos() + len;
2654         if (len > cur.lastpos() + 1 - beg_pos) {
2655                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
2656                 len = cur.lastpos() + 1 - beg_pos;
2657                 end_pos = beg_pos + len;
2658         }
2659         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
2660                 if (isLowerCase(cur.paragraph().getChar(pos)))
2661                         return false;
2662         return true;
2663 }
2664
2665
2666 /** Check if first letter is upper case and second one is lower case */
2667 static bool firstUppercase(Cursor const & cur)
2668 {
2669         char_type ch1, ch2;
2670         pos_type pos = cur.selectionBegin().pos();
2671         if (pos >= cur.lastpos() - 1) {
2672                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
2673                 return false;
2674         }
2675         ch1 = cur.paragraph().getChar(pos);
2676         ch2 = cur.paragraph().getChar(pos + 1);
2677         bool result = isUpperCase(ch1) && isLowerCase(ch2);
2678         LYXERR(Debug::FIND, "firstUppercase(): "
2679                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
2680                << ch2 << "(" << char(ch2) << ")"
2681                << ", result=" << result << ", cur=" << cur);
2682         return result;
2683 }
2684
2685
2686 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
2687  **
2688  ** \fixme What to do with possible further paragraphs in replace buffer ?
2689  **/
2690 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
2691 {
2692         ParagraphList::iterator pit = buffer.paragraphs().begin();
2693         LASSERT(pit->size() >= 1, /**/);
2694         pos_type right = pos_type(1);
2695         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
2696         right = pit->size();
2697         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
2698 }
2699
2700 } // namespace
2701
2702 ///
2703 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
2704 {
2705         Cursor & cur = bv->cursor();
2706         if (opt.repl_buf_name == docstring()
2707             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
2708             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2709                 return;
2710
2711         DocIterator sel_beg = cur.selectionBegin();
2712         DocIterator sel_end = cur.selectionEnd();
2713         if (&sel_beg.inset() != &sel_end.inset()
2714             || sel_beg.pit() != sel_end.pit()
2715             || sel_beg.idx() != sel_end.idx())
2716                 return;
2717         int sel_len = sel_end.pos() - sel_beg.pos();
2718         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
2719                << ", sel_len: " << sel_len << endl);
2720         if (sel_len == 0)
2721                 return;
2722         LASSERT(sel_len > 0, return);
2723
2724         if (!matchAdv(sel_beg, sel_len))
2725                 return;
2726
2727         // Build a copy of the replace buffer, adapted to the KeepCase option
2728         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
2729         ostringstream oss;
2730         repl_buffer_orig.write(oss);
2731         string lyx = oss.str();
2732         Buffer repl_buffer("", false);
2733         repl_buffer.setUnnamed(true);
2734         LASSERT(repl_buffer.readString(lyx), return);
2735         if (opt.keep_case && sel_len >= 2) {
2736                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
2737                 if (cur.inTexted()) {
2738                         if (firstUppercase(cur))
2739                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
2740                         else if (allNonLowercase(cur, sel_len))
2741                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
2742                 }
2743         }
2744         cap::cutSelection(cur, false);
2745         if (cur.inTexted()) {
2746                 repl_buffer.changeLanguage(
2747                         repl_buffer.language(),
2748                         cur.getFont().language());
2749                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
2750                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
2751                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
2752                                         repl_buffer.params().documentClassPtr(),
2753                                         bv->buffer().errorList("Paste"));
2754                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
2755                 sel_len = repl_buffer.paragraphs().begin()->size();
2756         } else if (cur.inMathed()) {
2757                 odocstringstream ods;
2758                 otexstream os(ods);
2759                 OutputParams runparams(&repl_buffer.params().encoding());
2760                 runparams.nice = false;
2761                 runparams.flavor = OutputParams::LATEX;
2762                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2763                 runparams.dryrun = true;
2764                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
2765                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
2766                 docstring repl_latex = ods.str();
2767                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
2768                 string s;
2769                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
2770                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
2771                 repl_latex = from_utf8(s);
2772                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
2773                 MathData ar(cur.buffer());
2774                 asArray(repl_latex, ar, Parse::NORMAL);
2775                 cur.insert(ar);
2776                 sel_len = ar.size();
2777                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2778         }
2779         if (cur.pos() >= sel_len)
2780                 cur.pos() -= sel_len;
2781         else
2782                 cur.pos() = 0;
2783         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2784         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
2785         bv->processUpdateFlags(Update::Force);
2786 }
2787
2788
2789 /// Perform a FindAdv operation.
2790 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
2791 {
2792         DocIterator cur;
2793         int match_len = 0;
2794
2795         // e.g., when invoking word-findadv from mini-buffer wither with
2796         //       wrong options syntax or before ever opening advanced F&R pane
2797         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2798                 return false;
2799
2800         try {
2801                 MatchStringAdv matchAdv(bv->buffer(), opt);
2802                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
2803                 if (length > 0)
2804                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
2805                 findAdvReplace(bv, opt, matchAdv);
2806                 cur = bv->cursor();
2807                 if (opt.forward)
2808                         match_len = findForwardAdv(cur, matchAdv);
2809                 else
2810                         match_len = findBackwardsAdv(cur, matchAdv);
2811         } catch (...) {
2812                 // This may only be raised by lyx::regex()
2813                 bv->message(_("Invalid regular expression!"));
2814                 return false;
2815         }
2816
2817         if (match_len == 0) {
2818                 bv->message(_("Match not found!"));
2819                 return false;
2820         }
2821
2822         bv->message(_("Match found!"));
2823
2824         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
2825         bv->putSelectionAt(cur, match_len, !opt.forward);
2826
2827         return true;
2828 }
2829
2830
2831 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
2832 {
2833         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
2834            << opt.casesensitive << ' '
2835            << opt.matchword << ' '
2836            << opt.forward << ' '
2837            << opt.expandmacros << ' '
2838            << opt.ignoreformat << ' '
2839            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
2840            << opt.keep_case << ' '
2841            << int(opt.scope) << ' '
2842            << int(opt.restr);
2843
2844         LYXERR(Debug::FIND, "built: " << os.str());
2845
2846         return os;
2847 }
2848
2849
2850 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
2851 {
2852         LYXERR(Debug::FIND, "parsing");
2853         string s;
2854         string line;
2855         getline(is, line);
2856         while (line != "EOSS") {
2857                 if (! s.empty())
2858                         s = s + "\n";
2859                 s = s + line;
2860                 if (is.eof())   // Tolerate malformed request
2861                         break;
2862                 getline(is, line);
2863         }
2864         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
2865         opt.find_buf_name = from_utf8(s);
2866         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
2867         is.get();       // Waste space before replace string
2868         s = "";
2869         getline(is, line);
2870         while (line != "EOSS") {
2871                 if (! s.empty())
2872                         s = s + "\n";
2873                 s = s + line;
2874                 if (is.eof())   // Tolerate malformed request
2875                         break;
2876                 getline(is, line);
2877         }
2878         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
2879         opt.repl_buf_name = from_utf8(s);
2880         is >> opt.keep_case;
2881         int i;
2882         is >> i;
2883         opt.scope = FindAndReplaceOptions::SearchScope(i);
2884         is >> i;
2885         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
2886
2887         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
2888                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
2889                << opt.scope << ' ' << opt.restr);
2890         return is;
2891 }
2892
2893 } // namespace lyx