Flutter Linux Embedder
fl_standard_method_codec.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
6 
7 #include <gmodule.h>
8 
10 
11 // See lib/src/services/message_codecs.dart in Flutter source for description of
12 // encoding.
13 
14 // Envelope codes.
15 static constexpr guint8 kEnvelopeTypeSuccess = 0;
16 static constexpr guint8 kEnvelopeTypeError = 1;
17 
19  FlMethodCodec parent_instance;
20 
21  FlStandardMessageCodec* message_codec;
22 };
23 
25 
26 G_DEFINE_TYPE(FlStandardMethodCodec,
27  fl_standard_method_codec,
28  fl_method_codec_get_type())
29 
30 static void fl_standard_method_codec_set_property(GObject* object,
31  guint prop_id,
32  const GValue* value,
33  GParamSpec* pspec) {
34  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(object);
35 
36  switch (prop_id) {
37  case kPropMessageCodec:
38  g_set_object(&self->message_codec,
39  FL_STANDARD_MESSAGE_CODEC(g_value_get_object(value)));
40  break;
41  default:
42  G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
43  break;
44  }
45 }
46 
47 static void fl_standard_method_codec_get_property(GObject* object,
48  guint prop_id,
49  GValue* value,
50  GParamSpec* pspec) {
51  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(object);
52 
53  switch (prop_id) {
54  case kPropMessageCodec:
55  g_value_set_object(value, self->message_codec);
56  break;
57  default:
58  G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
59  break;
60  }
61 }
62 
63 static void fl_standard_method_codec_dispose(GObject* object) {
64  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(object);
65 
66  g_clear_object(&self->message_codec);
67 
68  G_OBJECT_CLASS(fl_standard_method_codec_parent_class)->dispose(object);
69 }
70 
71 // Implements FlMethodCodec::encode_method_call.
72 static GBytes* fl_standard_method_codec_encode_method_call(FlMethodCodec* codec,
73  const gchar* name,
74  FlValue* args,
75  GError** error) {
76  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(codec);
77 
78  g_autoptr(GByteArray) buffer = g_byte_array_new();
79  g_autoptr(FlValue) name_value = fl_value_new_string(name);
80  if (!fl_standard_message_codec_write_value(self->message_codec, buffer,
81  name_value, error)) {
82  return nullptr;
83  }
84  if (!fl_standard_message_codec_write_value(self->message_codec, buffer, args,
85  error)) {
86  return nullptr;
87  }
88 
89  return g_byte_array_free_to_bytes(
90  static_cast<GByteArray*>(g_steal_pointer(&buffer)));
91 }
92 
93 // Implements FlMethodCodec::decode_method_call.
95  FlMethodCodec* codec,
96  GBytes* message,
97  gchar** name,
98  FlValue** args,
99  GError** error) {
100  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(codec);
101 
102  size_t offset = 0;
103  g_autoptr(FlValue) name_value = fl_standard_message_codec_read_value(
104  self->message_codec, message, &offset, error);
105  if (name_value == nullptr) {
106  return FALSE;
107  }
108  if (fl_value_get_type(name_value) != FL_VALUE_TYPE_STRING) {
110  "Method call name wrong type");
111  return FALSE;
112  }
113 
114  g_autoptr(FlValue) args_value = fl_standard_message_codec_read_value(
115  self->message_codec, message, &offset, error);
116  if (args_value == nullptr) {
117  return FALSE;
118  }
119 
120  if (offset != g_bytes_get_size(message)) {
122  "Unexpected extra data");
123  return FALSE;
124  }
125 
126  *name = g_strdup(fl_value_get_string(name_value));
127  *args = fl_value_ref(args_value);
128 
129  return TRUE;
130 }
131 
132 // Implements FlMethodCodec::encode_success_envelope.
134  FlMethodCodec* codec,
135  FlValue* result,
136  GError** error) {
137  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(codec);
138 
139  g_autoptr(GByteArray) buffer = g_byte_array_new();
140  guint8 type = kEnvelopeTypeSuccess;
142  if (!fl_standard_message_codec_write_value(self->message_codec, buffer,
143  result, error)) {
144  return nullptr;
145  }
146 
147  return g_byte_array_free_to_bytes(
148  static_cast<GByteArray*>(g_steal_pointer(&buffer)));
149 }
150 
151 // Implements FlMethodCodec::encode_error_envelope.
153  FlMethodCodec* codec,
154  const gchar* code,
155  const gchar* message,
156  FlValue* details,
157  GError** error) {
158  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(codec);
159 
160  g_autoptr(GByteArray) buffer = g_byte_array_new();
161  guint8 type = kEnvelopeTypeError;
163  g_autoptr(FlValue) code_value = fl_value_new_string(code);
164  if (!fl_standard_message_codec_write_value(self->message_codec, buffer,
165  code_value, error)) {
166  return nullptr;
167  }
168  g_autoptr(FlValue) message_value =
169  message != nullptr ? fl_value_new_string(message) : nullptr;
170  if (!fl_standard_message_codec_write_value(self->message_codec, buffer,
171  message_value, error)) {
172  return nullptr;
173  }
174  if (!fl_standard_message_codec_write_value(self->message_codec, buffer,
175  details, error)) {
176  return nullptr;
177  }
178 
179  return g_byte_array_free_to_bytes(
180  static_cast<GByteArray*>(g_steal_pointer(&buffer)));
181 }
182 
183 // Implements FlMethodCodec::encode_decode_response.
185  FlMethodCodec* codec,
186  GBytes* message,
187  GError** error) {
188  FlStandardMethodCodec* self = FL_STANDARD_METHOD_CODEC(codec);
189 
190  if (g_bytes_get_size(message) == 0) {
191  g_set_error(error, FL_MESSAGE_CODEC_ERROR,
192  FL_MESSAGE_CODEC_ERROR_OUT_OF_DATA, "Empty response");
193  return nullptr;
194  }
195 
196  // First byte is response type.
197  const guint8* data =
198  static_cast<const guint8*>(g_bytes_get_data(message, nullptr));
199  guint8 type = data[0];
200  size_t offset = 1;
201 
202  g_autoptr(FlMethodResponse) response = nullptr;
203  if (type == kEnvelopeTypeError) {
205  self->message_codec, message, &offset, error);
206  if (code == nullptr) {
207  return nullptr;
208  }
211  "Error code wrong type");
212  return nullptr;
213  }
214 
215  g_autoptr(FlValue) error_message = fl_standard_message_codec_read_value(
216  self->message_codec, message, &offset, error);
217  if (error_message == nullptr) {
218  return nullptr;
219  }
220  if (fl_value_get_type(error_message) != FL_VALUE_TYPE_STRING &&
221  fl_value_get_type(error_message) != FL_VALUE_TYPE_NULL) {
223  "Error message wrong type");
224  return nullptr;
225  }
226 
227  g_autoptr(FlValue) details = fl_standard_message_codec_read_value(
228  self->message_codec, message, &offset, error);
229  if (details == nullptr) {
230  return nullptr;
231  }
232 
233  response = FL_METHOD_RESPONSE(fl_method_error_response_new(
234  fl_value_get_string(code),
235  fl_value_get_type(error_message) == FL_VALUE_TYPE_STRING
236  ? fl_value_get_string(error_message)
237  : nullptr,
238  fl_value_get_type(details) != FL_VALUE_TYPE_NULL ? details : nullptr));
239  } else if (type == kEnvelopeTypeSuccess) {
241  self->message_codec, message, &offset, error);
242 
243  if (result == nullptr) {
244  return nullptr;
245  }
246 
247  response = FL_METHOD_RESPONSE(fl_method_success_response_new(result));
248  } else {
250  "Unknown envelope type %02x", type);
251  return nullptr;
252  }
253 
254  if (offset != g_bytes_get_size(message)) {
256  "Unexpected extra data");
257  return nullptr;
258  }
259 
260  return FL_METHOD_RESPONSE(g_object_ref(response));
261 }
262 
264  FlStandardMethodCodecClass* klass) {
265  G_OBJECT_CLASS(klass)->set_property = fl_standard_method_codec_set_property;
266  G_OBJECT_CLASS(klass)->get_property = fl_standard_method_codec_get_property;
267  G_OBJECT_CLASS(klass)->dispose = fl_standard_method_codec_dispose;
268 
269  FL_METHOD_CODEC_CLASS(klass)->encode_method_call =
271  FL_METHOD_CODEC_CLASS(klass)->decode_method_call =
273  FL_METHOD_CODEC_CLASS(klass)->encode_success_envelope =
275  FL_METHOD_CODEC_CLASS(klass)->encode_error_envelope =
277  FL_METHOD_CODEC_CLASS(klass)->decode_response =
279 
280  g_object_class_install_property(
281  G_OBJECT_CLASS(klass), kPropMessageCodec,
282  g_param_spec_object(
283  "message-codec", "message-codec", "Message codec to use",
284  fl_message_codec_get_type(),
285  static_cast<GParamFlags>(G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
286  G_PARAM_STATIC_STRINGS)));
287 }
288 
289 static void fl_standard_method_codec_init(FlStandardMethodCodec* self) {}
290 
291 G_MODULE_EXPORT FlStandardMethodCodec* fl_standard_method_codec_new() {
292  g_autoptr(FlStandardMessageCodec) message_codec =
295 }
296 
297 G_MODULE_EXPORT FlStandardMethodCodec*
299  FlStandardMessageCodec* message_codec) {
300  return FL_STANDARD_METHOD_CODEC(
301  g_object_new(fl_standard_method_codec_get_type(), "message-codec",
302  message_codec, nullptr));
303 }
prop_id
guint prop_id
Definition: fl_standard_method_codec.cc:31
fl_method_error_response_new
G_MODULE_EXPORT FlMethodErrorResponse * fl_method_error_response_new(const gchar *code, const gchar *message, FlValue *details)
Definition: fl_method_response.cc:144
fl_standard_message_codec_new
G_MODULE_EXPORT FlStandardMessageCodec * fl_standard_message_codec_new()
Definition: fl_standard_message_codec.cc:637
type
uint8_t type
Definition: fl_standard_message_codec_test.cc:1115
fl_standard_message_codec_write_value
G_MODULE_EXPORT gboolean fl_standard_message_codec_write_value(FlStandardMessageCodec *self, GByteArray *buffer, FlValue *value, GError **error)
Definition: fl_standard_message_codec.cc:685
fl_standard_method_codec_new
G_MODULE_EXPORT FlStandardMethodCodec * fl_standard_method_codec_new()
Definition: fl_standard_method_codec.cc:291
fl_standard_method_codec_class_init
static void fl_standard_method_codec_class_init(FlStandardMethodCodecClass *klass)
Definition: fl_standard_method_codec.cc:263
fl_standard_method_codec_encode_error_envelope
static GBytes * fl_standard_method_codec_encode_error_envelope(FlMethodCodec *codec, const gchar *code, const gchar *message, FlValue *details, GError **error)
Definition: fl_standard_method_codec.cc:152
_FlStandardMethodCodec::parent_instance
FlMethodCodec parent_instance
Definition: fl_standard_method_codec.cc:19
FlValue
typedefG_BEGIN_DECLS struct _FlValue FlValue
Definition: fl_value.h:42
fl_standard_method_codec_new_with_message_codec
G_MODULE_EXPORT FlStandardMethodCodec * fl_standard_method_codec_new_with_message_codec(FlStandardMessageCodec *message_codec)
Definition: fl_standard_method_codec.cc:298
fl_standard_method_codec_decode_method_call
static gboolean fl_standard_method_codec_decode_method_call(FlMethodCodec *codec, GBytes *message, gchar **name, FlValue **args, GError **error)
Definition: fl_standard_method_codec.cc:94
G_DEFINE_TYPE
G_DEFINE_TYPE(FlStandardMethodCodec, fl_standard_method_codec, fl_method_codec_get_type()) static void fl_standard_method_codec_set_property(GObject *object
pspec
guint const GValue GParamSpec * pspec
Definition: fl_standard_method_codec.cc:33
fl_value_get_string
const G_MODULE_EXPORT gchar * fl_value_get_string(FlValue *self)
Definition: fl_value.cc:682
fl_method_success_response_new
G_MODULE_EXPORT FlMethodSuccessResponse * fl_method_success_response_new(FlValue *result)
Definition: fl_method_response.cc:126
FL_VALUE_TYPE_NULL
@ FL_VALUE_TYPE_NULL
Definition: fl_value.h:65
fl_value_ref
G_MODULE_EXPORT FlValue * fl_value_ref(FlValue *self)
Definition: fl_value.cc:394
g_byte_array_append
g_byte_array_append(buffer, &type, sizeof(uint8_t))
_FlStandardMethodCodec
Definition: fl_standard_method_codec.cc:18
fl_value_get_type
G_MODULE_EXPORT FlValueType fl_value_get_type(FlValue *self)
Definition: fl_value.cc:466
_FlStandardMethodCodec::message_codec
FlStandardMessageCodec * message_codec
Definition: fl_standard_method_codec.cc:21
FL_VALUE_TYPE_STRING
@ FL_VALUE_TYPE_STRING
Definition: fl_value.h:69
kEnvelopeTypeError
static constexpr guint8 kEnvelopeTypeError
Definition: fl_standard_method_codec.cc:16
fl_standard_method_codec_dispose
static void fl_standard_method_codec_dispose(GObject *object)
Definition: fl_standard_method_codec.cc:63
TRUE
return TRUE
Definition: fl_pixel_buffer_texture_test.cc:53
FL_MESSAGE_CODEC_ERROR_FAILED
@ FL_MESSAGE_CODEC_ERROR_FAILED
Definition: fl_message_codec.h:34
fl_standard_method_codec_get_property
static void fl_standard_method_codec_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
Definition: fl_standard_method_codec.cc:47
kPropMessageCodec
@ kPropMessageCodec
Definition: fl_standard_method_codec.cc:24
fl_standard_method_codec_encode_method_call
static GBytes * fl_standard_method_codec_encode_method_call(FlMethodCodec *codec, const gchar *name, FlValue *args, GError **error)
Definition: fl_standard_method_codec.cc:72
fl_standard_method_codec.h
result
GAsyncResult * result
Definition: fl_text_input_plugin.cc:106
FL_MESSAGE_CODEC_ERROR_OUT_OF_DATA
@ FL_MESSAGE_CODEC_ERROR_OUT_OF_DATA
Definition: fl_message_codec.h:35
args
G_BEGIN_DECLS G_MODULE_EXPORT FlValue * args
Definition: fl_event_channel.h:89
error
const uint8_t uint32_t uint32_t GError ** error
Definition: fl_pixel_buffer_texture_test.cc:40
fl_standard_method_codec_decode_response
static FlMethodResponse * fl_standard_method_codec_decode_response(FlMethodCodec *codec, GBytes *message, GError **error)
Definition: fl_standard_method_codec.cc:184
buffer
static const uint8_t buffer[]
Definition: fl_pixel_buffer_texture_test.cc:44
fl_standard_message_codec.h
value
guint const GValue * value
Definition: fl_standard_method_codec.cc:32
fl_standard_method_codec_init
static void fl_standard_method_codec_init(FlStandardMethodCodec *self)
Definition: fl_standard_method_codec.cc:289
kEnvelopeTypeSuccess
static constexpr guint8 kEnvelopeTypeSuccess
Definition: fl_standard_method_codec.cc:15
fl_standard_method_codec_encode_success_envelope
static GBytes * fl_standard_method_codec_encode_success_envelope(FlMethodCodec *codec, FlValue *result, GError **error)
Definition: fl_standard_method_codec.cc:133
fl_value_new_string
G_MODULE_EXPORT FlValue * fl_value_new_string(const gchar *value)
Definition: fl_value.cc:276
fl_standard_message_codec_read_value
G_MODULE_EXPORT FlValue * fl_standard_message_codec_read_value(FlStandardMessageCodec *self, GBytes *buffer, size_t *offset, GError **error)
Definition: fl_standard_message_codec.cc:694
kPropLast
@ kPropLast
Definition: fl_standard_method_codec.cc:24
FL_MESSAGE_CODEC_ERROR
#define FL_MESSAGE_CODEC_ERROR
Definition: fl_message_codec.h:30