OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef MOJO_PUBLIC_CPP_BINDINGS_LIB_ARRAY_SERIALIZATION_H_ | 5 #ifndef MOJO_PUBLIC_CPP_BINDINGS_LIB_ARRAY_SERIALIZATION_H_ |
6 #define MOJO_PUBLIC_CPP_BINDINGS_LIB_ARRAY_SERIALIZATION_H_ | 6 #define MOJO_PUBLIC_CPP_BINDINGS_LIB_ARRAY_SERIALIZATION_H_ |
7 | 7 |
8 #include <string.h> // For |memcpy()|. | 8 #include <string.h> // For |memcpy()|. |
9 | 9 |
10 #include <vector> | 10 #include <vector> |
11 | 11 |
| 12 #include "mojo/public/c/system/macros.h" |
12 #include "mojo/public/cpp/bindings/lib/array_internal.h" | 13 #include "mojo/public/cpp/bindings/lib/array_internal.h" |
13 #include "mojo/public/cpp/bindings/lib/string_serialization.h" | 14 #include "mojo/public/cpp/bindings/lib/string_serialization.h" |
| 15 #include "mojo/public/cpp/bindings/lib/template_util.h" |
| 16 #include "mojo/public/cpp/bindings/lib/validation_errors.h" |
14 | 17 |
15 namespace mojo { | 18 namespace mojo { |
16 | 19 |
17 template <typename E> | 20 template <typename E> |
18 inline size_t GetSerializedSize_(const Array<E>& input); | 21 inline size_t GetSerializedSize_(const Array<E>& input); |
19 | 22 |
20 template <typename E, typename F> | 23 // Because ValidateParams requires explicit argument specification, the |
21 inline void Serialize_(Array<E> input, internal::Buffer* buf, | 24 // argument-dependent loopup technique used to omit namespace when calling |
22 internal::Array_Data<F>** output); | 25 // Serialize_() doesn't seem to work. Therefore, this function is named |
| 26 // differently from those Serialize_() overloads. |
| 27 template <typename ValidateParams, typename E, typename F> |
| 28 inline void SerializeArray_(Array<E> input, internal::Buffer* buf, |
| 29 internal::Array_Data<F>** output); |
| 30 |
23 template <typename E, typename F> | 31 template <typename E, typename F> |
24 inline void Deserialize_(internal::Array_Data<F>* data, Array<E>* output); | 32 inline void Deserialize_(internal::Array_Data<F>* data, Array<E>* output); |
25 | 33 |
26 namespace internal { | 34 namespace internal { |
27 | 35 |
28 template <typename E, typename F, bool move_only = IsMoveOnlyType<E>::value> | 36 template <typename E, typename F, bool move_only = IsMoveOnlyType<E>::value> |
29 struct ArraySerializer; | 37 struct ArraySerializer; |
30 | 38 |
31 template <typename E, typename F> struct ArraySerializer<E, F, false> { | 39 template <typename E, typename F> struct ArraySerializer<E, F, false> { |
32 MOJO_COMPILE_ASSERT(sizeof(E) == sizeof(F), wrong_array_serializer); | 40 MOJO_COMPILE_ASSERT(sizeof(E) == sizeof(F), wrong_array_serializer); |
33 static size_t GetSerializedSize(const Array<E>& input) { | 41 static size_t GetSerializedSize(const Array<E>& input) { |
34 return sizeof(Array_Data<F>) + Align(input.size() * sizeof(E)); | 42 return sizeof(Array_Data<F>) + Align(input.size() * sizeof(E)); |
35 } | 43 } |
| 44 template <bool element_is_nullable, typename ElementValidateParams> |
36 static void SerializeElements( | 45 static void SerializeElements( |
37 Array<E> input, Buffer* buf, Array_Data<F>* output) { | 46 Array<E> input, Buffer* buf, Array_Data<F>* output) { |
| 47 MOJO_COMPILE_ASSERT(!element_is_nullable, |
| 48 Primitive_type_should_be_non_nullable); |
| 49 MOJO_COMPILE_ASSERT( |
| 50 (IsSame<ElementValidateParams, NoValidateParams>::value), |
| 51 Primitive_type_should_not_have_array_validate_params); |
| 52 |
38 memcpy(output->storage(), &input.storage()[0], input.size() * sizeof(E)); | 53 memcpy(output->storage(), &input.storage()[0], input.size() * sizeof(E)); |
39 } | 54 } |
40 static void DeserializeElements( | 55 static void DeserializeElements( |
41 Array_Data<F>* input, Array<E>* output) { | 56 Array_Data<F>* input, Array<E>* output) { |
42 std::vector<E> result(input->size()); | 57 std::vector<E> result(input->size()); |
43 memcpy(&result[0], input->storage(), input->size() * sizeof(E)); | 58 memcpy(&result[0], input->storage(), input->size() * sizeof(E)); |
44 output->Swap(&result); | 59 output->Swap(&result); |
45 } | 60 } |
46 }; | 61 }; |
47 | 62 |
48 template <> struct ArraySerializer<bool, bool, false> { | 63 template <> struct ArraySerializer<bool, bool, false> { |
49 static size_t GetSerializedSize(const Array<bool>& input) { | 64 static size_t GetSerializedSize(const Array<bool>& input) { |
50 return sizeof(Array_Data<bool>) + Align((input.size() + 7) / 8); | 65 return sizeof(Array_Data<bool>) + Align((input.size() + 7) / 8); |
51 } | 66 } |
| 67 template <bool element_is_nullable, typename ElementValidateParams> |
52 static void SerializeElements( | 68 static void SerializeElements( |
53 Array<bool> input, Buffer* buf, Array_Data<bool>* output) { | 69 Array<bool> input, Buffer* buf, Array_Data<bool>* output) { |
| 70 MOJO_COMPILE_ASSERT(!element_is_nullable, |
| 71 Primitive_type_should_be_non_nullable); |
| 72 MOJO_COMPILE_ASSERT( |
| 73 (IsSame<ElementValidateParams, NoValidateParams>::value), |
| 74 Primitive_type_should_not_have_array_validate_params); |
| 75 |
54 // TODO(darin): Can this be a memcpy somehow instead of a bit-by-bit copy? | 76 // TODO(darin): Can this be a memcpy somehow instead of a bit-by-bit copy? |
55 for (size_t i = 0; i < input.size(); ++i) | 77 for (size_t i = 0; i < input.size(); ++i) |
56 output->at(i) = input[i]; | 78 output->at(i) = input[i]; |
57 } | 79 } |
58 static void DeserializeElements( | 80 static void DeserializeElements( |
59 Array_Data<bool>* input, Array<bool>* output) { | 81 Array_Data<bool>* input, Array<bool>* output) { |
60 Array<bool> result(input->size()); | 82 Array<bool> result(input->size()); |
61 // TODO(darin): Can this be a memcpy somehow instead of a bit-by-bit copy? | 83 // TODO(darin): Can this be a memcpy somehow instead of a bit-by-bit copy? |
62 for (size_t i = 0; i < input->size(); ++i) | 84 for (size_t i = 0; i < input->size(); ++i) |
63 result.at(i) = input->at(i); | 85 result.at(i) = input->at(i); |
64 output->Swap(&result); | 86 output->Swap(&result); |
65 } | 87 } |
66 }; | 88 }; |
67 | 89 |
68 template <typename H> struct ArraySerializer<ScopedHandleBase<H>, H, true> { | 90 template <typename H> struct ArraySerializer<ScopedHandleBase<H>, H, true> { |
69 static size_t GetSerializedSize(const Array<ScopedHandleBase<H> >& input) { | 91 static size_t GetSerializedSize(const Array<ScopedHandleBase<H> >& input) { |
70 return sizeof(Array_Data<H>) + Align(input.size() * sizeof(H)); | 92 return sizeof(Array_Data<H>) + Align(input.size() * sizeof(H)); |
71 } | 93 } |
72 static void SerializeElements( | 94 template <bool element_is_nullable, typename ElementValidateParams> |
73 Array<ScopedHandleBase<H> > input, | 95 static void SerializeElements(Array<ScopedHandleBase<H> > input, |
74 Buffer* buf, | 96 Buffer* buf, |
75 Array_Data<H>* output) { | 97 Array_Data<H>* output) { |
76 for (size_t i = 0; i < input.size(); ++i) | 98 MOJO_COMPILE_ASSERT( |
| 99 (IsSame<ElementValidateParams, NoValidateParams>::value), |
| 100 Handle_type_should_not_have_array_validate_params); |
| 101 |
| 102 for (size_t i = 0; i < input.size(); ++i) { |
77 output->at(i) = input[i].release(); // Transfer ownership of the handle. | 103 output->at(i) = input[i].release(); // Transfer ownership of the handle. |
| 104 MOJO_INTERNAL_DLOG_SERIALIZATION_WARNING( |
| 105 IsNonNullableValidationEnabled() && !element_is_nullable && |
| 106 !output->at(i).is_valid(), |
| 107 VALIDATION_ERROR_UNEXPECTED_INVALID_HANDLE); |
| 108 } |
78 } | 109 } |
79 static void DeserializeElements( | 110 static void DeserializeElements( |
80 Array_Data<H>* input, Array<ScopedHandleBase<H> >* output) { | 111 Array_Data<H>* input, Array<ScopedHandleBase<H> >* output) { |
81 Array<ScopedHandleBase<H> > result(input->size()); | 112 Array<ScopedHandleBase<H> > result(input->size()); |
82 for (size_t i = 0; i < input->size(); ++i) | 113 for (size_t i = 0; i < input->size(); ++i) |
83 result.at(i) = MakeScopedHandle(FetchAndReset(&input->at(i))); | 114 result.at(i) = MakeScopedHandle(FetchAndReset(&input->at(i))); |
84 output->Swap(&result); | 115 output->Swap(&result); |
85 } | 116 } |
86 }; | 117 }; |
87 | 118 |
88 template <typename S> struct ArraySerializer<S, typename S::Data_*, true> { | 119 template <typename S> struct ArraySerializer<S, typename S::Data_*, true> { |
89 static size_t GetSerializedSize(const Array<S>& input) { | 120 static size_t GetSerializedSize(const Array<S>& input) { |
90 size_t size = sizeof(Array_Data<typename S::Data_*>) + | 121 size_t size = sizeof(Array_Data<typename S::Data_*>) + |
91 input.size() * sizeof(internal::StructPointer<typename S::Data_>); | 122 input.size() * sizeof(internal::StructPointer<typename S::Data_>); |
92 for (size_t i = 0; i < input.size(); ++i) | 123 for (size_t i = 0; i < input.size(); ++i) |
93 size += GetSerializedSize_(input[i]); | 124 size += GetSerializedSize_(input[i]); |
94 return size; | 125 return size; |
95 } | 126 } |
96 static void SerializeElements( | 127 template <bool element_is_nullable, typename ElementValidateParams> |
97 Array<S> input, | 128 static void SerializeElements(Array<S> input, |
98 Buffer* buf, | 129 Buffer* buf, |
99 Array_Data<typename S::Data_*>* output) { | 130 Array_Data<typename S::Data_*>* output) { |
100 for (size_t i = 0; i < input.size(); ++i) { | 131 for (size_t i = 0; i < input.size(); ++i) { |
101 typename S::Data_* element; | 132 typename S::Data_* element; |
102 Serialize_(input[i].Pass(), buf, &element); | 133 SerializeCaller<S, ElementValidateParams>::Run( |
| 134 input[i].Pass(), buf, &element); |
103 output->at(i) = element; | 135 output->at(i) = element; |
| 136 MOJO_INTERNAL_DLOG_SERIALIZATION_WARNING( |
| 137 IsNonNullableValidationEnabled() && !element_is_nullable && !element, |
| 138 VALIDATION_ERROR_UNEXPECTED_NULL_POINTER); |
104 } | 139 } |
105 } | 140 } |
106 static void DeserializeElements( | 141 static void DeserializeElements( |
107 Array_Data<typename S::Data_*>* input, Array<S>* output) { | 142 Array_Data<typename S::Data_*>* input, Array<S>* output) { |
108 Array<S> result(input->size()); | 143 Array<S> result(input->size()); |
109 for (size_t i = 0; i < input->size(); ++i) { | 144 for (size_t i = 0; i < input->size(); ++i) { |
110 S element; | 145 S element; |
111 Deserialize_(input->at(i), &element); | 146 Deserialize_(input->at(i), &element); |
112 result[i] = element.Pass(); | 147 result[i] = element.Pass(); |
113 } | 148 } |
114 output->Swap(&result); | 149 output->Swap(&result); |
115 } | 150 } |
| 151 |
| 152 private: |
| 153 template <typename T, typename Params> |
| 154 struct SerializeCaller { |
| 155 static void Run(T input, Buffer* buf, typename T::Data_** output) { |
| 156 MOJO_COMPILE_ASSERT((IsSame<Params, NoValidateParams>::value), |
| 157 Struct_type_should_not_have_array_validate_params); |
| 158 |
| 159 Serialize_(input.Pass(), buf, output); |
| 160 } |
| 161 }; |
| 162 |
| 163 template <typename T, typename Params> |
| 164 struct SerializeCaller<Array<T>, Params> { |
| 165 static void Run(Array<T> input, |
| 166 Buffer* buf, |
| 167 typename Array<T>::Data_** output) { |
| 168 SerializeArray_<Params>(input.Pass(), buf, output); |
| 169 } |
| 170 }; |
116 }; | 171 }; |
117 | 172 |
118 template <> struct ArraySerializer<String, String_Data*, false> { | 173 template <> struct ArraySerializer<String, String_Data*, false> { |
119 static size_t GetSerializedSize(const Array<String>& input) { | 174 static size_t GetSerializedSize(const Array<String>& input) { |
120 size_t size = sizeof(Array_Data<String_Data*>) + | 175 size_t size = sizeof(Array_Data<String_Data*>) + |
121 input.size() * sizeof(internal::StringPointer); | 176 input.size() * sizeof(internal::StringPointer); |
122 for (size_t i = 0; i < input.size(); ++i) | 177 for (size_t i = 0; i < input.size(); ++i) |
123 size += GetSerializedSize_(input[i]); | 178 size += GetSerializedSize_(input[i]); |
124 return size; | 179 return size; |
125 } | 180 } |
| 181 template <bool element_is_nullable, typename ElementValidateParams> |
126 static void SerializeElements( | 182 static void SerializeElements( |
127 Array<String> input, | 183 Array<String> input, |
128 Buffer* buf, | 184 Buffer* buf, |
129 Array_Data<String_Data*>* output) { | 185 Array_Data<String_Data*>* output) { |
| 186 MOJO_COMPILE_ASSERT( |
| 187 (IsSame<ElementValidateParams, |
| 188 ArrayValidateParams<0, false, NoValidateParams> >::value), |
| 189 String_type_has_unexpected_array_validate_params); |
| 190 |
130 for (size_t i = 0; i < input.size(); ++i) { | 191 for (size_t i = 0; i < input.size(); ++i) { |
131 String_Data* element; | 192 String_Data* element; |
132 Serialize_(input[i], buf, &element); | 193 Serialize_(input[i], buf, &element); |
133 output->at(i) = element; | 194 output->at(i) = element; |
| 195 MOJO_INTERNAL_DLOG_SERIALIZATION_WARNING( |
| 196 IsNonNullableValidationEnabled() && !element_is_nullable && !element, |
| 197 VALIDATION_ERROR_UNEXPECTED_NULL_POINTER); |
134 } | 198 } |
135 } | 199 } |
136 static void DeserializeElements( | 200 static void DeserializeElements( |
137 Array_Data<String_Data*>* input, Array<String>* output) { | 201 Array_Data<String_Data*>* input, Array<String>* output) { |
138 Array<String> result(input->size()); | 202 Array<String> result(input->size()); |
139 for (size_t i = 0; i < input->size(); ++i) | 203 for (size_t i = 0; i < input->size(); ++i) |
140 Deserialize_(input->at(i), &result[i]); | 204 Deserialize_(input->at(i), &result[i]); |
141 output->Swap(&result); | 205 output->Swap(&result); |
142 } | 206 } |
143 }; | 207 }; |
144 | 208 |
145 } // namespace internal | 209 } // namespace internal |
146 | 210 |
147 template <typename E> | 211 template <typename E> |
148 inline size_t GetSerializedSize_(const Array<E>& input) { | 212 inline size_t GetSerializedSize_(const Array<E>& input) { |
149 if (!input) | 213 if (!input) |
150 return 0; | 214 return 0; |
151 typedef typename internal::WrapperTraits<E>::DataType F; | 215 typedef typename internal::WrapperTraits<E>::DataType F; |
152 return internal::ArraySerializer<E, F>::GetSerializedSize(input); | 216 return internal::ArraySerializer<E, F>::GetSerializedSize(input); |
153 } | 217 } |
154 | 218 |
155 template <typename E, typename F> | 219 template <typename ValidateParams, typename E, typename F> |
156 inline void Serialize_(Array<E> input, internal::Buffer* buf, | 220 inline void SerializeArray_(Array<E> input, internal::Buffer* buf, |
157 internal::Array_Data<F>** output) { | 221 internal::Array_Data<F>** output) { |
158 if (input) { | 222 if (input) { |
| 223 MOJO_INTERNAL_DLOG_SERIALIZATION_WARNING( |
| 224 ValidateParams::expected_num_elements != 0 && |
| 225 input.size() != ValidateParams::expected_num_elements, |
| 226 internal::VALIDATION_ERROR_UNEXPECTED_ARRAY_HEADER); |
| 227 |
159 internal::Array_Data<F>* result = | 228 internal::Array_Data<F>* result = |
160 internal::Array_Data<F>::New(input.size(), buf); | 229 internal::Array_Data<F>::New(input.size(), buf); |
161 internal::ArraySerializer<E, F>::SerializeElements( | 230 internal::ArraySerializer<E, F>::template SerializeElements< |
162 internal::Forward(input), buf, result); | 231 ValidateParams::element_is_nullable, |
| 232 typename ValidateParams::ElementValidateParams>( |
| 233 internal::Forward(input), buf, result); |
163 *output = result; | 234 *output = result; |
164 } else { | 235 } else { |
165 *output = NULL; | 236 *output = NULL; |
166 } | 237 } |
167 } | 238 } |
168 | 239 |
169 template <typename E, typename F> | 240 template <typename E, typename F> |
170 inline void Deserialize_(internal::Array_Data<F>* input, | 241 inline void Deserialize_(internal::Array_Data<F>* input, Array<E>* output) { |
171 Array<E>* output) { | |
172 if (input) { | 242 if (input) { |
173 internal::ArraySerializer<E, F>::DeserializeElements(input, output); | 243 internal::ArraySerializer<E, F>::DeserializeElements(input, output); |
174 } else { | 244 } else { |
175 output->reset(); | 245 output->reset(); |
176 } | 246 } |
177 } | 247 } |
178 | 248 |
179 } // namespace mojo | 249 } // namespace mojo |
180 | 250 |
181 #endif // MOJO_PUBLIC_CPP_BINDINGS_LIB_ARRAY_SERIALIZATION_H_ | 251 #endif // MOJO_PUBLIC_CPP_BINDINGS_LIB_ARRAY_SERIALIZATION_H_ |
OLD | NEW |