linguistic/source/defs.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: defs.hxx,v $
  10  * $Revision: 1.4 $
  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_DEFS_HXX_
  32 #define _LINGUISTIC_DEFS_HXX_
  33
  34 #include <com/sun/star/linguistic2/XSpellChecker.hpp>
  35 #include <com/sun/star/linguistic2/XProofreader.hpp>
  36 #include <com/sun/star/linguistic2/XHyphenator.hpp>
  37 #include <com/sun/star/linguistic2/XThesaurus.hpp>
  38
  39 ///////////////////////////////////////////////////////////////////////////
  40
  41 #define A2OU(x) ::rtl::OUString::createFromAscii( x )
  42
  43 namespace css = ::com::sun::star;
  44
  45 ///////////////////////////////////////////////////////////////////////////
  46
  47 struct LangSvcEntries
  48 {
  49     css::uno::Sequence< ::rtl::OUString >   aSvcImplNames;
  50
  51     sal_Int16   nLastTriedSvcIndex;
  52     bool        bAlreadyWarned;
  53     bool        bDoWarnAgain;
  54
  55     LangSvcEntries() : nLastTriedSvcIndex(-1), bAlreadyWarned(false), bDoWarnAgain(false) {}
  56
  57     inline LangSvcEntries( const css::uno::Sequence< ::rtl::OUString > &rSvcImplNames ) :
  58         aSvcImplNames(rSvcImplNames),
  59         nLastTriedSvcIndex(-1), bAlreadyWarned(false), bDoWarnAgain(false)
  60     {
  61     }
  62
  63     inline LangSvcEntries( const ::rtl::OUString &rSvcImplName ) :
  64         nLastTriedSvcIndex(-1), bAlreadyWarned(false), bDoWarnAgain(false)
  65     {
  66         aSvcImplNames.realloc(1);
  67         aSvcImplNames[0] = rSvcImplName;
  68     }
  69
  70     bool    IsAlreadyWarned() const         { return bAlreadyWarned != 0; }
  71     void    SetAlreadyWarned( bool bVal )   { bAlreadyWarned = 0 != bVal; }
  72     bool    IsDoWarnAgain() const           { return bDoWarnAgain != 0; }
  73     void    SetDoWarnAgain( bool bVal )     { bDoWarnAgain = 0 != bVal; }
  74
  75     inline void Clear()
  76     {
  77         aSvcImplNames.realloc(0);
  78         nLastTriedSvcIndex  = -1;
  79         bAlreadyWarned      = false;
  80         bDoWarnAgain        = false;
  81     }
  82 };
  83
  84 struct LangSvcEntries_Spell : public LangSvcEntries
  85 {
  86     css::uno::Sequence< css::uno::Reference< css::linguistic2::XSpellChecker > >  aSvcRefs;
  87
  88     LangSvcEntries_Spell() : LangSvcEntries() {}
  89     LangSvcEntries_Spell( const css::uno::Sequence< ::rtl::OUString > &rSvcImplNames ) : LangSvcEntries( rSvcImplNames ) {}
  90 };
  91
  92 struct LangSvcEntries_Grammar : public LangSvcEntries
  93 {
  94     css::uno::Sequence< css::uno::Reference< css::linguistic2::XProofreader > >  aSvcRefs;
  95
  96     LangSvcEntries_Grammar() : LangSvcEntries() {}
  97     LangSvcEntries_Grammar( const ::rtl::OUString &rSvcImplName ) : LangSvcEntries( rSvcImplName ) {}
  98 };
  99
 100 struct LangSvcEntries_Hyph : public LangSvcEntries
 101 {
 102     css::uno::Sequence< css::uno::Reference< css::linguistic2::XHyphenator > >  aSvcRefs;
 103
 104     LangSvcEntries_Hyph() : LangSvcEntries() {}
 105     LangSvcEntries_Hyph( const ::rtl::OUString &rSvcImplName ) : LangSvcEntries( rSvcImplName ) {}
 106 };
 107
 108 struct LangSvcEntries_Thes : public LangSvcEntries
 109 {
 110     css::uno::Sequence< css::uno::Reference< css::linguistic2::XThesaurus > >  aSvcRefs;
 111
 112     LangSvcEntries_Thes() : LangSvcEntries() {}
 113     LangSvcEntries_Thes( const css::uno::Sequence< ::rtl::OUString > &rSvcImplNames ) : LangSvcEntries( rSvcImplNames ) {}
 114 };
 115
 116 ///////////////////////////////////////////////////////////////////////////
 117
 118 // virtual base class for the different dispatchers
 119 class LinguDispatcher
 120 {
 121 public:
 122     enum DspType    { DSP_SPELL, DSP_HYPH, DSP_THES, DSP_GRAMMAR };
 123
 124     virtual void SetServiceList( const css::lang::Locale &rLocale, const css::uno::Sequence< rtl::OUString > &rSvcImplNames ) = 0;
 125     virtual css::uno::Sequence< rtl::OUString > GetServiceList( const css::lang::Locale &rLocale ) const = 0;
 126     virtual DspType GetDspType() const = 0;
 127 };
 128
 129 ///////////////////////////////////////////////////////////////////////////
 130
 131 #endif
 132