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/Application.h"
37 #include "frontends/alert.h"
39 #include "mathed/InsetMath.h"
40 #include "mathed/InsetMathGrid.h"
41 #include "mathed/InsetMathHull.h"
42 #include "mathed/MathData.h"
43 #include "mathed/MathStream.h"
44 #include "mathed/MathSupport.h"
46 #include "support/convert.h"
47 #include "support/debug.h"
48 #include "support/docstream.h"
49 #include "support/FileName.h"
50 #include "support/gettext.h"
51 #include "support/lassert.h"
52 #include "support/lstrings.h"
54 #include "support/regex.h"
58 using namespace lyx::support;
63 // Helper class for deciding what should be ignored
68 : ignoreFamily_(false), ignoreSeries_(false),
69 ignoreShape_(false), ignoreUnderline_(false),
70 ignoreMarkUp_(false), ignoreStrikeOut_(false),
71 ignoreSectioning_(false), ignoreFrontMatter_(true),
72 ignoreColor_(false), ignoreLanguage_(false) {}
74 bool getFamily() { return ignoreFamily_; };
76 bool getSeries() { return ignoreSeries_; };
78 bool getShape() { return ignoreShape_; };
80 bool getUnderline() { return ignoreUnderline_; };
82 bool getMarkUp() { return ignoreMarkUp_; };
84 bool getStrikeOut() { return ignoreStrikeOut_; };
86 bool getSectioning() { return ignoreSectioning_; };
88 bool getFrontMatter() { return ignoreFrontMatter_; };
90 bool getColor() { return ignoreColor_; };
92 bool getLanguage() { return ignoreLanguage_; };
94 void setIgnoreFormat(string type, bool value);
104 bool ignoreUnderline_;
108 bool ignoreStrikeOut_;
110 bool ignoreSectioning_;
112 bool ignoreFrontMatter_;
116 bool ignoreLanguage_;
120 void IgnoreFormats::setIgnoreFormat(string type, bool value)
122 if (type == "color") {
123 ignoreColor_ = value;
125 else if (type == "language") {
126 ignoreLanguage_ = value;
128 else if (type == "sectioning") {
129 ignoreSectioning_ = value;
130 ignoreFrontMatter_ = value;
132 else if (type == "font") {
133 ignoreSeries_ = value;
134 ignoreShape_ = value;
135 ignoreFamily_ = value;
137 else if (type == "series") {
138 ignoreSeries_ = value;
140 else if (type == "shape") {
141 ignoreShape_ = value;
143 else if (type == "family") {
144 ignoreFamily_ = value;
146 else if (type == "markup") {
147 ignoreMarkUp_ = value;
149 else if (type == "underline") {
150 ignoreUnderline_ = value;
152 else if (type == "strike") {
153 ignoreStrikeOut_ = value;
157 // The global variable that can be changed from outside
158 IgnoreFormats ignoreFormats;
161 void setIgnoreFormat(string type, bool value)
163 ignoreFormats.setIgnoreFormat(type, value);
169 bool parse_bool(docstring & howto)
174 howto = split(howto, var, ' ');
179 class MatchString : public binary_function<Paragraph, pos_type, int>
182 MatchString(docstring const & str, bool cs, bool mw)
183 : str(str), case_sens(cs), whole_words(mw)
186 // returns true if the specified string is at the specified position
187 // del specifies whether deleted strings in ct mode will be considered
188 int operator()(Paragraph const & par, pos_type pos, bool del = true) const
190 return par.find(str, case_sens, whole_words, pos, del);
198 // match whole words only
203 int findForward(DocIterator & cur, MatchString const & match,
204 bool find_del = true)
206 for (; cur; cur.forwardChar())
207 if (cur.inTexted()) {
208 int len = match(cur.paragraph(), cur.pos(), find_del);
216 int findBackwards(DocIterator & cur, MatchString const & match,
217 bool find_del = true)
221 if (cur.inTexted()) {
222 int len = match(cur.paragraph(), cur.pos(), find_del);
231 bool searchAllowed(docstring const & str)
234 frontend::Alert::error(_("Search error"), _("Search string is empty"));
241 bool findOne(BufferView * bv, docstring const & searchstr,
242 bool case_sens, bool whole, bool forward,
243 bool find_del = true, bool check_wrap = false)
245 if (!searchAllowed(searchstr))
248 DocIterator cur = forward
249 ? bv->cursor().selectionEnd()
250 : bv->cursor().selectionBegin();
252 MatchString const match(searchstr, case_sens, whole);
254 int match_len = forward
255 ? findForward(cur, match, find_del)
256 : findBackwards(cur, match, find_del);
259 bv->putSelectionAt(cur, match_len, !forward);
260 else if (check_wrap) {
261 DocIterator cur_orig(bv->cursor());
264 q = _("End of file reached while searching forward.\n"
265 "Continue searching from the beginning?");
267 q = _("Beginning of file reached while searching backward.\n"
268 "Continue searching from the end?");
269 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
270 q, 0, 1, _("&Yes"), _("&No"));
271 if (wrap_answer == 0) {
273 bv->cursor().clear();
274 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
276 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
277 bv->cursor().backwardPos();
279 bv->clearSelection();
280 if (findOne(bv, searchstr, case_sens, whole, forward, find_del, false))
283 bv->cursor().setCursor(cur_orig);
287 return match_len > 0;
291 int replaceAll(BufferView * bv,
292 docstring const & searchstr, docstring const & replacestr,
293 bool case_sens, bool whole)
295 Buffer & buf = bv->buffer();
297 if (!searchAllowed(searchstr) || buf.isReadonly())
300 DocIterator cur_orig(bv->cursor());
302 MatchString const match(searchstr, case_sens, whole);
305 int const rsize = replacestr.size();
306 int const ssize = searchstr.size();
309 cur.setCursor(doc_iterator_begin(&buf));
310 int match_len = findForward(cur, match, false);
311 while (match_len > 0) {
312 // Backup current cursor position and font.
313 pos_type const pos = cur.pos();
314 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
316 int striked = ssize -
317 cur.paragraph().eraseChars(pos, pos + match_len,
318 buf.params().track_changes);
319 cur.paragraph().insert(pos, replacestr, font,
320 Change(buf.params().track_changes
322 : Change::UNCHANGED));
323 for (int i = 0; i < rsize + striked; ++i)
326 match_len = findForward(cur, match, false);
329 bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
331 cur_orig.fixIfBroken();
332 bv->setCursor(cur_orig);
338 // the idea here is that we are going to replace the string that
339 // is selected IF it is the search string.
340 // if there is a selection, but it is not the search string, then
341 // we basically ignore it. (FIXME We ought to replace only within
343 // if there is no selection, then:
344 // (i) if some search string has been provided, then we find it.
345 // (think of how the dialog works when you hit "replace" the
347 // (ii) if no search string has been provided, then we treat the
348 // word the cursor is in as the search string. (why? i have no
349 // idea.) but this only works in text?
351 // returns the number of replacements made (one, if any) and
352 // whether anything at all was done.
353 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
354 docstring const & replacestr, bool case_sens,
355 bool whole, bool forward, bool findnext)
357 Cursor & cur = bv->cursor();
359 if (!cur.selection()) {
360 // no selection, non-empty search string: find it
361 if (!searchstr.empty()) {
362 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
363 return make_pair(found, 0);
365 // empty search string
368 return make_pair(false, 0);
369 // select current word and treat it as the search string.
370 // This causes a minor bug as undo will restore this selection,
371 // which the user did not create (#8986).
372 cur.innerText()->selectWord(cur, WHOLE_WORD);
373 searchstr = cur.selectionAsString(false);
376 // if we still don't have a search string, report the error
378 if (!searchAllowed(searchstr))
379 return make_pair(false, 0);
381 bool have_selection = cur.selection();
382 docstring const selected = cur.selectionAsString(false);
385 ? searchstr == selected
386 : compare_no_case(searchstr, selected) == 0;
388 // no selection or current selection is not search word:
389 // just find the search word
390 if (!have_selection || !match) {
391 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
392 return make_pair(found, 0);
395 // we're now actually ready to replace. if the buffer is
396 // read-only, we can't, though.
397 if (bv->buffer().isReadonly())
398 return make_pair(false, 0);
400 cap::replaceSelectionWithString(cur, replacestr);
402 cur.pos() += replacestr.length();
403 LASSERT(cur.pos() <= cur.lastpos(),
404 cur.pos() = cur.lastpos());
407 findOne(bv, searchstr, case_sens, whole, forward, false, findnext);
409 return make_pair(true, 1);
415 docstring const find2string(docstring const & search,
416 bool casesensitive, bool matchword, bool forward)
420 << int(casesensitive) << ' '
421 << int(matchword) << ' '
427 docstring const replace2string(docstring const & replace,
428 docstring const & search,
429 bool casesensitive, bool matchword,
430 bool all, bool forward, bool findnext)
433 ss << replace << '\n'
435 << int(casesensitive) << ' '
436 << int(matchword) << ' '
438 << int(forward) << ' '
444 bool lyxfind(BufferView * bv, FuncRequest const & ev)
446 if (!bv || ev.action() != LFUN_WORD_FIND)
449 //lyxerr << "find called, cmd: " << ev << endl;
451 // data is of the form
453 // <casesensitive> <matchword> <forward>"
455 docstring howto = split(ev.argument(), search, '\n');
457 bool casesensitive = parse_bool(howto);
458 bool matchword = parse_bool(howto);
459 bool forward = parse_bool(howto);
461 return findOne(bv, search, casesensitive, matchword, forward, true, true);
465 bool lyxreplace(BufferView * bv,
466 FuncRequest const & ev, bool has_deleted)
468 if (!bv || ev.action() != LFUN_WORD_REPLACE)
471 // data is of the form
474 // <casesensitive> <matchword> <all> <forward> <findnext>"
477 docstring howto = split(ev.argument(), rplc, '\n');
478 howto = split(howto, search, '\n');
480 bool casesensitive = parse_bool(howto);
481 bool matchword = parse_bool(howto);
482 bool all = parse_bool(howto);
483 bool forward = parse_bool(howto);
484 bool findnext = howto.empty() ? true : parse_bool(howto);
489 int replace_count = 0;
491 replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
492 update = replace_count > 0;
495 replaceOne(bv, search, rplc, casesensitive, matchword, forward, findnext);
497 replace_count = rv.second;
500 Buffer const & buf = bv->buffer();
502 // emit message signal.
503 buf.message(_("String not found."));
505 if (replace_count == 0) {
506 buf.message(_("String found."));
507 } else if (replace_count == 1) {
508 buf.message(_("String has been replaced."));
510 docstring const str =
511 bformat(_("%1$d strings have been replaced."), replace_count);
515 } else if (findnext) {
516 // if we have deleted characters, we do not replace at all, but
517 // rather search for the next occurence
518 if (findOne(bv, search, casesensitive, matchword, forward, true, findnext))
521 bv->message(_("String not found."));
527 bool findNextChange(BufferView * bv, Cursor & cur, bool const check_wrap)
529 for (; cur; cur.forwardPos())
530 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
534 DocIterator cur_orig(bv->cursor());
535 docstring q = _("End of file reached while searching forward.\n"
536 "Continue searching from the beginning?");
537 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
538 q, 0, 1, _("&Yes"), _("&No"));
539 if (wrap_answer == 0) {
540 bv->cursor().clear();
541 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
542 bv->clearSelection();
543 cur.setCursor(bv->cursor().selectionBegin());
544 if (findNextChange(bv, cur, false))
547 bv->cursor().setCursor(cur_orig);
554 bool findPreviousChange(BufferView * bv, Cursor & cur, bool const check_wrap)
556 for (cur.backwardPos(); cur; cur.backwardPos()) {
557 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
562 DocIterator cur_orig(bv->cursor());
563 docstring q = _("Beginning of file reached while searching backward.\n"
564 "Continue searching from the end?");
565 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
566 q, 0, 1, _("&Yes"), _("&No"));
567 if (wrap_answer == 0) {
568 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
569 bv->cursor().backwardPos();
570 bv->clearSelection();
571 cur.setCursor(bv->cursor().selectionBegin());
572 if (findPreviousChange(bv, cur, false))
575 bv->cursor().setCursor(cur_orig);
582 bool selectChange(Cursor & cur, bool forward)
584 if (!cur.inTexted() || !cur.paragraph().isChanged(cur.pos()))
586 Change ch = cur.paragraph().lookupChange(cur.pos());
588 CursorSlice tip1 = cur.top();
589 for (; tip1.pit() < tip1.lastpit() || tip1.pos() < tip1.lastpos(); tip1.forwardPos()) {
590 Change ch2 = tip1.paragraph().lookupChange(tip1.pos());
591 if (!ch2.isSimilarTo(ch))
594 CursorSlice tip2 = cur.top();
595 for (; tip2.pit() > 0 || tip2.pos() > 0;) {
597 Change ch2 = tip2.paragraph().lookupChange(tip2.pos());
598 if (!ch2.isSimilarTo(ch)) {
599 // take a step forward to correctly set the selection
607 cur.bv().mouseSetCursor(cur, false);
609 cur.bv().mouseSetCursor(cur, true);
617 bool findChange(BufferView * bv, bool forward)
620 cur.setCursor(forward ? bv->cursor().selectionEnd()
621 : bv->cursor().selectionBegin());
622 forward ? findNextChange(bv, cur, true) : findPreviousChange(bv, cur, true);
623 return selectChange(cur, forward);
628 bool findNextChange(BufferView * bv)
630 return findChange(bv, true);
634 bool findPreviousChange(BufferView * bv)
636 return findChange(bv, false);
643 typedef vector<pair<string, string> > Escapes;
645 /// A map of symbols and their escaped equivalent needed within a regex.
646 /// @note Beware of order
647 Escapes const & get_regexp_escapes()
649 typedef std::pair<std::string, std::string> P;
651 static Escapes escape_map;
652 if (escape_map.empty()) {
653 escape_map.push_back(P("$", "_x_$"));
654 escape_map.push_back(P("{", "_x_{"));
655 escape_map.push_back(P("}", "_x_}"));
656 escape_map.push_back(P("[", "_x_["));
657 escape_map.push_back(P("]", "_x_]"));
658 escape_map.push_back(P("(", "_x_("));
659 escape_map.push_back(P(")", "_x_)"));
660 escape_map.push_back(P("+", "_x_+"));
661 escape_map.push_back(P("*", "_x_*"));
662 escape_map.push_back(P(".", "_x_."));
663 escape_map.push_back(P("\\", "(?:\\\\|\\\\backslash)"));
664 escape_map.push_back(P("~", "(?:\\\\textasciitilde|\\\\sim)"));
665 escape_map.push_back(P("^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
666 escape_map.push_back(P("_x_", "\\"));
671 /// A map of lyx escaped strings and their unescaped equivalent.
672 Escapes const & get_lyx_unescapes()
674 typedef std::pair<std::string, std::string> P;
676 static Escapes escape_map;
677 if (escape_map.empty()) {
678 escape_map.push_back(P("\\%", "%"));
679 escape_map.push_back(P("\\mathcircumflex ", "^"));
680 escape_map.push_back(P("\\mathcircumflex", "^"));
681 escape_map.push_back(P("\\backslash ", "\\"));
682 escape_map.push_back(P("\\backslash", "\\"));
683 escape_map.push_back(P("\\\\{", "_x_<"));
684 escape_map.push_back(P("\\\\}", "_x_>"));
685 escape_map.push_back(P("\\sim ", "~"));
686 escape_map.push_back(P("\\sim", "~"));
691 /// A map of escapes turning a regexp matching text to one matching latex.
692 Escapes const & get_regexp_latex_escapes()
694 typedef std::pair<std::string, std::string> P;
696 static Escapes escape_map;
697 if (escape_map.empty()) {
698 escape_map.push_back(P("\\\\", "(?:\\\\\\\\|\\\\backslash|\\\\textbackslash\\{\\}|\\\\textbackslash)"));
699 escape_map.push_back(P("(<?!\\\\\\\\textbackslash)\\{", "\\\\\\{"));
700 escape_map.push_back(P("(<?!\\\\\\\\textbackslash\\\\\\{)\\}", "\\\\\\}"));
701 escape_map.push_back(P("\\[", "\\{\\[\\}"));
702 escape_map.push_back(P("\\]", "\\{\\]\\}"));
703 escape_map.push_back(P("\\^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
704 escape_map.push_back(P("%", "\\\\\\%"));
705 escape_map.push_back(P("#", "\\\\#"));
710 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
711 ** the found occurrence were escaped.
713 string apply_escapes(string s, Escapes const & escape_map)
715 LYXERR(Debug::FIND, "Escaping: '" << s << "'");
716 Escapes::const_iterator it;
717 for (it = escape_map.begin(); it != escape_map.end(); ++it) {
718 // LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
719 unsigned int pos = 0;
720 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
721 s.replace(pos, it->first.length(), it->second);
722 LYXERR(Debug::FIND, "After escape: " << s);
723 pos += it->second.length();
724 // LYXERR(Debug::FIND, "pos: " << pos);
727 LYXERR(Debug::FIND, "Escaped : '" << s << "'");
732 /// Within \regexp{} apply get_lyx_unescapes() only (i.e., preserve regexp semantics of the string),
733 /// while outside apply get_lyx_unescapes()+get_regexp_escapes().
734 /// If match_latex is true, then apply regexp_latex_escapes() to \regexp{} contents as well.
735 string escape_for_regex(string s, bool match_latex)
738 while (pos < s.size()) {
739 size_t new_pos = s.find("\\regexp{", pos);
740 if (new_pos == string::npos)
742 LYXERR(Debug::FIND, "new_pos: " << new_pos);
743 string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
744 LYXERR(Debug::FIND, "t [lyx]: " << t);
745 t = apply_escapes(t, get_regexp_escapes());
746 LYXERR(Debug::FIND, "t [rxp]: " << t);
747 s.replace(pos, new_pos - pos, t);
748 new_pos = pos + t.size();
749 LYXERR(Debug::FIND, "Regexp after escaping: " << s);
750 LYXERR(Debug::FIND, "new_pos: " << new_pos);
751 if (new_pos == s.size())
753 // Might fail if \\endregexp{} is preceeded by unexpected stuff (weird escapes)
754 size_t end_pos = s.find("\\endregexp{}}", new_pos + 8);
755 LYXERR(Debug::FIND, "end_pos: " << end_pos);
756 t = s.substr(new_pos + 8, end_pos - (new_pos + 8));
757 LYXERR(Debug::FIND, "t in regexp : " << t);
758 t = apply_escapes(t, get_lyx_unescapes());
759 LYXERR(Debug::FIND, "t in regexp [lyx]: " << t);
761 t = apply_escapes(t, get_regexp_latex_escapes());
762 LYXERR(Debug::FIND, "t in regexp [ltx]: " << t);
764 if (end_pos == s.size()) {
765 s.replace(new_pos, end_pos - new_pos, t);
766 LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
769 s.replace(new_pos, end_pos + 13 - new_pos, t);
770 LYXERR(Debug::FIND, "Regexp after \\regexp{...\\endregexp{}} removal: " << s);
771 pos = new_pos + t.size();
772 LYXERR(Debug::FIND, "pos: " << pos);
778 /// Wrapper for lyx::regex_replace with simpler interface
779 bool regex_replace(string const & s, string & t, string const & searchstr,
780 string const & replacestr)
782 lyx::regex e(searchstr, regex_constants::ECMAScript);
784 ostream_iterator<char, char> it(oss);
785 lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
786 // tolerate t and s be references to the same variable
787 bool rv = (s != oss.str());
793 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
795 ** Verify that closed braces exactly match open braces. This avoids that, for example,
796 ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
799 ** Number of open braces that must remain open at the end for the verification to succeed.
801 bool braces_match(string::const_iterator const & beg,
802 string::const_iterator const & end,
806 string::const_iterator it = beg;
807 LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
808 for (; it != end; ++it) {
809 // Skip escaped braces in the count
814 } else if (*it == '{') {
816 } else if (*it == '}') {
817 if (open_pars == 0) {
818 LYXERR(Debug::FIND, "Found unmatched closed brace");
824 if (open_pars != unmatched) {
825 LYXERR(Debug::FIND, "Found " << open_pars
826 << " instead of " << unmatched
827 << " unmatched open braces at the end of count");
830 LYXERR(Debug::FIND, "Braces match as expected");
835 /** The class performing a match between a position in the document and the FindAdvOptions.
837 class MatchStringAdv {
839 MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
841 /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
842 ** constructor as opt.search, under the opt.* options settings.
845 ** If set, then match is searched only against beginning of text starting at cur.
846 ** If unset, then match is searched anywhere in text starting at cur.
849 ** The length of the matching text, or zero if no match was found.
851 int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
856 /// first buffer on which search was started
857 lyx::Buffer * const p_first_buf;
859 FindAndReplaceOptions const & opt;
862 /// Auxiliary find method (does not account for opt.matchword)
863 int findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
865 /** Normalize a stringified or latexified LyX paragraph.
869 ** <li>if search is not casesensitive, then lowercase the string;
870 ** <li>remove any newline at begin or end of the string;
871 ** <li>replace any newline in the middle of the string with a simple space;
872 ** <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
875 ** @todo Normalization should also expand macros, if the corresponding
876 ** search option was checked.
878 string normalize(docstring const & s, bool hack_braces) const;
879 // normalized string to search
880 string par_as_string;
881 // regular expression to use for searching
883 // same as regexp, but prefixed with a ".*"
885 // leading format material as string
886 string lead_as_string;
887 // par_as_string after removal of lead_as_string
888 string par_as_string_nolead;
889 // unmatched open braces in the search string/regexp
891 // number of (.*?) subexpressions added at end of search regexp for closing
892 // environments, math mode, styles, etc...
894 // Are we searching with regular expressions ?
899 static docstring buffer_to_latex(Buffer & buffer)
901 OutputParams runparams(&buffer.params().encoding());
902 odocstringstream ods;
904 runparams.nice = true;
905 runparams.flavor = OutputParams::LATEX;
906 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
907 // No side effect of file copying and image conversion
908 runparams.dryrun = true;
909 runparams.for_search = true;
910 pit_type const endpit = buffer.paragraphs().size();
911 for (pit_type pit = 0; pit != endpit; ++pit) {
912 TeXOnePar(buffer, buffer.text(), pit, os, runparams);
913 LYXERR(Debug::FIND, "searchString up to here: " << ods.str());
919 static docstring stringifySearchBuffer(Buffer & buffer, FindAndReplaceOptions const & opt)
922 if (!opt.ignoreformat) {
923 str = buffer_to_latex(buffer);
925 OutputParams runparams(&buffer.params().encoding());
926 runparams.nice = true;
927 runparams.flavor = OutputParams::LATEX;
928 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
929 runparams.dryrun = true;
930 runparams.for_search = true;
931 for (pos_type pit = pos_type(0); pit < (pos_type)buffer.paragraphs().size(); ++pit) {
932 Paragraph const & par = buffer.paragraphs().at(pit);
933 LYXERR(Debug::FIND, "Adding to search string: '"
934 << par.asString(pos_type(0), par.size(),
935 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
938 str += par.asString(pos_type(0), par.size(),
939 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
947 /// Return separation pos between the leading material and the rest
948 static size_t identifyLeading(string const & s)
951 // @TODO Support \item[text]
952 // Kornel: Added textsl, textsf, textit, texttt and noun
953 // + allow to search for colored text too
954 while (regex_replace(t, t, REGEX_BOS "\\\\(((emph|noun|minisec|text(bf|md|sl|sf|it|tt))|((textcolor|foreignlanguage)\\{[a-z]+\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)\\{", "")
955 || regex_replace(t, t, REGEX_BOS "\\$", "")
956 || regex_replace(t, t, REGEX_BOS "\\\\\\[ ", "")
957 || regex_replace(t, t, REGEX_BOS " ?\\\\item\\{[a-z]+\\}", "")
958 || regex_replace(t, t, REGEX_BOS "\\\\begin\\{[a-zA-Z_]*\\*?\\} ", ""))
960 LYXERR(Debug::FIND, " after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
965 * Given a latexified string, retrieve some handled features
966 * The features of the regex will later be compared with the features
967 * of the searched text. If the regex features are not a
968 * subset of the analized, then, in not format ignoring search
969 * we can early stop the search in the relevant inset.
971 typedef map<string, bool> Features;
973 static Features identifyFeatures(string const & s)
975 static regex const feature("\\\\(([a-z]+(\\{([a-z]+)\\}|\\*)?))\\{");
976 static regex const valid("^(((emph|noun|text(bf|md|sl|sf|it|tt)|(textcolor|foreignlanguage|item)\\{[a-z]+\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)$");
981 for (sregex_iterator it(s.begin(), s.end(), feature), end; it != end; ++it) {
984 if (sub.str(1).compare("regexp") == 0) {
988 string token = sub.str(1);
990 if (regex_match(token, sub2, valid)) {
998 if (sub.str(1).compare("endregexp") == 0) {
1008 * defines values features of a key "\\[a-z]+{"
1015 isMain, /* for \\foreignlanguage */
1023 isIgnored /* to be ignored by creating infos */
1028 parenthesiscount(1),
1032 KeyInfo(KeyType type, int parcount, bool disable)
1034 parenthesiscount(parcount),
1043 int parenthesiscount;
1045 bool used; /* by pattern */
1050 Border(int l=0, int u=0) : low(l), upper(u) {};
1055 #define MAXOPENED 30
1057 bool isPatternString;
1059 Intervall(bool isPattern) : isPatternString(isPattern), ignoreidx(-1), actualdeptindex(0) { depts[0] = 0;};
1062 int depts[MAXOPENED];
1063 int closes[MAXOPENED];
1064 int actualdeptindex;
1065 Border borders[2*MAXOPENED];
1066 // int previousNotIgnored(int);
1067 int nextNotIgnored(int);
1068 void handleOpenP(int i);
1069 void handleCloseP(int i, bool closingAllowed);
1070 void resetOpenedP(int openPos);
1071 void addIntervall(int upper);
1072 void addIntervall(int low, int upper); /* if explicit */
1073 void setForDefaultLang(int upTo);
1074 int findclosing(int start, int end, char up, char down);
1075 void handleParentheses(int lastpos, bool closingAllowed);
1076 void output(ostringstream &os, int lastpos);
1077 // string show(int lastpos);
1080 void Intervall::setForDefaultLang(int upTo)
1082 // Enable the use of first token again
1083 if (ignoreidx >= 0) {
1084 if (borders[0].low < upTo)
1085 borders[0].low = upTo;
1086 if (borders[0].upper < upTo)
1087 borders[0].upper = upTo;
1091 static void checkDepthIndex(int val)
1093 static int maxdepthidx = MAXOPENED-2;
1094 if (val > maxdepthidx) {
1096 LYXERR0("maxdepthidx now " << val);
1100 static void checkIgnoreIdx(int val)
1102 static int maxignoreidx = 2*MAXOPENED - 4;
1103 if (val > maxignoreidx) {
1105 LYXERR0("maxignoreidx now " << val);
1110 * Expand the region of ignored parts of the input latex string
1111 * The region is only relevant in output()
1113 void Intervall::addIntervall(int low, int upper)
1116 if (low == upper) return;
1117 for (idx = ignoreidx+1; idx > 0; --idx) {
1118 if (low > borders[idx-1].upper) {
1122 Border br(low, upper);
1123 if (idx > ignoreidx) {
1126 checkIgnoreIdx(ignoreidx);
1130 // Expand only if one of the new bound is inside the interwall
1131 // We know here that br.low > borders[idx-1].upper
1132 if (br.upper < borders[idx].low) {
1133 // We have to insert at this pos
1134 for (int i = ignoreidx+1; i > idx; --i) {
1135 borders[i] = borders[i-1];
1139 checkIgnoreIdx(ignoreidx);
1142 // Here we know, that we are overlapping
1143 if (br.low > borders[idx].low)
1144 br.low = borders[idx].low;
1145 // check what has to be concatenated
1147 for (int i = idx; i <= ignoreidx; i++) {
1148 if (br.upper >= borders[i].low) {
1150 if (br.upper < borders[i].upper)
1151 br.upper = borders[i].upper;
1157 // count should be >= 1 here
1160 for (int i = idx + count; i <= ignoreidx; i++) {
1161 borders[i-count+1] = borders[i];
1163 ignoreidx -= count - 1;
1169 void Intervall::handleOpenP(int i)
1172 depts[actualdeptindex] = i+1;
1173 closes[actualdeptindex] = -1;
1174 checkDepthIndex(actualdeptindex);
1177 void Intervall::handleCloseP(int i, bool closingAllowed)
1179 if (actualdeptindex <= 0) {
1180 if (! closingAllowed)
1181 LYXERR(Debug::FIND, "Bad closing parenthesis in latex"); /* should not happen, but the latex input may be wrong */
1182 // if we are at the very end
1183 addIntervall(i, i+1);
1186 closes[actualdeptindex] = i+1;
1191 void Intervall::resetOpenedP(int openPos)
1193 // Used as initializer for foreignlanguage entry
1194 actualdeptindex = 1;
1195 depts[1] = openPos+1;
1200 int Intervall::previousNotIgnored(int start)
1202 int idx = 0; /* int intervalls */
1203 for (idx = ignoreidx; idx >= 0; --idx) {
1204 if (start > borders[idx].upper)
1206 if (start >= borders[idx].low)
1207 start = borders[idx].low-1;
1213 int Intervall::nextNotIgnored(int start)
1215 int idx = 0; /* int intervalls */
1216 for (idx = 0; idx <= ignoreidx; idx++) {
1217 if (start < borders[idx].low)
1219 if (start < borders[idx].upper)
1220 start = borders[idx].upper;
1225 typedef map<string, KeyInfo> KeysMap;
1226 typedef vector< KeyInfo> Entries;
1227 static KeysMap keys = map<string, KeyInfo>();
1234 void buildKeys(bool);
1235 void buildEntries(bool);
1236 void makeKey(const string &, KeyInfo, bool isPatternString);
1237 void processRegion(int start, int region_end); /* remove {} parts */
1238 void removeHead(KeyInfo&, int count=0);
1241 LatexInfo(string par, bool isPatternString) : interval(isPatternString) {
1243 buildKeys(isPatternString);
1244 entries = vector<KeyInfo>();
1245 buildEntries(isPatternString);
1249 if (entries.empty()) {
1256 if (int(entries.size()) > entidx) {
1263 bool setNextKey(int idx) {
1264 if ((idx == entidx) && (entidx >= 0)) {
1271 int process(ostringstream &os, KeyInfo &actual);
1272 int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1273 // string show(int lastpos) { return interval.show(lastpos);};
1274 int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1275 KeyInfo &getKeyInfo(int keyinfo) {
1276 static KeyInfo invalidInfo = KeyInfo();
1277 if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1280 return entries[keyinfo];
1282 void setForDefaultLang(int upTo) {interval.setForDefaultLang(upTo);};
1283 void addIntervall(int low, int up) { interval.addIntervall(low, up); };
1287 int Intervall::findclosing(int start, int end, char up = '{', char down = '}')
1291 for (int i = start; i < end; i += 1 + skip) {
1295 if (c == '\\') skip = 1;
1299 else if (c == down) {
1300 if (depth == 0) return i;
1316 vector<MathEntry> entries;
1321 void insert(string wait, size_t start, size_t end) {
1322 MathEntry m = MathEntry();
1324 m.mathStart = start;
1326 m.mathSize = end - start;
1327 entries.push_back(m);
1329 bool evaluating(size_t pos) {
1330 while (actualIdx < entries.size()) {
1331 if (pos < entries[actualIdx].mathStart)
1333 if (pos < entries[actualIdx].mathEnd)
1339 bool empty() { return entries.empty(); };
1340 size_t getEndPos() {
1341 if (entries.empty() || (actualIdx >= entries.size())) {
1344 return entries[actualIdx].mathEnd;
1346 size_t getStartPos() {
1347 if (entries.empty() || (actualIdx >= entries.size())) {
1348 return 100000; /* definitely enough? */
1350 return entries[actualIdx].mathStart;
1352 size_t getFirstPos() {
1354 return getStartPos();
1357 if (entries.empty() || (actualIdx >= entries.size())) {
1360 return entries[actualIdx].mathSize;
1362 void incrEntry() { actualIdx++; };
1365 void LatexInfo::buildEntries(bool isPatternString)
1367 static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1368 static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1369 static bool disableLanguageOverride = false;
1370 smatch sub, submath;
1371 bool evaluatingRegexp = false;
1373 bool evaluatingMath = false;
1375 bool math_end_waiting = false;
1376 size_t math_pos = 10000;
1379 for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1381 if (math_end_waiting) {
1382 size_t pos = submath.position(size_t(0));
1383 if ((math_end == "$") &&
1384 (submath.str(0) == "$") &&
1385 (interval.par[pos-1] != '\\')) {
1386 mi.insert("$", math_pos, pos + 1);
1387 math_end_waiting = false;
1389 else if ((math_end == "\\]") &&
1390 (submath.str(0) == "\\]")) {
1391 mi.insert("\\]", math_pos, pos + 2);
1392 math_end_waiting = false;
1394 else if ((submath.str(1).compare("end") == 0) &&
1395 (submath.str(2).compare(math_end) == 0)) {
1396 mi.insert(math_end, math_pos, pos + submath.str(0).length());
1397 math_end_waiting = false;
1403 if (submath.str(1).compare("begin") == 0) {
1404 math_end_waiting = true;
1405 math_end = submath.str(2);
1406 math_pos = submath.position(size_t(0));
1408 else if (submath.str(0).compare("\\[") == 0) {
1409 math_end_waiting = true;
1411 math_pos = submath.position(size_t(0));
1413 else if (submath.str(0) == "$") {
1414 size_t pos = submath.position(size_t(0));
1415 if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1416 math_end_waiting = true;
1423 // Ignore language if there is math somewhere in pattern-string
1424 if (isPatternString) {
1427 keys["foreignlanguage"].disabled = true;
1428 disableLanguageOverride = true;
1431 disableLanguageOverride = false;
1434 if (disableLanguageOverride) {
1435 keys["foreignlanguage"].disabled = true;
1438 math_pos = mi.getFirstPos();
1439 for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1441 string key = sub.str(3);
1443 if (sub.str(0)[0] == '\\')
1444 key = sub.str(0)[1];
1448 if (evaluatingRegexp) {
1449 if (sub.str(1).compare("endregexp") == 0) {
1450 evaluatingRegexp = false;
1451 // found._tokenstart already set
1452 found._dataEnd = sub.position(size_t(0)) + 13;
1453 found._dataStart = found._dataEnd;
1454 found._tokensize = found._dataEnd - found._tokenstart;
1455 found.parenthesiscount = 0;
1459 if (evaluatingMath) {
1460 if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1462 evaluatingMath = false;
1464 math_pos = mi.getStartPos();
1466 if (keys.find(key) == keys.end()) {
1467 LYXERR(Debug::FIND, "Found unknown key " << sub.str(0));
1471 if (key.compare("regexp") == 0) {
1472 evaluatingRegexp = true;
1473 found._tokenstart = sub.position(size_t(0));
1474 found._tokensize = 0;
1478 // Handle the other params of key
1479 if (found.keytype == KeyInfo::isIgnored)
1481 else if (found.keytype == KeyInfo::isMath) {
1482 if (size_t(sub.position(size_t(0))) == math_pos) {
1484 found._tokenstart = sub.position(size_t(0));
1485 found._tokensize = mi.getSize();
1486 found._dataEnd = found._tokenstart + found._tokensize;
1487 found._dataStart = found._dataEnd;
1488 found.parenthesiscount = 0;
1489 evaluatingMath = true;
1492 // begin|end of unknown env, discard
1493 // First handle tables
1494 // longtable|tabular
1495 bool discardComment;
1496 if ((sub.str(5).compare("longtable") == 0) ||
1497 (sub.str(5).compare("tabular") == 0)) {
1498 discardComment = true; /* '%' */
1501 discardComment = false;
1503 // discard spaces before pos(0)
1504 int pos = sub.position(size_t(0));
1506 for (count = 0; pos - count > 0; count++) {
1507 char c = interval.par[pos-count-1];
1508 if (discardComment) {
1509 if ((c != ' ') && (c != '%'))
1515 found.keytype = KeyInfo::doRemove;
1516 found._tokenstart = pos - count;
1517 if (sub.str(1).compare(0, 5, "begin") == 0) {
1518 size_t pos1 = pos + sub.str(0).length();
1519 if (sub.str(5).compare("cjk") == 0) {
1520 pos1 = interval.findclosing(pos1+1, interval.par.length()) + 1;
1521 if ((interval.par[pos1] == '{') && (interval.par[pos1+1] == '}'))
1523 found.keytype = KeyInfo::isMain;
1524 found._dataStart = pos1;
1525 found._dataEnd = interval.par.length();
1526 found.disabled = keys["foreignlanguage"].disabled;
1527 found.used = keys["foreignlanguage"].used;
1528 found._tokensize = pos1 - found._tokenstart;
1529 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1532 if (interval.par[pos1] == '[') {
1533 pos1 = interval.findclosing(pos1+1, interval.par.length(), '[', ']')+1;
1535 if (interval.par[pos1] == '{') {
1536 found._dataEnd = interval.findclosing(pos1+1, interval.par.length()) + 1;
1539 found._dataEnd = pos1;
1541 found._dataStart = found._dataEnd;
1542 found._tokensize = count + found._dataEnd - pos;
1543 found.parenthesiscount = 0;
1544 found.disabled = true;
1548 // Handle "\end{...}"
1549 found._dataStart = pos + sub.str(0).length();
1550 found._dataEnd = found._dataStart;
1551 found._tokensize = count + found._dataEnd - pos;
1552 found.parenthesiscount = 0;
1553 found.disabled = true;
1557 else if (found.keytype != KeyInfo::isRegex) {
1558 found._tokenstart = sub.position(size_t(0));
1559 if (found.parenthesiscount == 0) {
1560 // Probably to be discarded
1561 char following = interval.par[sub.position(size_t(0)) + sub.str(3).length() + 1];
1562 if (following == ' ')
1563 found.head = "\\" + sub.str(3) + " ";
1564 else if (following == '=') {
1565 // like \uldepth=1000pt
1566 found.head = sub.str(0);
1569 found.head = "\\" + key;
1570 found._tokensize = found.head.length();
1571 found._dataEnd = found._tokenstart + found._tokensize;
1572 found._dataStart = found._dataEnd;
1575 if (found.parenthesiscount == 1) {
1576 found.head = "\\" + key + "{";
1578 else if (found.parenthesiscount == 2) {
1579 found.head = sub.str(0) + "{";
1581 found._tokensize = found.head.length();
1582 found._dataStart = found._tokenstart + found.head.length();
1583 size_t endpos = interval.findclosing(found._dataStart, interval.par.length());
1584 if ((endpos == interval.par.length()) &&
1585 (found.keytype == KeyInfo::doRemove)) {
1586 // Missing closing => error in latex-input?
1587 // therefore do not delete remaining data
1588 found._dataStart -= 1;
1589 found._dataEnd = found._dataStart;
1592 found._dataEnd = endpos;
1593 if (isPatternString) {
1594 keys[key].used = true;
1598 entries.push_back(found);
1602 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1604 stringstream s(keysstring);
1606 const char delim = '|';
1607 while (getline(s, key, delim)) {
1608 KeyInfo keyII(keyI);
1609 if (isPatternString) {
1612 else if ( !keys[key].used)
1613 keyII.disabled = true;
1618 void LatexInfo::buildKeys(bool isPatternString)
1621 static bool keysBuilt = false;
1622 if (keysBuilt && !isPatternString) return;
1624 // Know standard keys with 1 parameter.
1625 // Split is done, if not at start of region
1626 makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1627 makeKey("textbf", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1628 makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1629 makeKey("uuline|uline|uwave", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1630 makeKey("emph|noun", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1631 makeKey("sout|xout", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1633 makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1634 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1635 makeKey("section*|subsection*|subsubsection*|paragraph*",
1636 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1637 makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1638 makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getFrontMatter()), isPatternString);
1640 makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1642 // Split is done, if not at start of region
1643 makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
1645 // Split is done always.
1646 makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
1650 makeKey("backslash|textbackslash|textasciicircum|textasciitilde|ldots", KeyInfo(KeyInfo::isChar, 1, false), isPatternString);
1651 // Found in fr/UserGuide.lyx
1652 makeKey("og|fg|textvisiblespace|lyx", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1653 makeKey("textquotedbl|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1655 // Known macros to remove (including their parameter)
1657 makeKey("inputencoding|shortcut|label|ref", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1659 // Macros to remove, but let the parameter survive
1661 makeKey("url|href|menuitem|footnote|code|index|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1663 // Same effect as previous, parameter will survive (because there is no one anyway)
1665 makeKey("noindent", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
1666 // Remove table decorations
1667 makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1668 // Discard shape-header
1669 makeKey("circlepar|diamondpar|heartpar|nutpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1670 makeKey("trianglerightpar|hexagonpar|starpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1671 makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1672 makeKey("triangleleftpar|shapepar|dropuppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1673 // like ('tiny{}' or '\tiny ' ... )
1674 makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, true), isPatternString);
1676 // Survives, like known character
1677 makeKey("lyx|latex|tex", KeyInfo(KeyInfo::isIgnored, 0, false), isPatternString);
1678 makeKey("item", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
1680 makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1681 makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1682 makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1684 makeKey("par|uldepth|ULdepth|protect", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1685 // Remove RTL/LTR marker
1686 makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1688 if (isPatternString) {
1689 // Allow the first searched string to rebuild the keys too
1693 // no need to rebuild again
1699 * Keep the list of actual opened parentheses actual
1700 * (e.g. depth == 4 means there are 4 '{' not processed yet)
1702 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
1705 for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
1709 if (c == '\\') skip = 1;
1710 else if (c == '{') {
1713 else if (c == '}') {
1714 handleCloseP(i, closingAllowed);
1720 string Intervall::show(int lastpos)
1722 int idx = 0; /* int intervalls */
1726 for (idx = 0; idx <= ignoreidx; idx++) {
1727 while (i < lastpos) {
1729 if (i <= borders[idx].low) {
1730 if (borders[idx].low > lastpos)
1731 printsize = lastpos - i;
1733 printsize = borders[idx].low - i;
1734 s += par.substr(i, printsize);
1736 if (i >= borders[idx].low)
1737 i = borders[idx].upper;
1740 i = borders[idx].upper;
1746 s += par.substr(i, lastpos-i);
1752 void Intervall::output(ostringstream &os, int lastpos)
1754 // get number of chars to output
1755 int idx = 0; /* int intervalls */
1757 for (idx = 0; idx <= ignoreidx; idx++) {
1760 if (i <= borders[idx].low) {
1761 if (borders[idx].low > lastpos)
1762 printsize = lastpos - i;
1764 printsize = borders[idx].low - i;
1765 os << par.substr(i, printsize);
1767 handleParentheses(i, false);
1768 if (i >= borders[idx].low)
1769 i = borders[idx].upper;
1772 i = borders[idx].upper;
1779 os << par.substr(i, lastpos-i);
1781 handleParentheses(lastpos, false);
1782 for (int i = actualdeptindex; i > 0; --i) {
1785 if (! isPatternString)
1787 handleParentheses(lastpos, true); /* extra closings '}' allowed here */
1790 void LatexInfo::processRegion(int start, int region_end)
1792 while (start < region_end) { /* Let {[} and {]} survive */
1793 if ((interval.par[start] == '{') &&
1794 (interval.par[start+1] != ']') &&
1795 (interval.par[start+1] != '[')) {
1796 // Closing is allowed past the region
1797 int closing = interval.findclosing(start+1, interval.par.length());
1798 interval.addIntervall(start, start+1);
1799 interval.addIntervall(closing, closing+1);
1801 start = interval.nextNotIgnored(start+1);
1805 void LatexInfo::removeHead(KeyInfo &actual, int count)
1807 if (actual.parenthesiscount == 0) {
1808 // "{\tiny{} ...}" ==> "{{} ...}"
1809 interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
1812 // Remove header hull, that is "\url{abcd}" ==> "abcd"
1813 interval.addIntervall(actual._tokenstart, actual._dataStart);
1814 interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
1818 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
1821 switch (actual.keytype)
1823 case KeyInfo::isChar: {
1824 nextKeyIdx = getNextKey();
1827 case KeyInfo::isSize: {
1828 if (actual.disabled) {
1830 processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
1831 interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1832 nextKeyIdx = getNextKey();
1834 // Split on this key if not at start
1835 int start = interval.nextNotIgnored(previousStart);
1836 if (start < actual._tokenstart) {
1837 interval.output(os, actual._tokenstart);
1838 interval.addIntervall(start, actual._tokenstart);
1840 // discard entry if at end of actual
1841 nextKeyIdx = process(os, actual);
1845 case KeyInfo::isStandard: {
1846 if (actual.disabled) {
1848 processRegion(actual._dataStart, actual._dataStart+1);
1849 nextKeyIdx = getNextKey();
1851 // Split on this key if not at start
1852 int start = interval.nextNotIgnored(previousStart);
1853 if (start < actual._tokenstart) {
1854 interval.output(os, actual._tokenstart);
1855 interval.addIntervall(start, actual._tokenstart);
1857 // discard entry if at end of actual
1858 nextKeyIdx = process(os, actual);
1862 case KeyInfo::doRemove: {
1863 // Remove the key with all parameters and following spaces
1865 for (pos = actual._dataEnd+1; pos < interval.par.length(); pos++) {
1866 if ((interval.par[pos] != ' ') && (interval.par[pos] != '%'))
1869 interval.addIntervall(actual._tokenstart, pos);
1870 nextKeyIdx = getNextKey();
1873 case KeyInfo::isList: {
1874 // Discard space before _tokenstart
1876 for (count = 0; count < actual._tokenstart; count++) {
1877 if (interval.par[actual._tokenstart-count-1] != ' ')
1880 if (actual.disabled) {
1881 interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
1884 interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1886 // Discard extra parentheses '[]'
1887 if (interval.par[actual._dataEnd+1] == '[') {
1888 int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
1889 if ((interval.par[actual._dataEnd+2] == '{') &&
1890 (interval.par[posdown-1] == '}')) {
1891 interval.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
1892 interval.addIntervall(posdown-1, posdown+1);
1895 interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
1896 interval.addIntervall(posdown, posdown+1);
1898 int blk = interval.nextNotIgnored(actual._dataEnd+1);
1899 if (blk > posdown) {
1900 // Discard at most 1 space after empty item
1902 for (count = 0; count < 1; count++) {
1903 if (interval.par[blk+count] != ' ')
1907 interval.addIntervall(blk, blk+count);
1910 nextKeyIdx = getNextKey();
1913 case KeyInfo::isSectioning: {
1914 // Discard spaces before _tokenstart
1916 for (count = 0; count < actual._tokenstart; count++) {
1917 if (interval.par[actual._tokenstart-count-1] != ' ')
1920 if (actual.disabled) {
1921 removeHead(actual, count);
1922 nextKeyIdx = getNextKey();
1924 interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1925 nextKeyIdx = process(os, actual);
1929 case KeyInfo::isMath: {
1930 // Same as regex, use the content unchanged
1931 nextKeyIdx = getNextKey();
1934 case KeyInfo::isRegex: {
1935 // DO NOT SPLIT ON REGEX
1937 nextKeyIdx = getNextKey();
1940 case KeyInfo::isIgnored: {
1941 // Treat like a character for now
1942 nextKeyIdx = getNextKey();
1945 case KeyInfo::isMain: {
1946 if (interval.par.substr(actual._dataStart, 2) == "% ")
1947 interval.addIntervall(actual._dataStart, actual._dataStart+2);
1948 if (actual.disabled) {
1950 if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
1951 (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
1952 // Discard also the space before math-equation
1953 interval.addIntervall(actual._dataStart, actual._dataStart+1);
1955 interval.resetOpenedP(actual._dataStart-1);
1958 if (actual._tokenstart == 0) {
1959 // for the first (and maybe dummy) language
1960 interval.setForDefaultLang(actual._tokenstart + actual._tokensize);
1962 interval.resetOpenedP(actual._dataStart-1);
1966 case KeyInfo::invalid:
1967 // This cannot happen, already handled
1970 // LYXERR0("Unhandled keytype");
1971 nextKeyIdx = getNextKey();
1978 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
1980 int end = interval.nextNotIgnored(actual._dataEnd);
1981 int oldStart = actual._dataStart;
1982 int nextKeyIdx = getNextKey();
1984 if ((nextKeyIdx < 0) ||
1985 (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
1986 (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
1987 if (oldStart <= end) {
1988 processRegion(oldStart, end);
1993 KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
1995 if (nextKey.keytype == KeyInfo::isMain) {
1996 (void) dispatch(os, actual._dataStart, nextKey);
1997 end = nextKey._tokenstart;
2000 processRegion(oldStart, nextKey._tokenstart);
2001 nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2003 oldStart = nextKey._dataEnd+1;
2005 // now nextKey is either invalid or is outside of actual._dataEnd
2006 // output the remaining and discard myself
2007 if (oldStart <= end) {
2008 processRegion(oldStart, end);
2010 if (interval.par[end] == '}') {
2012 // This is the normal case.
2013 // But if using the firstlanguage, the closing may be missing
2015 // get minimum of 'end' and 'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2017 if (actual._dataEnd < end)
2018 output_end = interval.nextNotIgnored(actual._dataEnd);
2020 output_end = interval.nextNotIgnored(end);
2021 if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2022 interval.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2024 if (interval.nextNotIgnored(actual._dataStart) < output_end)
2025 interval.output(os, output_end);
2026 interval.addIntervall(actual._tokenstart, end);
2030 string splitOnKnownMacros(string par, bool isPatternString) {
2032 LatexInfo li(par, isPatternString);
2033 KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2035 DummyKey._tokensize = 0;
2036 DummyKey._tokenstart = 0;
2037 DummyKey._dataStart = 0;
2038 DummyKey._dataEnd = par.length();
2039 DummyKey.disabled = true;
2040 int firstkeyIdx = li.getFirstKey();
2042 if (firstkeyIdx >= 0) {
2043 KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2045 if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2046 // Use dummy firstKey
2047 firstKey = DummyKey;
2048 (void) li.setNextKey(firstkeyIdx);
2051 if (par.substr(firstKey._dataStart, 2) == "% ")
2052 li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2054 nextkeyIdx = li.process(os, firstKey);
2055 while (nextkeyIdx >= 0) {
2056 // Check for a possible gap between the last
2057 // entry and this one
2058 int datastart = li.nextNotIgnored(firstKey._dataStart);
2059 KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2060 if ((nextKey._tokenstart > datastart)) {
2062 firstKey._dataStart = datastart;
2063 firstKey._dataEnd = par.length();
2064 (void) li.setNextKey(nextkeyIdx);
2065 if (firstKey._tokensize > 0) {
2066 // Fake the last opened parenthesis
2067 li.setForDefaultLang(firstKey._tokensize);
2069 nextkeyIdx = li.process(os, firstKey);
2072 if (nextKey.keytype != KeyInfo::isMain) {
2073 firstKey._dataStart = datastart;
2074 firstKey._dataEnd = nextKey._dataEnd+1;
2075 (void) li.setNextKey(nextkeyIdx);
2076 if (firstKey._tokensize > 0)
2077 li.setForDefaultLang(firstKey._tokensize);
2078 nextkeyIdx = li.process(os, firstKey);
2081 nextkeyIdx = li.process(os, nextKey);
2085 // Handle the remaining
2086 firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2087 firstKey._dataEnd = par.length();
2089 if ((firstKey._dataStart < firstKey._dataEnd) &&
2090 (par[firstKey._dataStart] != '}')) {
2091 if (firstKey._tokensize > 0)
2092 li.setForDefaultLang(firstKey._tokensize);
2093 (void) li.process(os, firstKey);
2097 // return string definitelly impossible to match
2098 s = "\\foreignlanguage{ignore}{ }";
2102 s = par; /* no known macros found */
2107 * Try to unify the language specs in the latexified text.
2108 * Resulting modified string is set to "", if
2109 * the searched tex does not contain all the features in the search pattern
2111 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2113 static Features regex_f;
2114 static int missed = 0;
2115 static bool regex_with_format = false;
2117 int parlen = par.length();
2119 while ((parlen > 0) && (par[parlen-1] == '\n')) {
2124 // Split the latex input into pieces which
2125 // can be digested by our search engine
2126 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2127 result = splitOnKnownMacros(par, isPatternString);
2128 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2131 result = par.substr(0, parlen);
2132 if (isPatternString) {
2135 regex_f = identifyFeatures(result);
2136 string features = "";
2137 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2138 string a = it->first;
2139 regex_with_format = true;
2140 features += " " + a;
2141 // LYXERR0("Identified regex format:" << a);
2143 LYXERR(Debug::FIND, "Identified Features" << features);
2146 } else if (regex_with_format) {
2147 Features info = identifyFeatures(result);
2148 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2149 string a = it->first;
2150 bool b = it->second;
2151 if (b && ! info[a]) {
2153 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2159 // LYXERR0("No regex formats");
2165 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2166 static int identifyClosing(string & t)
2168 int open_braces = 0;
2170 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2171 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2173 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2175 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2177 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2187 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2188 : p_buf(&buf), p_first_buf(&buf), opt(opt)
2190 Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2191 docstring const & ds = stringifySearchBuffer(find_buf, opt);
2192 use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2193 // When using regexp, braces are hacked already by escape_for_regex()
2194 par_as_string = normalize(ds, !use_regexp);
2196 close_wildcards = 0;
2198 size_t lead_size = 0;
2199 // correct the language settings
2200 par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2201 if (opt.ignoreformat) {
2203 // if par_as_string_nolead were emty,
2204 // the following call to findAux will always *find* the string
2205 // in the checked data, and thus always using the slow
2206 // examining of the current text part.
2207 par_as_string_nolead = par_as_string;
2210 lead_size = identifyLeading(par_as_string);
2211 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2212 lead_as_string = par_as_string.substr(0, lead_size);
2213 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2217 open_braces = identifyClosing(par_as_string);
2218 identifyClosing(par_as_string_nolead);
2219 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2220 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2222 string lead_as_regexp;
2223 if (lead_size > 0) {
2224 // @todo No need to search for \regexp{} insets in leading material
2225 lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2226 par_as_string = par_as_string_nolead;
2227 LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2228 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2230 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2231 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2232 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2234 // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2235 regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2236 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2237 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2238 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2239 || regex_replace(par_as_string, par_as_string,
2240 "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2241 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2242 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2246 if (!opt.ignoreformat) {
2247 // Remove extra '\}' at end
2248 while ( regex_replace(par_as_string, par_as_string, "(.*)\\\\}$", "$1")) {
2253 regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2254 // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2255 regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2256 // replace '[^...]' with '[^...\}\{\\]'
2257 regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2258 regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2259 regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2261 regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2264 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2265 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2266 LYXERR(Debug::FIND, "Close .*? : " << close_wildcards);
2267 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2269 // If entered regexp must match at begin of searched string buffer
2270 // Kornel: Added parentheses to use $1 for size of the leading string
2274 // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2275 // Unfortunately is '\1', '\2', etc not working for strings with extra format
2276 // so the convert has no effect in that case
2277 for (int i = 8; i > 0; --i) {
2278 string orig = "\\\\" + std::to_string(i);
2279 string dest = "\\" + std::to_string(i+1);
2280 while (regex_replace(par_as_string, par_as_string, orig, dest));
2282 regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2283 regexp2_str = "(" + lead_as_regexp + ").*" + par_as_string;
2285 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2286 regexp = lyx::regex(regexp_str);
2288 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2289 regexp2 = lyx::regex(regexp2_str);
2294 // Count number of characters in string
2298 // \\[a-zA-Z]+ ==> 1
2299 static int computeSize(string s, int len)
2305 for (int i = 0; i < len; i += skip, count++) {
2308 if (isalpha(s[i+1])) {
2309 for (int j = 2; i+j < len; j++) {
2310 if (! isalpha(s[i+j])) {
2313 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2315 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2323 else if (s[i] == '{') {
2329 else if (s[i] == '-') {
2330 if (s[i+1] == '-') {
2346 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2349 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2352 docstring docstr = stringifyFromForSearch(opt, cur, len);
2353 string str = normalize(docstr, true);
2354 if (!opt.ignoreformat) {
2355 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2357 if (str.empty()) return(-1);
2358 LYXERR(Debug::FIND, "Matching against '" << lyx::to_utf8(docstr) << "'");
2359 LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2362 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2363 regex const *p_regexp;
2364 regex_constants::match_flag_type flags;
2366 flags = regex_constants::match_continuous;
2369 flags = regex_constants::match_default;
2370 p_regexp = ®exp2;
2372 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2373 if (re_it == sregex_iterator())
2375 match_results<string::const_iterator> const & m = *re_it;
2377 if (0) { // Kornel Benko: DO NOT CHECKK
2378 // Check braces on the segment that matched the entire regexp expression,
2379 // plus the last subexpression, if a (.*?) was inserted in the constructor.
2380 if (!braces_match(m[0].first, m[0].second, open_braces))
2384 // Check braces on segments that matched all (.*?) subexpressions,
2385 // except the last "padding" one inserted by lyx.
2386 for (size_t i = 1; i < m.size() - 1; ++i)
2387 if (!braces_match(m[i].first, m[i].second, open_braces))
2390 // Exclude from the returned match length any length
2391 // due to close wildcards added at end of regexp
2392 // and also the length of the leading (e.g. '\emph{')
2394 // Whole found string, including the leading: m[0].second - m[0].first
2395 // Size of the leading string: m[1].second - m[1].first
2396 int leadingsize = 0;
2398 leadingsize = m[1].second - m[1].first;
2400 for (size_t i = 0; i < m.size(); i++) {
2401 LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2403 if (close_wildcards == 0)
2404 result = m[0].second - m[0].first;
2407 result = m[m.size() - close_wildcards].first - m[0].first;
2409 size_t pos = m.position(size_t(0));
2410 // Ignore last closing characters
2411 while (result > 0) {
2412 if (str[pos+result-1] == '}')
2417 if (result > leadingsize)
2418 result -= leadingsize;
2421 return computeSize(str.substr(pos+leadingsize,result), result);
2424 // else !use_regexp: but all code paths above return
2425 LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2426 << par_as_string << "', str='" << str << "'");
2427 LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2428 << lead_as_string << "', par_as_string_nolead='"
2429 << par_as_string_nolead << "'");
2432 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2433 << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2434 if (str.substr(0, par_as_string.size()) == par_as_string)
2435 return par_as_string.size();
2437 size_t pos = str.find(par_as_string_nolead);
2438 if (pos != string::npos)
2439 return par_as_string.size();
2445 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2447 int res = findAux(cur, len, at_begin);
2449 "res=" << res << ", at_begin=" << at_begin
2450 << ", matchword=" << opt.matchword
2451 << ", inTexted=" << cur.inTexted());
2452 if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2454 if ((len > 0) && (res < len))
2456 Paragraph const & par = cur.paragraph();
2457 bool ws_left = (cur.pos() > 0)
2458 ? par.isWordSeparator(cur.pos() - 1)
2460 bool ws_right = (cur.pos() + len < par.size())
2461 ? par.isWordSeparator(cur.pos() + len)
2464 "cur.pos()=" << cur.pos() << ", res=" << res
2465 << ", separ: " << ws_left << ", " << ws_right
2468 if (ws_left && ws_right) {
2469 // Check for word separators inside the found 'word'
2470 for (int i = 0; i < len; i++) {
2471 if (par.isWordSeparator(cur.pos() + i))
2480 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2483 if (! opt.casesensitive)
2484 t = lyx::to_utf8(lowercase(s));
2486 t = lyx::to_utf8(s);
2487 // Remove \n at begin
2488 while (!t.empty() && t[0] == '\n')
2491 while (!t.empty() && t[t.size() - 1] == '\n')
2492 t = t.substr(0, t.size() - 1);
2494 // Replace all other \n with spaces
2495 while ((pos = t.find("\n")) != string::npos)
2496 t.replace(pos, 1, " ");
2497 // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
2498 // Kornel: Added textsl, textsf, textit, texttt and noun
2499 // + allow to seach for colored text too
2500 LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
2501 while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
2502 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2503 while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
2504 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2506 while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
2507 // FIXME - check what preceeds the brace
2509 if (opt.ignoreformat)
2510 while (regex_replace(t, t, "\\{", "_x_<")
2511 || regex_replace(t, t, "\\}", "_x_>"))
2512 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2514 while (regex_replace(t, t, "\\\\\\{", "_x_<")
2515 || regex_replace(t, t, "\\\\\\}", "_x_>"))
2516 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2523 docstring stringifyFromCursor(DocIterator const & cur, int len)
2525 LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
2526 if (cur.inTexted()) {
2527 Paragraph const & par = cur.paragraph();
2528 // TODO what about searching beyond/across paragraph breaks ?
2529 // TODO Try adding a AS_STR_INSERTS as last arg
2530 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
2531 int(par.size()) : cur.pos() + len;
2532 OutputParams runparams(&cur.buffer()->params().encoding());
2533 runparams.nice = true;
2534 runparams.flavor = OutputParams::LATEX;
2535 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
2536 // No side effect of file copying and image conversion
2537 runparams.dryrun = true;
2538 LYXERR(Debug::FIND, "Stringifying with cur: "
2539 << cur << ", from pos: " << cur.pos() << ", end: " << end);
2540 return par.asString(cur.pos(), end,
2541 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
2543 } else if (cur.inMathed()) {
2544 CursorSlice cs = cur.top();
2545 MathData md = cs.cell();
2546 MathData::const_iterator it_end =
2547 (( len == -1 || cs.pos() + len > int(md.size()))
2549 : md.begin() + cs.pos() + len );
2551 for (MathData::const_iterator it = md.begin() + cs.pos();
2554 docstring s = asString(md2);
2555 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
2558 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2563 /** Computes the LaTeX export of buf starting from cur and ending len positions
2564 * after cur, if len is positive, or at the paragraph or innermost inset end
2567 docstring latexifyFromCursor(DocIterator const & cur, int len)
2569 LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
2570 LYXERR(Debug::FIND, " with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
2571 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
2572 Buffer const & buf = *cur.buffer();
2574 odocstringstream ods;
2576 OutputParams runparams(&buf.params().encoding());
2577 runparams.nice = false;
2578 runparams.flavor = OutputParams::LATEX;
2579 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2580 // No side effect of file copying and image conversion
2581 runparams.dryrun = true;
2582 runparams.for_search = true;
2584 if (cur.inTexted()) {
2585 // @TODO what about searching beyond/across paragraph breaks ?
2586 pos_type endpos = cur.paragraph().size();
2587 if (len != -1 && endpos > cur.pos() + len)
2588 endpos = cur.pos() + len;
2589 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
2590 string(), cur.pos(), endpos);
2591 string s = lyx::to_utf8(ods.str());
2592 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
2593 return(lyx::from_utf8(s));
2594 } else if (cur.inMathed()) {
2595 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
2596 for (int s = cur.depth() - 1; s >= 0; --s) {
2597 CursorSlice const & cs = cur[s];
2598 if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
2600 cs.asInsetMath()->asHullInset()->header_write(ws);
2605 CursorSlice const & cs = cur.top();
2606 MathData md = cs.cell();
2607 MathData::const_iterator it_end =
2608 ((len == -1 || cs.pos() + len > int(md.size()))
2610 : md.begin() + cs.pos() + len);
2612 for (MathData::const_iterator it = md.begin() + cs.pos();
2616 ods << asString(md2);
2617 // Retrieve the math environment type, and add '$' or '$]'
2618 // or others (\end{equation}) accordingly
2619 for (int s = cur.depth() - 1; s >= 0; --s) {
2620 CursorSlice const & cs2 = cur[s];
2621 InsetMath * inset = cs2.asInsetMath();
2622 if (inset && inset->asHullInset()) {
2624 inset->asHullInset()->footer_write(ws);
2628 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
2630 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2636 /** Finalize an advanced find operation, advancing the cursor to the innermost
2637 ** position that matches, plus computing the length of the matching text to
2640 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
2642 // Search the foremost position that matches (avoids find of entire math
2643 // inset when match at start of it)
2645 DocIterator old_cur(cur.buffer());
2647 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
2651 } while (cur && cur.depth() > d && match(cur) > 0);
2653 int max_match = match(cur); /* match valid only if not searching whole words */
2654 if (max_match <= 0) return 0;
2655 LYXERR(Debug::FIND, "Ok");
2657 // Compute the match length
2659 if (match.opt.matchword) {
2660 if (cur.pos() + len > cur.lastpos())
2662 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2663 while (cur.pos() + len <= cur.lastpos() && match(cur, len) <= 0) {
2665 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2667 // Length of matched text (different from len param)
2668 int old_match = match(cur, len);
2672 // Greedy behaviour while matching regexps
2673 while ((new_match = match(cur, len + 1)) > old_match) {
2675 old_match = new_match;
2676 LYXERR(Debug::FIND, "verifying match with len = " << len);
2683 int maxl = cur.lastpos() - cur.pos();
2684 // Greedy behaviour while matching regexps
2685 while (maxl > minl) {
2686 int actual_match = match(cur, len);
2687 if (actual_match == max_match) {
2689 len = (int)((maxl + minl)/2);
2691 else if (actual_match < max_match) {
2693 len = (int)((maxl + minl)/2);
2696 // cannot happen, but in case of
2698 max_match = actual_match;
2707 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
2711 while (!theApp()->longOperationCancelled() && cur) {
2712 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
2713 int match_len = match(cur, -1, false);
2714 LYXERR(Debug::FIND, "match_len: " << match_len);
2715 if (match_len > 0) {
2716 int match_len_zero_count = 0;
2717 for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
2718 LYXERR(Debug::FIND, "Advancing cur: " << cur);
2719 int match_len3 = match(cur, 1);
2722 int match_len2 = match(cur);
2723 LYXERR(Debug::FIND, "match_len2: " << match_len2);
2724 if (match_len2 > 0) {
2725 // Sometimes in finalize we understand it wasn't a match
2726 // and we need to continue the outest loop
2727 int len = findAdvFinalize(cur, match);
2732 if (match_len2 >= 0) {
2733 if (match_len2 == 0)
2734 match_len_zero_count++;
2736 match_len_zero_count = 0;
2739 if (++match_len_zero_count > 3) {
2740 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
2741 match_len_zero_count = 0;
2749 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
2750 LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
2753 // This should exit nested insets, if any, or otherwise undefine the currsor.
2754 cur.pos() = cur.lastpos();
2755 LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
2763 /// Find the most backward consecutive match within same paragraph while searching backwards.
2764 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
2766 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2767 DocIterator tmp_cur = cur;
2768 int len = findAdvFinalize(tmp_cur, match);
2769 Inset & inset = cur.inset();
2770 for (; cur != cur_begin; cur.backwardPos()) {
2771 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
2772 DocIterator new_cur = cur;
2773 new_cur.backwardPos();
2774 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
2776 int new_len = findAdvFinalize(new_cur, match);
2781 LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
2787 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
2791 // Backup of original position
2792 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2793 if (cur == cur_begin)
2796 DocIterator cur_orig(cur);
2797 bool pit_changed = false;
2800 bool found_match = match(cur, -1, false);
2804 cur.pos() = cur.lastpos();
2806 cur.pos() = cur_orig.pos();
2807 LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
2808 DocIterator cur_prev_iter;
2810 found_match = match(cur);
2811 LYXERR(Debug::FIND, "findBackAdv3: found_match="
2812 << found_match << ", cur: " << cur);
2814 return findMostBackwards(cur, match);
2816 // Stop if begin of document reached
2817 if (cur == cur_begin)
2819 cur_prev_iter = cur;
2823 if (cur == cur_begin)
2830 } while (!theApp()->longOperationCancelled());
2838 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
2839 DocIterator const & cur, int len)
2841 if (cur.pos() < 0 || cur.pos() > cur.lastpos())
2843 if (!opt.ignoreformat)
2844 return latexifyFromCursor(cur, len);
2846 return stringifyFromCursor(cur, len);
2850 FindAndReplaceOptions::FindAndReplaceOptions(
2851 docstring const & find_buf_name, bool casesensitive,
2852 bool matchword, bool forward, bool expandmacros, bool ignoreformat,
2853 docstring const & repl_buf_name, bool keep_case,
2854 SearchScope scope, SearchRestriction restr)
2855 : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
2856 forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
2857 repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
2865 /** Check if 'len' letters following cursor are all non-lowercase */
2866 static bool allNonLowercase(Cursor const & cur, int len)
2868 pos_type beg_pos = cur.selectionBegin().pos();
2869 pos_type end_pos = cur.selectionBegin().pos() + len;
2870 if (len > cur.lastpos() + 1 - beg_pos) {
2871 LYXERR(Debug::FIND, "This should not happen, more debug needed");
2872 len = cur.lastpos() + 1 - beg_pos;
2873 end_pos = beg_pos + len;
2875 for (pos_type pos = beg_pos; pos != end_pos; ++pos)
2876 if (isLowerCase(cur.paragraph().getChar(pos)))
2882 /** Check if first letter is upper case and second one is lower case */
2883 static bool firstUppercase(Cursor const & cur)
2886 pos_type pos = cur.selectionBegin().pos();
2887 if (pos >= cur.lastpos() - 1) {
2888 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
2891 ch1 = cur.paragraph().getChar(pos);
2892 ch2 = cur.paragraph().getChar(pos + 1);
2893 bool result = isUpperCase(ch1) && isLowerCase(ch2);
2894 LYXERR(Debug::FIND, "firstUppercase(): "
2895 << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
2896 << ch2 << "(" << char(ch2) << ")"
2897 << ", result=" << result << ", cur=" << cur);
2902 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
2904 ** \fixme What to do with possible further paragraphs in replace buffer ?
2906 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
2908 ParagraphList::iterator pit = buffer.paragraphs().begin();
2909 LASSERT(pit->size() >= 1, /**/);
2910 pos_type right = pos_type(1);
2911 pit->changeCase(buffer.params(), pos_type(0), right, first_case);
2912 right = pit->size();
2913 pit->changeCase(buffer.params(), pos_type(1), right, others_case);
2919 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
2921 Cursor & cur = bv->cursor();
2922 if (opt.repl_buf_name == docstring()
2923 || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
2924 || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2927 DocIterator sel_beg = cur.selectionBegin();
2928 DocIterator sel_end = cur.selectionEnd();
2929 if (&sel_beg.inset() != &sel_end.inset()
2930 || sel_beg.pit() != sel_end.pit()
2931 || sel_beg.idx() != sel_end.idx())
2933 int sel_len = sel_end.pos() - sel_beg.pos();
2934 LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
2935 << ", sel_len: " << sel_len << endl);
2938 LASSERT(sel_len > 0, return);
2940 if (!matchAdv(sel_beg, sel_len))
2943 // Build a copy of the replace buffer, adapted to the KeepCase option
2944 Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
2946 repl_buffer_orig.write(oss);
2947 string lyx = oss.str();
2948 Buffer repl_buffer("", false);
2949 repl_buffer.setUnnamed(true);
2950 LASSERT(repl_buffer.readString(lyx), return);
2951 if (opt.keep_case && sel_len >= 2) {
2952 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
2953 if (cur.inTexted()) {
2954 if (firstUppercase(cur))
2955 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
2956 else if (allNonLowercase(cur, sel_len))
2957 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
2960 cap::cutSelection(cur, false);
2961 if (cur.inTexted()) {
2962 repl_buffer.changeLanguage(
2963 repl_buffer.language(),
2964 cur.getFont().language());
2965 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
2966 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
2967 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
2968 repl_buffer.params().documentClassPtr(),
2969 bv->buffer().errorList("Paste"));
2970 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
2971 sel_len = repl_buffer.paragraphs().begin()->size();
2972 } else if (cur.inMathed()) {
2973 odocstringstream ods;
2975 OutputParams runparams(&repl_buffer.params().encoding());
2976 runparams.nice = false;
2977 runparams.flavor = OutputParams::LATEX;
2978 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2979 runparams.dryrun = true;
2980 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
2981 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
2982 docstring repl_latex = ods.str();
2983 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
2985 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
2986 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
2987 repl_latex = from_utf8(s);
2988 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
2989 MathData ar(cur.buffer());
2990 asArray(repl_latex, ar, Parse::NORMAL);
2992 sel_len = ar.size();
2993 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
2995 if (cur.pos() >= sel_len)
2996 cur.pos() -= sel_len;
2999 LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3000 bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3001 bv->processUpdateFlags(Update::Force);
3005 /// Perform a FindAdv operation.
3006 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3011 // e.g., when invoking word-findadv from mini-buffer wither with
3012 // wrong options syntax or before ever opening advanced F&R pane
3013 if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3017 MatchStringAdv matchAdv(bv->buffer(), opt);
3018 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3020 bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3021 findAdvReplace(bv, opt, matchAdv);
3024 match_len = findForwardAdv(cur, matchAdv);
3026 match_len = findBackwardsAdv(cur, matchAdv);
3028 // This may only be raised by lyx::regex()
3029 bv->message(_("Invalid regular expression!"));
3033 if (match_len == 0) {
3034 bv->message(_("Match not found!"));
3038 bv->message(_("Match found!"));
3040 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3041 bv->putSelectionAt(cur, match_len, !opt.forward);
3047 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3049 os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3050 << opt.casesensitive << ' '
3051 << opt.matchword << ' '
3052 << opt.forward << ' '
3053 << opt.expandmacros << ' '
3054 << opt.ignoreformat << ' '
3055 << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3056 << opt.keep_case << ' '
3057 << int(opt.scope) << ' '
3060 LYXERR(Debug::FIND, "built: " << os.str());
3066 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3068 LYXERR(Debug::FIND, "parsing");
3072 while (line != "EOSS") {
3076 if (is.eof()) // Tolerate malformed request
3080 LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3081 opt.find_buf_name = from_utf8(s);
3082 is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
3083 is.get(); // Waste space before replace string
3086 while (line != "EOSS") {
3090 if (is.eof()) // Tolerate malformed request
3094 LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3095 opt.repl_buf_name = from_utf8(s);
3096 is >> opt.keep_case;
3099 opt.scope = FindAndReplaceOptions::SearchScope(i);
3101 opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3103 LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3104 << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3105 << opt.scope << ' ' << opt.restr);