extl/error/alloc_error.h

   1 /* ///////////////////////////////////////////////////////////////////////
   2  * File:                alloc_error.h
   3  *
   4  * Created:             08.04.30
   5  * Updated:             08.11.23
   6  *
   7  * Brief:               The Allocate Memory Error
   8  *
   9  * [<Home>]
  10  * Copyright (c) 2008-2020, Waruqi All rights reserved.
  11  * //////////////////////////////////////////////////////////////////// */
  12
  13 #ifndef EXTL_ERROR_ALLOC_ERROR_H
  14 #define EXTL_ERROR_ALLOC_ERROR_H
  15
  16 /*!\file alloc_error.h
  17  * \brief The Allocate Memory Error
  18  */
  19 #ifndef __cplusplus
  20 #       error alloc_error.h need be supported by c++.
  21 #endif
  22
  23 /* ///////////////////////////////////////////////////////////////////////
  24  * Includes
  25  */
  26 #include "prefix.h"
  27 #include "memory_error.h"
  28
  29 /* ///////////////////////////////////////////////////////////////////////
  30  * ::extl namespace
  31  */
  32 EXTL_BEGIN_NAMESPACE
  33
  34 /*!\brief alloc_error class
  35  *
  36  * \ingroup extl_group_error
  37  */
  38 class alloc_error
  39         : public memory_error
  40 {
  41         /// \name Types
  42         /// @{
  43         public:
  44                 typedef memory_error                                            base_type;
  45                 typedef alloc_error                                                     class_type;
  46                 typedef base_type::code_type                            code_type;
  47                 typedef base_type::string_type                          string_type;
  48                 typedef base_type::char_type                            char_type;
  49         /// @}
  50
  51         /// \name Constructors
  52         /// @{
  53         public:
  54                 explicit_k alloc_error(char_type const* reason = NULL , code_type error_code = 0)
  55                         : base_type(reason, error_code)
  56                 {}
  57         /// @}
  58
  59         /// \name Helpers
  60         /// @{
  61         protected:
  62                 virtual char_type const* get_default_reason() const
  63                 {
  64                         return "Unknown Allocate Memory Error";
  65                 }
  66         /// @}
  67 };
  68
  69 /* ///////////////////////////////////////////////////////////////////////
  70  * ::extl namespace
  71  */
  72 EXTL_END_NAMESPACE
  73
  74 /* //////////////////////////////////////////////////////////////////// */
  75 #endif /* EXTL_ERROR_ALLOC_ERROR_H */
  76 /* //////////////////////////////////////////////////////////////////// */
  77