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
{
81 FindAndReplaceOptions(
82 docstring
const & search
,
89 docstring
const & replace
91 FindAndReplaceOptions() { }
102 /// Write a FindAdvOptions instance to a stringstream
103 std::ostringstream
& operator<<(std::ostringstream
& os
, lyx::FindAndReplaceOptions
const & opt
);
105 /// Read a FindAdvOptions instance from a stringstream
106 std::istringstream
& operator>>(std::istringstream
& is
, lyx::FindAndReplaceOptions
& opt
);
108 /// Dispatch a LFUN_WORD_FINDADV command request
109 void findAdv(BufferView
* bv
, FuncRequest
const & ev
);
111 /// Perform a FindAdv operation.
112 bool findAdv(BufferView
* bv
, FindAndReplaceOptions
const & opt
);
114 /** Computes the simple-text or LaTeX export (depending on opt) of buf starting
115 ** from cur and ending len positions after cur, if len is positive, or at the
116 ** paragraph or innermost inset end if len is -1.
118 ** This is useful for computing opt.search from the SearchAdvDialog controller (ControlSearchAdv).
119 ** Ideally, this should not be needed, and the opt.search field should become a Text const &.
121 docstring
stringifyFromForSearch(
122 FindAndReplaceOptions
const & opt
,
123 DocIterator
const & cur
,