]> git.lyx.org Git - lyx.git/blob - src/lyxfind.cpp
Routines for calculating numerical labels for BibTeX citations.
[lyx.git] / src / lyxfind.cpp
1 /**
2  * \file lyxfind.cpp
3  * This file is part of LyX, the document processor.
4  * License details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author John Levon
8  * \author Jürgen Vigna
9  * \author Alfredo Braunstein
10  * \author Tommaso Cucinotta
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "lyxfind.h"
18
19 #include "Buffer.h"
20 #include "BufferList.h"
21 #include "buffer_funcs.h"
22 #include "BufferParams.h"
23 #include "BufferView.h"
24 #include "Changes.h"
25 #include "Cursor.h"
26 #include "CutAndPaste.h"
27 #include "FuncRequest.h"
28 #include "OutputParams.h"
29 #include "output_latex.h"
30 #include "Paragraph.h"
31 #include "ParIterator.h"
32 #include "TexRow.h"
33 #include "Text.h"
34 #include "FuncRequest.h"
35 #include "LyXFunc.h"
36
37 #include "mathed/InsetMath.h"
38 #include "mathed/InsetMathGrid.h"
39 #include "mathed/InsetMathHull.h"
40 #include "mathed/MathStream.h"
41
42 #include "frontends/alert.h"
43
44 #include "support/convert.h"
45 #include "support/debug.h"
46 #include "support/docstream.h"
47 #include "support/gettext.h"
48 #include "support/lstrings.h"
49 #include "support/lassert.h"
50
51 #include "frontends/Application.h"
52 #include "frontends/LyXView.h"
53
54 #include <boost/regex.hpp>
55 #include <boost/next_prior.hpp>
56
57 using namespace std;
58 using namespace lyx::support;
59
60 namespace lyx {
61
62 namespace {
63
64 bool parse_bool(docstring & howto)
65 {
66         if (howto.empty())
67                 return false;
68         docstring var;
69         howto = split(howto, var, ' ');
70         return var == "1";
71 }
72
73
74 class MatchString : public binary_function<Paragraph, pos_type, bool>
75 {
76 public:
77         MatchString(docstring const & str, bool cs, bool mw)
78                 : str(str), cs(cs), mw(mw)
79         {}
80
81         // returns true if the specified string is at the specified position
82         // del specifies whether deleted strings in ct mode will be considered
83         bool operator()(Paragraph const & par, pos_type pos, bool del = true) const
84         {
85                 return par.find(str, cs, mw, pos, del);
86         }
87
88 private:
89         // search string
90         docstring str;
91         // case sensitive
92         bool cs;
93         // match whole words only
94         bool mw;
95 };
96
97
98 bool findForward(DocIterator & cur, MatchString const & match,
99                  bool find_del = true)
100 {
101         for (; cur; cur.forwardChar())
102                 if (cur.inTexted() &&
103                     match(cur.paragraph(), cur.pos(), find_del))
104                         return true;
105         return false;
106 }
107
108
109 bool findBackwards(DocIterator & cur, MatchString const & match,
110                  bool find_del = true)
111 {
112         while (cur) {
113                 cur.backwardChar();
114                 if (cur.inTexted() &&
115                     match(cur.paragraph(), cur.pos(), find_del))
116                         return true;
117         }
118         return false;
119 }
120
121
122 bool findChange(DocIterator & cur, bool next)
123 {
124         if (!next)
125                 cur.backwardPos();
126         for (; cur; next ? cur.forwardPos() : cur.backwardPos())
127                 if (cur.inTexted() && cur.paragraph().isChanged(cur.pos())) {
128                         if (!next)
129                                 // if we search backwards, take a step forward
130                                 // to correctly set the anchor
131                                 cur.forwardPos();
132                         return true;
133                 }
134
135         return false;
136 }
137
138
139 bool searchAllowed(BufferView * /*bv*/, docstring const & str)
140 {
141         if (str.empty()) {
142                 frontend::Alert::error(_("Search error"), _("Search string is empty"));
143                 return false;
144         }
145         return true;
146 }
147
148
149 bool find(BufferView * bv, docstring const & searchstr,
150         bool cs, bool mw, bool fw, bool find_del = true)
151 {
152         if (!searchAllowed(bv, searchstr))
153                 return false;
154
155         DocIterator cur = bv->cursor();
156
157         MatchString const match(searchstr, cs, mw);
158
159         bool found = fw ? findForward(cur, match, find_del) :
160                           findBackwards(cur, match, find_del);
161
162         if (found)
163                 bv->putSelectionAt(cur, searchstr.length(), !fw);
164
165         return found;
166 }
167
168
169 int replaceAll(BufferView * bv,
170                docstring const & searchstr, docstring const & replacestr,
171                bool cs, bool mw)
172 {
173         Buffer & buf = bv->buffer();
174
175         if (!searchAllowed(bv, searchstr) || buf.isReadonly())
176                 return 0;
177
178         MatchString const match(searchstr, cs, mw);
179         int num = 0;
180
181         int const rsize = replacestr.size();
182         int const ssize = searchstr.size();
183
184         Cursor cur(*bv);
185         cur.setCursor(doc_iterator_begin(&buf));
186         while (findForward(cur, match, false)) {
187                 // Backup current cursor position and font.
188                 pos_type const pos = cur.pos();
189                 Font const font = cur.paragraph().getFontSettings(buf.params(), pos);
190                 cur.recordUndo();
191                 int striked = ssize - cur.paragraph().eraseChars(pos, pos + ssize,
192                                                             buf.params().trackChanges);
193                 cur.paragraph().insert(pos, replacestr, font,
194                                        Change(buf.params().trackChanges ?
195                                               Change::INSERTED : Change::UNCHANGED));
196                 for (int i = 0; i < rsize + striked; ++i)
197                         cur.forwardChar();
198                 ++num;
199         }
200
201         buf.updateLabels();
202         bv->putSelectionAt(doc_iterator_begin(&buf), 0, false);
203         if (num)
204                 buf.markDirty();
205         return num;
206 }
207
208
209 bool stringSelected(BufferView * bv, docstring & searchstr,
210                     bool cs, bool mw, bool fw)
211 {
212         // if nothing selected and searched string is empty, this
213         // means that we want to search current word at cursor position.
214         if (!bv->cursor().selection() && searchstr.empty()) {
215                 bv->cursor().innerText()->selectWord(bv->cursor(), WHOLE_WORD);
216                 searchstr = bv->cursor().selectionAsString(false);
217                 return true;
218         }
219
220         // if nothing selected or selection does not equal search
221         // string search and select next occurance and return
222         docstring const & str1 = searchstr;
223         docstring const str2 = bv->cursor().selectionAsString(false);
224         if ((cs && str1 != str2) || compare_no_case(str1, str2) != 0) {
225                 find(bv, searchstr, cs, mw, fw);
226                 return false;
227         }
228
229         return true;
230 }
231
232
233 int replace(BufferView * bv, docstring & searchstr,
234             docstring const & replacestr, bool cs, bool mw, bool fw)
235 {
236         if (!stringSelected(bv, searchstr, cs, mw, fw))
237                 return 0;
238
239         if (!searchAllowed(bv, searchstr) || bv->buffer().isReadonly())
240                 return 0;
241
242         Cursor & cur = bv->cursor();
243         cap::replaceSelectionWithString(cur, replacestr, fw);
244         bv->buffer().markDirty();
245         find(bv, searchstr, cs, mw, fw, false);
246         bv->buffer().updateMacros();
247         bv->processUpdateFlags(Update::Force | Update::FitCursor);
248
249         return 1;
250 }
251
252 } // namespace anon
253
254
255 docstring const find2string(docstring const & search,
256                          bool casesensitive, bool matchword, bool forward)
257 {
258         odocstringstream ss;
259         ss << search << '\n'
260            << int(casesensitive) << ' '
261            << int(matchword) << ' '
262            << int(forward);
263         return ss.str();
264 }
265
266
267 docstring const replace2string(docstring const & replace,
268         docstring const & search, bool casesensitive, bool matchword,
269         bool all, bool forward)
270 {
271         odocstringstream ss;
272         ss << replace << '\n'
273            << search << '\n'
274            << int(casesensitive) << ' '
275            << int(matchword) << ' '
276            << int(all) << ' '
277            << int(forward);
278         return ss.str();
279 }
280
281
282 bool find(BufferView * bv, FuncRequest const & ev)
283 {
284         if (!bv || ev.action != LFUN_WORD_FIND)
285                 return false;
286
287         //lyxerr << "find called, cmd: " << ev << endl;
288
289         // data is of the form
290         // "<search>
291         //  <casesensitive> <matchword> <forward>"
292         docstring search;
293         docstring howto = split(ev.argument(), search, '\n');
294
295         bool casesensitive = parse_bool(howto);
296         bool matchword     = parse_bool(howto);
297         bool forward       = parse_bool(howto);
298
299         return find(bv, search, casesensitive, matchword, forward);
300 }
301
302
303 void replace(BufferView * bv, FuncRequest const & ev, bool has_deleted)
304 {
305         if (!bv || ev.action != LFUN_WORD_REPLACE)
306                 return;
307
308         // data is of the form
309         // "<search>
310         //  <replace>
311         //  <casesensitive> <matchword> <all> <forward>"
312         docstring search;
313         docstring rplc;
314         docstring howto = split(ev.argument(), rplc, '\n');
315         howto = split(howto, search, '\n');
316
317         bool casesensitive = parse_bool(howto);
318         bool matchword     = parse_bool(howto);
319         bool all           = parse_bool(howto);
320         bool forward       = parse_bool(howto);
321
322         if (!has_deleted) {
323                 int const replace_count = all
324                         ? replaceAll(bv, search, rplc, casesensitive, matchword)
325                         : replace(bv, search, rplc, casesensitive, matchword, forward);
326
327                 Buffer & buf = bv->buffer();
328                 if (replace_count == 0) {
329                         // emit message signal.
330                         buf.message(_("String not found!"));
331                 } else {
332                         if (replace_count == 1) {
333                                 // emit message signal.
334                                 buf.message(_("String has been replaced."));
335                         } else {
336                                 docstring str = convert<docstring>(replace_count);
337                                 str += _(" strings have been replaced.");
338                                 // emit message signal.
339                                 buf.message(str);
340                         }
341                 }
342         } else {
343                 // if we have deleted characters, we do not replace at all, but
344                 // rather search for the next occurence
345                 if (find(bv, search, casesensitive, matchword, forward))
346                         bv->showCursor();
347                 else
348                         bv->message(_("String not found!"));
349         }
350 }
351
352
353 bool findNextChange(BufferView * bv)
354 {
355         return findChange(bv, true);
356 }
357
358
359 bool findPreviousChange(BufferView * bv)
360 {
361         return findChange(bv, false);
362 }
363
364
365 bool findChange(BufferView * bv, bool next)
366 {
367         if (bv->cursor().selection()) {
368                 // set the cursor at the beginning or at the end of the selection
369                 // before searching. Otherwise, the current change will be found.
370                 if (next != (bv->cursor().top() > bv->cursor().anchor()))
371                         bv->cursor().setCursorToAnchor();
372         }
373
374         DocIterator cur = bv->cursor();
375
376         // Are we within a change ? Then first search forward (backward),
377         // clear the selection and search the other way around (see the end
378         // of this function). This will avoid changes to be selected half.
379         bool search_both_sides = false;
380         DocIterator tmpcur = cur;
381         // Leave math first
382         while (tmpcur.inMathed())
383                 tmpcur.pop_back();
384         Change change_next_pos
385                 = tmpcur.paragraph().lookupChange(tmpcur.pos());
386         if (change_next_pos.changed() && cur.inMathed()) {
387                 cur = tmpcur;
388                 search_both_sides = true;
389         } else if (tmpcur.pos() > 0 && tmpcur.inTexted()) {
390                 Change change_prev_pos
391                         = tmpcur.paragraph().lookupChange(tmpcur.pos() - 1);
392                 if (change_next_pos.isSimilarTo(change_prev_pos))
393                         search_both_sides = true;
394         }
395
396         if (!findChange(cur, next))
397                 return false;
398
399         bv->cursor().setCursor(cur);
400         bv->cursor().resetAnchor();
401
402         if (!next)
403                 // take a step into the change
404                 cur.backwardPos();
405
406         Change orig_change = cur.paragraph().lookupChange(cur.pos());
407
408         CursorSlice & tip = cur.top();
409         if (next) {
410                 for (; !tip.at_end(); tip.forwardPos()) {
411                         Change change = tip.paragraph().lookupChange(tip.pos());
412                         if (change != orig_change)
413                                 break;
414                 }
415         } else {
416                 for (; !tip.at_begin();) {
417                         tip.backwardPos();
418                         Change change = tip.paragraph().lookupChange(tip.pos());
419                         if (change != orig_change) {
420                                 // take a step forward to correctly set the selection
421                                 tip.forwardPos();
422                                 break;
423                         }
424                 }
425         }
426
427         // Now put cursor to end of selection:
428         bv->cursor().setCursor(cur);
429         bv->cursor().setSelection();
430
431         if (search_both_sides) {
432                 bv->cursor().setSelection(false);
433                 findChange(bv, !next);
434         }
435
436         return true;
437 }
438
439 namespace {
440
441 typedef vector<pair<string, string> > Escapes;
442
443 /// A map of symbols and their escaped equivalent needed within a regex.
444 Escapes const & get_regexp_escapes()
445 {
446         static Escapes escape_map;
447         if (escape_map.empty()) {
448                 escape_map.push_back(pair<string, string>("\\", "\\\\"));
449                 escape_map.push_back(pair<string, string>("^", "\\^"));
450                 escape_map.push_back(pair<string, string>("$", "\\$"));
451                 escape_map.push_back(pair<string, string>("{", "\\{"));
452                 escape_map.push_back(pair<string, string>("}", "\\}"));
453                 escape_map.push_back(pair<string, string>("[", "\\["));
454                 escape_map.push_back(pair<string, string>("]", "\\]"));
455                 escape_map.push_back(pair<string, string>("(", "\\("));
456                 escape_map.push_back(pair<string, string>(")", "\\)"));
457                 escape_map.push_back(pair<string, string>("+", "\\+"));
458                 escape_map.push_back(pair<string, string>("*", "\\*"));
459                 escape_map.push_back(pair<string, string>(".", "\\."));
460         }
461         return escape_map;
462 }
463
464 /// A map of lyx escaped strings and their unescaped equivalent.
465 Escapes const & get_lyx_unescapes() {
466         static Escapes escape_map;
467         if (escape_map.empty()) {
468                 escape_map.push_back(pair<string, string>("{*}", "*"));
469                 escape_map.push_back(pair<string, string>("{[}", "["));
470                 escape_map.push_back(pair<string, string>("\\$", "$"));
471                 escape_map.push_back(pair<string, string>("\\backslash{}", "\\"));
472                 escape_map.push_back(pair<string, string>("\\backslash", "\\"));
473                 escape_map.push_back(pair<string, string>("\\sim ", "~"));
474                 escape_map.push_back(pair<string, string>("\\^", "^"));
475         }
476         return escape_map;
477 }
478
479 /** @todo Probably the maps need to be migrated to regexps, in order to distinguish if
480  ** the found occurrence were escaped.
481  **/
482 string apply_escapes(string s, Escapes const & escape_map)
483 {
484         LYXERR(Debug::FIND, "Escaping: '" << s << "'");
485         Escapes::const_iterator it;
486         for (it = escape_map.begin(); it != escape_map.end(); ++it) {
487 //              LYXERR(Debug::FIND, "Escaping " << it->first << " as " << it->second);
488                 unsigned int pos = 0;
489                 while (pos < s.length() && (pos = s.find(it->first, pos)) < s.length()) {
490                         s.replace(pos, it->first.length(), it->second);
491 //                      LYXERR(Debug::FIND, "After escape: " << s);
492                         pos += it->second.length();
493 //                      LYXERR(Debug::FIND, "pos: " << pos);
494                 }
495         }
496         LYXERR(Debug::FIND, "Escaped : '" << s << "'");
497         return s;
498 }
499
500 /** Return the position of the closing brace matching the open one at s[pos],
501  ** or s.size() if not found.
502  **/
503 size_t find_matching_brace(string const & s, size_t pos)
504 {
505         LASSERT(s[pos] == '{', /* */);
506         int open_braces = 1;
507         for (++pos; pos < s.size(); ++pos) {
508                 if (s[pos] == '\\')
509                         ++pos;
510                 else if (s[pos] == '{')
511                         ++open_braces;
512                 else if (s[pos] == '}') {
513                         --open_braces;
514                         if (open_braces == 0)
515                                 return pos;
516                 }
517         }
518         return s.size();
519 }
520
521 /// Within \regexp{} apply get_regex_escapes(), while outside apply get_lyx_unescapes().
522 string escape_for_regex(string s)
523 {
524         size_t pos = 0;
525         while (pos < s.size()) {
526                         size_t new_pos = s.find("\\regexp{", pos);
527                         if (new_pos == string::npos)
528                                         new_pos = s.size();
529                         LYXERR(Debug::FIND, "new_pos: " << new_pos);
530                         string t = apply_escapes(s.substr(pos, new_pos - pos), get_lyx_unescapes());
531                         LYXERR(Debug::FIND, "t      : " << t);
532                         t = apply_escapes(t, get_regexp_escapes());
533                         s.replace(pos, new_pos - pos, t);
534                         new_pos = pos + t.size();
535                         LYXERR(Debug::FIND, "Regexp after escaping: " << s);
536                         LYXERR(Debug::FIND, "new_pos: " << new_pos);
537                         if (new_pos == s.size())
538                                         break;
539                         size_t end_pos = find_matching_brace(s, new_pos + 7);
540                         LYXERR(Debug::FIND, "end_pos: " << end_pos);
541                         t = apply_escapes(s.substr(new_pos + 8, end_pos - (new_pos + 8)), get_lyx_unescapes());
542                         LYXERR(Debug::FIND, "t      : " << t);
543                         if (end_pos == s.size()) {
544                                         s.replace(new_pos, end_pos - new_pos, t);
545                                         pos = s.size();
546                                         LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
547                                         break;
548                         }
549                         s.replace(new_pos, end_pos + 1 - new_pos, t);
550                         LYXERR(Debug::FIND, "Regexp after \\regexp{} removal: " << s);
551                         pos = new_pos + t.size();
552                         LYXERR(Debug::FIND, "pos: " << pos);
553         }
554         return s;
555 }
556
557 /// Wrapper for boost::regex_replace with simpler interface
558 bool regex_replace(string const & s, string & t, string const & searchstr,
559         string const & replacestr)
560 {
561         boost::regex e(searchstr);
562         ostringstream oss;
563         ostream_iterator<char, char> it(oss);
564         boost::regex_replace(it, s.begin(), s.end(), e, replacestr);
565         // tolerate t and s be references to the same variable
566         bool rv = (s != oss.str());
567         t = oss.str();
568         return rv;
569 }
570
571 /** Checks if supplied string segment is well-formed from the standpoint of matching open-closed braces.
572  **
573  ** Verify that closed braces exactly match open braces. This avoids that, for example,
574  ** \frac{.*}{x} matches \frac{x+\frac{y}{x}}{z} with .* being 'x+\frac{y'.
575  **
576  ** @param unmatched
577  ** Number of open braces that must remain open at the end for the verification to succeed.
578  **/
579 bool braces_match(string::const_iterator const & beg,
580         string::const_iterator const & end, int unmatched = 0)
581 {
582         int open_pars = 0;
583         string::const_iterator it = beg;
584         LYXERR(Debug::FIND, "Checking " << unmatched << " unmatched braces in '" << string(beg, end) << "'");
585         for (; it != end; ++it) {
586                 // Skip escaped braces in the count
587                 if (*it == '\\') {
588                         ++it;
589                         if (it == end)
590                                 break;
591                 } else if (*it == '{') {
592                         ++open_pars;
593                 } else if (*it == '}') {
594                         if (open_pars == 0) {
595                                 LYXERR(Debug::FIND, "Found unmatched closed brace");
596                                 return false;
597                         } else
598                                 --open_pars;
599                 }
600         }
601         if (open_pars != unmatched) {
602           LYXERR(Debug::FIND, "Found " << open_pars 
603                  << " instead of " << unmatched 
604                  << " unmatched open braces at the end of count");
605                         return false;
606         }
607         LYXERR(Debug::FIND, "Braces match as expected");
608         return true;
609 }
610
611 /** The class performing a match between a position in the document and the FindAdvOptions.
612  **/
613 class MatchStringAdv {
614 public:
615         MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt);
616
617         /** Tests if text starting at the supplied position matches with the one provided to the MatchStringAdv
618          ** constructor as opt.search, under the opt.* options settings.
619          **
620          ** @param at_begin
621          **     If set, then match is searched only against beginning of text starting at cur.
622          **     If unset, then match is searched anywhere in text starting at cur.
623          **
624          ** @return
625          ** The length of the matching text, or zero if no match was found.
626          **/
627         int operator()(DocIterator const & cur, int len = -1, bool at_begin = true) const;
628
629 public:
630         /// buffer
631         lyx::Buffer * p_buf;
632         /// first buffer on which search was started
633         lyx::Buffer * const p_first_buf;
634         /// options
635         FindAndReplaceOptions const & opt;
636
637 private:
638         /** Normalize a stringified or latexified LyX paragraph.
639          **
640          ** Normalize means:
641          ** <ul>
642          **   <li>if search is not casesensitive, then lowercase the string;
643          **   <li>remove any newline at begin or end of the string;
644          **   <li>replace any newline in the middle of the string with a simple space;
645          **   <li>remove stale empty styles and environments, like \emph{} and \textbf{}.
646          ** </ul>
647          **
648          ** @todo Normalization should also expand macros, if the corresponding
649          ** search option was checked.
650          **/
651         string normalize(docstring const & s) const;
652         // normalized string to search
653         string par_as_string;
654         // regular expression to use for searching
655         boost::regex regexp;
656         // same as regexp, but prefixed with a ".*"
657         boost::regex regexp2;
658         // unmatched open braces in the search string/regexp
659         int open_braces;
660         // number of (.*?) subexpressions added at end of search regexp for closing
661         // environments, math mode, styles, etc...
662         int close_wildcards;
663 };
664
665
666 MatchStringAdv::MatchStringAdv(lyx::Buffer & buf, FindAndReplaceOptions const & opt)
667         : p_buf(&buf), p_first_buf(&buf), opt(opt)
668 {
669         par_as_string = normalize(opt.search);
670         open_braces = 0;
671         close_wildcards = 0;
672
673         if (! opt.regexp) {
674                 // Remove trailing closure of math, macros and environments, so to catch parts of them.
675                 do {
676                         LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
677                         if (regex_replace(par_as_string, par_as_string, "(.*)[[:blank:]]\\'", "$1"))
678                                         continue;
679                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\$\\'", "$1"))
680                                         continue;
681                         // @todo need to account for open square braces as well ?
682                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\\\]\\'", "$1"))
683                                         continue;
684                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\\\end\\{[a-zA-Z_]*\\}\\'", "$1"))
685                                         continue;
686                         if (regex_replace(par_as_string, par_as_string, "(.*[^\\\\]) ?\\}\\'", "$1")) {
687                                 ++open_braces;
688                                 continue;
689                         }
690                         break;
691                 } while (true);
692                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
693                 LASSERT(braces_match(par_as_string.begin(), par_as_string.end(), open_braces), /* */);
694                 LYXERR(Debug::FIND, "Built MatchStringAdv object: par_as_string = '" << par_as_string << "'");
695         } else {
696                 par_as_string = escape_for_regex(par_as_string);
697                 // Insert (.*?) before trailing closure of math, macros and environments, so to catch parts of them.
698                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
699                 if (
700                         // Insert .* before trailing '\$' ('$' has been escaped by escape_for_regex)
701                         regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\$)\\'", "$1(.*?)$2")
702                                 // Insert .* before trailing '\\\]' ('\]' has been escaped by escape_for_regex)
703                                 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\\\\\\\\\])\\'", "$1(.*?)$2")
704                                 // Insert .* before trailing '\\end\{...}' ('\end{...}' has been escaped by escape_for_regex)
705                                 || regex_replace(par_as_string, par_as_string, 
706                                         "(.*[^\\\\])(\\\\\\\\end\\\\\\{[a-zA-Z_]*\\\\\\})\\'", "$1(.*?)$2")
707                                 // Insert .* before trailing '\}' ('}' has been escaped by escape_for_regex)
708                                 || regex_replace(par_as_string, par_as_string, "(.*[^\\\\])(\\\\\\})\\'", "$1(.*?)$2")
709                 ) {
710                         ++close_wildcards;
711                 }
712                 LYXERR(Debug::FIND, "par_as_string now is '" << par_as_string << "'");
713                 LYXERR(Debug::FIND, "Open braces: " << open_braces);
714                 LYXERR(Debug::FIND, "Close .*?  : " << close_wildcards);
715                 LASSERT(braces_match(par_as_string.begin(), par_as_string.end(), open_braces), /* */);
716                 LYXERR(Debug::FIND, "Replaced text (to be used as regex): " << par_as_string);
717                 // If entered regexp must match at begin of searched string buffer
718                 regexp = boost::regex(string("\\`") + par_as_string);
719                 // If entered regexp may match wherever in searched string buffer
720                 regexp2 = boost::regex(string("\\`.*") + par_as_string);
721         }
722 }
723
724
725 int MatchStringAdv::operator()(DocIterator const & cur, int len, bool at_begin) const
726 {
727         docstring docstr = stringifyFromForSearch(opt, cur, len);
728         LYXERR(Debug::FIND, "Matching against     '" << lyx::to_utf8(docstr) << "'");
729         string str = normalize(docstr);
730         LYXERR(Debug::FIND, "After normalization: '" << str << "'");
731         if (! opt.regexp) {
732                 if (at_begin) {
733                         if (str.substr(0, par_as_string.size()) == par_as_string)
734                                 return par_as_string.size();
735                 } else {
736                         size_t pos = str.find(par_as_string);
737                         if (pos != string::npos)
738                                 return par_as_string.size();
739                 }
740         } else {
741                 // Try all possible regexp matches, 
742                 //until one that verifies the braces match test is found
743                 boost::regex const *p_regexp = at_begin ? &regexp : &regexp2;
744                 boost::sregex_iterator re_it(str.begin(), str.end(), *p_regexp);
745                 boost::sregex_iterator re_it_end;
746                 for (; re_it != re_it_end; ++re_it) {
747                         boost::match_results<string::const_iterator> const & m = *re_it;
748                         // Check braces on the segment that matched the entire regexp expression,
749                         // plus the last subexpression, if a (.*?) was inserted in the constructor.
750                         if (! braces_match(m[0].first, m[0].second, open_braces))
751                                 return 0;
752                         // Check braces on segments that matched all (.*?) subexpressions.
753                         for (size_t i = 1; i < m.size(); ++i)
754                                 if (! braces_match(m[i].first, m[i].second))
755                                         return false;
756                         // Exclude from the returned match length any length 
757                         // due to close wildcards added at end of regexp
758                         if (close_wildcards == 0)
759                                 return m[0].second - m[0].first;
760                         else
761                                 return m[m.size() - close_wildcards].first - m[0].first;
762                 }
763         }
764         return 0;
765 }
766
767
768 string MatchStringAdv::normalize(docstring const & s) const
769 {
770         string t;
771         if (! opt.casesensitive)
772                 t = lyx::to_utf8(lowercase(s));
773         else
774                 t = lyx::to_utf8(s);
775         // Remove \n at begin
776         while (t.size() > 0 && t[0] == '\n')
777                 t = t.substr(1);
778         // Remove \n at end
779         while (t.size() > 0 && t[t.size() - 1] == '\n')
780                 t = t.substr(0, t.size() - 1);
781         size_t pos;
782         // Replace all other \n with spaces
783         while ((pos = t.find("\n")) != string::npos)
784                 t.replace(pos, 1, " ");
785         // Remove stale empty \emph{}, \textbf{} and similar blocks from latexify
786         LYXERR(Debug::FIND, "Removing stale empty \\emph{}, \\textbf{}, \\*section{} macros from: " << t);
787         while (regex_replace(t, t, "\\\\(emph|textbf|subsubsection|subsection|section|subparagraph|paragraph)(\\{\\})+", ""))
788                 LYXERR(Debug::FIND, "  further removing stale empty \\emph{}, \\textbf{} macros from: " << t);
789         return t;
790 }
791
792
793 docstring stringifyFromCursor(DocIterator const & cur, int len)
794 {
795         LYXERR(Debug::FIND, "Stringifying with len=" << len << " from cursor at pos: " << cur);
796         if (cur.inTexted()) {
797                         Paragraph const & par = cur.paragraph();
798                         // TODO what about searching beyond/across paragraph breaks ?
799                         // TODO Try adding a AS_STR_INSERTS as last arg
800                         pos_type end = ( len == -1 || cur.pos() + len > int(par.size()) ) ?
801                                 int(par.size()) : cur.pos() + len;
802                         OutputParams runparams(&cur.buffer()->params().encoding());
803                         odocstringstream os;
804                         runparams.nice = true;
805                         runparams.flavor = OutputParams::LATEX;
806                         runparams.linelen = 100000; //lyxrc.plaintext_linelen;
807                         // No side effect of file copying and image conversion
808                         runparams.dryrun = true;
809                         LYXERR(Debug::FIND, "Stringifying with cur: " 
810                                 << cur << ", from pos: " << cur.pos() << ", end: " << end);
811                         return par.stringify(cur.pos(), end, AS_STR_INSETS, runparams);
812         } else if (cur.inMathed()) {
813                         odocstringstream os;
814                         CursorSlice cs = cur.top();
815                         MathData md = cs.cell();
816                         MathData::const_iterator it_end = 
817                                 ( ( len == -1 || cs.pos() + len > int(md.size()) )
818                                         ? md.end() : md.begin() + cs.pos() + len );
819                         for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
820                                         os << *it;
821                         return os.str();
822         }
823         LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
824         return docstring();
825 }
826
827
828 /** Computes the LaTeX export of buf starting from cur and ending len positions
829  * after cur, if len is positive, or at the paragraph or innermost inset end
830  * if len is -1.
831  */
832 docstring latexifyFromCursor(DocIterator const & cur, int len)
833 {
834         LYXERR(Debug::FIND, "Latexifying with len=" << len << " from cursor at pos: " << cur);
835         LYXERR(Debug::FIND, "  with cur.lastpost=" << cur.lastpos() << ", cur.lastrow="
836                 << cur.lastrow() << ", cur.lastcol=" << cur.lastcol());
837         Buffer const & buf = *cur.buffer();
838         LASSERT(buf.isLatex(), /* */);
839
840         TexRow texrow;
841         odocstringstream ods;
842         OutputParams runparams(&buf.params().encoding());
843         runparams.nice = false;
844         runparams.flavor = OutputParams::LATEX;
845         runparams.linelen = 8000; //lyxrc.plaintext_linelen;
846         // No side effect of file copying and image conversion
847         runparams.dryrun = true;
848
849         if (cur.inTexted()) {
850                         // @TODO what about searching beyond/across paragraph breaks ?
851                         ParagraphList::const_iterator pit = cur.innerText()->paragraphs().begin();
852                         for (int i = 0; i < cur.pit(); ++i)
853                                         ++pit;
854 //              ParagraphList::const_iterator pit_end = pit;
855 //              ++pit_end;
856 //              lyx::latexParagraphs(buf, cur.innerText()->paragraphs(), ods, texrow, runparams, string(), pit, pit_end);
857                 pos_type const endpos = (len == -1 || cur.pos() + len > int(pit->size()))
858                         ? pit->size() : cur.pos() + len;
859                 TeXOnePar(buf, *cur.innerText(), pit, ods, texrow, runparams, string(),
860                         cur.pos(), endpos);
861                 LYXERR(Debug::FIND, "Latexified text: '" << lyx::to_utf8(ods.str()) << "'");
862         } else if (cur.inMathed()) {
863                 // Retrieve the math environment type, and add '$' or '$[' or others (\begin{equation}) accordingly
864                 for (int s = cur.depth() - 1; s >= 0; --s) {
865                                 CursorSlice const & cs = cur[s];
866                                 if (cs.asInsetMath() && cs.asInsetMath() && cs.asInsetMath()->asHullInset()) {
867                                                 WriteStream ws(ods);
868                                                 cs.asInsetMath()->asHullInset()->header_write(ws);
869                                                 break;
870                                 }
871                 }
872
873                 CursorSlice const & cs = cur.top();
874                 MathData md = cs.cell();
875                 MathData::const_iterator it_end = ( ( len == -1 || cs.pos() + len > int(md.size()) )
876                         ? md.end() : md.begin() + cs.pos() + len );
877                 for (MathData::const_iterator it = md.begin() + cs.pos(); it != it_end; ++it)
878                                 ods << *it;
879
880                 // MathData md = cur.cell();
881                 // MathData::const_iterator it_end = ( ( len == -1 || cur.pos() + len > int(md.size()) ) ? md.end() : md.begin() + cur.pos() + len );
882                 // for (MathData::const_iterator it = md.begin() + cur.pos(); it != it_end; ++it) {
883                 //      MathAtom const & ma = *it;
884                 //      ma.nucleus()->latex(buf, ods, runparams);
885                 // }
886
887                 // Retrieve the math environment type, and add '$' or '$]'
888                 // or others (\end{equation}) accordingly
889                 for (int s = cur.depth() - 1; s >= 0; --s) {
890                         CursorSlice const & cs = cur[s];
891                         InsetMath * inset = cs.asInsetMath();
892                         if (inset && inset->asHullInset()) {
893                                 WriteStream ws(ods);
894                                 inset->asHullInset()->footer_write(ws);
895                                 break;
896                         }
897                 }
898                 LYXERR(Debug::FIND, "Latexified math: '" << lyx::to_utf8(ods.str()) << "'");
899         } else {
900                 LYXERR(Debug::FIND, "Don't know how to stringify from here: " << cur);
901         }
902         return ods.str();
903 }
904
905
906 /** Finalize an advanced find operation, advancing the cursor to the innermost
907  ** position that matches, plus computing the length of the matching text to
908  ** be selected
909  **/
910 int findAdvFinalize(DocIterator & cur, MatchStringAdv const & match)
911 {
912         // Search the foremost position that matches (avoids find of entire math
913         // inset when match at start of it)
914         size_t d;
915         DocIterator old_cur(cur.buffer());
916         do {
917                 LYXERR(Debug::FIND, "Forwarding one step (searching for innermost match)");
918                 d = cur.depth();
919                 old_cur = cur;
920                 cur.forwardPos();
921         } while (cur && cur.depth() > d && match(cur) > 0);
922         cur = old_cur;
923         LASSERT(match(cur) > 0, /* */);
924         LYXERR(Debug::FIND, "Ok");
925
926         // Compute the match length
927         int len = 1;
928         LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
929         while (cur.pos() + len <= cur.lastpos() && match(cur, len) == 0) {
930                 ++len;
931                 LYXERR(Debug::FIND, "verifying unmatch with len = " << len);
932         }
933         // Length of matched text (different from len param)
934         int old_len = match(cur, len);
935         int new_len;
936         // Greedy behaviour while matching regexps
937         while ((new_len = match(cur, len + 1)) > old_len) {
938                 ++len;
939                 old_len = new_len;
940                 LYXERR(Debug::FIND, "verifying   match with len = " << len);
941         }
942         return len;
943 }
944
945
946 /// Finds forward
947 int findForwardAdv(DocIterator & cur, MatchStringAdv & match)
948 {
949         if (!cur)
950                 return 0;
951         while (cur && !match(cur, -1, false)) {
952                 if (cur.pit() < cur.lastpit())
953                         cur.forwardPar();
954                 else {
955                         cur.forwardPos();
956                 }
957         }
958         for (; cur; cur.forwardPos()) {
959                 if (match(cur))
960                         return findAdvFinalize(cur, match);
961         }
962         return 0;
963 }
964
965
966 /// Find the most backward consecutive match within same paragraph while searching backwards.
967 void findMostBackwards(DocIterator & cur, MatchStringAdv const & match, int & len)
968 {
969         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
970         len = findAdvFinalize(cur, match);
971         if (cur != cur_begin) {
972                 Inset & inset = cur.inset();
973                 int old_len;
974                 DocIterator old_cur;
975                 DocIterator dit2;
976                 do {
977                         old_cur = cur;
978                         old_len = len;
979                         cur.backwardPos();
980                         LYXERR(Debug::FIND, "findMostBackwards(): old_cur=" 
981                                 << old_cur << ", old_len=" << len << ", cur=" << cur);
982                         dit2 = cur;
983                 } while (cur != cur_begin && &cur.inset() == &inset && match(cur)
984                          && (len = findAdvFinalize(dit2, match)) > old_len);
985                 cur = old_cur;
986                 len = old_len;
987         }
988         LYXERR(Debug::FIND, "findMostBackwards(): cur=" << cur);
989 }
990
991
992 /// Finds backwards
993 int findBackwardsAdv(DocIterator & cur, MatchStringAdv & match) {
994         if (! cur)
995                 return 0;
996         // Backup of original position
997         DocIterator cur_orig(cur);
998         DocIterator cur_begin = doc_iterator_begin(cur.buffer());
999         if (cur == cur_begin)
1000                 return 0;
1001         bool found_match;
1002         bool pit_changed = false;
1003         found_match = false;
1004         do {
1005                 cur.pos() = 0;
1006                 found_match = match(cur, -1, false);
1007
1008                 if (found_match) {
1009                         if (pit_changed)
1010                                 cur.pos() = cur.lastpos();
1011                         else
1012                                 cur.pos() = cur_orig.pos();
1013                         LYXERR(Debug::FIND, "findBackAdv2: cur: " << cur);
1014                         DocIterator cur_prev_iter;
1015                         while (true) {
1016                                 found_match = match(cur);
1017                                 LYXERR(Debug::FIND, "findBackAdv3: found_match=" 
1018                                        << found_match << ", cur: " << cur);
1019                                 if (found_match) {
1020                                         int len;
1021                                         findMostBackwards(cur, match, len);
1022                                         if (cur < cur_orig)
1023                                                 return len;
1024                                 }
1025                                 // Prevent infinite loop at begin of document
1026                                 if (cur == cur_begin || cur == cur_prev_iter)
1027                                         break;
1028                                 cur_prev_iter = cur;
1029                                 cur.backwardPos();
1030                         }
1031                 }
1032                 if (cur == cur_begin)
1033                         break;
1034                 if (cur.pit() > 0)
1035                         --cur.pit();
1036                 else
1037                         cur.backwardPos();
1038                 pit_changed = true;
1039         } while (true);
1040         return 0;
1041 }
1042
1043
1044 } // anonym namespace
1045
1046
1047 docstring stringifyFromForSearch(FindAndReplaceOptions const & opt,
1048         DocIterator const & cur, int len)
1049 {
1050         if (!opt.ignoreformat)
1051                 return latexifyFromCursor(cur, len);
1052         else
1053                 return stringifyFromCursor(cur, len);
1054 }
1055
1056
1057 FindAndReplaceOptions::FindAndReplaceOptions(docstring const & search, bool casesensitive,
1058         bool matchword, bool forward, bool expandmacros, bool ignoreformat,
1059         bool regexp, docstring const & replace, bool keep_case,
1060         SearchScope scope)
1061         : search(search), casesensitive(casesensitive), matchword(matchword),
1062         forward(forward), expandmacros(expandmacros), ignoreformat(ignoreformat),
1063         regexp(regexp), replace(replace), keep_case(keep_case), scope(scope)
1064 {
1065 }
1066
1067
1068 /** Checks if the supplied character is lower-case */
1069 static bool isLowerCase(char_type ch) {
1070         return lowercase(ch) == ch;
1071 }
1072
1073
1074 /** Checks if the supplied character is upper-case */
1075 static bool isUpperCase(char_type ch) {
1076         return uppercase(ch) == ch;
1077 }
1078
1079
1080 /** Check if 'len' letters following cursor are all non-lowercase */
1081 static bool allNonLowercase(DocIterator const & cur, int len) {
1082         pos_type end_pos = cur.pos() + len;
1083         for (pos_type pos = cur.pos(); pos != end_pos; ++pos)
1084                 if (isLowerCase(cur.paragraph().getChar(pos)))
1085                         return false;
1086         return true;
1087 }
1088
1089
1090 /** Check if first letter is upper case and second one is lower case */
1091 static bool firstUppercase(DocIterator const & cur) {
1092         char_type ch1, ch2;
1093         if (cur.pos() >= cur.lastpos() - 1) {
1094                 LYXERR(Debug::FIND, "No upper-case at cur: " << cur);
1095                 return false;
1096         }
1097         ch1 = cur.paragraph().getChar(cur.pos());
1098         ch2 = cur.paragraph().getChar(cur.pos()+1);
1099         bool result = isUpperCase(ch1) && isLowerCase(ch2);
1100         LYXERR(Debug::FIND, "firstUppercase(): "
1101                << "ch1=" << ch1 << "(" << char(ch1) << "), ch2=" 
1102                << ch2 << "(" << char(ch2) << ")"
1103                << ", result=" << result << ", cur=" << cur);
1104         return result;
1105 }
1106
1107
1108 /** Make first letter of supplied buffer upper-case, and the rest lower-case.
1109  **
1110  ** \fixme What to do with possible further paragraphs in replace buffer ?
1111  **/
1112 static void changeFirstCase(Buffer & buffer, TextCase first_case, TextCase others_case) {
1113         ParagraphList::iterator pit = buffer.paragraphs().begin();
1114         pos_type right = pos_type(1);
1115         pit->changeCase(buffer.params(), pos_type(0), right, first_case);
1116         right = pit->size() + 1;
1117         pit->changeCase(buffer.params(), right, right, others_case);
1118 }
1119
1120
1121 /// Perform a FindAdv operation.
1122 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt)
1123 {
1124         DocIterator cur = bv->cursor();
1125         int match_len = 0;
1126
1127         if (opt.search.empty()) {
1128                         bv->message(_("Search text is empty!"));
1129                         return false;
1130         }
1131
1132         MatchStringAdv matchAdv(bv->buffer(), opt);
1133         try {
1134                 if (opt.forward)
1135                                 match_len = findForwardAdv(cur, matchAdv);
1136                 else
1137                                 match_len = findBackwardsAdv(cur, matchAdv);
1138         } catch (...) {
1139                 // This may only be raised by boost::regex()
1140                 bv->message(_("Invalid regular expression!"));
1141                 return false;
1142         }
1143
1144         if (match_len == 0) {
1145                 bv->message(_("Match not found!"));
1146                 return false;
1147         }
1148
1149         LYXERR(Debug::FIND, "Putting selection at buf=" << matchAdv.p_buf
1150                 << "cur=" << cur << " with len: " << match_len);
1151
1152         bv->putSelectionAt(cur, match_len, ! opt.forward);
1153         if (opt.replace == docstring(from_utf8(LYX_FR_NULL_STRING))) {
1154                 bv->message(_("Match found!"));
1155         } else {
1156                 string lyx = to_utf8(opt.replace);
1157                 // FIXME: Seems so stupid to me to rebuild a buffer here,
1158                 // when we already have one (replace_work_area_.buffer())
1159                 Buffer repl_buffer("", false);
1160                 repl_buffer.setUnnamed(true);
1161                 if (repl_buffer.readString(lyx)) {
1162                         if (opt.keep_case && match_len >= 2) {
1163                                 if (cur.inTexted()) {
1164                                         if (firstUppercase(cur))
1165                                                 changeFirstCase(repl_buffer, text_uppercase, text_lowercase);
1166                                         else if (allNonLowercase(cur, match_len))
1167                                                 changeFirstCase(repl_buffer, text_uppercase, text_uppercase);
1168                                 }
1169                         }
1170                         cap::cutSelection(bv->cursor(), false, false);
1171                         if (! cur.inMathed()) {
1172                                 LYXERR(Debug::FIND, "Replacing by pasteParagraphList()ing repl_buffer");
1173                                 cap::pasteParagraphList(bv->cursor(), repl_buffer.paragraphs(),
1174                                                         repl_buffer.params().documentClassPtr(),
1175                                                         bv->buffer().errorList("Paste"));
1176                         } else {
1177                                 odocstringstream ods;
1178                                 OutputParams runparams(&repl_buffer.params().encoding());
1179                                 runparams.nice = false;
1180                                 runparams.flavor = OutputParams::LATEX;
1181                                 runparams.linelen = 8000; //lyxrc.plaintext_linelen;
1182                                 runparams.dryrun = true;
1183                                 TexRow texrow;
1184                                 TeXOnePar(repl_buffer, repl_buffer.text(), 
1185                                           repl_buffer.paragraphs().begin(), ods, texrow, runparams);
1186                                 //repl_buffer.getSourceCode(ods, 0, repl_buffer.paragraphs().size(), false);
1187                                 docstring repl_latex = ods.str();
1188                                 LYXERR(Debug::FIND, "Latexified replace_buffer: '" << repl_latex << "'");
1189                                 string s;
1190                                 regex_replace(to_utf8(repl_latex), s, "\\$(.*)\\$", "$1");
1191                                 regex_replace(s, s, "\\\\\\[(.*)\\\\\\]", "$1");
1192                                 repl_latex = from_utf8(s);
1193                                 LYXERR(Debug::FIND, "Replacing by niceInsert()ing latex: '" << repl_latex << "'");
1194                                 bv->cursor().niceInsert(repl_latex);
1195                         }
1196                         bv->putSelectionAt(cur, repl_buffer.paragraphs().begin()->size(), ! opt.forward);
1197                         bv->message(_("Match found and replaced !"));
1198                 } else
1199                         LASSERT(false, /**/);
1200         }
1201
1202         return true;
1203 }
1204
1205
1206 ostringstream & operator<<(ostringstream & os, lyx::FindAndReplaceOptions const & opt)
1207 {
1208         os << to_utf8(opt.search) << "\nEOSS\n"
1209            << opt.casesensitive << ' '
1210            << opt.matchword << ' '
1211            << opt.forward << ' '
1212            << opt.expandmacros << ' '
1213            << opt.ignoreformat << ' '
1214            << opt.regexp << ' '
1215            << to_utf8(opt.replace) << "\nEOSS\n"
1216            << opt.keep_case << ' '
1217            << int(opt.scope);
1218
1219         LYXERR(Debug::FIND, "built: " << os.str());
1220
1221         return os;
1222 }
1223
1224 istringstream & operator>>(istringstream & is, lyx::FindAndReplaceOptions & opt)
1225 {
1226         LYXERR(Debug::FIND, "parsing");
1227         string s;
1228         string line;
1229         getline(is, line);
1230         while (line != "EOSS") {
1231                 if (! s.empty())
1232                                 s = s + "\n";
1233                 s = s + line;
1234                 if (is.eof())   // Tolerate malformed request
1235                                 break;
1236                 getline(is, line);
1237         }
1238         LYXERR(Debug::FIND, "searching for: '" << s << "'");
1239         opt.search = from_utf8(s);
1240         is >> opt.casesensitive >> opt.matchword >> opt.forward >> opt.expandmacros >> opt.ignoreformat >> opt.regexp;
1241         is.get();       // Waste space before replace string
1242         s = "";
1243         getline(is, line);
1244         while (line != "EOSS") {
1245                 if (! s.empty())
1246                                 s = s + "\n";
1247                 s = s + line;
1248                 if (is.eof())   // Tolerate malformed request
1249                                 break;
1250                 getline(is, line);
1251         }
1252         is >> opt.keep_case;
1253         int i;
1254         is >> i;
1255         opt.scope = FindAndReplaceOptions::SearchScope(i);
1256         LYXERR(Debug::FIND, "parsed: " << opt.casesensitive << ' ' << opt.matchword << ' ' << opt.forward << ' '
1257                    << opt.expandmacros << ' ' << opt.ignoreformat << ' ' << opt.regexp << ' ' << opt.keep_case);
1258         LYXERR(Debug::FIND, "replacing with: '" << s << "'");
1259         opt.replace = from_utf8(s);
1260         return is;
1261 }
1262
1263 } // lyx namespace