Main Page | Modules | Data Structures | Directories | File List | Data Fields | Related Pages

string class
[D-BUS internal implementation details]

DBusString data structure. More...

Defines

#define ASSIGN_4_OCTETS(p, octets)   *((dbus_uint32_t*)(p)) = *((dbus_uint32_t*)(octets));
#define ASSIGN_8_OCTETS(p, octets)   *((dbus_uint64_t*)(p)) = *((dbus_uint64_t*)(octets));
#define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at)
 Checks assertions for two strings we're copying a segment between, and declares real_source/real_dest variables.
#define UTF8_COMPUTE(Char, Mask, Len)
 computes length and mask of a unicode character
#define UTF8_LENGTH(Char)
 computes length of a unicode character in UTF-8
#define UTF8_GET(Result, Chars, Count, Mask, Len)
 Gets a UTF-8 value.
#define UNICODE_VALID(Char)
 Check whether a unicode char is in a valid range.
#define VALID_INITIAL_NAME_CHARACTER(c)
 Determine wether the given charater is valid as the first charater in a name.
#define VALID_NAME_CHARACTER(c)
 Determine wether the given charater is valid as a second or later character in a nam.

Functions

dbus_bool_t _dbus_string_init_preallocated (DBusString *str, int allocate_size)
 Initializes a string that can be up to the given allocation size before it has to realloc.
dbus_bool_t _dbus_string_init (DBusString *str)
 Initializes a string.
void _dbus_string_init_const (DBusString *str, const char *value)
 Initializes a constant string.
void _dbus_string_init_const_len (DBusString *str, const char *value, int len)
 Initializes a constant string with a length.
void _dbus_string_free (DBusString *str)
 Frees a string created by _dbus_string_init().
char * _dbus_string_get_data (DBusString *str)
 Gets the raw character buffer from the string.
char * _dbus_string_get_data_len (DBusString *str, int start, int len)
 Gets a sub-portion of the raw character buffer from the string.
const char * _dbus_string_get_const_data_len (const DBusString *str, int start, int len)
 const version of _dbus_string_get_data_len().
void _dbus_string_set_byte (DBusString *str, int i, unsigned char byte)
 Sets the value of the byte at the given position.
dbus_bool_t _dbus_string_insert_bytes (DBusString *str, int i, int n_bytes, unsigned char byte)
 Inserts a number of bytes of a given value at the given position.
dbus_bool_t _dbus_string_insert_byte (DBusString *str, int i, unsigned char byte)
 Inserts a single byte at the given position.
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.
dbus_bool_t _dbus_string_steal_data_len (DBusString *str, char **data_return, int start, int len)
 Like _dbus_string_get_data_len(), but removes the gotten data from the original string.
dbus_bool_t _dbus_string_copy_data (const DBusString *str, char **data_return)
 Copies the data from the string into a char*.
dbus_bool_t _dbus_string_copy_data_len (const DBusString *str, char **data_return, int start, int len)
 Copies a segment of the string into a char*.
void _dbus_string_copy_to_buffer (const DBusString *str, char *buffer, int avail_len)
 Copies the contents of a DBusString into a different buffer.
dbus_bool_t _dbus_string_lengthen (DBusString *str, int additional_length)
 Makes a string longer by the given number of bytes.
void _dbus_string_shorten (DBusString *str, int length_to_remove)
 Makes a string shorter by the given number of bytes.
dbus_bool_t _dbus_string_set_length (DBusString *str, int length)
 Sets the length of a string.
dbus_bool_t _dbus_string_align_length (DBusString *str, int alignment)
 Align the length of a string to a specific alignment (typically 4 or 8) by appending nul bytes to the string.
dbus_bool_t _dbus_string_alloc_space (DBusString *str, int extra_bytes)
 Preallocate extra_bytes such that a future lengthening of the string by extra_bytes is guaranteed to succeed without an out of memory error.
dbus_bool_t _dbus_string_append (DBusString *str, const char *buffer)
 Appends a nul-terminated C-style string to a DBusString.
dbus_bool_t _dbus_string_append_4_aligned (DBusString *str, const unsigned char octets[4])
 Appends 4 bytes aligned on a 4 byte boundary with any alignment padding initialized to 0.
dbus_bool_t _dbus_string_append_8_aligned (DBusString *str, const unsigned char octets[8])
 Appends 8 bytes aligned on an 8 byte boundary with any alignment padding initialized to 0.
dbus_bool_t _dbus_string_insert_4_aligned (DBusString *str, int insert_at, const unsigned char octets[4])
 Inserts 4 bytes aligned on a 4 byte boundary with any alignment padding initialized to 0.
dbus_bool_t _dbus_string_insert_8_aligned (DBusString *str, int insert_at, const unsigned char octets[8])
 Inserts 8 bytes aligned on an 8 byte boundary with any alignment padding initialized to 0.
dbus_bool_t _dbus_string_insert_alignment (DBusString *str, int *insert_at, int alignment)
 Inserts padding at *insert_at such to align it to the given boundary.
dbus_bool_t _dbus_string_append_printf_valist (DBusString *str, const char *format, va_list args)
 Appends a printf-style formatted string to the DBusString.
dbus_bool_t _dbus_string_append_printf (DBusString *str, const char *format,...)
 Appends a printf-style formatted string to the DBusString.
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.
dbus_bool_t _dbus_string_append_byte (DBusString *str, unsigned char byte)
 Appends a single byte to the string, returning FALSE if not enough memory.
dbus_bool_t _dbus_string_append_unichar (DBusString *str, dbus_unichar_t ch)
 Appends a single Unicode character, encoding the character in UTF-8 format.
void _dbus_string_delete (DBusString *str, int start, int len)
 Deletes a segment of a DBusString with length len starting at start.
dbus_bool_t _dbus_string_move (DBusString *source, int start, DBusString *dest, int insert_at)
 Moves the end of one string into another string.
dbus_bool_t _dbus_string_copy (const DBusString *source, int start, DBusString *dest, int insert_at)
 Like _dbus_string_move(), but does not delete the section of the source string that's copied to the dest string.
dbus_bool_t _dbus_string_move_len (DBusString *source, int start, int len, DBusString *dest, int insert_at)
 Like _dbus_string_move(), but can move a segment from the middle of the source string.
dbus_bool_t _dbus_string_copy_len (const DBusString *source, int start, int len, DBusString *dest, int insert_at)
 Like _dbus_string_copy(), but can copy a segment from the middle of the source string.
dbus_bool_t _dbus_string_replace_len (const DBusString *source, int start, int len, DBusString *dest, int replace_at, int replace_len)
 Replaces a segment of dest string with a segment of source string.
void _dbus_string_get_unichar (const DBusString *str, int start, dbus_unichar_t *ch_return, int *end_return)
 Gets a unicode character from a UTF-8 string.
