| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef SC_ADDINCOL_HXX |
| #define SC_ADDINCOL_HXX |
| |
| #include "global.hxx" |
| #include <com/sun/star/sheet/XVolatileResult.hpp> |
| #include <com/sun/star/sheet/XAddIn.hpp> |
| #include <com/sun/star/sheet/XResultListener.hpp> |
| #include <com/sun/star/sheet/ResultEvent.hpp> |
| #include <com/sun/star/container/XNameAccess.hpp> |
| #include <com/sun/star/reflection/XIdlMethod.hpp> |
| #include <com/sun/star/sheet/LocalizedName.hpp> |
| #include <tools/string.hxx> |
| #include <i18npool/lang.h> |
| #include <rtl/ustring.h> |
| #include "scdllapi.h" |
| #include <rtl/ustring.hxx> |
| |
| #ifndef SC_SCMATRIX_HXX |
| #include "scmatrix.hxx" |
| #endif |
| |
| #include <hash_map> |
| |
| |
| class String; |
| class SfxObjectShell; |
| class ScUnoAddInFuncData; |
| class ScMatrix; |
| class ScFuncDesc; |
| |
| |
| typedef ::std::hash_map< String, const ScUnoAddInFuncData*, ScStringHashCode, ::std::equal_to< String > > ScAddInHashMap; |
| |
| |
| enum ScAddInArgumentType |
| { |
| SC_ADDINARG_NONE, // - |
| SC_ADDINARG_INTEGER, // long |
| SC_ADDINARG_DOUBLE, // double |
| SC_ADDINARG_STRING, // string |
| SC_ADDINARG_INTEGER_ARRAY, // sequence<sequence<long>> |
| SC_ADDINARG_DOUBLE_ARRAY, // sequence<sequence<double>> |
| SC_ADDINARG_STRING_ARRAY, // sequence<sequence<string>> |
| SC_ADDINARG_MIXED_ARRAY, // sequence<sequence<any>> |
| SC_ADDINARG_VALUE_OR_ARRAY, // any |
| SC_ADDINARG_CELLRANGE, // XCellRange |
| SC_ADDINARG_CALLER, // XPropertySet |
| SC_ADDINARG_VARARGS // sequence<any> |
| }; |
| |
| //------------------------------------------------------------------------ |
| |
| struct ScAddInArgDesc |
| { |
| String aInternalName; // used to match configuration and reflection information |
| String aName; |
| String aDescription; |
| ScAddInArgumentType eType; |
| sal_Bool bOptional; |
| }; |
| |
| class ScUnoAddInFuncData |
| { |
| private: |
| String aOriginalName; // kept in formula |
| String aLocalName; // for display |
| String aUpperName; // for entering formulas |
| String aUpperLocal; // for entering formulas |
| String aDescription; |
| com::sun::star::uno::Reference< com::sun::star::reflection::XIdlMethod> xFunction; |
| com::sun::star::uno::Any aObject; |
| long nArgCount; |
| ScAddInArgDesc* pArgDescs; |
| long nCallerPos; |
| sal_uInt16 nCategory; |
| rtl::OString sHelpId; |
| mutable com::sun::star::uno::Sequence< com::sun::star::sheet::LocalizedName> aCompNames; |
| mutable sal_Bool bCompInitialized; |
| |
| public: |
| ScUnoAddInFuncData( const String& rNam, const String& rLoc, |
| const String& rDesc, |
| sal_uInt16 nCat, const rtl::OString&, |
| const com::sun::star::uno::Reference< |
| com::sun::star::reflection::XIdlMethod>& rFunc, |
| const com::sun::star::uno::Any& rO, |
| long nAC, const ScAddInArgDesc* pAD, |
| long nCP ); |
| ~ScUnoAddInFuncData(); |
| |
| const String& GetOriginalName() const { return aOriginalName; } |
| const String& GetLocalName() const { return aLocalName; } |
| const String& GetUpperName() const { return aUpperName; } |
| const String& GetUpperLocal() const { return aUpperLocal; } |
| const com::sun::star::uno::Reference< com::sun::star::reflection::XIdlMethod>& GetFunction() const |
| { return xFunction; } |
| const com::sun::star::uno::Any& GetObject() const { return aObject; } |
| long GetArgumentCount() const { return nArgCount; } |
| const ScAddInArgDesc* GetArguments() const { return pArgDescs; } |
| long GetCallerPos() const { return nCallerPos; } |
| const String& GetDescription() const { return aDescription; } |
| sal_uInt16 GetCategory() const { return nCategory; } |
| const rtl::OString GetHelpId() const { return sHelpId; } |
| |
| const com::sun::star::uno::Sequence< com::sun::star::sheet::LocalizedName>& GetCompNames() const; |
| sal_Bool GetExcelName( LanguageType eDestLang, String& rRetExcelName ) const; |
| |
| void SetFunction( const com::sun::star::uno::Reference< com::sun::star::reflection::XIdlMethod>& rNewFunc, |
| const com::sun::star::uno::Any& rNewObj ); |
| void SetArguments( long nNewCount, const ScAddInArgDesc* pNewDescs ); |
| void SetCallerPos( long nNewPos ); |
| void SetCompNames( const com::sun::star::uno::Sequence< com::sun::star::sheet::LocalizedName>& rNew ); |
| }; |
| |
| //------------------------------------------------------------------------ |
| |
| class SC_DLLPUBLIC ScUnoAddInCollection |
| { |
| private: |
| long nFuncCount; |
| ScUnoAddInFuncData** ppFuncData; |
| ScAddInHashMap* pExactHashMap; // exact internal name |
| ScAddInHashMap* pNameHashMap; // internal name upper |
| ScAddInHashMap* pLocalHashMap; // localized name upper |
| sal_Bool bInitialized; |
| |
| void Initialize(); |
| void ReadConfiguration(); |
| void ReadFromAddIn( const com::sun::star::uno::Reference< |
| com::sun::star::uno::XInterface>& xInterface ); |
| void UpdateFromAddIn( const com::sun::star::uno::Reference< |
| com::sun::star::uno::XInterface>& xInterface, |
| const String& rServiceName ); |
| void LoadComponent( const ScUnoAddInFuncData& rFuncData ); |
| |
| public: |
| ScUnoAddInCollection(); |
| ~ScUnoAddInCollection(); |
| |
| /// User enetered name. rUpperName MUST already be upper case! |
| String FindFunction( const String& rUpperName, sal_Bool bLocalFirst ); |
| |
| // rName is the exact Name. |
| // Only if bComplete is set, the function reference and argument types |
| // are initialized (component may have to be loaded). |
| const ScUnoAddInFuncData* GetFuncData( const String& rName, bool bComplete = false ); |
| |
| /** For enumeration in ScCompiler::OpCodeMap::getAvailableMappings(). |
| @param nIndex |
| 0 <= nIndex < GetFuncCount() |
| */ |
| const ScUnoAddInFuncData* GetFuncData( long nIndex ); |
| |
| void Clear(); |
| |
| void LocalizeString( String& rName ); // modify rName - input: exact name |
| |
| long GetFuncCount(); |
| sal_Bool FillFunctionDesc( long nFunc, ScFuncDesc& rDesc ); |
| |
| static sal_Bool FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc ); |
| |
| sal_Bool GetExcelName( const String& rCalcName, LanguageType eDestLang, String& rRetExcelName ); |
| sal_Bool GetCalcName( const String& rExcelName, String& rRetCalcName ); |
| // both leave rRet... unchanged, if no matching name is found |
| }; |
| |
| |
| class ScUnoAddInCall |
| { |
| private: |
| const ScUnoAddInFuncData* pFuncData; |
| com::sun::star::uno::Sequence<com::sun::star::uno::Any> aArgs; |
| com::sun::star::uno::Sequence<com::sun::star::uno::Any> aVarArg; |
| com::sun::star::uno::Reference<com::sun::star::uno::XInterface> xCaller; |
| sal_Bool bValidCount; |
| // result: |
| sal_uInt16 nErrCode; |
| sal_Bool bHasString; |
| double fValue; |
| String aString; |
| ScMatrixRef xMatrix; |
| com::sun::star::uno::Reference<com::sun::star::sheet::XVolatileResult> xVarRes; |
| |
| void ExecuteCallWithArgs( |
| com::sun::star::uno::Sequence<com::sun::star::uno::Any>& rCallArgs); |
| |
| public: |
| // exact name |
| ScUnoAddInCall( ScUnoAddInCollection& rColl, const String& rName, |
| long nParamCount ); |
| ~ScUnoAddInCall(); |
| |
| sal_Bool NeedsCaller() const; |
| void SetCaller( const com::sun::star::uno::Reference< |
| com::sun::star::uno::XInterface>& rInterface ); |
| void SetCallerFromObjectShell( SfxObjectShell* pSh ); |
| |
| sal_Bool ValidParamCount(); |
| ScAddInArgumentType GetArgType( long nPos ); |
| void SetParam( long nPos, const com::sun::star::uno::Any& rValue ); |
| |
| void ExecuteCall(); |
| |
| void SetResult( const com::sun::star::uno::Any& rNewRes ); |
| |
| sal_uInt16 GetErrCode() const { return nErrCode; } |
| sal_Bool HasString() const { return bHasString; } |
| sal_Bool HasMatrix() const { return ( xMatrix.Is() ); } |
| sal_Bool HasVarRes() const { return ( xVarRes.is() ); } |
| double GetValue() const { return fValue; } |
| const String& GetString() const { return aString; } |
| ScMatrixRef GetMatrix() const { return xMatrix; } |
| com::sun::star::uno::Reference<com::sun::star::sheet::XVolatileResult> |
| GetVarRes() const { return xVarRes; } |
| }; |
| |
| |
| #endif |
| |
