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, bool>
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 bool 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 bool findForward(DocIterator & cur, MatchString const & match,
97 for (; cur; cur.forwardChar())
99 match(cur.paragraph(), cur.pos(), find_del))
105 bool findBackwards(DocIterator & cur, MatchString const & match,
106 bool find_del = true)
110 if (cur.inTexted() &&
111 match(cur.paragraph(), cur.pos(), find_del))
118 bool findChange(DocIterator & cur, bool next)
122 for (; cur; next ? cur.forwardPos() : cur.backwardPos())
123 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos())) {
125 // if we search backwards, take a step forward
126 // to correctly set the anchor
135 bool searchAllowed(docstring const & str)
138 frontend::Alert::error(_("Search error"), _("Search string is empty"));
145 bool findOne(BufferView * bv, docstring const & searchstr,
146 bool case_sens, bool whole, bool forward, bool find_del = true)
148 if (!searchAllowed(searchstr))
151 DocIterator cur = bv->cursor();
153 MatchString const match(searchstr, case_sens, whole);
155 bool found = forward ? findForward(cur, match, find_del) :
156 findBackwards(cur, match, find_del);
159 bv->putSelectionAt(cur, searchstr.length(), !forward);
165 int replaceAll(BufferView * bv,
166 docstring const & searchstr, docstring const & replacestr,
167 bool case_sens, bool whole)
169 Buffer & buf = bv->buffer();
171 if (!searchAllowed(searchstr) || buf.isReadonly())
174 DocIterator cur_orig(bv->cursor());
176 MatchString const match(searchstr, case_sens, whole);
179 int const rsize = replacestr.size();
180 int const ssize = searchstr.size();
183 cur.setCursor(doc_iterator_begin(&buf));
184 while (findForward(cur, match, false)) {
185 // Backup current cursor position and font.
186 pos_type const pos = cur.pos();
187 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
189 int striked = ssize - cur.paragraph().eraseChars(pos, pos + ssize,
190 buf.params().trackChanges);
191 cur.paragraph().insert(pos, replacestr, font,
192 Change(buf.params().trackChanges ?
193 Change::INSERTED : Change::UNCHANGED));
194 for (int i = 0; i < rsize + striked; ++i)
199 bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
203 cur_orig.fixIfBroken();
204 bv->setCursor(cur_orig);
210 // the idea here is that we are going to replace the string that
211 // is selected IF it is the search string.
212 // if there is a selection, but it is not the search string, then
213 // we basically ignore it. (FIXME We ought to replace only within
215 // if there is no selection, then:
216 // (i) if some search string has been provided, then we find it.
217 // (think of how the dialog works when you hit "replace" the
219 // (ii) if no search string has been provided, then we treat the
220 // word the cursor is in as the search string. (why? i have no
221 // idea.) but this only works in text?
223 // returns the number of replacements made (one, if any) and
224 // whether anything at all was done.
225 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
226 docstring const & replacestr, bool case_sens,
227 bool whole, bool forward)
229 Cursor & cur = bv->cursor();
230 if (!cur.selection()) {
231 // no selection, non-empty search string: find it
232 if (!searchstr.empty()) {
233 findOne(bv, searchstr, case_sens, whole, forward);
234 return pair<bool, int>(true, 0);
236 // empty search string
239 return pair<bool, int>(false, 0);
240 // select current word and treat it as the search string
241 cur.innerText()->selectWord(cur, WHOLE_WORD);
242 searchstr = cur.selectionAsString(false);
245 // if we still don't have a search string, report the error
247 if (!searchAllowed(searchstr))
248 return pair<bool, int>(false, 0);
250 bool have_selection = cur.selection();
251 docstring const selected = cur.selectionAsString(false);
253 case_sens ? searchstr == selected
254 : compare_no_case(searchstr, selected) == 0;
256 // no selection or current selection is not search word:
257 // just find the search word
258 if (!have_selection || !match) {
259 findOne(bv, searchstr, case_sens, whole, forward);
260 return pair<bool, int>(true, 0);
263 // we're now actually ready to replace. if the buffer is
264 // read-only, we can't, though.
265 if (bv->buffer().isReadonly())
266 return pair<bool, int>(false, 0);
268 cap::replaceSelectionWithString(cur, replacestr, forward);
269 bv->buffer().markDirty();
270 findOne(bv, searchstr, case_sens, whole, forward, false);
272 return pair<bool, int>(true, 1);
278 docstring const find2string(docstring const & search,
279 bool casesensitive, bool matchword, bool forward)
283 << int(casesensitive) << ' '
284 << int(matchword) << ' '
290 docstring const replace2string(docstring const & replace,
291 docstring const & search, bool casesensitive, bool matchword,
292 bool all, bool forward)
295 ss << replace << '\n'
297 << int(casesensitive) << ' '
298 << int(matchword) << ' '
305 bool lyxfind(BufferView * bv, FuncRequest const & ev)
307 if (!bv || ev.action() != LFUN_WORD_FIND)
310 //lyxerr << "find called, cmd: " << ev << endl;
312 // data is of the form
314 // <casesensitive> <matchword> <forward>"
316 docstring howto = split(ev.argument(), search, '\n');
318 bool casesensitive = parse_bool(howto);
319 bool matchword = parse_bool(howto);
320 bool forward = parse_bool(howto);
322 return findOne(bv, search, casesensitive, matchword, forward);
326 bool lyxreplace(BufferView * bv,
327 FuncRequest const & ev, bool has_deleted)
329 if (!bv || ev.action() != LFUN_WORD_REPLACE)
332 // data is of the form
335 // <casesensitive> <matchword> <all> <forward>"
338 docstring howto = split(ev.argument(), rplc, '\n');
339 howto = split(howto, search, '\n');
341 bool casesensitive = parse_bool(howto);
342 bool matchword = parse_bool(howto);
343 bool all = parse_bool(howto);
344 bool forward = parse_bool(howto);
346 int replace_count = 0;
351 replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
352 update = replace_count > 0;
355 replaceOne(bv, search, rplc, casesensitive, matchword, forward);
357 replace_count = rv.second;
360 Buffer const & buf = bv->buffer();
362 // emit message signal.
363 buf.message(_("String not found!"));
365 if (replace_count == 0) {
366 buf.message(_("String found."));
367 } else if (replace_count == 1) {
368 buf.message(_("String has been replaced."));
370 docstring const str =
371 bformat(_("%1$d strings have been replaced."), replace_count);
376 // if we have deleted characters, we do not replace at all, but
377 // rather search for the next occurence
378 if (findOne(bv, search, casesensitive, matchword, forward))
381 bv->message(_("String not found!"));
387 bool findNextChange(BufferView * bv)
389 return findChange(bv, true);
393 bool findPreviousChange(BufferView * bv)
395 return findChange(bv, false);
399 bool findChange(BufferView * bv, bool next)
401 if (bv->cursor().selection()) {
402 // set the cursor at the beginning or at the end of the selection
403 // before searching. Otherwise, the current change will be found.
404 if (next != (bv->cursor().top() > bv->cursor().normalAnchor()))
405 bv->cursor().setCursorToAnchor();
408 DocIterator cur = bv->cursor();
410 // Are we within a change ? Then first search forward (backward),
411 // clear the selection and search the other way around (see the end
412 // of this function). This will avoid changes to be selected half.
413 bool search_both_sides = false;
414 DocIterator tmpcur = cur;
416 while (tmpcur.inMathed())
418 Change change_next_pos
419 = tmpcur.paragraph().lookupChange(tmpcur.pos());
420 if (change_next_pos.changed() && cur.inMathed()) {
422 search_both_sides = true;
423 } else if (tmpcur.pos() > 0 && tmpcur.inTexted()) {
424 Change change_prev_pos
425 = tmpcur.paragraph().lookupChange(tmpcur.pos() - 1);
426 if (change_next_pos.isSimilarTo(change_prev_pos))
427 search_both_sides = true;
430 if (!findChange(cur, next))
433 bv->cursor().setCursor(cur);
434 bv->cursor().resetAnchor();
437 // take a step into the change
440 Change orig_change = cur.paragraph().lookupChange(cur.pos());
442 CursorSlice & tip = cur.top();
444 for (; !tip.at_end(); tip.forwardPos()) {
445 Change change = tip.paragraph().lookupChange(tip.pos());
446 if (!change.isSimilarTo(orig_change))
450 for (; !tip.at_begin();) {
452 Change change = tip.paragraph().lookupChange(tip.pos());
453 if (!change.isSimilarTo(orig_change)) {
454 // take a step forward to correctly set the selection
461 // Now put cursor to end of selection:
462 bv->cursor().setCursor(cur);
463 bv->cursor().setSelection();
465 if (search_both_sides) {
466 bv->cursor().setSelection(false);
467 findChange(bv, !next);
475 typedef vector<pair<string, string> > Escapes;
477 /// A map of symbols and their escaped equivalent needed within a regex.
478 Escapes const & get_regexp_escapes()
480 static Escapes escape_map;
481 if (escape_map.empty()) {
482 escape_map.push_back(pair<string, string>("\\", "\\\\"));
483 escape_map.push_back(pair<string, string>("^", "\\^"));
484 escape_map.push_back(pair<string, string>("$", "\\$"));
485 escape_map.push_back(pair<string, string>("{", "\\{"));
486 escape_map.push_back(pair<string, string>("}", "\\}"));
487 escape_map.push_back(pair<string, string>("[", "\\["));
488 escape_map.push_back(pair<string, string>("]", "\\]"));
489 escape_map.push_back(pair<string, string>("(", "\\("));
490 escape_map.push_back(pair<string, string>(")", "\\)"));
491 escape_map.push_back(pair<string, string>("+", "\\+"));
492 escape_map.push_back(pair<string, string>("*", "\\*"));
493 escape_map.push_back(pair<string, string>(".", "\\."));
498 /// A map of lyx escaped strings and their unescaped equivalent.
499 Escapes const & get_lyx_unescapes() {
500 static Escapes escape_map;
501 if (escape_map.empty()) {
502 escape_map.push_back(pair<string, string>("{*}", "*"));
503 escape_map.push_back(pair<string, string>("{[}", "["));
504 escape_map.push_back(pair<string, string>("\\$", "$"));
505 escape_map.push_back(pair<string, string>("\\backslash{}", "\\"));
506 escape_map.push_back(pair<string, string>("\\backslash", "\\"));
507 escape_map.push_back(pair<string, string>("\\sim ", "~"));
508 escape_map.push_back(pair<string, string>("\\^", "^"));
513 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
514 ** the found occurrence were escaped.
516 string apply_escapes(string s, Escapes const & escape_map)
518 LYXERR(Debug::FIND, "Escaping: '" << s << "'");
519 Escapes::const_iterator it;
520 for (it = escape_map.begin(); it != escape_map.end(); ++it) {
521 // LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
522 unsigned int pos = 0;
523 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
524 s.replace(pos, it->first.length(), it->second);
525 // LYXERR(Debug::FIND, "After escape: " << s);
526 pos += it->second.length();
527 // LYXERR(Debug::FIND, "pos: " << pos);
530 LYXERR(Debug::FIND, "Escaped : '" << s << "'");
534 /** Return the position of the closing brace matching the open one at s[pos],
535 ** or s.size() if not found.
537 size_t find_matching_brace(string const & s, size_t pos)
539 LASSERT(s[pos] == '{', /* */);
541 for (++pos; pos < s.size(); ++pos) {
544 else if (s[pos] == '{')
546 else if (s[pos] == '}') {
548 if (open_braces == 0)
555 /// Within \regexp{} apply get_regex_escapes(), while outside apply get_lyx_unescapes().
556 string escape_for_regex(string s)
559 while (pos < s.size()) {
560 size_t new_pos = s.find("\\regexp{{{", pos);
561 if (new_pos == string::npos)
563 LYXERR(Debug::FIND, "new_pos: " << new_pos);
564 string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
565 LYXERR(Debug::FIND, "t : " << t);
566 t = apply_escapes(t, get_regexp_escapes());
567 LYXERR(Debug::FIND, "t : " << t);
568 s.replace(pos, new_pos - pos, t);
569 new_pos = pos + t.size();
570 LYXERR(Debug::FIND, "Regexp after escaping: " << s);
571 LYXERR(Debug::FIND, "new_pos: " << new_pos);
572 if (new_pos == s.size())
574 size_t end_pos = s.find("}}}", new_pos + 10); // find_matching_brace(s, new_pos + 7);
575 LYXERR(Debug::FIND, "end_pos: " << end_pos);
576 t = apply_escapes(s.substr(new_pos + 10, end_pos - (new_pos + 10)), get_lyx_unescapes());
577 LYXERR(Debug::FIND, "t : " << t);
578 if (end_pos == s.size()) {
579 s.replace(new_pos, end_pos - new_pos, t);
581 LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
584 s.replace(new_pos, end_pos + 3 - new_pos, t);
585 LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
586 pos = new_pos + t.size();
587 LYXERR(Debug::FIND, "pos: " << pos);
592 /// Wrapper for lyx::regex_replace with simpler interface
593 bool regex_replace(string const & s, string & t, string const & searchstr,
594 string const & replacestr)
596 lyx::regex e(searchstr);
598 ostream_iterator<char, char> it(oss);
599 lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
600 // tolerate t and s be references to the same variable
601 bool rv = (s != oss.str());
606 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
608 ** Verify that closed braces exactly match open braces. This avoids that, for example,
609 ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
612 ** Number of open braces that must remain open at the end for the verification to succeed.
614 bool braces_match(string::const_iterator const & beg,
615 string::const_iterator const & end,
619 string::const_iterator it = beg;
620 LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
621 for (; it != end; ++it) {
622 // Skip escaped braces in the count
627 } else if (*it == '{') {
629 } else if (*it == '}') {
630 if (open_pars == 0) {
631 LYXERR(Debug::FIND, "Found unmatched closed brace");
637 if (open_pars != unmatched) {
638 LYXERR(Debug::FIND, "Found " << open_pars
639 << " instead of " << unmatched
640 << " unmatched open braces at the end of count");
643 LYXERR(Debug::FIND, "Braces match as expected");
647 /** The class performing a match between a position in the document and the FindAdvOptions.
649 class MatchStringAdv {
651 MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
653 /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
654 ** constructor as opt.search, under the opt.* options settings.
657 ** If set, then match is searched only against beginning of text starting at cur.
658 ** If unset, then match is searched anywhere in text starting at cur.
661 ** The length of the matching text, or zero if no match was found.
663 int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
668 /// first buffer on which search was started
669 lyx::Buffer * const p_first_buf;
671 FindAndReplaceOptions const & opt;
674 /// Auxiliary find method (does not account for opt.matchword)
675 int findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
677 /** Normalize a stringified or latexified LyX paragraph.
681 ** <li>if search is not casesensitive, then lowercase the string;
682 ** <li>remove any newline at begin or end of the string;
683 ** <li>replace any newline in the middle of the string with a simple space;
684 ** <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
687 ** @todo Normalization should also expand macros, if the corresponding
688 ** search option was checked.
690 string normalize(docstring const & s) const;
691 // normalized string to search
692 string par_as_string;
693 // regular expression to use for searching
695 // same as regexp, but prefixed with a ".*"
697 // unmatched open braces in the search string/regexp
699 // number of (.*?) subexpressions added at end of search regexp for closing
700 // environments, math mode, styles, etc...
705 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
706 : p_buf(&buf), p_first_buf(&buf), opt(opt)
708 par_as_string = normalize(opt.search);
713 // Remove trailing closure of math, macros and environments, so to catch parts of them.
715 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
716 if (regex_replace(par_as_string, par_as_string, "(.*)[[:blank:]]\\'", "$1"))
718 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\$\\'", "$1"))
720 // @todo need to account for open square braces as well ?
721 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\\\]\\'", "$1"))
723 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\end\\{[a-zA-Z_]*\\}\\'", "$1"))
725 if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\}\\'", "$1")) {
731 LYXERR(Debug::FIND, "Open braces: " << open_braces);
732 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
734 par_as_string = escape_for_regex(par_as_string);
735 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
736 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
738 // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
739 regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
740 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
741 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
742 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
743 || regex_replace(par_as_string, par_as_string,
744 "(.*[^\\\\])(\\\\\\\\end\\\\\\{[a-zA-Z_]*\\\\\\})\\'", "$1(.*?)$2")
745 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
746 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
750 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
751 LYXERR(Debug::FIND, "Open braces: " << open_braces);
752 LYXERR(Debug::FIND, "Close .*? : " << close_wildcards);
753 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
754 // If entered regexp must match at begin of searched string buffer
755 regexp = lyx::regex(string("\\`") + par_as_string);
756 // If entered regexp may match wherever in searched string buffer
757 regexp2 = lyx::regex(string("\\`.*") + par_as_string);
762 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
764 docstring docstr = stringifyFromForSearch(opt, cur, len);
765 LYXERR(Debug::FIND, "Matching against '" << lyx::to_utf8(docstr) << "'");
766 string str = normalize(docstr);
767 LYXERR(Debug::FIND, "After normalization: '" << str << "'");
769 LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='" << par_as_string << "', str='" << str << "'");
771 LYXERR(Debug::FIND, "size=" << par_as_string.size() << ", substr='" << str.substr(0, par_as_string.size()) << "'");
772 if (str.substr(0, par_as_string.size()) == par_as_string)
773 return par_as_string.size();
775 size_t pos = str.find(par_as_string);
776 if (pos != string::npos)
777 return par_as_string.size();
780 LYXERR(Debug::FIND, "Searching in regexp mode");
781 // Try all possible regexp matches,
782 //until one that verifies the braces match test is found
783 regex const *p_regexp = at_begin ? ®exp : ®exp2;
784 sregex_iterator re_it(str.begin(), str.end(), *p_regexp);
785 sregex_iterator re_it_end;
786 for (; re_it != re_it_end; ++re_it) {
787 match_results<string::const_iterator> const & m = *re_it;
788 // Check braces on the segment that matched the entire regexp expression,
789 // plus the last subexpression, if a (.*?) was inserted in the constructor.
790 if (! braces_match(m[0].first, m[0].second, open_braces))
792 // Check braces on segments that matched all (.*?) subexpressions.
793 for (size_t i = 1; i < m.size(); ++i)
794 if (! braces_match(m[i].first, m[i].second))
796 // Exclude from the returned match length any length
797 // due to close wildcards added at end of regexp
798 if (close_wildcards == 0)
799 return m[0].second - m[0].first;
801 return m[m.size() - close_wildcards].first - m[0].first;
808 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
810 int res = findAux(cur, len, at_begin);
811 if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
813 Paragraph const & par = cur.paragraph();
814 bool ws_left = cur.pos() > 0 ?
815 par.isWordSeparator(cur.pos() - 1) : true;
816 bool ws_right = cur.pos() + res < par.size() ?
817 par.isWordSeparator(cur.pos() + res) : true;
819 "cur.pos()=" << cur.pos() << ", res=" << res
820 << ", separ: " << ws_left << ", " << ws_right
822 if (ws_left && ws_right)
828 string MatchStringAdv::normalize(docstring const & s) const
831 if (! opt.casesensitive)
832 t = lyx::to_utf8(lowercase(s));
835 // Remove \n at begin
836 while (t.size() > 0 && t[0] == '\n')
839 while (t.size() > 0 && t[t.size() - 1] == '\n')
840 t = t.substr(0, t.size() - 1);
842 // Replace all other \n with spaces
843 while ((pos = t.find("\n")) != string::npos)
844 t.replace(pos, 1, " ");
845 // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
846 LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
847 while (regex_replace(t, t, "\\\\(emph|textbf|subsubsection|subsection|section|subparagraph|paragraph)(\\{\\})+", ""))
848 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
853 docstring stringifyFromCursor(DocIterator const & cur, int len)
855 LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
856 if (cur.inTexted()) {
857 Paragraph const & par = cur.paragraph();
858 // TODO what about searching beyond/across paragraph breaks ?
859 // TODO Try adding a AS_STR_INSERTS as last arg
860 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
861 int(par.size()) : cur.pos() + len;
862 OutputParams runparams(&cur.buffer()->params().encoding());
864 runparams.nice = true;
865 runparams.flavor = OutputParams::LATEX;
866 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
867 // No side effect of file copying and image conversion
868 runparams.dryrun = true;
869 LYXERR(Debug::FIND, "Stringifying with cur: "
870 << cur << ", from pos: " << cur.pos() << ", end: " << end);
871 return par.stringify(cur.pos(), end, AS_STR_INSETS, runparams);
872 } else if (cur.inMathed()) {
874 CursorSlice cs = cur.top();
875 MathData md = cs.cell();
876 MathData::const_iterator it_end =
877 ( ( len == -1 || cs.pos() + len > int(md.size()) )
878 ? md.end() : md.begin() + cs.pos() + len );
879 for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
883 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
888 /** Computes the LaTeX export of buf starting from cur and ending len positions
889 * after cur, if len is positive, or at the paragraph or innermost inset end
892 docstring latexifyFromCursor(DocIterator const & cur, int len)
894 LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
895 LYXERR(Debug::FIND, " with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
896 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
897 Buffer const & buf = *cur.buffer();
898 LASSERT(buf.isLatex(), /* */);
901 odocstringstream ods;
902 OutputParams runparams(&buf.params().encoding());
903 runparams.nice = false;
904 runparams.flavor = OutputParams::LATEX;
905 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
906 // No side effect of file copying and image conversion
907 runparams.dryrun = true;
909 if (cur.inTexted()) {
910 // @TODO what about searching beyond/across paragraph breaks ?
911 ParagraphList::const_iterator pit = cur.innerText()->paragraphs().begin();
912 for (int i = 0; i < cur.pit(); ++i)
914 pos_type const endpos = (len == -1 || cur.pos() + len > int(pit->size()))
915 ? pit->size() : cur.pos() + len;
916 TeXOnePar(buf, *cur.innerText(), pit, ods, texrow, runparams, string(),
918 LYXERR(Debug::FIND, "Latexified text: '" << lyx::to_utf8(ods.str()) << "'");
919 } else if (cur.inMathed()) {
920 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
921 for (int s = cur.depth() - 1; s >= 0; --s) {
922 CursorSlice const & cs = cur[s];
923 if (cs.asInsetMath() && cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
925 cs.asInsetMath()->asHullInset()->header_write(ws);
930 CursorSlice const & cs = cur.top();
931 MathData md = cs.cell();
932 MathData::const_iterator it_end = ( ( len == -1 || cs.pos() + len > int(md.size()) )
933 ? md.end() : md.begin() + cs.pos() + len );
934 for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
937 // Retrieve the math environment type, and add '$' or '$]'
938 // or others (\end{equation}) accordingly
939 for (int s = cur.depth() - 1; s >= 0; --s) {
940 CursorSlice const & cs = cur[s];
941 InsetMath * inset = cs.asInsetMath();
942 if (inset && inset->asHullInset()) {
944 inset->asHullInset()->footer_write(ws);
948 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
950 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
956 /** Finalize an advanced find operation, advancing the cursor to the innermost
957 ** position that matches, plus computing the length of the matching text to
960 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
962 // Search the foremost position that matches (avoids find of entire math
963 // inset when match at start of it)
965 DocIterator old_cur(cur.buffer());
967 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
971 } while (cur && cur.depth() > d && match(cur) > 0);
973 LASSERT(match(cur) > 0, /* */);
974 LYXERR(Debug::FIND, "Ok");
976 // Compute the match length
978 if (cur.pos() + len > cur.lastpos())
980 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
981 while (cur.pos() + len <= cur.lastpos() && match(cur, len) == 0) {
983 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
985 // Length of matched text (different from len param)
986 int old_len = match(cur, len);
988 // Greedy behaviour while matching regexps
989 while ((new_len = match(cur, len + 1)) > old_len) {
992 LYXERR(Debug::FIND, "verifying match with len = " << len);
999 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
1003 while (cur && !match(cur, -1, false)) {
1004 if (cur.pit() < cur.lastpit())
1010 for (; cur; cur.forwardPos()) {
1012 return findAdvFinalize(cur, match);
1018 /// Find the most backward consecutive match within same paragraph while searching backwards.
1019 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
1021 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
1022 DocIterator tmp_cur = cur;
1023 int len = findAdvFinalize(tmp_cur, match);
1024 Inset & inset = cur.inset();
1025 for (; cur != cur_begin; cur.backwardPos()) {
1026 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
1027 DocIterator new_cur = cur;
1028 new_cur.backwardPos();
1029 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
1031 int new_len = findAdvFinalize(new_cur, match);
1036 LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
1042 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match) {
1045 // Backup of original position
1046 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
1047 if (cur == cur_begin)
1050 DocIterator cur_orig(cur);
1052 bool pit_changed = false;
1053 found_match = false;
1056 found_match = match(cur, -1, false);
1060 cur.pos() = cur.lastpos();
1062 cur.pos() = cur_orig.pos();
1063 LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
1064 DocIterator cur_prev_iter;
1066 found_match = match(cur);
1067 LYXERR(Debug::FIND, "findBackAdv3: found_match="
1068 << found_match << ", cur: " << cur);
1070 return findMostBackwards(cur, match);
1072 // Stop if begin of document reached
1073 if (cur == cur_begin)
1075 cur_prev_iter = cur;
1079 if (cur == cur_begin)
1091 } // anonym namespace
1094 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
1095 DocIterator const & cur, int len)
1097 if (!opt.ignoreformat)
1098 return latexifyFromCursor(cur, len);
1100 return stringifyFromCursor(cur, len);
1104 FindAndReplaceOptions::FindAndReplaceOptions(docstring const & search, bool casesensitive,
1105 bool matchword, bool forward, bool expandmacros, bool ignoreformat,
1106 bool regexp, docstring const & replace, bool keep_case,
1108 : search(search), casesensitive(casesensitive), matchword(matchword),
1109 forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
1110 regexp(regexp), replace(replace), keep_case(keep_case), scope(scope)
1118 /** Check if 'len' letters following cursor are all non-lowercase */
1119 static bool allNonLowercase(DocIterator const & cur, int len) {
1120 pos_type end_pos = cur.pos() + len;
1121 for (pos_type pos = cur.pos(); pos != end_pos; ++pos)
1122 if (isLowerCase(cur.paragraph().getChar(pos)))
1128 /** Check if first letter is upper case and second one is lower case */
1129 static bool firstUppercase(DocIterator const & cur) {
1131 if (cur.pos() >= cur.lastpos() - 1) {
1132 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
1135 ch1 = cur.paragraph().getChar(cur.pos());
1136 ch2 = cur.paragraph().getChar(cur.pos()+1);
1137 bool result = isUpperCase(ch1) && isLowerCase(ch2);
1138 LYXERR(Debug::FIND, "firstUppercase(): "
1139 << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
1140 << ch2 << "(" << char(ch2) << ")"
1141 << ", result=" << result << ", cur=" << cur);
1146 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
1148 ** \fixme What to do with possible further paragraphs in replace buffer ?
1150 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case) {
1151 ParagraphList::iterator pit = buffer.paragraphs().begin();
1152 pos_type right = pos_type(1);
1153 pit->changeCase(buffer.params(), pos_type(0), right, first_case);
1154 right = pit->size() + 1;
1155 pit->changeCase(buffer.params(), right, right, others_case);
1160 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
1162 Cursor & cur = bv->cursor();
1163 if (opt.replace == docstring(from_utf8(LYX_FR_NULL_STRING)))
1165 DocIterator sel_beg = cur.selectionBegin();
1166 DocIterator sel_end = cur.selectionEnd();
1167 if (&sel_beg.inset() != &sel_end.inset()
1168 || sel_beg.pit() != sel_end.pit())
1170 int sel_len = sel_end.pos() - sel_beg.pos();
1171 LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
1172 << ", sel_len: " << sel_len << endl);
1175 LASSERT(sel_len > 0, /**/);
1177 if (!matchAdv(sel_beg, sel_len))
1180 string lyx = to_utf8(opt.replace);
1181 // FIXME: Seems so stupid to me to rebuild a buffer here,
1182 // when we already have one (replace_work_area_.buffer())
1183 Buffer repl_buffer("", false);
1184 repl_buffer.setUnnamed(true);
1185 LASSERT(repl_buffer.readString(lyx), /**/);
1186 repl_buffer.changeLanguage(
1187 repl_buffer.language(),
1188 cur.getFont().language());
1189 if (opt.keep_case && sel_len >= 2) {
1190 if (cur.inTexted()) {
1191 if (firstUppercase(cur))
1192 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
1193 else if (allNonLowercase(cur, sel_len))
1194 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
1197 cap::cutSelection(cur, false, false);
1198 if (!cur.inMathed()) {
1199 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
1200 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
1201 repl_buffer.params().documentClassPtr(),
1202 bv->buffer().errorList("Paste"));
1204 odocstringstream ods;
1205 OutputParams runparams(&repl_buffer.params().encoding());
1206 runparams.nice = false;
1207 runparams.flavor = OutputParams::LATEX;
1208 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
1209 runparams.dryrun = true;
1211 TeXOnePar(repl_buffer, repl_buffer.text(),
1212 repl_buffer.paragraphs().begin(), ods, texrow, runparams);
1213 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
1214 docstring repl_latex = ods.str();
1215 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
1217 regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
1218 regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
1219 repl_latex = from_utf8(s);
1220 LYXERR(Debug::FIND, "Replacing by niceInsert()ing latex: '" << repl_latex << "'");
1221 cur.niceInsert(repl_latex);
1223 bv->buffer().markDirty();
1224 cur.pos() -= repl_buffer.paragraphs().begin()->size();
1225 bv->putSelectionAt(DocIterator(cur), repl_buffer.paragraphs().begin()->size(), !opt.forward);
1226 bv->processUpdateFlags(Update::Force);
1230 /// Perform a FindAdv operation.
1231 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
1236 if (opt.search.empty()) {
1237 bv->message(_("Search text is empty!"));
1242 MatchStringAdv matchAdv(bv->buffer(), opt);
1243 findAdvReplace(bv, opt, matchAdv);
1246 match_len = findForwardAdv(cur, matchAdv);
1248 match_len = findBackwardsAdv(cur, matchAdv);
1250 // This may only be raised by lyx::regex()
1251 bv->message(_("Invalid regular expression!"));
1255 if (match_len == 0) {
1256 bv->message(_("Match not found!"));
1260 bv->message(_("Match found!"));
1262 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
1263 bv->putSelectionAt(cur, match_len, !opt.forward);
1269 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
1271 os << to_utf8(opt.search) << "\nEOSS\n"
1272 << opt.casesensitive << ' '
1273 << opt.matchword << ' '
1274 << opt.forward << ' '
1275 << opt.expandmacros << ' '
1276 << opt.ignoreformat << ' '
1277 << opt.regexp << ' '
1278 << to_utf8(opt.replace) << "\nEOSS\n"
1279 << opt.keep_case << ' '
1282 LYXERR(Debug::FIND, "built: " << os.str());
1287 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
1289 LYXERR(Debug::FIND, "parsing");
1293 while (line != "EOSS") {
1297 if (is.eof()) // Tolerate malformed request
1301 LYXERR(Debug::FIND, "searching for: '" << s << "'");
1302 opt.search = from_utf8(s);
1303 is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.regexp;
1304 is.get(); // Waste space before replace string
1307 while (line != "EOSS") {
1311 if (is.eof()) // Tolerate malformed request
1315 is >> opt.keep_case;
1318 opt.scope = FindAndReplaceOptions::SearchScope(i);
1319 LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
1320 << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.regexp << ' ' << opt.keep_case);
1321 LYXERR(Debug::FIND, "replacing with: '" << s << "'");
1322 opt.replace = from_utf8(s);