You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
123 lines
3.2 KiB
123 lines
3.2 KiB
// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*-
|
|
/*
|
|
* filter.h
|
|
*
|
|
* Copyright (C) 2004 Zack Rusin <zack@kde.org>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef KSPELL_FILTER_H
|
|
#define KSPELL_FILTER_H
|
|
|
|
#include <qstring.h>
|
|
#include <kdelibs_export.h>
|
|
|
|
namespace KSpell2
|
|
{
|
|
class Settings;
|
|
|
|
/**
|
|
* Structure abstracts the word and its position in the
|
|
* parent text.
|
|
*
|
|
* @author Zack Rusin <zack@kde.org>
|
|
* @short struct represents word
|
|
*/
|
|
struct Word
|
|
{
|
|
Word() : start( 0 ), end( true )
|
|
{}
|
|
|
|
Word( const QString& w, int st, bool e = false )
|
|
: word( w ), start( st ), end( e )
|
|
{}
|
|
Word( const Word& other )
|
|
: word( other.word ), start( other.start ),
|
|
end( other.end )
|
|
{}
|
|
|
|
QString word;
|
|
uint start;
|
|
bool end;
|
|
};
|
|
|
|
/**
|
|
* Filter is used to split text into words which
|
|
* will be spell checked.
|
|
*
|
|
* @author Zack Rusin <zack@kde.org>
|
|
* @short used to split text into words
|
|
*/
|
|
class KDE_EXPORT Filter
|
|
{
|
|
public:
|
|
static Filter *defaultFilter();
|
|
public:
|
|
Filter();
|
|
virtual ~Filter();
|
|
|
|
static Word end();
|
|
|
|
/**
|
|
* Sets the Settings object for this Filter
|
|
*/
|
|
void setSettings( Settings* );
|
|
|
|
/**
|
|
* Returns currently used Settings object
|
|
*/
|
|
Settings *settings() const;
|
|
|
|
bool atEnd() const;
|
|
|
|
void setBuffer( const QString& buffer );
|
|
QString buffer() const;
|
|
|
|
void restart();
|
|
|
|
virtual Word nextWord() const;
|
|
virtual Word previousWord() const;
|
|
virtual Word wordAtPosition( unsigned int pos ) const;
|
|
|
|
virtual void setCurrentPosition( int );
|
|
virtual int currentPosition() const;
|
|
virtual void replace( const Word& w, const QString& newWord );
|
|
|
|
/**
|
|
* Should return the sentence containing the current word
|
|
*/
|
|
virtual QString context() const;
|
|
protected:
|
|
bool trySkipLinks() const;
|
|
bool ignore( const QString& word ) const;
|
|
QChar skipToLetter( uint &fromPosition ) const;
|
|
bool shouldBeSkipped( bool wordWasUppercase, bool wordWasRunTogether,
|
|
const QString& foundWord ) const;
|
|
|
|
protected:
|
|
QString m_buffer;
|
|
mutable uint m_currentPosition;
|
|
|
|
private:
|
|
class Private;
|
|
Private *d;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|