dbus_bool_t _dbus_string_find (const DBusString *str, int start, const char *substr, int *found)
 Finds the given substring in the string, returning TRUE and filling in the byte index where the substring was found, if it was found.
dbus_bool_t _dbus_string_find_to (const DBusString *str, int start, int end, const char *substr, int *found)
 Finds the given substring in the string, up to a certain position, returning TRUE and filling in the byte index where the substring was found, if it was found.
dbus_bool_t _dbus_string_find_byte_backward (const DBusString *str, int start, unsigned char byte, int *found)
 Find the given byte scanning backward from the given start.
dbus_bool_t _dbus_string_find_blank (const DBusString *str, int start, int *found)
 Finds a blank (space or tab) in the string.
void _dbus_string_skip_blank (const DBusString *str, int start, int *end)
 Skips blanks from start, storing the first non-blank in *end (blank is space or tab).
void _dbus_string_skip_white (const DBusString *str, int start, int *end)
 Skips whitespace from start, storing the first non-whitespace in *end.
dbus_bool_t _dbus_string_pop_line (DBusString *source, DBusString *dest)
 Assigns a newline-terminated or \r\n-terminated line from the front of the string to the given dest string.
void _dbus_string_delete_first_word (DBusString *str)
 Deletes up to and including the first blank space in the string.
void _dbus_string_delete_leading_blanks (DBusString *str)
 Deletes any leading blanks in the string.
dbus_bool_t _dbus_string_equal (const DBusString *a, const DBusString *b)
 Tests two DBusString for equality.
dbus_bool_t _dbus_string_equal_len (const DBusString *a, const DBusString *b, int len)
 Tests two DBusString for equality up to the given length.
dbus_bool_t _dbus_string_equal_substring (const DBusString *a, int a_start, int a_len, const DBusString *b, int b_start)
 Tests two sub-parts of two DBusString for equality.
dbus_bool_t _dbus_string_equal_c_str (const DBusString *a, const char *c_str)
 Checks whether a string is equal to a C string.
dbus_bool_t _dbus_string_starts_with_c_str (const DBusString *a, const char *c_str)
 Checks whether a string starts with the given C string.
dbus_bool_t _dbus_string_ends_with_c_str (const DBusString *a, const char *c_str)
 Returns whether a string ends with the given suffix.
dbus_bool_t _dbus_string_hex_encode (const DBusString *source, int start, DBusString *dest, int insert_at)
 Encodes a string in hex, the way MD5 and SHA-1 are usually encoded.
dbus_bool_t _dbus_string_hex_decode (const DBusString *source, int start, int *end_return, DBusString *dest, int insert_at)
 Decodes a string from hex encoding.
dbus_bool_t _dbus_string_validate_ascii (const DBusString *str, int start, int len)
 Checks that the given range of the string is valid ASCII with no nul bytes.
dbus_bool_t _dbus_string_validate_utf8 (const DBusString *str, int start, int len)
 Checks that the given range of the string is valid UTF-8.
dbus_bool_t _dbus_string_validate_nul (const DBusString *str, int start, int len)
 Checks that the given range of the string is all nul bytes.
dbus_bool_t _dbus_string_validate_path (const DBusString *str, int start, int len)
 Checks that the given range of the string is a valid object path name in the D-BUS protocol.
dbus_bool_t _dbus_string_validate_interface (const DBusString *str, int start, int len)
 Checks that the given range of the string is a valid interface name in the D-BUS protocol.
dbus_bool_t _dbus_string_validate_member (const DBusString *str, int start, int len)
 Checks that the given range of the string is a valid member name in the D-BUS protocol.
dbus_bool_t _dbus_string_validate_error_name (const DBusString *str, int start, int len)
 Checks that the given range of the string is a valid error name in the D-BUS protocol.
dbus_bool_t _dbus_string_validate_service (const DBusString *str, int start, int len)
 Checks that the given range of the string is a valid service name in the D-BUS protocol.
dbus_bool_t _dbus_string_validate_signature (const DBusString *str, int start, int len)
 Checks that the given range of the string is a valid message type signature in the D-BUS protocol.
void _dbus_string_zero (DBusString *str)
 Clears all allocated bytes in the string to zero.
dbus_bool_t _dbus_string_append_int (DBusString *str, long value)
 Appends an integer to a DBusString.
dbus_bool_t _dbus_string_append_uint (DBusString *str, unsigned long value)
 Appends an unsigned integer to a DBusString.
dbus_bool_t _dbus_string_append_double (DBusString *str, double value)
 Appends a double to a DBusString.
dbus_bool_t _dbus_string_parse_int (const DBusString *str, int start, long *value_return, int *end_return)
 Parses an integer contained in a DBusString.
dbus_bool_t _dbus_string_parse_double (const DBusString *str, int start, double *value_return, int *end_return)
 Parses a floating point number contained in a DBusString.

Detailed Description

DBusString data structure.

Types and functions related to DBusString. DBusString is intended to be a string class that makes it hard to mess up security issues (and just in general harder to write buggy code). It should be used (or extended and then used) rather than the libc stuff in string.h. The string class is a bit inconvenient at spots because it handles out-of-memory failures and tries to be extra-robust.

A DBusString has a maximum length set at initialization time; this can be used to ensure that a buffer doesn't get too big. The _dbus_string_lengthen() method checks for overflow, and for max length being exceeded.

Try to avoid conversion to a plain C string, i.e. add methods on the string object instead, only convert to C string when passing things out to the public API. In particular, no sprintf, strcpy, strcat, any of that should be used. The GString feature of accepting negative numbers for "length of string" is also absent, because it could keep us from detecting bogus huge lengths. i.e. if we passed in some bogus huge length it would be taken to mean "current length of string" instead of "broken crack"

Todo:
DBusString needs a lot of cleaning up; some of the API is no longer used, and the API is pretty inconsistent.
In particular all the "append" APIs, especially those involving alignment but probably lots of them, are no longer used by the marshaling code which always does "inserts" now.

Define Documentation

#define DBUS_STRING_COPY_PREAMBLE source,
start,
dest,
insert_at   ) 
 

Value:

DBusRealString *real_source = (DBusRealString*) source;               \
  DBusRealString *real_dest = (DBusRealString*) dest;                   \
  _dbus_assert ((source) != (dest));                                    \
  DBUS_GENERIC_STRING_PREAMBLE (real_source);                           \
  DBUS_GENERIC_STRING_PREAMBLE (real_dest);                             \
  _dbus_assert (!real_dest->constant);                                  \
  _dbus_assert (!real_dest->locked);                                    \
  _dbus_assert ((start) >= 0);                                          \
  _dbus_assert ((start) <= real_source->len);                           \
  _dbus_assert ((insert_at) >= 0);                                      \
  _dbus_assert ((insert_at) <= real_dest->len)
