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
  26 #include <svtools/ehdl.hxx>
  27 #include <svtools/svtresid.hxx>
  28 #include <svtools/svtools.hrc>
  29 #include <svtools/sfxecode.hxx>
  30
  31 //=========================================================================
  32
  33 static sal_uInt16 aWndFunc(
  34     Window *pWin,            // Parent des Dialoges
  35     sal_uInt16 nFlags,
  36     const OUString &rErr,      // Fehlertext
  37     const OUString &rAction)   // Actiontext
  38
  39 /*  [Beschreibung]
  40
  41     Bringt eine Fehlerbox auf den Schirm. Je nach nFlags werden
  42     Error/ Info usw. Boxen mit den gewuenschten Buttons angezeigt
  43
  44     Rueckgabewert ist der gedrueckte Button
  45
  46     */
  47
  48
  49 {
  50     SolarMutexGuard aGuard;
  51
  52     // aus den Flags die benoetigten WinBits ermitteln
  53     WinBits eBits=0;
  54     if ( (ERRCODE_BUTTON_CANCEL|ERRCODE_BUTTON_RETRY) == (nFlags & (ERRCODE_BUTTON_CANCEL|ERRCODE_BUTTON_RETRY)) )
  55         eBits = WB_RETRY_CANCEL;
  56     else if ( ERRCODE_BUTTON_OK_CANCEL == (nFlags & ERRCODE_BUTTON_OK_CANCEL) )
  57         eBits = WB_OK_CANCEL;
  58     else if ( ERRCODE_BUTTON_OK == (nFlags & ERRCODE_BUTTON_OK) )
  59         eBits = WB_OK;
  60     else if ( ERRCODE_BUTTON_YES_NO_CANCEL == (nFlags & ERRCODE_BUTTON_YES_NO_CANCEL) )
  61         eBits = WB_YES_NO_CANCEL;
  62     else if ( ERRCODE_BUTTON_YES_NO == (nFlags & ERRCODE_BUTTON_YES_NO) )
  63         eBits = WB_YES_NO;
  64
  65     switch(nFlags & 0x0f00)
  66     {
  67       case ERRCODE_BUTTON_DEF_OK:
  68             eBits |= WB_DEF_OK;
  69             break;
  70
  71       case ERRCODE_BUTTON_DEF_CANCEL:
  72             eBits |= WB_DEF_CANCEL;
  73             break;
  74
  75       case ERRCODE_BUTTON_DEF_YES:
  76             eBits |= WB_DEF_YES;
  77             break;
  78
  79       case ERRCODE_BUTTON_DEF_NO:
  80             eBits |= WB_DEF_NO;
  81             break;
  82     }
  83
  84     String aErr(SvtResId(STR_ERR_HDLMESS).toString());
  85     String aAction(rAction);
  86     if ( aAction.Len() )
  87         aAction += OUString(":\n");
  88     aErr.SearchAndReplace(OUString("$(ACTION)"), aAction);
  89     aErr.SearchAndReplace(OUString("$(ERROR)"), rErr);
  90
  91     MessBox* pBox;
  92     switch ( nFlags & 0xf000 )
  93     {
  94         case ERRCODE_MSG_ERROR:
  95             pBox = new ErrorBox(pWin, eBits, aErr);
  96             break;
  97
  98         case ERRCODE_MSG_WARNING:
  99             pBox = new WarningBox(pWin, eBits, aErr);
 100             break;
 101
 102         case ERRCODE_MSG_INFO:
 103             pBox = new InfoBox(pWin, aErr);
 104             break;
 105
 106         case ERRCODE_MSG_QUERY:
 107             pBox = new QueryBox(pWin, eBits, aErr);
 108             break;
 109
 110         default:
 111         {
 112             SAL_WARN( "svtools.misc", "no MessBox type");
 113             pBox = NULL;
 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     delete pBox;
 141     return nRet;
 142 }
 143
 144 //-------------------------------------------------------------------------
 145
 146 SfxErrorHandler::SfxErrorHandler(sal_uInt16 nIdP, sal_uLong lStartP, sal_uLong lEndP, ResMgr *pMgrP) :
 147
 148     lStart(lStartP), lEnd(lEndP), nId(nIdP), pMgr(pMgrP), pFreeMgr( NULL )
 149
 150 {
 151     RegisterDisplay(&aWndFunc);
 152     if( ! pMgr )
 153     {
 154         pFreeMgr = pMgr = ResMgr::CreateResMgr("ofa", Application::GetSettings().GetUILanguageTag() );
 155     }
 156 }
 157
 158 //-------------------------------------------------------------------------
 159
 160 SfxErrorHandler::~SfxErrorHandler()
 161 {
 162     delete pFreeMgr;
 163 }
 164
 165 //-------------------------------------------------------------------------
 166
 167 sal_Bool SfxErrorHandler::CreateString(
 168     const ErrorInfo *pErr, OUString &rStr, sal_uInt16& nFlags) const
 169
 170 /*  [Beschreibung]
 171
 172     Der Fehlerstring fuer die ErrorInfo pErr wird zusammengesetzt.
 173
 174     */
 175
 176 {
 177     sal_uLong nErrCode = pErr->GetErrorCode() & ERRCODE_ERROR_MASK;
 178     if( nErrCode>=lEnd || nErrCode<=lStart )
 179         return sal_False;
 180     MessageInfo *pMsgInfo=PTR_CAST(MessageInfo,pErr);
 181     if(pMsgInfo)
 182     {
 183         if(GetMessageString(nErrCode, rStr, nFlags))
 184         {
 185             rStr = rStr.replaceAll("$(ARG1)", pMsgInfo->GetMessageArg());
 186             return sal_True;
 187         }
 188     }
 189     else if(GetErrorString(nErrCode, rStr, nFlags))
 190     {
 191         StringErrorInfo *pStringInfo=PTR_CAST(StringErrorInfo,pErr);
 192         if(pStringInfo)
 193         {
 194             rStr = rStr.replaceAll(OUString("$(ARG1)"),
 195                                       pStringInfo->GetErrorString());
 196         }
 197         else
 198         {
 199             TwoStringErrorInfo * pTwoStringInfo = PTR_CAST(TwoStringErrorInfo,
 200                                                            pErr);
 201             if (pTwoStringInfo)
 202             {
 203                 rStr = rStr.replaceAll("$(ARG1)", pTwoStringInfo->GetArg1());
 204                 rStr = rStr.replaceAll("$(ARG2)", pTwoStringInfo->GetArg2());
 205             }
 206         }
 207         return sal_True;
 208     }
 209     return sal_False;
 210 }
 211
 212 //-------------------------------------------------------------------------
 213
 214 class ResString: public String
 215
 216 /*  [Beschreibung]
 217
 218     Hilfsklasse zum Auslesen eines Strings und optionaler ExtraData aus
 219     einer String Resource.
 220
 221     */
 222
 223 {
 224     sal_uInt16 nFlags;
 225   public:
 226     sal_uInt16 GetFlags() const {return nFlags;}
 227     const String & GetString() const {return *this;}
 228     ResString( ResId &rId);
 229 };
 230
 231 //-------------------------------------------------------------------------
 232
 233 ResString::ResString(ResId & rId):
 234     String(rId.SetAutoRelease(sal_False).toString()),
 235     nFlags(0)
 236 {
 237     ResMgr * pResMgr = rId.GetResMgr();
 238      // String ctor temporarily sets global ResManager
 239     if (pResMgr->GetRemainSize())
 240         nFlags = sal_uInt16(pResMgr->ReadShort());
 241     rId.SetAutoRelease(sal_True);
 242     pResMgr->PopContext();
 243 }
 244
 245 //-------------------------------------------------------------------------
 246
 247 struct ErrorResource_Impl : private Resource
 248
 249 /*  [Beschreibung]
 250
 251     Hilfsklasse zum Zugriff auf String SubResourcen einer Resource
 252     */
 253
 254 {
 255
 256     ResId aResId;
 257
 258     ErrorResource_Impl(ResId& rErrIdP, sal_uInt16 nId)
 259         : Resource(rErrIdP),aResId(nId,*rErrIdP.GetResMgr()){}
 260
 261     ~ErrorResource_Impl() { FreeResource(); }
 262
 263     operator ResString(){ return ResString( aResId ); }
 264     operator sal_Bool(){return IsAvailableRes(aResId.SetRT(RSC_STRING));}
 265
 266 };
 267
 268
 269 sal_Bool SfxErrorHandler::GetClassString(sal_uLong lClassId, String &rStr) const
 270
 271 /*  [Beschreibung]
 272
 273     Erzeugt den String fuer die Klasse des Fehlers. Wird immer aus der
 274     Resource des Sfx gelesen
 275
 276     */
 277
 278 {
 279     sal_Bool bRet = sal_False;
 280     ResMgr* pResMgr = ResMgr::CreateResMgr("ofa", Application::GetSettings().GetUILanguageTag() );
 281     if( pResMgr )
 282     {
 283         ResId aId(RID_ERRHDL, *pResMgr );
 284         ErrorResource_Impl aEr(aId, (sal_uInt16)lClassId);
 285         if(aEr)
 286         {
 287             rStr=((ResString)aEr).GetString();
 288             bRet = sal_True;
 289         }
 290     }
 291     delete pResMgr;
 292     return bRet;
 293 }
 294
 295 //-------------------------------------------------------------------------
 296
 297 sal_Bool SfxErrorHandler::GetMessageString(
 298     sal_uLong lErrId, OUString &rStr, sal_uInt16 &nFlags) const
 299
 300 /*  [Beschreibung]
 301
 302     Erzeugt den String fuer die Ausgabe in einer MessageBox
 303
 304     */
 305
 306 {
 307     sal_Bool bRet = sal_False;
 308     ResId *pResId= new ResId(nId, *pMgr);
 309
 310     ErrorResource_Impl aEr(*pResId, (sal_uInt16)lErrId);
 311     if(aEr)
 312     {
 313         ResString aErrorString(aEr);
 314         sal_uInt16 nResFlags = aErrorString.GetFlags();
 315         if( nResFlags )
 316             nFlags=aErrorString.GetFlags();
 317         rStr = aErrorString.GetString();
 318         bRet = sal_True;
 319     }
 320
 321     delete pResId;
 322     return bRet;
 323 }
 324
 325 //-------------------------------------------------------------------------
 326
 327 sal_Bool SfxErrorHandler::GetErrorString(
 328     sal_uLong lErrId, OUString &rStr, sal_uInt16 &nFlags) const
 329
 330 /*  [Beschreibung]
 331     Erzeugt den Fehlerstring fuer den eigentlichen Fehler ohne
 332     dessen Klasse
 333
 334     */
 335
 336 {
 337     SolarMutexGuard aGuard;
 338
 339     sal_Bool bRet = sal_False;
 340     rStr=SvtResId(RID_ERRHDL_CLASS).toString();
 341     ResId aResId(nId, *pMgr);
 342
 343     {
 344         ErrorResource_Impl aEr(aResId, (sal_uInt16)lErrId);
 345         if(aEr)
 346         {
 347             ResString aErrorString(aEr);
 348
 349             sal_uInt16 nResFlags = aErrorString.GetFlags();
 350             if ( nResFlags )
 351                 nFlags = nResFlags;
 352             rStr = rStr.replaceAll(OUString("$(ERROR)"), aErrorString.GetString());
 353             bRet = sal_True;
 354         }
 355         else
 356             bRet = sal_False;
 357     }
 358
 359     if( bRet )
 360     {
 361         String aErrStr;
 362         GetClassString(lErrId & ERRCODE_CLASS_MASK,
 363                        aErrStr);
 364         if(aErrStr.Len())
 365             aErrStr += OUString(".\n");
 366         rStr = rStr.replaceAll(OUString("$(CLASS)"),aErrStr);
 367     }
 368
 369     return bRet;
 370 }
 371
 372 //-------------------------------------------------------------------------
 373
 374 SfxErrorContext::SfxErrorContext(
 375     sal_uInt16 nCtxIdP, Window *pWindow, sal_uInt16 nResIdP, ResMgr *pMgrP)
 376 :   ErrorContext(pWindow), nCtxId(nCtxIdP), nResId(nResIdP), pMgr(pMgrP)
 377 {
 378     if( nResId==USHRT_MAX )
 379         nResId=RID_ERRCTX;
 380 }
 381
 382 //-------------------------------------------------------------------------
 383
 384 SfxErrorContext::SfxErrorContext(
 385     sal_uInt16 nCtxIdP, const String &aArg1P, Window *pWindow,
 386     sal_uInt16 nResIdP, ResMgr *pMgrP)
 387 :   ErrorContext(pWindow), nCtxId(nCtxIdP), nResId(nResIdP), pMgr(pMgrP),
 388     aArg1(aArg1P)
 389 {
 390     if( nResId==USHRT_MAX )
 391         nResId=RID_ERRCTX;
 392 }
 393
 394 //-------------------------------------------------------------------------
 395
 396 sal_Bool SfxErrorContext::GetString(sal_uLong nErrId, OUString &rStr)
 397
 398 /*  [Beschreibung]
 399
 400     Baut die Beschreibung eines ErrorContextes auf
 401     */
 402
 403 {
 404     bool bRet = false;
 405     ResMgr* pFreeMgr = NULL;
 406     if( ! pMgr )
 407     {
 408         pFreeMgr = pMgr = ResMgr::CreateResMgr("ofa", Application::GetSettings().GetUILanguageTag() );
 409     }
 410     if( pMgr )
 411     {
 412         SolarMutexGuard aGuard;
 413
 414         ResId aResId( nResId, *pMgr );
 415
 416         ErrorResource_Impl aTestEr( aResId, nCtxId );
 417         if ( aTestEr )
 418         {
 419             rStr = ( (ResString)aTestEr ).GetString();
 420             rStr = rStr.replaceAll(OUString("$(ARG1)"), aArg1 );
 421             bRet = true;
 422         }
 423         else
 424         {
 425             SAL_WARN( "svtools.misc", "ErrorContext cannot find the resource" );
 426             bRet = false;
 427         }
 428
 429         if ( bRet )
 430         {
 431             sal_uInt16 nId = ( nErrId & ERRCODE_WARNING_MASK ) ? ERRCTX_WARNING : ERRCTX_ERROR;
 432             ResId aSfxResId( RID_ERRCTX, *pMgr );
 433             ErrorResource_Impl aEr( aSfxResId, nId );
 434             rStr = rStr.replaceAll( OUString("$(ERR)"), ( (ResString)aEr ).GetString() );
 435         }
 436     }
 437
 438     if( pFreeMgr )
 439     {
 440         delete pFreeMgr;
 441         pMgr = NULL;
 442     }
 443     return bRet;
 444 }
 445
 446 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */