| File: | home/maarten/src/libreoffice/core/include/rtl/ref.hxx |
| Warning: | line 113, column 13 Use of memory after it is freed |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
| 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 | ||||
| 21 | #include <awt/animatedimagespeer.hxx> | |||
| 22 | #include <toolkit/helper/property.hxx> | |||
| 23 | ||||
| 24 | #include <com/sun/star/awt/XAnimatedImages.hpp> | |||
| 25 | #include <com/sun/star/awt/Size.hpp> | |||
| 26 | #include <com/sun/star/graphic/GraphicProvider.hpp> | |||
| 27 | #include <com/sun/star/graphic/XGraphicProvider.hpp> | |||
| 28 | #include <com/sun/star/beans/XPropertySet.hpp> | |||
| 29 | #include <com/sun/star/graphic/XGraphic.hpp> | |||
| 30 | #include <com/sun/star/awt/ImageScaleMode.hpp> | |||
| 31 | ||||
| 32 | #include <comphelper/namedvaluecollection.hxx> | |||
| 33 | #include <comphelper/processfactory.hxx> | |||
| 34 | #include <o3tl/safeint.hxx> | |||
| 35 | #include <rtl/ustrbuf.hxx> | |||
| 36 | #include <tools/diagnose_ex.h> | |||
| 37 | #include <tools/urlobj.hxx> | |||
| 38 | #include <vcl/toolkit/throbber.hxx> | |||
| 39 | #include <vcl/svapp.hxx> | |||
| 40 | #include <vcl/settings.hxx> | |||
| 41 | ||||
| 42 | #include <limits> | |||
| 43 | #include <string_view> | |||
| 44 | ||||
| 45 | namespace toolkit | |||
| 46 | { | |||
| 47 | ||||
| 48 | ||||
| 49 | using ::com::sun::star::uno::XComponentContext; | |||
| 50 | using ::com::sun::star::uno::Reference; | |||
| 51 | using ::com::sun::star::uno::XInterface; | |||
| 52 | using ::com::sun::star::uno::UNO_QUERY_THROW; | |||
| 53 | using ::com::sun::star::uno::Exception; | |||
| 54 | using ::com::sun::star::uno::Any; | |||
| 55 | using ::com::sun::star::uno::Sequence; | |||
| 56 | using ::com::sun::star::lang::EventObject; | |||
| 57 | using ::com::sun::star::container::ContainerEvent; | |||
| 58 | using ::com::sun::star::awt::XAnimatedImages; | |||
| 59 | using ::com::sun::star::awt::Size; | |||
| 60 | using ::com::sun::star::graphic::XGraphicProvider; | |||
| 61 | using ::com::sun::star::beans::XPropertySet; | |||
| 62 | using ::com::sun::star::graphic::XGraphic; | |||
| 63 | ||||
| 64 | namespace ImageScaleMode = ::com::sun::star::awt::ImageScaleMode; | |||
| 65 | ||||
| 66 | ||||
| 67 | //= AnimatedImagesPeer_Data | |||
| 68 | ||||
| 69 | namespace { | |||
| 70 | ||||
| 71 | struct CachedImage | |||
| 72 | { | |||
| 73 | OUString sImageURL; | |||
| 74 | mutable Reference< XGraphic > xGraphic; | |||
| 75 | ||||
| 76 | CachedImage() | |||
| 77 | :sImageURL() | |||
| 78 | ,xGraphic() | |||
| 79 | { | |||
| 80 | } | |||
| 81 | ||||
| 82 | explicit CachedImage( OUString const& i_imageURL ) | |||
| 83 | :sImageURL( i_imageURL ) | |||
| 84 | ,xGraphic() | |||
| 85 | { | |||
| 86 | } | |||
| 87 | }; | |||
| 88 | ||||
| 89 | } | |||
| 90 | ||||
| 91 | struct AnimatedImagesPeer_Data | |||
| 92 | { | |||
| 93 | AnimatedImagesPeer& rAntiImpl; | |||
| 94 | ::std::vector< ::std::vector< CachedImage > > aCachedImageSets; | |||
| 95 | ||||
| 96 | explicit AnimatedImagesPeer_Data( AnimatedImagesPeer& i_antiImpl ) | |||
| 97 | :rAntiImpl( i_antiImpl ) | |||
| 98 | ,aCachedImageSets() | |||
| 99 | { | |||
| 100 | } | |||
| 101 | }; | |||
| 102 | ||||
| 103 | ||||
| 104 | //= helper | |||
| 105 | ||||
| 106 | namespace | |||
| 107 | { | |||
| 108 | ||||
| 109 | OUString lcl_getHighContrastURL( OUString const& i_imageURL ) | |||
| 110 | { | |||
| 111 | INetURLObject aURL( i_imageURL ); | |||
| 112 | if ( aURL.GetProtocol() != INetProtocol::PrivSoffice ) | |||
| 113 | { | |||
| 114 | OSL_VERIFY( aURL.insertName( "sifr", false, 0 ) )do { if (!(aURL.insertName( "sifr", false, 0 ))) do { if (true && (!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "114" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 115 | return aURL.GetMainURL( INetURLObject::DecodeMechanism::NONE ); | |||
| 116 | } | |||
| 117 | // the private: scheme is not considered to be hierarchical by INetURLObject, so manually insert the | |||
| 118 | // segment | |||
| 119 | const sal_Int32 separatorPos = i_imageURL.indexOf( '/' ); | |||
| 120 | ENSURE_OR_RETURN( separatorPos != -1, "lcl_getHighContrastURL: unsupported URL scheme - cannot automatically determine HC version!", i_imageURL )if( !(separatorPos != -1) ) { do { if (true && (!(separatorPos != -1))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "120" ": "), "%s", "lcl_getHighContrastURL: unsupported URL scheme - cannot automatically determine HC version!" ); } } while (false); return i_imageURL; }; | |||
| 121 | ||||
| 122 | OUStringBuffer composer; | |||
| 123 | composer.append( std::u16string_view(i_imageURL).substr(0, separatorPos) ); | |||
| 124 | composer.append( "/sifr" ); | |||
| 125 | composer.append( std::u16string_view(i_imageURL).substr(separatorPos) ); | |||
| 126 | return composer.makeStringAndClear(); | |||
| 127 | } | |||
| 128 | ||||
| 129 | ||||
| 130 | bool lcl_ensureImage_throw( Reference< XGraphicProvider > const& i_graphicProvider, const bool i_isHighContrast, const CachedImage& i_cachedImage ) | |||
| 131 | { | |||
| 132 | if ( !i_cachedImage.xGraphic.is() ) | |||
| 133 | { | |||
| 134 | ::comphelper::NamedValueCollection aMediaProperties; | |||
| 135 | if ( i_isHighContrast ) | |||
| 136 | { | |||
| 137 | // try (to find) the high-contrast version of the graphic first | |||
| 138 | aMediaProperties.put( "URL", lcl_getHighContrastURL( i_cachedImage.sImageURL ) ); | |||
| 139 | i_cachedImage.xGraphic = i_graphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ); | |||
| 140 | } | |||
| 141 | if ( !i_cachedImage.xGraphic.is() ) | |||
| 142 | { | |||
| 143 | aMediaProperties.put( "URL", i_cachedImage.sImageURL ); | |||
| 144 | i_cachedImage.xGraphic = i_graphicProvider->queryGraphic( aMediaProperties.getPropertyValues() ); | |||
| 145 | } | |||
| 146 | } | |||
| 147 | return i_cachedImage.xGraphic.is(); | |||
| 148 | } | |||
| 149 | ||||
| 150 | ||||
| 151 | Size lcl_getGraphicSizePixel( Reference< XGraphic > const& i_graphic ) | |||
| 152 | { | |||
| 153 | Size aSizePixel; | |||
| 154 | try | |||
| 155 | { | |||
| 156 | if ( i_graphic.is() ) | |||
| 157 | { | |||
| 158 | const Reference< XPropertySet > xGraphicProps( i_graphic, UNO_QUERY_THROW ); | |||
| 159 | OSL_VERIFY( xGraphicProps->getPropertyValue("SizePixel") >>= aSizePixel )do { if (!(xGraphicProps->getPropertyValue("SizePixel") >>= aSizePixel)) do { if (true && (!(0))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "159" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 160 | } | |||
| 161 | } | |||
| 162 | catch( const Exception& ) | |||
| 163 | { | |||
| 164 | DBG_UNHANDLED_EXCEPTION("toolkit")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "164" ": ", "toolkit" );; | |||
| 165 | } | |||
| 166 | return aSizePixel; | |||
| 167 | } | |||
| 168 | ||||
| 169 | ||||
| 170 | void lcl_init( Sequence< OUString > const& i_imageURLs, ::std::vector< CachedImage >& o_images ) | |||
| 171 | { | |||
| 172 | o_images.resize(0); | |||
| 173 | size_t count = size_t( i_imageURLs.getLength() ); | |||
| 174 | o_images.reserve( count ); | |||
| 175 | for ( const auto& rImageURL : i_imageURLs ) | |||
| 176 | { | |||
| 177 | o_images.emplace_back( rImageURL ); | |||
| 178 | } | |||
| 179 | } | |||
| 180 | ||||
| 181 | ||||
| 182 | void lcl_updateImageList_nothrow( AnimatedImagesPeer_Data& i_data ) | |||
| 183 | { | |||
| 184 | VclPtr<Throbber> pThrobber = i_data.rAntiImpl.GetAsDynamic<Throbber>(); | |||
| 185 | if ( !pThrobber ) | |||
| 186 | return; | |||
| 187 | ||||
| 188 | try | |||
| 189 | { | |||
| 190 | // collect the image sizes of the different image sets | |||
| 191 | const Reference< XComponentContext > xContext( ::comphelper::getProcessComponentContext() ); | |||
| 192 | const Reference< XGraphicProvider > xGraphicProvider( css::graphic::GraphicProvider::create(xContext) ); | |||
| 193 | ||||
| 194 | const bool isHighContrast = pThrobber->GetSettings().GetStyleSettings().GetHighContrastMode(); | |||
| 195 | ||||
| 196 | sal_Int32 nPreferredSet = -1; | |||
| 197 | const size_t nImageSetCount = i_data.aCachedImageSets.size(); | |||
| 198 | if ( nImageSetCount < 2 ) | |||
| 199 | { | |||
| 200 | nPreferredSet = sal_Int32( nImageSetCount ) - 1; | |||
| 201 | } | |||
| 202 | else | |||
| 203 | { | |||
| 204 | ::std::vector< Size > aImageSizes( nImageSetCount ); | |||
| 205 | for ( size_t nImageSet = 0; nImageSet < nImageSetCount; ++nImageSet ) | |||
| 206 | { | |||
| 207 | ::std::vector< CachedImage > const& rImageSet( i_data.aCachedImageSets[ nImageSet ] ); | |||
| 208 | if ( ( rImageSet.empty() ) | |||
| 209 | || ( !lcl_ensureImage_throw( xGraphicProvider, isHighContrast, rImageSet[0] ) ) | |||
| 210 | ) | |||
| 211 | { | |||
| 212 | aImageSizes[ nImageSet ] = Size( SAL_MAX_INT32((sal_Int32) 0x7FFFFFFF), SAL_MAX_INT32((sal_Int32) 0x7FFFFFFF) ); | |||
| 213 | } | |||
| 214 | else | |||
| 215 | { | |||
| 216 | aImageSizes[ nImageSet ] = lcl_getGraphicSizePixel( rImageSet[0].xGraphic ); | |||
| 217 | } | |||
| 218 | } | |||
| 219 | ||||
| 220 | // find the set with the smallest difference between window size and image size | |||
| 221 | const ::Size aWindowSizePixel = pThrobber->GetSizePixel(); | |||
| 222 | long nMinimalDistance = ::std::numeric_limits< long >::max(); | |||
| 223 | for ( ::std::vector< Size >::const_iterator check = aImageSizes.begin(); | |||
| 224 | check != aImageSizes.end(); | |||
| 225 | ++check | |||
| 226 | ) | |||
| 227 | { | |||
| 228 | if ( ( check->Width > aWindowSizePixel.Width() ) | |||
| 229 | || ( check->Height > aWindowSizePixel.Height() ) | |||
| 230 | ) | |||
| 231 | // do not use an image set which doesn't fit into the window | |||
| 232 | continue; | |||
| 233 | ||||
| 234 | const sal_Int64 distance = | |||
| 235 | ( aWindowSizePixel.Width() - check->Width ) * ( aWindowSizePixel.Width() - check->Width ) | |||
| 236 | + ( aWindowSizePixel.Height() - check->Height ) * ( aWindowSizePixel.Height() - check->Height ); | |||
| 237 | if ( distance < nMinimalDistance ) | |||
| 238 | { | |||
| 239 | nMinimalDistance = distance; | |||
| 240 | nPreferredSet = check - aImageSizes.begin(); | |||
| 241 | } | |||
| 242 | } | |||
| 243 | } | |||
| 244 | ||||
| 245 | // found a set? | |||
| 246 | std::vector< Image > aImages; | |||
| 247 | if ( ( nPreferredSet >= 0 ) && ( o3tl::make_unsigned( nPreferredSet ) < nImageSetCount ) ) | |||
| 248 | { | |||
| 249 | // => set the images | |||
| 250 | ::std::vector< CachedImage > const& rImageSet( i_data.aCachedImageSets[ nPreferredSet ] ); | |||
| 251 | aImages.resize( rImageSet.size() ); | |||
| 252 | sal_Int32 imageIndex = 0; | |||
| 253 | for ( const auto& rCachedImage : rImageSet ) | |||
| 254 | { | |||
| 255 | lcl_ensureImage_throw( xGraphicProvider, isHighContrast, rCachedImage ); | |||
| 256 | aImages[ imageIndex++ ] = Image(rCachedImage.xGraphic); | |||
| 257 | } | |||
| 258 | } | |||
| 259 | pThrobber->setImageList( aImages ); | |||
| 260 | } | |||
| 261 | catch( const Exception& ) | |||
| 262 | { | |||
| 263 | DBG_UNHANDLED_EXCEPTION("toolkit")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "263" ": ", "toolkit" );; | |||
| 264 | } | |||
| 265 | } | |||
| 266 | ||||
| 267 | ||||
| 268 | void lcl_updateImageList_nothrow( AnimatedImagesPeer_Data& i_data, const Reference< XAnimatedImages >& i_images ) | |||
| 269 | { | |||
| 270 | try | |||
| 271 | { | |||
| 272 | const sal_Int32 nImageSetCount = i_images->getImageSetCount(); | |||
| 273 | i_data.aCachedImageSets.resize(0); | |||
| 274 | for ( sal_Int32 set = 0; set < nImageSetCount; ++set ) | |||
| 275 | { | |||
| 276 | const Sequence< OUString > aImageURLs( i_images->getImageSet( set ) ); | |||
| 277 | ::std::vector< CachedImage > aImages; | |||
| 278 | lcl_init( aImageURLs, aImages ); | |||
| 279 | i_data.aCachedImageSets.push_back( aImages ); | |||
| 280 | } | |||
| 281 | ||||
| 282 | lcl_updateImageList_nothrow( i_data ); | |||
| 283 | } | |||
| 284 | catch( const Exception& ) | |||
| 285 | { | |||
| 286 | DBG_UNHANDLED_EXCEPTION("toolkit")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "286" ": ", "toolkit" );; | |||
| 287 | } | |||
| 288 | } | |||
| 289 | } | |||
| 290 | ||||
| 291 | ||||
| 292 | //= AnimatedImagesPeer | |||
| 293 | ||||
| 294 | ||||
| 295 | AnimatedImagesPeer::AnimatedImagesPeer() | |||
| 296 | :AnimatedImagesPeer_Base() | |||
| 297 | ,m_xData( new AnimatedImagesPeer_Data( *this ) ) | |||
| 298 | { | |||
| 299 | } | |||
| 300 | ||||
| 301 | ||||
| 302 | AnimatedImagesPeer::~AnimatedImagesPeer() | |||
| 303 | { | |||
| 304 | } | |||
| 305 | ||||
| 306 | ||||
| 307 | void SAL_CALL AnimatedImagesPeer::startAnimation() | |||
| 308 | { | |||
| 309 | SolarMutexGuard aGuard; | |||
| 310 | VclPtr<Throbber> pThrobber = GetAsDynamic<Throbber>(); | |||
| 311 | if (pThrobber) | |||
| 312 | pThrobber->start(); | |||
| 313 | } | |||
| 314 | ||||
| 315 | void SAL_CALL AnimatedImagesPeer::stopAnimation() | |||
| 316 | { | |||
| 317 | SolarMutexGuard aGuard; | |||
| 318 | VclPtr<Throbber> pThrobber = GetAsDynamic<Throbber>(); | |||
| 319 | if (pThrobber) | |||
| 320 | pThrobber->stop(); | |||
| 321 | } | |||
| 322 | ||||
| 323 | sal_Bool SAL_CALL AnimatedImagesPeer::isAnimationRunning() | |||
| 324 | { | |||
| 325 | SolarMutexGuard aGuard; | |||
| 326 | VclPtr<Throbber> pThrobber = GetAsDynamic<Throbber>(); | |||
| 327 | if (pThrobber) | |||
| 328 | return pThrobber->isRunning(); | |||
| 329 | return false; | |||
| 330 | } | |||
| 331 | ||||
| 332 | void SAL_CALL AnimatedImagesPeer::setProperty( const OUString& i_propertyName, const Any& i_value ) | |||
| 333 | { | |||
| 334 | SolarMutexGuard aGuard; | |||
| 335 | ||||
| 336 | VclPtr<Throbber> pThrobber = GetAsDynamic<Throbber>(); | |||
| 337 | if ( pThrobber ) | |||
| 338 | { | |||
| 339 | VCLXWindow::setProperty( i_propertyName, i_value ); | |||
| 340 | return; | |||
| 341 | } | |||
| 342 | ||||
| 343 | const sal_uInt16 nPropertyId = GetPropertyId( i_propertyName ); | |||
| 344 | switch ( nPropertyId ) | |||
| 345 | { | |||
| 346 | case BASEPROPERTY_STEP_TIME118: | |||
| 347 | { | |||
| 348 | sal_Int32 nStepTime( 0 ); | |||
| 349 | if ( i_value >>= nStepTime ) | |||
| 350 | pThrobber->setStepTime( nStepTime ); | |||
| 351 | break; | |||
| 352 | } | |||
| 353 | case BASEPROPERTY_AUTO_REPEAT157: | |||
| 354 | { | |||
| 355 | bool bRepeat( true ); | |||
| 356 | if ( i_value >>= bRepeat ) | |||
| 357 | pThrobber->setRepeat( bRepeat ); | |||
| 358 | break; | |||
| 359 | } | |||
| 360 | ||||
| 361 | case BASEPROPERTY_IMAGE_SCALE_MODE137: | |||
| 362 | { | |||
| 363 | sal_Int16 nScaleMode( ImageScaleMode::ANISOTROPIC ); | |||
| 364 | VclPtr<ImageControl> pImageControl = GetAsDynamic< ImageControl >(); | |||
| 365 | if ( pImageControl && ( i_value >>= nScaleMode ) ) | |||
| 366 | pImageControl->SetScaleMode( nScaleMode ); | |||
| 367 | } | |||
| 368 | break; | |||
| 369 | ||||
| 370 | default: | |||
| 371 | AnimatedImagesPeer_Base::setProperty( i_propertyName, i_value ); | |||
| 372 | break; | |||
| 373 | } | |||
| 374 | } | |||
| 375 | ||||
| 376 | ||||
| 377 | Any SAL_CALL AnimatedImagesPeer::getProperty( const OUString& i_propertyName ) | |||
| 378 | { | |||
| 379 | SolarMutexGuard aGuard; | |||
| 380 | ||||
| 381 | Any aReturn; | |||
| 382 | ||||
| 383 | VclPtr<Throbber> pThrobber = GetAsDynamic<Throbber>(); | |||
| ||||
| 384 | if ( !pThrobber ) | |||
| 385 | return VCLXWindow::getProperty( i_propertyName ); | |||
| 386 | ||||
| 387 | const sal_uInt16 nPropertyId = GetPropertyId( i_propertyName ); | |||
| 388 | switch ( nPropertyId ) | |||
| 389 | { | |||
| 390 | case BASEPROPERTY_STEP_TIME118: | |||
| 391 | aReturn <<= pThrobber->getStepTime(); | |||
| 392 | break; | |||
| 393 | ||||
| 394 | case BASEPROPERTY_AUTO_REPEAT157: | |||
| 395 | aReturn <<= pThrobber->getRepeat(); | |||
| 396 | break; | |||
| 397 | ||||
| 398 | case BASEPROPERTY_IMAGE_SCALE_MODE137: | |||
| 399 | { | |||
| 400 | VclPtr<ImageControl> pImageControl = GetAsDynamic<ImageControl>(); | |||
| 401 | aReturn <<= ( pImageControl ? pImageControl->GetScaleMode() : ImageScaleMode::ANISOTROPIC ); | |||
| 402 | } | |||
| 403 | break; | |||
| 404 | ||||
| 405 | default: | |||
| 406 | aReturn = AnimatedImagesPeer_Base::getProperty( i_propertyName ); | |||
| 407 | break; | |||
| 408 | } | |||
| 409 | ||||
| 410 | return aReturn; | |||
| 411 | } | |||
| 412 | ||||
| 413 | ||||
| 414 | void AnimatedImagesPeer::ProcessWindowEvent( const VclWindowEvent& i_windowEvent ) | |||
| 415 | { | |||
| 416 | if ( i_windowEvent.GetId() == VclEventId::WindowResize ) | |||
| 417 | { | |||
| 418 | lcl_updateImageList_nothrow( *m_xData ); | |||
| 419 | } | |||
| 420 | ||||
| 421 | AnimatedImagesPeer_Base::ProcessWindowEvent( i_windowEvent ); | |||
| 422 | } | |||
| 423 | ||||
| 424 | ||||
| 425 | void AnimatedImagesPeer::impl_updateImages_nolck( const Reference< XInterface >& i_animatedImages ) | |||
| 426 | { | |||
| 427 | SolarMutexGuard aGuard; | |||
| 428 | ||||
| 429 | lcl_updateImageList_nothrow( *m_xData, Reference< XAnimatedImages >( i_animatedImages, UNO_QUERY_THROW ) ); | |||
| 430 | } | |||
| 431 | ||||
| 432 | ||||
| 433 | void SAL_CALL AnimatedImagesPeer::elementInserted( const ContainerEvent& i_event ) | |||
| 434 | { | |||
| 435 | SolarMutexGuard aGuard; | |||
| 436 | Reference< XAnimatedImages > xAnimatedImages( i_event.Source, UNO_QUERY_THROW ); | |||
| 437 | ||||
| 438 | sal_Int32 nPosition(0); | |||
| 439 | OSL_VERIFY( i_event.Accessor >>= nPosition )do { if (!(i_event.Accessor >>= nPosition)) do { if (true && (!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "439" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 440 | size_t position = size_t( nPosition ); | |||
| 441 | if ( position > m_xData->aCachedImageSets.size() ) | |||
| 442 | { | |||
| 443 | OSL_ENSURE( false, "AnimatedImagesPeer::elementInserted: illegal accessor/index!" )do { if (true && (!(false))) { sal_detail_logFormat(( SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "443" ": "), "%s", "AnimatedImagesPeer::elementInserted: illegal accessor/index!" ); } } while (false); | |||
| 444 | lcl_updateImageList_nothrow( *m_xData, xAnimatedImages ); | |||
| 445 | } | |||
| 446 | ||||
| 447 | Sequence< OUString > aImageURLs; | |||
| 448 | OSL_VERIFY( i_event.Element >>= aImageURLs )do { if (!(i_event.Element >>= aImageURLs)) do { if (true && (!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "448" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 449 | ::std::vector< CachedImage > aImages; | |||
| 450 | lcl_init( aImageURLs, aImages ); | |||
| 451 | m_xData->aCachedImageSets.insert( m_xData->aCachedImageSets.begin() + position, aImages ); | |||
| 452 | lcl_updateImageList_nothrow( *m_xData ); | |||
| 453 | } | |||
| 454 | ||||
| 455 | ||||
| 456 | void SAL_CALL AnimatedImagesPeer::elementRemoved( const ContainerEvent& i_event ) | |||
| 457 | { | |||
| 458 | SolarMutexGuard aGuard; | |||
| 459 | Reference< XAnimatedImages > xAnimatedImages( i_event.Source, UNO_QUERY_THROW ); | |||
| 460 | ||||
| 461 | sal_Int32 nPosition(0); | |||
| 462 | OSL_VERIFY( i_event.Accessor >>= nPosition )do { if (!(i_event.Accessor >>= nPosition)) do { if (true && (!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "462" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 463 | size_t position = size_t( nPosition ); | |||
| 464 | if ( position >= m_xData->aCachedImageSets.size() ) | |||
| 465 | { | |||
| 466 | OSL_ENSURE( false, "AnimatedImagesPeer::elementRemoved: illegal accessor/index!" )do { if (true && (!(false))) { sal_detail_logFormat(( SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "466" ": "), "%s", "AnimatedImagesPeer::elementRemoved: illegal accessor/index!" ); } } while (false); | |||
| 467 | lcl_updateImageList_nothrow( *m_xData, xAnimatedImages ); | |||
| 468 | } | |||
| 469 | ||||
| 470 | m_xData->aCachedImageSets.erase( m_xData->aCachedImageSets.begin() + position ); | |||
| 471 | lcl_updateImageList_nothrow( *m_xData ); | |||
| 472 | } | |||
| 473 | ||||
| 474 | ||||
| 475 | void SAL_CALL AnimatedImagesPeer::elementReplaced( const ContainerEvent& i_event ) | |||
| 476 | { | |||
| 477 | SolarMutexGuard aGuard; | |||
| 478 | Reference< XAnimatedImages > xAnimatedImages( i_event.Source, UNO_QUERY_THROW ); | |||
| 479 | ||||
| 480 | sal_Int32 nPosition(0); | |||
| 481 | OSL_VERIFY( i_event.Accessor >>= nPosition )do { if (!(i_event.Accessor >>= nPosition)) do { if (true && (!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "481" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 482 | size_t position = size_t( nPosition ); | |||
| 483 | if ( position >= m_xData->aCachedImageSets.size() ) | |||
| 484 | { | |||
| 485 | OSL_ENSURE( false, "AnimatedImagesPeer::elementReplaced: illegal accessor/index!" )do { if (true && (!(false))) { sal_detail_logFormat(( SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "485" ": "), "%s", "AnimatedImagesPeer::elementReplaced: illegal accessor/index!" ); } } while (false); | |||
| 486 | lcl_updateImageList_nothrow( *m_xData, xAnimatedImages ); | |||
| 487 | } | |||
| 488 | ||||
| 489 | Sequence< OUString > aImageURLs; | |||
| 490 | OSL_VERIFY( i_event.Element >>= aImageURLs )do { if (!(i_event.Element >>= aImageURLs)) do { if (true && (!(0))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/toolkit/source/awt/animatedimagespeer.cxx" ":" "490" ": "), "OSL_ASSERT: %s", "0"); } } while (false); } while (0); | |||
| 491 | ::std::vector< CachedImage > aImages; | |||
| 492 | lcl_init( aImageURLs, aImages ); | |||
| 493 | m_xData->aCachedImageSets[ position ] = aImages; | |||
| 494 | lcl_updateImageList_nothrow( *m_xData ); | |||
| 495 | } | |||
| 496 | ||||
| 497 | ||||
| 498 | void SAL_CALL AnimatedImagesPeer::disposing( const EventObject& i_event ) | |||
| 499 | { | |||
| 500 | VCLXWindow::disposing( i_event ); | |||
| 501 | } | |||
| 502 | ||||
| 503 | ||||
| 504 | void SAL_CALL AnimatedImagesPeer::modified( const EventObject& i_event ) | |||
| 505 | { | |||
| 506 | impl_updateImages_nolck( i_event.Source ); | |||
| 507 | } | |||
| 508 | ||||
| 509 | ||||
| 510 | void SAL_CALL AnimatedImagesPeer::dispose( ) | |||
| 511 | { | |||
| 512 | AnimatedImagesPeer_Base::dispose(); | |||
| 513 | SolarMutexGuard aGuard; | |||
| 514 | m_xData->aCachedImageSets.resize(0); | |||
| 515 | } | |||
| 516 | ||||
| 517 | ||||
| 518 | } // namespace toolkit | |||
| 519 | ||||
| 520 | ||||
| 521 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX |
| 21 | #define INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX |
| 22 | |
| 23 | #include <toolkit/dllapi.h> |
| 24 | #include <toolkit/awt/vclxdevice.hxx> |
| 25 | #include <vcl/window.hxx> |
| 26 | |
| 27 | #include <com/sun/star/awt/XWindow2.hpp> |
| 28 | #include <com/sun/star/awt/XVclWindowPeer.hpp> |
| 29 | #include <com/sun/star/awt/XLayoutConstrains.hpp> |
| 30 | #include <com/sun/star/awt/XView.hpp> |
| 31 | #include <com/sun/star/beans/XPropertySetInfo.hpp> |
| 32 | #include <com/sun/star/accessibility/XAccessible.hpp> |
| 33 | #include <com/sun/star/awt/XDockableWindow.hpp> |
| 34 | #include <com/sun/star/awt/XStyleSettingsSupplier.hpp> |
| 35 | |
| 36 | #include <comphelper/servicehelper.hxx> |
| 37 | #include <cppuhelper/implbase.hxx> |
| 38 | |
| 39 | #include <tools/gen.hxx> |
| 40 | #include <tools/link.hxx> |
| 41 | |
| 42 | #include <memory> |
| 43 | #include <vector> |
| 44 | #include <functional> |
| 45 | |
| 46 | namespace comphelper { class OInterfaceContainerHelper2; } |
| 47 | namespace com::sun::star::accessibility { class XAccessibleContext; } |
| 48 | |
| 49 | class VclWindowEvent; |
| 50 | |
| 51 | namespace toolkit |
| 52 | { |
| 53 | class IAccessibleFactory; |
| 54 | } |
| 55 | |
| 56 | |
| 57 | class UnoPropertyArrayHelper; |
| 58 | class VCLXWindowImpl; |
| 59 | typedef cppu::ImplInheritanceHelper< VCLXDevice, |
| 60 | css::awt::XWindow2, |
| 61 | css::awt::XVclWindowPeer, |
| 62 | css::awt::XLayoutConstrains, |
| 63 | css::awt::XView, |
| 64 | css::awt::XDockableWindow, |
| 65 | css::accessibility::XAccessible, |
| 66 | css::lang::XEventListener, |
| 67 | css::beans::XPropertySetInfo, |
| 68 | css::awt::XStyleSettingsSupplier |
| 69 | > VCLXWindow_Base; |
| 70 | |
| 71 | class TOOLKIT_DLLPUBLIC__attribute__ ((visibility("default"))) VCLXWindow : public VCLXWindow_Base |
| 72 | { |
| 73 | private: |
| 74 | std::unique_ptr<VCLXWindowImpl> mpImpl; |
| 75 | |
| 76 | UnoPropertyArrayHelper *GetPropHelper(); |
| 77 | |
| 78 | protected: |
| 79 | Size ImplCalcWindowSize( const Size& rOutSz ) const; |
| 80 | DECL_LINK(WindowEventListener, VclWindowEvent&, void )static void LinkStubWindowEventListener(void *, VclWindowEvent &); void WindowEventListener(VclWindowEvent&); |
| 81 | |
| 82 | virtual void ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent ); |
| 83 | virtual css::uno::Reference< css::accessibility::XAccessibleContext > |
| 84 | CreateAccessibleContext(); |
| 85 | |
| 86 | void SetSynthesizingVCLEvent( bool b ); |
| 87 | bool IsSynthesizingVCLEvent() const; |
| 88 | |
| 89 | void SetSystemParent_Impl( const css::uno::Any& rHandle ); |
| 90 | |
| 91 | ::toolkit::IAccessibleFactory& getAccessibleFactory(); |
| 92 | |
| 93 | // helper ... |
| 94 | static void PushPropertyIds( std::vector< sal_uInt16 > &aIds, int nFirstId, ...); |
| 95 | // for use in controls/ |
| 96 | static void ImplGetPropertyIds( std::vector< sal_uInt16 > &aIds, |
| 97 | bool bWithDefaults = false ); |
| 98 | virtual void GetPropertyIds( std::vector< sal_uInt16 > &aIds ); |
| 99 | |
| 100 | ::comphelper::OInterfaceContainerHelper2& GetContainerListeners(); |
| 101 | ::comphelper::OInterfaceContainerHelper2& GetTopWindowListeners(); |
| 102 | |
| 103 | public: |
| 104 | typedef ::std::function<void ()> Callback; |
| 105 | |
| 106 | protected: |
| 107 | /** executes the given callback asynchronously |
| 108 | |
| 109 | At the moment the callback is called, the Solar Mutex is not locked. In particular, this implies that |
| 110 | you cannot rely on |this| not being disposed. However, you *can* rely on |this| being still alive (i.e. |
| 111 | having a ref count > 0). |
| 112 | |
| 113 | As a consequence, this can be used for doing listener notifications, using event multiplexers. Those multiplexers |
| 114 | care for the disposed state themself, and are alive as long as |this| is alive. |
| 115 | */ |
| 116 | void ImplExecuteAsyncWithoutSolarLock( |
| 117 | const Callback& i_callback |
| 118 | ); |
| 119 | |
| 120 | public: |
| 121 | VCLXWindow( bool bWithDefaultProps = false ); |
| 122 | virtual ~VCLXWindow() override; |
| 123 | |
| 124 | virtual void SetWindow( const VclPtr< vcl::Window > &pWindow ); |
| 125 | template< class derived_type > VclPtr< derived_type > GetAs() const { |
| 126 | return VclPtr< derived_type >( static_cast< derived_type * >( GetOutputDevice().get() ) ); } |
| 127 | template< class derived_type > VclPtr< derived_type > GetAsDynamic() const { |
| 128 | return VclPtr< derived_type >( dynamic_cast< derived_type * >( GetOutputDevice().get() ) ); } |
| 129 | VclPtr<vcl::Window> GetWindow() const { return GetAs<vcl::Window>(); } |
| 130 | |
| 131 | void suspendVclEventListening( ); |
| 132 | void resumeVclEventListening( ); |
| 133 | |
| 134 | void notifyWindowRemoved( vcl::Window const & _rWindow ); |
| 135 | |
| 136 | // css::lang::XUnoTunnel |
| 137 | UNO3_GETIMPLEMENTATION_DECL(VCLXWindow)static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId () throw(); virtual sal_Int64 getSomething( const css::uno::Sequence < sal_Int8 >& aIdentifier ) override; |
| 138 | |
| 139 | // css::lang::XEventListener |
| 140 | virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override; |
| 141 | |
| 142 | // css::lang::XComponent |
| 143 | void SAL_CALL dispose( ) override; |
| 144 | void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override; |
| 145 | void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override; |
| 146 | |
| 147 | // css::awt::XWindow |
| 148 | void SAL_CALL setPosSize( sal_Int32 X, sal_Int32 Y, sal_Int32 Width, sal_Int32 Height, sal_Int16 Flags ) override; |
| 149 | css::awt::Rectangle SAL_CALL getPosSize( ) override; |
| 150 | void SAL_CALL setVisible( sal_Bool Visible ) override; |
| 151 | void SAL_CALL setEnable( sal_Bool Enable ) override; |
| 152 | void SAL_CALL setFocus( ) override; |
| 153 | void SAL_CALL addWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override; |
| 154 | void SAL_CALL removeWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override; |
| 155 | void SAL_CALL addFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override; |
| 156 | void SAL_CALL removeFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override; |
| 157 | void SAL_CALL addKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override; |
| 158 | void SAL_CALL removeKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override; |
| 159 | void SAL_CALL addMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override; |
| 160 | void SAL_CALL removeMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override; |
| 161 | void SAL_CALL addMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override; |
| 162 | void SAL_CALL removeMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override; |
| 163 | void SAL_CALL addPaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override; |
| 164 | void SAL_CALL removePaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override; |
| 165 | |
| 166 | // css::awt::XWindowPeer |
| 167 | css::uno::Reference< css::awt::XToolkit > SAL_CALL getToolkit( ) override; |
| 168 | void SAL_CALL setPointer( const css::uno::Reference< css::awt::XPointer >& Pointer ) override; |
| 169 | void SAL_CALL setBackground( sal_Int32 Color ) override; |
| 170 | void SAL_CALL invalidate( sal_Int16 Flags ) override; |
| 171 | void SAL_CALL invalidateRect( const css::awt::Rectangle& Rect, sal_Int16 Flags ) override; |
| 172 | |
| 173 | // css::awt::XVclWindowPeer |
| 174 | sal_Bool SAL_CALL isChild( const css::uno::Reference< css::awt::XWindowPeer >& Peer ) override; |
| 175 | void SAL_CALL setDesignMode( sal_Bool bOn ) override; |
| 176 | sal_Bool SAL_CALL isDesignMode( ) override; |
| 177 | void SAL_CALL enableClipSiblings( sal_Bool bClip ) override; |
| 178 | void SAL_CALL setForeground( sal_Int32 Color ) override; |
| 179 | void SAL_CALL setControlFont( const css::awt::FontDescriptor& aFont ) override; |
| 180 | void SAL_CALL getStyles( sal_Int16 nType, css::awt::FontDescriptor& Font, sal_Int32& ForegroundColor, sal_Int32& BackgroundColor ) override; |
| 181 | void SAL_CALL setProperty( const OUString& PropertyName, const css::uno::Any& Value ) override; |
| 182 | css::uno::Any SAL_CALL getProperty( const OUString& PropertyName ) override; |
| 183 | |
| 184 | // css::awt::XLayoutConstrains |
| 185 | css::awt::Size SAL_CALL getMinimumSize( ) override; |
| 186 | css::awt::Size SAL_CALL getPreferredSize( ) override; |
| 187 | css::awt::Size SAL_CALL calcAdjustedSize( const css::awt::Size& aNewSize ) override; |
| 188 | |
| 189 | // css::awt::XView |
| 190 | sal_Bool SAL_CALL setGraphics( const css::uno::Reference< css::awt::XGraphics >& aDevice ) override; |
| 191 | css::uno::Reference< css::awt::XGraphics > SAL_CALL getGraphics( ) override; |
| 192 | css::awt::Size SAL_CALL getSize( ) override; |
| 193 | void SAL_CALL draw( sal_Int32 nX, sal_Int32 nY ) override; |
| 194 | void SAL_CALL setZoom( float fZoomX, float fZoomY ) override; |
| 195 | |
| 196 | // css::accessibility::XAccessible |
| 197 | css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) override; |
| 198 | |
| 199 | // css::awt::XDockableWindow |
| 200 | void SAL_CALL addDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override; |
| 201 | void SAL_CALL removeDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override; |
| 202 | void SAL_CALL enableDocking( sal_Bool bEnable ) override; |
| 203 | sal_Bool SAL_CALL isFloating( ) override; |
| 204 | void SAL_CALL setFloatingMode( sal_Bool bFloating ) override; |
| 205 | void SAL_CALL lock( ) override; |
| 206 | void SAL_CALL unlock( ) override; |
| 207 | sal_Bool SAL_CALL isLocked( ) override; |
| 208 | void SAL_CALL startPopupMode( const css::awt::Rectangle& WindowRect ) override; |
| 209 | sal_Bool SAL_CALL isInPopupMode( ) override; |
| 210 | |
| 211 | // css::awt::XWindow2 |
| 212 | void SAL_CALL setOutputSize( const css::awt::Size& aSize ) override; |
| 213 | css::awt::Size SAL_CALL getOutputSize( ) override; |
| 214 | sal_Bool SAL_CALL isVisible( ) override; |
| 215 | sal_Bool SAL_CALL isActive( ) override; |
| 216 | sal_Bool SAL_CALL isEnabled( ) override; |
| 217 | sal_Bool SAL_CALL hasFocus( ) override; |
| 218 | |
| 219 | // css::beans::XPropertySetInfo |
| 220 | css::uno::Sequence< css::beans::Property > SAL_CALL getProperties( ) override; |
| 221 | css::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) override; |
| 222 | sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) override; |
| 223 | |
| 224 | // XStyleSettingsSupplier |
| 225 | virtual css::uno::Reference< css::awt::XStyleSettings > SAL_CALL getStyleSettings() override; |
| 226 | }; |
| 227 | |
| 228 | #endif // INCLUDED_TOOLKIT_AWT_VCLXWINDOW_HXX |
| 229 | |
| 230 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_VCL_PTR_HXX |
| 21 | #define INCLUDED_VCL_PTR_HXX |
| 22 | |
| 23 | #include <sal/config.h> |
| 24 | |
| 25 | #include <rtl/ref.hxx> |
| 26 | |
| 27 | #include <utility> |
| 28 | #include <type_traits> |
| 29 | |
| 30 | #ifdef DBG_UTIL |
| 31 | #ifndef _WIN32 |
| 32 | #include <vcl/vclmain.hxx> |
| 33 | #endif |
| 34 | #endif |
| 35 | |
| 36 | class VclReferenceBase; |
| 37 | |
| 38 | namespace vcl::detail { |
| 39 | |
| 40 | template<typename> |
| 41 | constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; } |
| 42 | |
| 43 | template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase( |
| 44 | int (*)[sizeof(T)]) |
| 45 | { return std::is_base_of<VclReferenceBase, T>::value; } |
| 46 | |
| 47 | } // namespace vcl::detail |
| 48 | |
| 49 | /** |
| 50 | * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses. |
| 51 | * |
| 52 | * For more details on the design please see vcl/README.lifecycle |
| 53 | * |
| 54 | * @param reference_type must be a subclass of vcl::Window |
| 55 | */ |
| 56 | template <class reference_type> |
| 57 | class VclPtr |
| 58 | { |
| 59 | static_assert( |
| 60 | vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>( |
| 61 | nullptr), |
| 62 | "template argument type must be derived from VclReferenceBase"); |
| 63 | |
| 64 | ::rtl::Reference<reference_type> m_rInnerRef; |
| 65 | |
| 66 | public: |
| 67 | /** Constructor... |
| 68 | */ |
| 69 | VclPtr() |
| 70 | : m_rInnerRef() |
| 71 | {} |
| 72 | |
| 73 | /** Constructor... |
| 74 | */ |
| 75 | VclPtr (reference_type * pBody) |
| 76 | : m_rInnerRef(pBody) |
| 77 | {} |
| 78 | |
| 79 | /** Constructor... that doesn't take a ref. |
| 80 | */ |
| 81 | VclPtr (reference_type * pBody, __sal_NoAcquire) |
| 82 | : m_rInnerRef(pBody, SAL_NO_ACQUIRE) |
| 83 | {} |
| 84 | |
| 85 | /** Up-casting conversion constructor: Copies interface reference. |
| 86 | |
| 87 | Does not work for up-casts to ambiguous bases. For the special case of |
| 88 | up-casting to Reference< XInterface >, see the corresponding conversion |
| 89 | operator. |
| 90 | |
| 91 | @param rRef another reference |
| 92 | */ |
| 93 | template< class derived_type > |
| 94 | VclPtr( |
| 95 | const VclPtr< derived_type > & rRef, |
| 96 | typename std::enable_if< |
| 97 | std::is_base_of<reference_type, derived_type>::value, int>::type |
| 98 | = 0 ) |
| 99 | : m_rInnerRef( static_cast<reference_type*>(rRef) ) |
| 100 | { |
| 101 | } |
| 102 | |
| 103 | #if defined(DBG_UTIL) && !defined(_WIN32) |
| 104 | virtual ~VclPtr() |
| 105 | { |
| 106 | assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain ::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 106, __extension__ __PRETTY_FUNCTION__)); |
| 107 | // We can be one of the intermediate counts, but if we are the last |
| 108 | // VclPtr keeping this object alive, then something forgot to call dispose(). |
| 109 | assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef ->isDisposed() || m_rInnerRef->getRefCount() > 1) && "someone forgot to call dispose()") ? void (0) : __assert_fail ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\"" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 110, __extension__ __PRETTY_FUNCTION__)) |
| 110 | && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef ->isDisposed() || m_rInnerRef->getRefCount() > 1) && "someone forgot to call dispose()") ? void (0) : __assert_fail ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\"" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 110, __extension__ __PRETTY_FUNCTION__)); |
| 111 | } |
| 112 | VclPtr(VclPtr const &) = default; |
| 113 | VclPtr(VclPtr &&) = default; |
| 114 | VclPtr & operator =(VclPtr const &) = default; |
| 115 | VclPtr & operator =(VclPtr &&) = default; |
| 116 | #endif |
| 117 | |
| 118 | /** |
| 119 | * A construction helper for VclPtr. Since VclPtr types are created |
| 120 | * with a reference-count of one - to help fit into the existing |
| 121 | * code-flow; this helps us to construct them easily. |
| 122 | * |
| 123 | * For more details on the design please see vcl/README.lifecycle |
| 124 | * |
| 125 | * @tparam reference_type must be a subclass of vcl::Window |
| 126 | */ |
| 127 | template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg) |
| 128 | { |
| 129 | return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE ); |
| 130 | } |
| 131 | |
| 132 | /** Probably most common used: handle->someBodyOp(). |
| 133 | */ |
| 134 | reference_type * operator->() const |
| 135 | { |
| 136 | return m_rInnerRef.get(); |
| 137 | } |
| 138 | |
| 139 | /** Get the body. Can be used instead of operator->(). |
| 140 | I.e. handle->someBodyOp() and handle.get()->someBodyOp() |
| 141 | are the same. |
| 142 | */ |
| 143 | reference_type * get() const |
| 144 | { |
| 145 | return m_rInnerRef.get(); |
| 146 | } |
| 147 | |
| 148 | void set(reference_type *pBody) |
| 149 | { |
| 150 | m_rInnerRef.set(pBody); |
| 151 | } |
| 152 | |
| 153 | void reset(reference_type *pBody) |
| 154 | { |
| 155 | m_rInnerRef.set(pBody); |
| 156 | } |
| 157 | |
| 158 | /** Up-casting copy assignment operator. |
| 159 | |
| 160 | Does not work for up-casts to ambiguous bases. |
| 161 | |
| 162 | @param rRef another reference |
| 163 | */ |
| 164 | template<typename derived_type> |
| 165 | typename std::enable_if< |
| 166 | std::is_base_of<reference_type, derived_type>::value, |
| 167 | VclPtr &>::type |
| 168 | operator =(VclPtr<derived_type> const & rRef) |
| 169 | { |
| 170 | m_rInnerRef.set(rRef.get()); |
| 171 | return *this; |
| 172 | } |
| 173 | |
| 174 | VclPtr & operator =(reference_type * pBody) |
| 175 | { |
| 176 | m_rInnerRef.set(pBody); |
| 177 | return *this; |
| 178 | } |
| 179 | |
| 180 | operator reference_type * () const |
| 181 | { |
| 182 | return m_rInnerRef.get(); |
| 183 | } |
| 184 | |
| 185 | explicit operator bool () const |
| 186 | { |
| 187 | return m_rInnerRef.get() != nullptr; |
| 188 | } |
| 189 | |
| 190 | void clear() |
| 191 | { |
| 192 | m_rInnerRef.clear(); |
| 193 | } |
| 194 | |
| 195 | void reset() |
| 196 | { |
| 197 | m_rInnerRef.clear(); |
| 198 | } |
| 199 | |
| 200 | void disposeAndClear() |
| 201 | { |
| 202 | // hold it alive for the lifetime of this method |
| 203 | ::rtl::Reference<reference_type> aTmp(m_rInnerRef); |
| 204 | m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-) |
| 205 | if (aTmp.get()) { |
| 206 | aTmp->disposeOnce(); |
| 207 | } |
| 208 | } |
| 209 | |
| 210 | /** Needed to place VclPtr's into STL collection. |
| 211 | */ |
| 212 | bool operator< (const VclPtr<reference_type> & handle) const |
| 213 | { |
| 214 | return (m_rInnerRef < handle.m_rInnerRef); |
| 215 | } |
| 216 | }; // class VclPtr |
| 217 | |
| 218 | template<typename T1, typename T2> |
| 219 | inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
| 220 | return p1.get() == p2.get(); |
| 221 | } |
| 222 | |
| 223 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2) |
| 224 | { |
| 225 | return p1.get() == p2; |
| 226 | } |
| 227 | |
| 228 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) { |
| 229 | return p1.get() == p2; |
| 230 | } |
| 231 | |
| 232 | template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2) |
| 233 | { |
| 234 | return p1 == p2.get(); |
| 235 | } |
| 236 | |
| 237 | template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) { |
| 238 | return p1 == p2.get(); |
| 239 | } |
| 240 | |
| 241 | template<typename T1, typename T2> |
| 242 | inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
| 243 | return !(p1 == p2); |
| 244 | } |
| 245 | |
| 246 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2) |
| 247 | { |
| 248 | return !(p1 == p2); |
| 249 | } |
| 250 | |
| 251 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) { |
| 252 | return !(p1 == p2); |
| 253 | } |
| 254 | |
| 255 | template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2) |
| 256 | { |
| 257 | return !(p1 == p2); |
| 258 | } |
| 259 | |
| 260 | template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) { |
| 261 | return !(p1 == p2); |
| 262 | } |
| 263 | |
| 264 | /** |
| 265 | * A construction helper for a temporary VclPtr. Since VclPtr types |
| 266 | * are created with a reference-count of one - to help fit into |
| 267 | * the existing code-flow; this helps us to construct them easily. |
| 268 | * see also VclPtr::Create and ScopedVclPtr |
| 269 | * |
| 270 | * For more details on the design please see vcl/README.lifecycle |
| 271 | * |
| 272 | * @param reference_type must be a subclass of vcl::Window |
| 273 | */ |
| 274 | template <class reference_type> |
| 275 | class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type> |
| 276 | { |
| 277 | public: |
| 278 | template<typename... Arg> VclPtrInstance(Arg &&... arg) |
| 279 | : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE ) |
| 280 | { |
| 281 | } |
| 282 | |
| 283 | /** |
| 284 | * Override and disallow this, to prevent people accidentally calling it and actually |
| 285 | * getting VclPtr::Create and getting a naked VclPtr<> instance |
| 286 | */ |
| 287 | template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete; |
| 288 | }; |
| 289 | |
| 290 | template <class reference_type> |
| 291 | class ScopedVclPtr : public VclPtr<reference_type> |
| 292 | { |
| 293 | public: |
| 294 | /** Constructor... |
| 295 | */ |
| 296 | ScopedVclPtr() |
| 297 | : VclPtr<reference_type>() |
| 298 | {} |
| 299 | |
| 300 | /** Constructor |
| 301 | */ |
| 302 | ScopedVclPtr (reference_type * pBody) |
| 303 | : VclPtr<reference_type>(pBody) |
| 304 | {} |
| 305 | |
| 306 | /** Copy constructor... |
| 307 | */ |
| 308 | ScopedVclPtr (const VclPtr<reference_type> & handle) |
| 309 | : VclPtr<reference_type>(handle) |
| 310 | {} |
| 311 | |
| 312 | /** |
| 313 | Assignment that releases the last reference. |
| 314 | */ |
| 315 | void disposeAndReset(reference_type *pBody) |
| 316 | { |
| 317 | if (pBody != this->get()) { |
| 318 | VclPtr<reference_type>::disposeAndClear(); |
| 319 | VclPtr<reference_type>::set(pBody); |
| 320 | } |
| 321 | } |
| 322 | |
| 323 | /** |
| 324 | Assignment that releases the last reference. |
| 325 | */ |
| 326 | ScopedVclPtr<reference_type>& operator = (reference_type * pBody) |
| 327 | { |
| 328 | disposeAndReset(pBody); |
| 329 | return *this; |
| 330 | } |
| 331 | |
| 332 | /** Up-casting conversion constructor: Copies interface reference. |
| 333 | |
| 334 | Does not work for up-casts to ambiguous bases. For the special case of |
| 335 | up-casting to Reference< XInterface >, see the corresponding conversion |
| 336 | operator. |
| 337 | |
| 338 | @param rRef another reference |
| 339 | */ |
| 340 | template< class derived_type > |
| 341 | ScopedVclPtr( |
| 342 | const VclPtr< derived_type > & rRef, |
| 343 | typename std::enable_if< |
| 344 | std::is_base_of<reference_type, derived_type>::value, int>::type |
| 345 | = 0 ) |
| 346 | : VclPtr<reference_type>( rRef ) |
| 347 | { |
| 348 | } |
| 349 | |
| 350 | /** Up-casting assignment operator. |
| 351 | |
| 352 | Does not work for up-casts to ambiguous bases. |
| 353 | |
| 354 | @param rRef another VclPtr |
| 355 | */ |
| 356 | template<typename derived_type> |
| 357 | typename std::enable_if< |
| 358 | std::is_base_of<reference_type, derived_type>::value, |
| 359 | ScopedVclPtr &>::type |
| 360 | operator =(VclPtr<derived_type> const & rRef) |
| 361 | { |
| 362 | disposeAndReset(rRef.get()); |
| 363 | return *this; |
| 364 | } |
| 365 | |
| 366 | /** |
| 367 | * Override and disallow this, to prevent people accidentally calling it and actually |
| 368 | * getting VclPtr::Create and getting a naked VclPtr<> instance |
| 369 | */ |
| 370 | template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete; |
| 371 | |
| 372 | ~ScopedVclPtr() |
| 373 | { |
| 374 | VclPtr<reference_type>::disposeAndClear(); |
| 375 | assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get( ) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references |
| 376 | } |
| 377 | |
| 378 | private: |
| 379 | // Most likely we don't want this default copy-constructor. |
| 380 | ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete; |
| 381 | // And certainly we don't want a default assignment operator. |
| 382 | ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete; |
| 383 | // And disallow reset as that doesn't call disposeAndClear on the original reference |
| 384 | void reset() = delete; |
| 385 | void reset(reference_type *pBody) = delete; |
| 386 | |
| 387 | protected: |
| 388 | ScopedVclPtr (reference_type * pBody, __sal_NoAcquire) |
| 389 | : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE) |
| 390 | {} |
| 391 | }; |
| 392 | |
| 393 | /** |
| 394 | * A construction helper for ScopedVclPtr. Since VclPtr types are created |
| 395 | * with a reference-count of one - to help fit into the existing |
| 396 | * code-flow; this helps us to construct them easily. |
| 397 | * |
| 398 | * For more details on the design please see vcl/README.lifecycle |
| 399 | * |
| 400 | * @param reference_type must be a subclass of vcl::Window |
| 401 | */ |
| 402 | #if defined _MSC_VER |
| 403 | #pragma warning(push) |
| 404 | #pragma warning(disable: 4521) // " multiple copy constructors specified" |
| 405 | #endif |
| 406 | template <class reference_type> |
| 407 | class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type> |
| 408 | { |
| 409 | public: |
| 410 | template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg) |
| 411 | : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE ) |
| 412 | { |
| 413 | } |
| 414 | |
| 415 | /** |
| 416 | * Override and disallow this, to prevent people accidentally calling it and actually |
| 417 | * getting VclPtr::Create and getting a naked VclPtr<> instance |
| 418 | */ |
| 419 | template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete; |
| 420 | |
| 421 | private: |
| 422 | // Prevent the above perfect forwarding ctor from hijacking (accidental) |
| 423 | // attempts at ScopedVclPtrInstance copy construction (where the hijacking |
| 424 | // would typically lead to somewhat obscure error messages); both non-const |
| 425 | // and const variants are needed here, as the ScopedVclPtr base class has a |
| 426 | // const--variant copy ctor, so the implicitly declared copy ctor for |
| 427 | // ScopedVclPtrInstance would also be the const variant, so non-const copy |
| 428 | // construction attempts would be hijacked by the perfect forwarding ctor; |
| 429 | // but if we only declared a non-const variant here, the const variant would |
| 430 | // no longer be implicitly declared (as there would already be an explicitly |
| 431 | // declared copy ctor), so const copy construction attempts would then be |
| 432 | // hijacked by the perfect forwarding ctor: |
| 433 | ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete; |
| 434 | ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete; |
| 435 | }; |
| 436 | #if defined _MSC_VER |
| 437 | #pragma warning(pop) |
| 438 | #endif |
| 439 | |
| 440 | #endif // INCLUDED_VCL_PTR_HXX |
| 441 | |
| 442 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_RTL_REF_HXX | ||||||||||||||||||||
| 21 | #define INCLUDED_RTL_REF_HXX | ||||||||||||||||||||
| 22 | |||||||||||||||||||||
| 23 | #include "sal/config.h" | ||||||||||||||||||||
| 24 | |||||||||||||||||||||
| 25 | #include <cassert> | ||||||||||||||||||||
| 26 | #include <cstddef> | ||||||||||||||||||||
| 27 | #include <functional> | ||||||||||||||||||||
| 28 | #ifdef LIBO_INTERNAL_ONLY1 | ||||||||||||||||||||
| 29 | #include <type_traits> | ||||||||||||||||||||
| 30 | #endif | ||||||||||||||||||||
| 31 | |||||||||||||||||||||
| 32 | #include "sal/types.h" | ||||||||||||||||||||
| 33 | |||||||||||||||||||||
| 34 | namespace rtl | ||||||||||||||||||||
| 35 | { | ||||||||||||||||||||
| 36 | |||||||||||||||||||||
| 37 | /** Template reference class for reference type. | ||||||||||||||||||||
| 38 | */ | ||||||||||||||||||||
| 39 | template <class reference_type> | ||||||||||||||||||||
| 40 | class Reference | ||||||||||||||||||||
| 41 | { | ||||||||||||||||||||
| 42 | /** The <b>reference_type</b> body pointer. | ||||||||||||||||||||
| 43 | */ | ||||||||||||||||||||
| 44 | reference_type * m_pBody; | ||||||||||||||||||||
| 45 | |||||||||||||||||||||
| 46 | |||||||||||||||||||||
| 47 | public: | ||||||||||||||||||||
| 48 | /** Constructor... | ||||||||||||||||||||
| 49 | */ | ||||||||||||||||||||
| 50 | Reference() | ||||||||||||||||||||
| 51 | : m_pBody (NULL__null) | ||||||||||||||||||||
| 52 | {} | ||||||||||||||||||||
| 53 | |||||||||||||||||||||
| 54 | |||||||||||||||||||||
| 55 | /** Constructor... | ||||||||||||||||||||
| 56 | */ | ||||||||||||||||||||
| 57 | Reference (reference_type * pBody, __sal_NoAcquire) | ||||||||||||||||||||
| 58 | : m_pBody (pBody) | ||||||||||||||||||||
| 59 | { | ||||||||||||||||||||
| 60 | } | ||||||||||||||||||||
| 61 | |||||||||||||||||||||
| 62 | /** Constructor... | ||||||||||||||||||||
| 63 | */ | ||||||||||||||||||||
| 64 | Reference (reference_type * pBody) | ||||||||||||||||||||
| 65 | : m_pBody (pBody) | ||||||||||||||||||||
| 66 | { | ||||||||||||||||||||
| 67 | if (m_pBody) | ||||||||||||||||||||
| 68 | m_pBody->acquire(); | ||||||||||||||||||||
| 69 | } | ||||||||||||||||||||
| 70 | |||||||||||||||||||||
| 71 | /** Copy constructor... | ||||||||||||||||||||
| 72 | */ | ||||||||||||||||||||
| 73 | Reference (const Reference<reference_type> & handle) | ||||||||||||||||||||
| 74 | : m_pBody (handle.m_pBody) | ||||||||||||||||||||
| 75 | { | ||||||||||||||||||||
| 76 | if (m_pBody) | ||||||||||||||||||||
| 77 | m_pBody->acquire(); | ||||||||||||||||||||
| 78 | } | ||||||||||||||||||||
| 79 | |||||||||||||||||||||
| 80 | #ifdef LIBO_INTERNAL_ONLY1 | ||||||||||||||||||||
| 81 | /** Move constructor... | ||||||||||||||||||||
| 82 | */ | ||||||||||||||||||||
| 83 | Reference (Reference<reference_type> && handle) noexcept | ||||||||||||||||||||
| 84 | : m_pBody (handle.m_pBody) | ||||||||||||||||||||
| 85 | { | ||||||||||||||||||||
| 86 | handle.m_pBody = nullptr; | ||||||||||||||||||||
| 87 | } | ||||||||||||||||||||
| 88 | #endif | ||||||||||||||||||||
| 89 | |||||||||||||||||||||
| 90 | #if defined LIBO_INTERNAL_ONLY1 | ||||||||||||||||||||
| 91 | /** Up-casting conversion constructor: Copies interface reference. | ||||||||||||||||||||
| 92 | |||||||||||||||||||||
| 93 | Does not work for up-casts to ambiguous bases. | ||||||||||||||||||||
| 94 | |||||||||||||||||||||
| 95 | @param rRef another reference | ||||||||||||||||||||
| 96 | */ | ||||||||||||||||||||
| 97 | template< class derived_type > | ||||||||||||||||||||
| 98 | inline Reference( | ||||||||||||||||||||
| 99 | const Reference< derived_type > & rRef, | ||||||||||||||||||||
| 100 | std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 ) | ||||||||||||||||||||
| 101 | : m_pBody (rRef.get()) | ||||||||||||||||||||
| 102 | { | ||||||||||||||||||||
| 103 | if (m_pBody) | ||||||||||||||||||||
| 104 | m_pBody->acquire(); | ||||||||||||||||||||
| 105 | } | ||||||||||||||||||||
| 106 | #endif | ||||||||||||||||||||
| 107 | |||||||||||||||||||||
| 108 | /** Destructor... | ||||||||||||||||||||
| 109 | */ | ||||||||||||||||||||
| 110 | ~Reference() COVERITY_NOEXCEPT_FALSE | ||||||||||||||||||||
| 111 | { | ||||||||||||||||||||
| 112 | if (m_pBody
| ||||||||||||||||||||
| 113 | m_pBody->release(); | ||||||||||||||||||||
| |||||||||||||||||||||
| 114 | } | ||||||||||||||||||||
| 115 | |||||||||||||||||||||
| 116 | /** Set... | ||||||||||||||||||||
| 117 | Similar to assignment. | ||||||||||||||||||||
| 118 | */ | ||||||||||||||||||||
| 119 | Reference<reference_type> & | ||||||||||||||||||||
| 120 | SAL_CALL set (reference_type * pBody) | ||||||||||||||||||||
| 121 | { | ||||||||||||||||||||
| 122 | if (pBody) | ||||||||||||||||||||
| 123 | pBody->acquire(); | ||||||||||||||||||||
| 124 | reference_type * const pOld = m_pBody; | ||||||||||||||||||||
| 125 | m_pBody = pBody; | ||||||||||||||||||||
| 126 | if (pOld) | ||||||||||||||||||||
| 127 | pOld->release(); | ||||||||||||||||||||
| 128 | return *this; | ||||||||||||||||||||
| 129 | } | ||||||||||||||||||||
| 130 | |||||||||||||||||||||
| 131 | /** Assignment. | ||||||||||||||||||||
| 132 | Unbinds this instance from its body (if bound) and | ||||||||||||||||||||
| 133 | bind it to the body represented by the handle. | ||||||||||||||||||||
| 134 | */ | ||||||||||||||||||||
| 135 | Reference<reference_type> & | ||||||||||||||||||||
| 136 | SAL_CALL operator= (const Reference<reference_type> & handle) | ||||||||||||||||||||
| 137 | { | ||||||||||||||||||||
| 138 | return set( handle.m_pBody ); | ||||||||||||||||||||
| 139 | } | ||||||||||||||||||||
| 140 | |||||||||||||||||||||
| 141 | #ifdef LIBO_INTERNAL_ONLY1 | ||||||||||||||||||||
| 142 | /** Assignment. | ||||||||||||||||||||
| 143 | * Unbinds this instance from its body (if bound), | ||||||||||||||||||||
| 144 | * bind it to the body represented by the handle, and | ||||||||||||||||||||
| 145 | * set the body represented by the handle to nullptr. | ||||||||||||||||||||
| 146 | */ | ||||||||||||||||||||
| 147 | Reference<reference_type> & | ||||||||||||||||||||
| 148 | operator= (Reference<reference_type> && handle) | ||||||||||||||||||||
| 149 | { | ||||||||||||||||||||
| 150 | // self-movement guts ourself | ||||||||||||||||||||
| 151 | if (m_pBody) | ||||||||||||||||||||
| 152 | m_pBody->release(); | ||||||||||||||||||||
| 153 | m_pBody = handle.m_pBody; | ||||||||||||||||||||
| 154 | handle.m_pBody = nullptr; | ||||||||||||||||||||
| 155 | return *this; | ||||||||||||||||||||
| 156 | } | ||||||||||||||||||||
| 157 | #endif | ||||||||||||||||||||
| 158 | |||||||||||||||||||||
| 159 | /** Assignment... | ||||||||||||||||||||
| 160 | */ | ||||||||||||||||||||
| 161 | Reference<reference_type> & | ||||||||||||||||||||
| 162 | SAL_CALL operator= (reference_type * pBody) | ||||||||||||||||||||
| 163 | { | ||||||||||||||||||||
| 164 | return set( pBody ); | ||||||||||||||||||||
| 165 | } | ||||||||||||||||||||
| 166 | |||||||||||||||||||||
| 167 | /** Unbind the body from this handle. | ||||||||||||||||||||
| 168 | Note that for a handle representing a large body, | ||||||||||||||||||||
| 169 | "handle.clear().set(new body());" _might_ | ||||||||||||||||||||
| 170 | perform a little bit better than "handle.set(new body());", | ||||||||||||||||||||
| 171 | since in the second case two large objects exist in memory | ||||||||||||||||||||
| 172 | (the old body and the new body). | ||||||||||||||||||||
| 173 | */ | ||||||||||||||||||||
| 174 | Reference<reference_type> & SAL_CALL clear() | ||||||||||||||||||||
| 175 | { | ||||||||||||||||||||
| 176 | if (m_pBody) | ||||||||||||||||||||
| 177 | { | ||||||||||||||||||||
| 178 | reference_type * const pOld = m_pBody; | ||||||||||||||||||||
| 179 | m_pBody = NULL__null; | ||||||||||||||||||||
| 180 | pOld->release(); | ||||||||||||||||||||
| 181 | } | ||||||||||||||||||||
| 182 | return *this; | ||||||||||||||||||||
| 183 | } | ||||||||||||||||||||
| 184 | |||||||||||||||||||||
| 185 | |||||||||||||||||||||
| 186 | /** Get the body. Can be used instead of operator->(). | ||||||||||||||||||||
| 187 | I.e. handle->someBodyOp() and handle.get()->someBodyOp() | ||||||||||||||||||||
| 188 | are the same. | ||||||||||||||||||||
| 189 | */ | ||||||||||||||||||||
| 190 | reference_type * SAL_CALL get() const | ||||||||||||||||||||
| 191 | { | ||||||||||||||||||||
| 192 | return m_pBody; | ||||||||||||||||||||
| 193 | } | ||||||||||||||||||||
| 194 | |||||||||||||||||||||
| 195 | |||||||||||||||||||||
| 196 | /** Probably most common used: handle->someBodyOp(). | ||||||||||||||||||||
| 197 | */ | ||||||||||||||||||||
| 198 | reference_type * SAL_CALL operator->() const | ||||||||||||||||||||
| 199 | { | ||||||||||||||||||||
| 200 | assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx" , 200, __extension__ __PRETTY_FUNCTION__)); | ||||||||||||||||||||
| 201 | return m_pBody; | ||||||||||||||||||||
| 202 | } | ||||||||||||||||||||
| 203 | |||||||||||||||||||||
| 204 | |||||||||||||||||||||
| 205 | /** Allows (*handle).someBodyOp(). | ||||||||||||||||||||
| 206 | */ | ||||||||||||||||||||
| 207 | reference_type & SAL_CALL operator*() const | ||||||||||||||||||||
| 208 | { | ||||||||||||||||||||
| 209 | assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx" , 209, __extension__ __PRETTY_FUNCTION__)); | ||||||||||||||||||||
| 210 | return *m_pBody; | ||||||||||||||||||||
| 211 | } | ||||||||||||||||||||
| 212 | |||||||||||||||||||||
| 213 | |||||||||||||||||||||
| 214 | /** Returns True if the handle does point to a valid body. | ||||||||||||||||||||
| 215 | */ | ||||||||||||||||||||
| 216 | bool SAL_CALL is() const | ||||||||||||||||||||
| 217 | { | ||||||||||||||||||||
| 218 | return (m_pBody != NULL__null); | ||||||||||||||||||||
| 219 | } | ||||||||||||||||||||
| 220 | |||||||||||||||||||||
| 221 | #if defined LIBO_INTERNAL_ONLY1 | ||||||||||||||||||||
| 222 | /** Returns True if the handle does point to a valid body. | ||||||||||||||||||||
| 223 | */ | ||||||||||||||||||||
| 224 | explicit operator bool() const | ||||||||||||||||||||
| 225 | { | ||||||||||||||||||||
| 226 | return is(); | ||||||||||||||||||||
| 227 | } | ||||||||||||||||||||
| 228 | #endif | ||||||||||||||||||||
| 229 | |||||||||||||||||||||
| 230 | /** Returns True if this points to pBody. | ||||||||||||||||||||
| 231 | */ | ||||||||||||||||||||
| 232 | bool SAL_CALL operator== (const reference_type * pBody) const | ||||||||||||||||||||
| 233 | { | ||||||||||||||||||||
| 234 | return (m_pBody == pBody); | ||||||||||||||||||||
| 235 | } | ||||||||||||||||||||
| 236 | |||||||||||||||||||||
| 237 | |||||||||||||||||||||
| 238 | /** Returns True if handle points to the same body. | ||||||||||||||||||||
| 239 | */ | ||||||||||||||||||||
| 240 | bool | ||||||||||||||||||||
| 241 | SAL_CALL operator== (const Reference<reference_type> & handle) const | ||||||||||||||||||||
| 242 | { | ||||||||||||||||||||
| 243 | return (m_pBody == handle.m_pBody); | ||||||||||||||||||||
| 244 | } | ||||||||||||||||||||
| 245 | |||||||||||||||||||||
| 246 | |||||||||||||||||||||
| 247 | /** Needed to place References into STL collection. | ||||||||||||||||||||
| 248 | */ | ||||||||||||||||||||
| 249 | bool | ||||||||||||||||||||
| 250 | SAL_CALL operator!= (const Reference<reference_type> & handle) const | ||||||||||||||||||||
| 251 | { | ||||||||||||||||||||
| 252 | return (m_pBody != handle.m_pBody); | ||||||||||||||||||||
| 253 | } | ||||||||||||||||||||
| 254 | |||||||||||||||||||||
| 255 | |||||||||||||||||||||
| 256 | /** Needed to place References into STL collection. | ||||||||||||||||||||
| 257 | */ | ||||||||||||||||||||
| 258 | bool | ||||||||||||||||||||
| 259 | SAL_CALL operator< (const Reference<reference_type> & handle) const | ||||||||||||||||||||
| 260 | { | ||||||||||||||||||||
| 261 | return (m_pBody < handle.m_pBody); | ||||||||||||||||||||
| 262 | } | ||||||||||||||||||||
| 263 | |||||||||||||||||||||
| 264 | |||||||||||||||||||||
| 265 | /** Needed to place References into STL collection. | ||||||||||||||||||||
| 266 | */ | ||||||||||||||||||||
| 267 | bool | ||||||||||||||||||||
| 268 | SAL_CALL operator> (const Reference<reference_type> & handle) const | ||||||||||||||||||||
| 269 | { | ||||||||||||||||||||
| 270 | return (m_pBody > handle.m_pBody); | ||||||||||||||||||||
| 271 | } | ||||||||||||||||||||
| 272 | }; | ||||||||||||||||||||
| 273 | |||||||||||||||||||||
| 274 | } // namespace rtl | ||||||||||||||||||||
| 275 | |||||||||||||||||||||
| 276 | #if defined LIBO_INTERNAL_ONLY1 | ||||||||||||||||||||
| 277 | namespace std | ||||||||||||||||||||
| 278 | { | ||||||||||||||||||||
| 279 | |||||||||||||||||||||
| 280 | /// @cond INTERNAL | ||||||||||||||||||||
| 281 | /** | ||||||||||||||||||||
| 282 | Make rtl::Reference hashable by default for use in STL containers. | ||||||||||||||||||||
| 283 | |||||||||||||||||||||
| 284 | @since LibreOffice 6.3 | ||||||||||||||||||||
| 285 | */ | ||||||||||||||||||||
| 286 | template<typename T> | ||||||||||||||||||||
| 287 | struct hash<::rtl::Reference<T>> | ||||||||||||||||||||
| 288 | { | ||||||||||||||||||||
| 289 | std::size_t operator()(::rtl::Reference<T> const & s) const | ||||||||||||||||||||
| 290 | { return std::size_t(s.get()); } | ||||||||||||||||||||
| 291 | }; | ||||||||||||||||||||
| 292 | /// @endcond | ||||||||||||||||||||
| 293 | |||||||||||||||||||||
| 294 | } | ||||||||||||||||||||
| 295 | |||||||||||||||||||||
| 296 | #endif | ||||||||||||||||||||
| 297 | |||||||||||||||||||||
| 298 | #endif /* ! INCLUDED_RTL_REF_HXX */ | ||||||||||||||||||||
| 299 | |||||||||||||||||||||
| 300 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_VCL_Reference_HXX |
| 20 | #define INCLUDED_VCL_Reference_HXX |
| 21 | |
| 22 | #include <vcl/dllapi.h> |
| 23 | #include <osl/interlck.h> |
| 24 | |
| 25 | class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase |
| 26 | { |
| 27 | mutable oslInterlockedCount mnRefCnt; |
| 28 | |
| 29 | template<typename T> friend class VclPtr; |
| 30 | |
| 31 | public: |
| 32 | void acquire() const |
| 33 | { |
| 34 | osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1); |
| 35 | } |
| 36 | |
| 37 | void release() const |
| 38 | { |
| 39 | if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0) |
| 40 | delete this; |
| 41 | } |
| 42 | #ifdef DBG_UTIL |
| 43 | #ifndef _WIN32 |
| 44 | sal_Int32 getRefCount() const { return mnRefCnt; } |
| 45 | #endif |
| 46 | #endif |
| 47 | |
| 48 | |
| 49 | private: |
| 50 | VclReferenceBase(const VclReferenceBase&) = delete; |
| 51 | VclReferenceBase& operator=(const VclReferenceBase&) = delete; |
| 52 | |
| 53 | bool mbDisposed : 1; |
| 54 | |
| 55 | protected: |
| 56 | VclReferenceBase(); |
| 57 | protected: |
| 58 | virtual ~VclReferenceBase(); |
| 59 | |
| 60 | protected: |
| 61 | virtual void dispose(); |
| 62 | |
| 63 | public: |
| 64 | void disposeOnce(); |
| 65 | bool isDisposed() const { return mbDisposed; } |
| 66 | |
| 67 | }; |
| 68 | #endif |