X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Flyxfind.h;h=727b17f466a74051979e5311869b71c4380ecda4;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=61e3977053bd935b4bdd1a5df94b525c93a5967b;hpb=32a716152e3e19d0afe039fe7220e982619348cf;p=lyx.git diff --git a/src/lyxfind.h b/src/lyxfind.h index 61e3977053..727b17f466 100644 --- a/src/lyxfind.h +++ b/src/lyxfind.h @@ -4,10 +4,11 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author John Levon - * \author Jürgen Vigna + * \author Jürgen Vigna * \author Alfredo Braunstein + * \author Tommaso Cucinotta * * Full author contact details are available in file CREDITS. */ @@ -15,61 +16,128 @@ #ifndef LYXFIND_H #define LYXFIND_H -#include "support/types.h" +#include "support/strfwd.h" -#include - -class BufferView; -class LyXText; +// FIXME +#include "support/docstring.h" namespace lyx { -namespace find { -/** - * This function replaces an ocurrence of \param search with the - * string \param replace - * - * \param bv the BufferView in which the search is to be performed, - * starting at the current cursor position. - * \param search the string we're looking for. - * \param replace if \c search is found, replace it with this. - * \param cs perform a case-sensitive search for \c search. - * \param mw match whole words only. - * \param fw search forward from the current cursor position. - */ -int replace(BufferView * bv, - std::string const & search, std::string const & replace, - bool cs, bool mw, bool fw); -/** - * This function replaces all ocurrences of \param search with - * the string \param replace - * - * \param bv the BufferView in which the search is to be performed, - * starting at the current cursor position. - * \param search the string we're looking for. - * \param replace if \c search is found, replace it with this. - * \param cs perform a case-sensitive search for \c search. - * \param mw match whole words only. + +class Buffer; +class Cursor; +class BufferView; +class DocIterator; +class FuncRequest; +class Text; + +/** Encode the parameters needed to find \c search as a string + * that can be dispatched to the LyX core in a FuncRequest wrapper. */ +docstring const find2string(docstring const & search, + bool casesensitive, + bool matchword, + bool forward); -int replaceAll(BufferView * bv, - std::string const & search, std::string const & replace, - bool cs, bool mw); +/** Encode the parameters needed to replace \c search with \c replace + * as a string that can be dispatched to the LyX core in a FuncRequest + * wrapper. + */ +docstring const replace2string(docstring const & replace, + docstring const & search, + bool casesensitive, + bool matchword, + bool all, + bool forward, + bool findnext = true); -/** - * This function is called as a general interface to find some text - * from the actual cursor position in whatever direction we want to - * go. This does also update the screen. +/** Parse the string encoding of the find request that is found in + * \c ev.argument and act on it. + * The string is encoded by \c find2string. + * \return true if the string was found. */ -bool find(BufferView *, std::string const & search, - bool cs, bool mw, bool fw); +bool lyxfind(BufferView * bv, FuncRequest const & ev); +/** Parse the string encoding of the replace request that is found in + * \c ev.argument and act on it. + * The string is encoded by \c replace2string. + * \return whether we did anything + */ +bool lyxreplace(BufferView * bv, + FuncRequest const &, bool has_deleted = false); /// find the next change in the buffer bool findNextChange(BufferView * bv); -} // namespace find +/// find the previous change in the buffer +bool findPreviousChange(BufferView * bv); + +/// select change under the cursor +bool selectChange(Cursor & cur, bool forward = true); + + +class FindAndReplaceOptions { +public: + typedef enum { + S_BUFFER, + S_DOCUMENT, + S_OPEN_BUFFERS, + S_ALL_MANUALS + } SearchScope; + typedef enum { + R_EVERYTHING, + R_ONLY_MATHS + } SearchRestriction; + FindAndReplaceOptions( + docstring const & find_buf_name, + bool casesensitive, + bool matchword, + bool forward, + bool expandmacros, + bool ignoreformat, + docstring const & repl_buf_name, + bool keep_case, + SearchScope scope = S_BUFFER, + SearchRestriction restr = R_EVERYTHING + ); + FindAndReplaceOptions() : casesensitive(false), matchword(false), forward(false), + expandmacros(false), ignoreformat(false), + keep_case(false), scope(S_BUFFER), restr(R_EVERYTHING) {} + docstring find_buf_name; + bool casesensitive; + bool matchword; + bool forward; + bool expandmacros; + bool ignoreformat; + /// This is docstring() if no replace was requested + docstring repl_buf_name; + bool keep_case; + SearchScope scope; + SearchRestriction restr; +}; + +/// Write a FindAdvOptions instance to a stringstream +std::ostringstream & operator<<(std::ostringstream & os, lyx::FindAndReplaceOptions const & opt); + +/// Read a FindAdvOptions instance from a stringstream +std::istringstream & operator>>(std::istringstream & is, lyx::FindAndReplaceOptions & opt); + +/// Perform a FindAdv operation. +bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt); + +/** Computes the simple-text or LaTeX export (depending on opt) of buf starting + ** from cur and ending len positions after cur, if len is positive, or at the + ** paragraph or innermost inset end if len is -1. + ** + ** This is useful for computing opt.search from the SearchAdvDialog controller (ControlSearchAdv). + ** Ideally, this should not be needed, and the opt.search field should become a Text const &. + **/ +docstring stringifyFromForSearch( + FindAndReplaceOptions const & opt, + DocIterator const & cur, + int len = -1); + } // namespace lyx #endif // LYXFIND_H