3 * This file is part of LyX, the document processor.
4 * License details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
9 * \author Alfredo Braunstein
10 * \author Tommaso Cucinotta
12 * Full author contact details are available in file CREDITS.
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "BufferView.h"
26 #include "CutAndPaste.h"
27 #include "FuncRequest.h"
29 #include "output_latex.h"
30 #include "OutputParams.h"
31 #include "Paragraph.h"
32 #include "ParIterator.h"
36 #include "frontends/alert.h"
38 #include "mathed/InsetMath.h"
39 #include "mathed/InsetMathGrid.h"
40 #include "mathed/InsetMathHull.h"
41 #include "mathed/MathStream.h"
43 #include "support/convert.h"
44 #include "support/debug.h"
45 #include "support/docstream.h"
46 #include "support/gettext.h"
47 #include "support/lassert.h"
48 #include "support/lstrings.h"
50 #include "support/regex.h"
51 #include <boost/next_prior.hpp>
54 using namespace lyx::support;
60 bool parse_bool(docstring & howto)
65 howto = split(howto, var, ' ');
70 class MatchString : public binary_function<Paragraph, pos_type, int>
73 MatchString(docstring const & str, bool cs, bool mw)
74 : str(str), case_sens(cs), whole_words(mw)
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 int operator()(Paragraph const & par, pos_type pos, bool del = true) const
81 return par.find(str, case_sens, whole_words, pos, del);
89 // match whole words only
94 int findForward(DocIterator & cur, MatchString const & match,
97 for (; cur; cur.forwardChar())
99 int len = match(cur.paragraph(), cur.pos(), find_del);
107 int findBackwards(DocIterator & cur, MatchString const & match,
108 bool find_del = true)
112 if (cur.inTexted()) {
113 int len = match(cur.paragraph(), cur.pos(), find_del);
122 bool findChange(DocIterator & cur, bool next)
126 for (; cur; next ? cur.forwardPos() : cur.backwardPos())
127 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos())) {
129 // if we search backwards, take a step forward
130 // to correctly set the anchor
139 bool searchAllowed(docstring const & str)
142 frontend::Alert::error(_("Search error"), _("Search string is empty"));
149 bool findOne(BufferView * bv, docstring const & searchstr,
150 bool case_sens, bool whole, bool forward, bool find_del = true)
152 if (!searchAllowed(searchstr))
155 DocIterator cur = bv->cursor();
157 MatchString const match(searchstr, case_sens, whole);
159 int match_len = forward ? findForward(cur, match, find_del) :
160 findBackwards(cur, match, find_del);
163 bv->putSelectionAt(cur, match_len, !forward);
165 return match_len > 0;
169 int replaceAll(BufferView * bv,
170 docstring const & searchstr, docstring const & replacestr,
171 bool case_sens, bool whole)
173 Buffer & buf = bv->buffer();
175 if (!searchAllowed(searchstr) || buf.isReadonly())
178 DocIterator cur_orig(bv->cursor());
180 MatchString const match(searchstr, case_sens, whole);
183 int const rsize = replacestr.size();
184 int const ssize = searchstr.size();
187 cur.setCursor(doc_iterator_begin(&buf));
188 int match_len = findForward(cur, match, false);
189 while (match_len > 0) {
190 // Backup current cursor position and font.
191 pos_type const pos = cur.pos();
192 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
194 int striked = ssize - cur.paragraph().eraseChars(pos, pos + match_len,
195 buf.params().trackChanges);
196 cur.paragraph().insert(pos, replacestr, font,
197 Change(buf.params().trackChanges ?
198 Change::INSERTED : Change::UNCHANGED));
199 for (int i = 0; i < rsize + striked; ++i)
202 match_len = findForward(cur, match, false);
205 bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
207 cur_orig.fixIfBroken();
208 bv->setCursor(cur_orig);
214 // the idea here is that we are going to replace the string that
215 // is selected IF it is the search string.
216 // if there is a selection, but it is not the search string, then
217 // we basically ignore it. (FIXME We ought to replace only within
219 // if there is no selection, then:
220 // (i) if some search string has been provided, then we find it.
221 // (think of how the dialog works when you hit "replace" the
223 // (ii) if no search string has been provided, then we treat the
224 // word the cursor is in as the search string. (why? i have no
225 // idea.) but this only works in text?
227 // returns the number of replacements made (one, if any) and
228 // whether anything at all was done.
229 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
230 docstring const & replacestr, bool case_sens,
231 bool whole, bool forward)
233 Cursor & cur = bv->cursor();
234 if (!cur.selection()) {
235 // no selection, non-empty search string: find it
236 if (!searchstr.empty()) {
237 findOne(bv, searchstr, case_sens, whole, forward);
238 return pair<bool, int>(true, 0);
240 // empty search string
243 return pair<bool, int>(false, 0);
244 // select current word and treat it as the search string
245 cur.innerText()->selectWord(cur, WHOLE_WORD);
246 searchstr = cur.selectionAsString(false);
249 // if we still don't have a search string, report the error
251 if (!searchAllowed(searchstr))
252 return pair<bool, int>(false, 0);
254 bool have_selection = cur.selection();
255 docstring const selected = cur.selectionAsString(false);
257 case_sens ? searchstr == selected
258 : compare_no_case(searchstr, selected) == 0;
260 // no selection or current selection is not search word:
261 // just find the search word
262 if (!have_selection || !match) {
263 findOne(bv, searchstr, case_sens, whole, forward);
264 return pair<bool, int>(true, 0);
267 // we're now actually ready to replace. if the buffer is
268 // read-only, we can't, though.
269 if (bv->buffer().isReadonly())
270 return pair<bool, int>(false, 0);
272 cap::replaceSelectionWithString(cur, replacestr, forward);
274 cur.pos() += replacestr.length();
275 LASSERT(cur.pos() <= cur.lastpos(), /* */);
277 cur.pos() -= replacestr.length();
278 LASSERT(cur.pos() >= 0, /* */);
280 findOne(bv, searchstr, case_sens, whole, forward, false);
282 return pair<bool, int>(true, 1);
288 docstring const find2string(docstring const & search,
289 bool casesensitive, bool matchword, bool forward)
293 << int(casesensitive) << ' '
294 << int(matchword) << ' '
300 docstring const replace2string(docstring const & replace,
301 docstring const & search, bool casesensitive, bool matchword,
302 bool all, bool forward)
305 ss << replace << '\n'
307 << int(casesensitive) << ' '
308 << int(matchword) << ' '
315 bool lyxfind(BufferView * bv, FuncRequest const & ev)
317 if (!bv || ev.action() != LFUN_WORD_FIND)
320 //lyxerr << "find called, cmd: " << ev << endl;
322 // data is of the form
324 // <casesensitive> <matchword> <forward>"
326 docstring howto = split(ev.argument(), search, '\n');
328 bool casesensitive = parse_bool(howto);
329 bool matchword = parse_bool(howto);
330 bool forward = parse_bool(howto);
332 return findOne(bv, search, casesensitive, matchword, forward);
336 bool lyxreplace(BufferView * bv,
337 FuncRequest const & ev, bool has_deleted)
339 if (!bv || ev.action() != LFUN_WORD_REPLACE)
342 // data is of the form
345 // <casesensitive> <matchword> <all> <forward>"
348 docstring howto = split(ev.argument(), rplc, '\n');
349 howto = split(howto, search, '\n');
351 bool casesensitive = parse_bool(howto);
352 bool matchword = parse_bool(howto);
353 bool all = parse_bool(howto);
354 bool forward = parse_bool(howto);
356 int replace_count = 0;
361 replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
362 update = replace_count > 0;
365 replaceOne(bv, search, rplc, casesensitive, matchword, forward);
367 replace_count = rv.second;
370 Buffer const & buf = bv->buffer();
372 // emit message signal.
373 buf.message(_("String not found!"));
375 if (replace_count == 0) {
376 buf.message(_("String found."));
377 } else if (replace_count == 1) {
378 buf.message(_("String has been replaced."));
380 docstring const str =
381 bformat(_("%1$d strings have been replaced."), replace_count);
386 // if we have deleted characters, we do not replace at all, but
387 // rather search for the next occurence
388 if (findOne(bv, search, casesensitive, matchword, forward))
391 bv->message(_("String not found!"));
397 bool findNextChange(BufferView * bv)
399 return findChange(bv, true);
403 bool findPreviousChange(BufferView * bv)
405 return findChange(bv, false);
409 bool findChange(BufferView * bv, bool next)
411 if (bv->cursor().selection()) {
412 // set the cursor at the beginning or at the end of the selection
413 // before searching. Otherwise, the current change will be found.
414 if (next != (bv->cursor().top() > bv->cursor().normalAnchor()))
415 bv->cursor().setCursorToAnchor();
418 DocIterator cur = bv->cursor();
420 // Are we within a change ? Then first search forward (backward),
421 // clear the selection and search the other way around (see the end
422 // of this function). This will avoid changes to be selected half.
423 bool search_both_sides = false;
424 DocIterator tmpcur = cur;
426 while (tmpcur.inMathed())
428 Change change_next_pos
429 = tmpcur.paragraph().lookupChange(tmpcur.pos());
430 if (change_next_pos.changed() && cur.inMathed()) {
432 search_both_sides = true;
433 } else if (tmpcur.pos() > 0 && tmpcur.inTexted()) {
434 Change change_prev_pos
435 = tmpcur.paragraph().lookupChange(tmpcur.pos() - 1);
436 if (change_next_pos.isSimilarTo(change_prev_pos))
437 search_both_sides = true;
440 if (!findChange(cur, next))
443 bv->cursor().setCursor(cur);
444 bv->cursor().resetAnchor();
447 // take a step into the change
450 Change orig_change = cur.paragraph().lookupChange(cur.pos());
452 CursorSlice & tip = cur.top();
454 for (; !tip.at_end(); tip.forwardPos()) {
455 Change change = tip.paragraph().lookupChange(tip.pos());
456 if (!change.isSimilarTo(orig_change))
460 for (; !tip.at_begin();) {
462 Change change = tip.paragraph().lookupChange(tip.pos());
463 if (!change.isSimilarTo(orig_change)) {
464 // take a step forward to correctly set the selection
471 // Now put cursor to end of selection:
472 bv->cursor().setCursor(cur);
473 bv->cursor().setSelection();
475 if (search_both_sides) {
476 bv->cursor().setSelection(false);
477 findChange(bv, !next);
485 typedef vector<pair<string, string> > Escapes;
487 /// A map of symbols and their escaped equivalent needed within a regex.
488 Escapes const & get_regexp_escapes()
490 static Escapes escape_map;
491 if (escape_map.empty()) {
492 escape_map.push_back(pair<string, string>("\\", "\\\\"));
493 escape_map.push_back(pair<string, string>("^", "\\^"));
494 escape_map.push_back(pair<string, string>("$", "\\$"));
495 escape_map.push_back(pair<string, string>("{", "\\{"));
496 escape_map.push_back(pair<string, string>("}", "\\}"));
497 escape_map.push_back(pair<string, string>("[", "\\["));
498 escape_map.push_back(pair<string, string>("]", "\\]"));
499 escape_map.push_back(pair<string, string>("(", "\\("));
500 escape_map.push_back(pair<string, string>(")", "\\)"));
501 escape_map.push_back(pair<string, string>("+", "\\+"));
502 escape_map.push_back(pair<string, string>("*", "\\*"));
503 escape_map.push_back(pair<string, string>(".", "\\."));
508 /// A map of lyx escaped strings and their unescaped equivalent.
509 Escapes const & get_lyx_unescapes() {
510 static Escapes escape_map;
511 if (escape_map.empty()) {
512 escape_map.push_back(pair<string, string>("{*}", "*"));
513 escape_map.push_back(pair<string, string>("{[}", "["));
514 escape_map.push_back(pair<string, string>("\\$", "$"));
515 escape_map.push_back(pair<string, string>("\\backslash{}", "\\"));
516 escape_map.push_back(pair<string, string>("\\backslash", "\\"));
517 escape_map.push_back(pair<string, string>("\\sim ", "~"));
518 escape_map.push_back(pair<string, string>("\\^", "^"));
523 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
524 ** the found occurrence were escaped.
526 string apply_escapes(string s, Escapes const & escape_map)
528 LYXERR(Debug::FIND, "Escaping: '" << s << "'");
529 Escapes::const_iterator it;
530 for (it = escape_map.begin(); it != escape_map.end(); ++it) {
531 // LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
532 unsigned int pos = 0;
533 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
534 s.replace(pos, it->first.length(), it->second);
535 // LYXERR(Debug::FIND, "After escape: " << s);
536 pos += it->second.length();
537 // LYXERR(Debug::FIND, "pos: " << pos);
540 LYXERR(Debug::FIND, "Escaped : '" << s << "'");
544 /** Return the position of the closing brace matching the open one at s[pos],
545 ** or s.size() if not found.
547 size_t find_matching_brace(string const & s, size_t pos)
549 LASSERT(s[pos] == '{', /* */);
551 for (++pos; pos < s.size(); ++pos) {
554 else if (s[pos] == '{')
556 else if (s[pos] == '}') {
558 if (open_braces == 0)
565 /// Within \regexp{} apply get_regex_escapes(), while outside apply get_lyx_unescapes().
566 string escape_for_regex(string s)
569 while (pos < s.size()) {
570 size_t new_pos = s.find("\\regexp{{{", pos);
571 if (new_pos == string::npos)
573 LYXERR(Debug::FIND, "new_pos: " << new_pos);
574 string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
575 LYXERR(Debug::FIND, "t : " << t);
576 t = apply_escapes(t, get_regexp_escapes());
577 LYXERR(Debug::FIND, "t : " << t);
578 s.replace(pos, new_pos - pos, t);
579 new_pos = pos + t.size();
580 LYXERR(Debug::FIND, "Regexp after escaping: " << s);
581 LYXERR(Debug::FIND, "new_pos: " << new_pos);
582 if (new_pos == s.size())
584 size_t end_pos = s.find("}}}", new_pos + 10); // find_matching_brace(s, new_pos + 7);
585 LYXERR(Debug::FIND, "end_pos: " << end_pos);
586 t = apply_escapes(s.substr(new_pos + 10, end_pos - (new_pos + 10)), get_lyx_unescapes());
587 LYXERR(Debug::FIND, "t : " << t);
588 if (end_pos == s.size()) {
589 s.replace(new_pos, end_pos - new_pos, t);
591 LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
594 s.replace(new_pos, end_pos + 3 - new_pos, t);
595 LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
596 pos = new_pos + t.size();
597 LYXERR(Debug::FIND, "pos: " << pos);
602 /// Wrapper for lyx::regex_replace with simpler interface
603 bool regex_replace(string const & s, string & t, string const & searchstr,
604 string const & replacestr)
606 lyx::regex e(searchstr);
608 ostream_iterator<char, char> it(oss);
609 lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
610 // tolerate t and s be references to the same variable
611 bool rv = (s != oss.str());
616 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
618 ** Verify that closed braces exactly match open braces. This avoids that, for example,
619 ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
622 ** Number of open braces that must remain open at the end for the verification to succeed.
624 bool braces_match(string::const_iterator const & beg,
625 string::const_iterator const & end,
629 string::const_iterator it = beg;
630 LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
631 for (; it != end; ++it) {
632 // Skip escaped braces in the count
637 } else if (*it == '{') {
639 } else if (*it == '}') {
640 if (open_pars == 0) {
641 LYXERR(Debug::FIND, "Found unmatched closed brace");
647 if (open_pars != unmatched) {
648 LYXERR(Debug::FIND, "Found " << open_pars
649 << " instead of " << unmatched
650 << " unmatched open braces at the end of count");
653 LYXERR(Debug::FIND, "Braces match as expected");
657 /** The class performing a match between a position in the document and the FindAdvOptions.
659 class MatchStringAdv {
661 MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
663 /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
664 ** constructor as opt.search, under the opt.* options settings.
667 ** If set, then match is searched only against beginning of text starting at cur.
668 ** If unset, then match is searched anywhere in text starting at cur.
671 ** The length of the matching text, or zero if no match was found.
673 int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
678 /// first buffer on which search was started
679 lyx::Buffer * const p_first_buf;
681 FindAndReplaceOptions const & opt;
684 /// Auxiliary find method (does not account for opt.matchword)
685 int findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
687 /** Normalize a stringified or latexified LyX paragraph.
691 ** <li>if search is not casesensitive, then lowercase the string;
692 ** <li>remove any newline at begin or end of the string;
693 ** <li>replace any newline in the middle of the string with a simple space;
694 ** <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
697 ** @todo Normalization should also expand macros, if the corresponding
698 ** search option was checked.
700 string normalize(docstring const & s) const;
701 // normalized string to search
702 string par_as_string;
703 // regular expression to use for searching
705 // same as regexp, but prefixed with a ".*"
707 // unmatched open braces in the search string/regexp
709 // number of (.*?) subexpressions added at end of search regexp for closing
710 // environments, math mode, styles, etc...
715 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
716 : p_buf(&buf), p_first_buf(&buf), opt(opt)
718 par_as_string = normalize(opt.search);
723 // Remove trailing closure of math, macros and environments, so to catch parts of them.
725 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
726 if (regex_replace(par_as_string, par_as_string, "(.*)[[:blank:]]\\'", "$1"))
728 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\$\\'", "$1"))
730 // @todo need to account for open square braces as well ?
731 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\\\]\\'", "$1"))
733 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\end\\{[a-zA-Z_]*\\}\\'", "$1"))
735 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\}\\'", "$1")) {
741 LYXERR(Debug::FIND, "Open braces: " << open_braces);
742 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
744 par_as_string = escape_for_regex(par_as_string);
745 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
746 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
748 // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
749 regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
750 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
751 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
752 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
753 || regex_replace(par_as_string, par_as_string,
754 "(.*[^\\\\])(\\\\\\\\end\\\\\\{[a-zA-Z_]*\\\\\\})\\'", "$1(.*?)$2")
755 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
756 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
760 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
761 LYXERR(Debug::FIND, "Open braces: " << open_braces);
762 LYXERR(Debug::FIND, "Close .*? : " << close_wildcards);
763 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
764 // If entered regexp must match at begin of searched string buffer
765 regexp = lyx::regex(string("\\`") + par_as_string);
766 // If entered regexp may match wherever in searched string buffer
767 regexp2 = lyx::regex(string("\\`.*") + par_as_string);
772 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
774 docstring docstr = stringifyFromForSearch(opt, cur, len);
775 LYXERR(Debug::FIND, "Matching against '" << lyx::to_utf8(docstr) << "'");
776 string str = normalize(docstr);
777 LYXERR(Debug::FIND, "After normalization: '" << str << "'");
779 LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='" << par_as_string << "', str='" << str << "'");
781 LYXERR(Debug::FIND, "size=" << par_as_string.size() << ", substr='" << str.substr(0, par_as_string.size()) << "'");
782 if (str.substr(0, par_as_string.size()) == par_as_string)
783 return par_as_string.size();
785 string t = par_as_string;
786 while (regex_replace(t, t, "\\\\(emph|textbf|subsubsection|subsection|section|subparagraph|paragraph|part)\\{", "")
787 || regex_replace(t, t, "^\\$", "")
788 || regex_replace(t, t, "^\\\\\\[ ", ""))
789 LYXERR(Debug::FIND, " after removing leading $, \\[ , \\emph{, \\textbf{, etc.: " << t);
790 size_t pos = str.find(t);
791 if (pos != string::npos)
792 return par_as_string.size();
795 LYXERR(Debug::FIND, "Searching in regexp mode");
796 // Try all possible regexp matches,
797 //until one that verifies the braces match test is found
798 regex const *p_regexp = at_begin ? ®exp : ®exp2;
799 sregex_iterator re_it(str.begin(), str.end(), *p_regexp);
800 sregex_iterator re_it_end;
801 for (; re_it != re_it_end; ++re_it) {
802 match_results<string::const_iterator> const & m = *re_it;
803 // Check braces on the segment that matched the entire regexp expression,
804 // plus the last subexpression, if a (.*?) was inserted in the constructor.
805 if (!braces_match(m[0].first, m[0].second, open_braces))
807 // Check braces on segments that matched all (.*?) subexpressions.
808 for (size_t i = 1; i < m.size(); ++i)
809 if (!braces_match(m[i].first, m[i].second))
811 // Exclude from the returned match length any length
812 // due to close wildcards added at end of regexp
813 if (close_wildcards == 0)
814 return m[0].second - m[0].first;
816 return m[m.size() - close_wildcards].first - m[0].first;
823 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
825 int res = findAux(cur, len, at_begin);
826 if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
828 Paragraph const & par = cur.paragraph();
829 bool ws_left = cur.pos() > 0 ?
830 par.isWordSeparator(cur.pos() - 1) : true;
831 bool ws_right = cur.pos() + res < par.size() ?
832 par.isWordSeparator(cur.pos() + res) : true;
834 "cur.pos()=" << cur.pos() << ", res=" << res
835 << ", separ: " << ws_left << ", " << ws_right
837 if (ws_left && ws_right)
843 string MatchStringAdv::normalize(docstring const & s) const
846 if (! opt.casesensitive)
847 t = lyx::to_utf8(lowercase(s));
850 // Remove \n at begin
851 while (t.size() > 0 && t[0] == '\n')
854 while (t.size() > 0 && t[t.size() - 1] == '\n')
855 t = t.substr(0, t.size() - 1);
857 // Replace all other \n with spaces
858 while ((pos = t.find("\n")) != string::npos)
859 t.replace(pos, 1, " ");
860 // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
861 LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
862 while (regex_replace(t, t, "\\\\(emph|textbf|subsubsection|subsection|section|subparagraph|paragraph|part)(\\{\\})+", ""))
863 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
868 docstring stringifyFromCursor(DocIterator const & cur, int len)
870 LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
871 if (cur.inTexted()) {
872 Paragraph const & par = cur.paragraph();
873 // TODO what about searching beyond/across paragraph breaks ?
874 // TODO Try adding a AS_STR_INSERTS as last arg
875 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
876 int(par.size()) : cur.pos() + len;
877 OutputParams runparams(&cur.buffer()->params().encoding());
879 runparams.nice = true;
880 runparams.flavor = OutputParams::LATEX;
881 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
882 // No side effect of file copying and image conversion
883 runparams.dryrun = true;
884 LYXERR(Debug::FIND, "Stringifying with cur: "
885 << cur << ", from pos: " << cur.pos() << ", end: " << end);
886 return par.stringify(cur.pos(), end, AS_STR_INSETS, runparams);
887 } else if (cur.inMathed()) {
889 CursorSlice cs = cur.top();
890 MathData md = cs.cell();
891 MathData::const_iterator it_end =
892 ( ( len == -1 || cs.pos() + len > int(md.size()) )
893 ? md.end() : md.begin() + cs.pos() + len );
894 for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
898 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
903 /** Computes the LaTeX export of buf starting from cur and ending len positions
904 * after cur, if len is positive, or at the paragraph or innermost inset end
907 docstring latexifyFromCursor(DocIterator const & cur, int len)
909 LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
910 LYXERR(Debug::FIND, " with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
911 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
912 Buffer const & buf = *cur.buffer();
913 LASSERT(buf.isLatex(), /* */);
916 odocstringstream ods;
917 OutputParams runparams(&buf.params().encoding());
918 runparams.nice = false;
919 runparams.flavor = OutputParams::LATEX;
920 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
921 // No side effect of file copying and image conversion
922 runparams.dryrun = true;
924 if (cur.inTexted()) {
925 // @TODO what about searching beyond/across paragraph breaks ?
926 pos_type endpos = cur.paragraph().size();
927 if (len != -1 && endpos > cur.pos() + len)
928 endpos = cur.pos() + len;
929 TeXOnePar(buf, *cur.innerText(), cur.pit(), ods, texrow, runparams,
930 string(), cur.pos(), endpos);
931 LYXERR(Debug::FIND, "Latexified text: '" << lyx::to_utf8(ods.str()) << "'");
932 } else if (cur.inMathed()) {
933 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
934 for (int s = cur.depth() - 1; s >= 0; --s) {
935 CursorSlice const & cs = cur[s];
936 if (cs.asInsetMath() && cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
938 cs.asInsetMath()->asHullInset()->header_write(ws);
943 CursorSlice const & cs = cur.top();
944 MathData md = cs.cell();
945 MathData::const_iterator it_end = ( ( len == -1 || cs.pos() + len > int(md.size()) )
946 ? md.end() : md.begin() + cs.pos() + len );
947 for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
950 // Retrieve the math environment type, and add '$' or '$]'
951 // or others (\end{equation}) accordingly
952 for (int s = cur.depth() - 1; s >= 0; --s) {
953 CursorSlice const & cs = cur[s];
954 InsetMath * inset = cs.asInsetMath();
955 if (inset && inset->asHullInset()) {
957 inset->asHullInset()->footer_write(ws);
961 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
963 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
969 /** Finalize an advanced find operation, advancing the cursor to the innermost
970 ** position that matches, plus computing the length of the matching text to
973 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
975 // Search the foremost position that matches (avoids find of entire math
976 // inset when match at start of it)
978 DocIterator old_cur(cur.buffer());
980 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
984 } while (cur && cur.depth() > d && match(cur) > 0);
986 LASSERT(match(cur) > 0, /* */);
987 LYXERR(Debug::FIND, "Ok");
989 // Compute the match length
991 if (cur.pos() + len > cur.lastpos())
993 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
994 while (cur.pos() + len <= cur.lastpos() && match(cur, len) == 0) {
996 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
998 // Length of matched text (different from len param)
999 int old_len = match(cur, len);
1001 // Greedy behaviour while matching regexps
1002 while ((new_len = match(cur, len + 1)) > old_len) {
1005 LYXERR(Debug::FIND, "verifying match with len = " << len);
1012 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
1016 while (cur && !match(cur, -1, false)) {
1017 if (cur.pit() < cur.lastpit())
1023 for (; cur; cur.forwardPos()) {
1025 return findAdvFinalize(cur, match);
1031 /// Find the most backward consecutive match within same paragraph while searching backwards.
1032 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
1034 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
1035 DocIterator tmp_cur = cur;
1036 int len = findAdvFinalize(tmp_cur, match);
1037 Inset & inset = cur.inset();
1038 for (; cur != cur_begin; cur.backwardPos()) {
1039 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
1040 DocIterator new_cur = cur;
1041 new_cur.backwardPos();
1042 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
1044 int new_len = findAdvFinalize(new_cur, match);
1049 LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
1055 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match) {
1058 // Backup of original position
1059 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
1060 if (cur == cur_begin)
1063 DocIterator cur_orig(cur);
1065 bool pit_changed = false;
1066 found_match = false;
1069 found_match = match(cur, -1, false);
1073 cur.pos() = cur.lastpos();
1075 cur.pos() = cur_orig.pos();
1076 LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
1077 DocIterator cur_prev_iter;
1079 found_match = match(cur);
1080 LYXERR(Debug::FIND, "findBackAdv3: found_match="
1081 << found_match << ", cur: " << cur);
1083 return findMostBackwards(cur, match);
1085 // Stop if begin of document reached
1086 if (cur == cur_begin)
1088 cur_prev_iter = cur;
1092 if (cur == cur_begin)
1104 } // anonym namespace
1107 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
1108 DocIterator const & cur, int len)
1110 if (!opt.ignoreformat)
1111 return latexifyFromCursor(cur, len);
1113 return stringifyFromCursor(cur, len);
1117 FindAndReplaceOptions::FindAndReplaceOptions(docstring const & search, bool casesensitive,
1118 bool matchword, bool forward, bool expandmacros, bool ignoreformat,
1119 bool regexp, docstring const & replace, bool keep_case,
1121 : search(search), casesensitive(casesensitive), matchword(matchword),
1122 forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
1123 regexp(regexp), replace(replace), keep_case(keep_case), scope(scope)
1131 /** Check if 'len' letters following cursor are all non-lowercase */
1132 static bool allNonLowercase(DocIterator const & cur, int len) {
1133 pos_type end_pos = cur.pos() + len;
1134 for (pos_type pos = cur.pos(); pos != end_pos; ++pos)
1135 if (isLowerCase(cur.paragraph().getChar(pos)))
1141 /** Check if first letter is upper case and second one is lower case */
1142 static bool firstUppercase(DocIterator const & cur) {
1144 if (cur.pos() >= cur.lastpos() - 1) {
1145 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
1148 ch1 = cur.paragraph().getChar(cur.pos());
1149 ch2 = cur.paragraph().getChar(cur.pos()+1);
1150 bool result = isUpperCase(ch1) && isLowerCase(ch2);
1151 LYXERR(Debug::FIND, "firstUppercase(): "
1152 << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
1153 << ch2 << "(" << char(ch2) << ")"
1154 << ", result=" << result << ", cur=" << cur);
1159 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
1161 ** \fixme What to do with possible further paragraphs in replace buffer ?
1163 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case) {
1164 ParagraphList::iterator pit = buffer.paragraphs().begin();
1165 pos_type right = pos_type(1);
1166 pit->changeCase(buffer.params(), pos_type(0), right, first_case);
1167 right = pit->size() + 1;
1168 pit->changeCase(buffer.params(), right, right, others_case);
1173 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
1175 Cursor & cur = bv->cursor();
1176 if (opt.replace == docstring(from_utf8(LYX_FR_NULL_STRING)))
1178 DocIterator sel_beg = cur.selectionBegin();
1179 DocIterator sel_end = cur.selectionEnd();
1180 if (&sel_beg.inset() != &sel_end.inset()
1181 || sel_beg.pit() != sel_end.pit())
1183 int sel_len = sel_end.pos() - sel_beg.pos();
1184 LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
1185 << ", sel_len: " << sel_len << endl);
1188 LASSERT(sel_len > 0, /**/);
1190 if (!matchAdv(sel_beg, sel_len))
1193 string lyx = to_utf8(opt.replace);
1194 // FIXME: Seems so stupid to me to rebuild a buffer here,
1195 // when we already have one (replace_work_area_.buffer())
1196 Buffer repl_buffer("", false);
1197 repl_buffer.setUnnamed(true);
1198 LASSERT(repl_buffer.readString(lyx), /**/);
1199 if (opt.keep_case && sel_len >= 2) {
1200 if (cur.inTexted()) {
1201 if (firstUppercase(cur))
1202 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
1203 else if (allNonLowercase(cur, sel_len))
1204 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
1207 cap::cutSelection(cur, false, false);
1208 if (!cur.inMathed()) {
1209 repl_buffer.changeLanguage(
1210 repl_buffer.language(),
1211 cur.getFont().language());
1212 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
1213 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
1214 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
1215 repl_buffer.params().documentClassPtr(),
1216 bv->buffer().errorList("Paste"));
1217 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
1219 odocstringstream ods;
1220 OutputParams runparams(&repl_buffer.params().encoding());
1221 runparams.nice = false;
1222 runparams.flavor = OutputParams::LATEX;
1223 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
1224 runparams.dryrun = true;
1226 TeXOnePar(repl_buffer, repl_buffer.text(), 0, ods, texrow, runparams);
1227 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
1228 docstring repl_latex = ods.str();
1229 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
1231 regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
1232 regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
1233 repl_latex = from_utf8(s);
1234 LYXERR(Debug::FIND, "Replacing by niceInsert()ing latex: '" << repl_latex << "'");
1235 cur.niceInsert(repl_latex);
1237 cur.pos() -= repl_buffer.paragraphs().begin()->size();
1238 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << repl_buffer.paragraphs().begin()->size());
1239 bv->putSelectionAt(DocIterator(cur), repl_buffer.paragraphs().begin()->size(), !opt.forward);
1240 bv->processUpdateFlags(Update::Force);
1244 /// Perform a FindAdv operation.
1245 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
1250 if (opt.search.empty()) {
1251 bv->message(_("Search text is empty!"));
1256 MatchStringAdv matchAdv(bv->buffer(), opt);
1257 findAdvReplace(bv, opt, matchAdv);
1260 match_len = findForwardAdv(cur, matchAdv);
1262 match_len = findBackwardsAdv(cur, matchAdv);
1264 // This may only be raised by lyx::regex()
1265 bv->message(_("Invalid regular expression!"));
1269 if (match_len == 0) {
1270 bv->message(_("Match not found!"));
1274 bv->message(_("Match found!"));
1276 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
1277 bv->putSelectionAt(cur, match_len, !opt.forward);
1283 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
1285 os << to_utf8(opt.search) << "\nEOSS\n"
1286 << opt.casesensitive << ' '
1287 << opt.matchword << ' '
1288 << opt.forward << ' '
1289 << opt.expandmacros << ' '
1290 << opt.ignoreformat << ' '
1291 << opt.regexp << ' '
1292 << to_utf8(opt.replace) << "\nEOSS\n"
1293 << opt.keep_case << ' '
1296 LYXERR(Debug::FIND, "built: " << os.str());
1301 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
1303 LYXERR(Debug::FIND, "parsing");
1307 while (line != "EOSS") {
1311 if (is.eof()) // Tolerate malformed request
1315 LYXERR(Debug::FIND, "searching for: '" << s << "'");
1316 opt.search = from_utf8(s);
1317 is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.regexp;
1318 is.get(); // Waste space before replace string
1321 while (line != "EOSS") {
1325 if (is.eof()) // Tolerate malformed request
1329 is >> opt.keep_case;
1332 opt.scope = FindAndReplaceOptions::SearchScope(i);
1333 LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
1334 << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.regexp << ' ' << opt.keep_case);
1335 LYXERR(Debug::FIND, "replacing with: '" << s << "'");
1336 opt.replace = from_utf8(s);