protobuf 2.8.0.beta9 → 2.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (204) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +0 -1
  3. data/{UPGRADING.md → CHANGES.md} +20 -12
  4. data/LICENSE.txt +14 -0
  5. data/README.md +60 -74
  6. data/bin/protoc-gen-ruby +26 -0
  7. data/bin/rprotoc +4 -58
  8. data/lib/protobuf.rb +15 -13
  9. data/lib/protobuf/code_generator.rb +41 -0
  10. data/lib/protobuf/descriptors/google/protobuf/compiler/plugin.pb.rb +51 -0
  11. data/lib/protobuf/descriptors/google/protobuf/descriptor.pb.rb +248 -0
  12. data/lib/protobuf/field/base_field.rb +0 -1
  13. data/lib/protobuf/field/bytes_field.rb +1 -1
  14. data/lib/protobuf/field/message_field.rb +2 -4
  15. data/lib/protobuf/field/varint_field.rb +4 -7
  16. data/lib/protobuf/generators/base.rb +71 -0
  17. data/lib/protobuf/generators/enum_generator.rb +31 -0
  18. data/lib/protobuf/generators/extension_generator.rb +28 -0
  19. data/lib/protobuf/generators/field_generator.rb +132 -0
  20. data/lib/protobuf/generators/file_generator.rb +140 -0
  21. data/lib/protobuf/generators/group_generator.rb +113 -0
  22. data/lib/protobuf/generators/message_generator.rb +99 -0
  23. data/lib/protobuf/generators/printable.rb +161 -0
  24. data/lib/protobuf/generators/service_generator.rb +27 -0
  25. data/lib/protobuf/lifecycle.rb +7 -3
  26. data/lib/protobuf/message.rb +51 -34
  27. data/lib/protobuf/rpc/connectors/common.rb +4 -6
  28. data/lib/protobuf/rpc/server.rb +1 -1
  29. data/lib/protobuf/rpc/servers/zmq/server.rb +2 -2
  30. data/lib/protobuf/rpc/servers/zmq/worker.rb +2 -2
  31. data/lib/protobuf/rpc/service.rb +3 -3
  32. data/lib/protobuf/rpc/service_directory.rb +24 -12
  33. data/lib/protobuf/version.rb +1 -1
  34. data/proto/google/protobuf/compiler/plugin.proto +147 -0
  35. data/proto/google/protobuf/descriptor.proto +620 -0
  36. data/protobuf.gemspec +12 -21
  37. data/spec/bin/protoc-gen-ruby_spec.rb +18 -0
  38. data/spec/data/data.bin +3 -0
  39. data/{test/data/unk.png → spec/data/types.bin} +0 -0
  40. data/spec/encoding/all_types_spec.rb +91 -0
  41. data/spec/encoding/extreme_values_spec.rb +0 -0
  42. data/spec/lib/protobuf/code_generator_spec.rb +60 -0
  43. data/spec/lib/protobuf/generators/base_spec.rb +87 -0
  44. data/spec/lib/protobuf/generators/enum_generator_spec.rb +45 -0
  45. data/spec/lib/protobuf/generators/extension_generator_spec.rb +43 -0
  46. data/spec/lib/protobuf/generators/field_generator_spec.rb +99 -0
  47. data/spec/lib/protobuf/generators/file_generator_spec.rb +29 -0
  48. data/spec/lib/protobuf/generators/message_generator_spec.rb +0 -0
  49. data/spec/lib/protobuf/generators/service_generator_spec.rb +43 -0
  50. data/spec/lib/protobuf/lifecycle_spec.rb +31 -1
  51. data/spec/lib/protobuf/logger_spec.rb +5 -0
  52. data/spec/lib/protobuf/message_spec.rb +22 -8
  53. data/spec/lib/protobuf/rpc/connectors/common_spec.rb +1 -1
  54. data/spec/lib/protobuf/rpc/service_directory_spec.rb +45 -7
  55. data/spec/lib/protobuf/rpc/service_spec.rb +3 -3
  56. data/spec/spec_helper.rb +15 -16
  57. data/spec/support/test/all_types.data.bin +0 -0
  58. data/spec/support/test/all_types.data.txt +119 -0
  59. data/spec/support/test/defaults.pb.rb +25 -0
  60. data/spec/support/test/defaults.proto +9 -0
  61. data/spec/support/test/enum.pb.rb +10 -8
  62. data/spec/support/test/extended.pb.rb +5 -3
  63. data/spec/support/test/extreme_values.data.bin +0 -0
  64. data/spec/support/test/google_unittest.pb.rb +543 -0
  65. data/spec/support/test/google_unittest.proto +713 -0
  66. data/spec/support/test/google_unittest_import.pb.rb +37 -0
  67. data/{ext/protobuf-2.4.1/src/google/protobuf/io/package_info.h → spec/support/test/google_unittest_import.proto} +27 -17
  68. data/spec/support/test/google_unittest_import_public.pb.rb +8 -0
  69. data/{ext/protobuf-2.4.1/src/google/protobuf/io/coded_stream_inl.h → spec/support/test/google_unittest_import_public.proto} +5 -31
  70. data/spec/support/test/multi_field_extensions.pb.rb +29 -7
  71. data/spec/support/test/multi_field_extensions.proto +12 -2
  72. data/spec/support/test/resource.pb.rb +20 -16
  73. metadata +149 -236
  74. data/examples/addressbook.pb.rb +0 -55
  75. data/examples/addressbook.proto +0 -24
  76. data/examples/reading_a_message.rb +0 -32
  77. data/examples/writing_a_message.rb +0 -46
  78. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/code_generator.h +0 -142
  79. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/command_line_interface.h +0 -318
  80. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_enum.h +0 -99
  81. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_enum_field.h +0 -103
  82. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_extension.h +0 -85
  83. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_field.h +0 -167
  84. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_file.h +0 -98
  85. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_generator.h +0 -72
  86. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_helpers.h +0 -159
  87. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_message.h +0 -170
  88. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_message_field.h +0 -102
  89. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_primitive_field.h +0 -103
  90. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_service.h +0 -118
  91. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_string_field.h +0 -104
  92. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/cpp/cpp_test_bad_identifiers.pb.h +0 -2721
  93. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/importer.h +0 -303
  94. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_enum.h +0 -84
  95. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_enum_field.h +0 -121
  96. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_extension.h +0 -77
  97. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_field.h +0 -108
  98. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_file.h +0 -101
  99. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_generator.h +0 -72
  100. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_helpers.h +0 -213
  101. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_message.h +0 -109
  102. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_message_field.h +0 -134
  103. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_primitive_field.h +0 -121
  104. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_service.h +0 -113
  105. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/java/java_string_field.h +0 -120
  106. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/mock_code_generator.h +0 -113
  107. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/package_info.h +0 -64
  108. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/parser.h +0 -434
  109. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/plugin.h +0 -73
  110. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/plugin.pb.h +0 -790
  111. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/python/python_generator.h +0 -156
  112. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/subprocess.h +0 -108
  113. data/ext/protobuf-2.4.1/src/google/protobuf/compiler/zip_writer.h +0 -93
  114. data/ext/protobuf-2.4.1/src/google/protobuf/descriptor.h +0 -1367
  115. data/ext/protobuf-2.4.1/src/google/protobuf/descriptor.pb.h +0 -5223
  116. data/ext/protobuf-2.4.1/src/google/protobuf/descriptor_database.h +0 -366
  117. data/ext/protobuf-2.4.1/src/google/protobuf/dynamic_message.h +0 -136
  118. data/ext/protobuf-2.4.1/src/google/protobuf/extension_set.h +0 -904
  119. data/ext/protobuf-2.4.1/src/google/protobuf/generated_message_reflection.h +0 -424
  120. data/ext/protobuf-2.4.1/src/google/protobuf/generated_message_util.h +0 -82
  121. data/ext/protobuf-2.4.1/src/google/protobuf/io/coded_stream.h +0 -1102
  122. data/ext/protobuf-2.4.1/src/google/protobuf/io/gzip_stream.h +0 -207
  123. data/ext/protobuf-2.4.1/src/google/protobuf/io/printer.h +0 -136
  124. data/ext/protobuf-2.4.1/src/google/protobuf/io/tokenizer.h +0 -313
  125. data/ext/protobuf-2.4.1/src/google/protobuf/io/zero_copy_stream.h +0 -238
  126. data/ext/protobuf-2.4.1/src/google/protobuf/io/zero_copy_stream_impl.h +0 -357
  127. data/ext/protobuf-2.4.1/src/google/protobuf/io/zero_copy_stream_impl_lite.h +0 -340
  128. data/ext/protobuf-2.4.1/src/google/protobuf/message.h +0 -692
  129. data/ext/protobuf-2.4.1/src/google/protobuf/message_lite.h +0 -239
  130. data/ext/protobuf-2.4.1/src/google/protobuf/package_info.h +0 -64
  131. data/ext/protobuf-2.4.1/src/google/protobuf/reflection_ops.h +0 -80
  132. data/ext/protobuf-2.4.1/src/google/protobuf/repeated_field.h +0 -1295
  133. data/ext/protobuf-2.4.1/src/google/protobuf/service.h +0 -291
  134. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/common.h +0 -1211
  135. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/hash.h +0 -220
  136. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/map-util.h +0 -119
  137. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/once.h +0 -123
  138. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/stl_util-inl.h +0 -121
  139. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/strutil.h +0 -457
  140. data/ext/protobuf-2.4.1/src/google/protobuf/stubs/substitute.h +0 -170
  141. data/ext/protobuf-2.4.1/src/google/protobuf/test_util.h +0 -174
  142. data/ext/protobuf-2.4.1/src/google/protobuf/test_util_lite.h +0 -101
  143. data/ext/protobuf-2.4.1/src/google/protobuf/testing/file.h +0 -83
  144. data/ext/protobuf-2.4.1/src/google/protobuf/testing/googletest.h +0 -98
  145. data/ext/protobuf-2.4.1/src/google/protobuf/text_format.h +0 -285
  146. data/ext/protobuf-2.4.1/src/google/protobuf/unittest.pb.h +0 -11915
  147. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_custom_options.pb.h +0 -2895
  148. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_embed_optimize_for.pb.h +0 -211
  149. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_empty.pb.h +0 -56
  150. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_import.pb.h +0 -188
  151. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_import_lite.pb.h +0 -151
  152. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_lite.pb.h +0 -4752
  153. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_lite_imports_nonlite.pb.h +0 -150
  154. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_mset.pb.h +0 -816
  155. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_no_generic_services.pb.h +0 -197
  156. data/ext/protobuf-2.4.1/src/google/protobuf/unittest_optimize_for.pb.h +0 -403
  157. data/ext/protobuf-2.4.1/src/google/protobuf/unknown_field_set.h +0 -268
  158. data/ext/protobuf-2.4.1/src/google/protobuf/wire_format.h +0 -304
  159. data/ext/protobuf-2.4.1/src/google/protobuf/wire_format_lite.h +0 -620
  160. data/ext/protobuf-2.4.1/src/google/protobuf/wire_format_lite_inl.h +0 -774
  161. data/ext/ruby_generator/Makefile +0 -10
  162. data/ext/ruby_generator/RubyGenerator.cpp +0 -544
  163. data/ext/ruby_generator/RubyGenerator.h +0 -206
  164. data/ext/ruby_generator/extconf.rb +0 -35
  165. data/test/data/data_source.py +0 -14
  166. data/test/data/types_source.py +0 -22
  167. data/test/proto/addressbook.pb.rb +0 -66
  168. data/test/proto/addressbook.proto +0 -33
  169. data/test/proto/addressbook_base.pb.rb +0 -58
  170. data/test/proto/addressbook_base.proto +0 -26
  171. data/test/proto/addressbook_ext.pb.rb +0 -20
  172. data/test/proto/addressbook_ext.proto +0 -6
  173. data/test/proto/collision.pb.rb +0 -17
  174. data/test/proto/collision.proto +0 -5
  175. data/test/proto/ext_collision.pb.rb +0 -24
  176. data/test/proto/ext_collision.proto +0 -8
  177. data/test/proto/ext_range.pb.rb +0 -22
  178. data/test/proto/ext_range.proto +0 -7
  179. data/test/proto/float_default.proto +0 -10
  180. data/test/proto/lowercase.pb.rb +0 -30
  181. data/test/proto/lowercase.proto +0 -9
  182. data/test/proto/merge.pb.rb +0 -39
  183. data/test/proto/merge.proto +0 -15
  184. data/test/proto/nested.pb.rb +0 -30
  185. data/test/proto/nested.proto +0 -9
  186. data/test/proto/optional_field.pb.rb +0 -35
  187. data/test/proto/optional_field.proto +0 -12
  188. data/test/proto/packed.pb.rb +0 -22
  189. data/test/proto/packed.proto +0 -6
  190. data/test/proto/rpc.proto +0 -6
  191. data/test/proto/types.pb.rb +0 -84
  192. data/test/proto/types.proto +0 -37
  193. data/test/test_addressbook.rb +0 -56
  194. data/test/test_enum_value.rb +0 -41
  195. data/test/test_extension.rb +0 -36
  196. data/test/test_lowercase.rb +0 -11
  197. data/test/test_message.rb +0 -128
  198. data/test/test_optional_field.rb +0 -103
  199. data/test/test_packed_field.rb +0 -40
  200. data/test/test_parse.rb +0 -15
  201. data/test/test_repeated_types.rb +0 -132
  202. data/test/test_serialize.rb +0 -61
  203. data/test/test_standard_message.rb +0 -96
  204. data/test/test_types.rb +0 -226
