lyx_mirror/src/lyxfind.h
Abdelrazak Younes c5e56fea32 First part of Tommaso advanced search patch. Only the backend function.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27514 a592a061-630c-0410-9148-cb99ea01b6c8
2008-11-15 23:30:27 +00:00

114 lines
3.2 KiB
C++

// -*- 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
#include "support/strfwd.h"
// FIXME
#include "support/docstring.h"
namespace lyx {
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;
};
/// Write a FindAdvOptions instance to a stringstream
std::ostringstream & operator<<(std::ostringstream & os, lyx::FindAdvOptions const & opt);
/// Read a FindAdvOptions instance from a stringstream
std::istringstream & operator>>(std::istringstream & is, lyx::FindAdvOptions & opt);
/// Dispatch a LFUN_WORD_FINDADV command request
void findAdv(BufferView * bv, FuncRequest const & ev);
/// 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 // LYXFIND_H