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 -*- */ | |||
2 | /* | |||
3 | * This file is part of the LibreOffice project. | |||
4 | * | |||
5 | * This Source Code Form is subject to the terms of the Mozilla Public | |||
6 | * License, v. 2.0. If a copy of the MPL was not distributed with this | |||
7 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. | |||
8 | * | |||
9 | * This file incorporates work covered by the following license notice: | |||
10 | * | |||
11 | * Licensed to the Apache Software Foundation (ASF) under one or more | |||
12 | * contributor license agreements. See the NOTICE file distributed | |||
13 | * with this work for additional information regarding copyright | |||
14 | * ownership. The ASF licenses this file to you under the Apache | |||
15 | * License, Version 2.0 (the "License"); you may not use this file | |||
16 | * except in compliance with the License. You may obtain a copy of | |||
17 | * the License at http://www.apache.org/licenses/LICENSE-2.0 . | |||
18 | */ | |||
19 | ||||
20 | #include <dbtreelistbox.hxx> | |||
21 | #include <callbacks.hxx> | |||
22 | ||||
23 | #include <com/sun/star/ui/XContextMenuInterceptor.hpp> | |||
24 | #include <com/sun/star/uno/XComponentContext.hpp> | |||
25 | #include <com/sun/star/frame/XController.hpp> | |||
26 | #include <com/sun/star/lang/IllegalArgumentException.hpp> | |||
27 | #include <cppuhelper/implbase.hxx> | |||
28 | #include <comphelper/interfacecontainer2.hxx> | |||
29 | #include <comphelper/processfactory.hxx> | |||
30 | #include <comphelper/propertyvalue.hxx> | |||
31 | #include <dbaccess/IController.hxx> | |||
32 | #include <framework/actiontriggerhelper.hxx> | |||
33 | #include <toolkit/awt/vclxmenu.hxx> | |||
34 | #include <toolkit/helper/vclunohelper.hxx> | |||
35 | #include <svx/dbaobjectex.hxx> | |||
36 | #include <vcl/commandevent.hxx> | |||
37 | #include <vcl/event.hxx> | |||
38 | #include <vcl/help.hxx> | |||
39 | #include <vcl/menu.hxx> | |||
40 | #include <vcl/svapp.hxx> | |||
41 | ||||
42 | #include <memory> | |||
43 | ||||
44 | namespace dbaui | |||
45 | { | |||
46 | ||||
47 | using namespace ::com::sun::star; | |||
48 | using namespace ::com::sun::star::uno; | |||
49 | using namespace ::com::sun::star::beans; | |||
50 | using namespace ::com::sun::star::lang; | |||
51 | using namespace ::com::sun::star::datatransfer; | |||
52 | using namespace ::com::sun::star::ui; | |||
53 | using namespace ::com::sun::star::view; | |||
54 | ||||
55 | InterimDBTreeListBox::InterimDBTreeListBox(vcl::Window* pParent, bool bSQLType) | |||
56 | : InterimItemWindow(pParent, "dbaccess/ui/dbtreelist.ui", "DBTreeList") | |||
57 | , TreeListBox(m_xBuilder->weld_tree_view("treeview"), bSQLType) | |||
58 | { | |||
59 | InitControlBase(&GetWidget()); | |||
60 | } | |||
61 | ||||
62 | InterimDBTreeListBox::~InterimDBTreeListBox() | |||
63 | { | |||
64 | disposeOnce(); | |||
65 | } | |||
66 | ||||
67 | void InterimDBTreeListBox::dispose() | |||
68 | { | |||
69 | implStopSelectionTimer(); | |||
70 | m_xTreeView.reset(); | |||
71 | InterimItemWindow::dispose(); | |||
72 | } | |||
73 | ||||
74 | bool InterimDBTreeListBox::DoChildKeyInput(const KeyEvent& rKEvt) | |||
75 | { | |||
76 | return ChildKeyInput(rKEvt); | |||
77 | } | |||
78 | ||||
79 | TreeListBoxDropTarget::TreeListBoxDropTarget(TreeListBox& rTreeView) | |||
80 | : DropTargetHelper(rTreeView.GetWidget().get_drop_target()) | |||
81 | , m_rTreeView(rTreeView) | |||
82 | { | |||
83 | } | |||
84 | ||||
85 | sal_Int8 TreeListBoxDropTarget::AcceptDrop(const AcceptDropEvent& rEvt) | |||
86 | { | |||
87 | sal_Int8 nAccept = m_rTreeView.AcceptDrop(rEvt); | |||
88 | ||||
89 | if (nAccept != DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE) | |||
90 | { | |||
91 | // to enable the autoscroll when we're close to the edges | |||
92 | weld::TreeView& rWidget = m_rTreeView.GetWidget(); | |||
93 | rWidget.get_dest_row_at_pos(rEvt.maPosPixel, nullptr, true); | |||
94 | } | |||
95 | ||||
96 | return nAccept; | |||
97 | } | |||
98 | ||||
99 | sal_Int8 TreeListBoxDropTarget::ExecuteDrop(const ExecuteDropEvent& rEvt) | |||
100 | { | |||
101 | return m_rTreeView.ExecuteDrop(rEvt); | |||
102 | } | |||
103 | ||||
104 | TreeListBox::TreeListBox(std::unique_ptr<weld::TreeView> xTreeView, bool bSQLType) | |||
105 | : m_xTreeView(std::move(xTreeView)) | |||
106 | , m_aDropTargetHelper(*this) | |||
107 | , m_pActionListener(nullptr) | |||
108 | , m_pContextMenuProvider(nullptr) | |||
109 | { | |||
110 | m_xTreeView->connect_key_press(LINK(this, TreeListBox, KeyInputHdl)::tools::detail::makeLink( ::tools::detail::castTo<TreeListBox *>(this), &TreeListBox::LinkStubKeyInputHdl)); | |||
111 | m_xTreeView->connect_changed(LINK(this, TreeListBox, SelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<TreeListBox *>(this), &TreeListBox::LinkStubSelectHdl)); | |||
112 | m_xTreeView->connect_query_tooltip(LINK(this, TreeListBox, QueryTooltipHdl)::tools::detail::makeLink( ::tools::detail::castTo<TreeListBox *>(this), &TreeListBox::LinkStubQueryTooltipHdl)); | |||
113 | m_xTreeView->connect_popup_menu(LINK(this, TreeListBox, CommandHdl)::tools::detail::makeLink( ::tools::detail::castTo<TreeListBox *>(this), &TreeListBox::LinkStubCommandHdl)); | |||
114 | ||||
115 | if (bSQLType) | |||
116 | m_xHelper.set(new ODataClipboard); | |||
117 | else | |||
118 | m_xHelper.set(new svx::OComponentTransferable); | |||
119 | m_xTreeView->enable_drag_source(m_xHelper, DND_ACTION_COPYcss::datatransfer::dnd::DNDConstants::ACTION_COPY); | |||
120 | m_xTreeView->connect_drag_begin(LINK(this, TreeListBox, DragBeginHdl)::tools::detail::makeLink( ::tools::detail::castTo<TreeListBox *>(this), &TreeListBox::LinkStubDragBeginHdl)); | |||
121 | ||||
122 | m_aTimer.SetTimeout(900); | |||
123 | m_aTimer.SetInvokeHandler(LINK(this, TreeListBox, OnTimeOut)::tools::detail::makeLink( ::tools::detail::castTo<TreeListBox *>(this), &TreeListBox::LinkStubOnTimeOut)); | |||
124 | } | |||
125 | ||||
126 | bool TreeListBox::DoChildKeyInput(const KeyEvent& /*rKEvt*/) | |||
127 | { | |||
128 | // nothing by default | |||
129 | return false; | |||
130 | } | |||
131 | ||||
132 | IMPL_LINK(TreeListBox, KeyInputHdl, const KeyEvent&, rKEvt, bool)bool TreeListBox::LinkStubKeyInputHdl(void * instance, const KeyEvent & data) { return static_cast<TreeListBox *>(instance )->KeyInputHdl(data); } bool TreeListBox::KeyInputHdl(const KeyEvent& rKEvt) | |||
133 | { | |||
134 | KeyFuncType eFunc = rKEvt.GetKeyCode().GetFunction(); | |||
135 | bool bHandled = false; | |||
136 | ||||
137 | switch (eFunc) | |||
138 | { | |||
139 | case KeyFuncType::COPY: | |||
140 | bHandled = m_aCopyHandler.IsSet() && !m_xTreeView->get_selected(nullptr); | |||
141 | if (bHandled) | |||
142 | m_aCopyHandler.Call(nullptr); | |||
143 | break; | |||
144 | case KeyFuncType::PASTE: | |||
145 | bHandled = m_aPasteHandler.IsSet() && !m_xTreeView->get_selected(nullptr); | |||
146 | if (bHandled) | |||
147 | m_aPasteHandler.Call(nullptr); | |||
148 | break; | |||
149 | case KeyFuncType::DELETE: | |||
150 | bHandled = m_aDeleteHandler.IsSet() && !m_xTreeView->get_selected(nullptr); | |||
151 | if (bHandled) | |||
152 | m_aDeleteHandler.Call(nullptr); | |||
153 | break; | |||
154 | default: | |||
155 | break; | |||
156 | } | |||
157 | ||||
158 | return bHandled || DoChildKeyInput(rKEvt); | |||
159 | } | |||
160 | ||||
161 | void TreeListBox::implStopSelectionTimer() | |||
162 | { | |||
163 | if ( m_aTimer.IsActive() ) | |||
164 | m_aTimer.Stop(); | |||
165 | } | |||
166 | ||||
167 | void TreeListBox::implStartSelectionTimer() | |||
168 | { | |||
169 | implStopSelectionTimer(); | |||
170 | m_aTimer.Start(); | |||
171 | } | |||
172 | ||||
173 | IMPL_LINK_NOARG(TreeListBox, SelectHdl, weld::TreeView&, void)void TreeListBox::LinkStubSelectHdl(void * instance, weld::TreeView & data) { return static_cast<TreeListBox *>(instance )->SelectHdl(data); } void TreeListBox::SelectHdl(__attribute__ ((unused)) weld::TreeView&) | |||
174 | { | |||
175 | implStartSelectionTimer(); | |||
176 | } | |||
177 | ||||
178 | TreeListBox::~TreeListBox() | |||
179 | { | |||
180 | } | |||
181 | ||||
182 | std::unique_ptr<weld::TreeIter> TreeListBox::GetEntryPosByName(const OUString& aName, const weld::TreeIter* pStart, const IEntryFilter* _pFilter) const | |||
183 | { | |||
184 | auto xEntry(m_xTreeView->make_iterator(pStart)); | |||
185 | if (!pStart && !m_xTreeView->get_iter_first(*xEntry)) | |||
186 | return nullptr; | |||
187 | ||||
188 | do | |||
189 | { | |||
190 | if (m_xTreeView->get_text(*xEntry) == aName) | |||
191 | { | |||
192 | if (!_pFilter || _pFilter->includeEntry(reinterpret_cast<void*>(m_xTreeView->get_id(*xEntry).toUInt64()))) | |||
193 | { | |||
194 | // found | |||
195 | return xEntry; | |||
196 | } | |||
197 | } | |||
198 | } while (m_xTreeView->iter_next(*xEntry)); | |||
199 | ||||
200 | return nullptr; | |||
201 | } | |||
202 | ||||
203 | IMPL_LINK(TreeListBox, DragBeginHdl, bool&, rUnsetDragIcon, bool)bool TreeListBox::LinkStubDragBeginHdl(void * instance, bool& data) { return static_cast<TreeListBox *>(instance)-> DragBeginHdl(data); } bool TreeListBox::DragBeginHdl(bool& rUnsetDragIcon) | |||
204 | { | |||
205 | rUnsetDragIcon = false; | |||
206 | ||||
207 | if (m_pActionListener) | |||
208 | { | |||
209 | m_xDragedEntry = m_xTreeView->make_iterator(); | |||
210 | if (!m_xTreeView->get_selected(m_xDragedEntry.get())) | |||
211 | m_xDragedEntry.reset(); | |||
212 | if (m_xDragedEntry && m_pActionListener->requestDrag(*m_xDragedEntry)) | |||
213 | { | |||
214 | // if the (asynchronous) drag started, stop the selection timer | |||
215 | implStopSelectionTimer(); | |||
216 | return false; | |||
217 | } | |||
218 | } | |||
219 | ||||
220 | return true; | |||
221 | } | |||
222 | ||||
223 | sal_Int8 TreeListBox::AcceptDrop(const AcceptDropEvent& rEvt) | |||
224 | { | |||
225 | sal_Int8 nDropOption = DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE; | |||
226 | if ( m_pActionListener ) | |||
227 | { | |||
228 | ::Point aDropPos = rEvt.maPosPixel; | |||
229 | std::unique_ptr<weld::TreeIter> xDropTarget(m_xTreeView->make_iterator()); | |||
230 | if (!m_xTreeView->get_dest_row_at_pos(aDropPos, xDropTarget.get(), true)) | |||
231 | xDropTarget.reset(); | |||
232 | ||||
233 | // check if drag is on child entry, which is not allowed | |||
234 | std::unique_ptr<weld::TreeIter> xParent; | |||
235 | if (rEvt.mnAction & DND_ACTION_MOVEcss::datatransfer::dnd::DNDConstants::ACTION_MOVE) | |||
236 | { | |||
237 | if (!m_xDragedEntry) // no entry to move | |||
238 | return m_pActionListener->queryDrop(rEvt, m_aDropTargetHelper.GetDataFlavorExVector()); | |||
239 | ||||
240 | if (xDropTarget) | |||
241 | { | |||
242 | xParent = m_xTreeView->make_iterator(xDropTarget.get()); | |||
243 | if (!m_xTreeView->iter_parent(*xParent)) | |||
244 | xParent.reset(); | |||
245 | } | |||
246 | while (xParent && m_xTreeView->iter_compare(*xParent, *m_xDragedEntry) != 0) | |||
247 | { | |||
248 | if (!m_xTreeView->iter_parent(*xParent)) | |||
249 | xParent.reset(); | |||
250 | } | |||
251 | } | |||
252 | ||||
253 | if (!xParent) | |||
254 | { | |||
255 | nDropOption = m_pActionListener->queryDrop(rEvt, m_aDropTargetHelper.GetDataFlavorExVector()); | |||
256 | // check if move is allowed | |||
257 | if ( nDropOption & DND_ACTION_MOVEcss::datatransfer::dnd::DNDConstants::ACTION_MOVE ) | |||
258 | { | |||
259 | if (!m_xDragedEntry || !xDropTarget || | |||
260 | m_xTreeView->iter_compare(*m_xDragedEntry, *xDropTarget) == 0 || | |||
261 | GetEntryPosByName(m_xTreeView->get_text(*m_xDragedEntry), xDropTarget.get())) | |||
262 | { | |||
263 | nDropOption = nDropOption & ~DND_ACTION_MOVEcss::datatransfer::dnd::DNDConstants::ACTION_MOVE;//DND_ACTION_NONE; | |||
264 | } | |||
265 | } | |||
266 | } | |||
267 | } | |||
268 | ||||
269 | return nDropOption; | |||
270 | } | |||
271 | ||||
272 | sal_Int8 TreeListBox::ExecuteDrop(const ExecuteDropEvent& rEvt) | |||
273 | { | |||
274 | if (m_pActionListener) | |||
275 | m_pActionListener->executeDrop(rEvt); | |||
276 | m_xTreeView->unset_drag_dest_row(); | |||
277 | return DND_ACTION_NONEcss::datatransfer::dnd::DNDConstants::ACTION_NONE; | |||
278 | } | |||
279 | ||||
280 | IMPL_LINK(TreeListBox, QueryTooltipHdl, const weld::TreeIter&, rIter, OUString)OUString TreeListBox::LinkStubQueryTooltipHdl(void * instance , const weld::TreeIter& data) { return static_cast<TreeListBox *>(instance)->QueryTooltipHdl(data); } OUString TreeListBox ::QueryTooltipHdl(const weld::TreeIter& rIter) | |||
281 | { | |||
282 | OUString sQuickHelpText; | |||
283 | if (m_pActionListener && | |||
284 | m_pActionListener->requestQuickHelp(reinterpret_cast<void*>(m_xTreeView->get_id(rIter).toUInt64()), sQuickHelpText)) | |||
285 | { | |||
286 | return sQuickHelpText; | |||
287 | } | |||
288 | return m_xTreeView->get_tooltip_text(); | |||
289 | } | |||
290 | ||||
291 | namespace | |||
292 | { | |||
293 | // SelectionSupplier | |||
294 | typedef ::cppu::WeakImplHelper< XSelectionSupplier | |||
295 | > SelectionSupplier_Base; | |||
296 | class SelectionSupplier : public SelectionSupplier_Base | |||
297 | { | |||
298 | public: | |||
299 | explicit SelectionSupplier( const Any& _rSelection ) | |||
300 | :m_aSelection( _rSelection ) | |||
301 | { | |||
302 | } | |||
303 | ||||
304 | virtual sal_Bool SAL_CALL select( const Any& xSelection ) override; | |||
305 | virtual Any SAL_CALL getSelection( ) override; | |||
306 | virtual void SAL_CALL addSelectionChangeListener( const Reference< XSelectionChangeListener >& xListener ) override; | |||
307 | virtual void SAL_CALL removeSelectionChangeListener( const Reference< XSelectionChangeListener >& xListener ) override; | |||
308 | ||||
309 | protected: | |||
310 | virtual ~SelectionSupplier() override | |||
311 | { | |||
312 | } | |||
313 | ||||
314 | private: | |||
315 | Any m_aSelection; | |||
316 | }; | |||
317 | ||||
318 | sal_Bool SAL_CALL SelectionSupplier::select( const Any& /*_Selection*/ ) | |||
319 | { | |||
320 | throw IllegalArgumentException(); | |||
321 | // API bug: this should be a NoSupportException | |||
322 | } | |||
323 | ||||
324 | Any SAL_CALL SelectionSupplier::getSelection( ) | |||
325 | { | |||
326 | return m_aSelection; | |||
327 | } | |||
328 | ||||
329 | void SAL_CALL SelectionSupplier::addSelectionChangeListener( const Reference< XSelectionChangeListener >& /*_Listener*/ ) | |||
330 | { | |||
331 | OSL_FAIL( "SelectionSupplier::removeSelectionChangeListener: no support!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/control/dbtreelistbox.cxx" ":" "331" ": "), "%s", "SelectionSupplier::removeSelectionChangeListener: no support!" ); } } while (false); | |||
332 | // API bug: this should be a NoSupportException | |||
333 | } | |||
334 | ||||
335 | void SAL_CALL SelectionSupplier::removeSelectionChangeListener( const Reference< XSelectionChangeListener >& /*_Listener*/ ) | |||
336 | { | |||
337 | OSL_FAIL( "SelectionSupplier::removeSelectionChangeListener: no support!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/control/dbtreelistbox.cxx" ":" "337" ": "), "%s", "SelectionSupplier::removeSelectionChangeListener: no support!" ); } } while (false); | |||
338 | // API bug: this should be a NoSupportException | |||
339 | } | |||
340 | } | |||
341 | ||||
342 | IMPL_LINK(TreeListBox, CommandHdl, const CommandEvent&, rCEvt, bool)bool TreeListBox::LinkStubCommandHdl(void * instance, const CommandEvent & data) { return static_cast<TreeListBox *>(instance )->CommandHdl(data); } bool TreeListBox::CommandHdl(const CommandEvent & rCEvt) | |||
| ||||
343 | { | |||
344 | if (rCEvt.GetCommand() != CommandEventId::ContextMenu) | |||
345 | return false; | |||
346 | ||||
347 | ::Point aPos = rCEvt.GetMousePosPixel(); | |||
348 | ||||
349 | std::unique_ptr<weld::TreeIter> xIter(m_xTreeView->make_iterator()); | |||
350 | if (m_xTreeView->get_dest_row_at_pos(aPos, xIter.get(), false) && !m_xTreeView->is_selected(*xIter)) | |||
351 | { | |||
352 | m_xTreeView->unselect_all(); | |||
353 | m_xTreeView->set_cursor(*xIter); | |||
354 | m_xTreeView->select(*xIter); | |||
355 | SelectHdl(*m_xTreeView); | |||
356 | } | |||
357 | ||||
358 | if (!m_pContextMenuProvider) | |||
359 | return false; | |||
360 | ||||
361 | OUString aResourceName(m_pContextMenuProvider->getContextMenuResourceName()); | |||
362 | if (aResourceName.isEmpty()) | |||
363 | return false; | |||
364 | ||||
365 | css::uno::Sequence< css::uno::Any > aArgs( 3 ); | |||
366 | aArgs[0] <<= comphelper::makePropertyValue( "Value", aResourceName ); | |||
367 | aArgs[1] <<= comphelper::makePropertyValue( "Frame", m_pContextMenuProvider->getCommandController().getXController()->getFrame() ); | |||
368 | aArgs[2] <<= comphelper::makePropertyValue( "IsContextMenu", true ); | |||
369 | ||||
370 | css::uno::Reference< css::uno::XComponentContext > xContext = comphelper::getProcessComponentContext(); | |||
371 | css::uno::Reference<css::frame::XPopupMenuController> xMenuController | |||
372 | (xContext->getServiceManager()->createInstanceWithArgumentsAndContext( | |||
373 | "com.sun.star.comp.framework.ResourceMenuController", aArgs, xContext), css::uno::UNO_QUERY); | |||
374 | ||||
375 | if (!xMenuController.is()) | |||
376 | return false; | |||
377 | ||||
378 | VclPtr<vcl::Window> xMenuParent = m_pContextMenuProvider->getMenuParent(); | |||
379 | ||||
380 | rtl::Reference xPopupMenu( new VCLXPopupMenu ); | |||
381 | xMenuController->setPopupMenu( xPopupMenu.get() ); | |||
382 | VclPtr<PopupMenu> pContextMenu( static_cast< PopupMenu* >( xPopupMenu->GetMenu() ) ); | |||
383 | ||||
384 | // allow context menu interception | |||
385 | ::comphelper::OInterfaceContainerHelper2* pInterceptors = m_pContextMenuProvider->getContextMenuInterceptors(); | |||
386 | if (pInterceptors && pInterceptors->getLength()) | |||
387 | { | |||
388 | OUString aMenuIdentifier( "private:resource/popupmenu/" + aResourceName ); | |||
389 | ||||
390 | ContextMenuExecuteEvent aEvent; | |||
391 | aEvent.SourceWindow = VCLUnoHelper::GetInterface(xMenuParent); | |||
392 | aEvent.ExecutePosition.X = -1; | |||
393 | aEvent.ExecutePosition.Y = -1; | |||
394 | aEvent.ActionTriggerContainer = ::framework::ActionTriggerHelper::CreateActionTriggerContainerFromMenu( | |||
395 | pContextMenu.get(), &aMenuIdentifier ); | |||
396 | aEvent.Selection = new SelectionSupplier(m_pContextMenuProvider->getCurrentSelection(*m_xTreeView)); | |||
397 | ||||
398 | ::comphelper::OInterfaceIteratorHelper2 aIter( *pInterceptors ); | |||
399 | bool bModifiedMenu = false; | |||
400 | bool bAskInterceptors = true; | |||
401 | while ( aIter.hasMoreElements() && bAskInterceptors ) | |||
402 | { | |||
403 | Reference< XContextMenuInterceptor > xInterceptor( aIter.next(), UNO_QUERY ); | |||
404 | if ( !xInterceptor.is() ) | |||
405 | continue; | |||
406 | ||||
407 | try | |||
408 | { | |||
409 | ContextMenuInterceptorAction eAction = xInterceptor->notifyContextMenuExecute( aEvent ); | |||
410 | switch ( eAction ) | |||
411 | { | |||
412 | case ContextMenuInterceptorAction_CANCELLED: | |||
413 | return false; | |||
414 | ||||
415 | case ContextMenuInterceptorAction_EXECUTE_MODIFIED: | |||
416 | bModifiedMenu = true; | |||
417 | bAskInterceptors = false; | |||
418 | break; | |||
419 | ||||
420 | case ContextMenuInterceptorAction_CONTINUE_MODIFIED: | |||
421 | bModifiedMenu = true; | |||
422 | bAskInterceptors = true; | |||
423 | break; | |||
424 | ||||
425 | default: | |||
426 | OSL_FAIL( "DBTreeListBox::CreateContextMenu: unexpected return value of the interceptor call!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/dbaccess/source/ui/control/dbtreelistbox.cxx" ":" "426" ": "), "%s", "DBTreeListBox::CreateContextMenu: unexpected return value of the interceptor call!" ); } } while (false); | |||
427 | [[fallthrough]]; | |||
428 | case ContextMenuInterceptorAction_IGNORED: | |||
429 | break; | |||
430 | } | |||
431 | } | |||
432 | catch( const DisposedException& e ) | |||
433 | { | |||
434 | if ( e.Context == xInterceptor ) | |||
435 | aIter.remove(); | |||
436 | } | |||
437 | } | |||
438 | ||||
439 | if ( bModifiedMenu ) | |||
440 | { | |||
441 | pContextMenu->Clear(); | |||
442 | ::framework::ActionTriggerHelper::CreateMenuFromActionTriggerContainer( | |||
443 | pContextMenu, aEvent.ActionTriggerContainer ); | |||
444 | aEvent.ActionTriggerContainer.clear(); | |||
445 | } | |||
446 | } | |||
447 | ||||
448 | // adjust pos relative to m_xTreeView to relative to xMenuParent | |||
449 | m_pContextMenuProvider->adjustMenuPosition(*m_xTreeView, aPos); | |||
450 | ||||
451 | // do action for selected entry in popup menu | |||
452 | pContextMenu->Execute(xMenuParent, aPos); | |||
453 | pContextMenu.disposeAndClear(); | |||
454 | ||||
455 | css::uno::Reference<css::lang::XComponent> xComponent(xMenuController, css::uno::UNO_QUERY); | |||
456 | if (xComponent.is()) | |||
457 | xComponent->dispose(); | |||
458 | xMenuController.clear(); | |||
459 | ||||
460 | return true; | |||
461 | } | |||
462 | ||||
463 | IMPL_LINK_NOARG(TreeListBox, OnTimeOut, Timer*, void)void TreeListBox::LinkStubOnTimeOut(void * instance, Timer* data ) { return static_cast<TreeListBox *>(instance)->OnTimeOut (data); } void TreeListBox::OnTimeOut(__attribute__ ((unused) ) Timer*) | |||
464 | { | |||
465 | implStopSelectionTimer(); | |||
466 | ||||
467 | m_aSelChangeHdl.Call( nullptr ); | |||
468 | } | |||
469 | ||||
470 | std::unique_ptr<weld::TreeIter> TreeListBox::GetRootLevelParent(const weld::TreeIter* pEntry) const | |||
471 | { | |||
472 | if (!pEntry) | |||
473 | return nullptr; | |||
474 | std::unique_ptr<weld::TreeIter> xEntry(m_xTreeView->make_iterator(pEntry)); | |||
475 | while (m_xTreeView->get_iter_depth(*xEntry)) | |||
476 | m_xTreeView->iter_parent(*xEntry); | |||
477 | return xEntry; | |||
478 | } | |||
479 | ||||
480 | DBTreeViewBase::DBTreeViewBase(weld::Container* pContainer) | |||
481 | : m_xBuilder(Application::CreateBuilder(pContainer, "dbaccess/ui/dbtreelist.ui")) | |||
482 | , m_xContainer(m_xBuilder->weld_container("DBTreeList")) | |||
483 | { | |||
484 | } | |||
485 | ||||
486 | DBTreeViewBase::~DBTreeViewBase() | |||
487 | { | |||
488 | } | |||
489 | ||||
490 | DBTreeView::DBTreeView(weld::Container* pContainer, bool bSQLType) | |||
491 | : DBTreeViewBase(pContainer) | |||
492 | { | |||
493 | m_xTreeListBox.reset(new TreeListBox(m_xBuilder->weld_tree_view("treeview"), bSQLType)); | |||
494 | } | |||
495 | ||||
496 | } // namespace dbaui | |||
497 | ||||
498 | /* 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 |