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 <AnnotationWin.hxx> | |||
21 | ||||
22 | #include "AnnotationMenuButton.hxx" | |||
23 | #include <PostItMgr.hxx> | |||
24 | ||||
25 | #include <strings.hrc> | |||
26 | ||||
27 | #include <uiobject.hxx> | |||
28 | ||||
29 | #include <vcl/fixed.hxx> | |||
30 | #include <vcl/menu.hxx> | |||
31 | #include <vcl/scrbar.hxx> | |||
32 | #include <vcl/settings.hxx> | |||
33 | #include <vcl/svapp.hxx> | |||
34 | #include <vcl/uitest/logger.hxx> | |||
35 | #include <vcl/uitest/eventdescription.hxx> | |||
36 | ||||
37 | #include <svl/undo.hxx> | |||
38 | #include <unotools/localedatawrapper.hxx> | |||
39 | #include <unotools/syslocale.hxx> | |||
40 | #include <svl/languageoptions.hxx> | |||
41 | ||||
42 | #include <editeng/eeitem.hxx> | |||
43 | #include <editeng/postitem.hxx> | |||
44 | #include <editeng/fhgtitem.hxx> | |||
45 | #include <editeng/langitem.hxx> | |||
46 | ||||
47 | #include <editeng/editview.hxx> | |||
48 | #include <editeng/outliner.hxx> | |||
49 | #include <editeng/editeng.hxx> | |||
50 | #include <editeng/editobj.hxx> | |||
51 | #include <editeng/outlobj.hxx> | |||
52 | ||||
53 | #include <comphelper/lok.hxx> | |||
54 | #include <docufld.hxx> | |||
55 | #include <txtfld.hxx> | |||
56 | #include <ndtxt.hxx> | |||
57 | #include <view.hxx> | |||
58 | #include <viewopt.hxx> | |||
59 | #include <wrtsh.hxx> | |||
60 | #include <docsh.hxx> | |||
61 | #include <doc.hxx> | |||
62 | #include <IDocumentUndoRedo.hxx> | |||
63 | #include <SwUndoField.hxx> | |||
64 | #include <edtwin.hxx> | |||
65 | #include "ShadowOverlayObject.hxx" | |||
66 | #include "AnchorOverlayObject.hxx" | |||
67 | #include "OverlayRanges.hxx" | |||
68 | #include "SidebarTxtControl.hxx" | |||
69 | ||||
70 | #include <memory> | |||
71 | ||||
72 | namespace{ | |||
73 | ||||
74 | void collectUIInformation( const OUString& aevent , const OUString& aID ) | |||
75 | { | |||
76 | EventDescription aDescription; | |||
77 | aDescription.aID = aID; | |||
78 | aDescription.aParameters = {{"" , ""}}; | |||
79 | aDescription.aAction = aevent; | |||
80 | aDescription.aParent = "MainWindow"; | |||
81 | aDescription.aKeyWord = "SwEditWinUIObject"; | |||
82 | UITestLogger::getInstance().logEvent(aDescription); | |||
83 | } | |||
84 | ||||
85 | } | |||
86 | ||||
87 | namespace sw::annotation { | |||
88 | ||||
89 | SwAnnotationWin::SwAnnotationWin( SwEditWin& rEditWin, | |||
90 | SwPostItMgr& aMgr, | |||
91 | SwSidebarItem& rSidebarItem, | |||
92 | SwFormatField* aField ) | |||
93 | : Window(&rEditWin) | |||
94 | , maBuilder(nullptr, AllSettings::GetUIRootDir(), "modules/swriter/ui/annotationmenu.ui", "") | |||
95 | , mrMgr(aMgr) | |||
96 | , mrView(rEditWin.GetView()) | |||
97 | , mnEventId(nullptr) | |||
98 | , mpSidebarTextControl(nullptr) | |||
99 | , mpVScrollbar(nullptr) | |||
100 | , mpMetadataAuthor(nullptr) | |||
101 | , mpMetadataDate(nullptr) | |||
102 | , mpMenuButton(nullptr) | |||
103 | , mColorAnchor() | |||
104 | , mColorDark() | |||
105 | , mColorLight() | |||
106 | , mChangeColor() | |||
107 | , meSidebarPosition(sw::sidebarwindows::SidebarPosition::NONE) | |||
108 | , mPosSize() | |||
109 | , mAnchorRect() | |||
110 | , mPageBorder(0) | |||
111 | , mbAnchorRectChanged(false) | |||
112 | , mbResolvedStateUpdated(false) | |||
113 | , mbMouseOver(false) | |||
114 | , mLayoutStatus(SwPostItHelper::INVISIBLE) | |||
115 | , mbReadonly(false) | |||
116 | , mbIsFollow(false) | |||
117 | , mrSidebarItem(rSidebarItem) | |||
118 | , mpAnchorFrame(rSidebarItem.maLayoutInfo.mpAnchorFrame) | |||
119 | , mpFormatField(aField) | |||
120 | , mpField( static_cast<SwPostItField*>(aField->GetField())) | |||
121 | , mpButtonPopup(nullptr) | |||
122 | { | |||
123 | set_id("Comment"+OUString::number(mpField->GetPostItId())); | |||
124 | ||||
125 | mpShadow = sidebarwindows::ShadowOverlayObject::CreateShadowOverlayObject( mrView ); | |||
126 | if ( mpShadow ) | |||
127 | { | |||
128 | mpShadow->setVisible(false); | |||
129 | } | |||
130 | ||||
131 | mrMgr.ConnectSidebarWinToFrame( *(mrSidebarItem.maLayoutInfo.mpAnchorFrame), | |||
132 | mrSidebarItem.GetFormatField(), | |||
133 | *this ); | |||
134 | ||||
135 | if (SupportsDoubleBuffering()) | |||
136 | // When double-buffering, allow parents to paint on our area. That's | |||
137 | // necessary when parents paint the complete buffer. | |||
138 | SetParentClipMode(ParentClipMode::NoClip); | |||
139 | } | |||
140 | ||||
141 | SwAnnotationWin::~SwAnnotationWin() | |||
142 | { | |||
143 | disposeOnce(); | |||
144 | } | |||
145 | ||||
146 | void SwAnnotationWin::dispose() | |||
147 | { | |||
148 | mpButtonPopup.clear(); | |||
149 | maBuilder.disposeBuilder(); | |||
150 | ||||
151 | if (IsDisposed()) | |||
| ||||
152 | return; | |||
153 | ||||
154 | mrMgr.DisconnectSidebarWinFromFrame( *(mrSidebarItem.maLayoutInfo.mpAnchorFrame), | |||
155 | *this ); | |||
156 | ||||
157 | Disable(); | |||
158 | ||||
159 | if ( mpSidebarTextControl ) | |||
160 | { | |||
161 | if ( mpOutlinerView ) | |||
162 | { | |||
163 | mpOutlinerView->SetWindow( nullptr ); | |||
164 | } | |||
165 | } | |||
166 | mpSidebarTextControl.disposeAndClear(); | |||
167 | ||||
168 | mpOutlinerView.reset(); | |||
169 | mpOutliner.reset(); | |||
170 | ||||
171 | if (mpMetadataAuthor) | |||
172 | { | |||
173 | mpMetadataAuthor->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubWindowEventListener ) ); | |||
174 | } | |||
175 | mpMetadataAuthor.disposeAndClear(); | |||
176 | ||||
177 | if (mpMetadataResolved) | |||
178 | { | |||
179 | mpMetadataResolved->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubWindowEventListener ) ); | |||
180 | } | |||
181 | mpMetadataResolved.disposeAndClear(); | |||
182 | ||||
183 | if (mpMetadataDate) | |||
184 | { | |||
185 | mpMetadataDate->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubWindowEventListener ) ); | |||
186 | } | |||
187 | mpMetadataDate.disposeAndClear(); | |||
188 | ||||
189 | if (mpVScrollbar) | |||
190 | { | |||
191 | mpVScrollbar->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubWindowEventListener ) ); | |||
192 | } | |||
193 | mpVScrollbar.disposeAndClear(); | |||
194 | ||||
195 | RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubWindowEventListener ) ); | |||
196 | ||||
197 | mpAnchor.reset(); | |||
198 | mpShadow.reset(); | |||
199 | ||||
200 | mpTextRangeOverlay.reset(); | |||
201 | ||||
202 | mpMenuButton.disposeAndClear(); | |||
203 | ||||
204 | if (mnEventId) | |||
205 | Application::RemoveUserEvent( mnEventId ); | |||
206 | ||||
207 | vcl::Window::dispose(); | |||
208 | } | |||
209 | ||||
210 | void SwAnnotationWin::SetPostItText() | |||
211 | { | |||
212 | //If the cursor was visible, then make it visible again after | |||
213 | //changing text, e.g. fdo#33599 | |||
214 | vcl::Cursor *pCursor = GetOutlinerView()->GetEditView().GetCursor(); | |||
215 | bool bCursorVisible = pCursor && pCursor->IsVisible(); | |||
216 | ||||
217 | //If the new text is the same as the old text, keep the same insertion | |||
218 | //point .e.g. fdo#33599 | |||
219 | mpField = static_cast<SwPostItField*>(mpFormatField->GetField()); | |||
220 | OUString sNewText = mpField->GetPar2(); | |||
221 | bool bTextUnchanged = sNewText == mpOutliner->GetEditEngine().GetText(); | |||
222 | ESelection aOrigSelection(GetOutlinerView()->GetEditView().GetSelection()); | |||
223 | ||||
224 | // get text from SwPostItField and insert into our textview | |||
225 | mpOutliner->SetModifyHdl( Link<LinkParamNone*,void>() ); | |||
226 | mpOutliner->EnableUndo( false ); | |||
227 | if( mpField->GetTextObject() ) | |||
228 | mpOutliner->SetText( *mpField->GetTextObject() ); | |||
229 | else | |||
230 | { | |||
231 | mpOutliner->Clear(); | |||
232 | GetOutlinerView()->SetAttribs(DefaultItem()); | |||
233 | GetOutlinerView()->InsertText(sNewText); | |||
234 | } | |||
235 | ||||
236 | mpOutliner->ClearModifyFlag(); | |||
237 | mpOutliner->GetUndoManager().Clear(); | |||
238 | mpOutliner->EnableUndo( true ); | |||
239 | mpOutliner->SetModifyHdl( LINK( this, SwAnnotationWin, ModifyHdl )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubModifyHdl) ); | |||
240 | if (bTextUnchanged) | |||
241 | GetOutlinerView()->GetEditView().SetSelection(aOrigSelection); | |||
242 | if (bCursorVisible) | |||
243 | GetOutlinerView()->ShowCursor(); | |||
244 | Invalidate(); | |||
245 | } | |||
246 | ||||
247 | void SwAnnotationWin::SetResolved(bool resolved) | |||
248 | { | |||
249 | bool oldState = IsResolved(); | |||
250 | static_cast<SwPostItField*>(mpFormatField->GetField())->SetResolved(resolved); | |||
251 | const SwViewOption* pVOpt = mrView.GetWrtShellPtr()->GetViewOptions(); | |||
252 | mrSidebarItem.mbShow = !IsResolved() || (pVOpt->IsResolvedPostIts()); | |||
253 | ||||
254 | mpTextRangeOverlay.reset(); | |||
255 | ||||
256 | if(IsResolved()) | |||
257 | mpMetadataResolved->Show(); | |||
258 | else | |||
259 | mpMetadataResolved->Hide(); | |||
260 | ||||
261 | if(IsResolved() != oldState) | |||
262 | mbResolvedStateUpdated = true; | |||
263 | UpdateData(); | |||
264 | Invalidate(); | |||
265 | collectUIInformation("SETRESOLVED",get_id()); | |||
266 | } | |||
267 | ||||
268 | void SwAnnotationWin::ToggleResolved() | |||
269 | { | |||
270 | SetResolved(!IsResolved()); | |||
271 | } | |||
272 | ||||
273 | void SwAnnotationWin::ToggleResolvedForThread() | |||
274 | { | |||
275 | GetTopReplyNote()->ToggleResolved(); | |||
276 | mrMgr.UpdateResolvedStatus(GetTopReplyNote()); | |||
277 | mrMgr.LayoutPostIts(); | |||
278 | } | |||
279 | ||||
280 | void SwAnnotationWin::DeleteThread() | |||
281 | { | |||
282 | // Go to the top and delete each comment one by one | |||
283 | SwAnnotationWin *current, *topNote; | |||
284 | current = topNote = GetTopReplyNote(); | |||
285 | SwAnnotationWin* next = mrMgr.GetNextPostIt(KEY_PAGEDOWN, current); | |||
286 | ||||
287 | while(next && next->GetTopReplyNote() == topNote) | |||
288 | { | |||
289 | current->mnEventId = Application::PostUserEvent( LINK( current, SwAnnotationWin, DeleteHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(current), &SwAnnotationWin::LinkStubDeleteHdl), nullptr, true ); | |||
290 | current = next; | |||
291 | next = mrMgr.GetNextPostIt(KEY_PAGEDOWN, current); | |||
292 | } | |||
293 | current->mnEventId = Application::PostUserEvent( LINK( current, SwAnnotationWin, DeleteHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(current), &SwAnnotationWin::LinkStubDeleteHdl), nullptr, true ); | |||
294 | } | |||
295 | ||||
296 | bool SwAnnotationWin::IsResolved() const | |||
297 | { | |||
298 | return static_cast<SwPostItField*>(mpFormatField->GetField())->GetResolved(); | |||
299 | } | |||
300 | ||||
301 | bool SwAnnotationWin::IsThreadResolved() | |||
302 | { | |||
303 | /// First Get the top note | |||
304 | // then iterate downwards checking resolved status | |||
305 | SwAnnotationWin *pTopNote, *TopNote; | |||
306 | pTopNote = TopNote = GetTopReplyNote(); | |||
307 | if (!pTopNote->IsResolved()) | |||
308 | return false; | |||
309 | ||||
310 | SwAnnotationWin* pSidebarWin = mrMgr.GetNextPostIt(KEY_PAGEDOWN, pTopNote); | |||
311 | ||||
312 | while (pSidebarWin && pSidebarWin->GetTopReplyNote() == TopNote) | |||
313 | { | |||
314 | pTopNote = pSidebarWin; | |||
315 | if (!pTopNote->IsResolved()) | |||
316 | return false; | |||
317 | pSidebarWin = mrMgr.GetNextPostIt(KEY_PAGEDOWN, pSidebarWin); | |||
318 | } | |||
319 | return true; | |||
320 | } | |||
321 | ||||
322 | void SwAnnotationWin::UpdateData() | |||
323 | { | |||
324 | if ( mpOutliner->IsModified() || mbResolvedStateUpdated ) | |||
325 | { | |||
326 | IDocumentUndoRedo & rUndoRedo( | |||
327 | mrView.GetDocShell()->GetDoc()->GetIDocumentUndoRedo()); | |||
328 | std::unique_ptr<SwField> pOldField; | |||
329 | if (rUndoRedo.DoesUndo()) | |||
330 | { | |||
331 | pOldField = mpField->Copy(); | |||
332 | } | |||
333 | mpField->SetPar2(mpOutliner->GetEditEngine().GetText()); | |||
334 | mpField->SetTextObject(mpOutliner->CreateParaObject()); | |||
335 | if (rUndoRedo.DoesUndo()) | |||
336 | { | |||
337 | SwTextField *const pTextField = mpFormatField->GetTextField(); | |||
338 | SwPosition aPosition( pTextField->GetTextNode() ); | |||
339 | aPosition.nContent = pTextField->GetStart(); | |||
340 | rUndoRedo.AppendUndo( | |||
341 | std::make_unique<SwUndoFieldFromDoc>(aPosition, *pOldField, *mpField, nullptr, true)); | |||
342 | } | |||
343 | // so we get a new layout of notes (anchor position is still the same and we would otherwise not get one) | |||
344 | mrMgr.SetLayout(); | |||
345 | // #i98686# if we have several views, all notes should update their text | |||
346 | if(mbResolvedStateUpdated) | |||
347 | mpFormatField->Broadcast(SwFormatFieldHint( nullptr, SwFormatFieldHintWhich::RESOLVED)); | |||
348 | else | |||
349 | mpFormatField->Broadcast(SwFormatFieldHint( nullptr, SwFormatFieldHintWhich::CHANGED)); | |||
350 | mrView.GetDocShell()->SetModified(); | |||
351 | } | |||
352 | mpOutliner->ClearModifyFlag(); | |||
353 | mpOutliner->GetUndoManager().Clear(); | |||
354 | mbResolvedStateUpdated = false; | |||
355 | } | |||
356 | ||||
357 | void SwAnnotationWin::Delete() | |||
358 | { | |||
359 | collectUIInformation("DELETE",get_id()); | |||
360 | if (!mrView.GetWrtShellPtr()->GotoField(*mpFormatField)) | |||
361 | return; | |||
362 | ||||
363 | if ( mrMgr.GetActiveSidebarWin() == this) | |||
364 | { | |||
365 | mrMgr.SetActiveSidebarWin(nullptr); | |||
366 | // if the note is empty, the previous line will send a delete event, but we are already there | |||
367 | if (mnEventId) | |||
368 | { | |||
369 | Application::RemoveUserEvent( mnEventId ); | |||
370 | mnEventId = nullptr; | |||
371 | } | |||
372 | } | |||
373 | // we delete the field directly, the Mgr cleans up the PostIt by listening | |||
374 | GrabFocusToDocument(); | |||
375 | mrView.GetWrtShellPtr()->ClearMark(); | |||
376 | mrView.GetWrtShellPtr()->DelRight(); | |||
377 | } | |||
378 | ||||
379 | void SwAnnotationWin::GotoPos() | |||
380 | { | |||
381 | mrView.GetDocShell()->GetWrtShell()->GotoField(*mpFormatField); | |||
382 | } | |||
383 | ||||
384 | sal_uInt32 SwAnnotationWin::MoveCaret() | |||
385 | { | |||
386 | // if this is an answer, do not skip over all following ones, but insert directly behind the current one | |||
387 | // but when just leaving a note, skip all following ones as well to continue typing | |||
388 | return mrMgr.IsAnswer() | |||
389 | ? 1 | |||
390 | : 1 + CountFollowing(); | |||
391 | } | |||
392 | ||||
393 | // returns a non-zero postit parent id, if exists, otherwise 0 for root comments | |||
394 | sal_uInt32 SwAnnotationWin::CalcParent() | |||
395 | { | |||
396 | SwTextField* pTextField = mpFormatField->GetTextField(); | |||
397 | SwPosition aPosition( pTextField->GetTextNode() ); | |||
398 | aPosition.nContent = pTextField->GetStart(); | |||
399 | SwTextAttr * const pTextAttr = | |||
400 | pTextField->GetTextNode().GetTextAttrForCharAt( | |||
401 | aPosition.nContent.GetIndex() - 1, | |||
402 | RES_TXTATR_ANNOTATION ); | |||
403 | const SwField* pField = pTextAttr ? pTextAttr->GetFormatField().GetField() : nullptr; | |||
404 | sal_uInt32 nParentId = 0; | |||
405 | if (pField && pField->Which() == SwFieldIds::Postit) | |||
406 | { | |||
407 | const SwPostItField* pPostItField = static_cast<const SwPostItField*>(pField); | |||
408 | nParentId = pPostItField->GetPostItId(); | |||
409 | } | |||
410 | return nParentId; | |||
411 | } | |||
412 | ||||
413 | // counts how many SwPostItField we have right after the current one | |||
414 | sal_uInt32 SwAnnotationWin::CountFollowing() | |||
415 | { | |||
416 | sal_uInt32 aCount = 1; // we start with 1, so we have to subtract one at the end again | |||
417 | SwTextField* pTextField = mpFormatField->GetTextField(); | |||
418 | SwPosition aPosition( pTextField->GetTextNode() ); | |||
419 | aPosition.nContent = pTextField->GetStart(); | |||
420 | ||||
421 | SwTextAttr * pTextAttr = pTextField->GetTextNode().GetTextAttrForCharAt( | |||
422 | aPosition.nContent.GetIndex() + 1, | |||
423 | RES_TXTATR_ANNOTATION ); | |||
424 | SwField* pField = pTextAttr | |||
425 | ? const_cast<SwField*>(pTextAttr->GetFormatField().GetField()) | |||
426 | : nullptr; | |||
427 | while ( pField && ( pField->Which()== SwFieldIds::Postit ) ) | |||
428 | { | |||
429 | aCount++; | |||
430 | pTextAttr = pTextField->GetTextNode().GetTextAttrForCharAt( | |||
431 | aPosition.nContent.GetIndex() + aCount, | |||
432 | RES_TXTATR_ANNOTATION ); | |||
433 | pField = pTextAttr | |||
434 | ? const_cast<SwField*>(pTextAttr->GetFormatField().GetField()) | |||
435 | : nullptr; | |||
436 | } | |||
437 | return aCount - 1; | |||
438 | } | |||
439 | ||||
440 | VclPtr<MenuButton> SwAnnotationWin::CreateMenuButton() | |||
441 | { | |||
442 | mpButtonPopup = maBuilder.get_menu("menu"); | |||
443 | sal_uInt16 nByAuthorId = mpButtonPopup->GetItemId("deleteby"); | |||
444 | OUString aText = mpButtonPopup->GetItemText(nByAuthorId); | |||
445 | SwRewriter aRewriter; | |||
446 | aRewriter.AddRule(UndoArg1,GetAuthor()); | |||
447 | aText = aRewriter.Apply(aText); | |||
448 | mpButtonPopup->SetItemText(nByAuthorId, aText); | |||
449 | VclPtrInstance<AnnotationMenuButton> pMenuButton( *this ); | |||
450 | pMenuButton->SetPopupMenu( mpButtonPopup ); | |||
451 | pMenuButton->Show(); | |||
452 | return pMenuButton; | |||
453 | } | |||
454 | ||||
455 | void SwAnnotationWin::InitAnswer(OutlinerParaObject const * pText) | |||
456 | { | |||
457 | // If tiled annotations is off in lok case, skip adding additional reply text. | |||
458 | if (comphelper::LibreOfficeKit::isActive() && !comphelper::LibreOfficeKit::isTiledAnnotations()) | |||
459 | return; | |||
460 | ||||
461 | //collect our old meta data | |||
462 | SwAnnotationWin* pWin = mrMgr.GetNextPostIt(KEY_PAGEUP, this); | |||
463 | if (!pWin) | |||
464 | return; | |||
465 | ||||
466 | const SvtSysLocale aSysLocale; | |||
467 | const LocaleDataWrapper& rLocalData = aSysLocale.GetLocaleData(); | |||
468 | SwRewriter aRewriter; | |||
469 | aRewriter.AddRule(UndoArg1, pWin->GetAuthor()); | |||
470 | const OUString aText = aRewriter.Apply(SwResId(STR_REPLYreinterpret_cast<char const *>("STR_REPLY" "\004" u8"Reply to $1" ))) | |||
471 | + " (" + rLocalData.getDate( pWin->GetDate()) | |||
472 | + ", " + rLocalData.getTime( pWin->GetTime(), false) | |||
473 | + "): \""; | |||
474 | GetOutlinerView()->InsertText(aText); | |||
475 | ||||
476 | // insert old, selected text or "..." | |||
477 | // TODO: iterate over all paragraphs, not only first one to find out if it is empty | |||
478 | if (!pText->GetTextObject().GetText(0).isEmpty()) | |||
479 | GetOutlinerView()->GetEditView().InsertText(pText->GetTextObject()); | |||
480 | else | |||
481 | GetOutlinerView()->InsertText("..."); | |||
482 | GetOutlinerView()->InsertText("\"\n"); | |||
483 | ||||
484 | GetOutlinerView()->SetSelection(ESelection(0,0,EE_PARA_ALL((sal_Int32) 0x7FFFFFFF),EE_TEXTPOS_ALL((sal_Int32) 0x7FFFFFFF))); | |||
485 | SfxItemSet aAnswerSet( mrView.GetDocShell()->GetPool() ); | |||
486 | aAnswerSet.Put(SvxFontHeightItem(200,80,EE_CHAR_FONTHEIGHT)); | |||
487 | aAnswerSet.Put(SvxPostureItem(ITALIC_NORMAL,EE_CHAR_ITALIC)); | |||
488 | GetOutlinerView()->SetAttribs(aAnswerSet); | |||
489 | GetOutlinerView()->SetSelection(ESelection(EE_PARA_MAX_COUNT((sal_Int32) 0x7FFFFFFF),EE_TEXTPOS_MAX_COUNT((sal_Int32) 0x7FFFFFFF),EE_PARA_MAX_COUNT((sal_Int32) 0x7FFFFFFF),EE_TEXTPOS_MAX_COUNT((sal_Int32) 0x7FFFFFFF))); | |||
490 | ||||
491 | //remove all attributes and reset our standard ones | |||
492 | GetOutlinerView()->GetEditView().RemoveAttribsKeepLanguages(true); | |||
493 | GetOutlinerView()->SetAttribs(DefaultItem()); | |||
494 | // lets insert an undo step so the initial text can be easily deleted | |||
495 | // but do not use UpdateData() directly, would set modified state again and reentrance into Mgr | |||
496 | mpOutliner->SetModifyHdl( Link<LinkParamNone*,void>() ); | |||
497 | IDocumentUndoRedo & rUndoRedo( | |||
498 | mrView.GetDocShell()->GetDoc()->GetIDocumentUndoRedo()); | |||
499 | std::unique_ptr<SwField> pOldField; | |||
500 | if (rUndoRedo.DoesUndo()) | |||
501 | { | |||
502 | pOldField = mpField->Copy(); | |||
503 | } | |||
504 | mpField->SetPar2(mpOutliner->GetEditEngine().GetText()); | |||
505 | mpField->SetTextObject(mpOutliner->CreateParaObject()); | |||
506 | if (rUndoRedo.DoesUndo()) | |||
507 | { | |||
508 | SwTextField *const pTextField = mpFormatField->GetTextField(); | |||
509 | SwPosition aPosition( pTextField->GetTextNode() ); | |||
510 | aPosition.nContent = pTextField->GetStart(); | |||
511 | rUndoRedo.AppendUndo( | |||
512 | std::make_unique<SwUndoFieldFromDoc>(aPosition, *pOldField, *mpField, nullptr, true)); | |||
513 | } | |||
514 | mpOutliner->SetModifyHdl( LINK( this, SwAnnotationWin, ModifyHdl )::tools::detail::makeLink( ::tools::detail::castTo<SwAnnotationWin *>(this), &SwAnnotationWin::LinkStubModifyHdl) ); | |||
515 | mpOutliner->ClearModifyFlag(); | |||
516 | mpOutliner->GetUndoManager().Clear(); | |||
517 | } | |||
518 | ||||
519 | void SwAnnotationWin::UpdateText(const OUString& aText) | |||
520 | { | |||
521 | mpOutliner->Clear(); | |||
522 | GetOutlinerView()->InsertText(aText); | |||
523 | UpdateData(); | |||
524 | } | |||
525 | ||||
526 | SvxLanguageItem SwAnnotationWin::GetLanguage() const | |||
527 | { | |||
528 | // set initial language for outliner | |||
529 | SvtScriptType nScriptType = SvtLanguageOptions::GetScriptTypeOfLanguage( mpField->GetLanguage() ); | |||
530 | sal_uInt16 nLangWhichId = 0; | |||
531 | switch (nScriptType) | |||
532 | { | |||
533 | case SvtScriptType::LATIN : nLangWhichId = EE_CHAR_LANGUAGE ; break; | |||
534 | case SvtScriptType::ASIAN : nLangWhichId = EE_CHAR_LANGUAGE_CJK; break; | |||
535 | case SvtScriptType::COMPLEX : nLangWhichId = EE_CHAR_LANGUAGE_CTL; break; | |||
536 | default: OSL_FAIL("GetLanguage: wrong script type")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/docvw/AnnotationWin.cxx" ":" "536" ": "), "%s", "GetLanguage: wrong script type"); } } while (false); | |||
537 | } | |||
538 | return SvxLanguageItem(mpField->GetLanguage(),nLangWhichId); | |||
539 | } | |||
540 | ||||
541 | bool SwAnnotationWin::IsProtected() const | |||
542 | { | |||
543 | return mbReadonly || | |||
544 | GetLayoutStatus() == SwPostItHelper::DELETED || | |||
545 | ( mpFormatField && mpFormatField->IsProtect() ); | |||
546 | } | |||
547 | ||||
548 | OUString SwAnnotationWin::GetAuthor() const | |||
549 | { | |||
550 | return mpField->GetPar1(); | |||
551 | } | |||
552 | ||||
553 | Date SwAnnotationWin::GetDate() const | |||
554 | { | |||
555 | return mpField->GetDate(); | |||
556 | } | |||
557 | ||||
558 | tools::Time SwAnnotationWin::GetTime() const | |||
559 | { | |||
560 | return mpField->GetTime(); | |||
561 | } | |||
562 | ||||
563 | FactoryFunction SwAnnotationWin::GetUITestFactory() const | |||
564 | { | |||
565 | return CommentUIObject::create; | |||
566 | } | |||
567 | ||||
568 | } // end of namespace sw::annotation | |||
569 | ||||
570 | /* 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 |