javanano_field.h revision fea3fd5cb6ff88b51da60b1f33004944d93a9fce 
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#include <google/protobuf/compiler/javanano/javanano_params.h>
42
43namespace google {
44namespace protobuf {
45  namespace io {
46    class Printer;             // printer.h
47  }
48}
49
50namespace protobuf {
51namespace compiler {
52namespace javanano {
53
54class FieldGenerator {
55 public:
56  //FieldGenerator() {}
57  FieldGenerator(const Params& params) : params_(params) {}
58  virtual ~FieldGenerator();
59
60  virtual void GenerateMembers(io::Printer* printer) const = 0;
61  virtual void GenerateClearCode(io::Printer* printer) const = 0;
62  virtual void GenerateMergingCode(io::Printer* printer) const = 0;
63
64  // Generates code to merge from packed serialized form. The default
65  // implementation will fail; subclasses which can handle packed serialized
66  // forms will override this and print appropriate code to the printer.
67  virtual void GenerateMergingCodeFromPacked(io::Printer* printer) const;
68
69  virtual void GenerateSerializationCode(io::Printer* printer) const = 0;
70  virtual void GenerateSerializedSizeCode(io::Printer* printer) const = 0;
71  virtual void GenerateEqualsCode(io::Printer* printer) const = 0;
72  virtual void GenerateHashCodeCode(io::Printer* printer) const = 0;
73
74 protected:
75  const Params& params_;
76 private:
77  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGenerator);
78};
79
80// Convenience class which constructs FieldGenerators for a Descriptor.
81class FieldGeneratorMap {
82 public:
83  explicit FieldGeneratorMap(const Descriptor* descriptor, const Params &params);
84  ~FieldGeneratorMap();
85
86  const FieldGenerator& get(const FieldDescriptor* field) const;
87  const FieldGenerator& get_extension(int index) const;
88  int total_bits() const { return total_bits_; }
89
90 private:
91  const Descriptor* descriptor_;
92  scoped_array<scoped_ptr<FieldGenerator> > field_generators_;
93  scoped_array<scoped_ptr<FieldGenerator> > extension_generators_;
94  int total_bits_;
95
96  static FieldGenerator* MakeGenerator(const FieldDescriptor* field,
97      const Params &params, int* next_has_bit_index);
98
99  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap);
100};
101
102}  // namespace javanano
103}  // namespace compiler
104}  // namespace protobuf
105
106}  // namespace google
107#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__
108