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 <string.h> | ||||||||
21 | |||||||||
22 | #include <vcl/window.hxx> | ||||||||
23 | |||||||||
24 | #include <wrtsh.hxx> | ||||||||
25 | #include <doc.hxx> | ||||||||
26 | #include <docary.hxx> | ||||||||
27 | #include <charfmt.hxx> | ||||||||
28 | |||||||||
29 | #include <sfx2/bindings.hxx> | ||||||||
30 | #include <sfx2/request.hxx> | ||||||||
31 | #include <sfx2/sfxdlg.hxx> | ||||||||
32 | #include <sfx2/viewfrm.hxx> | ||||||||
33 | #include <editeng/eeitem.hxx> | ||||||||
34 | #include <editeng/editeng.hxx> | ||||||||
35 | #include <editeng/editdata.hxx> | ||||||||
36 | #include <editeng/outliner.hxx> | ||||||||
37 | #include <editeng/editview.hxx> | ||||||||
38 | #include <editeng/langitem.hxx> | ||||||||
39 | |||||||||
40 | #include <svl/languageoptions.hxx> | ||||||||
41 | #include <svtools/langtab.hxx> | ||||||||
42 | #include <svl/slstitm.hxx> | ||||||||
43 | #include <svl/stritem.hxx> | ||||||||
44 | #include <svx/svxids.hrc> | ||||||||
45 | |||||||||
46 | #include <ndtxt.hxx> | ||||||||
47 | #include <pam.hxx> | ||||||||
48 | #include <view.hxx> | ||||||||
49 | #include <viewopt.hxx> | ||||||||
50 | |||||||||
51 | #include <langhelper.hxx> | ||||||||
52 | #include <memory> | ||||||||
53 | |||||||||
54 | using namespace ::com::sun::star; | ||||||||
55 | |||||||||
56 | namespace SwLangHelper | ||||||||
57 | { | ||||||||
58 | |||||||||
59 | void GetLanguageStatus( OutlinerView* pOLV, SfxItemSet& rSet ) | ||||||||
60 | { | ||||||||
61 | ESelection aSelection = pOLV->GetSelection(); | ||||||||
62 | EditView& rEditView=pOLV->GetEditView(); | ||||||||
63 | EditEngine* pEditEngine=rEditView.GetEditEngine(); | ||||||||
64 | |||||||||
65 | // the value of used script types | ||||||||
66 | const SvtScriptType nScriptType =pOLV->GetSelectedScriptType(); | ||||||||
67 | OUString aScriptTypesInUse( OUString::number( static_cast<int>(nScriptType) ) );//pEditEngine->GetScriptType(aSelection) | ||||||||
68 | |||||||||
69 | // get keyboard language | ||||||||
70 | OUString aKeyboardLang; | ||||||||
71 | LanguageType nLang = LANGUAGE_DONTKNOWLanguageType(0x03FF); | ||||||||
72 | |||||||||
73 | vcl::Window* pWin = rEditView.GetWindow(); | ||||||||
74 | if(pWin) | ||||||||
75 | nLang = pWin->GetInputLanguage(); | ||||||||
76 | if (nLang != LANGUAGE_DONTKNOWLanguageType(0x03FF) && nLang != LANGUAGE_SYSTEMLanguageType(0x0000)) | ||||||||
77 | aKeyboardLang = SvtLanguageTable::GetLanguageString( nLang ); | ||||||||
78 | |||||||||
79 | // get the language that is in use | ||||||||
80 | OUString aCurrentLang("*"); | ||||||||
81 | SfxItemSet aSet(pOLV->GetAttribs()); | ||||||||
82 | nLang = SwLangHelper::GetCurrentLanguage( aSet,nScriptType ); | ||||||||
83 | if (nLang != LANGUAGE_DONTKNOWLanguageType(0x03FF)) | ||||||||
84 | aCurrentLang = SvtLanguageTable::GetLanguageString( nLang ); | ||||||||
85 | |||||||||
86 | // build sequence for status value | ||||||||
87 | uno::Sequence< OUString > aSeq( 4 ); | ||||||||
88 | aSeq[0] = aCurrentLang; | ||||||||
89 | aSeq[1] = aScriptTypesInUse; | ||||||||
90 | aSeq[2] = aKeyboardLang; | ||||||||
91 | aSeq[3] = SwLangHelper::GetTextForLanguageGuessing( pEditEngine, aSelection ); | ||||||||
92 | |||||||||
93 | // set sequence as status value | ||||||||
94 | SfxStringListItem aItem( SID_LANGUAGE_STATUS( 10000 + 1067 ) ); | ||||||||
95 | aItem.SetStringList( aSeq ); | ||||||||
96 | rSet.Put( aItem ); | ||||||||
97 | } | ||||||||
98 | |||||||||
99 | bool SetLanguageStatus( OutlinerView* pOLV, SfxRequest &rReq, SwView const &rView, SwWrtShell &rSh ) | ||||||||
100 | { | ||||||||
101 | bool bRestoreSelection = false; | ||||||||
102 | SfxItemSet aEditAttr(pOLV->GetAttribs()); | ||||||||
103 | ESelection aSelection = pOLV->GetSelection(); | ||||||||
104 | EditView & rEditView = pOLV->GetEditView(); | ||||||||
105 | EditEngine * pEditEngine = rEditView.GetEditEngine(); | ||||||||
106 | |||||||||
107 | // get the language | ||||||||
108 | OUString aNewLangText; | ||||||||
109 | |||||||||
110 | const SfxStringItem* pItem = rReq.GetArg<SfxStringItem>(SID_LANGUAGE_STATUS( 10000 + 1067 )); | ||||||||
111 | if (pItem
| ||||||||
| |||||||||
112 | aNewLangText = pItem->GetValue(); | ||||||||
113 | |||||||||
114 | //!! Remember the view frame right now... | ||||||||
115 | //!! (call to GetView().GetViewFrame() will break if the | ||||||||
116 | //!! SwTextShell got destroyed meanwhile.) | ||||||||
117 | SfxViewFrame *pViewFrame = rView.GetViewFrame(); | ||||||||
118 | |||||||||
119 | if (aNewLangText == "*" ) | ||||||||
120 | { | ||||||||
121 | // open the dialog "Tools/Options/Language Settings - Language" | ||||||||
122 | SfxAbstractDialogFactory* pFact = SfxAbstractDialogFactory::Create(); | ||||||||
123 | ScopedVclPtr<VclAbstractDialog> pDlg(pFact->CreateVclDialog( rView.GetFrameWeld(), SID_LANGUAGE_OPTIONS( 10000 + 921 ) )); | ||||||||
124 | pDlg->Execute(); | ||||||||
125 | } | ||||||||
126 | else | ||||||||
127 | { | ||||||||
128 | // setting the new language... | ||||||||
129 | if (!aNewLangText.isEmpty()) | ||||||||
130 | { | ||||||||
131 | const OUString aSelectionLangPrefix("Current_"); | ||||||||
132 | const OUString aParagraphLangPrefix("Paragraph_"); | ||||||||
133 | const OUString aDocumentLangPrefix("Default_"); | ||||||||
134 | |||||||||
135 | sal_Int32 nPos = 0; | ||||||||
136 | bool bForSelection = true; | ||||||||
137 | bool bForParagraph = false; | ||||||||
138 | if (-1 != (nPos = aNewLangText.indexOf( aSelectionLangPrefix ))) | ||||||||
139 | { | ||||||||
140 | // ... for the current selection | ||||||||
141 | aNewLangText = aNewLangText.replaceAt(nPos, aSelectionLangPrefix.getLength(), ""); | ||||||||
142 | bForSelection = true; | ||||||||
143 | } | ||||||||
144 | else if (-1 != (nPos = aNewLangText.indexOf( aParagraphLangPrefix ))) | ||||||||
145 | { | ||||||||
146 | // ... for the current paragraph language | ||||||||
147 | aNewLangText = aNewLangText.replaceAt(nPos, aParagraphLangPrefix.getLength(), ""); | ||||||||
148 | bForSelection = true; | ||||||||
149 | bForParagraph = true; | ||||||||
150 | } | ||||||||
151 | else if (-1 != (nPos = aNewLangText.indexOf( aDocumentLangPrefix ))) | ||||||||
152 | { | ||||||||
153 | // ... as default document language | ||||||||
154 | aNewLangText = aNewLangText.replaceAt(nPos, aDocumentLangPrefix.getLength(), ""); | ||||||||
155 | bForSelection = false; | ||||||||
156 | } | ||||||||
157 | |||||||||
158 | if (bForParagraph) | ||||||||
159 | { | ||||||||
160 | bRestoreSelection = true; | ||||||||
161 | SwLangHelper::SelectPara( rEditView, aSelection ); | ||||||||
162 | aSelection = pOLV->GetSelection(); | ||||||||
163 | } | ||||||||
164 | if (!bForSelection) // document language to be changed... | ||||||||
165 | { | ||||||||
166 | rSh.StartAction(); | ||||||||
167 | rSh.LockView( true ); | ||||||||
168 | rSh.Push(); | ||||||||
169 | |||||||||
170 | // prepare to apply new language to all text in document | ||||||||
171 | rSh.SelAll(); | ||||||||
172 | rSh.ExtendedSelectAll(); | ||||||||
173 | } | ||||||||
174 | |||||||||
175 | if (aNewLangText == "LANGUAGE_NONE") | ||||||||
176 | SwLangHelper::SetLanguage_None( rSh, pOLV, aSelection, bForSelection, aEditAttr ); | ||||||||
177 | else if (aNewLangText == "RESET_LANGUAGES") | ||||||||
178 | SwLangHelper::ResetLanguages( rSh, pOLV ); | ||||||||
179 | else | ||||||||
180 | SwLangHelper::SetLanguage( rSh, pOLV, aSelection, aNewLangText, bForSelection, aEditAttr ); | ||||||||
181 | |||||||||
182 | // ugly hack, as it seems that EditView/EditEngine does not update their spellchecking marks | ||||||||
183 | // when setting a new language attribute | ||||||||
184 | if (bForSelection) | ||||||||
185 | { | ||||||||
186 | const SwViewOption* pVOpt = rView.GetWrtShellPtr()->GetViewOptions(); | ||||||||
187 | EEControlBits nCntrl = pEditEngine->GetControlWord(); | ||||||||
188 | // turn off | ||||||||
189 | nCntrl &= ~EEControlBits::ONLINESPELLING; | ||||||||
190 | pEditEngine->SetControlWord(nCntrl); | ||||||||
191 | |||||||||
192 | //turn back on | ||||||||
193 | if (pVOpt->IsOnlineSpell()) | ||||||||
194 | nCntrl |= EEControlBits::ONLINESPELLING; | ||||||||
195 | else | ||||||||
196 | nCntrl &= ~EEControlBits::ONLINESPELLING; | ||||||||
197 | pEditEngine->SetControlWord(nCntrl); | ||||||||
198 | |||||||||
199 | pEditEngine->CompleteOnlineSpelling(); | ||||||||
200 | rEditView.Invalidate(); | ||||||||
201 | } | ||||||||
202 | |||||||||
203 | if (!bForSelection) | ||||||||
204 | { | ||||||||
205 | // need to release view and restore selection... | ||||||||
206 | rSh.Pop(SwCursorShell::PopMode::DeleteCurrent); | ||||||||
207 | rSh.LockView( false ); | ||||||||
208 | rSh.EndAction(); | ||||||||
209 | } | ||||||||
210 | } | ||||||||
211 | } | ||||||||
212 | |||||||||
213 | // invalidate slot to get the new language displayed | ||||||||
214 | pViewFrame->GetBindings().Invalidate( rReq.GetSlot() ); | ||||||||
215 | |||||||||
216 | rReq.Done(); | ||||||||
217 | return bRestoreSelection; | ||||||||
218 | } | ||||||||
219 | |||||||||
220 | void SetLanguage( SwWrtShell &rWrtSh, const OUString &rLangText, bool bIsForSelection, SfxItemSet &rCoreSet ) | ||||||||
221 | { | ||||||||
222 | SetLanguage( rWrtSh, nullptr , ESelection(), rLangText, bIsForSelection, rCoreSet ); | ||||||||
223 | } | ||||||||
224 | |||||||||
225 | void SetLanguage( SwWrtShell &rWrtSh, OutlinerView const * pOLV, const ESelection& rSelection, const OUString &rLangText, bool bIsForSelection, SfxItemSet &rCoreSet ) | ||||||||
226 | { | ||||||||
227 | const LanguageType nLang = SvtLanguageTable::GetLanguageType( rLangText ); | ||||||||
228 | if (nLang == LANGUAGE_DONTKNOWLanguageType(0x03FF)) | ||||||||
229 | return; | ||||||||
230 | |||||||||
231 | EditEngine* pEditEngine = pOLV ? pOLV->GetEditView().GetEditEngine() : nullptr; | ||||||||
232 | OSL_ENSURE( !pOLV || pEditEngine, "OutlinerView without EditEngine???" )do { if (true && (!(!pOLV || pEditEngine))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/langhelper.cxx" ":" "232" ": "), "%s", "OutlinerView without EditEngine???") ; } } while (false); | ||||||||
233 | |||||||||
234 | //get ScriptType | ||||||||
235 | sal_uInt16 nLangWhichId = 0; | ||||||||
236 | bool bIsSingleScriptType = true; | ||||||||
237 | switch (SvtLanguageOptions::GetScriptTypeOfLanguage( nLang )) | ||||||||
238 | { | ||||||||
239 | case SvtScriptType::LATIN : nLangWhichId = pEditEngine ? sal_uInt16(EE_CHAR_LANGUAGE) : sal_uInt16(RES_CHRATR_LANGUAGE); break; | ||||||||
240 | case SvtScriptType::ASIAN : nLangWhichId = pEditEngine ? sal_uInt16(EE_CHAR_LANGUAGE_CJK) : sal_uInt16(RES_CHRATR_CJK_LANGUAGE); break; | ||||||||
241 | case SvtScriptType::COMPLEX : nLangWhichId = pEditEngine ? sal_uInt16(EE_CHAR_LANGUAGE_CTL) : sal_uInt16(RES_CHRATR_CTL_LANGUAGE); break; | ||||||||
242 | default: | ||||||||
243 | bIsSingleScriptType = false; | ||||||||
244 | OSL_FAIL("unexpected case" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/langhelper.cxx" ":" "244" ": "), "%s", "unexpected case"); } } while (false); | ||||||||
245 | } | ||||||||
246 | if (!bIsSingleScriptType) | ||||||||
247 | return; | ||||||||
248 | |||||||||
249 | // change language for selection or paragraph | ||||||||
250 | // (for paragraph is handled by previously having set the selection to the | ||||||||
251 | // whole paragraph) | ||||||||
252 | if (bIsForSelection) | ||||||||
253 | { | ||||||||
254 | // apply language to current selection | ||||||||
255 | if (pEditEngine) | ||||||||
256 | { | ||||||||
257 | rCoreSet.Put( SvxLanguageItem( nLang, nLangWhichId )); | ||||||||
258 | pEditEngine->QuickSetAttribs(rCoreSet, rSelection); | ||||||||
259 | } | ||||||||
260 | else | ||||||||
261 | { | ||||||||
262 | rWrtSh.GetCurAttr( rCoreSet ); | ||||||||
263 | rCoreSet.Put( SvxLanguageItem( nLang, nLangWhichId )); | ||||||||
264 | rWrtSh.SetAttrSet( rCoreSet ); | ||||||||
265 | } | ||||||||
266 | } | ||||||||
267 | else // change language for all text | ||||||||
268 | { | ||||||||
269 | // set document default language | ||||||||
270 | switch (nLangWhichId) | ||||||||
271 | { | ||||||||
272 | case EE_CHAR_LANGUAGE : nLangWhichId = RES_CHRATR_LANGUAGE; break; | ||||||||
273 | case EE_CHAR_LANGUAGE_CJK : nLangWhichId = RES_CHRATR_CJK_LANGUAGE; break; | ||||||||
274 | case EE_CHAR_LANGUAGE_CTL : nLangWhichId = RES_CHRATR_CTL_LANGUAGE; break; | ||||||||
275 | } | ||||||||
276 | //Set the default document language | ||||||||
277 | rWrtSh.SetDefault( SvxLanguageItem( nLang, nLangWhichId ) ); | ||||||||
278 | |||||||||
279 | //Resolves: fdo#35282 Clear the language from all Text Styles, and | ||||||||
280 | //fallback to default document language | ||||||||
281 | const SwTextFormatColls *pColls = rWrtSh.GetDoc()->GetTextFormatColls(); | ||||||||
282 | for(size_t i = 0, nCount = pColls->size(); i < nCount; ++i) | ||||||||
283 | { | ||||||||
284 | SwTextFormatColl &rTextColl = *(*pColls)[ i ]; | ||||||||
285 | rTextColl.ResetFormatAttr(nLangWhichId); | ||||||||
286 | } | ||||||||
287 | //Resolves: fdo#35282 Clear the language from all Character Styles, | ||||||||
288 | //and fallback to default document language | ||||||||
289 | const SwCharFormats *pCharFormats = rWrtSh.GetDoc()->GetCharFormats(); | ||||||||
290 | for(size_t i = 0, nCount = pCharFormats->size(); i < nCount; ++i) | ||||||||
291 | { | ||||||||
292 | SwCharFormat &rCharFormat = *(*pCharFormats)[ i ]; | ||||||||
293 | rCharFormat.ResetFormatAttr(nLangWhichId); | ||||||||
294 | } | ||||||||
295 | |||||||||
296 | // #i102191: hard set respective language attribute in text document | ||||||||
297 | // (for all text in the document - which should be selected by now...) | ||||||||
298 | rWrtSh.SetAttrItem( SvxLanguageItem( nLang, nLangWhichId ) ); | ||||||||
299 | } | ||||||||
300 | } | ||||||||
301 | |||||||||
302 | void SetLanguage_None( SwWrtShell &rWrtSh, bool bIsForSelection, SfxItemSet &rCoreSet ) | ||||||||
303 | { | ||||||||
304 | SetLanguage_None( rWrtSh,nullptr,ESelection(),bIsForSelection,rCoreSet ); | ||||||||
305 | } | ||||||||
306 | |||||||||
307 | void SetLanguage_None( SwWrtShell &rWrtSh, OutlinerView const * pOLV, const ESelection& rSelection, bool bIsForSelection, SfxItemSet &rCoreSet ) | ||||||||
308 | { | ||||||||
309 | // EditEngine IDs | ||||||||
310 | const sal_uInt16 aLangWhichId_EE[3] = | ||||||||
311 | { | ||||||||
312 | EE_CHAR_LANGUAGE, | ||||||||
313 | EE_CHAR_LANGUAGE_CJK, | ||||||||
314 | EE_CHAR_LANGUAGE_CTL | ||||||||
315 | }; | ||||||||
316 | |||||||||
317 | // Writer IDs | ||||||||
318 | const sal_uInt16 aLangWhichId_Writer[3] = | ||||||||
319 | { | ||||||||
320 | RES_CHRATR_LANGUAGE, | ||||||||
321 | RES_CHRATR_CJK_LANGUAGE, | ||||||||
322 | RES_CHRATR_CTL_LANGUAGE | ||||||||
323 | }; | ||||||||
324 | |||||||||
325 | if (bIsForSelection) | ||||||||
326 | { | ||||||||
327 | // change language for selection or paragraph | ||||||||
328 | // (for paragraph is handled by previously having set the selection to the | ||||||||
329 | // whole paragraph) | ||||||||
330 | |||||||||
331 | EditEngine* pEditEngine = pOLV ? pOLV->GetEditView().GetEditEngine() : nullptr; | ||||||||
332 | OSL_ENSURE( !pOLV || pEditEngine, "OutlinerView without EditEngine???" )do { if (true && (!(!pOLV || pEditEngine))) { sal_detail_logFormat ((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/langhelper.cxx" ":" "332" ": "), "%s", "OutlinerView without EditEngine???") ; } } while (false); | ||||||||
333 | if (pEditEngine) | ||||||||
334 | { | ||||||||
335 | for (sal_uInt16 i : aLangWhichId_EE) | ||||||||
336 | rCoreSet.Put( SvxLanguageItem( LANGUAGE_NONELanguageType(0x00FF), i )); | ||||||||
337 | pEditEngine->QuickSetAttribs(rCoreSet, rSelection); | ||||||||
338 | } | ||||||||
339 | else | ||||||||
340 | { | ||||||||
341 | rWrtSh.GetCurAttr( rCoreSet ); | ||||||||
342 | for (sal_uInt16 i : aLangWhichId_Writer) | ||||||||
343 | rCoreSet.Put( SvxLanguageItem( LANGUAGE_NONELanguageType(0x00FF), i )); | ||||||||
344 | rWrtSh.SetAttrSet( rCoreSet ); | ||||||||
345 | } | ||||||||
346 | } | ||||||||
347 | else // change language for all text | ||||||||
348 | { | ||||||||
349 | std::set<sal_uInt16> aAttribs; | ||||||||
350 | for (sal_uInt16 i : aLangWhichId_Writer) | ||||||||
351 | { | ||||||||
352 | rWrtSh.SetDefault( SvxLanguageItem( LANGUAGE_NONELanguageType(0x00FF), i ) ); | ||||||||
353 | aAttribs.insert( i ); | ||||||||
354 | } | ||||||||
355 | |||||||||
356 | // set all language attributes to default | ||||||||
357 | // (for all text in the document - which should be selected by now...) | ||||||||
358 | rWrtSh.ResetAttr( aAttribs ); | ||||||||
359 | } | ||||||||
360 | } | ||||||||
361 | |||||||||
362 | void ResetLanguages( SwWrtShell &rWrtSh, OutlinerView const * pOLV ) | ||||||||
363 | { | ||||||||
364 | // reset language for current selection. | ||||||||
365 | // The selection should already have been expanded to the whole paragraph or | ||||||||
366 | // to all text in the document if those are the ranges where to reset | ||||||||
367 | // the language attributes | ||||||||
368 | |||||||||
369 | if (pOLV) | ||||||||
370 | { | ||||||||
371 | EditView &rEditView = pOLV->GetEditView(); | ||||||||
372 | rEditView.RemoveAttribs( true, EE_CHAR_LANGUAGE ); | ||||||||
373 | rEditView.RemoveAttribs( true, EE_CHAR_LANGUAGE_CJK ); | ||||||||
374 | rEditView.RemoveAttribs( true, EE_CHAR_LANGUAGE_CTL ); | ||||||||
375 | } | ||||||||
376 | else | ||||||||
377 | { | ||||||||
378 | std::set<sal_uInt16> aAttribs; | ||||||||
379 | aAttribs.insert( RES_CHRATR_LANGUAGE ); | ||||||||
380 | aAttribs.insert( RES_CHRATR_CJK_LANGUAGE ); | ||||||||
381 | aAttribs.insert( RES_CHRATR_CTL_LANGUAGE ); | ||||||||
382 | rWrtSh.ResetAttr( aAttribs ); | ||||||||
383 | } | ||||||||
384 | } | ||||||||
385 | |||||||||
386 | /// @returns : the language for the selected text that is set for the | ||||||||
387 | /// specified attribute (script type). | ||||||||
388 | /// If there are more than one languages used LANGUAGE_DONTKNOW will be returned. | ||||||||
389 | /// @param nLangWhichId : one of | ||||||||
390 | /// RES_CHRATR_LANGUAGE, RES_CHRATR_CJK_LANGUAGE, RES_CHRATR_CTL_LANGUAGE, | ||||||||
391 | LanguageType GetLanguage( SwWrtShell &rSh, sal_uInt16 nLangWhichId ) | ||||||||
392 | { | ||||||||
393 | SfxItemSet aSet( rSh.GetAttrPool(), {{nLangWhichId, nLangWhichId}} ); | ||||||||
394 | rSh.GetCurAttr( aSet ); | ||||||||
395 | |||||||||
396 | return GetLanguage(aSet,nLangWhichId); | ||||||||
397 | } | ||||||||
398 | |||||||||
399 | LanguageType GetLanguage( SfxItemSet const & aSet, sal_uInt16 nLangWhichId ) | ||||||||
400 | { | ||||||||
401 | |||||||||
402 | LanguageType nLang = LANGUAGE_SYSTEMLanguageType(0x0000); | ||||||||
403 | |||||||||
404 | const SfxPoolItem *pItem = nullptr; | ||||||||
405 | SfxItemState nState = aSet.GetItemState( nLangWhichId, true, &pItem ); | ||||||||
406 | if (nState > SfxItemState::DEFAULT && pItem) | ||||||||
407 | { | ||||||||
408 | // the item is set and can be used | ||||||||
409 | nLang = dynamic_cast<const SvxLanguageItem&>(*pItem).GetLanguage(); | ||||||||
410 | } | ||||||||
411 | else if (nState == SfxItemState::DEFAULT) | ||||||||
412 | { | ||||||||
413 | // since the attribute is not set: retrieve the default value | ||||||||
414 | nLang = dynamic_cast<const SvxLanguageItem&>(aSet.GetPool()->GetDefaultItem( nLangWhichId )).GetLanguage(); | ||||||||
415 | } | ||||||||
416 | else if (nState == SfxItemState::DONTCARE) | ||||||||
417 | { | ||||||||
418 | // there is more than one language... | ||||||||
419 | nLang = LANGUAGE_DONTKNOWLanguageType(0x03FF); | ||||||||
420 | } | ||||||||
421 | OSL_ENSURE( nLang != LANGUAGE_SYSTEM, "failed to get the language?" )do { if (true && (!(nLang != LanguageType(0x0000)))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl" ), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/langhelper.cxx" ":" "421" ": "), "%s", "failed to get the language?"); } } while (false); | ||||||||
422 | |||||||||
423 | return nLang; | ||||||||
424 | } | ||||||||
425 | |||||||||
426 | /// @returns: the language in use for the selected text. | ||||||||
427 | /// 'In use' means the language(s) matching the script type(s) of the | ||||||||
428 | /// selected text. Or in other words, the language a spell checker would use. | ||||||||
429 | /// If there is more than one language LANGUAGE_DONTKNOW will be returned. | ||||||||
430 | LanguageType GetCurrentLanguage( SwWrtShell &rSh ) | ||||||||
431 | { | ||||||||
432 | //set language attribute to use according to the script type | ||||||||
433 | sal_uInt16 nLangWhichId = 0; | ||||||||
434 | bool bIsSingleScriptType = true; | ||||||||
435 | switch (rSh.GetScriptType()) | ||||||||
436 | { | ||||||||
437 | case SvtScriptType::LATIN : nLangWhichId = RES_CHRATR_LANGUAGE; break; | ||||||||
438 | case SvtScriptType::ASIAN : nLangWhichId = RES_CHRATR_CJK_LANGUAGE; break; | ||||||||
439 | case SvtScriptType::COMPLEX : nLangWhichId = RES_CHRATR_CTL_LANGUAGE; break; | ||||||||
440 | default: bIsSingleScriptType = false; break; | ||||||||
441 | } | ||||||||
442 | |||||||||
443 | // get language according to the script type(s) in use | ||||||||
444 | LanguageType nCurrentLang = LANGUAGE_SYSTEMLanguageType(0x0000); | ||||||||
445 | if (bIsSingleScriptType) | ||||||||
446 | nCurrentLang = GetLanguage( rSh, nLangWhichId ); | ||||||||
447 | else | ||||||||
448 | { | ||||||||
449 | // check if all script types are set to LANGUAGE_NONE and return | ||||||||
450 | // that if this is the case. Otherwise, having multiple script types | ||||||||
451 | // in use always means there are several languages in use... | ||||||||
452 | const sal_uInt16 aScriptTypes[3] = | ||||||||
453 | { | ||||||||
454 | RES_CHRATR_LANGUAGE, | ||||||||
455 | RES_CHRATR_CJK_LANGUAGE, | ||||||||
456 | RES_CHRATR_CTL_LANGUAGE | ||||||||
457 | }; | ||||||||
458 | nCurrentLang = LANGUAGE_NONELanguageType(0x00FF); | ||||||||
459 | for (sal_uInt16 aScriptType : aScriptTypes) | ||||||||
460 | { | ||||||||
461 | LanguageType nTmpLang = GetLanguage( rSh, aScriptType ); | ||||||||
462 | if (nTmpLang != LANGUAGE_NONELanguageType(0x00FF)) | ||||||||
463 | { | ||||||||
464 | nCurrentLang = LANGUAGE_DONTKNOWLanguageType(0x03FF); | ||||||||
465 | break; | ||||||||
466 | } | ||||||||
467 | } | ||||||||
468 | } | ||||||||
469 | OSL_ENSURE( nCurrentLang != LANGUAGE_SYSTEM, "failed to get the language?" )do { if (true && (!(nCurrentLang != LanguageType(0x0000 )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl" ), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/langhelper.cxx" ":" "469" ": "), "%s", "failed to get the language?"); } } while (false); | ||||||||
470 | |||||||||
471 | return nCurrentLang; | ||||||||
472 | } | ||||||||
473 | |||||||||
474 | /// @returns: the language in use for the selected text. | ||||||||
475 | /// 'In use' means the language(s) matching the script type(s) of the | ||||||||
476 | /// selected text. Or in other words, the language a spell checker would use. | ||||||||
477 | /// If there is more than one language LANGUAGE_DONTKNOW will be returned. | ||||||||
478 | LanguageType GetCurrentLanguage( SfxItemSet const & aSet, SvtScriptType nScriptType ) | ||||||||
479 | { | ||||||||
480 | //set language attribute to use according to the script type | ||||||||
481 | sal_uInt16 nLangWhichId = 0; | ||||||||
482 | bool bIsSingleScriptType = true; | ||||||||
483 | switch (nScriptType) | ||||||||
484 | { | ||||||||
485 | case SvtScriptType::LATIN : nLangWhichId = EE_CHAR_LANGUAGE; break; | ||||||||
486 | case SvtScriptType::ASIAN : nLangWhichId = EE_CHAR_LANGUAGE_CJK; break; | ||||||||
487 | case SvtScriptType::COMPLEX : nLangWhichId = EE_CHAR_LANGUAGE_CTL; break; | ||||||||
488 | default: bIsSingleScriptType = false; | ||||||||
489 | } | ||||||||
490 | |||||||||
491 | // get language according to the script type(s) in use | ||||||||
492 | LanguageType nCurrentLang = LANGUAGE_SYSTEMLanguageType(0x0000); | ||||||||
493 | if (bIsSingleScriptType) | ||||||||
494 | nCurrentLang = GetLanguage( aSet, nLangWhichId ); | ||||||||
495 | else | ||||||||
496 | { | ||||||||
497 | // check if all script types are set to LANGUAGE_NONE and return | ||||||||
498 | // that if this is the case. Otherwise, having multiple script types | ||||||||
499 | // in use always means there are several languages in use... | ||||||||
500 | const sal_uInt16 aScriptTypes[3] = | ||||||||
501 | { | ||||||||
502 | EE_CHAR_LANGUAGE, | ||||||||
503 | EE_CHAR_LANGUAGE_CJK, | ||||||||
504 | EE_CHAR_LANGUAGE_CTL | ||||||||
505 | }; | ||||||||
506 | nCurrentLang = LANGUAGE_NONELanguageType(0x00FF); | ||||||||
507 | for (sal_uInt16 aScriptType : aScriptTypes) | ||||||||
508 | { | ||||||||
509 | LanguageType nTmpLang = GetLanguage( aSet, aScriptType ); | ||||||||
510 | if (nTmpLang != LANGUAGE_NONELanguageType(0x00FF)) | ||||||||
511 | { | ||||||||
512 | nCurrentLang = LANGUAGE_DONTKNOWLanguageType(0x03FF); | ||||||||
513 | break; | ||||||||
514 | } | ||||||||
515 | } | ||||||||
516 | } | ||||||||
517 | OSL_ENSURE( nCurrentLang != LANGUAGE_SYSTEM, "failed to get the language?" )do { if (true && (!(nCurrentLang != LanguageType(0x0000 )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl" ), ("/home/maarten/src/libreoffice/core/sw/source/uibase/shells/langhelper.cxx" ":" "517" ": "), "%s", "failed to get the language?"); } } while (false); | ||||||||
518 | |||||||||
519 | return nCurrentLang; | ||||||||
520 | } | ||||||||
521 | |||||||||
522 | OUString GetTextForLanguageGuessing( SwWrtShell const &rSh ) | ||||||||
523 | { | ||||||||
524 | // string for guessing language | ||||||||
525 | OUString aText; | ||||||||
526 | SwPaM *pCursor = rSh.GetCursor(); | ||||||||
527 | SwTextNode *pNode = pCursor->GetNode().GetTextNode(); | ||||||||
528 | if (pNode) | ||||||||
529 | { | ||||||||
530 | aText = pNode->GetText(); | ||||||||
531 | if (!aText.isEmpty()) | ||||||||
532 | { | ||||||||
533 | sal_Int32 nEnd = pCursor->GetPoint()->nContent.GetIndex(); | ||||||||
534 | // at most 100 chars to the left... | ||||||||
535 | const sal_Int32 nStt = nEnd > 100 ? nEnd - 100 : 0; | ||||||||
536 | // ... and 100 to the right of the cursor position | ||||||||
537 | nEnd = aText.getLength() - nEnd > 100 ? nEnd + 100 : aText.getLength(); | ||||||||
538 | aText = aText.copy( nStt, nEnd - nStt ); | ||||||||
539 | } | ||||||||
540 | } | ||||||||
541 | return aText; | ||||||||
542 | } | ||||||||
543 | |||||||||
544 | OUString GetTextForLanguageGuessing(EditEngine const * rEditEngine, const ESelection& rDocSelection) | ||||||||
545 | { | ||||||||
546 | // string for guessing language | ||||||||
547 | |||||||||
548 | // get the full text of the paragraph that the end of selection is in | ||||||||
549 | OUString aText = rEditEngine->GetText(rDocSelection.nEndPos); | ||||||||
550 | if (!aText.isEmpty()) | ||||||||
551 | { | ||||||||
552 | sal_Int32 nStt = 0; | ||||||||
553 | sal_Int32 nEnd = rDocSelection.nEndPos; | ||||||||
554 | // at most 100 chars to the left... | ||||||||
555 | nStt = nEnd > 100 ? nEnd - 100 : 0; | ||||||||
556 | // ... and 100 to the right of the cursor position | ||||||||
557 | nEnd = aText.getLength() - nEnd > 100 ? nEnd + 100 : aText.getLength(); | ||||||||
558 | aText = aText.copy( nStt, nEnd - nStt ); | ||||||||
559 | } | ||||||||
560 | |||||||||
561 | return aText; | ||||||||
562 | } | ||||||||
563 | |||||||||
564 | void SelectPara( EditView &rEditView, const ESelection &rCurSel ) | ||||||||
565 | { | ||||||||
566 | ESelection aParaSel( rCurSel.nStartPara, 0, rCurSel.nStartPara, EE_TEXTPOS_ALL((sal_Int32) 0x7FFFFFFF) ); | ||||||||
567 | rEditView.SetSelection( aParaSel ); | ||||||||
568 | } | ||||||||
569 | |||||||||
570 | void SelectCurrentPara( SwWrtShell &rWrtSh ) | ||||||||
571 | { | ||||||||
572 | // select current para | ||||||||
573 | if (!rWrtSh.IsSttPara()) | ||||||||
574 | rWrtSh.MovePara( GoCurrPara, fnParaStart ); | ||||||||
575 | if (!rWrtSh.HasMark()) | ||||||||
576 | rWrtSh.SetMark(); | ||||||||
577 | rWrtSh.SwapPam(); | ||||||||
578 | if (!rWrtSh.IsEndPara()) | ||||||||
579 | rWrtSh.MovePara( GoCurrPara, fnParaEnd ); | ||||||||
580 | #if OSL_DEBUG_LEVEL1 > 1 | ||||||||
581 | OUString aSelText; | ||||||||
582 | rWrtSh.GetSelectedText( aSelText ); | ||||||||
583 | (void) aSelText; | ||||||||
584 | #endif | ||||||||
585 | } | ||||||||
586 | } | ||||||||
587 | |||||||||
588 | /* 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 |