D-Bus  1.12.2
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);
241  reason = _dbus_validate_signature_with_reason (&str, 0, _dbus_string_get_length (&str));
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 
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 
558 
561 
564 
568 
573 
577 
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 
dbus_bool_t dbus_type_is_fixed(int typecode)
Tells you whether values of this type can change length if you set them to some other value...
#define DBUS_TYPE_UINT16
Type code marking a 16-bit unsigned integer.
Definition: dbus-protocol.h:78
#define NULL
A null pointer, defined appropriately for C or C++.
#define DBUS_STRUCT_BEGIN_CHAR_AS_STRING
DBUS_STRUCT_BEGIN_CHAR as a string literal instead of a int literal
#define DBUS_TYPE_STRUCT
STRUCT and DICT_ENTRY are sort of special since their codes can&#39;t appear in a type string...
#define DBUS_TYPE_DICT_ENTRY
Type code used to represent a dict entry; however, this type code does not appear in type signatures...
#define DBUS_TYPE_STRING
Type code marking a UTF-8 encoded, nul-terminated Unicode string.
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
void _dbus_type_signature_next(const char *type_str, int *type_pos)
Skips to the next "complete" type inside a type signature.
#define DBUS_TYPE_ARRAY_AS_STRING
DBUS_TYPE_ARRAY as a string literal instead of a int literal
#define DBUS_TYPE_BYTE
Type code marking an 8-bit unsigned integer.
Definition: dbus-protocol.h:66
DBusSignatureIter struct; contains no public fields.
dbus_bool_t dbus_signature_iter_next(DBusSignatureIter *iter)
Skip to the next value on this "level".
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:175
#define DBUS_DICT_ENTRY_END_CHAR_AS_STRING
DBUS_DICT_ENTRY_END_CHAR as a string literal instead of a int literal
DBusValidity
This is primarily used in unit testing, so we can verify that each invalid message is invalid for the...
#define DBUS_STRUCT_END_CHAR
Code marking the end of a struct type in a type signature.
#define DBUS_TYPE_DOUBLE
Type code marking an 8-byte double in IEEE 754 format.
Definition: dbus-protocol.h:98
#define DBUS_TYPE_ARRAY
Type code marking a D-Bus array type.
#define DBUS_TYPE_INT64
Type code marking a 64-bit signed integer.
Definition: dbus-protocol.h:90
Implementation details of DBusSignatureIter, all fields are private.
int _dbus_first_type_in_signature_c_str(const char *str, int pos)
Similar to _dbus_first_type_in_signature, but operates on a C string buffer.
dbus_bool_t dbus_type_is_basic(int typecode)
A "basic type" is a somewhat arbitrary concept, but the intent is to include those types that are ful...
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
void _dbus_string_init_const(DBusString *str, const char *value)
Initializes a constant string.
Definition: dbus-string.c:190
void dbus_signature_iter_init(DBusSignatureIter *iter, const char *signature)
Initializes a DBusSignatureIter for reading a type signature.
#define DBUS_TYPE_INT32_AS_STRING
DBUS_TYPE_INT32 as a string literal instead of a int literal
Definition: dbus-protocol.h:84
#define DBUS_TYPE_VARIANT_AS_STRING
DBUS_TYPE_VARIANT as a string literal instead of a int literal
void dbus_signature_iter_recurse(const DBusSignatureIter *iter, DBusSignatureIter *subiter)
Initialize a new iterator pointing to the first type in the current container.
#define DBUS_TYPE_UINT16_AS_STRING
DBUS_TYPE_UINT16 as a string literal instead of a int literal
Definition: dbus-protocol.h:80
#define DBUS_TYPE_INT32
Type code marking a 32-bit signed integer.
Definition: dbus-protocol.h:82
unsigned int finished
true if we are at the end iter
#define DBUS_TYPE_DOUBLE_AS_STRING
DBUS_TYPE_DOUBLE as a string literal instead of a int literal
Object representing an exception.
Definition: dbus-errors.h:48
#define DBUS_TYPE_BYTE_AS_STRING
DBUS_TYPE_BYTE as a string literal instead of a int literal
Definition: dbus-protocol.h:68
#define DBUS_TYPE_SIGNATURE
Type code marking a D-Bus type signature.
#define DBUS_TYPE_UINT64
Type code marking a 64-bit unsigned integer.
Definition: dbus-protocol.h:94
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:354
#define DBUS_TYPE_VARIANT
Type code marking a D-Bus variant type.
#define DBUS_TYPE_UINT32
Type code marking a 32-bit unsigned integer.
Definition: dbus-protocol.h:86
the data is valid
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
Definition: dbus-string.c:259
#define TRUE
Expands to "1".
#define _dbus_assert_not_reached(explanation)
Aborts with an error message if called.
#define DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
DBUS_DICT_ENTRY_BEGIN_CHAR as a string literal instead of a int literal
#define DBUS_TYPE_OBJECT_PATH
Type code marking a D-Bus object path.
#define DBUS_TYPE_UNIX_FD
Type code marking a unix file descriptor.
#define DBUS_TYPE_INT16_AS_STRING
DBUS_TYPE_INT16 as a string literal instead of a int literal
Definition: dbus-protocol.h:76
int dbus_signature_iter_get_element_type(const DBusSignatureIter *iter)
Convenience function for returning the element type of an array; This function allows you to avoid in...
#define DBUS_TYPE_INVALID
Type code that is never equal to a legitimate type code.
Definition: dbus-protocol.h:60
DBusValidity _dbus_validate_signature_with_reason(const DBusString *type_str, int type_pos, int len)
Verifies that the range of type_str from type_pos to type_end is a valid signature.
#define DBUS_ERROR_INVALID_SIGNATURE
A type signature is not valid.
#define DBUS_TYPE_INT16
Type code marking a 16-bit signed integer.
Definition: dbus-protocol.h:74
#define DBUS_TYPE_BOOLEAN
Type code marking a boolean.
Definition: dbus-protocol.h:70
dbus_bool_t _dbus_string_append_len(DBusString *str, const char *buffer, int len)
Appends block of bytes with the given length to a DBusString.
Definition: dbus-string.c:1137
#define DBUS_STRUCT_END_CHAR_AS_STRING
DBUS_STRUCT_END_CHAR a string literal instead of a int literal
dbus_bool_t dbus_signature_validate(const char *signature, DBusError *error)
Check a type signature for validity.
#define DBUS_TYPE_STRING_AS_STRING
DBUS_TYPE_STRING as a string literal instead of a int literal
#define FALSE
Expands to "0".
dbus_bool_t dbus_signature_validate_single(const char *signature, DBusError *error)
Check that a type signature is both valid and contains exactly one complete type. ...
#define DBUS_DICT_ENTRY_END_CHAR
Code marking the end of a dict entry type in a type signature.
#define DBUS_TYPE_BOOLEAN_AS_STRING
DBUS_TYPE_BOOLEAN as a string literal instead of a int literal
Definition: dbus-protocol.h:72
dbus_bool_t _dbus_string_steal_data(DBusString *str, char **data_return)
Like _dbus_string_get_data(), but removes the gotten data from the original string.
Definition: dbus-string.c:641
int dbus_signature_iter_get_current_type(const DBusSignatureIter *iter)
Returns the current type pointed to by the iterator.
const char * pos
current position in the signature string
unsigned int in_array
true if we are a subiterator pointing to an array&#39;s element type
#define DBUS_TYPE_DICT_ENTRY_AS_STRING
DBUS_TYPE_DICT_ENTRY as a string literal instead of a int literal
#define DBUS_TYPE_UINT32_AS_STRING
DBUS_TYPE_UINT32 as a string literal instead of a int literal
Definition: dbus-protocol.h:88
dbus_bool_t dbus_type_is_valid(int typecode)
Return TRUE if the argument is a valid typecode.
char * dbus_signature_iter_get_signature(const DBusSignatureIter *iter)
Returns the signature of the single complete type starting at the given iterator. ...
dbus_bool_t dbus_type_is_container(int typecode)
A "container type" can contain basic types, or nested container types.