File: | home/maarten/src/libreoffice/core/include/rtl/ref.hxx |
Warning: | line 192, column 9 Use of memory after it is freed |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ | |||
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 | // Design proposal: https://wiki.documentfoundation.org/Design/Whiteboards/Comments_Ruler_Control | |||
11 | ||||
12 | #include <swruler.hxx> | |||
13 | ||||
14 | #include <viewsh.hxx> | |||
15 | #include <edtwin.hxx> | |||
16 | #include <PostItMgr.hxx> | |||
17 | #include <view.hxx> | |||
18 | #include <cmdid.h> | |||
19 | #include <sfx2/request.hxx> | |||
20 | #include <tools/UnitConversion.hxx> | |||
21 | #include <vcl/commandevent.hxx> | |||
22 | #include <vcl/event.hxx> | |||
23 | #include <vcl/window.hxx> | |||
24 | #include <vcl/settings.hxx> | |||
25 | #include <tools/json_writer.hxx> | |||
26 | #include <strings.hrc> | |||
27 | #include <comphelper/lok.hxx> | |||
28 | #include <LibreOfficeKit/LibreOfficeKitEnums.h> | |||
29 | #include <boost/property_tree/json_parser.hpp> | |||
30 | ||||
31 | #define CONTROL_BORDER_WIDTH1 1 | |||
32 | ||||
33 | namespace | |||
34 | { | |||
35 | /** | |||
36 | * Draw a little arrow / triangle with different directions | |||
37 | * | |||
38 | * \param nX left coordinate of arrow square | |||
39 | * \param nY top coordinate of arrow square | |||
40 | * \param nSize size of the long triangle side / arrow square | |||
41 | * \param Color arrow color | |||
42 | * \param bCollapsed if the arrow should display the collapsed state | |||
43 | */ | |||
44 | void ImplDrawArrow(vcl::RenderContext& rRenderContext, long nX, long nY, long nSize, | |||
45 | const Color& rColor, bool bCollapsed) | |||
46 | { | |||
47 | tools::Polygon aTrianglePolygon(4); | |||
48 | ||||
49 | if (bCollapsed) | |||
50 | { | |||
51 | if (AllSettings::GetLayoutRTL()) // < | |||
52 | { | |||
53 | aTrianglePolygon.SetPoint({ nX + nSize / 2, nY }, 0); | |||
54 | aTrianglePolygon.SetPoint({ nX + nSize / 2, nY + nSize }, 1); | |||
55 | aTrianglePolygon.SetPoint({ nX, nY + nSize / 2 }, 2); | |||
56 | aTrianglePolygon.SetPoint({ nX + nSize / 2, nY }, 3); | |||
57 | } | |||
58 | else // > | |||
59 | { | |||
60 | aTrianglePolygon.SetPoint({ nX, nY }, 0); | |||
61 | aTrianglePolygon.SetPoint({ nX + nSize / 2, nY + nSize / 2 }, 1); | |||
62 | aTrianglePolygon.SetPoint({ nX, nY + nSize }, 2); | |||
63 | aTrianglePolygon.SetPoint({ nX, nY }, 3); | |||
64 | } | |||
65 | } | |||
66 | else // v | |||
67 | { | |||
68 | aTrianglePolygon.SetPoint({ nX, nY + nSize / 2 }, 0); | |||
69 | aTrianglePolygon.SetPoint({ nX + nSize, nY + nSize / 2 }, 1); | |||
70 | aTrianglePolygon.SetPoint({ nX + nSize / 2, nY + nSize }, 2); | |||
71 | aTrianglePolygon.SetPoint({ nX, nY + nSize / 2 }, 3); | |||
72 | } | |||
73 | ||||
74 | rRenderContext.SetLineColor(); | |||
75 | rRenderContext.SetFillColor(rColor); | |||
76 | rRenderContext.DrawPolygon(aTrianglePolygon); | |||
77 | } | |||
78 | } | |||
79 | ||||
80 | // Constructor | |||
81 | SwCommentRuler::SwCommentRuler(SwViewShell* pViewSh, vcl::Window* pParent, SwEditWin* pWin, | |||
82 | SvxRulerSupportFlags nRulerFlags, SfxBindings& rBindings, | |||
83 | WinBits nWinStyle) | |||
84 | : SvxRuler(pParent, pWin, nRulerFlags, rBindings, nWinStyle | WB_HSCROLL) | |||
85 | , mpViewShell(pViewSh) | |||
86 | , mpSwWin(pWin) | |||
87 | , mbIsHighlighted(false) | |||
88 | , mnFadeRate(0) | |||
89 | , maVirDev(VclPtr<VirtualDevice>::Create(*this)) | |||
90 | { | |||
91 | // Set fading timeout: 5 x 40ms = 200ms | |||
92 | maFadeTimer.SetTimeout(40); | |||
93 | maFadeTimer.SetInvokeHandler(LINK(this, SwCommentRuler, FadeHandler)::tools::detail::makeLink( ::tools::detail::castTo<SwCommentRuler *>(this), &SwCommentRuler::LinkStubFadeHandler)); | |||
94 | maFadeTimer.SetDebugName("sw::SwCommentRuler maFadeTimer"); | |||
95 | ||||
96 | // we have a little bit more space, as we don't draw ruler ticks | |||
97 | vcl::Font aFont(maVirDev->GetFont()); | |||
98 | aFont.SetFontHeight(aFont.GetFontHeight() + 1); | |||
99 | maVirDev->SetFont(aFont); | |||
100 | } | |||
101 | ||||
102 | SwCommentRuler::~SwCommentRuler() { disposeOnce(); } | |||
| ||||
103 | ||||
104 | void SwCommentRuler::dispose() | |||
105 | { | |||
106 | mpSwWin.clear(); | |||
107 | SvxRuler::dispose(); | |||
108 | } | |||
109 | ||||
110 | void SwCommentRuler::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) | |||
111 | { | |||
112 | if (comphelper::LibreOfficeKit::isActive()) | |||
113 | return; // no need to waste time on startup | |||
114 | ||||
115 | SvxRuler::Paint(rRenderContext, rRect); | |||
116 | ||||
117 | // Don't draw if there is not any note | |||
118 | if (mpViewShell->GetPostItMgr() && mpViewShell->GetPostItMgr()->HasNotes()) | |||
119 | DrawCommentControl(rRenderContext); | |||
120 | } | |||
121 | ||||
122 | void SwCommentRuler::DrawCommentControl(vcl::RenderContext& rRenderContext) | |||
123 | { | |||
124 | const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings(); | |||
125 | const bool bIsCollapsed = !mpViewShell->GetPostItMgr()->ShowNotes(); | |||
126 | const tools::Rectangle aControlRect = GetCommentControlRegion(); | |||
127 | ||||
128 | maVirDev->SetOutputSizePixel(aControlRect.GetSize()); | |||
129 | ||||
130 | // set colors | |||
131 | if (!bIsCollapsed) | |||
132 | { | |||
133 | if (mbIsHighlighted) | |||
134 | maVirDev->SetFillColor( | |||
135 | GetFadedColor(rStyleSettings.GetHighlightColor(), rStyleSettings.GetDialogColor())); | |||
136 | else | |||
137 | maVirDev->SetFillColor(rStyleSettings.GetDialogColor()); | |||
138 | maVirDev->SetLineColor(rStyleSettings.GetShadowColor()); | |||
139 | } | |||
140 | else | |||
141 | { | |||
142 | if (mbIsHighlighted) | |||
143 | maVirDev->SetFillColor(GetFadedColor(rStyleSettings.GetHighlightColor(), | |||
144 | rStyleSettings.GetWorkspaceColor())); | |||
145 | else | |||
146 | maVirDev->SetFillColor(rStyleSettings.GetWorkspaceColor()); | |||
147 | maVirDev->SetLineColor(); | |||
148 | } | |||
149 | Color aTextColor = GetFadedColor(rStyleSettings.GetHighlightTextColor(), | |||
150 | rStyleSettings.GetButtonTextColor()); | |||
151 | maVirDev->SetTextColor(aTextColor); | |||
152 | ||||
153 | // calculate label and arrow positions | |||
154 | const OUString aLabel = SwResId(STR_COMMENTS_LABELreinterpret_cast<char const *>("STR_COMMENTS_LABEL" "\004" u8"Comments")); | |||
155 | const long nTriangleSize = maVirDev->GetTextHeight() / 2 + 1; | |||
156 | const long nTrianglePad = maVirDev->GetTextHeight() / 4; | |||
157 | ||||
158 | Point aLabelPos(0, (aControlRect.GetHeight() - maVirDev->GetTextHeight()) / 2); | |||
159 | Point aArrowPos(0, (aControlRect.GetHeight() - nTriangleSize) / 2); | |||
160 | ||||
161 | if (!AllSettings::GetLayoutRTL()) // | > Comments | | |||
162 | { | |||
163 | aArrowPos.setX(nTrianglePad); | |||
164 | aLabelPos.setX(aArrowPos.X() + nTriangleSize + nTrianglePad); | |||
165 | } | |||
166 | else // RTL => | Comments < | | |||
167 | { | |||
168 | const long nLabelWidth = maVirDev->GetTextWidth(aLabel); | |||
169 | if (!bIsCollapsed) | |||
170 | { | |||
171 | aArrowPos.setX(aControlRect.GetWidth() - 1 - nTrianglePad - CONTROL_BORDER_WIDTH1 | |||
172 | - nTriangleSize); | |||
173 | aLabelPos.setX(aArrowPos.X() - nTrianglePad - nLabelWidth); | |||
174 | } | |||
175 | else | |||
176 | { | |||
177 | // if comments are collapsed, left align the text, because otherwise it's very likely to be invisible | |||
178 | aArrowPos.setX(nLabelWidth + nTrianglePad + nTriangleSize); | |||
179 | aLabelPos.setX(aArrowPos.X() - nTrianglePad - nLabelWidth); | |||
180 | } | |||
181 | } | |||
182 | ||||
183 | // draw control | |||
184 | maVirDev->DrawRect(tools::Rectangle(Point(), aControlRect.GetSize())); | |||
185 | maVirDev->DrawText(aLabelPos, aLabel); | |||
186 | ImplDrawArrow(*maVirDev, aArrowPos.X(), aArrowPos.Y(), nTriangleSize, aTextColor, bIsCollapsed); | |||
187 | rRenderContext.DrawOutDev(aControlRect.TopLeft(), aControlRect.GetSize(), Point(), | |||
188 | aControlRect.GetSize(), *maVirDev); | |||
189 | } | |||
190 | ||||
191 | // Just accept double-click outside comment control | |||
192 | void SwCommentRuler::Command(const CommandEvent& rCEvt) | |||
193 | { | |||
194 | Point aMousePos = rCEvt.GetMousePosPixel(); | |||
195 | // Ignore command request if it is inside Comment Control | |||
196 | if (!mpViewShell->GetPostItMgr() || !mpViewShell->GetPostItMgr()->HasNotes() | |||
197 | || !GetCommentControlRegion().IsInside(aMousePos)) | |||
198 | SvxRuler::Command(rCEvt); | |||
199 | } | |||
200 | ||||
201 | void SwCommentRuler::MouseMove(const MouseEvent& rMEvt) | |||
202 | { | |||
203 | SvxRuler::MouseMove(rMEvt); | |||
204 | if (!mpViewShell->GetPostItMgr() || !mpViewShell->GetPostItMgr()->HasNotes()) | |||
205 | return; | |||
206 | ||||
207 | UpdateCommentHelpText(); | |||
208 | ||||
209 | Point aMousePos = rMEvt.GetPosPixel(); | |||
210 | bool bWasHighlighted = mbIsHighlighted; | |||
211 | mbIsHighlighted = GetCommentControlRegion().IsInside(aMousePos); | |||
212 | if (mbIsHighlighted != bWasHighlighted) | |||
213 | // Do start fading | |||
214 | maFadeTimer.Start(); | |||
215 | } | |||
216 | ||||
217 | void SwCommentRuler::MouseButtonDown(const MouseEvent& rMEvt) | |||
218 | { | |||
219 | Point aMousePos = rMEvt.GetPosPixel(); | |||
220 | if (!rMEvt.IsLeft() || IsTracking() || !GetCommentControlRegion().IsInside(aMousePos)) | |||
221 | { | |||
222 | SvxRuler::MouseButtonDown(rMEvt); | |||
223 | return; | |||
224 | } | |||
225 | ||||
226 | // Toggle notes visibility | |||
227 | SwView& rView = mpSwWin->GetView(); | |||
228 | SfxRequest aRequest(rView.GetViewFrame(), SID_TOGGLE_NOTES( 10000 + 1098 )); | |||
229 | rView.ExecViewOptions(aRequest); | |||
230 | ||||
231 | // It is inside comment control, so update help text | |||
232 | UpdateCommentHelpText(); | |||
233 | ||||
234 | Invalidate(); | |||
235 | } | |||
236 | ||||
237 | void SwCommentRuler::CreateJsonNotification(tools::JsonWriter& rJsonWriter) | |||
238 | { | |||
239 | // Note that GetMargin1(), GetMargin2(), GetNullOffset(), and GetPageOffset() return values in | |||
240 | // pixels. Not twips. So "converting" the returned values with convertTwipToMm100() is quite | |||
241 | // wrong. (Also, even if the return values actually were in twips, it is questionable why we | |||
242 | // would want to pass them in mm100, as all other length values in the LOKit protocol apparently | |||
243 | // are in twips.) | |||
244 | ||||
245 | // Anyway, as the consuming code in Online mostly seems to work anyway, it is likely that it | |||
246 | // would work as well even if the values in pixels were passed without a bogus "conversion" to | |||
247 | // mm100. But let's keep this as is for now. | |||
248 | ||||
249 | // Also note that in desktop LibreOffice, these pixel values for the ruler of course change as | |||
250 | // one changes the zoom level. (Can be seen if one temporarily modifies the NotifyKit() function | |||
251 | // below to call this CreateJsonNotification() function and print its result in all cases even | |||
252 | // without LibreOfficeKit::isActive().) But in both web-based Online and in the iOS app, the | |||
253 | // zoom level from the point of view of this code here apparently does not change even if one | |||
254 | // zooms from the Online code's point of view. | |||
255 | rJsonWriter.put("margin1", convertTwipToMm100(GetMargin1())); | |||
256 | rJsonWriter.put("margin2", convertTwipToMm100(GetMargin2())); | |||
257 | rJsonWriter.put("leftOffset", convertTwipToMm100(GetNullOffset())); | |||
258 | rJsonWriter.put("pageOffset", convertTwipToMm100(GetPageOffset())); | |||
259 | ||||
260 | // GetPageWidth() on the other hand does return a value in twips. | |||
261 | // So here convertTwipToMm100() really does produce actual mm100. Fun. | |||
262 | rJsonWriter.put("pageWidth", convertTwipToMm100(GetPageWidth())); | |||
263 | ||||
264 | { | |||
265 | auto tabsNode = rJsonWriter.startNode("tabs"); | |||
266 | ||||
267 | // The RulerTab array elements that GetTabs() returns have their nPos field in twips. So these | |||
268 | // too are actual mm100. | |||
269 | for (auto const& tab : GetTabs()) | |||
270 | { | |||
271 | auto tabNode = rJsonWriter.startNode(""); | |||
272 | rJsonWriter.put("position", convertTwipToMm100(tab.nPos)); | |||
273 | rJsonWriter.put("style", tab.nStyle); | |||
274 | } | |||
275 | } | |||
276 | ||||
277 | RulerUnitData aUnitData = GetCurrentRulerUnit(); | |||
278 | rJsonWriter.put("unit", aUnitData.aUnitStr); | |||
279 | } | |||
280 | ||||
281 | void SwCommentRuler::NotifyKit() | |||
282 | { | |||
283 | if (!comphelper::LibreOfficeKit::isActive()) | |||
284 | return; | |||
285 | ||||
286 | tools::JsonWriter aJsonWriter; | |||
287 | CreateJsonNotification(aJsonWriter); | |||
288 | mpViewShell->GetSfxViewShell()->libreOfficeKitViewCallback(LOK_CALLBACK_RULER_UPDATE, | |||
289 | aJsonWriter.extractData()); | |||
290 | } | |||
291 | ||||
292 | void SwCommentRuler::Update() | |||
293 | { | |||
294 | tools::Rectangle aPreviousControlRect = GetCommentControlRegion(); | |||
295 | SvxRuler::Update(); | |||
296 | if (aPreviousControlRect != GetCommentControlRegion()) | |||
297 | Invalidate(); | |||
298 | NotifyKit(); | |||
299 | } | |||
300 | ||||
301 | void SwCommentRuler::UpdateCommentHelpText() | |||
302 | { | |||
303 | const char* pTooltipResId; | |||
304 | if (mpViewShell->GetPostItMgr()->ShowNotes()) | |||
305 | pTooltipResId = STR_HIDE_COMMENTSreinterpret_cast<char const *>("STR_HIDE_COMMENTS" "\004" u8"Hide comments"); | |||
306 | else | |||
307 | pTooltipResId = STR_SHOW_COMMENTSreinterpret_cast<char const *>("STR_SHOW_COMMENTS" "\004" u8"Show comments"); | |||
308 | SetQuickHelpText(SwResId(pTooltipResId)); | |||
309 | } | |||
310 | ||||
311 | // TODO Make Ruler return its central rectangle instead of margins. | |||
312 | tools::Rectangle SwCommentRuler::GetCommentControlRegion() | |||
313 | { | |||
314 | SwPostItMgr* pPostItMgr = mpViewShell->GetPostItMgr(); | |||
315 | ||||
316 | //rhbz#1006850 When the SwPostItMgr ctor is called from SwView::SwView it | |||
317 | //triggers an update of the uiview, but the result of the ctor hasn't been | |||
318 | //set into the mpViewShell yet, so GetPostItMgr is temporarily still NULL | |||
319 | if (!pPostItMgr) | |||
320 | return tools::Rectangle(); | |||
321 | ||||
322 | const unsigned long nSidebarWidth = pPostItMgr->GetSidebarWidth(true); | |||
323 | ||||
324 | //FIXME When the page width is larger then screen, the ruler is misplaced by one pixel | |||
325 | long nLeft = GetPageOffset(); | |||
326 | if (GetTextRTL()) | |||
327 | nLeft += GetBorderOffset() - nSidebarWidth; | |||
328 | else | |||
329 | nLeft += GetWinOffset() + mpSwWin->LogicToPixel(Size(GetPageWidth(), 0)).Width(); | |||
330 | ||||
331 | // Ruler::ImplDraw uses RULER_OFF (value: 3px) as offset, and Ruler::ImplFormat adds one extra pixel | |||
332 | long nTop = 4; | |||
333 | // Somehow pPostItMgr->GetSidebarBorderWidth() returns border width already doubled | |||
334 | long nRight = nLeft + nSidebarWidth + pPostItMgr->GetSidebarBorderWidth(true); | |||
335 | long nBottom = nTop + GetRulerVirHeight() - 3; | |||
336 | ||||
337 | tools::Rectangle aRect(nLeft, nTop, nRight, nBottom); | |||
338 | return aRect; | |||
339 | } | |||
340 | ||||
341 | Color SwCommentRuler::GetFadedColor(const Color& rHighColor, const Color& rLowColor) | |||
342 | { | |||
343 | if (!maFadeTimer.IsActive()) | |||
344 | return mbIsHighlighted ? rHighColor : rLowColor; | |||
345 | ||||
346 | Color aColor = rHighColor; | |||
347 | aColor.Merge(rLowColor, mnFadeRate * 255 / 100.0f); | |||
348 | return aColor; | |||
349 | } | |||
350 | ||||
351 | IMPL_LINK_NOARG(SwCommentRuler, FadeHandler, Timer*, void)void SwCommentRuler::LinkStubFadeHandler(void * instance, Timer * data) { return static_cast<SwCommentRuler *>(instance )->FadeHandler(data); } void SwCommentRuler::FadeHandler(__attribute__ ((unused)) Timer*) | |||
352 | { | |||
353 | const int nStep = 25; | |||
354 | if (mbIsHighlighted && mnFadeRate < 100) | |||
355 | mnFadeRate += nStep; | |||
356 | else if (!mbIsHighlighted && mnFadeRate > 0) | |||
357 | mnFadeRate -= nStep; | |||
358 | else | |||
359 | return; | |||
360 | ||||
361 | Invalidate(); | |||
362 | ||||
363 | if (mnFadeRate != 0 && mnFadeRate != 100) | |||
364 | maFadeTimer.Start(); | |||
365 | } | |||
366 | ||||
367 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
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 | |
36 | class VclReferenceBase; |
37 | |
38 | namespace vcl::detail { |
39 | |
40 | template<typename> |
41 | constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; } |
42 | |
43 | template<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 | */ |
56 | template <class reference_type> |
57 | class 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 | |
66 | public: |
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 ;-) |
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 | |
218 | template<typename T1, typename T2> |
219 | inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
220 | return p1.get() == p2.get(); |
221 | } |
222 | |
223 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2) |
224 | { |
225 | return p1.get() == p2; |
226 | } |
227 | |
228 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) { |
229 | return p1.get() == p2; |
230 | } |
231 | |
232 | template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2) |
233 | { |
234 | return p1 == p2.get(); |
235 | } |
236 | |
237 | template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) { |
238 | return p1 == p2.get(); |
239 | } |
240 | |
241 | template<typename T1, typename T2> |
242 | inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
243 | return !(p1 == p2); |
244 | } |
245 | |
246 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2) |
247 | { |
248 | return !(p1 == p2); |
249 | } |
250 | |
251 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) { |
252 | return !(p1 == p2); |
253 | } |
254 | |
255 | template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2) |
256 | { |
257 | return !(p1 == p2); |
258 | } |
259 | |
260 | template<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 | */ |
274 | template <class reference_type> |
275 | class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type> |
276 | { |
277 | public: |
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 | |
290 | template <class reference_type> |
291 | class ScopedVclPtr : public VclPtr<reference_type> |
292 | { |
293 | public: |
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 | |
378 | private: |
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 | |
387 | protected: |
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 |
406 | template <class reference_type> |
407 | class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type> |
408 | { |
409 | public: |
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 | |
421 | private: |
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: */ |
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 | |||||||||
34 | namespace rtl | ||||||||
35 | { | ||||||||
36 | |||||||||
37 | /** Template reference class for reference type. | ||||||||
38 | */ | ||||||||
39 | template <class reference_type> | ||||||||
40 | class Reference | ||||||||
41 | { | ||||||||
42 | /** The <b>reference_type</b> body pointer. | ||||||||
43 | */ | ||||||||
44 | reference_type * m_pBody; | ||||||||
45 | |||||||||
46 | |||||||||
47 | public: | ||||||||
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
| ||||||||
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; | ||||||||
| |||||||||
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 | ||||||||
277 | namespace 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 | */ | ||||||||
286 | template<typename T> | ||||||||
287 | struct 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: */ |
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 | |
25 | class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase |
26 | { |
27 | mutable oslInterlockedCount mnRefCnt; |
28 | |
29 | template<typename T> friend class VclPtr; |
30 | |
31 | public: |
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) |
40 | delete this; |
41 | } |
42 | #ifdef DBG_UTIL |
43 | #ifndef _WIN32 |
44 | sal_Int32 getRefCount() const { return mnRefCnt; } |
45 | #endif |
46 | #endif |
47 | |
48 | |
49 | private: |
50 | VclReferenceBase(const VclReferenceBase&) = delete; |
51 | VclReferenceBase& operator=(const VclReferenceBase&) = delete; |
52 | |
53 | bool mbDisposed : 1; |
54 | |
55 | protected: |
56 | VclReferenceBase(); |
57 | protected: |
58 | virtual ~VclReferenceBase(); |
59 | |
60 | protected: |
61 | virtual void dispose(); |
62 | |
63 | public: |
64 | void disposeOnce(); |
65 | bool isDisposed() const { return mbDisposed; } |
66 | |
67 | }; |
68 | #endif |