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 */
1016 noMain, /* to discard language in content */
1024 isIgnored /* to be ignored by creating infos */
1029 parenthesiscount(1),
1033 KeyInfo(KeyType type, int parcount, bool disable)
1035 parenthesiscount(parcount),
1044 int parenthesiscount;
1046 bool used; /* by pattern */
1051 Border(int l=0, int u=0) : low(l), upper(u) {};
1056 #define MAXOPENED 30
1058 bool isPatternString;
1060 Intervall(bool isPattern) : isPatternString(isPattern), ignoreidx(-1), actualdeptindex(0) { depts[0] = 0;};
1063 int depts[MAXOPENED];
1064 int closes[MAXOPENED];
1065 int actualdeptindex;
1066 Border borders[2*MAXOPENED];
1067 // int previousNotIgnored(int);
1068 int nextNotIgnored(int);
1069 void handleOpenP(int i);
1070 void handleCloseP(int i, bool closingAllowed);
1071 void resetOpenedP(int openPos);
1072 void addIntervall(int upper);
1073 void addIntervall(int low, int upper); /* if explicit */
1074 void setForDefaultLang(int upTo);
1075 int findclosing(int start, int end, char up, char down);
1076 void handleParentheses(int lastpos, bool closingAllowed);
1077 void output(ostringstream &os, int lastpos);
1078 // string show(int lastpos);
1081 void Intervall::setForDefaultLang(int upTo)
1083 // Enable the use of first token again
1084 if (ignoreidx >= 0) {
1085 if (borders[0].low < upTo)
1086 borders[0].low = upTo;
1087 if (borders[0].upper < upTo)
1088 borders[0].upper = upTo;
1092 static void checkDepthIndex(int val)
1094 static int maxdepthidx = MAXOPENED-2;
1095 if (val > maxdepthidx) {
1097 LYXERR0("maxdepthidx now " << val);
1101 static void checkIgnoreIdx(int val)
1103 static int maxignoreidx = 2*MAXOPENED - 4;
1104 if (val > maxignoreidx) {
1106 LYXERR0("maxignoreidx now " << val);
1111 * Expand the region of ignored parts of the input latex string
1112 * The region is only relevant in output()
1114 void Intervall::addIntervall(int low, int upper)
1117 if (low == upper) return;
1118 for (idx = ignoreidx+1; idx > 0; --idx) {
1119 if (low > borders[idx-1].upper) {
1123 Border br(low, upper);
1124 if (idx > ignoreidx) {
1127 checkIgnoreIdx(ignoreidx);
1131 // Expand only if one of the new bound is inside the interwall
1132 // We know here that br.low > borders[idx-1].upper
1133 if (br.upper < borders[idx].low) {
1134 // We have to insert at this pos
1135 for (int i = ignoreidx+1; i > idx; --i) {
1136 borders[i] = borders[i-1];
1140 checkIgnoreIdx(ignoreidx);
1143 // Here we know, that we are overlapping
1144 if (br.low > borders[idx].low)
1145 br.low = borders[idx].low;
1146 // check what has to be concatenated
1148 for (int i = idx; i <= ignoreidx; i++) {
1149 if (br.upper >= borders[i].low) {
1151 if (br.upper < borders[i].upper)
1152 br.upper = borders[i].upper;
1158 // count should be >= 1 here
1161 for (int i = idx + count; i <= ignoreidx; i++) {
1162 borders[i-count+1] = borders[i];
1164 ignoreidx -= count - 1;
1170 void Intervall::handleOpenP(int i)
1173 depts[actualdeptindex] = i+1;
1174 closes[actualdeptindex] = -1;
1175 checkDepthIndex(actualdeptindex);
1178 void Intervall::handleCloseP(int i, bool closingAllowed)
1180 if (actualdeptindex <= 0) {
1181 if (! closingAllowed)
1182 LYXERR(Debug::FIND, "Bad closing parenthesis in latex"); /* should not happen, but the latex input may be wrong */
1183 // if we are at the very end
1184 addIntervall(i, i+1);
1187 closes[actualdeptindex] = i+1;
1192 void Intervall::resetOpenedP(int openPos)
1194 // Used as initializer for foreignlanguage entry
1195 actualdeptindex = 1;
1196 depts[1] = openPos+1;
1201 int Intervall::previousNotIgnored(int start)
1203 int idx = 0; /* int intervalls */
1204 for (idx = ignoreidx; idx >= 0; --idx) {
1205 if (start > borders[idx].upper)
1207 if (start >= borders[idx].low)
1208 start = borders[idx].low-1;
1214 int Intervall::nextNotIgnored(int start)
1216 int idx = 0; /* int intervalls */
1217 for (idx = 0; idx <= ignoreidx; idx++) {
1218 if (start < borders[idx].low)
1220 if (start < borders[idx].upper)
1221 start = borders[idx].upper;
1226 typedef map<string, KeyInfo> KeysMap;
1227 typedef vector< KeyInfo> Entries;
1228 static KeysMap keys = map<string, KeyInfo>();
1235 void buildKeys(bool);
1236 void buildEntries(bool);
1237 void makeKey(const string &, KeyInfo, bool isPatternString);
1238 void processRegion(int start, int region_end); /* remove {} parts */
1239 void removeHead(KeyInfo&, int count=0);
1242 LatexInfo(string par, bool isPatternString) : interval(isPatternString) {
1244 buildKeys(isPatternString);
1245 entries = vector<KeyInfo>();
1246 buildEntries(isPatternString);
1250 if (entries.empty()) {
1257 if (int(entries.size()) > entidx) {
1264 bool setNextKey(int idx) {
1265 if ((idx == entidx) && (entidx >= 0)) {
1272 int process(ostringstream &os, KeyInfo &actual);
1273 int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1274 // string show(int lastpos) { return interval.show(lastpos);};
1275 int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1276 KeyInfo &getKeyInfo(int keyinfo) {
1277 static KeyInfo invalidInfo = KeyInfo();
1278 if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1281 return entries[keyinfo];
1283 void setForDefaultLang(int upTo) {interval.setForDefaultLang(upTo);};
1284 void addIntervall(int low, int up) { interval.addIntervall(low, up); };
1288 int Intervall::findclosing(int start, int end, char up = '{', char down = '}')
1292 for (int i = start; i < end; i += 1 + skip) {
1296 if (c == '\\') skip = 1;
1300 else if (c == down) {
1301 if (depth == 0) return i;
1317 vector<MathEntry> entries;
1322 void insert(string wait, size_t start, size_t end) {
1323 MathEntry m = MathEntry();
1325 m.mathStart = start;
1327 m.mathSize = end - start;
1328 entries.push_back(m);
1330 bool evaluating(size_t pos) {
1331 while (actualIdx < entries.size()) {
1332 if (pos < entries[actualIdx].mathStart)
1334 if (pos < entries[actualIdx].mathEnd)
1340 bool empty() { return entries.empty(); };
1341 size_t getEndPos() {
1342 if (entries.empty() || (actualIdx >= entries.size())) {
1345 return entries[actualIdx].mathEnd;
1347 size_t getStartPos() {
1348 if (entries.empty() || (actualIdx >= entries.size())) {
1349 return 100000; /* definitely enough? */
1351 return entries[actualIdx].mathStart;
1353 size_t getFirstPos() {
1355 return getStartPos();
1358 if (entries.empty() || (actualIdx >= entries.size())) {
1361 return entries[actualIdx].mathSize;
1363 void incrEntry() { actualIdx++; };
1366 void LatexInfo::buildEntries(bool isPatternString)
1368 static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1369 static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1370 static bool disableLanguageOverride = false;
1371 smatch sub, submath;
1372 bool evaluatingRegexp = false;
1374 bool evaluatingMath = false;
1375 bool evaluatingCode = false;
1379 bool math_end_waiting = false;
1380 size_t math_pos = 10000;
1383 for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1385 if (math_end_waiting) {
1386 size_t pos = submath.position(size_t(0));
1387 if ((math_end == "$") &&
1388 (submath.str(0) == "$") &&
1389 (interval.par[pos-1] != '\\')) {
1390 mi.insert("$", math_pos, pos + 1);
1391 math_end_waiting = false;
1393 else if ((math_end == "\\]") &&
1394 (submath.str(0) == "\\]")) {
1395 mi.insert("\\]", math_pos, pos + 2);
1396 math_end_waiting = false;
1398 else if ((submath.str(1).compare("end") == 0) &&
1399 (submath.str(2).compare(math_end) == 0)) {
1400 mi.insert(math_end, math_pos, pos + submath.str(0).length());
1401 math_end_waiting = false;
1407 if (submath.str(1).compare("begin") == 0) {
1408 math_end_waiting = true;
1409 math_end = submath.str(2);
1410 math_pos = submath.position(size_t(0));
1412 else if (submath.str(0).compare("\\[") == 0) {
1413 math_end_waiting = true;
1415 math_pos = submath.position(size_t(0));
1417 else if (submath.str(0) == "$") {
1418 size_t pos = submath.position(size_t(0));
1419 if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1420 math_end_waiting = true;
1427 // Ignore language if there is math somewhere in pattern-string
1428 if (isPatternString) {
1431 keys["foreignlanguage"].disabled = true;
1432 disableLanguageOverride = true;
1435 disableLanguageOverride = false;
1438 if (disableLanguageOverride) {
1439 keys["foreignlanguage"].disabled = true;
1442 math_pos = mi.getFirstPos();
1443 for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1445 string key = sub.str(3);
1447 if (sub.str(0)[0] == '\\')
1448 key = sub.str(0)[1];
1452 size_t k_pos = sub.position(size_t(0));
1453 if ((k_pos > 0) && (interval.par[k_pos - 1] == '\\')) {
1454 // Escaped '$', ignoring
1460 if (evaluatingRegexp) {
1461 if (sub.str(1).compare("endregexp") == 0) {
1462 evaluatingRegexp = false;
1463 // found._tokenstart already set
1464 found._dataEnd = sub.position(size_t(0)) + 13;
1465 found._dataStart = found._dataEnd;
1466 found._tokensize = found._dataEnd - found._tokenstart;
1467 found.parenthesiscount = 0;
1471 if (evaluatingMath) {
1472 if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1474 evaluatingMath = false;
1476 math_pos = mi.getStartPos();
1478 if (keys.find(key) == keys.end()) {
1479 LYXERR(Debug::FIND, "Found unknown key " << sub.str(0));
1483 if (key.compare("regexp") == 0) {
1484 evaluatingRegexp = true;
1485 found._tokenstart = sub.position(size_t(0));
1486 found._tokensize = 0;
1490 // Handle the other params of key
1491 if (found.keytype == KeyInfo::isIgnored)
1493 else if (found.keytype == KeyInfo::isMath) {
1494 if (size_t(sub.position(size_t(0))) == math_pos) {
1496 found._tokenstart = sub.position(size_t(0));
1497 found._tokensize = mi.getSize();
1498 found._dataEnd = found._tokenstart + found._tokensize;
1499 found._dataStart = found._dataEnd;
1500 found.parenthesiscount = 0;
1501 evaluatingMath = true;
1504 // begin|end of unknown env, discard
1505 // First handle tables
1506 // longtable|tabular
1507 bool discardComment;
1508 if ((sub.str(5).compare("longtable") == 0) ||
1509 (sub.str(5).compare("tabular") == 0)) {
1510 discardComment = true; /* '%' */
1513 discardComment = false;
1515 // discard spaces before pos(0)
1516 int pos = sub.position(size_t(0));
1518 for (count = 0; pos - count > 0; count++) {
1519 char c = interval.par[pos-count-1];
1520 if (discardComment) {
1521 if ((c != ' ') && (c != '%'))
1527 found.keytype = KeyInfo::doRemove;
1528 found._tokenstart = pos - count;
1529 if (sub.str(1).compare(0, 5, "begin") == 0) {
1530 size_t pos1 = pos + sub.str(0).length();
1531 if (sub.str(5).compare("cjk") == 0) {
1532 pos1 = interval.findclosing(pos1+1, interval.par.length()) + 1;
1533 if ((interval.par[pos1] == '{') && (interval.par[pos1+1] == '}'))
1535 found.keytype = KeyInfo::isMain;
1536 found._dataStart = pos1;
1537 found._dataEnd = interval.par.length();
1538 found.disabled = keys["foreignlanguage"].disabled;
1539 found.used = keys["foreignlanguage"].used;
1540 found._tokensize = pos1 - found._tokenstart;
1541 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1544 if (interval.par[pos1] == '[') {
1545 pos1 = interval.findclosing(pos1+1, interval.par.length(), '[', ']')+1;
1547 if (interval.par[pos1] == '{') {
1548 found._dataEnd = interval.findclosing(pos1+1, interval.par.length()) + 1;
1551 found._dataEnd = pos1;
1553 found._dataStart = found._dataEnd;
1554 found._tokensize = count + found._dataEnd - pos;
1555 found.parenthesiscount = 0;
1556 found.disabled = true;
1560 // Handle "\end{...}"
1561 found._dataStart = pos + sub.str(0).length();
1562 found._dataEnd = found._dataStart;
1563 found._tokensize = count + found._dataEnd - pos;
1564 found.parenthesiscount = 0;
1565 found.disabled = true;
1569 else if (found.keytype != KeyInfo::isRegex) {
1570 found._tokenstart = sub.position(size_t(0));
1571 if (found.parenthesiscount == 0) {
1572 // Probably to be discarded
1573 char following = interval.par[sub.position(size_t(0)) + sub.str(3).length() + 1];
1574 if (following == ' ')
1575 found.head = "\\" + sub.str(3) + " ";
1576 else if (following == '=') {
1577 // like \uldepth=1000pt
1578 found.head = sub.str(0);
1581 found.head = "\\" + key;
1582 found._tokensize = found.head.length();
1583 found._dataEnd = found._tokenstart + found._tokensize;
1584 found._dataStart = found._dataEnd;
1587 if (found.parenthesiscount == 1) {
1588 found.head = "\\" + key + "{";
1590 else if (found.parenthesiscount == 2) {
1591 found.head = sub.str(0) + "{";
1593 found._tokensize = found.head.length();
1594 found._dataStart = found._tokenstart + found.head.length();
1595 size_t endpos = interval.findclosing(found._dataStart, interval.par.length());
1596 if (found.keytype == KeyInfo::noMain) {
1597 evaluatingCode = true;
1599 codeStart = found._dataStart;
1601 else if (evaluatingCode) {
1602 if (size_t(found._dataStart) > codeEnd)
1603 evaluatingCode = false;
1604 else if (found.keytype == KeyInfo::isMain) {
1605 // Disable this key, treate it as standard
1606 found.keytype = KeyInfo::isStandard;
1607 found.disabled = true;
1608 if ((codeEnd == interval.par.length()) &&
1609 (found._tokenstart == codeStart)) {
1610 // trickery, because the code inset starts
1611 // with \selectlanguage ...
1613 if (entries.size() > 1) {
1614 entries[entries.size()-1]._dataEnd = codeEnd;
1619 if ((endpos == interval.par.length()) &&
1620 (found.keytype == KeyInfo::doRemove)) {
1621 // Missing closing => error in latex-input?
1622 // therefore do not delete remaining data
1623 found._dataStart -= 1;
1624 found._dataEnd = found._dataStart;
1627 found._dataEnd = endpos;
1628 if (isPatternString) {
1629 keys[key].used = true;
1633 entries.push_back(found);
1637 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1639 stringstream s(keysstring);
1641 const char delim = '|';
1642 while (getline(s, key, delim)) {
1643 KeyInfo keyII(keyI);
1644 if (isPatternString) {
1647 else if ( !keys[key].used)
1648 keyII.disabled = true;
1653 void LatexInfo::buildKeys(bool isPatternString)
1656 static bool keysBuilt = false;
1657 if (keysBuilt && !isPatternString) return;
1659 // Known standard keys with 1 parameter.
1660 // Split is done, if not at start of region
1661 makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1662 makeKey("textbf", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1663 makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1664 makeKey("uuline|uline|uwave", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1665 makeKey("emph|noun", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1666 makeKey("sout|xout", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1668 makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1669 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1670 makeKey("section*|subsection*|subsubsection*|paragraph*",
1671 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1672 makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1673 makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getFrontMatter()), isPatternString);
1675 makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1677 // Split is done, if not at start of region
1678 makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
1680 // Split is done always.
1681 makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
1685 makeKey("backslash|textbackslash|textasciicircum|textasciitilde|ldots", KeyInfo(KeyInfo::isChar, 1, false), isPatternString);
1686 // Found in fr/UserGuide.lyx
1687 makeKey("og|fg|textvisiblespace|lyx", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1688 makeKey("textquotedbl|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1690 // Known macros to remove (including their parameter)
1692 makeKey("inputencoding|shortcut|label|ref", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1694 // handle like standard keys with 1 parameter.
1695 makeKey("url|href", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
1697 // Macros to remove, but let the parameter survive
1699 makeKey("menuitem|index|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1701 // Remove language spec from content of these insets
1702 makeKey("code|footnote", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
1704 // Same effect as previous, parameter will survive (because there is no one anyway)
1706 makeKey("noindent", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
1707 // Remove table decorations
1708 makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1709 // Discard shape-header
1710 makeKey("circlepar|diamondpar|heartpar|nutpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1711 makeKey("trianglerightpar|hexagonpar|starpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1712 makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1713 makeKey("triangleleftpar|shapepar|dropuppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1714 // like ('tiny{}' or '\tiny ' ... )
1715 makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, true), isPatternString);
1717 // Survives, like known character
1718 makeKey("lyx|latex|tex", KeyInfo(KeyInfo::isIgnored, 0, false), isPatternString);
1719 makeKey("item", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
1721 makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1722 makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1723 makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
1725 makeKey("par|uldepth|ULdepth|protect", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1726 // Remove RTL/LTR marker
1727 makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
1729 if (isPatternString) {
1730 // Allow the first searched string to rebuild the keys too
1734 // no need to rebuild again
1740 * Keep the list of actual opened parentheses actual
1741 * (e.g. depth == 4 means there are 4 '{' not processed yet)
1743 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
1746 for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
1750 if (c == '\\') skip = 1;
1751 else if (c == '{') {
1754 else if (c == '}') {
1755 handleCloseP(i, closingAllowed);
1761 string Intervall::show(int lastpos)
1763 int idx = 0; /* int intervalls */
1767 for (idx = 0; idx <= ignoreidx; idx++) {
1768 while (i < lastpos) {
1770 if (i <= borders[idx].low) {
1771 if (borders[idx].low > lastpos)
1772 printsize = lastpos - i;
1774 printsize = borders[idx].low - i;
1775 s += par.substr(i, printsize);
1777 if (i >= borders[idx].low)
1778 i = borders[idx].upper;
1781 i = borders[idx].upper;
1787 s += par.substr(i, lastpos-i);
1793 void Intervall::output(ostringstream &os, int lastpos)
1795 // get number of chars to output
1796 int idx = 0; /* int intervalls */
1798 for (idx = 0; idx <= ignoreidx; idx++) {
1801 if (i <= borders[idx].low) {
1802 if (borders[idx].low > lastpos)
1803 printsize = lastpos - i;
1805 printsize = borders[idx].low - i;
1806 os << par.substr(i, printsize);
1808 handleParentheses(i, false);
1809 if (i >= borders[idx].low)
1810 i = borders[idx].upper;
1813 i = borders[idx].upper;
1820 os << par.substr(i, lastpos-i);
1822 handleParentheses(lastpos, false);
1823 for (int i = actualdeptindex; i > 0; --i) {
1826 if (! isPatternString)
1828 handleParentheses(lastpos, true); /* extra closings '}' allowed here */
1831 void LatexInfo::processRegion(int start, int region_end)
1833 while (start < region_end) { /* Let {[} and {]} survive */
1834 if ((interval.par[start] == '{') &&
1835 (interval.par[start+1] != ']') &&
1836 (interval.par[start+1] != '[')) {
1837 // Closing is allowed past the region
1838 int closing = interval.findclosing(start+1, interval.par.length());
1839 interval.addIntervall(start, start+1);
1840 interval.addIntervall(closing, closing+1);
1842 start = interval.nextNotIgnored(start+1);
1846 void LatexInfo::removeHead(KeyInfo &actual, int count)
1848 if (actual.parenthesiscount == 0) {
1849 // "{\tiny{} ...}" ==> "{{} ...}"
1850 interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
1853 // Remove header hull, that is "\url{abcd}" ==> "abcd"
1854 interval.addIntervall(actual._tokenstart, actual._dataStart);
1855 interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
1859 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
1862 switch (actual.keytype)
1864 case KeyInfo::isChar: {
1865 nextKeyIdx = getNextKey();
1868 case KeyInfo::isSize: {
1869 if (actual.disabled) {
1871 processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
1872 interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
1873 nextKeyIdx = getNextKey();
1875 // Split on this key if not at start
1876 int start = interval.nextNotIgnored(previousStart);
1877 if (start < actual._tokenstart) {
1878 interval.output(os, actual._tokenstart);
1879 interval.addIntervall(start, actual._tokenstart);
1881 // discard entry if at end of actual
1882 nextKeyIdx = process(os, actual);
1886 case KeyInfo::noMain:
1888 case KeyInfo::isStandard: {
1889 if (actual.disabled) {
1891 processRegion(actual._dataStart, actual._dataStart+1);
1892 nextKeyIdx = getNextKey();
1894 // Split on this key if not at start
1895 int start = interval.nextNotIgnored(previousStart);
1896 if (start < actual._tokenstart) {
1897 interval.output(os, actual._tokenstart);
1898 interval.addIntervall(start, actual._tokenstart);
1900 // discard entry if at end of actual
1901 nextKeyIdx = process(os, actual);
1905 case KeyInfo::doRemove: {
1906 // Remove the key with all parameters and following spaces
1908 for (pos = actual._dataEnd+1; pos < interval.par.length(); pos++) {
1909 if ((interval.par[pos] != ' ') && (interval.par[pos] != '%'))
1912 interval.addIntervall(actual._tokenstart, pos);
1913 nextKeyIdx = getNextKey();
1916 case KeyInfo::isList: {
1917 // Discard space before _tokenstart
1919 for (count = 0; count < actual._tokenstart; count++) {
1920 if (interval.par[actual._tokenstart-count-1] != ' ')
1923 if (actual.disabled) {
1924 interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
1927 interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1929 // Discard extra parentheses '[]'
1930 if (interval.par[actual._dataEnd+1] == '[') {
1931 int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
1932 if ((interval.par[actual._dataEnd+2] == '{') &&
1933 (interval.par[posdown-1] == '}')) {
1934 interval.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
1935 interval.addIntervall(posdown-1, posdown+1);
1938 interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
1939 interval.addIntervall(posdown, posdown+1);
1941 int blk = interval.nextNotIgnored(actual._dataEnd+1);
1942 if (blk > posdown) {
1943 // Discard at most 1 space after empty item
1945 for (count = 0; count < 1; count++) {
1946 if (interval.par[blk+count] != ' ')
1950 interval.addIntervall(blk, blk+count);
1953 nextKeyIdx = getNextKey();
1956 case KeyInfo::isSectioning: {
1957 // Discard spaces before _tokenstart
1959 for (count = 0; count < actual._tokenstart; count++) {
1960 if (interval.par[actual._tokenstart-count-1] != ' ')
1963 if (actual.disabled) {
1964 removeHead(actual, count);
1965 nextKeyIdx = getNextKey();
1967 interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
1968 nextKeyIdx = process(os, actual);
1972 case KeyInfo::isMath: {
1973 // Same as regex, use the content unchanged
1974 nextKeyIdx = getNextKey();
1977 case KeyInfo::isRegex: {
1978 // DO NOT SPLIT ON REGEX
1980 nextKeyIdx = getNextKey();
1983 case KeyInfo::isIgnored: {
1984 // Treat like a character for now
1985 nextKeyIdx = getNextKey();
1988 case KeyInfo::isMain: {
1989 if (interval.par.substr(actual._dataStart, 2) == "% ")
1990 interval.addIntervall(actual._dataStart, actual._dataStart+2);
1991 if (actual.disabled) {
1993 if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
1994 (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
1995 // Discard also the space before math-equation
1996 interval.addIntervall(actual._dataStart, actual._dataStart+1);
1998 interval.resetOpenedP(actual._dataStart-1);
2001 if (actual._tokenstart == 0) {
2002 // for the first (and maybe dummy) language
2003 interval.setForDefaultLang(actual._tokenstart + actual._tokensize);
2005 interval.resetOpenedP(actual._dataStart-1);
2009 case KeyInfo::invalid:
2010 // This cannot happen, already handled
2013 // LYXERR0("Unhandled keytype");
2014 nextKeyIdx = getNextKey();
2021 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
2023 int end = interval.nextNotIgnored(actual._dataEnd);
2024 int oldStart = actual._dataStart;
2025 int nextKeyIdx = getNextKey();
2027 if ((nextKeyIdx < 0) ||
2028 (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2029 (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
2030 if (oldStart <= end) {
2031 processRegion(oldStart, end);
2036 KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2038 if (nextKey.keytype == KeyInfo::isMain) {
2039 (void) dispatch(os, actual._dataStart, nextKey);
2040 end = nextKey._tokenstart;
2043 processRegion(oldStart, nextKey._tokenstart);
2044 nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2046 oldStart = nextKey._dataEnd+1;
2048 // now nextKey is either invalid or is outside of actual._dataEnd
2049 // output the remaining and discard myself
2050 if (oldStart <= end) {
2051 processRegion(oldStart, end);
2053 if (interval.par[end] == '}') {
2055 // This is the normal case.
2056 // But if using the firstlanguage, the closing may be missing
2058 // get minimum of 'end' and 'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2060 if (actual._dataEnd < end)
2061 output_end = interval.nextNotIgnored(actual._dataEnd);
2063 output_end = interval.nextNotIgnored(end);
2064 if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2065 interval.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2067 if (interval.nextNotIgnored(actual._dataStart) < output_end)
2068 interval.output(os, output_end);
2069 interval.addIntervall(actual._tokenstart, end);
2073 string splitOnKnownMacros(string par, bool isPatternString) {
2075 LatexInfo li(par, isPatternString);
2076 KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2078 DummyKey._tokensize = 0;
2079 DummyKey._tokenstart = 0;
2080 DummyKey._dataStart = 0;
2081 DummyKey._dataEnd = par.length();
2082 DummyKey.disabled = true;
2083 int firstkeyIdx = li.getFirstKey();
2085 if (firstkeyIdx >= 0) {
2086 KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2088 if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2089 // Use dummy firstKey
2090 firstKey = DummyKey;
2091 (void) li.setNextKey(firstkeyIdx);
2094 if (par.substr(firstKey._dataStart, 2) == "% ")
2095 li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2097 nextkeyIdx = li.process(os, firstKey);
2098 while (nextkeyIdx >= 0) {
2099 // Check for a possible gap between the last
2100 // entry and this one
2101 int datastart = li.nextNotIgnored(firstKey._dataStart);
2102 KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2103 if ((nextKey._tokenstart > datastart)) {
2105 firstKey._dataStart = datastart;
2106 firstKey._dataEnd = par.length();
2107 (void) li.setNextKey(nextkeyIdx);
2108 if (firstKey._tokensize > 0) {
2109 // Fake the last opened parenthesis
2110 li.setForDefaultLang(firstKey._tokensize);
2112 nextkeyIdx = li.process(os, firstKey);
2115 if (nextKey.keytype != KeyInfo::isMain) {
2116 firstKey._dataStart = datastart;
2117 firstKey._dataEnd = nextKey._dataEnd+1;
2118 (void) li.setNextKey(nextkeyIdx);
2119 if (firstKey._tokensize > 0)
2120 li.setForDefaultLang(firstKey._tokensize);
2121 nextkeyIdx = li.process(os, firstKey);
2124 nextkeyIdx = li.process(os, nextKey);
2128 // Handle the remaining
2129 firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2130 firstKey._dataEnd = par.length();
2132 if ((firstKey._dataStart < firstKey._dataEnd) &&
2133 (par[firstKey._dataStart] != '}')) {
2134 if (firstKey._tokensize > 0)
2135 li.setForDefaultLang(firstKey._tokensize);
2136 (void) li.process(os, firstKey);
2140 // return string definitelly impossible to match
2141 s = "\\foreignlanguage{ignore}{ }";
2145 s = par; /* no known macros found */
2150 * Try to unify the language specs in the latexified text.
2151 * Resulting modified string is set to "", if
2152 * the searched tex does not contain all the features in the search pattern
2154 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2156 static Features regex_f;
2157 static int missed = 0;
2158 static bool regex_with_format = false;
2160 int parlen = par.length();
2162 while ((parlen > 0) && (par[parlen-1] == '\n')) {
2167 // Split the latex input into pieces which
2168 // can be digested by our search engine
2169 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2170 result = splitOnKnownMacros(par, isPatternString);
2171 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2174 result = par.substr(0, parlen);
2175 if (isPatternString) {
2178 regex_f = identifyFeatures(result);
2179 string features = "";
2180 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2181 string a = it->first;
2182 regex_with_format = true;
2183 features += " " + a;
2184 // LYXERR0("Identified regex format:" << a);
2186 LYXERR(Debug::FIND, "Identified Features" << features);
2189 } else if (regex_with_format) {
2190 Features info = identifyFeatures(result);
2191 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2192 string a = it->first;
2193 bool b = it->second;
2194 if (b && ! info[a]) {
2196 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2202 // LYXERR0("No regex formats");
2208 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2209 static int identifyClosing(string & t)
2211 int open_braces = 0;
2213 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2214 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2216 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2218 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2220 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2230 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2231 : p_buf(&buf), p_first_buf(&buf), opt(opt)
2233 Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2234 docstring const & ds = stringifySearchBuffer(find_buf, opt);
2235 use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2236 // When using regexp, braces are hacked already by escape_for_regex()
2237 par_as_string = normalize(ds, !use_regexp);
2239 close_wildcards = 0;
2241 size_t lead_size = 0;
2242 // correct the language settings
2243 par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2244 if (opt.ignoreformat) {
2246 // if par_as_string_nolead were emty,
2247 // the following call to findAux will always *find* the string
2248 // in the checked data, and thus always using the slow
2249 // examining of the current text part.
2250 par_as_string_nolead = par_as_string;
2253 lead_size = identifyLeading(par_as_string);
2254 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2255 lead_as_string = par_as_string.substr(0, lead_size);
2256 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2260 open_braces = identifyClosing(par_as_string);
2261 identifyClosing(par_as_string_nolead);
2262 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2263 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2265 string lead_as_regexp;
2266 if (lead_size > 0) {
2267 // @todo No need to search for \regexp{} insets in leading material
2268 lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2269 par_as_string = par_as_string_nolead;
2270 LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2271 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2273 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2274 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2275 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2277 // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2278 regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2279 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2280 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2281 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2282 || regex_replace(par_as_string, par_as_string,
2283 "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2284 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2285 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2289 if (!opt.ignoreformat) {
2290 // Remove extra '\}' at end
2291 while ( regex_replace(par_as_string, par_as_string, "(.*)\\\\}$", "$1")) {
2296 regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2297 // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2298 regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2299 // replace '[^...]' with '[^...\}\{\\]'
2300 regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2301 regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2302 regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2304 regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2307 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2308 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2309 LYXERR(Debug::FIND, "Close .*? : " << close_wildcards);
2310 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2312 // If entered regexp must match at begin of searched string buffer
2313 // Kornel: Added parentheses to use $1 for size of the leading string
2317 // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2318 // Unfortunately is '\1', '\2', etc not working for strings with extra format
2319 // so the convert has no effect in that case
2320 for (int i = 8; i > 0; --i) {
2321 string orig = "\\\\" + std::to_string(i);
2322 string dest = "\\" + std::to_string(i+1);
2323 while (regex_replace(par_as_string, par_as_string, orig, dest));
2325 regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2326 regexp2_str = "(" + lead_as_regexp + ").*" + par_as_string;
2328 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2329 regexp = lyx::regex(regexp_str);
2331 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2332 regexp2 = lyx::regex(regexp2_str);
2337 // Count number of characters in string
2341 // \\[a-zA-Z]+ ==> 1
2342 static int computeSize(string s, int len)
2348 for (int i = 0; i < len; i += skip, count++) {
2351 if (isalpha(s[i+1])) {
2352 for (int j = 2; i+j < len; j++) {
2353 if (! isalpha(s[i+j])) {
2356 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2358 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2366 else if (s[i] == '{') {
2372 else if (s[i] == '-') {
2373 if (s[i+1] == '-') {
2389 int MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2392 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2395 docstring docstr = stringifyFromForSearch(opt, cur, len);
2396 string str = normalize(docstr, true);
2397 if (!opt.ignoreformat) {
2398 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2400 if (str.empty()) return(-1);
2401 LYXERR(Debug::FIND, "Matching against '" << lyx::to_utf8(docstr) << "'");
2402 LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2405 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2406 regex const *p_regexp;
2407 regex_constants::match_flag_type flags;
2409 flags = regex_constants::match_continuous;
2412 flags = regex_constants::match_default;
2413 p_regexp = ®exp2;
2415 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2416 if (re_it == sregex_iterator())
2418 match_results<string::const_iterator> const & m = *re_it;
2420 if (0) { // Kornel Benko: DO NOT CHECKK
2421 // Check braces on the segment that matched the entire regexp expression,
2422 // plus the last subexpression, if a (.*?) was inserted in the constructor.
2423 if (!braces_match(m[0].first, m[0].second, open_braces))
2427 // Check braces on segments that matched all (.*?) subexpressions,
2428 // except the last "padding" one inserted by lyx.
2429 for (size_t i = 1; i < m.size() - 1; ++i)
2430 if (!braces_match(m[i].first, m[i].second, open_braces))
2433 // Exclude from the returned match length any length
2434 // due to close wildcards added at end of regexp
2435 // and also the length of the leading (e.g. '\emph{')
2437 // Whole found string, including the leading: m[0].second - m[0].first
2438 // Size of the leading string: m[1].second - m[1].first
2439 int leadingsize = 0;
2441 leadingsize = m[1].second - m[1].first;
2443 for (size_t i = 0; i < m.size(); i++) {
2444 LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2446 if (close_wildcards == 0)
2447 result = m[0].second - m[0].first;
2450 result = m[m.size() - close_wildcards].first - m[0].first;
2452 size_t pos = m.position(size_t(0));
2453 // Ignore last closing characters
2454 while (result > 0) {
2455 if (str[pos+result-1] == '}')
2460 if (result > leadingsize)
2461 result -= leadingsize;
2464 return computeSize(str.substr(pos+leadingsize,result), result);
2467 // else !use_regexp: but all code paths above return
2468 LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2469 << par_as_string << "', str='" << str << "'");
2470 LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2471 << lead_as_string << "', par_as_string_nolead='"
2472 << par_as_string_nolead << "'");
2475 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2476 << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2477 if (str.substr(0, par_as_string.size()) == par_as_string)
2478 return par_as_string.size();
2480 size_t pos = str.find(par_as_string_nolead);
2481 if (pos != string::npos)
2482 return par_as_string.size();
2488 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2490 int res = findAux(cur, len, at_begin);
2492 "res=" << res << ", at_begin=" << at_begin
2493 << ", matchword=" << opt.matchword
2494 << ", inTexted=" << cur.inTexted());
2495 if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2497 if ((len > 0) && (res < len))
2499 Paragraph const & par = cur.paragraph();
2500 bool ws_left = (cur.pos() > 0)
2501 ? par.isWordSeparator(cur.pos() - 1)
2503 bool ws_right = (cur.pos() + len < par.size())
2504 ? par.isWordSeparator(cur.pos() + len)
2507 "cur.pos()=" << cur.pos() << ", res=" << res
2508 << ", separ: " << ws_left << ", " << ws_right
2511 if (ws_left && ws_right) {
2512 // Check for word separators inside the found 'word'
2513 for (int i = 0; i < len; i++) {
2514 if (par.isWordSeparator(cur.pos() + i))
2523 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2526 if (! opt.casesensitive)
2527 t = lyx::to_utf8(lowercase(s));
2529 t = lyx::to_utf8(s);
2530 // Remove \n at begin
2531 while (!t.empty() && t[0] == '\n')
2534 while (!t.empty() && t[t.size() - 1] == '\n')
2535 t = t.substr(0, t.size() - 1);
2537 // Replace all other \n with spaces
2538 while ((pos = t.find("\n")) != string::npos)
2539 t.replace(pos, 1, " ");
2540 // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
2541 // Kornel: Added textsl, textsf, textit, texttt and noun
2542 // + allow to seach for colored text too
2543 LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
2544 while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
2545 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2546 while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
2547 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
2549 while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
2550 // FIXME - check what preceeds the brace
2552 if (opt.ignoreformat)
2553 while (regex_replace(t, t, "\\{", "_x_<")
2554 || regex_replace(t, t, "\\}", "_x_>"))
2555 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2557 while (regex_replace(t, t, "\\\\\\{", "_x_<")
2558 || regex_replace(t, t, "\\\\\\}", "_x_>"))
2559 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
2566 docstring stringifyFromCursor(DocIterator const & cur, int len)
2568 LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
2569 if (cur.inTexted()) {
2570 Paragraph const & par = cur.paragraph();
2571 // TODO what about searching beyond/across paragraph breaks ?
2572 // TODO Try adding a AS_STR_INSERTS as last arg
2573 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
2574 int(par.size()) : cur.pos() + len;
2575 OutputParams runparams(&cur.buffer()->params().encoding());
2576 runparams.nice = true;
2577 runparams.flavor = OutputParams::LATEX;
2578 runparams.linelen = 100000; //lyxrc.plaintext_linelen;
2579 // No side effect of file copying and image conversion
2580 runparams.dryrun = true;
2581 LYXERR(Debug::FIND, "Stringifying with cur: "
2582 << cur << ", from pos: " << cur.pos() << ", end: " << end);
2583 return par.asString(cur.pos(), end,
2584 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
2586 } else if (cur.inMathed()) {
2587 CursorSlice cs = cur.top();
2588 MathData md = cs.cell();
2589 MathData::const_iterator it_end =
2590 (( len == -1 || cs.pos() + len > int(md.size()))
2592 : md.begin() + cs.pos() + len );
2594 for (MathData::const_iterator it = md.begin() + cs.pos();
2597 docstring s = asString(md2);
2598 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
2601 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2606 /** Computes the LaTeX export of buf starting from cur and ending len positions
2607 * after cur, if len is positive, or at the paragraph or innermost inset end
2610 docstring latexifyFromCursor(DocIterator const & cur, int len)
2612 LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
2613 LYXERR(Debug::FIND, " with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
2614 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
2615 Buffer const & buf = *cur.buffer();
2617 odocstringstream ods;
2619 OutputParams runparams(&buf.params().encoding());
2620 runparams.nice = false;
2621 runparams.flavor = OutputParams::LATEX;
2622 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
2623 // No side effect of file copying and image conversion
2624 runparams.dryrun = true;
2625 runparams.for_search = true;
2627 if (cur.inTexted()) {
2628 // @TODO what about searching beyond/across paragraph breaks ?
2629 pos_type endpos = cur.paragraph().size();
2630 if (len != -1 && endpos > cur.pos() + len)
2631 endpos = cur.pos() + len;
2632 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
2633 string(), cur.pos(), endpos);
2634 string s = lyx::to_utf8(ods.str());
2635 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
2636 return(lyx::from_utf8(s));
2637 } else if (cur.inMathed()) {
2638 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
2639 for (int s = cur.depth() - 1; s >= 0; --s) {
2640 CursorSlice const & cs = cur[s];
2641 if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
2643 cs.asInsetMath()->asHullInset()->header_write(ws);
2648 CursorSlice const & cs = cur.top();
2649 MathData md = cs.cell();
2650 MathData::const_iterator it_end =
2651 ((len == -1 || cs.pos() + len > int(md.size()))
2653 : md.begin() + cs.pos() + len);
2655 for (MathData::const_iterator it = md.begin() + cs.pos();
2659 ods << asString(md2);
2660 // Retrieve the math environment type, and add '$' or '$]'
2661 // or others (\end{equation}) accordingly
2662 for (int s = cur.depth() - 1; s >= 0; --s) {
2663 CursorSlice const & cs2 = cur[s];
2664 InsetMath * inset = cs2.asInsetMath();
2665 if (inset && inset->asHullInset()) {
2667 inset->asHullInset()->footer_write(ws);
2671 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
2673 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
2679 /** Finalize an advanced find operation, advancing the cursor to the innermost
2680 ** position that matches, plus computing the length of the matching text to
2683 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
2685 // Search the foremost position that matches (avoids find of entire math
2686 // inset when match at start of it)
2688 DocIterator old_cur(cur.buffer());
2690 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
2694 } while (cur && cur.depth() > d && match(cur) > 0);
2696 int max_match = match(cur); /* match valid only if not searching whole words */
2697 if (max_match <= 0) return 0;
2698 LYXERR(Debug::FIND, "Ok");
2700 // Compute the match length
2702 if (cur.pos() + len > cur.lastpos())
2704 if (match.opt.matchword) {
2705 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2706 while (cur.pos() + len <= cur.lastpos() && match(cur, len) <= 0) {
2708 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
2710 // Length of matched text (different from len param)
2711 int old_match = match(cur, len);
2715 // Greedy behaviour while matching regexps
2716 while ((new_match = match(cur, len + 1)) > old_match) {
2718 old_match = new_match;
2719 LYXERR(Debug::FIND, "verifying match with len = " << len);
2726 int maxl = cur.lastpos() - cur.pos();
2727 // Greedy behaviour while matching regexps
2728 while (maxl > minl) {
2729 int actual_match = match(cur, len);
2730 if (actual_match >= max_match) {
2731 // actual_match > max_match _can_ happen,
2732 // if the search area splits
2733 // some following word so that the regex
2734 // (e.g. 'r.*r\b' matches 'r' from the middle of the
2736 // This means, the len value is too big
2738 len = (int)((maxl + minl)/2);
2741 // (actual_match < max_match)
2743 len = (int)((maxl + minl)/2);
2752 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
2756 while (!theApp()->longOperationCancelled() && cur) {
2757 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
2758 int match_len = match(cur, -1, false);
2759 LYXERR(Debug::FIND, "match_len: " << match_len);
2760 if (match_len > 0) {
2761 int match_len_zero_count = 0;
2762 for (; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
2763 LYXERR(Debug::FIND, "Advancing cur: " << cur);
2764 int match_len3 = match(cur, 1);
2767 int match_len2 = match(cur);
2768 LYXERR(Debug::FIND, "match_len2: " << match_len2);
2769 if (match_len2 > 0) {
2770 // Sometimes in finalize we understand it wasn't a match
2771 // and we need to continue the outest loop
2772 int len = findAdvFinalize(cur, match);
2777 if (match_len2 >= 0) {
2778 if (match_len2 == 0)
2779 match_len_zero_count++;
2781 match_len_zero_count = 0;
2784 if (++match_len_zero_count > 3) {
2785 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
2786 match_len_zero_count = 0;
2794 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
2795 LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
2798 // This should exit nested insets, if any, or otherwise undefine the currsor.
2799 cur.pos() = cur.lastpos();
2800 LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
2808 /// Find the most backward consecutive match within same paragraph while searching backwards.
2809 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
2811 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2812 DocIterator tmp_cur = cur;
2813 int len = findAdvFinalize(tmp_cur, match);
2814 Inset & inset = cur.inset();
2815 for (; cur != cur_begin; cur.backwardPos()) {
2816 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
2817 DocIterator new_cur = cur;
2818 new_cur.backwardPos();
2819 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur))
2821 int new_len = findAdvFinalize(new_cur, match);
2826 LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
2832 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
2836 // Backup of original position
2837 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
2838 if (cur == cur_begin)
2841 DocIterator cur_orig(cur);
2842 bool pit_changed = false;
2845 bool found_match = match(cur, -1, false);
2849 cur.pos() = cur.lastpos();
2851 cur.pos() = cur_orig.pos();
2852 LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
2853 DocIterator cur_prev_iter;
2855 found_match = match(cur);
2856 LYXERR(Debug::FIND, "findBackAdv3: found_match="
2857 << found_match << ", cur: " << cur);
2859 return findMostBackwards(cur, match);
2861 // Stop if begin of document reached
2862 if (cur == cur_begin)
2864 cur_prev_iter = cur;
2868 if (cur == cur_begin)
2875 } while (!theApp()->longOperationCancelled());
2883 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
2884 DocIterator const & cur, int len)
2886 if (cur.pos() < 0 || cur.pos() > cur.lastpos())
2888 if (!opt.ignoreformat)
2889 return latexifyFromCursor(cur, len);
2891 return stringifyFromCursor(cur, len);
2895 FindAndReplaceOptions::FindAndReplaceOptions(
2896 docstring const & find_buf_name, bool casesensitive,
2897 bool matchword, bool forward, bool expandmacros, bool ignoreformat,
2898 docstring const & repl_buf_name, bool keep_case,
2899 SearchScope scope, SearchRestriction restr)
2900 : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
2901 forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
2902 repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr)
2910 /** Check if 'len' letters following cursor are all non-lowercase */
2911 static bool allNonLowercase(Cursor const & cur, int len)
2913 pos_type beg_pos = cur.selectionBegin().pos();
2914 pos_type end_pos = cur.selectionBegin().pos() + len;
2915 if (len > cur.lastpos() + 1 - beg_pos) {
2916 LYXERR(Debug::FIND, "This should not happen, more debug needed");
2917 len = cur.lastpos() + 1 - beg_pos;
2918 end_pos = beg_pos + len;
2920 for (pos_type pos = beg_pos; pos != end_pos; ++pos)
2921 if (isLowerCase(cur.paragraph().getChar(pos)))
2927 /** Check if first letter is upper case and second one is lower case */
2928 static bool firstUppercase(Cursor const & cur)
2931 pos_type pos = cur.selectionBegin().pos();
2932 if (pos >= cur.lastpos() - 1) {
2933 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
2936 ch1 = cur.paragraph().getChar(pos);
2937 ch2 = cur.paragraph().getChar(pos + 1);
2938 bool result = isUpperCase(ch1) && isLowerCase(ch2);
2939 LYXERR(Debug::FIND, "firstUppercase(): "
2940 << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
2941 << ch2 << "(" << char(ch2) << ")"
2942 << ", result=" << result << ", cur=" << cur);
2947 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
2949 ** \fixme What to do with possible further paragraphs in replace buffer ?
2951 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
2953 ParagraphList::iterator pit = buffer.paragraphs().begin();
2954 LASSERT(pit->size() >= 1, /**/);
2955 pos_type right = pos_type(1);
2956 pit->changeCase(buffer.params(), pos_type(0), right, first_case);
2957 right = pit->size();
2958 pit->changeCase(buffer.params(), pos_type(1), right, others_case);
2964 static void findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
2966 Cursor & cur = bv->cursor();
2967 if (opt.repl_buf_name == docstring()
2968 || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
2969 || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
2972 DocIterator sel_beg = cur.selectionBegin();
2973 DocIterator sel_end = cur.selectionEnd();
2974 if (&sel_beg.inset() != &sel_end.inset()
2975 || sel_beg.pit() != sel_end.pit()
2976 || sel_beg.idx() != sel_end.idx())
2978 int sel_len = sel_end.pos() - sel_beg.pos();
2979 LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
2980 << ", sel_len: " << sel_len << endl);
2983 LASSERT(sel_len > 0, return);
2985 if (!matchAdv(sel_beg, sel_len))
2988 // Build a copy of the replace buffer, adapted to the KeepCase option
2989 Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
2991 repl_buffer_orig.write(oss);
2992 string lyx = oss.str();
2993 Buffer repl_buffer("", false);
2994 repl_buffer.setUnnamed(true);
2995 LASSERT(repl_buffer.readString(lyx), return);
2996 if (opt.keep_case && sel_len >= 2) {
2997 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
2998 if (cur.inTexted()) {
2999 if (firstUppercase(cur))
3000 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3001 else if (allNonLowercase(cur, sel_len))
3002 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3005 cap::cutSelection(cur, false);
3006 if (cur.inTexted()) {
3007 repl_buffer.changeLanguage(
3008 repl_buffer.language(),
3009 cur.getFont().language());
3010 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3011 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3012 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3013 repl_buffer.params().documentClassPtr(),
3014 bv->buffer().errorList("Paste"));
3015 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3016 sel_len = repl_buffer.paragraphs().begin()->size();
3017 } else if (cur.inMathed()) {
3018 odocstringstream ods;
3020 OutputParams runparams(&repl_buffer.params().encoding());
3021 runparams.nice = false;
3022 runparams.flavor = OutputParams::LATEX;
3023 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3024 runparams.dryrun = true;
3025 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3026 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3027 docstring repl_latex = ods.str();
3028 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3030 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3031 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3032 repl_latex = from_utf8(s);
3033 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3034 MathData ar(cur.buffer());
3035 asArray(repl_latex, ar, Parse::NORMAL);
3037 sel_len = ar.size();
3038 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3040 if (cur.pos() >= sel_len)
3041 cur.pos() -= sel_len;
3044 LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3045 bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3046 bv->processUpdateFlags(Update::Force);
3050 /// Perform a FindAdv operation.
3051 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3056 // e.g., when invoking word-findadv from mini-buffer wither with
3057 // wrong options syntax or before ever opening advanced F&R pane
3058 if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3062 MatchStringAdv matchAdv(bv->buffer(), opt);
3063 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3065 bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3066 findAdvReplace(bv, opt, matchAdv);
3069 match_len = findForwardAdv(cur, matchAdv);
3071 match_len = findBackwardsAdv(cur, matchAdv);
3073 // This may only be raised by lyx::regex()
3074 bv->message(_("Invalid regular expression!"));
3078 if (match_len == 0) {
3079 bv->message(_("Match not found!"));
3083 bv->message(_("Match found!"));
3085 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3086 bv->putSelectionAt(cur, match_len, !opt.forward);
3092 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3094 os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3095 << opt.casesensitive << ' '
3096 << opt.matchword << ' '
3097 << opt.forward << ' '
3098 << opt.expandmacros << ' '
3099 << opt.ignoreformat << ' '
3100 << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3101 << opt.keep_case << ' '
3102 << int(opt.scope) << ' '
3105 LYXERR(Debug::FIND, "built: " << os.str());
3111 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3113 LYXERR(Debug::FIND, "parsing");
3117 while (line != "EOSS") {
3121 if (is.eof()) // Tolerate malformed request
3125 LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3126 opt.find_buf_name = from_utf8(s);
3127 is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat;
3128 is.get(); // Waste space before replace string
3131 while (line != "EOSS") {
3135 if (is.eof()) // Tolerate malformed request
3139 LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3140 opt.repl_buf_name = from_utf8(s);
3141 is >> opt.keep_case;
3144 opt.scope = FindAndReplaceOptions::SearchScope(i);
3146 opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3148 LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3149 << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3150 << opt.scope << ' ' << opt.restr);