4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
10 * \author Alfredo Braunstein
11 * \author Tommaso Cucinotta
13 * Full author contact details are available in file CREDITS.
19 #include "support/strfwd.h"
22 #include "support/docstring.h"
34 /** Encode the parameters needed to find \c search as a string
35 * that can be dispatched to the LyX core in a FuncRequest wrapper.
37 docstring const find2string(docstring const & search,
42 /** Encode the parameters needed to replace \c search with \c replace
43 * as a string that can be dispatched to the LyX core in a FuncRequest
46 docstring const replace2string(docstring const & replace,
47 docstring const & search,
53 /** Parse the string encoding of the find request that is found in
54 * \c ev.argument and act on it.
55 * The string is encoded by \c find2string.
56 * \return true if the string was found.
58 bool find(BufferView * bv, FuncRequest const & ev);
60 /** Parse the string encoding of the replace request that is found in
61 * \c ev.argument and act on it.
62 * The string is encoded by \c replace2string.
64 void replace(BufferView * bv, FuncRequest const &, bool has_deleted = false);
66 /// find the next change in the buffer
67 bool findNextChange(BufferView * bv);
69 /// find the previous change in the buffer
70 bool findPreviousChange(BufferView * bv);
72 /// find the change in the buffer
73 /// \param next true to find the next change, otherwise the previous
74 bool findChange(BufferView * bv, bool next);
76 // Hopefully, nobody will ever replace with something like this
77 #define LYX_FR_NULL_STRING "__LYX__F&R__NULL__STRING__"
79 class FindAndReplaceOptions {
87 FindAndReplaceOptions(
88 docstring const & search,
95 docstring const & replace,
97 SearchScope scope = S_BUFFER
99 FindAndReplaceOptions() { }
112 /// Write a FindAdvOptions instance to a stringstream
113 std::ostringstream & operator<<(std::ostringstream & os, lyx::FindAndReplaceOptions const & opt);
115 /// Read a FindAdvOptions instance from a stringstream
116 std::istringstream & operator>>(std::istringstream & is, lyx::FindAndReplaceOptions & opt);
118 /// Perform a FindAdv operation.
119 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt);
121 /** Computes the simple-text or LaTeX export (depending on opt) of buf starting
122 ** from cur and ending len positions after cur, if len is positive, or at the
123 ** paragraph or innermost inset end if len is -1.
125 ** This is useful for computing opt.search from the SearchAdvDialog controller (ControlSearchAdv).
126 ** Ideally, this should not be needed, and the opt.search field should become a Text const &.
128 docstring stringifyFromForSearch(
129 FindAndReplaceOptions const & opt,
130 DocIterator const & cur,