You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

136 lines
6.0 KiB

  1. /* /////////////////////////////////////////////////////////////////////////
  2. * File: stlsoft/util/forward_enums.hpp (originally MLFwdEnm.h)
  3. *
  4. * Purpose: Contains macros for forward declaring enums.
  5. *
  6. * Created: 3rd November 2000
  7. * Updated: 29th April 2010
  8. *
  9. * Home: http://stlsoft.org/
  10. *
  11. * Copyright (c) 2000-2010, Matthew Wilson and Synesis Software
  12. * All rights reserved.
  13. *
  14. * Redistribution and use in source and binary forms, with or without
  15. * modification, are permitted provided that the following conditions are met:
  16. *
  17. * - Redistributions of source code must retain the above copyright notice, this
  18. * list of conditions and the following disclaimer.
  19. * - Redistributions in binary form must reproduce the above copyright notice,
  20. * this list of conditions and the following disclaimer in the documentation
  21. * and/or other materials provided with the distribution.
  22. * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
  23. * any contributors may be used to endorse or promote products derived from
  24. * this software without specific prior written permission.
  25. *
  26. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  27. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29. * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  30. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  33. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  34. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36. * POSSIBILITY OF SUCH DAMAGE.
  37. *
  38. * ////////////////////////////////////////////////////////////////////// */
  39. /** \file stlsoft/util/forward_enums.hpp
  40. *
  41. * \brief [C++ only] Macros for declaring and defining forward enums
  42. * (\ref group__library__utility "Utility" Library).
  43. */
  44. #ifndef STLSOFT_INCL_STLSOFT_HPP_FORWARD_ENUM
  45. #define STLSOFT_INCL_STLSOFT_HPP_FORWARD_ENUM
  46. #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
  47. # define STLSOFT_VER_STLSOFT_HPP_FORWARD_ENUM_MAJOR 3
  48. # define STLSOFT_VER_STLSOFT_HPP_FORWARD_ENUM_MINOR 0
  49. # define STLSOFT_VER_STLSOFT_HPP_FORWARD_ENUM_REVISION 2
  50. # define STLSOFT_VER_STLSOFT_HPP_FORWARD_ENUM_EDIT 46
  51. #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
  52. /* /////////////////////////////////////////////////////////////////////////
  53. * Includes
  54. */
  55. #ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT
  56. # include <stlsoft/stlsoft.h>
  57. #endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */
  58. /* /////////////////////////////////////////////////////////////////////////
  59. * Namespace
  60. */
  61. #ifndef _STLSOFT_NO_NAMESPACE
  62. namespace stlsoft
  63. {
  64. #endif /* _STLSOFT_NO_NAMESPACE */
  65. /* /////////////////////////////////////////////////////////////////////////
  66. * Macros
  67. */
  68. #define STLSOFT_DECLARE_FWD_ENUM(X) \
  69. \
  70. struct X ## _type_; \
  71. \
  72. typedef X ## _type_ X
  73. #define STLSOFT_DEFINE_FWD_ENUM_BEGIN(X) \
  74. \
  75. enum X ## _enum_ \
  76. {
  77. #define STLSOFT_DEFINE_FWD_ENUM_END(X) \
  78. \
  79. }; \
  80. \
  81. STLSOFT_DECLARE_FWD_ENUM(X); \
  82. \
  83. struct X ## _type_ \
  84. { \
  85. public: \
  86. typedef X ## _enum_ enum_type; \
  87. public: \
  88. static X ## _type_ cast(long l) \
  89. { \
  90. return X ## _type_ (static_cast<X ## _enum_>(l)); \
  91. } \
  92. \
  93. public: \
  94. X ## _type_(X ## _enum_ e) \
  95. : m_e(e) \
  96. {} \
  97. \
  98. operator X ## _enum_ () const \
  99. { \
  100. return m_e; \
  101. } \
  102. \
  103. int to_int() const \
  104. { \
  105. return m_e; \
  106. } \
  107. \
  108. private: \
  109. X ## _enum_ m_e; \
  110. };
  111. /* ////////////////////////////////////////////////////////////////////// */
  112. #ifndef _STLSOFT_NO_NAMESPACE
  113. } // namespace stlsoft
  114. #endif /* _STLSOFT_NO_NAMESPACE */
  115. /* ////////////////////////////////////////////////////////////////////// */
  116. #endif /* !STLSOFT_INCL_STLSOFT_HPP_FORWARD_ENUM */
  117. /* ///////////////////////////// end of file //////////////////////////// */