diff options
author | David Tardon <dtardon@redhat.com> | 2013-04-19 18:54:16 +0200 |
---|---|---|
committer | David Tardon <dtardon@redhat.com> | 2013-04-24 05:17:10 +0000 |
commit | 6c7659b584ea7ed3652ca4eb9a2297f36310c365 (patch) | |
tree | adf631e2d3db309b0696babd9d026bce0996c215 /include/cppuhelper/weak.hxx | |
parent | 24500d6798007d84521eb24a81c121ebe69d3bfd (diff) |
move URE headers to include/
Change-Id: Ib48a12e902f2311c295b2007f08f44dee28f431d
Reviewed-on: https://gerrit.libreoffice.org/3499
Reviewed-by: David Tardon <dtardon@redhat.com>
Tested-by: David Tardon <dtardon@redhat.com>
Diffstat (limited to 'include/cppuhelper/weak.hxx')
-rw-r--r-- | include/cppuhelper/weak.hxx | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/include/cppuhelper/weak.hxx b/include/cppuhelper/weak.hxx new file mode 100644 index 000000000000..80d5ec07c500 --- /dev/null +++ b/include/cppuhelper/weak.hxx @@ -0,0 +1,164 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef _CPPUHELPER_WEAK_HXX_ +#define _CPPUHELPER_WEAK_HXX_ + +#include <osl/interlck.h> +#include <rtl/alloc.h> +#include <cppuhelper/weakref.hxx> +#include <cppuhelper/queryinterface.hxx> +#include <com/sun/star/uno/XWeak.hpp> +#include "cppuhelperdllapi.h" + + +namespace cppu +{ + +class OWeakConnectionPoint; + +/** Base class to implement an UNO object supporting weak references, i.e. the object can be held + weakly (by a ::com::sun::star::uno::WeakReference). + This implementation copes with reference counting. Upon last release(), the virtual dtor + is called. + + @derive + Inherit from this class and delegate acquire()/ release() calls. +*/ +class CPPUHELPER_DLLPUBLIC OWeakObject : public ::com::sun::star::uno::XWeak +{ + friend class OWeakConnectionPoint; + +protected: + /** Virtual dtor. + + @attention + Despite the fact that a RuntimeException is allowed to be thrown, you must not throw any + exception upon destruction! + */ + virtual ~OWeakObject() SAL_THROW( (::com::sun::star::uno::RuntimeException) ); + + /** disposes and resets m_pWeakConnectionPoint + @pre + m_refCount equals 0 + */ + void disposeWeakConnectionPoint(); + + /** reference count. + + @attention + Don't modify manually! Use acquire() and release(). + */ + oslInterlockedCount m_refCount; + + /// @cond INTERNAL + + /** Container of all weak reference listeners and the connection point from the weak reference. + */ + OWeakConnectionPoint * m_pWeakConnectionPoint; + + /** reserved for future use. do not use. + */ + void * m_pReserved; + + /// @endcond + +public: + /// @cond INTERNAL + // these are here to force memory de/allocation to sal lib. + inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW(()) + { return ::rtl_allocateMemory( nSize ); } + inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW(()) + { ::rtl_freeMemory( pMem ); } + inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW(()) + { return pMem; } + inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW(()) + {} + /// @endcond + +#ifdef _MSC_VER + /** Default Constructor. Sets the reference count to zero. + Accidentally occurs in msvc mapfile = > had to be outlined. + */ + OWeakObject() SAL_THROW(()); +#else + /** Default Constructor. Sets the reference count to zero. + */ + inline OWeakObject() SAL_THROW(()) + : m_refCount( 0 ) + , m_pWeakConnectionPoint( 0 ) + {} +#endif + /** Dummy copy constructor. Set the reference count to zero. + + @param rObj dummy param + */ + inline OWeakObject( const OWeakObject & rObj ) SAL_THROW(()) + : com::sun::star::uno::XWeak() + , m_refCount( 0 ) + , m_pWeakConnectionPoint( 0 ) + { + (void) rObj; + } + /** Dummy assignment operator. Does not affect reference count. + + @return this OWeakObject + */ + inline OWeakObject & SAL_CALL operator = ( const OWeakObject &) + SAL_THROW(()) + { return *this; } + + /** Basic queryInterface() implementation supporting \::com::sun::star::uno::XWeak and + \::com::sun::star::uno::XInterface. + + @param rType demanded type + @return demanded type or empty any + */ + virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( + const ::com::sun::star::uno::Type & rType ) + throw (::com::sun::star::uno::RuntimeException); + /** increasing m_refCount + */ + virtual void SAL_CALL acquire() + throw (); + /** decreasing m_refCount + */ + virtual void SAL_CALL release() + throw (); + + /** XWeak::queryAdapter() implementation + + @return a \::com::sun::star::uno::XAdapter reference + */ + virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XAdapter > SAL_CALL queryAdapter() + throw (::com::sun::star::uno::RuntimeException); + + /** Cast operator to XInterface reference. + + @return XInterface reference + */ + inline SAL_CALL operator ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > () SAL_THROW(()) + { return this; } +}; + +} + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |