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