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 <csvruler.hxx> | |||
21 | #include <AccessibleCsvControl.hxx> | |||
22 | ||||
23 | #include <optutil.hxx> | |||
24 | #include <com/sun/star/uno/Any.hxx> | |||
25 | #include <com/sun/star/uno/Sequence.hxx> | |||
26 | #include <vcl/event.hxx> | |||
27 | #include <vcl/settings.hxx> | |||
28 | #include <vcl/ptrstyle.hxx> | |||
29 | #include <vcl/svapp.hxx> | |||
30 | #include <vcl/virdev.hxx> | |||
31 | ||||
32 | using namespace com::sun::star::uno; | |||
33 | ||||
34 | #define SEP_PATH"Office.Calc/Dialogs/CSVImport" "Office.Calc/Dialogs/CSVImport" | |||
35 | #define FIXED_WIDTH_LIST"FixedWidthList" "FixedWidthList" | |||
36 | ||||
37 | static void load_FixedWidthList(ScCsvSplits &rSplits) | |||
38 | { | |||
39 | Sequence<Any>aValues; | |||
40 | const Any *pProperties; | |||
41 | Sequence<OUString> aNames { FIXED_WIDTH_LIST"FixedWidthList" }; | |||
42 | ScLinkConfigItem aItem( SEP_PATH"Office.Calc/Dialogs/CSVImport" ); | |||
43 | ||||
44 | aValues = aItem.GetProperties( aNames ); | |||
45 | pProperties = aValues.getConstArray(); | |||
46 | ||||
47 | if( !pProperties[0].hasValue() ) | |||
48 | return; | |||
49 | ||||
50 | rSplits.Clear(); | |||
51 | ||||
52 | OUString sFixedWidthLists; | |||
53 | pProperties[0] >>= sFixedWidthLists; | |||
54 | ||||
55 | sal_Int32 nIdx {0}; | |||
56 | for(;;) | |||
57 | { | |||
58 | const sal_Int32 n {sFixedWidthLists.getToken(0, ';', nIdx).toInt32()}; | |||
59 | if (nIdx<0) | |||
60 | { | |||
61 | // String ends with a semi-colon so there | |||
62 | // is no useful 'int' after the last one. | |||
63 | // This also works in case of empty string | |||
64 | break; | |||
65 | } | |||
66 | rSplits.Insert(n); | |||
67 | } | |||
68 | } | |||
69 | static void save_FixedWidthList(const ScCsvSplits& rSplits) | |||
70 | { | |||
71 | OUStringBuffer sSplits; | |||
72 | // Create a semi-colon separated string to save the splits | |||
73 | sal_uInt32 n = rSplits.Count(); | |||
74 | for (sal_uInt32 i = 0; i < n; ++i) | |||
75 | { | |||
76 | sSplits.append(OUString::number(rSplits[i])); | |||
77 | sSplits.append(";"); | |||
78 | } | |||
79 | ||||
80 | OUString sFixedWidthLists = sSplits.makeStringAndClear(); | |||
81 | Sequence<Any> aValues; | |||
82 | Any *pProperties; | |||
83 | Sequence<OUString> aNames { FIXED_WIDTH_LIST"FixedWidthList" }; | |||
84 | ScLinkConfigItem aItem( SEP_PATH"Office.Calc/Dialogs/CSVImport" ); | |||
85 | ||||
86 | aValues = aItem.GetProperties( aNames ); | |||
87 | pProperties = aValues.getArray(); | |||
88 | pProperties[0] <<= sFixedWidthLists; | |||
89 | ||||
90 | aItem.PutProperties(aNames, aValues); | |||
91 | } | |||
92 | ||||
93 | ScCsvRuler::ScCsvRuler(const ScCsvLayoutData& rData, ScCsvTableBox* pTableBox) | |||
94 | : ScCsvControl(rData) | |||
95 | , mpTableBox(pTableBox) | |||
96 | , mnPosCursorLast(1) | |||
97 | , mnPosMTStart(0) | |||
98 | , mnPosMTCurr(0) | |||
99 | , mbPosMTMoved(false) | |||
100 | , mnSplitSize(0) | |||
101 | , mbTracking(false) | |||
102 | { | |||
103 | } | |||
104 | ||||
105 | void ScCsvRuler::SetDrawingArea(weld::DrawingArea* pDrawingArea) | |||
106 | { | |||
107 | ScCsvControl::SetDrawingArea(pDrawingArea); | |||
108 | ||||
109 | UpdateSplitSize(); | |||
110 | ||||
111 | Size aSize(1, GetTextHeight() + mnSplitSize + 2); | |||
112 | pDrawingArea->set_size_request(aSize.Width(), aSize.Height()); | |||
113 | SetOutputSizePixel(aSize); | |||
114 | ||||
115 | EnableRTL( false ); // RTL | |||
116 | InitColors(); | |||
117 | InitSizeData(); | |||
118 | ||||
119 | OutputDevice& rRefDevice = pDrawingArea->get_ref_device(); | |||
120 | maBackgrDev->SetFont( rRefDevice.GetFont() ); | |||
121 | maRulerDev->SetFont( rRefDevice.GetFont() ); | |||
122 | load_FixedWidthList( maSplits ); | |||
123 | } | |||
124 | ||||
125 | ScCsvRuler::~ScCsvRuler() | |||
126 | { | |||
127 | save_FixedWidthList( maSplits ); | |||
128 | } | |||
| ||||
129 | ||||
130 | // common ruler handling ------------------------------------------------------ | |||
131 | ||||
132 | void ScCsvRuler::ApplyLayout( const ScCsvLayoutData& rOldData ) | |||
133 | { | |||
134 | ScCsvDiff nDiff = GetLayoutData().GetDiff( rOldData ) & (ScCsvDiff::HorizontalMask | ScCsvDiff::RulerCursor); | |||
135 | if( nDiff == ScCsvDiff::Equal ) return; | |||
136 | ||||
137 | DisableRepaint(); | |||
138 | if( nDiff & ScCsvDiff::HorizontalMask ) | |||
139 | { | |||
140 | InitSizeData(); | |||
141 | if( GetRulerCursorPos() >= GetPosCount() ) | |||
142 | MoveCursor( GetPosCount() - 1 ); | |||
143 | } | |||
144 | if( nDiff & ScCsvDiff::RulerCursor ) | |||
145 | { | |||
146 | ImplInvertCursor( rOldData.mnPosCursor ); | |||
147 | ImplInvertCursor( GetRulerCursorPos() ); | |||
148 | } | |||
149 | EnableRepaint(); | |||
150 | ||||
151 | if( nDiff & ScCsvDiff::PosOffset ) | |||
152 | AccSendVisibleEvent(); | |||
153 | } | |||
154 | ||||
155 | void ScCsvRuler::InitColors() | |||
156 | { | |||
157 | const StyleSettings& rSett = Application::GetSettings().GetStyleSettings(); | |||
158 | maBackColor = rSett.GetFaceColor(); | |||
159 | maActiveColor = rSett.GetWindowColor(); | |||
160 | maTextColor = rSett.GetLabelTextColor(); | |||
161 | maSplitColor = maBackColor.IsDark() ? maTextColor : COL_LIGHTRED; | |||
162 | InvalidateGfx(); | |||
163 | } | |||
164 | ||||
165 | void ScCsvRuler::UpdateSplitSize() | |||
166 | { | |||
167 | mnSplitSize = (GetCharWidth() * 3 / 5) | 1; // make an odd number | |||
168 | } | |||
169 | ||||
170 | void ScCsvRuler::InitSizeData() | |||
171 | { | |||
172 | maWinSize = GetOutputSizePixel(); | |||
173 | ||||
174 | UpdateSplitSize(); | |||
175 | ||||
176 | sal_Int32 nActiveWidth = std::min( GetWidth() - GetHdrWidth(), GetPosCount() * GetCharWidth() ); | |||
177 | sal_Int32 nActiveHeight = GetTextHeight(); | |||
178 | ||||
179 | maActiveRect.SetPos( Point( GetFirstX(), (GetHeight() - nActiveHeight - 1) / 2 ) ); | |||
180 | maActiveRect.SetSize( Size( nActiveWidth, nActiveHeight ) ); | |||
181 | ||||
182 | maBackgrDev->SetOutputSizePixel( maWinSize ); | |||
183 | maRulerDev->SetOutputSizePixel( maWinSize ); | |||
184 | ||||
185 | InvalidateGfx(); | |||
186 | } | |||
187 | ||||
188 | void ScCsvRuler::MoveCursor( sal_Int32 nPos, bool bScroll ) | |||
189 | { | |||
190 | DisableRepaint(); | |||
191 | if( bScroll ) | |||
192 | Execute( CSVCMD_MAKEPOSVISIBLE, nPos ); | |||
193 | Execute( CSVCMD_MOVERULERCURSOR, IsVisibleSplitPos( nPos ) ? nPos : CSV_POS_INVALID ); | |||
194 | EnableRepaint(); | |||
195 | AccSendCaretEvent(); | |||
196 | } | |||
197 | ||||
198 | void ScCsvRuler::MoveCursorRel( ScMoveMode eDir ) | |||
199 | { | |||
200 | if( GetRulerCursorPos() == CSV_POS_INVALID ) | |||
201 | return; | |||
202 | ||||
203 | switch( eDir ) | |||
204 | { | |||
205 | case MOVE_FIRST: | |||
206 | MoveCursor( 1 ); | |||
207 | break; | |||
208 | case MOVE_LAST: | |||
209 | MoveCursor( GetPosCount() - 1 ); | |||
210 | break; | |||
211 | case MOVE_PREV: | |||
212 | if( GetRulerCursorPos() > 1 ) | |||
213 | MoveCursor( GetRulerCursorPos() - 1 ); | |||
214 | break; | |||
215 | case MOVE_NEXT: | |||
216 | if( GetRulerCursorPos() < GetPosCount() - 1 ) | |||
217 | MoveCursor( GetRulerCursorPos() + 1 ); | |||
218 | break; | |||
219 | default: | |||
220 | { | |||
221 | // added to avoid warnings | |||
222 | } | |||
223 | } | |||
224 | } | |||
225 | ||||
226 | void ScCsvRuler::MoveCursorToSplit( ScMoveMode eDir ) | |||
227 | { | |||
228 | if( GetRulerCursorPos() == CSV_POS_INVALID ) | |||
229 | return; | |||
230 | ||||
231 | sal_uInt32 nIndex = CSV_VEC_NOTFOUND; | |||
232 | switch( eDir ) | |||
233 | { | |||
234 | case MOVE_FIRST: nIndex = maSplits.LowerBound( 0 ); break; | |||
235 | case MOVE_LAST: nIndex = maSplits.UpperBound( GetPosCount() ); break; | |||
236 | case MOVE_PREV: nIndex = maSplits.UpperBound( GetRulerCursorPos() - 1 ); break; | |||
237 | case MOVE_NEXT: nIndex = maSplits.LowerBound( GetRulerCursorPos() + 1 ); break; | |||
238 | default: | |||
239 | { | |||
240 | // added to avoid warnings | |||
241 | } | |||
242 | } | |||
243 | sal_Int32 nPos = maSplits[ nIndex ]; | |||
244 | if( nPos != CSV_POS_INVALID ) | |||
245 | MoveCursor( nPos ); | |||
246 | } | |||
247 | ||||
248 | void ScCsvRuler::ScrollVertRel( ScMoveMode eDir ) | |||
249 | { | |||
250 | sal_Int32 nLine = GetFirstVisLine(); | |||
251 | switch( eDir ) | |||
252 | { | |||
253 | case MOVE_PREV: --nLine; break; | |||
254 | case MOVE_NEXT: ++nLine; break; | |||
255 | case MOVE_PREVPAGE: nLine -= GetVisLineCount() - 1; break; | |||
256 | case MOVE_NEXTPAGE: nLine += GetVisLineCount() - 1; break; | |||
257 | default: | |||
258 | { | |||
259 | // added to avoid warnings | |||
260 | } | |||
261 | } | |||
262 | Execute( CSVCMD_SETLINEOFFSET, nLine ); | |||
263 | } | |||
264 | ||||
265 | // split handling ------------------------------------------------------------- | |||
266 | ||||
267 | sal_Int32 ScCsvRuler::GetNoScrollPos( sal_Int32 nPos ) const | |||
268 | { | |||
269 | sal_Int32 nNewPos = nPos; | |||
270 | if( nNewPos != CSV_POS_INVALID ) | |||
271 | { | |||
272 | if( nNewPos < GetFirstVisPos() + CSV_SCROLL_DIST ) | |||
273 | { | |||
274 | sal_Int32 nScroll = (GetFirstVisPos() > 0) ? CSV_SCROLL_DIST : 0; | |||
275 | nNewPos = std::max( nPos, GetFirstVisPos() + nScroll ); | |||
276 | } | |||
277 | else if( nNewPos > GetLastVisPos() - CSV_SCROLL_DIST - 1 ) | |||
278 | { | |||
279 | sal_Int32 nScroll = (GetFirstVisPos() < GetMaxPosOffset()) ? CSV_SCROLL_DIST : 0; | |||
280 | nNewPos = std::min( nNewPos, GetLastVisPos() - nScroll - sal_Int32( 1 ) ); | |||
281 | } | |||
282 | } | |||
283 | return nNewPos; | |||
284 | } | |||
285 | ||||
286 | void ScCsvRuler::InsertSplit( sal_Int32 nPos ) | |||
287 | { | |||
288 | if( maSplits.Insert( nPos ) ) | |||
289 | { | |||
290 | ImplDrawSplit( nPos ); | |||
291 | Repaint(); | |||
292 | } | |||
293 | } | |||
294 | ||||
295 | void ScCsvRuler::RemoveSplit( sal_Int32 nPos ) | |||
296 | { | |||
297 | if( maSplits.Remove( nPos ) ) | |||
298 | { | |||
299 | ImplEraseSplit( nPos ); | |||
300 | Repaint(); | |||
301 | } | |||
302 | } | |||
303 | ||||
304 | void ScCsvRuler::MoveSplit( sal_Int32 nPos, sal_Int32 nNewPos ) | |||
305 | { | |||
306 | bool bRemove = maSplits.Remove( nPos ); | |||
307 | bool bInsert = maSplits.Insert( nNewPos ); | |||
308 | if( bRemove || bInsert ) | |||
309 | { | |||
310 | ImplEraseSplit( nPos ); | |||
311 | ImplDrawSplit( nNewPos ); | |||
312 | Repaint(); | |||
313 | } | |||
314 | } | |||
315 | ||||
316 | void ScCsvRuler::RemoveAllSplits() | |||
317 | { | |||
318 | maSplits.Clear(); | |||
319 | Repaint( true ); | |||
320 | } | |||
321 | ||||
322 | sal_Int32 ScCsvRuler::FindEmptyPos( sal_Int32 nPos, ScMoveMode eDir ) const | |||
323 | { | |||
324 | sal_Int32 nNewPos = nPos; | |||
325 | if( nNewPos != CSV_POS_INVALID ) | |||
326 | { | |||
327 | switch( eDir ) | |||
328 | { | |||
329 | case MOVE_FIRST: | |||
330 | nNewPos = std::min( nPos, FindEmptyPos( 0, MOVE_NEXT ) ); | |||
331 | break; | |||
332 | case MOVE_LAST: | |||
333 | nNewPos = std::max( nPos, FindEmptyPos( GetPosCount(), MOVE_PREV ) ); | |||
334 | break; | |||
335 | case MOVE_PREV: | |||
336 | while( HasSplit( --nNewPos ) ) ; | |||
337 | break; | |||
338 | case MOVE_NEXT: | |||
339 | while( HasSplit( ++nNewPos ) ) ; | |||
340 | break; | |||
341 | default: | |||
342 | { | |||
343 | // added to avoid warnings | |||
344 | } | |||
345 | } | |||
346 | } | |||
347 | return IsValidSplitPos( nNewPos ) ? nNewPos : CSV_POS_INVALID; | |||
348 | } | |||
349 | ||||
350 | void ScCsvRuler::MoveCurrSplit( sal_Int32 nNewPos ) | |||
351 | { | |||
352 | DisableRepaint(); | |||
353 | Execute( CSVCMD_MOVESPLIT, GetRulerCursorPos(), nNewPos ); | |||
354 | MoveCursor( nNewPos ); | |||
355 | EnableRepaint(); | |||
356 | } | |||
357 | ||||
358 | void ScCsvRuler::MoveCurrSplitRel( ScMoveMode eDir ) | |||
359 | { | |||
360 | if( HasSplit( GetRulerCursorPos() ) ) | |||
361 | { | |||
362 | sal_Int32 nNewPos = FindEmptyPos( GetRulerCursorPos(), eDir ); | |||
363 | if( nNewPos != CSV_POS_INVALID ) | |||
364 | MoveCurrSplit( nNewPos ); | |||
365 | } | |||
366 | } | |||
367 | ||||
368 | // event handling ------------------------------------------------------------- | |||
369 | ||||
370 | void ScCsvRuler::Resize() | |||
371 | { | |||
372 | ScCsvControl::Resize(); | |||
373 | InitSizeData(); | |||
374 | Repaint(); | |||
375 | } | |||
376 | ||||
377 | void ScCsvRuler::GetFocus() | |||
378 | { | |||
379 | ScCsvControl::GetFocus(); | |||
380 | DisableRepaint(); | |||
381 | if( GetRulerCursorPos() == CSV_POS_INVALID ) | |||
382 | MoveCursor( GetNoScrollPos( mnPosCursorLast ) ); | |||
383 | EnableRepaint(); | |||
384 | } | |||
385 | ||||
386 | void ScCsvRuler::LoseFocus() | |||
387 | { | |||
388 | ScCsvControl::LoseFocus(); | |||
389 | mnPosCursorLast = GetRulerCursorPos(); | |||
390 | MoveCursor( CSV_POS_INVALID ); | |||
391 | } | |||
392 | ||||
393 | void ScCsvRuler::StyleUpdated() | |||
394 | { | |||
395 | InitColors(); | |||
396 | Repaint(); | |||
397 | ||||
398 | ScCsvControl::StyleUpdated(); | |||
399 | } | |||
400 | ||||
401 | bool ScCsvRuler::MouseButtonDown( const MouseEvent& rMEvt ) | |||
402 | { | |||
403 | DisableRepaint(); | |||
404 | if( !HasFocus() ) | |||
405 | GrabFocus(); | |||
406 | if( rMEvt.IsLeft() ) | |||
407 | { | |||
408 | sal_Int32 nPos = GetPosFromX( rMEvt.GetPosPixel().X() ); | |||
409 | if( IsVisibleSplitPos( nPos ) ) | |||
410 | StartMouseTracking( nPos ); | |||
411 | ImplSetMousePointer( nPos ); | |||
412 | } | |||
413 | EnableRepaint(); | |||
414 | return true; | |||
415 | } | |||
416 | ||||
417 | bool ScCsvRuler::MouseButtonUp( const MouseEvent& ) | |||
418 | { | |||
419 | if (mbTracking) | |||
420 | { | |||
421 | EndMouseTracking(); | |||
422 | mbTracking = false; | |||
423 | } | |||
424 | return true; | |||
425 | } | |||
426 | ||||
427 | bool ScCsvRuler::MouseMove( const MouseEvent& rMEvt ) | |||
428 | { | |||
429 | if( !rMEvt.IsModifierChanged() ) | |||
430 | { | |||
431 | sal_Int32 nPos = GetPosFromX( rMEvt.GetPosPixel().X() ); | |||
432 | if( mbTracking ) | |||
433 | { | |||
434 | // on mouse tracking: keep position valid | |||
435 | nPos = std::max( std::min( nPos, GetPosCount() - sal_Int32( 1 ) ), sal_Int32( 1 ) ); | |||
436 | MoveMouseTracking( nPos ); | |||
437 | } | |||
438 | else | |||
439 | { | |||
440 | tools::Rectangle aRect( Point(), maWinSize ); | |||
441 | if( !IsVisibleSplitPos( nPos ) || !aRect.IsInside( rMEvt.GetPosPixel() ) ) | |||
442 | // if focused, keep old cursor position for key input | |||
443 | nPos = HasFocus() ? GetRulerCursorPos() : CSV_POS_INVALID; | |||
444 | MoveCursor( nPos, false ); | |||
445 | } | |||
446 | ImplSetMousePointer( nPos ); | |||
447 | } | |||
448 | return true; | |||
449 | } | |||
450 | ||||
451 | bool ScCsvRuler::KeyInput( const KeyEvent& rKEvt ) | |||
452 | { | |||
453 | const vcl::KeyCode& rKCode = rKEvt.GetKeyCode(); | |||
454 | sal_uInt16 nCode = rKCode.GetCode(); | |||
455 | bool bNoMod = !rKCode.GetModifier(); | |||
456 | bool bShift = (rKCode.GetModifier() == KEY_SHIFT); | |||
457 | bool bJump = (rKCode.GetModifier() == KEY_MOD1); | |||
458 | bool bMove = (rKCode.GetModifier() == (KEY_MOD1 | KEY_SHIFT)); | |||
459 | ||||
460 | ScMoveMode eHDir = GetHorzDirection( nCode, true ); | |||
461 | ScMoveMode eVDir = GetVertDirection( nCode, false ); | |||
462 | ||||
463 | if( bNoMod ) | |||
464 | { | |||
465 | if( eHDir != MOVE_NONE ) | |||
466 | MoveCursorRel( eHDir ); | |||
467 | else if( eVDir != MOVE_NONE ) | |||
468 | ScrollVertRel( eVDir ); | |||
469 | else switch( nCode ) | |||
470 | { | |||
471 | case KEY_SPACE: Execute( CSVCMD_TOGGLESPLIT, GetRulerCursorPos() ); break; | |||
472 | case KEY_INSERT: Execute( CSVCMD_INSERTSPLIT, GetRulerCursorPos() ); break; | |||
473 | case KEY_DELETE: Execute( CSVCMD_REMOVESPLIT, GetRulerCursorPos() ); break; | |||
474 | } | |||
475 | } | |||
476 | else if( bJump && (eHDir != MOVE_NONE) ) | |||
477 | MoveCursorToSplit( eHDir ); | |||
478 | else if( bMove && (eHDir != MOVE_NONE) ) | |||
479 | MoveCurrSplitRel( eHDir ); | |||
480 | else if( bShift && (nCode == KEY_DELETE) ) | |||
481 | Execute( CSVCMD_REMOVEALLSPLITS ); | |||
482 | ||||
483 | return rKCode.GetGroup() == KEYGROUP_CURSOR; | |||
484 | } | |||
485 | ||||
486 | void ScCsvRuler::StartMouseTracking( sal_Int32 nPos ) | |||
487 | { | |||
488 | mnPosMTStart = mnPosMTCurr = nPos; | |||
489 | mbPosMTMoved = false; | |||
490 | maOldSplits = maSplits; | |||
491 | Execute( CSVCMD_INSERTSPLIT, nPos ); | |||
492 | if( HasSplit( nPos ) ) | |||
493 | mbTracking = true; | |||
494 | } | |||
495 | ||||
496 | void ScCsvRuler::MoveMouseTracking( sal_Int32 nPos ) | |||
497 | { | |||
498 | if( mnPosMTCurr != nPos ) | |||
499 | { | |||
500 | DisableRepaint(); | |||
501 | MoveCursor( nPos ); | |||
502 | if( (mnPosMTCurr != mnPosMTStart) && maOldSplits.HasSplit( mnPosMTCurr ) ) | |||
503 | Execute( CSVCMD_INSERTSPLIT, nPos ); | |||
504 | else | |||
505 | Execute( CSVCMD_MOVESPLIT, mnPosMTCurr, nPos ); | |||
506 | mnPosMTCurr = nPos; | |||
507 | mbPosMTMoved = true; | |||
508 | EnableRepaint(); | |||
509 | } | |||
510 | } | |||
511 | ||||
512 | void ScCsvRuler::EndMouseTracking() | |||
513 | { | |||
514 | // remove on simple click on an existing split | |||
515 | if( (mnPosMTCurr == mnPosMTStart) && maOldSplits.HasSplit( mnPosMTCurr ) && !mbPosMTMoved ) | |||
516 | Execute( CSVCMD_REMOVESPLIT, mnPosMTCurr ); | |||
517 | mnPosMTStart = CSV_POS_INVALID; | |||
518 | } | |||
519 | ||||
520 | // painting ------------------------------------------------------------------- | |||
521 | ||||
522 | void ScCsvRuler::Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& ) | |||
523 | { | |||
524 | ImplRedraw(rRenderContext); | |||
525 | } | |||
526 | ||||
527 | void ScCsvRuler::ImplRedraw(vcl::RenderContext& rRenderContext) | |||
528 | { | |||
529 | if( IsVisible() ) | |||
530 | { | |||
531 | if( !IsValidGfx() ) | |||
532 | { | |||
533 | ValidateGfx(); | |||
534 | ImplDrawBackgrDev(); | |||
535 | ImplDrawRulerDev(); | |||
536 | } | |||
537 | rRenderContext.DrawOutDev( Point(), maWinSize, Point(), maWinSize, *maRulerDev ); | |||
538 | } | |||
539 | } | |||
540 | ||||
541 | tools::Rectangle ScCsvRuler::GetFocusRect() | |||
542 | { | |||
543 | /* Draws directly tracking rectangle to the column with the specified index. */ | |||
544 | if(HasFocus()) | |||
545 | return tools::Rectangle(0, 0, GetWidth() - 1, GetHeight() - 2); | |||
546 | return weld::CustomWidgetController::GetFocusRect(); | |||
547 | } | |||
548 | ||||
549 | void ScCsvRuler::ImplDrawArea( sal_Int32 nPosX, sal_Int32 nWidth ) | |||
550 | { | |||
551 | maBackgrDev->SetLineColor(); | |||
552 | tools::Rectangle aRect( Point( nPosX, 0 ), Size( nWidth, GetHeight() ) ); | |||
553 | maBackgrDev->SetFillColor( maBackColor ); | |||
554 | maBackgrDev->DrawRect( aRect ); | |||
555 | ||||
556 | aRect = maActiveRect; | |||
557 | aRect.SetLeft( std::max( GetFirstX(), nPosX ) ); | |||
558 | aRect.SetRight( std::min( std::min( GetX( GetPosCount() ), GetLastX() ), nPosX + nWidth - sal_Int32( 1 ) ) ); | |||
559 | if( aRect.Left() <= aRect.Right() ) | |||
560 | { | |||
561 | maBackgrDev->SetFillColor( maActiveColor ); | |||
562 | maBackgrDev->DrawRect( aRect ); | |||
563 | } | |||
564 | ||||
565 | maBackgrDev->SetLineColor( maTextColor ); | |||
566 | sal_Int32 nY = GetHeight() - 1; | |||
567 | maBackgrDev->DrawLine( Point( nPosX, nY ), Point( nPosX + nWidth - 1, nY ) ); | |||
568 | } | |||
569 | ||||
570 | void ScCsvRuler::ImplDrawBackgrDev() | |||
571 | { | |||
572 | ImplDrawArea( 0, GetWidth() ); | |||
573 | ||||
574 | // scale | |||
575 | maBackgrDev->SetLineColor( maTextColor ); | |||
576 | maBackgrDev->SetFillColor(); | |||
577 | sal_Int32 nPos; | |||
578 | ||||
579 | sal_Int32 nFirstPos = std::max( GetPosFromX( 0 ) - 1, sal_Int32(0) ); | |||
580 | sal_Int32 nLastPos = GetPosFromX( GetWidth() ); | |||
581 | sal_Int32 nY = (maActiveRect.Top() + maActiveRect.Bottom()) / 2; | |||
582 | for( nPos = nFirstPos; nPos <= nLastPos; ++nPos ) | |||
583 | { | |||
584 | sal_Int32 nX = GetX( nPos ); | |||
585 | if( nPos % 5 ) | |||
586 | maBackgrDev->DrawPixel( Point( nX, nY ) ); | |||
587 | else | |||
588 | maBackgrDev->DrawLine( Point( nX, nY - 1 ), Point( nX, nY + 1 ) ); | |||
589 | } | |||
590 | ||||
591 | // texts | |||
592 | maBackgrDev->SetTextColor( maTextColor ); | |||
593 | maBackgrDev->SetTextFillColor(); | |||
594 | for( nPos = ((nFirstPos + 9) / 10) * 10; nPos <= nLastPos; nPos += 10 ) | |||
595 | { | |||
596 | OUString aText( OUString::number( nPos ) ); | |||
597 | sal_Int32 nTextWidth = maBackgrDev->GetTextWidth( aText ); | |||
598 | sal_Int32 nTextX = GetX( nPos ) - nTextWidth / 2; | |||
599 | ImplDrawArea( nTextX - 1, nTextWidth + 2 ); | |||
600 | maBackgrDev->DrawText( Point( nTextX, maActiveRect.Top() ), aText ); | |||
601 | } | |||
602 | } | |||
603 | ||||
604 | void ScCsvRuler::ImplDrawSplit( sal_Int32 nPos ) | |||
605 | { | |||
606 | if( IsVisibleSplitPos( nPos ) ) | |||
607 | { | |||
608 | Point aPos( GetX( nPos ) - mnSplitSize / 2, GetHeight() - mnSplitSize - 2 ); | |||
609 | Size aSize( mnSplitSize, mnSplitSize ); | |||
610 | maRulerDev->SetLineColor( maTextColor ); | |||
611 | maRulerDev->SetFillColor( maSplitColor ); | |||
612 | maRulerDev->DrawEllipse( tools::Rectangle( aPos, aSize ) ); | |||
613 | maRulerDev->DrawPixel( Point( GetX( nPos ), GetHeight() - 2 ) ); | |||
614 | } | |||
615 | } | |||
616 | ||||
617 | void ScCsvRuler::ImplEraseSplit( sal_Int32 nPos ) | |||
618 | { | |||
619 | if( IsVisibleSplitPos( nPos ) ) | |||
620 | { | |||
621 | ImplInvertCursor( GetRulerCursorPos() ); | |||
622 | Point aPos( GetX( nPos ) - mnSplitSize / 2, 0 ); | |||
623 | Size aSize( mnSplitSize, GetHeight() ); | |||
624 | maRulerDev->DrawOutDev( aPos, aSize, aPos, aSize, *maBackgrDev ); | |||
625 | ImplInvertCursor( GetRulerCursorPos() ); | |||
626 | } | |||
627 | } | |||
628 | ||||
629 | void ScCsvRuler::ImplDrawRulerDev() | |||
630 | { | |||
631 | maRulerDev->DrawOutDev( Point(), maWinSize, Point(), maWinSize, *maBackgrDev ); | |||
632 | ImplInvertCursor( GetRulerCursorPos() ); | |||
633 | ||||
634 | sal_uInt32 nFirst = maSplits.LowerBound( GetFirstVisPos() ); | |||
635 | sal_uInt32 nLast = maSplits.UpperBound( GetLastVisPos() ); | |||
636 | if( (nFirst != CSV_VEC_NOTFOUND) && (nLast != CSV_VEC_NOTFOUND) ) | |||
637 | for( sal_uInt32 nIndex = nFirst; nIndex <= nLast; ++nIndex ) | |||
638 | ImplDrawSplit( GetSplitPos( nIndex ) ); | |||
639 | } | |||
640 | ||||
641 | void ScCsvRuler::ImplInvertCursor( sal_Int32 nPos ) | |||
642 | { | |||
643 | if( IsVisibleSplitPos( nPos ) ) | |||
644 | { | |||
645 | ImplInvertRect( *maRulerDev, tools::Rectangle( Point( GetX( nPos ) - 1, 0 ), Size( 3, GetHeight() - 1 ) ) ); | |||
646 | if( HasSplit( nPos ) ) | |||
647 | ImplDrawSplit( nPos ); | |||
648 | } | |||
649 | } | |||
650 | ||||
651 | void ScCsvRuler::ImplSetMousePointer( sal_Int32 nPos ) | |||
652 | { | |||
653 | SetPointer( HasSplit( nPos ) ? PointerStyle::HSplit : PointerStyle::Arrow ); | |||
654 | } | |||
655 | ||||
656 | // accessibility ============================================================== | |||
657 | ||||
658 | css::uno::Reference<css::accessibility::XAccessible> ScCsvRuler::CreateAccessible() | |||
659 | { | |||
660 | rtl::Reference<ScAccessibleCsvRuler> xRef(new ScAccessibleCsvRuler(*this)); | |||
661 | mxAccessible.set(xRef.get()); | |||
662 | return css::uno::Reference<css::accessibility::XAccessible>(xRef.get()); | |||
663 | } | |||
664 | ||||
665 | /* 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 |