include/tools/errinf.hxx

   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 __RSC
  21
  22 #ifndef INCLUDED_TOOLS_ERRINF_HXX
  23 #define INCLUDED_TOOLS_ERRINF_HXX
  24
  25 #include <limits.h>
  26 #include <rtl/ustring.hxx>
  27 #include <tools/errcode.hxx>
  28 #include <tools/toolsdllapi.h>
  29 #include <memory>
  30
  31 // FIXME: horrible legacy dependency on VCL from tools.
  32 namespace vcl { class Window; }
  33
  34 class DynamicErrorInfo_Impl;
  35 class ErrorHandler_Impl;
  36
  37 class TOOLS_DLLPUBLIC ErrorInfo
  38 {
  39 private:
  40     sal_uIntPtr             lUserId;
  41
  42 public:
  43
  44                             ErrorInfo( sal_uIntPtr lArgUserId ) :
  45                                 lUserId( lArgUserId ){}
  46     virtual                 ~ErrorInfo();
  47
  48     sal_uIntPtr             GetErrorCode() const { return lUserId; }
  49
  50     static ErrorInfo*       GetErrorInfo(sal_uIntPtr);
  51 };
  52
  53 class TOOLS_DLLPUBLIC DynamicErrorInfo : public ErrorInfo
  54 {
  55     friend class DynamicErrorInfo_Impl;
  56
  57 private:
  58     std::unique_ptr<DynamicErrorInfo_Impl>   pImpl;
  59
  60 public:
  61
  62                             DynamicErrorInfo(sal_uIntPtr lUserId, sal_uInt16 nMask);
  63     virtual                 ~DynamicErrorInfo() override;
  64
  65     operator                sal_uIntPtr() const;
  66     sal_uInt16              GetDialogMask() const;
  67 };
  68
  69 class TOOLS_DLLPUBLIC StringErrorInfo : public DynamicErrorInfo
  70 {
  71 private:
  72     OUString                aString;
  73
  74 public:
  75
  76                             StringErrorInfo( sal_uIntPtr lUserId,
  77                                             const OUString& aStringP,
  78                                             sal_uInt16 nMask = 0);
  79     const OUString&         GetErrorString() const { return aString; }
  80 };
  81
  82 class TOOLS_DLLPUBLIC TwoStringErrorInfo: public DynamicErrorInfo
  83 {
  84 private:
  85     OUString aArg1;
  86     OUString aArg2;
  87
  88 public:
  89
  90     TwoStringErrorInfo(sal_uIntPtr nUserID, const OUString & rTheArg1,
  91                        const OUString & rTheArg2, sal_uInt16 nMask):
  92         DynamicErrorInfo(nUserID, nMask), aArg1(rTheArg1), aArg2(rTheArg2) {}
  93
  94     virtual ~TwoStringErrorInfo() override {}
  95
  96     const OUString& GetArg1() const { return aArg1; }
  97     const OUString& GetArg2() const { return aArg2; }
  98 };
  99
 100 struct ErrorContextImpl;
 101 class TOOLS_DLLPUBLIC ErrorContext
 102 {
 103     friend class ErrorHandler;
 104
 105 private:
 106     std::unique_ptr<ErrorContextImpl> pImpl;
 107
 108 public:
 109                             ErrorContext(vcl::Window *pWin);
 110     virtual                 ~ErrorContext();
 111
 112     virtual bool            GetString( sal_uIntPtr nErrId, OUString& rCtxStr ) = 0;
 113     vcl::Window*            GetParent();
 114
 115     static ErrorContext*    GetContext();
 116 };
 117
 118 typedef sal_uInt16 WindowDisplayErrorFunc(
 119     vcl::Window *, sal_uInt16 nMask, const OUString &rErr, const OUString &rAction);
 120
 121 typedef void BasicDisplayErrorFunc(
 122     const OUString &rErr, const OUString &rAction);
 123
 124 class TOOLS_DLLPUBLIC ErrorHandler
 125 {
 126     friend class ErrorHandler_Impl;
 127
 128 private:
 129     static sal_uInt16   HandleError_Impl( sal_uIntPtr lId,
 130                               sal_uInt16 nFlags,
 131                               bool bJustCreateString,
 132                               OUString & rError);
 133 protected:
 134     virtual bool        CreateString( const ErrorInfo *,
 135                               OUString &, sal_uInt16& nMask ) const = 0;
 136
 137 public:
 138                         ErrorHandler();
 139     virtual             ~ErrorHandler();
 140
 141     static sal_uInt16   HandleError ( sal_uIntPtr lId, sal_uInt16 nMask = USHRT_MAX );
 142     static bool         GetErrorString( sal_uIntPtr lId, OUString& rStr );
 143
 144     static void         RegisterDisplay( BasicDisplayErrorFunc* );
 145     static void         RegisterDisplay( WindowDisplayErrorFunc* );
 146 };
 147
 148 #endif
 149 #endif
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */