scripting/source/basprov/basmethnode.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 "basmethnode.hxx"
  21 #include <com/sun/star/beans/PropertyAttribute.hpp>
  22 #include <com/sun/star/frame/DispatchHelper.hpp>
  23 #include <com/sun/star/frame/Desktop.hpp>
  24 #include <com/sun/star/frame/XDispatchProvider.hpp>
  25 #include <com/sun/star/lang/XMultiComponentFactory.hpp>
  26 #include <com/sun/star/script/browse/BrowseNodeTypes.hpp>
  27 #include <osl/mutex.hxx>
  28 #include <vcl/svapp.hxx>
  29 #include <basic/sbstar.hxx>
  30 #include <basic/sbmeth.hxx>
  31 #include <basic/sbmod.hxx>
  32
  33 #include <util/MiscUtils.hxx>
  34
  35 using namespace ::com::sun::star;
  36 using namespace ::com::sun::star::lang;
  37 using namespace ::com::sun::star::uno;
  38 using namespace ::com::sun::star::beans;
  39 using namespace ::comphelper;
  40 using namespace ::com::sun::star::script;
  41 using namespace ::sf_misc;
  42
  43 #define BASPROV_PROPERTY_ID_URI         1
  44 #define BASPROV_PROPERTY_ID_EDITABLE    2
  45
  46 #define BASPROV_PROPERTY_URI            OUString( "URI"  )
  47 #define BASPROV_PROPERTY_EDITABLE       "Editable"
  48
  49 #define BASPROV_DEFAULT_ATTRIBS()       PropertyAttribute::BOUND | PropertyAttribute::TRANSIENT | PropertyAttribute::READONLY
  50
  51
  52
  53 namespace basprov
  54 {
  55
  56
  57
  58     // BasicMethodNodeImpl
  59
  60
  61     BasicMethodNodeImpl::BasicMethodNodeImpl( const Reference< XComponentContext >& rxContext,
  62         const OUString& sScriptingContext, SbMethod* pMethod, bool isAppScript )
  63         : ::scripting_helper::OBroadcastHelperHolder( m_aMutex )
  64         ,OPropertyContainer( GetBroadcastHelper() )
  65         ,m_xContext( rxContext )
  66         ,m_sScriptingContext( sScriptingContext )
  67         ,m_pMethod( pMethod )
  68         ,m_bIsAppScript( isAppScript )
  69         ,m_bEditable( true )
  70     {
  71         if ( m_pMethod )
  72         {
  73             SbModule* pModule = m_pMethod->GetModule();
  74             if ( pModule )
  75             {
  76                 StarBASIC* pBasic = static_cast< StarBASIC* >( pModule->GetParent() );
  77                 if ( pBasic )
  78                 {
  79                     m_sURI = "vnd.sun.star.script:";
  80                     m_sURI += pBasic->GetName();
  81                     m_sURI += ".";
  82                     m_sURI += pModule->GetName();
  83                     m_sURI += ".";
  84                     m_sURI += m_pMethod->GetName();
  85                     m_sURI += "?language=Basic&location=";
  86                     if ( m_bIsAppScript )
  87                         m_sURI += "application";
  88                     else
  89                         m_sURI += "document";
  90                 }
  91             }
  92         }
  93
  94         registerProperty( BASPROV_PROPERTY_URI,      BASPROV_PROPERTY_ID_URI,      BASPROV_DEFAULT_ATTRIBS(), &m_sURI,      cppu::UnoType<decltype(m_sURI)>::get() );
  95         registerProperty( BASPROV_PROPERTY_EDITABLE, BASPROV_PROPERTY_ID_EDITABLE, BASPROV_DEFAULT_ATTRIBS(), &m_bEditable, cppu::UnoType<decltype(m_bEditable)>::get() );
  96     }
  97
  98
  99
 100     BasicMethodNodeImpl::~BasicMethodNodeImpl()
 101     {
 102     }
 103
 104
 105     // XInterface
 106
 107
 108     IMPLEMENT_FORWARD_XINTERFACE2( BasicMethodNodeImpl, BasicMethodNodeImpl_BASE, OPropertyContainer )
 109
 110
 111     // XTypeProvider
 112
 113
 114     IMPLEMENT_FORWARD_XTYPEPROVIDER2( BasicMethodNodeImpl, BasicMethodNodeImpl_BASE, OPropertyContainer )
 115
 116
 117     // XBrowseNode
 118
 119
 120     OUString BasicMethodNodeImpl::getName(  ) throw (RuntimeException, std::exception)
 121     {
 122         SolarMutexGuard aGuard;
 123
 124         OUString sMethodName;
 125         if ( m_pMethod )
 126             sMethodName = m_pMethod->GetName();
 127
 128         return sMethodName;
 129     }
 130
 131
 132
 133     Sequence< Reference< browse::XBrowseNode > > BasicMethodNodeImpl::getChildNodes(  ) throw (RuntimeException, std::exception)
 134     {
 135         SolarMutexGuard aGuard;
 136
 137         return Sequence< Reference< browse::XBrowseNode > >();
 138     }
 139
 140
 141
 142     sal_Bool BasicMethodNodeImpl::hasChildNodes(  ) throw (RuntimeException, std::exception)
 143     {
 144         SolarMutexGuard aGuard;
 145
 146         return sal_False;
 147     }
 148
 149
 150
 151     sal_Int16 BasicMethodNodeImpl::getType(  ) throw (RuntimeException, std::exception)
 152     {
 153         SolarMutexGuard aGuard;
 154
 155         return browse::BrowseNodeTypes::SCRIPT;
 156     }
 157
 158
 159     // OPropertySetHelper
 160
 161
 162     ::cppu::IPropertyArrayHelper& BasicMethodNodeImpl::getInfoHelper(  )
 163     {
 164         return *getArrayHelper();
 165     }
 166
 167
 168     // OPropertyArrayUsageHelper
 169
 170
 171     ::cppu::IPropertyArrayHelper* BasicMethodNodeImpl::createArrayHelper(  ) const
 172     {
 173         Sequence< Property > aProps;
 174         describeProperties( aProps );
 175         return new ::cppu::OPropertyArrayHelper( aProps );
 176     }
 177
 178
 179     // XPropertySet
 180
 181
 182     Reference< XPropertySetInfo > BasicMethodNodeImpl::getPropertySetInfo(  ) throw (RuntimeException, std::exception)
 183     {
 184         Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 185         return xInfo;
 186     }
 187
 188
 189     // XInvocation
 190
 191
 192     Reference< XIntrospectionAccess > BasicMethodNodeImpl::getIntrospection(  ) throw (RuntimeException, std::exception)
 193     {
 194         return Reference< XIntrospectionAccess >();
 195     }
 196
 197
 198
 199     Any BasicMethodNodeImpl::invoke( const OUString& aFunctionName, const Sequence< Any >& aParams,
 200         Sequence< sal_Int16 >& aOutParamIndex, Sequence< Any >& aOutParam )
 201         throw (IllegalArgumentException, script::CannotConvertException,
 202                reflection::InvocationTargetException, RuntimeException, std::exception)
 203     {
 204         (void)aParams;
 205         (void)aOutParamIndex;
 206         (void)aOutParam;
 207
 208         if ( aFunctionName == BASPROV_PROPERTY_EDITABLE )
 209         {
 210             OUString sDocURL, sLibName, sModName;
 211             sal_uInt16 nLine1 = 0, nLine2;
 212
 213             if ( !m_bIsAppScript )
 214             {
 215                 Reference< frame::XModel > xModel = MiscUtils::tDocUrlToModel( m_sScriptingContext );
 216
 217                 if ( xModel.is() )
 218                 {
 219                     sDocURL = xModel->getURL();
 220                     if ( sDocURL.isEmpty() )
 221                     {
 222                         Sequence < PropertyValue > aProps = xModel->getArgs();
 223                         sal_Int32 nProps = aProps.getLength();
 224                         const PropertyValue* pProps = aProps.getConstArray();
 225                         for ( sal_Int32 i = 0; i < nProps; ++i )
 226                         {
 227                             // TODO: according to MBA the property 'Title' may change in future
 228                             if ( pProps[i].Name == "Title" )
 229                             {
 230                                 pProps[i].Value >>= sDocURL;
 231                                 break;
 232                             }
 233                         }
 234                     }
 235                 }
 236             }
 237
 238             if ( m_pMethod )
 239             {
 240                 m_pMethod->GetLineRange( nLine1, nLine2 );
 241                 SbModule* pModule = m_pMethod->GetModule();
 242                 if ( pModule )
 243                 {
 244                     sModName = pModule->GetName();
 245                     StarBASIC* pBasic = static_cast< StarBASIC* >( pModule->GetParent() );
 246                     if ( pBasic )
 247                         sLibName = pBasic->GetName();
 248                 }
 249             }
 250
 251             if ( m_xContext.is() )
 252             {
 253                 Reference< frame::XDesktop2 > xDesktop = frame::Desktop::create( m_xContext );
 254
 255                 Reference < frame::XDispatchProvider > xProv( xDesktop->getCurrentFrame(), UNO_QUERY );
 256
 257                 if ( xProv.is() )
 258                 {
 259                     Reference< frame::XDispatchHelper > xHelper( frame::DispatchHelper::create( m_xContext ) );
 260
 261                     Sequence < PropertyValue > aArgs(7);
 262                     aArgs[0].Name = "Document";
 263                     aArgs[0].Value <<= sDocURL;
 264                     aArgs[1].Name = "LibName";
 265                     aArgs[1].Value <<= sLibName;
 266                     aArgs[2].Name = "Name";
 267                     aArgs[2].Value <<= sModName;
 268                     aArgs[3].Name = "Type";
 269                     aArgs[3].Value <<= OUString("Module");
 270                     aArgs[4].Name = "Line";
 271                     aArgs[4].Value <<= static_cast< sal_uInt32 >( nLine1 );
 272                     xHelper->executeDispatch( xProv, OUString(".uno:BasicIDEAppear"), OUString(), 0, aArgs );
 273                 }
 274             }
 275         }
 276         else
 277         {
 278             throw IllegalArgumentException(
 279                 "BasicMethodNodeImpl::invoke: function name not supported!",
 280                 Reference< XInterface >(), 1 );
 281         }
 282
 283         return Any();
 284     }
 285
 286
 287
 288     void BasicMethodNodeImpl::setValue( const OUString& aPropertyName, const Any& aValue )
 289         throw (UnknownPropertyException, script::CannotConvertException,
 290                reflection::InvocationTargetException, RuntimeException, std::exception)
 291     {
 292         (void)aPropertyName;
 293         (void)aValue;
 294
 295         throw UnknownPropertyException(
 296             "BasicMethodNodeImpl::setValue: property name is unknown!" );
 297     }
 298
 299
 300
 301     Any BasicMethodNodeImpl::getValue( const OUString& aPropertyName ) throw (UnknownPropertyException, RuntimeException, std::exception)
 302     {
 303         (void)aPropertyName;
 304
 305         throw UnknownPropertyException(
 306             "BasicMethodNodeImpl::getValue: property name is unknown!" );
 307     }
 308
 309
 310
 311     sal_Bool BasicMethodNodeImpl::hasMethod( const OUString& aName ) throw (RuntimeException, std::exception)
 312     {
 313         bool bReturn = false;
 314         if ( aName == BASPROV_PROPERTY_EDITABLE )
 315             bReturn = true;
 316
 317         return bReturn;
 318     }
 319
 320
 321
 322     sal_Bool BasicMethodNodeImpl::hasProperty( const OUString& aName ) throw (RuntimeException, std::exception)
 323     {
 324         (void)aName;
 325
 326         return sal_False;
 327     }
 328
 329
 330
 331
 332 }   // namespace basprov
 333
 334
 335 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */