mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-20 06:49:56 +00:00
62 lines
1.3 KiB
C
62 lines
1.3 KiB
C
|
// -*- C++ -*-
|
||
|
|
/**
|
||
|
|
* \file SpellBase.h
|
||
|
|
* Copyright 2002 the LyX Team
|
||
|
|
* Read the file COPYING
|
||
|
|
*
|
||
|
|
* \author unknown
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef SPELL_BASE_H
|
||
|
|
#define SPELL_BASE_H
|
||
|
|
|
||
|
|
#include "LString.h" // can't forward declare...
|
||
|
|
|
||
|
|
class BufferParams;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Base class of all spell checker implementations.
|
||
|
|
*/
|
||
|
|
class SpellBase {
|
||
|
|
public:
|
||
|
|
|
||
|
|
/// the result from checking a single word
|
||
|
|
enum Result {
|
||
|
|
OK = 1, //< word is correct
|
||
|
|
ROOT, //< root of given word was found
|
||
|
|
COMPOUNDWORD, //< word found through compound formation
|
||
|
|
UNKNOWN, //< word not found
|
||
|
|
MISSED, //< not found, with suggestions
|
||
|
|
IGNORE //< number of other ignored "word"
|
||
|
|
};
|
||
|
|
|
||
|
|
virtual ~SpellBase() {}
|
||
|
|
|
||
|
|
/// return true if the spellchecker instance still exists
|
||
|
|
virtual bool alive() = 0;
|
||
|
|
|
||
|
|
/// clean up on messy exit
|
||
|
|
virtual void cleanUp() = 0;
|
||
|
|
|
||
|
|
/// check the given word and return the result
|
||
|
|
virtual enum Result check(string const &) = 0;
|
||
|
|
|
||
|
|
/// finish this spellchecker instance
|
||
|
|
virtual void close() = 0;
|
||
|
|
|
||
|
|
/// insert the given word into the personal dictionary
|
||
|
|
virtual void insert(string const &) = 0;
|
||
|
|
|
||
|
|
/// accept the given word temporarily
|
||
|
|
virtual void accept(string const &) = 0;
|
||
|
|
|
||
|
|
/// return the next near miss after a MISSED result
|
||
|
|
virtual string const nextMiss() = 0;
|
||
|
|
|
||
|
|
/// give an error message on messy exit
|
||
|
|
virtual string const error() = 0;
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif // SPELL_BASE_H
|