Provide proper fallback if a bibliography processor is not found

[lyx.git] / src / lyxfind.h

diff --git a/src/lyxfind.h b/src/lyxfind.h
index 0e4887bf3f6c005d6b36d9b8d367dc86ef5d3841..61f44366ec0671a93f48a9349d8bd8a3298d73c4 100644 (file)
--- 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,20 +16,26 @@
 #ifndef LYXFIND_H
 #define LYXFIND_H
 
-#include "support/types.h"
+#include "support/strfwd.h"
 
-#include <string>
+// FIXME
+#include "support/docstring.h"
 
 namespace lyx {
 
+
+
+class Buffer;
+class Cursor;
 class BufferView;
+class DocIterator;
 class FuncRequest;
-class LyXText;
+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.
  */
-std::string const find2string(std::string const & search,
+docstring const find2string(docstring const & search,
                              bool casesensitive,
                              bool matchword,
                              bool forward);
@@ -37,28 +44,100 @@ std::string const find2string(std::string const & search,
  *  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,
+docstring const replace2string(docstring const & replace,
+                                docstring const & search,
                                 bool casesensitive,
                                 bool matchword,
                                 bool all,
-                                bool forward);
+                                bool forward,
+                                bool findnext = true);
 
 /** 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.
  */
-void find(BufferView * bv, FuncRequest const & ev);
+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
  */
-void replace(BufferView * bv, FuncRequest const &);
+bool lyxreplace(BufferView * bv,
+               FuncRequest const &, bool has_deleted = false);
 
 /// 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
+       );
+       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