1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
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_JAVA_FIELD_H__
36#define GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__
37
38#include <string>
39#include <google/protobuf/stubs/common.h>
40#include <google/protobuf/descriptor.h>
41
42namespace google {
43namespace protobuf {
44  namespace io {
45    class Printer;             // printer.h
46  }
47}
48
49namespace protobuf {
50namespace compiler {
51namespace java {
52
53class FieldGenerator {
54 public:
55  FieldGenerator() {}
56  virtual ~FieldGenerator();
57
58  virtual int GetNumBitsForMessage() const = 0;
59  virtual int GetNumBitsForBuilder() const = 0;
60  virtual void GenerateInterfaceMembers(io::Printer* printer) const = 0;
61  virtual void GenerateMembers(io::Printer* printer) const = 0;
62  virtual void GenerateBuilderMembers(io::Printer* printer) const = 0;
63  virtual void GenerateInitializationCode(io::Printer* printer) const = 0;
64  virtual void GenerateBuilderClearCode(io::Printer* printer) const = 0;
65  virtual void GenerateMergingCode(io::Printer* printer) const = 0;
66  virtual void GenerateBuildingCode(io::Printer* printer) const = 0;
67  virtual void GenerateParsingCode(io::Printer* printer) const = 0;
68  virtual void GenerateParsingCodeFromPacked(io::Printer* printer) const;
69  virtual void GenerateParsingDoneCode(io::Printer* printer) const = 0;
70  virtual void GenerateSerializationCode(io::Printer* printer) const = 0;
71  virtual void GenerateSerializedSizeCode(io::Printer* printer) const = 0;
72  virtual void GenerateFieldBuilderInitializationCode(io::Printer* printer)
73      const = 0;
74
75  virtual void GenerateEqualsCode(io::Printer* printer) const = 0;
76  virtual void GenerateHashCode(io::Printer* printer) const = 0;
77
78  virtual string GetBoxedType() const = 0;
79
80 private:
81  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGenerator);
82};
83
84// Convenience class which constructs FieldGenerators for a Descriptor.
85class FieldGeneratorMap {
86 public:
87  explicit FieldGeneratorMap(const Descriptor* descriptor);
88  ~FieldGeneratorMap();
89
90  const FieldGenerator& get(const FieldDescriptor* field) const;
91  const FieldGenerator& get_extension(int index) const;
92
93 private:
94  const Descriptor* descriptor_;
95  scoped_array<scoped_ptr<FieldGenerator> > field_generators_;
96  scoped_array<scoped_ptr<FieldGenerator> > extension_generators_;
97
98  static FieldGenerator* MakeGenerator(const FieldDescriptor* field,
99      int messageBitIndex, int builderBitIndex);
100
101  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap);
102};
103
104}  // namespace java
105}  // namespace compiler
106}  // namespace protobuf
107
108}  // namespace google
109#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__
110