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 confuno.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 SC_DLLIMPLEMENTATION -D SC_INFO_OSVERSION="LINUX" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -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/clew/source/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sc/source/core/inc -I /home/maarten/src/libreoffice/core/sc/source/filter/inc -I /home/maarten/src/libreoffice/core/sc/source/ui/inc -I /home/maarten/src/libreoffice/core/sc/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sc/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/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/sc/source/ui/unoobj/confuno.cxx

/home/maarten/src/libreoffice/core/sc/source/ui/unoobj/confuno.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 <sal/config.h>
21
22#include <utility>
23
24#include <config_features.h>
25
26#include <confuno.hxx>
27#include <unonames.hxx>
28#include <docsh.hxx>
29#include <miscuno.hxx>
30#include <forbiuno.hxx>
31#include <appoptio.hxx>
32#include <viewopti.hxx>
33#include <docpool.hxx>
34#include <sc.hrc>
35#include <scmod.hxx>
36
37#include <com/sun/star/beans/PropertyAttribute.hpp>
38#include <com/sun/star/document/LinkUpdateModes.hpp>
39#include <cppuhelper/supportsservice.hxx>
40#include <formula/grammar.hxx>
41#include <sfx2/printer.hxx>
42#include <svl/itemset.hxx>
43#include <vcl/svapp.hxx>
44#include <tools/stream.hxx>
45
46using namespace com::sun::star;
47
48#define SCSAVEVERSION"SaveVersionOnClose" "SaveVersionOnClose"
49
50static const SfxItemPropertyMapEntry* lcl_GetConfigPropertyMap()
51{
52 static const SfxItemPropertyMapEntry aConfigPropertyMap_Impl[] =
53 {
54 {u"" SC_UNO_SHOWZERO"ShowZeroValues", 0, cppu::UnoType<bool>::get(), 0, 0},
55 {u"" SC_UNO_SHOWNOTES"ShowNotes", 0, cppu::UnoType<bool>::get(), 0, 0},
56 {u"" SC_UNO_SHOWGRID"ShowGrid", 0, cppu::UnoType<bool>::get(), 0, 0},
57 {u"" SC_UNO_GRIDCOLOR"GridColor", 0, cppu::UnoType<sal_Int32>::get(), 0, 0},
58 {u"" SC_UNO_SHOWPAGEBR"ShowPageBreaks", 0, cppu::UnoType<bool>::get(), 0, 0},
59 {u"" SC_UNONAME_LINKUPD"LinkUpdateMode", 0, cppu::UnoType<sal_Int16>::get(), 0, 0},
60 {u"" SC_UNO_COLROWHDR"HasColumnRowHeaders", 0, cppu::UnoType<bool>::get(), 0, 0},
61 {u"" SC_UNO_SHEETTABS"HasSheetTabs", 0, cppu::UnoType<bool>::get(), 0, 0},
62 {u"" SC_UNO_OUTLSYMB"IsOutlineSymbolsSet", 0, cppu::UnoType<bool>::get(), 0, 0},
63 {u"" SC_UNO_SNAPTORASTER"IsSnapToRaster", 0, cppu::UnoType<bool>::get(), 0, 0},
64 {u"" SC_UNO_RASTERVIS"RasterIsVisible", 0, cppu::UnoType<bool>::get(), 0, 0},
65 {u"" SC_UNO_RASTERRESX"RasterResolutionX", 0, cppu::UnoType<sal_Int32>::get(), 0, 0},
66 {u"" SC_UNO_RASTERRESY"RasterResolutionY", 0, cppu::UnoType<sal_Int32>::get(), 0, 0},
67 {u"" SC_UNO_RASTERSUBX"RasterSubdivisionX", 0, cppu::UnoType<sal_Int32>::get(), 0, 0},
68 {u"" SC_UNO_RASTERSUBY"RasterSubdivisionY", 0, cppu::UnoType<sal_Int32>::get(), 0, 0},
69 {u"" SC_UNO_RASTERSYNC"IsRasterAxisSynchronized", 0, cppu::UnoType<bool>::get(), 0, 0},
70 {u"" SC_UNO_AUTOCALC"AutoCalculate", 0, cppu::UnoType<bool>::get(), 0, 0},
71 {u"" SC_UNO_PRINTERNAME"PrinterName", 0, cppu::UnoType<OUString>::get(), 0, 0},
72 {u"" SC_UNO_PRINTERSETUP"PrinterSetup", 0, cppu::UnoType<uno::Sequence<sal_Int8>>::get(), 0, 0},
73 {u"" SC_UNO_PRINTERPAPER"PrinterPaperFromSetup", 0, cppu::UnoType<bool>::get(), 0, 0},
74 {u"" SC_UNO_APPLYDOCINF"ApplyUserData", 0, cppu::UnoType<bool>::get(), 0, 0 },
75 {u"" SC_UNO_SAVE_THUMBNAIL"SaveThumbnail", 0, cppu::UnoType<bool>::get(), 0, 0 },
76 {u"" SC_UNO_FORBIDDEN"ForbiddenCharacters", 0, cppu::UnoType<i18n::XForbiddenCharacters>::get(), beans::PropertyAttribute::READONLY, 0},
77 {u"" SC_UNO_CHARCOMP"CharacterCompressionType", 0, cppu::UnoType<sal_Int16>::get(), 0, 0},
78 {u"" SC_UNO_ASIANKERN"IsKernAsianPunctuation", 0, cppu::UnoType<bool>::get(), 0, 0},
79 {u"" SCSAVEVERSION"SaveVersionOnClose", 0, cppu::UnoType<bool>::get(), 0, 0},
80 {u"" SC_UNO_UPDTEMPL"UpdateFromTemplate", 0, cppu::UnoType<bool>::get(), 0, 0},
81 /*Stampit enable/disable print cancel */
82 {u"" SC_UNO_ALLOWPRINTJOBCANCEL"AllowPrintJobCancel", 0, cppu::UnoType<bool>::get(), 0, 0},
83 {u"" SC_UNO_LOADREADONLY"LoadReadonly", 0, cppu::UnoType<bool>::get(), 0, 0},
84 {u"" SC_UNO_SHAREDOC"IsDocumentShared", 0, cppu::UnoType<bool>::get(), 0, 0},
85 {u"" SC_UNO_MODIFYPASSWORDINFO"ModifyPasswordInfo", 0, cppu::UnoType<uno::Sequence< beans::PropertyValue >>::get(), 0, 0},
86 {u"" SC_UNO_EMBED_FONTS"EmbedFonts", 0, cppu::UnoType<bool>::get(), 0, 0},
87 {u"" SC_UNO_EMBED_ONLY_USED_FONTS"EmbedOnlyUsedFonts", 0, cppu::UnoType<bool>::get(), 0, 0},
88 {u"" SC_UNO_EMBED_FONT_SCRIPT_LATIN"EmbedLatinScriptFonts", 0, cppu::UnoType<bool>::get(), 0, 0},
89 {u"" SC_UNO_EMBED_FONT_SCRIPT_ASIAN"EmbedAsianScriptFonts", 0, cppu::UnoType<bool>::get(), 0, 0},
90 {u"" SC_UNO_EMBED_FONT_SCRIPT_COMPLEX"EmbedComplexScriptFonts", 0, cppu::UnoType<bool>::get(), 0, 0},
91 {u"" SC_UNO_SYNTAXSTRINGREF"SyntaxStringRef", 0, cppu::UnoType<sal_Int16>::get(), 0, 0},
92 { u"", 0, css::uno::Type(), 0, 0 }
93 };
94 return aConfigPropertyMap_Impl;
95}
96
97ScDocumentConfiguration::ScDocumentConfiguration(ScDocShell* pDocSh)
98 : pDocShell(pDocSh) ,
99 aPropSet ( lcl_GetConfigPropertyMap() )
100{
101 pDocShell->GetDocument().AddUnoObject(*this);
102}
103
104ScDocumentConfiguration::~ScDocumentConfiguration()
105{
106 SolarMutexGuard g;
107
108 if (pDocShell)
109 pDocShell->GetDocument().RemoveUnoObject(*this);
110}
111
112void ScDocumentConfiguration::Notify( SfxBroadcaster&, const SfxHint& rHint )
113{
114 // reference update does not matter here
115
116 if ( rHint.GetId() == SfxHintId::Dying )
117 {
118 pDocShell = nullptr;
119 }
120}
121
122// XPropertySet
123
124uno::Reference<beans::XPropertySetInfo> SAL_CALL ScDocumentConfiguration::getPropertySetInfo()
125{
126 SolarMutexGuard aGuard;
127 static uno::Reference<beans::XPropertySetInfo> aRef(
128 new SfxItemPropertySetInfo( aPropSet.getPropertyMap() ));
129 return aRef;
130}
131
132void SAL_CALL ScDocumentConfiguration::setPropertyValue(
133 const OUString& aPropertyName, const uno::Any& aValue )
134{
135 SolarMutexGuard aGuard;
136
137 if(!pDocShell)
1
Assuming field 'pDocShell' is non-null
→
2
←
Taking false branch
→
138 throw uno::RuntimeException();
139
140 ScDocument& rDoc = pDocShell->GetDocument();
141 bool bUpdateHeights = false;
142
143 ScViewOptions aViewOpt(rDoc.GetViewOptions());
144
145 /*Stampit enable/disable print cancel */
146 if ( aPropertyName == SC_UNO_ALLOWPRINTJOBCANCEL"AllowPrintJobCancel" )
3
←
Taking false branch
→
147 pDocShell->Stamp_SetPrintCancelState( ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
148 /*Stampit enable/disable print cancel */
149
150 else if ( aPropertyName == SC_UNO_SHOWZERO"ShowZeroValues" )
4
←
Taking false branch
→
151 aViewOpt.SetOption(VOPT_NULLVALS, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
152 else if ( aPropertyName == SC_UNO_SHOWNOTES"ShowNotes" )
5
←
Taking false branch
→
153 aViewOpt.SetOption(VOPT_NOTES, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
154 else if ( aPropertyName == SC_UNO_SHOWGRID"ShowGrid" )
6
←
Taking false branch
→
155 aViewOpt.SetOption(VOPT_GRID, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
156 else if ( aPropertyName == SC_UNO_GRIDCOLOR"GridColor" )
7
←
Taking false branch
→
157 {
158 sal_Int64 nColor = 0;
159 if (aValue >>= nColor)
160 {
161 Color aColor(static_cast<sal_uInt32>(nColor));
162 aViewOpt.SetGridColor(aColor, OUString());
163 }
164 }
165 else if ( aPropertyName == SC_UNO_SHOWPAGEBR"ShowPageBreaks" )
8
←
Taking false branch
→
166 aViewOpt.SetOption(VOPT_PAGEBREAKS, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
167 else if ( aPropertyName == SC_UNONAME_LINKUPD"LinkUpdateMode" )
9
←
Taking false branch
→
168 {
169 // XXX NOTE: this is the css::document::Settings property
170 // LinkUpdateMode, not the css::sheet::XGlobalSheetSettings
171 // attribute LinkUpdateMode.
172 sal_Int16 n;
173 if (!(aValue >>= n) || n < css::document::LinkUpdateModes::NEVER ||
174 n > css::document::LinkUpdateModes::GLOBAL_SETTING)
175 {
176 throw css::lang::IllegalArgumentException(
177 ("LinkUpdateMode property value must be a SHORT with a value in"
178 " the range of the css::document::LinkUpdateModes constants"),
179 css::uno::Reference<css::uno::XInterface>(), -1);
180 }
181 ScLkUpdMode eMode;
182 switch (n)
183 {
184 case css::document::LinkUpdateModes::NEVER:
185 eMode = LM_NEVER;
186 break;
187 case css::document::LinkUpdateModes::MANUAL:
188 eMode = LM_ON_DEMAND;
189 break;
190 case css::document::LinkUpdateModes::AUTO:
191 eMode = LM_ALWAYS;
192 break;
193 case css::document::LinkUpdateModes::GLOBAL_SETTING:
194 default:
195 eMode = SC_MOD()( static_cast<ScModule*>(SfxApplication::GetModule(SfxToolsModule
::Calc)) )->GetAppOptions().GetLinkMode();
196 break;
197 }
198 rDoc.SetLinkMode( eMode );
199 }
200 else if ( aPropertyName == SC_UNO_COLROWHDR"HasColumnRowHeaders" )
10
←
Taking false branch
→
201 aViewOpt.SetOption(VOPT_HEADER, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
202 else if ( aPropertyName == SC_UNO_SHEETTABS"HasSheetTabs" )
11
←
Taking false branch
→
203 aViewOpt.SetOption(VOPT_TABCONTROLS, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
204 else if ( aPropertyName == SC_UNO_OUTLSYMB"IsOutlineSymbolsSet" )
12
←
Taking false branch
→
205 aViewOpt.SetOption(VOPT_OUTLINER, ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
206 else if ( aPropertyName == SC_UNO_AUTOCALC"AutoCalculate" )
13
←
Taking false branch
→
207 rDoc.SetAutoCalc( ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
208 else if ( aPropertyName == SC_UNO_PRINTERNAME"PrinterName" )
14
←
Assuming the condition is true
→
15
←
Taking true branch
→
209 {
210 OUString sPrinterName;
211 if ( !(aValue >>= sPrinterName) )
16
←
Taking false branch
→
212 throw lang::IllegalArgumentException();
213
214 // #i75610# if the name is empty, do nothing (don't create any printer)
215 if ( !sPrinterName.isEmpty() && pDocShell->GetCreateMode() != SfxObjectCreateMode::EMBEDDED )
17
←
Assuming the condition is true
→
18
←
Taking true branch
→
216 {
217 SfxPrinter* pPrinter = pDocShell->GetPrinter();
218 if (!pPrinter)
19
←
Assuming 'pPrinter' is non-null
→
20
←
Taking false branch
→
219 throw uno::RuntimeException();
220
221 if (pPrinter->GetName() != sPrinterName)
21
←
Taking true branch
→
222 {
223 VclPtrInstance<SfxPrinter> pNewPrinter( pPrinter->GetOptions().Clone(), sPrinterName );
22
←
Calling constructor for 'VclPtrInstance<SfxPrinter>'
→
24
←
Returning from constructor for 'VclPtrInstance<SfxPrinter>'
→
224 if (pNewPrinter->IsKnown())
25
←
Assuming the condition is false
→
26
←
Taking false branch
→
225 pDocShell->SetPrinter( pNewPrinter, SfxPrinterChangeFlags::PRINTER );
226 else
227 pNewPrinter.disposeAndClear();
27
←
Calling 'VclPtr::disposeAndClear'
→
228 }
229
230 }
231
232 }
233 else if ( aPropertyName == SC_UNO_PRINTERSETUP"PrinterSetup" )
234 {
235 uno::Sequence<sal_Int8> aSequence;
236 if ( aValue >>= aSequence )
237 {
238 sal_uInt32 nSize = aSequence.getLength();
239 // #i75610# if the sequence is empty, do nothing (don't create any printer)
240 if ( nSize != 0 )
241 {
242 SvMemoryStream aStream (aSequence.getArray(), nSize, StreamMode::READ );
243 aStream.Seek ( STREAM_SEEK_TO_BEGIN0L );
244 auto pSet = std::make_unique<SfxItemSet>( *rDoc.GetPool(),
245 svl::Items<SID_PRINTER_NOTFOUND_WARN(5000 + 320), SID_PRINTER_NOTFOUND_WARN(5000 + 320),
246 SID_PRINTER_CHANGESTODOC(5000 + 324), SID_PRINTER_CHANGESTODOC(5000 + 324),
247 SID_PRINT_SELECTEDSHEET(5000 + 1712), SID_PRINT_SELECTEDSHEET(5000 + 1712),
248 SID_SCPRINTOPTIONS((26000) + 68), SID_SCPRINTOPTIONS((26000) + 68)>{} );
249
250 SfxPrinter* pPrinter = pDocShell->GetPrinter();
251 bool bPreferPrinterPapersize = false;
252 if ( pPrinter )
253 bPreferPrinterPapersize = pPrinter->GetPrinterSettingsPreferred();
254
255 VclPtr<SfxPrinter> pTempPrinter = SfxPrinter::Create( aStream, std::move(pSet) );
256 pTempPrinter->SetPrinterSettingsPreferred( bPreferPrinterPapersize );
257 pDocShell->SetPrinter( pTempPrinter );
258 }
259 }
260 }
261 else if ( aPropertyName == SC_UNO_PRINTERPAPER"PrinterPaperFromSetup" )
262 {
263 bool bPreferPrinterPapersize;
264 if( aValue >>= bPreferPrinterPapersize )
265 {
266 if( pDocShell->GetCreateMode() != SfxObjectCreateMode::EMBEDDED )
267 {
268 SfxPrinter *pTempPrinter = pDocShell->GetPrinter( true );
269 if (pTempPrinter)
270 pTempPrinter->SetPrinterSettingsPreferred( bPreferPrinterPapersize );
271 }
272 }
273 }
274 else if ( aPropertyName == SC_UNO_APPLYDOCINF"ApplyUserData" )
275 {
276 bool bTmp=true;
277 if ( aValue >>= bTmp )
278 pDocShell->SetUseUserData( bTmp );
279 }
280 else if ( aPropertyName == SC_UNO_SAVE_THUMBNAIL"SaveThumbnail")
281 {
282 bool bTmp = true;
283 if (aValue >>= bTmp)
284 pDocShell->SetUseThumbnailSave( bTmp );
285 }
286 else if ( aPropertyName == SC_UNO_FORBIDDEN"ForbiddenCharacters" )
287 {
288 // read-only - should not be set
289 }
290 else if ( aPropertyName == SC_UNO_CHARCOMP"CharacterCompressionType" )
291 {
292 // Int16 contains CharacterCompressionType values
293 sal_Int16 nUno = ScUnoHelpFunctions::GetInt16FromAny( aValue );
294 rDoc.SetAsianCompression( static_cast<CharCompressType>(nUno) );
295 bUpdateHeights = true;
296 }
297 else if ( aPropertyName == SC_UNO_ASIANKERN"IsKernAsianPunctuation" )
298 {
299 rDoc.SetAsianKerning( ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
300 bUpdateHeights = true;
301 }
302 else if ( aPropertyName == SCSAVEVERSION"SaveVersionOnClose" )
303 {
304 bool bTmp=false;
305 if ( aValue >>= bTmp )
306 pDocShell->SetSaveVersionOnClose( bTmp );
307 }
308 else if ( aPropertyName == SC_UNO_UPDTEMPL"UpdateFromTemplate" )
309 {
310 bool bTmp=true;
311 if ( aValue >>= bTmp )
312 pDocShell->SetQueryLoadTemplate( bTmp );
313 }
314 else if ( aPropertyName == SC_UNO_LOADREADONLY"LoadReadonly" )
315 {
316 bool bTmp=false;
317 if ( aValue >>= bTmp )
318 pDocShell->SetLoadReadonly( bTmp );
319 }
320 else if ( aPropertyName == SC_UNO_SHAREDOC"IsDocumentShared" )
321 {
322#if HAVE_FEATURE_MULTIUSER_ENVIRONMENT1
323 bool bDocShared = false;
324 if ( aValue >>= bDocShared )
325 {
326 pDocShell->SetSharedXMLFlag( bDocShared );
327 }
328#endif
329 }
330 else if ( aPropertyName == SC_UNO_MODIFYPASSWORDINFO"ModifyPasswordInfo" )
331 {
332 uno::Sequence< beans::PropertyValue > aInfo;
333 if ( !( aValue >>= aInfo ) )
334 throw lang::IllegalArgumentException(
335 "Value of type Sequence<PropertyValue> expected!",
336 uno::Reference< uno::XInterface >(),
337 2 );
338
339 if ( !pDocShell->SetModifyPasswordInfo( aInfo ) )
340 throw beans::PropertyVetoException(
341 "The hash is not allowed to be changed now!" );
342 }
343 else if (aPropertyName == SC_UNO_EMBED_FONTS"EmbedFonts")
344 {
345 bool bVal = aValue.has<bool>() && aValue.get<bool>();
346 rDoc.SetEmbedFonts(bVal);
347 }
348 else if (aPropertyName == SC_UNO_EMBED_ONLY_USED_FONTS"EmbedOnlyUsedFonts")
349 {
350 bool bVal = aValue.has<bool>() && aValue.get<bool>();
351 rDoc.SetEmbedUsedFontsOnly(bVal);
352 }
353 else if (aPropertyName == SC_UNO_EMBED_FONT_SCRIPT_LATIN"EmbedLatinScriptFonts")
354 {
355 bool bVal = aValue.has<bool>() && aValue.get<bool>();
356 rDoc.SetEmbedFontScriptLatin(bVal);
357 }
358 else if (aPropertyName == SC_UNO_EMBED_FONT_SCRIPT_ASIAN"EmbedAsianScriptFonts")
359 {
360 bool bVal = aValue.has<bool>() && aValue.get<bool>();
361 rDoc.SetEmbedFontScriptAsian(bVal);
362 }
363 else if (aPropertyName == SC_UNO_EMBED_FONT_SCRIPT_COMPLEX"EmbedComplexScriptFonts")
364 {
365 bool bVal = aValue.has<bool>() && aValue.get<bool>();
366 rDoc.SetEmbedFontScriptComplex(bVal);
367 }
368 else if ( aPropertyName == SC_UNO_SYNTAXSTRINGREF"SyntaxStringRef" )
369 {
370 ScCalcConfig aCalcConfig = rDoc.GetCalcConfig();
371 sal_Int16 nUno = 0;
372
373 if( aValue >>= nUno )
374 {
375 switch (nUno)
376 {
377 case 0: // CONV_OOO
378 case 2: // CONV_XL_A1
379 case 3: // CONV_XL_R1C1
380 case 7: // CONV_A1_XL_A1
381 aCalcConfig.SetStringRefSyntax( static_cast<formula::FormulaGrammar::AddressConvention>( nUno ) );
382 break;
383 default:
384 aCalcConfig.SetStringRefSyntax( formula::FormulaGrammar::CONV_UNSPECIFIED );
385 break;
386
387 }
388 rDoc.SetCalcConfig( aCalcConfig );
389 }
390 }
391
392 else
393 {
394 ScGridOptions aGridOpt(aViewOpt.GetGridOptions());
395 if ( aPropertyName == SC_UNO_SNAPTORASTER"IsSnapToRaster" )
396 aGridOpt.SetUseGridSnap( ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
397 else if ( aPropertyName == SC_UNO_RASTERVIS"RasterIsVisible" )
398 aGridOpt.SetGridVisible( ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
399 else if ( aPropertyName == SC_UNO_RASTERRESX"RasterResolutionX" )
400 aGridOpt.SetFieldDrawX( static_cast <sal_uInt32> ( ScUnoHelpFunctions::GetInt32FromAny( aValue ) ) );
401 else if ( aPropertyName == SC_UNO_RASTERRESY"RasterResolutionY" )
402 aGridOpt.SetFieldDrawY( static_cast <sal_uInt32> ( ScUnoHelpFunctions::GetInt32FromAny( aValue ) ) );
403 else if ( aPropertyName == SC_UNO_RASTERSUBX"RasterSubdivisionX" )
404 aGridOpt.SetFieldDivisionX( static_cast <sal_uInt32> ( ScUnoHelpFunctions::GetInt32FromAny( aValue ) ) );
405 else if ( aPropertyName == SC_UNO_RASTERSUBY"RasterSubdivisionY" )
406 aGridOpt.SetFieldDivisionY( static_cast <sal_uInt32> ( ScUnoHelpFunctions::GetInt32FromAny( aValue ) ) );
407 else if ( aPropertyName == SC_UNO_RASTERSYNC"IsRasterAxisSynchronized" )
408 aGridOpt.SetSynchronize( ScUnoHelpFunctions::GetBoolFromAny( aValue ) );
409 else
410 throw beans::UnknownPropertyException(aPropertyName);
411 aViewOpt.SetGridOptions(aGridOpt);
412 }
413 rDoc.SetViewOptions(aViewOpt);
414
415 if ( bUpdateHeights && !rDoc.IsImportingXML() )
416 {
417 // update automatic row heights and repaint
418 SCTAB nTabCount = rDoc.GetTableCount();
419 for (SCTAB nTab=0; nTab<nTabCount; nTab++)
420 if ( !pDocShell->AdjustRowHeight( 0, rDoc.MaxRow(), nTab ) )
421 pDocShell->PostPaint(ScRange(0, 0, nTab, rDoc.MaxCol(), rDoc.MaxRow(), nTab), PaintPartFlags::Grid);
422 pDocShell->SetDocumentModified();
423 }
424
425}
426
427uno::Any SAL_CALL ScDocumentConfiguration::getPropertyValue( const OUString& aPropertyName )
428{
429 SolarMutexGuard aGuard;
430 uno::Any aRet;
431
432 if(!pDocShell)
433 throw uno::RuntimeException();
434
435 ScDocument& rDoc = pDocShell->GetDocument();
436 const ScViewOptions& aViewOpt = rDoc.GetViewOptions();
437
438 /*Stampit enable/disable print cancel */
439 if ( aPropertyName == SC_UNO_ALLOWPRINTJOBCANCEL"AllowPrintJobCancel" )
440 aRet <<= pDocShell->Stamp_GetPrintCancelState();
441 /*Stampit enable/disable print cancel */
442
443 else if ( aPropertyName == SC_UNO_SHOWZERO"ShowZeroValues" )
444 aRet <<= aViewOpt.GetOption( VOPT_NULLVALS );
445 else if ( aPropertyName == SC_UNO_SHOWNOTES"ShowNotes" )
446 aRet <<= aViewOpt.GetOption( VOPT_NOTES );
447 else if ( aPropertyName == SC_UNO_SHOWGRID"ShowGrid" )
448 aRet <<= aViewOpt.GetOption( VOPT_GRID );
449 else if ( aPropertyName == SC_UNO_GRIDCOLOR"GridColor" )
450 {
451 OUString aColorName;
452 Color aColor = aViewOpt.GetGridColor(&aColorName);
453 aRet <<= aColor;
454 }
455 else if ( aPropertyName == SC_UNO_SHOWPAGEBR"ShowPageBreaks" )
456 aRet <<= aViewOpt.GetOption( VOPT_PAGEBREAKS );
457 else if ( aPropertyName == SC_UNONAME_LINKUPD"LinkUpdateMode" )
458 {
459 sal_Int16 nLUM;
460 switch (rDoc.GetLinkMode())
461 {
462 case LM_ALWAYS:
463 nLUM = css::document::LinkUpdateModes::AUTO;
464 break;
465 case LM_NEVER:
466 nLUM = css::document::LinkUpdateModes::NEVER;
467 break;
468 case LM_ON_DEMAND:
469 nLUM = css::document::LinkUpdateModes::MANUAL;
470 break;
471 case LM_UNKNOWN:
472 default:
473 nLUM = css::document::LinkUpdateModes::GLOBAL_SETTING;
474 break;
475 }
476 aRet <<= nLUM;
477 }
478 else if ( aPropertyName == SC_UNO_COLROWHDR"HasColumnRowHeaders" )
479 aRet <<= aViewOpt.GetOption( VOPT_HEADER );
480 else if ( aPropertyName == SC_UNO_SHEETTABS"HasSheetTabs" )
481 aRet <<= aViewOpt.GetOption( VOPT_TABCONTROLS );
482 else if ( aPropertyName == SC_UNO_OUTLSYMB"IsOutlineSymbolsSet" )
483 aRet <<= aViewOpt.GetOption( VOPT_OUTLINER );
484 else if ( aPropertyName == SC_UNO_AUTOCALC"AutoCalculate" )
485 aRet <<= rDoc.GetAutoCalc();
486 else if ( aPropertyName == SC_UNO_PRINTERNAME"PrinterName" )
487 {
488 // #i75610# don't create the printer, return empty string if no printer created yet
489 // (as in SwXDocumentSettings)
490 SfxPrinter* pPrinter = rDoc.GetPrinter( false );
491 if (pPrinter)
492 aRet <<= pPrinter->GetName();
493 else
494 aRet <<= OUString();
495 }
496 else if ( aPropertyName == SC_UNO_PRINTERSETUP"PrinterSetup" )
497 {
498 // #i75610# don't create the printer, return empty sequence if no printer created yet
499 // (as in SwXDocumentSettings)
500 SfxPrinter* pPrinter = rDoc.GetPrinter( false );
501 if (pPrinter)
502 {
503 SvMemoryStream aStream;
504 pPrinter->Store( aStream );
505 aRet <<= uno::Sequence< sal_Int8 >( static_cast< const sal_Int8* >( aStream.GetData() ),
506 aStream.TellEnd() );
507 }
508 else
509 aRet <<= uno::Sequence<sal_Int8>();
510 }
511 else if ( aPropertyName == SC_UNO_PRINTERPAPER"PrinterPaperFromSetup")
512 {
513 SfxPrinter *pTempPrinter = pDocShell->GetPrinter( false );
514 aRet <<= pTempPrinter && pTempPrinter->GetPrinterSettingsPreferred();
515
516 }
517 else if ( aPropertyName == SC_UNO_APPLYDOCINF"ApplyUserData" )
518 aRet <<= pDocShell->IsUseUserData();
519 else if ( aPropertyName == SC_UNO_SAVE_THUMBNAIL"SaveThumbnail" )
520 aRet <<= pDocShell->IsUseThumbnailSave();
521 else if ( aPropertyName == SC_UNO_FORBIDDEN"ForbiddenCharacters" )
522 {
523 aRet <<= uno::Reference<i18n::XForbiddenCharacters>(new ScForbiddenCharsObj( pDocShell ));
524 }
525 else if ( aPropertyName == SC_UNO_CHARCOMP"CharacterCompressionType" )
526 aRet <<= static_cast<sal_Int16> ( rDoc.GetAsianCompression() );
527 else if ( aPropertyName == SC_UNO_ASIANKERN"IsKernAsianPunctuation" )
528 aRet <<= rDoc.GetAsianKerning();
529 else if ( aPropertyName == SCSAVEVERSION"SaveVersionOnClose" )
530 aRet <<= pDocShell->IsSaveVersionOnClose();
531 else if ( aPropertyName == SC_UNO_UPDTEMPL"UpdateFromTemplate" )
532 aRet <<= pDocShell->IsQueryLoadTemplate();
533 else if ( aPropertyName == SC_UNO_LOADREADONLY"LoadReadonly" )
534 aRet <<= pDocShell->IsLoadReadonly();
535 else if ( aPropertyName == SC_UNO_SHAREDOC"IsDocumentShared" )
536 {
537#if HAVE_FEATURE_MULTIUSER_ENVIRONMENT1
538 aRet <<= pDocShell->HasSharedXMLFlagSet();
539#endif
540 }
541 else if ( aPropertyName == SC_UNO_MODIFYPASSWORDINFO"ModifyPasswordInfo" )
542 aRet <<= pDocShell->GetModifyPasswordInfo();
543 else if (aPropertyName == SC_UNO_EMBED_FONTS"EmbedFonts")
544 aRet <<= rDoc.IsEmbedFonts();
545 else if (aPropertyName == SC_UNO_EMBED_ONLY_USED_FONTS"EmbedOnlyUsedFonts")
546 aRet <<= rDoc.IsEmbedUsedFontsOnly();
547 else if (aPropertyName == SC_UNO_EMBED_FONT_SCRIPT_LATIN"EmbedLatinScriptFonts")
548 aRet <<= rDoc.IsEmbedFontScriptLatin();
549 else if (aPropertyName == SC_UNO_EMBED_FONT_SCRIPT_ASIAN"EmbedAsianScriptFonts")
550 aRet <<= rDoc.IsEmbedFontScriptAsian();
551 else if (aPropertyName == SC_UNO_EMBED_FONT_SCRIPT_COMPLEX"EmbedComplexScriptFonts")
552 aRet <<= rDoc.IsEmbedFontScriptComplex();
553 else if ( aPropertyName == SC_UNO_SYNTAXSTRINGREF"SyntaxStringRef" )
554 {
555 ScCalcConfig aCalcConfig = rDoc.GetCalcConfig();
556 formula::FormulaGrammar::AddressConvention eConv = aCalcConfig.meStringRefAddressSyntax;
557
558 // don't save "unspecified" string ref syntax ... query formula grammar
559 // and save that instead
560 if( eConv == formula::FormulaGrammar::CONV_UNSPECIFIED)
561 {
562 eConv = rDoc.GetAddressConvention();
563 }
564
565 // write if it has been read|imported or explicitly changed
566 // or if ref syntax isn't what would be native for our file format
567 // i.e. CalcA1 in this case
568 if ( aCalcConfig.mbHasStringRefSyntax ||
569 (eConv != formula::FormulaGrammar::CONV_OOO) )
570 {
571 switch (eConv)
572 {
573 case formula::FormulaGrammar::CONV_OOO:
574 case formula::FormulaGrammar::CONV_XL_A1:
575 case formula::FormulaGrammar::CONV_XL_R1C1:
576 case formula::FormulaGrammar::CONV_A1_XL_A1:
577 aRet <<= static_cast<sal_Int16>( eConv );
578 break;
579
580 case formula::FormulaGrammar::CONV_UNSPECIFIED:
581 case formula::FormulaGrammar::CONV_ODF:
582 case formula::FormulaGrammar::CONV_XL_OOX:
583 case formula::FormulaGrammar::CONV_LOTUS_A1:
584 case formula::FormulaGrammar::CONV_LAST:
585 {
586 aRet <<= sal_Int16(9999);
587 break;
588 }
589 }
590 }
591 }
592
593 else
594 {
595 const ScGridOptions& aGridOpt = aViewOpt.GetGridOptions();
596 if ( aPropertyName == SC_UNO_SNAPTORASTER"IsSnapToRaster" )
597 aRet <<= aGridOpt.GetUseGridSnap();
598 else if ( aPropertyName == SC_UNO_RASTERVIS"RasterIsVisible" )
599 aRet <<= aGridOpt.GetGridVisible();
600 else if ( aPropertyName == SC_UNO_RASTERRESX"RasterResolutionX" )
601 aRet <<= static_cast<sal_Int32> ( aGridOpt.GetFieldDrawX() );
602 else if ( aPropertyName == SC_UNO_RASTERRESY"RasterResolutionY" )
603 aRet <<= static_cast<sal_Int32> ( aGridOpt.GetFieldDrawY() );
604 else if ( aPropertyName == SC_UNO_RASTERSUBX"RasterSubdivisionX" )
605 aRet <<= static_cast<sal_Int32> ( aGridOpt.GetFieldDivisionX() );
606 else if ( aPropertyName == SC_UNO_RASTERSUBY"RasterSubdivisionY" )
607 aRet <<= static_cast<sal_Int32> ( aGridOpt.GetFieldDivisionY() );
608 else if ( aPropertyName == SC_UNO_RASTERSYNC"IsRasterAxisSynchronized" )
609 aRet <<= aGridOpt.GetSynchronize();
610 else
611 throw beans::UnknownPropertyException(aPropertyName);
612 }
613
614
615 return aRet;
616}
617
618SC_IMPL_DUMMY_PROPERTY_LISTENER( ScDocumentConfiguration )void ScDocumentConfiguration::addPropertyChangeListener( const
OUString&, const uno::Reference<beans::XPropertyChangeListener
>&) { do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/unoobj/confuno.cxx"
":" "618" ": "), "%s", "not implemented"); } } while (false)
; } void ScDocumentConfiguration::removePropertyChangeListener
( const OUString&, const uno::Reference<beans::XPropertyChangeListener
>&) { do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/unoobj/confuno.cxx"
":" "618" ": "), "%s", "not implemented"); } } while (false)
; } void ScDocumentConfiguration::addVetoableChangeListener( const
OUString&, const uno::Reference<beans::XVetoableChangeListener
>&) { do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/unoobj/confuno.cxx"
":" "618" ": "), "%s", "not implemented"); } } while (false)
; } void ScDocumentConfiguration::removeVetoableChangeListener
( const OUString&, const uno::Reference<beans::XVetoableChangeListener
>&) { do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/ui/unoobj/confuno.cxx"
":" "618" ": "), "%s", "not implemented"); } } while (false)
; }
619
620// XServiceInfo
621OUString SAL_CALL ScDocumentConfiguration::getImplementationName()
622{
623 return "ScDocumentConfiguration";
624}
625
626sal_Bool SAL_CALL ScDocumentConfiguration::supportsService( const OUString& rServiceName )
627{
628 return cppu::supportsService(this, rServiceName);
629}
630
631uno::Sequence<OUString> SAL_CALL ScDocumentConfiguration::getSupportedServiceNames()
632{
633 return {"com.sun.star.comp.SpreadsheetSettings",
634 "com.sun.star.document.Settings"};
635}
636
637/* 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);
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 ;-)
28
←
Calling 'Reference::clear'
→
35
←
Returning; memory was released
→
205 if (aTmp.get()) {
36
←
Calling 'Reference::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 )
23
←
Memory is allocated
→
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)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
28.1
Field 'm_pBody' is non-null
28.1
Field 'm_pBody' is non-null
28.1
Field 'm_pBody' is non-null
28.1
Field 'm_pBody' is non-null
)
29
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
30
←
Calling 'VclReferenceBase::release'
→
34
←
Returning; memory was released
→
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;
37
←
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)
31
←
Assuming the condition is true
→
32
←
Taking true branch
→
40 delete this;
33
←
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