diff options
Diffstat (limited to 'sc/inc/addincol.hxx')
| -rw-r--r-- | sc/inc/addincol.hxx | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/sc/inc/addincol.hxx b/sc/inc/addincol.hxx new file mode 100644 index 000000000000..f8c47ab24446 --- /dev/null +++ b/sc/inc/addincol.hxx @@ -0,0 +1,247 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 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; + 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; + USHORT nCategory; + rtl::OString sHelpId; + mutable com::sun::star::uno::Sequence< com::sun::star::sheet::LocalizedName> aCompNames; + mutable BOOL bCompInitialized; + +public: + ScUnoAddInFuncData( const String& rNam, const String& rLoc, + const String& rDesc, + USHORT 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; } + USHORT GetCategory() const { return nCategory; } + const rtl::OString GetHelpId() const { return sHelpId; } + + const com::sun::star::uno::Sequence< com::sun::star::sheet::LocalizedName>& GetCompNames() const; + 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 + 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, 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(); + BOOL FillFunctionDesc( long nFunc, ScFuncDesc& rDesc ); + + static BOOL FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc ); + + BOOL GetExcelName( const String& rCalcName, LanguageType eDestLang, String& rRetExcelName ); + 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; + BOOL bValidCount; + // result: + USHORT nErrCode; + 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(); + + BOOL NeedsCaller() const; + void SetCaller( const com::sun::star::uno::Reference< + com::sun::star::uno::XInterface>& rInterface ); + void SetCallerFromObjectShell( SfxObjectShell* pSh ); + + 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 ); + + USHORT GetErrCode() const { return nErrCode; } + BOOL HasString() const { return bHasString; } + BOOL HasMatrix() const { return ( xMatrix.Is() ); } + 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 + |