EmbeddedObjects.lyx, Math.lyx, UserGuide.lyx: Spanish translation updates by Ignacio

[lyx.git] / src / lyxfind.h

diff --git a/src/lyxfind.h b/src/lyxfind.h
index 52b79307e49cd419d00f6a62965e20d12ae61fc7..e755efbd1548a585dc47be8043679c009cbb1a94 100644 (file)
--- a/src/lyxfind.h
+++ b/src/lyxfind.h
@@ -1,33 +1,113 @@
 // -*- 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"
+
+namespace lyx {
 
-#include "LString.h"
-#include "lyxparagraph.h"
 
+
+class Buffer;
 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);
+
+/** 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 & search,
+                                docstring const & replace,
+                                bool casesensitive,
+                                bool matchword,
+                                bool all,
+                                bool forward);
+
+/** 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 * 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.
+ */
+void replace(BufferView * bv, FuncRequest const &, bool has_deleted = false);
+
+/// find the next change in the buffer
+bool findNextChange(BufferView * bv);
+
+class FindAdvOptions {
+public:
+  FindAdvOptions(
+                 docstring const & search,
+                 bool casesensitive,
+                 bool matchword,
+                 bool forward,
+                 bool expandmacros,
+                 bool ignoreformat,
+                 bool regexp);
+  FindAdvOptions() {}
+  docstring search;
+  bool casesensitive;
+  bool matchword;
+  bool forward;
+  bool expandmacros;
+  bool ignoreformat;
+  bool regexp;
+};
 
-int LyXReplace(BufferView * bv, string const &, string const &,
-              bool const &, bool const &, bool const &, bool const & = false);
+/// Write a FindAdvOptions instance to a stringstream
+std::ostringstream & operator<<(std::ostringstream & os, lyx::FindAdvOptions const & opt);
 
-bool LyXFind(BufferView * bv, string const &, bool const &, bool const &,
-            bool const &);
+/// Read a FindAdvOptions instance from a stringstream
+std::istringstream & operator>>(std::istringstream & is, lyx::FindAdvOptions & opt);
 
-/// 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);
+/// Dispatch a LFUN_WORD_FINDADV command request
+void findAdv(BufferView * bv, FuncRequest const & ev);
 
-/// 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);
+/// Perform a FindAdv operation.
+bool findAdv(BufferView * bv, FindAdvOptions 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(FindAdvOptions const & opt,
+    Buffer const & buf, DocIterator const & cur, int len = -1);
 
+} // namespace lyx
 
-#endif
+#endif // LYXFIND_H