Checks assertions for two strings we're copying a segment between, and declares real_source/real_dest variables.

Parameters:
source the source string
start the starting offset
dest the dest string
insert_at where the copied segment is inserted

Definition at line 1431 of file dbus-string.c.

Referenced by _dbus_string_copy(), _dbus_string_copy_len(), _dbus_string_move_len(), and _dbus_string_replace_len().

#define UNICODE_VALID Char   ) 
 

Value:

((Char) < 0x110000 &&                     \
     (((Char) & 0xFFFFF800) != 0xD800) &&     \
     ((Char) < 0xFDD0 || (Char) > 0xFDEF) &&  \
     ((Char) & 0xFFFF) != 0xFFFF)
Check whether a unicode char is in a valid range.

Parameters:
Char the character

Definition at line 1720 of file dbus-string.c.

Referenced by _dbus_string_validate_utf8().

#define UTF8_COMPUTE Char,
Mask,
Len   ) 
 

computes length and mask of a unicode character

Parameters:
Char the char
Mask the mask variable to assign to
Len the length variable to assign to

Definition at line 1645 of file dbus-string.c.

Referenced by _dbus_string_get_unichar(), and _dbus_string_validate_utf8().

#define UTF8_GET Result,
Chars,
Count,
Mask,
Len   ) 
 

Value:

(Result) = (Chars)[0] & (Mask);                                       \
  for ((Count) = 1; (Count) < (Len); ++(Count))                               \
    {                                                                         \
      if (((Chars)[(Count)] & 0xc0) != 0x80)                                  \
        {                                                                     \
          (Result) = -1;                                                      \
          break;                                                              \
        }                                                                     \
      (Result) <<= 6;                                                         \
      (Result) |= ((Chars)[(Count)] & 0x3f);                                  \
    }
Gets a UTF-8 value.

Parameters:
Result variable for extracted unicode char.
Chars the bytes to decode
Count counter variable
Mask mask for this char
Len length for this char in bytes

Definition at line 1702 of file dbus-string.c.

Referenced by _dbus_string_get_unichar(), and _dbus_string_validate_utf8().

#define UTF8_LENGTH Char   ) 
 

Value:

((Char) < 0x80 ? 1 :                 \
   ((Char) < 0x800 ? 2 :               \
    ((Char) < 0x10000 ? 3 :            \
     ((Char) < 0x200000 ? 4 :          \
      ((Char) < 0x4000000 ? 5 : 6)))))
computes length of a unicode character in UTF-8

Parameters:
Char the char

Definition at line 1686 of file dbus-string.c.

Referenced by _dbus_string_validate_utf8().

#define VALID_INITIAL_NAME_CHARACTER  ) 
 

Value:

( ((c) >= 'A' && (c) <= 'Z') ||               \
    ((c) >= 'a' && (c) <= 'z') ||               \
    ((c) == '_') )
Determine wether the given charater is valid as the first charater in a name.

Definition at line 2827 of file dbus-string.c.

Referenced by _dbus_string_validate_interface(), and _dbus_string_validate_member().

#define VALID_NAME_CHARACTER  ) 
 

Value:

( ((c) >= '0' && (c) <= '9') ||               \
    ((c) >= 'A' && (c) <= 'Z') ||               \
    ((c) >= 'a' && (c) <= 'z') ||               \
    ((c) == '_') )
Determine wether the given charater is valid as a second or later character in a nam.

Definition at line 2836 of file dbus-string.c.

Referenced by _dbus_string_validate_interface(), and _dbus_string_validate_member().


Function Documentation

dbus_bool_t _dbus_string_align_length DBusString str,
int  alignment
 

Align the length of a string to a specific alignment (typically 4 or 8) by appending nul bytes to the string.

Parameters:
str a string
alignment the alignment
Returns:
FALSE if no memory

Definition at line 980 of file dbus-string.c.

dbus_bool_t _dbus_string_alloc_space DBusString str,
int  extra_bytes
 

Preallocate extra_bytes such that a future lengthening of the string by extra_bytes is guaranteed to succeed without an out of memory error.

Parameters:
str a string
extra_bytes bytes to alloc
Returns:
FALSE if no memory

Definition at line 996 of file dbus-string.c.

References _dbus_string_lengthen(), _dbus_string_shorten(), FALSE, and TRUE.

dbus_bool_t _dbus_string_append DBusString str,
const char *  buffer
 

Appends a nul-terminated C-style string to a DBusString.

Parameters:
str the DBusString
buffer the nul-terminated characters to append
Returns:
FALSE if not enough memory.

Definition at line 1032 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, FALSE, DBusRealString::max_length, and NULL.

Referenced by _dbus_become_daemon(), _dbus_directory_get_next_file(), _dbus_homedir_from_username(), _dbus_keyring_new_homedir(), _dbus_marshal_object_path(), _dbus_server_new_for_domain_socket(), _dbus_server_new_for_tcp_socket(), _dbus_string_get_dirname(), _dbus_string_save_to_file(), _dbus_transport_new_for_domain_socket(), _dbus_transport_new_for_tcp_socket(), _dbus_user_at_console(), dbus_server_listen(), and dbus_set_error().

dbus_bool_t _dbus_string_append_4_aligned DBusString str,
const unsigned char  octets[4]
 

Appends 4 bytes aligned on a 4 byte boundary with any alignment padding initialized to 0.

Parameters:
str the DBusString
octets 4 bytes to append
Returns:
FALSE if not enough memory.

Definition at line 1081 of file dbus-string.c.

References DBUS_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_append_8_aligned DBusString str,
const unsigned char  octets[8]
 

Appends 8 bytes aligned on an 8 byte boundary with any alignment padding initialized to 0.

Parameters:
str the DBusString
octets 8 bytes to append
Returns:
FALSE if not enough memory.

Definition at line 1103 of file dbus-string.c.

References DBUS_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_append_byte DBusString str,
unsigned char  byte
 

Appends a single byte to the string, returning FALSE if not enough memory.

Parameters:
str the string
byte the byte to append
Returns:
TRUE on success

Definition at line 1282 of file dbus-string.c.

References DBUS_STRING_PREAMBLE, FALSE, DBusRealString::len, and TRUE.

Referenced by _dbus_concat_dir_and_file(), _dbus_marshal_basic_type(), _dbus_marshal_object_path(), _dbus_string_hex_decode(), and _dbus_string_hex_encode().

dbus_bool_t _dbus_string_append_double DBusString str,
double  value
 

Appends a double to a DBusString.

Parameters:
str the string
value the floating point value
Returns:
FALSE if not enough memory or other failure.

