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 global.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/core/data/global.cxx

/home/maarten/src/libreoffice/core/sc/source/core/data/global.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 <scitems.hxx>
21#include <svx/algitem.hxx>
22#include <editeng/brushitem.hxx>
23#include <editeng/editobj.hxx>
24#include <svl/srchitem.hxx>
25#include <editeng/langitem.hxx>
26#include <sfx2/docfile.hxx>
27#include <sfx2/dispatch.hxx>
28#include <sfx2/objsh.hxx>
29#include <sfx2/sfxsids.hrc>
30#include <sfx2/viewfrm.hxx>
31#include <sfx2/viewsh.hxx>
32#include <svl/intitem.hxx>
33#include <svl/stritem.hxx>
34#include <svl/zforlist.hxx>
35#include <svl/zformat.hxx>
36#include <vcl/keycodes.hxx>
37#include <vcl/virdev.hxx>
38#include <vcl/settings.hxx>
39#include <vcl/svapp.hxx>
40#include <unotools/charclass.hxx>
41#include <unotools/securityoptions.hxx>
42#include <osl/diagnose.h>
43
44#include <i18nlangtag/mslangid.hxx>
45#include <comphelper/doublecheckedinit.hxx>
46#include <comphelper/processfactory.hxx>
47#include <comphelper/string.hxx>
48#include <unotools/calendarwrapper.hxx>
49#include <unotools/collatorwrapper.hxx>
50#include <unotools/syslocale.hxx>
51#include <unotools/transliterationwrapper.hxx>
52
53#include <comphelper/lok.hxx>
54#include <vcl/opengl/OpenGLWrapper.hxx>
55
56#include <global.hxx>
57#include <scresid.hxx>
58#include <autoform.hxx>
59#include <patattr.hxx>
60#include <addincol.hxx>
61#include <adiasync.hxx>
62#include <userlist.hxx>
63#include <interpre.hxx>
64#include <unitconv.hxx>
65#include <compiler.hxx>
66#include <parclass.hxx>
67#include <funcdesc.hxx>
68#include <globstr.hrc>
69#include <strings.hrc>
70#include <scmod.hxx>
71#include <editutil.hxx>
72#include <docsh.hxx>
73
74tools::SvRef<ScDocShell> ScGlobal::xDrawClipDocShellRef;
75std::unique_ptr<SvxSearchItem> ScGlobal::xSearchItem;
76std::unique_ptr<ScAutoFormat> ScGlobal::xAutoFormat;
77std::atomic<LegacyFuncCollection*> ScGlobal::pLegacyFuncCollection(nullptr);
78std::atomic<ScUnoAddInCollection*> ScGlobal::pAddInCollection(nullptr);
79std::unique_ptr<ScUserList> ScGlobal::xUserList;
80LanguageType ScGlobal::eLnge = LANGUAGE_SYSTEMLanguageType(0x0000);
81std::atomic<css::lang::Locale*> ScGlobal::pLocale(nullptr);
82std::unique_ptr<SvtSysLocale> ScGlobal::xSysLocale;
83std::unique_ptr<CalendarWrapper> ScGlobal::xCalendar;
84std::atomic<CollatorWrapper*> ScGlobal::pCollator(nullptr);
85std::atomic<CollatorWrapper*> ScGlobal::pCaseCollator(nullptr);
86std::atomic<::utl::TransliterationWrapper*> ScGlobal::pTransliteration(nullptr);
87std::atomic<::utl::TransliterationWrapper*> ScGlobal::pCaseTransliteration(nullptr);
88css::uno::Reference< css::i18n::XOrdinalSuffix> ScGlobal::xOrdinalSuffix;
89const OUString ScGlobal::aEmptyOUString;
90OUString ScGlobal::aStrClipDocName;
91
92std::unique_ptr<SvxBrushItem> ScGlobal::xEmptyBrushItem;
93std::unique_ptr<SvxBrushItem> ScGlobal::xButtonBrushItem;
94
95std::unique_ptr<ScFunctionList> ScGlobal::xStarCalcFunctionList;
96std::unique_ptr<ScFunctionMgr> ScGlobal::xStarCalcFunctionMgr;
97
98std::atomic<ScUnitConverter*> ScGlobal::pUnitConverter(nullptr);
99std::unique_ptr<SvNumberFormatter> ScGlobal::xEnglishFormatter;
100std::unique_ptr<ScFieldEditEngine> ScGlobal::xFieldEditEngine;
101
102double ScGlobal::nScreenPPTX = 96.0;
103double ScGlobal::nScreenPPTY = 96.0;
104
105sal_uInt16 ScGlobal::nDefFontHeight = 225;
106sal_uInt16 ScGlobal::nStdRowHeight = 256;
107
108long ScGlobal::nLastRowHeightExtra = 0;
109long ScGlobal::nLastColWidthExtra = STD_EXTRA_WIDTH113;
110
111SfxViewShell* pScActiveViewShell = nullptr; //FIXME: Make this a member
112sal_uInt16 nScClickMouseModifier = 0; //FIXME: This too
113sal_uInt16 nScFillModeMouseModifier = 0; //FIXME: And this
114
115bool ScGlobal::bThreadedGroupCalcInProgress = false;
116
117// Static functions
118
119bool ScGlobal::HasAttrChanged( const SfxItemSet& rNewAttrs,
120 const SfxItemSet& rOldAttrs,
121 const sal_uInt16 nWhich )
122{
123 bool bInvalidate = false;
124 const SfxPoolItem* pNewItem = nullptr;
125 const SfxItemState eNewState = rNewAttrs.GetItemState( nWhich, true, &pNewItem );
126 const SfxPoolItem* pOldItem = nullptr;
127 const SfxItemState eOldState = rOldAttrs.GetItemState( nWhich, true, &pOldItem );
128
129 if ( eNewState == eOldState )
130 {
131 // Both Items set
132 // PoolItems, meaning comparing pointers is valid
133 if ( SfxItemState::SET == eOldState )
134 bInvalidate = (pNewItem != pOldItem);
135 }
136 else
137 {
138 // Contains a Default Item
139 // PoolItems, meaning Item comparison necessary
140 if (!pOldItem)
141 pOldItem = &rOldAttrs.GetPool()->GetDefaultItem( nWhich );
142
143 if (!pNewItem)
144 pNewItem = &rNewAttrs.GetPool()->GetDefaultItem( nWhich );
145
146 bInvalidate = (*pNewItem != *pOldItem);
147 }
148
149 return bInvalidate;
150}
151
152sal_uInt32 ScGlobal::GetStandardFormat( SvNumberFormatter& rFormatter,
153 sal_uInt32 nFormat, SvNumFormatType nType )
154{
155 const SvNumberformat* pFormat = rFormatter.GetEntry( nFormat );
156 if ( pFormat )
157 return rFormatter.GetStandardFormat( nFormat, nType, pFormat->GetLanguage() );
158 return rFormatter.GetStandardFormat( nType, eLnge );
159}
160
161sal_uInt16 ScGlobal::GetStandardRowHeight()
162{
163 return nStdRowHeight;
164}
165
166SvNumberFormatter* ScGlobal::GetEnglishFormatter()
167{
168 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 168, __extension__ __PRETTY_FUNCTION__));
169 if ( !xEnglishFormatter )
170 {
171 xEnglishFormatter.reset( new SvNumberFormatter(
172 ::comphelper::getProcessComponentContext(), LANGUAGE_ENGLISH_USLanguageType(0x0409) ) );
173 xEnglishFormatter->SetEvalDateFormat( NF_EVALDATEFORMAT_INTL_FORMAT );
174 }
175 return xEnglishFormatter.get();
176}
177
178bool ScGlobal::CheckWidthInvalidate( bool& bNumFormatChanged,
179 const SfxItemSet& rNewAttrs,
180 const SfxItemSet& rOldAttrs )
181{
182 // Check whether attribute changes in rNewAttrs compared to rOldAttrs render
183 // the text width at a cell invalid
184 bNumFormatChanged =
185 HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_VALUE_FORMAT );
186 return ( bNumFormatChanged
187 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_LANGUAGE_FORMAT )
188 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT )
189 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CJK_FONT )
190 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CTL_FONT )
191 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_HEIGHT )
192 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CJK_FONT_HEIGHT )
193 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CTL_FONT_HEIGHT )
194 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_WEIGHT )
195 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CJK_FONT_WEIGHT )
196 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CTL_FONT_WEIGHT )
197 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_POSTURE )
198 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CJK_FONT_POSTURE )
199 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_CTL_FONT_POSTURE )
200 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_UNDERLINE )
201 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_OVERLINE )
202 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_CROSSEDOUT )
203 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_CONTOUR )
204 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_FONT_SHADOWED )
205 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_STACKED )
206 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_ROTATE_VALUE )
207 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_ROTATE_MODE )
208 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_LINEBREAK )
209 || HasAttrChanged( rNewAttrs, rOldAttrs, ATTR_MARGIN )
210 );
211}
212
213const SvxSearchItem& ScGlobal::GetSearchItem()
214{
215 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 215, __extension__ __PRETTY_FUNCTION__));
216 if (!xSearchItem)
217 {
218 xSearchItem.reset(new SvxSearchItem( SID_SEARCH_ITEMTypedWhichId<SvxSearchItem>(10000 + 291) ));
219 xSearchItem->SetAppFlag( SvxSearchApp::CALC );
220 }
221 return *xSearchItem;
222}
223
224void ScGlobal::SetSearchItem( const SvxSearchItem& rNew )
225{
226 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 226, __extension__ __PRETTY_FUNCTION__));
227 // FIXME: An assignment operator would be nice here
228 xSearchItem.reset(rNew.Clone());
229
230 xSearchItem->SetWhich( SID_SEARCH_ITEMTypedWhichId<SvxSearchItem>(10000 + 291) );
231 xSearchItem->SetAppFlag( SvxSearchApp::CALC );
232}
233
234void ScGlobal::ClearAutoFormat()
235{
236 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 236, __extension__ __PRETTY_FUNCTION__));
237 if (xAutoFormat)
238 {
239 // When modified via StarOne then only the SaveLater flag is set and no saving is done.
240 // If the flag is set then save now.
241 if (xAutoFormat->IsSaveLater())
242 xAutoFormat->Save();
243 xAutoFormat.reset();
244 }
245}
246
247ScAutoFormat* ScGlobal::GetAutoFormat()
248{
249 return xAutoFormat.get();
250}
251
252ScAutoFormat* ScGlobal::GetOrCreateAutoFormat()
253{
254 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 254, __extension__ __PRETTY_FUNCTION__));
255 if ( !xAutoFormat )
256 {
257 xAutoFormat.reset(new ScAutoFormat);
258 xAutoFormat->Load();
259 }
260
261 return xAutoFormat.get();
262}
263
264LegacyFuncCollection* ScGlobal::GetLegacyFuncCollection()
265{
266 return comphelper::doubleCheckedInit( pLegacyFuncCollection, []() { return new LegacyFuncCollection(); });
267}
268
269ScUnoAddInCollection* ScGlobal::GetAddInCollection()
270{
271 return comphelper::doubleCheckedInit( pAddInCollection, []() { return new ScUnoAddInCollection(); });
272}
273
274ScUserList* ScGlobal::GetUserList()
275{
276 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 276, __extension__ __PRETTY_FUNCTION__));
277 // Hack: Load Cfg item at the App
278 global_InitAppOptions();
279
280 if (!xUserList)
281 xUserList.reset(new ScUserList());
282 return xUserList.get();
283}
284
285void ScGlobal::SetUserList( const ScUserList* pNewList )
286{
287 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 287, __extension__ __PRETTY_FUNCTION__));
288 if ( pNewList )
289 {
290 if ( !xUserList )
291 xUserList.reset( new ScUserList( *pNewList ) );
292 else
293 *xUserList = *pNewList;
294 }
295 else
296 {
297 xUserList.reset();
298 }
299}
300
301OUString ScGlobal::GetErrorString(FormulaError nErr)
302{
303 const char* pErrNumber;
304 switch (nErr)
305 {
306 case FormulaError::NoRef:
307 pErrNumber = STR_NO_REF_TABLEreinterpret_cast<char const *>("STR_NO_REF_TABLE" "\004"
u8"#REF!");
308 break;
309 case FormulaError::NoAddin:
310 pErrNumber = STR_NO_ADDINreinterpret_cast<char const *>("STR_NO_ADDIN" "\004" u8"#ADDIN?"
);
311 break;
312 case FormulaError::NoMacro:
313 pErrNumber = STR_NO_MACROreinterpret_cast<char const *>("STR_NO_MACRO" "\004" u8"#MACRO?"
);
314 break;
315 case FormulaError::NotAvailable:
316 return ScCompiler::GetNativeSymbol(ocErrNA);
317 case FormulaError::NoName:
318 return ScCompiler::GetNativeSymbol(ocErrName);
319 case FormulaError::NoValue:
320 return ScCompiler::GetNativeSymbol(ocErrValue);
321 case FormulaError::NoCode:
322 return ScCompiler::GetNativeSymbol(ocErrNull);
323 case FormulaError::DivisionByZero:
324 return ScCompiler::GetNativeSymbol(ocErrDivZero);
325 case FormulaError::IllegalFPOperation:
326 return ScCompiler::GetNativeSymbol(ocErrNum);
327 default:
328 return ScResId(STR_ERROR_STRreinterpret_cast<char const *>("STR_ERROR_STR" "\004" u8"Err:"
)) + OUString::number( static_cast<int>(nErr) );
329 }
330 return ScResId(pErrNumber);
331}
332
333OUString ScGlobal::GetLongErrorString(FormulaError nErr)
334{
335 const char* pErrNumber;
336 switch (nErr)
337 {
338 case FormulaError::NONE:
339 return OUString();
340 case FormulaError::IllegalArgument:
341 pErrNumber = STR_LONG_ERR_ILL_ARGreinterpret_cast<char const *>("STR_LONG_ERR_ILL_ARG" "\004"
u8"Error: Invalid argument");
342 break;
343 case FormulaError::IllegalFPOperation:
344 pErrNumber = STR_LONG_ERR_ILL_FPOreinterpret_cast<char const *>("STR_LONG_ERR_ILL_FPO" "\004"
u8"Error: Invalid numeric value");
345 break;
346 case FormulaError::IllegalChar:
347 pErrNumber = STR_LONG_ERR_ILL_CHARreinterpret_cast<char const *>("STR_LONG_ERR_ILL_CHAR" "\004"
u8"Error: Invalid character");
348 break;
349 case FormulaError::IllegalParameter:
350 pErrNumber = STR_LONG_ERR_ILL_PARreinterpret_cast<char const *>("STR_LONG_ERR_ILL_PAR" "\004"
u8"Error in parameter list");
351 break;
352 case FormulaError::Pair:
353 case FormulaError::PairExpected:
354 pErrNumber = STR_LONG_ERR_PAIRreinterpret_cast<char const *>("STR_LONG_ERR_PAIR" "\004"
u8"Error: in bracketing");
355 break;
356 case FormulaError::OperatorExpected:
357 pErrNumber = STR_LONG_ERR_OP_EXPreinterpret_cast<char const *>("STR_LONG_ERR_OP_EXP" "\004"
u8"Error: Operator missing");
358 break;
359 case FormulaError::VariableExpected:
360 case FormulaError::ParameterExpected:
361 pErrNumber = STR_LONG_ERR_VAR_EXPreinterpret_cast<char const *>("STR_LONG_ERR_VAR_EXP" "\004"
u8"Error: Variable missing");
362 break;
363 case FormulaError::CodeOverflow:
364 pErrNumber = STR_LONG_ERR_CODE_OVFreinterpret_cast<char const *>("STR_LONG_ERR_CODE_OVF" "\004"
u8"Error: Formula overflow");
365 break;
366 case FormulaError::StringOverflow:
367 pErrNumber = STR_LONG_ERR_STR_OVFreinterpret_cast<char const *>("STR_LONG_ERR_STR_OVF" "\004"
u8"Error: String overflow");
368 break;
369 case FormulaError::StackOverflow:
370 pErrNumber = STR_LONG_ERR_STACK_OVFreinterpret_cast<char const *>("STR_LONG_ERR_STACK_OVF"
"\004" u8"Error: Internal overflow");
371 break;
372 case FormulaError::MatrixSize:
373 pErrNumber = STR_LONG_ERR_MATRIX_SIZEreinterpret_cast<char const *>("STR_LONG_ERR_MATRIX_SIZE"
"\004" u8"Error: Array or matrix size");
374 break;
375 case FormulaError::UnknownState:
376 case FormulaError::UnknownVariable:
377 case FormulaError::UnknownOpCode:
378 case FormulaError::UnknownStackVariable:
379 case FormulaError::UnknownToken:
380 case FormulaError::NoCode:
381 pErrNumber = STR_LONG_ERR_SYNTAXreinterpret_cast<char const *>("STR_LONG_ERR_SYNTAX" "\004"
u8"Internal syntactical error");
382 break;
383 case FormulaError::CircularReference:
384 pErrNumber = STR_LONG_ERR_CIRC_REFreinterpret_cast<char const *>("STR_LONG_ERR_CIRC_REF" "\004"
u8"Error: Circular reference");
385 break;
386 case FormulaError::NoConvergence:
387 pErrNumber = STR_LONG_ERR_NO_CONVreinterpret_cast<char const *>("STR_LONG_ERR_NO_CONV" "\004"
u8"Error: Calculation does not converge");
388 break;
389 case FormulaError::NoRef:
390 pErrNumber = STR_LONG_ERR_NO_REFreinterpret_cast<char const *>("STR_LONG_ERR_NO_REF" "\004"
u8"Error: Not a valid reference");
391 break;
392 case FormulaError::NoName:
393 pErrNumber = STR_LONG_ERR_NO_NAMEreinterpret_cast<char const *>("STR_LONG_ERR_NO_NAME" "\004"
u8"Error: Invalid name");
394 break;
395 case FormulaError::NoAddin:
396 pErrNumber = STR_LONG_ERR_NO_ADDINreinterpret_cast<char const *>("STR_LONG_ERR_NO_ADDIN" "\004"
u8"Error: Add-in not found");
397 break;
398 case FormulaError::NoMacro:
399 pErrNumber = STR_LONG_ERR_NO_MACROreinterpret_cast<char const *>("STR_LONG_ERR_NO_MACRO" "\004"
u8"Error: Macro not found");
400 break;
401 case FormulaError::DivisionByZero:
402 pErrNumber = STR_LONG_ERR_DIV_ZEROreinterpret_cast<char const *>("STR_LONG_ERR_DIV_ZERO" "\004"
u8"Error: Division by zero");
403 break;
404 case FormulaError::NestedArray:
405 pErrNumber = STR_ERR_LONG_NESTED_ARRAYreinterpret_cast<char const *>("STR_ERR_LONG_NESTED_ARRAY"
"\004" u8"Nested arrays are not supported.");
406 break;
407 case FormulaError::BadArrayContent:
408 pErrNumber = STR_ERR_LONG_BAD_ARRAY_CONTENTreinterpret_cast<char const *>("STR_ERR_LONG_BAD_ARRAY_CONTENT"
"\004" u8"Unsupported inline array content.");
409 break;
410 case FormulaError::LinkFormulaNeedingCheck:
411 pErrNumber = STR_ERR_LONG_LINK_FORMULA_NEEDING_CHECKreinterpret_cast<char const *>("STR_ERR_LONG_LINK_FORMULA_NEEDING_CHECK"
"\004" u8"External content disabled.");
412 break;
413 case FormulaError::NoValue:
414 pErrNumber = STR_LONG_ERR_NO_VALUEreinterpret_cast<char const *>("STR_LONG_ERR_NO_VALUE" "\004"
u8"Error: Wrong data type");
415 break;
416 case FormulaError::NotAvailable:
417 pErrNumber = STR_LONG_ERR_NVreinterpret_cast<char const *>("STR_LONG_ERR_NV" "\004"
u8"Error: Value not available");
418 break;
419 default:
420 return ScResId(STR_ERROR_STRreinterpret_cast<char const *>("STR_ERROR_STR" "\004" u8"Err:"
)) + OUString::number( static_cast<int>(nErr) );
421 break;
422 }
423 return ScResId(pErrNumber);
424}
425
426SvxBrushItem* ScGlobal::GetButtonBrushItem()
427{
428 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 428, __extension__ __PRETTY_FUNCTION__));
429 xButtonBrushItem->SetColor( Application::GetSettings().GetStyleSettings().GetFaceColor() );
430 return xButtonBrushItem.get();
431}
432
433void ScGlobal::Init()
434{
435 // The default language for number formats (ScGlobal::eLnge) must
436 // always be LANGUAGE_SYSTEM
437 // FIXME: So remove this variable?
438 eLnge = LANGUAGE_SYSTEMLanguageType(0x0000);
439
440 xSysLocale = std::make_unique<SvtSysLocale>();
441
442 xEmptyBrushItem = std::make_unique<SvxBrushItem>( COL_TRANSPARENT, ATTR_BACKGROUND );
443 xButtonBrushItem = std::make_unique<SvxBrushItem>( Color(), ATTR_BACKGROUND );
444
445 InitPPT();
446 //ScCompiler::InitSymbolsNative();
447 // ScParameterClassification _after_ Compiler, needs function resources if
448 // arguments are to be merged in, which in turn need strings of function
449 // names from the compiler.
450 ScParameterClassification::Init();
451
452 InitAddIns();
453
454 aStrClipDocName = ScResId( SCSTR_NONAMEreinterpret_cast<char const *>("SCSTR_NONAME" "\004" u8"unnamed"
) ) + "1";
455
456 // ScDocumentPool::InitVersionMaps() has been called earlier already
457}
458
459void ScGlobal::InitPPT()
460{
461 OutputDevice* pDev = Application::GetDefaultDevice();
462
463 if (comphelper::LibreOfficeKit::isActive() || OpenGLWrapper::isVCLOpenGLEnabled())
464 {
465 // LOK: the below limited precision is not enough for RowColumnHeader.
466 // OpenGL: limited precision breaks AA of text in charts.
467 nScreenPPTX = double(pDev->GetDPIX()) / double(TWIPS_PER_INCH(20.0 * 72.0));
468 nScreenPPTY = double(pDev->GetDPIY()) / double(TWIPS_PER_INCH(20.0 * 72.0));
469 }
470 else
471 {
472 // Avoid cumulative placement errors by intentionally limiting
473 // precision.
474 Point aPix1000 = pDev->LogicToPixel(Point(1000, 1000), MapMode(MapUnit::MapTwip));
475 nScreenPPTX = aPix1000.X() / 1000.0;
476 nScreenPPTY = aPix1000.Y() / 1000.0;
477 }
478}
479
480const OUString& ScGlobal::GetClipDocName()
481{
482 return aStrClipDocName;
483}
484
485void ScGlobal::SetClipDocName( const OUString& rNew )
486{
487 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 487, __extension__ __PRETTY_FUNCTION__));
488 aStrClipDocName = rNew;
489}
490
491void ScGlobal::InitTextHeight(const SfxItemPool* pPool)
492{
493 if (!pPool)
1
Assuming 'pPool' is non-null
→
2
←
Taking false branch
→
494 {
495 OSL_FAIL("ScGlobal::InitTextHeight: No Pool")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "495" ": "), "%s", "ScGlobal::InitTextHeight: No Pool");
} } while (false);
496 return;
497 }
498
499 const ScPatternAttr& rPattern = pPool->GetDefaultItem(ATTR_PATTERN);
500
501 OutputDevice* pDefaultDev = Application::GetDefaultDevice();
502 ScopedVclPtrInstance< VirtualDevice > pVirtWindow( *pDefaultDev );
3
←
Calling constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
5
←
Returning from constructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
503 pVirtWindow->SetMapMode(MapMode(MapUnit::MapPixel));
504 vcl::Font aDefFont;
505 rPattern.GetFont(aDefFont, SC_AUTOCOL_BLACK, pVirtWindow); // Font color doesn't matter here
506 pVirtWindow->SetFont(aDefFont);
507 sal_uInt16 nTest = static_cast<sal_uInt16>(
508 pVirtWindow->PixelToLogic(Size(0, pVirtWindow->GetTextHeight()), MapMode(MapUnit::MapTwip)).Height());
509
510 if (nTest > nDefFontHeight)
6
←
Assuming 'nTest' is <= 'nDefFontHeight'
→
7
←
Taking false branch
→
511 nDefFontHeight = nTest;
512
513 const SvxMarginItem& rMargin = rPattern.GetItem(ATTR_MARGIN);
514
515 nTest = static_cast<sal_uInt16>(nDefFontHeight + rMargin.GetTopMargin()
516 + rMargin.GetBottomMargin() - STD_ROWHEIGHT_DIFF23);
517
518 if (nTest > nStdRowHeight)
8
←
Assuming 'nTest' is <= 'nStdRowHeight'
→
9
←
Taking false branch
→
519 nStdRowHeight = nTest;
520}
10
←
Calling implicit destructor for 'ScopedVclPtrInstance<VirtualDevice>'
→
11
←
Calling '~ScopedVclPtr'
→
521
522void ScGlobal::Clear()
523{
524 // Destroy asyncs _before_ ExitExternalFunc!
525 theAddInAsyncTbl.clear();
526 ExitExternalFunc();
527 ClearAutoFormat();
528 xSearchItem.reset();
529 delete pLegacyFuncCollection.load(); pLegacyFuncCollection = nullptr;
530 delete pAddInCollection.load(); pAddInCollection = nullptr;
531 xUserList.reset();
532 xStarCalcFunctionList.reset(); // Destroy before ResMgr!
533 xStarCalcFunctionMgr.reset();
534 ScParameterClassification::Exit();
535 ScCompiler::DeInit();
536 ScInterpreter::GlobalExit(); // Delete static Stack
537
538 xEmptyBrushItem.reset();
539 xButtonBrushItem.reset();
540 xEnglishFormatter.reset();
541 delete pCaseTransliteration.load(); pCaseTransliteration = nullptr;
542 delete pTransliteration.load(); pTransliteration = nullptr;
543 delete pCaseCollator.load(); pCaseCollator = nullptr;
544 delete pCollator.load(); pCollator = nullptr;
545 xCalendar.reset();
546 xSysLocale.reset();
547 delete pLocale.load(); pLocale = nullptr;
548
549 delete pUnitConverter.load(); pUnitConverter = nullptr;
550 xFieldEditEngine.reset();
551
552 xDrawClipDocShellRef.clear();
553}
554
555rtl_TextEncoding ScGlobal::GetCharsetValue( const OUString& rCharSet )
556{
557 // new TextEncoding values
558 if ( CharClass::isAsciiNumeric( rCharSet ) )
559 {
560 sal_Int32 nVal = rCharSet.toInt32();
561 if ( nVal == RTL_TEXTENCODING_DONTKNOW(((rtl_TextEncoding) 0)) )
562 return osl_getThreadTextEncoding();
563 return static_cast<rtl_TextEncoding>(nVal);
564 }
565 // old CharSet values for compatibility
566 else if (rCharSet.equalsIgnoreAsciiCase("ANSI") ) return RTL_TEXTENCODING_MS_1252(((rtl_TextEncoding) 1));
567 else if (rCharSet.equalsIgnoreAsciiCase("MAC") ) return RTL_TEXTENCODING_APPLE_ROMAN(((rtl_TextEncoding) 2));
568 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC") ) return RTL_TEXTENCODING_IBM_850(((rtl_TextEncoding) 4));
569 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC_437")) return RTL_TEXTENCODING_IBM_437(((rtl_TextEncoding) 3));
570 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC_850")) return RTL_TEXTENCODING_IBM_850(((rtl_TextEncoding) 4));
571 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC_860")) return RTL_TEXTENCODING_IBM_860(((rtl_TextEncoding) 5));
572 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC_861")) return RTL_TEXTENCODING_IBM_861(((rtl_TextEncoding) 6));
573 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC_863")) return RTL_TEXTENCODING_IBM_863(((rtl_TextEncoding) 7));
574 else if (rCharSet.equalsIgnoreAsciiCase("IBMPC_865")) return RTL_TEXTENCODING_IBM_865(((rtl_TextEncoding) 8));
575 // Some wrong "help" on the net mentions UTF8 and even unoconv uses it,
576 // which worked accidentally if the system encoding is UTF-8 anyway, so
577 // support it ;) but only when reading.
578 else if (rCharSet.equalsIgnoreAsciiCase("UTF8")) return RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76));
579 else if (rCharSet.equalsIgnoreAsciiCase("UTF-8")) return RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76));
580 else return osl_getThreadTextEncoding();
581}
582
583OUString ScGlobal::GetCharsetString( rtl_TextEncoding eVal )
584{
585 const char* pChar;
586 switch ( eVal )
587 {
588 // old CharSet strings for compatibility
589 case RTL_TEXTENCODING_MS_1252(((rtl_TextEncoding) 1)): pChar = "ANSI"; break;
590 case RTL_TEXTENCODING_APPLE_ROMAN(((rtl_TextEncoding) 2)): pChar = "MAC"; break;
591 // IBMPC == IBMPC_850
592 case RTL_TEXTENCODING_IBM_437(((rtl_TextEncoding) 3)): pChar = "IBMPC_437"; break;
593 case RTL_TEXTENCODING_IBM_850(((rtl_TextEncoding) 4)): pChar = "IBMPC_850"; break;
594 case RTL_TEXTENCODING_IBM_860(((rtl_TextEncoding) 5)): pChar = "IBMPC_860"; break;
595 case RTL_TEXTENCODING_IBM_861(((rtl_TextEncoding) 6)): pChar = "IBMPC_861"; break;
596 case RTL_TEXTENCODING_IBM_863(((rtl_TextEncoding) 7)): pChar = "IBMPC_863"; break;
597 case RTL_TEXTENCODING_IBM_865(((rtl_TextEncoding) 8)): pChar = "IBMPC_865"; break;
598 case RTL_TEXTENCODING_DONTKNOW(((rtl_TextEncoding) 0)): pChar = "SYSTEM"; break;
599 // new string of TextEncoding value
600 default:
601 return OUString::number( eVal );
602 }
603 return OUString::createFromAscii(pChar);
604}
605
606bool ScGlobal::HasStarCalcFunctionList()
607{
608 return bool(xStarCalcFunctionList);
609}
610
611ScFunctionList* ScGlobal::GetStarCalcFunctionList()
612{
613 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 613, __extension__ __PRETTY_FUNCTION__));
614 if ( !xStarCalcFunctionList )
615 xStarCalcFunctionList.reset(new ScFunctionList);
616
617 return xStarCalcFunctionList.get();
618}
619
620ScFunctionMgr* ScGlobal::GetStarCalcFunctionMgr()
621{
622 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 622, __extension__ __PRETTY_FUNCTION__));
623 if ( !xStarCalcFunctionMgr )
624 xStarCalcFunctionMgr.reset(new ScFunctionMgr);
625
626 return xStarCalcFunctionMgr.get();
627}
628
629void ScGlobal::ResetFunctionList()
630{
631 // FunctionMgr has pointers into FunctionList, must also be updated
632 xStarCalcFunctionMgr.reset();
633 xStarCalcFunctionList.reset();
634}
635
636ScUnitConverter* ScGlobal::GetUnitConverter()
637{
638 return comphelper::doubleCheckedInit( pUnitConverter,
639 []() { return new ScUnitConverter; });
640}
641
642const sal_Unicode* ScGlobal::UnicodeStrChr( const sal_Unicode* pStr,
643 sal_Unicode c )
644{
645 if ( !pStr )
646 return nullptr;
647 while ( *pStr )
648 {
649 if ( *pStr == c )
650 return pStr;
651 pStr++;
652 }
653 return nullptr;
654}
655
656OUString ScGlobal::addToken(const OUString& rTokenList, const OUString& rToken,
657 sal_Unicode cSep, sal_Int32 nSepCount, bool bForceSep)
658{
659 OUStringBuffer aBuf(rTokenList);
660 if( bForceSep || (!rToken.isEmpty() && !rTokenList.isEmpty()) )
661 comphelper::string::padToLength(aBuf, aBuf.getLength() + nSepCount, cSep);
662 aBuf.append(rToken);
663 return aBuf.makeStringAndClear();
664}
665
666bool ScGlobal::IsQuoted( const OUString& rString, sal_Unicode cQuote )
667{
668 return (rString.getLength() >= 2) && (rString[0] == cQuote) && (rString[ rString.getLength() - 1 ] == cQuote);
669}
670
671void ScGlobal::AddQuotes( OUString& rString, sal_Unicode cQuote, bool bEscapeEmbedded )
672{
673 if (bEscapeEmbedded)
674 {
675 sal_Unicode pQ[3];
676 pQ[0] = pQ[1] = cQuote;
677 pQ[2] = 0;
678 OUString aQuotes( pQ );
679 rString = rString.replaceAll( OUStringChar(cQuote), aQuotes);
680 }
681 rString = OUStringChar( cQuote ) + rString + OUStringChar( cQuote );
682}
683
684void ScGlobal::EraseQuotes( OUString& rString, sal_Unicode cQuote, bool bUnescapeEmbedded )
685{
686 if ( IsQuoted( rString, cQuote ) )
687 {
688 rString = rString.copy( 1, rString.getLength() - 2 );
689 if (bUnescapeEmbedded)
690 {
691 sal_Unicode pQ[3];
692 pQ[0] = pQ[1] = cQuote;
693 pQ[2] = 0;
694 OUString aQuotes( pQ );
695 rString = rString.replaceAll( aQuotes, OUStringChar(cQuote));
696 }
697 }
698}
699
700sal_Int32 ScGlobal::FindUnquoted( const OUString& rString, sal_Unicode cChar)
701{
702 const sal_Unicode cQuote = '\'';
703 const sal_Unicode* const pStart = rString.getStr();
704 const sal_Unicode* const pStop = pStart + rString.getLength();
705 const sal_Unicode* p = pStart;
706 bool bQuoted = false;
707 while (p < pStop)
708 {
709 if (*p == cChar && !bQuoted)
710 return sal::static_int_cast< sal_Int32 >( p - pStart );
711 else if (*p == cQuote)
712 {
713 if (!bQuoted)
714 bQuoted = true;
715 else if (p < pStop-1 && *(p+1) == cQuote)
716 ++p;
717 else
718 bQuoted = false;
719 }
720 ++p;
721 }
722 return -1;
723}
724
725const sal_Unicode* ScGlobal::FindUnquoted( const sal_Unicode* pString, sal_Unicode cChar )
726{
727 sal_Unicode cQuote = '\'';
728 const sal_Unicode* p = pString;
729 bool bQuoted = false;
730 while (*p)
731 {
732 if (*p == cChar && !bQuoted)
733 return p;
734 else if (*p == cQuote)
735 {
736 if (!bQuoted)
737 bQuoted = true;
738 else if (*(p+1) == cQuote)
739 ++p;
740 else
741 bQuoted = false;
742 }
743 ++p;
744 }
745 return nullptr;
746}
747
748bool ScGlobal::EETextObjEqual( const EditTextObject* pObj1,
749 const EditTextObject* pObj2 )
750{
751 if ( pObj1 == pObj2 ) // Both empty or the same object
752 return true;
753
754 if ( pObj1 && pObj2 )
755 return pObj1->Equals( *pObj2);
756
757 return false;
758}
759
760void ScGlobal::OpenURL(const OUString& rURL, const OUString& rTarget, bool bIgnoreSettings)
761{
762 // OpenURL is always called in the GridWindow by mouse clicks in some way or another.
763 // That's why pScActiveViewShell and nScClickMouseModifier are correct.
764
765 if (!bIgnoreSettings && !ShouldOpenURL())
766 return;
767
768 SfxViewFrame* pViewFrm = SfxViewFrame::Current();
769 if (!pViewFrm)
770 return;
771
772 OUString aUrlName( rURL );
773 SfxViewFrame* pFrame = nullptr;
774 const SfxObjectShell* pObjShell = nullptr;
775 OUString aReferName;
776 if ( pScActiveViewShell )
777 {
778 pFrame = pScActiveViewShell->GetViewFrame();
779 pObjShell = pFrame->GetObjectShell();
780 const SfxMedium* pMed = pObjShell->GetMedium();
781 if (pMed)
782 aReferName = pMed->GetName();
783 }
784
785 // Don't fiddle with fragments pointing into current document.
786 // Also don't mess around with a vnd.sun.star.script or service or other
787 // internal "URI".
788 if (!aUrlName.startsWith("#")
789 && !aUrlName.startsWithIgnoreAsciiCase("vnd.sun.star.script:")
790 && !aUrlName.startsWithIgnoreAsciiCase("macro:")
791 && !aUrlName.startsWithIgnoreAsciiCase("slot:")
792 && !aUrlName.startsWithIgnoreAsciiCase("service:")
793 && !aUrlName.startsWithIgnoreAsciiCase(".uno:"))
794 {
795 // Any relative reference would fail with "not an absolute URL"
796 // error, try to construct an absolute URI with the path relative
797 // to the current document's path or work path, as usual for all
798 // external references.
799 // This then also, as ScGlobal::GetAbsDocName() uses
800 // INetURLObject::smartRel2Abs(), supports "\\" UNC path names as
801 // smb:// Samba shares and DOS path separators converted to proper
802 // file:// URI.
803 const OUString aNewUrlName( ScGlobal::GetAbsDocName( aUrlName, pObjShell));
804 if (!aNewUrlName.isEmpty())
805 aUrlName = aNewUrlName;
806 }
807
808 SfxStringItem aUrl( SID_FILE_NAME(5000 + 507), aUrlName );
809 SfxStringItem aTarget( SID_TARGETNAME(5000 + 560), rTarget );
810 if ( nScClickMouseModifier & KEY_SHIFT ) // control-click -> into new window
811 aTarget.SetValue("_blank");
812
813 SfxFrameItem aFrm( SID_DOCFRAME(5000 + 598), pFrame );
814 SfxStringItem aReferer( SID_REFERER(5000 + 654), aReferName );
815
816 SfxBoolItem aNewView( SID_OPEN_NEW_VIEW(5000 + 520), false );
817 SfxBoolItem aBrowsing( SID_BROWSE(5000 + 1658), true );
818
819 // No SID_SILENT anymore
820 pViewFrm->GetDispatcher()->ExecuteList(SID_OPENDOC(5000 + 501),
821 SfxCallMode::ASYNCHRON | SfxCallMode::RECORD,
822 { &aUrl, &aTarget, &aFrm, &aReferer, &aNewView, &aBrowsing });
823}
824
825bool ScGlobal::ShouldOpenURL()
826{
827 SvtSecurityOptions aSecOpt;
828 bool bCtrlClickHappened = (nScClickMouseModifier & KEY_MOD1);
829 bool bCtrlClickSecOption = aSecOpt.IsOptionSet( SvtSecurityOptions::EOption::CtrlClickHyperlink );
830 if( bCtrlClickHappened && ! bCtrlClickSecOption )
831 {
832 // return since ctrl+click happened when the
833 // ctrl+click security option was disabled, link should not open
834 return false;
835 }
836 else if( ! bCtrlClickHappened && bCtrlClickSecOption )
837 {
838 // ctrl+click did not happen; only click happened maybe with some
839 // other key combo. and security option is set, so return
840 return false;
841 }
842 return true;
843}
844
845bool ScGlobal::IsSystemRTL()
846{
847 return MsLangId::isRightToLeft( Application::GetSettings().GetLanguageTag().getLanguageType() );
848}
849
850SvtScriptType ScGlobal::GetDefaultScriptType()
851{
852 // Used when text contains only WEAK characters.
853 // Script type of office language is used then (same as GetEditDefaultLanguage,
854 // to get consistent behavior of text in simple cells and EditEngine,
855 // also same as GetAppLanguage() in Writer)
856 return SvtLanguageOptions::GetScriptTypeOfLanguage( Application::GetSettings().GetLanguageTag().getLanguageType() );
857}
858
859LanguageType ScGlobal::GetEditDefaultLanguage()
860{
861 // Used for EditEngine::SetDefaultLanguage
862 return Application::GetSettings().GetLanguageTag().getLanguageType();
863}
864
865sal_uInt16 ScGlobal::GetScriptedWhichID( SvtScriptType nScriptType, sal_uInt16 nWhich )
866{
867 switch ( nScriptType )
868 {
869 case SvtScriptType::LATIN:
870 case SvtScriptType::ASIAN:
871 case SvtScriptType::COMPLEX:
872 break; // take exact matches
873 default: // prefer one, first COMPLEX, then ASIAN
874 if ( nScriptType & SvtScriptType::COMPLEX )
875 nScriptType = SvtScriptType::COMPLEX;
876 else if ( nScriptType & SvtScriptType::ASIAN )
877 nScriptType = SvtScriptType::ASIAN;
878 }
879 switch ( nScriptType )
880 {
881 case SvtScriptType::COMPLEX:
882 {
883 switch ( nWhich )
884 {
885 case ATTR_FONT:
886 case ATTR_CJK_FONT:
887 nWhich = ATTR_CTL_FONT;
888 break;
889 case ATTR_FONT_HEIGHT:
890 case ATTR_CJK_FONT_HEIGHT:
891 nWhich = ATTR_CTL_FONT_HEIGHT;
892 break;
893 case ATTR_FONT_WEIGHT:
894 case ATTR_CJK_FONT_WEIGHT:
895 nWhich = ATTR_CTL_FONT_WEIGHT;
896 break;
897 case ATTR_FONT_POSTURE:
898 case ATTR_CJK_FONT_POSTURE:
899 nWhich = ATTR_CTL_FONT_POSTURE;
900 break;
901 }
902 }
903 break;
904 case SvtScriptType::ASIAN:
905 {
906 switch ( nWhich )
907 {
908 case ATTR_FONT:
909 case ATTR_CTL_FONT:
910 nWhich = ATTR_CJK_FONT;
911 break;
912 case ATTR_FONT_HEIGHT:
913 case ATTR_CTL_FONT_HEIGHT:
914 nWhich = ATTR_CJK_FONT_HEIGHT;
915 break;
916 case ATTR_FONT_WEIGHT:
917 case ATTR_CTL_FONT_WEIGHT:
918 nWhich = ATTR_CJK_FONT_WEIGHT;
919 break;
920 case ATTR_FONT_POSTURE:
921 case ATTR_CTL_FONT_POSTURE:
922 nWhich = ATTR_CJK_FONT_POSTURE;
923 break;
924 }
925 }
926 break;
927 default:
928 {
929 switch ( nWhich )
930 {
931 case ATTR_CTL_FONT:
932 case ATTR_CJK_FONT:
933 nWhich = ATTR_FONT;
934 break;
935 case ATTR_CTL_FONT_HEIGHT:
936 case ATTR_CJK_FONT_HEIGHT:
937 nWhich = ATTR_FONT_HEIGHT;
938 break;
939 case ATTR_CTL_FONT_WEIGHT:
940 case ATTR_CJK_FONT_WEIGHT:
941 nWhich = ATTR_FONT_WEIGHT;
942 break;
943 case ATTR_CTL_FONT_POSTURE:
944 case ATTR_CJK_FONT_POSTURE:
945 nWhich = ATTR_FONT_POSTURE;
946 break;
947 }
948 }
949 }
950 return nWhich;
951}
952
953void ScGlobal::AddLanguage( SfxItemSet& rSet, const SvNumberFormatter& rFormatter )
954{
955 OSL_ENSURE( rSet.GetItemState( ATTR_LANGUAGE_FORMAT, false ) == SfxItemState::DEFAULT,do { if (true && (!(rSet.GetItemState( ATTR_LANGUAGE_FORMAT
, false ) == SfxItemState::DEFAULT))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "956" ": "), "%s", "ScGlobal::AddLanguage - language already added"
); } } while (false)
956 "ScGlobal::AddLanguage - language already added")do { if (true && (!(rSet.GetItemState( ATTR_LANGUAGE_FORMAT
, false ) == SfxItemState::DEFAULT))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "956" ": "), "%s", "ScGlobal::AddLanguage - language already added"
); } } while (false);
957
958 const SfxPoolItem* pHardItem;
959 if ( rSet.GetItemState( ATTR_VALUE_FORMAT, false, &pHardItem ) != SfxItemState::SET )
960 return;
961
962 const SvNumberformat* pHardFormat = rFormatter.GetEntry(
963 static_cast<const SfxUInt32Item*>(pHardItem)->GetValue() );
964
965 sal_uInt32 nParentFmt = 0; // Pool default
966 const SfxItemSet* pParent = rSet.GetParent();
967 if ( pParent )
968 nParentFmt = pParent->Get( ATTR_VALUE_FORMAT ).GetValue();
969 const SvNumberformat* pParFormat = rFormatter.GetEntry( nParentFmt );
970
971 if ( pHardFormat && pParFormat &&
972 (pHardFormat->GetLanguage() != pParFormat->GetLanguage()) )
973 rSet.Put( SvxLanguageItem( pHardFormat->GetLanguage(), ATTR_LANGUAGE_FORMAT ) );
974}
975
976utl::TransliterationWrapper* ScGlobal::GetpTransliteration()
977{
978 return comphelper::doubleCheckedInit( pTransliteration,
979 []()
980 {
981 const LanguageType eOfficeLanguage = Application::GetSettings().GetLanguageTag().getLanguageType();
982 ::utl::TransliterationWrapper* p = new ::utl::TransliterationWrapper(
983 ::comphelper::getProcessComponentContext(), TransliterationFlags::IGNORE_CASE );
984 p->loadModuleIfNeeded( eOfficeLanguage );
985 return p;
986 });
987}
988::utl::TransliterationWrapper* ScGlobal::GetCaseTransliteration()
989{
990 return comphelper::doubleCheckedInit( pCaseTransliteration,
991 []()
992 {
993 const LanguageType eOfficeLanguage = Application::GetSettings().GetLanguageTag().getLanguageType();
994 ::utl::TransliterationWrapper* p = new ::utl::TransliterationWrapper(
995 ::comphelper::getProcessComponentContext(), TransliterationFlags::NONE );
996 p->loadModuleIfNeeded( eOfficeLanguage );
997 return p;
998 });
999}
1000
1001const LocaleDataWrapper* ScGlobal::getLocaleDataPtr()
1002{
1003 OSL_ENSURE(do { if (true && (!(xSysLocale))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "1005" ": "), "%s", "ScGlobal::getLocaleDataPtr() called before ScGlobal::Init()"
); } } while (false)
1004 xSysLocale,do { if (true && (!(xSysLocale))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "1005" ": "), "%s", "ScGlobal::getLocaleDataPtr() called before ScGlobal::Init()"
); } } while (false)
1005 "ScGlobal::getLocaleDataPtr() called before ScGlobal::Init()")do { if (true && (!(xSysLocale))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "1005" ": "), "%s", "ScGlobal::getLocaleDataPtr() called before ScGlobal::Init()"
); } } while (false);
1006
1007 return xSysLocale->GetLocaleDataPtr();
1008}
1009
1010const CharClass* ScGlobal::getCharClassPtr()
1011{
1012 OSL_ENSURE(do { if (true && (!(xSysLocale))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "1014" ": "), "%s", "ScGlobal::getCharClassPtr() called before ScGlobal::Init()"
); } } while (false)
1013 xSysLocale,do { if (true && (!(xSysLocale))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "1014" ": "), "%s", "ScGlobal::getCharClassPtr() called before ScGlobal::Init()"
); } } while (false)
1014 "ScGlobal::getCharClassPtr() called before ScGlobal::Init()")do { if (true && (!(xSysLocale))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
":" "1014" ": "), "%s", "ScGlobal::getCharClassPtr() called before ScGlobal::Init()"
); } } while (false);
1015
1016 return xSysLocale->GetCharClassPtr();
1017}
1018
1019CalendarWrapper* ScGlobal::GetCalendar()
1020{
1021 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 1021, __extension__ __PRETTY_FUNCTION__));
1022 if ( !xCalendar )
1023 {
1024 xCalendar.reset( new CalendarWrapper( ::comphelper::getProcessComponentContext() ) );
1025 xCalendar->loadDefaultCalendar( *GetLocale() );
1026 }
1027 return xCalendar.get();
1028}
1029CollatorWrapper* ScGlobal::GetCollator()
1030{
1031 return comphelper::doubleCheckedInit( pCollator,
1032 []()
1033 {
1034 CollatorWrapper* p = new CollatorWrapper( ::comphelper::getProcessComponentContext() );
1035 p->loadDefaultCollator( *GetLocale(), SC_COLLATOR_IGNOREScss::i18n::CollatorOptions::CollatorOptions_IGNORE_CASE );
1036 return p;
1037 });
1038}
1039CollatorWrapper* ScGlobal::GetCaseCollator()
1040{
1041 return comphelper::doubleCheckedInit( pCaseCollator,
1042 []()
1043 {
1044 CollatorWrapper* p = new CollatorWrapper( ::comphelper::getProcessComponentContext() );
1045 p->loadDefaultCollator( *GetLocale(), 0 );
1046 return p;
1047 });
1048}
1049css::lang::Locale* ScGlobal::GetLocale()
1050{
1051 return comphelper::doubleCheckedInit( pLocale,
1052 []() { return new css::lang::Locale( Application::GetSettings().GetLanguageTag().getLocale()); });
1053}
1054
1055ScFieldEditEngine& ScGlobal::GetStaticFieldEditEngine()
1056{
1057 assert(!bThreadedGroupCalcInProgress)(static_cast <bool> (!bThreadedGroupCalcInProgress) ? void
(0) : __assert_fail ("!bThreadedGroupCalcInProgress", "/home/maarten/src/libreoffice/core/sc/source/core/data/global.cxx"
, 1057, __extension__ __PRETTY_FUNCTION__));
1058 if (!xFieldEditEngine)
1059 {
1060 // Creating a ScFieldEditEngine with pDocument=NULL leads to document
1061 // specific fields not being resolvable! See
1062 // ScFieldEditEngine::CalcFieldValue(). pEnginePool=NULL lets
1063 // EditEngine internally create and delete a default pool.
1064 xFieldEditEngine.reset(new ScFieldEditEngine( nullptr, nullptr));
1065 }
1066 return *xFieldEditEngine;
1067}
1068
1069OUString ScGlobal::ReplaceOrAppend( const OUString& rString,
1070 const OUString& rPlaceholder, const OUString& rReplacement )
1071{
1072 if (rString.isEmpty())
1073 return rReplacement;
1074 sal_Int32 nFound = rString.indexOf( rPlaceholder);
1075 if (nFound < 0)
1076 {
1077 if (rString[rString.getLength()-1] == ' ')
1078 return rString + rReplacement;
1079 return rString + " " + rReplacement;
1080 }
1081 return rString.replaceFirst( rPlaceholder, rReplacement, &nFound);
1082}
1083
1084/* 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 ;-)
13
←
Calling 'Reference::clear'
→
20
←
Returning; memory was released
→
205 if (aTmp.get()) {
21
←
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 )
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();
12
←
Calling 'VclPtr::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 )
4
←
Memory is allocated
→
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
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
)
14
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
15
←
Calling 'VclReferenceBase::release'
→
19
←
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;
22
←
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)
16
←
Assuming the condition is true
→
17
←
Taking true branch
→
40 delete this;
18
←
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