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