DBusString implementation details

DBusString implementation details. More...

Macros
#define	_DBUS_STRING_MAX_LENGTH   (_DBUS_INT32_MAX - _DBUS_STRING_ALLOCATION_PADDING)
	The maximum length of a DBusString.
#define	DBUS_GENERIC_STRING_PREAMBLE(real)
	Checks a bunch of assertions about a string object.
#define	DBUS_STRING_PREAMBLE(str)
	Checks assertions about a string object that needs to be modifiable - may not be locked or const.
#define	DBUS_LOCKED_STRING_PREAMBLE(str)
	Checks assertions about a string object that may be locked but can't be const.
#define	DBUS_CONST_STRING_PREAMBLE(str)
	Checks assertions about a string that may be const or locked.
#define	DBUS_IS_ASCII_BLANK(c)   ((c) == ' ' || (c) == '\t')
	Checks for ASCII blank byte.
#define	DBUS_IS_ASCII_WHITE(c)   ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')
	Checks for ASCII whitespace byte.

Detailed Description

DBusString implementation details.

The guts of DBusString.

Macro Definition Documentation

_DBUS_STRING_MAX_LENGTH

#define _DBUS_STRING_MAX_LENGTH   (_DBUS_INT32_MAX - _DBUS_STRING_ALLOCATION_PADDING)

The maximum length of a DBusString.

Definition at line 71 of file dbus-string-private.h.

DBUS_CONST_STRING_PREAMBLE

#define DBUS_CONST_STRING_PREAMBLE

(

str

)

Value:

  const DBusRealString *real = (DBusRealString*) str; \
  DBUS_GENERIC_STRING_PREAMBLE (real)

Checks assertions about a string that may be const or locked.

Also declares the "real" variable pointing to DBusRealString.

Parameters

str	the string.

Definition at line 116 of file dbus-string-private.h.

DBUS_GENERIC_STRING_PREAMBLE

#define DBUS_GENERIC_STRING_PREAMBLE

(

real

)

Value:

  do { \
      (void) real; /* might be unused unless asserting */ \
      _dbus_assert ((real) != NULL); \
      _dbus_assert ((real)->valid); \
      _dbus_assert ((real)->len >= 0); \
      _dbus_assert ((real)->allocated >= 0); \
      _dbus_assert ((real)->len <= ((real)->allocated - _DBUS_STRING_ALLOCATION_PADDING)); \
      _dbus_assert ((real)->len <= _DBUS_STRING_MAX_LENGTH); \
  } while (0)

Checks a bunch of assertions about a string object.

Parameters

real	the DBusRealString

Definition at line 78 of file dbus-string-private.h.

DBUS_IS_ASCII_BLANK

#define DBUS_IS_ASCII_BLANK

(

c

)

((c) == ' ' || (c) == '\t')

Checks for ASCII blank byte.

Parameters

c

the byte

Definition at line 123 of file dbus-string-private.h.

DBUS_IS_ASCII_WHITE

#define DBUS_IS_ASCII_WHITE

(

c

)

((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')

Checks for ASCII whitespace byte.

Parameters

c

the byte

Definition at line 129 of file dbus-string-private.h.

DBUS_LOCKED_STRING_PREAMBLE

#define DBUS_LOCKED_STRING_PREAMBLE

(

str

)

Value:

  DBusRealString *real = (DBusRealString*) str; \
  DBUS_GENERIC_STRING_PREAMBLE (real);                                                 \
  _dbus_assert (!(real)->constant)

Checks assertions about a string object that may be locked but can't be const.

i.e. a string object that we can free. Also declares the "real" variable pointing to DBusRealString.

Parameters

str	the string

Definition at line 107 of file dbus-string-private.h.

DBUS_STRING_PREAMBLE

#define DBUS_STRING_PREAMBLE

(

str

)

Value:

  DBusRealString *real = (DBusRealString*) str; \
  DBUS_GENERIC_STRING_PREAMBLE (real);                                          \
  _dbus_assert (!(real)->constant);                                             \
  _dbus_assert (!(real)->locked)

Checks assertions about a string object that needs to be modifiable - may not be locked or const.

Also declares the "real" variable pointing to DBusRealString.

Parameters

str	the string

Definition at line 95 of file dbus-string-private.h.