suggest.h

/*
  For general Scribus (>=1.3.2) copyright and licensing information
  please refer to the COPYING file provided with the
  program. Following this notice may exist a copyright and/or license
  notice that predates the release of Scribus 1.3.2 for which a new
  license (GPL+exception) is in place.
*/
#ifndef SUGGEST_H
#define SUGGEST_H

// ISO C++ include files
#include <sstream>            // For formatting aspell dictionary entries
#include <stdexcept>          // For exceptions
#include <string>             // Used in function arguments, errors 
#include <vector>             // Used in function arguments
#include <iostream>           // Printing to std::cout
// aspell include files
#include <aspell.h>

namespace Speller {
  namespace Aspell {
    class Suggest {
    private:
        AspellConfig*  fconfig;
        AspellSpeller* fspeller;
            std::string    flang;
            std::string    fjargon;
        std::string    fencoding;

        void checkError() throw( std::runtime_error );
        void checkConfigError() throw( std::runtime_error );
        void init(const std::string& lang, const std::string& jargon,
            const std::string& encoding)
            throw( std::invalid_argument, std::runtime_error );
        void printWordList(const AspellWordList* wlist,
                   char delim='\n') throw(std::invalid_argument);
        void setConfig() throw( std::invalid_argument );
        void storeWordList(const AspellWordList* wlist,
                   std::vector<std::string>& replacement)
            throw( std::invalid_argument );

    public:
        static const char* kDICT_DELIM;
        static const char* kEMPTY;
        static const char* kDEF_LANG;
        static const char* kDEF_JARGON;
        static const char* kDEF_ENCODING;

        // Defaults are for standard aspell English dictionary. Use
        // "iso8859-1" for Basic Latin. See aspell lang.dat file for
        // actual encoding used for a given dictionary.
        Suggest(const std::string& lang=kDEF_LANG,
            const std::string& jargon=kDEF_JARGON,
            const std::string& encoding=kDEF_ENCODING)
            throw( std::invalid_argument, std::runtime_error );
        Suggest(const AspellDictInfo* dinfo,
            const std::string& encoding=kDEF_ENCODING)
            throw( std::invalid_argument, std::runtime_error );
        void addPersonalList(const std::string& word)
            throw( std::runtime_error );
        bool checkWord(const std::string& word);
        bool checkWord(const std::string& word,
               std::vector<std::string>& replacement,
               bool always=true) throw( std::invalid_argument );
        void clearSessionList() throw( std::runtime_error );
        std::string getConfigOpt(const std::string& opt);
        void getConfigOpt(const std::string& opt,
                  std::vector<std::string>& vals);
        void ignoreWord(const std::string& word)
            throw( std::runtime_error );
        void listDicts(std::vector<AspellDictInfo>& vals);
        void listDicts(std::vector<std::string>& vals);
        void printMainList() throw( std::invalid_argument );
        void printPersonalList() throw( std::invalid_argument );
        void printSessionList() throw( std::invalid_argument );
        bool printSuggestions(const std::string& word, bool always=true)
            throw( std::invalid_argument );
        void resetConfig()
            throw( std::invalid_argument, std::runtime_error );
        void resetConfig(const std::string& lang,
                 const std::string& jargon,
                 const std::string& encoding=kDEF_ENCODING)
            throw( std::invalid_argument, std::runtime_error );
        void saveLists() throw( std::runtime_error );
        void setConfigOpt(const std::string& opt, const std::string& val)
            throw( std::invalid_argument );
        void StoreMainList(std::vector<std::string>& replacement)
            throw( std::invalid_argument );
        void StorePersonalList(std::vector<std::string>& replacement)
            throw( std::invalid_argument );
        void StoreSessionList(std::vector<std::string>& replacement)
            throw( std::invalid_argument );
    };  // class Suggest
  }  // namespace Aspell
}  // namespace Speller
#endif  // #ifndef SUGGEST_H
//@@@@@@@@@@@@@@@@@@@@@@@@@ END OF FILE @@@@@@@@@@@@@@@@@@@@@@@@@