LibreOffice
LibreOffice 7.2 SDK C/C++ API Reference
weakref.hxx
Go to the documentation of this file.
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  * This file is part of LibreOffice published API.
22  */
23 #ifndef INCLUDED_CPPUHELPER_WEAKREF_HXX
24 #define INCLUDED_CPPUHELPER_WEAKREF_HXX
25 
26 #include "sal/config.h"
27 
28 #include <cstddef>
29 
31 #include "com/sun/star/uno/XInterface.hpp"
33 
34 
35 namespace com
36 {
37 namespace sun
38 {
39 namespace star
40 {
41 namespace uno
42 {
43 
44 class OWeakRefListener;
45 
56 {
57 public:
61  : m_pImpl( NULL )
62  {}
63 
68  WeakReferenceHelper( const WeakReferenceHelper & rWeakRef );
69 
70 #if defined LIBO_INTERNAL_ONLY
71  WeakReferenceHelper(WeakReferenceHelper && other) noexcept : m_pImpl(other.m_pImpl)
72  { other.m_pImpl = nullptr; }
73 #endif
74 
80  WeakReferenceHelper( const css::uno::Reference< css::uno::XInterface > & xInt );
81 
84  ~WeakReferenceHelper();
85 
90  WeakReferenceHelper & SAL_CALL operator = ( const WeakReferenceHelper & rWeakRef );
91 
92 #if defined LIBO_INTERNAL_ONLY
93  WeakReferenceHelper & SAL_CALL operator =(WeakReferenceHelper && other);
94 #endif
95 
102  WeakReferenceHelper & SAL_CALL operator = (
103  const css::uno::Reference< css::uno::XInterface > & xInt );
104 
110  bool SAL_CALL operator == ( const WeakReferenceHelper & rObj ) const
111  { return (get() == rObj.get()); }
112 
117  css::uno::Reference< css::uno::XInterface > SAL_CALL get() const;
118 
123  SAL_CALL operator Reference< XInterface > () const
124  { return get(); }
125 
130  void SAL_CALL clear();
131 
132 protected:
134  OWeakRefListener * m_pImpl;
136 };
137 
149 template< class interface_type >
151 {
152 public:
157  {}
158 
164  : WeakReferenceHelper( rRef )
165  {}
166 
175  WeakReference & SAL_CALL operator = (
176  const css::uno::Reference< interface_type > & xInt )
177  { WeakReferenceHelper::operator=(xInt); return *this; }
178 
179 #if defined LIBO_INTERNAL_ONLY
180  WeakReference & SAL_CALL operator = (
181  css::uno::Reference< interface_type > && xInt )
182  { WeakReferenceHelper::operator=(std::move(xInt)); return *this; }
183 #endif
184 
189  SAL_CALL operator Reference< interface_type > () const
190  { return Reference< interface_type >::query( get() ); }
191 };
192 
193 }
194 }
195 }
196 }
197 
198 #endif
199 
200 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
static SAL_WARN_UNUSED_RESULT Reference< interface_type > query(const BaseReference &rRef)
Queries given interface reference for type interface_type.
Definition: Reference.hxx:373
bool operator==(const Any &rAny, const C &value)
Template equality operator: compares set value of left side any to right side value.
Definition: Any.hxx:657
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:587
Definition: types.h:359
Template reference class for interface type derived from BaseReference.
Definition: unotype.hxx:43
WeakReference(const Reference< interface_type > &rRef)
Copy ctor.
Definition: weakref.hxx:163
WeakReferenceHelper & operator=(const WeakReferenceHelper &rWeakRef)
Releases this reference and takes over rWeakRef.
css::uno::Reference< css::uno::XInterface > get() const
Gets a hard reference to the object.
The WeakReference<> holds a weak reference to an object.
Definition: weakref.hxx:150
#define CPPUHELPER_DLLPUBLIC
Definition: cppuhelperdllapi.h:32
WeakReference()
Default ctor.
Definition: weakref.hxx:155
The WeakReferenceHelper holds a weak reference to an object.
Definition: weakref.hxx:55
WeakReferenceHelper()
Default ctor.
Definition: weakref.hxx:60