Helge's infamous brackets bug

[lyx.git] / src / lyxfind.h

diff --git a/src/lyxfind.h b/src/lyxfind.h
index 37509ef0a2ca4503ddc22742bad3087f03387a2c..8a82caac878c06251190ea40caf07f6f871aa56f 100644 (file)
--- a/src/lyxfind.h
+++ b/src/lyxfind.h
@@ -1,32 +1,66 @@
+// -*- 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
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 #ifndef LYXFIND_H
 #define LYXFIND_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "support/types.h"
 
-#include "LString.h"
-#include "lyxparagraph.h"
+#include <string>
 
 class BufferView;
+class FuncRequest;
+class LyXText;
+
+namespace lyx {
+namespace find {
+
+/** Encode the parameters needed to find \c search as a string
+ *  that can be dispatched to the LyX core in a FuncRequest wrapper.
+ */
+std::string const find2string(std::string const & search,
+                             bool casesensitive,
+                             bool matchword,
+                             bool forward);
 
-int LyXReplace(BufferView * bv, string const &, string const &,
-              bool const &, bool const &, bool const &, bool const & = false);
+/** 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.
+ */
+std::string const replace2string(std::string const & search,
+                                std::string const & replace,
+                                bool casesensitive,
+                                bool matchword,
+                                bool all,
+                                bool forward);
 
-bool LyXFind(BufferView * bv, string const &, bool const &, bool const &,
-            bool const &);
+/** 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.
+ */
+void find(BufferView * bv, FuncRequest const & ev);
 
-/// returns true if the specified string is at the specified  position
-bool IsStringInText(LyXParagraph * par, LyXParagraph::size_type pos,
-                   string const & str, bool const & = true,
-                   bool const & = 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.
+ */
+void replace(BufferView * bv, FuncRequest const &);
 
-/// 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);
+/// find the next change in the buffer
+bool findNextChange(BufferView * bv);
 
+} // namespace find
+} // namespace lyx
 
-#endif
+#endif // LYXFIND_H