Definition at line 1062 of file dbus-sysdeps.c.

References _dbus_string_get_data_len(), _dbus_string_lengthen(), _dbus_string_shorten(), FALSE, and TRUE.

dbus_bool_t _dbus_string_append_int DBusString str,
long  value
 

Appends an integer to a DBusString.

Parameters:
str the string
value the integer value
Returns:
FALSE if not enough memory or other failure.

Definition at line 986 of file dbus-sysdeps.c.

References _dbus_string_get_data_len(), _dbus_string_lengthen(), _dbus_string_shorten(), FALSE, and TRUE.

Referenced by _dbus_become_daemon(), _dbus_server_new_for_tcp_socket(), and _dbus_transport_new_for_tcp_socket().

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.

Parameters:
str the DBusString
buffer the bytes to append
len the number of bytes to append
Returns:
FALSE if not enough memory.

Definition at line 1262 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, and NULL.

Referenced by _dbus_marshal_byte_array(), _dbus_marshal_string(), _dbus_marshal_string_len(), and _dbus_sha_final().

dbus_bool_t _dbus_string_append_printf DBusString str,
const char *  format,
  ...
 

Appends a printf-style formatted string to the DBusString.

Parameters:
str the string
format printf format
Returns:
FALSE if no memory

Definition at line 1239 of file dbus-string.c.

References _dbus_string_append_printf_valist().

Referenced by dbus_connection_dispatch().

dbus_bool_t _dbus_string_append_printf_valist DBusString str,
const char *  format,
va_list  args
 

Appends a printf-style formatted string to the DBusString.

Parameters:
str the string
format printf format
args variable argument list
Returns:
FALSE if no memory

Definition at line 1200 of file dbus-string.c.

References _dbus_string_lengthen(), DBUS_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

Referenced by _dbus_string_append_printf(), dbus_message_new_error_printf(), and dbus_set_error().

dbus_bool_t _dbus_string_append_uint DBusString str,
unsigned long  value
 

Appends an unsigned integer to a DBusString.

Parameters:
str the string
value the integer value
Returns:
FALSE if not enough memory or other failure.

Definition at line 1024 of file dbus-sysdeps.c.

References _dbus_string_get_data_len(), _dbus_string_lengthen(), _dbus_string_shorten(), FALSE, and TRUE.

dbus_bool_t _dbus_string_append_unichar DBusString str,
dbus_unichar_t  ch
 

Appends a single Unicode character, encoding the character in UTF-8 format.

Parameters:
str the string
ch the Unicode character

Definition at line 1303 of file dbus-string.c.

References DBUS_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::max_length, and TRUE.

dbus_bool_t _dbus_string_copy const DBusString source,
int  start,
DBusString dest,
int  insert_at
 

Like _dbus_string_move(), but does not delete the section of the source string that's copied to the dest string.

Parameters:
source the source string
start where to start copying the source string
dest the destination string
insert_at where to place the copied part of source string
Returns:
FALSE if not enough memory

Definition at line 1479 of file dbus-string.c.

References DBUS_STRING_COPY_PREAMBLE.

Referenced by _dbus_auth_decode_data(), _dbus_auth_encode_data(), _dbus_concat_dir_and_file(), _dbus_keyring_new_homedir(), _dbus_string_save_to_file(), and dbus_message_copy().

dbus_bool_t _dbus_string_copy_data const DBusString str,
char **  data_return
 

Copies the data from the string into a char*.

Parameters:
str the string
data_return place to return the data
Returns:
TRUE on success, FALSE on no memory

Definition at line 744 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, dbus_malloc(), FALSE, DBusRealString::len, NULL, DBusRealString::str, and TRUE.

Referenced by _dbus_server_init_base(), and _dbus_transport_init_base().

dbus_bool_t _dbus_string_copy_data_len const DBusString str,
char **  data_return,
int  start,
int  len
 

Copies a segment of the string into a char*.

Parameters:
str the string
data_return place to return the data
start start index
len length to copy
Returns:
FALSE if no memory

Definition at line 769 of file dbus-string.c.

References _dbus_assert, _dbus_string_copy_len(), _dbus_string_free(), _dbus_string_init(), _dbus_string_steal_data(), DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::max_length, NULL, and TRUE.

dbus_bool_t _dbus_string_copy_len const DBusString source,
int  start,
int  len,
DBusString dest,
int  insert_at
 

Like _dbus_string_copy(), but can copy a segment from the middle of the source string.

Parameters:
source the source string
start where to start copying the source string
len length of segment to copy
dest the destination string
insert_at where to place the copied segment of source string
Returns:
FALSE if not enough memory

Definition at line 1574 of file dbus-string.c.

References _dbus_assert, and DBUS_STRING_COPY_PREAMBLE.

Referenced by _dbus_string_copy_data_len(), _dbus_string_get_dirname(), and dbus_parse_address().

void _dbus_string_copy_to_buffer const DBusString str,
char *  buffer,
int  avail_len
 

Copies the contents of a DBusString into a different buffer.

The resulting buffer will be nul-terminated.

Parameters:
str a string
buffer a C buffer to copy data to
len maximum length of C buffer

Definition at line 813 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, DBusRealString::len, and DBusRealString::str.

void _dbus_string_delete DBusString str,
int  start,
int  len
 

Deletes a segment of a DBusString with length len starting at start.

(Hint: to clear an entire string, setting length to 0 with _dbus_string_set_length() is easier.)

Parameters:
str the DBusString
start where to start deleting
len the number of bytes to delete

Definition at line 1389 of file dbus-string.c.

References _dbus_assert, and DBUS_STRING_PREAMBLE.

Referenced by _dbus_auth_bytes_sent(), _dbus_string_delete_first_word(), and _dbus_string_delete_leading_blanks().

void _dbus_string_delete_first_word DBusString str  ) 
 

Deletes up to and including the first blank space in the string.

Parameters:
str the string

Definition at line 2095 of file dbus-string.c.

References _dbus_string_delete(), _dbus_string_find_blank(), and _dbus_string_skip_blank().

void _dbus_string_delete_leading_blanks DBusString str  ) 
 

Deletes any leading blanks in the string.

Parameters:
str the string

Definition at line 2111 of file dbus-string.c.

References _dbus_string_delete(), and _dbus_string_skip_blank().

dbus_bool_t _dbus_string_ends_with_c_str const DBusString a,
const char *  c_str
 

Returns whether a string ends with the given suffix.

Todo:
memcmp might make this faster.

Parameters:
a the string
c_str the C-style string
Returns:
TRUE if the string ends with the suffix

Definition at line 2344 of file dbus-string.c.

References _dbus_assert, DBUS_GENERIC_STRING_PREAMBLE, FALSE, DBusRealString::len, NULL, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_equal const DBusString a,
const DBusString b
 

