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 <rtl/ustring.hxx> | |||
21 | #include <i18nlangtag/languagetag.hxx> | |||
22 | #include <vcl/svapp.hxx> | |||
23 | #include <vcl/weld.hxx> | |||
24 | #include <svtools/langtab.hxx> | |||
25 | ||||
26 | #include <vcl/errinf.hxx> | |||
27 | #include <editeng/unolingu.hxx> | |||
28 | #include <com/sun/star/frame/XStorable.hpp> | |||
29 | #include <com/sun/star/linguistic2/XLinguProperties.hpp> | |||
30 | #include <com/sun/star/linguistic2/XSpellChecker1.hpp> | |||
31 | #include <com/sun/star/linguistic2/XHyphenator.hpp> | |||
32 | #include <com/sun/star/linguistic2/XSearchableDictionaryList.hpp> | |||
33 | #include <com/sun/star/linguistic2/XDictionary.hpp> | |||
34 | ||||
35 | #include <editeng/svxenum.hxx> | |||
36 | #include <editeng/splwrap.hxx> | |||
37 | #include <editeng/edtdlg.hxx> | |||
38 | #include <editeng/eerdll.hxx> | |||
39 | #include <editeng/editrids.hrc> | |||
40 | #include <editeng/editerr.hxx> | |||
41 | ||||
42 | #include <map> | |||
43 | #include <memory> | |||
44 | ||||
45 | using namespace ::com::sun::star; | |||
46 | using namespace ::com::sun::star::uno; | |||
47 | using namespace ::com::sun::star::beans; | |||
48 | using namespace ::com::sun::star::linguistic2; | |||
49 | ||||
50 | ||||
51 | // misc functions --------------------------------------------- | |||
52 | ||||
53 | void SvxPrepareAutoCorrect( OUString &rOldText, const OUString &rNewText ) | |||
54 | { | |||
55 | // This function should be used to strip (or add) trailing '.' from | |||
56 | // the strings before passing them on to the autocorrect function in | |||
57 | // order that the autocorrect function will hopefully | |||
58 | // works properly with normal words and abbreviations (with trailing '.') | |||
59 | // independent of if they are at the end of the sentence or not. | |||
60 | // | |||
61 | // rOldText: text to be replaced | |||
62 | // rNewText: replacement text | |||
63 | ||||
64 | sal_Int32 nOldLen = rOldText.getLength(); | |||
65 | sal_Int32 nNewLen = rNewText.getLength(); | |||
66 | if (nOldLen && nNewLen) | |||
67 | { | |||
68 | bool bOldHasDot = '.' == rOldText[ nOldLen - 1 ], | |||
69 | bNewHasDot = '.' == rNewText[ nNewLen - 1 ]; | |||
70 | if (bOldHasDot && !bNewHasDot | |||
71 | /*this is: !(bOldHasDot && bNewHasDot) && bOldHasDot*/) | |||
72 | rOldText = rOldText.copy( 0, nOldLen - 1 ); | |||
73 | } | |||
74 | } | |||
75 | ||||
76 | #define SVX_LANG_NEED_CHECK0 0 | |||
77 | #define SVX_LANG_OK1 1 | |||
78 | #define SVX_LANG_MISSING2 2 | |||
79 | #define SVX_LANG_MISSING_DO_WARN3 3 | |||
80 | ||||
81 | typedef std::map< LanguageType, sal_uInt16 > LangCheckState_map_t; | |||
82 | ||||
83 | static LangCheckState_map_t & GetLangCheckState() | |||
84 | { | |||
85 | static LangCheckState_map_t aLangCheckState; | |||
86 | return aLangCheckState; | |||
87 | } | |||
88 | ||||
89 | void SvxSpellWrapper::ShowLanguageErrors() | |||
90 | { | |||
91 | // display message boxes for languages not available for | |||
92 | // spellchecking or hyphenation | |||
93 | LangCheckState_map_t &rLCS = GetLangCheckState(); | |||
94 | for (auto const& elem : rLCS) | |||
95 | { | |||
96 | LanguageType nLang = elem.first; | |||
97 | sal_uInt16 nVal = elem.second; | |||
98 | sal_uInt16 nTmpSpell = nVal & 0x00FF; | |||
99 | sal_uInt16 nTmpHyph = (nVal >> 8) & 0x00FF; | |||
100 | ||||
101 | if (SVX_LANG_MISSING_DO_WARN3 == nTmpSpell) | |||
102 | { | |||
103 | OUString aErr( SvtLanguageTable::GetLanguageString( nLang ) ); | |||
104 | ErrorHandler::HandleError( | |||
105 | *new StringErrorInfo( ERRCODE_SVX_LINGU_LANGUAGENOTEXISTSErrCode(ErrCodeArea::Svx, 2), aErr ) ); | |||
106 | nTmpSpell = SVX_LANG_MISSING2; | |||
107 | } | |||
108 | if (SVX_LANG_MISSING_DO_WARN3 == nTmpHyph) | |||
109 | { | |||
110 | OUString aErr( SvtLanguageTable::GetLanguageString( nLang ) ); | |||
111 | ErrorHandler::HandleError( | |||
112 | *new StringErrorInfo( ERRCODE_SVX_LINGU_LANGUAGENOTEXISTSErrCode(ErrCodeArea::Svx, 2), aErr ) ); | |||
113 | nTmpHyph = SVX_LANG_MISSING2; | |||
114 | } | |||
115 | ||||
116 | rLCS[ nLang ] = (nTmpHyph << 8) | nTmpSpell; | |||
117 | } | |||
118 | ||||
119 | } | |||
120 | ||||
121 | SvxSpellWrapper::~SvxSpellWrapper() | |||
122 | { | |||
123 | } | |||
124 | ||||
125 | /*-------------------------------------------------------------------- | |||
126 | * Description: Constructor, the test sequence is determined | |||
127 | * | |||
128 | * !bStart && !bOtherCntnt: BODY_END, BODY_START, OTHER | |||
129 | * !bStart && bOtherCntnt: OTHER, BODY | |||
130 | * bStart && !bOtherCntnt: BODY_END, OTHER | |||
131 | * bStart && bOtherCntnt: OTHER | |||
132 | * | |||
133 | --------------------------------------------------------------------*/ | |||
134 | ||||
135 | SvxSpellWrapper::SvxSpellWrapper( weld::Window* pWn, | |||
136 | const bool bStart, const bool bIsAllRight ) : | |||
137 | ||||
138 | pWin ( pWn ), | |||
139 | bOtherCntnt ( false ), | |||
140 | bStartChk ( false ), | |||
141 | bRevAllowed ( true ), | |||
142 | bAllRight ( bIsAllRight ) | |||
143 | { | |||
144 | Reference< linguistic2::XLinguProperties > xProp( LinguMgr::GetLinguPropertySet() ); | |||
145 | bool bWrapReverse = xProp.is() && xProp->getIsWrapReverse(); | |||
146 | bReverse = bWrapReverse; | |||
147 | bStartDone = !bReverse && bStart; | |||
148 | bEndDone = bReverse && bStart; | |||
149 | } | |||
150 | ||||
151 | ||||
152 | SvxSpellWrapper::SvxSpellWrapper( weld::Window* pWn, | |||
153 | Reference< XHyphenator > const &xHyphenator, | |||
154 | const bool bStart, const bool bOther ) : | |||
155 | pWin ( pWn ), | |||
156 | xHyph ( xHyphenator ), | |||
157 | bOtherCntnt ( bOther ), | |||
158 | bReverse ( false ), | |||
159 | bStartDone ( bOther || bStart ), | |||
160 | bEndDone ( false ), | |||
161 | bStartChk ( bOther ), | |||
162 | bRevAllowed ( false ), | |||
163 | bAllRight ( true ) | |||
164 | { | |||
165 | } | |||
166 | ||||
167 | ||||
168 | sal_Int16 SvxSpellWrapper::CheckSpellLang( | |||
169 | Reference< XSpellChecker1 > const & xSpell, LanguageType nLang) | |||
170 | { | |||
171 | LangCheckState_map_t &rLCS = GetLangCheckState(); | |||
172 | ||||
173 | LangCheckState_map_t::iterator aIt( rLCS.find( nLang ) ); | |||
174 | sal_uInt16 nVal = aIt == rLCS.end() ? SVX_LANG_NEED_CHECK0 : aIt->second; | |||
175 | ||||
176 | if (aIt == rLCS.end()) | |||
177 | rLCS[ nLang ] = nVal; | |||
178 | ||||
179 | if (SVX_LANG_NEED_CHECK0 == (nVal & 0x00FF)) | |||
180 | { | |||
181 | sal_uInt16 nTmpVal = SVX_LANG_MISSING_DO_WARN3; | |||
182 | if (xSpell.is() && xSpell->hasLanguage( static_cast<sal_uInt16>(nLang) )) | |||
183 | nTmpVal = SVX_LANG_OK1; | |||
184 | nVal &= 0xFF00; | |||
185 | nVal |= nTmpVal; | |||
186 | ||||
187 | rLCS[ nLang ] = nVal; | |||
188 | } | |||
189 | ||||
190 | return static_cast<sal_Int16>(nVal); | |||
191 | } | |||
192 | ||||
193 | sal_Int16 SvxSpellWrapper::CheckHyphLang( | |||
194 | Reference< XHyphenator > const & xHyph, LanguageType nLang) | |||
195 | { | |||
196 | LangCheckState_map_t &rLCS = GetLangCheckState(); | |||
197 | ||||
198 | LangCheckState_map_t::iterator aIt( rLCS.find( nLang ) ); | |||
199 | sal_uInt16 nVal = aIt == rLCS.end() ? 0 : aIt->second; | |||
200 | ||||
201 | if (aIt == rLCS.end()) | |||
202 | rLCS[ nLang ] = nVal; | |||
203 | ||||
204 | if (SVX_LANG_NEED_CHECK0 == ((nVal >> 8) & 0x00FF)) | |||
205 | { | |||
206 | sal_uInt16 nTmpVal = SVX_LANG_MISSING_DO_WARN3; | |||
207 | if (xHyph.is() && xHyph->hasLocale( LanguageTag::convertToLocale( nLang ) )) | |||
208 | nTmpVal = SVX_LANG_OK1; | |||
209 | nVal &= 0x00FF; | |||
210 | nVal |= nTmpVal << 8; | |||
211 | ||||
212 | rLCS[ nLang ] = nVal; | |||
213 | } | |||
214 | ||||
215 | return static_cast<sal_Int16>(nVal); | |||
216 | } | |||
217 | ||||
218 | ||||
219 | void SvxSpellWrapper::SpellStart( SvxSpellArea /*eSpell*/ ) | |||
220 | { // Here, the necessary preparations be made for SpellContinue in the | |||
221 | } // given area. | |||
222 | ||||
223 | ||||
224 | bool SvxSpellWrapper::SpellMore() | |||
225 | { | |||
226 | return false; // Should additional documents be examined? | |||
227 | } | |||
228 | ||||
229 | ||||
230 | void SvxSpellWrapper::SpellEnd() | |||
231 | { // Area is complete, tidy up if necessary | |||
232 | ||||
233 | // display error for last language not found | |||
234 | ShowLanguageErrors(); | |||
235 | } | |||
236 | ||||
237 | void SvxSpellWrapper::SpellContinue() | |||
238 | { | |||
239 | } | |||
240 | ||||
241 | void SvxSpellWrapper::ReplaceAll( const OUString & ) | |||
242 | { // Replace Word from the Replace list | |||
243 | } | |||
244 | ||||
245 | void SvxSpellWrapper::InsertHyphen( const sal_Int32 ) | |||
246 | { // inserting and deleting Hyphen | |||
247 | } | |||
248 | ||||
249 | // Testing of the document areas in the order specified by the flags | |||
250 | void SvxSpellWrapper::SpellDocument( ) | |||
251 | { | |||
252 | if ( bOtherCntnt ) | |||
| ||||
253 | { | |||
254 | bReverse = false; | |||
255 | SpellStart( SvxSpellArea::Other ); | |||
256 | } | |||
257 | else | |||
258 | { | |||
259 | bStartChk = bReverse; | |||
260 | SpellStart( bReverse ? SvxSpellArea::BodyStart : SvxSpellArea::BodyEnd ); | |||
261 | } | |||
262 | ||||
263 | if ( !FindSpellError() ) | |||
264 | return; | |||
265 | ||||
266 | Reference< XHyphenatedWord > xHyphWord( GetLast(), UNO_QUERY ); | |||
267 | ||||
268 | if (xHyphWord.is()) | |||
269 | { | |||
270 | EditAbstractDialogFactory* pFact = EditAbstractDialogFactory::Create(); | |||
271 | ScopedVclPtr<AbstractHyphenWordDialog> pDlg(pFact->CreateHyphenWordDialog( | |||
272 | pWin, | |||
273 | xHyphWord->getWord(), | |||
274 | LanguageTag( xHyphWord->getLocale() ).getLanguageType(), | |||
275 | xHyph, this )); | |||
276 | pDlg->Execute(); | |||
277 | } | |||
278 | } | |||
279 | ||||
280 | ||||
281 | // Select the next area | |||
282 | ||||
283 | ||||
284 | bool SvxSpellWrapper::SpellNext( ) | |||
285 | { | |||
286 | Reference< linguistic2::XLinguProperties > xProp( LinguMgr::GetLinguPropertySet() ); | |||
287 | bool bWrapReverse = xProp.is() && xProp->getIsWrapReverse(); | |||
288 | bool bActRev = bRevAllowed && bWrapReverse; | |||
289 | ||||
290 | // bActRev is the direction after Spell checking, bReverse is the one | |||
291 | // at the beginning. | |||
292 | if( bActRev == bReverse ) | |||
293 | { // No change of direction, thus is the | |||
294 | if( bStartChk ) // desired area ( bStartChk ) | |||
295 | bStartDone = true; // completely processed. | |||
296 | else | |||
297 | bEndDone = true; | |||
298 | } | |||
299 | else if( bReverse == bStartChk ) //For a change of direction, an area can | |||
300 | { // be processed during certain circumstances | |||
301 | if( bStartChk ) // If the first part is spell checked in backwards | |||
302 | bEndDone = true; // and this is reversed in the process, then | |||
303 | else // then the end part is processed (and vice-versa). | |||
304 | bStartDone = true; | |||
305 | } | |||
306 | ||||
307 | bReverse = bActRev; | |||
308 | if( bOtherCntnt && bStartDone && bEndDone ) // Document has been fully checked? | |||
309 | { | |||
310 | if ( SpellMore() ) // spell check another document? | |||
311 | { | |||
312 | bOtherCntnt = false; | |||
313 | bStartDone = !bReverse; | |||
314 | bEndDone = bReverse; | |||
315 | SpellStart( SvxSpellArea::Body ); | |||
316 | return true; | |||
317 | } | |||
318 | return false; | |||
319 | } | |||
320 | ||||
321 | bool bGoOn = false; | |||
322 | ||||
323 | if ( bOtherCntnt ) | |||
324 | { | |||
325 | bStartChk = false; | |||
326 | SpellStart( SvxSpellArea::Body ); | |||
327 | bGoOn = true; | |||
328 | } | |||
329 | else if ( bStartDone && bEndDone ) | |||
330 | { | |||
331 | if ( SpellMore() ) // check another document? | |||
332 | { | |||
333 | bOtherCntnt = false; | |||
334 | bStartDone = !bReverse; | |||
335 | bEndDone = bReverse; | |||
336 | SpellStart( SvxSpellArea::Body ); | |||
337 | return true; | |||
338 | } | |||
339 | } | |||
340 | else | |||
341 | { | |||
342 | // a BODY_area done, ask for the other BODY_area | |||
343 | xWait.reset(); | |||
344 | ||||
345 | const char* pResId = bReverse ? RID_SVXSTR_QUERY_BW_CONTINUEreinterpret_cast<char const *>("RID_SVXSTR_QUERY_BW_CONTINUE" "\004" u8"Continue checking at end of document?") : RID_SVXSTR_QUERY_CONTINUEreinterpret_cast<char const *>("RID_SVXSTR_QUERY_CONTINUE" "\004" u8"Continue checking at beginning of document?"); | |||
346 | std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(pWin, | |||
347 | VclMessageType::Question, VclButtonsType::YesNo, | |||
348 | EditResId(pResId))); | |||
349 | if (xBox->run() != RET_YES) | |||
350 | { | |||
351 | // sacrifice the other area if necessary ask for special area | |||
352 | xWait.reset(new weld::WaitObject(pWin)); | |||
353 | bStartDone = bEndDone = true; | |||
354 | return SpellNext(); | |||
355 | } | |||
356 | else | |||
357 | { | |||
358 | bStartChk = !bStartDone; | |||
359 | SpellStart( bStartChk ? SvxSpellArea::BodyStart : SvxSpellArea::BodyEnd ); | |||
360 | bGoOn = true; | |||
361 | } | |||
362 | xWait.reset(new weld::WaitObject(pWin)); | |||
363 | } | |||
364 | return bGoOn; | |||
365 | } | |||
366 | ||||
367 | ||||
368 | Reference< XDictionary > SvxSpellWrapper::GetAllRightDic() | |||
369 | { | |||
370 | Reference< XDictionary > xDic; | |||
371 | ||||
372 | Reference< XSearchableDictionaryList > xDicList( LinguMgr::GetDictionaryList() ); | |||
373 | if (xDicList.is()) | |||
374 | { | |||
375 | Sequence< Reference< XDictionary > > aDics( xDicList->getDictionaries() ); | |||
376 | const Reference< XDictionary > *pDic = aDics.getConstArray(); | |||
377 | sal_Int32 nCount = aDics.getLength(); | |||
378 | ||||
379 | sal_Int32 i = 0; | |||
380 | while (!xDic.is() && i < nCount) | |||
381 | { | |||
382 | Reference< XDictionary > xTmp = pDic[i]; | |||
383 | if (xTmp.is()) | |||
384 | { | |||
385 | if ( xTmp->isActive() && | |||
386 | xTmp->getDictionaryType() != DictionaryType_NEGATIVE && | |||
387 | LanguageTag( xTmp->getLocale() ).getLanguageType() == LANGUAGE_NONELanguageType(0x00FF) ) | |||
388 | { | |||
389 | Reference< frame::XStorable > xStor( xTmp, UNO_QUERY ); | |||
390 | if (xStor.is() && xStor->hasLocation() && !xStor->isReadonly()) | |||
391 | { | |||
392 | xDic = xTmp; | |||
393 | } | |||
394 | } | |||
395 | } | |||
396 | ++i; | |||
397 | } | |||
398 | ||||
399 | if (!xDic.is()) | |||
400 | { | |||
401 | xDic = LinguMgr::GetStandardDic(); | |||
402 | if (xDic.is()) | |||
403 | xDic->setActive( true ); | |||
404 | } | |||
405 | } | |||
406 | ||||
407 | return xDic; | |||
408 | } | |||
409 | ||||
410 | ||||
411 | bool SvxSpellWrapper::FindSpellError() | |||
412 | { | |||
413 | ShowLanguageErrors(); | |||
414 | ||||
415 | xWait.reset(new weld::WaitObject(pWin)); | |||
416 | bool bSpell = true; | |||
417 | ||||
418 | Reference< XDictionary > xAllRightDic; | |||
419 | if (IsAllRight()) | |||
420 | xAllRightDic = GetAllRightDic(); | |||
421 | ||||
422 | while ( bSpell ) | |||
423 | { | |||
424 | SpellContinue(); | |||
425 | ||||
426 | Reference< XSpellAlternatives > xAlt( GetLast(), UNO_QUERY ); | |||
427 | Reference< XHyphenatedWord > xHyphWord( GetLast(), UNO_QUERY ); | |||
428 | ||||
429 | if (xAlt.is()) | |||
430 | { | |||
431 | if (IsAllRight() && xAllRightDic.is()) | |||
432 | { | |||
433 | xAllRightDic->add( xAlt->getWord(), false, OUString() ); | |||
434 | } | |||
435 | else | |||
436 | { | |||
437 | // look up in ChangeAllList for misspelled word | |||
438 | Reference< XDictionary > xChangeAllList = | |||
439 | LinguMgr::GetChangeAllList(); | |||
440 | Reference< XDictionaryEntry > xEntry; | |||
441 | if (xChangeAllList.is()) | |||
442 | xEntry = xChangeAllList->getEntry( xAlt->getWord() ); | |||
443 | ||||
444 | if (xEntry.is()) | |||
445 | { | |||
446 | // replace word without asking | |||
447 | ReplaceAll( xEntry->getReplacementText() ); | |||
448 | } | |||
449 | else | |||
450 | bSpell = false; | |||
451 | } | |||
452 | } | |||
453 | else if (xHyphWord.is()) | |||
454 | bSpell = false; | |||
455 | else | |||
456 | { | |||
457 | SpellEnd(); | |||
458 | bSpell = SpellNext(); | |||
459 | } | |||
460 | } | |||
461 | xWait.reset(); | |||
462 | return GetLast().is(); | |||
463 | } | |||
464 | ||||
465 | ||||
466 | /* 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 |