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