libplist
1.8
|
Typedefs | |
typedef void * | plist_t |
The basic plist abstract data type. | |
typedef void * | plist_dict_iter |
The plist dictionary iterator. |
Enumerations | |
enum | plist_type { PLIST_BOOLEAN, PLIST_UINT, PLIST_REAL, PLIST_STRING, PLIST_ARRAY, PLIST_DICT, PLIST_DATE, PLIST_DATA, PLIST_KEY, PLIST_NONE } |
The enumeration of plist node types. More... |
Functions | |
PLIST_API plist_t | plist_new_dict (void) |
Create a new root plist_t type PLIST_DICT. | |
PLIST_API plist_t | plist_new_array (void) |
Create a new root plist_t type PLIST_ARRAY. | |
PLIST_API plist_t | plist_new_string (const char *val) |
Create a new plist_t type PLIST_STRING. | |
PLIST_API plist_t | plist_new_bool (uint8_t val) |
Create a new plist_t type PLIST_BOOLEAN. | |
PLIST_API plist_t | plist_new_uint (uint64_t val) |
Create a new plist_t type PLIST_UINT. | |
PLIST_API plist_t | plist_new_real (double val) |
Create a new plist_t type PLIST_REAL. | |
PLIST_API plist_t | plist_new_data (const char *val, uint64_t length) |
Create a new plist_t type PLIST_DATA. | |
PLIST_API plist_t | plist_new_date (int32_t sec, int32_t usec) |
Create a new plist_t type PLIST_DATE. | |
PLIST_API void | plist_free (plist_t plist) |
Destruct a plist_t node and all its children recursively. | |
PLIST_API plist_t | plist_copy (plist_t node) |
Return a copy of passed node and it's children. | |
PLIST_API uint32_t | plist_array_get_size (plist_t node) |
Get size of a PLIST_ARRAY node. | |
PLIST_API plist_t | plist_array_get_item (plist_t node, uint32_t n) |
Get the nth item in a PLIST_ARRAY node. | |
PLIST_API uint32_t | plist_array_get_item_index (plist_t node) |
Get the index of an item. | |
PLIST_API void | plist_array_set_item (plist_t node, plist_t item, uint32_t n) |
Set the nth item in a PLIST_ARRAY node. | |
PLIST_API void | plist_array_append_item (plist_t node, plist_t item) |
Append a new item at the end of a PLIST_ARRAY node. | |
PLIST_API void | plist_array_insert_item (plist_t node, plist_t item, uint32_t n) |
Insert a new item at position n in a PLIST_ARRAY node. | |
PLIST_API void | plist_array_remove_item (plist_t node, uint32_t n) |
Remove an existing position in a PLIST_ARRAY node. | |
PLIST_API uint32_t | plist_dict_get_size (plist_t node) |
Get size of a PLIST_DICT node. | |
PLIST_API void | plist_dict_new_iter (plist_t node, plist_dict_iter *iter) |
Create iterator of a PLIST_DICT node. | |
PLIST_API void | plist_dict_next_item (plist_t node, plist_dict_iter iter, char **key, plist_t *val) |
Increment iterator of a PLIST_DICT node. | |
PLIST_API void | plist_dict_get_item_key (plist_t node, char **key) |
Get key associated to an item. | |
PLIST_API plist_t | plist_dict_get_item (plist_t node, const char *key) |
Get the nth item in a PLIST_DICT node. | |
PLIST_API void | plist_dict_set_item (plist_t node, const char *key, plist_t item) |
Set item identified by key in a PLIST_DICT node. | |
PLIST_API void | plist_dict_insert_item (plist_t node, const char *key, plist_t item) |
Insert a new item at position n in a PLIST_DICT node. | |
PLIST_API void | plist_dict_remove_item (plist_t node, const char *key) |
Remove an existing position in a PLIST_DICT node. | |
PLIST_API plist_t | plist_get_parent (plist_t node) |
Get the parent of a node. | |
PLIST_API plist_type | plist_get_node_type (plist_t node) |
Get the plist_type of a node. | |
PLIST_API void | plist_get_key_val (plist_t node, char **val) |
Get the value of a PLIST_KEY node. | |
PLIST_API void | plist_get_string_val (plist_t node, char **val) |
Get the value of a PLIST_STRING node. | |
PLIST_API void | plist_get_bool_val (plist_t node, uint8_t *val) |
Get the value of a PLIST_BOOLEAN node. | |
PLIST_API void | plist_get_uint_val (plist_t node, uint64_t *val) |
Get the value of a PLIST_UINT node. | |
PLIST_API void | plist_get_real_val (plist_t node, double *val) |
Get the value of a PLIST_REAL node. | |
PLIST_API void | plist_get_data_val (plist_t node, char **val, uint64_t *length) |
Get the value of a PLIST_DATA node. | |
PLIST_API void | plist_get_date_val (plist_t node, int32_t *sec, int32_t *usec) |
Get the value of a PLIST_DATE node. | |
PLIST_API void | plist_set_type (plist_t node, plist_type type) |
Forces type of node. | |
PLIST_API void | plist_set_key_val (plist_t node, const char *val) |
Set the value of a node. | |
PLIST_API void | plist_set_string_val (plist_t node, const char *val) |
Set the value of a node. | |
PLIST_API void | plist_set_bool_val (plist_t node, uint8_t val) |
Set the value of a node. | |
PLIST_API void | plist_set_uint_val (plist_t node, uint64_t val) |
Set the value of a node. | |
PLIST_API void | plist_set_real_val (plist_t node, double val) |
Set the value of a node. | |
PLIST_API void | plist_set_data_val (plist_t node, const char *val, uint64_t length) |
Set the value of a node. | |
PLIST_API void | plist_set_date_val (plist_t node, int32_t sec, int32_t usec) |
Set the value of a node. | |
PLIST_API void | plist_to_xml (plist_t plist, char **plist_xml, uint32_t *length) |
Export the plist_t structure to XML format. | |
PLIST_API void | plist_to_bin (plist_t plist, char **plist_bin, uint32_t *length) |
Export the plist_t structure to binary format. | |
PLIST_API void | plist_from_xml (const char *plist_xml, uint32_t length, plist_t *plist) |
Import the plist_t structure from XML format. | |
PLIST_API void | plist_from_bin (const char *plist_bin, uint32_t length, plist_t *plist) |
Import the plist_t structure from binary format. | |
PLIST_API plist_t | plist_access_path (plist_t plist, uint32_t length,...) |
Get a node from its path. | |
PLIST_API plist_t | plist_access_pathv (plist_t plist, uint32_t length, va_list v) |
Variadic version of plist_access_path. | |
PLIST_API char | plist_compare_node_value (plist_t node_l, plist_t node_r) |
Compare two node values. |
enum plist_type |
The enumeration of plist node types.
Get a node from its path.
Each path element depends on the associated father node type. For Dictionaries, var args are casted to const char*, for arrays, var args are caster to uint32_t Search is breath first order.
plist | the node to access result from. |
length | length of the path to access |
References plist_access_pathv().
Variadic version of plist_access_path.
plist | the node to access result from. |
length | length of the path to access |
v | list of array's index and dic'st key |
References PLIST_ARRAY, plist_array_get_item(), PLIST_DICT, plist_dict_get_item(), plist_get_node_type(), and PLIST_NONE.
Referenced by plist_access_path().
Append a new item at the end of a PLIST_ARRAY node.
node | the node of type PLIST_ARRAY |
item | the new item |
References PLIST_ARRAY, and plist_get_node_type().
Get the nth item in a PLIST_ARRAY node.
node | the node of type PLIST_ARRAY |
n | the index of the item to get. Range is [0, array_size[ |
References PLIST_ARRAY, and plist_get_node_type().
Referenced by plist_access_pathv(), plist_array_remove_item(), and plist_array_set_item().
PLIST_API uint32_t plist_array_get_item_index | ( | plist_t | node | ) |
Get the index of an item.
item must be a member of a PLIST_ARRAY node.
node | the node |
References PLIST_ARRAY, plist_get_node_type(), and plist_get_parent().
PLIST_API uint32_t plist_array_get_size | ( | plist_t | node | ) |
Get size of a PLIST_ARRAY node.
node | the node of type PLIST_ARRAY |
References PLIST_ARRAY, and plist_get_node_type().
Insert a new item at position n in a PLIST_ARRAY node.
node | the node of type PLIST_ARRAY |
item | the new item to insert |
n | The position at which the node will be stored. Range is [0, array_size[. Assert if n is not in range. |
References PLIST_ARRAY, and plist_get_node_type().
PLIST_API void plist_array_remove_item | ( | plist_t | node, |
uint32_t | n | ||
) |
Remove an existing position in a PLIST_ARRAY node.
Removed position will be freed using plist_free
node | the node of type PLIST_ARRAY |
n | The position to remove. Range is [0, array_size[. Assert if n is not in range. |
References PLIST_ARRAY, plist_array_get_item(), plist_free(), and plist_get_node_type().
Set the nth item in a PLIST_ARRAY node.
The previous item at index n will be freed using plist_free
node | the node of type PLIST_ARRAY |
item | the new item at index n |
n | the index of the item to get. Range is [0, array_size[. Assert if n is not in range. |
References PLIST_ARRAY, plist_array_get_item(), and plist_get_node_type().
Compare two node values.
node_l | left node to compare |
node_r | rigth node to compare |
Return a copy of passed node and it's children.
node | the plist to copy |
Get the nth item in a PLIST_DICT node.
node | the node of type PLIST_DICT |
key | the identifier of the item to get. |
References PLIST_DICT, plist_get_node_type(), and PLIST_KEY.
Referenced by plist_access_pathv(), plist_dict_remove_item(), and plist_dict_set_item().
PLIST_API void plist_dict_get_item_key | ( | plist_t | node, |
char ** | key | ||
) |
Get key associated to an item.
Item must be member of a dictionary
node | the node |
key | a location to store the key. |
References PLIST_DICT, plist_get_key_val(), plist_get_node_type(), and plist_get_parent().
PLIST_API uint32_t plist_dict_get_size | ( | plist_t | node | ) |
Get size of a PLIST_DICT node.
node | the node of type PLIST_DICT |
References PLIST_DICT, and plist_get_node_type().
Insert a new item at position n in a PLIST_DICT node.
node | the node of type PLIST_DICT |
item | the new item to insert |
key | The identifier of the item to insert. Assert if identifier already present. |
References PLIST_DICT, and plist_get_node_type().
PLIST_API void plist_dict_new_iter | ( | plist_t | node, |
plist_dict_iter * | iter | ||
) |
Create iterator of a PLIST_DICT node.
The allocated iterator shoult be freed with tandard free function
node | the node of type PLIST_DICT |
iter | iterator of the PLIST_DICT node |
PLIST_API void plist_dict_next_item | ( | plist_t | node, |
plist_dict_iter | iter, | ||
char ** | key, | ||
plist_t * | val | ||
) |
Increment iterator of a PLIST_DICT node.
node | the node of type PLIST_DICT |
iter | iterator of the dictionary |
key | a location to store the key, or NULL. |
val | a location to store the value, or NULL. |
References PLIST_DICT, plist_get_key_val(), and plist_get_node_type().
PLIST_API void plist_dict_remove_item | ( | plist_t | node, |
const char * | key | ||
) |
Remove an existing position in a PLIST_DICT node.
Removed position will be freed using plist_free
node | the node of type PLIST_DICT |
key | The identifier of the item to remove. Assert if identifier is not present. |
References PLIST_DICT, plist_dict_get_item(), plist_free(), and plist_get_node_type().
Set item identified by key in a PLIST_DICT node.
The previous item at index n will be freed using plist_free
node | the node of type PLIST_DICT |
item | the new item associated to key |
key | the identifier of the item to get. Assert if identifier is not present. |
References PLIST_DICT, plist_dict_get_item(), and plist_get_node_type().
PLIST_API void plist_free | ( | plist_t | plist | ) |
Destruct a plist_t node and all its children recursively.
plist | the plist to free |
Referenced by plist_array_remove_item(), and plist_dict_remove_item().
PLIST_API void plist_from_bin | ( | const char * | plist_bin, |
uint32_t | length, | ||
plist_t * | plist | ||
) |
Import the plist_t structure from binary format.
plist_bin | a pointer to the xml buffer. |
length | length of the buffer to read. |
plist | a pointer to the imported plist. |
References PLIST_ARRAY, PLIST_DICT, and PLIST_KEY.
PLIST_API void plist_from_xml | ( | const char * | plist_xml, |
uint32_t | length, | ||
plist_t * | plist | ||
) |
Import the plist_t structure from XML format.
plist_xml | a pointer to the xml buffer. |
length | length of the buffer to read. |
plist | a pointer to the imported plist. |
PLIST_API void plist_get_bool_val | ( | plist_t | node, |
uint8_t * | val | ||
) |
Get the value of a PLIST_BOOLEAN node.
This function does nothing if node is not of type PLIST_BOOLEAN
node | the node |
val | a pointer to a uint8_t variable. |
References PLIST_BOOLEAN, and plist_get_node_type().
PLIST_API void plist_get_data_val | ( | plist_t | node, |
char ** | val, | ||
uint64_t * | length | ||
) |
Get the value of a PLIST_DATA node.
This function does nothing if node is not of type PLIST_DATA
node | the node |
val | a pointer to an unallocated char buffer. This function allocates the memory, caller is responsible for freeing it. |
length | the length of the buffer |
References PLIST_DATA, and plist_get_node_type().
PLIST_API void plist_get_date_val | ( | plist_t | node, |
int32_t * | sec, | ||
int32_t * | usec | ||
) |
Get the value of a PLIST_DATE node.
This function does nothing if node is not of type PLIST_DATE
node | the node |
sec | a pointer to an int32_t variable. Represents the number of seconds since 01/01/2001. |
usec | a pointer to an int32_t variable. Represents the number of microseconds |
References PLIST_DATE, and plist_get_node_type().
PLIST_API void plist_get_key_val | ( | plist_t | node, |
char ** | val | ||
) |
Get the value of a PLIST_KEY node.
This function does nothing if node is not of type PLIST_KEY
node | the node |
val | a pointer to a C-string. This function allocates the memory, caller is responsible for freeing it. |
References plist_get_node_type(), and PLIST_KEY.
Referenced by plist_dict_get_item_key(), and plist_dict_next_item().
PLIST_API plist_type plist_get_node_type | ( | plist_t | node | ) |
Get the plist_type of a node.
node | the node |
References PLIST_NONE.
Referenced by plist_access_pathv(), plist_array_append_item(), plist_array_get_item(), plist_array_get_item_index(), plist_array_get_size(), plist_array_insert_item(), plist_array_remove_item(), plist_array_set_item(), plist_dict_get_item(), plist_dict_get_item_key(), plist_dict_get_size(), plist_dict_insert_item(), plist_dict_next_item(), plist_dict_remove_item(), plist_dict_set_item(), plist_get_bool_val(), plist_get_data_val(), plist_get_date_val(), plist_get_key_val(), plist_get_real_val(), plist_get_string_val(), and plist_get_uint_val().
Get the parent of a node.
node | the parent (NULL if node is root) |
Referenced by plist_array_get_item_index(), and plist_dict_get_item_key().
PLIST_API void plist_get_real_val | ( | plist_t | node, |
double * | val | ||
) |
Get the value of a PLIST_REAL node.
This function does nothing if node is not of type PLIST_REAL
node | the node |
val | a pointer to a double variable. |
References plist_get_node_type(), and PLIST_REAL.
PLIST_API void plist_get_string_val | ( | plist_t | node, |
char ** | val | ||
) |
Get the value of a PLIST_STRING node.
This function does nothing if node is not of type PLIST_STRING
node | the node |
val | a pointer to a C-string. This function allocates the memory, caller is responsible for freeing it. Data is UTF-8 encoded. |
References plist_get_node_type(), and PLIST_STRING.
PLIST_API void plist_get_uint_val | ( | plist_t | node, |
uint64_t * | val | ||
) |
Get the value of a PLIST_UINT node.
This function does nothing if node is not of type PLIST_UINT
node | the node |
val | a pointer to a uint64_t variable. |
References plist_get_node_type(), and PLIST_UINT.
PLIST_API plist_t plist_new_array | ( | void | ) |
Create a new root plist_t type PLIST_ARRAY.
References PLIST_ARRAY.
PLIST_API plist_t plist_new_bool | ( | uint8_t | val | ) |
Create a new plist_t type PLIST_BOOLEAN.
val | the boolean value, 0 is false, other values are true. |
References PLIST_BOOLEAN.
PLIST_API plist_t plist_new_data | ( | const char * | val, |
uint64_t | length | ||
) |
Create a new plist_t type PLIST_DATA.
val | the binary buffer |
length | the length of the buffer |
References PLIST_DATA.
PLIST_API plist_t plist_new_date | ( | int32_t | sec, |
int32_t | usec | ||
) |
Create a new plist_t type PLIST_DATE.
sec | the number of seconds since 01/01/2001 |
usec | the number of microseconds |
References PLIST_DATE.
PLIST_API plist_t plist_new_dict | ( | void | ) |
Create a new root plist_t type PLIST_DICT.
References PLIST_DICT.
PLIST_API plist_t plist_new_real | ( | double | val | ) |
Create a new plist_t type PLIST_REAL.
val | the real value |
References PLIST_REAL.
PLIST_API plist_t plist_new_string | ( | const char * | val | ) |
Create a new plist_t type PLIST_STRING.
val | the sting value, encoded in UTF8. |
References PLIST_STRING.
PLIST_API plist_t plist_new_uint | ( | uint64_t | val | ) |
Create a new plist_t type PLIST_UINT.
val | the unsigned integer value |
References PLIST_UINT.
PLIST_API void plist_set_bool_val | ( | plist_t | node, |
uint8_t | val | ||
) |
Set the value of a node.
Forces type of node to PLIST_BOOLEAN
node | the node |
val | the boolean value |
References PLIST_BOOLEAN.
PLIST_API void plist_set_data_val | ( | plist_t | node, |
const char * | val, | ||
uint64_t | length | ||
) |
Set the value of a node.
Forces type of node to PLIST_DATA
node | the node |
val | the binary buffer |
length | the length of the buffer |
References PLIST_DATA.
PLIST_API void plist_set_date_val | ( | plist_t | node, |
int32_t | sec, | ||
int32_t | usec | ||
) |
Set the value of a node.
Forces type of node to PLIST_DATE
node | the node |
sec | the number of seconds since 01/01/2001 |
usec | the number of microseconds |
References PLIST_DATE.
PLIST_API void plist_set_key_val | ( | plist_t | node, |
const char * | val | ||
) |
PLIST_API void plist_set_real_val | ( | plist_t | node, |
double | val | ||
) |
Set the value of a node.
Forces type of node to PLIST_REAL
node | the node |
val | the real value |
References PLIST_REAL.
PLIST_API void plist_set_string_val | ( | plist_t | node, |
const char * | val | ||
) |
Set the value of a node.
Forces type of node to PLIST_STRING
node | the node |
val | the string value |
References PLIST_STRING.
PLIST_API void plist_set_type | ( | plist_t | node, |
plist_type | type | ||
) |
Forces type of node.
Changing type of structured nodes is only allowed if node is empty. Reset value of node;
node | the node |
type | the key value |
References PLIST_BOOLEAN, PLIST_DATE, PLIST_REAL, and PLIST_UINT.
PLIST_API void plist_set_uint_val | ( | plist_t | node, |
uint64_t | val | ||
) |
Set the value of a node.
Forces type of node to PLIST_UINT
node | the node |
val | the unsigned integer value |
References PLIST_UINT.
PLIST_API void plist_to_bin | ( | plist_t | plist, |
char ** | plist_bin, | ||
uint32_t * | length | ||
) |
Export the plist_t structure to binary format.
plist | the root node to export |
plist_bin | a pointer to a char* buffer. This function allocates the memory, caller is responsible for freeing it. |
length | a pointer to an uint32_t variable. Represents the length of the allocated buffer. |
References PLIST_ARRAY, PLIST_BOOLEAN, PLIST_DATA, PLIST_DATE, PLIST_DICT, PLIST_KEY, PLIST_REAL, PLIST_STRING, and PLIST_UINT.
PLIST_API void plist_to_xml | ( | plist_t | plist, |
char ** | plist_xml, | ||
uint32_t * | length | ||
) |
Export the plist_t structure to XML format.
plist | the root node to export |
plist_xml | a pointer to a C-string. This function allocates the memory, caller is responsible for freeing it. Data is UTF-8 encoded. |
length | a pointer to an uint32_t variable. Represents the length of the allocated buffer. |