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"
37 #include "frontends/Application.h"
38 #include "frontends/alert.h"
40 #include "mathed/InsetMath.h"
41 #include "mathed/InsetMathGrid.h"
42 #include "mathed/InsetMathHull.h"
43 #include "mathed/MathData.h"
44 #include "mathed/MathStream.h"
45 #include "mathed/MathSupport.h"
47 #include "support/convert.h"
48 #include "support/debug.h"
49 #include "support/docstream.h"
50 #include "support/FileName.h"
51 #include "support/gettext.h"
52 #include "support/lassert.h"
53 #include "support/lstrings.h"
55 #include "support/regex.h"
56 #include "support/textutils.h"
60 using namespace lyx::support;
65 // Helper class for deciding what should be ignored
70 : ignoreFamily_(false), ignoreSeries_(false),
71 ignoreShape_(false), ignoreUnderline_(false),
72 ignoreMarkUp_(false), ignoreStrikeOut_(false),
73 ignoreSectioning_(false), ignoreFrontMatter_(false),
74 ignoreColor_(false), ignoreLanguage_(false) {}
76 bool getFamily() { return ignoreFamily_; };
78 bool getSeries() { return ignoreSeries_; };
80 bool getShape() { return ignoreShape_; };
82 bool getUnderline() { return ignoreUnderline_; };
84 bool getMarkUp() { return ignoreMarkUp_; };
86 bool getStrikeOut() { return ignoreStrikeOut_; };
88 bool getSectioning() { return ignoreSectioning_; };
90 bool getFrontMatter() { return ignoreFrontMatter_; };
92 bool getColor() { return ignoreColor_; };
94 bool getLanguage() { return ignoreLanguage_; };
96 void setIgnoreFormat(string type, bool value);
106 bool ignoreUnderline_;
110 bool ignoreStrikeOut_;
112 bool ignoreSectioning_;
114 bool ignoreFrontMatter_;
118 bool ignoreLanguage_;
122 void IgnoreFormats::setIgnoreFormat(string type, bool value)
124 if (type == "color") {
125 ignoreColor_ = value;
127 else if (type == "language") {
128 ignoreLanguage_ = value;
130 else if (type == "sectioning") {
131 ignoreSectioning_ = value;
132 ignoreFrontMatter_ = value;
134 else if (type == "font") {
135 ignoreSeries_ = value;
136 ignoreShape_ = value;
137 ignoreFamily_ = value;
139 else if (type == "series") {
140 ignoreSeries_ = value;
142 else if (type == "shape") {
143 ignoreShape_ = value;
145 else if (type == "family") {
146 ignoreFamily_ = value;
148 else if (type == "markup") {
149 ignoreMarkUp_ = value;
151 else if (type == "underline") {
152 ignoreUnderline_ = value;
154 else if (type == "strike") {
155 ignoreStrikeOut_ = value;
159 // The global variable that can be changed from outside
160 IgnoreFormats ignoreFormats;
163 void setIgnoreFormat(string type, bool value)
165 ignoreFormats.setIgnoreFormat(type, value);
171 bool parse_bool(docstring & howto)
176 howto = split(howto, var, ' ');
181 class MatchString : public binary_function<Paragraph, pos_type, int>
184 MatchString(docstring const & str, bool cs, bool mw)
185 : str(str), case_sens(cs), whole_words(mw)
188 // returns true if the specified string is at the specified position
189 // del specifies whether deleted strings in ct mode will be considered
190 int operator()(Paragraph const & par, pos_type pos, bool del = true) const
192 return par.find(str, case_sens, whole_words, pos, del);
200 // match whole words only
205 int findForward(DocIterator & cur, MatchString const & match,
206 bool find_del = true)
208 for (; cur; cur.forwardChar())
209 if (cur.inTexted()) {
210 int len = match(cur.paragraph(), cur.pos(), find_del);
218 int findBackwards(DocIterator & cur, MatchString const & match,
219 bool find_del = true)
223 if (cur.inTexted()) {
224 int len = match(cur.paragraph(), cur.pos(), find_del);
233 bool searchAllowed(docstring const & str)
236 frontend::Alert::error(_("Search error"), _("Search string is empty"));
243 bool findOne(BufferView * bv, docstring const & searchstr,
244 bool case_sens, bool whole, bool forward,
245 bool find_del = true, bool check_wrap = false)
247 if (!searchAllowed(searchstr))
250 DocIterator cur = forward
251 ? bv->cursor().selectionEnd()
252 : bv->cursor().selectionBegin();
254 MatchString const match(searchstr, case_sens, whole);
256 int match_len = forward
257 ? findForward(cur, match, find_del)
258 : findBackwards(cur, match, find_del);
261 bv->putSelectionAt(cur, match_len, !forward);
262 else if (check_wrap) {
263 DocIterator cur_orig(bv->cursor());
266 q = _("End of file reached while searching forward.\n"
267 "Continue searching from the beginning?");
269 q = _("Beginning of file reached while searching backward.\n"
270 "Continue searching from the end?");
271 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
272 q, 0, 1, _("&Yes"), _("&No"));
273 if (wrap_answer == 0) {
275 bv->cursor().clear();
276 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
278 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
279 bv->cursor().backwardPos();
281 bv->clearSelection();
282 if (findOne(bv, searchstr, case_sens, whole, forward, find_del, false))
285 bv->cursor().setCursor(cur_orig);
289 return match_len > 0;
293 int replaceAll(BufferView * bv,
294 docstring const & searchstr, docstring const & replacestr,
295 bool case_sens, bool whole)
297 Buffer & buf = bv->buffer();
299 if (!searchAllowed(searchstr) || buf.isReadonly())
302 DocIterator cur_orig(bv->cursor());
304 MatchString const match(searchstr, case_sens, whole);
307 int const rsize = replacestr.size();
308 int const ssize = searchstr.size();
311 cur.setCursor(doc_iterator_begin(&buf));
312 int match_len = findForward(cur, match, false);
313 while (match_len > 0) {
314 // Backup current cursor position and font.
315 pos_type const pos = cur.pos();
316 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
318 int striked = ssize -
319 cur.paragraph().eraseChars(pos, pos + match_len,
320 buf.params().track_changes);
321 cur.paragraph().insert(pos, replacestr, font,
322 Change(buf.params().track_changes
324 : Change::UNCHANGED));
325 for (int i = 0; i < rsize + striked; ++i)
328 match_len = findForward(cur, match, false);
331 bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
333 cur_orig.fixIfBroken();
334 bv->setCursor(cur_orig);
340 // the idea here is that we are going to replace the string that
341 // is selected IF it is the search string.
342 // if there is a selection, but it is not the search string, then
343 // we basically ignore it. (FIXME We ought to replace only within
345 // if there is no selection, then:
346 // (i) if some search string has been provided, then we find it.
347 // (think of how the dialog works when you hit "replace" the
349 // (ii) if no search string has been provided, then we treat the
350 // word the cursor is in as the search string. (why? i have no
351 // idea.) but this only works in text?
353 // returns the number of replacements made (one, if any) and
354 // whether anything at all was done.
355 pair<bool, int> replaceOne(BufferView * bv, docstring searchstr,
356 docstring const & replacestr, bool case_sens,
357 bool whole, bool forward, bool findnext)
359 Cursor & cur = bv->cursor();
361 if (!cur.selection()) {
362 // no selection, non-empty search string: find it
363 if (!searchstr.empty()) {
364 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
365 return make_pair(found, 0);
367 // empty search string
370 return make_pair(false, 0);
371 // select current word and treat it as the search string.
372 // This causes a minor bug as undo will restore this selection,
373 // which the user did not create (#8986).
374 cur.innerText()->selectWord(cur, WHOLE_WORD);
375 searchstr = cur.selectionAsString(false);
378 // if we still don't have a search string, report the error
380 if (!searchAllowed(searchstr))
381 return make_pair(false, 0);
383 bool have_selection = cur.selection();
384 docstring const selected = cur.selectionAsString(false);
387 ? searchstr == selected
388 : compare_no_case(searchstr, selected) == 0;
390 // no selection or current selection is not search word:
391 // just find the search word
392 if (!have_selection || !match) {
393 found = findOne(bv, searchstr, case_sens, whole, forward, true, findnext);
394 return make_pair(found, 0);
397 // we're now actually ready to replace. if the buffer is
398 // read-only, we can't, though.
399 if (bv->buffer().isReadonly())
400 return make_pair(false, 0);
402 cap::replaceSelectionWithString(cur, replacestr);
404 cur.pos() += replacestr.length();
405 LASSERT(cur.pos() <= cur.lastpos(),
406 cur.pos() = cur.lastpos());
409 findOne(bv, searchstr, case_sens, whole, forward, false, findnext);
411 return make_pair(true, 1);
417 docstring const find2string(docstring const & search,
418 bool casesensitive, bool matchword, bool forward)
422 << int(casesensitive) << ' '
423 << int(matchword) << ' '
429 docstring const replace2string(docstring const & replace,
430 docstring const & search,
431 bool casesensitive, bool matchword,
432 bool all, bool forward, bool findnext)
435 ss << replace << '\n'
437 << int(casesensitive) << ' '
438 << int(matchword) << ' '
440 << int(forward) << ' '
446 bool lyxfind(BufferView * bv, FuncRequest const & ev)
448 if (!bv || ev.action() != LFUN_WORD_FIND)
451 //lyxerr << "find called, cmd: " << ev << endl;
453 // data is of the form
455 // <casesensitive> <matchword> <forward>"
457 docstring howto = split(ev.argument(), search, '\n');
459 bool casesensitive = parse_bool(howto);
460 bool matchword = parse_bool(howto);
461 bool forward = parse_bool(howto);
463 return findOne(bv, search, casesensitive, matchword, forward, true, true);
467 bool lyxreplace(BufferView * bv,
468 FuncRequest const & ev, bool has_deleted)
470 if (!bv || ev.action() != LFUN_WORD_REPLACE)
473 // data is of the form
476 // <casesensitive> <matchword> <all> <forward> <findnext>"
479 docstring howto = split(ev.argument(), rplc, '\n');
480 howto = split(howto, search, '\n');
482 bool casesensitive = parse_bool(howto);
483 bool matchword = parse_bool(howto);
484 bool all = parse_bool(howto);
485 bool forward = parse_bool(howto);
486 bool findnext = howto.empty() ? true : parse_bool(howto);
491 int replace_count = 0;
493 replace_count = replaceAll(bv, search, rplc, casesensitive, matchword);
494 update = replace_count > 0;
497 replaceOne(bv, search, rplc, casesensitive, matchword, forward, findnext);
499 replace_count = rv.second;
502 Buffer const & buf = bv->buffer();
504 // emit message signal.
505 buf.message(_("String not found."));
507 if (replace_count == 0) {
508 buf.message(_("String found."));
509 } else if (replace_count == 1) {
510 buf.message(_("String has been replaced."));
512 docstring const str =
513 bformat(_("%1$d strings have been replaced."), replace_count);
517 } else if (findnext) {
518 // if we have deleted characters, we do not replace at all, but
519 // rather search for the next occurence
520 if (findOne(bv, search, casesensitive, matchword, forward, true, findnext))
523 bv->message(_("String not found."));
529 bool findNextChange(BufferView * bv, Cursor & cur, bool const check_wrap)
531 for (; cur; cur.forwardPos())
532 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
536 DocIterator cur_orig(bv->cursor());
537 docstring q = _("End of file reached while searching forward.\n"
538 "Continue searching from the beginning?");
539 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
540 q, 0, 1, _("&Yes"), _("&No"));
541 if (wrap_answer == 0) {
542 bv->cursor().clear();
543 bv->cursor().push_back(CursorSlice(bv->buffer().inset()));
544 bv->clearSelection();
545 cur.setCursor(bv->cursor().selectionBegin());
546 if (findNextChange(bv, cur, false))
549 bv->cursor().setCursor(cur_orig);
556 bool findPreviousChange(BufferView * bv, Cursor & cur, bool const check_wrap)
558 for (cur.backwardPos(); cur; cur.backwardPos()) {
559 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos()))
564 DocIterator cur_orig(bv->cursor());
565 docstring q = _("Beginning of file reached while searching backward.\n"
566 "Continue searching from the end?");
567 int wrap_answer = frontend::Alert::prompt(_("Wrap search?"),
568 q, 0, 1, _("&Yes"), _("&No"));
569 if (wrap_answer == 0) {
570 bv->cursor().setCursor(doc_iterator_end(&bv->buffer()));
571 bv->cursor().backwardPos();
572 bv->clearSelection();
573 cur.setCursor(bv->cursor().selectionBegin());
574 if (findPreviousChange(bv, cur, false))
577 bv->cursor().setCursor(cur_orig);
584 bool selectChange(Cursor & cur, bool forward)
586 if (!cur.inTexted() || !cur.paragraph().isChanged(cur.pos()))
588 Change ch = cur.paragraph().lookupChange(cur.pos());
590 CursorSlice tip1 = cur.top();
591 for (; tip1.pit() < tip1.lastpit() || tip1.pos() < tip1.lastpos(); tip1.forwardPos()) {
592 Change ch2 = tip1.paragraph().lookupChange(tip1.pos());
593 if (!ch2.isSimilarTo(ch))
596 CursorSlice tip2 = cur.top();
597 for (; tip2.pit() > 0 || tip2.pos() > 0;) {
599 Change ch2 = tip2.paragraph().lookupChange(tip2.pos());
600 if (!ch2.isSimilarTo(ch)) {
601 // take a step forward to correctly set the selection
609 cur.bv().mouseSetCursor(cur, false);
611 cur.bv().mouseSetCursor(cur, true);
619 bool findChange(BufferView * bv, bool forward)
622 cur.setCursor(forward ? bv->cursor().selectionEnd()
623 : bv->cursor().selectionBegin());
624 forward ? findNextChange(bv, cur, true) : findPreviousChange(bv, cur, true);
625 return selectChange(cur, forward);
630 bool findNextChange(BufferView * bv)
632 return findChange(bv, true);
636 bool findPreviousChange(BufferView * bv)
638 return findChange(bv, false);
645 typedef vector<pair<string, string> > Escapes;
647 /// A map of symbols and their escaped equivalent needed within a regex.
648 /// @note Beware of order
649 Escapes const & get_regexp_escapes()
651 typedef std::pair<std::string, std::string> P;
653 static Escapes escape_map;
654 if (escape_map.empty()) {
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("*", "_x_*"));
664 escape_map.push_back(P(".", "_x_."));
665 escape_map.push_back(P("\\", "(?:\\\\|\\\\backslash)"));
666 escape_map.push_back(P("~", "(?:\\\\textasciitilde|\\\\sim)"));
667 escape_map.push_back(P("^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
668 escape_map.push_back(P("_x_", "\\"));
673 /// A map of lyx escaped strings and their unescaped equivalent.
674 Escapes const & get_lyx_unescapes()
676 typedef std::pair<std::string, std::string> P;
678 static Escapes escape_map;
679 if (escape_map.empty()) {
680 escape_map.push_back(P("\\%", "%"));
681 escape_map.push_back(P("\\mathcircumflex ", "^"));
682 escape_map.push_back(P("\\mathcircumflex", "^"));
683 escape_map.push_back(P("\\backslash ", "\\"));
684 escape_map.push_back(P("\\backslash", "\\"));
685 escape_map.push_back(P("\\\\{", "_x_<"));
686 escape_map.push_back(P("\\\\}", "_x_>"));
687 escape_map.push_back(P("\\sim ", "~"));
688 escape_map.push_back(P("\\sim", "~"));
693 /// A map of escapes turning a regexp matching text to one matching latex.
694 Escapes const & get_regexp_latex_escapes()
696 typedef std::pair<std::string, std::string> P;
698 static Escapes escape_map;
699 if (escape_map.empty()) {
700 escape_map.push_back(P("\\\\", "(?:\\\\\\\\|\\\\backslash|\\\\textbackslash\\{\\}|\\\\textbackslash)"));
701 escape_map.push_back(P("(<?!\\\\\\\\textbackslash)\\{", "\\\\\\{"));
702 escape_map.push_back(P("(<?!\\\\\\\\textbackslash\\\\\\{)\\}", "\\\\\\}"));
703 escape_map.push_back(P("\\[", "\\{\\[\\}"));
704 escape_map.push_back(P("\\]", "\\{\\]\\}"));
705 escape_map.push_back(P("\\^", "(?:\\^|\\\\textasciicircum\\{\\}|\\\\textasciicircum|\\\\mathcircumflex)"));
706 escape_map.push_back(P("%", "\\\\\\%"));
707 escape_map.push_back(P("#", "\\\\#"));
712 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
713 ** the found occurrence were escaped.
715 string apply_escapes(string s, Escapes const & escape_map)
717 LYXERR(Debug::FIND, "Escaping: '" << s << "'");
718 Escapes::const_iterator it;
719 for (it = escape_map.begin(); it != escape_map.end(); ++it) {
720 // LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
721 unsigned int pos = 0;
722 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
723 s.replace(pos, it->first.length(), it->second);
724 LYXERR(Debug::FIND, "After escape: " << s);
725 pos += it->second.length();
726 // LYXERR(Debug::FIND, "pos: " << pos);
729 LYXERR(Debug::FIND, "Escaped : '" << s << "'");
734 /// Within \regexp{} apply get_lyx_unescapes() only (i.e., preserve regexp semantics of the string),
735 /// while outside apply get_lyx_unescapes()+get_regexp_escapes().
736 /// If match_latex is true, then apply regexp_latex_escapes() to \regexp{} contents as well.
737 string escape_for_regex(string s, bool match_latex)
740 while (pos < s.size()) {
741 size_t new_pos = s.find("\\regexp{", pos);
742 if (new_pos == string::npos)
746 LYXERR(Debug::FIND, "new_pos: " << new_pos);
747 t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
748 LYXERR(Debug::FIND, "t [lyx]: " << t);
749 t = apply_escapes(t, get_regexp_escapes());
750 LYXERR(Debug::FIND, "t [rxp]: " << t);
751 s.replace(pos, new_pos - pos, t);
752 new_pos = pos + t.size();
753 LYXERR(Debug::FIND, "Regexp after escaping: " << s);
754 LYXERR(Debug::FIND, "new_pos: " << new_pos);
755 if (new_pos == s.size())
758 // Might fail if \\endregexp{} is preceeded by unexpected stuff (weird escapes)
759 size_t end_pos = s.find("\\endregexp{}}", new_pos + 8);
760 LYXERR(Debug::FIND, "end_pos: " << end_pos);
761 t = s.substr(new_pos + 8, end_pos - (new_pos + 8));
762 LYXERR(Debug::FIND, "t in regexp : " << t);
763 t = apply_escapes(t, get_lyx_unescapes());
764 LYXERR(Debug::FIND, "t in regexp [lyx]: " << t);
766 t = apply_escapes(t, get_regexp_latex_escapes());
767 LYXERR(Debug::FIND, "t in regexp [ltx]: " << t);
769 if (end_pos == s.size()) {
770 s.replace(new_pos, end_pos - new_pos, t);
771 LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
774 s.replace(new_pos, end_pos + 13 - new_pos, t);
775 LYXERR(Debug::FIND, "Regexp after \\regexp{...\\endregexp{}} removal: " << s);
776 pos = new_pos + t.size();
777 LYXERR(Debug::FIND, "pos: " << pos);
783 /// Wrapper for lyx::regex_replace with simpler interface
784 bool regex_replace(string const & s, string & t, string const & searchstr,
785 string const & replacestr)
787 lyx::regex e(searchstr, regex_constants::ECMAScript);
789 ostream_iterator<char, char> it(oss);
790 lyx::regex_replace(it, s.begin(), s.end(), e, replacestr);
791 // tolerate t and s be references to the same variable
792 bool rv = (s != oss.str());
798 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
800 ** Verify that closed braces exactly match open braces. This avoids that, for example,
801 ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
804 ** Number of open braces that must remain open at the end for the verification to succeed.
806 bool braces_match(string::const_iterator const & beg,
807 string::const_iterator const & end,
811 string::const_iterator it = beg;
812 LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
813 for (; it != end; ++it) {
814 // Skip escaped braces in the count
819 } else if (*it == '{') {
821 } else if (*it == '}') {
822 if (open_pars == 0) {
823 LYXERR(Debug::FIND, "Found unmatched closed brace");
829 if (open_pars != unmatched) {
830 LYXERR(Debug::FIND, "Found " << open_pars
831 << " instead of " << unmatched
832 << " unmatched open braces at the end of count");
835 LYXERR(Debug::FIND, "Braces match as expected");
845 MatchResult(): match_len(0),match2end(0), pos(0) {};
848 /** The class performing a match between a position in the document and the FindAdvOptions.
850 class MatchStringAdv {
852 MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
854 /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
855 ** constructor as opt.search, under the opt.* options settings.
858 ** If set, then match is searched only against beginning of text starting at cur.
859 ** If unset, then match is searched anywhere in text starting at cur.
862 ** The length of the matching text, or zero if no match was found.
864 MatchResult operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
869 /// first buffer on which search was started
870 lyx::Buffer * const p_first_buf;
872 FindAndReplaceOptions const & opt;
875 /// Auxiliary find method (does not account for opt.matchword)
876 MatchResult findAux(DocIterator const & cur, int len = -1, bool at_begin = true) const;
878 /** Normalize a stringified or latexified LyX paragraph.
882 ** <li>if search is not casesensitive, then lowercase the string;
883 ** <li>remove any newline at begin or end of the string;
884 ** <li>replace any newline in the middle of the string with a simple space;
885 ** <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
888 ** @todo Normalization should also expand macros, if the corresponding
889 ** search option was checked.
891 string normalize(docstring const & s, bool hack_braces) const;
892 // normalized string to search
893 string par_as_string;
894 // regular expression to use for searching
896 // same as regexp, but prefixed with a ".*?"
898 // leading format material as string
899 string lead_as_string;
900 // par_as_string after removal of lead_as_string
901 string par_as_string_nolead;
902 // unmatched open braces in the search string/regexp
904 // number of (.*?) subexpressions added at end of search regexp for closing
905 // environments, math mode, styles, etc...
907 // Are we searching with regular expressions ?
912 static docstring buffer_to_latex(Buffer & buffer)
914 //OutputParams runparams(&buffer.params().encoding());
915 OutputParams runparams(encodings.fromLyXName("utf8"));
916 odocstringstream ods;
918 runparams.nice = true;
919 runparams.flavor = OutputParams::XETEX;
920 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
921 // No side effect of file copying and image conversion
922 runparams.dryrun = true;
923 runparams.for_search = true;
924 pit_type const endpit = buffer.paragraphs().size();
925 for (pit_type pit = 0; pit != endpit; ++pit) {
926 TeXOnePar(buffer, buffer.text(), pit, os, runparams);
927 LYXERR(Debug::FIND, "searchString up to here: " << ods.str());
933 static docstring stringifySearchBuffer(Buffer & buffer, FindAndReplaceOptions const & opt)
936 if (!opt.ignoreformat) {
937 str = buffer_to_latex(buffer);
939 // OutputParams runparams(&buffer.params().encoding());
940 OutputParams runparams(encodings.fromLyXName("utf8"));
941 runparams.nice = true;
942 runparams.flavor = OutputParams::XETEX;
943 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
944 runparams.dryrun = true;
945 runparams.for_search = true;
946 for (pos_type pit = pos_type(0); pit < (pos_type)buffer.paragraphs().size(); ++pit) {
947 Paragraph const & par = buffer.paragraphs().at(pit);
948 LYXERR(Debug::FIND, "Adding to search string: '"
949 << par.asString(pos_type(0), par.size(),
950 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
953 str += par.asString(pos_type(0), par.size(),
954 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
962 /// Return separation pos between the leading material and the rest
963 static size_t identifyLeading(string const & s)
966 // @TODO Support \item[text]
967 // Kornel: Added textsl, textsf, textit, texttt and noun
968 // + allow to search for colored text too
969 while (regex_replace(t, t, REGEX_BOS "\\\\(((footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|emph|noun|minisec|text(bf|md|sl|sf|it|tt))|((textcolor|foreignlanguage|latexenvironment)\\{[a-z]+\\*?\\})|(u|uu)line|(s|x)out|uwave)|((sub)?(((sub)?section)|paragraph)|part|chapter)\\*?)\\{", "")
970 || regex_replace(t, t, REGEX_BOS "\\$", "")
971 || regex_replace(t, t, REGEX_BOS "\\\\\\[ ", "")
972 || regex_replace(t, t, REGEX_BOS " ?\\\\item\\{[a-z]+\\}", "")
973 || regex_replace(t, t, REGEX_BOS "\\\\begin\\{[a-zA-Z_]*\\*?\\} ", ""))
975 LYXERR(Debug::FIND, " after removing leading $, \\[ , \\emph{, \\textbf{, etc.: '" << t << "'");
980 * Given a latexified string, retrieve some handled features
981 * The features of the regex will later be compared with the features
982 * of the searched text. If the regex features are not a
983 * subset of the analized, then, in not format ignoring search
984 * we can early stop the search in the relevant inset.
986 typedef map<string, bool> Features;
988 static Features identifyFeatures(string const & s)
990 static regex const feature("\\\\(([a-zA-Z]+(\\{([a-z]+\\*?)\\}|\\*)?))\\{");
991 static regex const valid("^("
993 "(footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge|"
994 "emph|noun|text(bf|md|sl|sf|it|tt)|"
995 "(textcolor|foreignlanguage|item|listitem|latexenvironment)\\{[a-z]+\\*?\\})|"
996 "(u|uu)line|(s|x)out|uwave|"
997 "(sub|extra)?title|author|subject|publishers|dedication|(upper|lower)titleback|lyx(right)?address)|"
998 "((sub)?(((sub)?section)|paragraph)|part|chapter|lyxslide)\\*?)$");
1003 for (sregex_iterator it(s.begin(), s.end(), feature), end; it != end; ++it) {
1006 if (sub.str(1).compare("regexp") == 0) {
1010 string token = sub.str(1);
1012 if (regex_match(token, sub2, valid)) {
1020 if (sub.str(1).compare("endregexp") == 0) {
1030 * defines values features of a key "\\[a-z]+{"
1035 /* Char type with content discarded
1036 * like \hspace{1cm} */
1038 /* Char, like \backslash */
1040 /* \part, \section*, ... */
1042 /* title, author etc */
1044 /* \foreignlanguage{ngerman}, ... */
1047 * to discard language in content */
1050 /* \begin{eqnarray}...\end{eqnarray}, ... $...$ */
1052 /* fonts, colors, markups, ... */
1054 /* footnotesize, ... large, ...
1055 * Ignore all of them */
1058 /* inputencoding, ...
1059 * Discard also content, because they do not help in search */
1062 * like remove, but also all arguments */
1064 /* item, listitem */
1066 /* tex, latex, ... like isChar */
1068 /* like \lettrine[lines=5]{}{} */
1070 /* End of arguments marker for lettrine,
1071 * so that they can be ignored */
1081 parenthesiscount(1),
1085 KeyInfo(KeyType type, int parcount, bool disable)
1091 parenthesiscount(parcount),
1100 int parenthesiscount;
1102 bool used; /* by pattern */
1107 Border(int l=0, int u=0) : low(l), upper(u) {};
1112 #define MAXOPENED 30
1114 bool isPatternString_;
1116 explicit Intervall(bool isPattern, string const & p) :
1117 isPatternString_(isPattern), par(p), ignoreidx(-1), actualdeptindex(0),
1126 static vector<Border> borders;
1127 int depts[MAXOPENED];
1128 int closes[MAXOPENED];
1129 int actualdeptindex;
1130 int previousNotIgnored(int);
1131 int nextNotIgnored(int);
1132 void handleOpenP(int i);
1133 void handleCloseP(int i, bool closingAllowed);
1134 void resetOpenedP(int openPos);
1135 void addIntervall(int upper);
1136 void addIntervall(int low, int upper); /* if explicit */
1137 void removeAccents();
1138 void setForDefaultLang(KeyInfo &defLang);
1139 int findclosing(int start, int end, char up, char down, int repeat);
1140 void handleParentheses(int lastpos, bool closingAllowed);
1142 int isOpeningPar(int pos);
1144 void output(ostringstream &os, int lastpos);
1145 // string show(int lastpos);
1148 vector<Border> Intervall::borders = vector<Border>(30);
1150 int Intervall::isOpeningPar(int pos)
1152 if ((pos < 0) || (size_t(pos) >= par.size()))
1154 if (par[pos] != '{')
1156 if (size_t(pos) + 2 >= par.size())
1158 if (par[pos+2] != '}')
1160 if (par[pos+1] == '[' || par[pos+1] == ']')
1165 void Intervall::setForDefaultLang(KeyInfo &defLang)
1167 // Enable the use of first token again
1168 if (ignoreidx >= 0) {
1169 int value = defLang._tokenstart + defLang._tokensize;
1171 if (borders[0].low < value)
1172 borders[0].low = value;
1173 if (borders[0].upper < value)
1174 borders[0].upper = value;
1179 static void checkDepthIndex(int val)
1181 static int maxdepthidx = MAXOPENED-2;
1182 static int lastmaxdepth = 0;
1183 if (val > lastmaxdepth) {
1184 LYXERR0("Depth reached " << val);
1187 if (val > maxdepthidx) {
1189 LYXERR0("maxdepthidx now " << val);
1194 // Not needed, because borders are now dynamically expanded
1195 static void checkIgnoreIdx(int val)
1197 static int lastmaxignore = -1;
1198 if ((lastmaxignore < val) && (size_t(val+1) >= borders.size())) {
1199 LYXERR0("IgnoreIdx reached " << val);
1200 lastmaxignore = val;
1206 * Expand the region of ignored parts of the input latex string
1207 * The region is only relevant in output()
1209 void Intervall::addIntervall(int low, int upper)
1212 if (low == upper) return;
1213 for (idx = ignoreidx+1; idx > 0; --idx) {
1214 if (low > borders[idx-1].upper) {
1218 Border br(low, upper);
1219 if (idx > ignoreidx) {
1220 if (borders.size() <= size_t(idx)) {
1221 borders.push_back(br);
1227 // checkIgnoreIdx(ignoreidx);
1231 // Expand only if one of the new bound is inside the interwall
1232 // We know here that br.low > borders[idx-1].upper
1233 if (br.upper < borders[idx].low) {
1234 // We have to insert at this pos
1235 if (size_t(ignoreidx+1) >= borders.size()) {
1236 borders.push_back(borders[ignoreidx]);
1239 borders[ignoreidx+1] = borders[ignoreidx];
1241 for (int i = ignoreidx; i > idx; --i) {
1242 borders[i] = borders[i-1];
1246 // checkIgnoreIdx(ignoreidx);
1249 // Here we know, that we are overlapping
1250 if (br.low > borders[idx].low)
1251 br.low = borders[idx].low;
1252 // check what has to be concatenated
1254 for (int i = idx; i <= ignoreidx; i++) {
1255 if (br.upper >= borders[i].low) {
1257 if (br.upper < borders[i].upper)
1258 br.upper = borders[i].upper;
1264 // count should be >= 1 here
1267 for (int i = idx + count; i <= ignoreidx; i++) {
1268 borders[i-count+1] = borders[i];
1270 ignoreidx -= count - 1;
1276 typedef map<string, string> AccentsMap;
1277 static AccentsMap accents = map<string, string>();
1279 static void buildaccent(string n, string param, string values)
1283 const char delim = '|';
1284 while (getline(s, name, delim)) {
1286 for (size_t i = 0; i < param.size(); i++) {
1287 string key = name + "{" + param[i] + "}";
1288 // get the corresponding utf8-value
1289 if ((values[start] & 0xc0) != 0xc0) {
1290 // should not happen, utf8 encoding starts at least with 11xxxxxx
1291 // but value for '\dot{i}' is 'i', which is ascii
1292 if ((values[start] & 0x80) == 0) {
1294 accents[key] = values.substr(start, 1);
1295 // LYXERR0("" << key << "=" << accents[key]);
1300 for (int j = 1; ;j++) {
1301 if (start + j >= values.size()) {
1302 accents[key] = values.substr(start, j);
1303 start = values.size() - 1;
1306 else if ((values[start+j] & 0xc0) != 0x80) {
1307 // This is the first byte of following utf8 char
1308 accents[key] = values.substr(start, j);
1310 // LYXERR0("" << key << "=" << accents[key]);
1318 static void buildAccentsMap()
1320 accents["imath"] = "ı";
1322 accents["jmath"] = "ȷ";
1323 accents["lyxmathsym{ß}"] = "ß";
1324 accents["text{ß}"] = "ß";
1325 accents["ddot{\\imath}"] = "ï";
1326 buildaccent("ddot", "aAeEiIioOuUyY",
1327 "äÄëËïÏïöÖüÜÿŸ"); // umlaut
1328 buildaccent("dot|.", "cCeEGgIizZaAoObBdDfFyY",
1329 "ċĊėĖĠġİİżŻȧȦȯȮḃḂḋḊḟḞẏẎ"); // dot{i} can only happen if ignoring case, but there is no lowercase of 'İ'
1330 accents["acute{\\imath}"] = "í";
1331 buildaccent("acute", "aAcCeElLoOnNrRsSuUyYzZiI",
1332 "áÁćĆéÉĺĹóÓńŃŕŔśŚúÚýÝźŹíÍ");
1333 buildaccent("dacute|H|h", "oOuU", "őŐűŰ"); // double acute
1334 buildaccent("mathring|r", "aAuUwy",
1336 accents["check{\\imath}"] = "ǐ";
1337 accents["check{\\jmath}"] = "ǰ";
1338 buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTtzZ",
1339 "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤťžŽ"); // caron
1340 accents["hat{\\imath}"] = "î";
1341 accents["hat{\\jmath}"] = "ĵ";
1342 buildaccent("hat|^", "aAeEiIcCgGhHjJsSwWyYzZoOuU",
1343 "âÂêÊîÎĉĈĝĜĥĤĵĴŝŜŵŴŷŶẑẐôÔûÛ"); // circ
1344 accents["bar{\\imath}"] = "ī";
1345 buildaccent("bar|=", "aAeEiIoOuUyY",
1346 "āĀēĒīĪōŌūŪȳȲ"); // macron
1347 accents["tilde{\\imath}"] = "ĩ";
1348 buildaccent("tilde", "aAnNoOiIuU",
1349 "ãÃñÑõÕĩĨũŨ"); // tilde
1350 accents["breve{\\imath}"] = "ĭ";
1351 buildaccent("breve|u", "aAeEgGiIoOuU",
1352 "ăĂĕĔğĞĭĬŏŎŭŬ"); // breve
1353 accents["grave{\\imath}"] = "ì";
1354 buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1355 "àÀèÈìÌòÒùÙǹǸẁẀỳỲ"); // grave
1356 buildaccent("subdot|d", "BbDdHhKkLlMmNnRrSsTtVvWwZzAaEeIiOoUuYy",
1357 "ḄḅḌḍḤḥḲḳḶḷṂṃṆṇṚṛṢṣṬṭṾṿẈẉẒẓẠạẸẹỊịỌọỤụỴỵ"); // dot below
1358 buildaccent("ogonek|k", "AaEeIiUuOo",
1359 "ĄąĘęĮįŲųǪǫ"); // ogonek
1360 buildaccent("cedilla|c", "CcGgKkLlNnRrSsTtEeDdHh",
1361 "ÇçĢĢĶķĻļŅņŖŗŞşŢţȨȩḐḑḨḩ"); // cedilla
1362 buildaccent("subring|textsubring", "Aa",
1364 buildaccent("subhat|textsubcircum", "DdEeLlNnTtUu",
1365 "ḒḓḘḙḼḽṊṋṰṱṶṷ"); // subcircum
1366 buildaccent("subtilde|textsubtilde", "EeIiUu",
1367 "ḚḛḬḭṴṵ"); // subtilde
1368 accents["dgrave{\\imath}"] = "ȉ";
1369 accents["textdoublegrave{\\i}"] = "ȉ";
1370 buildaccent("dgrave|textdoublegrave", "AaEeIiOoRrUu",
1371 "ȀȁȄȅȈȉȌȍȐȑȔȕ"); // double grave
1372 accents["rcap{\\imath}"] = "ȉ";
1373 accents["textroundcap{\\i}"] = "ȉ";
1374 buildaccent("rcap|textroundcap", "AaEeIiOoRrUu",
1375 "ȂȃȆȇȊȋȎȏȒȓȖȗ"); // inverted breve
1379 * Created accents in math or regexp environment
1380 * are macros, but we need the utf8 equivalent
1382 void Intervall::removeAccents()
1384 if (accents.empty())
1386 static regex const accre("\\\\(([\\S]|grave|breve|lyxmathsym|text|ddot|dot|acute|dacute|mathring|check|hat|bar|tilde|subdot|ogonek|cedilla|subring|textsubring|subhat|textsubcircum|subtilde|textsubtilde|dgrave|textdoublegrave|rcap|textroundcap)\\{[^\\{\\}]+\\}|(i|imath|jmath)(?![a-zA-Z]))");
1388 for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1390 string key = sub.str(1);
1391 if (accents.find(key) != accents.end()) {
1392 string val = accents[key];
1393 size_t pos = sub.position(size_t(0));
1394 for (size_t i = 0; i < val.size(); i++) {
1395 par[pos+i] = val[i];
1397 addIntervall(pos+val.size(), pos + sub.str(0).size());
1398 for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1399 // remove traces of any remaining chars
1404 LYXERR0("Not added accent for \"" << key << "\"");
1409 void Intervall::handleOpenP(int i)
1412 depts[actualdeptindex] = i+1;
1413 closes[actualdeptindex] = -1;
1414 checkDepthIndex(actualdeptindex);
1417 void Intervall::handleCloseP(int i, bool closingAllowed)
1419 if (actualdeptindex <= 0) {
1420 if (! closingAllowed)
1421 LYXERR(Debug::FIND, "Bad closing parenthesis in latex"); /* should not happen, but the latex input may be wrong */
1422 // if we are at the very end
1423 addIntervall(i, i+1);
1426 closes[actualdeptindex] = i+1;
1431 void Intervall::resetOpenedP(int openPos)
1433 // Used as initializer for foreignlanguage entry
1434 actualdeptindex = 1;
1435 depts[1] = openPos+1;
1439 int Intervall::previousNotIgnored(int start)
1441 int idx = 0; /* int intervalls */
1442 for (idx = ignoreidx; idx >= 0; --idx) {
1443 if (start > borders[idx].upper)
1445 if (start >= borders[idx].low)
1446 start = borders[idx].low-1;
1451 int Intervall::nextNotIgnored(int start)
1453 int idx = 0; /* int intervalls */
1454 for (idx = 0; idx <= ignoreidx; idx++) {
1455 if (start < borders[idx].low)
1457 if (start < borders[idx].upper)
1458 start = borders[idx].upper;
1463 typedef map<string, KeyInfo> KeysMap;
1464 typedef vector< KeyInfo> Entries;
1465 static KeysMap keys = map<string, KeyInfo>();
1471 Intervall interval_;
1472 void buildKeys(bool);
1473 void buildEntries(bool);
1474 void makeKey(const string &, KeyInfo, bool isPatternString);
1475 void processRegion(int start, int region_end); /* remove {} parts */
1476 void removeHead(KeyInfo&, int count=0);
1479 LatexInfo(string par, bool isPatternString) : entidx_(-1), interval_(isPatternString, par)
1481 buildKeys(isPatternString);
1482 entries_ = vector<KeyInfo>();
1483 buildEntries(isPatternString);
1487 if (entries_.empty()) {
1490 if (entries_[0].keytype == KeyInfo::isTitle) {
1491 if (! entries_[0].disabled) {
1492 interval_.hasTitle = true;
1493 interval_.titleValue = entries_[0].head;
1496 interval_.hasTitle = false;
1497 interval_.titleValue = "";
1499 removeHead(entries_[0]);
1500 if (entries_.size() > 1)
1509 if (int(entries_.size()) > entidx_) {
1516 bool setNextKey(int idx) {
1517 if ((idx == entidx_) && (entidx_ >= 0)) {
1524 int find(int start, KeyInfo::KeyType keytype) {
1528 while (tmpIdx < int(entries_.size())) {
1529 if (entries_[tmpIdx].keytype == keytype)
1535 int process(ostringstream &os, KeyInfo &actual);
1536 int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1537 // string show(int lastpos) { return interval.show(lastpos);};
1538 int nextNotIgnored(int start) { return interval_.nextNotIgnored(start);};
1539 KeyInfo &getKeyInfo(int keyinfo) {
1540 static KeyInfo invalidInfo = KeyInfo();
1541 if ((keyinfo < 0) || ( keyinfo >= int(entries_.size())))
1544 return entries_[keyinfo];
1546 void setForDefaultLang(KeyInfo &defLang) {interval_.setForDefaultLang(defLang);};
1547 void addIntervall(int low, int up) { interval_.addIntervall(low, up); };
1551 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1556 for (int i = start; i < end; i += 1 + skip) {
1560 if (c == '\\') skip = 1;
1564 else if (c == down) {
1566 if ((repeat <= 0) || (par[i+1] != up))
1584 vector<MathEntry> entries_;
1589 void insert(string wait, size_t start, size_t end) {
1590 MathEntry m = MathEntry();
1592 m.mathStart = start;
1594 m.mathSize = end - start;
1595 entries_.push_back(m);
1597 bool empty() { return entries_.empty(); };
1598 size_t getEndPos() {
1599 if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1602 return entries_[actualIdx_].mathEnd;
1604 size_t getStartPos() {
1605 if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1606 return 100000; /* definitely enough? */
1608 return entries_[actualIdx_].mathStart;
1610 size_t getFirstPos() {
1612 return getStartPos();
1615 if (entries_.empty() || (actualIdx_ >= entries_.size())) {
1618 return entries_[actualIdx_].mathSize;
1620 void incrEntry() { actualIdx_++; };
1623 void LatexInfo::buildEntries(bool isPatternString)
1625 static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1626 static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1627 static bool disableLanguageOverride = false;
1628 smatch sub, submath;
1629 bool evaluatingRegexp = false;
1631 bool evaluatingMath = false;
1632 bool evaluatingCode = false;
1634 bool evaluatingOptional = false;
1635 size_t optionalEnd = 0;
1638 bool math_end_waiting = false;
1639 size_t math_pos = 10000;
1642 interval_.removeAccents();
1644 for (sregex_iterator itmath(interval_.par.begin(), interval_.par.end(), rmath), end; itmath != end; ++itmath) {
1646 if (math_end_waiting) {
1647 size_t pos = submath.position(size_t(0));
1648 if ((math_end == "$") &&
1649 (submath.str(0) == "$") &&
1650 (interval_.par[pos-1] != '\\')) {
1651 mi.insert("$", math_pos, pos + 1);
1652 math_end_waiting = false;
1654 else if ((math_end == "\\]") &&
1655 (submath.str(0) == "\\]")) {
1656 mi.insert("\\]", math_pos, pos + 2);
1657 math_end_waiting = false;
1659 else if ((submath.str(1).compare("end") == 0) &&
1660 (submath.str(2).compare(math_end) == 0)) {
1661 mi.insert(math_end, math_pos, pos + submath.str(0).length());
1662 math_end_waiting = false;
1668 if (submath.str(1).compare("begin") == 0) {
1669 math_end_waiting = true;
1670 math_end = submath.str(2);
1671 math_pos = submath.position(size_t(0));
1673 else if (submath.str(0).compare("\\[") == 0) {
1674 math_end_waiting = true;
1676 math_pos = submath.position(size_t(0));
1678 else if (submath.str(0) == "$") {
1679 size_t pos = submath.position(size_t(0));
1680 if ((pos == 0) || (interval_.par[pos-1] != '\\')) {
1681 math_end_waiting = true;
1688 // Ignore language if there is math somewhere in pattern-string
1689 if (isPatternString) {
1692 keys["foreignlanguage"].disabled = true;
1693 disableLanguageOverride = true;
1696 disableLanguageOverride = false;
1699 if (disableLanguageOverride) {
1700 keys["foreignlanguage"].disabled = true;
1703 math_pos = mi.getFirstPos();
1704 for (sregex_iterator it(interval_.par.begin(), interval_.par.end(), rkeys), end; it != end; ++it) {
1706 string key = sub.str(3);
1708 if (sub.str(0)[0] == '\\')
1709 key = sub.str(0)[1];
1713 size_t k_pos = sub.position(size_t(0));
1714 if ((k_pos > 0) && (interval_.par[k_pos - 1] == '\\')) {
1715 // Escaped '$', ignoring
1721 if (evaluatingRegexp) {
1722 if (sub.str(1).compare("endregexp") == 0) {
1723 evaluatingRegexp = false;
1724 // found._tokenstart already set
1725 found._dataEnd = sub.position(size_t(0)) + 13;
1726 found._dataStart = found._dataEnd;
1727 found._tokensize = found._dataEnd - found._tokenstart;
1728 found.parenthesiscount = 0;
1729 found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1736 if (evaluatingMath) {
1737 if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1739 evaluatingMath = false;
1741 math_pos = mi.getStartPos();
1743 if (keys.find(key) == keys.end()) {
1744 found = KeyInfo(KeyInfo::isStandard, 0, true);
1745 if (isPatternString) {
1746 found.keytype = KeyInfo::isChar;
1747 found.disabled = false;
1754 if (key.compare("regexp") == 0) {
1755 evaluatingRegexp = true;
1756 found._tokenstart = sub.position(size_t(0));
1757 found._tokensize = 0;
1761 // Handle the other params of key
1762 if (found.keytype == KeyInfo::isIgnored)
1764 else if (found.keytype == KeyInfo::isMath) {
1765 if (size_t(sub.position(size_t(0))) == math_pos) {
1767 found._tokenstart = sub.position(size_t(0));
1768 found._tokensize = mi.getSize();
1769 found._dataEnd = found._tokenstart + found._tokensize;
1770 found._dataStart = found._dataEnd;
1771 found.parenthesiscount = 0;
1772 found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1773 evaluatingMath = true;
1776 // begin|end of unknown env, discard
1777 // First handle tables
1778 // longtable|tabular
1779 bool discardComment;
1781 found.keytype = KeyInfo::doRemove;
1782 if ((sub.str(5).compare("longtable") == 0) ||
1783 (sub.str(5).compare("tabular") == 0)) {
1784 discardComment = true; /* '%' */
1787 discardComment = false;
1788 static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1790 string token = sub.str(5);
1791 if (regex_match(token, sub2, removeArgs)) {
1792 found.keytype = KeyInfo::removeWithArg;
1795 // discard spaces before pos(0)
1796 int pos = sub.position(size_t(0));
1798 for (count = 0; pos - count > 0; count++) {
1799 char c = interval_.par[pos-count-1];
1800 if (discardComment) {
1801 if ((c != ' ') && (c != '%'))
1807 found._tokenstart = pos - count;
1808 if (sub.str(1).compare(0, 5, "begin") == 0) {
1809 size_t pos1 = pos + sub.str(0).length();
1810 if (sub.str(5).compare("cjk") == 0) {
1811 pos1 = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1812 if ((interval_.par[pos1] == '{') && (interval_.par[pos1+1] == '}'))
1814 found.keytype = KeyInfo::isMain;
1815 found._dataStart = pos1;
1816 found._dataEnd = interval_.par.length();
1817 found.disabled = keys["foreignlanguage"].disabled;
1818 found.used = keys["foreignlanguage"].used;
1819 found._tokensize = pos1 - found._tokenstart;
1820 found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1823 // Swallow possible optional params
1824 while (interval_.par[pos1] == '[') {
1825 pos1 = interval_.findclosing(pos1+1, interval_.par.length(), '[', ']')+1;
1827 // Swallow also the eventual parameter
1828 if (interval_.par[pos1] == '{') {
1829 found._dataEnd = interval_.findclosing(pos1+1, interval_.par.length()) + 1;
1832 found._dataEnd = pos1;
1834 found._dataStart = found._dataEnd;
1835 found._tokensize = count + found._dataEnd - pos;
1836 found.parenthesiscount = 0;
1837 found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1838 found.disabled = true;
1842 // Handle "\end{...}"
1843 found._dataStart = pos + sub.str(0).length();
1844 found._dataEnd = found._dataStart;
1845 found._tokensize = count + found._dataEnd - pos;
1846 found.parenthesiscount = 0;
1847 found.head = interval_.par.substr(found._tokenstart, found._tokensize);
1848 found.disabled = true;
1852 else if (found.keytype != KeyInfo::isRegex) {
1853 found._tokenstart = sub.position(size_t(0));
1854 if (found.parenthesiscount == 0) {
1855 // Probably to be discarded
1856 size_t following_pos = sub.position(size_t(0)) + sub.str(3).length() + 1;
1857 char following = interval_.par[following_pos];
1858 if (following == ' ')
1859 found.head = "\\" + sub.str(3) + " ";
1860 else if (following == '=') {
1861 // like \uldepth=1000pt
1862 found.head = sub.str(0);
1865 found.head = "\\" + key;
1866 found._tokensize = found.head.length();
1867 found._dataEnd = found._tokenstart + found._tokensize;
1868 found._dataStart = found._dataEnd;
1871 int params = found._tokenstart + key.length() + 1;
1872 if (evaluatingOptional) {
1873 if (size_t(found._tokenstart) > optionalEnd) {
1874 evaluatingOptional = false;
1877 found.disabled = true;
1880 int optend = params;
1881 while (interval_.par[optend] == '[') {
1882 // discard optional parameters
1883 optend = interval_.findclosing(optend+1, interval_.par.length(), '[', ']') + 1;
1885 if (optend > params) {
1886 key += interval_.par.substr(params, optend-params);
1887 evaluatingOptional = true;
1888 optionalEnd = optend;
1890 string token = sub.str(5);
1891 int closings = found.parenthesiscount;
1892 if (found.parenthesiscount == 1) {
1893 found.head = "\\" + key + "{";
1895 else if (found.parenthesiscount > 1) {
1897 found.head = sub.str(0) + "{";
1898 closings = found.parenthesiscount - 1;
1901 found.head = "\\" + key + "{";
1904 found._tokensize = found.head.length();
1905 found._dataStart = found._tokenstart + found.head.length();
1906 if (interval_.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
1907 found._dataStart += 15;
1909 size_t endpos = interval_.findclosing(found._dataStart, interval_.par.length(), '{', '}', closings);
1910 if (found.keytype == KeyInfo::isList) {
1911 // Check if it really is list env
1912 static regex const listre("^([a-z]+)$");
1914 if (!regex_match(token, sub2, listre)) {
1915 // Change the key of this entry. It is not in a list/item environment
1916 found.keytype = KeyInfo::endArguments;
1919 if (found.keytype == KeyInfo::noMain) {
1920 evaluatingCode = true;
1922 codeStart = found._dataStart;
1924 else if (evaluatingCode) {
1925 if (size_t(found._dataStart) > codeEnd)
1926 evaluatingCode = false;
1927 else if (found.keytype == KeyInfo::isMain) {
1928 // Disable this key, treate it as standard
1929 found.keytype = KeyInfo::isStandard;
1930 found.disabled = true;
1931 if ((codeEnd == interval_.par.length()) &&
1932 (found._tokenstart == codeStart)) {
1933 // trickery, because the code inset starts
1934 // with \selectlanguage ...
1936 if (entries_.size() > 1) {
1937 entries_[entries_.size()-1]._dataEnd = codeEnd;
1942 if ((endpos == interval_.par.length()) &&
1943 (found.keytype == KeyInfo::doRemove)) {
1944 // Missing closing => error in latex-input?
1945 // therefore do not delete remaining data
1946 found._dataStart -= 1;
1947 found._dataEnd = found._dataStart;
1950 found._dataEnd = endpos;
1952 if (isPatternString) {
1953 keys[key].used = true;
1956 entries_.push_back(found);
1960 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1962 stringstream s(keysstring);
1964 const char delim = '|';
1965 while (getline(s, key, delim)) {
1966 KeyInfo keyII(keyI);
1967 if (isPatternString) {
1970 else if ( !keys[key].used)
1971 keyII.disabled = true;
1976 void LatexInfo::buildKeys(bool isPatternString)
1979 static bool keysBuilt = false;
1980 if (keysBuilt && !isPatternString) return;
1982 // Known standard keys with 1 parameter.
1983 // Split is done, if not at start of region
1984 makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1985 makeKey("textbf", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1986 makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1987 makeKey("uuline|uline|uwave", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1988 makeKey("emph|noun", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1989 makeKey("sout|xout", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1991 makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1992 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1993 makeKey("section*|subsection*|subsubsection*|paragraph*",
1994 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1995 makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1996 makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
1998 makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
2000 // Split is done, if not at start of region
2001 makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
2002 makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
2004 // Split is done always.
2005 makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
2009 makeKey("backslash|textbackslash|slash", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2010 makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2011 makeKey("textasciiacute|texemdash", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2012 makeKey("dots|ldots", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2014 makeKey("quad|qquad|hfill|dotfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2015 makeKey("textvisiblespace|nobreakspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2016 makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2018 // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2019 // Custom space/skip, remove the content (== length value)
2020 makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
2021 // Found in fr/UserGuide.lyx
2022 makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2024 makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2025 makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2026 // Known macros to remove (including their parameter)
2028 makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
2029 makeKey("addtocounter|setlength", KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
2030 // handle like standard keys with 1 parameter.
2031 makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
2033 // Macros to remove, but let the parameter survive
2035 makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2037 // Remove language spec from content of these insets
2038 makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
2040 // Same effect as previous, parameter will survive (because there is no one anyway)
2042 makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2043 // Remove table decorations
2044 makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
2045 // Discard shape-header.
2046 // For footnote or shortcut too, because of lang settings
2047 // and wrong handling if used 'KeyInfo::noMain'
2048 makeKey("circlepar|diamondpar|heartpar|nutpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2049 makeKey("trianglerightpar|hexagonpar|starpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2050 makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2051 makeKey("triangleleftpar|shapepar|dropuppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2052 makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2053 makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2054 // like ('tiny{}' or '\tiny ' ... )
2055 makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2057 // Survives, like known character
2058 makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2059 makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2061 makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2062 makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2063 makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2065 makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2066 // Remove RTL/LTR marker
2067 makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2068 makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2069 makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2070 makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2071 makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2072 makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2073 makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2074 if (isPatternString) {
2075 // Allow the first searched string to rebuild the keys too
2079 // no need to rebuild again
2085 * Keep the list of actual opened parentheses actual
2086 * (e.g. depth == 4 means there are 4 '{' not processed yet)
2088 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2091 for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2095 if (c == '\\') skip = 1;
2096 else if (c == '{') {
2099 else if (c == '}') {
2100 handleCloseP(i, closingAllowed);
2106 string Intervall::show(int lastpos)
2108 int idx = 0; /* int intervalls */
2111 for (idx = 0; idx <= ignoreidx; idx++) {
2112 while (i < lastpos) {
2114 if (i <= borders[idx].low) {
2115 if (borders[idx].low > lastpos)
2116 printsize = lastpos - i;
2118 printsize = borders[idx].low - i;
2119 s += par.substr(i, printsize);
2121 if (i >= borders[idx].low)
2122 i = borders[idx].upper;
2125 i = borders[idx].upper;
2131 s += par.substr(i, lastpos-i);
2137 void Intervall::output(ostringstream &os, int lastpos)
2139 // get number of chars to output
2140 int idx = 0; /* int intervalls */
2143 string startTitle = titleValue;
2144 for (idx = 0; idx <= ignoreidx; idx++) {
2146 if (i <= borders[idx].low) {
2148 if (borders[idx].low > lastpos)
2149 printsize = lastpos - i;
2151 printsize = borders[idx].low - i;
2152 if (printsize > 0) {
2153 os << startTitle << par.substr(i, printsize);
2155 printed += printsize;
2158 handleParentheses(i, false);
2159 if (i >= borders[idx].low)
2160 i = borders[idx].upper;
2163 i = borders[idx].upper;
2170 os << startTitle << par.substr(i, lastpos-i);
2171 printed += lastpos-i;
2173 handleParentheses(lastpos, false);
2174 for (int i = actualdeptindex; i > 0; --i) {
2177 if (hasTitle && (printed > 0))
2179 if (! isPatternString_)
2181 handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2184 void LatexInfo::processRegion(int start, int region_end)
2186 while (start < region_end) { /* Let {[} and {]} survive */
2187 int cnt = interval_.isOpeningPar(start);
2189 // Closing is allowed past the region
2190 int closing = interval_.findclosing(start+1, interval_.par.length());
2191 interval_.addIntervall(start, start+1);
2192 interval_.addIntervall(closing, closing+1);
2196 start = interval_.nextNotIgnored(start+1);
2200 void LatexInfo::removeHead(KeyInfo &actual, int count)
2202 if (actual.parenthesiscount == 0) {
2203 // "{\tiny{} ...}" ==> "{{} ...}"
2204 interval_.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2207 // Remove header hull, that is "\url{abcd}" ==> "abcd"
2208 interval_.addIntervall(actual._tokenstart - count, actual._dataStart);
2209 interval_.addIntervall(actual._dataEnd, actual._dataEnd+1);
2213 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2216 switch (actual.keytype)
2218 case KeyInfo::isTitle: {
2220 nextKeyIdx = getNextKey();
2223 case KeyInfo::cleanToStart: {
2224 actual._dataEnd = actual._dataStart;
2225 nextKeyIdx = getNextKey();
2226 // Search for end of arguments
2227 int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2229 for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2230 entries_[i].disabled = true;
2232 actual._dataEnd = entries_[tmpIdx]._dataEnd;
2234 while (interval_.par[actual._dataEnd] == ' ')
2236 interval_.addIntervall(0, actual._dataEnd+1);
2237 interval_.actualdeptindex = 0;
2238 interval_.depts[0] = actual._dataEnd+1;
2239 interval_.closes[0] = -1;
2242 case KeyInfo::noContent: { /* char like "\hspace{2cm}" */
2243 if (actual.disabled)
2244 interval_.addIntervall(actual._tokenstart, actual._dataEnd);
2246 interval_.addIntervall(actual._dataStart, actual._dataEnd);
2249 case KeyInfo::isChar: {
2250 nextKeyIdx = getNextKey();
2253 case KeyInfo::isSize: {
2254 if (actual.disabled || (interval_.par[actual._dataStart] != '{') || (interval_.par[actual._dataStart-1] == ' ')) {
2255 processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
2256 interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2257 nextKeyIdx = getNextKey();
2259 // Here _dataStart points to '{', so correct it
2260 actual._dataStart += 1;
2261 actual._tokensize += 1;
2262 actual.parenthesiscount = 1;
2263 if (interval_.par[actual._dataStart] == '}') {
2264 // Determine the end if used like '{\tiny{}...}'
2265 actual._dataEnd = interval_.findclosing(actual._dataStart+1, interval_.par.length()) + 1;
2266 interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2269 // Determine the end if used like '\tiny{...}'
2270 actual._dataEnd = interval_.findclosing(actual._dataStart, interval_.par.length()) + 1;
2272 // Split on this key if not at start
2273 int start = interval_.nextNotIgnored(previousStart);
2274 if (start < actual._tokenstart) {
2275 interval_.output(os, actual._tokenstart);
2276 interval_.addIntervall(start, actual._tokenstart);
2278 // discard entry if at end of actual
2279 nextKeyIdx = process(os, actual);
2283 case KeyInfo::endArguments:
2284 // Remove trailing '{}' too
2285 actual._dataStart += 1;
2286 actual._dataEnd += 1;
2287 interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2288 nextKeyIdx = getNextKey();
2290 case KeyInfo::noMain:
2292 case KeyInfo::isStandard: {
2293 if (actual.disabled) {
2295 processRegion(actual._dataStart, actual._dataStart+1);
2296 nextKeyIdx = getNextKey();
2298 // Split on this key if not at datastart of calling entry
2299 int start = interval_.nextNotIgnored(previousStart);
2300 if (start < actual._tokenstart) {
2301 interval_.output(os, actual._tokenstart);
2302 interval_.addIntervall(start, actual._tokenstart);
2304 // discard entry if at end of actual
2305 nextKeyIdx = process(os, actual);
2309 case KeyInfo::removeWithArg: {
2310 nextKeyIdx = getNextKey();
2311 // Search for end of arguments
2312 int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2314 for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2315 entries_[i].disabled = true;
2317 actual._dataEnd = entries_[tmpIdx]._dataEnd;
2319 interval_.addIntervall(actual._tokenstart, actual._dataEnd+1);
2322 case KeyInfo::doRemove: {
2323 // Remove the key with all parameters and following spaces
2325 for (pos = actual._dataEnd+1; pos < interval_.par.length(); pos++) {
2326 if ((interval_.par[pos] != ' ') && (interval_.par[pos] != '%'))
2329 interval_.addIntervall(actual._tokenstart, pos);
2330 nextKeyIdx = getNextKey();
2333 case KeyInfo::isList: {
2334 // Discard space before _tokenstart
2336 for (count = 0; count < actual._tokenstart; count++) {
2337 if (interval_.par[actual._tokenstart-count-1] != ' ')
2340 nextKeyIdx = getNextKey();
2341 int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2343 // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2345 // How else can we catch this one?
2346 for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2347 entries_[i].disabled = true;
2349 actual._dataEnd = entries_[tmpIdx]._dataEnd;
2351 else if (nextKeyIdx > 0) {
2352 // Ignore any lang entries inside data region
2353 for (int i = nextKeyIdx; i < int(entries_.size()) && entries_[i]._tokenstart < actual._dataEnd; i++) {
2354 if (entries_[i].keytype == KeyInfo::isMain)
2355 entries_[i].disabled = true;
2358 if (actual.disabled) {
2359 interval_.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2362 interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2364 if (interval_.par[actual._dataEnd+1] == '[') {
2365 int posdown = interval_.findclosing(actual._dataEnd+2, interval_.par.length(), '[', ']');
2366 if ((interval_.par[actual._dataEnd+2] == '{') &&
2367 (interval_.par[posdown-1] == '}')) {
2368 interval_.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2369 interval_.addIntervall(posdown-1, posdown+1);
2372 interval_.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2373 interval_.addIntervall(posdown, posdown+1);
2375 int blk = interval_.nextNotIgnored(actual._dataEnd+1);
2376 if (blk > posdown) {
2377 // Discard at most 1 space after empty item
2379 for (count = 0; count < 1; count++) {
2380 if (interval_.par[blk+count] != ' ')
2384 interval_.addIntervall(blk, blk+count);
2389 case KeyInfo::isSectioning: {
2390 // Discard spaces before _tokenstart
2392 int val = actual._tokenstart;
2393 for (count = 0; count < actual._tokenstart;) {
2394 val = interval_.previousNotIgnored(val-1);
2395 if (interval_.par[val] != ' ')
2398 count = actual._tokenstart - val;
2401 if (actual.disabled) {
2402 removeHead(actual, count);
2403 nextKeyIdx = getNextKey();
2405 interval_.addIntervall(actual._tokenstart-count, actual._tokenstart);
2406 nextKeyIdx = process(os, actual);
2410 case KeyInfo::isMath: {
2411 // Same as regex, use the content unchanged
2412 nextKeyIdx = getNextKey();
2415 case KeyInfo::isRegex: {
2416 // DO NOT SPLIT ON REGEX
2418 nextKeyIdx = getNextKey();
2421 case KeyInfo::isIgnored: {
2422 // Treat like a character for now
2423 nextKeyIdx = getNextKey();
2426 case KeyInfo::isMain: {
2427 if (interval_.par.substr(actual._dataStart, 2) == "% ")
2428 interval_.addIntervall(actual._dataStart, actual._dataStart+2);
2429 if (actual._tokenstart > 0) {
2430 int prev = interval_.previousNotIgnored(actual._tokenstart - 1);
2431 if ((prev >= 0) && interval_.par[prev] == '%')
2432 interval_.addIntervall(prev, prev+1);
2434 if (actual.disabled) {
2436 if ((interval_.par.substr(actual._dataStart, 3) == " \\[") ||
2437 (interval_.par.substr(actual._dataStart, 8) == " \\begin{")) {
2438 // Discard also the space before math-equation
2439 interval_.addIntervall(actual._dataStart, actual._dataStart+1);
2441 nextKeyIdx = getNextKey();
2442 // interval.resetOpenedP(actual._dataStart-1);
2445 if (actual._tokenstart < 26) {
2446 // for the first (and maybe dummy) language
2447 interval_.setForDefaultLang(actual);
2449 interval_.resetOpenedP(actual._dataStart-1);
2453 case KeyInfo::invalid:
2454 // This cannot happen, already handled
2457 // LYXERR0("Unhandled keytype");
2458 nextKeyIdx = getNextKey();
2465 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
2467 int end = interval_.nextNotIgnored(actual._dataEnd);
2468 int oldStart = actual._dataStart;
2469 int nextKeyIdx = getNextKey();
2471 if ((nextKeyIdx < 0) ||
2472 (entries_[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2473 (entries_[nextKeyIdx].keytype == KeyInfo::invalid)) {
2474 if (oldStart <= end) {
2475 processRegion(oldStart, end);
2480 KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2482 if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2483 (void) dispatch(os, actual._dataStart, nextKey);
2484 end = nextKey._tokenstart;
2487 processRegion(oldStart, nextKey._tokenstart);
2488 nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2490 oldStart = nextKey._dataEnd+1;
2492 // now nextKey is either invalid or is outside of actual._dataEnd
2493 // output the remaining and discard myself
2494 if (oldStart <= end) {
2495 processRegion(oldStart, end);
2497 if (interval_.par[end] == '}') {
2499 // This is the normal case.
2500 // But if using the firstlanguage, the closing may be missing
2502 // get minimum of 'end' and 'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2504 if (actual._dataEnd < end)
2505 output_end = interval_.nextNotIgnored(actual._dataEnd);
2507 output_end = interval_.nextNotIgnored(end);
2508 if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2509 interval_.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2511 // Remove possible empty data
2512 int dstart = interval_.nextNotIgnored(actual._dataStart);
2513 while (interval_.isOpeningPar(dstart) == 1) {
2514 interval_.addIntervall(dstart, dstart+1);
2515 int dend = interval_.findclosing(dstart+1, output_end);
2516 interval_.addIntervall(dend, dend+1);
2517 dstart = interval_.nextNotIgnored(dstart+1);
2519 if (dstart < output_end)
2520 interval_.output(os, output_end);
2521 interval_.addIntervall(actual._tokenstart, end);
2525 string splitOnKnownMacros(string par, bool isPatternString)
2528 LatexInfo li(par, isPatternString);
2529 // LYXERR0("Berfore split: " << par);
2530 KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2532 DummyKey._tokensize = 0;
2533 DummyKey._dataStart = 0;
2534 DummyKey._dataEnd = par.length();
2535 DummyKey.disabled = true;
2536 int firstkeyIdx = li.getFirstKey();
2538 if (firstkeyIdx >= 0) {
2539 KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2540 DummyKey._tokenstart = firstKey._tokenstart;
2542 if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2543 // Use dummy firstKey
2544 firstKey = DummyKey;
2545 (void) li.setNextKey(firstkeyIdx);
2548 if (par.substr(firstKey._dataStart, 2) == "% ")
2549 li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2551 nextkeyIdx = li.process(os, firstKey);
2552 while (nextkeyIdx >= 0) {
2553 // Check for a possible gap between the last
2554 // entry and this one
2555 int datastart = li.nextNotIgnored(firstKey._dataStart);
2556 KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2557 if ((nextKey._tokenstart > datastart)) {
2559 firstKey._dataStart = datastart;
2560 firstKey._dataEnd = par.length();
2561 (void) li.setNextKey(nextkeyIdx);
2562 // Fake the last opened parenthesis
2563 li.setForDefaultLang(firstKey);
2564 nextkeyIdx = li.process(os, firstKey);
2567 if (nextKey.keytype != KeyInfo::isMain) {
2568 firstKey._dataStart = datastart;
2569 firstKey._dataEnd = nextKey._dataEnd+1;
2570 (void) li.setNextKey(nextkeyIdx);
2571 li.setForDefaultLang(firstKey);
2572 nextkeyIdx = li.process(os, firstKey);
2575 nextkeyIdx = li.process(os, nextKey);
2579 // Handle the remaining
2580 firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2581 firstKey._dataEnd = par.length();
2583 if ((firstKey._dataStart < firstKey._dataEnd) &&
2584 (par[firstKey._dataStart] != '}')) {
2585 li.setForDefaultLang(firstKey);
2586 (void) li.process(os, firstKey);
2590 // return string definitelly impossible to match
2591 s = "\\foreignlanguage{ignore}{ }";
2595 s = par; /* no known macros found */
2596 // LYXERR0("After split: " << s);
2601 * Try to unify the language specs in the latexified text.
2602 * Resulting modified string is set to "", if
2603 * the searched tex does not contain all the features in the search pattern
2605 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2607 static Features regex_f;
2608 static int missed = 0;
2609 static bool regex_with_format = false;
2611 int parlen = par.length();
2613 while ((parlen > 0) && (par[parlen-1] == '\n')) {
2616 if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2617 // Happens to be there in case of description or labeling environment
2622 // Split the latex input into pieces which
2623 // can be digested by our search engine
2624 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2625 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2626 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2629 result = par.substr(0, parlen);
2630 if (isPatternString) {
2633 regex_f = identifyFeatures(result);
2634 string features = "";
2635 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2636 string a = it->first;
2637 regex_with_format = true;
2638 features += " " + a;
2639 // LYXERR0("Identified regex format:" << a);
2641 LYXERR(Debug::FIND, "Identified Features" << features);
2644 } else if (regex_with_format) {
2645 Features info = identifyFeatures(result);
2646 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2647 string a = it->first;
2648 bool b = it->second;
2649 if (b && ! info[a]) {
2651 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2657 // LYXERR0("No regex formats");
2663 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2664 static int identifyClosing(string & t)
2666 int open_braces = 0;
2668 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2669 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2671 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2673 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2675 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2684 static int num_replaced = 0;
2685 static bool previous_single_replace = true;
2687 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2688 : p_buf(&buf), p_first_buf(&buf), opt(opt)
2690 Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2691 docstring const & ds = stringifySearchBuffer(find_buf, opt);
2692 use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2693 if (opt.replace_all && previous_single_replace) {
2694 previous_single_replace = false;
2697 else if (!opt.replace_all) {
2698 num_replaced = 0; // count number of replaced strings
2699 previous_single_replace = true;
2701 // When using regexp, braces are hacked already by escape_for_regex()
2702 par_as_string = normalize(ds, !use_regexp);
2704 close_wildcards = 0;
2706 size_t lead_size = 0;
2707 // correct the language settings
2708 par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2709 if (opt.ignoreformat) {
2711 // if par_as_string_nolead were emty,
2712 // the following call to findAux will always *find* the string
2713 // in the checked data, and thus always using the slow
2714 // examining of the current text part.
2715 par_as_string_nolead = par_as_string;
2718 lead_size = identifyLeading(par_as_string);
2719 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2720 lead_as_string = par_as_string.substr(0, lead_size);
2721 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2725 open_braces = identifyClosing(par_as_string);
2726 identifyClosing(par_as_string_nolead);
2727 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2728 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2730 string lead_as_regexp;
2731 if (lead_size > 0) {
2732 // @todo No need to search for \regexp{} insets in leading material
2733 lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2734 par_as_string = par_as_string_nolead;
2735 LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2736 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2738 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2739 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2740 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2742 // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2743 regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2744 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2745 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2746 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2747 || regex_replace(par_as_string, par_as_string,
2748 "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2749 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2750 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2754 if (!opt.ignoreformat) {
2755 // Remove extra '\}' at end if not part of \{\.\}
2756 size_t lng = par_as_string.size();
2758 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
2760 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
2769 if (lng < par_as_string.size())
2770 par_as_string = par_as_string.substr(0,lng);
2773 regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2774 // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2775 regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2776 // replace '[^...]' with '[^...\}\{\\]'
2777 regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2778 regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2779 regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2781 regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2784 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2785 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2786 LYXERR(Debug::FIND, "Close .*? : " << close_wildcards);
2787 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2789 // If entered regexp must match at begin of searched string buffer
2790 // Kornel: Added parentheses to use $1 for size of the leading string
2794 // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2795 // Unfortunately is '\1', '\2', etc not working for strings with extra format
2796 // so the convert has no effect in that case
2797 for (int i = 8; i > 0; --i) {
2798 string orig = "\\\\" + std::to_string(i);
2799 string dest = "\\" + std::to_string(i+1);
2800 while (regex_replace(par_as_string, par_as_string, orig, dest));
2802 regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2803 regexp2_str = "(" + lead_as_regexp + ").*?" + par_as_string;
2805 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2806 regexp = lyx::regex(regexp_str);
2808 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2809 regexp2 = lyx::regex(regexp2_str);
2814 // Count number of characters in string
2818 // \\[a-zA-Z]+ ==> 1
2819 static int computeSize(string s, int len)
2825 for (int i = 0; i < len; i += skip, count++) {
2828 if (isalpha(s[i+1])) {
2829 for (int j = 2; i+j < len; j++) {
2830 if (! isalpha(s[i+j])) {
2833 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2835 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2843 else if (s[i] == '{') {
2849 else if (s[i] == '-') {
2850 if (s[i+1] == '-') {
2866 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2871 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2874 docstring docstr = stringifyFromForSearch(opt, cur, len);
2875 string str = normalize(docstr, true);
2876 if (!opt.ignoreformat) {
2877 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2880 mres.match_len = -1;
2883 LYXERR(Debug::FIND, "Matching against '" << lyx::to_utf8(docstr) << "'");
2884 LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2887 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2888 regex const *p_regexp;
2889 regex_constants::match_flag_type flags;
2891 flags = regex_constants::match_continuous;
2894 flags = regex_constants::match_default;
2895 p_regexp = ®exp2;
2897 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2898 if (re_it == sregex_iterator())
2900 match_results<string::const_iterator> const & m = *re_it;
2902 if (0) { // Kornel Benko: DO NOT CHECKK
2903 // Check braces on the segment that matched the entire regexp expression,
2904 // plus the last subexpression, if a (.*?) was inserted in the constructor.
2905 if (!braces_match(m[0].first, m[0].second, open_braces))
2909 // Check braces on segments that matched all (.*?) subexpressions,
2910 // except the last "padding" one inserted by lyx.
2911 for (size_t i = 1; i < m.size() - 1; ++i)
2912 if (!braces_match(m[i].first, m[i].second, open_braces))
2915 // Exclude from the returned match length any length
2916 // due to close wildcards added at end of regexp
2917 // and also the length of the leading (e.g. '\emph{}')
2919 // Whole found string, including the leading: m[0].second - m[0].first
2920 // Size of the leading string: m[1].second - m[1].first
2921 int leadingsize = 0;
2923 leadingsize = m[1].second - m[1].first;
2925 for (size_t i = 0; i < m.size(); i++) {
2926 LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2928 if (close_wildcards == 0)
2929 result = m[0].second - m[0].first;
2932 result = m[m.size() - close_wildcards].first - m[0].first;
2934 size_t pos = m.position(size_t(0));
2935 // Ignore last closing characters
2936 while (result > 0) {
2937 if (str[pos+result-1] == '}')
2942 if (result > leadingsize)
2943 result -= leadingsize;
2946 mres.match_len = computeSize(str.substr(pos+leadingsize,result), result);
2947 mres.match2end = str.size() - pos - leadingsize;
2948 mres.pos = pos+leadingsize;
2952 // else !use_regexp: but all code paths above return
2953 LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2954 << par_as_string << "', str='" << str << "'");
2955 LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2956 << lead_as_string << "', par_as_string_nolead='"
2957 << par_as_string_nolead << "'");
2960 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2961 << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2962 if (str.substr(0, par_as_string.size()) == par_as_string) {
2963 mres.match_len = par_as_string.size();
2964 mres.match2end = str.size();
2969 // Start the search _after_ the leading part
2970 size_t pos = str.find(par_as_string_nolead, lead_as_string.size());
2971 if (pos != string::npos) {
2972 mres.match_len = par_as_string.size();
2973 mres.match2end = str.size() - pos;
2982 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2984 MatchResult mres = findAux(cur, len, at_begin);
2985 int res = mres.match_len;
2987 "res=" << res << ", at_begin=" << at_begin
2988 << ", matchword=" << opt.matchword
2989 << ", inTexted=" << cur.inTexted());
2990 if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2992 if ((len > 0) && (res < len)) {
2996 Paragraph const & par = cur.paragraph();
2997 bool ws_left = (cur.pos() > 0)
2998 ? par.isWordSeparator(cur.pos() - 1)
3000 bool ws_right = (cur.pos() + len < par.size())
3001 ? par.isWordSeparator(cur.pos() + len)
3004 "cur.pos()=" << cur.pos() << ", res=" << res
3005 << ", separ: " << ws_left << ", " << ws_right
3008 if (ws_left && ws_right) {
3009 // Check for word separators inside the found 'word'
3010 for (int i = 0; i < len; i++) {
3011 if (par.isWordSeparator(cur.pos() + i)) {
3023 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
3026 if (! opt.casesensitive)
3027 t = lyx::to_utf8(lowercase(s));
3029 t = lyx::to_utf8(s);
3030 // Remove \n at begin
3031 while (!t.empty() && t[0] == '\n')
3034 while (!t.empty() && t[t.size() - 1] == '\n')
3035 t = t.substr(0, t.size() - 1);
3037 // Handle all other '\n'
3038 while ((pos = t.find("\n")) != string::npos) {
3039 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
3041 if (isAlnumASCII(t[pos+1])) {
3042 t.replace(pos-2, 3, " ");
3045 t.replace(pos-2, 3, "");
3048 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
3049 // '\n' adjacent to non-alpha-numerics, discard
3050 t.replace(pos, 1, "");
3053 // Replace all other \n with spaces
3054 t.replace(pos, 1, " ");
3057 // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
3058 // Kornel: Added textsl, textsf, textit, texttt and noun
3059 // + allow to seach for colored text too
3060 LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
3061 while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
3062 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3063 while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3064 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3066 while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3067 // FIXME - check what preceeds the brace
3069 if (opt.ignoreformat)
3070 while (regex_replace(t, t, "\\{", "_x_<")
3071 || regex_replace(t, t, "\\}", "_x_>"))
3072 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3074 while (regex_replace(t, t, "\\\\\\{", "_x_<")
3075 || regex_replace(t, t, "\\\\\\}", "_x_>"))
3076 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3083 docstring stringifyFromCursor(DocIterator const & cur, int len)
3085 LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3086 if (cur.inTexted()) {
3087 Paragraph const & par = cur.paragraph();
3088 // TODO what about searching beyond/across paragraph breaks ?
3089 // TODO Try adding a AS_STR_INSERTS as last arg
3090 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3091 int(par.size()) : cur.pos() + len;
3092 // OutputParams runparams(&cur.buffer()->params().encoding());
3093 OutputParams runparams(encodings.fromLyXName("utf8"));
3094 runparams.nice = true;
3095 runparams.flavor = OutputParams::XETEX;
3096 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3097 // No side effect of file copying and image conversion
3098 runparams.dryrun = true;
3099 runparams.for_search = true;
3100 LYXERR(Debug::FIND, "Stringifying with cur: "
3101 << cur << ", from pos: " << cur.pos() << ", end: " << end);
3102 return par.asString(cur.pos(), end,
3103 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3105 } else if (cur.inMathed()) {
3106 CursorSlice cs = cur.top();
3107 MathData md = cs.cell();
3108 MathData::const_iterator it_end =
3109 (( len == -1 || cs.pos() + len > int(md.size()))
3111 : md.begin() + cs.pos() + len );
3113 for (MathData::const_iterator it = md.begin() + cs.pos();
3116 docstring s = asString(md2);
3117 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3120 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3125 /** Computes the LaTeX export of buf starting from cur and ending len positions
3126 * after cur, if len is positive, or at the paragraph or innermost inset end
3129 docstring latexifyFromCursor(DocIterator const & cur, int len)
3131 LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3132 LYXERR(Debug::FIND, " with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3133 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3134 Buffer const & buf = *cur.buffer();
3136 odocstringstream ods;
3138 //OutputParams runparams(&buf.params().encoding());
3139 OutputParams runparams(encodings.fromLyXName("utf8"));
3140 runparams.nice = false;
3141 runparams.flavor = OutputParams::XETEX;
3142 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3143 // No side effect of file copying and image conversion
3144 runparams.dryrun = true;
3145 runparams.for_search = true;
3147 if (cur.inTexted()) {
3148 // @TODO what about searching beyond/across paragraph breaks ?
3149 pos_type endpos = cur.paragraph().size();
3150 if (len != -1 && endpos > cur.pos() + len)
3151 endpos = cur.pos() + len;
3152 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3153 string(), cur.pos(), endpos);
3154 string s = lyx::to_utf8(ods.str());
3155 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3156 return(lyx::from_utf8(s));
3157 } else if (cur.inMathed()) {
3158 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3159 for (int s = cur.depth() - 1; s >= 0; --s) {
3160 CursorSlice const & cs = cur[s];
3161 if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3163 cs.asInsetMath()->asHullInset()->header_write(ws);
3168 CursorSlice const & cs = cur.top();
3169 MathData md = cs.cell();
3170 MathData::const_iterator it_end =
3171 ((len == -1 || cs.pos() + len > int(md.size()))
3173 : md.begin() + cs.pos() + len);
3175 for (MathData::const_iterator it = md.begin() + cs.pos();
3179 ods << asString(md2);
3180 // Retrieve the math environment type, and add '$' or '$]'
3181 // or others (\end{equation}) accordingly
3182 for (int s = cur.depth() - 1; s >= 0; --s) {
3183 CursorSlice const & cs2 = cur[s];
3184 InsetMath * inset = cs2.asInsetMath();
3185 if (inset && inset->asHullInset()) {
3187 inset->asHullInset()->footer_write(ws);
3191 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3193 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3199 /** Finalize an advanced find operation, advancing the cursor to the innermost
3200 ** position that matches, plus computing the length of the matching text to
3203 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
3205 // Search the foremost position that matches (avoids find of entire math
3206 // inset when match at start of it)
3208 DocIterator old_cur(cur.buffer());
3210 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
3214 } while (cur && cur.depth() > d && match(cur).match_len > 0);
3216 int max_match = match(cur).match_len; /* match valid only if not searching whole words */
3217 if (max_match <= 0) return 0;
3218 LYXERR(Debug::FIND, "Ok");
3220 // Compute the match length
3222 if (cur.pos() + len > cur.lastpos())
3224 if (match.opt.matchword) {
3225 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3226 while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3228 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3230 // Length of matched text (different from len param)
3231 int old_match = match(cur, len).match_len;
3235 // Greedy behaviour while matching regexps
3236 while ((new_match = match(cur, len + 1).match_len) > old_match) {
3238 old_match = new_match;
3239 LYXERR(Debug::FIND, "verifying match with len = " << len);
3246 int maxl = cur.lastpos() - cur.pos();
3247 // Greedy behaviour while matching regexps
3248 while (maxl > minl) {
3249 int actual_match = match(cur, len).match_len;
3250 if (actual_match >= max_match) {
3251 // actual_match > max_match _can_ happen,
3252 // if the search area splits
3253 // some following word so that the regex
3254 // (e.g. 'r.*r\b' matches 'r' from the middle of the
3256 // This means, the len value is too big
3258 len = (int)((maxl + minl)/2);
3261 // (actual_match < max_match)
3263 len = (int)((maxl + minl)/2);
3267 // Search for real start of matched characters
3272 } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3273 if (cur.depth() < old_cur.depth()) {
3275 LYXERR0("cur.depth() < old_cur.depth(), this should never happen");
3278 if (cur.pos() != old_cur.pos()) {
3279 // OK, forwarded 1 pos in actual inset
3280 actual_match = match(cur, len-1).match_len;
3281 if (actual_match == max_match) {
3282 // Ha, got it! The shorter selection has the same match length
3287 // OK, the shorter selection matches less chars, revert to previous value
3293 LYXERR0("cur.pos() == old_cur.pos(), this should never happen");
3294 actual_match = match(cur, len).match_len;
3295 if (actual_match == max_match)
3305 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
3309 while (!theApp()->longOperationCancelled() && cur) {
3310 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3311 MatchResult mres = match(cur, -1, false);
3312 int match_len = mres.match_len;
3313 LYXERR(Debug::FIND, "match_len: " << match_len);
3314 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3315 LYXERR0("BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3318 if (match_len > 0) {
3319 // Try to find the begin of searched string
3320 int increment = mres.pos/2;
3321 while (mres.pos > 5 && (increment > 5)) {
3322 DocIterator old_cur = cur;
3323 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3325 if (! cur || (cur.pit() > old_cur.pit())) {
3326 // Are we outside of the paragraph?
3327 // This can happen if moving past some UTF8-encoded chars
3332 MatchResult mres2 = match(cur, -1, false);
3333 if ((mres2.match2end < mres.match2end) ||
3334 (mres2.match_len < mres.match_len)) {
3341 if (increment > mres.pos/2)
3342 increment = mres.pos/2;
3346 int match_len_zero_count = 0;
3347 for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3349 int remaining_len = match(cur, -1, false).match_len;
3350 if (remaining_len <= 0) {
3351 // Apparently the searched string is not in the remaining part
3358 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3359 int match_len3 = match(cur, 1).match_len;
3362 int match_len2 = match(cur).match_len;
3363 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3364 if (match_len2 > 0) {
3365 // Sometimes in finalize we understand it wasn't a match
3366 // and we need to continue the outest loop
3367 int len = findAdvFinalize(cur, match);
3372 if (match_len2 >= 0) {
3373 if (match_len2 == 0)
3374 match_len_zero_count++;
3376 match_len_zero_count = 0;
3379 if (++match_len_zero_count > 3) {
3380 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3381 match_len_zero_count = 0;
3389 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3390 LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3393 // This should exit nested insets, if any, or otherwise undefine the currsor.
3394 cur.pos() = cur.lastpos();
3395 LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3403 /// Find the most backward consecutive match within same paragraph while searching backwards.
3404 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3406 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3407 DocIterator tmp_cur = cur;
3408 int len = findAdvFinalize(tmp_cur, match);
3409 Inset & inset = cur.inset();
3410 for (; cur != cur_begin; cur.backwardPos()) {
3411 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3412 DocIterator new_cur = cur;
3413 new_cur.backwardPos();
3414 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3416 int new_len = findAdvFinalize(new_cur, match);
3421 LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3427 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3431 // Backup of original position
3432 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3433 if (cur == cur_begin)
3436 DocIterator cur_orig(cur);
3437 bool pit_changed = false;
3440 bool found_match = (match(cur, -1, false).match_len > 0);
3444 cur.pos() = cur.lastpos();
3446 cur.pos() = cur_orig.pos();
3447 LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
3448 DocIterator cur_prev_iter;
3450 found_match = (match(cur).match_len > 0);
3451 LYXERR(Debug::FIND, "findBackAdv3: found_match="
3452 << found_match << ", cur: " << cur);
3454 return findMostBackwards(cur, match);
3456 // Stop if begin of document reached
3457 if (cur == cur_begin)
3459 cur_prev_iter = cur;
3463 if (cur == cur_begin)
3470 } while (!theApp()->longOperationCancelled());
3478 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
3479 DocIterator const & cur, int len)
3481 if (cur.pos() < 0 || cur.pos() > cur.lastpos())
3483 if (!opt.ignoreformat)
3484 return latexifyFromCursor(cur, len);
3486 return stringifyFromCursor(cur, len);
3490 FindAndReplaceOptions::FindAndReplaceOptions(
3491 docstring const & find_buf_name, bool casesensitive,
3492 bool matchword, bool forward, bool expandmacros, bool ignoreformat,
3493 docstring const & repl_buf_name, bool keep_case,
3494 SearchScope scope, SearchRestriction restr, bool replace_all)
3495 : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
3496 forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
3497 repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr), replace_all(replace_all)
3505 /** Check if 'len' letters following cursor are all non-lowercase */
3506 static bool allNonLowercase(Cursor const & cur, int len)
3508 pos_type beg_pos = cur.selectionBegin().pos();
3509 pos_type end_pos = cur.selectionBegin().pos() + len;
3510 if (len > cur.lastpos() + 1 - beg_pos) {
3511 LYXERR(Debug::FIND, "This should not happen, more debug needed");
3512 len = cur.lastpos() + 1 - beg_pos;
3513 end_pos = beg_pos + len;
3515 for (pos_type pos = beg_pos; pos != end_pos; ++pos)
3516 if (isLowerCase(cur.paragraph().getChar(pos)))
3522 /** Check if first letter is upper case and second one is lower case */
3523 static bool firstUppercase(Cursor const & cur)
3526 pos_type pos = cur.selectionBegin().pos();
3527 if (pos >= cur.lastpos() - 1) {
3528 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
3531 ch1 = cur.paragraph().getChar(pos);
3532 ch2 = cur.paragraph().getChar(pos + 1);
3533 bool result = isUpperCase(ch1) && isLowerCase(ch2);
3534 LYXERR(Debug::FIND, "firstUppercase(): "
3535 << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
3536 << ch2 << "(" << char(ch2) << ")"
3537 << ", result=" << result << ", cur=" << cur);
3542 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
3544 ** \fixme What to do with possible further paragraphs in replace buffer ?
3546 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
3548 ParagraphList::iterator pit = buffer.paragraphs().begin();
3549 LASSERT(pit->size() >= 1, /**/);
3550 pos_type right = pos_type(1);
3551 pit->changeCase(buffer.params(), pos_type(0), right, first_case);
3552 right = pit->size();
3553 pit->changeCase(buffer.params(), pos_type(1), right, others_case);
3559 static int findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
3561 Cursor & cur = bv->cursor();
3562 if (opt.repl_buf_name == docstring()
3563 || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
3564 || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3567 DocIterator sel_beg = cur.selectionBegin();
3568 DocIterator sel_end = cur.selectionEnd();
3569 if (&sel_beg.inset() != &sel_end.inset()
3570 || sel_beg.pit() != sel_end.pit()
3571 || sel_beg.idx() != sel_end.idx())
3573 int sel_len = sel_end.pos() - sel_beg.pos();
3574 LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
3575 << ", sel_len: " << sel_len << endl);
3578 LASSERT(sel_len > 0, return 0);
3580 if (!matchAdv(sel_beg, sel_len).match_len)
3583 // Build a copy of the replace buffer, adapted to the KeepCase option
3584 Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
3586 repl_buffer_orig.write(oss);
3587 string lyx = oss.str();
3588 Buffer repl_buffer("", false);
3589 repl_buffer.setUnnamed(true);
3590 LASSERT(repl_buffer.readString(lyx), return 0);
3591 if (opt.keep_case && sel_len >= 2) {
3592 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
3593 if (cur.inTexted()) {
3594 if (firstUppercase(cur))
3595 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3596 else if (allNonLowercase(cur, sel_len))
3597 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3600 cap::cutSelection(cur, false);
3601 if (cur.inTexted()) {
3602 repl_buffer.changeLanguage(
3603 repl_buffer.language(),
3604 cur.getFont().language());
3605 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3606 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3607 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3608 repl_buffer.params().documentClassPtr(),
3609 bv->buffer().errorList("Paste"));
3610 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3611 sel_len = repl_buffer.paragraphs().begin()->size();
3612 } else if (cur.inMathed()) {
3613 odocstringstream ods;
3615 // OutputParams runparams(&repl_buffer.params().encoding());
3616 OutputParams runparams(encodings.fromLyXName("utf8"));
3617 runparams.nice = false;
3618 runparams.flavor = OutputParams::XETEX;
3619 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3620 runparams.dryrun = true;
3621 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3622 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3623 docstring repl_latex = ods.str();
3624 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3626 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3627 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3628 repl_latex = from_utf8(s);
3629 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3630 MathData ar(cur.buffer());
3631 asArray(repl_latex, ar, Parse::NORMAL);
3633 sel_len = ar.size();
3634 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3636 if (cur.pos() >= sel_len)
3637 cur.pos() -= sel_len;
3640 LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3641 bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3642 bv->processUpdateFlags(Update::Force);
3647 /// Perform a FindAdv operation.
3648 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3653 // e.g., when invoking word-findadv from mini-buffer wither with
3654 // wrong options syntax or before ever opening advanced F&R pane
3655 if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3659 MatchStringAdv matchAdv(bv->buffer(), opt);
3660 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3662 bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3663 num_replaced += findAdvReplace(bv, opt, matchAdv);
3666 match_len = findForwardAdv(cur, matchAdv);
3668 match_len = findBackwardsAdv(cur, matchAdv);
3670 // This may only be raised by lyx::regex()
3671 bv->message(_("Invalid regular expression!"));
3675 if (match_len == 0) {
3676 if (num_replaced > 0) {
3677 switch (num_replaced)
3680 bv->message(_("One match has been replaced."));
3683 bv->message(_("Two matches have been replaced."));
3686 bv->message(bformat(_("%1$d matches have been replaced."), num_replaced));
3692 bv->message(_("Match not found."));
3697 if (num_replaced > 0)
3698 bv->message(_("Match has been replaced."));
3700 bv->message(_("Match found."));
3702 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3703 bv->putSelectionAt(cur, match_len, !opt.forward);
3709 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3711 os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3712 << opt.casesensitive << ' '
3713 << opt.matchword << ' '
3714 << opt.forward << ' '
3715 << opt.expandmacros << ' '
3716 << opt.ignoreformat << ' '
3717 << opt.replace_all << ' '
3718 << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3719 << opt.keep_case << ' '
3720 << int(opt.scope) << ' '
3723 LYXERR(Debug::FIND, "built: " << os.str());
3729 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3731 LYXERR(Debug::FIND, "parsing");
3735 while (line != "EOSS") {
3739 if (is.eof()) // Tolerate malformed request
3743 LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3744 opt.find_buf_name = from_utf8(s);
3745 is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.replace_all;
3746 is.get(); // Waste space before replace string
3749 while (line != "EOSS") {
3753 if (is.eof()) // Tolerate malformed request
3757 LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3758 opt.repl_buf_name = from_utf8(s);
3759 is >> opt.keep_case;
3762 opt.scope = FindAndReplaceOptions::SearchScope(i);
3764 opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3766 LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3767 << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3768 << opt.scope << ' ' << opt.restr);