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 31 // Author: kenton@google.com (Kenton Varda) 32 // Based on original Protocol Buffers design by 33 // Sanjay Ghemawat, Jeff Dean, and others. 34 35 #ifndef GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 37 38 #include <map> 39 #include <set> 40 #include <string> 41 #include <google/protobuf/compiler/cpp/cpp_options.h> 42 #include <google/protobuf/descriptor.h> 43 44 namespace google { 45 namespace protobuf { 46 namespace io { 47 class Printer; // printer.h 48 } 49 } // namespace protobuf 50 } // namespace google 51 52 namespace google { 53 namespace protobuf { 54 namespace compiler { 55 namespace cpp { 56 57 class EnumGenerator { 58 public: 59 // See generator.cc for the meaning of dllexport_decl. 60 EnumGenerator(const EnumDescriptor* descriptor, 61 const std::map<std::string, std::string>& vars, 62 const Options& options); 63 ~EnumGenerator(); 64 65 // Generate header code defining the enum. This code should be placed 66 // within the enum's package namespace, but NOT within any class, even for 67 // nested enums. 68 void GenerateDefinition(io::Printer* printer); 69 70 // Generate specialization of GetEnumDescriptor<MyEnum>(). 71 // Precondition: in ::google::protobuf namespace. 72 void GenerateGetEnumDescriptorSpecializations(io::Printer* printer); 73 74 // For enums nested within a message, generate code to import all the enum's 75 // symbols (e.g. the enum type name, all its values, etc.) into the class's 76 // namespace. This should be placed inside the class definition in the 77 // header. 78 void GenerateSymbolImports(io::Printer* printer) const; 79 80 // Source file stuff. 81 82 // Generate non-inline methods related to the enum, such as IsValidValue(). 83 // Goes in the .cc file. EnumDescriptors are stored in an array, idx is 84 // the index in this array that corresponds with this enum. 85 void GenerateMethods(int idx, io::Printer* printer); 86 87 private: 88 const EnumDescriptor* descriptor_; 89 const std::string classname_; 90 const Options& options_; 91 // whether to generate the *_ARRAYSIZE constant. 92 const bool generate_array_size_; 93 94 std::map<std::string, std::string> variables_; 95 96 friend class FileGenerator; 97 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator); 98 }; 99 100 } // namespace cpp 101 } // namespace compiler 102 } // namespace protobuf 103 } // namespace google 104 105 #endif // GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 106