generated_enum_reflection.h 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. // Author: jasonh@google.com (Jason Hsueh)
  31. //
  32. // This header is logically internal, but is made public because it is used
  33. // from protocol-compiler-generated code, which may reside in other components.
  34. // It provides reflection support for generated enums, and is included in
  35. // generated .pb.h files and should have minimal dependencies. The methods are
  36. // implemented in generated_message_reflection.cc.
  37. #ifndef GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
  38. #define GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
  39. #include <string>
  40. #include <google/protobuf/generated_enum_util.h>
  41. #include <google/protobuf/port.h>
  42. #include <google/protobuf/stubs/strutil.h>
  43. #ifdef SWIG
  44. #error "You cannot SWIG proto headers"
  45. #endif
  46. #include <google/protobuf/port_def.inc>
  47. namespace google {
  48. namespace protobuf {
  49. class EnumDescriptor;
  50. } // namespace protobuf
  51. } // namespace google
  52. namespace google {
  53. namespace protobuf {
  54. // Returns the EnumDescriptor for enum type E, which must be a
  55. // proto-declared enum type. Code generated by the protocol compiler
  56. // will include specializations of this template for each enum type declared.
  57. template <typename E>
  58. const EnumDescriptor* GetEnumDescriptor();
  59. namespace internal {
  60. // Helper for EnumType_Parse functions: try to parse the string 'name' as
  61. // an enum name of the given type, returning true and filling in value on
  62. // success, or returning false and leaving value unchanged on failure.
  63. PROTOBUF_EXPORT bool ParseNamedEnum(const EnumDescriptor* descriptor,
  64. ConstStringParam name, int* value);
  65. template <typename EnumType>
  66. bool ParseNamedEnum(const EnumDescriptor* descriptor, ConstStringParam name,
  67. EnumType* value) {
  68. int tmp;
  69. if (!ParseNamedEnum(descriptor, name, &tmp)) return false;
  70. *value = static_cast<EnumType>(tmp);
  71. return true;
  72. }
  73. // Just a wrapper around printing the name of a value. The main point of this
  74. // function is not to be inlined, so that you can do this without including
  75. // descriptor.h.
  76. PROTOBUF_EXPORT const std::string& NameOfEnum(const EnumDescriptor* descriptor,
  77. int value);
  78. } // namespace internal
  79. } // namespace protobuf
  80. } // namespace google
  81. #include <google/protobuf/port_undef.inc>
  82. #endif // GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__