extl/type/null_type.h

   1 /* ///////////////////////////////////////////////////////////////////////
   2  * File:                null_type.h
   3  *
   4  * Created:             08.07.16
   5  * Updated:             08.07.16
   6  *
   7  * Brief: The null type - as type placeholder instead of void type
   8  *
   9  * [<Home>]
  10  * Copyright (c) 2008-2020, Waruqi All rights reserved.
  11  * //////////////////////////////////////////////////////////////////// */
  12 #ifndef EXTL_TYPE_NULL_TYPE_H
  13 #define EXTL_TYPE_NULL_TYPE_H
  14
  15 /* ///////////////////////////////////////////////////////////////////////
  16  * Includes
  17  */
  18 #include "../config/config.h"
  19 #include "typedef.h"
  20
  21 /* ///////////////////////////////////////////////////////////////////////
  22  * ::extl namespace
  23  */
  24 EXTL_BEGIN_NAMESPACE
  25
  26 #ifdef __cplusplus
  27
  28 // forward declaration
  29 struct null_type;
  30 EXTL_INLINE null_type const& cnull();
  31
  32 // null_type
  33 struct null_type
  34 {
  35         private:
  36                 // Prohibit generating an instance
  37                 null_type(){};
  38                 // Prohibit copy constructor
  39                 null_type(null_type const&);
  40                 // Prohibit assignment
  41                 null_type& operator =(null_type const&);
  42
  43         public:
  44                 /* Gets a const reference instance as ab placeholder
  45                  * e.g.
  46                  * void func(null_type const& p = cnull());
  47                  */
  48                 friend null_type const& cnull()
  49                 {
  50                         /* a helper function to provide a static const null_type instance */
  51                         static const null_type s_null_obj;
  52                         return s_null_obj;
  53                 }
  54 };
  55
  56 // is_null_type traits
  57 template < typename_param_k T >
  58 struct is_null_type
  59 {
  60         EXTL_STATIC_MEMBER_CONST(e_bool_t, value = e_false_v);
  61 };
  62
  63 EXTL_TEMPLATE_SPECIALISATION
  64 struct is_null_type<null_type>
  65 {
  66         EXTL_STATIC_MEMBER_CONST(e_bool_t, value = e_true_v);
  67 };
  68
  69 #else /* !__cplusplus */
  70
  71 typedef struct null_type_tag{}          null_type;
  72 /* a helper function to provide a const null_type type temporary */
  73 EXTL_INLINE const null_type cnull()     { return null_type();   }
  74
  75 #endif /* __cplusplus */
  76
  77 /* e_null_t */
  78 typedef null_type                               e_null_t;
  79
  80 /* ///////////////////////////////////////////////////////////////////////
  81  * ::extl namespace
  82  */
  83 EXTL_END_NAMESPACE
  84
  85 /* //////////////////////////////////////////////////////////////////// */
  86 #endif /* EXTL_TYPE_NULL_TYPE_H */
  87 /* //////////////////////////////////////////////////////////////////// */