linguistic/source/spelldsp.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: spelldsp.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _LINGUISTIC_SPELLDSP_HXX_
  32 #define _LINGUISTIC_SPELLDSP_HXX_
  33
  34 #include "lngopt.hxx"
  35 #include "misc.hxx"
  36 #include "iprcache.hxx"
  37
  38 #include <uno/lbnames.h>                        // CPPU_CURRENT_LANGUAGE_BINDING_NAME macro, which specify the environment type
  39 #include <cppuhelper/implbase1.hxx>
  40 #include <cppuhelper/implbase2.hxx>
  41 #include <cppuhelper/implbase7.hxx>
  42 #include <com/sun/star/lang/XComponent.hpp>
  43 #include <com/sun/star/lang/XInitialization.hpp>
  44 #include <com/sun/star/lang/XServiceDisplayName.hpp>
  45 #include <com/sun/star/beans/XPropertySet.hpp>
  46 #include <com/sun/star/beans/PropertyValues.hpp>
  47 #include <com/sun/star/lang/XServiceInfo.hpp>
  48 #include <com/sun/star/linguistic2/XSpellChecker1.hpp>
  49 #include <com/sun/star/linguistic2/XSpellChecker.hpp>
  50 #include <com/sun/star/linguistic2/XSearchableDictionaryList.hpp>
  51 #include <com/sun/star/linguistic2/XLinguServiceEventBroadcaster.hpp>
  52
  53 #include <boost/shared_ptr.hpp>
  54 #include <map>
  55
  56 class LngSvcMgr;
  57
  58 ///////////////////////////////////////////////////////////////////////////
  59
  60 class SpellCheckerDispatcher :
  61     public cppu::WeakImplHelper2
  62     <
  63         ::com::sun::star::linguistic2::XSpellChecker1,
  64         ::com::sun::star::linguistic2::XSpellChecker
  65     >,
  66     public LinguDispatcher
  67 {
  68     typedef boost::shared_ptr< LangSvcEntries_Spell >               LangSvcEntries_Spell_Ptr_t;
  69     typedef std::map< LanguageType, LangSvcEntries_Spell_Ptr_t >    SpellSvcByLangMap_t;
  70     SpellSvcByLangMap_t     aSvcMap;
  71     LinguOptions            aOpt;
  72
  73     ::com::sun::star::uno::Reference<
  74         ::com::sun::star::beans::XPropertySet >                                         xPropSet;
  75     ::com::sun::star::uno::Reference<
  76         ::com::sun::star::linguistic2::XSearchableDictionaryList >      xDicList;
  77
  78     LngSvcMgr                                   &rMgr;
  79     linguistic::SpellCache      *pCache; // Spell Cache (holds known words)
  80
  81     // disallow copy-constructor and assignment-operator for now
  82     SpellCheckerDispatcher(const SpellCheckerDispatcher &);
  83     SpellCheckerDispatcher & operator = (const SpellCheckerDispatcher &);
  84
  85     inline linguistic::SpellCache &  GetCache() const;
  86
  87     inline ::com::sun::star::uno::Reference<
  88         ::com::sun::star::beans::XPropertySet >
  89             GetPropSet();
  90     inline ::com::sun::star::uno::Reference<
  91         ::com::sun::star::linguistic2::XSearchableDictionaryList >
  92             GetDicList();
  93
  94     void        ClearSvcList();
  95
  96     BOOL    isValid_Impl(const ::rtl::OUString& aWord, LanguageType nLanguage,
  97                     const ::com::sun::star::beans::PropertyValues& aProperties,
  98                     BOOL bCheckDics)
  99                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 100
 101     ::com::sun::star::uno::Reference<
 102         ::com::sun::star::linguistic2::XSpellAlternatives >
 103             spell_Impl(const ::rtl::OUString& aWord, LanguageType nLanguage,
 104                     const ::com::sun::star::beans::PropertyValues& aProperties,
 105                     BOOL bCheckDics)
 106                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 107
 108 public:
 109     SpellCheckerDispatcher( LngSvcMgr &rLngSvcMgr );
 110     virtual ~SpellCheckerDispatcher();
 111
 112     // XSupportedLocales (for XSpellChecker)
 113     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::lang::Locale > SAL_CALL getLocales() throw(::com::sun::star::uno::RuntimeException);
 114     virtual sal_Bool SAL_CALL hasLocale( const ::com::sun::star::lang::Locale& aLocale ) throw(::com::sun::star::uno::RuntimeException);
 115
 116     // XSpellChecker
 117     virtual sal_Bool SAL_CALL isValid( const ::rtl::OUString& aWord, const ::com::sun::star::lang::Locale& aLocale, const ::com::sun::star::beans::PropertyValues& aProperties ) throw(::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 118     virtual ::com::sun::star::uno::Reference< ::com::sun::star::linguistic2::XSpellAlternatives > SAL_CALL spell( const ::rtl::OUString& aWord, const ::com::sun::star::lang::Locale& aLocale, const ::com::sun::star::beans::PropertyValues& aProperties ) throw(::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 119
 120     // XSupportedLanguages
 121     virtual ::com::sun::star::uno::Sequence< ::sal_Int16 > SAL_CALL getLanguages(  ) throw (::com::sun::star::uno::RuntimeException);
 122     virtual ::sal_Bool SAL_CALL hasLanguage( ::sal_Int16 nLanguage ) throw (::com::sun::star::uno::RuntimeException);
 123
 124     // XSpellChecker1
 125     virtual ::sal_Bool SAL_CALL isValid( const ::rtl::OUString& aWord, ::sal_Int16 nLanguage, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& aProperties ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 126     virtual ::com::sun::star::uno::Reference< ::com::sun::star::linguistic2::XSpellAlternatives > SAL_CALL spell( const ::rtl::OUString& aWord, ::sal_Int16 nLanguage, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& aProperties ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 127
 128     // LinguDispatcher
 129     virtual void SetServiceList( const ::com::sun::star::lang::Locale &rLocale, const ::com::sun::star::uno::Sequence< rtl::OUString > &rSvcImplNames );
 130     virtual ::com::sun::star::uno::Sequence< rtl::OUString > GetServiceList( const ::com::sun::star::lang::Locale &rLocale ) const;
 131     virtual DspType GetDspType() const;
 132
 133     void    FlushSpellCache();
 134 };
 135
 136
 137 inline linguistic::SpellCache & SpellCheckerDispatcher::GetCache() const
 138 {
 139     if (!pCache)
 140         ((SpellCheckerDispatcher *) this)->pCache = new linguistic::SpellCache();
 141     return *pCache;
 142 }
 143
 144
 145 inline ::com::sun::star::uno::Reference<
 146     ::com::sun::star::beans::XPropertySet >
 147         SpellCheckerDispatcher::GetPropSet()
 148 {
 149     return xPropSet.is() ?
 150         xPropSet : xPropSet = linguistic::GetLinguProperties();
 151 }
 152
 153
 154 inline ::com::sun::star::uno::Reference<
 155     ::com::sun::star::linguistic2::XSearchableDictionaryList >
 156         SpellCheckerDispatcher::GetDicList()
 157 {
 158     return xDicList.is() ?
 159         xDicList : xDicList = linguistic::GetSearchableDictionaryList();
 160 }
 161
 162
 163 ///////////////////////////////////////////////////////////////////////////
 164
 165 #endif
 166