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