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 | #include <memory> | |||
21 | #include <DrawDocShell.hxx> | |||
22 | #include <svx/svdpagv.hxx> | |||
23 | #include <svx/svxdlg.hxx> | |||
24 | ||||
25 | #include <helpids.h> | |||
26 | #include <ViewShell.hxx> | |||
27 | #include <FrameView.hxx> | |||
28 | #include <drawdoc.hxx> | |||
29 | #include <sdpage.hxx> | |||
30 | #include <ClientView.hxx> | |||
31 | #include <Window.hxx> | |||
32 | #include <strings.hrc> | |||
33 | ||||
34 | #include <sdresid.hxx> | |||
35 | #include <fupoor.hxx> | |||
36 | #include <vcl/svapp.hxx> | |||
37 | #include <vcl/virdev.hxx> | |||
38 | #include <rtl/character.hxx> | |||
39 | #include <tools/debug.hxx> | |||
40 | ||||
41 | namespace sd { | |||
42 | ||||
43 | /** | |||
44 | * Drawing of DocShell (with the helper class SdDrawViewShell) | |||
45 | */ | |||
46 | void DrawDocShell::Draw(OutputDevice* pOut, const JobSetup&, sal_uInt16 nAspect) | |||
47 | { | |||
48 | if (nAspect == ASPECT_THUMBNAIL2) | |||
49 | { | |||
50 | // THUMBNAIL: here we may can set the draft mode | |||
51 | } | |||
52 | ||||
53 | std::unique_ptr<ClientView> pView( new ClientView(this, pOut) ); | |||
54 | ||||
55 | pView->SetHlplVisible(false); | |||
56 | pView->SetGridVisible(false); | |||
57 | pView->SetBordVisible(false); | |||
58 | pView->SetPageVisible(false); | |||
59 | pView->SetGlueVisible(false); | |||
60 | ||||
61 | SdPage* pSelectedPage = nullptr; | |||
62 | ||||
63 | const std::vector<std::unique_ptr<sd::FrameView>> &rViews = mpDoc->GetFrameViewList(); | |||
64 | if( !rViews.empty() ) | |||
65 | { | |||
66 | sd::FrameView* pFrameView = rViews[0].get(); | |||
67 | if( pFrameView->GetPageKind() == PageKind::Standard ) | |||
68 | { | |||
69 | sal_uInt16 nSelectedPage = pFrameView->GetSelectedPage(); | |||
70 | pSelectedPage = mpDoc->GetSdPage(nSelectedPage, PageKind::Standard); | |||
71 | } | |||
72 | } | |||
73 | ||||
74 | if( nullptr == pSelectedPage ) | |||
75 | { | |||
76 | SdPage* pPage = nullptr; | |||
77 | sal_uInt16 nPageCnt = mpDoc->GetSdPageCount(PageKind::Standard); | |||
78 | ||||
79 | for (sal_uInt16 i = 0; i < nPageCnt; i++) | |||
80 | { | |||
81 | pPage = mpDoc->GetSdPage(i, PageKind::Standard); | |||
82 | ||||
83 | if ( pPage->IsSelected() ) | |||
84 | pSelectedPage = pPage; | |||
85 | } | |||
86 | ||||
87 | if( nullptr == pSelectedPage ) | |||
88 | pSelectedPage = mpDoc->GetSdPage(0, PageKind::Standard); | |||
89 | } | |||
90 | ||||
91 | ::tools::Rectangle aVisArea = GetVisArea(nAspect); | |||
92 | pOut->IntersectClipRegion(aVisArea); | |||
93 | pView->ShowSdrPage(pSelectedPage); | |||
94 | ||||
95 | if (pOut->GetOutDevType() == OUTDEV_WINDOW) | |||
96 | return; | |||
97 | ||||
98 | MapMode aOldMapMode = pOut->GetMapMode(); | |||
99 | ||||
100 | if (pOut->GetOutDevType() == OUTDEV_PRINTER) | |||
101 | { | |||
102 | MapMode aMapMode = aOldMapMode; | |||
103 | Point aOrigin = aMapMode.GetOrigin(); | |||
104 | aOrigin.AdjustX(1 ); | |||
105 | aOrigin.AdjustY(1 ); | |||
106 | aMapMode.SetOrigin(aOrigin); | |||
107 | pOut->SetMapMode(aMapMode); | |||
108 | } | |||
109 | ||||
110 | vcl::Region aRegion(aVisArea); | |||
111 | pView->CompleteRedraw(pOut, aRegion); | |||
112 | ||||
113 | if (pOut->GetOutDevType() == OUTDEV_PRINTER) | |||
114 | { | |||
115 | pOut->SetMapMode(aOldMapMode); | |||
116 | } | |||
117 | } | |||
118 | ||||
119 | ::tools::Rectangle DrawDocShell::GetVisArea(sal_uInt16 nAspect) const | |||
120 | { | |||
121 | ::tools::Rectangle aVisArea; | |||
122 | ||||
123 | if( ( ASPECT_THUMBNAIL2 == nAspect ) || ( ASPECT_DOCPRINT8 == nAspect ) ) | |||
124 | { | |||
125 | // provide size of first page | |||
126 | MapMode aSrcMapMode(MapUnit::MapPixel); | |||
127 | MapMode aDstMapMode(MapUnit::Map100thMM); | |||
128 | Size aSize = mpDoc->GetSdPage(0, PageKind::Standard)->GetSize(); | |||
129 | aSrcMapMode.SetMapUnit(MapUnit::Map100thMM); | |||
130 | ||||
131 | aSize = Application::GetDefaultDevice()->LogicToLogic(aSize, &aSrcMapMode, &aDstMapMode); | |||
132 | aVisArea.SetSize(aSize); | |||
133 | } | |||
134 | else | |||
135 | { | |||
136 | aVisArea = SfxObjectShell::GetVisArea(nAspect); | |||
137 | } | |||
138 | ||||
139 | if (aVisArea.IsEmpty() && mpViewShell) | |||
140 | { | |||
141 | vcl::Window* pWin = mpViewShell->GetActiveWindow(); | |||
142 | ||||
143 | if (pWin) | |||
144 | { | |||
145 | aVisArea = pWin->PixelToLogic(::tools::Rectangle(Point(0,0), pWin->GetOutputSizePixel())); | |||
146 | } | |||
147 | } | |||
148 | ||||
149 | return aVisArea; | |||
150 | } | |||
151 | ||||
152 | void DrawDocShell::Connect(ViewShell* pViewSh) | |||
153 | { | |||
154 | mpViewShell = pViewSh; | |||
155 | } | |||
156 | ||||
157 | void DrawDocShell::Disconnect(ViewShell const * pViewSh) | |||
158 | { | |||
159 | if (mpViewShell == pViewSh) | |||
160 | { | |||
161 | mpViewShell = nullptr; | |||
162 | } | |||
163 | } | |||
164 | ||||
165 | FrameView* DrawDocShell::GetFrameView() | |||
166 | { | |||
167 | FrameView* pFrameView = nullptr; | |||
168 | ||||
169 | if (mpViewShell) | |||
170 | { | |||
171 | pFrameView = mpViewShell->GetFrameView(); | |||
172 | } | |||
173 | ||||
174 | return pFrameView; | |||
175 | } | |||
176 | ||||
177 | /** | |||
178 | * Creates a bitmap of an arbitrary page | |||
179 | */ | |||
180 | BitmapEx DrawDocShell::GetPagePreviewBitmap(SdPage* pPage) | |||
181 | { | |||
182 | const sal_uInt16 nMaxEdgePixel = 90; | |||
183 | MapMode aMapMode( MapUnit::Map100thMM ); | |||
184 | const Size aSize( pPage->GetSize() ); | |||
185 | const Point aNullPt; | |||
186 | ScopedVclPtrInstance< VirtualDevice > pVDev( *Application::GetDefaultDevice() ); | |||
187 | ||||
188 | pVDev->SetMapMode( aMapMode ); | |||
189 | ||||
190 | const Size aPixSize( pVDev->LogicToPixel( aSize ) ); | |||
191 | const sal_uLong nMaxEdgePix = std::max( aPixSize.Width(), aPixSize.Height() ); | |||
192 | Fraction aFrac( nMaxEdgePixel, nMaxEdgePix ); | |||
193 | ||||
194 | aMapMode.SetScaleX( aFrac ); | |||
195 | aMapMode.SetScaleY( aFrac ); | |||
196 | pVDev->SetMapMode( aMapMode ); | |||
197 | pVDev->SetOutputSize( aSize ); | |||
198 | ||||
199 | // that we also get the dark lines at the right and bottom page margin | |||
200 | aFrac = Fraction( nMaxEdgePixel - 1, nMaxEdgePix ); | |||
201 | aMapMode.SetScaleX( aFrac ); | |||
202 | aMapMode.SetScaleY( aFrac ); | |||
203 | pVDev->SetMapMode( aMapMode ); | |||
204 | ||||
205 | std::unique_ptr<ClientView> pView(new ClientView( this, pVDev )); | |||
206 | FrameView* pFrameView = GetFrameView(); | |||
207 | pView->ShowSdrPage( pPage ); | |||
208 | ||||
209 | if ( GetFrameView() ) | |||
210 | { | |||
211 | // initialize the drawing-(screen) attributes | |||
212 | pView->SetGridCoarse( pFrameView->GetGridCoarse() ); | |||
213 | pView->SetGridFine( pFrameView->GetGridFine() ); | |||
214 | pView->SetSnapGridWidth(pFrameView->GetSnapGridWidthX(), pFrameView->GetSnapGridWidthY()); | |||
215 | pView->SetGridVisible( pFrameView->IsGridVisible() ); | |||
216 | pView->SetGridFront( pFrameView->IsGridFront() ); | |||
217 | pView->SetSnapAngle( pFrameView->GetSnapAngle() ); | |||
218 | pView->SetGridSnap( pFrameView->IsGridSnap() ); | |||
219 | pView->SetBordSnap( pFrameView->IsBordSnap() ); | |||
220 | pView->SetHlplSnap( pFrameView->IsHlplSnap() ); | |||
221 | pView->SetOFrmSnap( pFrameView->IsOFrmSnap() ); | |||
222 | pView->SetOPntSnap( pFrameView->IsOPntSnap() ); | |||
223 | pView->SetOConSnap( pFrameView->IsOConSnap() ); | |||
224 | pView->SetDragStripes( pFrameView->IsDragStripes() ); | |||
225 | pView->SetFrameDragSingles( pFrameView->IsFrameDragSingles() ); | |||
226 | pView->SetSnapMagneticPixel( pFrameView->GetSnapMagneticPixel() ); | |||
227 | pView->SetMarkedHitMovesAlways( pFrameView->IsMarkedHitMovesAlways() ); | |||
228 | pView->SetMoveOnlyDragging( pFrameView->IsMoveOnlyDragging() ); | |||
229 | pView->SetSlantButShear( pFrameView->IsSlantButShear() ); | |||
230 | pView->SetNoDragXorPolys( pFrameView->IsNoDragXorPolys() ); | |||
231 | pView->SetCrookNoContortion( pFrameView->IsCrookNoContortion() ); | |||
232 | pView->SetAngleSnapEnabled( pFrameView->IsAngleSnapEnabled() ); | |||
233 | pView->SetBigOrtho( pFrameView->IsBigOrtho() ); | |||
234 | pView->SetOrtho( pFrameView->IsOrtho() ); | |||
235 | ||||
236 | SdrPageView* pPageView = pView->GetSdrPageView(); | |||
237 | ||||
238 | if (pPageView) | |||
239 | { | |||
240 | if ( pPageView->GetVisibleLayers() != pFrameView->GetVisibleLayers() ) | |||
241 | pPageView->SetVisibleLayers( pFrameView->GetVisibleLayers() ); | |||
242 | ||||
243 | if ( pPageView->GetPrintableLayers() != pFrameView->GetPrintableLayers() ) | |||
244 | pPageView->SetPrintableLayers( pFrameView->GetPrintableLayers() ); | |||
245 | ||||
246 | if ( pPageView->GetLockedLayers() != pFrameView->GetLockedLayers() ) | |||
247 | pPageView->SetLockedLayers( pFrameView->GetLockedLayers() ); | |||
248 | ||||
249 | pPageView->SetHelpLines( pFrameView->GetStandardHelpLines() ); | |||
250 | } | |||
251 | ||||
252 | if ( pView->GetActiveLayer() != pFrameView->GetActiveLayer() ) | |||
253 | pView->SetActiveLayer( pFrameView->GetActiveLayer() ); | |||
254 | } | |||
255 | ||||
256 | pView->CompleteRedraw( pVDev, vcl::Region(::tools::Rectangle(aNullPt, aSize)) ); | |||
257 | ||||
258 | // IsRedrawReady() always gives sal_True while ( !pView->IsRedrawReady() ) {} | |||
259 | pView.reset(); | |||
260 | ||||
261 | pVDev->SetMapMode( MapMode() ); | |||
262 | ||||
263 | BitmapEx aPreview( pVDev->GetBitmapEx( aNullPt, pVDev->GetOutputSizePixel() ) ); | |||
264 | ||||
265 | DBG_ASSERT(!!aPreview, "Preview-Bitmap could not be generated")do { if (true && (!(!!aPreview))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/sd/source/ui/docshell/docshel2.cxx" ":" "265" ": "), "%s", "Preview-Bitmap could not be generated" ); } } while (false); | |||
266 | ||||
267 | return aPreview; | |||
268 | } | |||
269 | ||||
270 | /** | |||
271 | * Checks if the page exists. If so, we force the user to enter a not yet used | |||
272 | * name. | |||
273 | * @return sal_False if the user cancels the action. | |||
274 | */ | |||
275 | bool DrawDocShell::CheckPageName(weld::Window* pWin, OUString& rName) | |||
276 | { | |||
277 | const OUString aStrForDlg( rName ); | |||
278 | bool bIsNameValid = IsNewPageNameValid( rName, true ); | |||
279 | ||||
280 | if( ! bIsNameValid ) | |||
| ||||
281 | { | |||
282 | OUString aDesc; | |||
283 | SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create(); | |||
284 | ||||
285 | if (GetDocumentType() == DocumentType::Draw) | |||
286 | aDesc = SdResId( STR_WARN_PAGE_EXISTS_DRAWreinterpret_cast<char const *>("STR_WARN_PAGE_EXISTS_DRAW" "\004" u8"The page name already exists or is invalid. Please enter another name." ) ); | |||
287 | else | |||
288 | aDesc = SdResId( STR_WARN_PAGE_EXISTSreinterpret_cast<char const *>("STR_WARN_PAGE_EXISTS" "\004" u8"The slide name already exists or is invalid. Please enter another name." ) ); | |||
289 | ||||
290 | ScopedVclPtr<AbstractSvxNameDialog> aNameDlg(pFact->CreateSvxNameDialog(pWin, aStrForDlg, aDesc)); | |||
291 | aNameDlg->SetEditHelpId( HID_SD_NAMEDIALOG_PAGE"SD_HID_SD_NAMEDIALOG_PAGE" ); | |||
292 | ||||
293 | aNameDlg->SetCheckNameHdl( LINK( this, DrawDocShell, RenameSlideHdl )::tools::detail::makeLink( ::tools::detail::castTo<DrawDocShell *>(this), &DrawDocShell::LinkStubRenameSlideHdl) ); | |||
294 | ||||
295 | rtl::Reference<FuPoor> xFunc( mpViewShell->GetCurrentFunction() ); | |||
296 | if( xFunc.is() ) | |||
297 | xFunc->cancel(); | |||
298 | ||||
299 | if( aNameDlg->Execute() == RET_OK ) | |||
300 | { | |||
301 | aNameDlg->GetName( rName ); | |||
302 | bIsNameValid = IsNewPageNameValid( rName ); | |||
303 | } | |||
304 | } | |||
305 | ||||
306 | return bIsNameValid; | |||
307 | } | |||
308 | ||||
309 | bool DrawDocShell::IsNewPageNameValid( OUString & rInOutPageName, bool bResetStringIfStandardName /* = false */ ) | |||
310 | { | |||
311 | bool bCanUseNewName = false; | |||
312 | ||||
313 | // check if name is something like 'Slide n' | |||
314 | OUString aStrPage(SdResId(STR_SD_PAGEreinterpret_cast<char const *>("STR_SD_PAGE" "\004" u8"Slide" )) + " "); | |||
315 | ||||
316 | bool bIsStandardName = false; | |||
317 | ||||
318 | // prevent also _future_ slide names of the form "'STR_SD_PAGE' + ' ' + '[0-9]+|[a-z]|[A-Z]|[CDILMVX]+|[cdilmvx]+'" | |||
319 | // (arabic, lower- and upper case single letter, lower- and upper case roman numbers) | |||
320 | if (rInOutPageName.startsWith(aStrPage) && | |||
321 | rInOutPageName.getLength() > aStrPage.getLength()) | |||
322 | { | |||
323 | sal_Int32 nIdx{ aStrPage.getLength() }; | |||
324 | OUString sRemainder = rInOutPageName.getToken(0, ' ', nIdx); | |||
325 | if (sRemainder[0] >= '0' && sRemainder[0] <= '9') | |||
326 | { | |||
327 | // check for arabic numbering | |||
328 | ||||
329 | sal_Int32 nIndex = 1; | |||
330 | // skip all following numbers | |||
331 | while (nIndex < sRemainder.getLength() && | |||
332 | sRemainder[nIndex] >= '0' && sRemainder[nIndex] <= '9') | |||
333 | { | |||
334 | nIndex++; | |||
335 | } | |||
336 | ||||
337 | // EOL? Reserved name! | |||
338 | if (nIndex >= sRemainder.getLength()) | |||
339 | { | |||
340 | bIsStandardName = true; | |||
341 | } | |||
342 | } | |||
343 | else if (sRemainder.getLength() == 1 && | |||
344 | rtl::isAsciiLowerCase(sRemainder[0])) | |||
345 | { | |||
346 | // lower case, single character: reserved | |||
347 | bIsStandardName = true; | |||
348 | } | |||
349 | else if (sRemainder.getLength() == 1 && | |||
350 | rtl::isAsciiUpperCase(sRemainder[0])) | |||
351 | { | |||
352 | // upper case, single character: reserved | |||
353 | bIsStandardName = true; | |||
354 | } | |||
355 | else | |||
356 | { | |||
357 | // check for upper/lower case roman numbering | |||
358 | OUString sReserved("cdilmvx"); | |||
359 | ||||
360 | // skip all following characters contained in one reserved class | |||
361 | if (sReserved.indexOf(sRemainder[0]) == -1) | |||
362 | sReserved = sReserved.toAsciiUpperCase(); | |||
363 | ||||
364 | sal_Int32 nIndex = 0; | |||
365 | while (nIndex < sRemainder.getLength() && | |||
366 | sReserved.indexOf(sRemainder[nIndex]) != -1) | |||
367 | { | |||
368 | nIndex++; | |||
369 | } | |||
370 | ||||
371 | // EOL? Reserved name! | |||
372 | if (nIndex >= sRemainder.getLength()) | |||
373 | { | |||
374 | bIsStandardName = true; | |||
375 | } | |||
376 | } | |||
377 | } | |||
378 | ||||
379 | if( bIsStandardName ) | |||
380 | { | |||
381 | if( bResetStringIfStandardName ) | |||
382 | { | |||
383 | // this is for insertion of slides from other files with standard | |||
384 | // name. They get a new standard name, if the string is set to an | |||
385 | // empty one. | |||
386 | rInOutPageName.clear(); | |||
387 | bCanUseNewName = true; | |||
388 | } | |||
389 | else | |||
390 | bCanUseNewName = false; | |||
391 | } | |||
392 | else | |||
393 | { | |||
394 | if (!rInOutPageName.isEmpty()) | |||
395 | { | |||
396 | bool bOutDummy; | |||
397 | sal_uInt16 nExistingPageNum = mpDoc->GetPageByName( rInOutPageName, bOutDummy ); | |||
398 | bCanUseNewName = ( nExistingPageNum == SDRPAGE_NOTFOUND0xFFFF ); | |||
399 | } | |||
400 | else | |||
401 | bCanUseNewName = false; | |||
402 | } | |||
403 | ||||
404 | return bCanUseNewName; | |||
405 | } | |||
406 | ||||
407 | bool DrawDocShell::IsPageNameUnique( const OUString & rPageName ) const | |||
408 | { | |||
409 | return mpDoc->IsPageNameUnique(rPageName); | |||
410 | } | |||
411 | ||||
412 | IMPL_LINK( DrawDocShell, RenameSlideHdl, AbstractSvxNameDialog&, rDialog, bool )bool DrawDocShell::LinkStubRenameSlideHdl(void * instance, AbstractSvxNameDialog & data) { return static_cast<DrawDocShell *>(instance )->RenameSlideHdl(data); } bool DrawDocShell::RenameSlideHdl (AbstractSvxNameDialog& rDialog) | |||
413 | { | |||
414 | OUString aNewName; | |||
415 | rDialog.GetName( aNewName ); | |||
416 | return IsNewPageNameValid( aNewName ); | |||
417 | } | |||
418 | ||||
419 | } // end of namespace sd | |||
420 | ||||
421 | /* 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 |