sc/inc/addincol.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SC_INC_ADDINCOL_HXX
  21 #define INCLUDED_SC_INC_ADDINCOL_HXX
  22
  23 #include <memory>
  24 #include "global.hxx"
  25 #include <com/sun/star/sheet/XVolatileResult.hpp>
  26 #include <com/sun/star/sheet/XAddIn.hpp>
  27 #include <com/sun/star/sheet/XResultListener.hpp>
  28 #include <com/sun/star/sheet/ResultEvent.hpp>
  29 #include <com/sun/star/container/XNameAccess.hpp>
  30 #include <com/sun/star/reflection/XIdlMethod.hpp>
  31 #include <i18nlangtag/lang.h>
  32 #include <rtl/ustring.h>
  33 #include "scdllapi.h"
  34 #include <rtl/ustring.hxx>
  35 #include "scmatrix.hxx"
  36
  37 #include "types.hxx"
  38
  39 #include <unordered_map>
  40
  41 class SfxObjectShell;
  42 class ScUnoAddInFuncData;
  43 class ScFuncDesc;
  44
  45 typedef std::unordered_map< OUString, const ScUnoAddInFuncData* > ScAddInHashMap;
  46
  47 enum ScAddInArgumentType
  48 {
  49     SC_ADDINARG_NONE,                   ///< -
  50     SC_ADDINARG_INTEGER,                ///< long
  51     SC_ADDINARG_DOUBLE,                 ///< double
  52     SC_ADDINARG_STRING,                 ///< string
  53     SC_ADDINARG_INTEGER_ARRAY,          ///< sequence<sequence<long>>
  54     SC_ADDINARG_DOUBLE_ARRAY,           ///< sequence<sequence<double>>
  55     SC_ADDINARG_STRING_ARRAY,           ///< sequence<sequence<string>>
  56     SC_ADDINARG_MIXED_ARRAY,            ///< sequence<sequence<any>>
  57     SC_ADDINARG_VALUE_OR_ARRAY,         ///< any
  58     SC_ADDINARG_CELLRANGE,              ///< XCellRange
  59     SC_ADDINARG_CALLER,                 ///< XPropertySet
  60     SC_ADDINARG_VARARGS                 ///< sequence<any>
  61 };
  62
  63 struct ScAddInArgDesc
  64 {
  65     OUString         aInternalName; ///< used to match configuration and reflection information
  66     OUString         aName;
  67     OUString         aDescription;
  68     ScAddInArgumentType eType;
  69     bool                    bOptional;
  70 };
  71
  72 class ScUnoAddInFuncData
  73 {
  74 public:
  75     struct LocalizedName
  76     {
  77         OUString    maLocale;
  78         OUString    maName;
  79
  80                     LocalizedName( const OUString& rLocale, const OUString& rName )
  81                         : maLocale( rLocale), maName( rName) { }
  82     };
  83 private:
  84     OUString     aOriginalName;      ///< kept in formula
  85     OUString     aLocalName;         ///< for display
  86     OUString     aUpperName;         ///< for entering formulas
  87     OUString     aUpperLocal;        ///< for entering formulas
  88     OUString     aDescription;
  89     css::uno::Reference< css::reflection::XIdlMethod> xFunction;
  90     css::uno::Any       aObject;
  91     long                nArgCount;
  92     std::unique_ptr<ScAddInArgDesc[]>
  93                         pArgDescs;
  94     long                nCallerPos;
  95     sal_uInt16          nCategory;
  96     OString             sHelpId;
  97     mutable ::std::vector< LocalizedName > maCompNames;
  98     mutable bool        bCompInitialized;
  99
 100 public:
 101                 ScUnoAddInFuncData( const OUString& rNam, const OUString& rLoc,
 102                                     const OUString& rDesc,
 103                                     sal_uInt16 nCat, const OString&,
 104                                     const css::uno::Reference< css::reflection::XIdlMethod>& rFunc,
 105                                     const css::uno::Any& rO,
 106                                     long nAC, const ScAddInArgDesc* pAD,
 107                                     long nCP );
 108                 ~ScUnoAddInFuncData();
 109
 110     const OUString&  GetOriginalName() const     { return aOriginalName; }
 111     const OUString&  GetLocalName() const        { return aLocalName; }
 112     const OUString&  GetUpperName() const        { return aUpperName; }
 113     const OUString&  GetUpperLocal() const       { return aUpperLocal; }
 114     const css::uno::Reference< css::reflection::XIdlMethod>&   GetFunction() const
 115                                                         { return xFunction; }
 116     const css::uno::Any& GetObject() const   { return aObject; }
 117     long                    GetArgumentCount() const    { return nArgCount; }
 118     const ScAddInArgDesc*   GetArguments() const        { return pArgDescs.get(); }
 119     long                    GetCallerPos() const        { return nCallerPos; }
 120     const OUString&         GetDescription() const      { return aDescription; }
 121     sal_uInt16              GetCategory() const         { return nCategory; }
 122     const OString&          GetHelpId() const           { return sHelpId; }
 123
 124     const ::std::vector< LocalizedName >&  GetCompNames() const;
 125     bool                    GetExcelName( LanguageType eDestLang, OUString& rRetExcelName ) const;
 126
 127     void    SetFunction( const css::uno::Reference< css::reflection::XIdlMethod>& rNewFunc,
 128                          const css::uno::Any& rNewObj );
 129     void    SetArguments( long nNewCount, const ScAddInArgDesc* pNewDescs );
 130     void    SetCallerPos( long nNewPos );
 131     void    SetCompNames( const ::std::vector< LocalizedName >& rNew );
 132 };
 133
 134 class SC_DLLPUBLIC ScUnoAddInCollection
 135 {
 136 private:
 137     long                    nFuncCount;
 138     ScUnoAddInFuncData**    ppFuncData;
 139     ScAddInHashMap*         pExactHashMap;      ///< exact internal name
 140     ScAddInHashMap*         pNameHashMap;       ///< internal name upper
 141     ScAddInHashMap*         pLocalHashMap;      ///< localized name upper
 142     bool                    bInitialized;
 143
 144     void        Initialize();
 145     void        ReadConfiguration();
 146     void        ReadFromAddIn( const css::uno::Reference< css::uno::XInterface>& xInterface );
 147     void        UpdateFromAddIn( const css::uno::Reference< css::uno::XInterface>& xInterface,
 148                                 const OUString& rServiceName );
 149     void        LoadComponent( const ScUnoAddInFuncData& rFuncData );
 150
 151 public:
 152                 ScUnoAddInCollection();
 153                 ~ScUnoAddInCollection();
 154
 155                         /// User entered name. rUpperName MUST already be upper case!
 156     const OUString &    FindFunction( const OUString& rUpperName, bool bLocalFirst );
 157
 158                         /** Only if bComplete is set, the function reference and argument types
 159                             are initialized (component may have to be loaded).
 160                             @param rName is the exact Name. */
 161     const ScUnoAddInFuncData*   GetFuncData( const OUString& rName, bool bComplete = false );
 162
 163                         /** For enumeration in ScCompiler::OpCodeMap::getAvailableMappings().
 164                             @param nIndex
 165                                 0 <= nIndex < GetFuncCount()
 166                          */
 167     const ScUnoAddInFuncData*   GetFuncData( long nIndex );
 168
 169     void                Clear();
 170
 171     void                LocalizeString( OUString& rName );    ///< modify rName - input: exact name
 172
 173     long                GetFuncCount();
 174     bool                FillFunctionDesc( long nFunc, ScFuncDesc& rDesc );
 175
 176     static bool         FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc );
 177                   /// leave rRetExcelName unchanged, if no matching name is found
 178     bool                GetExcelName( const OUString& rCalcName, LanguageType eDestLang, OUString& rRetExcelName );
 179                   /// leave rRetCalcName unchanged, if no matching name is found
 180     bool                GetCalcName( const OUString& rExcelName, OUString& rRetCalcName );
 181 };
 182
 183 class ScUnoAddInCall
 184 {
 185 private:
 186     const ScUnoAddInFuncData*   pFuncData;
 187     css::uno::Sequence<css::uno::Any>         aArgs;
 188     css::uno::Sequence<css::uno::Any>         aVarArg;
 189     css::uno::Reference<css::uno::XInterface> xCaller;
 190     bool                        bValidCount;
 191     // result:
 192     FormulaError                nErrCode;
 193     bool                        bHasString;
 194     double                      fValue;
 195     OUString                    aString;
 196     ScMatrixRef                 xMatrix;
 197     css::uno::Reference<css::sheet::XVolatileResult> xVarRes;
 198
 199     void            ExecuteCallWithArgs(css::uno::Sequence<css::uno::Any>& rCallArgs);
 200
 201 public:
 202                     // exact name
 203                     ScUnoAddInCall( ScUnoAddInCollection& rColl, const OUString& rName,
 204                                     long nParamCount );
 205                     ~ScUnoAddInCall();
 206
 207     bool                NeedsCaller() const;
 208     void                SetCaller( const css::uno::Reference<css::uno::XInterface>& rInterface );
 209     void                SetCallerFromObjectShell( const SfxObjectShell* pSh );
 210
 211     bool                ValidParamCount() { return bValidCount;}
 212     ScAddInArgumentType GetArgType( long nPos );
 213     void                SetParam( long nPos, const css::uno::Any& rValue );
 214
 215     void                ExecuteCall();
 216
 217     void                SetResult( const css::uno::Any& rNewRes );
 218
 219     FormulaError        GetErrCode() const      { return nErrCode; }
 220     bool                HasString() const       { return bHasString; }
 221     bool                HasMatrix() const       { return xMatrix.get(); }
 222     bool                HasVarRes() const       { return xVarRes.is(); }
 223     double              GetValue() const        { return fValue; }
 224     const OUString&     GetString() const       { return aString; }
 225     const ScMatrixRef&  GetMatrix() const       { return xMatrix;}
 226     const css::uno::Reference<css::sheet::XVolatileResult>&
 227                         GetVarRes() const       { return xVarRes; }
 228 };
 229
 230 #endif
 231
 232 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */