D-Bus  1.8.1
Data Structures | Macros | Functions

DBusList data structure. More...

Data Structures

struct  DBusList
 A node in a linked list. More...
 

Macros

#define _dbus_list_get_next_link(list, link)   ((link)->next == *(list) ? NULL : (link)->next)
 Gets the next link in the list, or NULL if there are no more links. More...
 
#define _dbus_list_get_prev_link(list, link)   ((link) == *(list) ? NULL : (link)->prev)
 Gets the previous link in the list, or NULL if there are no more links. More...
 

Functions

DBusList_dbus_list_alloc_link (void *data)
 Allocates a linked list node. More...
 
void _dbus_list_free_link (DBusList *link)
 Frees a linked list node allocated with _dbus_list_alloc_link. More...
 
dbus_bool_t _dbus_list_append (DBusList **list, void *data)
 Appends a value to the list. More...
 
dbus_bool_t _dbus_list_prepend (DBusList **list, void *data)
 Prepends a value to the list. More...
 
void _dbus_list_append_link (DBusList **list, DBusList *link)
 Appends a link to the list. More...
 
void _dbus_list_prepend_link (DBusList **list, DBusList *link)
 Prepends a link to the list. More...
 
dbus_bool_t _dbus_list_insert_after (DBusList **list, DBusList *after_this_link, void *data)
 Inserts data into the list after the given existing link. More...
 
void _dbus_list_insert_before_link (DBusList **list, DBusList *before_this_link, DBusList *link)
 Inserts a link into the list before the given existing link. More...
 
void _dbus_list_insert_after_link (DBusList **list, DBusList *after_this_link, DBusList *link)
 Inserts a link into the list after the given existing link. More...
 
dbus_bool_t _dbus_list_remove (DBusList **list, void *data)
 Removes a value from the list. More...
 
dbus_bool_t _dbus_list_remove_last (DBusList **list, void *data)
 Removes a value from the list. More...
 
DBusList_dbus_list_find_last (DBusList **list, void *data)
 Finds a value in the list. More...
 
void _dbus_list_unlink (DBusList **list, DBusList *link)
 Removes the given link from the list, but doesn't free it. More...
 
void _dbus_list_remove_link (DBusList **list, DBusList *link)
 Removes a link from the list. More...
 
void _dbus_list_clear (DBusList **list)
 Frees all links in the list and sets the list head to NULL. More...
 
DBusList_dbus_list_get_first_link (DBusList **list)
 Gets the first link in the list. More...
 
DBusList_dbus_list_get_last_link (DBusList **list)
 Gets the last link in the list. More...
 
void * _dbus_list_get_last (DBusList **list)
 Gets the last data in the list. More...
 
void * _dbus_list_get_first (DBusList **list)
 Gets the first data in the list. More...
 
DBusList_dbus_list_pop_first_link (DBusList **list)
 Removes the first link in the list and returns it. More...
 
void * _dbus_list_pop_first (DBusList **list)
 Removes the first value in the list and returns it. More...
 
void * _dbus_list_pop_last (DBusList **list)
 Removes the last value in the list and returns it. More...
 
dbus_bool_t _dbus_list_copy (DBusList **list, DBusList **dest)
 Copies a list. More...
 
int _dbus_list_get_length (DBusList **list)
 Gets the length of a list. More...
 
void _dbus_list_foreach (DBusList **list, DBusForeachFunction function, void *data)
 Calls the given function for each element in the list. More...
 
dbus_bool_t _dbus_list_length_is_one (DBusList **list)
 Check whether length is exactly one. More...
 

Detailed Description

DBusList data structure.

Types and functions related to DBusList.

Macro Definition Documentation

#define _dbus_list_get_next_link (   list,
  link 
)    ((link)->next == *(list) ? NULL : (link)->next)

Gets the next link in the list, or NULL if there are no more links.

Used for iteration.

DBusList *link;
while (link != NULL)
{
printf ("value is %p\n", link->data);
link = _dbus_list_get_next_link (&link);
}
Parameters
listaddress of the list head.
linkcurrent link.
Returns
the next link, or NULL if none.

Definition at line 90 of file dbus-list.h.

Referenced by _dbus_list_clear(), _dbus_list_copy(), _dbus_list_foreach(), _dbus_list_get_length(), _dbus_list_remove(), _dbus_object_tree_dispatch_and_unlock(), _dbus_timeout_list_set_functions(), _dbus_watch_list_set_functions(), dbus_address_entry_get_value(), dbus_connection_dispatch(), and dbus_parse_address().

#define _dbus_list_get_prev_link (   list,
  link 
)    ((link) == *(list) ? NULL : (link)->prev)

Gets the previous link in the list, or NULL if there are no more links.

Used for iteration.

DBusList *link;
link = _dbus_list_get_last_link (&list);
while (link != NULL)
{
printf ("value is %p\n", link->data);
link = _dbus_list_get_prev_link (&link);
}
Parameters
listaddress of the list head.
linkcurrent link.
Returns
the previous link, or NULL if none.

Definition at line 91 of file dbus-list.h.

Referenced by _dbus_list_find_last(), and dbus_connection_remove_filter().

Function Documentation

DBusList* _dbus_list_alloc_link ( void *  data)

Allocates a linked list node.

Useful for preallocating nodes and using _dbus_list_append_link() to avoid allocations.

Parameters
datathe value to store in the link.
Returns
a newly allocated link.

Definition at line 242 of file dbus-list.c.

Referenced by _dbus_connection_new_for_transport(), _dbus_message_add_counter(), _dbus_pending_call_set_timeout_error_unlocked(), and dbus_connection_dispatch().

dbus_bool_t _dbus_list_append ( DBusList **  list,
void *  data 
)

Appends a value to the list.

May return FALSE if insufficient memory exists to add a list link. This is a constant-time operation.

Parameters
listaddress of the list head.
datathe value to append.
Returns
TRUE on success.

Definition at line 270 of file dbus-list.c.

References _dbus_list_prepend(), FALSE, next, and TRUE.

Referenced by _dbus_list_copy(), _dbus_object_tree_dispatch_and_unlock(), _dbus_split_paths_and_append(), _dbus_timeout_list_add_timeout(), _dbus_validate_signature_with_reason(), _dbus_watch_list_add_watch(), dbus_connection_add_filter(), and dbus_parse_address().

void _dbus_list_append_link ( DBusList **  list,
DBusList link 
)

Appends a link to the list.

Cannot fail due to out of memory. This is a constant-time operation.

Parameters
listaddress of the list head.
linkthe link to append.

Definition at line 315 of file dbus-list.c.

References _dbus_list_prepend_link(), and next.

Referenced by _dbus_connection_queue_received_message_link(), _dbus_connection_queue_synthesized_message_link(), _dbus_list_insert_before_link(), and _dbus_message_add_counter_link().

void _dbus_list_clear ( DBusList **  list)

Frees all links in the list and sets the list head to NULL.

Does not free the data in each link, for obvious reasons. This is a linear-time operation.

Parameters
listaddress of the list head.

Definition at line 542 of file dbus-list.c.

References _dbus_list_get_next_link, and NULL.

Referenced by _dbus_auth_unref(), _dbus_list_copy(), _dbus_message_loader_unref(), _dbus_pending_call_set_reply_unlocked(), _dbus_split_paths_and_append(), _dbus_timeout_list_free(), _dbus_validate_signature_with_reason(), _dbus_watch_list_free(), dbus_connection_dispatch(), and dbus_parse_address().

dbus_bool_t _dbus_list_copy ( DBusList **  list,
DBusList **  dest 
)

Copies a list.

This is a linear-time operation. If there isn't enough memory to copy the entire list, the destination list will be set to NULL.

Parameters
listaddress of the head of the list to copy.
destaddress where the copied list should be placed.
Returns
TRUE on success, FALSE if not enough memory.

Definition at line 697 of file dbus-list.c.

References _dbus_assert, _dbus_list_append(), _dbus_list_clear(), _dbus_list_get_next_link, data, FALSE, NULL, and TRUE.

Referenced by dbus_connection_dispatch().

DBusList* _dbus_list_find_last ( DBusList **  list,
void *  data 
)

Finds a value in the list.

Returns the last link with value equal to the given data pointer. This is a linear-time operation. Returns NULL if no value found that matches.

Parameters
listaddress of the list head.
datathe value to find.
Returns
the link if found

Definition at line 472 of file dbus-list.c.

References _dbus_list_get_last_link(), _dbus_list_get_prev_link, data, and NULL.