Tests two DBusString for equality.

Todo:
memcmp is probably faster
Parameters:
a first string
b second string
Returns:
TRUE if equal

Definition at line 2131 of file dbus-string.c.

References DBUS_GENERIC_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

Referenced by _dbus_keyring_is_for_user(), and dbus_error_has_name().

dbus_bool_t _dbus_string_equal_c_str const DBusString a,
const char *  c_str
 

Checks whether a string is equal to a C string.

Parameters:
a the string
c_str the C string
Returns:
TRUE if equal

Definition at line 2270 of file dbus-string.c.

References _dbus_assert, DBUS_GENERIC_STRING_PREAMBLE, FALSE, DBusRealString::len, NULL, DBusRealString::str, and TRUE.

Referenced by dbus_address_entry_get_value().

dbus_bool_t _dbus_string_equal_len const DBusString a,
const DBusString b,
int  len
 

Tests two DBusString for equality up to the given length.

The strings may be shorter than the given length.

Todo:
write a unit test

memcmp is probably faster

Parameters:
a first string
b second string
len the maximum length to look at
Returns:
TRUE if equal for the given number of bytes

Definition at line 2174 of file dbus-string.c.

References DBUS_GENERIC_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_equal_substring const DBusString a,
int  a_start,
int  a_len,
const DBusString b,
int  b_start
 

Tests two sub-parts of two DBusString for equality.

The specified range of the first string must exist; the specified start position of the second string must exist.

Todo:
write a unit test

memcmp is probably faster

Parameters:
a first string
a_start where to start substring in first string
a_len length of substring in first string
b second string
b_start where to start substring in second string
Returns:
TRUE if the two substrings are equal

Definition at line 2222 of file dbus-string.c.

References _dbus_assert, DBUS_GENERIC_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_find const DBusString str,
int  start,
const char *  substr,
int *  found
 

Finds the given substring in the string, returning TRUE and filling in the byte index where the substring was found, if it was found.

Returns FALSE if the substring wasn't found. Sets *start to the length of the string if the substring is not found.

Parameters:
str the string
start where to start looking
substr the substring
found return location for where it was found, or NULL
Returns:
TRUE if found

Definition at line 1788 of file dbus-string.c.

References _dbus_string_find_to().

Referenced by _dbus_keyring_validate_context(), _dbus_string_pop_line(), and dbus_parse_address().

dbus_bool_t _dbus_string_find_blank const DBusString str,
int  start,
int *  found
 

Finds a blank (space or tab) in the string.

Returns TRUE if found, FALSE otherwise. If a blank is not found sets *found to the length of the string.

Parameters:
str the string
start byte index to start looking
found place to store the location of the first blank
Returns:
TRUE if a blank was found

Definition at line 1920 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

Referenced by _dbus_keyring_validate_context(), and _dbus_string_delete_first_word().

dbus_bool_t _dbus_string_find_byte_backward const DBusString str,
int  start,
unsigned char  byte,
int *  found
 

Find the given byte scanning backward from the given start.

Sets *found to -1 if the byte is not found.

Parameters:
str the string
start the place to start scanning (will not find the byte at this point)
byte the byte to find
found return location for where it was found
Returns:
TRUE if found

Definition at line 1883 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, NULL, and DBusRealString::str.

Referenced by _dbus_string_get_dirname().

dbus_bool_t _dbus_string_find_to const DBusString str,
int  start,
int  end,
const char *  substr,
int *  found
 

Finds the given substring in the string, up to a certain position, returning TRUE and filling in the byte index where the substring was found, if it was found.

Returns FALSE if the substring wasn't found. Sets *start to the length of the string if the substring is not found.

Parameters:
str the string
start where to start looking
end where to stop looking
substr the substring
found return location for where it was found, or NULL
Returns:
TRUE if found

Definition at line 1815 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, NULL, DBusRealString::str, and TRUE.

Referenced by _dbus_string_find(), and dbus_parse_address().

void _dbus_string_free DBusString str  ) 
 

Frees a string created by _dbus_string_init().

Parameters:
str memory where the string is stored.

Definition at line 318 of file dbus-string.c.

References DBusRealString::align_offset, DBusRealString::constant, dbus_free(), DBUS_GENERIC_STRING_PREAMBLE, DBusRealString::invalid, DBusRealString::str, and TRUE.

Referenced by _dbus_auth_unref(), _dbus_become_daemon(), _dbus_keyring_new_homedir(), _dbus_keyring_unref(), _dbus_message_loader_unref(), _dbus_server_new_for_domain_socket(), _dbus_server_new_for_tcp_socket(), _dbus_sha_compute(), _dbus_string_copy_data_len(), _dbus_string_hex_decode(), _dbus_string_hex_encode(), _dbus_string_save_to_file(), _dbus_string_steal_data_len(), _dbus_transport_new_for_domain_socket(), _dbus_transport_new_for_fd(), _dbus_transport_new_for_tcp_socket(), _dbus_transport_open(), _dbus_user_at_console(), dbus_connection_dispatch(), dbus_message_copy(), dbus_message_new_error_printf(), dbus_parse_address(), dbus_server_listen(), and dbus_set_error().

const char* _dbus_string_get_const_data_len const DBusString str,
int  start,
int  len
 

const version of _dbus_string_get_data_len().

Parameters:
str the string
start byte offset to return
len length of segment to return
Returns:
the string data

Definition at line 533 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, and DBusRealString::str.

Referenced by _dbus_demarshal_byte_array(), _dbus_demarshal_object_path(), _dbus_demarshal_string(), _dbus_marshal_validate_type(), _dbus_message_loader_queue_messages(), _dbus_string_parse_double(), _dbus_string_parse_int(), _dbus_verbose_bytes_of_string(), _dbus_write(), _dbus_write_two(), dbus_message_get_auto_activation(), and dbus_message_get_no_reply().

char* _dbus_string_get_data DBusString str  ) 
 

Gets the raw character buffer from the string.

The returned buffer will be nul-terminated, but note that strings may contain binary data so there may be extra nul characters prior to the termination. This function should be little-used, extend DBusString or add stuff to dbus-sysdeps.c instead. It's an error to use this function on a const string.

Parameters:
str the string
Returns:
the data

Definition at line 473 of file dbus-string.c.

References DBUS_STRING_PREAMBLE, and DBusRealString::str.

char* _dbus_string_get_data_len DBusString str,
int  start,
int  len
 

Gets a sub-portion of the raw character buffer from the string.

The "len" field is required simply for error checking, to be sure you don't try to use more string than exists. The nul termination of the returned buffer remains at the end of the entire string, not at start + len.

Parameters:
str the string
start byte offset to return
len length of segment to return
Returns:
the string data

