Line data Source code
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 <limits.h>
21 : #include <tools/shl.hxx>
22 : #include <tools/debug.hxx>
23 : #include <tools/errinf.hxx>
24 : #include <rtl/strbuf.hxx>
25 : #include <osl/diagnose.h>
26 : #include <vcl/window.hxx>
27 :
28 : class ErrorHandler;
29 :
30 : namespace {
31 : typedef void (* DisplayFnPtr)();
32 : }
33 :
34 : struct EDcrData
35 : {
36 : public:
37 : ErrorHandler *pFirstHdl;
38 : ErrorContext *pFirstCtx;
39 : DisplayFnPtr pDsp;
40 : bool bIsWindowDsp;
41 :
42 : DynamicErrorInfo *ppDcr[ERRCODE_DYNAMIC_COUNT];
43 : sal_uInt16 nNextDcr;
44 : EDcrData();
45 :
46 : static EDcrData *GetData();
47 : };
48 :
49 : class EDcr_Impl
50 : {
51 : sal_uIntPtr lErrId;
52 : sal_uInt16 nMask;
53 :
54 : void RegisterEDcr(DynamicErrorInfo *);
55 : static void UnRegisterEDcr(DynamicErrorInfo *);
56 : static ErrorInfo *GetDynamicErrorInfo(sal_uIntPtr lId);
57 :
58 : friend class DynamicErrorInfo;
59 : friend class ErrorInfo;
60 : };
61 :
62 242 : EDcrData::EDcrData()
63 : : pFirstHdl(0)
64 : , pFirstCtx(0)
65 : , pDsp(0)
66 : , bIsWindowDsp(false)
67 242 : , nNextDcr(0)
68 : {
69 7744 : for(sal_uInt16 n=0;n<ERRCODE_DYNAMIC_COUNT;n++)
70 7502 : ppDcr[n]=0;
71 242 : }
72 :
73 9116 : EDcrData *EDcrData::GetData()
74 : {
75 : #ifdef BOOTSTRAP
76 : return 0x0;
77 : #else
78 9116 : EDcrData **ppDat=reinterpret_cast<EDcrData **>(GetAppData(SHL_ERR));
79 9116 : if(!*ppDat)
80 : {
81 242 : return (*ppDat=new EDcrData);
82 : }
83 : else
84 8874 : return *ppDat;
85 : #endif
86 : }
87 :
88 2 : void EDcr_Impl::RegisterEDcr(DynamicErrorInfo *pDcr)
89 : {
90 : // Register dynamic identifier
91 2 : EDcrData* pData=EDcrData::GetData();
92 4 : lErrId= (((sal_uIntPtr)pData->nNextDcr + 1) << ERRCODE_DYNAMIC_SHIFT) +
93 4 : pDcr->GetErrorCode();
94 2 : DynamicErrorInfo **ppDcr=pData->ppDcr;
95 2 : sal_uInt16 nNext=pData->nNextDcr;
96 :
97 2 : if(ppDcr[nNext])
98 : {
99 0 : delete ppDcr[nNext];
100 : }
101 2 : ppDcr[nNext]=pDcr;
102 2 : if(++pData->nNextDcr>=ERRCODE_DYNAMIC_COUNT)
103 0 : pData->nNextDcr=0;
104 2 : }
105 :
106 0 : void EDcr_Impl::UnRegisterEDcr(DynamicErrorInfo *pDcr)
107 : {
108 :
109 0 : EDcrData* pData=EDcrData::GetData();
110 0 : DynamicErrorInfo **ppDcr=pData->ppDcr;
111 : sal_uIntPtr lIdx=(
112 0 : ((sal_uIntPtr)(*pDcr) & ERRCODE_DYNAMIC_MASK)>>ERRCODE_DYNAMIC_SHIFT)-1;
113 : DBG_ASSERT(ppDcr[lIdx]==pDcr,"ErrHdl: Error nicht gefunden");
114 0 : if(ppDcr[lIdx]==pDcr)
115 0 : ppDcr[lIdx]=0;
116 0 : }
117 :
118 0 : TYPEINIT0(ErrorInfo);
119 0 : TYPEINIT1(DynamicErrorInfo, ErrorInfo);
120 0 : TYPEINIT1(StringErrorInfo, DynamicErrorInfo);
121 0 : TYPEINIT1(TwoStringErrorInfo, DynamicErrorInfo);
122 0 : TYPEINIT1(MessageInfo, DynamicErrorInfo);
123 :
124 0 : ErrorInfo *ErrorInfo::GetErrorInfo(sal_uIntPtr lId)
125 : {
126 0 : if(lId & ERRCODE_DYNAMIC_MASK)
127 0 : return EDcr_Impl::GetDynamicErrorInfo(lId);
128 : else
129 0 : return new ErrorInfo(lId);
130 : }
131 :
132 2 : DynamicErrorInfo::operator sal_uIntPtr() const
133 : {
134 2 : return pImpl->lErrId;
135 : }
136 :
137 2 : DynamicErrorInfo::DynamicErrorInfo(sal_uIntPtr lArgUserId, sal_uInt16 nMask)
138 2 : : ErrorInfo(lArgUserId)
139 : {
140 2 : pImpl=new EDcr_Impl;
141 2 : pImpl->RegisterEDcr(this);
142 2 : pImpl->nMask=nMask;
143 2 : }
144 :
145 0 : DynamicErrorInfo::~DynamicErrorInfo()
146 : {
147 0 : EDcr_Impl::UnRegisterEDcr(this);
148 0 : delete pImpl;
149 0 : }
150 :
151 0 : ErrorInfo* EDcr_Impl::GetDynamicErrorInfo(sal_uIntPtr lId)
152 : {
153 0 : sal_uIntPtr lIdx=((lId & ERRCODE_DYNAMIC_MASK)>>ERRCODE_DYNAMIC_SHIFT)-1;
154 0 : DynamicErrorInfo* pDcr=EDcrData::GetData()->ppDcr[lIdx];
155 0 : if(pDcr && (sal_uIntPtr)(*pDcr)==lId)
156 0 : return pDcr;
157 : else
158 0 : return new ErrorInfo(lId & ~ERRCODE_DYNAMIC_MASK);
159 : }
160 :
161 0 : sal_uInt16 DynamicErrorInfo::GetDialogMask() const
162 : {
163 0 : return pImpl->nMask;
164 : }
165 :
166 1 : StringErrorInfo::StringErrorInfo(
167 : sal_uIntPtr UserId, const OUString& aStringP, sal_uInt16 nFlags)
168 1 : : DynamicErrorInfo(UserId, nFlags), aString(aStringP)
169 : {
170 1 : }
171 :
172 : class ErrHdl_Impl
173 : {
174 : public:
175 : ErrorHandler *pNext;
176 : static bool CreateString(const ErrorHandler *pStart,
177 : const ErrorInfo*, OUString&, sal_uInt16&);
178 : };
179 :
180 0 : static void aDspFunc(const OUString &rErr, const OUString &rAction)
181 : {
182 0 : OStringBuffer aErr("Aktion: ");
183 0 : aErr.append(OUStringToOString(rAction, RTL_TEXTENCODING_ASCII_US));
184 0 : aErr.append(" Fehler: ");
185 0 : aErr.append(OUStringToOString(rErr, RTL_TEXTENCODING_ASCII_US));
186 0 : OSL_FAIL(aErr.getStr());
187 0 : }
188 :
189 : // FIXME: this is a horrible reverse dependency on VCL
190 : struct ErrorContextImpl
191 : {
192 : ErrorContext *pNext;
193 : vcl::Window *pWin; // should be VclPtr for strong lifecyle
194 : };
195 :
196 2009 : ErrorContext::ErrorContext(vcl::Window *pWinP)
197 : {
198 2009 : pImpl = new ErrorContextImpl();
199 2009 : EDcrData *pData=EDcrData::GetData();
200 2009 : ErrorContext *&pHdl = pData->pFirstCtx;
201 2009 : pImpl->pWin = pWinP;
202 2009 : pImpl->pNext = pHdl;
203 2009 : pHdl = this;
204 2009 : }
205 :
206 2009 : ErrorContext::~ErrorContext()
207 : {
208 2009 : ErrorContext **ppCtx=&(EDcrData::GetData()->pFirstCtx);
209 4018 : while(*ppCtx && *ppCtx!=this)
210 0 : ppCtx=&((*ppCtx)->pImpl->pNext);
211 2009 : if(*ppCtx)
212 2009 : *ppCtx=(*ppCtx)->pImpl->pNext;
213 2009 : delete pImpl;
214 2009 : }
215 :
216 0 : ErrorContext *ErrorContext::GetContext()
217 : {
218 0 : return EDcrData::GetData()->pFirstCtx;
219 : }
220 :
221 870 : ErrorHandler::ErrorHandler()
222 : {
223 870 : pImpl=new ErrHdl_Impl;
224 870 : EDcrData *pData=EDcrData::GetData();
225 870 : ErrorHandler *&pHdl=pData->pFirstHdl;
226 870 : pImpl->pNext=pHdl;
227 870 : pHdl=this;
228 870 : if(!pData->pDsp)
229 130 : RegisterDisplay(&aDspFunc);
230 870 : }
231 :
232 524 : ErrorHandler::~ErrorHandler()
233 : {
234 524 : ErrorHandler **ppHdl=&(EDcrData::GetData()->pFirstHdl);
235 1262 : while(*ppHdl && *ppHdl!=this)
236 214 : ppHdl=&((*ppHdl)->pImpl->pNext);
237 524 : if(*ppHdl)
238 524 : *ppHdl=(*ppHdl)->pImpl->pNext;
239 524 : delete pImpl;
240 524 : }
241 :
242 0 : vcl::Window* ErrorContext::GetParent()
243 : {
244 0 : return pImpl ? pImpl->pWin : NULL;
245 : }
246 :
247 870 : void ErrorHandler::RegisterDisplay(WindowDisplayErrorFunc *aDsp)
248 : {
249 870 : EDcrData *pData=EDcrData::GetData();
250 870 : pData->bIsWindowDsp=true;
251 870 : pData->pDsp = reinterpret_cast< DisplayFnPtr >(aDsp);
252 870 : }
253 :
254 2832 : void ErrorHandler::RegisterDisplay(BasicDisplayErrorFunc *aDsp)
255 : {
256 2832 : EDcrData *pData=EDcrData::GetData();
257 2832 : pData->bIsWindowDsp=false;
258 2832 : pData->pDsp = reinterpret_cast< DisplayFnPtr >(aDsp);
259 2832 : }
260 :
261 : /** Handles an error.
262 :
263 : If nFlags is not set, the DynamicErrorInfo flags or the
264 : resource flags will be used.
265 : Thus:
266 :
267 : 1. nFlags,
268 : 2. Resource Flags
269 : 3. Dynamic Flags
270 : 4. Default ERRCODE_BUTTON_OK, ERRCODE_MSG_ERROR
271 :
272 : @param lId error id
273 : @param nFlags error flags.
274 : @param bJustCreateString ???
275 : @param rError ???
276 :
277 : @return ???
278 : */
279 1 : sal_uInt16 ErrorHandler::HandleError_Impl(
280 : sal_uIntPtr lId, sal_uInt16 nFlags, bool bJustCreateString, OUString & rError)
281 : {
282 1 : OUString aErr;
283 2 : OUString aAction;
284 1 : if(!lId || lId == ERRCODE_ABORT)
285 1 : return 0;
286 0 : EDcrData *pData=EDcrData::GetData();
287 0 : ErrorInfo *pInfo=ErrorInfo::GetErrorInfo(lId);
288 0 : ErrorContext *pCtx=ErrorContext::GetContext();
289 0 : if(pCtx)
290 0 : pCtx->GetString(pInfo->GetErrorCode(), aAction);
291 0 : vcl::Window *pParent=0;
292 : // Remove parent from context
293 0 : for(;pCtx;pCtx=pCtx->pImpl->pNext)
294 0 : if(pCtx->GetParent())
295 : {
296 0 : pParent=pCtx->GetParent();
297 0 : break;
298 : }
299 :
300 0 : bool bWarning = ((lId & ERRCODE_WARNING_MASK) == ERRCODE_WARNING_MASK);
301 0 : sal_uInt16 nErrFlags = ERRCODE_BUTTON_DEF_OK | ERRCODE_BUTTON_OK;
302 0 : if (bWarning)
303 0 : nErrFlags |= ERRCODE_MSG_WARNING;
304 : else
305 0 : nErrFlags |= ERRCODE_MSG_ERROR;
306 :
307 0 : DynamicErrorInfo* pDynPtr=PTR_CAST(DynamicErrorInfo,pInfo);
308 0 : if(pDynPtr)
309 : {
310 0 : sal_uInt16 nDynFlags = pDynPtr->GetDialogMask();
311 0 : if( nDynFlags )
312 0 : nErrFlags = nDynFlags;
313 : }
314 :
315 0 : if(ErrHdl_Impl::CreateString(pData->pFirstHdl,pInfo,aErr,nErrFlags))
316 : {
317 0 : if (bJustCreateString)
318 : {
319 0 : rError = aErr;
320 0 : return 1;
321 : }
322 : else
323 : {
324 0 : if(!pData->pDsp)
325 : {
326 0 : OStringBuffer aStr("Action: ");
327 0 : aStr.append(OUStringToOString(aAction, RTL_TEXTENCODING_ASCII_US));
328 0 : aStr.append("\nFehler: ");
329 0 : aStr.append(OUStringToOString(aErr, RTL_TEXTENCODING_ASCII_US));
330 0 : OSL_FAIL(aStr.getStr());
331 : }
332 : else
333 : {
334 0 : delete pInfo;
335 0 : if(!pData->bIsWindowDsp)
336 : {
337 0 : (*reinterpret_cast<BasicDisplayErrorFunc*>(pData->pDsp))(aErr,aAction);
338 0 : return 0;
339 : }
340 : else
341 : {
342 0 : if (nFlags != USHRT_MAX)
343 0 : nErrFlags = nFlags;
344 : return (*reinterpret_cast<WindowDisplayErrorFunc*>(pData->pDsp))(
345 0 : pParent, nErrFlags, aErr, aAction);
346 : }
347 : }
348 : }
349 : }
350 : OSL_FAIL("Error nicht behandelt");
351 : // Error 1 is General Error in the Sfx
352 0 : if(pInfo->GetErrorCode()!=1)
353 : {
354 0 : HandleError_Impl(1, USHRT_MAX, bJustCreateString, rError);
355 : }
356 : else
357 : {
358 : OSL_FAIL("Error 1 nicht gehandeled");
359 : }
360 0 : delete pInfo;
361 1 : return 0;
362 : }
363 :
364 : // static
365 0 : bool ErrorHandler::GetErrorString(sal_uIntPtr lId, OUString& rStr)
366 : {
367 0 : return (bool)HandleError_Impl( lId, USHRT_MAX, true, rStr );
368 : }
369 :
370 : /** Handles an error.
371 :
372 : @see ErrorHandler::HandleError_Impl
373 : */
374 1 : sal_uInt16 ErrorHandler::HandleError(sal_uIntPtr lId, sal_uInt16 nFlags)
375 : {
376 1 : OUString aDummy;
377 1 : return HandleError_Impl( lId, nFlags, false, aDummy );
378 : }
379 :
380 0 : bool ErrHdl_Impl::CreateString( const ErrorHandler *pStart,
381 : const ErrorInfo* pInfo, OUString& pStr,
382 : sal_uInt16 &rFlags)
383 : {
384 0 : for(const ErrorHandler *pHdl=pStart;pHdl;pHdl=pHdl->pImpl->pNext)
385 : {
386 0 : if(pHdl->CreateString( pInfo, pStr, rFlags))
387 0 : return true;
388 : }
389 0 : return false;
390 : }
391 :
392 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
