spell_manager.h

Go to the documentation of this file.

/* AbiSuite
 * Copyright (C) 2001 Dom Lachowicz <cinamod@hotmail.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef SPELL_MANAGER_H
#define SPELL_MANAGER_H

/* pre-emptive dismissal; ut_types.h is needed by just about everything,
 * so even if it's commented out in-file that's still a lot of work for
 * the preprocessor to do...
 */
#ifndef UT_TYPES_H
#include "ut_types.h"
#endif
#include "ut_string_class.h"
#include "ut_vector.h"
#include "ut_hash.h"
#include "barbarisms.h"

// forward declaration
class SpellManager;

struct DictionaryMapping
{
    UT_String lang; // the language tag
    UT_String dict; // the dictionary for the tag
    UT_String enc;  // the encoding of the dictionary
};

class ABI_EXPORT SpellChecker
{
    friend class SpellManager;

public:

    enum SpellCheckResult
    {
        LOOKUP_SUCCEEDED = 0, // looking up the word succeeded
        LOOKUP_FAILED = 1,    // could not find the word
        LOOKUP_ERROR = 2      // internal error
    };

    SpellCheckResult    checkWord(const UT_UCSChar* word, size_t len);
    UT_GenericVector<UT_UCSChar*>* suggestWord(const UT_UCSChar* word, size_t len);

    // vector of DictionaryMapping*
    virtual UT_Vector & getMapping() {return m_vecEmpty;};
    virtual bool doesDictionaryExist (const char * /*szLang*/) {return false;};
    virtual bool addToCustomDict (const UT_UCSChar *word, size_t len);

    virtual void correctWord (const UT_UCSChar *toCorrect, size_t toCorrectLen,
                              const UT_UCSChar *correct, size_t correctLen);

    virtual void ignoreWord (const UT_UCSChar *toCorrect, size_t toCorrectLen) = 0;

    virtual bool isIgnored (const UT_UCSChar * pWord, size_t len) const = 0;

    const UT_String& getLanguage () const
    {
        return m_sLanguage;
    }

    bool requestDictionary (const char * szLang);
    bool isDictionaryFound(void)
        { return m_bFoundDictionary;}
    void setDictionaryFound(bool b)
        { m_bFoundDictionary = b;}

protected:

    SpellChecker();

    virtual ~SpellChecker();

    void setLanguage (const char * lang)
    {
        m_sLanguage = lang;
    }

    static void couldNotLoadDictionary ( const char * szLang );

    UT_String           m_sLanguage;
    BarbarismChecker    m_BarbarismChecker;
    UT_Vector           m_vecEmpty;

    bool                m_bIsBarbarism;
    bool                m_bIsDictionaryWord;
    bool                m_bFoundDictionary;

private:
    SpellChecker(const SpellChecker&);      // no impl
    void operator=(const SpellChecker&);    // no impl

    virtual bool                _requestDictionary (const char * szLang) = 0;
    virtual SpellCheckResult    _checkWord(const UT_UCSChar* word, size_t len) = 0;
    virtual UT_GenericVector<UT_UCSChar*> *_suggestWord(const UT_UCSChar* word, size_t len) = 0;
};

class ABI_EXPORT SpellManager
{
public:
    static SpellManager & instance (void);

    virtual ~SpellManager ();


    virtual SpellChecker * lastDictionary (void) const;
    virtual SpellChecker * requestDictionary (const char * szLang);
    UT_uint32 numLoadedDicts () const { return m_nLoadedDicts; }

    SpellChecker *  getInstance() const;

private:
    SpellManager ();
    SpellManager ( const SpellManager & other );
    SpellManager & operator= ( const SpellManager & other );


    UT_StringPtrMap m_map;
    UT_String m_missingHashs;
    SpellChecker * m_lastDict;
    UT_uint32 m_nLoadedDicts;
};

#endif /* SPELL_MANAGER_H */