// -*- 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"
+
+// FIXME
+#include "support/docstring.h"
-#include "LString.h"
-#include "paragraph.h"
+namespace lyx {
+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);
+
+/** 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);
+
+/** 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,
+ bool wrap = true,
+ bool onlysel = false);
+
+/** 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);
+
+bool findOne(BufferView * bv, docstring const & searchstr,
+ bool case_sens, bool whole, bool forward,
+ bool find_del = true, bool check_wrap = false,
+ bool const 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);
+
+/// 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);
-int LyXReplace(BufferView * bv, string const &, string const &,
- bool const &, bool const &, bool const &, bool const & = false);
+/// Read a FindAdvOptions instance from a stringstream
+std::istringstream & operator>>(std::istringstream & is, lyx::FindAndReplaceOptions & opt);
-bool LyXFind(BufferView * bv, string const &, bool const &, bool const &,
- bool const &);
+/// Perform a FindAdv operation.
+bool findAdv(BufferView * bv, FindAndReplaceOptions & opt);
-/// returns true if the specified string is at the specified position
-bool IsStringInText(Paragraph * par, Paragraph::size_type pos,
- string const & str, bool const & = true,
- bool const & = false);
+/** 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);
-/// if the string is found: return true and set the cursor to the new position
-bool SearchForward(BufferView *, string const & str, bool const & = true,
- bool const & = false);
-///
-bool SearchBackward(BufferView *, string const & str, bool const & = true,
- bool const & = false);
+} // namespace lyx
-#endif
+#endif // LYXFIND_H
projects / lyx.git / blobdiff