D-Bus  1.12.16
dbus-signature.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-signature.c Routines for reading recursive type signatures
3  *
4  * Copyright (C) 2005 Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  */
23 
24 #include <config.h>
25 
26 #include "dbus-signature.h"
27 #include "dbus-marshal-recursive.h"
28 #include "dbus-marshal-basic.h"
29 #include "dbus-internals.h"
30 #include "dbus-test.h"
31 
35 typedef struct
36 {
37  const char *pos;
38  unsigned int finished : 1;
39  unsigned int in_array : 1;
41 
43 #define TYPE_IS_CONTAINER(typecode) \
44  ((typecode) == DBUS_TYPE_STRUCT || \
45  (typecode) == DBUS_TYPE_DICT_ENTRY || \
46  (typecode) == DBUS_TYPE_VARIANT || \
47  (typecode) == DBUS_TYPE_ARRAY)
48 
49 
66 void
68  const char *signature)
69 {
70  DBusSignatureRealIter *real_iter = (DBusSignatureRealIter *) iter;
71 
72  real_iter->pos = signature;
73  real_iter->finished = FALSE;
74  real_iter->in_array = FALSE;
75 }
76 
91 int
93 {
94  DBusSignatureRealIter *real_iter = (DBusSignatureRealIter *) iter;
95 
96  return _dbus_first_type_in_signature_c_str (real_iter->pos, 0);
97 }
98 
111 char *
113 {
114  DBusSignatureRealIter *real_iter = (DBusSignatureRealIter *) iter;
115  DBusString str;
116  char *ret;
117  int pos;
118 
119  if (!_dbus_string_init (&str))
120  return NULL;
121 
122  pos = 0;
123  _dbus_type_signature_next (real_iter->pos, &pos);
124 
125  if (!_dbus_string_append_len (&str, real_iter->pos, pos))
126  return NULL;
127  if (!_dbus_string_steal_data (&str, &ret))
128  ret = NULL;
129  _dbus_string_free (&str);
130 
131  return ret;
132 }
133 
145 int
147 {
148  DBusSignatureRealIter *real_iter = (DBusSignatureRealIter *) iter;
149 
150  _dbus_return_val_if_fail (dbus_signature_iter_get_current_type (iter) == DBUS_TYPE_ARRAY, DBUS_TYPE_INVALID);
151 
152  return _dbus_first_type_in_signature_c_str (real_iter->pos, 1);
153 }
154 
165 {
166  DBusSignatureRealIter *real_iter = (DBusSignatureRealIter *) iter;
167 
168  if (real_iter->finished)
169  return FALSE;
170  else
171  {
172  int pos;
173 
174  if (real_iter->in_array)
175  {
176  real_iter->finished = TRUE;
177  return FALSE;
178  }
179 
180  pos = 0;
181  _dbus_type_signature_next (real_iter->pos, &pos);
182  real_iter->pos += pos;
183 
184  if (*real_iter->pos == DBUS_STRUCT_END_CHAR
185  || *real_iter->pos == DBUS_DICT_ENTRY_END_CHAR)
186  {
187  real_iter->finished = TRUE;
188  return FALSE;
189  }
190 
191  return *real_iter->pos != DBUS_TYPE_INVALID;
192  }
193 }
194 
206 void
208  DBusSignatureIter *subiter)
209 {
210  DBusSignatureRealIter *real_iter = (DBusSignatureRealIter *) iter;
211  DBusSignatureRealIter *real_sub_iter = (DBusSignatureRealIter *) subiter;
212 
213  _dbus_return_if_fail (dbus_type_is_container (dbus_signature_iter_get_current_type (iter)));
214 
215  *real_sub_iter = *real_iter;
216  real_sub_iter->in_array = FALSE;
217  real_sub_iter->pos++;
218 
220  real_sub_iter->in_array = TRUE;
221 }
222 
233 dbus_signature_validate (const char *signature,
234  DBusError *error)
235 
236 {
237  DBusString str;
238  DBusValidity reason;
239 
240  _dbus_string_init_const (&str, signature);
242 
243  if (reason == DBUS_VALID)
244  return TRUE;
245  else
246  {
248  _dbus_validity_to_error_message (reason));
249  return FALSE;
250  }
251 }
252 
265 dbus_signature_validate_single (const char *signature,
266  DBusError *error)
267 {
268  DBusSignatureIter iter;
269 
270  if (!dbus_signature_validate (signature, error))
271  return FALSE;
272 
273  dbus_signature_iter_init (&iter, signature);
275  goto lose;
276  if (!dbus_signature_iter_next (&iter))
277  return TRUE;
278  lose:
279  dbus_set_error (error, DBUS_ERROR_INVALID_SIGNATURE, "Exactly one complete type required in signature");
280  return FALSE;
281 }
282 
296 {
297  /* only reasonable (non-line-noise) typecodes are allowed */
298  _dbus_return_val_if_fail (dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID,
299  FALSE);
300  return TYPE_IS_CONTAINER (typecode);
301 }
302 
319 dbus_type_is_basic (int typecode)
320 {
321  /* only reasonable (non-line-noise) typecodes are allowed */
322  _dbus_return_val_if_fail (dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID,
323  FALSE);
324 
325  /* everything that isn't invalid or a container */
326  return !(typecode == DBUS_TYPE_INVALID || TYPE_IS_CONTAINER (typecode));
327 }
328 
350 dbus_type_is_fixed (int typecode)
351 {
352  /* only reasonable (non-line-noise) typecodes are allowed */
353  _dbus_return_val_if_fail (dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID,
354  FALSE);
355 
356  switch (typecode)
357  {
358  case DBUS_TYPE_BYTE:
359  case DBUS_TYPE_BOOLEAN:
360  case DBUS_TYPE_INT16:
361  case DBUS_TYPE_UINT16:
362  case DBUS_TYPE_INT32:
363  case DBUS_TYPE_UINT32:
364  case DBUS_TYPE_INT64:
365  case DBUS_TYPE_UINT64:
366  case DBUS_TYPE_DOUBLE:
367  case DBUS_TYPE_UNIX_FD:
368  return TRUE;
369  default:
370  return FALSE;
371  }
372 }
373 
384 dbus_type_is_valid (int typecode)
385 {
386  switch (typecode)
387  {
388  case DBUS_TYPE_BYTE:
389  case DBUS_TYPE_BOOLEAN:
390  case DBUS_TYPE_INT16:
391  case DBUS_TYPE_UINT16:
392  case DBUS_TYPE_INT32:
393  case DBUS_TYPE_UINT32:
394  case DBUS_TYPE_INT64:
395  case DBUS_TYPE_UINT64:
396  case DBUS_TYPE_DOUBLE:
397  case DBUS_TYPE_STRING:
399  case DBUS_TYPE_SIGNATURE:
400  case DBUS_TYPE_ARRAY:
401  case DBUS_TYPE_STRUCT:
403  case DBUS_TYPE_VARIANT:
404  case DBUS_TYPE_UNIX_FD:
405  return TRUE;
406 
407  default:
408  return FALSE;
409  }
410 }
411  /* end of DBusSignature group */
413 
414 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
415 
423 _dbus_signature_test (void)
424 {
425  DBusSignatureIter iter;
426  DBusSignatureIter subiter;
427  DBusSignatureIter subsubiter;
428  DBusSignatureIter subsubsubiter;
429  const char *sig;
430  dbus_bool_t boolres;
431 
432  _DBUS_STATIC_ASSERT (sizeof (DBusSignatureIter) >= sizeof (DBusSignatureRealIter));
433 
434  sig = "";
437  dbus_signature_iter_init (&iter, sig);
439 
443  dbus_signature_iter_init (&iter, sig);
445 
448  dbus_signature_iter_init (&iter, sig);
450  boolres = dbus_signature_iter_next (&iter);
451  _dbus_assert (boolres);
453 
462  dbus_signature_iter_init (&iter, sig);
464  boolres = dbus_signature_iter_next (&iter);
465  _dbus_assert (boolres);
467  dbus_signature_iter_recurse (&iter, &subiter);
469  boolres = dbus_signature_iter_next (&subiter);
470  _dbus_assert (boolres);
472  boolres = dbus_signature_iter_next (&subiter);
473  _dbus_assert (boolres);
475  boolres = dbus_signature_iter_next (&subiter);
476  _dbus_assert (boolres);
478 
482  DBUS_TYPE_BYTE_AS_STRING
487  DBUS_TYPE_BYTE_AS_STRING
488  DBUS_STRUCT_END_CHAR_AS_STRING
491  dbus_signature_iter_init (&iter, sig);
493  boolres = dbus_signature_iter_next (&iter);
494  _dbus_assert (boolres);
496  dbus_signature_iter_recurse (&iter, &subiter);
498  boolres = dbus_signature_iter_next (&subiter);
499  _dbus_assert (boolres);
501  boolres = dbus_signature_iter_next (&subiter);
502  _dbus_assert (boolres);
505 
506  dbus_signature_iter_recurse (&subiter, &subsubiter);
509 
510  dbus_signature_iter_recurse (&subsubiter, &subsubsubiter);
512  boolres = dbus_signature_iter_next (&subiter);
513  _dbus_assert (boolres);
515  dbus_signature_iter_recurse (&subiter, &subsubiter);
517 
526  dbus_signature_iter_init (&iter, sig);
529 
530  dbus_signature_iter_recurse (&iter, &subiter);
531  dbus_signature_iter_recurse (&subiter, &subsubiter);
533  boolres = dbus_signature_iter_next (&subsubiter);
534  _dbus_assert (boolres);
536  boolres = dbus_signature_iter_next (&subsubiter);
537  _dbus_assert (!boolres);
538 
539  boolres = dbus_signature_iter_next (&iter);
540  _dbus_assert (boolres);
542  boolres = dbus_signature_iter_next (&iter);
543  _dbus_assert (!boolres);
544 
547 
550 
554 
555  sig = DBUS_TYPE_ARRAY_AS_STRING
558 
561 
564 
568 
570  DBUS_TYPE_INT32_AS_STRING
573 
574  sig = DBUS_STRUCT_END_CHAR_AS_STRING
577 
578  sig = DBUS_STRUCT_BEGIN_CHAR_AS_STRING
581  return TRUE;
582 #if 0
583  oom:
584  _dbus_assert_not_reached ("out of memory");
585  return FALSE;
586 #endif
587 }
588 
589 #endif
590