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) :
1117 isPatternString(isPattern),
1119 actualdeptindex(0) { depts[0] = 0; closes[0] = 0;};
1122 int depts[MAXOPENED];
1123 int closes[MAXOPENED];
1124 int actualdeptindex;
1125 Border borders[2*MAXOPENED];
1126 int previousNotIgnored(int);
1127 int nextNotIgnored(int);
1128 void handleOpenP(int i);
1129 void handleCloseP(int i, bool closingAllowed);
1130 void resetOpenedP(int openPos);
1131 void addIntervall(int upper);
1132 void addIntervall(int low, int upper); /* if explicit */
1133 void removeAccents();
1134 void setForDefaultLang(KeyInfo &defLang);
1135 int findclosing(int start, int end, char up, char down, int repeat);
1136 void handleParentheses(int lastpos, bool closingAllowed);
1138 int isOpeningPar(int pos);
1140 void output(ostringstream &os, int lastpos);
1141 // string show(int lastpos);
1144 int Intervall::isOpeningPar(int pos)
1146 if ((pos < 0) || (size_t(pos) >= par.size()))
1148 if (par[pos] != '{')
1150 if (size_t(pos) + 2 >= par.size())
1152 if (par[pos+2] != '}')
1154 if (par[pos+1] == '[' || par[pos+1] == ']')
1159 void Intervall::setForDefaultLang(KeyInfo &defLang)
1161 // Enable the use of first token again
1162 if (ignoreidx >= 0) {
1163 int value = defLang._tokenstart + defLang._tokensize;
1165 if (borders[0].low < value)
1166 borders[0].low = value;
1167 if (borders[0].upper < value)
1168 borders[0].upper = value;
1173 static void checkDepthIndex(int val)
1175 static int maxdepthidx = MAXOPENED-2;
1176 if (val > maxdepthidx) {
1178 LYXERR0("maxdepthidx now " << val);
1182 static void checkIgnoreIdx(int val)
1184 static int maxignoreidx = 2*MAXOPENED - 4;
1185 if (val > maxignoreidx) {
1187 LYXERR0("maxignoreidx now " << val);
1192 * Expand the region of ignored parts of the input latex string
1193 * The region is only relevant in output()
1195 void Intervall::addIntervall(int low, int upper)
1198 if (low == upper) return;
1199 for (idx = ignoreidx+1; idx > 0; --idx) {
1200 if (low > borders[idx-1].upper) {
1204 Border br(low, upper);
1205 if (idx > ignoreidx) {
1208 checkIgnoreIdx(ignoreidx);
1212 // Expand only if one of the new bound is inside the interwall
1213 // We know here that br.low > borders[idx-1].upper
1214 if (br.upper < borders[idx].low) {
1215 // We have to insert at this pos
1216 for (int i = ignoreidx+1; i > idx; --i) {
1217 borders[i] = borders[i-1];
1221 checkIgnoreIdx(ignoreidx);
1224 // Here we know, that we are overlapping
1225 if (br.low > borders[idx].low)
1226 br.low = borders[idx].low;
1227 // check what has to be concatenated
1229 for (int i = idx; i <= ignoreidx; i++) {
1230 if (br.upper >= borders[i].low) {
1232 if (br.upper < borders[i].upper)
1233 br.upper = borders[i].upper;
1239 // count should be >= 1 here
1242 for (int i = idx + count; i <= ignoreidx; i++) {
1243 borders[i-count+1] = borders[i];
1245 ignoreidx -= count - 1;
1251 typedef map<string, string> AccentsMap;
1252 static AccentsMap accents = map<string, string>();
1254 static void buildaccent(string n, string param, string values)
1258 const char delim = '|';
1259 while (getline(s, name, delim)) {
1261 for (size_t i = 0; i < param.size(); i++) {
1262 string key = name + "{" + param[i] + "}";
1263 // get the corresponding utf8-value
1264 if ((values[start] & 0xc0) != 0xc0) {
1265 // should not happen, utf8 encoding starts at least with 11xxxxxx
1266 // but value for '\dot{i}' is 'i', which is ascii
1267 if ((values[start] & 0x80) == 0) {
1269 accents[key] = values.substr(start, 1);
1274 for (int j = 1; ;j++) {
1275 if (start + j >= values.size()) {
1276 accents[key] = values.substr(start, j);
1277 start = values.size() - 1;
1280 else if ((values[start+j] & 0xc0) != 0x80) {
1281 // This is the first byte of following utf8 char
1282 accents[key] = values.substr(start, j);
1291 static void buildAccentsMap()
1293 accents["imath"] = "ı";
1295 accents["jmath"] = "ȷ";
1296 accents["lyxmathsym{ß}"] = "ß";
1297 accents["text{ß}"] = "ß";
1298 accents["ddot{\\imath}"] = "ï";
1299 buildaccent("ddot", "aAeEiIioOuUyY",
1300 "äÄëËïÏïöÖüÜÿŸ"); // umlaut
1301 buildaccent("dot|.", "cCeEGgIizZaAoObBdDfFyY",
1302 "ċĊėĖĠġİİżŻȧȦȯȮḃḂḋḊḟḞẏẎ"); // dot{i} can only happen if ignoring case, but there is no lowercase of 'İ'
1303 accents["acute{\\imath}"] = "í";
1304 buildaccent("acute", "aAcCeElLoOnNrRsSuUyYzZiI",
1305 "áÁćĆéÉĺĹóÓńŃŕŔśŚúÚýÝźŹíÍ");
1306 buildaccent("dacute|H|h", "oOuU", "őŐűŰ"); // double acute
1307 buildaccent("mathring|r", "aAuUwy",
1309 accents["check{\\imath}"] = "ǐ";
1310 accents["check{\\jmath}"] = "ǰ";
1311 buildaccent("check|v", "cCdDaAeEiIoOuUgGkKhHlLnNrRsSTtzZ",
1312 "čČďĎǎǍěĚǐǏǒǑǔǓǧǦǩǨȟȞľĽňŇřŘšŠŤťžŽ"); // caron
1313 accents["hat{\\imath}"] = "î";
1314 accents["hat{\\jmath}"] = "ĵ";
1315 buildaccent("hat|^", "aAeEiIcCgGhHjJsSwWyYzZoOuU",
1316 "âÂêÊîÎĉĈĝĜĥĤĵĴŝŜŵŴŷŶẑẐôÔûÛ"); // circ
1317 accents["bar{\\imath}"] = "ī";
1318 buildaccent("bar|=", "aAeEiIoOuUyY",
1319 "āĀēĒīĪōŌūŪȳȲ"); // macron
1320 accents["tilde{\\imath}"] = "ĩ";
1321 buildaccent("tilde", "aAnNoOiIuU",
1322 "ãÃñÑõÕĩĨũŨ"); // tilde
1323 accents["breve{\\imath}"] = "ĭ";
1324 buildaccent("breve|u", "aAeEgGiIoOuU",
1325 "ăĂĕĔğĞĭĬŏŎŭŬ"); // breve
1326 accents["grave{\\imath}"] = "ì";
1327 buildaccent("grave|`", "aAeEiIoOuUnNwWyY",
1328 "àÀèÈìÌòÒùÙǹǸẁẀỳỲ"); // grave
1329 buildaccent("subdot|d", "BbDdHhKkLlMmNnRrSsTtVvWwZzAaEeIiOoUuYy",
1330 "ḄḅḌḍḤḥḲḳḶḷṂṃṆṇṚṛṢṣṬṭṾṿẈẉẒẓẠạẸẹỊịỌọỤụỴỵ"); // dot below
1331 buildaccent("ogonek|k", "AaEeIiUuOo",
1332 "ĄąĘęĮįŲųǪǫ"); // ogonek
1336 * Created accents in math or regexp environment
1337 * are macros, but we need the utf8 equivalent
1339 void Intervall::removeAccents()
1341 if (accents.empty())
1343 static regex const accre("\\\\((.|grave|breve|lyxmathsym|text|ddot|dot|acute|dacute|mathring|check|hat|bar|tilde|subdot|ogonek)\\{[^\\{\\}]+\\}|(i|imath|jmath)(?![a-zA-Z]))");
1345 for (sregex_iterator itacc(par.begin(), par.end(), accre), end; itacc != end; ++itacc) {
1347 string key = sub.str(1);
1348 if (accents.find(key) != accents.end()) {
1349 string val = accents[key];
1350 size_t pos = sub.position(0);
1351 for (size_t i = 0; i < val.size(); i++) {
1352 par[pos+i] = val[i];
1354 addIntervall(pos+val.size(), pos + sub.str(0).size());
1355 for (size_t i = pos+val.size(); i < pos + sub.str(0).size(); i++) {
1356 // remove traces of any remaining chars
1361 LYXERR0("Not added accent for \"" << key << "\"");
1366 void Intervall::handleOpenP(int i)
1369 depts[actualdeptindex] = i+1;
1370 closes[actualdeptindex] = -1;
1371 checkDepthIndex(actualdeptindex);
1374 void Intervall::handleCloseP(int i, bool closingAllowed)
1376 if (actualdeptindex <= 0) {
1377 if (! closingAllowed)
1378 LYXERR(Debug::FIND, "Bad closing parenthesis in latex"); /* should not happen, but the latex input may be wrong */
1379 // if we are at the very end
1380 addIntervall(i, i+1);
1383 closes[actualdeptindex] = i+1;
1388 void Intervall::resetOpenedP(int openPos)
1390 // Used as initializer for foreignlanguage entry
1391 actualdeptindex = 1;
1392 depts[1] = openPos+1;
1396 int Intervall::previousNotIgnored(int start)
1398 int idx = 0; /* int intervalls */
1399 for (idx = ignoreidx; idx >= 0; --idx) {
1400 if (start > borders[idx].upper)
1402 if (start >= borders[idx].low)
1403 start = borders[idx].low-1;
1408 int Intervall::nextNotIgnored(int start)
1410 int idx = 0; /* int intervalls */
1411 for (idx = 0; idx <= ignoreidx; idx++) {
1412 if (start < borders[idx].low)
1414 if (start < borders[idx].upper)
1415 start = borders[idx].upper;
1420 typedef map<string, KeyInfo> KeysMap;
1421 typedef vector< KeyInfo> Entries;
1422 static KeysMap keys = map<string, KeyInfo>();
1429 void buildKeys(bool);
1430 void buildEntries(bool);
1431 void makeKey(const string &, KeyInfo, bool isPatternString);
1432 void processRegion(int start, int region_end); /* remove {} parts */
1433 void removeHead(KeyInfo&, int count=0);
1436 LatexInfo(string par, bool isPatternString) : entidx(-1), interval(isPatternString) {
1438 interval.hasTitle = false;
1439 interval.titleValue = "";
1440 buildKeys(isPatternString);
1441 entries = vector<KeyInfo>();
1442 buildEntries(isPatternString);
1446 if (entries.empty()) {
1449 if (entries[0].keytype == KeyInfo::isTitle) {
1450 if (! entries[0].disabled) {
1451 interval.hasTitle = true;
1452 interval.titleValue = entries[0].head;
1455 interval.hasTitle = false;
1456 interval.titleValue = "";
1458 removeHead(entries[0]);
1459 if (entries.size() > 1)
1468 if (int(entries.size()) > entidx) {
1475 bool setNextKey(int idx) {
1476 if ((idx == entidx) && (entidx >= 0)) {
1483 int find(int start, KeyInfo::KeyType keytype) {
1487 while (tmpIdx < int(entries.size())) {
1488 if (entries[tmpIdx].keytype == keytype)
1494 int process(ostringstream &os, KeyInfo &actual);
1495 int dispatch(ostringstream &os, int previousStart, KeyInfo &actual);
1496 // string show(int lastpos) { return interval.show(lastpos);};
1497 int nextNotIgnored(int start) { return interval.nextNotIgnored(start);};
1498 KeyInfo &getKeyInfo(int keyinfo) {
1499 static KeyInfo invalidInfo = KeyInfo();
1500 if ((keyinfo < 0) || ( keyinfo >= int(entries.size())))
1503 return entries[keyinfo];
1505 void setForDefaultLang(KeyInfo &defLang) {interval.setForDefaultLang(defLang);};
1506 void addIntervall(int low, int up) { interval.addIntervall(low, up); };
1510 int Intervall::findclosing(int start, int end, char up = '{', char down = '}', int repeat = 1)
1515 for (int i = start; i < end; i += 1 + skip) {
1519 if (c == '\\') skip = 1;
1523 else if (c == down) {
1525 if ((repeat <= 0) || (par[i+1] != up))
1543 vector<MathEntry> entries;
1548 void insert(string wait, size_t start, size_t end) {
1549 MathEntry m = MathEntry();
1551 m.mathStart = start;
1553 m.mathSize = end - start;
1554 entries.push_back(m);
1556 bool empty() { return entries.empty(); };
1557 size_t getEndPos() {
1558 if (entries.empty() || (actualIdx >= entries.size())) {
1561 return entries[actualIdx].mathEnd;
1563 size_t getStartPos() {
1564 if (entries.empty() || (actualIdx >= entries.size())) {
1565 return 100000; /* definitely enough? */
1567 return entries[actualIdx].mathStart;
1569 size_t getFirstPos() {
1571 return getStartPos();
1574 if (entries.empty() || (actualIdx >= entries.size())) {
1577 return entries[actualIdx].mathSize;
1579 void incrEntry() { actualIdx++; };
1582 void LatexInfo::buildEntries(bool isPatternString)
1584 static regex const rmath("\\$|\\\\\\[|\\\\\\]|\\\\(begin|end)\\{((eqnarray|equation|flalign|gather|multline|align|alignat)\\*?)\\}");
1585 static regex const rkeys("\\$|\\\\\\[|\\\\\\]|\\\\((([a-zA-Z]+\\*?)(\\{([a-z]+\\*?)\\}|=[0-9]+[a-z]+)?))");
1586 static bool disableLanguageOverride = false;
1587 smatch sub, submath;
1588 bool evaluatingRegexp = false;
1590 bool evaluatingMath = false;
1591 bool evaluatingCode = false;
1593 bool evaluatingOptional = false;
1594 size_t optionalEnd = 0;
1597 bool math_end_waiting = false;
1598 size_t math_pos = 10000;
1601 interval.removeAccents();
1603 for (sregex_iterator itmath(interval.par.begin(), interval.par.end(), rmath), end; itmath != end; ++itmath) {
1605 if (math_end_waiting) {
1606 size_t pos = submath.position(size_t(0));
1607 if ((math_end == "$") &&
1608 (submath.str(0) == "$") &&
1609 (interval.par[pos-1] != '\\')) {
1610 mi.insert("$", math_pos, pos + 1);
1611 math_end_waiting = false;
1613 else if ((math_end == "\\]") &&
1614 (submath.str(0) == "\\]")) {
1615 mi.insert("\\]", math_pos, pos + 2);
1616 math_end_waiting = false;
1618 else if ((submath.str(1).compare("end") == 0) &&
1619 (submath.str(2).compare(math_end) == 0)) {
1620 mi.insert(math_end, math_pos, pos + submath.str(0).length());
1621 math_end_waiting = false;
1627 if (submath.str(1).compare("begin") == 0) {
1628 math_end_waiting = true;
1629 math_end = submath.str(2);
1630 math_pos = submath.position(size_t(0));
1632 else if (submath.str(0).compare("\\[") == 0) {
1633 math_end_waiting = true;
1635 math_pos = submath.position(size_t(0));
1637 else if (submath.str(0) == "$") {
1638 size_t pos = submath.position(size_t(0));
1639 if ((pos == 0) || (interval.par[pos-1] != '\\')) {
1640 math_end_waiting = true;
1647 // Ignore language if there is math somewhere in pattern-string
1648 if (isPatternString) {
1651 keys["foreignlanguage"].disabled = true;
1652 disableLanguageOverride = true;
1655 disableLanguageOverride = false;
1658 if (disableLanguageOverride) {
1659 keys["foreignlanguage"].disabled = true;
1662 math_pos = mi.getFirstPos();
1663 for (sregex_iterator it(interval.par.begin(), interval.par.end(), rkeys), end; it != end; ++it) {
1665 string key = sub.str(3);
1667 if (sub.str(0)[0] == '\\')
1668 key = sub.str(0)[1];
1672 size_t k_pos = sub.position(size_t(0));
1673 if ((k_pos > 0) && (interval.par[k_pos - 1] == '\\')) {
1674 // Escaped '$', ignoring
1680 if (evaluatingRegexp) {
1681 if (sub.str(1).compare("endregexp") == 0) {
1682 evaluatingRegexp = false;
1683 // found._tokenstart already set
1684 found._dataEnd = sub.position(size_t(0)) + 13;
1685 found._dataStart = found._dataEnd;
1686 found._tokensize = found._dataEnd - found._tokenstart;
1687 found.parenthesiscount = 0;
1688 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1695 if (evaluatingMath) {
1696 if (size_t(sub.position(size_t(0))) < mi.getEndPos())
1698 evaluatingMath = false;
1700 math_pos = mi.getStartPos();
1702 if (keys.find(key) == keys.end()) {
1703 found = KeyInfo(KeyInfo::isStandard, 0, true);
1704 if (isPatternString) {
1705 found.keytype = KeyInfo::isChar;
1706 found.disabled = false;
1713 if (key.compare("regexp") == 0) {
1714 evaluatingRegexp = true;
1715 found._tokenstart = sub.position(size_t(0));
1716 found._tokensize = 0;
1720 // Handle the other params of key
1721 if (found.keytype == KeyInfo::isIgnored)
1723 else if (found.keytype == KeyInfo::isMath) {
1724 if (size_t(sub.position(size_t(0))) == math_pos) {
1726 found._tokenstart = sub.position(size_t(0));
1727 found._tokensize = mi.getSize();
1728 found._dataEnd = found._tokenstart + found._tokensize;
1729 found._dataStart = found._dataEnd;
1730 found.parenthesiscount = 0;
1731 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1732 evaluatingMath = true;
1735 // begin|end of unknown env, discard
1736 // First handle tables
1737 // longtable|tabular
1738 bool discardComment;
1740 found.keytype = KeyInfo::doRemove;
1741 if ((sub.str(5).compare("longtable") == 0) ||
1742 (sub.str(5).compare("tabular") == 0)) {
1743 discardComment = true; /* '%' */
1746 discardComment = false;
1747 static regex const removeArgs("^(multicols|multipar|sectionbox|subsectionbox|tcolorbox)$");
1749 string token = sub.str(5);
1750 if (regex_match(token, sub2, removeArgs)) {
1751 found.keytype = KeyInfo::removeWithArg;
1754 // discard spaces before pos(0)
1755 int pos = sub.position(size_t(0));
1757 for (count = 0; pos - count > 0; count++) {
1758 char c = interval.par[pos-count-1];
1759 if (discardComment) {
1760 if ((c != ' ') && (c != '%'))
1766 found._tokenstart = pos - count;
1767 if (sub.str(1).compare(0, 5, "begin") == 0) {
1768 size_t pos1 = pos + sub.str(0).length();
1769 if (sub.str(5).compare("cjk") == 0) {
1770 pos1 = interval.findclosing(pos1+1, interval.par.length()) + 1;
1771 if ((interval.par[pos1] == '{') && (interval.par[pos1+1] == '}'))
1773 found.keytype = KeyInfo::isMain;
1774 found._dataStart = pos1;
1775 found._dataEnd = interval.par.length();
1776 found.disabled = keys["foreignlanguage"].disabled;
1777 found.used = keys["foreignlanguage"].used;
1778 found._tokensize = pos1 - found._tokenstart;
1779 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1782 // Swallow possible optional params
1783 while (interval.par[pos1] == '[') {
1784 pos1 = interval.findclosing(pos1+1, interval.par.length(), '[', ']')+1;
1786 // Swallow also the eventual parameter
1787 if (interval.par[pos1] == '{') {
1788 found._dataEnd = interval.findclosing(pos1+1, interval.par.length()) + 1;
1791 found._dataEnd = pos1;
1793 found._dataStart = found._dataEnd;
1794 found._tokensize = count + found._dataEnd - pos;
1795 found.parenthesiscount = 0;
1796 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1797 found.disabled = true;
1801 // Handle "\end{...}"
1802 found._dataStart = pos + sub.str(0).length();
1803 found._dataEnd = found._dataStart;
1804 found._tokensize = count + found._dataEnd - pos;
1805 found.parenthesiscount = 0;
1806 found.head = interval.par.substr(found._tokenstart, found._tokensize);
1807 found.disabled = true;
1811 else if (found.keytype != KeyInfo::isRegex) {
1812 found._tokenstart = sub.position(size_t(0));
1813 if (found.parenthesiscount == 0) {
1814 // Probably to be discarded
1815 size_t following_pos = sub.position(size_t(0)) + sub.str(3).length() + 1;
1816 char following = interval.par[following_pos];
1817 if (following == ' ')
1818 found.head = "\\" + sub.str(3) + " ";
1819 else if (following == '=') {
1820 // like \uldepth=1000pt
1821 found.head = sub.str(0);
1824 found.head = "\\" + key;
1825 found._tokensize = found.head.length();
1826 found._dataEnd = found._tokenstart + found._tokensize;
1827 found._dataStart = found._dataEnd;
1830 int params = found._tokenstart + key.length() + 1;
1831 if (evaluatingOptional) {
1832 if (size_t(found._tokenstart) > optionalEnd) {
1833 evaluatingOptional = false;
1836 found.disabled = true;
1839 int optend = params;
1840 while (interval.par[optend] == '[') {
1841 // discard optional parameters
1842 optend = interval.findclosing(optend+1, interval.par.length(), '[', ']') + 1;
1844 if (optend > params) {
1845 key += interval.par.substr(params, optend-params);
1846 evaluatingOptional = true;
1847 optionalEnd = optend;
1849 string token = sub.str(5);
1850 int closings = found.parenthesiscount;
1851 if (found.parenthesiscount == 1) {
1852 found.head = "\\" + key + "{";
1854 else if (found.parenthesiscount > 1) {
1856 found.head = sub.str(0) + "{";
1857 closings = found.parenthesiscount - 1;
1860 found.head = "\\" + key + "{";
1863 found._tokensize = found.head.length();
1864 found._dataStart = found._tokenstart + found.head.length();
1865 if (interval.par.substr(found._dataStart-1, 15).compare("\\endarguments{}") == 0) {
1866 found._dataStart += 15;
1868 size_t endpos = interval.findclosing(found._dataStart, interval.par.length(), '{', '}', closings);
1869 if (found.keytype == KeyInfo::isList) {
1870 // Check if it really is list env
1871 static regex const listre("^([a-z]+)$");
1873 if (!regex_match(token, sub2, listre)) {
1874 // Change the key of this entry. It is not in a list/item environment
1875 found.keytype = KeyInfo::endArguments;
1878 if (found.keytype == KeyInfo::noMain) {
1879 evaluatingCode = true;
1881 codeStart = found._dataStart;
1883 else if (evaluatingCode) {
1884 if (size_t(found._dataStart) > codeEnd)
1885 evaluatingCode = false;
1886 else if (found.keytype == KeyInfo::isMain) {
1887 // Disable this key, treate it as standard
1888 found.keytype = KeyInfo::isStandard;
1889 found.disabled = true;
1890 if ((codeEnd == interval.par.length()) &&
1891 (found._tokenstart == codeStart)) {
1892 // trickery, because the code inset starts
1893 // with \selectlanguage ...
1895 if (entries.size() > 1) {
1896 entries[entries.size()-1]._dataEnd = codeEnd;
1901 if ((endpos == interval.par.length()) &&
1902 (found.keytype == KeyInfo::doRemove)) {
1903 // Missing closing => error in latex-input?
1904 // therefore do not delete remaining data
1905 found._dataStart -= 1;
1906 found._dataEnd = found._dataStart;
1909 found._dataEnd = endpos;
1911 if (isPatternString) {
1912 keys[key].used = true;
1915 entries.push_back(found);
1919 void LatexInfo::makeKey(const string &keysstring, KeyInfo keyI, bool isPatternString)
1921 stringstream s(keysstring);
1923 const char delim = '|';
1924 while (getline(s, key, delim)) {
1925 KeyInfo keyII(keyI);
1926 if (isPatternString) {
1929 else if ( !keys[key].used)
1930 keyII.disabled = true;
1935 void LatexInfo::buildKeys(bool isPatternString)
1938 static bool keysBuilt = false;
1939 if (keysBuilt && !isPatternString) return;
1941 // Known standard keys with 1 parameter.
1942 // Split is done, if not at start of region
1943 makeKey("textsf|textss|texttt", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getFamily()), isPatternString);
1944 makeKey("textbf", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getSeries()), isPatternString);
1945 makeKey("textit|textsc|textsl", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getShape()), isPatternString);
1946 makeKey("uuline|uline|uwave", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getUnderline()), isPatternString);
1947 makeKey("emph|noun", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getMarkUp()), isPatternString);
1948 makeKey("sout|xout", KeyInfo(KeyInfo::isStandard, 1, ignoreFormats.getStrikeOut()), isPatternString);
1950 makeKey("section|subsection|subsubsection|paragraph|subparagraph|minisec",
1951 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1952 makeKey("section*|subsection*|subsubsection*|paragraph*",
1953 KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1954 makeKey("part|part*|chapter|chapter*", KeyInfo(KeyInfo::isSectioning, 1, ignoreFormats.getSectioning()), isPatternString);
1955 makeKey("title|subtitle|author|subject|publishers|dedication|uppertitleback|lowertitleback|extratitle|lyxaddress|lyxrightaddress", KeyInfo(KeyInfo::isTitle, 1, ignoreFormats.getFrontMatter()), isPatternString);
1957 makeKey("regexp", KeyInfo(KeyInfo::isRegex, 1, false), isPatternString);
1959 // Split is done, if not at start of region
1960 makeKey("textcolor", KeyInfo(KeyInfo::isStandard, 2, ignoreFormats.getColor()), isPatternString);
1961 makeKey("latexenvironment", KeyInfo(KeyInfo::isStandard, 2, false), isPatternString);
1963 // Split is done always.
1964 makeKey("foreignlanguage", KeyInfo(KeyInfo::isMain, 2, ignoreFormats.getLanguage()), isPatternString);
1968 makeKey("backslash|textbackslash|slash", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1969 makeKey("textasciicircum|textasciitilde", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1970 makeKey("textasciiacute|texemdash", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1971 makeKey("dots|ldots", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1973 makeKey("quad|qquad|hfill|dotfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1974 makeKey("textvisiblespace|nobreakspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1975 makeKey("negthickspace|negmedspace|negthinspace", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1977 // makeKey("enskip|smallskip|medskip|bigskip|vfill", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1978 // Custom space/skip, remove the content (== length value)
1979 makeKey("vspace|vspace*|hspace|hspace*|mspace", KeyInfo(KeyInfo::noContent, 1, false), isPatternString);
1980 // Found in fr/UserGuide.lyx
1981 makeKey("og|fg", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1983 makeKey("textquotedbl|quotesinglbase|lyxarrow", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1984 makeKey("textquotedblleft|textquotedblright", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
1985 // Known macros to remove (including their parameter)
1987 makeKey("input|inputencoding|label|ref|index|bibitem", KeyInfo(KeyInfo::doRemove, 1, false), isPatternString);
1988 makeKey("addtocounter|setlength", KeyInfo(KeyInfo::noContent, 2, true), isPatternString);
1989 // handle like standard keys with 1 parameter.
1990 makeKey("url|href|vref|thanks", KeyInfo(KeyInfo::isStandard, 1, false), isPatternString);
1992 // Macros to remove, but let the parameter survive
1994 makeKey("menuitem|textmd|textrm", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
1996 // Remove language spec from content of these insets
1997 makeKey("code", KeyInfo(KeyInfo::noMain, 1, false), isPatternString);
1999 // Same effect as previous, parameter will survive (because there is no one anyway)
2001 makeKey("noindent|textcompwordmark|maketitle", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2002 // Remove table decorations
2003 makeKey("hline|tabularnewline|toprule|bottomrule|midrule", KeyInfo(KeyInfo::doRemove, 0, true), isPatternString);
2004 // Discard shape-header.
2005 // For footnote or shortcut too, because of lang settings
2006 // and wrong handling if used 'KeyInfo::noMain'
2007 makeKey("circlepar|diamondpar|heartpar|nutpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2008 makeKey("trianglerightpar|hexagonpar|starpar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2009 makeKey("triangleuppar|triangledownpar|droppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2010 makeKey("triangleleftpar|shapepar|dropuppar", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2011 makeKey("hphantom|vphantom|footnote|shortcut|include|includegraphics", KeyInfo(KeyInfo::isStandard, 1, true), isPatternString);
2012 makeKey("parbox", KeyInfo(KeyInfo::doRemove, 1, true), isPatternString);
2013 // like ('tiny{}' or '\tiny ' ... )
2014 makeKey("footnotesize|tiny|scriptsize|small|large|Large|LARGE|huge|Huge", KeyInfo(KeyInfo::isSize, 0, false), isPatternString);
2016 // Survives, like known character
2017 makeKey("lyx|LyX|latex|LaTeX|latexe|LaTeXe|tex|TeX", KeyInfo(KeyInfo::isChar, 0, false), isPatternString);
2018 makeKey("item|listitem", KeyInfo(KeyInfo::isList, 1, false), isPatternString);
2020 makeKey("begin|end", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2021 makeKey("[|]", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2022 makeKey("$", KeyInfo(KeyInfo::isMath, 1, false), isPatternString);
2024 makeKey("par|uldepth|ULdepth|protect|nobreakdash|medskip|relax", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2025 // Remove RTL/LTR marker
2026 makeKey("l|r|textlr|textfr|textar|beginl|endl", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2027 makeKey("lettrine", KeyInfo(KeyInfo::cleanToStart, 0, true), isPatternString);
2028 makeKey("lyxslide", KeyInfo(KeyInfo::isSectioning, 1, true), isPatternString);
2029 makeKey("endarguments", KeyInfo(KeyInfo::endArguments, 0, true), isPatternString);
2030 makeKey("twocolumn", KeyInfo(KeyInfo::removeWithArg, 2, true), isPatternString);
2031 makeKey("tnotetext|ead|fntext|cortext|address", KeyInfo(KeyInfo::removeWithArg, 0, true), isPatternString);
2032 makeKey("lyxend", KeyInfo(KeyInfo::isStandard, 0, true), isPatternString);
2033 if (isPatternString) {
2034 // Allow the first searched string to rebuild the keys too
2038 // no need to rebuild again
2044 * Keep the list of actual opened parentheses actual
2045 * (e.g. depth == 4 means there are 4 '{' not processed yet)
2047 void Intervall::handleParentheses(int lastpos, bool closingAllowed)
2050 for (int i = depts[actualdeptindex]; i < lastpos; i+= 1 + skip) {
2054 if (c == '\\') skip = 1;
2055 else if (c == '{') {
2058 else if (c == '}') {
2059 handleCloseP(i, closingAllowed);
2065 string Intervall::show(int lastpos)
2067 int idx = 0; /* int intervalls */
2070 for (idx = 0; idx <= ignoreidx; idx++) {
2071 while (i < lastpos) {
2073 if (i <= borders[idx].low) {
2074 if (borders[idx].low > lastpos)
2075 printsize = lastpos - i;
2077 printsize = borders[idx].low - i;
2078 s += par.substr(i, printsize);
2080 if (i >= borders[idx].low)
2081 i = borders[idx].upper;
2084 i = borders[idx].upper;
2090 s += par.substr(i, lastpos-i);
2096 void Intervall::output(ostringstream &os, int lastpos)
2098 // get number of chars to output
2099 int idx = 0; /* int intervalls */
2102 string startTitle = titleValue;
2103 for (idx = 0; idx <= ignoreidx; idx++) {
2105 if (i <= borders[idx].low) {
2107 if (borders[idx].low > lastpos)
2108 printsize = lastpos - i;
2110 printsize = borders[idx].low - i;
2111 if (printsize > 0) {
2112 os << startTitle << par.substr(i, printsize);
2114 printed += printsize;
2117 handleParentheses(i, false);
2118 if (i >= borders[idx].low)
2119 i = borders[idx].upper;
2122 i = borders[idx].upper;
2129 os << startTitle << par.substr(i, lastpos-i);
2130 printed += lastpos-i;
2132 handleParentheses(lastpos, false);
2133 for (int i = actualdeptindex; i > 0; --i) {
2136 if (hasTitle && (printed > 0))
2138 if (! isPatternString)
2140 handleParentheses(lastpos, true); /* extra closings '}' allowed here */
2143 void LatexInfo::processRegion(int start, int region_end)
2145 while (start < region_end) { /* Let {[} and {]} survive */
2146 int cnt = interval.isOpeningPar(start);
2148 // Closing is allowed past the region
2149 int closing = interval.findclosing(start+1, interval.par.length());
2150 interval.addIntervall(start, start+1);
2151 interval.addIntervall(closing, closing+1);
2155 start = interval.nextNotIgnored(start+1);
2159 void LatexInfo::removeHead(KeyInfo &actual, int count)
2161 if (actual.parenthesiscount == 0) {
2162 // "{\tiny{} ...}" ==> "{{} ...}"
2163 interval.addIntervall(actual._tokenstart-count, actual._tokenstart + actual._tokensize);
2166 // Remove header hull, that is "\url{abcd}" ==> "abcd"
2167 interval.addIntervall(actual._tokenstart - count, actual._dataStart);
2168 interval.addIntervall(actual._dataEnd, actual._dataEnd+1);
2172 int LatexInfo::dispatch(ostringstream &os, int previousStart, KeyInfo &actual)
2175 switch (actual.keytype)
2177 case KeyInfo::isTitle: {
2179 nextKeyIdx = getNextKey();
2182 case KeyInfo::cleanToStart: {
2183 actual._dataEnd = actual._dataStart;
2184 nextKeyIdx = getNextKey();
2185 // Search for end of arguments
2186 int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2188 for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2189 entries[i].disabled = true;
2191 actual._dataEnd = entries[tmpIdx]._dataEnd;
2193 while (interval.par[actual._dataEnd] == ' ')
2195 interval.addIntervall(0, actual._dataEnd+1);
2196 interval.actualdeptindex = 0;
2197 interval.depts[0] = actual._dataEnd+1;
2198 interval.closes[0] = -1;
2201 case KeyInfo::noContent: { /* char like "\hspace{2cm}" */
2202 if (actual.disabled)
2203 interval.addIntervall(actual._tokenstart, actual._dataEnd);
2205 interval.addIntervall(actual._dataStart, actual._dataEnd);
2208 case KeyInfo::isChar: {
2209 nextKeyIdx = getNextKey();
2212 case KeyInfo::isSize: {
2213 if (actual.disabled || (interval.par[actual._dataStart] != '{') || (interval.par[actual._dataStart-1] == ' ')) {
2214 processRegion(actual._dataEnd, actual._dataEnd+1); /* remove possibly following {} */
2215 interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2216 nextKeyIdx = getNextKey();
2218 // Here _dataStart points to '{', so correct it
2219 actual._dataStart += 1;
2220 actual._tokensize += 1;
2221 actual.parenthesiscount = 1;
2222 if (interval.par[actual._dataStart] == '}') {
2223 // Determine the end if used like '{\tiny{}...}'
2224 actual._dataEnd = interval.findclosing(actual._dataStart+1, interval.par.length()) + 1;
2225 interval.addIntervall(actual._dataStart, actual._dataStart+1);
2228 // Determine the end if used like '\tiny{...}'
2229 actual._dataEnd = interval.findclosing(actual._dataStart, interval.par.length()) + 1;
2231 // Split on this key if not at start
2232 int start = interval.nextNotIgnored(previousStart);
2233 if (start < actual._tokenstart) {
2234 interval.output(os, actual._tokenstart);
2235 interval.addIntervall(start, actual._tokenstart);
2237 // discard entry if at end of actual
2238 nextKeyIdx = process(os, actual);
2242 case KeyInfo::endArguments:
2243 // Remove trailing '{}' too
2244 actual._dataStart += 1;
2245 actual._dataEnd += 1;
2246 interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2247 nextKeyIdx = getNextKey();
2249 case KeyInfo::noMain:
2251 case KeyInfo::isStandard: {
2252 if (actual.disabled) {
2254 processRegion(actual._dataStart, actual._dataStart+1);
2255 nextKeyIdx = getNextKey();
2257 // Split on this key if not at datastart of calling entry
2258 int start = interval.nextNotIgnored(previousStart);
2259 if (start < actual._tokenstart) {
2260 interval.output(os, actual._tokenstart);
2261 interval.addIntervall(start, actual._tokenstart);
2263 // discard entry if at end of actual
2264 nextKeyIdx = process(os, actual);
2268 case KeyInfo::removeWithArg: {
2269 nextKeyIdx = getNextKey();
2270 // Search for end of arguments
2271 int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2273 for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2274 entries[i].disabled = true;
2276 actual._dataEnd = entries[tmpIdx]._dataEnd;
2278 interval.addIntervall(actual._tokenstart, actual._dataEnd+1);
2281 case KeyInfo::doRemove: {
2282 // Remove the key with all parameters and following spaces
2284 for (pos = actual._dataEnd+1; pos < interval.par.length(); pos++) {
2285 if ((interval.par[pos] != ' ') && (interval.par[pos] != '%'))
2288 interval.addIntervall(actual._tokenstart, pos);
2289 nextKeyIdx = getNextKey();
2292 case KeyInfo::isList: {
2293 // Discard space before _tokenstart
2295 for (count = 0; count < actual._tokenstart; count++) {
2296 if (interval.par[actual._tokenstart-count-1] != ' ')
2299 nextKeyIdx = getNextKey();
2300 int tmpIdx = find(nextKeyIdx, KeyInfo::endArguments);
2302 // Special case: \item is not a list, but a command (like in Style Author_Biography in maa-monthly.layout)
2304 // How else can we catch this one?
2305 for (int i = nextKeyIdx; i <= tmpIdx; i++) {
2306 entries[i].disabled = true;
2308 actual._dataEnd = entries[tmpIdx]._dataEnd;
2310 else if (nextKeyIdx > 0) {
2311 // Ignore any lang entries inside data region
2312 for (int i = nextKeyIdx; i < int(entries.size()) && entries[i]._tokenstart < actual._dataEnd; i++) {
2313 if (entries[i].keytype == KeyInfo::isMain)
2314 entries[i].disabled = true;
2317 if (actual.disabled) {
2318 interval.addIntervall(actual._tokenstart-count, actual._dataEnd+1);
2321 interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
2323 if (interval.par[actual._dataEnd+1] == '[') {
2324 int posdown = interval.findclosing(actual._dataEnd+2, interval.par.length(), '[', ']');
2325 if ((interval.par[actual._dataEnd+2] == '{') &&
2326 (interval.par[posdown-1] == '}')) {
2327 interval.addIntervall(actual._dataEnd+1,actual._dataEnd+3);
2328 interval.addIntervall(posdown-1, posdown+1);
2331 interval.addIntervall(actual._dataEnd+1, actual._dataEnd+2);
2332 interval.addIntervall(posdown, posdown+1);
2334 int blk = interval.nextNotIgnored(actual._dataEnd+1);
2335 if (blk > posdown) {
2336 // Discard at most 1 space after empty item
2338 for (count = 0; count < 1; count++) {
2339 if (interval.par[blk+count] != ' ')
2343 interval.addIntervall(blk, blk+count);
2348 case KeyInfo::isSectioning: {
2349 // Discard spaces before _tokenstart
2351 int val = actual._tokenstart;
2352 for (count = 0; count < actual._tokenstart;) {
2353 val = interval.previousNotIgnored(val-1);
2354 if (interval.par[val] != ' ')
2357 count = actual._tokenstart - val;
2360 if (actual.disabled) {
2361 removeHead(actual, count);
2362 nextKeyIdx = getNextKey();
2364 interval.addIntervall(actual._tokenstart-count, actual._tokenstart);
2365 nextKeyIdx = process(os, actual);
2369 case KeyInfo::isMath: {
2370 // Same as regex, use the content unchanged
2371 nextKeyIdx = getNextKey();
2374 case KeyInfo::isRegex: {
2375 // DO NOT SPLIT ON REGEX
2377 nextKeyIdx = getNextKey();
2380 case KeyInfo::isIgnored: {
2381 // Treat like a character for now
2382 nextKeyIdx = getNextKey();
2385 case KeyInfo::isMain: {
2386 if (interval.par.substr(actual._dataStart, 2) == "% ")
2387 interval.addIntervall(actual._dataStart, actual._dataStart+2);
2388 if (actual._tokenstart > 0) {
2389 int prev = interval.previousNotIgnored(actual._tokenstart - 1);
2390 if ((prev >= 0) && interval.par[prev] == '%')
2391 interval.addIntervall(prev, prev+1);
2393 if (actual.disabled) {
2395 if ((interval.par.substr(actual._dataStart, 3) == " \\[") ||
2396 (interval.par.substr(actual._dataStart, 8) == " \\begin{")) {
2397 // Discard also the space before math-equation
2398 interval.addIntervall(actual._dataStart, actual._dataStart+1);
2400 nextKeyIdx = getNextKey();
2401 // interval.resetOpenedP(actual._dataStart-1);
2404 if (actual._tokenstart < 26) {
2405 // for the first (and maybe dummy) language
2406 interval.setForDefaultLang(actual);
2408 interval.resetOpenedP(actual._dataStart-1);
2412 case KeyInfo::invalid:
2413 // This cannot happen, already handled
2416 // LYXERR0("Unhandled keytype");
2417 nextKeyIdx = getNextKey();
2424 int LatexInfo::process(ostringstream &os, KeyInfo &actual )
2426 int end = interval.nextNotIgnored(actual._dataEnd);
2427 int oldStart = actual._dataStart;
2428 int nextKeyIdx = getNextKey();
2430 if ((nextKeyIdx < 0) ||
2431 (entries[nextKeyIdx]._tokenstart >= actual._dataEnd) ||
2432 (entries[nextKeyIdx].keytype == KeyInfo::invalid)) {
2433 if (oldStart <= end) {
2434 processRegion(oldStart, end);
2439 KeyInfo &nextKey = getKeyInfo(nextKeyIdx);
2441 if ((nextKey.keytype == KeyInfo::isMain) && !nextKey.disabled) {
2442 (void) dispatch(os, actual._dataStart, nextKey);
2443 end = nextKey._tokenstart;
2446 processRegion(oldStart, nextKey._tokenstart);
2447 nextKeyIdx = dispatch(os, actual._dataStart, nextKey);
2449 oldStart = nextKey._dataEnd+1;
2451 // now nextKey is either invalid or is outside of actual._dataEnd
2452 // output the remaining and discard myself
2453 if (oldStart <= end) {
2454 processRegion(oldStart, end);
2456 if (interval.par[end] == '}') {
2458 // This is the normal case.
2459 // But if using the firstlanguage, the closing may be missing
2461 // get minimum of 'end' and 'actual._dataEnd' in case that the nextKey.keytype was 'KeyInfo::isMain'
2463 if (actual._dataEnd < end)
2464 output_end = interval.nextNotIgnored(actual._dataEnd);
2466 output_end = interval.nextNotIgnored(end);
2467 if ((actual.keytype == KeyInfo::isMain) && actual.disabled) {
2468 interval.addIntervall(actual._tokenstart, actual._tokenstart+actual._tokensize);
2470 // Remove possible empty data
2471 int dstart = interval.nextNotIgnored(actual._dataStart);
2472 while (interval.isOpeningPar(dstart) == 1) {
2473 interval.addIntervall(dstart, dstart+1);
2474 int dend = interval.findclosing(dstart+1, output_end);
2475 interval.addIntervall(dend, dend+1);
2476 dstart = interval.nextNotIgnored(dstart+1);
2478 if (dstart < output_end)
2479 interval.output(os, output_end);
2480 interval.addIntervall(actual._tokenstart, end);
2484 string splitOnKnownMacros(string par, bool isPatternString)
2487 LatexInfo li(par, isPatternString);
2488 // LYXERR0("Berfore split: " << par);
2489 KeyInfo DummyKey = KeyInfo(KeyInfo::KeyType::isMain, 2, true);
2491 DummyKey._tokensize = 0;
2492 DummyKey._dataStart = 0;
2493 DummyKey._dataEnd = par.length();
2494 DummyKey.disabled = true;
2495 int firstkeyIdx = li.getFirstKey();
2497 if (firstkeyIdx >= 0) {
2498 KeyInfo firstKey = li.getKeyInfo(firstkeyIdx);
2499 DummyKey._tokenstart = firstKey._tokenstart;
2501 if ((firstKey.keytype != KeyInfo::isMain) || firstKey.disabled) {
2502 // Use dummy firstKey
2503 firstKey = DummyKey;
2504 (void) li.setNextKey(firstkeyIdx);
2507 if (par.substr(firstKey._dataStart, 2) == "% ")
2508 li.addIntervall(firstKey._dataStart, firstKey._dataStart+2);
2510 nextkeyIdx = li.process(os, firstKey);
2511 while (nextkeyIdx >= 0) {
2512 // Check for a possible gap between the last
2513 // entry and this one
2514 int datastart = li.nextNotIgnored(firstKey._dataStart);
2515 KeyInfo &nextKey = li.getKeyInfo(nextkeyIdx);
2516 if ((nextKey._tokenstart > datastart)) {
2518 firstKey._dataStart = datastart;
2519 firstKey._dataEnd = par.length();
2520 (void) li.setNextKey(nextkeyIdx);
2521 // Fake the last opened parenthesis
2522 li.setForDefaultLang(firstKey);
2523 nextkeyIdx = li.process(os, firstKey);
2526 if (nextKey.keytype != KeyInfo::isMain) {
2527 firstKey._dataStart = datastart;
2528 firstKey._dataEnd = nextKey._dataEnd+1;
2529 (void) li.setNextKey(nextkeyIdx);
2530 li.setForDefaultLang(firstKey);
2531 nextkeyIdx = li.process(os, firstKey);
2534 nextkeyIdx = li.process(os, nextKey);
2538 // Handle the remaining
2539 firstKey._dataStart = li.nextNotIgnored(firstKey._dataStart);
2540 firstKey._dataEnd = par.length();
2542 if ((firstKey._dataStart < firstKey._dataEnd) &&
2543 (par[firstKey._dataStart] != '}')) {
2544 li.setForDefaultLang(firstKey);
2545 (void) li.process(os, firstKey);
2549 // return string definitelly impossible to match
2550 s = "\\foreignlanguage{ignore}{ }";
2554 s = par; /* no known macros found */
2555 // LYXERR0("After split: " << s);
2560 * Try to unify the language specs in the latexified text.
2561 * Resulting modified string is set to "", if
2562 * the searched tex does not contain all the features in the search pattern
2564 static string correctlanguagesetting(string par, bool isPatternString, bool withformat)
2566 static Features regex_f;
2567 static int missed = 0;
2568 static bool regex_with_format = false;
2570 int parlen = par.length();
2572 while ((parlen > 0) && (par[parlen-1] == '\n')) {
2575 if (isPatternString && (parlen > 0) && (par[parlen-1] == '~')) {
2576 // Happens to be there in case of description or labeling environment
2581 // Split the latex input into pieces which
2582 // can be digested by our search engine
2583 LYXERR(Debug::FIND, "input: \"" << par << "\"");
2584 result = splitOnKnownMacros(par.substr(0,parlen), isPatternString);
2585 LYXERR(Debug::FIND, "After split: \"" << result << "\"");
2588 result = par.substr(0, parlen);
2589 if (isPatternString) {
2592 regex_f = identifyFeatures(result);
2593 string features = "";
2594 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2595 string a = it->first;
2596 regex_with_format = true;
2597 features += " " + a;
2598 // LYXERR0("Identified regex format:" << a);
2600 LYXERR(Debug::FIND, "Identified Features" << features);
2603 } else if (regex_with_format) {
2604 Features info = identifyFeatures(result);
2605 for (auto it = regex_f.cbegin(); it != regex_f.cend(); ++it) {
2606 string a = it->first;
2607 bool b = it->second;
2608 if (b && ! info[a]) {
2610 LYXERR(Debug::FIND, "Missed(" << missed << " " << a <<", srclen = " << parlen );
2616 // LYXERR0("No regex formats");
2622 // Remove trailing closure of math, macros and environments, so to catch parts of them.
2623 static int identifyClosing(string & t)
2625 int open_braces = 0;
2627 LYXERR(Debug::FIND, "identifyClosing(): t now is '" << t << "'");
2628 if (regex_replace(t, t, "(.*[^\\\\])\\$" REGEX_EOS, "$1"))
2630 if (regex_replace(t, t, "(.*[^\\\\]) \\\\\\]" REGEX_EOS, "$1"))
2632 if (regex_replace(t, t, "(.*[^\\\\]) \\\\end\\{[a-zA-Z_]*\\*?\\}" REGEX_EOS, "$1"))
2634 if (regex_replace(t, t, "(.*[^\\\\])\\}" REGEX_EOS, "$1")) {
2643 static int num_replaced = 0;
2644 static bool previous_single_replace = true;
2646 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
2647 : p_buf(&buf), p_first_buf(&buf), opt(opt)
2649 Buffer & find_buf = *theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true);
2650 docstring const & ds = stringifySearchBuffer(find_buf, opt);
2651 use_regexp = lyx::to_utf8(ds).find("\\regexp{") != std::string::npos;
2652 if (opt.replace_all && previous_single_replace) {
2653 previous_single_replace = false;
2656 else if (!opt.replace_all) {
2657 num_replaced = 0; // count number of replaced strings
2658 previous_single_replace = true;
2660 // When using regexp, braces are hacked already by escape_for_regex()
2661 par_as_string = normalize(ds, !use_regexp);
2663 close_wildcards = 0;
2665 size_t lead_size = 0;
2666 // correct the language settings
2667 par_as_string = correctlanguagesetting(par_as_string, true, !opt.ignoreformat);
2668 if (opt.ignoreformat) {
2670 // if par_as_string_nolead were emty,
2671 // the following call to findAux will always *find* the string
2672 // in the checked data, and thus always using the slow
2673 // examining of the current text part.
2674 par_as_string_nolead = par_as_string;
2677 lead_size = identifyLeading(par_as_string);
2678 LYXERR(Debug::FIND, "Lead_size: " << lead_size);
2679 lead_as_string = par_as_string.substr(0, lead_size);
2680 par_as_string_nolead = par_as_string.substr(lead_size, par_as_string.size() - lead_size);
2684 open_braces = identifyClosing(par_as_string);
2685 identifyClosing(par_as_string_nolead);
2686 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2687 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
2689 string lead_as_regexp;
2690 if (lead_size > 0) {
2691 // @todo No need to search for \regexp{} insets in leading material
2692 lead_as_regexp = escape_for_regex(par_as_string.substr(0, lead_size), !opt.ignoreformat);
2693 par_as_string = par_as_string_nolead;
2694 LYXERR(Debug::FIND, "lead_as_regexp is '" << lead_as_regexp << "'");
2695 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2697 par_as_string = escape_for_regex(par_as_string, !opt.ignoreformat);
2698 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
2699 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2701 // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
2702 regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
2703 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
2704 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])( \\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
2705 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
2706 || regex_replace(par_as_string, par_as_string,
2707 "(.*[^\\\\])( \\\\\\\\end\\\\\\{[a-zA-Z_]*)(\\\\\\*)?(\\\\\\})\\'", "$1(.*?)$2$3$4")
2708 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
2709 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
2713 if (!opt.ignoreformat) {
2714 // Remove extra '\}' at end if not part of \{\.\}
2715 size_t lng = par_as_string.size();
2717 if (par_as_string.substr(lng-2, 2).compare("\\}") == 0) {
2719 if (par_as_string.substr(lng-6,3).compare("\\{\\") == 0)
2728 if (lng < par_as_string.size())
2729 par_as_string = par_as_string.substr(0,lng);
2732 regex_replace(par_as_string, par_as_string, "\\\\\\.", "_xxbdotxx_");
2733 // handle '.' -> '[^]', replace later as '[^\}\{\\]'
2734 regex_replace(par_as_string, par_as_string, "\\.", "[^]");
2735 // replace '[^...]' with '[^...\}\{\\]'
2736 regex_replace(par_as_string, par_as_string, "\\[\\^([^\\\\\\]]*)\\]", "_xxbrlxx_$1\\}\\{\\\\_xxbrrxx_");
2737 regex_replace(par_as_string, par_as_string, "_xxbrlxx_", "[^");
2738 regex_replace(par_as_string, par_as_string, "_xxbrrxx_", "]");
2740 regex_replace(par_as_string, par_as_string, "_xxbdotxx_", "\\.");
2743 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
2744 LYXERR(Debug::FIND, "Open braces: " << open_braces);
2745 LYXERR(Debug::FIND, "Close .*? : " << close_wildcards);
2746 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
2748 // If entered regexp must match at begin of searched string buffer
2749 // Kornel: Added parentheses to use $1 for size of the leading string
2753 // TODO: Adapt '\[12345678]' in par_as_string to acount for the first '()
2754 // Unfortunately is '\1', '\2', etc not working for strings with extra format
2755 // so the convert has no effect in that case
2756 for (int i = 8; i > 0; --i) {
2757 string orig = "\\\\" + std::to_string(i);
2758 string dest = "\\" + std::to_string(i+1);
2759 while (regex_replace(par_as_string, par_as_string, orig, dest));
2761 regexp_str = "(" + lead_as_regexp + ")" + par_as_string;
2762 regexp2_str = "(" + lead_as_regexp + ").*?" + par_as_string;
2764 LYXERR(Debug::FIND, "Setting regexp to : '" << regexp_str << "'");
2765 regexp = lyx::regex(regexp_str);
2767 LYXERR(Debug::FIND, "Setting regexp2 to: '" << regexp2_str << "'");
2768 regexp2 = lyx::regex(regexp2_str);
2773 // Count number of characters in string
2777 // \\[a-zA-Z]+ ==> 1
2778 static int computeSize(string s, int len)
2784 for (int i = 0; i < len; i += skip, count++) {
2787 if (isalpha(s[i+1])) {
2788 for (int j = 2; i+j < len; j++) {
2789 if (! isalpha(s[i+j])) {
2792 else if ((s[i+j] == '{') && s[i+j+1] == '}')
2794 else if ((s[i+j] == '{') && (i + j + 1 >= len))
2802 else if (s[i] == '{') {
2808 else if (s[i] == '-') {
2809 if (s[i+1] == '-') {
2825 MatchResult MatchStringAdv::findAux(DocIterator const & cur, int len, bool at_begin) const
2830 (opt.restr == FindAndReplaceOptions::R_ONLY_MATHS && !cur.inMathed()) )
2833 docstring docstr = stringifyFromForSearch(opt, cur, len);
2834 string str = normalize(docstr, true);
2835 if (!opt.ignoreformat) {
2836 str = correctlanguagesetting(str, false, !opt.ignoreformat);
2839 mres.match_len = -1;
2842 LYXERR(Debug::FIND, "Matching against '" << lyx::to_utf8(docstr) << "'");
2843 LYXERR(Debug::FIND, "After normalization: '" << str << "'");
2846 LYXERR(Debug::FIND, "Searching in regexp mode: at_begin=" << at_begin);
2847 regex const *p_regexp;
2848 regex_constants::match_flag_type flags;
2850 flags = regex_constants::match_continuous;
2853 flags = regex_constants::match_default;
2854 p_regexp = ®exp2;
2856 sregex_iterator re_it(str.begin(), str.end(), *p_regexp, flags);
2857 if (re_it == sregex_iterator())
2859 match_results<string::const_iterator> const & m = *re_it;
2861 if (0) { // Kornel Benko: DO NOT CHECKK
2862 // Check braces on the segment that matched the entire regexp expression,
2863 // plus the last subexpression, if a (.*?) was inserted in the constructor.
2864 if (!braces_match(m[0].first, m[0].second, open_braces))
2868 // Check braces on segments that matched all (.*?) subexpressions,
2869 // except the last "padding" one inserted by lyx.
2870 for (size_t i = 1; i < m.size() - 1; ++i)
2871 if (!braces_match(m[i].first, m[i].second, open_braces))
2874 // Exclude from the returned match length any length
2875 // due to close wildcards added at end of regexp
2876 // and also the length of the leading (e.g. '\emph{}')
2878 // Whole found string, including the leading: m[0].second - m[0].first
2879 // Size of the leading string: m[1].second - m[1].first
2880 int leadingsize = 0;
2882 leadingsize = m[1].second - m[1].first;
2884 for (size_t i = 0; i < m.size(); i++) {
2885 LYXERR(Debug::FIND, "Match " << i << " is " << m[i].second - m[i].first << " long");
2887 if (close_wildcards == 0)
2888 result = m[0].second - m[0].first;
2891 result = m[m.size() - close_wildcards].first - m[0].first;
2893 size_t pos = m.position(size_t(0));
2894 // Ignore last closing characters
2895 while (result > 0) {
2896 if (str[pos+result-1] == '}')
2901 if (result > leadingsize)
2902 result -= leadingsize;
2905 mres.match_len = computeSize(str.substr(pos+leadingsize,result), result);
2906 mres.match2end = str.size() - pos - leadingsize;
2907 mres.pos = pos+leadingsize;
2911 // else !use_regexp: but all code paths above return
2912 LYXERR(Debug::FIND, "Searching in normal mode: par_as_string='"
2913 << par_as_string << "', str='" << str << "'");
2914 LYXERR(Debug::FIND, "Searching in normal mode: lead_as_string='"
2915 << lead_as_string << "', par_as_string_nolead='"
2916 << par_as_string_nolead << "'");
2919 LYXERR(Debug::FIND, "size=" << par_as_string.size()
2920 << ", substr='" << str.substr(0, par_as_string.size()) << "'");
2921 if (str.substr(0, par_as_string.size()) == par_as_string) {
2922 mres.match_len = par_as_string.size();
2923 mres.match2end = str.size();
2928 // Start the search _after_ the leading part
2929 size_t pos = str.find(par_as_string_nolead, lead_as_string.size());
2930 if (pos != string::npos) {
2931 mres.match_len = par_as_string.size();
2932 mres.match2end = str.size() - pos;
2941 MatchResult MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
2943 MatchResult mres = findAux(cur, len, at_begin);
2944 int res = mres.match_len;
2946 "res=" << res << ", at_begin=" << at_begin
2947 << ", matchword=" << opt.matchword
2948 << ", inTexted=" << cur.inTexted());
2949 if (res == 0 || !at_begin || !opt.matchword || !cur.inTexted())
2951 if ((len > 0) && (res < len)) {
2955 Paragraph const & par = cur.paragraph();
2956 bool ws_left = (cur.pos() > 0)
2957 ? par.isWordSeparator(cur.pos() - 1)
2959 bool ws_right = (cur.pos() + len < par.size())
2960 ? par.isWordSeparator(cur.pos() + len)
2963 "cur.pos()=" << cur.pos() << ", res=" << res
2964 << ", separ: " << ws_left << ", " << ws_right
2967 if (ws_left && ws_right) {
2968 // Check for word separators inside the found 'word'
2969 for (int i = 0; i < len; i++) {
2970 if (par.isWordSeparator(cur.pos() + i)) {
2982 string MatchStringAdv::normalize(docstring const & s, bool hack_braces) const
2985 if (! opt.casesensitive)
2986 t = lyx::to_utf8(lowercase(s));
2988 t = lyx::to_utf8(s);
2989 // Remove \n at begin
2990 while (!t.empty() && t[0] == '\n')
2993 while (!t.empty() && t[t.size() - 1] == '\n')
2994 t = t.substr(0, t.size() - 1);
2996 // Handle all other '\n'
2997 while ((pos = t.find("\n")) != string::npos) {
2998 if (pos > 1 && t[pos-1] == '\\' && t[pos-2] == '\\' ) {
3000 if (isAlnumASCII(t[pos+1])) {
3001 t.replace(pos-2, 3, " ");
3004 t.replace(pos-2, 3, "");
3007 else if (!isAlnumASCII(t[pos+1]) || !isAlnumASCII(t[pos-1])) {
3008 // '\n' adjacent to non-alpha-numerics, discard
3009 t.replace(pos, 1, "");
3012 // Replace all other \n with spaces
3013 t.replace(pos, 1, " ");
3016 // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
3017 // Kornel: Added textsl, textsf, textit, texttt and noun
3018 // + allow to seach for colored text too
3019 LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
3020 while (regex_replace(t, t, "\\\\(emph|noun|text(bf|sl|sf|it|tt)|(u|uu)line|(s|x)out|uwave)(\\{(\\{\\})?\\})+", ""))
3021 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3022 while (regex_replace(t, t, "\\\\((sub)?(((sub)?section)|paragraph)|part)\\*?(\\{(\\{\\})?\\})+", ""))
3023 LYXERR(Debug::FIND, " further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
3025 while (regex_replace(t, t, "\\\\(foreignlanguage|textcolor|item)\\{[a-z]+\\}(\\{(\\{\\})?\\})+", ""));
3026 // FIXME - check what preceeds the brace
3028 if (opt.ignoreformat)
3029 while (regex_replace(t, t, "\\{", "_x_<")
3030 || regex_replace(t, t, "\\}", "_x_>"))
3031 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3033 while (regex_replace(t, t, "\\\\\\{", "_x_<")
3034 || regex_replace(t, t, "\\\\\\}", "_x_>"))
3035 LYXERR(Debug::FIND, "After {} replacement: '" << t << "'");
3042 docstring stringifyFromCursor(DocIterator const & cur, int len)
3044 LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
3045 if (cur.inTexted()) {
3046 Paragraph const & par = cur.paragraph();
3047 // TODO what about searching beyond/across paragraph breaks ?
3048 // TODO Try adding a AS_STR_INSERTS as last arg
3049 pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
3050 int(par.size()) : cur.pos() + len;
3051 // OutputParams runparams(&cur.buffer()->params().encoding());
3052 OutputParams runparams(encodings.fromLyXName("utf8"));
3053 runparams.nice = true;
3054 runparams.flavor = OutputParams::XETEX;
3055 runparams.linelen = 10000; //lyxrc.plaintext_linelen;
3056 // No side effect of file copying and image conversion
3057 runparams.dryrun = true;
3058 runparams.for_search = true;
3059 LYXERR(Debug::FIND, "Stringifying with cur: "
3060 << cur << ", from pos: " << cur.pos() << ", end: " << end);
3061 return par.asString(cur.pos(), end,
3062 AS_STR_INSETS | AS_STR_SKIPDELETE | AS_STR_PLAINTEXT,
3064 } else if (cur.inMathed()) {
3065 CursorSlice cs = cur.top();
3066 MathData md = cs.cell();
3067 MathData::const_iterator it_end =
3068 (( len == -1 || cs.pos() + len > int(md.size()))
3070 : md.begin() + cs.pos() + len );
3072 for (MathData::const_iterator it = md.begin() + cs.pos();
3075 docstring s = asString(md2);
3076 LYXERR(Debug::FIND, "Stringified math: '" << s << "'");
3079 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3084 /** Computes the LaTeX export of buf starting from cur and ending len positions
3085 * after cur, if len is positive, or at the paragraph or innermost inset end
3088 docstring latexifyFromCursor(DocIterator const & cur, int len)
3090 LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
3091 LYXERR(Debug::FIND, " with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
3092 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
3093 Buffer const & buf = *cur.buffer();
3095 odocstringstream ods;
3097 //OutputParams runparams(&buf.params().encoding());
3098 OutputParams runparams(encodings.fromLyXName("utf8"));
3099 runparams.nice = false;
3100 runparams.flavor = OutputParams::XETEX;
3101 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3102 // No side effect of file copying and image conversion
3103 runparams.dryrun = true;
3104 runparams.for_search = true;
3106 if (cur.inTexted()) {
3107 // @TODO what about searching beyond/across paragraph breaks ?
3108 pos_type endpos = cur.paragraph().size();
3109 if (len != -1 && endpos > cur.pos() + len)
3110 endpos = cur.pos() + len;
3111 TeXOnePar(buf, *cur.innerText(), cur.pit(), os, runparams,
3112 string(), cur.pos(), endpos);
3113 string s = lyx::to_utf8(ods.str());
3114 LYXERR(Debug::FIND, "Latexified +modified text: '" << s << "'");
3115 return(lyx::from_utf8(s));
3116 } else if (cur.inMathed()) {
3117 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
3118 for (int s = cur.depth() - 1; s >= 0; --s) {
3119 CursorSlice const & cs = cur[s];
3120 if (cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
3122 cs.asInsetMath()->asHullInset()->header_write(ws);
3127 CursorSlice const & cs = cur.top();
3128 MathData md = cs.cell();
3129 MathData::const_iterator it_end =
3130 ((len == -1 || cs.pos() + len > int(md.size()))
3132 : md.begin() + cs.pos() + len);
3134 for (MathData::const_iterator it = md.begin() + cs.pos();
3138 ods << asString(md2);
3139 // Retrieve the math environment type, and add '$' or '$]'
3140 // or others (\end{equation}) accordingly
3141 for (int s = cur.depth() - 1; s >= 0; --s) {
3142 CursorSlice const & cs2 = cur[s];
3143 InsetMath * inset = cs2.asInsetMath();
3144 if (inset && inset->asHullInset()) {
3146 inset->asHullInset()->footer_write(ws);
3150 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
3152 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
3158 /** Finalize an advanced find operation, advancing the cursor to the innermost
3159 ** position that matches, plus computing the length of the matching text to
3162 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
3164 // Search the foremost position that matches (avoids find of entire math
3165 // inset when match at start of it)
3167 DocIterator old_cur(cur.buffer());
3169 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
3173 } while (cur && cur.depth() > d && match(cur).match_len > 0);
3175 int max_match = match(cur).match_len; /* match valid only if not searching whole words */
3176 if (max_match <= 0) return 0;
3177 LYXERR(Debug::FIND, "Ok");
3179 // Compute the match length
3181 if (cur.pos() + len > cur.lastpos())
3183 if (match.opt.matchword) {
3184 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3185 while (cur.pos() + len <= cur.lastpos() && match(cur, len).match_len <= 0) {
3187 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
3189 // Length of matched text (different from len param)
3190 int old_match = match(cur, len).match_len;
3194 // Greedy behaviour while matching regexps
3195 while ((new_match = match(cur, len + 1).match_len) > old_match) {
3197 old_match = new_match;
3198 LYXERR(Debug::FIND, "verifying match with len = " << len);
3205 int maxl = cur.lastpos() - cur.pos();
3206 // Greedy behaviour while matching regexps
3207 while (maxl > minl) {
3208 int actual_match = match(cur, len).match_len;
3209 if (actual_match >= max_match) {
3210 // actual_match > max_match _can_ happen,
3211 // if the search area splits
3212 // some following word so that the regex
3213 // (e.g. 'r.*r\b' matches 'r' from the middle of the
3215 // This means, the len value is too big
3217 len = (int)((maxl + minl)/2);
3220 // (actual_match < max_match)
3222 len = (int)((maxl + minl)/2);
3226 // Search for real start of matched characters
3231 } while (cur.depth() > old_cur.depth()); /* Skip inner insets */
3232 if (cur.depth() < old_cur.depth()) {
3234 LYXERR0("cur.depth() < old_cur.depth(), this should never happen");
3237 if (cur.pos() != old_cur.pos()) {
3238 // OK, forwarded 1 pos in actual inset
3239 actual_match = match(cur, len-1).match_len;
3240 if (actual_match == max_match) {
3241 // Ha, got it! The shorter selection has the same match length
3246 // OK, the shorter selection matches less chars, revert to previous value
3252 LYXERR0("cur.pos() == old_cur.pos(), this should never happen");
3253 actual_match = match(cur, len).match_len;
3254 if (actual_match == max_match)
3264 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
3268 while (!theApp()->longOperationCancelled() && cur) {
3269 LYXERR(Debug::FIND, "findForwardAdv() cur: " << cur);
3270 MatchResult mres = match(cur, -1, false);
3271 int match_len = mres.match_len;
3272 LYXERR(Debug::FIND, "match_len: " << match_len);
3273 if ((mres.pos > 100000) || (mres.match2end > 100000) || (match_len > 100000)) {
3274 LYXERR0("BIG LENGTHS: " << mres.pos << ", " << match_len << ", " << mres.match2end);
3277 if (match_len > 0) {
3278 // Try to find the begin of searched string
3279 int increment = mres.pos/2;
3280 while (mres.pos > 5 && (increment > 5)) {
3281 DocIterator old_cur = cur;
3282 for (int i = 0; i < increment && cur; cur.forwardPos(), i++) {
3284 if (! cur || (cur.pit() > old_cur.pit())) {
3285 // Are we outside of the paragraph?
3286 // This can happen if moving past some UTF8-encoded chars
3291 MatchResult mres2 = match(cur, -1, false);
3292 if ((mres2.match2end < mres.match2end) ||
3293 (mres2.match_len < mres.match_len)) {
3300 if (increment > mres.pos/2)
3301 increment = mres.pos/2;
3305 int match_len_zero_count = 0;
3306 for (int i = 0; !theApp()->longOperationCancelled() && cur; cur.forwardPos()) {
3308 int remaining_len = match(cur, -1, false).match_len;
3309 if (remaining_len <= 0) {
3310 // Apparently the searched string is not in the remaining part
3317 LYXERR(Debug::FIND, "Advancing cur: " << cur);
3318 int match_len3 = match(cur, 1).match_len;
3321 int match_len2 = match(cur).match_len;
3322 LYXERR(Debug::FIND, "match_len2: " << match_len2);
3323 if (match_len2 > 0) {
3324 // Sometimes in finalize we understand it wasn't a match
3325 // and we need to continue the outest loop
3326 int len = findAdvFinalize(cur, match);
3331 if (match_len2 >= 0) {
3332 if (match_len2 == 0)
3333 match_len_zero_count++;
3335 match_len_zero_count = 0;
3338 if (++match_len_zero_count > 3) {
3339 LYXERR(Debug::FIND, "match_len2_zero_count: " << match_len_zero_count << ", match_len was " << match_len);
3340 match_len_zero_count = 0;
3348 if (match_len >= 0 && cur.pit() < cur.lastpit()) {
3349 LYXERR(Debug::FIND, "Advancing par: cur=" << cur);
3352 // This should exit nested insets, if any, or otherwise undefine the currsor.
3353 cur.pos() = cur.lastpos();
3354 LYXERR(Debug::FIND, "Advancing pos: cur=" << cur);
3362 /// Find the most backward consecutive match within same paragraph while searching backwards.
3363 int findMostBackwards(DocIterator & cur, MatchStringAdv const & match)
3365 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3366 DocIterator tmp_cur = cur;
3367 int len = findAdvFinalize(tmp_cur, match);
3368 Inset & inset = cur.inset();
3369 for (; cur != cur_begin; cur.backwardPos()) {
3370 LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
3371 DocIterator new_cur = cur;
3372 new_cur.backwardPos();
3373 if (new_cur == cur || &new_cur.inset() != &inset || !match(new_cur).match_len)
3375 int new_len = findAdvFinalize(new_cur, match);
3380 LYXERR(Debug::FIND, "findMostBackwards(): exiting with cur=" << cur);
3386 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match)
3390 // Backup of original position
3391 DocIterator cur_begin = doc_iterator_begin(cur.buffer());
3392 if (cur == cur_begin)
3395 DocIterator cur_orig(cur);
3396 bool pit_changed = false;
3399 bool found_match = (match(cur, -1, false).match_len > 0);
3403 cur.pos() = cur.lastpos();
3405 cur.pos() = cur_orig.pos();
3406 LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
3407 DocIterator cur_prev_iter;
3409 found_match = (match(cur).match_len > 0);
3410 LYXERR(Debug::FIND, "findBackAdv3: found_match="
3411 << found_match << ", cur: " << cur);
3413 return findMostBackwards(cur, match);
3415 // Stop if begin of document reached
3416 if (cur == cur_begin)
3418 cur_prev_iter = cur;
3422 if (cur == cur_begin)
3429 } while (!theApp()->longOperationCancelled());
3437 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
3438 DocIterator const & cur, int len)
3440 if (cur.pos() < 0 || cur.pos() > cur.lastpos())
3442 if (!opt.ignoreformat)
3443 return latexifyFromCursor(cur, len);
3445 return stringifyFromCursor(cur, len);
3449 FindAndReplaceOptions::FindAndReplaceOptions(
3450 docstring const & find_buf_name, bool casesensitive,
3451 bool matchword, bool forward, bool expandmacros, bool ignoreformat,
3452 docstring const & repl_buf_name, bool keep_case,
3453 SearchScope scope, SearchRestriction restr, bool replace_all)
3454 : find_buf_name(find_buf_name), casesensitive(casesensitive), matchword(matchword),
3455 forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
3456 repl_buf_name(repl_buf_name), keep_case(keep_case), scope(scope), restr(restr), replace_all(replace_all)
3464 /** Check if 'len' letters following cursor are all non-lowercase */
3465 static bool allNonLowercase(Cursor const & cur, int len)
3467 pos_type beg_pos = cur.selectionBegin().pos();
3468 pos_type end_pos = cur.selectionBegin().pos() + len;
3469 if (len > cur.lastpos() + 1 - beg_pos) {
3470 LYXERR(Debug::FIND, "This should not happen, more debug needed");
3471 len = cur.lastpos() + 1 - beg_pos;
3472 end_pos = beg_pos + len;
3474 for (pos_type pos = beg_pos; pos != end_pos; ++pos)
3475 if (isLowerCase(cur.paragraph().getChar(pos)))
3481 /** Check if first letter is upper case and second one is lower case */
3482 static bool firstUppercase(Cursor const & cur)
3485 pos_type pos = cur.selectionBegin().pos();
3486 if (pos >= cur.lastpos() - 1) {
3487 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
3490 ch1 = cur.paragraph().getChar(pos);
3491 ch2 = cur.paragraph().getChar(pos + 1);
3492 bool result = isUpperCase(ch1) && isLowerCase(ch2);
3493 LYXERR(Debug::FIND, "firstUppercase(): "
3494 << "ch1=" << ch1 << "(" << char(ch1) << "), ch2="
3495 << ch2 << "(" << char(ch2) << ")"
3496 << ", result=" << result << ", cur=" << cur);
3501 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
3503 ** \fixme What to do with possible further paragraphs in replace buffer ?
3505 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case)
3507 ParagraphList::iterator pit = buffer.paragraphs().begin();
3508 LASSERT(pit->size() >= 1, /**/);
3509 pos_type right = pos_type(1);
3510 pit->changeCase(buffer.params(), pos_type(0), right, first_case);
3511 right = pit->size();
3512 pit->changeCase(buffer.params(), pos_type(1), right, others_case);
3518 static int findAdvReplace(BufferView * bv, FindAndReplaceOptions const & opt, MatchStringAdv & matchAdv)
3520 Cursor & cur = bv->cursor();
3521 if (opt.repl_buf_name == docstring()
3522 || theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true) == 0
3523 || theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3526 DocIterator sel_beg = cur.selectionBegin();
3527 DocIterator sel_end = cur.selectionEnd();
3528 if (&sel_beg.inset() != &sel_end.inset()
3529 || sel_beg.pit() != sel_end.pit()
3530 || sel_beg.idx() != sel_end.idx())
3532 int sel_len = sel_end.pos() - sel_beg.pos();
3533 LYXERR(Debug::FIND, "sel_beg: " << sel_beg << ", sel_end: " << sel_end
3534 << ", sel_len: " << sel_len << endl);
3537 LASSERT(sel_len > 0, return 0);
3539 if (!matchAdv(sel_beg, sel_len).match_len)
3542 // Build a copy of the replace buffer, adapted to the KeepCase option
3543 Buffer & repl_buffer_orig = *theBufferList().getBuffer(FileName(to_utf8(opt.repl_buf_name)), true);
3545 repl_buffer_orig.write(oss);
3546 string lyx = oss.str();
3547 Buffer repl_buffer("", false);
3548 repl_buffer.setUnnamed(true);
3549 LASSERT(repl_buffer.readString(lyx), return 0);
3550 if (opt.keep_case && sel_len >= 2) {
3551 LYXERR(Debug::FIND, "keep_case true: cur.pos()=" << cur.pos() << ", sel_len=" << sel_len);
3552 if (cur.inTexted()) {
3553 if (firstUppercase(cur))
3554 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
3555 else if (allNonLowercase(cur, sel_len))
3556 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
3559 cap::cutSelection(cur, false);
3560 if (cur.inTexted()) {
3561 repl_buffer.changeLanguage(
3562 repl_buffer.language(),
3563 cur.getFont().language());
3564 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
3565 LYXERR(Debug::FIND, "Before pasteParagraphList() cur=" << cur << endl);
3566 cap::pasteParagraphList(cur, repl_buffer.paragraphs(),
3567 repl_buffer.params().documentClassPtr(),
3568 bv->buffer().errorList("Paste"));
3569 LYXERR(Debug::FIND, "After pasteParagraphList() cur=" << cur << endl);
3570 sel_len = repl_buffer.paragraphs().begin()->size();
3571 } else if (cur.inMathed()) {
3572 odocstringstream ods;
3574 // OutputParams runparams(&repl_buffer.params().encoding());
3575 OutputParams runparams(encodings.fromLyXName("utf8"));
3576 runparams.nice = false;
3577 runparams.flavor = OutputParams::XETEX;
3578 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
3579 runparams.dryrun = true;
3580 TeXOnePar(repl_buffer, repl_buffer.text(), 0, os, runparams);
3581 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
3582 docstring repl_latex = ods.str();
3583 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
3585 (void)regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
3586 (void)regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
3587 repl_latex = from_utf8(s);
3588 LYXERR(Debug::FIND, "Replacing by insert()ing latex: '" << repl_latex << "' cur=" << cur << " with depth=" << cur.depth());
3589 MathData ar(cur.buffer());
3590 asArray(repl_latex, ar, Parse::NORMAL);
3592 sel_len = ar.size();
3593 LYXERR(Debug::FIND, "After insert() cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3595 if (cur.pos() >= sel_len)
3596 cur.pos() -= sel_len;
3599 LYXERR(Debug::FIND, "After pos adj cur=" << cur << " with depth: " << cur.depth() << " and len: " << sel_len);
3600 bv->putSelectionAt(DocIterator(cur), sel_len, !opt.forward);
3601 bv->processUpdateFlags(Update::Force);
3606 /// Perform a FindAdv operation.
3607 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
3612 // e.g., when invoking word-findadv from mini-buffer wither with
3613 // wrong options syntax or before ever opening advanced F&R pane
3614 if (theBufferList().getBuffer(FileName(to_utf8(opt.find_buf_name)), true) == 0)
3618 MatchStringAdv matchAdv(bv->buffer(), opt);
3619 int length = bv->cursor().selectionEnd().pos() - bv->cursor().selectionBegin().pos();
3621 bv->putSelectionAt(bv->cursor().selectionBegin(), length, !opt.forward);
3622 num_replaced += findAdvReplace(bv, opt, matchAdv);
3625 match_len = findForwardAdv(cur, matchAdv);
3627 match_len = findBackwardsAdv(cur, matchAdv);
3629 // This may only be raised by lyx::regex()
3630 bv->message(_("Invalid regular expression!"));
3634 if (match_len == 0) {
3635 if (num_replaced > 0) {
3636 switch (num_replaced)
3639 bv->message(_("One match has been replaced."));
3642 bv->message(_("Two matches have been replaced."));
3645 bv->message(bformat(_("%1$d matches have been replaced."), num_replaced));
3651 bv->message(_("Match not found."));
3656 if (num_replaced > 0)
3657 bv->message(_("Match has been replaced."));
3659 bv->message(_("Match found."));
3661 LYXERR(Debug::FIND, "Putting selection at cur=" << cur << " with len: " << match_len);
3662 bv->putSelectionAt(cur, match_len, !opt.forward);
3668 ostringstream & operator<<(ostringstream & os, FindAndReplaceOptions const & opt)
3670 os << to_utf8(opt.find_buf_name) << "\nEOSS\n"
3671 << opt.casesensitive << ' '
3672 << opt.matchword << ' '
3673 << opt.forward << ' '
3674 << opt.expandmacros << ' '
3675 << opt.ignoreformat << ' '
3676 << opt.replace_all << ' '
3677 << to_utf8(opt.repl_buf_name) << "\nEOSS\n"
3678 << opt.keep_case << ' '
3679 << int(opt.scope) << ' '
3682 LYXERR(Debug::FIND, "built: " << os.str());
3688 istringstream & operator>>(istringstream & is, FindAndReplaceOptions & opt)
3690 LYXERR(Debug::FIND, "parsing");
3694 while (line != "EOSS") {
3698 if (is.eof()) // Tolerate malformed request
3702 LYXERR(Debug::FIND, "file_buf_name: '" << s << "'");
3703 opt.find_buf_name = from_utf8(s);
3704 is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.replace_all;
3705 is.get(); // Waste space before replace string
3708 while (line != "EOSS") {
3712 if (is.eof()) // Tolerate malformed request
3716 LYXERR(Debug::FIND, "repl_buf_name: '" << s << "'");
3717 opt.repl_buf_name = from_utf8(s);
3718 is >> opt.keep_case;
3721 opt.scope = FindAndReplaceOptions::SearchScope(i);
3723 opt.restr = FindAndReplaceOptions::SearchRestriction(i);
3725 LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
3726 << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.keep_case << ' '
3727 << opt.scope << ' ' << opt.restr);