src/lyxfind.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxfind.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author John Levon
   9  * \author Jürgen Vigna
  10  * \author Alfredo Braunstein
  11  * \author Tommaso Cucinotta
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #ifndef LYXFIND_H
  17 #define LYXFIND_H
  18
  19 #include "support/strfwd.h"
  20
  21 // FIXME
  22 #include "support/docstring.h"
  23
  24 namespace lyx {
  25
  26
  27
  28 class Buffer;
  29 class BufferView;
  30 class DocIterator;
  31 class FuncRequest;
  32 class Text;
  33
  34 /** Encode the parameters needed to find \c search as a string
  35  *  that can be dispatched to the LyX core in a FuncRequest wrapper.
  36  */
  37 docstring const find2string(docstring const & search,
  38                               bool casesensitive,
  39                               bool matchword,
  40                               bool forward);
  41
  42 /** Encode the parameters needed to replace \c search with \c replace
  43  *  as a string that can be dispatched to the LyX core in a FuncRequest
  44  *  wrapper.
  45  */
  46 docstring const replace2string(docstring const & replace,
  47                                  docstring const & search,
  48                                  bool casesensitive,
  49                                  bool matchword,
  50                                  bool all,
  51                                  bool forward);
  52
  53 /** Parse the string encoding of the find request that is found in
  54  *  \c ev.argument and act on it.
  55  * The string is encoded by \c find2string.
  56  * \return true if the string was found.
  57  */
  58 bool find(BufferView * bv, FuncRequest const & ev);
  59
  60 /** Parse the string encoding of the replace request that is found in
  61  *  \c ev.argument and act on it.
  62  * The string is encoded by \c replace2string.
  63  */
  64 void replace(BufferView * bv, FuncRequest const &, bool has_deleted = false);
  65
  66 /// find the next change in the buffer
  67 bool findNextChange(BufferView * bv);
  68
  69 /// find the previous change in the buffer
  70 bool findPreviousChange(BufferView * bv);
  71
  72 /// find the change in the buffer
  73 /// \param next true to find the next change, otherwise the previous
  74 bool findChange(BufferView * bv, bool next);
  75
  76 // Hopefully, nobody will ever replace with something like this
  77 #define LYX_FR_NULL_STRING "__LYX__F&R__NULL__STRING__"
  78
  79 class FindAndReplaceOptions {
  80 public:
  81         typedef enum {
  82                 S_BUFFER,
  83                 S_DOCUMENT,
  84                 S_OPEN_BUFFERS,
  85                 S_ALL_MANUALS
  86         } SearchScope;
  87         FindAndReplaceOptions(
  88                 docstring const & search,
  89                 bool casesensitive,
  90                 bool matchword,
  91                 bool forward,
  92                 bool expandmacros,
  93                 bool ignoreformat,
  94                 bool regexp,
  95                 docstring const & replace,
  96                 bool keep_case,
  97                 SearchScope scope = S_BUFFER
  98         );
  99         FindAndReplaceOptions() {  }
 100         docstring search;
 101         bool casesensitive;
 102         bool matchword;
 103         bool forward;
 104         bool expandmacros;
 105         bool ignoreformat;
 106         bool regexp;
 107         docstring replace;
 108         bool keep_case;
 109         SearchScope scope;
 110 };
 111
 112 /// Write a FindAdvOptions instance to a stringstream
 113 std::ostringstream & operator<<(std::ostringstream & os, lyx::FindAndReplaceOptions const & opt);
 114
 115 /// Read a FindAdvOptions instance from a stringstream
 116 std::istringstream & operator>>(std::istringstream & is, lyx::FindAndReplaceOptions & opt);
 117
 118 /// Dispatch a LFUN_WORD_FINDADV command request
 119 void findAdv(BufferView * bv, FuncRequest const & ev);
 120
 121 /// Perform a FindAdv operation.
 122 bool findAdv(BufferView * bv, FindAndReplaceOptions const & opt);
 123
 124 /** Computes the simple-text or LaTeX export (depending on opt) of buf starting
 125  ** from cur and ending len positions after cur, if len is positive, or at the
 126  ** paragraph or innermost inset end if len is -1.
 127  **
 128  ** This is useful for computing opt.search from the SearchAdvDialog controller (ControlSearchAdv).
 129  ** Ideally, this should not be needed, and the opt.search field should become a Text const &.
 130  **/
 131 docstring stringifyFromForSearch(
 132         FindAndReplaceOptions const & opt,
 133         DocIterator const & cur,
 134         int len = -1);
 135
 136 } // namespace lyx
 137
 138 #endif // LYXFIND_H