scripting/source/basprov/basscript.cxx

   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 #include "basscript.hxx"
  21 #include <utility>
  22 #include <vcl/svapp.hxx>
  23 #include <basic/sbx.hxx>
  24 #include <basic/sbmod.hxx>
  25 #include <basic/sbmeth.hxx>
  26 #include <basic/sbuno.hxx>
  27 #include <basic/basmgr.hxx>
  28 #include <com/sun/star/script/provider/ScriptFrameworkErrorException.hpp>
  29 #include <com/sun/star/script/provider/ScriptFrameworkErrorType.hpp>
  30 #include <bcholder.hxx>
  31 #include <comphelper/propertycontainer.hxx>
  32 #include <com/sun/star/beans/PropertyAttribute.hpp>
  33 #include <map>
  34
  35
  36 using namespace ::com::sun::star;
  37 using namespace ::com::sun::star::lang;
  38 using namespace ::com::sun::star::uno;
  39 using namespace ::com::sun::star::script;
  40 using namespace ::com::sun::star::document;
  41 using namespace ::com::sun::star::beans;
  42
  43
  44 static void ChangeTypeKeepingValue(SbxVariable& var, SbxDataType to)
  45 {
  46     SbxValues val(to);
  47     var.Get(val);
  48     bool bSetFlag = var.IsSet(SbxFlagBits::Fixed);
  49     var.ResetFlag(SbxFlagBits::Fixed);
  50     var.Put(val);
  51     if (bSetFlag)
  52         var.SetFlag(SbxFlagBits::Fixed);
  53 }
  54
  55 namespace basprov
  56 {
  57
  58 #define BASSCRIPT_PROPERTY_ID_CALLER         1
  59 constexpr OUString BASSCRIPT_PROPERTY_CALLER = u"Caller"_ustr;
  60
  61 #define BASSCRIPT_DEFAULT_ATTRIBS()       PropertyAttribute::BOUND | PropertyAttribute::TRANSIENT
  62
  63     typedef ::std::map< sal_Int16, Any > OutParamMap;
  64
  65
  66     // BasicScriptImpl
  67
  68
  69     BasicScriptImpl::BasicScriptImpl( OUString funcName, SbMethodRef xMethod )
  70         : ::scripting_helper::OBroadcastHelperHolder( m_aMutex )
  71         ,OPropertyContainer( GetBroadcastHelper() )
  72         ,m_xMethod(std::move( xMethod ))
  73         ,m_funcName(std::move( funcName ))
  74         ,m_documentBasicManager( nullptr )
  75         ,m_xDocumentScriptContext()
  76     {
  77         registerProperty( BASSCRIPT_PROPERTY_CALLER, BASSCRIPT_PROPERTY_ID_CALLER, BASSCRIPT_DEFAULT_ATTRIBS(), &m_caller, cppu::UnoType<decltype(m_caller)>::get() );
  78     }
  79
  80
  81     BasicScriptImpl::BasicScriptImpl( OUString funcName, SbMethodRef xMethod,
  82         BasicManager& documentBasicManager, const Reference< XScriptInvocationContext >& documentScriptContext ) : ::scripting_helper::OBroadcastHelperHolder( m_aMutex )
  83         ,OPropertyContainer( GetBroadcastHelper() )
  84         ,m_xMethod(std::move( xMethod ))
  85         ,m_funcName(std::move( funcName ))
  86         ,m_documentBasicManager( &documentBasicManager )
  87         ,m_xDocumentScriptContext( documentScriptContext )
  88     {
  89         StartListening( *m_documentBasicManager );
  90         registerProperty( BASSCRIPT_PROPERTY_CALLER, BASSCRIPT_PROPERTY_ID_CALLER, BASSCRIPT_DEFAULT_ATTRIBS(), &m_caller, cppu::UnoType<decltype(m_caller)>::get() );
  91     }
  92
  93
  94     BasicScriptImpl::~BasicScriptImpl()
  95     {
  96         SolarMutexGuard g;
  97
  98         if ( m_documentBasicManager )
  99             EndListening( *m_documentBasicManager );
 100     }
 101
 102
 103     // SfxListener
 104
 105     void BasicScriptImpl::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
 106     {
 107         if ( &rBC != m_documentBasicManager )
 108         {
 109             OSL_ENSURE( false, "BasicScriptImpl::Notify: where does this come from?" );
 110             // not interested in
 111             return;
 112         }
 113         if ( rHint.GetId() == SfxHintId::Dying )
 114         {
 115             m_documentBasicManager = nullptr;
 116             EndListening( rBC );    // prevent multiple notifications
 117         }
 118     }
 119
 120
 121     // XInterface
 122
 123
 124     IMPLEMENT_FORWARD_XINTERFACE2( BasicScriptImpl, BasicScriptImpl_BASE, OPropertyContainer )
 125
 126
 127     // XTypeProvider
 128
 129
 130     IMPLEMENT_FORWARD_XTYPEPROVIDER2( BasicScriptImpl, BasicScriptImpl_BASE, OPropertyContainer )
 131
 132
 133     // OPropertySetHelper
 134
 135
 136     ::cppu::IPropertyArrayHelper& BasicScriptImpl::getInfoHelper(  )
 137     {
 138         return *getArrayHelper();
 139     }
 140
 141
 142     // OPropertyArrayUsageHelper
 143
 144
 145     ::cppu::IPropertyArrayHelper* BasicScriptImpl::createArrayHelper(  ) const
 146     {
 147         Sequence< Property > aProps;
 148         describeProperties( aProps );
 149         return new ::cppu::OPropertyArrayHelper( aProps );
 150     }
 151
 152
 153     // XPropertySet
 154
 155
 156     Reference< XPropertySetInfo > BasicScriptImpl::getPropertySetInfo(  )
 157     {
 158         Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 159         return xInfo;
 160     }
 161
 162
 163     // XScript
 164
 165
 166     Any BasicScriptImpl::invoke( const Sequence< Any >& aParams, Sequence< sal_Int16 >& aOutParamIndex, Sequence< Any >& aOutParam )
 167     {
 168         // TODO: throw CannotConvertException
 169         // TODO: check length of aOutParamIndex, aOutParam
 170
 171         SolarMutexGuard aGuard;
 172
 173         Any aReturn;
 174
 175         if ( m_xMethod.is() )
 176         {
 177             // check if compiled
 178             SbModule* pModule = static_cast< SbModule* >( m_xMethod->GetParent() );
 179             if ( pModule && !pModule->IsCompiled() )
 180                 pModule->Compile();
 181
 182             // check number of parameters
 183             sal_Int32 nParamsCount = aParams.getLength();
 184             SbxInfo* pInfo = m_xMethod->GetInfo();
 185             if ( pInfo )
 186             {
 187                 sal_Int32 nSbxOptional = 0;
 188                 sal_uInt16 n = 1;
 189                 for ( const SbxParamInfo* pParamInfo = pInfo->GetParam( n ); pParamInfo; pParamInfo = pInfo->GetParam( ++n ) )
 190                 {
 191                     if ( pParamInfo->nFlags & SbxFlagBits::Optional )
 192                         ++nSbxOptional;
 193                     else
 194                         nSbxOptional = 0;
 195                 }
 196                 sal_Int32 nSbxCount = n - 1;
 197                 if ( nParamsCount < nSbxCount - nSbxOptional )
 198                 {
 199                     throw provider::ScriptFrameworkErrorException(
 200                          "wrong number of parameters!",
 201                          Reference< XInterface >(),
 202                          m_funcName,
 203                          "Basic",
 204                          provider::ScriptFrameworkErrorType::NO_SUCH_SCRIPT  );
 205                 }
 206             }
 207
 208             // set parameters
 209             SbxArrayRef xSbxParams;
 210             if ( nParamsCount > 0 )
 211             {
 212                 xSbxParams = new SbxArray;
 213                 const Any* pParams = aParams.getConstArray();
 214                 for ( sal_Int32 i = 0; i < nParamsCount; ++i )
 215                 {
 216                     SbxVariableRef xSbxVar = new SbxVariable( SbxVARIANT );
 217                     unoToSbxValue( xSbxVar.get(), pParams[i] );
 218                     xSbxParams->Put(xSbxVar.get(), static_cast<sal_uInt32>(i) + 1);
 219
 220                     if (pInfo)
 221                     {
 222                         if (auto* p = pInfo->GetParam(static_cast<sal_uInt16>(i) + 1))
 223                         {
 224                             SbxDataType t = static_cast<SbxDataType>(p->eType & 0x0FFF);
 225                             // tdf#133889 Revert the downcasting performed in sbxToUnoValueImpl
 226                             // to allow passing by reference.
 227                             SbxDataType a = xSbxVar->GetType();
 228                             if (t == SbxSINGLE && (a == SbxINTEGER || a == SbxLONG))
 229                             {
 230                                 sal_Int32 val = xSbxVar->GetLong();
 231                                 if (val >= -16777216 && val <= 16777215)
 232                                     ChangeTypeKeepingValue(*xSbxVar, t);
 233                             }
 234                             else if (t == SbxDOUBLE && (a == SbxINTEGER || a == SbxLONG))
 235                                 ChangeTypeKeepingValue(*xSbxVar, t);
 236                             else if (t == SbxLONG && a == SbxINTEGER)
 237                                 ChangeTypeKeepingValue(*xSbxVar, t);
 238                             else if (t == SbxULONG && a == SbxUSHORT)
 239                                 ChangeTypeKeepingValue(*xSbxVar, t);
 240                             // Enable passing by ref
 241                             if (t != SbxVARIANT)
 242                                 xSbxVar->SetFlag(SbxFlagBits::Fixed);
 243                         }
 244                     }
 245                 }
 246             }
 247             if ( xSbxParams.is() )
 248                 m_xMethod->SetParameters( xSbxParams.get() );
 249
 250             // call method
 251             SbxVariableRef xReturn = new SbxVariable;
 252             ErrCode nErr = ERRCODE_NONE;
 253
 254             // if it's a document-based script, temporarily reset ThisComponent to the script invocation context
 255             Any aOldThisComponent;
 256             if ( m_documentBasicManager && m_xDocumentScriptContext.is() )
 257                 m_documentBasicManager->SetGlobalUNOConstant( "ThisComponent", Any( m_xDocumentScriptContext ), &aOldThisComponent );
 258
 259             if ( m_caller.hasElements() && m_caller[ 0 ].hasValue()  )
 260             {
 261                 SbxVariableRef xCallerVar = new SbxVariable( SbxVARIANT );
 262                 unoToSbxValue( xCallerVar.get(), m_caller[ 0 ] );
 263                 nErr = m_xMethod->Call( xReturn.get(), xCallerVar.get() );
 264             }
 265             else
 266                 nErr = m_xMethod->Call( xReturn.get() );
 267
 268             if ( m_documentBasicManager && m_xDocumentScriptContext.is() )
 269                 m_documentBasicManager->SetGlobalUNOConstant( "ThisComponent", aOldThisComponent );
 270
 271             if ( nErr != ERRCODE_NONE )
 272             {
 273                 // TODO: throw InvocationTargetException ?
 274             }
 275
 276             // get output parameters
 277             if ( xSbxParams.is() )
 278             {
 279                 SbxInfo* pInfo_ = m_xMethod->GetInfo();
 280                 if ( pInfo_ )
 281                 {
 282                     OutParamMap aOutParamMap;
 283                     for (sal_uInt32 n = 1, nCount = xSbxParams->Count(); n < nCount; ++n)
 284                     {
 285                         assert(nCount <= std::numeric_limits<sal_uInt16>::max());
 286                         const SbxParamInfo* pParamInfo = pInfo_->GetParam( sal::static_int_cast<sal_uInt16>(n) );
 287                         if ( pParamInfo && ( pParamInfo->eType & SbxBYREF ) != 0 )
 288                         {
 289                             SbxVariable* pVar = xSbxParams->Get(n);
 290                             if ( pVar )
 291                             {
 292                                 SbxVariableRef xVar = pVar;
 293                                 aOutParamMap.emplace( n - 1, sbxToUnoValue( xVar.get() ) );
 294                             }
 295                         }
 296                     }
 297                     sal_Int32 nOutParamCount = aOutParamMap.size();
 298                     aOutParamIndex.realloc( nOutParamCount );
 299                     aOutParam.realloc( nOutParamCount );
 300                     sal_Int16* pOutParamIndex = aOutParamIndex.getArray();
 301                     Any* pOutParam = aOutParam.getArray();
 302                     for ( const auto& rEntry : aOutParamMap )
 303                     {
 304                         *pOutParamIndex = rEntry.first;
 305                         ++pOutParamIndex;
 306                         *pOutParam = rEntry.second;
 307                         ++pOutParam;
 308                     }
 309                 }
 310             }
 311
 312             // get return value
 313             aReturn = sbxToUnoValue( xReturn.get() );
 314
 315             // reset parameters
 316             m_xMethod->SetParameters( nullptr );
 317         }
 318
 319         return aReturn;
 320     }
 321
 322
 323 }   // namespace basprov
 324
 325
 326 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */