/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * 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 . */ #pragma once #include #include #include #include #include #include #include "scdllapi.h" #include #include #include "types.hxx" #include #include #include namespace com::sun::star::reflection { class XIdlMethod; } namespace com::sun::star::sheet { class XVolatileResult; } namespace com::sun::star::uno { class XInterface; } class SfxObjectShell; class ScUnoAddInFuncData; class ScFuncDesc; typedef std::unordered_map< OUString, const ScUnoAddInFuncData* > ScAddInHashMap; enum ScAddInArgumentType { SC_ADDINARG_NONE, ///< - SC_ADDINARG_INTEGER, ///< long SC_ADDINARG_DOUBLE, ///< double SC_ADDINARG_STRING, ///< string SC_ADDINARG_INTEGER_ARRAY, ///< sequence> SC_ADDINARG_DOUBLE_ARRAY, ///< sequence> SC_ADDINARG_STRING_ARRAY, ///< sequence> SC_ADDINARG_MIXED_ARRAY, ///< sequence> SC_ADDINARG_VALUE_OR_ARRAY, ///< any SC_ADDINARG_CELLRANGE, ///< XCellRange SC_ADDINARG_CALLER, ///< XPropertySet SC_ADDINARG_VARARGS ///< sequence }; struct ScAddInArgDesc { OUString aInternalName; ///< used to match configuration and reflection information OUString aName; OUString aDescription; ScAddInArgumentType eType; bool bOptional; }; class ScUnoAddInFuncData { public: struct LocalizedName { OUString maLocale; OUString maName; LocalizedName( const OUString& rLocale, const OUString& rName ) : maLocale( rLocale), maName( rName) { } }; private: OUString aOriginalName; ///< kept in formula OUString aLocalName; ///< for display OUString aUpperName; ///< for entering formulas OUString aUpperLocal; ///< for entering formulas OUString aDescription; css::uno::Reference< css::reflection::XIdlMethod> xFunction; css::uno::Any aObject; tools::Long nArgCount; std::unique_ptr pArgDescs; tools::Long nCallerPos; sal_uInt16 nCategory; OString sHelpId; mutable ::std::vector< LocalizedName > maCompNames; mutable bool bCompInitialized; public: ScUnoAddInFuncData( const OUString& rNam, const OUString& rLoc, const OUString& rDesc, sal_uInt16 nCat, const OString&, const css::uno::Reference< css::reflection::XIdlMethod>& rFunc, const css::uno::Any& rO, tools::Long nAC, const ScAddInArgDesc* pAD, tools::Long nCP ); ~ScUnoAddInFuncData(); const OUString& GetOriginalName() const { return aOriginalName; } const OUString& GetLocalName() const { return aLocalName; } const OUString& GetUpperName() const { return aUpperName; } const OUString& GetUpperLocal() const { return aUpperLocal; } const css::uno::Reference< css::reflection::XIdlMethod>& GetFunction() const { return xFunction; } const css::uno::Any& GetObject() const { return aObject; } tools::Long GetArgumentCount() const { return nArgCount; } const ScAddInArgDesc* GetArguments() const { return pArgDescs.get(); } tools::Long GetCallerPos() const { return nCallerPos; } const OUString& GetDescription() const { return aDescription; } sal_uInt16 GetCategory() const { return nCategory; } const OString& GetHelpId() const { return sHelpId; } const ::std::vector< LocalizedName >& GetCompNames() const; bool GetExcelName( LanguageType eDestLang, OUString& rRetExcelName ) const; void SetFunction( const css::uno::Reference< css::reflection::XIdlMethod>& rNewFunc, const css::uno::Any& rNewObj ); void SetArguments( tools::Long nNewCount, const ScAddInArgDesc* pNewDescs ); void SetCallerPos( tools::Long nNewPos ); void SetCompNames( ::std::vector< LocalizedName >&& rNew ); }; class SC_DLLPUBLIC ScUnoAddInCollection { private: tools::Long nFuncCount; std::unique_ptr[]> ppFuncData; std::unique_ptr pExactHashMap; ///< exact internal name std::unique_ptr pNameHashMap; ///< internal name upper std::unique_ptr pLocalHashMap; ///< localized name upper bool bInitialized; void Initialize(); void ReadConfiguration(); void ReadFromAddIn( const css::uno::Reference< css::uno::XInterface>& xInterface ); void UpdateFromAddIn( const css::uno::Reference< css::uno::XInterface>& xInterface, std::u16string_view rServiceName ); void LoadComponent( const ScUnoAddInFuncData& rFuncData ); public: ScUnoAddInCollection(); ~ScUnoAddInCollection(); /// User entered name. rUpperName MUST already be upper case! OUString FindFunction( const OUString& rUpperName, bool bLocalFirst ); /** Only if bComplete is set, the function reference and argument types are initialized (component may have to be loaded). @param rName is the exact Name. */ const ScUnoAddInFuncData* GetFuncData( const OUString& rName, bool bComplete = false ); /** For enumeration in ScCompiler::OpCodeMap::getAvailableMappings(). @param nIndex 0 <= nIndex < GetFuncCount() */ const ScUnoAddInFuncData* GetFuncData( tools::Long nIndex ); void Clear(); void LocalizeString( OUString& rName ); ///< modify rName - input: exact name tools::Long GetFuncCount(); bool FillFunctionDesc( tools::Long nFunc, ScFuncDesc& rDesc ); static bool FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc ); /// leave rRetExcelName unchanged, if no matching name is found bool GetExcelName( const OUString& rCalcName, LanguageType eDestLang, OUString& rRetExcelName ); /// leave rRetCalcName unchanged, if no matching name is found bool GetCalcName( const OUString& rExcelName, OUString& rRetCalcName ); }; class ScUnoAddInCall { private: const ScUnoAddInFuncData* pFuncData; css::uno::Sequence aArgs; css::uno::Sequence aVarArg; css::uno::Reference xCaller; bool bValidCount; // result: FormulaError nErrCode; bool bHasString; double fValue; OUString aString; ScMatrixRef xMatrix; css::uno::Reference xVarRes; void ExecuteCallWithArgs(css::uno::Sequence& rCallArgs); public: // exact name ScUnoAddInCall( ScUnoAddInCollection& rColl, const OUString& rName, tools::Long nParamCount ); ~ScUnoAddInCall(); bool NeedsCaller() const; void SetCaller( const css::uno::Reference& rInterface ); void SetCallerFromObjectShell( const SfxObjectShell* pSh ); bool ValidParamCount() { return bValidCount;} ScAddInArgumentType GetArgType( tools::Long nPos ); void SetParam( tools::Long nPos, const css::uno::Any& rValue ); void ExecuteCall(); void SetResult( const css::uno::Any& rNewRes ); FormulaError GetErrCode() const { return nErrCode; } bool HasString() const { return bHasString; } bool HasMatrix() const { return bool(xMatrix); } bool HasVarRes() const { return xVarRes.is(); } double GetValue() const { return fValue; } const OUString& GetString() const { return aString; } const ScMatrixRef& GetMatrix() const { return xMatrix;} const css::uno::Reference& GetVarRes() const { return xVarRes; } }; /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ es2 LibreOffice 核心代码仓库文档基金会
summaryrefslogtreecommitdiff
AgeCommit message (Expand)Author