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 } 50 51 namespace protobuf { 52 namespace compiler { 53 namespace cpp { 54 55 class EnumGenerator { 56 public: 57 // See generator.cc for the meaning of dllexport_decl. 58 EnumGenerator(const EnumDescriptor* descriptor, const Options& options); 59 ~EnumGenerator(); 60 61 // Header stuff. 62 63 // Fills the name to use when declaring the enum. This is for use when 64 // generating other .proto.h files. This code should be placed within the 65 // enum's package namespace, but NOT within any class, even for nested 66 // enums. A given key in enum_names will map from an enum class name to the 67 // EnumDescriptor that was responsible for its inclusion in the map. This can 68 // be used to associate the descriptor with the code generated for it. 69 void FillForwardDeclaration(map<string, const EnumDescriptor*>* enum_names); 70 71 // Generate header code defining the enum. This code should be placed 72 // within the enum's package namespace, but NOT within any class, even for 73 // nested enums. 74 void GenerateDefinition(io::Printer* printer); 75 76 // Generate specialization of GetEnumDescriptor<MyEnum>(). 77 // Precondition: in ::google::protobuf namespace. 78 void GenerateGetEnumDescriptorSpecializations(io::Printer* printer); 79 80 // For enums nested within a message, generate code to import all the enum's 81 // symbols (e.g. the enum type name, all its values, etc.) into the class's 82 // namespace. This should be placed inside the class definition in the 83 // header. 84 void GenerateSymbolImports(io::Printer* printer); 85 86 // Source file stuff. 87 88 // Generate code that initializes the global variable storing the enum's 89 // descriptor. 90 void GenerateDescriptorInitializer(io::Printer* printer, int index); 91 92 // Generate non-inline methods related to the enum, such as IsValidValue(). 93 // Goes in the .cc file. 94 void GenerateMethods(io::Printer* printer); 95 96 private: 97 const EnumDescriptor* descriptor_; 98 const string classname_; 99 const Options& options_; 100 // whether to generate the *_ARRAYSIZE constant. 101 const bool generate_array_size_; 102 103 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator); 104 }; 105 106 } // namespace cpp 107 } // namespace compiler 108 } // namespace protobuf 109 110 } // namespace google 111 #endif // GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 112