100 lines
3.6 KiB
C++
100 lines
3.6 KiB
C++
// Protocol Buffers - Google's data interchange format
|
|
// Copyright 2008 Google Inc. All rights reserved.
|
|
// http://code.google.com/p/protobuf/
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are
|
|
// met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
// in the documentation and/or other materials provided with the
|
|
// distribution.
|
|
// * Neither the name of Google Inc. nor the names of its
|
|
// contributors may be used to endorse or promote products derived from
|
|
// this software without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
// Author: kenton@google.com (Kenton Varda)
|
|
// Based on original Protocol Buffers design by
|
|
// Sanjay Ghemawat, Jeff Dean, and others.
|
|
|
|
#ifndef GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
|
|
#define GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
|
|
|
|
#include <string>
|
|
#include <google/protobuf/descriptor.h>
|
|
|
|
namespace google {
|
|
namespace protobuf {
|
|
namespace io {
|
|
class Printer; // printer.h
|
|
}
|
|
}
|
|
|
|
namespace protobuf {
|
|
namespace compiler {
|
|
namespace cpp {
|
|
|
|
class EnumGenerator {
|
|
public:
|
|
// See generator.cc for the meaning of dllexport_decl.
|
|
explicit EnumGenerator(const EnumDescriptor* descriptor,
|
|
const string& dllexport_decl);
|
|
~EnumGenerator();
|
|
|
|
// Header stuff.
|
|
|
|
// Generate header code defining the enum. This code should be placed
|
|
// within the enum's package namespace, but NOT within any class, even for
|
|
// nested enums.
|
|
void GenerateDefinition(io::Printer* printer);
|
|
|
|
// Generate specialization of GetEnumDescriptor<MyEnum>().
|
|
// Precondition: in ::google::protobuf namespace.
|
|
void GenerateGetEnumDescriptorSpecializations(io::Printer* printer);
|
|
|
|
// For enums nested within a message, generate code to import all the enum's
|
|
// symbols (e.g. the enum type name, all its values, etc.) into the class's
|
|
// namespace. This should be placed inside the class definition in the
|
|
// header.
|
|
void GenerateSymbolImports(io::Printer* printer);
|
|
|
|
// Source file stuff.
|
|
|
|
// Generate code that initializes the global variable storing the enum's
|
|
// descriptor.
|
|
void GenerateDescriptorInitializer(io::Printer* printer, int index);
|
|
|
|
// Generate non-inline methods related to the enum, such as IsValidValue().
|
|
// Goes in the .cc file.
|
|
void GenerateMethods(io::Printer* printer);
|
|
|
|
private:
|
|
const EnumDescriptor* descriptor_;
|
|
string classname_;
|
|
string dllexport_decl_;
|
|
|
|
GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator);
|
|
};
|
|
|
|
} // namespace cpp
|
|
} // namespace compiler
|
|
} // namespace protobuf
|
|
|
|
} // namespace google
|
|
#endif // GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
|