Definition at line 511 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, and DBusRealString::str.

Referenced by _dbus_read(), _dbus_string_append_double(), _dbus_string_append_int(), _dbus_string_append_uint(), dbus_message_set_auto_activation(), and dbus_message_set_no_reply().

void _dbus_string_get_unichar const DBusString str,
int  start,
dbus_unichar_t *  ch_return,
int *  end_return
 

Gets a unicode character from a UTF-8 string.

Does no validation; you must verify that the string is valid UTF-8 in advance and must pass in the start of a character.

Parameters:
str the string
start the start of the UTF-8 character.
ch_return location to return the character
end_return location to return the byte index of next character

Definition at line 1737 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, DBusRealString::len, DBusRealString::str, UTF8_COMPUTE, and UTF8_GET.

dbus_bool_t _dbus_string_hex_decode const DBusString source,
int  start,
int *  end_return,
DBusString dest,
int  insert_at
 

Decodes a string from hex encoding.

Parameters:
source the string to decode
start byte index to start decode
end_return return location of the end of the hex data, or NULL
dest string where decoded data should be placed
insert_at where to place decoded data
Returns:
TRUE if decoding was successful, FALSE if no memory.

Definition at line 2447 of file dbus-string.c.

References _dbus_assert, _dbus_string_append_byte(), _dbus_string_free(), _dbus_string_init(), _dbus_string_move(), _dbus_string_set_byte(), FALSE, and TRUE.

dbus_bool_t _dbus_string_hex_encode const DBusString source,
int  start,
DBusString dest,
int  insert_at
 

Encodes a string in hex, the way MD5 and SHA-1 are usually encoded.

(Each byte is two hex digits.)

Parameters:
source the string to encode
start byte index to start encoding
dest string where encoded data should be placed
insert_at where to place encoded data
Returns:
TRUE if encoding was successful, FALSE if no memory etc.

Definition at line 2388 of file dbus-string.c.

References _dbus_assert, _dbus_string_append_byte(), _dbus_string_free(), _dbus_string_init(), _dbus_string_move(), FALSE, and TRUE.

Referenced by _dbus_keyring_get_hex_key(), and _dbus_sha_compute().

dbus_bool_t _dbus_string_init DBusString str  ) 
 

Initializes a string.

The string starts life with zero length. The string must eventually be freed with _dbus_string_free().

Parameters:
str memory to hold the string
Returns:
TRUE on success, FALSE if no memory

Definition at line 235 of file dbus-string.c.

References _dbus_string_init_preallocated().

Referenced by _dbus_become_daemon(), _dbus_keyring_new_homedir(), _dbus_message_loader_new(), _dbus_server_new_for_domain_socket(), _dbus_server_new_for_tcp_socket(), _dbus_sha_compute(), _dbus_string_copy_data_len(), _dbus_string_hex_decode(), _dbus_string_hex_encode(), _dbus_string_save_to_file(), _dbus_string_steal_data(), _dbus_string_steal_data_len(), _dbus_transport_new_for_domain_socket(), _dbus_transport_new_for_fd(), _dbus_transport_new_for_tcp_socket(), _dbus_user_at_console(), dbus_connection_dispatch(), dbus_message_new_error_printf(), dbus_parse_address(), dbus_server_listen(), and dbus_set_error().

void _dbus_string_init_const DBusString str,
const char *  value
 

Initializes a constant string.

The value parameter is not copied (should be static), and the string may never be modified. It is safe but not necessary to call _dbus_string_free() on a const string. The string has a length limit of MAXINT - 8.

Parameters:
str memory to use for the string
value a string to be stored in str (not copied!!!)

Definition at line 267 of file dbus-string.c.

References _dbus_assert, _dbus_string_init_const_len(), and NULL.

Referenced by _dbus_keyring_new_homedir(), _dbus_transport_open(), dbus_error_has_name(), dbus_parse_address(), and dbus_server_listen().

void _dbus_string_init_const_len DBusString str,
const char *  value,
int  len
 

Initializes a constant string with a length.

The value parameter is not copied (should be static), and the string may never be modified. It is safe but not necessary to call _dbus_string_free() on a const string.

Parameters:
str memory to use for the string
value a string to be stored in str (not copied!!!)
len the length to use

Definition at line 287 of file dbus-string.c.

References _dbus_assert, DBusRealString::allocated, ALLOCATION_PADDING, DBusRealString::constant, FALSE, DBusRealString::invalid, DBusRealString::len, DBusRealString::max_length, MAX_MAX_LENGTH, NULL, DBusRealString::str, and TRUE.

Referenced by _dbus_string_init_const().

dbus_bool_t _dbus_string_init_preallocated DBusString str,
int  allocate_size
 

Initializes a string that can be up to the given allocation size before it has to realloc.

The string starts life with zero length. The string must eventually be freed with _dbus_string_free().

Parameters:
str memory to hold the string
allocate_size amount to preallocate
Returns:
TRUE on success, FALSE if no memory

Definition at line 191 of file dbus-string.c.

References _dbus_assert, DBusRealString::align_offset, DBusRealString::allocated, ALLOCATION_PADDING, DBusRealString::constant, dbus_malloc(), FALSE, DBusRealString::invalid, DBusRealString::len, DBusRealString::locked, DBusRealString::max_length, MAX_MAX_LENGTH, NULL, DBusRealString::str, and TRUE.

Referenced by _dbus_string_init(), and dbus_message_copy().

dbus_bool_t _dbus_string_insert_4_aligned DBusString str,
int  insert_at,
const unsigned char  octets[4]
 

Inserts 4 bytes aligned on a 4 byte boundary with any alignment padding initialized to 0.

Parameters:
str the DBusString
octets 4 bytes to insert
Returns:
FALSE if not enough memory.

Definition at line 1125 of file dbus-string.c.

References DBUS_STRING_PREAMBLE, FALSE, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_insert_8_aligned DBusString str,
int  insert_at,
const unsigned char  octets[8]
 

Inserts 8 bytes aligned on an 8 byte boundary with any alignment padding initialized to 0.

Parameters:
str the DBusString
octets 8 bytes to insert
Returns:
FALSE if not enough memory.

Definition at line 1148 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, FALSE, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_insert_alignment DBusString str,
int *  insert_at,
int  alignment
 

Inserts padding at *insert_at such to align it to the given boundary.

Initializes the padding to nul bytes. Sets *insert_at to the aligned position.

Parameters:
str the DBusString
insert_at location to be aligned
alignment alignment boundary (1, 4, or 8)
Returns:
FALSE if not enough memory.

Definition at line 1176 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, FALSE, and TRUE.

dbus_bool_t _dbus_string_insert_byte DBusString str,
int  i,
unsigned char  byte
 

