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