1fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Protocol Buffers - Google's data interchange format 2fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Copyright 2008 Google Inc. All rights reserved. 3fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// http://code.google.com/p/protobuf/ 4fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 5fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Redistribution and use in source and binary forms, with or without 6fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// modification, are permitted provided that the following conditions are 7fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// met: 8fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 9fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions of source code must retain the above copyright 10fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// notice, this list of conditions and the following disclaimer. 11fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions in binary form must reproduce the above 12fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// copyright notice, this list of conditions and the following disclaimer 13fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// in the documentation and/or other materials provided with the 14fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// distribution. 15fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Neither the name of Google Inc. nor the names of its 16fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// contributors may be used to endorse or promote products derived from 17fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// this software without specific prior written permission. 18fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 19fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 31fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Author: kenton@google.com (Kenton Varda) 32fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Based on original Protocol Buffers design by 33fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Sanjay Ghemawat, Jeff Dean, and others. 34fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 35fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifndef GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.h> 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville namespace io { 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class Printer; // printer.h 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace cpp { 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass EnumGenerator { 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // See generator.cc for the meaning of dllexport_decl. 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville explicit EnumGenerator(const EnumDescriptor* descriptor, 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& dllexport_decl); 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville ~EnumGenerator(); 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Header stuff. 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate header code defining the enum. This code should be placed 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // within the enum's package namespace, but NOT within any class, even for 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // nested enums. 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateDefinition(io::Printer* printer); 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate specialization of GetEnumDescriptor<MyEnum>(). 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Precondition: in ::google::protobuf namespace. 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateGetEnumDescriptorSpecializations(io::Printer* printer); 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // For enums nested within a message, generate code to import all the enum's 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // symbols (e.g. the enum type name, all its values, etc.) into the class's 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // namespace. This should be placed inside the class definition in the 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // header. 74fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateSymbolImports(io::Printer* printer); 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Source file stuff. 77fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate code that initializes the global variable storing the enum's 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // descriptor. 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateDescriptorInitializer(io::Printer* printer, int index); 81fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 82fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate non-inline methods related to the enum, such as IsValidValue(). 83fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Goes in the .cc file. 84fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateMethods(io::Printer* printer); 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const EnumDescriptor* descriptor_; 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string classname_; 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string dllexport_decl_; 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator); 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace cpp 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__ 100