svtools/source/misc/ehdl.cxx

   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 <osl/mutex.hxx>
  21 #include <tools/rcid.h>
  22 #include <tools/wintypes.hxx>
  23 #include <vcl/msgbox.hxx>
  24 #include <vcl/svapp.hxx>
  25 #include <vcl/settings.hxx>
  26
  27 #include <svtools/ehdl.hxx>
  28 #include <svtools/svtresid.hxx>
  29 #include <svtools/svtools.hrc>
  30 #include <svtools/sfxecode.hxx>
  31 #include <boost/scoped_ptr.hpp>
  32
  33
  34 static sal_uInt16 aWndFunc(
  35     vcl::Window *pWin,            // Parent of the dialog
  36     sal_uInt16 nFlags,
  37     const OUString &rErr,      // error text
  38     const OUString &rAction)   // action text
  39
  40 /*  [Description]
  41
  42     Draw an errorbox on the screen. Depending on nFlags
  43     Error/Info etc. boxes with the requested buttosn are shown.
  44
  45     Returnvalue is the button pressed
  46
  47     */
  48
  49
  50 {
  51     SolarMutexGuard aGuard;
  52
  53     // determine necessary WinBits from the flags
  54     WinBits eBits=0;
  55     if ( (ERRCODE_BUTTON_CANCEL|ERRCODE_BUTTON_RETRY) == (nFlags & (ERRCODE_BUTTON_CANCEL|ERRCODE_BUTTON_RETRY)) )
  56         eBits = WB_RETRY_CANCEL;
  57     else if ( ERRCODE_BUTTON_OK_CANCEL == (nFlags & ERRCODE_BUTTON_OK_CANCEL) )
  58         eBits = WB_OK_CANCEL;
  59     else if ( ERRCODE_BUTTON_OK == (nFlags & ERRCODE_BUTTON_OK) )
  60         eBits = WB_OK;
  61     else if ( ERRCODE_BUTTON_YES_NO_CANCEL == (nFlags & ERRCODE_BUTTON_YES_NO_CANCEL) )
  62         eBits = WB_YES_NO_CANCEL;
  63     else if ( ERRCODE_BUTTON_YES_NO == (nFlags & ERRCODE_BUTTON_YES_NO) )
  64         eBits = WB_YES_NO;
  65
  66     switch(nFlags & 0x0f00)
  67     {
  68       case ERRCODE_BUTTON_DEF_OK:
  69             eBits |= WB_DEF_OK;
  70             break;
  71
  72       case ERRCODE_BUTTON_DEF_CANCEL:
  73             eBits |= WB_DEF_CANCEL;
  74             break;
  75
  76       case ERRCODE_BUTTON_DEF_YES:
  77             eBits |= WB_DEF_YES;
  78             break;
  79
  80       case ERRCODE_BUTTON_DEF_NO:
  81             eBits |= WB_DEF_NO;
  82             break;
  83     }
  84
  85     OUString aErr(SvtResId(STR_ERR_HDLMESS).toString());
  86     OUString aAction(rAction);
  87     if ( !aAction.isEmpty() )
  88         aAction += ":\n";
  89     aErr = aErr.replaceAll("$(ACTION)", aAction);
  90     aErr = aErr.replaceAll("$(ERROR)", rErr);
  91
  92     VclPtr<MessBox> pBox;
  93     switch ( nFlags & 0xf000 )
  94     {
  95         case ERRCODE_MSG_ERROR:
  96             pBox.reset(VclPtr<ErrorBox>::Create(pWin, eBits, aErr));
  97             break;
  98
  99         case ERRCODE_MSG_WARNING:
 100             pBox.reset(VclPtr<WarningBox>::Create(pWin, eBits, aErr));
 101             break;
 102
 103         case ERRCODE_MSG_INFO:
 104             pBox.reset(VclPtr<InfoBox>::Create(pWin, aErr));
 105             break;
 106
 107         case ERRCODE_MSG_QUERY:
 108             pBox.reset(VclPtr<QueryBox>::Create(pWin, eBits, aErr));
 109             break;
 110
 111         default:
 112         {
 113             SAL_WARN( "svtools.misc", "no MessBox type");
 114             return ERRCODE_BUTTON_OK;
 115         }
 116     }
 117
 118     sal_uInt16 nRet = RET_CANCEL;
 119     switch ( pBox->Execute() )
 120     {
 121         case RET_OK:
 122             nRet = ERRCODE_BUTTON_OK;
 123             break;
 124         case RET_CANCEL:
 125             nRet = ERRCODE_BUTTON_CANCEL;
 126             break;
 127         case RET_RETRY:
 128             nRet = ERRCODE_BUTTON_RETRY;
 129             break;
 130         case RET_YES:
 131             nRet = ERRCODE_BUTTON_YES;
 132             break;
 133         case RET_NO:
 134             nRet = ERRCODE_BUTTON_NO;
 135             break;
 136         default:
 137             SAL_WARN( "svtools.misc", "Unknown MessBox return value" );
 138             break;
 139     }
 140     return nRet;
 141 }
 142
 143
 144
 145 SfxErrorHandler::SfxErrorHandler(sal_uInt16 nIdP, sal_uLong lStartP, sal_uLong lEndP, ResMgr *pMgrP) :
 146
 147     lStart(lStartP), lEnd(lEndP), nId(nIdP), pMgr(pMgrP), pFreeMgr( NULL )
 148
 149 {
 150     RegisterDisplay(&aWndFunc);
 151     if( ! pMgr )
 152     {
 153         pFreeMgr = pMgr = ResMgr::CreateResMgr("ofa", Application::GetSettings().GetUILanguageTag() );
 154     }
 155 }
 156
 157
 158
 159 SfxErrorHandler::~SfxErrorHandler()
 160 {
 161     delete pFreeMgr;
 162 }
 163
 164
 165
 166 bool SfxErrorHandler::CreateString(
 167     const ErrorInfo *pErr, OUString &rStr, sal_uInt16& nFlags) const
 168
 169 /*  [Description]
 170
 171     Assemble error string for the ErrorInfo pErr.
 172
 173     */
 174
 175 {
 176     sal_uLong nErrCode = pErr->GetErrorCode() & ERRCODE_ERROR_MASK;
 177     if( nErrCode>=lEnd || nErrCode<=lStart )
 178         return false;
 179     const MessageInfo *pMsgInfo = PTR_CAST(MessageInfo,pErr);
 180     if(pMsgInfo)
 181     {
 182         if(GetMessageString(nErrCode, rStr, nFlags))
 183         {
 184             rStr = rStr.replaceAll("$(ARG1)", pMsgInfo->GetMessageArg());
 185             return true;
 186         }
 187     }
 188     else if(GetErrorString(nErrCode, rStr, nFlags))
 189     {
 190         const StringErrorInfo *pStringInfo = PTR_CAST(StringErrorInfo,pErr);
 191         if(pStringInfo)
 192         {
 193             rStr = rStr.replaceAll(OUString("$(ARG1)"),
 194                                       pStringInfo->GetErrorString());
 195         }
 196         else
 197         {
 198             const TwoStringErrorInfo * pTwoStringInfo = PTR_CAST(TwoStringErrorInfo,
 199                                                            pErr);
 200             if (pTwoStringInfo)
 201             {
 202                 rStr = rStr.replaceAll("$(ARG1)", pTwoStringInfo->GetArg1());
 203                 rStr = rStr.replaceAll("$(ARG2)", pTwoStringInfo->GetArg2());
 204             }
 205         }
 206         return true;
 207     }
 208     return false;
 209 }
 210
 211
 212
 213 class ResString: public OUString
 214
 215 /*  [Description]
 216
 217     Helpclass to read a string and optional ExtraData from
 218     a string Resource.
 219
 220     */
 221
 222 {
 223     sal_uInt16 nFlags;
 224   public:
 225     sal_uInt16 GetFlags() const {return nFlags;}
 226     const OUString & GetString() const {return *this;}
 227     ResString( ResId &rId);
 228 };
 229
 230
 231
 232 ResString::ResString(ResId & rId):
 233     OUString(rId.SetAutoRelease(false).toString()),
 234     nFlags(0)
 235 {
 236     ResMgr * pResMgr = rId.GetResMgr();
 237      // String ctor temporarily sets global ResManager
 238     if (pResMgr->GetRemainSize())
 239         nFlags = sal_uInt16(pResMgr->ReadShort());
 240     rId.SetAutoRelease(true);
 241     pResMgr->PopContext();
 242 }
 243
 244
 245
 246 struct ErrorResource_Impl : private Resource
 247
 248 /*  [Description]
 249
 250     Helpclass for access to string sub-resources of a resource
 251     */
 252
 253 {
 254
 255     ResId aResId;
 256
 257     ErrorResource_Impl(ResId& rErrIdP, sal_uInt16 nId)
 258         : Resource(rErrIdP),aResId(nId,*rErrIdP.GetResMgr()){}
 259
 260     ~ErrorResource_Impl() { FreeResource(); }
 261
 262     operator ResString() { return ResString( aResId ); }
 263     operator bool()      { return IsAvailableRes(aResId.SetRT(RSC_STRING)); }
 264
 265 };
 266
 267
 268 bool SfxErrorHandler::GetClassString(sal_uLong lClassId, OUString &rStr) const
 269
 270 /*  [Description]
 271
 272     Creates the string for the class of the error. Will always
 273     be read from the resource of the Sfx.
 274
 275     */
 276
 277 {
 278     bool bRet = false;
 279     boost::scoped_ptr<ResMgr> pResMgr(ResMgr::CreateResMgr("ofa", Application::GetSettings().GetUILanguageTag() ));
 280     if( pResMgr )
 281     {
 282         ResId aId(RID_ERRHDL, *pResMgr );
 283         ErrorResource_Impl aEr(aId, (sal_uInt16)lClassId);
 284         if(aEr)
 285         {
 286             rStr = static_cast<ResString>(aEr).GetString();
 287             bRet = true;
 288         }
 289     }
 290     return bRet;
 291 }
 292
 293
 294
 295 bool SfxErrorHandler::GetMessageString(
 296     sal_uLong lErrId, OUString &rStr, sal_uInt16 &nFlags) const
 297
 298 /*  [Description]
 299
 300     Creates the string to output a message box
 301
 302     */
 303
 304 {
 305     bool bRet = false;
 306     boost::scoped_ptr<ResId> pResId(new ResId(nId, *pMgr));
 307
 308     ErrorResource_Impl aEr(*pResId, (sal_uInt16)lErrId);
 309     if(aEr)
 310     {
 311         ResString aErrorString(aEr);
 312         sal_uInt16 nResFlags = aErrorString.GetFlags();
 313         if( nResFlags )
 314             nFlags=aErrorString.GetFlags();
 315         rStr = aErrorString.GetString();
 316         bRet = true;
 317     }
 318
 319     return bRet;
 320 }
 321
 322
 323
 324 bool SfxErrorHandler::GetErrorString(
 325     sal_uLong lErrId, OUString &rStr, sal_uInt16 &nFlags) const
 326
 327 /*  [Description]
 328
 329     Creates the error string for the actual error
 330     without its class
 331
 332     */
 333
 334 {
 335     SolarMutexGuard aGuard;
 336
 337     bool bRet = false;
 338     rStr = SvtResId(RID_ERRHDL_CLASS).toString();
 339     ResId aResId(nId, *pMgr);
 340
 341     {
 342         ErrorResource_Impl aEr(aResId, (sal_uInt16)lErrId);
 343         if(aEr)
 344         {
 345             ResString aErrorString(aEr);
 346
 347             sal_uInt16 nResFlags = aErrorString.GetFlags();
 348             if ( nResFlags )
 349                 nFlags = nResFlags;
 350             rStr = rStr.replaceAll(OUString("$(ERROR)"), aErrorString.GetString());
 351             bRet = true;
 352         }
 353         else
 354             bRet = false;
 355     }
 356
 357     if( bRet )
 358     {
 359         OUString aErrStr;
 360         GetClassString(lErrId & ERRCODE_CLASS_MASK,
 361                        aErrStr);
 362         if(!aErrStr.isEmpty())
 363             aErrStr += ".\n";
 364         rStr = rStr.replaceAll("$(CLASS)",aErrStr);
 365     }
 366
 367     return bRet;
 368 }
 369
 370
 371
 372 SfxErrorContext::SfxErrorContext(
 373     sal_uInt16 nCtxIdP, vcl::Window *pWindow, sal_uInt16 nResIdP, ResMgr *pMgrP)
 374 :   ErrorContext(pWindow), nCtxId(nCtxIdP), nResId(nResIdP), pMgr(pMgrP)
 375 {
 376     if( nResId==USHRT_MAX )
 377         nResId=RID_ERRCTX;
 378 }
 379
 380
 381
 382 SfxErrorContext::SfxErrorContext(
 383     sal_uInt16 nCtxIdP, const OUString &aArg1P, vcl::Window *pWindow,
 384     sal_uInt16 nResIdP, ResMgr *pMgrP)
 385 :   ErrorContext(pWindow), nCtxId(nCtxIdP), nResId(nResIdP), pMgr(pMgrP),
 386     aArg1(aArg1P)
 387 {
 388     if( nResId==USHRT_MAX )
 389         nResId=RID_ERRCTX;
 390 }
 391
 392
 393
 394 bool SfxErrorContext::GetString(sal_uLong nErrId, OUString &rStr)
 395
 396 /*  [Description]
 397
 398     Constructs the description of a error context
 399     */
 400
 401 {
 402     bool bRet = false;
 403     ResMgr* pFreeMgr = NULL;
 404     if( ! pMgr )
 405     {
 406         pFreeMgr = pMgr = ResMgr::CreateResMgr("ofa", Application::GetSettings().GetUILanguageTag() );
 407     }
 408     if( pMgr )
 409     {
 410         SolarMutexGuard aGuard;
 411
 412         ResId aResId( nResId, *pMgr );
 413
 414         ErrorResource_Impl aTestEr( aResId, nCtxId );
 415         if ( aTestEr )
 416         {
 417             rStr = static_cast<ResString>(aTestEr).GetString();
 418             rStr = rStr.replaceAll(OUString("$(ARG1)"), aArg1 );
 419             bRet = true;
 420         }
 421         else
 422         {
 423             SAL_WARN( "svtools.misc", "ErrorContext cannot find the resource" );
 424             bRet = false;
 425         }
 426
 427         if ( bRet )
 428         {
 429             sal_uInt16 nId = ( nErrId & ERRCODE_WARNING_MASK ) ? ERRCTX_WARNING : ERRCTX_ERROR;
 430             ResId aSfxResId( RID_ERRCTX, *pMgr );
 431             ErrorResource_Impl aEr( aSfxResId, nId );
 432             rStr = rStr.replaceAll( OUString("$(ERR)"), static_cast<ResString>(aEr).GetString() );
 433         }
 434     }
 435
 436     if( pFreeMgr )
 437     {
 438         delete pFreeMgr;
 439         pMgr = NULL;
 440     }
 441     return bRet;
 442 }
 443
 444 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */