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