1
// Protocol Buffers - Google's data interchange format
2
// Copyright 2008 Google Inc. All rights reserved.
3
// http://code.google.com/p/protobuf/
5
// Redistribution and use in source and binary forms, with or without
6
// modification, are permitted provided that the following conditions are
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
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.
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.
31
// Author: kenton@google.com (Kenton Varda)
32
// Based on original Protocol Buffers design by
33
// Sanjay Ghemawat, Jeff Dean, and others.
35
#ifndef GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
36
#define GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
39
#include <google/protobuf/compiler/cpp/cpp_options.h>
40
#include <google/protobuf/descriptor.h>
46
class Printer; // printer.h
56
// See generator.cc for the meaning of dllexport_decl.
57
explicit EnumGenerator(const EnumDescriptor* descriptor,
58
const Options& options);
63
// Generate header code defining the enum. This code should be placed
64
// within the enum's package namespace, but NOT within any class, even for
66
void GenerateDefinition(io::Printer* printer);
68
// Generate specialization of GetEnumDescriptor<MyEnum>().
69
// Precondition: in ::google::protobuf namespace.
70
void GenerateGetEnumDescriptorSpecializations(io::Printer* printer);
72
// For enums nested within a message, generate code to import all the enum's
73
// symbols (e.g. the enum type name, all its values, etc.) into the class's
74
// namespace. This should be placed inside the class definition in the
76
void GenerateSymbolImports(io::Printer* printer);
80
// Generate code that initializes the global variable storing the enum's
82
void GenerateDescriptorInitializer(io::Printer* printer, int index);
84
// Generate non-inline methods related to the enum, such as IsValidValue().
85
// Goes in the .cc file.
86
void GenerateMethods(io::Printer* printer);
89
const EnumDescriptor* descriptor_;
93
GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator);
97
} // namespace compiler
98
} // namespace protobuf
100
} // namespace google
101
#endif // GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__