Referenced by _dbus_list_remove_last(), _dbus_message_loader_queue_messages(), and _dbus_message_remove_counter().

void _dbus_list_foreach ( DBusList **  list,
DBusForeachFunction  function,
void *  data 
)

Calls the given function for each element in the list.

The function is passed the list element as its first argument, and the given data as its second argument.

Parameters
listaddress of the head of the list.
functionfunction to call for each element.
dataextra data for the function.

Definition at line 759 of file dbus-list.c.

References _dbus_list_get_next_link, data, and NULL.

Referenced by _dbus_message_loader_unref(), _dbus_split_paths_and_append(), _dbus_timeout_list_free(), _dbus_timeout_list_set_functions(), _dbus_watch_list_free(), _dbus_watch_list_set_functions(), and dbus_connection_dispatch().

void _dbus_list_free_link ( DBusList link)

Frees a linked list node allocated with _dbus_list_alloc_link.

Does not free the data in the node.

Parameters
linkthe list node

Definition at line 254 of file dbus-list.c.

Referenced by _dbus_connection_new_for_transport(), _dbus_connection_unlock(), dbus_connection_dispatch(), and dbus_connection_free_preallocated_send().

void* _dbus_list_get_first ( DBusList **  list)

Gets the first data in the list.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the first data in the list, or NULL for an empty list.

Definition at line 612 of file dbus-list.c.

References NULL.

Referenced by dbus_connection_borrow_message().

DBusList* _dbus_list_get_first_link ( DBusList **  list)

Gets the first link in the list.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the first link, or NULL for an empty list.

Definition at line 567 of file dbus-list.c.

Referenced by _dbus_list_pop_first(), _dbus_list_pop_first_link(), _dbus_object_tree_dispatch_and_unlock(), _dbus_timeout_list_set_functions(), _dbus_watch_list_set_functions(), dbus_address_entry_get_value(), dbus_connection_dispatch(), and dbus_parse_address().

void* _dbus_list_get_last ( DBusList **  list)

Gets the last data in the list.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the last data in the list, or NULL for an empty list.

Definition at line 596 of file dbus-list.c.

References NULL.

Referenced by _dbus_connection_get_message_to_send().

DBusList* _dbus_list_get_last_link ( DBusList **  list)

Gets the last link in the list.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the last link, or NULL for an empty list.

Definition at line 580 of file dbus-list.c.

References NULL.

Referenced by _dbus_connection_message_sent_unlocked(), _dbus_list_find_last(), _dbus_list_pop_last(), and dbus_connection_remove_filter().

int _dbus_list_get_length ( DBusList **  list)

Gets the length of a list.

This is a linear-time operation.

Parameters
listaddress of the head of the list
Returns
number of elements in the list.

Definition at line 730 of file dbus-list.c.

References _dbus_list_get_next_link, and NULL.

Referenced by _dbus_object_tree_dispatch_and_unlock(), and dbus_parse_address().

dbus_bool_t _dbus_list_insert_after ( DBusList **  list,
DBusList after_this_link,
void *  data 
)

Inserts data into the list after the given existing link.

Parameters
listthe list to modify
after_this_linkexisting link to insert after, or NULL to prepend
datathe value to insert
Returns
TRUE on success, FALSE if memory allocation fails

Definition at line 348 of file dbus-list.c.

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

void _dbus_list_insert_after_link ( DBusList **  list,
DBusList after_this_link,
DBusList link 
)

Inserts a link into the list after the given existing link.

Parameters
listthe list to modify
after_this_linkexisting link to insert after, or NULL to prepend
linkthe link to insert

Definition at line 394 of file dbus-list.c.

References _dbus_list_prepend_link(), and NULL.

void _dbus_list_insert_before_link ( DBusList **  list,
DBusList before_this_link,
DBusList link 
)

Inserts a link into the list before the given existing link.

Parameters
listthe list to modify
before_this_linkexisting link to insert before, or NULL to append
linkthe link to insert

Definition at line 376 of file dbus-list.c.

References _dbus_list_append_link(), and NULL.

dbus_bool_t _dbus_list_length_is_one ( DBusList **  list)

Check whether length is exactly one.

Parameters
listthe list
Returns
TRUE if length is exactly one

Definition at line 783 of file dbus-list.c.

References NULL.

void* _dbus_list_pop_first ( DBusList **  list)

Removes the first value in the list and returns it.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the first data in the list, or NULL for an empty list.

Definition at line 649 of file dbus-list.c.

References _dbus_list_get_first_link(), _dbus_list_remove_link(), data, and NULL.

Referenced by _dbus_message_loader_pop_message(), and dbus_connection_steal_borrowed_message().

DBusList* _dbus_list_pop_first_link ( DBusList **  list)

Removes the first link in the list and returns it.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the first link in the list, or NULL for an empty list.

Definition at line 628 of file dbus-list.c.

References _dbus_list_get_first_link(), _dbus_list_unlink(), and NULL.

Referenced by _dbus_connection_unlock(), and _dbus_message_loader_pop_message_link().

void* _dbus_list_pop_last ( DBusList **  list)

Removes the last value in the list and returns it.

This is a constant-time operation.

Parameters
listaddress of the list head.
Returns
the last data in the list, or NULL for an empty list.

Definition at line 672 of file dbus-list.c.

References _dbus_list_get_last_link(), _dbus_list_remove_link(), data, and NULL.

Referenced by _dbus_validate_signature_with_reason().

dbus_bool_t _dbus_list_prepend ( DBusList **  list,
void *  data 
)

Prepends a value to the list.

May return FALSE if insufficient memory exists to add a list link. This is a constant-time operation.

Parameters
listaddress of the list head.
datathe value to prepend.
Returns
TRUE on success.

Definition at line 292 of file dbus-list.c.

References FALSE, NULL, and TRUE.

Referenced by _dbus_list_append(), and _dbus_list_insert_after().

void _dbus_list_prepend_link ( DBusList **  list,
DBusList link 
)

Prepends a link to the list.

Cannot fail due to out of memory. This is a constant-time operation.

Parameters
listaddress of the list head.
linkthe link to prepend.

Definition at line 333 of file dbus-list.c.

Referenced by _dbus_connection_message_sent_unlocked(), _dbus_list_append_link(), _dbus_list_insert_after_link(), _dbus_message_loader_putback_message_link(), and dbus_connection_dispatch().

dbus_bool_t _dbus_list_remove ( DBusList **  list,
void *  data 
)

Removes a value from the list.

Only removes the first value equal to the given data pointer, even if multiple values exist which match. This is a linear-time operation.

Parameters
listaddress of the list head.
datathe value to remove.
Returns
TRUE if a value was found to remove.

Definition at line 415 of file dbus-list.c.

References _dbus_list_get_next_link, _dbus_list_remove_link(), data, FALSE, NULL, and TRUE.

Referenced by _dbus_timeout_list_remove_timeout(), and _dbus_watch_list_remove_watch().

dbus_bool_t _dbus_list_remove_last ( DBusList **  list,
void *  data 
)

Removes a value from the list.

Only removes the last value equal to the given data pointer, even if multiple values exist which match. This is a linear-time operation.

Parameters
listaddress of the list head.
datathe value to remove.
Returns
TRUE if a value was found to remove.

Definition at line 446 of file dbus-list.c.

References _dbus_list_find_last(), _dbus_list_remove_link(), FALSE, and TRUE.

Referenced by _dbus_timeout_list_add_timeout(), and _dbus_watch_list_add_watch().

void _dbus_list_remove_link ( DBusList **  list,
DBusList link 
)

Removes a link from the list.

This is a constant-time operation.

Parameters
listaddress of the list head.
linkthe list link to remove.

Definition at line 527 of file dbus-list.c.

References _dbus_list_unlink().

Referenced by _dbus_list_pop_first(), _dbus_list_pop_last(), _dbus_list_remove(), _dbus_list_remove_last(), _dbus_message_remove_counter(), _dbus_object_tree_dispatch_and_unlock(), and dbus_connection_remove_filter().

void _dbus_list_unlink ( DBusList **  list,
DBusList link 
)

Removes the given link from the list, but doesn't free it.

_dbus_list_remove_link() both removes the link and also frees it.

Parameters
listthe list
linkthe link in the list

Definition at line 499 of file dbus-list.c.

References next, NULL, and prev.

Referenced by _dbus_connection_message_sent_unlocked(), _dbus_list_pop_first_link(), and _dbus_list_remove_link().