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 "BufferParams.h"
  22 #include "BufferView.h"
  23 #include "Changes.h"
  24 #include "Cursor.h"
  25 #include "CutAndPaste.h"
  26 #include "FuncRequest.h"
  27 #include "OutputParams.h"
  28 #include "output_latex.h"
  29 #include "Paragraph.h"
  30 #include "ParIterator.h"
  31 #include "TexRow.h"
  32 #include "Text.h"
  33 #include "FuncRequest.h"
  34 #include "LyXFunc.h"
  35
  36 #include "mathed/InsetMath.h"
  37 #include "mathed/InsetMathGrid.h"
  38 #include "mathed/InsetMathHull.h"
  39 #include "mathed/MathStream.h"
  40
  41 #include "frontends/alert.h"
  42
  43 #include "support/convert.h"
  44 #include "support/debug.h"
  45 #include "support/docstream.h"
  46 #include "support/gettext.h"
  47 #include "support/lstrings.h"
  48 #include "support/lassert.h"
  49
  50 #include <boost/regex.hpp>
  51 #include <boost/next_prior.hpp>
  52
  53 using namespace std;
  54 using namespace lyx::support;
  55
  56 namespace lyx {
  57
  58 namespace {
  59
  60 bool parse_bool(docstring & howto)
  61 {
  62         if (howto.empty())
  63                 return false;
  64         docstring var;
  65         howto = split(howto, var, ' ');
  66         return var == "1";
  67 }
  68
  69
  70 class MatchString : public binary_function<Paragraph, pos_type, bool>
  71 {
  72 public:
  73         MatchString(docstring const & str, bool cs, bool mw)
  74                 : str(str), cs(cs), mw(mw)
  75         {}
  76
  77         // returns true if the specified string is at the specified position
  78         // del specifies whether deleted strings in ct mode will be considered
  79         bool operator()(Paragraph const & par, pos_type pos, bool del = true) const
  80         {
  81                 return par.find(str, cs, mw, pos, del);
  82         }
  83
  84 private:
  85         // search string
  86         docstring str;
  87         // case sensitive
  88         bool cs;
  89         // match whole words only
  90         bool mw;
  91 };
  92
  93
  94 bool findForward(DocIterator & cur, MatchString const & match,
  95                  bool find_del = true)
  96 {
  97         for (; cur; cur.forwardChar())
  98                 if (cur.inTexted() &&
  99                     match(cur.paragraph(), cur.pos(), find_del))
 100                         return true;
 101         return false;
 102 }
 103
 104
 105 bool findBackwards(DocIterator & cur, MatchString const & match,
 106                  bool find_del = true)
 107 {
 108         while (cur) {
 109                 cur.backwardChar();
 110                 if (cur.inTexted() &&
 111                     match(cur.paragraph(), cur.pos(), find_del))
 112                         return true;
 113         }
 114         return false;
 115 }
 116
 117
 118 bool findChange(DocIterator & cur, bool next)
 119 {
 120         if (!next)
 121                 cur.backwardPos();
 122         for (; cur; next ? cur.forwardPos() : cur.backwardPos())
 123                 if (cur.inTexted() && !cur.paragraph().isUnchanged(cur.pos())) {
 124                         if (!next)
 125                                 // if we search backwards, take a step forward
 126                                 // to correctly set the anchor
 127                                 cur.forwardPos();
 128                         return true;
 129                 }
 130
 131         return false;
 132 }
 133
 134
 135 bool searchAllowed(BufferView * /*bv*/, docstring const & str)
 136 {
 137         if (str.empty()) {
 138                 frontend::Alert::error(_("Search error"), _("Search string is empty"));
 139                 return false;
 140         }
 141         return true;
 142 }
 143
 144
 145 bool find(BufferView * bv, docstring const & searchstr,
 146         bool cs, bool mw, bool fw, bool find_del = true)
 147 {
 148         if (!searchAllowed(bv, searchstr))
 149                 return false;
 150
 151         DocIterator cur = bv->cursor();
 152
 153         MatchString const match(searchstr, cs, mw);
 154
 155         bool found = fw ? findForward(cur, match, find_del) :
 156                           findBackwards(cur, match, find_del);
 157
 158         if (found)
 159                 bv->putSelectionAt(cur, searchstr.length(), !fw);
 160
 161         return found;
 162 }
 163
 164
 165 int replaceAll(BufferView * bv,
 166                docstring const & searchstr, docstring const & replacestr,
 167                bool cs, bool mw)
 168 {
 169         Buffer & buf = bv->buffer();
 170
 171         if (!searchAllowed(bv, searchstr) || buf.isReadonly())
 172                 return 0;
 173
 174         MatchString const match(searchstr, cs, mw);
 175         int num = 0;
 176
 177         int const rsize = replacestr.size();
 178         int const ssize = searchstr.size();
 179
 180         Cursor cur(*bv);
 181         cur.setCursor(doc_iterator_begin(&buf));
 182         while (findForward(cur, match, false)) {
 183                 // Backup current cursor position and font.
 184                 pos_type const pos = cur.pos();
 185                 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
 186                 cur.recordUndo();
 187                 int striked = ssize - cur.paragraph().eraseChars(pos, pos + ssize,
 188                                                             buf.params().trackChanges);
 189                 cur.paragraph().insert(pos, replacestr, font,
 190                                        Change(buf.params().trackChanges ?
 191                                               Change::INSERTED : Change::UNCHANGED));
 192                 for (int i = 0; i < rsize + striked; ++i)
 193                         cur.forwardChar();
 194                 ++num;
 195         }
 196
 197         buf.updateLabels();
 198         bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
 199         if (num)
 200                 buf.markDirty();
 201         return num;
 202 }
 203
 204
 205 bool stringSelected(BufferView * bv, docstring const & searchstr,
 206                     bool cs, bool mw, bool fw)
 207 {
 208         // if nothing selected or selection does not equal search
 209         // string search and select next occurance and return
 210         docstring const & str1 = searchstr;
 211         docstring const str2 = bv->cursor().selectionAsString(false);
 212         if ((cs && str1 != str2) || compare_no_case(str1, str2) != 0) {
 213                 find(bv, searchstr, cs, mw, fw);
 214                 return false;
 215         }
 216
 217         return true;
 218 }
 219
 220
 221 int replace(BufferView * bv, docstring const & searchstr,
 222             docstring const & replacestr, bool cs, bool mw, bool fw)
 223 {
 224         if (!searchAllowed(bv, searchstr) || bv->buffer().isReadonly())
 225                 return 0;
 226
 227         if (!stringSelected(bv, searchstr, cs, mw, fw))
 228                 return 0;
 229
 230         Cursor & cur = bv->cursor();
 231         cap::replaceSelectionWithString(cur, replacestr, fw);
 232         bv->buffer().markDirty();
 233         find(bv, searchstr, cs, mw, fw, false);
 234         bv->buffer().updateMacros();
 235         bv->processUpdateFlags(Update::Force | Update::FitCursor);
 236
 237         return 1;
 238 }
 239
 240 } // namespace anon
 241
 242
 243 docstring const find2string(docstring const & search,
 244                          bool casesensitive, bool matchword, bool forward)
 245 {
 246         odocstringstream ss;
 247         ss << search << '\n'
 248            << int(casesensitive) << ' '
 249            << int(matchword) << ' '
 250            << int(forward);
 251         return ss.str();
 252 }
 253
 254
 255 docstring const replace2string(docstring const & search, docstring const & replace,
 256                             bool casesensitive, bool matchword,
 257                             bool all, bool forward)
 258 {
 259         odocstringstream ss;
 260         ss << search << '\n'
 261            << replace << '\n'
 262            << int(casesensitive) << ' '
 263            << int(matchword) << ' '
 264            << int(all) << ' '
 265            << int(forward);
 266         return ss.str();
 267 }
 268
 269
 270 bool find(BufferView * bv, FuncRequest const & ev)
 271 {
 272         if (!bv || ev.action != LFUN_WORD_FIND)
 273                 return false;
 274
 275         //lyxerr << "find called, cmd: " << ev << endl;
 276
 277         // data is of the form
 278         // "<search>
 279         //  <casesensitive> <matchword> <forward>"
 280         docstring search;
 281         docstring howto = split(ev.argument(), search, '\n');
 282
 283         bool casesensitive = parse_bool(howto);
 284         bool matchword     = parse_bool(howto);
 285         bool forward       = parse_bool(howto);
 286
 287         return find(bv, search, casesensitive, matchword, forward);
 288 }
 289
 290
 291 void replace(BufferView * bv, FuncRequest const & ev, bool has_deleted)
 292 {
 293         if (!bv || ev.action != LFUN_WORD_REPLACE)
 294                 return;
 295
 296         // data is of the form
 297         // "<search>
 298         //  <replace>
 299         //  <casesensitive> <matchword> <all> <forward>"
 300         docstring search;
 301         docstring rplc;
 302         docstring howto = split(ev.argument(), search, '\n');
 303         howto = split(howto, rplc, '\n');
 304
 305         bool casesensitive = parse_bool(howto);
 306         bool matchword     = parse_bool(howto);
 307         bool all           = parse_bool(howto);
 308         bool forward       = parse_bool(howto);
 309
 310         if (!has_deleted) {
 311                 int const replace_count = all
 312                         ? replaceAll(bv, search, rplc, casesensitive, matchword)
 313                         : replace(bv, search, rplc, casesensitive, matchword, forward);
 314
 315                 Buffer & buf = bv->buffer();
 316                 if (replace_count == 0) {
 317                         // emit message signal.
 318                         buf.message(_("String not found!"));
 319                 } else {
 320                         if (replace_count == 1) {
 321                                 // emit message signal.
 322                                 buf.message(_("String has been replaced."));
 323                         } else {
 324                                 docstring str = convert<docstring>(replace_count);
 325                                 str += _(" strings have been replaced.");
 326                                 // emit message signal.
 327                                 buf.message(str);
 328                         }
 329                 }
 330         } else {
 331                 // if we have deleted characters, we do not replace at all, but
 332                 // rather search for the next occurence
 333                 if (find(bv, search, casesensitive, matchword, forward))
 334                         bv->showCursor();
 335                 else
 336                         bv->message(_("String not found!"));
 337         }
 338 }
 339
 340
 341 bool findNextChange(BufferView * bv)
 342 {
 343         return findChange(bv, true);
 344 }
 345
 346
 347 bool findPreviousChange(BufferView * bv)
 348 {
 349         return findChange(bv, false);
 350 }
 351
 352
 353 bool findChange(BufferView * bv, bool next)
 354 {
 355         if (bv->cursor().selection()) {
 356                 // set the cursor at the beginning or at the end of the selection
 357                 // before searching. Otherwise, the current change will be found.
 358                 if (next != bv->cursor().top() > bv->cursor().anchor())
 359                         bv->cursor().setCursorToAnchor();
 360         }
 361
 362         DocIterator cur = bv->cursor();
 363
 364         // Are we within a change ? Then first search forward (backward),
 365         // clear the selection and search the other way around (see the end
 366         // of this function). This will avoid changes to be selected half.
 367         bool search_both_sides = false;
 368         if (cur.pos() > 1) {
 369                 Change change_next_pos
 370                         = cur.paragraph().lookupChange(cur.pos());
 371                 Change change_prev_pos
 372                         = cur.paragraph().lookupChange(cur.pos() - 1);
 373                 if (change_next_pos.isSimilarTo(change_prev_pos))
 374                         search_both_sides = true;
 375         }
 376
 377         if (!findChange(cur, next))
 378                 return false;
 379
 380         bv->cursor().setCursor(cur);
 381         bv->cursor().resetAnchor();
 382
 383         if (!next)
 384                 // take a step into the change
 385                 cur.backwardPos();
 386
 387         Change orig_change = cur.paragraph().lookupChange(cur.pos());
 388
 389         CursorSlice & tip = cur.top();
 390         if (next) {
 391                 for (; !tip.at_end(); tip.forwardPos()) {
 392                         Change change = tip.paragraph().lookupChange(tip.pos());
 393                         if (change != orig_change)
 394                                 break;
 395                 }
 396         } else {
 397                 for (; !tip.at_begin(); tip.backwardPos()) {
 398                         Change change = tip.paragraph().lookupChange(tip.pos());
 399                         if (change != orig_change) {
 400                                 // take a step forward to correctly set the selection
 401                                 tip.forwardPos();
 402                                 break;
 403                         }
 404                 }
 405         }
 406
 407         // Now put cursor to end of selection:
 408         bv->cursor().setCursor(cur);
 409         bv->cursor().setSelection();
 410
 411         if (search_both_sides) {
 412                 bv->cursor().setSelection(false);
 413                 findChange(bv, !next);
 414         }
 415
 416         return true;
 417 }
 418
 419 namespace {
 420
 421 typedef vector<pair<string, string> > Escapes;
 422
 423 /// A map of symbols and their escaped equivalent needed within a regex.
 424 Escapes const & get_regexp_escapes()
 425 {
 426         static Escapes escape_map;
 427         if (escape_map.empty()) {
 428                 escape_map.push_back(pair<string, string>("\\", "\\\\"));
 429                 escape_map.push_back(pair<string, string>("^", "\\^"));
 430                 escape_map.push_back(pair<string, string>("$", "\\$"));
 431                 escape_map.push_back(pair<string, string>("{", "\\{"));
 432                 escape_map.push_back(pair<string, string>("}", "\\}"));
 433                 escape_map.push_back(pair<string, string>("[", "\\["));
 434                 escape_map.push_back(pair<string, string>("]", "\\]"));
 435                 escape_map.push_back(pair<string, string>("(", "\\("));
 436                 escape_map.push_back(pair<string, string>(")", "\\)"));
 437                 escape_map.push_back(pair<string, string>("+", "\\+"));
 438                 escape_map.push_back(pair<string, string>("*", "\\*"));
 439                 escape_map.push_back(pair<string, string>(".", "\\."));
 440         }
 441         return escape_map;
 442 }
 443
 444 /// A map of lyx escaped strings and their unescaped equivalent.
 445 Escapes const & get_lyx_unescapes() {
 446         static Escapes escape_map;
 447         if (escape_map.empty()) {
 448                 escape_map.push_back(pair<string, string>("{*}", "*"));
 449                 escape_map.push_back(pair<string, string>("{[}", "["));
 450                 escape_map.push_back(pair<string, string>("\\$", "$"));
 451                 escape_map.push_back(pair<string, string>("\\backslash{}", "\\"));
 452                 escape_map.push_back(pair<string, string>("\\backslash", "\\"));
 453                 escape_map.push_back(pair<string, string>("\\sim ", "~"));
 454                 escape_map.push_back(pair<string, string>("\\^", "^"));
 455         }
 456         return escape_map;
 457 }
 458
 459 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
 460  ** the found occurrence were escaped.
 461  **/
 462 string apply_escapes(string s, Escapes const & escape_map)
 463 {
 464         LYXERR(Debug::DEBUG, "Escaping: '" << s << "'");
 465         Escapes::const_iterator it;
 466         for (it = escape_map.begin(); it != escape_map.end(); ++it) {
 467 //              LYXERR(Debug::DEBUG, "Escaping " << it->first << " as " << it->second);
 468                 unsigned int pos = 0;
 469                 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
 470                         s.replace(pos, it->first.length(), it->second);
 471 //                      LYXERR(Debug::DEBUG, "After escape: " << s);
 472                         pos += it->second.length();
 473 //                      LYXERR(Debug::DEBUG, "pos: " << pos);
 474                 }
 475         }
 476         LYXERR(Debug::DEBUG, "Escaped : '" << s << "'");
 477         return s;
 478 }
 479
 480 /** Return the position of the closing brace matching the open one at s[pos],
 481  ** or s.size() if not found.
 482  **/
 483 size_t find_matching_brace(string const & s, size_t pos)
 484 {
 485         LASSERT(s[pos] == '{', /* */);
 486         int open_braces = 1;
 487         for (++pos; pos < s.size(); ++pos) {
 488                 if (s[pos] == '\\')
 489                         ++pos;
 490                 else if (s[pos] == '{')
 491                         ++open_braces;
 492                 else if (s[pos] == '}') {
 493                         --open_braces;
 494                         if (open_braces == 0)
 495                                 return pos;
 496                 }
 497         }
 498         return s.size();
 499 }
 500
 501 /// Within \regex{} apply get_regex_escapes(), while outside apply get_lyx_unescapes().
 502 string escape_for_regex(string s)
 503 {
 504         size_t pos = 0;
 505         while (pos < s.size()) {
 506                         size_t new_pos = s.find("\\regexp{", pos);
 507                         if (new_pos == string::npos)
 508                                         new_pos = s.size();
 509                         LYXERR(Debug::DEBUG, "new_pos: " << new_pos);
 510                         string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
 511                         LYXERR(Debug::DEBUG, "t      : " << t);
 512                         t = apply_escapes(t, get_regexp_escapes());
 513                         s.replace(pos, new_pos - pos, t);
 514                         new_pos = pos + t.size();
 515                         LYXERR(Debug::DEBUG, "Regexp after escaping: " << s);
 516                         LYXERR(Debug::DEBUG, "new_pos: " << new_pos);
 517                         if (new_pos == s.size())
 518                                         break;
 519                         size_t end_pos = find_matching_brace(s, new_pos + 7);
 520                         LYXERR(Debug::DEBUG, "end_pos: " << end_pos);
 521                         t = apply_escapes(s.substr(new_pos + 8, end_pos - (new_pos + 8)), get_lyx_unescapes());
 522                         LYXERR(Debug::DEBUG, "t      : " << t);
 523                         if (end_pos == s.size()) {
 524                                         s.replace(new_pos, end_pos - new_pos, t);
 525                                         pos = s.size();
 526                                         LYXERR(Debug::DEBUG, "Regexp after \\regexp{} removal: " << s);
 527                                         break;
 528                         }
 529                         s.replace(new_pos, end_pos + 1 - new_pos, t);
 530                         LYXERR(Debug::DEBUG, "Regexp after \\regexp{} removal: " << s);
 531                         pos = new_pos + t.size();
 532                         LYXERR(Debug::DEBUG, "pos: " << pos);
 533         }
 534         return s;
 535 }
 536
 537 /// Wrapper for boost::regex_replace with simpler interface
 538 bool regex_replace(string const & s, string & t, string const & searchstr,
 539         string const & replacestr)
 540 {
 541         boost::regex e(searchstr);
 542         ostringstream oss;
 543         ostream_iterator<char, char> it(oss);
 544         boost::regex_replace(it, s.begin(), s.end(), e, replacestr);
 545         // tolerate t and s be references to the same variable
 546         bool rv = (s != oss.str());
 547         t = oss.str();
 548         return rv;
 549 }
 550
 551 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
 552  **
 553  ** Verify that closed braces exactly match open braces. This avoids that, for example,
 554  ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
 555  **
 556  ** @param unmatched
 557  ** Number of open braces that must remain open at the end for the verification to succeed.
 558  **/
 559 bool braces_match(string::const_iterator const & beg,
 560         string::const_iterator const & end, int unmatched = 0)
 561 {
 562         int open_pars = 0;
 563         string::const_iterator it = beg;
 564         LYXERR(Debug::DEBUG, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
 565         for (; it != end; ++it) {
 566                 // Skip escaped braces in the count
 567                 if (*it == '\\') {
 568                         ++it;
 569                         if (it == end)
 570                                 break;
 571                 } else if (*it == '{') {
 572                         ++open_pars;
 573                 } else if (*it == '}') {
 574                         if (open_pars == 0) {
 575                                 LYXERR(Debug::DEBUG, "Found unmatched closed brace");
 576                                 return false;
 577                         } else
 578                                 --open_pars;
 579                 }
 580         }
 581         if (open_pars != unmatched) {
 582           LYXERR(Debug::DEBUG, "Found " << open_pars << " instead of " << unmatched << " unmatched open braces at the end of count");
 583                         return false;
 584         }
 585         LYXERR(Debug::DEBUG, "Braces match as expected");
 586         return true;
 587 }
 588
 589 /** The class performing a match between a position in the document and the FindAdvOptions.
 590  **
 591  ** @todo The user-entered regexp expression(s) should be enclosed within something like \regexp{},
 592  **       to be written by a dedicated Inset, so to avoid escaping it in escape_for_regex().
 593  **/
 594 class MatchStringAdv {
 595 public:
 596         MatchStringAdv(lyx::Buffer const & buf, FindAndReplaceOptions const & opt);
 597
 598         /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
 599          ** constructor as opt.search, under the opt.* options settings.
 600          **
 601          ** @param at_begin
 602          **     If set, then match is searched only against beginning of text starting at cur.
 603          **     If unset, then match is searched anywhere in text starting at cur.
 604          **
 605          ** @return
 606          ** The length of the matching text, or zero if no match was found.
 607          **/
 608         int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
 609
 610 public:
 611         /// buffer
 612         lyx::Buffer const & buf;
 613         /// options
 614         FindAndReplaceOptions const & opt;
 615
 616 private:
 617         /** Normalize a stringified or latexified LyX paragraph.
 618          **
 619          ** Normalize means:
 620          ** <ul>
 621          **   <li>if search is not casesensitive, then lowercase the string;
 622          **   <li>remove any newline at begin or end of the string;
 623          **   <li>replace any newline in the middle of the string with a simple space;
 624          **   <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
 625          ** </ul>
 626          **
 627          ** @todo Normalization should also expand macros, if the corresponding
 628          ** search option was checked.
 629          **/
 630         string normalize(docstring const & s) const;
 631         // normalized string to search
 632         string par_as_string;
 633         // regular expression to use for searching
 634         boost::regex regexp;
 635         // same as regexp, but prefixed with a ".*"
 636         boost::regex regexp2;
 637         // unmatched open braces in the search string/regexp
 638         int open_braces;
 639         // number of (.*?) subexpressions added at end of search regexp for closing
 640         // environments, math mode, styles, etc...
 641         int close_wildcards;
 642 };
 643
 644
 645 MatchStringAdv::MatchStringAdv(lyx::Buffer const & buf, FindAndReplaceOptions const & opt)
 646   : buf(buf), opt(opt)
 647 {
 648         par_as_string = normalize(opt.search);
 649         open_braces = 0;
 650         close_wildcards = 0;
 651
 652         if (! opt.regexp) {
 653                 // Remove trailing closure of math, macros and environments, so to catch parts of them.
 654                 do {
 655                         LYXERR(Debug::DEBUG, "par_as_string now is '" << par_as_string << "'");
 656                         if (regex_replace(par_as_string, par_as_string, "(.*)[[:blank:]]\\'", "$1"))
 657                                         continue;
 658                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\$\\'", "$1"))
 659                                         continue;
 660                         // @todo need to account for open square braces as well ?
 661                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\\\]\\'", "$1"))
 662                                         continue;
 663                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\end\\{[a-zA-Z_]*\\}\\'", "$1"))
 664                                         continue;
 665                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\}\\'", "$1")) {
 666                                 ++open_braces;
 667                                 continue;
 668                         }
 669                         break;
 670                 } while (true);
 671                 LYXERR(Debug::DEBUG, "Open braces: " << open_braces);
 672                 LASSERT(braces_match(par_as_string.begin(), par_as_string.end(), open_braces), /* */);
 673                 LYXERR(Debug::DEBUG, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
 674         } else {
 675                 par_as_string = escape_for_regex(par_as_string);
 676                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
 677                 LYXERR(Debug::DEBUG, "par_as_string now is '" << par_as_string << "'");
 678                 if (
 679                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
 680                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
 681                                 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
 682                                 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
 683                                 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
 684                                 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\\\end\\\\\\{[a-zA-Z_]*\\\\\\})\\'", "$1(.*?)$2")
 685                                 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
 686                                 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
 687                 ) {
 688                         ++close_wildcards;
 689                 }
 690                 LYXERR(Debug::DEBUG, "par_as_string now is '" << par_as_string << "'");
 691                 LYXERR(Debug::DEBUG, "Open braces: " << open_braces);
 692                 LYXERR(Debug::DEBUG, "Close .*?  : " << close_wildcards);
 693                 LASSERT(braces_match(par_as_string.begin(), par_as_string.end(), open_braces), /* */);
 694                 // Entered regexp must match at begin of searched string buffer
 695                 par_as_string = string("\\`") + par_as_string;
 696                 LYXERR(Debug::DEBUG, "Replaced text (to be used as regex): " << par_as_string);
 697                 regexp = boost::regex(par_as_string);
 698                 regexp2 = boost::regex(string(".*") + par_as_string);
 699         }
 700 }
 701
 702
 703 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
 704 {
 705         docstring docstr = stringifyFromForSearch(opt, cur, len);
 706         LYXERR(Debug::DEBUG, "Matching against     '" << lyx::to_utf8(docstr) << "'");
 707         string str = normalize(docstr);
 708         LYXERR(Debug::DEBUG, "After normalization: '" << str << "'");
 709         if (! opt.regexp) {
 710                 if (at_begin) {
 711                         if (str.substr(0, par_as_string.size()) == par_as_string)
 712                                 return par_as_string.size();
 713                 } else {
 714                         size_t pos = str.find(par_as_string);
 715                         if (pos != string::npos)
 716                                 return par_as_string.size();
 717                 }
 718         } else {
 719                 // Try all possible regexp matches, until one that verifies the braces match test is found
 720                 boost::regex const *p_regexp = at_begin ? &regexp : &regexp2;
 721                 boost::sregex_iterator re_it(str.begin(), str.end(), *p_regexp);
 722                 boost::sregex_iterator re_it_end;
 723                 for (; re_it != re_it_end; ++re_it) {
 724                         boost::match_results<string::const_iterator> const & m = *re_it;
 725                         // Check braces on the segment that matched the entire regexp expression,
 726                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
 727                         if (! braces_match(m[0].first, m[0].second, open_braces))
 728                                 return 0;
 729                         // Check braces on segments that matched all (.*?) subexpressions.
 730                         for (size_t i = 1; i < m.size(); ++i)
 731                                 if (! braces_match(m[i].first, m[i].second))
 732                                         return false;
 733                         // Exclude from the returned match length any length due to close wildcards added at end of regexp
 734                         if (close_wildcards == 0)
 735                                 return m[0].second - m[0].first;
 736                         else
 737                                 return m[m.size() - close_wildcards].first - m[0].first;
 738                 }
 739         }
 740         return 0;
 741 }
 742
 743
 744 string MatchStringAdv::normalize(docstring const & s) const
 745 {
 746         string t;
 747         if (! opt.casesensitive)
 748                 t = lyx::to_utf8(lowercase(s));
 749         else
 750                 t = lyx::to_utf8(s);
 751         // Remove \n at begin
 752         while (t.size() > 0 && t[0] == '\n')
 753                 t = t.substr(1);
 754         // Remove \n at end
 755         while (t.size() > 0 && t[t.size() - 1] == '\n')
 756                 t = t.substr(0, t.size() - 1);
 757         size_t pos;
 758         // Replace all other \n with spaces
 759         while ((pos = t.find("\n")) != string::npos)
 760                 t.replace(pos, 1, " ");
 761         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
 762         while (regex_replace(t, t, "\\\\[a-zA-Z_]+(\\{\\})+", ""))
 763                 ;
 764         return t;
 765 }
 766
 767
 768 docstring stringifyFromCursor(DocIterator const & cur, int len)
 769 {
 770         LYXERR(Debug::DEBUG, "Stringifying with len=" << len << " from cursor at pos: " << cur);
 771         if (cur.inTexted()) {
 772                         Paragraph const & par = cur.paragraph();
 773                         // TODO what about searching beyond/across paragraph breaks ?
 774                         // TODO Try adding a AS_STR_INSERTS as last arg
 775                         pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ? int(par.size()) : cur.pos() + len;
 776                         OutputParams runparams(&cur.buffer()->params().encoding());
 777                         odocstringstream os;
 778                         runparams.nice = true;
 779                         runparams.flavor = OutputParams::LATEX;
 780                         runparams.linelen = 100000; //lyxrc.plaintext_linelen;
 781                         // No side effect of file copying and image conversion
 782                         runparams.dryrun = true;
 783                         LYXERR(Debug::DEBUG, "Stringifying with cur: " << cur << ", from pos: " << cur.pos() << ", end: " << end);
 784                         return par.stringify(cur.pos(), end, AS_STR_INSETS, runparams);
 785         } else if (cur.inMathed()) {
 786                         odocstringstream os;
 787                         CursorSlice cs = cur.top();
 788                         MathData md = cs.cell();
 789                         MathData::const_iterator it_end = ( ( len == -1 || cs.pos() + len > int(md.size()) ) ? md.end() : md.begin() + cs.pos() + len );
 790                         for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
 791                                         os << *it;
 792                         return os.str();
 793         }
 794         LYXERR(Debug::DEBUG, "Don't know how to stringify from here: " << cur);
 795         return docstring();
 796 }
 797
 798 /** Computes the LaTeX export of buf starting from cur and ending len positions
 799  * after cur, if len is positive, or at the paragraph or innermost inset end
 800  * if len is -1.
 801  */
 802
 803 docstring latexifyFromCursor(DocIterator const & cur, int len)
 804 {
 805         LYXERR(Debug::DEBUG, "Latexifying with len=" << len << " from cursor at pos: " << cur);
 806         LYXERR(Debug::DEBUG, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
 807                 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
 808         Buffer const & buf = *cur.buffer();
 809         LASSERT(buf.isLatex(), /* */);
 810
 811         TexRow texrow;
 812         odocstringstream ods;
 813         OutputParams runparams(&buf.params().encoding());
 814         runparams.nice = false;
 815         runparams.flavor = OutputParams::LATEX;
 816         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
 817         // No side effect of file copying and image conversion
 818         runparams.dryrun = true;
 819
 820         if (cur.inTexted()) {
 821                         // @TODO what about searching beyond/across paragraph breaks ?
 822                         ParagraphList::const_iterator pit = cur.innerText()->paragraphs().begin();
 823                         for (int i = 0; i < cur.pit(); ++i)
 824                                         ++pit;
 825 //              ParagraphList::const_iterator pit_end = pit;
 826 //              ++pit_end;
 827 //              lyx::latexParagraphs(buf, cur.innerText()->paragraphs(), ods, texrow, runparams, string(), pit, pit_end);
 828                 pos_type const endpos = (len == -1 || cur.pos() + len > int(pit->size()))
 829                         ? pit->size() : cur.pos() + len;
 830                 TeXOnePar(buf, *cur.innerText(), pit, ods, texrow, runparams, string(),
 831                         cur.pos(), endpos);
 832                 LYXERR(Debug::DEBUG, "Latexified text: '" << lyx::to_utf8(ods.str()) << "'");
 833         } else if (cur.inMathed()) {
 834                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
 835                 for (int s = cur.depth() - 1; s >= 0; --s) {
 836                                 CursorSlice const & cs = cur[s];
 837                                 if (cs.asInsetMath() && cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
 838                                                 WriteStream ws(ods);
 839                                                 cs.asInsetMath()->asHullInset()->header_write(ws);
 840                                                 break;
 841                                 }
 842                 }
 843
 844                 CursorSlice const & cs = cur.top();
 845                 MathData md = cs.cell();
 846                 MathData::const_iterator it_end = ( ( len == -1 || cs.pos() + len > int(md.size()) )
 847                         ? md.end() : md.begin() + cs.pos() + len );
 848                 for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
 849                                 ods << *it;
 850
 851                 // MathData md = cur.cell();
 852                 // MathData::const_iterator it_end = ( ( len == -1 || cur.pos() + len > int(md.size()) ) ? md.end() : md.begin() + cur.pos() + len );
 853                 // for (MathData::const_iterator it = md.begin() + cur.pos(); it != it_end; ++it) {
 854                 //      MathAtom const & ma = *it;
 855                 //      ma.nucleus()->latex(buf, ods, runparams);
 856                 // }
 857
 858                 // Retrieve the math environment type, and add '$' or '$]'
 859                 // or others (\end{equation}) accordingly
 860                 for (int s = cur.depth() - 1; s >= 0; --s) {
 861                         CursorSlice const & cs = cur[s];
 862                         InsetMath * inset = cs.asInsetMath();
 863                         if (inset && inset->asHullInset()) {
 864                                 WriteStream ws(ods);
 865                                 inset->asHullInset()->footer_write(ws);
 866                                 break;
 867                         }
 868                 }
 869                 LYXERR(Debug::DEBUG, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
 870         } else {
 871                 LYXERR(Debug::DEBUG, "Don't know how to stringify from here: " << cur);
 872         }
 873         return ods.str();
 874 }
 875
 876 /** Finalize an advanced find operation, advancing the cursor to the innermost
 877  ** position that matches, plus computing the length of the matching text to
 878  ** be selected
 879  **/
 880 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
 881 {
 882         // Search the foremost position that matches (avoids find of entire math
 883         // inset when match at start of it)
 884         size_t d;
 885         DocIterator old_cur(cur.buffer());
 886         do {
 887                 LYXERR(Debug::DEBUG, "Forwarding one step (searching for innermost match)");
 888                 d = cur.depth();
 889                 old_cur = cur;
 890                 cur.forwardPos();
 891         } while (cur && cur.depth() > d && match(cur) > 0);
 892         cur = old_cur;
 893         LASSERT(match(cur) > 0, /* */);
 894         LYXERR(Debug::DEBUG, "Ok");
 895
 896         // Compute the match length
 897         int len = 1;
 898         LYXERR(Debug::DEBUG, "verifying unmatch with len = " << len);
 899         while (cur.pos() + len <= cur.lastpos() && match(cur, len) == 0) {
 900                 ++len;
 901                 LYXERR(Debug::DEBUG, "verifying unmatch with len = " << len);
 902         }
 903         // Length of matched text (different from len param)
 904         int old_len = match(cur, len);
 905         int new_len;
 906         // Greedy behaviour while matching regexps
 907         while ((new_len = match(cur, len + 1)) > old_len) {
 908                 ++len;
 909                 old_len = new_len;
 910                 LYXERR(Debug::DEBUG, "verifying   match with len = " << len);
 911         }
 912         return len;
 913 }
 914
 915
 916 /// Finds forward
 917 int findForwardAdv(DocIterator & cur, MatchStringAdv const & match)
 918 {
 919         if (!cur)
 920                 return 0;
 921         int wrap_answer;
 922         do {
 923                 while (cur && !match(cur, -1, false)) {
 924                         if (cur.pit() < cur.lastpit())
 925                                 cur.forwardPar();
 926                         else {
 927                                 cur.forwardPos();
 928                         }
 929                 }
 930                 for (; cur; cur.forwardPos()) {
 931                         if (match(cur))
 932                                 return findAdvFinalize(cur, match);
 933                 }
 934                 wrap_answer = frontend::Alert::prompt(
 935                         _("Wrap search ?"),
 936                         _("End of document reached while searching forward\n"
 937                                 "\n"
 938                                 "Continue searching from beginning ?"),
 939                         0, 1, _("&Yes"), _("&No"));
 940                 cur.clear();
 941                 cur.push_back(CursorSlice(match.buf.inset()));
 942         } while (wrap_answer == 0);
 943         return 0;
 944 }
 945
 946
 947 /// Finds backwards
 948 int findBackwardsAdv(DocIterator & cur, MatchStringAdv const & match) {
 949         //      if (cur.pos() > 0 || cur.depth() > 0)
 950         //              cur.backwardPos();
 951         DocIterator cur_orig(cur);
 952         if (match(cur_orig))
 953                 findAdvFinalize(cur_orig, match);
 954         //      int total = cur.bottom().pit() + 1;
 955         int wrap_answer;
 956         do {
 957                 // TODO No ! così non va.
 958                 bool pit_changed = false;
 959                 while (cur && !match(cur, -1, false)) {
 960                         if (cur.pit() > 0)
 961                                 --cur.pit();
 962                         else {
 963                                 cur.backwardPos();
 964                                 if (cur)
 965                                         cur.pos() = 0;
 966                         }
 967                         pit_changed = true;
 968                 }
 969                 if (cur && pit_changed)
 970                         cur.pos() = cur.lastpos();
 971                 for (; cur; cur.backwardPos()) {
 972                         if (match(cur)) {
 973                                 // Find the most backward consecutive match within same paragraph while searching backwards.
 974                                 int pit = cur.pit();
 975                                 int old_len;
 976                                 DocIterator old_cur;
 977                                 int len = findAdvFinalize(cur, match);
 978                                 do {
 979                                         old_cur = cur;
 980                                         old_len = len;
 981                                         cur.backwardPos();
 982                                         LYXERR(Debug::DEBUG, "old_cur: " << old_cur << ", old_len=" << len << ", cur: " << cur);
 983                                 } while (cur && cur.pit() == pit && match(cur)
 984                                         && (len = findAdvFinalize(cur, match)) > old_len);
 985                                 cur = old_cur;
 986                                 len = old_len;
 987                                 LYXERR(Debug::DEBUG, "cur_orig    : " << cur_orig);
 988                                 LYXERR(Debug::DEBUG, "cur         : " << cur);
 989                                 if (cur != cur_orig)
 990                                         return len;
 991                         }
 992                 }
 993                 wrap_answer = frontend::Alert::prompt(
 994                         _("Wrap search ?"),
 995                         _("Beginning of document reached while searching backwards\n"
 996                                 "\n"
 997                                 "Continue searching from end ?"),
 998                         0, 1, _("&Yes"), _("&No"));
 999                 cur = doc_iterator_end(&match.buf);
1000                 cur.backwardPos();
1001         } while (wrap_answer == 0);
1002         return 0;
1003 }
1004
1005 } // anonym namespace
1006
1007
1008 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
1009         DocIterator const & cur, int len)
1010 {
1011         if (!opt.ignoreformat)
1012                 return latexifyFromCursor(cur, len);
1013         else
1014                 return stringifyFromCursor(cur, len);
1015 }
1016
1017
1018 lyx::FindAndReplaceOptions::FindAndReplaceOptions(docstring const & search, bool casesensitive,
1019         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
1020         bool regexp, docstring const & replace)
1021         : search(search), casesensitive(casesensitive), matchword(matchword),
1022         forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
1023         regexp(regexp), replace(replace)
1024 {
1025 }
1026
1027 /// Perform a FindAdv operation.
1028 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
1029 {
1030         DocIterator cur = bv->cursor();
1031         int match_len = 0;
1032
1033         if (opt.search.empty()) {
1034                         bv->message(_("Search text is empty!"));
1035                         return false;
1036         }
1037 //      if (! bv->buffer()) {
1038 //              bv->message(_("No open document !"));
1039 //              return false;
1040 //      }
1041
1042         try {
1043                 MatchStringAdv const matchAdv(bv->buffer(), opt);
1044                 if (opt.forward)
1045                                 match_len = findForwardAdv(cur, matchAdv);
1046                 else
1047                                 match_len = findBackwardsAdv(cur, matchAdv);
1048         } catch (...) {
1049                 // This may only be raised by boost::regex()
1050                 bv->message(_("Invalid regular expression!"));
1051                 return false;
1052         }
1053
1054         if (match_len == 0) {
1055                 bv->message(_("Match not found!"));
1056                 return false;
1057         }
1058
1059         LYXERR(Debug::DEBUG, "Putting selection at " << cur << " with len: " << match_len);
1060         bv->putSelectionAt(cur, match_len, ! opt.forward);
1061         bv->message(_("Match found!"));
1062         if (opt.replace != docstring(from_utf8(LYX_FR_NULL_STRING))) {
1063                 dispatch(FuncRequest(LFUN_SELF_INSERT, opt.replace));
1064         }
1065
1066         return true;
1067 }
1068
1069
1070 void findAdv(BufferView * bv, FuncRequest const & ev)
1071 {
1072         if (!bv || ev.action != LFUN_WORD_FINDADV)
1073                 return;
1074
1075         FindAndReplaceOptions opt;
1076         istringstream iss(to_utf8(ev.argument()));
1077         iss >> opt;
1078         findAdv(bv, opt);
1079 }
1080
1081
1082 ostringstream & operator<<(ostringstream & os, lyx::FindAndReplaceOptions const & opt)
1083 {
1084         os << to_utf8(opt.search) << "\nEOSS\n"
1085            << opt.casesensitive << ' '
1086            << opt.matchword << ' '
1087            << opt.forward << ' '
1088            << opt.expandmacros << ' '
1089            << opt.ignoreformat << ' '
1090            << opt.regexp << ' '
1091            << to_utf8(opt.replace) << "\nEOSS\n";
1092
1093         LYXERR(Debug::DEBUG, "built: " << os.str());
1094
1095         return os;
1096 }
1097
1098 istringstream & operator>>(istringstream & is, lyx::FindAndReplaceOptions & opt)
1099 {
1100         LYXERR(Debug::DEBUG, "parsing");
1101         string s;
1102         string line;
1103         getline(is, line);
1104         while (line != "EOSS") {
1105                 if (! s.empty())
1106                                 s = s + "\n";
1107                 s = s + line;
1108                 if (is.eof())   // Tolerate malformed request
1109                                 break;
1110                 getline(is, line);
1111         }
1112         LYXERR(Debug::DEBUG, "searching for: '" << s << "'");
1113         opt.search = from_utf8(s);
1114         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.regexp;
1115         is.get();       // Waste space before replace string
1116         s = "";
1117         getline(is, line);
1118         while (line != "EOSS") {
1119                 if (! s.empty())
1120                                 s = s + "\n";
1121                 s = s + line;
1122                 if (is.eof())   // Tolerate malformed request
1123                                 break;
1124                 getline(is, line);
1125         }
1126         LYXERR(Debug::DEBUG, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
1127                    << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.regexp);
1128         LYXERR(Debug::DEBUG, "replacing with: '" << s << "'");
1129         opt.replace = from_utf8(s);
1130         return is;
1131 }
1132
1133 } // lyx namespace