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 <config_features.h> | |||
21 | ||||
22 | #include <hintids.hxx> | |||
23 | ||||
24 | #include <comphelper/string.hxx> | |||
25 | #include <o3tl/deleter.hxx> | |||
26 | #include <sfx2/dispatch.hxx> | |||
27 | #include <sfx2/printer.hxx> | |||
28 | #include <sfx2/request.hxx> | |||
29 | #include <sfx2/linkmgr.hxx> | |||
30 | #include <sfx2/viewfrm.hxx> | |||
31 | #include <editeng/pbinitem.hxx> | |||
32 | #include <editeng/ulspitem.hxx> | |||
33 | #include <editeng/lrspitem.hxx> | |||
34 | #include <com/sun/star/frame/XModel.hpp> | |||
35 | #include <fmthdft.hxx> | |||
36 | #include <fmtanchr.hxx> | |||
37 | #include <fmtfsize.hxx> | |||
38 | #include <fmtornt.hxx> | |||
39 | #include <swwait.hxx> | |||
40 | #include <gloshdl.hxx> | |||
41 | #include <swmodule.hxx> | |||
42 | #include <view.hxx> | |||
43 | #include <docsh.hxx> | |||
44 | #include <fldbas.hxx> | |||
45 | #include <wrtsh.hxx> | |||
46 | #include <cmdid.h> | |||
47 | #include <dbmgr.hxx> | |||
48 | #include <fldmgr.hxx> | |||
49 | #include <labimg.hxx> | |||
50 | #include <section.hxx> | |||
51 | #include <pagedesc.hxx> | |||
52 | #include <poolfmt.hxx> | |||
53 | ||||
54 | #include <strings.hrc> | |||
55 | #include <swabstdlg.hxx> | |||
56 | ||||
57 | #include <IDocumentDeviceAccess.hxx> | |||
58 | ||||
59 | #include "appenv.hxx" | |||
60 | #include <memory> | |||
61 | ||||
62 | using namespace ::com::sun::star; | |||
63 | ||||
64 | const char MASTER_LABEL[] = "MasterLabel"; | |||
65 | ||||
66 | static const SwFrameFormat *lcl_InsertBCText( SwWrtShell& rSh, const SwLabItem& rItem, | |||
67 | SwFrameFormat &rFormat, | |||
68 | sal_uInt16 nCol, sal_uInt16 nRow ) | |||
69 | { | |||
70 | SfxItemSet aSet( | |||
71 | rSh.GetAttrPool(), svl::Items<RES_VERT_ORIENT, RES_ANCHOR>{}); | |||
72 | sal_uInt16 nPhyPageNum, nVirtPageNum; | |||
73 | rSh.GetPageNum( nPhyPageNum, nVirtPageNum ); | |||
74 | ||||
75 | //anchor frame to page | |||
76 | aSet.Put( SwFormatAnchor( RndStdIds::FLY_AT_PAGE, nPhyPageNum ) ); | |||
77 | aSet.Put( SwFormatHoriOrient( rItem.m_lLeft + static_cast<SwTwips>(nCol) * rItem.m_lHDist, | |||
78 | text::HoriOrientation::NONE, text::RelOrientation::PAGE_FRAME ) ); | |||
79 | aSet.Put( SwFormatVertOrient( rItem.m_lUpper + static_cast<SwTwips>(nRow) * rItem.m_lVDist, | |||
80 | text::VertOrientation::NONE, text::RelOrientation::PAGE_FRAME ) ); | |||
81 | const SwFrameFormat *pFormat = rSh.NewFlyFrame(aSet, true, &rFormat ); // Insert Fly | |||
82 | OSL_ENSURE( pFormat, "Fly not inserted" )do { if (true && (!(pFormat))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/app/applab.cxx" ":" "82" ": "), "%s", "Fly not inserted"); } } while (false); | |||
83 | ||||
84 | rSh.UnSelectFrame(); //Frame was selected automatically | |||
85 | ||||
86 | rSh.SetTextFormatColl( rSh.GetTextCollFromPool( RES_POOLCOLL_STANDARD ) ); | |||
87 | ||||
88 | if(!rItem.m_bSynchron || !(nCol|nRow)) | |||
89 | { | |||
90 | SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create(); | |||
91 | ::GlossarySetActGroup fnSetActGroup = pFact->SetGlossaryActGroupFunc(); | |||
92 | if ( fnSetActGroup ) | |||
93 | (*fnSetActGroup)( rItem.m_sGlossaryGroup ); | |||
94 | SwGlossaryHdl* pGlosHdl = rSh.GetView().GetGlosHdl(); | |||
95 | pGlosHdl->SetCurGroup(rItem.m_sGlossaryGroup, true); | |||
96 | pGlosHdl->InsertGlossary( rItem.m_sGlossaryBlockName ); | |||
97 | } | |||
98 | ||||
99 | return pFormat; | |||
100 | } | |||
101 | ||||
102 | static const SwFrameFormat *lcl_InsertLabText( SwWrtShell& rSh, const SwLabItem& rItem, | |||
103 | SwFrameFormat &rFormat, SwFieldMgr& rFieldMgr, | |||
104 | sal_uInt16 nCol, sal_uInt16 nRow, bool bLast ) | |||
105 | { | |||
106 | SfxItemSet aSet( | |||
107 | rSh.GetAttrPool(), svl::Items<RES_VERT_ORIENT, RES_ANCHOR>{}); | |||
108 | sal_uInt16 nPhyPageNum, nVirtPageNum; | |||
109 | rSh.GetPageNum( nPhyPageNum, nVirtPageNum ); | |||
110 | ||||
111 | //anchor frame to page | |||
112 | aSet.Put( SwFormatAnchor( RndStdIds::FLY_AT_PAGE, nPhyPageNum ) ); | |||
113 | aSet.Put( SwFormatHoriOrient( rItem.m_lLeft + static_cast<SwTwips>(nCol) * rItem.m_lHDist, | |||
114 | text::HoriOrientation::NONE, text::RelOrientation::PAGE_FRAME ) ); | |||
115 | aSet.Put( SwFormatVertOrient( rItem.m_lUpper + static_cast<SwTwips>(nRow) * rItem.m_lVDist, | |||
116 | text::VertOrientation::NONE, text::RelOrientation::PAGE_FRAME ) ); | |||
117 | const SwFrameFormat *pFormat = rSh.NewFlyFrame(aSet, true, &rFormat ); // Insert Fly | |||
118 | OSL_ENSURE( pFormat, "Fly not inserted" )do { if (true && (!(pFormat))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/app/applab.cxx" ":" "118" ": "), "%s", "Fly not inserted"); } } while (false ); | |||
119 | ||||
120 | rSh.UnSelectFrame(); //Frame was selected automatically | |||
121 | ||||
122 | rSh.SetTextFormatColl( rSh.GetTextCollFromPool( RES_POOLCOLL_STANDARD ) ); | |||
123 | ||||
124 | // If applicable "next dataset" | |||
125 | OUString sDBName; | |||
126 | if( (!rItem.m_bSynchron || !(nCol|nRow)) && !(sDBName = InsertLabEnvText( rSh, rFieldMgr, rItem.m_aWriting )).isEmpty() && !bLast ) | |||
127 | { | |||
128 | sDBName = comphelper::string::setToken(sDBName, 3, DB_DELIMu'\x00ff', "True"); | |||
129 | SwInsertField_Data aData(SwFieldTypesEnum::DatabaseNextSet, 0, sDBName, OUString(), 0, &rSh); | |||
130 | rFieldMgr.InsertField( aData ); | |||
131 | } | |||
132 | ||||
133 | return pFormat; | |||
134 | } | |||
135 | ||||
136 | void SwModule::InsertLab(SfxRequest& rReq, bool bLabel) | |||
137 | { | |||
138 | static sal_uInt16 nLabelTitleNo = 0; | |||
139 | static sal_uInt16 nBCTitleNo = 0; | |||
140 | ||||
141 | #if HAVE_FEATURE_DBCONNECTIVITY1 | |||
142 | // Create DB-Manager | |||
143 | std::unique_ptr<SwDBManager, o3tl::default_delete<SwDBManager>> pDBManager(new SwDBManager(nullptr)); | |||
144 | #endif | |||
145 | ||||
146 | // Read SwLabItem from Config | |||
147 | SwLabCfgItem aLabCfg(bLabel); | |||
148 | ||||
149 | // Move up Dialog | |||
150 | SfxItemSet aSet( GetPool(), svl::Items<FN_LABEL(20000 + 1051 ), FN_LABEL(20000 + 1051 )>{} ); | |||
151 | aSet.Put( aLabCfg.GetItem() ); | |||
152 | ||||
153 | SwAbstractDialogFactory* pDialogFactory = SwAbstractDialogFactory::Create(); | |||
154 | ||||
155 | ScopedVclPtr<AbstractSwLabDlg> pDlg(pDialogFactory->CreateSwLabDlg(rReq.GetFrameWeld(), aSet, | |||
| ||||
156 | #if HAVE_FEATURE_DBCONNECTIVITY1 | |||
157 | pDBManager.get(), | |||
158 | #else | |||
159 | NULL__null, | |||
160 | #endif | |||
161 | bLabel)); | |||
162 | ||||
163 | if ( RET_OK != pDlg->Execute() ) | |||
164 | return; | |||
165 | ||||
166 | // Read dialog, store item in config | |||
167 | const SwLabItem& rItem = static_cast<const SwLabItem&>( pDlg-> | |||
168 | GetOutputItemSet()->Get(FN_LABEL(20000 + 1051 ))); | |||
169 | aLabCfg.GetItem() = rItem; | |||
170 | aLabCfg.Commit(); | |||
171 | ||||
172 | // Create new document | |||
173 | SfxObjectShellLock xDocSh( new SwDocShell( SfxObjectCreateMode::STANDARD)); | |||
174 | xDocSh->DoInitNew(); | |||
175 | ||||
176 | // Printer | |||
177 | Printer *pPrt = pDlg->GetPrt(); | |||
178 | if (pPrt) | |||
179 | { | |||
180 | SwDocShell *pDocSh = static_cast<SwDocShell*>(&*xDocSh); | |||
181 | pDocSh->getIDocumentDeviceAccess().setJobsetup(pPrt->GetJobSetup()); | |||
182 | } | |||
183 | ||||
184 | SfxViewFrame* pViewFrame = SfxViewFrame::DisplayNewDocument( *xDocSh, rReq ); | |||
185 | ||||
186 | SwView *pNewView = static_cast<SwView*>( pViewFrame->GetViewShell()); | |||
187 | pNewView->AttrChangedNotify(nullptr);// So that SelectShell is being called. | |||
188 | ||||
189 | // Set document title | |||
190 | OUString aTmp; | |||
191 | if(bLabel) | |||
192 | { | |||
193 | aTmp = SwResId( STR_LAB_TITLEreinterpret_cast<char const *>("STR_LAB_TITLE" "\004" u8"Labels" )) + | |||
194 | OUString::number(++nLabelTitleNo ); | |||
195 | } | |||
196 | else | |||
197 | { | |||
198 | aTmp = pDlg->GetBusinessCardStr() + | |||
199 | OUString::number( ++nBCTitleNo ); | |||
200 | } | |||
201 | xDocSh->SetTitle( aTmp ); | |||
202 | ||||
203 | pViewFrame->GetFrame().Appear(); | |||
204 | ||||
205 | // Determine Shell | |||
206 | SwWrtShell *pSh = pNewView->GetWrtShellPtr(); | |||
207 | OSL_ENSURE( pSh, "missing WrtShell" )do { if (true && (!(pSh))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/app/applab.cxx" ":" "207" ": "), "%s", "missing WrtShell"); } } while (false ); | |||
208 | ||||
209 | { // block for locks the dispatcher!! | |||
210 | ||||
211 | SwWait aWait( static_cast<SwDocShell&>(*xDocSh), true ); | |||
212 | ||||
213 | CurrShell aCurr(pSh); | |||
214 | pSh->SetLabelDoc(rItem.m_bSynchron); | |||
215 | pSh->DoUndo( false ); | |||
216 | pSh->StartAllAction(); | |||
217 | ||||
218 | pSh->SetNewDoc(); // Avoid performance problems | |||
219 | ||||
220 | SwPageDesc aDesc = pSh->GetPageDesc( 0 ); | |||
221 | SwFrameFormat& rFormat = aDesc.GetMaster(); | |||
222 | ||||
223 | // Borders | |||
224 | SvxLRSpaceItem aLRMargin( RES_LR_SPACE ); | |||
225 | SvxULSpaceItem aULMargin( RES_UL_SPACE ); | |||
226 | aLRMargin.SetLeft (static_cast<sal_uInt16>(rItem.m_lLeft) ); | |||
227 | aULMargin.SetUpper(static_cast<sal_uInt16>(rItem.m_lUpper)); | |||
228 | aLRMargin.SetRight( 0 ); | |||
229 | aULMargin.SetLower( 0 ); | |||
230 | rFormat.SetFormatAttr(aLRMargin); | |||
231 | rFormat.SetFormatAttr(aULMargin); | |||
232 | ||||
233 | // Header and footer | |||
234 | rFormat.SetFormatAttr(SwFormatHeader(false)); | |||
235 | aDesc.ChgHeaderShare(false); | |||
236 | rFormat.SetFormatAttr(SwFormatFooter(false)); | |||
237 | aDesc.ChgFooterShare(false); | |||
238 | ||||
239 | aDesc.SetUseOn(UseOnPage::All); // Site numbering | |||
240 | ||||
241 | // Set page size | |||
242 | long lPgWidth, lPgHeight; | |||
243 | lPgWidth = std::max<sal_Int32>(rItem.m_lPWidth, MINLAY23); | |||
244 | lPgHeight = std::max<sal_Int32>(rItem.m_lPHeight, MINLAY23); | |||
245 | rFormat.SetFormatAttr( SwFormatFrameSize( SwFrameSize::Fixed, lPgWidth, lPgHeight )); | |||
246 | // Numbering type | |||
247 | SvxNumberType aType; | |||
248 | aType.SetNumberingType(SVX_NUM_NUMBER_NONE); | |||
249 | aDesc.SetNumType( aType ); | |||
250 | ||||
251 | // Followup template | |||
252 | const SwPageDesc &rFollow = pSh->GetPageDesc( pSh->GetCurPageDesc() ); | |||
253 | aDesc.SetFollow( &rFollow ); | |||
254 | ||||
255 | pPrt = pSh->getIDocumentDeviceAccess().getPrinter( true ); | |||
256 | SvxPaperBinItem aItem( RES_PAPER_BIN ); | |||
257 | aItem.SetValue(static_cast<sal_Int8>(pPrt->GetPaperBin())); | |||
258 | rFormat.SetFormatAttr(aItem); | |||
259 | ||||
260 | // Determine orientation of the resulting page | |||
261 | aDesc.SetLandscape(rItem.m_lPWidth > rItem.m_lPHeight); | |||
262 | ||||
263 | pSh->ChgPageDesc( 0, aDesc ); | |||
264 | ||||
265 | // Insert frame | |||
266 | std::unique_ptr<SwFieldMgr> pFieldMgr(new SwFieldMgr); | |||
267 | pFieldMgr->SetEvalExpFields(false); | |||
268 | ||||
269 | // Prepare border template | |||
270 | SwFrameFormat* pFormat = pSh->GetFrameFormatFromPool( RES_POOLFRM_LABEL ); | |||
271 | sal_Int32 iResultWidth = rItem.m_lLeft + (rItem.m_nCols - 1) * rItem.m_lHDist + rItem.m_lWidth - rItem.m_lPWidth; | |||
272 | sal_Int32 iResultHeight = rItem.m_lUpper + (rItem.m_nRows - 1) * rItem.m_lVDist + rItem.m_lHeight - rItem.m_lPHeight; | |||
273 | sal_Int32 iWidth = (iResultWidth > 0 ? rItem.m_lWidth - (iResultWidth / rItem.m_nCols) - 1 : rItem.m_lWidth); | |||
274 | sal_Int32 iHeight = (iResultHeight > 0 ? rItem.m_lHeight - (iResultHeight / rItem.m_nRows) - 1 : rItem.m_lHeight); | |||
275 | SwFormatFrameSize aFrameSize( SwFrameSize::Fixed, iWidth, iHeight ); | |||
276 | pFormat->SetFormatAttr( aFrameSize ); | |||
277 | ||||
278 | //frame represents label itself, no border space | |||
279 | SvxULSpaceItem aFrameNoULSpace( 0, 0, RES_UL_SPACE ); | |||
280 | SvxLRSpaceItem aFrameNoLRSpace( 0, 0, 0, 0, RES_LR_SPACE ); | |||
281 | pFormat->SetFormatAttr( aFrameNoULSpace ); | |||
282 | pFormat->SetFormatAttr( aFrameNoLRSpace ); | |||
283 | ||||
284 | const SwFrameFormat *pFirstFlyFormat = nullptr; | |||
285 | if ( rItem.m_bPage ) | |||
286 | { | |||
287 | SwFormatVertOrient aFrameVertOrient( pFormat->GetVertOrient() ); | |||
288 | aFrameVertOrient.SetVertOrient( text::VertOrientation::TOP ); | |||
289 | pFormat->SetFormatAttr(aFrameVertOrient); | |||
290 | ||||
291 | for ( sal_Int32 i = 0; i < rItem.m_nRows; ++i ) | |||
292 | { | |||
293 | for ( sal_Int32 j = 0; j < rItem.m_nCols; ++j ) | |||
294 | { | |||
295 | pSh->Push(); | |||
296 | const SwFrameFormat *pTmp = ( bLabel ? | |||
297 | lcl_InsertLabText( *pSh, rItem, *pFormat, *pFieldMgr, j, i, | |||
298 | i == rItem.m_nRows - 1 && j == rItem.m_nCols - 1 ) : | |||
299 | lcl_InsertBCText( *pSh, rItem, *pFormat, j, i ) ); | |||
300 | if (!(i|j)) | |||
301 | { | |||
302 | pFirstFlyFormat = pTmp; | |||
303 | ||||
304 | if (rItem.m_bSynchron) | |||
305 | { | |||
306 | // if there is no content in the fly then | |||
307 | // don't leave the fly!!! | |||
308 | pSh->Push(); | |||
309 | pSh->StartOfSection(); | |||
310 | bool bInFly = nullptr != pSh->WizardGetFly(); | |||
311 | pSh->Pop(bInFly ? SwCursorShell::PopMode::DeleteStack : SwCursorShell::PopMode::DeleteCurrent); | |||
312 | ||||
313 | if( bInFly ) | |||
314 | pSh->EndOfSection(true); // select all content | |||
315 | // in the fly | |||
316 | else | |||
317 | pSh->SetMark(); // set only the mark | |||
318 | ||||
319 | SwSectionData aSect(SectionType::Content, MASTER_LABEL); | |||
320 | pSh->InsertSection(aSect); | |||
321 | } | |||
322 | } | |||
323 | else if (rItem.m_bSynchron) | |||
324 | { | |||
325 | SwSectionData aSect(SectionType::FileLink, | |||
326 | pSh->GetUniqueSectionName()); | |||
327 | OUString sLinkName = | |||
328 | OUStringChar(sfx2::cTokenSeparator) + | |||
329 | OUStringChar(sfx2::cTokenSeparator) + | |||
330 | MASTER_LABEL; | |||
331 | aSect.SetLinkFileName(sLinkName); | |||
332 | aSect.SetProtectFlag(true); | |||
333 | pSh->Insert("."); // Dummytext to allocate the Section | |||
334 | pSh->StartOfSection(); | |||
335 | pSh->EndOfSection(true); // Select everything in the frame | |||
336 | pSh->InsertSection(aSect); | |||
337 | } | |||
338 | pSh->Pop(SwCursorShell::PopMode::DeleteCurrent); | |||
339 | } | |||
340 | } | |||
341 | } | |||
342 | else | |||
343 | { | |||
344 | pFirstFlyFormat = bLabel ? | |||
345 | lcl_InsertLabText( *pSh, rItem, *pFormat, *pFieldMgr, | |||
346 | static_cast< sal_uInt16 >(rItem.m_nCol - 1), | |||
347 | static_cast< sal_uInt16 >(rItem.m_nRow - 1), true ) : | |||
348 | lcl_InsertBCText(*pSh, rItem, *pFormat, | |||
349 | static_cast< sal_uInt16 >(rItem.m_nCol - 1), | |||
350 | static_cast< sal_uInt16 >(rItem.m_nRow - 1)); | |||
351 | } | |||
352 | ||||
353 | //fill the user fields | |||
354 | if(!bLabel) | |||
355 | { | |||
356 | uno::Reference< frame::XModel > xModel = pSh->GetView().GetDocShell()->GetBaseModel(); | |||
357 | OSL_ENSURE(pDialogFactory, "SwAbstractDialogFactory fail!")do { if (true && (!(pDialogFactory))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/app/applab.cxx" ":" "357" ": "), "%s", "SwAbstractDialogFactory fail!"); } } while (false); | |||
358 | SwLabDlgMethod SwLabDlgUpdateFieldInformation = pDialogFactory->GetSwLabDlgStaticMethod (); | |||
359 | SwLabDlgUpdateFieldInformation(xModel, rItem); | |||
360 | } | |||
361 | ||||
362 | pFieldMgr->SetEvalExpFields(true); | |||
363 | pFieldMgr->EvalExpFields(pSh); | |||
364 | ||||
365 | pFieldMgr.reset(); | |||
366 | ||||
367 | if (pFirstFlyFormat) | |||
368 | pSh->GotoFly(pFirstFlyFormat->GetName(), FLYCNTTYPE_ALL, false); | |||
369 | ||||
370 | if (pSh->IsAnyDatabaseFieldInDoc()) | |||
371 | pSh->GetView().ShowUIElement("private:resource/toolbar/mailmerge"); | |||
372 | ||||
373 | pSh->EndAllAction(); | |||
374 | pSh->DoUndo(); | |||
375 | } | |||
376 | ||||
377 | if( rItem.m_aWriting.indexOf( '<' ) >= 0 ) | |||
378 | { | |||
379 | // Open database browser on recently used database | |||
380 | ShowDBObj( *pNewView, pSh->GetDBData() ); | |||
381 | } | |||
382 | ||||
383 | if( rItem.m_bSynchron ) | |||
384 | { | |||
385 | SfxDispatcher* pDisp = pViewFrame->GetDispatcher(); | |||
386 | assert(pDisp && "No dispatcher in frame?")(static_cast <bool> (pDisp && "No dispatcher in frame?" ) ? void (0) : __assert_fail ("pDisp && \"No dispatcher in frame?\"" , "/home/maarten/src/libreoffice/core/sw/source/uibase/app/applab.cxx" , 386, __extension__ __PRETTY_FUNCTION__)); | |||
387 | pDisp->Execute(FN_SYNC_LABELS((20000 + 1600) + 143), SfxCallMode::ASYNCHRON); | |||
388 | } | |||
389 | rReq.SetReturnValue(SfxVoidItem(bLabel ? FN_LABEL(20000 + 1051 ) : FN_BUSINESS_CARD(20000 + 1052))); | |||
390 | ||||
391 | } | |||
392 | ||||
393 | /* 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 |