Inserts a single byte at the given position.

Parameters:
str the string
i the position
byte the value to insert
Returns:
TRUE on success

Definition at line 629 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, FALSE, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_insert_bytes DBusString str,
int  i,
int  n_bytes,
unsigned char  byte
 

Inserts a number of bytes of a given value at the given position.

Parameters:
str the string
i the position
n_bytes number of bytes
byte the value to insert
Returns:
TRUE on success

Definition at line 599 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, FALSE, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_lengthen DBusString str,
int  additional_length
 

Makes a string longer by the given number of bytes.

Checks whether adding additional_length to the current length would overflow an integer, and checks for exceeding a string's max length. The new bytes are not initialized, other than nul-terminating the end of the string. The uninitialized bytes may contain nul bytes or other junk.

Parameters:
str a string
additional_length length to add to the string.
Returns:
TRUE on success.

Definition at line 857 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, FALSE, DBusRealString::len, and DBusRealString::max_length.

Referenced by _dbus_marshal_string_len(), _dbus_read(), _dbus_string_alloc_space(), _dbus_string_append_double(), _dbus_string_append_int(), _dbus_string_append_printf_valist(), and _dbus_string_append_uint().

dbus_bool_t _dbus_string_move DBusString source,
int  start,
DBusString dest,
int  insert_at
 

Moves the end of one string into another string.

Both strings must be initialized, valid strings.

Parameters:
source the source string
start where to chop off the source string
dest the destination string
insert_at where to move the chopped-off part of source string
Returns:
FALSE if not enough memory

Definition at line 1455 of file dbus-string.c.

References _dbus_assert, _dbus_string_move_len(), and DBusRealString::len.

Referenced by _dbus_string_hex_decode(), and _dbus_string_hex_encode().

dbus_bool_t _dbus_string_move_len DBusString source,
int  start,
int  len,
DBusString dest,
int  insert_at
 

Like _dbus_string_move(), but can move a segment from the middle of the source string.

Todo:
this doesn't do anything with max_length field.
we should probably just kill the max_length field though.

Parameters:
source the source string
start first byte of source string to move
len length of segment to move
dest the destination string
insert_at where to move the bytes from the source string
Returns:
FALSE if not enough memory

Definition at line 1507 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_COPY_PREAMBLE, FALSE, and TRUE.

Referenced by _dbus_string_move(), _dbus_string_pop_line(), and _dbus_string_steal_data_len().

dbus_bool_t _dbus_string_parse_double const DBusString str,
int  start,
double *  value_return,
int *  end_return
 

Parses a floating point number contained in a DBusString.

Either return parameter may be NULL if you aren't interested in it. The integer is parsed and stored in value_return. Return parameters are not initialized if the function returns FALSE.

Parameters:
str the string
start the byte index of the start of the float
value_return return location of the float value or NULL
end_return return location of the end of the float, or NULL
Returns:
TRUE on success

Definition at line 1341 of file dbus-sysdeps.c.

References _dbus_string_get_const_data_len(), FALSE, NULL, and TRUE.

dbus_bool_t _dbus_string_parse_int const DBusString str,
int  start,
long *  value_return,
int *  end_return
 

Parses an integer contained in a DBusString.

Either return parameter may be NULL if you aren't interested in it. The integer is parsed and stored in value_return. Return parameters are not initialized if the function returns FALSE.

Parameters:
str the string
start the byte index of the start of the integer
value_return return location of the integer value or NULL
end_return return location of the end of the integer, or NULL
Returns:
TRUE on success

Definition at line 1104 of file dbus-sysdeps.c.

References _dbus_string_get_const_data_len(), FALSE, NULL, and TRUE.

Referenced by _dbus_transport_open(), _dbus_uid_from_string(), and dbus_server_listen().

dbus_bool_t _dbus_string_pop_line DBusString source,
DBusString dest
 

Assigns a newline-terminated or \r\n-terminated line from the front of the string to the given dest string.

The dest string's previous contents are deleted. If the source string contains no newline, moves the entire source string to the dest string.

Todo:
owen correctly notes that this is a stupid function (it was written purely for test code, e.g.
dbus-message-builder.c). Probably should be enforced as test code only with #ifdef DBUS_BUILD_TESTS

Parameters:
source the source string
dest the destination string (contents are replaced)
Returns:
FALSE if no memory, or source has length 0

Definition at line 2037 of file dbus-string.c.

References _dbus_assert, _dbus_string_find(), _dbus_string_move_len(), _dbus_string_set_length(), FALSE, and TRUE.

dbus_bool_t _dbus_string_replace_len const DBusString source,
int  start,
int  len,
DBusString dest,
int  replace_at,
int  replace_len
 

Replaces a segment of dest string with a segment of source string.

Todo:
optimize the case where the two lengths are the same, and avoid memmoving the data in the trailing part of the string twice.

avoid inserting the source into dest, then deleting the replaced chunk of dest (which creates a potentially large intermediate string).

Instead, extend the replaced chunk of dest with padding to the same size as the source chunk, then copy in the source bytes.

Parameters:
source the source string
start where to start copying the source string
len length of segment to copy
dest the destination string
replace_at start of segment of dest string to replace
replace_len length of segment of dest string to replace
Returns:
FALSE if not enough memory

Definition at line 1612 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_COPY_PREAMBLE, FALSE, and TRUE.

Referenced by _dbus_auth_set_context(), and _dbus_marshal_set_string().

void _dbus_string_set_byte DBusString str,
int  i,
unsigned char  byte
 

Sets the value of the byte at the given position.

Parameters:
str the string
i the position
byte the new value

Definition at line 554 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, and DBusRealString::str.

Referenced by _dbus_generate_random_ascii(), and _dbus_string_hex_decode().

dbus_bool_t _dbus_string_set_length DBusString str,
int  length
 

Sets the length of a string.

Can be used to truncate or lengthen the string. If the string is lengthened, the function may fail and return FALSE. Newly-added bytes are not initialized, as with _dbus_string_lengthen().

Parameters:
str a string
length new length of the string.
Returns:
FALSE on failure.

Definition at line 899 of file dbus-string.c.

References _dbus_assert, and DBUS_STRING_PREAMBLE.

Referenced by _dbus_auth_delete_unused_bytes(), _dbus_directory_get_next_file(), _dbus_file_get_contents(), _dbus_generate_random_bytes(), _dbus_keyring_new_homedir(), _dbus_marshal_byte_array(), _dbus_marshal_object_path(), _dbus_marshal_string(), _dbus_marshal_string_array(), _dbus_marshal_string_len(), _dbus_message_loader_new(), _dbus_read(), _dbus_string_pop_line(), dbus_message_iter_append_array(), dbus_message_iter_append_custom(), dbus_message_iter_append_dict(), dbus_message_iter_append_object_path(), dbus_message_iter_append_object_path_array(), dbus_message_iter_append_string(), and dbus_message_iter_append_string_array().

void _dbus_string_shorten DBusString str,
int  length_to_remove
 

Makes a string shorter by the given number of bytes.

Parameters:
str a string
length_to_remove length to remove from the string.

Definition at line 877 of file dbus-string.c.

References _dbus_assert, DBUS_STRING_PREAMBLE, and DBusRealString::len.

Referenced by _dbus_concat_dir_and_file(), _dbus_string_alloc_space(), _dbus_string_append_double(), _dbus_string_append_int(), and _dbus_string_append_uint().

void _dbus_string_skip_blank const DBusString str,
int  start,
int *  end
 

Skips blanks from start, storing the first non-blank in *end (blank is space or tab).

Parameters:
str the string
start where to start
end where to store the first non-blank byte index

Definition at line 1958 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, DBusRealString::len, and DBusRealString::str.

Referenced by _dbus_string_delete_first_word(), and _dbus_string_delete_leading_blanks().

void _dbus_string_skip_white const DBusString str,
int  start,
int *  end
 

Skips whitespace from start, storing the first non-whitespace in *end.

(whitespace is space, tab, newline, CR).

Parameters:
str the string
start where to start
end where to store the first non-whitespace byte index

Definition at line 1993 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, DBusRealString::len, and DBusRealString::str.

dbus_bool_t _dbus_string_starts_with_c_str const DBusString a,
const char *  c_str
 

Checks whether a string starts with the given C string.

Parameters:
a the string
c_str the C string
Returns:
TRUE if string starts with it

Definition at line 2306 of file dbus-string.c.

References _dbus_assert, DBUS_GENERIC_STRING_PREAMBLE, FALSE, DBusRealString::len, NULL, DBusRealString::str, and TRUE.

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.

The caller must free the data returned. This function may fail due to lack of memory, and return FALSE.

Parameters:
str the string
data_return location to return the buffer
Returns:
TRUE on success

Definition at line 656 of file dbus-string.c.

References _dbus_assert, _dbus_string_init(), DBUS_STRING_PREAMBLE, FALSE, DBusRealString::max_length, NULL, DBusRealString::str, and TRUE.

Referenced by _dbus_string_copy_data_len(), _dbus_string_steal_data_len(), and dbus_set_error().

dbus_bool_t _dbus_string_steal_data_len DBusString str,
char **  data_return,
int  start,
int  len
 

Like _dbus_string_get_data_len(), but removes the gotten data from the original string.

The caller must free the data returned. This function may fail due to lack of memory, and return FALSE. The returned string is nul-terminated and has length len.

Todo:
this function is broken because on failure it may corrupt the source string.

Parameters:
str the string
data_return location to return the buffer
start the start of segment to steal
len the length of segment to steal
Returns:
TRUE on success

Definition at line 700 of file dbus-string.c.

References _dbus_assert, _dbus_string_free(), _dbus_string_init(), _dbus_string_move_len(), _dbus_string_steal_data(), _dbus_warn(), DBUS_STRING_PREAMBLE, FALSE, DBusRealString::max_length, NULL, and TRUE.

dbus_bool_t _dbus_string_validate_ascii const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is valid ASCII with no nul bytes.

If the given range is not entirely contained in the string, returns FALSE.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is all valid ASCII

Definition at line 2588 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

Referenced by _dbus_generate_random_ascii(), and _dbus_keyring_validate_context().

dbus_bool_t _dbus_string_validate_error_name const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is a valid error name in the D-BUS protocol.

This includes a length restriction, etc., see the specification.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is a valid name

Definition at line 2995 of file dbus-string.c.

References _dbus_string_validate_interface().

dbus_bool_t _dbus_string_validate_interface const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is a valid interface name in the D-BUS protocol.

This includes a length restriction and an ASCII subset, see the specification.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is a valid name

Definition at line 2856 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, NULL, DBusRealString::str, TRUE, VALID_INITIAL_NAME_CHARACTER, and VALID_NAME_CHARACTER.

Referenced by _dbus_string_validate_error_name(), and _dbus_string_validate_service().

dbus_bool_t _dbus_string_validate_member const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is a valid member name in the D-BUS protocol.

This includes a length restriction, etc., see the specification.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is a valid name

Definition at line 2933 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, TRUE, VALID_INITIAL_NAME_CHARACTER, and VALID_NAME_CHARACTER.

dbus_bool_t _dbus_string_validate_nul const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is all nul bytes.

If the given range is not entirely contained in the string, returns FALSE.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is all nul bytes

Definition at line 2729 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

Referenced by _dbus_marshal_validate_arg().

dbus_bool_t _dbus_string_validate_path const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is a valid object path name in the D-BUS protocol.

This includes a length restriction, etc., see the specification. It does not validate UTF-8, that has to be done separately for now.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

change spec to disallow more things, such as spaces in the path name

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is a valid name

Definition at line 2773 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

Referenced by _dbus_marshal_validate_arg().

dbus_bool_t _dbus_string_validate_service const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is a valid service name in the D-BUS protocol.

This includes a length restriction, etc., see the specification.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is a valid name

Definition at line 3066 of file dbus-string.c.

References _dbus_string_validate_interface(), and FALSE.

dbus_bool_t _dbus_string_validate_signature const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is a valid message type signature in the D-BUS protocol.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is a valid signature

Definition at line 3091 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, and TRUE.

dbus_bool_t _dbus_string_validate_utf8 const DBusString str,
int  start,
int  len
 

Checks that the given range of the string is valid UTF-8.

If the given range is not entirely contained in the string, returns FALSE. If the string contains any nul bytes in the given range, returns FALSE. If the start and start+len are not on character boundaries, returns FALSE.

Todo:
this is inconsistent with most of DBusString in that it allows a start,len range that extends past the string end.

Parameters:
str the string
start first byte index to check
len number of bytes to check
Returns:
TRUE if the byte range exists and is all valid UTF-8

Definition at line 2631 of file dbus-string.c.

References _dbus_assert, DBUS_CONST_STRING_PREAMBLE, FALSE, DBusRealString::len, DBusRealString::str, TRUE, UNICODE_VALID, UTF8_COMPUTE, UTF8_GET, and UTF8_LENGTH.

void _dbus_string_zero DBusString str  ) 
 

Clears all allocated bytes in the string to zero.

Parameters:
str the string

Definition at line 3142 of file dbus-string.c.

References DBusRealString::align_offset, DBusRealString::allocated, DBUS_STRING_PREAMBLE, and DBusRealString::str.


Generated on Tue Dec 20 14:16:45 2005 for D-BUS by  doxygen 1.4.2