File: | home/maarten/src/libreoffice/core/include/rtl/ref.hxx |
Warning: | line 192, column 9 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 <sal/config.h> | |||
22 | ||||
23 | #include <tools/diagnose_ex.h> | |||
24 | ||||
25 | #include <basegfx/matrix/b2dhommatrix.hxx> | |||
26 | #include <basegfx/numeric/ftools.hxx> | |||
27 | #include <basegfx/utils/canvastools.hxx> | |||
28 | #include <com/sun/star/rendering/CompositeOperation.hpp> | |||
29 | #include <com/sun/star/rendering/RenderState.hpp> | |||
30 | #include <com/sun/star/rendering/TextDirection.hpp> | |||
31 | #include <com/sun/star/rendering/ViewState.hpp> | |||
32 | #include <comphelper/sequence.hxx> | |||
33 | #include <cppuhelper/supportsservice.hxx> | |||
34 | #include <vcl/metric.hxx> | |||
35 | #include <vcl/virdev.hxx> | |||
36 | ||||
37 | #include <canvas/canvastools.hxx> | |||
38 | ||||
39 | #include "textlayout.hxx" | |||
40 | ||||
41 | #include <memory> | |||
42 | ||||
43 | using namespace ::com::sun::star; | |||
44 | ||||
45 | namespace vclcanvas | |||
46 | { | |||
47 | namespace | |||
48 | { | |||
49 | void setupLayoutMode( OutputDevice& rOutDev, | |||
50 | sal_Int8 nTextDirection ) | |||
51 | { | |||
52 | // TODO(P3): avoid if already correctly set | |||
53 | ComplexTextLayoutFlags nLayoutMode = ComplexTextLayoutFlags::Default; | |||
54 | switch( nTextDirection ) | |||
55 | { | |||
56 | case rendering::TextDirection::WEAK_LEFT_TO_RIGHT: | |||
57 | break; | |||
58 | case rendering::TextDirection::STRONG_LEFT_TO_RIGHT: | |||
59 | nLayoutMode = ComplexTextLayoutFlags::BiDiStrong; | |||
60 | break; | |||
61 | case rendering::TextDirection::WEAK_RIGHT_TO_LEFT: | |||
62 | nLayoutMode = ComplexTextLayoutFlags::BiDiRtl; | |||
63 | break; | |||
64 | case rendering::TextDirection::STRONG_RIGHT_TO_LEFT: | |||
65 | nLayoutMode = ComplexTextLayoutFlags::BiDiRtl | ComplexTextLayoutFlags::BiDiStrong; | |||
66 | break; | |||
67 | default: | |||
68 | break; | |||
69 | } | |||
70 | ||||
71 | // set calculated layout mode. Origin is always the left edge, | |||
72 | // as required at the API spec | |||
73 | rOutDev.SetLayoutMode( nLayoutMode | ComplexTextLayoutFlags::TextOriginLeft ); | |||
74 | } | |||
75 | } | |||
76 | ||||
77 | TextLayout::TextLayout( const rendering::StringContext& aText, | |||
78 | sal_Int8 nDirection, | |||
79 | const CanvasFont::Reference& rFont, | |||
80 | const uno::Reference<rendering::XGraphicDevice>& xDevice, | |||
81 | const OutDevProviderSharedPtr& rOutDev ) : | |||
82 | TextLayout_Base( m_aMutex ), | |||
83 | maText( aText ), | |||
84 | maLogicalAdvancements(), | |||
85 | mpFont( rFont ), | |||
86 | mxDevice( xDevice ), | |||
87 | mpOutDevProvider( rOutDev ), | |||
88 | mnTextDirection( nDirection ) | |||
89 | {} | |||
90 | ||||
91 | void SAL_CALL TextLayout::disposing() | |||
92 | { | |||
93 | SolarMutexGuard aGuard; | |||
94 | ||||
95 | mpOutDevProvider.reset(); | |||
96 | mxDevice.clear(); | |||
97 | mpFont.clear(); | |||
98 | } | |||
99 | ||||
100 | // XTextLayout | |||
101 | uno::Sequence< uno::Reference< rendering::XPolyPolygon2D > > SAL_CALL TextLayout::queryTextShapes( ) | |||
102 | { | |||
103 | SolarMutexGuard aGuard; | |||
104 | ||||
105 | OutputDevice& rOutDev = mpOutDevProvider->getOutDev(); | |||
106 | ScopedVclPtrInstance< VirtualDevice > pVDev( rOutDev ); | |||
107 | pVDev->SetFont( mpFont->getVCLFont() ); | |||
108 | ||||
109 | setupLayoutMode( *pVDev, mnTextDirection ); | |||
110 | ||||
111 | const rendering::ViewState aViewState( | |||
112 | geometry::AffineMatrix2D(1,0,0, 0,1,0), | |||
113 | nullptr); | |||
114 | ||||
115 | rendering::RenderState aRenderState ( | |||
116 | geometry::AffineMatrix2D(1,0,0,0,1,0), | |||
117 | nullptr, | |||
118 | uno::Sequence<double>(4), | |||
119 | rendering::CompositeOperation::SOURCE); | |||
120 | ||||
121 | std::unique_ptr< long []> aOffsets(new long[maLogicalAdvancements.getLength()]); | |||
122 | setupTextOffsets(aOffsets.get(), maLogicalAdvancements, aViewState, aRenderState); | |||
123 | ||||
124 | std::vector< uno::Reference< rendering::XPolyPolygon2D> > aOutlineSequence; | |||
125 | ::basegfx::B2DPolyPolygonVector aOutlines; | |||
126 | if (pVDev->GetTextOutlines( | |||
127 | aOutlines, | |||
128 | maText.Text, | |||
129 | maText.StartPosition, | |||
130 | maText.StartPosition, | |||
131 | maText.Length, | |||
132 | 0, | |||
133 | aOffsets.get())) | |||
134 | { | |||
135 | aOutlineSequence.reserve(aOutlines.size()); | |||
136 | sal_Int32 nIndex (0); | |||
137 | for (auto const& outline : aOutlines) | |||
138 | { | |||
139 | aOutlineSequence[nIndex++] = ::basegfx::unotools::xPolyPolygonFromB2DPolyPolygon( | |||
140 | mxDevice, | |||
141 | outline); | |||
142 | } | |||
143 | } | |||
144 | ||||
145 | return comphelper::containerToSequence(aOutlineSequence); | |||
146 | } | |||
147 | ||||
148 | uno::Sequence< geometry::RealRectangle2D > SAL_CALL TextLayout::queryInkMeasures( ) | |||
149 | { | |||
150 | SolarMutexGuard aGuard; | |||
151 | ||||
152 | ||||
153 | OutputDevice& rOutDev = mpOutDevProvider->getOutDev(); | |||
154 | ScopedVclPtrInstance< VirtualDevice > pVDev( rOutDev ); | |||
| ||||
155 | pVDev->SetFont( mpFont->getVCLFont() ); | |||
156 | ||||
157 | setupLayoutMode( *pVDev, mnTextDirection ); | |||
158 | ||||
159 | const rendering::ViewState aViewState( | |||
160 | geometry::AffineMatrix2D(1,0,0, 0,1,0), | |||
161 | nullptr); | |||
162 | ||||
163 | rendering::RenderState aRenderState ( | |||
164 | geometry::AffineMatrix2D(1,0,0,0,1,0), | |||
165 | nullptr, | |||
166 | uno::Sequence<double>(4), | |||
167 | rendering::CompositeOperation::SOURCE); | |||
168 | ||||
169 | std::unique_ptr< long []> aOffsets(new long[maLogicalAdvancements.getLength()]); | |||
170 | setupTextOffsets(aOffsets.get(), maLogicalAdvancements, aViewState, aRenderState); | |||
171 | ||||
172 | MetricVector aMetricVector; | |||
173 | uno::Sequence<geometry::RealRectangle2D> aBoundingBoxes; | |||
174 | if (pVDev->GetGlyphBoundRects( | |||
175 | Point(0,0), | |||
176 | maText.Text, | |||
177 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.StartPosition), | |||
178 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.Length), | |||
179 | aMetricVector)) | |||
180 | { | |||
181 | aBoundingBoxes.realloc(aMetricVector.size()); | |||
182 | sal_Int32 nIndex (0); | |||
183 | for (auto const& metric : aMetricVector) | |||
184 | { | |||
185 | aBoundingBoxes[nIndex++] = geometry::RealRectangle2D( | |||
186 | metric.getX(), | |||
187 | metric.getY(), | |||
188 | metric.getX() + metric.getWidth(), | |||
189 | metric.getY() + metric.getHeight()); | |||
190 | } | |||
191 | } | |||
192 | return aBoundingBoxes; | |||
193 | } | |||
194 | ||||
195 | uno::Sequence< geometry::RealRectangle2D > SAL_CALL TextLayout::queryMeasures( ) | |||
196 | { | |||
197 | // TODO(F1) | |||
198 | return uno::Sequence< geometry::RealRectangle2D >(); | |||
199 | } | |||
200 | ||||
201 | uno::Sequence< double > SAL_CALL TextLayout::queryLogicalAdvancements( ) | |||
202 | { | |||
203 | SolarMutexGuard aGuard; | |||
204 | ||||
205 | return maLogicalAdvancements; | |||
206 | } | |||
207 | ||||
208 | void SAL_CALL TextLayout::applyLogicalAdvancements( const uno::Sequence< double >& aAdvancements ) | |||
209 | { | |||
210 | SolarMutexGuard aGuard; | |||
211 | ||||
212 | ENSURE_ARG_OR_THROW( aAdvancements.getLength() == maText.Length,if( !(aAdvancements.getLength() == maText.Length) ) { do { if (true && (!(aAdvancements.getLength() == maText.Length ))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl" ), ("/home/maarten/src/libreoffice/core/canvas/source/vcl/textlayout.cxx" ":" "213" ": "), "%s", "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" ); } } while (false); throw css::lang::IllegalArgumentException ( __func__ + OUStringLiteral(u",\n" "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" ), css::uno::Reference< css::uno::XInterface >(), 0 ); } | |||
213 | "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" )if( !(aAdvancements.getLength() == maText.Length) ) { do { if (true && (!(aAdvancements.getLength() == maText.Length ))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl" ), ("/home/maarten/src/libreoffice/core/canvas/source/vcl/textlayout.cxx" ":" "213" ": "), "%s", "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" ); } } while (false); throw css::lang::IllegalArgumentException ( __func__ + OUStringLiteral(u",\n" "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" ), css::uno::Reference< css::uno::XInterface >(), 0 ); }; | |||
214 | ||||
215 | maLogicalAdvancements = aAdvancements; | |||
216 | } | |||
217 | ||||
218 | geometry::RealRectangle2D SAL_CALL TextLayout::queryTextBounds( ) | |||
219 | { | |||
220 | SolarMutexGuard aGuard; | |||
221 | ||||
222 | if( !mpOutDevProvider ) | |||
223 | return geometry::RealRectangle2D(); | |||
224 | ||||
225 | OutputDevice& rOutDev = mpOutDevProvider->getOutDev(); | |||
226 | ||||
227 | ScopedVclPtrInstance< VirtualDevice > pVDev( rOutDev ); | |||
228 | pVDev->SetFont( mpFont->getVCLFont() ); | |||
229 | ||||
230 | // need metrics for Y offset, the XCanvas always renders | |||
231 | // relative to baseline | |||
232 | const ::FontMetric& aMetric( pVDev->GetFontMetric() ); | |||
233 | ||||
234 | setupLayoutMode( *pVDev, mnTextDirection ); | |||
235 | ||||
236 | const sal_Int32 nAboveBaseline( -aMetric.GetAscent() ); | |||
237 | const sal_Int32 nBelowBaseline( aMetric.GetDescent() ); | |||
238 | ||||
239 | if( maLogicalAdvancements.hasElements() ) | |||
240 | { | |||
241 | return geometry::RealRectangle2D( 0, nAboveBaseline, | |||
242 | maLogicalAdvancements[ maLogicalAdvancements.getLength()-1 ], | |||
243 | nBelowBaseline ); | |||
244 | } | |||
245 | else | |||
246 | { | |||
247 | return geometry::RealRectangle2D( 0, nAboveBaseline, | |||
248 | pVDev->GetTextWidth( | |||
249 | maText.Text, | |||
250 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.StartPosition), | |||
251 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.Length) ), | |||
252 | nBelowBaseline ); | |||
253 | } | |||
254 | } | |||
255 | ||||
256 | double SAL_CALL TextLayout::justify( double ) | |||
257 | { | |||
258 | // TODO(F1) | |||
259 | return 0.0; | |||
260 | } | |||
261 | ||||
262 | double SAL_CALL TextLayout::combinedJustify( const uno::Sequence< uno::Reference< rendering::XTextLayout > >&, | |||
263 | double ) | |||
264 | { | |||
265 | // TODO(F1) | |||
266 | return 0.0; | |||
267 | } | |||
268 | ||||
269 | rendering::TextHit SAL_CALL TextLayout::getTextHit( const geometry::RealPoint2D& ) | |||
270 | { | |||
271 | // TODO(F1) | |||
272 | return rendering::TextHit(); | |||
273 | } | |||
274 | ||||
275 | rendering::Caret SAL_CALL TextLayout::getCaret( sal_Int32, sal_Bool ) | |||
276 | { | |||
277 | // TODO(F1) | |||
278 | return rendering::Caret(); | |||
279 | } | |||
280 | ||||
281 | sal_Int32 SAL_CALL TextLayout::getNextInsertionIndex( sal_Int32, sal_Int32, sal_Bool ) | |||
282 | { | |||
283 | // TODO(F1) | |||
284 | return 0; | |||
285 | } | |||
286 | ||||
287 | uno::Reference< rendering::XPolyPolygon2D > SAL_CALL TextLayout::queryVisualHighlighting( sal_Int32, sal_Int32 ) | |||
288 | { | |||
289 | // TODO(F1) | |||
290 | return uno::Reference< rendering::XPolyPolygon2D >(); | |||
291 | } | |||
292 | ||||
293 | uno::Reference< rendering::XPolyPolygon2D > SAL_CALL TextLayout::queryLogicalHighlighting( sal_Int32, sal_Int32 ) | |||
294 | { | |||
295 | // TODO(F1) | |||
296 | return uno::Reference< rendering::XPolyPolygon2D >(); | |||
297 | } | |||
298 | ||||
299 | double SAL_CALL TextLayout::getBaselineOffset( ) | |||
300 | { | |||
301 | // TODO(F1) | |||
302 | return 0.0; | |||
303 | } | |||
304 | ||||
305 | sal_Int8 SAL_CALL TextLayout::getMainTextDirection( ) | |||
306 | { | |||
307 | SolarMutexGuard aGuard; | |||
308 | ||||
309 | return mnTextDirection; | |||
310 | } | |||
311 | ||||
312 | uno::Reference< rendering::XCanvasFont > SAL_CALL TextLayout::getFont( ) | |||
313 | { | |||
314 | SolarMutexGuard aGuard; | |||
315 | ||||
316 | return mpFont.get(); | |||
317 | } | |||
318 | ||||
319 | rendering::StringContext SAL_CALL TextLayout::getText( ) | |||
320 | { | |||
321 | SolarMutexGuard aGuard; | |||
322 | ||||
323 | return maText; | |||
324 | } | |||
325 | ||||
326 | void TextLayout::draw( OutputDevice& rOutDev, | |||
327 | const Point& rOutpos, | |||
328 | const rendering::ViewState& viewState, | |||
329 | const rendering::RenderState& renderState ) const | |||
330 | { | |||
331 | SolarMutexGuard aGuard; | |||
332 | ||||
333 | setupLayoutMode( rOutDev, mnTextDirection ); | |||
334 | ||||
335 | if( maLogicalAdvancements.hasElements() ) | |||
336 | { | |||
337 | // TODO(P2): cache that | |||
338 | std::unique_ptr< long []> aOffsets(new long[maLogicalAdvancements.getLength()]); | |||
339 | setupTextOffsets( aOffsets.get(), maLogicalAdvancements, viewState, renderState ); | |||
340 | ||||
341 | // TODO(F3): ensure correct length and termination for DX | |||
342 | // array (last entry _must_ contain the overall width) | |||
343 | ||||
344 | rOutDev.DrawTextArray( rOutpos, | |||
345 | maText.Text, | |||
346 | aOffsets.get(), | |||
347 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.StartPosition), | |||
348 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.Length) ); | |||
349 | } | |||
350 | else | |||
351 | { | |||
352 | rOutDev.DrawText( rOutpos, | |||
353 | maText.Text, | |||
354 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.StartPosition), | |||
355 | ::canvas::tools::numeric_cast<sal_uInt16>(maText.Length) ); | |||
356 | } | |||
357 | } | |||
358 | ||||
359 | namespace | |||
360 | { | |||
361 | class OffsetTransformer | |||
362 | { | |||
363 | public: | |||
364 | explicit OffsetTransformer( const ::basegfx::B2DHomMatrix& rMat ) : | |||
365 | maMatrix( rMat ) | |||
366 | { | |||
367 | } | |||
368 | ||||
369 | sal_Int32 operator()( const double& rOffset ) | |||
370 | { | |||
371 | // This is an optimization of the normal rMat*[x,0] | |||
372 | // transformation of the advancement vector (in x | |||
373 | // direction), followed by a length calculation of the | |||
374 | // resulting vector: advancement' = | |||
375 | // ||rMat*[x,0]||. Since advancements are vectors, we | |||
376 | // can ignore translational components, thus if [x,0], | |||
377 | // it follows that rMat*[x,0]=[x',0] holds. Thus, we | |||
378 | // just have to calc the transformation of the x | |||
379 | // component. | |||
380 | ||||
381 | // TODO(F2): Handle non-horizontal advancements! | |||
382 | return ::basegfx::fround( hypot(maMatrix.get(0,0)*rOffset, | |||
383 | maMatrix.get(1,0)*rOffset) ); | |||
384 | } | |||
385 | ||||
386 | private: | |||
387 | ::basegfx::B2DHomMatrix maMatrix; | |||
388 | }; | |||
389 | } | |||
390 | ||||
391 | void TextLayout::setupTextOffsets( long* outputOffsets, | |||
392 | const uno::Sequence< double >& inputOffsets, | |||
393 | const rendering::ViewState& viewState, | |||
394 | const rendering::RenderState& renderState ) const | |||
395 | { | |||
396 | ENSURE_OR_THROW( outputOffsets!=nullptr,if( !(outputOffsets!=nullptr) ){ do { if (true && (!( outputOffsets!=nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/canvas/source/vcl/textlayout.cxx" ":" "397" ": "), "%s", "TextLayout::setupTextOffsets offsets NULL" ); } } while (false); throw css::uno::RuntimeException( __func__ + OUStringLiteral(u",\n" "TextLayout::setupTextOffsets offsets NULL" ), css::uno::Reference< css::uno::XInterface >() ); } | |||
397 | "TextLayout::setupTextOffsets offsets NULL" )if( !(outputOffsets!=nullptr) ){ do { if (true && (!( outputOffsets!=nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/canvas/source/vcl/textlayout.cxx" ":" "397" ": "), "%s", "TextLayout::setupTextOffsets offsets NULL" ); } } while (false); throw css::uno::RuntimeException( __func__ + OUStringLiteral(u",\n" "TextLayout::setupTextOffsets offsets NULL" ), css::uno::Reference< css::uno::XInterface >() ); }; | |||
398 | ||||
399 | ::basegfx::B2DHomMatrix aMatrix; | |||
400 | ||||
401 | ::canvas::tools::mergeViewAndRenderTransform(aMatrix, | |||
402 | viewState, | |||
403 | renderState); | |||
404 | ||||
405 | // fill integer offsets | |||
406 | std::transform( inputOffsets.begin(), | |||
407 | inputOffsets.end(), | |||
408 | outputOffsets, | |||
409 | OffsetTransformer( aMatrix ) ); | |||
410 | } | |||
411 | ||||
412 | OUString SAL_CALL TextLayout::getImplementationName() | |||
413 | { | |||
414 | return "VCLCanvas::TextLayout"; | |||
415 | } | |||
416 | ||||
417 | sal_Bool SAL_CALL TextLayout::supportsService( const OUString& ServiceName ) | |||
418 | { | |||
419 | return cppu::supportsService( this, ServiceName ); | |||
420 | } | |||
421 | ||||
422 | uno::Sequence< OUString > SAL_CALL TextLayout::getSupportedServiceNames() | |||
423 | { | |||
424 | return { "com.sun.star.rendering.TextLayout" }; | |||
425 | } | |||
426 | } | |||
427 | ||||
428 | /* 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 |