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#ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_FIELD_BASE_H__
32#define GOOGLE_PROTOBUF_COMPILER_CSHARP_FIELD_BASE_H__
33
34#include <string>
35#include <google/protobuf/stubs/strutil.h>
36
37#include <google/protobuf/compiler/code_generator.h>
38#include <google/protobuf/compiler/csharp/csharp_source_generator_base.h>
39
40namespace google {
41namespace protobuf {
42namespace compiler {
43namespace csharp {
44
45class FieldGeneratorBase : public SourceGeneratorBase {
46 public:
47  FieldGeneratorBase(const FieldDescriptor* descriptor,
48                     int fieldOrdinal,
49                     const Options* options);
50  ~FieldGeneratorBase();
51
52  virtual void GenerateCloningCode(io::Printer* printer) = 0;
53  virtual void GenerateFreezingCode(io::Printer* printer);
54  virtual void GenerateCodecCode(io::Printer* printer);
55  virtual void GenerateMembers(io::Printer* printer) = 0;
56  virtual void GenerateMergingCode(io::Printer* printer) = 0;
57  virtual void GenerateParsingCode(io::Printer* printer) = 0;
58  virtual void GenerateSerializationCode(io::Printer* printer) = 0;
59  virtual void GenerateSerializedSizeCode(io::Printer* printer) = 0;
60
61  virtual void WriteHash(io::Printer* printer) = 0;
62  virtual void WriteEquals(io::Printer* printer) = 0;
63  // Currently unused, as we use reflection to generate JSON
64  virtual void WriteToString(io::Printer* printer) = 0;
65
66 protected:
67  const FieldDescriptor* descriptor_;
68  const int fieldOrdinal_;
69  map<string, string> variables_;
70
71  void AddDeprecatedFlag(io::Printer* printer);
72  void AddNullCheck(io::Printer* printer);
73  void AddNullCheck(io::Printer* printer, const std::string& name);
74
75  void AddPublicMemberAttributes(io::Printer* printer);
76  void SetCommonOneofFieldVariables(map<string, string>* variables);
77
78  std::string oneof_property_name();
79  std::string oneof_name();
80  std::string property_name();
81  std::string name();
82  std::string type_name();
83  std::string type_name(const FieldDescriptor* descriptor);
84  bool has_default_value();
85  bool is_nullable_type();
86  std::string default_value();
87  std::string default_value(const FieldDescriptor* descriptor);
88  std::string number();
89  std::string capitalized_type_name();
90
91 private:
92  void SetCommonFieldVariables(map<string, string>* variables);
93  std::string GetStringDefaultValueInternal();
94  std::string GetBytesDefaultValueInternal();
95
96  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorBase);
97};
98
99}  // namespace csharp
100}  // namespace compiler
101}  // namespace protobuf
102}  // namespace google
103
104#endif  // GOOGLE_PROTOBUF_COMPILER_CSHARP_FIELD_BASE_H__
105
106