@@ -1,366 +0,0 @@
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
- // Interface for manipulating databases of descriptors.
36
-
37
- #ifndef GOOGLE_PROTOBUF_DESCRIPTOR_DATABASE_H__
38
- #define GOOGLE_PROTOBUF_DESCRIPTOR_DATABASE_H__
39
-
40
- #include <map>
41
- #include <string>
42
- #include <utility>
43
- #include <vector>
44
- #include <google/protobuf/descriptor.h>
45
-
46
- namespace google {
47
- namespace protobuf {
48
-
49
- // Defined in this file.
50
- class DescriptorDatabase;
51
- class SimpleDescriptorDatabase;
52
- class EncodedDescriptorDatabase;
53
- class DescriptorPoolDatabase;
54
- class MergedDescriptorDatabase;
55
-
56
- // Abstract interface for a database of descriptors.
57
- //
58
- // This is useful if you want to create a DescriptorPool which loads
59
- // descriptors on-demand from some sort of large database. If the database
60
- // is large, it may be inefficient to enumerate every .proto file inside it
61
- // calling DescriptorPool::BuildFile() for each one. Instead, a DescriptorPool
62
- // can be created which wraps a DescriptorDatabase and only builds particular
63
- // descriptors when they are needed.
64
- class LIBPROTOBUF_EXPORT DescriptorDatabase {
65
- public:
66
- inline DescriptorDatabase() {}
67
- virtual ~DescriptorDatabase();
68
-
69
- // Find a file by file name. Fills in in *output and returns true if found.
70
- // Otherwise, returns false, leaving the contents of *output undefined.
71
- virtual bool FindFileByName(const string& filename,
72
- FileDescriptorProto* output) = 0;
73
-
74
- // Find the file that declares the given fully-qualified symbol name.
75
- // If found, fills in *output and returns true, otherwise returns false
76
- // and leaves *output undefined.
77
- virtual bool FindFileContainingSymbol(const string& symbol_name,
78
- FileDescriptorProto* output) = 0;
79
-
80
- // Find the file which defines an extension extending the given message type
81
- // with the given field number. If found, fills in *output and returns true,
82
- // otherwise returns false and leaves *output undefined. containing_type
83
- // must be a fully-qualified type name.
84
- virtual bool FindFileContainingExtension(const string& containing_type,
85
- int field_number,
86
- FileDescriptorProto* output) = 0;
87
-
88
- // Finds the tag numbers used by all known extensions of
89
- // extendee_type, and appends them to output in an undefined
90
- // order. This method is best-effort: it's not guaranteed that the
91
- // database will find all extensions, and it's not guaranteed that
92
- // FindFileContainingExtension will return true on all of the found
93
- // numbers. Returns true if the search was successful, otherwise
94
- // returns false and leaves output unchanged.
95
- //
96
- // This method has a default implementation that always returns
97
- // false.
98
- virtual bool FindAllExtensionNumbers(const string& extendee_type,
99
- vector<int>* output) {
100
- return false;
101
- }
102
-
103
- private:
104
- GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(DescriptorDatabase);
105
- };
106
-
107
- // A DescriptorDatabase into which you can insert files manually.
108
- //
109
- // FindFileContainingSymbol() is fully-implemented. When you add a file, its
110
- // symbols will be indexed for this purpose. Note that the implementation
111
- // may return false positives, but only if it isn't possible for the symbol
112
- // to be defined in any other file. In particular, if a file defines a symbol
113
- // "Foo", then searching for "Foo.[anything]" will match that file. This way,
114
- // the database does not need to aggressively index all children of a symbol.
115
- //
116
- // FindFileContainingExtension() is mostly-implemented. It works if and only
117
- // if the original FieldDescriptorProto defining the extension has a
118
- // fully-qualified type name in its "extendee" field (i.e. starts with a '.').
119
- // If the extendee is a relative name, SimpleDescriptorDatabase will not
120
- // attempt to resolve the type, so it will not know what type the extension is
121
- // extending. Therefore, calling FindFileContainingExtension() with the
122
- // extension's containing type will never actually find that extension. Note
123
- // that this is an unlikely problem, as all FileDescriptorProtos created by the
124
- // protocol compiler (as well as ones created by calling
125
- // FileDescriptor::CopyTo()) will always use fully-qualified names for all
126
- // types. You only need to worry if you are constructing FileDescriptorProtos
127
- // yourself, or are calling compiler::Parser directly.
128
- class LIBPROTOBUF_EXPORT SimpleDescriptorDatabase : public DescriptorDatabase {
129
- public:
130
- SimpleDescriptorDatabase();
131
- ~SimpleDescriptorDatabase();
132
-
133
- // Adds the FileDescriptorProto to the database, making a copy. The object
134
- // can be deleted after Add() returns. Returns false if the file conflicted
135
- // with a file already in the database, in which case an error will have
136
- // been written to GOOGLE_LOG(ERROR).
137
- bool Add(const FileDescriptorProto& file);
138
-
139
- // Adds the FileDescriptorProto to the database and takes ownership of it.
140
- bool AddAndOwn(const FileDescriptorProto* file);
141
-
142
- // implements DescriptorDatabase -----------------------------------
143
- bool FindFileByName(const string& filename,
144
- FileDescriptorProto* output);
145
- bool FindFileContainingSymbol(const string& symbol_name,
146
- FileDescriptorProto* output);
147
- bool FindFileContainingExtension(const string& containing_type,
148
- int field_number,
149
- FileDescriptorProto* output);
150
- bool FindAllExtensionNumbers(const string& extendee_type,
151
- vector<int>* output);
152
-
153
- private:
154
- // So that it can use DescriptorIndex.
155
- friend class EncodedDescriptorDatabase;
156
-
157
- // An index mapping file names, symbol names, and extension numbers to
158
- // some sort of values.
159
- template <typename Value>
160
- class DescriptorIndex {
161
- public:
162
- // Helpers to recursively add particular descriptors and all their contents
163
- // to the index.
164
- bool AddFile(const FileDescriptorProto& file,
165
- Value value);
166
- bool AddSymbol(const string& name, Value value);
167
- bool AddNestedExtensions(const DescriptorProto& message_type,
168
- Value value);
169
- bool AddExtension(const FieldDescriptorProto& field,
170
- Value value);
171
-
172
- Value FindFile(const string& filename);
173
- Value FindSymbol(const string& name);
174
- Value FindExtension(const string& containing_type, int field_number);
175
- bool FindAllExtensionNumbers(const string& containing_type,
176
- vector<int>* output);
177
-
178
- private:
179
- map<string, Value> by_name_;
180
- map<string, Value> by_symbol_;
181
- map<pair<string, int>, Value> by_extension_;
182
-
183
- // Invariant: The by_symbol_ map does not contain any symbols which are
184
- // prefixes of other symbols in the map. For example, "foo.bar" is a
185
- // prefix of "foo.bar.baz" (but is not a prefix of "foo.barbaz").
186
- //
187
- // This invariant is important because it means that given a symbol name,
188
- // we can find a key in the map which is a prefix of the symbol in O(lg n)
189
- // time, and we know that there is at most one such key.
190
- //
191
- // The prefix lookup algorithm works like so:
192
- // 1) Find the last key in the map which is less than or equal to the
193
- // search key.
194
- // 2) If the found key is a prefix of the search key, then return it.
195
- // Otherwise, there is no match.
196
- //
197
- // I am sure this algorithm has been described elsewhere, but since I
198
- // wasn't able to find it quickly I will instead prove that it works
199
- // myself. The key to the algorithm is that if a match exists, step (1)
200
- // will find it. Proof:
201
- // 1) Define the "search key" to be the key we are looking for, the "found
202
- // key" to be the key found in step (1), and the "match key" to be the
203
- // key which actually matches the serach key (i.e. the key we're trying
204
- // to find).
205
- // 2) The found key must be less than or equal to the search key by
206
- // definition.
207
- // 3) The match key must also be less than or equal to the search key
208
- // (because it is a prefix).
209
- // 4) The match key cannot be greater than the found key, because if it
210
- // were, then step (1) of the algorithm would have returned the match
211
- // key instead (since it finds the *greatest* key which is less than or
212
- // equal to the search key).
213
- // 5) Therefore, the found key must be between the match key and the search
214
- // key, inclusive.
215
- // 6) Since the search key must be a sub-symbol of the match key, if it is
216
- // not equal to the match key, then search_key[match_key.size()] must
217
- // be '.'.
218
- // 7) Since '.' sorts before any other character that is valid in a symbol
219
- // name, then if the found key is not equal to the match key, then
220
- // found_key[match_key.size()] must also be '.', because any other value
221
- // would make it sort after the search key.
222
- // 8) Therefore, if the found key is not equal to the match key, then the
223
- // found key must be a sub-symbol of the match key. However, this would
224
- // contradict our map invariant which says that no symbol in the map is
225
- // a sub-symbol of any other.
226
- // 9) Therefore, the found key must match the match key.
227
- //
228
- // The above proof assumes the match key exists. In the case that the
229
- // match key does not exist, then step (1) will return some other symbol.
230
- // That symbol cannot be a super-symbol of the search key since if it were,
231
- // then it would be a match, and we're assuming the match key doesn't exist.
232
- // Therefore, step 2 will correctly return no match.
233
-
234
- // Find the last entry in the by_symbol_ map whose key is less than or
235
- // equal to the given name.
236
- typename map<string, Value>::iterator FindLastLessOrEqual(
237
- const string& name);
238
-
239
- // True if either the arguments are equal or super_symbol identifies a
240
- // parent symbol of sub_symbol (e.g. "foo.bar" is a parent of
241
- // "foo.bar.baz", but not a parent of "foo.barbaz").
242
- bool IsSubSymbol(const string& sub_symbol, const string& super_symbol);
243
-
244
- // Returns true if and only if all characters in the name are alphanumerics,
245
- // underscores, or periods.
246
- bool ValidateSymbolName(const string& name);
247
- };
248
-
249
-
250
- DescriptorIndex<const FileDescriptorProto*> index_;
251
- vector<const FileDescriptorProto*> files_to_delete_;
252
-
253
- // If file is non-NULL, copy it into *output and return true, otherwise
254
- // return false.
255
- bool MaybeCopy(const FileDescriptorProto* file,
256
- FileDescriptorProto* output);
257
-
258
- GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(SimpleDescriptorDatabase);
259
- };
260
-
261
- // Very similar to SimpleDescriptorDatabase, but stores all the descriptors
262
- // as raw bytes and generally tries to use as little memory as possible.
263
- //
264
- // The same caveats regarding FindFileContainingExtension() apply as with
265
- // SimpleDescriptorDatabase.
266
- class LIBPROTOBUF_EXPORT EncodedDescriptorDatabase : public DescriptorDatabase {
267
- public:
268
- EncodedDescriptorDatabase();
269
- ~EncodedDescriptorDatabase();
270
-
271
- // Adds the FileDescriptorProto to the database. The descriptor is provided
272
- // in encoded form. The database does not make a copy of the bytes, nor
273
- // does it take ownership; it's up to the caller to make sure the bytes
274
- // remain valid for the life of the database. Returns false and logs an error
275
- // if the bytes are not a valid FileDescriptorProto or if the file conflicted
276
- // with a file already in the database.
277
- bool Add(const void* encoded_file_descriptor, int size);
278
-
279
- // Like Add(), but makes a copy of the data, so that the caller does not
280
- // need to keep it around.
281
- bool AddCopy(const void* encoded_file_descriptor, int size);
282
-
283
- // Like FindFileContainingSymbol but returns only the name of the file.
284
- bool FindNameOfFileContainingSymbol(const string& symbol_name,
285
- string* output);
286
-
287
- // implements DescriptorDatabase -----------------------------------
288
- bool FindFileByName(const string& filename,
289
- FileDescriptorProto* output);
290
- bool FindFileContainingSymbol(const string& symbol_name,
291
- FileDescriptorProto* output);
292
- bool FindFileContainingExtension(const string& containing_type,
293
- int field_number,
294
- FileDescriptorProto* output);
295
- bool FindAllExtensionNumbers(const string& extendee_type,
296
- vector<int>* output);
297
-
298
- private:
299
- SimpleDescriptorDatabase::DescriptorIndex<pair<const void*, int> > index_;
300
- vector<void*> files_to_delete_;
301
-
302
- // If encoded_file.first is non-NULL, parse the data into *output and return
303
- // true, otherwise return false.
304
- bool MaybeParse(pair<const void*, int> encoded_file,
305
- FileDescriptorProto* output);
306
-
307
- GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EncodedDescriptorDatabase);
308
- };
309
-
310
- // A DescriptorDatabase that fetches files from a given pool.
311
- class LIBPROTOBUF_EXPORT DescriptorPoolDatabase : public DescriptorDatabase {
312
- public:
313
- DescriptorPoolDatabase(const DescriptorPool& pool);
314
- ~DescriptorPoolDatabase();
315
-
316
- // implements DescriptorDatabase -----------------------------------
317
- bool FindFileByName(const string& filename,
318
- FileDescriptorProto* output);
319
- bool FindFileContainingSymbol(const string& symbol_name,
320
- FileDescriptorProto* output);
321
- bool FindFileContainingExtension(const string& containing_type,
322
- int field_number,
323
- FileDescriptorProto* output);
324
- bool FindAllExtensionNumbers(const string& extendee_type,
325
- vector<int>* output);
326
-
327
- private:
328
- const DescriptorPool& pool_;
329
- GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(DescriptorPoolDatabase);
330
- };
331
-
332
- // A DescriptorDatabase that wraps two or more others. It first searches the
333
- // first database and, if that fails, tries the second, and so on.
334
- class LIBPROTOBUF_EXPORT MergedDescriptorDatabase : public DescriptorDatabase {
335
- public:
336
- // Merge just two databases. The sources remain property of the caller.
337
- MergedDescriptorDatabase(DescriptorDatabase* source1,
338
- DescriptorDatabase* source2);
339
- // Merge more than two databases. The sources remain property of the caller.
340
- // The vector may be deleted after the constructor returns but the
341
- // DescriptorDatabases need to stick around.
342
- MergedDescriptorDatabase(const vector<DescriptorDatabase*>& sources);
343
- ~MergedDescriptorDatabase();
344
-
345
- // implements DescriptorDatabase -----------------------------------
346
- bool FindFileByName(const string& filename,
347
- FileDescriptorProto* output);
348
- bool FindFileContainingSymbol(const string& symbol_name,
349
- FileDescriptorProto* output);
350
- bool FindFileContainingExtension(const string& containing_type,
351
- int field_number,
352
- FileDescriptorProto* output);
353
- // Merges the results of calling all databases. Returns true iff any
354
- // of the databases returned true.
355
- bool FindAllExtensionNumbers(const string& extendee_type,
356
- vector<int>* output);
357
-
358
- private:
359
- vector<DescriptorDatabase*> sources_;
360
- GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MergedDescriptorDatabase);
361
- };
362
-
363
- } // namespace protobuf
364
-
365
- } // namespace google
366
- #endif // GOOGLE_PROTOBUF_DESCRIPTOR_DATABASE_H__
@@ -1,136 +0,0 @@
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
- // Defines an implementation of Message which can emulate types which are not
36
- // known at compile-time.
37
-
38
- #ifndef GOOGLE_PROTOBUF_DYNAMIC_MESSAGE_H__
39
- #define GOOGLE_PROTOBUF_DYNAMIC_MESSAGE_H__
40
-
41
- #include <google/protobuf/message.h>
42
- #include <google/protobuf/stubs/common.h>
43
-
44
- namespace google {
45
- namespace protobuf {
46
-
47
- // Defined in other files.
48
- class Descriptor; // descriptor.h
49
- class DescriptorPool; // descriptor.h
50
-
51
- // Constructs implementations of Message which can emulate types which are not
52
- // known at compile-time.
53
- //
54
- // Sometimes you want to be able to manipulate protocol types that you don't
55
- // know about at compile time. It would be nice to be able to construct
56
- // a Message object which implements the message type given by any arbitrary
57
- // Descriptor. DynamicMessage provides this.
58
- //
59
- // As it turns out, a DynamicMessage needs to construct extra
60
- // information about its type in order to operate. Most of this information
61
- // can be shared between all DynamicMessages of the same type. But, caching
62
- // this information in some sort of global map would be a bad idea, since
63
- // the cached information for a particular descriptor could outlive the
64
- // descriptor itself. To avoid this problem, DynamicMessageFactory
65
- // encapsulates this "cache". All DynamicMessages of the same type created
66
- // from the same factory will share the same support data. Any Descriptors
67
- // used with a particular factory must outlive the factory.
68
- class LIBPROTOBUF_EXPORT DynamicMessageFactory : public MessageFactory {
69
- public:
70
- // Construct a DynamicMessageFactory that will search for extensions in
71
- // the DescriptorPool in which the exendee is defined.
72
- DynamicMessageFactory();
73
-
74
- // Construct a DynamicMessageFactory that will search for extensions in
75
- // the given DescriptorPool.
76
- //
77
- // DEPRECATED: Use CodedInputStream::SetExtensionRegistry() to tell the
78
- // parser to look for extensions in an alternate pool. However, note that
79
- // this is almost never what you want to do. Almost all users should use
80
- // the zero-arg constructor.
81
- DynamicMessageFactory(const DescriptorPool* pool);
82
-
83
- ~DynamicMessageFactory();
84
-
85
- // Call this to tell the DynamicMessageFactory that if it is given a
86
- // Descriptor d for which:
87
- // d->file()->pool() == DescriptorPool::generated_pool(),
88
- // then it should delegate to MessageFactory::generated_factory() instead
89
- // of constructing a dynamic implementation of the message. In theory there
90
- // is no down side to doing this, so it may become the default in the future.
91
- void SetDelegateToGeneratedFactory(bool enable) {
92
- delegate_to_generated_factory_ = enable;
93
- }
94
-
95
- // implements MessageFactory ---------------------------------------
96
-
97
- // Given a Descriptor, constructs the default (prototype) Message of that
98
- // type. You can then call that message's New() method to construct a
99
- // mutable message of that type.
100
- //
101
- // Calling this method twice with the same Descriptor returns the same
102
- // object. The returned object remains property of the factory and will
103
- // be destroyed when the factory is destroyed. Also, any objects created
104
- // by calling the prototype's New() method share some data with the
105
- // prototype, so these must be destoyed before the DynamicMessageFactory
106
- // is destroyed.
107
- //
108
- // The given descriptor must outlive the returned message, and hence must
109
- // outlive the DynamicMessageFactory.
110
- //
111
- // The method is thread-safe.
112
- const Message* GetPrototype(const Descriptor* type);
113
-
114
- private:
115
- const DescriptorPool* pool_;
116
- bool delegate_to_generated_factory_;
117
-
118
- // This struct just contains a hash_map. We can't #include <google/protobuf/stubs/hash.h> from
119
- // this header due to hacks needed for hash_map portability in the open source
120
- // release. Namely, stubs/hash.h, which defines hash_map portably, is not a
121
- // public header (for good reason), but dynamic_message.h is, and public
122
- // headers may only #include other public headers.
123
- struct PrototypeMap;
124
- scoped_ptr<PrototypeMap> prototypes_;
125
- mutable Mutex prototypes_mutex_;
126
-
127
- friend class DynamicMessage;
128
- const Message* GetPrototypeNoLock(const Descriptor* type);
129
-
130
- GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(DynamicMessageFactory);
131
- };
132
-
133
- } // namespace protobuf
134
-
135
- } // namespace google
136
- #endif // GOOGLE_PROTOBUF_DYNAMIC_MESSAGE_H__