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

/home/maarten/src/libreoffice/core/sw/source/uibase/docvw/HeaderFooterWin.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
10#include <strings.hrc>
11
12#include <doc.hxx>
13#include <drawdoc.hxx>
14#include <cmdid.h>
15#include <DashedLine.hxx>
16#include <docsh.hxx>
17#include <edtwin.hxx>
18#include <fmthdft.hxx>
19#include <HeaderFooterWin.hxx>
20#include <pagedesc.hxx>
21#include <pagefrm.hxx>
22#include <view.hxx>
23#include <viewopt.hxx>
24#include <wrtsh.hxx>
25#include <IDocumentDrawModelAccess.hxx>
26
27#include <basegfx/color/bcolortools.hxx>
28#include <basegfx/matrix/b2dhommatrixtools.hxx>
29#include <basegfx/polygon/b2dpolygon.hxx>
30#include <basegfx/range/b2drectangle.hxx>
31#include <basegfx/vector/b2dsize.hxx>
32#include <drawinglayer/attribute/fillgradientattribute.hxx>
33#include <drawinglayer/attribute/fontattribute.hxx>
34#include <drawinglayer/primitive2d/fillgradientprimitive2d.hxx>
35#include <drawinglayer/primitive2d/modifiedcolorprimitive2d.hxx>
36#include <drawinglayer/primitive2d/polygonprimitive2d.hxx>
37#include <drawinglayer/primitive2d/PolyPolygonColorPrimitive2D.hxx>
38#include <drawinglayer/primitive2d/textlayoutdevice.hxx>
39#include <drawinglayer/primitive2d/textprimitive2d.hxx>
40#include <editeng/boxitem.hxx>
41#include <svx/hdft.hxx>
42#include <sfx2/bindings.hxx>
43#include <sfx2/viewfrm.hxx>
44#include <drawinglayer/processor2d/baseprocessor2d.hxx>
45#include <drawinglayer/processor2d/processorfromoutputdevice.hxx>
46#include <vcl/canvastools.hxx>
47#include <vcl/menu.hxx>
48#include <vcl/metric.hxx>
49#include <vcl/menubtn.hxx>
50#include <vcl/svapp.hxx>
51#include <vcl/settings.hxx>
52#include <memory>
53
54#define TEXT_PADDING5 5
55#define BOX_DISTANCE10 10
56#define BUTTON_WIDTH18 18
57
58using namespace basegfx;
59using namespace basegfx::utils;
60using namespace drawinglayer::attribute;
61
62namespace
63{
64 basegfx::BColor lcl_GetFillColor(const basegfx::BColor& rLineColor)
65 {
66 basegfx::BColor aHslLine = basegfx::utils::rgb2hsl(rLineColor);
67 double nLuminance = aHslLine.getZ() * 2.5;
68 if ( nLuminance == 0 )
69 nLuminance = 0.5;
70 else if ( nLuminance >= 1.0 )
71 nLuminance = aHslLine.getZ() * 0.4;
72 aHslLine.setZ( nLuminance );
73 return basegfx::utils::hsl2rgb( aHslLine );
74 }
75
76 basegfx::BColor lcl_GetLighterGradientColor(const basegfx::BColor& rDarkColor)
77 {
78 basegfx::BColor aHslDark = basegfx::utils::rgb2hsl(rDarkColor);
79 double nLuminance = aHslDark.getZ() * 255 + 20;
80 aHslDark.setZ( nLuminance / 255.0 );
81 return basegfx::utils::hsl2rgb( aHslDark );
82 }
83
84 B2DPolygon lcl_GetPolygon( const ::tools::Rectangle& rRect, bool bOnTop )
85 {
86 const double nRadius = 3;
87 const double nKappa((M_SQRT21.41421356237309504880 - 1.0) * 4.0 / 3.0);
88
89 B2DPolygon aPolygon;
90 aPolygon.append( B2DPoint( rRect.Left(), rRect.Top() ) );
91
92 {
93 B2DPoint aCorner( rRect.Left(), rRect.Bottom() );
94 B2DPoint aStart( rRect.Left(), rRect.Bottom() - nRadius );
95 B2DPoint aEnd( rRect.Left() + nRadius, rRect.Bottom() );
96 aPolygon.append( aStart );
97 aPolygon.appendBezierSegment(
98 interpolate( aStart, aCorner, nKappa ),
99 interpolate( aEnd, aCorner, nKappa ),
100 aEnd );
101 }
102
103 {
104 B2DPoint aCorner( rRect.Right(), rRect.Bottom() );
105 B2DPoint aStart( rRect.Right() - nRadius, rRect.Bottom() );
106 B2DPoint aEnd( rRect.Right(), rRect.Bottom() - nRadius );
107 aPolygon.append( aStart );
108 aPolygon.appendBezierSegment(
109 interpolate( aStart, aCorner, nKappa ),
110 interpolate( aEnd, aCorner, nKappa ),
111 aEnd );
112 }
113
114 aPolygon.append( B2DPoint( rRect.Right(), rRect.Top() ) );
115
116 if ( !bOnTop )
117 {
118 B2DRectangle aBRect = vcl::unotools::b2DRectangleFromRectangle(rRect);
119 B2DHomMatrix aRotation = createRotateAroundPoint(
120 aBRect.getCenterX(), aBRect.getCenterY(), M_PI3.14159265358979323846 );
121 aPolygon.transform( aRotation );
122 }
123
124 return aPolygon;
125 }
126}
127
128void SwFrameButtonPainter::PaintButton(drawinglayer::primitive2d::Primitive2DContainer& rSeq,
129 const tools::Rectangle& rRect, bool bOnTop)
130{
131 rSeq.clear();
132 B2DPolygon aPolygon = lcl_GetPolygon(rRect, bOnTop);
133
134 // Colors
135 basegfx::BColor aLineColor = SwViewOption::GetHeaderFooterMarkColor().getBColor();
136 basegfx::BColor aFillColor = lcl_GetFillColor(aLineColor);
137 basegfx::BColor aLighterColor = lcl_GetLighterGradientColor(aFillColor);
138
139 const StyleSettings& rSettings = Application::GetSettings().GetStyleSettings();
140 if (rSettings.GetHighContrastMode())
141 {
142 aFillColor = rSettings.GetDialogColor().getBColor();
143 aLineColor = rSettings.GetDialogTextColor().getBColor();
144
145 rSeq.push_back(drawinglayer::primitive2d::Primitive2DReference(
146 new drawinglayer::primitive2d::PolyPolygonColorPrimitive2D(B2DPolyPolygon(aPolygon), aFillColor)));
147 }
148 else
149 {
150 B2DRectangle aGradientRect = vcl::unotools::b2DRectangleFromRectangle(rRect);
151 double nAngle = M_PI3.14159265358979323846;
152 if (bOnTop)
153 nAngle = 0;
154 FillGradientAttribute aFillAttrs(drawinglayer::attribute::GradientStyle::Linear, 0.0, 0.0, 0.0, nAngle, aLighterColor, aFillColor, 10);
155 rSeq.push_back(drawinglayer::primitive2d::Primitive2DReference(
156 new drawinglayer::primitive2d::FillGradientPrimitive2D(aGradientRect, aFillAttrs)));
157 }
158
159 // Create the border lines primitive
160 rSeq.push_back(drawinglayer::primitive2d::Primitive2DReference(
161 new drawinglayer::primitive2d::PolygonHairlinePrimitive2D(aPolygon, aLineColor)));
162}
163
164SwHeaderFooterWin::SwHeaderFooterWin( SwEditWin* pEditWin, const SwFrame *pFrame, bool bHeader ) :
165 SwFrameMenuButtonBase( pEditWin, pFrame ),
166 m_aBuilder(nullptr, AllSettings::GetUIRootDir(), "modules/swriter/ui/headerfootermenu.ui", ""),
167 m_bIsHeader( bHeader ),
168 m_pPopupMenu(m_aBuilder.get_menu("menu")),
169 m_pLine( nullptr ),
170 m_bIsAppearing( false ),
171 m_nFadeRate( 100 ),
172 m_aFadeTimer( )
173{
174 //FIXME RenderContext
175
176 // Get the font and configure it
177 vcl::Font aFont = Application::GetSettings().GetStyleSettings().GetToolFont();
178 SetZoomedPointFont(*this, aFont);
179
180 // Create the line control
181 m_pLine = VclPtr<SwDashedLine>::Create(GetEditWin(), &SwViewOption::GetHeaderFooterMarkColor);
1
Calling 'VclPtr::Create'
→
3
←
Returned allocated memory
→
4
←
Calling implicit destructor for 'VclPtr<SwDashedLine>'
→
5
←
Calling '~Reference'
→
12
←
Returning from '~Reference'
→
13
←
Returning from destructor for 'VclPtr<SwDashedLine>'
→
182 m_pLine->SetZOrder(this, ZOrderFlags::Before);
14
←
Calling 'VclPtr::operator->'
→
183
184 // set the PopupMenu
185 // Rewrite the menu entries' text
186 if (m_bIsHeader)
187 {
188 m_pPopupMenu->SetItemText(m_pPopupMenu->GetItemId("edit"), SwResId(STR_FORMAT_HEADERreinterpret_cast<char const *>("STR_FORMAT_HEADER" "\004"
u8"Format Header...")));
189 m_pPopupMenu->SetItemText(m_pPopupMenu->GetItemId("delete"), SwResId(STR_DELETE_HEADERreinterpret_cast<char const *>("STR_DELETE_HEADER" "\004"
u8"Delete Header...")));
190 }
191 else
192 {
193 m_pPopupMenu->SetItemText(m_pPopupMenu->GetItemId("edit"), SwResId(STR_FORMAT_FOOTERreinterpret_cast<char const *>("STR_FORMAT_FOOTER" "\004"
u8"Format Footer...")));
194 m_pPopupMenu->SetItemText(m_pPopupMenu->GetItemId("delete"), SwResId(STR_DELETE_FOOTERreinterpret_cast<char const *>("STR_DELETE_FOOTER" "\004"
u8"Delete Footer...")));
195 }
196
197 SetPopupMenu(m_pPopupMenu);
198
199 m_aFadeTimer.SetTimeout(50);
200 m_aFadeTimer.SetInvokeHandler(LINK(this, SwHeaderFooterWin, FadeHandler)::tools::detail::makeLink( ::tools::detail::castTo<SwHeaderFooterWin
*>(this), &SwHeaderFooterWin::LinkStubFadeHandler));
201}
202
203SwHeaderFooterWin::~SwHeaderFooterWin( )
204{
205 disposeOnce();
206}
207
208void SwHeaderFooterWin::dispose()
209{
210 m_pPopupMenu.clear();
211 m_aBuilder.disposeBuilder();
212 m_pLine.disposeAndClear();
213 SwFrameMenuButtonBase::dispose();
214}
215
216void SwHeaderFooterWin::SetOffset(Point aOffset, long nXLineStart, long nXLineEnd)
217{
218 // Compute the text to show
219 const SwPageDesc* pDesc = GetPageFrame()->GetPageDesc();
220 bool bIsFirst = !pDesc->IsFirstShared() && GetPageFrame()->OnFirstPage();
221 bool bIsLeft = !pDesc->IsHeaderShared() && !GetPageFrame()->OnRightPage();
222 bool bIsRight = !pDesc->IsHeaderShared() && GetPageFrame()->OnRightPage();
223 m_sLabel = SwResId(STR_HEADER_TITLEreinterpret_cast<char const *>("STR_HEADER_TITLE" "\004"
u8"Header (%1)"));
224 if (!m_bIsHeader)
225 m_sLabel = bIsFirst ? SwResId(STR_FIRST_FOOTER_TITLEreinterpret_cast<char const *>("STR_FIRST_FOOTER_TITLE"
"\004" u8"First Page Footer (%1)"))
226 : bIsLeft ? SwResId(STR_LEFT_FOOTER_TITLEreinterpret_cast<char const *>("STR_LEFT_FOOTER_TITLE" "\004"
u8"Left Page Footer (%1)"))
227 : bIsRight ? SwResId(STR_RIGHT_FOOTER_TITLEreinterpret_cast<char const *>("STR_RIGHT_FOOTER_TITLE"
"\004" u8"Right Page Footer (%1)"))
228 : SwResId(STR_FOOTER_TITLEreinterpret_cast<char const *>("STR_FOOTER_TITLE" "\004"
u8"Footer (%1)") );
229 else
230 m_sLabel = bIsFirst ? SwResId(STR_FIRST_HEADER_TITLEreinterpret_cast<char const *>("STR_FIRST_HEADER_TITLE"
"\004" u8"First Page Header (%1)"))
231 : bIsLeft ? SwResId(STR_LEFT_HEADER_TITLEreinterpret_cast<char const *>("STR_LEFT_HEADER_TITLE" "\004"
u8"Left Page Header (%1)"))
232 : bIsRight ? SwResId(STR_RIGHT_HEADER_TITLEreinterpret_cast<char const *>("STR_RIGHT_HEADER_TITLE"
"\004" u8"Right Page Header (%1)"))
233 : SwResId(STR_HEADER_TITLEreinterpret_cast<char const *>("STR_HEADER_TITLE" "\004"
u8"Header (%1)"));
234
235 sal_Int32 nPos = m_sLabel.lastIndexOf("%1");
236 m_sLabel = m_sLabel.replaceAt(nPos, 2, pDesc->GetName());
237
238 // Compute the text size and get the box position & size from it
239 ::tools::Rectangle aTextRect;
240 GetTextBoundRect(aTextRect, m_sLabel);
241 ::tools::Rectangle aTextPxRect = LogicToPixel(aTextRect);
242 FontMetric aFontMetric = GetFontMetric(GetFont());
243 Size aBoxSize (aTextPxRect.GetWidth() + BUTTON_WIDTH18 + TEXT_PADDING5 * 2,
244 aFontMetric.GetLineHeight() + TEXT_PADDING5 * 2 );
245
246 long nYFooterOff = 0;
247 if (!m_bIsHeader)
248 nYFooterOff = aBoxSize.Height();
249
250 Point aBoxPos(aOffset.X() - aBoxSize.Width() - BOX_DISTANCE10,
251 aOffset.Y() - nYFooterOff);
252
253 if (AllSettings::GetLayoutRTL())
254 {
255 aBoxPos.setX( aOffset.X() + BOX_DISTANCE10 );
256 }
257
258 // Set the position & Size of the window
259 SetPosSizePixel(aBoxPos, aBoxSize);
260
261 double nYLinePos = aBoxPos.Y();
262 if (!m_bIsHeader)
263 nYLinePos += aBoxSize.Height();
264 Point aLinePos(nXLineStart, nYLinePos);
265 Size aLineSize(nXLineEnd - nXLineStart, 1);
266 m_pLine->SetPosSizePixel(aLinePos, aLineSize);
267}
268
269void SwHeaderFooterWin::ShowAll(bool bShow)
270{
271 if (!PopupMenu::IsInExecute())
272 {
273 m_bIsAppearing = bShow;
274
275 if (m_aFadeTimer.IsActive())
276 m_aFadeTimer.Stop();
277 m_aFadeTimer.Start();
278 }
279}
280
281bool SwHeaderFooterWin::Contains( const Point &rDocPt ) const
282{
283 ::tools::Rectangle aRect(GetPosPixel(), GetSizePixel());
284 if (aRect.IsInside(rDocPt))
285 return true;
286
287 ::tools::Rectangle aLineRect(m_pLine->GetPosPixel(), m_pLine->GetSizePixel());
288 return aLineRect.IsInside(rDocPt);
289}
290
291void SwHeaderFooterWin::Paint(vcl::RenderContext& rRenderContext, const ::tools::Rectangle&)
292{
293 // Use pixels for the rest of the drawing
294 SetMapMode(MapMode(MapUnit::MapPixel));
295 drawinglayer::primitive2d::Primitive2DContainer aSeq;
296 const ::tools::Rectangle aRect(::tools::Rectangle(Point(0, 0), rRenderContext.PixelToLogic(GetSizePixel())));
297
298 SwFrameButtonPainter::PaintButton(aSeq, aRect, m_bIsHeader);
299
300 // Create the text primitive
301 basegfx::BColor aLineColor = SwViewOption::GetHeaderFooterMarkColor().getBColor();
302 B2DVector aFontSize;
303 FontAttribute aFontAttr = drawinglayer::primitive2d::getFontAttributeFromVclFont(aFontSize, rRenderContext.GetFont(), false, false);
304
305 FontMetric aFontMetric = rRenderContext.GetFontMetric(rRenderContext.GetFont());
306 double nTextOffsetY = aFontMetric.GetAscent() + TEXT_PADDING5;
307 Point aTextPos(TEXT_PADDING5, nTextOffsetY);
308
309 basegfx::B2DHomMatrix aTextMatrix(createScaleTranslateB2DHomMatrix(
310 aFontSize.getX(), aFontSize.getY(),
311 double(aTextPos.X()), double(aTextPos.Y())));
312
313 aSeq.push_back(drawinglayer::primitive2d::Primitive2DReference(
314 new drawinglayer::primitive2d::TextSimplePortionPrimitive2D(
315 aTextMatrix, m_sLabel, 0, m_sLabel.getLength(),
316 std::vector<double>(), aFontAttr, css::lang::Locale(), aLineColor)));
317
318 // Create the 'plus' or 'arrow' primitive
319 B2DRectangle aSignArea(B2DPoint(aRect.Right() - BUTTON_WIDTH18, 0.0),
320 B2DSize(aRect.Right(), aRect.getHeight()));
321
322 B2DPolygon aSign;
323 if (IsEmptyHeaderFooter())
324 {
325 // Create the + polygon
326 double nLeft = aSignArea.getMinX() + TEXT_PADDING5;
327 double nRight = aSignArea.getMaxX() - TEXT_PADDING5;
328 double nHalfW = ( nRight - nLeft ) / 2.0;
329
330 double nTop = aSignArea.getCenterY() - nHalfW;
331 double nBottom = aSignArea.getCenterY() + nHalfW;
332
333 aSign.append(B2DPoint(nLeft, aSignArea.getCenterY() - 1.0));
334 aSign.append(B2DPoint(aSignArea.getCenterX() - 1.0, aSignArea.getCenterY() - 1.0));
335 aSign.append(B2DPoint(aSignArea.getCenterX() - 1.0, nTop));
336 aSign.append(B2DPoint(aSignArea.getCenterX() + 1.0, nTop));
337 aSign.append(B2DPoint(aSignArea.getCenterX() + 1.0, aSignArea.getCenterY() - 1.0));
338 aSign.append(B2DPoint(nRight, aSignArea.getCenterY() - 1.0));
339 aSign.append(B2DPoint(nRight, aSignArea.getCenterY() + 1.0));
340 aSign.append(B2DPoint(aSignArea.getCenterX() + 1.0, aSignArea.getCenterY() + 1.0));
341 aSign.append(B2DPoint(aSignArea.getCenterX() + 1.0, nBottom));
342 aSign.append(B2DPoint(aSignArea.getCenterX() - 1.0, nBottom));
343 aSign.append(B2DPoint(aSignArea.getCenterX() - 1.0, aSignArea.getCenterY() + 1.0));
344 aSign.append(B2DPoint(nLeft, aSignArea.getCenterY() + 1.0));
345 aSign.setClosed(true);
346 }
347 else
348 {
349 // Create the v polygon
350 B2DPoint aLeft(aSignArea.getMinX() + TEXT_PADDING5, aSignArea.getCenterY());
351 B2DPoint aRight(aSignArea.getMaxX() - TEXT_PADDING5, aSignArea.getCenterY());
352 B2DPoint aBottom((aLeft.getX() + aRight.getX()) / 2.0, aLeft.getY() + 4.0);
353 aSign.append(aLeft);
354 aSign.append(aRight);
355 aSign.append(aBottom);
356 aSign.setClosed(true);
357 }
358
359 BColor aSignColor = COL_BLACK.getBColor();
360 if (Application::GetSettings().GetStyleSettings().GetHighContrastMode())
361 aSignColor = COL_WHITE.getBColor();
362
363 aSeq.push_back( drawinglayer::primitive2d::Primitive2DReference(
364 new drawinglayer::primitive2d::PolyPolygonColorPrimitive2D(
365 B2DPolyPolygon(aSign), aSignColor)) );
366
367 // Create the processor and process the primitives
368 const drawinglayer::geometry::ViewInformation2D aNewViewInfos;
369 std::unique_ptr<drawinglayer::processor2d::BaseProcessor2D> pProcessor(
370 drawinglayer::processor2d::createBaseProcessor2DFromOutputDevice(rRenderContext, aNewViewInfos));
371
372 // TODO Ghost it all if needed
373 drawinglayer::primitive2d::Primitive2DContainer aGhostedSeq(1);
374 double nFadeRate = double(m_nFadeRate) / 100.0;
375
376 const basegfx::BColorModifierSharedPtr aBColorModifier =
377 std::make_shared<basegfx::BColorModifier_interpolate>(COL_WHITE.getBColor(),
378 1.0 - nFadeRate);
379
380 aGhostedSeq[0] = drawinglayer::primitive2d::Primitive2DReference(
381 new drawinglayer::primitive2d::ModifiedColorPrimitive2D(aSeq, aBColorModifier));
382
383 pProcessor->process(aGhostedSeq);
384}
385
386bool SwHeaderFooterWin::IsEmptyHeaderFooter( ) const
387{
388 bool bResult = true;
389
390 // Actually check it
391 const SwPageDesc* pDesc = GetPageFrame()->GetPageDesc();
392
393 bool const bFirst(GetPageFrame()->OnFirstPage());
394 const SwFrameFormat *const pFormat = (GetPageFrame()->OnRightPage())
395 ? pDesc->GetRightFormat(bFirst)
396 : pDesc->GetLeftFormat(bFirst);
397
398 if ( pFormat )
399 {
400 if ( m_bIsHeader )
401 bResult = !pFormat->GetHeader().IsActive();
402 else
403 bResult = !pFormat->GetFooter().IsActive();
404 }
405
406 return bResult;
407}
408
409void SwHeaderFooterWin::ExecuteCommand(const OString& rIdent)
410{
411 SwView& rView = GetEditWin()->GetView();
412 SwWrtShell& rSh = rView.GetWrtShell();
413
414 const OUString& rStyleName = GetPageFrame()->GetPageDesc()->GetName();
415 if (rIdent == "edit")
416 {
417 OString sPageId = m_bIsHeader ? OString("header") : OString("footer");
418 rView.GetDocShell()->FormatPage(rStyleName, sPageId, rSh);
419 }
420 else if (rIdent == "borderback")
421 {
422 const SwPageDesc* pDesc = GetPageFrame()->GetPageDesc();
423 const SwFrameFormat& rMaster = pDesc->GetMaster();
424 SwFrameFormat* pHFFormat = const_cast< SwFrameFormat* >( rMaster.GetFooter().GetFooterFormat() );
425 if ( m_bIsHeader )
426 pHFFormat = const_cast< SwFrameFormat* >( rMaster.GetHeader().GetHeaderFormat() );
427 SfxItemSet aSet( pHFFormat->GetAttrSet() );
428
429 // Items to hand over XPropertyList things like XColorList,
430 // XHatchList, XGradientList, and XBitmapList to the Area TabPage:
431 aSet.MergeRange( SID_COLOR_TABLETypedWhichId<SvxColorListItem>( 10000 + 179 ), SID_PATTERN_LISTTypedWhichId<SvxPatternListItem>( 10000 + 183 ) );
432 // create needed items for XPropertyList entries from the DrawModel so that
433 // the Area TabPage can access them
434 rSh.GetDoc()->getIDocumentDrawModelAccess().GetDrawModel()->PutAreaListItems( aSet );
435
436 aSet.MergeRange(SID_ATTR_BORDER_INNERTypedWhichId<SvxBoxInfoItem>( 10000 + 23 ), SID_ATTR_BORDER_INNERTypedWhichId<SvxBoxInfoItem>( 10000 + 23 ));
437 // Create a box info item... needed by the dialog
438 std::shared_ptr<SvxBoxInfoItem> aBoxInfo(std::make_shared<SvxBoxInfoItem>(SID_ATTR_BORDER_INNERTypedWhichId<SvxBoxInfoItem>( 10000 + 23 )));
439 const SfxPoolItem *pBoxInfo;
440 if (SfxItemState::SET == pHFFormat->GetAttrSet().GetItemState(SID_ATTR_BORDER_INNERTypedWhichId<SvxBoxInfoItem>( 10000 + 23 ), true, &pBoxInfo))
441 aBoxInfo.reset(static_cast<SvxBoxInfoItem*>(pBoxInfo->Clone()));
442
443 aBoxInfo->SetTable(false);
444 aBoxInfo->SetDist(true);
445 aBoxInfo->SetMinDist(false);
446 aBoxInfo->SetDefDist(MIN_BORDER_DIST28);
447 aBoxInfo->SetValid(SvxBoxInfoItemValidFlags::DISABLE);
448 aSet.Put(*aBoxInfo);
449
450 if (svx::ShowBorderBackgroundDlg( GetFrameWeld(), &aSet ) )
451 {
452 pHFFormat->SetFormatAttr( aSet );
453 rView.GetDocShell()->SetModified();
454 }
455 }
456 else if (rIdent == "delete")
457 {
458 rSh.ChangeHeaderOrFooter( rStyleName, m_bIsHeader, false, true );
459 // warning: "this" may be disposed now
460 rSh.GetWin()->GrabFocusToDocument();
461 }
462 else if (rIdent == "insert_pagenumber")
463 {
464 SfxViewFrame* pVFrame = rSh.GetView().GetViewFrame();
465 pVFrame->GetBindings().Execute(FN_INSERT_FLD_PGNUMBER((20000 + 300) + 94));
466 }
467 else if (rIdent == "insert_pagecount")
468 {
469 SfxViewFrame* pVFrame = rSh.GetView().GetViewFrame();
470 pVFrame->GetBindings().Execute(FN_INSERT_FLD_PGCOUNT((20000 + 300) + 95));
471 }
472}
473
474void SwHeaderFooterWin::SetReadonly( bool bReadonly )
475{
476 ShowAll( !bReadonly );
477}
478
479void SwHeaderFooterWin::MouseButtonDown( const MouseEvent& rMEvt )
480{
481 if (IsEmptyHeaderFooter())
482 {
483 SwView& rView = GetEditWin()->GetView();
484 SwWrtShell& rSh = rView.GetWrtShell();
485
486 const OUString& rStyleName = GetPageFrame()->GetPageDesc()->GetName();
487 rSh.ChangeHeaderOrFooter( rStyleName, m_bIsHeader, true, false );
488 }
489 else
490 MenuButton::MouseButtonDown( rMEvt );
491}
492
493void SwHeaderFooterWin::Select()
494{
495 ExecuteCommand(GetCurItemIdent());
496}
497
498IMPL_LINK_NOARG(SwHeaderFooterWin, FadeHandler, Timer *, void)void SwHeaderFooterWin::LinkStubFadeHandler(void * instance, Timer
* data) { return static_cast<SwHeaderFooterWin *>(instance
)->FadeHandler(data); } void SwHeaderFooterWin::FadeHandler
(__attribute__ ((unused)) Timer *)
499{
500 if (m_bIsAppearing && m_nFadeRate > 0)
501 m_nFadeRate -= 25;
502 else if (!m_bIsAppearing && m_nFadeRate < 100)
503 m_nFadeRate += 25;
504
505 if (m_nFadeRate != 100 && !IsVisible())
506 {
507 Show();
508 m_pLine->Show();
509 }
510 else if (m_nFadeRate == 100 && IsVisible())
511 {
512 Show(false);
513 m_pLine->Show(false);
514 }
515 else
516 Invalidate();
517
518 if (IsVisible() && m_nFadeRate > 0 && m_nFadeRate < 100)
519 m_aFadeTimer.Start();
520}
521
522/* 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 );
2
←
Memory is allocated
→
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
15
←
Calling 'Reference::get'
→
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
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
5.1
Field 'm_pBody' is non-null
5.1
Field 'm_pBody' is non-null
5.1
Field 'm_pBody' is non-null
5.1
Field 'm_pBody' is non-null
)
6
←
Taking true branch
→
113 m_pBody->release();
7
←
Calling 'VclReferenceBase::release'
→
11
←
Returning; memory was released
→
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
16
←
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)
8
←
Assuming the condition is true
→
9
←
Taking true branch
→
40 delete this;
10
←
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