Bug Summary

File:home/maarten/src/libreoffice/core/include/rtl/ref.hxx
Warning:line 192, column 9
Use of memory after it is freed

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name viewling.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D SW_DLLIMPLEMENTATION -D SWUI_DLL_NAME="libswuilo.so" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sw/source/core/inc -I /home/maarten/src/libreoffice/core/sw/source/filter/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sw/sdi -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/sw/generated -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx

/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx

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 <hintids.hxx>
21
22#include <com/sun/star/lang/Locale.hpp>
23#include <com/sun/star/linguistic2/XThesaurus.hpp>
24#include <com/sun/star/linguistic2/ProofreadingResult.hpp>
25#include <com/sun/star/linguistic2/XLinguProperties.hpp>
26#include <com/sun/star/i18n/TextConversionOption.hpp>
27#include <comphelper/lok.hxx>
28#include <comphelper/processfactory.hxx>
29#include <comphelper/propertyvalue.hxx>
30#include <comphelper/propertysequence.hxx>
31#include <comphelper/scopeguard.hxx>
32#include <toolkit/helper/vclunohelper.hxx>
33#include <vcl/weld.hxx>
34#include <svtools/ehdl.hxx>
35#include <sfx2/dispatch.hxx>
36#include <sfx2/viewfrm.hxx>
37#include <sfx2/request.hxx>
38#include <svx/dialmgr.hxx>
39#include <svx/svxerr.hxx>
40#include <svx/svxdlg.hxx>
41#include <swwait.hxx>
42#include <uitool.hxx>
43#include <view.hxx>
44#include <wrtsh.hxx>
45#include <viewopt.hxx>
46#include <swundo.hxx>
47#include <hyp.hxx>
48#include <olmenu.hxx>
49#include <pam.hxx>
50#include <edtwin.hxx>
51#include <ndtxt.hxx>
52#include <txtfrm.hxx>
53#include <cmdid.h>
54#include <strings.hrc>
55#include <hhcwrp.hxx>
56
57#include <boost/property_tree/json_parser.hpp>
58
59#include <com/sun/star/ui/dialogs/XExecutableDialog.hpp>
60#include <com/sun/star/ui/ContextMenuExecuteEvent.hpp>
61#include <com/sun/star/lang/XInitialization.hpp>
62#include <com/sun/star/frame/XDispatch.hpp>
63#include <com/sun/star/frame/XDispatchProvider.hpp>
64#include <com/sun/star/frame/XFrame.hpp>
65#include <com/sun/star/frame/XPopupMenuController.hpp>
66#include <com/sun/star/awt/PopupMenuDirection.hpp>
67#include <com/sun/star/util/URL.hpp>
68#include <com/sun/star/beans/PropertyValue.hpp>
69#include <com/sun/star/beans/XPropertySet.hpp>
70#include <com/sun/star/util/URLTransformer.hpp>
71#include <com/sun/star/util/XURLTransformer.hpp>
72
73#include <vcl/svapp.hxx>
74#include <rtl/ustring.hxx>
75
76#include <cppuhelper/bootstrap.hxx>
77#include <svtools/langtab.hxx>
78
79#include <editeng/editerr.hxx>
80#include <LibreOfficeKit/LibreOfficeKitEnums.h>
81
82#include <memory>
83
84using namespace sw::mark;
85using namespace ::com::sun::star;
86using namespace ::com::sun::star::beans;
87using namespace ::com::sun::star::uno;
88using namespace ::com::sun::star::linguistic2;
89
90// Lingu-Dispatcher
91
92void SwView::ExecLingu(SfxRequest &rReq)
93{
94 switch(rReq.GetSlot())
1
Control jumps to 'case 10245:' at line 96
95 {
96 case SID_THESAURUS( 10000 + 245 ):
97 StartThesaurus();
2
Calling 'SwView::StartThesaurus'
98 rReq.Ignore();
99 break;
100 case SID_HANGUL_HANJA_CONVERSION( 10000 + 959 ):
101 StartTextConversion( LANGUAGE_KOREANLanguageType(0x0412), LANGUAGE_KOREANLanguageType(0x0412), nullptr,
102 i18n::TextConversionOption::CHARACTER_BY_CHARACTER, true );
103 break;
104 case SID_CHINESE_CONVERSION( 10000 + 1016 ):
105 {
106 //open ChineseTranslationDialog
107 Reference< XComponentContext > xContext(
108 ::cppu::defaultBootstrap_InitialComponentContext() ); //@todo get context from calc if that has one
109 if(xContext.is())
110 {
111 Reference< lang::XMultiComponentFactory > xMCF( xContext->getServiceManager() );
112 if(xMCF.is())
113 {
114 Reference< ui::dialogs::XExecutableDialog > xDialog(
115 xMCF->createInstanceWithContext(
116 "com.sun.star.linguistic2.ChineseTranslationDialog", xContext),
117 UNO_QUERY);
118 Reference< lang::XInitialization > xInit( xDialog, UNO_QUERY );
119 if( xInit.is() )
120 {
121 Reference<awt::XWindow> xParentWindow;
122 if (weld::Window* pParentWindow = rReq.GetFrameWeld())
123 xParentWindow = pParentWindow->GetXWindow();
124 // initialize dialog
125 uno::Sequence<uno::Any> aSeq(comphelper::InitAnyPropertySequence(
126 {
127 {"ParentWindow", uno::Any(xParentWindow)}
128 }));
129 xInit->initialize( aSeq );
130
131 //execute dialog
132 sal_Int16 nDialogRet = xDialog->execute();
133 if( RET_OK == nDialogRet )
134 {
135 //get some parameters from the dialog
136 bool bToSimplified = true;
137 bool bUseVariants = true;
138 bool bCommonTerms = true;
139 Reference< beans::XPropertySet > xProp( xDialog, UNO_QUERY );
140 if( xProp.is() )
141 {
142 try
143 {
144 xProp->getPropertyValue( "IsDirectionToSimplified" ) >>= bToSimplified;
145 xProp->getPropertyValue( "IsUseCharacterVariants" ) >>= bUseVariants;
146 xProp->getPropertyValue( "IsTranslateCommonTerms" ) >>= bCommonTerms;
147 }
148 catch (const Exception&)
149 {
150 }
151 }
152
153 //execute translation
154 LanguageType nSourceLang = bToSimplified ? LANGUAGE_CHINESE_TRADITIONALLanguageType(0x0404) : LANGUAGE_CHINESE_SIMPLIFIEDLanguageType(0x0804);
155 LanguageType nTargetLang = bToSimplified ? LANGUAGE_CHINESE_SIMPLIFIEDLanguageType(0x0804) : LANGUAGE_CHINESE_TRADITIONALLanguageType(0x0404);
156 sal_Int32 nOptions = bUseVariants ? i18n::TextConversionOption::USE_CHARACTER_VARIANTS : 0;
157 if( !bCommonTerms )
158 nOptions = nOptions | i18n::TextConversionOption::CHARACTER_BY_CHARACTER;
159
160 vcl::Font aTargetFont = OutputDevice::GetDefaultFont( DefaultFontType::CJK_TEXT,
161 nTargetLang, GetDefaultFontFlags::OnlyOne );
162
163 // disallow formatting, updating the view, ... while
164 // converting the document. (saves time)
165 // Also remember the current view and cursor position for later
166 m_pWrtShell->StartAction();
167
168 // remember cursor position data for later restoration of the cursor
169 const SwPosition *pPoint = m_pWrtShell->GetCursor()->GetPoint();
170 bool bRestoreCursor = pPoint->nNode.GetNode().IsTextNode();
171 const SwNodeIndex aPointNodeIndex( pPoint->nNode );
172 sal_Int32 nPointIndex = pPoint->nContent.GetIndex();
173
174 // since this conversion is not interactive the whole converted
175 // document should be undone in a single undo step.
176 m_pWrtShell->StartUndo( SwUndoId::OVERWRITE );
177
178 StartTextConversion( nSourceLang, nTargetLang, &aTargetFont, nOptions, false );
179
180 m_pWrtShell->EndUndo( SwUndoId::OVERWRITE );
181
182 if (bRestoreCursor)
183 {
184 SwTextNode *pTextNode = aPointNodeIndex.GetNode().GetTextNode();
185 // check for unexpected error case
186 OSL_ENSURE(pTextNode && pTextNode->GetText().getLength() >= nPointIndex,do { if (true && (!(pTextNode && pTextNode->
GetText().getLength() >= nPointIndex))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx"
":" "187" ": "), "%s", "text missing: corrupted node?"); } }
while (false)
187 "text missing: corrupted node?" )do { if (true && (!(pTextNode && pTextNode->
GetText().getLength() >= nPointIndex))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx"
":" "187" ": "), "%s", "text missing: corrupted node?"); } }
while (false)
;
188 if (!pTextNode || pTextNode->GetText().getLength() < nPointIndex)
189 nPointIndex = 0;
190 // restore cursor to its original position
191 m_pWrtShell->GetCursor()->GetPoint()->nContent.Assign( pTextNode, nPointIndex );
192 }
193
194 // enable all, restore view and cursor position
195 m_pWrtShell->EndAction();
196 }
197 }
198 Reference< lang::XComponent > xComponent( xDialog, UNO_QUERY );
199 if( xComponent.is() )
200 xComponent->dispose();
201 }
202 }
203 break;
204 }
205 case FN_HYPHENATE_OPT_DLG((20000 + 600) + 5 ):
206 HyphenateDocument();
207 break;
208 default:
209 OSL_ENSURE(false, "wrong Dispatcher")do { if (true && (!(false))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx"
":" "209" ": "), "%s", "wrong Dispatcher"); } } while (false
)
;
210 return;
211 }
212}
213
214// start language specific text conversion
215
216void SwView::StartTextConversion(
217 LanguageType nSourceLang,
218 LanguageType nTargetLang,
219 const vcl::Font *pTargetFont,
220 sal_Int32 nOptions,
221 bool bIsInteractive )
222{
223 // do not do text conversion if it is active elsewhere
224 if (SwEditShell::HasConvIter())
225 {
226 return;
227 }
228
229 SpellContext();
230
231 const SwViewOption* pVOpt = m_pWrtShell->GetViewOptions();
232 const bool bOldIdle = pVOpt->IsIdle();
233 pVOpt->SetIdle( false );
234
235 bool bOldIns = m_pWrtShell->IsInsMode();
236 m_pWrtShell->SetInsMode();
237
238 const bool bSelection = static_cast<SwCursorShell*>(m_pWrtShell.get())->HasSelection() ||
239 m_pWrtShell->GetCursor() != m_pWrtShell->GetCursor()->GetNext();
240
241 const bool bStart = bSelection || m_pWrtShell->IsStartOfDoc();
242 const bool bOther = !bSelection && !(m_pWrtShell->GetFrameType(nullptr,true) & FrameTypeFlags::BODY);
243
244 {
245 const uno::Reference< uno::XComponentContext > xContext(
246 comphelper::getProcessComponentContext() );
247 SwHHCWrapper aWrap( this, xContext, nSourceLang, nTargetLang, pTargetFont,
248 nOptions, bIsInteractive,
249 bStart, bOther, bSelection );
250 aWrap.Convert();
251 }
252
253 m_pWrtShell->SetInsMode( bOldIns );
254 pVOpt->SetIdle( bOldIdle );
255 SpellContext(false);
256}
257
258// spellcheck and text conversion related stuff
259
260void SwView::SpellStart( SvxSpellArea eWhich,
261 bool bStartDone, bool bEndDone,
262 SwConversionArgs *pConvArgs )
263{
264 Reference< XLinguProperties > xProp = ::GetLinguPropertySet();
265 bool bIsWrapReverse = !pConvArgs && xProp.is() && xProp->getIsWrapReverse();
266
267 SwDocPositions eStart = SwDocPositions::Start;
268 SwDocPositions eEnd = SwDocPositions::End;
269 SwDocPositions eCurr = SwDocPositions::Curr;
270 switch ( eWhich )
271 {
272 case SvxSpellArea::Body:
273 if( bIsWrapReverse )
274 eCurr = SwDocPositions::End;
275 else
276 eCurr = SwDocPositions::Start;
277 break;
278 case SvxSpellArea::BodyEnd:
279 if( bIsWrapReverse )
280 {
281 if( bStartDone )
282 eStart = SwDocPositions::Curr;
283 eCurr = SwDocPositions::End;
284 }
285 else if( bStartDone )
286 eCurr = SwDocPositions::Start;
287 break;
288 case SvxSpellArea::BodyStart:
289 if( !bIsWrapReverse )
290 {
291 if( bEndDone )
292 eEnd = SwDocPositions::Curr;
293 eCurr = SwDocPositions::Start;
294 }
295 else if( bEndDone )
296 eCurr = SwDocPositions::End;
297 break;
298 case SvxSpellArea::Other:
299 if( bIsWrapReverse )
300 {
301 eStart = SwDocPositions::OtherStart;
302 eEnd = SwDocPositions::OtherEnd;
303 eCurr = SwDocPositions::OtherEnd;
304 }
305 else
306 {
307 eStart = SwDocPositions::OtherStart;
308 eEnd = SwDocPositions::OtherEnd;
309 eCurr = SwDocPositions::OtherStart;
310 }
311 break;
312 default:
313 OSL_ENSURE( false, "SpellStart with unknown Area" )do { if (true && (!(false))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx"
":" "313" ": "), "%s", "SpellStart with unknown Area"); } } while
(false)
;
314 }
315 m_pWrtShell->SpellStart( eStart, eEnd, eCurr, pConvArgs );
316}
317
318// Error message while Spelling
319
320// The passed pointer nlang is itself the value
321void SwView::SpellError(LanguageType eLang)
322{
323 int nPend = 0;
324
325 if ( m_pWrtShell->ActionPend() )
326 {
327 m_pWrtShell->Push();
328 m_pWrtShell->ClearMark();
329 do
330 {
331 m_pWrtShell->EndAction();
332 ++nPend;
333 }
334 while( m_pWrtShell->ActionPend() );
335 }
336 OUString aErr(SvtLanguageTable::GetLanguageString( eLang ) );
337
338 SwEditWin &rEditWin = GetEditWin();
339 int nWaitCnt = 0;
340 while( rEditWin.IsWait() )
341 {
342 rEditWin.LeaveWait();
343 ++nWaitCnt;
344 }
345 if ( LANGUAGE_NONELanguageType(0x00FF) == eLang )
346 ErrorHandler::HandleError( ERRCODE_SVX_LINGU_NOLANGUAGEErrCode( ErrCodeArea::Svx, ErrCodeClass::NotExists, 9 ) );
347 else
348 ErrorHandler::HandleError( *new StringErrorInfo( ERRCODE_SVX_LINGU_LANGUAGENOTEXISTSErrCode(ErrCodeArea::Svx, 2), aErr ) );
349
350 while( nWaitCnt )
351 {
352 rEditWin.EnterWait();
353 --nWaitCnt;
354 }
355
356 if ( nPend )
357 {
358 while( nPend-- )
359 m_pWrtShell->StartAction();
360 m_pWrtShell->Combine();
361 }
362}
363
364// Finish spelling and restore cursor
365
366void SwView::SpellEnd( SwConversionArgs const *pConvArgs )
367{
368 m_pWrtShell->SpellEnd( pConvArgs );
369 if( m_pWrtShell->IsExtMode() )
370 m_pWrtShell->SetMark();
371}
372
373void SwView::HyphStart( SvxSpellArea eWhich )
374{
375 switch ( eWhich )
376 {
377 case SvxSpellArea::Body:
378 m_pWrtShell->HyphStart( SwDocPositions::Start, SwDocPositions::End );
379 break;
380 case SvxSpellArea::BodyEnd:
381 m_pWrtShell->HyphStart( SwDocPositions::Curr, SwDocPositions::End );
382 break;
383 case SvxSpellArea::BodyStart:
384 m_pWrtShell->HyphStart( SwDocPositions::Start, SwDocPositions::Curr );
385 break;
386 case SvxSpellArea::Other:
387 m_pWrtShell->HyphStart( SwDocPositions::OtherStart, SwDocPositions::OtherEnd );
388 break;
389 default:
390 OSL_ENSURE( false, "HyphStart with unknown Area" )do { if (true && (!(false))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx"
":" "390" ": "), "%s", "HyphStart with unknown Area"); } } while
(false)
;
391 }
392}
393
394// Interactive separation
395
396void SwView::HyphenateDocument()
397{
398 // do not hyphenate if interactive hyphenation is active elsewhere
399 if (SwEditShell::HasHyphIter())
400 {
401 std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(GetEditWin().GetFrameWeld(),
402 VclMessageType::Warning, VclButtonsType::Ok, SwResId(STR_MULT_INTERACT_HYPH_WARNreinterpret_cast<char const *>("STR_MULT_INTERACT_HYPH_WARN"
"\004" u8"The interactive hyphenation is already active\nin a different document"
)
)));
403 xBox->set_title(SwResId(STR_HYPH_TITLEreinterpret_cast<char const *>("STR_HYPH_TITLE" "\004" u8"Hyphenation"
)
));
404 xBox->run();
405 return;
406 }
407
408 SfxErrorContext aContext( ERRCTX_SVX_LINGU_HYPHENATION3, OUString(), m_pEditWin->GetFrameWeld(),
409 RID_SVXERRCTX, SvxResLocale() );
410
411 Reference< XHyphenator > xHyph( ::GetHyphenator() );
412 if (!xHyph.is())
413 {
414 ErrorHandler::HandleError( ERRCODE_SVX_LINGU_LINGUNOTEXISTSErrCode( ErrCodeArea::Svx, ErrCodeClass::NotExists, 3 ) );
415 return;
416 }
417
418 if (m_pWrtShell->GetSelectionType() & (SelectionType::DrawObjectEditMode|SelectionType::DrawObject))
419 {
420 // Hyphenation in a Draw object
421 HyphenateDrawText();
422 }
423 else
424 {
425 SwViewOption* pVOpt = const_cast<SwViewOption*>(m_pWrtShell->GetViewOptions());
426 bool bOldIdle = pVOpt->IsIdle();
427 pVOpt->SetIdle( false );
428
429 Reference< XLinguProperties > xProp( ::GetLinguPropertySet() );
430
431 m_pWrtShell->StartUndo(SwUndoId::INSATTR); // valid later
432
433 bool bHyphSpecial = xProp.is() && xProp->getIsHyphSpecial();
434 bool bSelection = static_cast<SwCursorShell*>(m_pWrtShell.get())->HasSelection() ||
435 m_pWrtShell->GetCursor() != m_pWrtShell->GetCursor()->GetNext();
436 bool bOther = m_pWrtShell->HasOtherCnt() && bHyphSpecial && !bSelection;
437 bool bStart = bSelection || ( !bOther && m_pWrtShell->IsStartOfDoc() );
438 bool bStop = false;
439 if( !bOther && !(m_pWrtShell->GetFrameType(nullptr,true) & FrameTypeFlags::BODY) && !bSelection )
440 // turned on no special area
441 {
442 // I want also in special areas hyphenation
443 std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(GetEditWin().GetFrameWeld(),
444 VclMessageType::Question, VclButtonsType::YesNo,
445 SwResId(STR_QUERY_SPECIAL_FORCEDreinterpret_cast<char const *>("STR_QUERY_SPECIAL_FORCED"
"\004" u8"Check special regions is deactivated. Check anyway?"
)
)));
446 if (xBox->run() == RET_YES)
447 {
448 bOther = true;
449 if (xProp.is())
450 {
451 xProp->setIsHyphSpecial( true );
452 }
453 }
454 else
455 bStop = true; // No hyphenation
456 }
457
458 if( !bStop )
459 {
460 SwHyphWrapper aWrap( this, xHyph, bStart, bOther, bSelection );
461 aWrap.SpellDocument();
462 m_pWrtShell->EndUndo(SwUndoId::INSATTR);
463 }
464 pVOpt->SetIdle( bOldIdle );
465 }
466}
467
468bool SwView::IsValidSelectionForThesaurus() const
469{
470 // must not be a multi-selection, and if it is a selection it needs
471 // to be within a single paragraph
472
473 const bool bMultiSel = m_pWrtShell->GetCursor()->IsMultiSelection();
474 const bool bSelection = static_cast<SwCursorShell*>(m_pWrtShell.get())->HasSelection();
475 return !bMultiSel && (!bSelection || m_pWrtShell->IsSelOnePara() );
476}
477
478OUString SwView::GetThesaurusLookUpText( bool bSelection ) const
479{
480 return bSelection ? m_pWrtShell->GetSelText() : m_pWrtShell->GetCurWord();
481}
482
483void SwView::InsertThesaurusSynonym( const OUString &rSynonmText, const OUString &rLookUpText, bool bSelection )
484{
485 bool bOldIns = m_pWrtShell->IsInsMode();
486 m_pWrtShell->SetInsMode();
487
488 m_pWrtShell->StartAllAction();
489 m_pWrtShell->StartUndo(SwUndoId::DELETE);
490
491 if( !bSelection )
492 {
493 if(m_pWrtShell->IsEndWrd())
494 m_pWrtShell->Left(CRSR_SKIP_CELLS, false, 1, false );
495
496 m_pWrtShell->SelWrd();
497
498 // make sure the selection build later from the data below does not
499 // include "in word" character to the left and right in order to
500 // preserve those. Therefore count those "in words" in order to modify
501 // the selection accordingly.
502 const sal_Unicode* pChar = rLookUpText.getStr();
503 sal_Int32 nLeft = 0;
504 while (*pChar++ == CH_TXTATR_INWORDu'\xFFF9')
505 ++nLeft;
506 pChar = rLookUpText.getLength() ? rLookUpText.getStr() + rLookUpText.getLength() - 1 : nullptr;
507 sal_Int32 nRight = 0;
508 while (pChar && *pChar-- == CH_TXTATR_INWORDu'\xFFF9')
509 ++nRight;
510
511 // adjust existing selection
512 SwPaM *pCursor = m_pWrtShell->GetCursor();
513 pCursor->GetPoint()->nContent -= nRight;
514 pCursor->GetMark()->nContent += nLeft;
515 }
516
517 m_pWrtShell->Insert( rSynonmText );
518
519 m_pWrtShell->EndUndo(SwUndoId::DELETE);
520 m_pWrtShell->EndAllAction();
521
522 m_pWrtShell->SetInsMode( bOldIns );
523}
524
525// Start thesaurus
526
527void SwView::StartThesaurus()
528{
529 if (!IsValidSelectionForThesaurus())
3
Taking false branch
530 return;
531
532 SfxErrorContext aContext( ERRCTX_SVX_LINGU_THESAURUS1, OUString(), m_pEditWin->GetFrameWeld(),
533 RID_SVXERRCTX, SvxResLocale() );
534
535 // Determine language
536 LanguageType eLang = m_pWrtShell->GetCurLang();
537 if( LANGUAGE_SYSTEMLanguageType(0x0000) == eLang )
4
Taking false branch
538 eLang = GetAppLanguage();
539
540 if( eLang == LANGUAGE_DONTKNOWLanguageType(0x03FF) || eLang == LANGUAGE_NONELanguageType(0x00FF) )
5
Taking false branch
541 {
542 SpellError( LANGUAGE_NONELanguageType(0x00FF) );
543 return;
544 }
545
546 SwViewOption* pVOpt = const_cast<SwViewOption*>(m_pWrtShell->GetViewOptions());
547 const bool bOldIdle = pVOpt->IsIdle();
548 pVOpt->SetIdle( false );
549 comphelper::ScopeGuard guard([&]() { pVOpt->SetIdle(bOldIdle); }); // restore when leaving scope
550
551 // get initial LookUp text
552 const bool bSelection = static_cast<SwCursorShell*>(m_pWrtShell.get())->HasSelection();
553 OUString aTmp = GetThesaurusLookUpText( bSelection );
554
555 Reference< XThesaurus > xThes( ::GetThesaurus() );
556
557 if ( !xThes.is() || !xThes->hasLocale( LanguageTag::convertToLocale( eLang ) ) )
6
Assuming the condition is false
7
Taking false branch
558 SpellError( eLang );
559 else
560 {
561 VclPtr<AbstractThesaurusDialog> pDlg;
562 // create dialog
563 { //Scope for SwWait-Object
564 SwWait aWait( *GetDocShell(), true );
565 // load library with dialog only on demand ...
566 SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create();
567 pDlg.reset(pFact->CreateThesaurusDialog(GetEditWin().GetFrameWeld(), xThes, aTmp, eLang));
8
Calling 'VclPtr::reset'
14
Returning from 'VclPtr::reset'
15
Calling implicit destructor for 'VclPtr<AbstractThesaurusDialog>'
16
Calling '~Reference'
23
Returning from '~Reference'
24
Returning from destructor for 'VclPtr<AbstractThesaurusDialog>'
568 }
569
570 if (pDlg)
25
Calling 'VclPtr::operator bool'
571 {
572 guard.dismiss(); // ignore, we'll call SetIdle() explicitly after the dialog ends
573
574 pDlg->StartExecuteAsync([aTmp, bSelection, bOldIdle, pDlg, pVOpt, this](sal_Int32 nResult){
575 if (nResult == RET_OK )
576 InsertThesaurusSynonym(pDlg->GetWord(), aTmp, bSelection);
577
578 pVOpt->SetIdle(bOldIdle);
579 pDlg->disposeOnce();
580 });
581 }
582 }
583}
584
585// Offer online suggestions
586
587namespace {
588
589//!! Start of extra code for context menu modifying extensions
590struct ExecuteInfo
591{
592 uno::Reference< frame::XDispatch > xDispatch;
593 util::URL aTargetURL;
594 uno::Sequence< PropertyValue > aArgs;
595};
596
597class AsyncExecute
598{
599public:
600 DECL_STATIC_LINK( AsyncExecute, ExecuteHdl_Impl, void*, void )static void LinkStubExecuteHdl_Impl(void *, void*); static void
ExecuteHdl_Impl(AsyncExecute *, void*)
;
601};
602
603}
604
605IMPL_STATIC_LINK( AsyncExecute, ExecuteHdl_Impl, void*, p, void )void AsyncExecute::LinkStubExecuteHdl_Impl(void * instance, void
* data) { return ExecuteHdl_Impl(static_cast<AsyncExecute *
>(instance), data); } void AsyncExecute::ExecuteHdl_Impl(__attribute__
((unused)) AsyncExecute *, void* p)
606{
607 ExecuteInfo* pExecuteInfo = static_cast<ExecuteInfo*>(p);
608 SolarMutexReleaser aReleaser;
609 try
610 {
611 // Asynchronous execution as this can lead to our own destruction!
612 // Framework can recycle our current frame and the layout manager disposes all user interface
613 // elements if a component gets detached from its frame!
614 pExecuteInfo->xDispatch->dispatch( pExecuteInfo->aTargetURL, pExecuteInfo->aArgs );
615 }
616 catch (const Exception&)
617 {
618 }
619
620 delete pExecuteInfo;
621}
622//!! End of extra code for context menu modifying extensions
623
624bool SwView::ExecSpellPopup(const Point& rPt)
625{
626 bool bRet = false;
627 const SwViewOption* pVOpt = m_pWrtShell->GetViewOptions();
628 if( pVOpt->IsOnlineSpell() &&
629 !m_pWrtShell->IsSelection())
630 {
631 if (m_pWrtShell->GetSelectionType() & SelectionType::DrawObjectEditMode)
632 bRet = ExecDrwTextSpellPopup(rPt);
633 else if (!m_pWrtShell->IsSelFrameMode())
634 {
635 const bool bOldViewLock = m_pWrtShell->IsViewLocked();
636 m_pWrtShell->LockView( true );
637 m_pWrtShell->Push();
638 SwRect aToFill;
639
640 SwCursorShell *pCursorShell = m_pWrtShell.get();
641 SwPaM *pCursor = pCursorShell->GetCursor();
642 SwPosition aPoint(*pCursor->GetPoint());
643 const SwTextNode *pNode = aPoint.nNode.GetNode().GetTextNode();
644
645 // Spell-check in case the idle jobs haven't had a chance to kick in.
646 // This makes it possible to suggest spelling corrections for
647 // wrong words independent of the spell-checking idle job.
648 if (pNode && pNode->IsWrongDirty() &&
649 !pCursorShell->IsTableMode() &&
650 !pCursor->HasMark() && !pCursor->IsMultiSelection())
651 {
652 std::pair<Point, bool> const tmp(rPt, false);
653 SwContentFrame *const pContentFrame = pCursor->GetContentNode()->getLayoutFrame(
654 pCursorShell->GetLayout(),
655 &aPoint, &tmp);
656 if (pContentFrame)
657 {
658 SwRect aRepaint(static_cast<SwTextFrame*>(pContentFrame)->AutoSpell_(
659 *pCursor->GetContentNode()->GetTextNode(), 0));
660 if (aRepaint.HasArea())
661 m_pWrtShell->InvalidateWindows(aRepaint);
662 }
663 }
664
665 // decide which variant of the context menu to use...
666 // if neither spell checking nor grammar checking provides suggestions use the
667 // default context menu.
668 bool bUseGrammarContext = false;
669 Reference< XSpellAlternatives > xAlt( m_pWrtShell->GetCorrection(&rPt, aToFill) );
670 ProofreadingResult aGrammarCheckRes;
671 sal_Int32 nErrorInResult = -1;
672 uno::Sequence< OUString > aSuggestions;
673 bool bCorrectionRes = false;
674 if (!xAlt.is() || !xAlt->getAlternatives().hasElements())
675 {
676 sal_Int32 nErrorPosInText = -1;
677 bCorrectionRes = m_pWrtShell->GetGrammarCorrection( aGrammarCheckRes, nErrorPosInText, nErrorInResult, aSuggestions, &rPt, aToFill );
678 OUString aMessageText;
679 if (nErrorInResult >= 0)
680 aMessageText = aGrammarCheckRes.aErrors[ nErrorInResult ].aShortComment;
681 // we like to use the grammar checking context menu if we either get
682 // some suggestions or at least a comment about the error found...
683 bUseGrammarContext = bCorrectionRes &&
684 (aSuggestions.hasElements() || !aMessageText.isEmpty());
685 }
686
687 // open respective context menu for spell check or grammar errors with correction suggestions...
688 if ((!bUseGrammarContext && xAlt.is()) ||
689 (bUseGrammarContext && bCorrectionRes && aGrammarCheckRes.aErrors.hasElements()))
690 {
691 // get paragraph text
692 OUString aParaText;
693 if (pNode)
694 aParaText = pNode->GetText(); // this may include hidden text but that should be Ok
695 else
696 {
697 OSL_FAIL("text node expected but not found" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/uiview/viewling.cxx"
":" "697" ": "), "%s", "text node expected but not found"); }
} while (false)
;
698 }
699
700 bRet = true;
701 m_pWrtShell->SttSelect();
702 std::unique_ptr<SwSpellPopup> xPopup(bUseGrammarContext ?
703 new SwSpellPopup(m_pWrtShell.get(), aGrammarCheckRes, nErrorInResult, aSuggestions, aParaText) :
704 new SwSpellPopup(m_pWrtShell.get(), xAlt, aParaText));
705 ui::ContextMenuExecuteEvent aEvent;
706 const Point aPixPos = GetEditWin().LogicToPixel( rPt );
707
708 aEvent.SourceWindow = VCLUnoHelper::GetInterface( m_pEditWin );
709 aEvent.ExecutePosition.X = aPixPos.X();
710 aEvent.ExecutePosition.Y = aPixPos.Y();
711 ScopedVclPtr<Menu> pMenu;
712
713 OUString sMenuName = bUseGrammarContext ?
714 OUString("private:resource/GrammarContextMenu") : OUString("private:resource/SpellContextMenu");
715 if (TryContextMenuInterception(xPopup->GetMenu(), sMenuName, pMenu, aEvent))
716 {
717 //! happy hacking for context menu modifying extensions of this
718 //! 'custom made' menu... *sigh* (code copied from sfx2 and framework)
719 if ( pMenu )
720 {
721 const sal_uInt16 nId = static_cast<PopupMenu*>(pMenu.get())->Execute(m_pEditWin, aPixPos);
722 OUString aCommand = static_cast<PopupMenu*>(pMenu.get())->GetItemCommand(nId);
723 if (aCommand.isEmpty() )
724 {
725 if (!ExecuteMenuCommand(dynamic_cast<PopupMenu&>(*pMenu), *GetViewFrame(), nId))
726 xPopup->Execute(nId);
727 }
728 else
729 {
730 SfxViewFrame *pSfxViewFrame = GetViewFrame();
731 uno::Reference< frame::XFrame > xFrame;
732 if ( pSfxViewFrame )
733 xFrame = pSfxViewFrame->GetFrame().GetFrameInterface();
734 css::util::URL aURL;
735 uno::Reference< frame::XDispatchProvider > xDispatchProvider( xFrame, UNO_QUERY );
736
737 try
738 {
739 uno::Reference< frame::XDispatch > xDispatch;
740 uno::Reference< util::XURLTransformer > xURLTransformer = util::URLTransformer::create(comphelper::getProcessComponentContext());
741
742 aURL.Complete = aCommand;
743 xURLTransformer->parseStrict(aURL);
744 uno::Sequence< beans::PropertyValue > aArgs;
745 xDispatch = xDispatchProvider->queryDispatch( aURL, OUString(), 0 );
746
747 if (xDispatch.is())
748 {
749 // Execute dispatch asynchronously
750 ExecuteInfo* pExecuteInfo = new ExecuteInfo;
751 pExecuteInfo->xDispatch = xDispatch;
752 pExecuteInfo->aTargetURL = aURL;
753 pExecuteInfo->aArgs = aArgs;
754 Application::PostUserEvent( LINK(nullptr, AsyncExecute , ExecuteHdl_Impl)::tools::detail::makeLink( ::tools::detail::castTo<AsyncExecute
*>(nullptr), &AsyncExecute::LinkStubExecuteHdl_Impl)
, pExecuteInfo );
755 }
756 }
757 catch (const Exception&)
758 {
759 }
760 }
761 }
762 else
763 {
764 if (comphelper::LibreOfficeKit::isActive())
765 {
766 if (SfxViewShell* pViewShell = SfxViewShell::Current())
767 {
768 boost::property_tree::ptree aMenu = SfxDispatcher::fillPopupMenu(&xPopup->GetMenu());
769 boost::property_tree::ptree aRoot;
770 aRoot.add_child("menu", aMenu);
771
772 std::stringstream aStream;
773 boost::property_tree::write_json(aStream, aRoot, true);
774 pViewShell->libreOfficeKitViewCallback(LOK_CALLBACK_CONTEXT_MENU, aStream.str().c_str());
775 }
776 }
777 else
778 {
779 xPopup->Execute(aToFill.SVRect(), m_pEditWin);
780 }
781 }
782 }
783 }
784
785 if (!comphelper::LibreOfficeKit::isActive())
786 m_pWrtShell->Pop(SwCursorShell::PopMode::DeleteCurrent);
787 m_pWrtShell->LockView( bOldViewLock );
788 }
789 }
790 return bRet;
791}
792
793/** Function: ExecSmartTagPopup
794
795 This function shows the popup menu for smarttag
796 actions.
797*/
798void SwView::ExecSmartTagPopup( const Point& rPt )
799{
800 const bool bOldViewLock = m_pWrtShell->IsViewLocked();
801 m_pWrtShell->LockView( true );
802 m_pWrtShell->Push();
803
804 css::uno::Sequence< css::uno::Any > aArgs( 2 );
805 aArgs[0] <<= comphelper::makePropertyValue( "Frame", GetDispatcher().GetFrame()->GetFrame().GetFrameInterface() );
806 aArgs[1] <<= comphelper::makePropertyValue( "CommandURL", OUString( ".uno:OpenSmartTagMenuOnCursor" ) );
807
808 css::uno::Reference< css::uno::XComponentContext > xContext = comphelper::getProcessComponentContext();
809 css::uno::Reference< css::frame::XPopupMenuController > xPopupController(
810 xContext->getServiceManager()->createInstanceWithArgumentsAndContext(
811 "com.sun.star.comp.svx.SmartTagMenuController", aArgs, xContext ), css::uno::UNO_QUERY );
812
813 css::uno::Reference< css::awt::XPopupMenu > xPopupMenu( xContext->getServiceManager()->createInstanceWithContext(
814 "com.sun.star.awt.PopupMenu", xContext ), css::uno::UNO_QUERY );
815
816 if ( xPopupController.is() && xPopupMenu.is() )
817 {
818 xPopupController->setPopupMenu( xPopupMenu );
819
820 SwRect aToFill;
821 m_pWrtShell->GetSmartTagRect( rPt, aToFill );
822 m_pWrtShell->SttSelect();
823
824 if ( aToFill.HasArea() )
825 xPopupMenu->execute( m_pEditWin->GetComponentInterface(),
826 VCLUnoHelper::ConvertToAWTRect( m_pEditWin->LogicToPixel( aToFill.SVRect() ) ), css::awt::PopupMenuDirection::EXECUTE_DOWN );
827
828 css::uno::Reference< css::lang::XComponent > xComponent( xPopupController, css::uno::UNO_QUERY );
829 if ( xComponent.is() )
830 xComponent->dispose();
831 }
832
833 m_pWrtShell->Pop(SwCursorShell::PopMode::DeleteCurrent);
834 m_pWrtShell->LockView( bOldViewLock );
835}
836
837/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx

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
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<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 */
56template <class reference_type>
57class 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
66public:
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);
9
Calling 'Reference::set'
13
Returning from 'Reference::set'
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;
26
Calling 'Reference::get'
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
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<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 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
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
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
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
378private:
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
387protected:
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
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
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
421private:
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: */

/home/maarten/src/libreoffice/core/include/rtl/ref.hxx

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
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
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
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
16.1
Field 'm_pBody' is non-null
)
17
Taking true branch
113 m_pBody->release();
18
Calling 'VclReferenceBase::release'
22
Returning; memory was released
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
10
Assuming 'pBody' is non-null
11
Taking true branch
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld
11.1
'pOld' is null
11.1
'pOld' is null
11.1
'pOld' is null
11.1
'pOld' is null
)
12
Taking false branch
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;
27
Use of memory after it is freed
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
277namespace 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*/
286template<typename T>
287struct 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: */

/home/maarten/src/libreoffice/core/include/vcl/vclreferencebase.hxx

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
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
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)
19
Assuming the condition is true
20
Taking true branch
40 delete this;
21
Memory is released
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif