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 textfld.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/shells/textfld.cxx

/home/maarten/src/libreoffice/core/sw/source/uibase/shells/textfld.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 <AnnotationWin.hxx>
21#include <comphelper/lok.hxx>
22#include <hintids.hxx>
23#include <IDocumentFieldsAccess.hxx>
24#include <sfx2/bindings.hxx>
25#include <sfx2/lnkbase.hxx>
26#include <fmtfld.hxx>
27#include <txtfld.hxx>
28#include <svl/itempool.hxx>
29#include <tools/lineend.hxx>
30#include <svl/whiter.hxx>
31#include <svl/eitem.hxx>
32#include <svl/macitem.hxx>
33#include <sfx2/viewfrm.hxx>
34#include <sfx2/request.hxx>
35#include <svx/postattr.hxx>
36#include <svx/hlnkitem.hxx>
37#include <svx/svxdlg.hxx>
38#include <fmtinfmt.hxx>
39#include <fldwrap.hxx>
40#include <redline.hxx>
41#include <view.hxx>
42#include <viewopt.hxx>
43#include <wrtsh.hxx>
44#include <textsh.hxx>
45#include <docufld.hxx>
46#include <ddefld.hxx>
47#include <fldmgr.hxx>
48#include <uitool.hxx>
49#include <cmdid.h>
50#include <strings.hrc>
51#include <sfx2/event.hxx>
52#include <swabstdlg.hxx>
53#include <doc.hxx>
54#include <PostItMgr.hxx>
55#include <swmodule.hxx>
56#include <xmloff/odffields.hxx>
57#include <IDocumentContentOperations.hxx>
58#include <IDocumentUndoRedo.hxx>
59#include <svl/zforlist.hxx>
60#include <svl/zformat.hxx>
61#include <IMark.hxx>
62#include <officecfg/Office/Compatibility.hxx>
63#include <ndtxt.hxx>
64
65
66using namespace nsSwDocInfoSubType;
67
68static OUString lcl_BuildTitleWithRedline( const SwRangeRedline *pRedline )
69{
70 const OUString sTitle(SwResId(STR_REDLINE_COMMENTreinterpret_cast<char const *>("STR_REDLINE_COMMENT" "\004"
u8"Comment: ")
));
71
72 const char* pResId = nullptr;
73 switch( pRedline->GetType() )
74 {
75 case RedlineType::Insert:
76 pResId = STR_REDLINE_INSERTEDreinterpret_cast<char const *>("STR_REDLINE_INSERTED" "\004"
u8"Insertion")
;
77 break;
78 case RedlineType::Delete:
79 pResId = STR_REDLINE_DELETEDreinterpret_cast<char const *>("STR_REDLINE_DELETED" "\004"
u8"Deletion")
;
80 break;
81 case RedlineType::Format:
82 case RedlineType::ParagraphFormat:
83 pResId = STR_REDLINE_FORMATTEDreinterpret_cast<char const *>("STR_REDLINE_FORMATTED" "\004"
u8"Formats")
;
84 break;
85 case RedlineType::Table:
86 pResId = STR_REDLINE_TABLECHGreinterpret_cast<char const *>("STR_REDLINE_TABLECHG" "\004"
u8"Table Changes")
;
87 break;
88 case RedlineType::FmtColl:
89 pResId = STR_REDLINE_FMTCOLLSETreinterpret_cast<char const *>("STR_REDLINE_FMTCOLLSET"
"\004" u8"Applied Paragraph Styles")
;
90 break;
91 default:
92 return sTitle;
93 }
94
95 return sTitle + SwResId(pResId);
96}
97
98void SwTextShell::ExecField(SfxRequest &rReq)
99{
100 SwWrtShell& rSh = GetShell();
101 const SfxPoolItem* pItem = nullptr;
102
103 sal_uInt16 nSlot = rReq.GetSlot();
104 const SfxItemSet* pArgs = rReq.GetArgs();
105 if(pArgs)
1
Assuming 'pArgs' is null
2
Taking false branch
106 pArgs->GetItemState(GetPool().GetWhich(nSlot), false, &pItem);
107
108 bool bMore = false;
109 bool bIsText = true;
110 SwFieldTypesEnum nInsertType = SwFieldTypesEnum::Date;
111 sal_uInt16 nInsertSubType = 0;
112 sal_uInt32 nInsertFormat = 0;
113
114 switch(nSlot)
3
Control jumps to 'case 20104:' at line 116
115 {
116 case FN_EDIT_FIELD((20000 + 100) + 4 ):
117 {
118 SwField* pField = rSh.GetCurField(true);
119 if( pField )
4
Assuming 'pField' is non-null
5
Taking true branch
120 {
121 switch ( pField->GetTypeId() )
6
Control jumps to the 'default' case at line 135
122 {
123 case SwFieldTypesEnum::DDE:
124 {
125 ::sfx2::SvBaseLink& rLink = static_cast<SwDDEFieldType*>(pField->GetTyp())->
126 GetBaseLink();
127 if(rLink.IsVisible())
128 {
129 SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create();
130 ScopedVclPtr<SfxAbstractLinksDialog> pDlg(pFact->CreateLinksDialog(GetView().GetFrameWeld(), &rSh.GetLinkManager(), false, &rLink));
131 pDlg->Execute();
132 }
133 break;
134 }
135 default:
136 {
137 SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create();
138 ScopedVclPtr<SfxAbstractDialog> pDlg(pFact->CreateSwFieldEditDlg( GetView() ));
7
Calling constructor for 'ScopedVclPtr<SfxAbstractDialog>'
14
Returning from constructor for 'ScopedVclPtr<SfxAbstractDialog>'
15
Calling implicit destructor for 'VclPtr<SfxAbstractDialog>'
16
Calling '~Reference'
23
Returning from '~Reference'
24
Returning from destructor for 'VclPtr<SfxAbstractDialog>'
139 pDlg->Execute();
25
Calling 'VclPtr::operator->'
140 }
141 }
142 }
143 break;
144 }
145 case FN_EXECUTE_MACROFIELD((20000 + 100) + 27):
146 {
147 SwField* pField = rSh.GetCurField();
148 if(pField && pField->GetTyp()->Which() == SwFieldIds::Macro)
149 {
150
151 const OUString& rMacro = static_cast<SwMacroField*>(pField)->GetMacro();
152 sal_Int32 nPos = rMacro.indexOf('.');
153 if(nPos != -1)
154 {
155 SvxMacro aMacro( rMacro.copy(nPos + 1), rMacro.copy(0,nPos), STARBASIC );
156 rSh.ExecMacro(aMacro);
157 }
158 }
159 }
160 break;
161
162 case FN_GOTO_NEXT_INPUTFLD((20000 + 100) + 47):
163 case FN_GOTO_PREV_INPUTFLD((20000 + 100) + 48):
164 {
165 bool bRet = false;
166 SwFieldType* pField = rSh.GetFieldType( 0, SwFieldIds::Input );
167 const bool bAddSetExpressionFields = !( rSh.GetViewOptions()->IsReadonly() );
168 if ( pField != nullptr
169 && rSh.MoveFieldType(
170 pField,
171 FN_GOTO_NEXT_INPUTFLD((20000 + 100) + 47) == nSlot,
172 SwFieldIds::Unknown,
173 bAddSetExpressionFields ) )
174 {
175 rSh.ClearMark();
176 if (!rSh.IsMultiSelection()
177 && (nullptr != dynamic_cast<const SwTextInputField*>(
178 SwCursorShell::GetTextFieldAtCursor(rSh.GetCursor(), true))))
179 {
180 rSh.SttSelect();
181 rSh.SelectText(
182 SwCursorShell::StartOfInputFieldAtPos( *(rSh.GetCursor()->Start()) ) + 1,
183 SwCursorShell::EndOfInputFieldAtPos( *(rSh.GetCursor()->Start()) ) - 1 );
184 }
185 else
186 {
187 rSh.StartInputFieldDlg(rSh.GetCurField(true), false, false, GetView().GetFrameWeld());
188 }
189 bRet = true;
190 }
191
192 rReq.SetReturnValue( SfxBoolItem( nSlot, bRet ));
193 }
194 break;
195
196 default:
197 bMore = true;
198 }
199 if(!bMore)
200 return;
201
202 // Here come the slots with FieldMgr.
203 SwFieldMgr aFieldMgr(GetShellPtr());
204 switch(nSlot)
205 {
206 case FN_INSERT_DBFIELD((20000 + 300) + 11):
207 {
208 bool bRes = false;
209 if( pItem )
210 {
211 sal_uInt32 nFormat = 0;
212 SwFieldTypesEnum nType = SwFieldTypesEnum::Date;
213 OUString aPar1 = static_cast<const SfxStringItem *>(pItem)->GetValue();
214 OUString aPar2;
215 sal_Int32 nCommand = 0;
216
217 if( SfxItemState::SET == pArgs->GetItemState( FN_PARAM_FIELD_TYPE((20000 + 1100)+54),
218 false, &pItem ))
219 nType = static_cast<SwFieldTypesEnum>(static_cast<const SfxUInt16Item *>(pItem)->GetValue());
220 aPar1 += OUStringChar(DB_DELIMu'\x00ff');
221 if( SfxItemState::SET == pArgs->GetItemState(
222 FN_PARAM_1((20000 + 1100)+60), false, &pItem ))
223 {
224 aPar1 += static_cast<const SfxStringItem *>(pItem)->GetValue();
225 }
226 if( SfxItemState::SET == pArgs->GetItemState(
227 FN_PARAM_3((20000 + 1100)+62), false, &pItem ))
228 nCommand = static_cast<const SfxInt32Item*>(pItem)->GetValue();
229 aPar1 += OUStringChar(DB_DELIMu'\x00ff')
230 + OUString::number(nCommand)
231 + OUStringChar(DB_DELIMu'\x00ff');
232 if( SfxItemState::SET == pArgs->GetItemState(
233 FN_PARAM_2((20000 + 1100)+61), false, &pItem ))
234 {
235 aPar1 += static_cast<const SfxStringItem *>(pItem)->GetValue();
236 }
237 if( SfxItemState::SET == pArgs->GetItemState(
238 FN_PARAM_FIELD_CONTENT((20000 + 1100) + 55), false, &pItem ))
239 aPar2 = static_cast<const SfxStringItem *>(pItem)->GetValue();
240 if( SfxItemState::SET == pArgs->GetItemState(
241 FN_PARAM_FIELD_FORMAT((20000 + 1100)+57), false, &pItem ))
242 nFormat = static_cast<const SfxUInt32Item *>(pItem)->GetValue();
243 OSL_FAIL("Command is not yet used")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/textfld.cxx"
":" "243" ": "), "%s", "Command is not yet used"); } } while
(false)
;
244 SwInsertField_Data aData(nType, 0, aPar1, aPar2, nFormat, GetShellPtr(), ' '/*separator*/ );
245 bRes = aFieldMgr.InsertField(aData);
246 }
247 rReq.SetReturnValue(SfxBoolItem( nSlot, bRes ));
248 }
249 break;
250 case FN_INSERT_FIELD_CTRL((20000 + 300) + 91):
251 case FN_INSERT_FIELD((20000 + 300) + 8 ):
252 {
253 bool bRes = false;
254 if( pItem && nSlot != FN_INSERT_FIELD_CTRL((20000 + 300) + 91))
255 {
256 sal_uInt32 nFormat = 0;
257 SwFieldTypesEnum nType = SwFieldTypesEnum::Date;
258 sal_uInt16 nSubType = 0;
259 OUString aPar1 = static_cast<const SfxStringItem *>(pItem)->GetValue();
260 OUString aPar2;
261 sal_Unicode cSeparator = ' ';
262
263 if( SfxItemState::SET == pArgs->GetItemState( FN_PARAM_FIELD_TYPE((20000 + 1100)+54),
264 false, &pItem ))
265 nType = static_cast<SwFieldTypesEnum>(static_cast<const SfxUInt16Item *>(pItem)->GetValue());
266 if( SfxItemState::SET == pArgs->GetItemState( FN_PARAM_FIELD_SUBTYPE((20000 + 1100)+56),
267 false, &pItem ))
268 nSubType = static_cast<const SfxUInt16Item *>(pItem)->GetValue();
269 if( SfxItemState::SET == pArgs->GetItemState(
270 FN_PARAM_FIELD_CONTENT((20000 + 1100) + 55), false, &pItem ))
271 aPar2 = static_cast<const SfxStringItem *>(pItem)->GetValue();
272 if( SfxItemState::SET == pArgs->GetItemState(
273 FN_PARAM_FIELD_FORMAT((20000 + 1100)+57), false, &pItem ))
274 nFormat = static_cast<const SfxUInt32Item *>(pItem)->GetValue();
275 if( SfxItemState::SET == pArgs->GetItemState(
276 FN_PARAM_3((20000 + 1100)+62), false, &pItem ))
277 {
278 OUString sTmp = static_cast<const SfxStringItem *>(pItem)->GetValue();
279 if(!sTmp.isEmpty())
280 cSeparator = sTmp[0];
281 }
282 SwInsertField_Data aData(nType, nSubType, aPar1, aPar2, nFormat, GetShellPtr(), cSeparator );
283 bRes = aFieldMgr.InsertField( aData );
284 }
285 else
286 {
287 //#i5788# prevent closing of the field dialog while a modal dialog ( Input field dialog ) is active
288 if(!GetView().GetViewFrame()->IsInModalMode())
289 {
290 SfxViewFrame* pVFrame = GetView().GetViewFrame();
291 pVFrame->ToggleChildWindow(FN_INSERT_FIELD((20000 + 300) + 8 ));
292 bRes = pVFrame->GetChildWindow( nSlot ) != nullptr;
293 Invalidate(rReq.GetSlot());
294 Invalidate(FN_INSERT_FIELD_CTRL((20000 + 300) + 91));
295 rReq.Ignore();
296 }
297 }
298 rReq.SetReturnValue(SfxBoolItem( nSlot, bRes ));
299 }
300 break;
301
302 case FN_INSERT_REF_FIELD((20000 + 300) + 13):
303 {
304 SfxViewFrame* pVFrame = GetView().GetViewFrame();
305 if (!pVFrame->HasChildWindow(FN_INSERT_FIELD((20000 + 300) + 8 )))
306 pVFrame->ToggleChildWindow(FN_INSERT_FIELD((20000 + 300) + 8 )); // Show dialog
307
308 // Switch Fielddlg at a new TabPage
309 sal_uInt16 nId = SwFieldDlgWrapper::GetChildWindowId();
310 SwFieldDlgWrapper *pWrp = static_cast<SwFieldDlgWrapper*>(pVFrame->GetChildWindow(nId));
311 if (pWrp)
312 pWrp->ShowReferencePage();
313 rReq.Ignore();
314 }
315 break;
316 case FN_DELETE_COMMENT((20000 + 2500)+6):
317 {
318 const SvxPostItIdItem* pIdItem = rReq.GetArg<SvxPostItIdItem>(SID_ATTR_POSTIT_IDTypedWhichId<SvxPostItIdItem>( 10000 + 47 ));
319 if (pIdItem && !pIdItem->GetValue().isEmpty() && GetView().GetPostItMgr())
320 {
321 GetView().GetPostItMgr()->Delete(pIdItem->GetValue().toUInt32());
322 }
323 else if ( GetView().GetPostItMgr() &&
324 GetView().GetPostItMgr()->HasActiveSidebarWin() )
325 {
326 GetView().GetPostItMgr()->DeleteActiveSidebarWin();
327 }
328 break;
329 }
330 case FN_DELETE_COMMENT_THREAD((20000 + 2500)+11):
331 {
332 const SvxPostItIdItem* pIdItem = rReq.GetArg<SvxPostItIdItem>(SID_ATTR_POSTIT_IDTypedWhichId<SvxPostItIdItem>( 10000 + 47 ));
333 if (pIdItem && !pIdItem->GetValue().isEmpty() && GetView().GetPostItMgr())
334 {
335 GetView().GetPostItMgr()->DeleteCommentThread(pIdItem->GetValue().toUInt32());
336 }
337 else if ( GetView().GetPostItMgr() &&
338 GetView().GetPostItMgr()->HasActiveSidebarWin() )
339 {
340 GetView().GetPostItMgr()->DeleteActiveSidebarWin();
341 }
342 break;
343 }
344 case FN_RESOLVE_NOTE((20000 + 2500)+9):
345 {
346 const SvxPostItIdItem* pIdItem = rReq.GetArg<SvxPostItIdItem>(SID_ATTR_POSTIT_IDTypedWhichId<SvxPostItIdItem>( 10000 + 47 ));
347 if (pIdItem && !pIdItem->GetValue().isEmpty() && GetView().GetPostItMgr())
348 {
349 GetView().GetPostItMgr()->ToggleResolved(pIdItem->GetValue().toUInt32());
350 }
351 break;
352 }
353 case FN_RESOLVE_NOTE_THREAD((20000 + 2500)+10):
354 {
355 const SvxPostItIdItem* pIdItem = rReq.GetArg<SvxPostItIdItem>(SID_ATTR_POSTIT_IDTypedWhichId<SvxPostItIdItem>( 10000 + 47 ));
356 if (pIdItem && !pIdItem->GetValue().isEmpty() && GetView().GetPostItMgr())
357 {
358 GetView().GetPostItMgr()->ToggleResolvedForThread(pIdItem->GetValue().toUInt32());
359 }
360 break;
361 }
362 case FN_DELETE_ALL_NOTES((20000 + 2500)+2):
363 if ( GetView().GetPostItMgr() )
364 GetView().GetPostItMgr()->Delete();
365 break;
366 case FN_FORMAT_ALL_NOTES((20000 + 2500)+8):
367 {
368 SwPostItMgr* pPostItMgr = GetView().GetPostItMgr();
369 if (pPostItMgr)
370 pPostItMgr->ExecuteFormatAllDialog(GetView());
371 }
372 break;
373 case FN_DELETE_NOTE_AUTHOR((20000 + 2500)+1):
374 {
375 const SfxStringItem* pNoteItem = rReq.GetArg<SfxStringItem>(nSlot);
376 if ( pNoteItem && GetView().GetPostItMgr() )
377 GetView().GetPostItMgr()->Delete( pNoteItem->GetValue() );
378 }
379 break;
380 case FN_HIDE_NOTE((20000 + 2500)+3):
381 if ( GetView().GetPostItMgr() &&
382 GetView().GetPostItMgr()->HasActiveSidebarWin() )
383 {
384 GetView().GetPostItMgr()->HideActiveSidebarWin();
385 }
386 break;
387 case FN_HIDE_ALL_NOTES((20000 + 2500)+5):
388 if ( GetView().GetPostItMgr() )
389 GetView().GetPostItMgr()->Hide();
390 break;
391 case FN_HIDE_NOTE_AUTHOR((20000 + 2500)+4):
392 {
393 const SfxStringItem* pNoteItem = rReq.GetArg<SfxStringItem>(nSlot);
394 if ( pNoteItem && GetView().GetPostItMgr() )
395 GetView().GetPostItMgr()->Hide( pNoteItem->GetValue() );
396 }
397 break;
398 case FN_REPLY((20000 + 2500)+7):
399 {
400 const SvxPostItIdItem* pIdItem = rReq.GetArg<SvxPostItIdItem>(SID_ATTR_POSTIT_IDTypedWhichId<SvxPostItIdItem>( 10000 + 47 ));
401 if (pIdItem && !pIdItem->GetValue().isEmpty())
402 {
403 SwFieldType* pType = rSh.GetDoc()->getIDocumentFieldsAccess().GetFieldType(SwFieldIds::Postit, OUString(), false);
404 if(pType->FindFormatForPostItId(pIdItem->GetValue().toUInt32()))
405 {
406 auto pMgr = GetView().GetPostItMgr();
407 auto pWin = pMgr->GetAnnotationWin(pIdItem->GetValue().toUInt32());
408 if(pWin)
409 {
410 OUString sText;
411 if(const auto pTextItem = rReq.GetArg<SvxPostItTextItem>(SID_ATTR_POSTIT_TEXTTypedWhichId<SvxPostItTextItem>( 10000 + 46 )))
412 sText = pTextItem->GetValue();
413 pMgr->RegisterAnswerText(sText);
414 pWin->ExecuteCommand(nSlot);
415 }
416 }
417 }
418 }
419 break;
420 case FN_POSTIT((20000 + 300) + 29):
421 {
422 rSh.InsertPostIt(aFieldMgr, rReq);
423 }
424 break;
425 case SID_EDIT_POSTIT( 10000 + 1158 ):
426 {
427 const SvxPostItIdItem* pIdItem = rReq.GetArg<SvxPostItIdItem>(SID_ATTR_POSTIT_IDTypedWhichId<SvxPostItIdItem>( 10000 + 47 ));
428 if (pIdItem && !pIdItem->GetValue().isEmpty())
429 {
430 const SvxPostItTextItem* pTextItem = rReq.GetArg<SvxPostItTextItem>(SID_ATTR_POSTIT_TEXTTypedWhichId<SvxPostItTextItem>( 10000 + 46 ));
431 OUString sText;
432 if ( pTextItem )
433 sText = pTextItem->GetValue();
434
435 sw::annotation::SwAnnotationWin* pAnnotationWin = GetView().GetPostItMgr()->GetAnnotationWin(pIdItem->GetValue().toUInt32());
436 if (pAnnotationWin)
437 {
438 pAnnotationWin->UpdateText(sText);
439
440 // explicit state update to get the Undo state right
441 GetView().AttrChangedNotify(nullptr);
442 }
443 }
444 }
445 break;
446 case FN_REDLINE_COMMENT((20000 + 1800) + 27):
447 {
448 /* this code can be used once we want redline comments in the margin, all other stuff can
449 then be deleted
450 String sComment;
451 const SwRangeRedline *pRedline = rSh.GetCurrRedline();
452
453 if (pRedline)
454 {
455 sComment = pRedline->GetComment();
456 if ( !sComment.Len() )
457 GetView().GetDocShell()->Broadcast(SwRedlineHint(pRedline,SWREDLINE_INSERTED));
458 const_cast<SwRangeRedline*>(pRedline)->Broadcast(SwRedlineHint(pRedline,SWREDLINE_FOCUS,&GetView()));
459 }
460 */
461
462 const SwRangeRedline *pRedline = rSh.GetCurrRedline();
463 SwDoc *pDoc = rSh.GetDoc();
464 // If index is specified, goto and select the appropriate redline
465 if (pArgs && pArgs->GetItemState(nSlot, false, &pItem) == SfxItemState::SET)
466 {
467 const sal_uInt32 nChangeId = static_cast<const SfxUInt32Item*>(pItem)->GetValue();
468 const SwRedlineTable& rRedlineTable = pDoc->getIDocumentRedlineAccess().GetRedlineTable();
469 for (SwRedlineTable::size_type nRedline = 0; nRedline < rRedlineTable.size(); ++nRedline)
470 {
471 if (nChangeId == rRedlineTable[nRedline]->GetId())
472 pRedline = rSh.GotoRedline(nRedline, true);
473 }
474 }
475
476 OUString sCommentText;
477 const SfxStringItem* pTextItem = rReq.GetArg<SvxPostItTextItem>(SID_ATTR_POSTIT_TEXTTypedWhichId<SvxPostItTextItem>( 10000 + 46 ));
478 if (pTextItem)
479 sCommentText = pTextItem->GetValue();
480
481 if (pRedline)
482 {
483 // In case of LOK and comment text is already provided, skip
484 // dialog creation and just change the redline comment directly
485 if (comphelper::LibreOfficeKit::isActive() && !sCommentText.isEmpty())
486 {
487 rSh.SetRedlineComment(sCommentText);
488 GetView().AttrChangedNotify(nullptr);
489 MaybeNotifyRedlineModification(const_cast<SwRangeRedline&>(*pRedline), pRedline->GetDoc());
490 break;
491 }
492
493 OUString sComment = convertLineEnd(pRedline->GetComment(), GetSystemLineEnd());
494
495 bool bTravel = false;
496
497 SvxAbstractDialogFactory* pFact = SvxAbstractDialogFactory::Create();
498 ::DialogGetRanges fnGetRange = pFact->GetDialogGetRangesFunc();
499 SfxItemSet aSet(GetPool(), fnGetRange());
500 aSet.Put(SvxPostItTextItem(sComment, SID_ATTR_POSTIT_TEXTTypedWhichId<SvxPostItTextItem>( 10000 + 46 )));
501 aSet.Put(SvxPostItAuthorItem(pRedline->GetAuthorString(), SID_ATTR_POSTIT_AUTHORTypedWhichId<SvxPostItAuthorItem>( 10000 + 44 )));
502
503 aSet.Put( SvxPostItDateItem( GetAppLangDateTimeString(
504 pRedline->GetRedlineData().GetTimeStamp() ),
505 SID_ATTR_POSTIT_DATETypedWhichId<SvxPostItDateItem>( 10000 + 45 ) ));
506
507 // Traveling only if more than one field.
508 rSh.StartAction();
509
510 rSh.Push();
511 const SwRangeRedline *pActRed = rSh.SelPrevRedline();
512
513 if (pActRed == pRedline)
514 { // New cursor is at the beginning of the current redlines.
515 rSh.Pop(); // Throw old cursor away
516 rSh.Push();
517 pActRed = rSh.SelPrevRedline();
518 }
519
520 bool bPrev = pActRed != nullptr;
521 rSh.Pop(SwCursorShell::PopMode::DeleteCurrent);
522 rSh.EndAction();
523
524 rSh.ClearMark();
525 // Select current redline.
526 pActRed = rSh.SelNextRedline();
527 if (pActRed != pRedline)
528 rSh.SelPrevRedline();
529
530 rSh.StartAction();
531 rSh.Push();
532 pActRed = rSh.SelNextRedline();
533 bool bNext = pActRed != nullptr;
534 rSh.Pop(SwCursorShell::PopMode::DeleteCurrent); // Restore cursor position
535
536 if( rSh.IsCursorPtAtEnd() )
537 rSh.SwapPam();
538
539 rSh.EndAction();
540
541 bTravel |= bNext || bPrev;
542
543 SvxAbstractDialogFactory* pFact2 = SvxAbstractDialogFactory::Create();
544 ScopedVclPtr<AbstractSvxPostItDialog> pDlg(pFact2->CreateSvxPostItDialog(GetView().GetFrameWeld(), aSet, bTravel));
545 pDlg->HideAuthor();
546
547 pDlg->SetText(lcl_BuildTitleWithRedline(pRedline));
548
549 if (bTravel)
550 {
551 pDlg->EnableTravel(bNext, bPrev);
552 pDlg->SetPrevHdl(LINK(this, SwTextShell, RedlinePrevHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwTextShell
*>(this), &SwTextShell::LinkStubRedlinePrevHdl)
);
553 pDlg->SetNextHdl(LINK(this, SwTextShell, RedlineNextHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwTextShell
*>(this), &SwTextShell::LinkStubRedlineNextHdl)
);
554 }
555
556 SwViewShell::SetCareDialog(pDlg->GetDialog());
557 g_bNoInterrupt = true;
558
559 if ( pDlg->Execute() == RET_OK )
560 {
561 const SfxItemSet* pOutSet = pDlg->GetOutputItemSet();
562 OUString sMsg(pOutSet->Get(SID_ATTR_POSTIT_TEXTTypedWhichId<SvxPostItTextItem>( 10000 + 46 )).GetValue());
563
564 // Insert or change a comment
565 rSh.SetRedlineComment(sMsg);
566 }
567
568 SwViewShell::SetCareDialog(nullptr);
569 pDlg.disposeAndClear();
570 g_bNoInterrupt = false;
571 rSh.ClearMark();
572 GetView().AttrChangedNotify(nullptr);
573 }
574 }
575 break;
576
577 case FN_JAVAEDIT((20000 + 1400) + 10):
578 {
579 OUString aType, aText;
580 bool bIsUrl=false;
581 bool bNew=false;
582 bool bUpdate = false;
583 SwFieldMgr aMgr;
584 if ( pItem )
585 {
586 aText = static_cast<const SfxStringItem*>(pItem)->GetValue();
587 const SfxStringItem* pType = rReq.GetArg<SfxStringItem>(FN_PARAM_2((20000 + 1100)+61));
588 const SfxBoolItem* pIsUrl = rReq.GetArg<SfxBoolItem>(FN_PARAM_1((20000 + 1100)+60));
589 if ( pType )
590 aType = pType->GetValue();
591 if ( pIsUrl )
592 bIsUrl = pIsUrl->GetValue();
593
594 SwScriptField* pField = static_cast<SwScriptField*>(aMgr.GetCurField());
595 bNew = !pField || (pField->GetTyp()->Which() != SwFieldIds::Script);
596 bUpdate = pField && ( bIsUrl != static_cast<bool>(pField->GetFormat()) || pField->GetPar2() != aType || pField->GetPar1() != aText );
597 }
598 else
599 {
600 SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create();
601 ScopedVclPtr<AbstractJavaEditDialog> pDlg(pFact->CreateJavaEditDialog(GetView().GetFrameWeld(), &rSh));
602 if ( pDlg->Execute() )
603 {
604 aType = pDlg->GetScriptType();
605 aText = pDlg->GetScriptText();
606 bIsUrl = pDlg->IsUrl();
607 bNew = pDlg->IsNew();
608 bUpdate = pDlg->IsUpdate();
609 rReq.AppendItem( SfxStringItem( FN_JAVAEDIT((20000 + 1400) + 10), aText ) );
610 rReq.AppendItem( SfxStringItem( FN_PARAM_2((20000 + 1100)+61), aType ) );
611 rReq.AppendItem( SfxBoolItem( FN_PARAM_1((20000 + 1100)+60), bIsUrl ) );
612 }
613 }
614
615 if( bNew )
616 {
617 SwInsertField_Data aData(SwFieldTypesEnum::Script, 0, aType, aText, bIsUrl ? 1 : 0);
618 aMgr.InsertField(aData);
619 rReq.Done();
620 }
621 else if( bUpdate )
622 {
623 aMgr.UpdateCurField( bIsUrl ? 1 : 0, aType, aText );
624 rSh.SetUndoNoResetModified();
625 rReq.Done();
626 }
627 else
628 rReq.Ignore();
629 }
630 break;
631
632 case FN_INSERT_FLD_DATE((20000 + 300) + 92) :
633 {
634 nInsertType = SwFieldTypesEnum::Date;
635 bIsText = false;
636 // use long date format for Hungarian
637 SwPaM* pCursorPos = rSh.GetCursor();
638 if( pCursorPos )
639 {
640 LanguageType nLang = pCursorPos->GetPoint()->nNode.GetNode().GetTextNode()->GetLang(pCursorPos->GetPoint()->nContent.GetIndex());
641 if (nLang == LANGUAGE_HUNGARIANLanguageType(0x040E))
642 nInsertFormat = rSh.GetNumberFormatter()->GetFormatIndex(NF_DATE_SYSTEM_LONG, nLang);
643 }
644 goto FIELD_INSERT;
645 }
646 case FN_INSERT_FLD_TIME((20000 + 300) + 93) :
647 nInsertType = SwFieldTypesEnum::Time;
648 bIsText = false;
649 goto FIELD_INSERT;
650 case FN_INSERT_FLD_PGNUMBER((20000 + 300) + 94):
651 nInsertType = SwFieldTypesEnum::PageNumber;
652 nInsertFormat = SVX_NUM_PAGEDESC; // Like page template
653 bIsText = false;
654 goto FIELD_INSERT;
655 case FN_INSERT_FLD_PGCOUNT((20000 + 300) + 95) :
656 nInsertType = SwFieldTypesEnum::DocumentStatistics;
657 nInsertSubType = 0;
658 bIsText = false;
659 nInsertFormat = SVX_NUM_PAGEDESC;
660 goto FIELD_INSERT;
661 case FN_INSERT_FLD_TOPIC((20000 + 300) + 96) :
662 nInsertType = SwFieldTypesEnum::DocumentInfo;
663 nInsertSubType = DI_SUBJECT;
664 goto FIELD_INSERT;
665 case FN_INSERT_FLD_TITLE((20000 + 300) + 97) :
666 nInsertType = SwFieldTypesEnum::DocumentInfo;
667 nInsertSubType = DI_TITLE;
668 goto FIELD_INSERT;
669 case FN_INSERT_FLD_AUTHOR((20000 + 300) + 98) :
670 nInsertType = SwFieldTypesEnum::DocumentInfo;
671 nInsertSubType = DI_CREATE|DI_SUB_AUTHOR;
672
673FIELD_INSERT:
674 {
675 //format conversion should only be done for number formatter formats
676 if(!nInsertFormat)
677 nInsertFormat = aFieldMgr.GetDefaultFormat(nInsertType, bIsText, rSh.GetNumberFormatter());
678 SwInsertField_Data aData(nInsertType, nInsertSubType,
679 OUString(), OUString(), nInsertFormat);
680 aFieldMgr.InsertField(aData);
681 rReq.Done();
682 }
683 break;
684
685 case FN_INSERT_TEXT_FORMFIELD((20000 + 1400) + 22):
686 {
687 rSh.GetDoc()->GetIDocumentUndoRedo().StartUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
688
689 SwPaM* pCursorPos = rSh.GetCursor();
690 if(pCursorPos)
691 {
692 // Insert five En Space into the text field so the field has extent
693 static const sal_Unicode vEnSpaces[ODF_FORMFIELD_DEFAULT_LENGTH5] = {8194, 8194, 8194, 8194, 8194};
694 bool bSuccess = rSh.GetDoc()->getIDocumentContentOperations().InsertString(*pCursorPos, OUString(vEnSpaces, ODF_FORMFIELD_DEFAULT_LENGTH5));
695 if(bSuccess)
696 {
697 IDocumentMarkAccess* pMarksAccess = rSh.GetDoc()->getIDocumentMarkAccess();
698 SwPaM aFieldPam(pCursorPos->GetPoint()->nNode, pCursorPos->GetPoint()->nContent.GetIndex() - ODF_FORMFIELD_DEFAULT_LENGTH5,
699 pCursorPos->GetPoint()->nNode, pCursorPos->GetPoint()->nContent.GetIndex());
700 pMarksAccess->makeFieldBookmark(aFieldPam, OUString(), ODF_FORMTEXT"vnd.oasis.opendocument.field.FORMTEXT",
701 aFieldPam.Start());
702 }
703 }
704
705 rSh.GetDoc()->GetIDocumentUndoRedo().EndUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
706 rSh.GetView().GetViewFrame()->GetBindings().Invalidate( SID_UNDO(5000 + 701) );
707 }
708 break;
709 case FN_INSERT_CHECKBOX_FORMFIELD((20000 + 1400) + 23):
710 {
711 rSh.GetDoc()->GetIDocumentUndoRedo().StartUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
712
713 SwPaM* pCursorPos = rSh.GetCursor();
714 if(pCursorPos)
715 {
716 IDocumentMarkAccess* pMarksAccess = rSh.GetDoc()->getIDocumentMarkAccess();
717 pMarksAccess->makeNoTextFieldBookmark(*pCursorPos, OUString(), ODF_FORMCHECKBOX"vnd.oasis.opendocument.field.FORMCHECKBOX");
718 }
719
720 rSh.GetDoc()->GetIDocumentUndoRedo().EndUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
721 rSh.GetView().GetViewFrame()->GetBindings().Invalidate( SID_UNDO(5000 + 701) );
722 }
723 break;
724 case FN_INSERT_DROPDOWN_FORMFIELD((20000 + 1400) + 24):
725 {
726 rSh.GetDoc()->GetIDocumentUndoRedo().StartUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
727
728 SwPaM* pCursorPos = rSh.GetCursor();
729 if(pCursorPos)
730 {
731 IDocumentMarkAccess* pMarksAccess = rSh.GetDoc()->getIDocumentMarkAccess();
732 pMarksAccess->makeNoTextFieldBookmark(*pCursorPos, OUString(), ODF_FORMDROPDOWN"vnd.oasis.opendocument.field.FORMDROPDOWN");
733 }
734
735 rSh.GetDoc()->GetIDocumentUndoRedo().EndUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
736 rSh.GetView().GetViewFrame()->GetBindings().Invalidate( SID_UNDO(5000 + 701) );
737 }
738 break;
739 case FN_INSERT_DATE_FORMFIELD((20000 + 1400) + 25):
740 {
741 rSh.GetDoc()->GetIDocumentUndoRedo().StartUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
742
743 SwPaM* pCursorPos = rSh.GetCursor();
744 if(pCursorPos)
745 {
746 // Insert five enspaces into the text field so the field has extent
747 sal_Unicode vEnSpaces[ODF_FORMFIELD_DEFAULT_LENGTH5] = {8194, 8194, 8194, 8194, 8194};
748 bool bSuccess = rSh.GetDoc()->getIDocumentContentOperations().InsertString(*pCursorPos, OUString(vEnSpaces, ODF_FORMFIELD_DEFAULT_LENGTH5));
749 if(bSuccess)
750 {
751 IDocumentMarkAccess* pMarksAccess = rSh.GetDoc()->getIDocumentMarkAccess();
752 SwPaM aFieldPam(pCursorPos->GetPoint()->nNode, pCursorPos->GetPoint()->nContent.GetIndex() - ODF_FORMFIELD_DEFAULT_LENGTH5,
753 pCursorPos->GetPoint()->nNode, pCursorPos->GetPoint()->nContent.GetIndex());
754 sw::mark::IFieldmark* pFieldBM = pMarksAccess->makeFieldBookmark(aFieldPam, OUString(), ODF_FORMDATE"vnd.oasis.opendocument.field.FORMDATE",
755 aFieldPam.Start());
756
757 // Use a default date format and language
758 sw::mark::IFieldmark::parameter_map_t* pParameters = pFieldBM->GetParameters();
759 SvNumberFormatter* pFormatter = rSh.GetDoc()->GetNumberFormatter();
760 sal_uInt32 nStandardFormat = pFormatter->GetStandardFormat(SvNumFormatType::DATE);
761 const SvNumberformat* pFormat = pFormatter->GetEntry(nStandardFormat);
762
763 (*pParameters)[ODF_FORMDATE_DATEFORMAT"DateField_DateFormat"] <<= pFormat->GetFormatstring();
764 (*pParameters)[ODF_FORMDATE_DATEFORMAT_LANGUAGE"DateField_DateFormat_Language"] <<= LanguageTag(pFormat->GetLanguage()).getBcp47();
765 }
766 }
767
768 rSh.GetDoc()->GetIDocumentUndoRedo().EndUndo(SwUndoId::INSERT_FORM_FIELD, nullptr);
769 rSh.GetView().GetViewFrame()->GetBindings().Invalidate( SID_UNDO(5000 + 701) );
770 }
771 break;
772 default:
773 OSL_FAIL("wrong dispatcher")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/textfld.cxx"
":" "773" ": "), "%s", "wrong dispatcher"); } } while (false
)
;
774 return;
775 }
776}
777
778void SwTextShell::StateField( SfxItemSet &rSet )
779{
780 SwWrtShell& rSh = GetShell();
781 SfxWhichIter aIter( rSet );
782 const SwField* pField = nullptr;
783 bool bGetField = false;
784 sal_uInt16 nWhich = aIter.FirstWhich();
785
786 while (nWhich)
787 {
788 switch (nWhich)
789 {
790 case FN_DELETE_COMMENT((20000 + 2500)+6):
791 case FN_DELETE_NOTE_AUTHOR((20000 + 2500)+1):
792 case FN_DELETE_ALL_NOTES((20000 + 2500)+2):
793 case FN_FORMAT_ALL_NOTES((20000 + 2500)+8):
794 case FN_HIDE_NOTE((20000 + 2500)+3):
795 case FN_HIDE_NOTE_AUTHOR((20000 + 2500)+4):
796 case FN_HIDE_ALL_NOTES((20000 + 2500)+5):
797 {
798 SwPostItMgr* pPostItMgr = GetView().GetPostItMgr();
799 if ( !pPostItMgr )
800 rSet.InvalidateItem( nWhich );
801 else if ( !pPostItMgr->HasActiveSidebarWin() )
802 {
803 rSet.InvalidateItem( FN_DELETE_COMMENT((20000 + 2500)+6) );
804 rSet.InvalidateItem( FN_HIDE_NOTE((20000 + 2500)+3) );
805 }
806 }
807 break;
808
809 case FN_EDIT_FIELD((20000 + 100) + 4 ):
810 {
811 if( !bGetField )
812 {
813 pField = rSh.GetCurField(true);
814 bGetField = true;
815 }
816
817 SwFieldIds nTempWhich = pField ? pField->GetTyp()->Which() : SwFieldIds::Unknown;
818 if( SwFieldIds::Unknown == nTempWhich ||
819 SwFieldIds::Postit == nTempWhich ||
820 SwFieldIds::Script == nTempWhich ||
821 SwFieldIds::TableOfAuthorities == nTempWhich )
822 rSet.DisableItem( nWhich );
823 else if( SwFieldIds::Dde == nTempWhich &&
824 !static_cast<SwDDEFieldType*>(pField->GetTyp())->GetBaseLink().IsVisible())
825 {
826 // nested links cannot be edited
827 rSet.DisableItem( nWhich );
828 }
829 }
830 break;
831
832 case FN_EXECUTE_MACROFIELD((20000 + 100) + 27):
833 {
834 if(!bGetField)
835 {
836 pField = rSh.GetCurField();
837 bGetField = true;
838 }
839 if(!pField || pField->GetTyp()->Which() != SwFieldIds::Macro)
840 rSet.DisableItem(nWhich);
841 }
842 break;
843
844 case FN_INSERT_FIELD((20000 + 300) + 8 ):
845 {
846 if ( rSh.CursorInsideInputField() )
847 {
848 rSet.DisableItem(nWhich);
849 }
850 else
851 {
852 SfxViewFrame* pVFrame = GetView().GetViewFrame();
853 //#i5788# prevent closing of the field dialog while a modal dialog ( Input field dialog ) is active
854 if(!pVFrame->IsInModalMode() &&
855 pVFrame->KnowsChildWindow(FN_INSERT_FIELD((20000 + 300) + 8 )) && !pVFrame->HasChildWindow(FN_INSERT_FIELD_DATA_ONLY((20000 + 300) + 19)) )
856 rSet.Put(SfxBoolItem( FN_INSERT_FIELD((20000 + 300) + 8 ), pVFrame->HasChildWindow(nWhich)));
857 else
858 rSet.DisableItem(FN_INSERT_FIELD((20000 + 300) + 8 ));
859 }
860 }
861 break;
862
863 case FN_INSERT_REF_FIELD((20000 + 300) + 13):
864 {
865 SfxViewFrame* pVFrame = GetView().GetViewFrame();
866 if ( !pVFrame->KnowsChildWindow(FN_INSERT_FIELD((20000 + 300) + 8 ))
867 || rSh.CursorInsideInputField() )
868 {
869 rSet.DisableItem(FN_INSERT_REF_FIELD((20000 + 300) + 13));
870 }
871 }
872 break;
873
874 case FN_INSERT_FIELD_CTRL((20000 + 300) + 91):
875 if ( rSh.CursorInsideInputField() )
876 {
877 rSet.DisableItem(nWhich);
878 }
879 else
880 {
881 rSet.Put(SfxBoolItem( nWhich, GetView().GetViewFrame()->HasChildWindow(FN_INSERT_FIELD((20000 + 300) + 8 ))));
882 }
883 break;
884
885 case FN_REDLINE_COMMENT((20000 + 1800) + 27):
886 if (!comphelper::LibreOfficeKit::isActive() && !rSh.GetCurrRedline())
887 rSet.DisableItem(nWhich);
888 break;
889
890 case FN_REPLY((20000 + 2500)+7):
891 if (!comphelper::LibreOfficeKit::isActive())
892 rSet.DisableItem(nWhich);
893 break;
894
895 case FN_POSTIT((20000 + 300) + 29) :
896 case FN_JAVAEDIT((20000 + 1400) + 10) :
897 {
898 bool bCurField = false;
899 pField = rSh.GetCurField();
900 if(nWhich == FN_POSTIT((20000 + 300) + 29))
901 bCurField = pField && pField->GetTyp()->Which() == SwFieldIds::Postit;
902 else
903 bCurField = pField && pField->GetTyp()->Which() == SwFieldIds::Script;
904
905 if( !bCurField && rSh.IsReadOnlyAvailable() && rSh.HasReadonlySel() )
906 {
907 rSet.DisableItem(nWhich);
908 }
909 else if ( rSh.CursorInsideInputField() )
910 {
911 rSet.DisableItem(nWhich);
912 }
913 // tdf#86188 Allow disabling comment insertion on footnote/endnote for better OOXML interoperability
914 else if ( rSh.IsCursorInFootnote() && !officecfg::Office::Compatibility::View::AllowCommentsInFootnotes::get() )
915 {
916 rSet.DisableItem(nWhich);
917 }
918 }
919
920 break;
921
922 case FN_INSERT_FLD_AUTHOR((20000 + 300) + 98):
923 case FN_INSERT_FLD_DATE((20000 + 300) + 92):
924 case FN_INSERT_FLD_PGCOUNT((20000 + 300) + 95):
925 case FN_INSERT_FLD_PGNUMBER((20000 + 300) + 94):
926 case FN_INSERT_FLD_TIME((20000 + 300) + 93):
927 case FN_INSERT_FLD_TITLE((20000 + 300) + 97):
928 case FN_INSERT_FLD_TOPIC((20000 + 300) + 96):
929 case FN_INSERT_DBFIELD((20000 + 300) + 11):
930 if ( rSh.CursorInsideInputField() )
931 {
932 rSet.DisableItem(nWhich);
933 }
934 break;
935
936 case FN_INSERT_TEXT_FORMFIELD((20000 + 1400) + 22):
937 case FN_INSERT_CHECKBOX_FORMFIELD((20000 + 1400) + 23):
938 case FN_INSERT_DROPDOWN_FORMFIELD((20000 + 1400) + 24):
939 case FN_INSERT_DATE_FORMFIELD((20000 + 1400) + 25):
940 if ( rSh.CursorInsideInputField() )
941 {
942 rSet.DisableItem(nWhich);
943 }
944 else
945 {
946 // Check whether we are in a text form field
947 SwPosition aCursorPos(*rSh.GetCursor()->GetPoint());
948 sw::mark::IFieldmark* pFieldBM = GetShell().getIDocumentMarkAccess()->getFieldmarkFor(aCursorPos);
949 if ((!pFieldBM || pFieldBM->GetFieldname() != ODF_FORMTEXT"vnd.oasis.opendocument.field.FORMTEXT")
950 && aCursorPos.nContent.GetIndex() > 0)
951 {
952 SwPosition aPos(aCursorPos);
953 --aPos.nContent;
954 pFieldBM = GetShell().getIDocumentMarkAccess()->getFieldmarkFor(aPos);
955 }
956 if (pFieldBM && pFieldBM->GetFieldname() == ODF_FORMTEXT"vnd.oasis.opendocument.field.FORMTEXT" &&
957 (aCursorPos > pFieldBM->GetMarkStart() && aCursorPos < pFieldBM->GetMarkEnd() ))
958 {
959 rSet.DisableItem(nWhich);
960 }
961 }
962 break;
963
964 }
965 nWhich = aIter.NextWhich();
966 }
967}
968
969void SwTextShell::InsertHyperlink(const SvxHyperlinkItem& rHlnkItem)
970{
971 const OUString& rName = rHlnkItem.GetName();
972 const OUString& rURL = rHlnkItem.GetURL();
973 const OUString& rTarget = rHlnkItem.GetTargetFrame();
974 sal_uInt16 nType = static_cast<sal_uInt16>(rHlnkItem.GetInsertMode());
975 nType &= ~HLINK_HTMLMODE;
976 const SvxMacroTableDtor* pMacroTable = rHlnkItem.GetMacroTable();
977
978 SwWrtShell& rSh = GetShell();
979
980 if( !(rSh.GetSelectionType() & SelectionType::Text) )
981 return;
982
983 rSh.StartAction();
984 SfxItemSet aSet(GetPool(), svl::Items<RES_TXTATR_INETFMT, RES_TXTATR_INETFMT>{});
985 rSh.GetCurAttr( aSet );
986
987 const SfxPoolItem* pItem;
988 if(SfxItemState::SET == aSet.GetItemState(RES_TXTATR_INETFMT, false, &pItem))
989 {
990 // Select links
991 rSh.SwCursorShell::SelectTextAttr(RES_TXTATR_INETFMT, false);
992 }
993 switch (nType)
994 {
995 case HLINK_DEFAULT:
996 case HLINK_FIELD:
997 {
998 SwFormatINetFormat aINetFormat( rURL, rTarget );
999 aINetFormat.SetName(rHlnkItem.GetIntName());
1000 if(pMacroTable)
1001 {
1002 const SvxMacro *pMacro = pMacroTable->Get( SvMacroItemId::OnMouseOver );
1003 if( pMacro )
1004 aINetFormat.SetMacro(SvMacroItemId::OnMouseOver, *pMacro);
1005 pMacro = pMacroTable->Get( SvMacroItemId::OnClick );
1006 if( pMacro )
1007 aINetFormat.SetMacro(SvMacroItemId::OnClick, *pMacro);
1008 pMacro = pMacroTable->Get( SvMacroItemId::OnMouseOut );
1009 if( pMacro )
1010 aINetFormat.SetMacro(SvMacroItemId::OnMouseOut, *pMacro);
1011 }
1012 rSh.SttSelect();
1013 rSh.InsertURL( aINetFormat, rName, true );
1014 rSh.EndSelect();
1015 }
1016 break;
1017
1018 case HLINK_BUTTON:
1019 bool bSel = rSh.HasSelection();
1020 if(bSel)
1021 rSh.DelRight();
1022 InsertURLButton( rURL, rTarget, rName );
1023 rSh.EnterStdMode();
1024 break;
1025 }
1026 rSh.EndAction();
1027}
1028
1029IMPL_LINK( SwTextShell, RedlineNextHdl, AbstractSvxPostItDialog&, rDlg, void )void SwTextShell::LinkStubRedlineNextHdl(void * instance, AbstractSvxPostItDialog
& data) { return static_cast<SwTextShell *>(instance
)->RedlineNextHdl(data); } void SwTextShell::RedlineNextHdl
(AbstractSvxPostItDialog& rDlg)
1030{
1031 SwWrtShell* pSh = GetShellPtr();
1032
1033 // Insert or change a comment.
1034 pSh->SetRedlineComment(rDlg.GetNote());
1035
1036 const SwRangeRedline *pRedline = pSh->GetCurrRedline();
1037
1038 if (!pRedline)
1039 return;
1040
1041 // Traveling only if more than one field.
1042 if( !pSh->IsCursorPtAtEnd() )
1043 pSh->SwapPam(); // Move the cursor behind the Redline.
1044
1045 pSh->Push();
1046 const SwRangeRedline *pActRed = pSh->SelNextRedline();
1047 pSh->Pop((pActRed != nullptr) ? SwCursorShell::PopMode::DeleteStack : SwCursorShell::PopMode::DeleteCurrent);
1048
1049 bool bEnable = false;
1050
1051 if (pActRed)
1052 {
1053 pSh->StartAction();
1054 pSh->Push();
1055 bEnable = pSh->SelNextRedline() != nullptr;
1056 pSh->Pop(SwCursorShell::PopMode::DeleteCurrent);
1057 pSh->EndAction();
1058 }
1059
1060 rDlg.EnableTravel(bEnable, true);
1061
1062 if( pSh->IsCursorPtAtEnd() )
1063 pSh->SwapPam();
1064
1065 pRedline = pSh->GetCurrRedline();
1066 OUString sComment = convertLineEnd(pRedline->GetComment(), GetSystemLineEnd());
1067
1068 rDlg.SetNote(sComment);
1069 rDlg.ShowLastAuthor( pRedline->GetAuthorString(),
1070 GetAppLangDateTimeString(
1071 pRedline->GetRedlineData().GetTimeStamp() ));
1072
1073 rDlg.SetText(lcl_BuildTitleWithRedline(pRedline));
1074
1075}
1076
1077IMPL_LINK( SwTextShell, RedlinePrevHdl, AbstractSvxPostItDialog&, rDlg, void )void SwTextShell::LinkStubRedlinePrevHdl(void * instance, AbstractSvxPostItDialog
& data) { return static_cast<SwTextShell *>(instance
)->RedlinePrevHdl(data); } void SwTextShell::RedlinePrevHdl
(AbstractSvxPostItDialog& rDlg)
1078{
1079 SwWrtShell* pSh = GetShellPtr();
1080
1081 // Insert or change a comment.
1082 pSh->SetRedlineComment(rDlg.GetNote());
1083
1084 const SwRangeRedline *pRedline = pSh->GetCurrRedline();
1085
1086 if (!pRedline)
1087 return;
1088
1089 // Traveling only if more than one field.
1090 pSh->Push();
1091 const SwRangeRedline *pActRed = pSh->SelPrevRedline();
1092 pSh->Pop((pActRed != nullptr) ? SwCursorShell::PopMode::DeleteStack : SwCursorShell::PopMode::DeleteCurrent);
1093
1094 bool bEnable = false;
1095
1096 if (pActRed)
1097 {
1098 pSh->StartAction();
1099 pSh->Push();
1100 bEnable = pSh->SelPrevRedline() != nullptr;
1101 pSh->Pop(SwCursorShell::PopMode::DeleteCurrent);
1102 pSh->EndAction();
1103 }
1104
1105 rDlg.EnableTravel(true, bEnable);
1106
1107 pRedline = pSh->GetCurrRedline();
1108 OUString sComment = convertLineEnd(pRedline->GetComment(), GetSystemLineEnd());
1109
1110 rDlg.SetNote(sComment);
1111 rDlg.ShowLastAuthor(pRedline->GetAuthorString(),
1112 GetAppLangDateTimeString(
1113 pRedline->GetRedlineData().GetTimeStamp() ));
1114
1115 rDlg.SetText(lcl_BuildTitleWithRedline(pRedline));
1116
1117}
1118
1119/* 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();
26
Calling 'Reference::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
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)
8
Calling implicit copy constructor for 'VclPtr<SfxAbstractDialog>'
9
Calling copy constructor for 'Reference<SfxAbstractDialog>'
12
Returning from copy constructor for 'Reference<SfxAbstractDialog>'
13
Returning from copy constructor for 'VclPtr<SfxAbstractDialog>'
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)
10
Assuming field 'm_pBody' is non-null
11
Taking true branch
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)
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;
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