X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxfind.h;h=f79ef240cd1415ffea4161ebcbce9668b83e35b1;hb=86bfa10abb57a0af7bbddc3af2c7cdb891c77203;hp=7415a466bcdffcdb1163841c749d1e58ad03ff0e;hpb=ae87b945156585b080ed155919f64b80e48d7a04;p=lyx.git diff --git a/src/lyxfind.h b/src/lyxfind.h index 7415a466bc..f79ef240cd 100644 --- a/src/lyxfind.h +++ b/src/lyxfind.h @@ -1,62 +1,167 @@ // -*- C++ -*- +/** + * \file lyxfind.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. + * + * \author Lars Gullik Bjønnes + * \author John Levon + * \author Jürgen Vigna + * \author Alfredo Braunstein + * \author Tommaso Cucinotta + * + * Full author contact details are available in file CREDITS. + */ + #ifndef LYXFIND_H #define LYXFIND_H -#ifdef __GNUG__ -#pragma interface -#endif +#include "support/strfwd.h" -#include "LString.h" -#include "support/types.h" +// FIXME +#include "support/docstring.h" -class BufferView; -class LyXText; +namespace lyx { -namespace lyxfind { - -enum SearchResult { - // - SR_NOT_FOUND = 0, - // - SR_FOUND, - // - SR_FOUND_NOUPDATE -}; +class Cursor; +class BufferView; +class DocIterator; +class FuncRequest; +/** Decode the \c argument to extract search plus options from a string + * that came to the LyX core in a FuncRequest wrapper. + */ +docstring const string2find(docstring const & argument, + bool &casesensitive, + bool &matchword, + bool &forward, + bool &wrap, + bool &instant, + bool &onlysel); -int LyXReplace(BufferView * bv, - string const &, string const &, - bool, bool = true, bool = false, - bool = false, bool = false); +/** 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, + bool wrap, + bool instant, + bool onlysel); -/** - * 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. +/** 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. */ -bool LyXFind(BufferView *, - string const & searchstr, bool forward, - bool casesens = true, bool matchwrd = false); +docstring const replace2string(docstring const & replace, + docstring const & search, + bool casesensitive, + bool matchword, + bool all, + bool forward, + bool findnext = true, + bool wrap = true, + bool onlysel = false); -/** - * This function does search from the cursor position inside the - * passed LyXText parameter and regards this LyXText as the root - * LyXText. It will NOT update any screen stuff. It will however - * set the cursor to the new position inside LyXText, before - * returning to the calling function. +/** 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 lyxfind(BufferView * bv, FuncRequest const & ev); -SearchResult LyXFind(BufferView *, LyXText * text, - string const & searchstr, bool forward, - bool casesens = true, bool matchwrd = false); +bool findOne(BufferView * bv, docstring const & searchstr, + bool case_sens, bool whole, bool forward, + bool find_del = true, bool check_wrap = false, + bool auto_wrap = false, bool instant = false, + bool onlysel = false); + +/** 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 &); /// find the next change in the buffer bool findNextChange(BufferView * bv); - -SearchResult findNextChange(BufferView * bv, LyXText * text, lyx::pos_type & length); - -SearchResult nextChange(BufferView * bv, LyXText * text, lyx::pos_type & length); - -} // end namespace LyXFind - + +/// 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, + bool replace_all = false + ); + + FindAndReplaceOptions() {} + + docstring find_buf_name; + bool casesensitive = false; + bool matchword = false; + bool forward = false; + bool matchAtStart = false; + bool expandmacros = false; + bool ignoreformat = false; + /// This is docstring() if no replace was requested + docstring repl_buf_name; + bool keep_case = false; + SearchScope scope = S_BUFFER; + SearchRestriction restr = R_EVERYTHING; + bool replace_all = false; +}; + +/// Set the formats that should be ignored +void setIgnoreFormat(std::string const & type, bool value, bool fromUser = true); + +/// 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 & 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