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
  56 using namespace std;
  57 using namespace lyx::support;
  58
  59 namespace lyx {
  60
  61 namespace {
  62
  63 bool parse_bool(docstring & howto)
  64 {
  65         if (howto.empty())
  66                 return false;
  67         docstring var;
  68         howto = split(howto, var, ' ');
  69         return var == "1";
  70 }
  71
  72
  73 class MatchString : public binary_function<Paragraph, pos_type, int>
  74 {
  75 public:
  76         MatchString(docstring const & str, bool cs, bool mw)
  77                 : str(str), case_sens(cs), whole_words(mw)
  78         {}
  79
  80         // returns true if the specified string is at the specified position
  81         // del specifies whether deleted strings in ct mode will be considered
  82         int operator()(Paragraph const & par, pos_type pos, bool del = true) const
  83         {
  84                 return par.find(str, case_sens, whole_words, pos, del);
  85         }
  86
  87 private:
  88         // search string
  89         docstring str;
  90         // case sensitive
  91         bool case_sens;
  92         // match whole words only
  93         bool whole_words;
  94 };
  95
  96
  97 int findForward(DocIterator & cur, MatchString const & match,
  98                 bool find_del = true)
  99 {
 100         for (; cur; cur.forwardChar())
 101                 if (cur.inTexted()) {
 102                         int len = match(cur.paragraph(), cur.pos(), find_del);
 103                         if (len > 0)
 104                                 return len;
 105                 }
 106         return 0;
 107 }
 108
 109
 110 int findBackwards(DocIterator & cur, MatchString const & match,
 111                   bool find_del = true)
 112 {
 113         while (cur) {
 114                 cur.backwardChar();
 115                 if (cur.inTexted()) {
 116                         int len = match(cur.paragraph(), cur.pos(), find_del);
 117                         if (len > 0)
 118                                 return len;
 119                 }
 120         }
 121         return 0;
 122 }
 123
 124
 125 bool searchAllowed(docstring const & str)
 126 {
 127         if (str.empty()) {
 128                 frontend::Alert::error(_("Search error"), _("Search string is empty"));
 129                 return false;
 130         }
 131         return true;
 132 }
 133
 134
 135 bool findOne(BufferView * bv, docstring const & searchstr,
 136              bool case_sens, bool whole, bool forward,
 137              bool find_del = true, bool check_wrap = false)
 138 {
 139         if (!searchAllowed(searchstr))
 140                 return false;
 141
 142         DocIterator cur = forward
 143                 ? bv->cursor().selectionEnd()
 144                 : bv->cursor().selectionBegin();
 145
 146         MatchString const match(searchstr, case_sens, whole);
 147
 148         int match_len = forward
 149                 ? findForward(cur, match, find_del)
 150                 : findBackwards(cur, match, find_del);
 151
 152         if (match_len > 0)
 153                 bv->putSelectionAt(cur, match_len, !forward);
 154         else if (check_wrap) {
 155                 DocIterator cur_orig(bv->cursor());
 156                 docstring q;
 157                 if (forward)
 158                         q = _("End of file reached while searching forward.\n"
 159                           "Continue searching from the beginning?");
 160                 else
 161                         q = _("Beginning of file reached while searching backward.\n"
 162                           "Continue searching from the end?");
 163                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
 164                         q, 0, 1, _("&Yes"), _("&No"));
 165                 if (wrap_answer == 0) {
 166                         if (forward) {
 167                                 bv->cursor().clear();
 168                                 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
 169                         } else {
 170                                 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
 171                                 bv->cursor().backwardPos();
 172                         }
 173                         bv->clearSelection();
 174                         if (findOne(bv, searchstr, case_sens, whole, forward, find_del, false))
 175                                 return true;
 176                 }
 177                 bv->cursor().setCursor(cur_orig);
 178                 return false;
 179         }
 180
 181         return match_len > 0;
 182 }
 183
 184
 185 int replaceAll(BufferView * bv,
 186                docstring const & searchstr, docstring const & replacestr,
 187                bool case_sens, bool whole)
 188 {
 189         Buffer & buf = bv->buffer();
 190
 191         if (!searchAllowed(searchstr) || buf.isReadonly())
 192                 return 0;
 193
 194         DocIterator cur_orig(bv->cursor());
 195
 196         MatchString const match(searchstr, case_sens, whole);
 197         int num = 0;
 198
 199         int const rsize = replacestr.size();
 200         int const ssize = searchstr.size();
 201
 202         Cursor cur(*bv);
 203         cur.setCursor(doc_iterator_begin(&buf));
 204         int match_len = findForward(cur, match, false);
 205         while (match_len > 0) {
 206                 // Backup current cursor position and font.
 207                 pos_type const pos = cur.pos();
 208                 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
 209                 cur.recordUndo();
 210                 int striked = ssize -
 211                         cur.paragraph().eraseChars(pos, pos + match_len,
 212                                                    buf.params().track_changes);
 213                 cur.paragraph().insert(pos, replacestr, font,
 214                                        Change(buf.params().track_changes
 215                                               ? Change::INSERTED
 216                                               : Change::UNCHANGED));
 217                 for (int i = 0; i < rsize + striked; ++i)
 218                         cur.forwardChar();
 219                 ++num;
 220                 match_len = findForward(cur, match, false);
 221         }
 222
 223         bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
 224
 225         cur_orig.fixIfBroken();
 226         bv->setCursor(cur_orig);
 227
 228         return num;
 229 }
 230
 231
 232 // the idea here is that we are going to replace the string that
 233 // is selected IF it is the search string.
 234 // if there is a selection, but it is not the search string, then
 235 // we basically ignore it. (FIXME We ought to replace only within
 236 // the selection.)
 237 // if there is no selection, then:
 238 //  (i) if some search string has been provided, then we find it.
 239 //      (think of how the dialog works when you hit "replace" the
 240 //      first time.)
 241 // (ii) if no search string has been provided, then we treat the
 242 //      word the cursor is in as the search string. (why? i have no
 243 //      idea.) but this only works in text?
 244 //
 245 // returns the number of replacements made (one, if any) and
 246 // whether anything at all was done.
 247 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
 248                            docstring const & replacestr, bool case_sens,
 249                            bool whole, bool forward, bool findnext)
 250 {
 251         Cursor & cur = bv->cursor();
 252         bool found = false;
 253         if (!cur.selection()) {
 254                 // no selection, non-empty search string: find it
 255                 if (!searchstr.empty()) {
 256                         found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
 257                         return make_pair(found, 0);
 258                 }
 259                 // empty search string
 260                 if (!cur.inTexted())
 261                         // bail in math
 262                         return make_pair(false, 0);
 263                 // select current word and treat it as the search string.
 264                 // This causes a minor bug as undo will restore this selection,
 265                 // which the user did not create (#8986).
 266                 cur.innerText()->selectWord(cur, WHOLE_WORD);
 267                 searchstr = cur.selectionAsString(false);
 268         }
 269
 270         // if we still don't have a search string, report the error
 271         // and abort.
 272         if (!searchAllowed(searchstr))
 273                 return make_pair(false, 0);
 274
 275         bool have_selection = cur.selection();
 276         docstring const selected = cur.selectionAsString(false);
 277         bool match =
 278                 case_sens
 279                 ? searchstr == selected
 280                 : compare_no_case(searchstr, selected) == 0;
 281
 282         // no selection or current selection is not search word:
 283         // just find the search word
 284         if (!have_selection || !match) {
 285                 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
 286                 return make_pair(found, 0);
 287         }
 288
 289         // we're now actually ready to replace. if the buffer is
 290         // read-only, we can't, though.
 291         if (bv->buffer().isReadonly())
 292                 return make_pair(false, 0);
 293
 294         cap::replaceSelectionWithString(cur, replacestr);
 295         if (forward) {
 296                 cur.pos() += replacestr.length();
 297                 LASSERT(cur.pos() <= cur.lastpos(),
 298                         cur.pos() = cur.lastpos());
 299         }
 300         if (findnext)
 301                 findOne(bv, searchstr, case_sens, whole, forward, false, findnext);
 302
 303         return make_pair(true, 1);
 304 }
 305
 306 } // namespace
 307
 308
 309 docstring const find2string(docstring const & search,
 310                             bool casesensitive, bool matchword, bool forward)
 311 {
 312         odocstringstream ss;
 313         ss << search << '\n'
 314            << int(casesensitive) << ' '
 315            << int(matchword) << ' '
 316            << int(forward);
 317         return ss.str();
 318 }
 319
 320
 321 docstring const replace2string(docstring const & replace,
 322                                docstring const & search,
 323                                bool casesensitive, bool matchword,
 324                                bool all, bool forward, bool findnext)
 325 {
 326         odocstringstream ss;
 327         ss << replace << '\n'
 328            << search << '\n'
 329            << int(casesensitive) << ' '
 330            << int(matchword) << ' '
 331            << int(all) << ' '
 332            << int(forward) << ' '
 333            << int(findnext);
 334         return ss.str();
 335 }
 336
 337
 338 bool lyxfind(BufferView * bv, FuncRequest const & ev)
 339 {
 340         if (!bv || ev.action() != LFUN_WORD_FIND)
 341                 return false;
 342
 343         //lyxerr << "find called, cmd: " << ev << endl;
 344
 345         // data is of the form
 346         // "<search>
 347         //  <casesensitive> <matchword> <forward>"
 348         docstring search;
 349         docstring howto = split(ev.argument(), search, '\n');
 350
 351         bool casesensitive = parse_bool(howto);
 352         bool matchword     = parse_bool(howto);
 353         bool forward       = parse_bool(howto);
 354
 355         return findOne(bv, search, casesensitive, matchword, forward, true, true);
 356 }
 357
 358
 359 bool lyxreplace(BufferView * bv,
 360                 FuncRequest const & ev, bool has_deleted)
 361 {
 362         if (!bv || ev.action() != LFUN_WORD_REPLACE)
 363                 return false;
 364
 365         // data is of the form
 366         // "<search>
 367         //  <replace>
 368         //  <casesensitive> <matchword> <all> <forward> <findnext>"
 369         docstring search;
 370         docstring rplc;
 371         docstring howto = split(ev.argument(), rplc, '\n');
 372         howto = split(howto, search, '\n');
 373
 374         bool casesensitive = parse_bool(howto);
 375         bool matchword     = parse_bool(howto);
 376         bool all           = parse_bool(howto);
 377         bool forward       = parse_bool(howto);
 378         bool findnext      = howto.empty() ? true : parse_bool(howto);
 379
 380         bool update = false;
 381
 382         if (!has_deleted) {
 383                 int replace_count = 0;
 384                 if (all) {
 385                         replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
 386                         update = replace_count > 0;
 387                 } else {
 388                         pair<bool, int> rv =
 389                                 replaceOne(bv, search, rplc, casesensitive, matchword, forward, findnext);
 390                         update = rv.first;
 391                         replace_count = rv.second;
 392                 }
 393
 394                 Buffer const & buf = bv->buffer();
 395                 if (!update) {
 396                         // emit message signal.
 397                         buf.message(_("String not found."));
 398                 } else {
 399                         if (replace_count == 0) {
 400                                 buf.message(_("String found."));
 401                         } else if (replace_count == 1) {
 402                                 buf.message(_("String has been replaced."));
 403                         } else {
 404                                 docstring const str =
 405                                         bformat(_("%1$d strings have been replaced."), replace_count);
 406                                 buf.message(str);
 407                         }
 408                 }
 409         } else if (findnext) {
 410                 // if we have deleted characters, we do not replace at all, but
 411                 // rather search for the next occurence
 412                 if (findOne(bv, search, casesensitive, matchword, forward, true, findnext))
 413                         update = true;
 414                 else
 415                         bv->message(_("String not found."));
 416         }
 417         return update;
 418 }
 419
 420
 421 bool findNextChange(BufferView * bv, Cursor & cur, bool const check_wrap)
 422 {
 423         for (; cur; cur.forwardPos())
 424                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
 425                         return true;
 426
 427         if (check_wrap) {
 428                 DocIterator cur_orig(bv->cursor());
 429                 docstring q = _("End of file reached while searching forward.\n"
 430                           "Continue searching from the beginning?");
 431                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
 432                         q, 0, 1, _("&Yes"), _("&No"));
 433                 if (wrap_answer == 0) {
 434                         bv->cursor().clear();
 435                         bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
 436                         bv->clearSelection();
 437                         cur.setCursor(bv->cursor().selectionBegin());
 438                         if (findNextChange(bv, cur, false))
 439                                 return true;
 440                 }
 441                 bv->cursor().setCursor(cur_orig);
 442         }
 443
 444         return false;
 445 }
 446
 447
 448 bool findPreviousChange(BufferView * bv, Cursor & cur, bool const check_wrap)
 449 {
 450         for (cur.backwardPos(); cur; cur.backwardPos()) {
 451                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
 452                         return true;
 453         }
 454
 455         if (check_wrap) {
 456                 DocIterator cur_orig(bv->cursor());
 457                 docstring q = _("Beginning of file reached while searching backward.\n"
 458                           "Continue searching from the end?");
 459                 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
 460                         q, 0, 1, _("&Yes"), _("&No"));
 461                 if (wrap_answer == 0) {
 462                         bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
 463                         bv->cursor().backwardPos();
 464                         bv->clearSelection();
 465                         cur.setCursor(bv->cursor().selectionBegin());
 466                         if (findPreviousChange(bv, cur, false))
 467                                 return true;
 468                 }
 469                 bv->cursor().setCursor(cur_orig);
 470         }
 471
 472         return false;
 473 }
 474
 475
 476 bool selectChange(Cursor & cur, bool forward)
 477 {
 478         if (!cur.inTexted() || !cur.paragraph().isChanged(cur.pos()))
 479                 return false;
 480         Change ch = cur.paragraph().lookupChange(cur.pos());
 481
 482         CursorSlice tip1 = cur.top();
 483         for (; tip1.pit() < tip1.lastpit() || tip1.pos() < tip1.lastpos(); tip1.forwardPos()) {
 484                 Change ch2 = tip1.paragraph().lookupChange(tip1.pos());
 485                 if (!ch2.isSimilarTo(ch))
 486                         break;
 487         }
 488         CursorSlice tip2 = cur.top();
 489         for (; tip2.pit() > 0 || tip2.pos() > 0;) {
 490                 tip2.backwardPos();
 491                 Change ch2 = tip2.paragraph().lookupChange(tip2.pos());
 492                 if (!ch2.isSimilarTo(ch)) {
 493                         // take a step forward to correctly set the selection
 494                         tip2.forwardPos();
 495                         break;
 496                 }
 497         }
 498         if (forward)
 499                 swap(tip1, tip2);
 500         cur.top() = tip1;
 501         cur.bv().mouseSetCursor(cur, false);
 502         cur.top() = tip2;
 503         cur.bv().mouseSetCursor(cur, true);
 504         return true;
 505 }
 506
 507
 508 namespace {
 509
 510
 511 bool findChange(BufferView * bv, bool forward)
 512 {
 513         Cursor cur(*bv);
 514         cur.setCursor(forward ? bv->cursor().selectionEnd()
 515                       : bv->cursor().selectionBegin());
 516         forward ? findNextChange(bv, cur, true) : findPreviousChange(bv, cur, true);
 517         return selectChange(cur, forward);
 518 }
 519
 520 } // namespace
 521
 522 bool findNextChange(BufferView * bv)
 523 {
 524         return findChange(bv, true);
 525 }
 526
 527
 528 bool findPreviousChange(BufferView * bv)
 529 {
 530         return findChange(bv, false);
 531 }
 532
 533
 534
 535 namespace {
 536
 537 typedef vector<pair<string, string> > Escapes;
 538
 539 /// A map of symbols and their escaped equivalent needed within a regex.
 540 /// @note Beware of order
 541 Escapes const & get_regexp_escapes()
 542 {
 543         typedef std::pair<std::string, std::string> P;
 544
 545         static Escapes escape_map;
 546         if (escape_map.empty()) {
 547                 escape_map.push_back(P("$", "_x_$"));
 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("\\", "(?:\\\\|\\\\backslash)"));
 558                 escape_map.push_back(P("~", "(?:\\\\textasciitilde|\\\\sim)"));
 559                 escape_map.push_back(P("^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
 560                 escape_map.push_back(P("_x_", "\\"));
 561         }
 562         return escape_map;
 563 }
 564
 565 /// A map of lyx escaped strings and their unescaped equivalent.
 566 Escapes const & get_lyx_unescapes()
 567 {
 568         typedef std::pair<std::string, std::string> P;
 569
 570         static Escapes escape_map;
 571         if (escape_map.empty()) {
 572                 escape_map.push_back(P("\\%", "%"));
 573                 escape_map.push_back(P("\\mathcircumflex ", "^"));
 574                 escape_map.push_back(P("\\mathcircumflex", "^"));
 575                 escape_map.push_back(P("\\backslash ", "\\"));
 576                 escape_map.push_back(P("\\backslash", "\\"));
 577                 escape_map.push_back(P("\\\\{", "_x_<"));
 578                 escape_map.push_back(P("\\\\}", "_x_>"));
 579                 escape_map.push_back(P("\\sim ", "~"));
 580                 escape_map.push_back(P("\\sim", "~"));
 581         }
 582         return escape_map;
 583 }
 584
 585 /// A map of escapes turning a regexp matching text to one matching latex.
 586 Escapes const & get_regexp_latex_escapes()
 587 {
 588         typedef std::pair<std::string, std::string> P;
 589
 590         static Escapes escape_map;
 591         if (escape_map.empty()) {
 592                 escape_map.push_back(P("\\\\", "(?:\\\\\\\\|\\\\backslash|\\\\textbackslash\\{\\}|\\\\textbackslash)"));
 593                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash)\\{", "\\\\\\{"));
 594                 escape_map.push_back(P("(<?!\\\\\\\\textbackslash\\\\\\{)\\}", "\\\\\\}"));
 595                 escape_map.push_back(P("\\[", "\\{\\[\\}"));
 596                 escape_map.push_back(P("\\]", "\\{\\]\\}"));
 597                 escape_map.push_back(P("\\^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
 598                 escape_map.push_back(P("%", "\\\\\\%"));
 599         }
 600         return escape_map;
 601 }
 602
 603 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
 604  ** the found occurrence were escaped.
 605  **/
 606 string apply_escapes(string s, Escapes const & escape_map)
 607 {
 608         LYXERR(Debug::FIND, "Escaping: '" << s << "'");
 609         Escapes::const_iterator it;
 610         for (it = escape_map.begin(); it != escape_map.end(); ++it) {
 611 //              LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
 612                 unsigned int pos = 0;
 613                 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
 614                         s.replace(pos, it->first.length(), it->second);
 615                         LYXERR(Debug::FIND, "After escape: " << s);
 616                         pos += it->second.length();
 617 //                      LYXERR(Debug::FIND, "pos: " << pos);
 618                 }
 619         }
 620         LYXERR(Debug::FIND, "Escaped : '" << s << "'");
 621         return s;
 622 }
 623
 624
 625 /// Within \regexp{} apply get_lyx_unescapes() only (i.e., preserve regexp semantics of the string),
 626 /// while outside apply get_lyx_unescapes()+get_regexp_escapes().
 627 /// If match_latex is true, then apply regexp_latex_escapes() to \regexp{} contents as well.
 628 string escape_for_regex(string s, bool match_latex)
 629 {
 630         size_t pos = 0;
 631         while (pos < s.size()) {
 632                 size_t new_pos = s.find("\\regexp{", pos);
 633                 if (new_pos == string::npos)
 634                         new_pos = s.size();
 635                 LYXERR(Debug::FIND, "new_pos: " << new_pos);
 636                 string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
 637                 LYXERR(Debug::FIND, "t [lyx]: " << t);
 638                 t = apply_escapes(t, get_regexp_escapes());
 639                 LYXERR(Debug::FIND, "t [rxp]: " << t);
 640                 s.replace(pos, new_pos - pos, t);
 641                 new_pos = pos + t.size();
 642                 LYXERR(Debug::FIND, "Regexp after escaping: " << s);
 643                 LYXERR(Debug::FIND, "new_pos: " << new_pos);
 644                 if (new_pos == s.size())
 645                         break;
 646                 // Might fail if \\endregexp{} is preceeded by unexpected stuff (weird escapes)
 647                 size_t end_pos = s.find("\\endregexp{}}", new_pos + 8);
 648                 LYXERR(Debug::FIND, "end_pos: " << end_pos);
 649                 t = s.substr(new_pos + 8, end_pos - (new_pos + 8));
 650                 LYXERR(Debug::FIND, "t in regexp      : " << t);
 651                 t = apply_escapes(t, get_lyx_unescapes());
 652                 LYXERR(Debug::FIND, "t in regexp [lyx]: " << t);
 653                 if (match_latex) {
 654                         t = apply_escapes(t, get_regexp_latex_escapes());
 655                         LYXERR(Debug::FIND, "t in regexp [ltx]: " << t);
 656                 }
 657                 if (end_pos == s.size()) {
 658                         s.replace(new_pos, end_pos - new_pos, t);
 659                         LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
 660                         break;
 661                 }
 662                 s.replace(new_pos, end_pos + 13 - new_pos, t);
 663                 LYXERR(Debug::FIND, "Regexp after \\regexp{...\\endregexp{}} removal: " << s);
 664                 pos = new_pos + t.size();
 665                 LYXERR(Debug::FIND, "pos: " << pos);
 666         }
 667         return s;
 668 }
 669
 670
 671 /// Wrapper for lyx::regex_replace with simpler interface
 672 bool regex_replace(string const & s, string & t, string const & searchstr,
 673                    string const & replacestr)
 674 {
 675         lyx::regex e(searchstr, regex_constants::ECMAScript);
 676         ostringstream oss;
 677         ostream_iterator<char, char> it(oss);
 678         lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
 679         // tolerate t and s be references to the same variable
 680         bool rv = (s != oss.str());
 681         t = oss.str();
 682         return rv;
 683 }
 684
 685
 686 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
 687  **
 688  ** Verify that closed braces exactly match open braces. This avoids that, for example,
 689  ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
 690  **
 691  ** @param unmatched
 692  ** Number of open braces that must remain open at the end for the verification to succeed.
 693  **/
 694 bool braces_match(string::const_iterator const & beg,
 695                   string::const_iterator const & end,
 696                   int unmatched = 0)
 697 {
 698         int open_pars = 0;
 699         string::const_iterator it = beg;
 700         LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
 701         for (; it != end; ++it) {
 702                 // Skip escaped braces in the count
 703                 if (*it == '\\') {
 704                         ++it;
 705                         if (it == end)
 706                                 break;
 707                 } else if (*it == '{') {
 708                         ++open_pars;
 709                 } else if (*it == '}') {
 710                         if (open_pars == 0) {
 711                                 LYXERR(Debug::FIND, "Found unmatched closed brace");
 712                                 return false;
 713                         } else
 714                                 --open_pars;
 715                 }
 716         }
 717         if (open_pars != unmatched) {
 718                 LYXERR(Debug::FIND, "Found " << open_pars
 719                        << " instead of " << unmatched
 720                        << " unmatched open braces at the end of count");
 721                 return false;
 722         }
 723         LYXERR(Debug::FIND, "Braces match as expected");
 724         return true;
 725 }
 726
 727
 728 /** The class performing a match between a position in the document and the FindAdvOptions.
 729  **/
 730 class MatchStringAdv {
 731 public:
 732         MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
 733
 734         /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
 735          ** constructor as opt.search, under the opt.* options settings.
 736          **
 737          ** @param at_begin
 738          **     If set, then match is searched only against beginning of text starting at cur.
 739          **     If unset, then match is searched anywhere in text starting at cur.
 740          **
 741          ** @return
 742          ** The length of the matching text, or zero if no match was found.
 743          **/
 744         int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
 745
 746 public:
 747         /// buffer
 748         lyx::Buffer * p_buf;
 749         /// first buffer on which search was started
 750         lyx::Buffer * const p_first_buf;
 751         /// options
 752         FindAndReplaceOptions const & opt;
 753
 754 private:
 755         /// Auxiliary find method (does not account for opt.matchword)
 756         int findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
 757
 758         /** Normalize a stringified or latexified LyX paragraph.
 759          **
 760          ** Normalize means:
 761          ** <ul>
 762          **   <li>if search is not casesensitive, then lowercase the string;
 763          **   <li>remove any newline at begin or end of the string;
 764          **   <li>replace any newline in the middle of the string with a simple space;
 765          **   <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
 766          ** </ul>
 767          **
 768          ** @todo Normalization should also expand macros, if the corresponding
 769          ** search option was checked.
 770          **/
 771         string normalize(docstring const & s, bool hack_braces) const;
 772         // normalized string to search
 773         string par_as_string;
 774         // regular expression to use for searching
 775         lyx::regex regexp;
 776         // same as regexp, but prefixed with a ".*"
 777         lyx::regex regexp2;
 778         // leading format material as string
 779         string lead_as_string;
 780         // par_as_string after removal of lead_as_string
 781         string par_as_string_nolead;
 782         // unmatched open braces in the search string/regexp
 783         int open_braces;
 784         // number of (.*?) subexpressions added at end of search regexp for closing
 785         // environments, math mode, styles, etc...
 786         int close_wildcards;
 787         // Are we searching with regular expressions ?
 788         bool use_regexp;
 789 };
 790
 791
 792 static docstring buffer_to_latex(Buffer & buffer)
 793 {
 794         OutputParams runparams(&buffer.params().encoding());
 795         odocstringstream ods;
 796         otexstream os(ods);
 797         runparams.nice = true;
 798         runparams.flavor = OutputParams::LATEX;
 799         runparams.linelen = 80; //lyxrc.plaintext_linelen;
 800         // No side effect of file copying and image conversion
 801         runparams.dryrun = true;
 802         pit_type const endpit = buffer.paragraphs().size();
 803         for (pit_type pit = 0; pit != endpit; ++pit) {
 804                 TeXOnePar(buffer, buffer.text(), pit, os, runparams);
 805                 LYXERR(Debug::FIND, "searchString up to here: " << ods.str());
 806         }
 807         return ods.str();
 808 }
 809
 810
 811 static docstring stringifySearchBuffer(Buffer & buffer, FindAndReplaceOptions const & opt)
 812 {
 813         docstring str;
 814         if (!opt.ignoreformat) {
 815                 str = buffer_to_latex(buffer);
 816         } else {
 817                 OutputParams runparams(&buffer.params().encoding());
 818                 runparams.nice = true;
 819                 runparams.flavor = OutputParams::LATEX;
 820                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
 821                 runparams.dryrun = true;
 822                 runparams.for_search = true;
 823                 for (pos_type pit = pos_type(0); pit < (pos_type)buffer.paragraphs().size(); ++pit) {
 824                         Paragraph const & par = buffer.paragraphs().at(pit);
 825                         LYXERR(Debug::FIND, "Adding to search string: '"
 826                                << par.asString(pos_type(0), par.size(),
 827                                                AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
 828                                                &runparams)
 829                                << "'");
 830                         str += par.asString(pos_type(0), par.size(),
 831                                             AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
 832                                             &runparams);
 833                 }
 834         }
 835         return str;
 836 }
 837
 838
 839 /// Return separation pos between the leading material and the rest
 840 static size_t identifyLeading(string const & s)
 841 {
 842         string t = s;
 843         // @TODO Support \item[text]
 844         while (regex_replace(t, t, REGEX_BOS "\\\\(emph|textbf|subsubsection|subsection|section|subparagraph|paragraph|part)\\*?\\{", "")
 845                || regex_replace(t, t, REGEX_BOS "\\$", "")
 846                || regex_replace(t, t, REGEX_BOS "\\\\\\[ ", "")
 847                || regex_replace(t, t, REGEX_BOS "\\\\item ", "")
 848                || regex_replace(t, t, REGEX_BOS "\\\\begin\\{[a-zA-Z_]*\\*?\\} ", ""))
 849                 LYXERR(Debug::FIND, "  after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
 850         return s.find(t);
 851 }
 852
 853
 854 // Remove trailing closure of math, macros and environments, so to catch parts of them.
 855 static int identifyClosing(string & t)
 856 {
 857         int open_braces = 0;
 858         do {
 859                 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
 860                 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
 861                         continue;
 862                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
 863                         continue;
 864                 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
 865                         continue;
 866                 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
 867                         ++open_braces;
 868                         continue;
 869                 }
 870                 break;
 871         } while (true);
 872         return open_braces;
 873 }
 874
 875
 876 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
 877         : p_buf(&buf), p_first_buf(&buf), opt(opt)
 878 {
 879         Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
 880         docstring const & ds = stringifySearchBuffer(find_buf, opt);
 881         use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
 882         // When using regexp, braces are hacked already by escape_for_regex()
 883         par_as_string = normalize(ds, !use_regexp);
 884         open_braces = 0;
 885         close_wildcards = 0;
 886
 887         size_t lead_size = 0;
 888         if (opt.ignoreformat) {
 889                 if (!use_regexp) {
 890                         // if par_as_string_nolead were emty,
 891                         // the following call to findAux will always *find* the string
 892                         // in the checked data, and thus always using the slow
 893                         // examining of the current text part.
 894                         par_as_string_nolead = par_as_string;
 895                 }
 896         } else {
 897                 lead_size = identifyLeading(par_as_string);
 898                 lead_as_string = par_as_string.substr(0, lead_size);
 899                 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
 900         }
 901
 902         if (!use_regexp) {
 903                 open_braces = identifyClosing(par_as_string);
 904                 identifyClosing(par_as_string_nolead);
 905                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
 906                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
 907         } else {
 908                 string lead_as_regexp;
 909                 if (lead_size > 0) {
 910                         // @todo No need to search for \regexp{} insets in leading material
 911                         lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
 912                         par_as_string = par_as_string_nolead;
 913                         LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
 914                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
 915                 }
 916                 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
 917                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
 918                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
 919                 if (
 920                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
 921                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
 922                         // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
 923                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
 924                         // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
 925                         || regex_replace(par_as_string, par_as_string,
 926                                          "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
 927                         // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
 928                         || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
 929                         ) {
 930                         ++close_wildcards;
 931                 }
 932                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
 933                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
 934                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
 935                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
 936
 937                 // If entered regexp must match at begin of searched string buffer
 938                 string regexp_str = lead_as_regexp + par_as_string;
 939                 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
 940                 regexp = lyx::regex(regexp_str);
 941
 942                 // If entered regexp may match wherever in searched string buffer
 943                 string regexp2_str = lead_as_regexp + ".*" + par_as_string;
 944                 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
 945                 regexp2 = lyx::regex(regexp2_str);
 946         }
 947 }
 948
 949
 950 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
 951 {
 952         if (at_begin &&
 953                 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
 954                 return 0;
 955
 956         docstring docstr = stringifyFromForSearch(opt, cur, len);
 957         string str = normalize(docstr, true);
 958         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
 959         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
 960
 961         if (use_regexp) {
 962                 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
 963                 regex const *p_regexp;
 964                 regex_constants::match_flag_type flags;
 965                 if (at_begin) {
 966                         flags = regex_constants::match_continuous;
 967                         p_regexp = &regexp;
 968                 } else {
 969                         flags = regex_constants::match_default;
 970                         p_regexp = &regexp2;
 971                 }
 972                 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
 973                 if (re_it == sregex_iterator())
 974                         return 0;
 975                 match_results<string::const_iterator> const & m = *re_it;
 976
 977                 // Check braces on the segment that matched the entire regexp expression,
 978                 // plus the last subexpression, if a (.*?) was inserted in the constructor.
 979                 if (!braces_match(m[0].first, m[0].second, open_braces))
 980                         return 0;
 981
 982                 // Check braces on segments that matched all (.*?) subexpressions,
 983                 // except the last "padding" one inserted by lyx.
 984                 for (size_t i = 1; i < m.size() - 1; ++i)
 985                         if (!braces_match(m[i].first, m[i].second))
 986                                 return false;
 987
 988                 // Exclude from the returned match length any length
 989                 // due to close wildcards added at end of regexp
 990                 if (close_wildcards == 0)
 991                         return m[0].second - m[0].first;
 992
 993                 return m[m.size() - close_wildcards].first - m[0].first;
 994         }
 995
 996         // else !use_regexp: but all code paths above return
 997         LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
 998                                  << par_as_string << "', str='" << str << "'");
 999         LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
1000                                  << lead_as_string << "', par_as_string_nolead='"
1001                                  << par_as_string_nolead << "'");
1002
1003         if (at_begin) {
1004                 LYXERR(Debug::FIND, "size=" << par_as_string.size()
1005                                          << ", substr='" << str.substr(0, par_as_string.size()) << "'");
1006                 if (str.substr(0, par_as_string.size()) == par_as_string)
1007                         return par_as_string.size();
1008         } else {
1009                 size_t pos = str.find(par_as_string_nolead);
1010                 if (pos != string::npos)
1011                         return par_as_string.size();
1012         }
1013         return 0;
1014 }
1015
1016
1017 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
1018 {
1019         int res = findAux(cur, len, at_begin);
1020         LYXERR(Debug::FIND,
1021                "res=" << res << ", at_begin=" << at_begin
1022                << ", matchword=" << opt.matchword
1023                << ", inTexted=" << cur.inTexted());
1024         if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
1025                 return res;
1026         Paragraph const & par = cur.paragraph();
1027         bool ws_left = (cur.pos() > 0)
1028                 ? par.isWordSeparator(cur.pos() - 1)
1029                 : true;
1030         bool ws_right = (cur.pos() + res < par.size())
1031                 ? par.isWordSeparator(cur.pos() + res)
1032                 : true;
1033         LYXERR(Debug::FIND,
1034                "cur.pos()=" << cur.pos() << ", res=" << res
1035                << ", separ: " << ws_left << ", " << ws_right
1036                << endl);
1037         if (ws_left && ws_right)
1038                 return res;
1039         return 0;
1040 }
1041
1042
1043 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
1044 {
1045         string t;
1046         if (! opt.casesensitive)
1047                 t = lyx::to_utf8(lowercase(s));
1048         else
1049                 t = lyx::to_utf8(s);
1050         // Remove \n at begin
1051         while (!t.empty() && t[0] == '\n')
1052                 t = t.substr(1);
1053         // Remove \n at end
1054         while (!t.empty() && t[t.size() - 1] == '\n')
1055                 t = t.substr(0, t.size() - 1);
1056         size_t pos;
1057         // Replace all other \n with spaces
1058         while ((pos = t.find("\n")) != string::npos)
1059                 t.replace(pos, 1, " ");
1060         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
1061         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
1062         while (regex_replace(t, t, "\\\\(emph|textbf|subsubsection|subsection|section|subparagraph|paragraph|part)(\\{\\})+", ""))
1063                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
1064
1065         // FIXME - check what preceeds the brace
1066         if (hack_braces) {
1067                 if (opt.ignoreformat)
1068                         while (regex_replace(t, t, "\\{", "_x_<")
1069                                || regex_replace(t, t, "\\}", "_x_>"))
1070                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
1071                 else
1072                         while (regex_replace(t, t, "\\\\\\{", "_x_<")
1073                                || regex_replace(t, t, "\\\\\\}", "_x_>"))
1074                                 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
1075         }
1076
1077         return t;
1078 }
1079
1080
1081 docstring stringifyFromCursor(DocIterator const & cur, int len)
1082 {
1083         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
1084         if (cur.inTexted()) {
1085                 Paragraph const & par = cur.paragraph();
1086                 // TODO what about searching beyond/across paragraph breaks ?
1087                 // TODO Try adding a AS_STR_INSERTS as last arg
1088                 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
1089                         int(par.size()) : cur.pos() + len;
1090                 OutputParams runparams(&cur.buffer()->params().encoding());
1091                 runparams.nice = true;
1092                 runparams.flavor = OutputParams::LATEX;
1093                 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
1094                 // No side effect of file copying and image conversion
1095                 runparams.dryrun = true;
1096                 LYXERR(Debug::FIND, "Stringifying with cur: "
1097                        << cur << ", from pos: " << cur.pos() << ", end: " << end);
1098                 return par.asString(cur.pos(), end,
1099                         AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
1100                         &runparams);
1101         } else if (cur.inMathed()) {
1102                 CursorSlice cs = cur.top();
1103                 MathData md = cs.cell();
1104                 MathData::const_iterator it_end =
1105                         (( len == -1 || cs.pos() + len > int(md.size()))
1106                          ? md.end()
1107                          : md.begin() + cs.pos() + len );
1108                 MathData md2;
1109                 for (MathData::const_iterator it = md.begin() + cs.pos();
1110                      it != it_end; ++it)
1111                         md2.push_back(*it);
1112                 docstring s = asString(md2);
1113                 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
1114                 return s;
1115         }
1116         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
1117         return docstring();
1118 }
1119
1120
1121 /** Computes the LaTeX export of buf starting from cur and ending len positions
1122  * after cur, if len is positive, or at the paragraph or innermost inset end
1123  * if len is -1.
1124  */
1125 docstring latexifyFromCursor(DocIterator const & cur, int len)
1126 {
1127         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
1128         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
1129                << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
1130         Buffer const & buf = *cur.buffer();
1131
1132         odocstringstream ods;
1133         otexstream os(ods);
1134         OutputParams runparams(&buf.params().encoding());
1135         runparams.nice = false;
1136         runparams.flavor = OutputParams::LATEX;
1137         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
1138         // No side effect of file copying and image conversion
1139         runparams.dryrun = true;
1140
1141         if (cur.inTexted()) {
1142                 // @TODO what about searching beyond/across paragraph breaks ?
1143                 pos_type endpos = cur.paragraph().size();
1144                 if (len != -1 && endpos > cur.pos() + len)
1145                         endpos = cur.pos() + len;
1146                 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
1147                           string(), cur.pos(), endpos);
1148                 LYXERR(Debug::FIND, "Latexified text: '" << lyx::to_utf8(ods.str()) << "'");
1149         } else if (cur.inMathed()) {
1150                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
1151                 for (int s = cur.depth() - 1; s >= 0; --s) {
1152                         CursorSlice const & cs = cur[s];
1153                         if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
1154                                 WriteStream ws(os);
1155                                 cs.asInsetMath()->asHullInset()->header_write(ws);
1156                                 break;
1157                         }
1158                 }
1159
1160                 CursorSlice const & cs = cur.top();
1161                 MathData md = cs.cell();
1162                 MathData::const_iterator it_end =
1163                         ((len == -1 || cs.pos() + len > int(md.size()))
1164                          ? md.end()
1165                          : md.begin() + cs.pos() + len);
1166                 MathData md2;
1167                 for (MathData::const_iterator it = md.begin() + cs.pos();
1168                      it != it_end; ++it)
1169                         md2.push_back(*it);
1170                 ods << asString(md2);
1171
1172                 // Retrieve the math environment type, and add '$' or '$]'
1173                 // or others (\end{equation}) accordingly
1174                 for (int s = cur.depth() - 1; s >= 0; --s) {
1175                         CursorSlice const & cs = cur[s];
1176                         InsetMath * inset = cs.asInsetMath();
1177                         if (inset && inset->asHullInset()) {
1178                                 WriteStream ws(os);
1179                                 inset->asHullInset()->footer_write(ws);
1180                                 break;
1181                         }
1182                 }
1183                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
1184         } else {
1185                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
1186         }
1187         return ods.str();
1188 }
1189
1190
1191 /** Finalize an advanced find operation, advancing the cursor to the innermost
1192  ** position that matches, plus computing the length of the matching text to
1193  ** be selected
1194  **/
1195 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
1196 {
1197         // Search the foremost position that matches (avoids find of entire math
1198         // inset when match at start of it)
1199         size_t d;
1200         DocIterator old_cur(cur.buffer());
1201         do {
1202                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
1203                 d = cur.depth();
1204                 old_cur = cur;
1205                 cur.forwardPos();
1206         } while (cur && cur.depth() > d && match(cur) > 0);
1207         cur = old_cur;
1208         LASSERT(match(cur) > 0, return 0);
1209         LYXERR(Debug::FIND, "Ok");
1210
1211         // Compute the match length
1212         int len = 1;
1213         if (cur.pos() + len > cur.lastpos())
1214                 return 0;
1215         LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
1216         while (cur.pos() + len <= cur.lastpos() && match(cur, len) == 0) {
1217                 ++len;
1218                 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
1219         }
1220         // Length of matched text (different from len param)
1221         int old_len = match(cur, len);
1222         int new_len;
1223         // Greedy behaviour while matching regexps
1224         while ((new_len = match(cur, len + 1)) > old_len) {
1225                 ++len;
1226                 old_len = new_len;
1227                 LYXERR(Debug::FIND, "verifying   match with len = " << len);
1228         }
1229         return len;
1230 }
1231
1232
1233 /// Finds forward
1234 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
1235 {
1236         if (!cur)
1237                 return 0;
1238         while (!theApp()->longOperationCancelled() && cur) {
1239                 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
1240                 int match_len = match(cur, -1, false);
1241                 LYXERR(Debug::FIND, "match_len: " << match_len);
1242                 if (match_len) {
1243                         for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
1244                                 LYXERR(Debug::FIND, "Advancing cur: " << cur);
1245                                 int match_len = match(cur);
1246                                 LYXERR(Debug::FIND, "match_len: " << match_len);
1247                                 if (match_len) {
1248                                         // Sometimes in finalize we understand it wasn't a match
1249                                         // and we need to continue the outest loop
1250                                         int len = findAdvFinalize(cur, match);
1251                                         if (len > 0)
1252                                                 return len;
1253                                 }
1254                         }
1255                         if (!cur)
1256                                 return 0;
1257                 }
1258                 if (cur.pit() < cur.lastpit()) {
1259                         LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
1260                         cur.forwardPar();
1261                 } else {
1262                         // This should exit nested insets, if any, or otherwise undefine the currsor.
1263                         cur.pos() = cur.lastpos();
1264                         LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
1265                         cur.forwardPos();
1266                 }
1267         }
1268         return 0;
1269 }
1270
1271
1272 /// Find the most backward consecutive match within same paragraph while searching backwards.
1273 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
1274 {
1275         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
1276         DocIterator tmp_cur = cur;
1277         int len = findAdvFinalize(tmp_cur, match);
1278         Inset & inset = cur.inset();
1279         for (; cur != cur_begin; cur.backwardPos()) {
1280                 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
1281                 DocIterator new_cur = cur;
1282                 new_cur.backwardPos();
1283                 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
1284                         break;
1285                 int new_len = findAdvFinalize(new_cur, match);
1286                 if (new_len == len)
1287                         break;
1288                 len = new_len;
1289         }
1290         LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
1291         return len;
1292 }
1293
1294
1295 /// Finds backwards
1296 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
1297 {
1298         if (! cur)
1299                 return 0;
1300         // Backup of original position
1301         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
1302         if (cur == cur_begin)
1303                 return 0;
1304         cur.backwardPos();
1305         DocIterator cur_orig(cur);
1306         bool pit_changed = false;
1307         do {
1308                 cur.pos() = 0;
1309                 bool found_match = match(cur, -1, false);
1310
1311                 if (found_match) {
1312                         if (pit_changed)
1313                                 cur.pos() = cur.lastpos();
1314                         else
1315                                 cur.pos() = cur_orig.pos();
1316                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
1317                         DocIterator cur_prev_iter;
1318                         do {
1319                                 found_match = match(cur);
1320                                 LYXERR(Debug::FIND, "findBackAdv3: found_match="
1321                                        << found_match << ", cur: " << cur);
1322                                 if (found_match)
1323                                         return findMostBackwards(cur, match);
1324
1325                                 // Stop if begin of document reached
1326                                 if (cur == cur_begin)
1327                                         break;
1328                                 cur_prev_iter = cur;
1329                                 cur.backwardPos();
1330                         } while (true);
1331                 }
1332                 if (cur == cur_begin)
1333                         break;
1334                 if (cur.pit() > 0)
1335                         --cur.pit();
1336                 else
1337                         cur.backwardPos();
1338                 pit_changed = true;
1339         } while (!theApp()->longOperationCancelled());
1340         return 0;
1341 }
1342
1343
1344 } // namespace
1345
1346
1347 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
1348                                  DocIterator const & cur, int len)
1349 {
1350         LASSERT(cur.pos() >= 0 && cur.pos() <= cur.lastpos(),
1351                 return docstring());
1352         if (!opt.ignoreformat)
1353                 return latexifyFromCursor(cur, len);
1354         else
1355                 return stringifyFromCursor(cur, len);
1356 }
1357
1358
1359 FindAndReplaceOptions::FindAndReplaceOptions(
1360         docstring const & find_buf_name, bool casesensitive,
1361         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
1362         docstring const & repl_buf_name, bool keep_case,
1363         SearchScope scope, SearchRestriction restr)
1364         : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
1365           forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
1366           repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
1367 {
1368 }
1369
1370
1371 namespace {
1372
1373
1374 /** Check if 'len' letters following cursor are all non-lowercase */
1375 static bool allNonLowercase(Cursor const & cur, int len)
1376 {
1377         pos_type beg_pos = cur.selectionBegin().pos();
1378         pos_type end_pos = cur.selectionBegin().pos() + len;
1379         if (len > cur.lastpos() + 1 - beg_pos) {
1380                 LYXERR(Debug::FIND, "This should not happen, more debug needed");
1381                 len = cur.lastpos() + 1 - beg_pos;
1382                 end_pos = beg_pos + len;
1383         }
1384         for (pos_type pos = beg_pos; pos != end_pos; ++pos)
1385                 if (isLowerCase(cur.paragraph().getChar(pos)))
1386                         return false;
1387         return true;
1388 }
1389
1390
1391 /** Check if first letter is upper case and second one is lower case */
1392 static bool firstUppercase(Cursor const & cur)
1393 {
1394         char_type ch1, ch2;
1395         pos_type pos = cur.selectionBegin().pos();
1396         if (pos >= cur.lastpos() - 1) {
1397                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
1398                 return false;
1399         }
1400         ch1 = cur.paragraph().getChar(pos);
1401         ch2 = cur.paragraph().getChar(pos + 1);
1402         bool result = isUpperCase(ch1) && isLowerCase(ch2);
1403         LYXERR(Debug::FIND, "firstUppercase(): "
1404                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
1405                << ch2 << "(" << char(ch2) << ")"
1406                << ", result=" << result << ", cur=" << cur);
1407         return result;
1408 }
1409
1410
1411 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
1412  **
1413  ** \fixme What to do with possible further paragraphs in replace buffer ?
1414  **/
1415 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
1416 {
1417         ParagraphList::iterator pit = buffer.paragraphs().begin();
1418         LASSERT(pit->size() >= 1, /**/);
1419         pos_type right = pos_type(1);
1420         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
1421         right = pit->size();
1422         pit->changeCase(buffer.params(), pos_type(1), right, others_case);
1423 }
1424
1425 } // namespace
1426
1427 ///
1428 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
1429 {
1430         Cursor & cur = bv->cursor();
1431         if (opt.repl_buf_name == docstring()
1432             || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
1433             || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
1434                 return;
1435
1436         DocIterator sel_beg = cur.selectionBegin();
1437         DocIterator sel_end = cur.selectionEnd();
1438         if (&sel_beg.inset() != &sel_end.inset()
1439             || sel_beg.pit() != sel_end.pit()
1440             || sel_beg.idx() != sel_end.idx())
1441                 return;
1442         int sel_len = sel_end.pos() - sel_beg.pos();
1443         LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
1444                << ", sel_len: " << sel_len << endl);
1445         if (sel_len == 0)
1446                 return;
1447         LASSERT(sel_len > 0, return);
1448
1449         if (!matchAdv(sel_beg, sel_len))
1450                 return;
1451
1452         // Build a copy of the replace buffer, adapted to the KeepCase option
1453         Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
1454         ostringstream oss;
1455         repl_buffer_orig.write(oss);
1456         string lyx = oss.str();
1457         Buffer repl_buffer("", false);
1458         repl_buffer.setInternal(true);
1459         repl_buffer.setUnnamed(true);
1460         LASSERT(repl_buffer.readString(lyx), return);
1461         if (opt.keep_case && sel_len >= 2) {
1462                 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
1463                 if (cur.inTexted()) {
1464                         if (firstUppercase(cur))
1465                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
1466                         else if (allNonLowercase(cur, sel_len))
1467                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
1468                 }
1469         }
1470         cap::cutSelection(cur, false);
1471         if (cur.inTexted()) {
1472                 repl_buffer.changeLanguage(
1473                         repl_buffer.language(),
1474                         cur.getFont().language());
1475                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
1476                 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
1477                 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
1478                                         repl_buffer.params().documentClassPtr(),
1479                                         bv->buffer().errorList("Paste"));
1480                 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
1481                 sel_len = repl_buffer.paragraphs().begin()->size();
1482         } else if (cur.inMathed()) {
1483                 odocstringstream ods;
1484                 otexstream os(ods);
1485                 OutputParams runparams(&repl_buffer.params().encoding());
1486                 runparams.nice = false;
1487                 runparams.flavor = OutputParams::LATEX;
1488                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
1489                 runparams.dryrun = true;
1490                 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
1491                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
1492                 docstring repl_latex = ods.str();
1493                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
1494                 string s;
1495                 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
1496                 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
1497                 repl_latex = from_utf8(s);
1498                 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
1499                 MathData ar(cur.buffer());
1500                 asArray(repl_latex, ar, Parse::NORMAL);
1501                 cur.insert(ar);
1502                 sel_len = ar.size();
1503                 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
1504         }
1505         if (cur.pos() >= sel_len)
1506                 cur.pos() -= sel_len;
1507         else
1508                 cur.pos() = 0;
1509         LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
1510         bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
1511         bv->processUpdateFlags(Update::Force);
1512 }
1513
1514
1515 /// Perform a FindAdv operation.
1516 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
1517 {
1518         DocIterator cur;
1519         int match_len = 0;
1520
1521         // e.g., when invoking word-findadv from mini-buffer wither with
1522         //       wrong options syntax or before ever opening advanced F&R pane
1523         if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
1524                 return false;
1525
1526         try {
1527                 MatchStringAdv matchAdv(bv->buffer(), opt);
1528                 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
1529                 if (length > 0)
1530                         bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
1531                 findAdvReplace(bv, opt, matchAdv);
1532                 cur = bv->cursor();
1533                 if (opt.forward)
1534                         match_len = findForwardAdv(cur, matchAdv);
1535                 else
1536                         match_len = findBackwardsAdv(cur, matchAdv);
1537         } catch (...) {
1538                 // This may only be raised by lyx::regex()
1539                 bv->message(_("Invalid regular expression!"));
1540                 return false;
1541         }
1542
1543         if (match_len == 0) {
1544                 bv->message(_("Match not found!"));
1545                 return false;
1546         }
1547
1548         bv->message(_("Match found!"));
1549
1550         LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
1551         bv->putSelectionAt(cur, match_len, !opt.forward);
1552
1553         return true;
1554 }
1555
1556
1557 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
1558 {
1559         os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
1560            << opt.casesensitive << ' '
1561            << opt.matchword << ' '
1562            << opt.forward << ' '
1563            << opt.expandmacros << ' '
1564            << opt.ignoreformat << ' '
1565            << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
1566            << opt.keep_case << ' '
1567            << int(opt.scope) << ' '
1568            << int(opt.restr);
1569
1570         LYXERR(Debug::FIND, "built: " << os.str());
1571
1572         return os;
1573 }
1574
1575
1576 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
1577 {
1578         LYXERR(Debug::FIND, "parsing");
1579         string s;
1580         string line;
1581         getline(is, line);
1582         while (line != "EOSS") {
1583                 if (! s.empty())
1584                         s = s + "\n";
1585                 s = s + line;
1586                 if (is.eof())   // Tolerate malformed request
1587                         break;
1588                 getline(is, line);
1589         }
1590         LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
1591         opt.find_buf_name = from_utf8(s);
1592         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
1593         is.get();       // Waste space before replace string
1594         s = "";
1595         getline(is, line);
1596         while (line != "EOSS") {
1597                 if (! s.empty())
1598                         s = s + "\n";
1599                 s = s + line;
1600                 if (is.eof())   // Tolerate malformed request
1601                         break;
1602                 getline(is, line);
1603         }
1604         LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
1605         opt.repl_buf_name = from_utf8(s);
1606         is >> opt.keep_case;
1607         int i;
1608         is >> i;
1609         opt.scope = FindAndReplaceOptions::SearchScope(i);
1610         is >> i;
1611         opt.restr = FindAndReplaceOptions::SearchRestriction(i);
1612
1613         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
1614                << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
1615                << opt.scope << ' ' << opt.restr);
1616         return is;
1617 }
1618
1619 } // namespace lyx