scaddins/source/datefunc/datefunc.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: datefunc.hxx,v $
  10  * $Revision: 1.7 $
  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 //------------------------------------------------------------------
  32 //
  33 // date functions add in
  34 //
  35 //------------------------------------------------------------------
  36
  37 #ifndef _SCA_DATEFUNC_HXX
  38 #define _SCA_DATEFUNC_HXX
  39
  40 #include <string.h>
  41 #include <com/sun/star/lang/XServiceName.hpp>
  42 #include <com/sun/star/lang/XServiceInfo.hpp>
  43 #include <com/sun/star/sheet/XAddIn.hpp>
  44 #include <com/sun/star/sheet/XCompatibilityNames.hpp>
  45 #include <com/sun/star/sheet/addin/XDateFunctions.hpp>
  46 #include <com/sun/star/sheet/addin/XMiscFunctions.hpp>
  47 #include <cppuhelper/implbase6.hxx>             // helper for implementations
  48 #include <tools/resid.hxx>
  49 #include <tools/rc.hxx>
  50 #include <tools/resary.hxx>
  51
  52 //------------------------------------------------------------------
  53
  54 class ScaList
  55 {
  56 private:
  57     static const sal_uInt32     nStartSize;
  58     static const sal_uInt32     nIncrSize;
  59
  60     void**                      pData;          // pointer array
  61     sal_uInt32                  nSize;          // array size
  62     sal_uInt32                  nCount;         // next index to be inserted at
  63     sal_uInt32                  nCurr;          // current pos for iterations
  64
  65     void                        _Grow();
  66     inline void                 Grow();
  67
  68 public:
  69                                 ScaList();
  70     virtual                     ~ScaList();
  71
  72     inline sal_uInt32           Count() const       { return nCount; }
  73
  74     inline const void*          GetObject( sal_uInt32 nIndex ) const
  75                                     { return (nIndex < nCount) ? pData[ nIndex ] : NULL; }
  76
  77     inline void*                First() { return nCount ? pData[ nCurr = 0 ] : NULL; }
  78     inline void*                Next()  { return (nCurr + 1 < nCount) ? pData[ ++nCurr ] : NULL; }
  79
  80     inline void                 Append( void* pNew );
  81     void                        Insert( void* pNew, sal_uInt32 nIndex );
  82 };
  83
  84
  85 inline void ScaList::Grow()
  86 {
  87     if( nCount >= nSize )
  88         _Grow();
  89 }
  90
  91 inline void ScaList::Append( void* pNew )
  92 {
  93     Grow();
  94     pData[ nCount++ ] = pNew;
  95 }
  96
  97
  98 //------------------------------------------------------------------
  99
 100 class ScaStringList : protected ScaList
 101 {
 102 public:
 103     inline                      ScaStringList() : ScaList() {};
 104     virtual                     ~ScaStringList();
 105
 106                                 using ScaList::Count;
 107
 108     inline const ::rtl::OUString* Get( sal_uInt32 nIndex ) const;
 109
 110     inline ::rtl::OUString*     First();
 111     inline ::rtl::OUString*     Next();
 112
 113     using ScaList::Append;
 114     inline void                 Append( ::rtl::OUString* pNew );
 115     inline void                 Append( const ::rtl::OUString& rNew );
 116 };
 117
 118
 119 inline const ::rtl::OUString* ScaStringList::Get( sal_uInt32 nIndex ) const
 120 {
 121     return static_cast< const ::rtl::OUString* >( ScaList::GetObject( nIndex ) );
 122 }
 123
 124 inline ::rtl::OUString* ScaStringList::First()
 125 {
 126     return static_cast< ::rtl::OUString* >( ScaList::First() );
 127 }
 128
 129 inline ::rtl::OUString* ScaStringList::Next()
 130 {
 131     return static_cast< ::rtl::OUString* >( ScaList::Next() );
 132 }
 133
 134 inline void ScaStringList::Append( ::rtl::OUString* pNew )
 135 {
 136     ScaList::Append( pNew );
 137 }
 138
 139 inline void ScaStringList::Append( const ::rtl::OUString& rNew )
 140 {
 141     ScaList::Append( new ::rtl::OUString( rNew ) );
 142 }
 143
 144
 145 //------------------------------------------------------------------
 146
 147 class ScaResId : public ResId
 148 {
 149 public:
 150                                 ScaResId( sal_uInt16 nResId, ResMgr& rResMgr );
 151 };
 152
 153
 154 //------------------------------------------------------------------
 155
 156 class ScaResStringLoader : public Resource
 157 {
 158 private:
 159     String                      aStr;
 160
 161 public:
 162     inline                      ScaResStringLoader( sal_uInt16 nResId, sal_uInt16 nStrId, ResMgr& rResMgr );
 163
 164     inline const String&        GetString() const   { return aStr; }
 165
 166 };
 167
 168
 169 inline ScaResStringLoader::ScaResStringLoader( sal_uInt16 nResId, sal_uInt16 nStrId, ResMgr& rResMgr ) :
 170     Resource( ScaResId( nResId, rResMgr ) ),
 171     aStr( ScaResId( nStrId, rResMgr ) )
 172 {
 173     FreeResource();
 174 }
 175
 176
 177 //------------------------------------------------------------------
 178
 179 class ScaResStringArrLoader : public Resource
 180 {
 181 private:
 182     ResStringArray              aStrArray;
 183
 184 public:
 185     inline                      ScaResStringArrLoader( sal_uInt16 nResId, sal_uInt16 nArrayId, ResMgr& rResMgr );
 186
 187     inline const ResStringArray& GetStringArray() const { return aStrArray; }
 188 };
 189
 190
 191
 192 inline ScaResStringArrLoader::ScaResStringArrLoader( sal_uInt16 nResId, sal_uInt16 nArrayId, ResMgr& rResMgr ) :
 193     Resource( ScaResId( nResId, rResMgr ) ),
 194     aStrArray( ScaResId( nArrayId, rResMgr ) )
 195 {
 196     FreeResource();
 197 }
 198
 199
 200 //------------------------------------------------------------------
 201
 202 class ScaResPublisher : public Resource
 203 {
 204 public:
 205     inline                      ScaResPublisher( const ScaResId& rResId ) : Resource( rResId ) {}
 206
 207     inline sal_Bool             IsAvailableRes( const ResId& rResId ) const
 208                                     { return Resource::IsAvailableRes( rResId ); }
 209     inline void                 FreeResource()
 210                                     { Resource::FreeResource(); }
 211 };
 212
 213
 214 //------------------------------------------------------------------
 215
 216 class ScaFuncRes : public Resource
 217 {
 218 public:
 219                                 ScaFuncRes( ResId& rResId, ResMgr& rResMgr, sal_uInt16 nIndex, ::rtl::OUString& rRet );
 220 };
 221
 222
 223 //------------------------------------------------------------------
 224
 225 enum ScaCategory
 226 {
 227     ScaCat_AddIn,
 228     ScaCat_DateTime,
 229     ScaCat_Text,
 230     ScaCat_Finance,
 231     ScaCat_Inf,
 232     ScaCat_Math,
 233     ScaCat_Tech
 234 };
 235
 236 struct ScaFuncDataBase
 237 {
 238     const sal_Char*             pIntName;           // internal name (get***)
 239     sal_uInt16                  nUINameID;          // resource ID to UI name
 240     sal_uInt16                  nDescrID;           // resource ID to description, parameter names and ~ description
 241     sal_uInt16                  nCompListID;        // resource ID to list of valid names
 242     sal_uInt16                  nParamCount;        // number of named / described parameters
 243     ScaCategory                 eCat;               // function category
 244     sal_Bool                    bDouble;            // name already exist in Calc
 245     sal_Bool                    bWithOpt;           // first parameter is internal
 246 };
 247
 248 class ScaFuncData
 249 {
 250 private:
 251     ::rtl::OUString             aIntName;           // internal name (get***)
 252     sal_uInt16                  nUINameID;          // resource ID to UI name
 253     sal_uInt16                  nDescrID;           // leads also to parameter descriptions!
 254     sal_uInt16                  nCompListID;        // resource ID to list of valid names
 255     sal_uInt16                  nParamCount;        // num of parameters
 256     ScaStringList               aCompList;          // list of all valid names
 257     ScaCategory                 eCat;               // function category
 258     sal_Bool                    bDouble;            // name already exist in Calc
 259     sal_Bool                    bWithOpt;           // first parameter is internal
 260
 261 public:
 262                                 ScaFuncData( const ScaFuncDataBase& rBaseData, ResMgr& rRscMgr );
 263     virtual                     ~ScaFuncData();
 264
 265     inline sal_uInt16           GetUINameID() const     { return nUINameID; }
 266     inline sal_uInt16           GetDescrID() const      { return nDescrID; }
 267     inline ScaCategory          GetCategory() const     { return eCat; }
 268     inline sal_Bool             IsDouble() const        { return bDouble; }
 269     inline sal_Bool             HasIntParam() const     { return bWithOpt; }
 270
 271     sal_uInt16                  GetStrIndex( sal_uInt16 nParam ) const;
 272     inline sal_Bool             Is( const ::rtl::OUString& rCompare ) const
 273                                                     { return aIntName == rCompare; }
 274
 275     inline const ScaStringList& GetCompNameList() const { return aCompList; }
 276 };
 277
 278
 279 //------------------------------------------------------------------
 280
 281 class ScaFuncDataList : private ScaList
 282 {
 283     ::rtl::OUString             aLastName;
 284     sal_uInt32                  nLast;
 285
 286 public:
 287                                 ScaFuncDataList( ResMgr& rResMgr );
 288     virtual                     ~ScaFuncDataList();
 289
 290                                 using ScaList::Count;
 291
 292     inline const ScaFuncData*   Get( sal_uInt32 nIndex ) const;
 293     const ScaFuncData*          Get( const ::rtl::OUString& rProgrammaticName ) const;
 294     inline ScaFuncData*         First();
 295     inline ScaFuncData*         Next();
 296
 297     using ScaList::Append;
 298     inline void                 Append( ScaFuncData* pNew ) { ScaList::Append( pNew ); }
 299 };
 300
 301
 302 inline const ScaFuncData* ScaFuncDataList::Get( sal_uInt32 nIndex ) const
 303 {
 304     return static_cast< const ScaFuncData* >( ScaList::GetObject( nIndex ) );
 305 }
 306
 307 inline ScaFuncData* ScaFuncDataList::First()
 308 {
 309     return static_cast< ScaFuncData* >( ScaList::First() );
 310 }
 311
 312 inline ScaFuncData* ScaFuncDataList::Next()
 313 {
 314     return static_cast< ScaFuncData* >( ScaList::Next() );
 315 }
 316
 317
 318 //------------------------------------------------------------------
 319 //------------------------------------------------------------------
 320
 321 ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL DateFunctionAddIn_CreateInstance(
 322     const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& );
 323
 324
 325 // THE AddIn class for date functions
 326
 327 class ScaDateAddIn : public ::cppu::WeakImplHelper6<
 328                                 ::com::sun::star::sheet::XAddIn,
 329                                 ::com::sun::star::sheet::XCompatibilityNames,
 330                                 ::com::sun::star::sheet::addin::XDateFunctions,
 331                                 ::com::sun::star::sheet::addin::XMiscFunctions,
 332                                 ::com::sun::star::lang::XServiceName,
 333                                 ::com::sun::star::lang::XServiceInfo >
 334 {
 335 private:
 336     ::com::sun::star::lang::Locale  aFuncLoc;
 337     ::com::sun::star::lang::Locale* pDefLocales;
 338     ResMgr*                                             pResMgr;
 339     ScaFuncDataList*            pFuncDataList;
 340
 341
 342     void                        InitDefLocales();
 343     const ::com::sun::star::lang::Locale& GetLocale( sal_uInt32 nIndex );
 344     ResMgr&                     GetResMgr() throw( ::com::sun::star::uno::RuntimeException );
 345     void                        InitData();
 346
 347     ::rtl::OUString             GetDisplFuncStr( sal_uInt16 nResId ) throw( ::com::sun::star::uno::RuntimeException );
 348     ::rtl::OUString             GetFuncDescrStr( sal_uInt16 nResId, sal_uInt16 nStrIndex ) throw( ::com::sun::star::uno::RuntimeException );
 349
 350 public:
 351                                 ScaDateAddIn();
 352     virtual                     ~ScaDateAddIn();
 353
 354     static ::rtl::OUString      getImplementationName_Static();
 355     static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static();
 356
 357                                 // XAddIn
 358     virtual ::rtl::OUString SAL_CALL getProgrammaticFuntionName( const ::rtl::OUString& aDisplayName ) throw( ::com::sun::star::uno::RuntimeException );
 359     virtual ::rtl::OUString SAL_CALL getDisplayFunctionName( const ::rtl::OUString& aProgrammaticName ) throw( ::com::sun::star::uno::RuntimeException );
 360     virtual ::rtl::OUString SAL_CALL getFunctionDescription( const ::rtl::OUString& aProgrammaticName ) throw( ::com::sun::star::uno::RuntimeException );
 361     virtual ::rtl::OUString SAL_CALL getDisplayArgumentName( const ::rtl::OUString& aProgrammaticName, sal_Int32 nArgument ) throw( ::com::sun::star::uno::RuntimeException );
 362     virtual ::rtl::OUString SAL_CALL getArgumentDescription( const ::rtl::OUString& aProgrammaticName, sal_Int32 nArgument ) throw( ::com::sun::star::uno::RuntimeException );
 363     virtual ::rtl::OUString SAL_CALL getProgrammaticCategoryName( const ::rtl::OUString& aProgrammaticName ) throw( ::com::sun::star::uno::RuntimeException );
 364     virtual ::rtl::OUString SAL_CALL getDisplayCategoryName( const ::rtl::OUString& aProgrammaticName ) throw( ::com::sun::star::uno::RuntimeException );
 365
 366                                 // XCompatibilityNames
 367     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::sheet::LocalizedName > SAL_CALL getCompatibilityNames( const ::rtl::OUString& aProgrammaticName ) throw( ::com::sun::star::uno::RuntimeException );
 368
 369                                 // XLocalizable
 370     virtual void SAL_CALL       setLocale( const ::com::sun::star::lang::Locale& eLocale ) throw( ::com::sun::star::uno::RuntimeException );
 371     virtual ::com::sun::star::lang::Locale SAL_CALL getLocale() throw( ::com::sun::star::uno::RuntimeException );
 372
 373                                 // XServiceName
 374     virtual ::rtl::OUString SAL_CALL getServiceName() throw( ::com::sun::star::uno::RuntimeException );
 375
 376                                 // XServiceInfo
 377     virtual ::rtl::OUString SAL_CALL getImplementationName() throw( ::com::sun::star::uno::RuntimeException );
 378     virtual sal_Bool SAL_CALL   supportsService( const ::rtl::OUString& ServiceName ) throw( ::com::sun::star::uno::RuntimeException );
 379     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames() throw( ::com::sun::star::uno::RuntimeException );
 380
 381     //  methods from own interfaces start here
 382
 383                                 // XDateFunctions
 384     virtual sal_Int32 SAL_CALL  getDiffWeeks(
 385                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 386                                     sal_Int32 nEndDate, sal_Int32 nStartDate,
 387                                     sal_Int32 nMode )
 388                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 389
 390     virtual sal_Int32 SAL_CALL  getDiffMonths(
 391                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 392                                     sal_Int32 nEndDate, sal_Int32 nStartDate,
 393                                     sal_Int32 nMode )
 394                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 395
 396     virtual sal_Int32 SAL_CALL  getDiffYears(
 397                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 398                                     sal_Int32 nEndDate, sal_Int32 nStartDate,
 399                                     sal_Int32 nMode )
 400                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 401
 402     virtual sal_Int32 SAL_CALL  getIsLeapYear(
 403                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 404                                     sal_Int32 nDate )
 405                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 406
 407     virtual sal_Int32 SAL_CALL  getDaysInMonth(
 408                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 409                                     sal_Int32 nDate )
 410                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 411
 412     virtual sal_Int32 SAL_CALL  getDaysInYear(
 413                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 414                                     sal_Int32 nDate )
 415                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 416
 417     virtual sal_Int32 SAL_CALL  getWeeksInYear(
 418                                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xOptions,
 419                                     sal_Int32 nDate )
 420                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 421
 422                                 // XMiscFunctions
 423     virtual ::rtl::OUString SAL_CALL getRot13(
 424                                     const ::rtl::OUString& aSrcText )
 425                                 throw( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException );
 426 };
 427
 428 //------------------------------------------------------------------
 429
 430 #endif  // _SCA_DATEFUNC_HXX
 431