summaryrefslogtreecommitdiffstats
path: root/include/plist
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2023-05-13 19:53:26 +0200
committerGravatar Nikias Bassen2023-05-13 19:53:26 +0200
commit91c0aa8fa82d3fb42c64b0e46bfa861cada5e47d (patch)
tree41d3ff96c3dfcd46b5172db9bd418dd62cb780f9 /include/plist
parent834bb313405bce621610862e76891377ab6601d5 (diff)
downloadlibplist-91c0aa8fa82d3fb42c64b0e46bfa861cada5e47d.tar.gz
libplist-91c0aa8fa82d3fb42c64b0e46bfa861cada5e47d.tar.bz2
Move PLIST_API to the headers
Diffstat (limited to 'include/plist')
-rw-r--r--include/plist/plist.h198
1 files changed, 107 insertions, 91 deletions
diff --git a/include/plist/plist.h b/include/plist/plist.h
index 953ecad..7605975 100644
--- a/include/plist/plist.h
+++ b/include/plist/plist.h
@@ -75,6 +75,22 @@ extern "C"
#endif
/*}}}*/
+#ifdef LIBPLIST_STATIC
+ #define PLIST_API
+#elif defined(_WIN32)
+ #ifdef DLL_EXPORT
+ #define PLIST_API __declspec(dllexport)
+ #else
+ #define PLIST_API __declspec(dllimport)
+ #endif
+#else
+ #if __GNUC__ >= 4
+ #define PLIST_API __attribute__((visibility("default")))
+ #else
+ #define PLIST_API
+ #endif
+#endif
+
#include <sys/types.h>
#include <stdarg.h>
#include <stdio.h>
@@ -180,7 +196,7 @@ extern "C"
* @return the created plist
* @sa #plist_type
*/
- plist_t plist_new_dict(void);
+ PLIST_API plist_t plist_new_dict(void);
/**
* Create a new root plist_t type #PLIST_ARRAY
@@ -188,7 +204,7 @@ extern "C"
* @return the created plist
* @sa #plist_type
*/
- plist_t plist_new_array(void);
+ PLIST_API plist_t plist_new_array(void);
/**
* Create a new plist_t type #PLIST_STRING
@@ -197,7 +213,7 @@ extern "C"
* @return the created item
* @sa #plist_type
*/
- plist_t plist_new_string(const char *val);
+ PLIST_API plist_t plist_new_string(const char *val);
/**
* Create a new plist_t type #PLIST_BOOLEAN
@@ -206,7 +222,7 @@ extern "C"
* @return the created item
* @sa #plist_type
*/
- plist_t plist_new_bool(uint8_t val);
+ PLIST_API plist_t plist_new_bool(uint8_t val);
/**
* Create a new plist_t type #PLIST_INT with an unsigned integer value
@@ -217,7 +233,7 @@ extern "C"
* @note The value is always stored as uint64_t internally.
* Use #plist_get_uint_val or #plist_get_int_val to get the unsigned or signed value.
*/
- plist_t plist_new_uint(uint64_t val);
+ PLIST_API plist_t plist_new_uint(uint64_t val);
/**
* Create a new plist_t type #PLIST_INT with a signed integer value
@@ -228,7 +244,7 @@ extern "C"
* @note The value is always stored as uint64_t internally.
* Use #plist_get_uint_val or #plist_get_int_val to get the unsigned or signed value.
*/
- plist_t plist_new_int(int64_t val);
+ PLIST_API plist_t plist_new_int(int64_t val);
/**
* Create a new plist_t type #PLIST_REAL
@@ -237,7 +253,7 @@ extern "C"
* @return the created item
* @sa #plist_type
*/
- plist_t plist_new_real(double val);
+ PLIST_API plist_t plist_new_real(double val);
/**
* Create a new plist_t type #PLIST_DATA
@@ -247,7 +263,7 @@ extern "C"
* @return the created item
* @sa #plist_type
*/
- plist_t plist_new_data(const char *val, uint64_t length);
+ PLIST_API plist_t plist_new_data(const char *val, uint64_t length);
/**
* Create a new plist_t type #PLIST_DATE
@@ -257,7 +273,7 @@ extern "C"
* @return the created item
* @sa #plist_type
*/
- plist_t plist_new_date(int32_t sec, int32_t usec);
+ PLIST_API plist_t plist_new_date(int32_t sec, int32_t usec);
/**
* Create a new plist_t type #PLIST_UID
@@ -266,7 +282,7 @@ extern "C"
* @return the created item
* @sa #plist_type
*/
- plist_t plist_new_uid(uint64_t val);
+ PLIST_API plist_t plist_new_uid(uint64_t val);
/**
* Create a new plist_t type #PLIST_NULL
@@ -275,14 +291,14 @@ extern "C"
* @note This type is not valid for all formats, e.g. the XML format
* does not support it.
*/
- plist_t plist_new_null(void);
+ PLIST_API plist_t plist_new_null(void);
/**
* Destruct a plist_t node and all its children recursively
*
* @param plist the plist to free
*/
- void plist_free(plist_t plist);
+ PLIST_API void plist_free(plist_t plist);
/**
* Return a copy of passed node and it's children
@@ -290,7 +306,7 @@ extern "C"
* @param node the plist to copy
* @return copied plist
*/
- plist_t plist_copy(plist_t node);
+ PLIST_API plist_t plist_copy(plist_t node);
/********************************************
@@ -305,7 +321,7 @@ extern "C"
* @param node the node of type #PLIST_ARRAY
* @return size of the #PLIST_ARRAY node
*/
- uint32_t plist_array_get_size(plist_t node);
+ PLIST_API uint32_t plist_array_get_size(plist_t node);
/**
* Get the nth item in a #PLIST_ARRAY node.
@@ -314,7 +330,7 @@ extern "C"
* @param n the index of the item to get. Range is [0, array_size[
* @return the nth item or NULL if node is not of type #PLIST_ARRAY
*/
- plist_t plist_array_get_item(plist_t node, uint32_t n);
+ PLIST_API plist_t plist_array_get_item(plist_t node, uint32_t n);
/**
* Get the index of an item. item must be a member of a #PLIST_ARRAY node.
@@ -322,7 +338,7 @@ extern "C"
* @param node the node
* @return the node index or UINT_MAX if node index can't be determined
*/
- uint32_t plist_array_get_item_index(plist_t node);
+ PLIST_API uint32_t plist_array_get_item_index(plist_t node);
/**
* Set the nth item in a #PLIST_ARRAY node.
@@ -332,7 +348,7 @@ extern "C"
* @param item the new item at index n. The array is responsible for freeing item when it is no longer needed.
* @param n the index of the item to get. Range is [0, array_size[. Assert if n is not in range.
*/
- void plist_array_set_item(plist_t node, plist_t item, uint32_t n);
+ PLIST_API void plist_array_set_item(plist_t node, plist_t item, uint32_t n);
/**
* Append a new item at the end of a #PLIST_ARRAY node.
@@ -340,7 +356,7 @@ extern "C"
* @param node the node of type #PLIST_ARRAY
* @param item the new item. The array is responsible for freeing item when it is no longer needed.
*/
- void plist_array_append_item(plist_t node, plist_t item);
+ PLIST_API void plist_array_append_item(plist_t node, plist_t item);
/**
* Insert a new item at position n in a #PLIST_ARRAY node.
@@ -349,7 +365,7 @@ extern "C"
* @param item the new item to insert. The array is responsible for freeing item when it is no longer needed.
* @param n The position at which the node will be stored. Range is [0, array_size[. Assert if n is not in range.
*/
- void plist_array_insert_item(plist_t node, plist_t item, uint32_t n);
+ PLIST_API void plist_array_insert_item(plist_t node, plist_t item, uint32_t n);
/**
* Remove an existing position in a #PLIST_ARRAY node.
@@ -358,7 +374,7 @@ extern "C"
* @param node the node of type #PLIST_ARRAY
* @param n The position to remove. Range is [0, array_size[. Assert if n is not in range.
*/
- void plist_array_remove_item(plist_t node, uint32_t n);
+ PLIST_API void plist_array_remove_item(plist_t node, uint32_t n);
/**
* Remove a node that is a child node of a #PLIST_ARRAY node.
@@ -366,7 +382,7 @@ extern "C"
*
* @param node The node to be removed from its #PLIST_ARRAY parent.
*/
- void plist_array_item_remove(plist_t node);
+ PLIST_API void plist_array_item_remove(plist_t node);
/**
* Create an iterator of a #PLIST_ARRAY node.
@@ -375,7 +391,7 @@ extern "C"
* @param node The node of type #PLIST_ARRAY
* @param iter Location to store the iterator for the array.
*/
- void plist_array_new_iter(plist_t node, plist_array_iter *iter);
+ PLIST_API void plist_array_new_iter(plist_t node, plist_array_iter *iter);
/**
* Increment iterator of a #PLIST_ARRAY node.
@@ -386,7 +402,7 @@ extern "C"
* returned item. Will be set to NULL when no more items are left
* to iterate.
*/
- void plist_array_next_item(plist_t node, plist_array_iter iter, plist_t *item);
+ PLIST_API void plist_array_next_item(plist_t node, plist_array_iter iter, plist_t *item);
/********************************************
@@ -401,7 +417,7 @@ extern "C"
* @param node the node of type #PLIST_DICT
* @return size of the #PLIST_DICT node
*/
- uint32_t plist_dict_get_size(plist_t node);
+ PLIST_API uint32_t plist_dict_get_size(plist_t node);
/**
* Create an iterator of a #PLIST_DICT node.
@@ -410,7 +426,7 @@ extern "C"
* @param node The node of type #PLIST_DICT.
* @param iter Location to store the iterator for the dictionary.
*/
- void plist_dict_new_iter(plist_t node, plist_dict_iter *iter);
+ PLIST_API void plist_dict_new_iter(plist_t node, plist_dict_iter *iter);
/**
* Increment iterator of a #PLIST_DICT node.
@@ -423,7 +439,7 @@ extern "C"
* free the returned value. Will be set to NULL when no more
* key/value pairs are left to iterate.
*/
- void plist_dict_next_item(plist_t node, plist_dict_iter iter, char **key, plist_t *val);
+ PLIST_API void plist_dict_next_item(plist_t node, plist_dict_iter iter, char **key, plist_t *val);
/**
* Get key associated key to an item. Item must be member of a dictionary.
@@ -431,7 +447,7 @@ extern "C"
* @param node the item
* @param key a location to store the key. The caller is responsible for freeing the returned string.
*/
- void plist_dict_get_item_key(plist_t node, char **key);
+ PLIST_API void plist_dict_get_item_key(plist_t node, char **key);
/**
* Get the nth item in a #PLIST_DICT node.
@@ -441,7 +457,7 @@ extern "C"
* @return the item or NULL if node is not of type #PLIST_DICT. The caller should not free
* the returned node.
*/
- plist_t plist_dict_get_item(plist_t node, const char* key);
+ PLIST_API plist_t plist_dict_get_item(plist_t node, const char* key);
/**
* Get key node associated to an item. Item must be member of a dictionary.
@@ -449,7 +465,7 @@ extern "C"
* @param node the item
* @return the key node of the given item, or NULL.
*/
- plist_t plist_dict_item_get_key(plist_t node);
+ PLIST_API plist_t plist_dict_item_get_key(plist_t node);
/**
* Set item identified by key in a #PLIST_DICT node.
@@ -460,7 +476,7 @@ extern "C"
* @param item the new item associated to key
* @param key the identifier of the item to set.
*/
- void plist_dict_set_item(plist_t node, const char* key, plist_t item);
+ PLIST_API void plist_dict_set_item(plist_t node, const char* key, plist_t item);
/**
* Remove an existing position in a #PLIST_DICT node.
@@ -469,7 +485,7 @@ extern "C"
* @param node the node of type #PLIST_DICT
* @param key The identifier of the item to remove. Assert if identifier is not present.
*/
- void plist_dict_remove_item(plist_t node, const char* key);
+ PLIST_API void plist_dict_remove_item(plist_t node, const char* key);
/**
* Merge a dictionary into another. This will add all key/value pairs
@@ -479,7 +495,7 @@ extern "C"
* @param target pointer to an existing node of type #PLIST_DICT
* @param source node of type #PLIST_DICT that should be merged into target
*/
- void plist_dict_merge(plist_t *target, plist_t source);
+ PLIST_API void plist_dict_merge(plist_t *target, plist_t source);
/********************************************
@@ -493,7 +509,7 @@ extern "C"
*
* @param node the parent (NULL if node is root)
*/
- plist_t plist_get_parent(plist_t node);
+ PLIST_API plist_t plist_get_parent(plist_t node);
/**
* Get the #plist_type of a node.
@@ -501,7 +517,7 @@ extern "C"
* @param node the node
* @return the type of the node
*/
- plist_type plist_get_node_type(plist_t node);
+ PLIST_API plist_type plist_get_node_type(plist_t node);
/**
* Get the value of a #PLIST_KEY node.
@@ -512,7 +528,7 @@ extern "C"
* caller is responsible for freeing it.
* @note Use plist_mem_free() to free the allocated memory.
*/
- void plist_get_key_val(plist_t node, char **val);
+ PLIST_API void plist_get_key_val(plist_t node, char **val);
/**
* Get the value of a #PLIST_STRING node.
@@ -523,7 +539,7 @@ extern "C"
* caller is responsible for freeing it. Data is UTF-8 encoded.
* @note Use plist_mem_free() to free the allocated memory.
*/
- void plist_get_string_val(plist_t node, char **val);
+ PLIST_API void plist_get_string_val(plist_t node, char **val);
/**
* Get a pointer to the buffer of a #PLIST_STRING node.
@@ -536,7 +552,7 @@ extern "C"
*
* @return Pointer to the NULL-terminated buffer.
*/
- const char* plist_get_string_ptr(plist_t node, uint64_t* length);
+ PLIST_API const char* plist_get_string_ptr(plist_t node, uint64_t* length);
/**
* Get the value of a #PLIST_BOOLEAN node.
@@ -545,7 +561,7 @@ extern "C"
* @param node the node
* @param val a pointer to a uint8_t variable.
*/
- void plist_get_bool_val(plist_t node, uint8_t * val);
+ PLIST_API void plist_get_bool_val(plist_t node, uint8_t * val);
/**
* Get the unsigned integer value of a #PLIST_INT node.
@@ -554,7 +570,7 @@ extern "C"
* @param node the node
* @param val a pointer to a uint64_t variable.
*/
- void plist_get_uint_val(plist_t node, uint64_t * val);
+ PLIST_API void plist_get_uint_val(plist_t node, uint64_t * val);
/**
* Get the signed integer value of a #PLIST_INT node.
@@ -563,7 +579,7 @@ extern "C"
* @param node the node
* @param val a pointer to a int64_t variable.
*/
- void plist_get_int_val(plist_t node, int64_t * val);
+ PLIST_API void plist_get_int_val(plist_t node, int64_t * val);
/**
* Get the value of a #PLIST_REAL node.
@@ -572,7 +588,7 @@ extern "C"
* @param node the node
* @param val a pointer to a double variable.
*/
- void plist_get_real_val(plist_t node, double *val);
+ PLIST_API void plist_get_real_val(plist_t node, double *val);
/**
* Get the value of a #PLIST_DATA node.
@@ -584,7 +600,7 @@ extern "C"
* @param length the length of the buffer
* @note Use plist_mem_free() to free the allocated memory.
*/
- void plist_get_data_val(plist_t node, char **val, uint64_t * length);
+ PLIST_API void plist_get_data_val(plist_t node, char **val, uint64_t * length);
/**
* Get a pointer to the data buffer of a #PLIST_DATA node.
@@ -597,7 +613,7 @@ extern "C"
*
* @return Pointer to the buffer
*/
- const char* plist_get_data_ptr(plist_t node, uint64_t* length);
+ PLIST_API const char* plist_get_data_ptr(plist_t node, uint64_t* length);
/**
* Get the value of a #PLIST_DATE node.
@@ -607,7 +623,7 @@ extern "C"
* @param sec a pointer to an int32_t variable. Represents the number of seconds since 01/01/2001.
* @param usec a pointer to an int32_t variable. Represents the number of microseconds
*/
- void plist_get_date_val(plist_t node, int32_t * sec, int32_t * usec);
+ PLIST_API void plist_get_date_val(plist_t node, int32_t * sec, int32_t * usec);
/**
* Get the value of a #PLIST_UID node.
@@ -616,7 +632,7 @@ extern "C"
* @param node the node
* @param val a pointer to a uint64_t variable.
*/
- void plist_get_uid_val(plist_t node, uint64_t * val);
+ PLIST_API void plist_get_uid_val(plist_t node, uint64_t * val);
/********************************************
@@ -632,7 +648,7 @@ extern "C"
* @param node the node
* @param val the key value
*/
- void plist_set_key_val(plist_t node, const char *val);
+ PLIST_API void plist_set_key_val(plist_t node, const char *val);
/**
* Set the value of a node.
@@ -642,7 +658,7 @@ extern "C"
* @param val the string value. The string is copied when set and will be
* freed by the node.
*/
- void plist_set_string_val(plist_t node, const char *val);
+ PLIST_API void plist_set_string_val(plist_t node, const char *val);
/**
* Set the value of a node.
@@ -651,7 +667,7 @@ extern "C"
* @param node the node
* @param val the boolean value
*/
- void plist_set_bool_val(plist_t node, uint8_t val);
+ PLIST_API void plist_set_bool_val(plist_t node, uint8_t val);
/**
* Set the value of a node.
@@ -660,7 +676,7 @@ extern "C"
* @param node the node
* @param val the unsigned integer value
*/
- void plist_set_uint_val(plist_t node, uint64_t val);
+ PLIST_API void plist_set_uint_val(plist_t node, uint64_t val);
/**
* Set the value of a node.
@@ -669,7 +685,7 @@ extern "C"
* @param node the node
* @param val the signed integer value
*/
- void plist_set_int_val(plist_t node, int64_t val);
+ PLIST_API void plist_set_int_val(plist_t node, int64_t val);
/**
* Set the value of a node.
@@ -678,7 +694,7 @@ extern "C"
* @param node the node
* @param val the real value
*/
- void plist_set_real_val(plist_t node, double val);
+ PLIST_API void plist_set_real_val(plist_t node, double val);
/**
* Set the value of a node.
@@ -689,7 +705,7 @@ extern "C"
* be freed by the node.
* @param length the length of the buffer
*/
- void plist_set_data_val(plist_t node, const char *val, uint64_t length);
+ PLIST_API void plist_set_data_val(plist_t node, const char *val, uint64_t length);
/**
* Set the value of a node.
@@ -699,7 +715,7 @@ extern "C"
* @param sec the number of seconds since 01/01/2001
* @param usec the number of microseconds
*/
- void plist_set_date_val(plist_t node, int32_t sec, int32_t usec);
+ PLIST_API void plist_set_date_val(plist_t node, int32_t sec, int32_t usec);
/**
* Set the value of a node.
@@ -708,7 +724,7 @@ extern "C"
* @param node the node
* @param val the unsigned integer value
*/
- void plist_set_uid_val(plist_t node, uint64_t val);
+ PLIST_API void plist_set_uid_val(plist_t node, uint64_t val);
/********************************************
@@ -727,7 +743,7 @@ extern "C"
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
* @note Use plist_mem_free() to free the allocated memory.
*/
- plist_err_t plist_to_xml(plist_t plist, char **plist_xml, uint32_t * length);
+ PLIST_API plist_err_t plist_to_xml(plist_t plist, char **plist_xml, uint32_t * length);
/**
* Export the #plist_t structure to binary format.
@@ -739,7 +755,7 @@ extern "C"
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
* @note Use plist_mem_free() to free the allocated memory.
*/
- plist_err_t plist_to_bin(plist_t plist, char **plist_bin, uint32_t * length);
+ PLIST_API plist_err_t plist_to_bin(plist_t plist, char **plist_bin, uint32_t * length);
/**
* Export the #plist_t structure to JSON format.
@@ -752,7 +768,7 @@ extern "C"
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
* @note Use plist_mem_free() to free the allocated memory.
*/
- plist_err_t plist_to_json(plist_t plist, char **plist_json, uint32_t* length, int prettify);
+ PLIST_API plist_err_t plist_to_json(plist_t plist, char **plist_json, uint32_t* length, int prettify);
/**
* Export the #plist_t structure to OpenStep format.
@@ -765,7 +781,7 @@ extern "C"
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
* @note Use plist_mem_free() to free the allocated memory.
*/
- plist_err_t plist_to_openstep(plist_t plist, char **plist_openstep, uint32_t* length, int prettify);
+ PLIST_API plist_err_t plist_to_openstep(plist_t plist, char **plist_openstep, uint32_t* length, int prettify);
/**
@@ -776,7 +792,7 @@ extern "C"
* @param plist a pointer to the imported plist.
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
*/
- plist_err_t plist_from_xml(const char *plist_xml, uint32_t length, plist_t * plist);
+ PLIST_API plist_err_t plist_from_xml(const char *plist_xml, uint32_t length, plist_t * plist);
/**
* Import the #plist_t structure from binary format.
@@ -786,7 +802,7 @@ extern "C"
* @param plist a pointer to the imported plist.
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
*/
- plist_err_t plist_from_bin(const char *plist_bin, uint32_t length, plist_t * plist);
+ PLIST_API plist_err_t plist_from_bin(const char *plist_bin, uint32_t length, plist_t * plist);
/**
* Import the #plist_t structure from JSON format.
@@ -796,7 +812,7 @@ extern "C"
* @param plist a pointer to the imported plist.
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
*/
- plist_err_t plist_from_json(const char *json, uint32_t length, plist_t * plist);
+ PLIST_API plist_err_t plist_from_json(const char *json, uint32_t length, plist_t * plist);
/**
* Import the #plist_t structure from OpenStep plist format.
@@ -806,7 +822,7 @@ extern "C"
* @param plist a pointer to the imported plist.
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
*/
- plist_err_t plist_from_openstep(const char *openstep, uint32_t length, plist_t * plist);
+ PLIST_API plist_err_t plist_from_openstep(const char *openstep, uint32_t length, plist_t * plist);
/**
* Import the #plist_t structure from memory data.
@@ -826,7 +842,7 @@ extern "C"
* @param format If non-NULL, the #plist_format_t value pointed to will be set to the parsed format.
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
*/
- plist_err_t plist_from_memory(const char *plist_data, uint32_t length, plist_t *plist, plist_format_t *format);
+ PLIST_API plist_err_t plist_from_memory(const char *plist_data, uint32_t length, plist_t *plist, plist_format_t *format);
/**
* Import the #plist_t structure directly from file.
@@ -841,7 +857,7 @@ extern "C"
* @param format If non-NULL, the #plist_format_t value pointed to will be set to the parsed format.
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure
*/
- plist_err_t plist_read_from_file(const char *filename, plist_t *plist, plist_format_t *format);
+ PLIST_API plist_err_t plist_read_from_file(const char *filename, plist_t *plist, plist_format_t *format);
/**
* Write the #plist_t structure to a NULL-terminated string using the given format and options.
@@ -856,7 +872,7 @@ extern "C"
* @note Use plist_mem_free() to free the allocated memory.
* @note #PLIST_FORMAT_BINARY is not supported by this function.
*/
- plist_err_t plist_write_to_string(plist_t plist, char **output, uint32_t* length, plist_format_t format, plist_write_options_t options);
+ PLIST_API plist_err_t plist_write_to_string(plist_t plist, char **output, uint32_t* length, plist_format_t format, plist_write_options_t options);
/**
* Write the #plist_t structure to a FILE* stream using the given format and options.
@@ -871,7 +887,7 @@ extern "C"
* (basically all output-only formats) are directly and efficiently written to the stream;
* the other formats are written to a memory buffer first.
*/
- plist_err_t plist_write_to_stream(plist_t plist, FILE* stream, plist_format_t format, plist_write_options_t options);
+ PLIST_API plist_err_t plist_write_to_stream(plist_t plist, FILE* stream, plist_format_t format, plist_write_options_t options);
/**
* Write the #plist_t structure to a file at given path using the given format and options.
@@ -883,7 +899,7 @@ extern "C"
* @return PLIST_ERR_SUCCESS on success or a #plist_err_t on failure.
* @note Use plist_mem_free() to free the allocated memory.
*/
- plist_err_t plist_write_to_file(plist_t plist, const char *filename, plist_format_t format, plist_write_options_t options);
+ PLIST_API plist_err_t plist_write_to_file(plist_t plist, const char *filename, plist_format_t format, plist_write_options_t options);
/**
* Print the given plist in human-readable format to standard output.
@@ -892,7 +908,7 @@ extern "C"
* @param plist The #plist_t structure to print
* @note For #PLIST_DATA nodes, only a maximum of 24 bytes (first 16 and last 8) are written.
*/
- void plist_print(plist_t plist);
+ PLIST_API void plist_print(plist_t plist);
/**
* Test if in-memory plist data is in binary format.
@@ -906,7 +922,7 @@ extern "C"
* @param length length of the buffer to read.
* @return 1 if the buffer is a binary plist, 0 otherwise.
*/
- int plist_is_binary(const char *plist_data, uint32_t length);
+ PLIST_API int plist_is_binary(const char *plist_data, uint32_t length);
/********************************************
* *
@@ -923,7 +939,7 @@ extern "C"
* @param length length of the path to access
* @return the value to access.
*/
- plist_t plist_access_path(plist_t plist, uint32_t length, ...);
+ PLIST_API plist_t plist_access_path(plist_t plist, uint32_t length, ...);
/**
* Variadic version of #plist_access_path.
@@ -933,7 +949,7 @@ extern "C"
* @param v list of array's index and dic'st key
* @return the value to access.
*/
- plist_t plist_access_pathv(plist_t plist, uint32_t length, va_list v);
+ PLIST_API plist_t plist_access_pathv(plist_t plist, uint32_t length, va_list v);
/**
* Compare two node values
@@ -942,7 +958,7 @@ extern "C"
* @param node_r rigth node to compare
* @return TRUE is type and value match, FALSE otherwise.
*/
- char plist_compare_node_value(plist_t node_l, plist_t node_r);
+ PLIST_API char plist_compare_node_value(plist_t node_l, plist_t node_r);
/** Helper macro used by PLIST_IS_* macros that will evaluate the type of a plist node. */
#define _PLIST_IS_TYPE(__plist, __plist_type) (__plist && (plist_get_node_type(__plist) == PLIST_##__plist_type))
@@ -977,7 +993,7 @@ extern "C"
* @param boolnode node of type PLIST_BOOL
* @return 1 if the boolean node has a value of TRUE or 0 if FALSE.
*/
- int plist_bool_val_is_true(plist_t boolnode);
+ PLIST_API int plist_bool_val_is_true(plist_t boolnode);
/**
* Helper function to test if a given #PLIST_INT node's value is negative
@@ -985,7 +1001,7 @@ extern "C"
* @param intnode node of type PLIST_INT
* @return 1 if the node's value is negative, or 0 if positive.
*/
- int plist_int_val_is_negative(plist_t intnode);
+ PLIST_API int plist_int_val_is_negative(plist_t intnode);
/**
* Helper function to compare the value of a PLIST_INT node against
@@ -997,7 +1013,7 @@ extern "C"
* 1 if the node's value is greater than cmpval,
* or -1 if the node's value is less than cmpval.
*/
- int plist_int_val_compare(plist_t uintnode, int64_t cmpval);
+ PLIST_API int plist_int_val_compare(plist_t uintnode, int64_t cmpval);
/**
* Helper function to compare the value of a PLIST_INT node against
@@ -1009,7 +1025,7 @@ extern "C"
* 1 if the node's value is greater than cmpval,
* or -1 if the node's value is less than cmpval.
*/
- int plist_uint_val_compare(plist_t uintnode, uint64_t cmpval);
+ PLIST_API int plist_uint_val_compare(plist_t uintnode, uint64_t cmpval);
/**
* Helper function to compare the value of a PLIST_UID node against
@@ -1021,7 +1037,7 @@ extern "C"
* 1 if the node's value is greater than cmpval,
* or -1 if the node's value is less than cmpval.
*/
- int plist_uid_val_compare(plist_t uidnode, uint64_t cmpval);
+ PLIST_API int plist_uid_val_compare(plist_t uidnode, uint64_t cmpval);
/**
* Helper function to compare the value of a PLIST_REAL node against
@@ -1038,7 +1054,7 @@ extern "C"
* 1 if the node's value is greater than cmpval,
* or -1 if the node's value is less than cmpval.
*/
- int plist_real_val_compare(plist_t realnode, double cmpval);
+ PLIST_API int plist_real_val_compare(plist_t realnode, double cmpval);
/**
* Helper function to compare the value of a PLIST_DATE node against
@@ -1051,7 +1067,7 @@ extern "C"
* 1 if the node's date is greater than the supplied values,
* or -1 if the node's date is less than the supplied values.
*/
- int plist_date_val_compare(plist_t datenode, int32_t cmpsec, int32_t cmpusec);
+ PLIST_API int plist_date_val_compare(plist_t datenode, int32_t cmpsec, int32_t cmpusec);
/**
* Helper function to compare the value of a PLIST_STRING node against
@@ -1064,7 +1080,7 @@ extern "C"
* > 0 if the node's value is lexicographically greater than cmpval,
* or < 0 if the node's value is lexicographically less than cmpval.
*/
- int plist_string_val_compare(plist_t strnode, const char* cmpval);
+ PLIST_API int plist_string_val_compare(plist_t strnode, const char* cmpval);
/**
* Helper function to compare the value of a PLIST_STRING node against
@@ -1078,7 +1094,7 @@ extern "C"
* > 0 if the node's value is lexicographically greater than cmpval,
* or < 0 if the node's value is lexicographically less than cmpval.
*/
- int plist_string_val_compare_with_size(plist_t strnode, const char* cmpval, size_t n);
+ PLIST_API int plist_string_val_compare_with_size(plist_t strnode, const char* cmpval, size_t n);
/**
* Helper function to match a given substring in the value of a
@@ -1089,7 +1105,7 @@ extern "C"
* @return 1 if the node's value contains the given substring,
* or 0 if not.
*/
- int plist_string_val_contains(plist_t strnode, const char* substr);
+ PLIST_API int plist_string_val_contains(plist_t strnode, const char* substr);
/**
* Helper function to compare the value of a PLIST_KEY node against
@@ -1102,7 +1118,7 @@ extern "C"
* > 0 if the node's value is lexicographically greater than cmpval,
* or < 0 if the node's value is lexicographically less than cmpval.
*/
- int plist_key_val_compare(plist_t keynode, const char* cmpval);
+ PLIST_API int plist_key_val_compare(plist_t keynode, const char* cmpval);
/**
* Helper function to compare the value of a PLIST_KEY node against
@@ -1116,7 +1132,7 @@ extern "C"
* > 0 if the node's value is lexicographically greater than cmpval,
* or < 0 if the node's value is lexicographically less than cmpval.
*/
- int plist_key_val_compare_with_size(plist_t keynode, const char* cmpval, size_t n);
+ PLIST_API int plist_key_val_compare_with_size(plist_t keynode, const char* cmpval, size_t n);
/**
* Helper function to match a given substring in the value of a
@@ -1127,7 +1143,7 @@ extern "C"
* @return 1 if the node's value contains the given substring,
* or 0 if not.
*/
- int plist_key_val_contains(plist_t keynode, const char* substr);
+ PLIST_API int plist_key_val_contains(plist_t keynode, const char* substr);
/**
* Helper function to compare the data of a PLIST_DATA node against
@@ -1143,7 +1159,7 @@ extern "C"
* > 0 if the node's value is lexicographically greater than cmpval,
* or < 0 if the node's value is lexicographically less than cmpval.
*/
- int plist_data_val_compare(plist_t datanode, const uint8_t* cmpval, size_t n);
+ PLIST_API int plist_data_val_compare(plist_t datanode, const uint8_t* cmpval, size_t n);
/**
* Helper function to compare the data of a PLIST_DATA node against
@@ -1159,7 +1175,7 @@ extern "C"
* > 0 if the node's value is lexicographically greater than cmpval,
* or < 0 if the node's value is lexicographically less than cmpval.
*/
- int plist_data_val_compare_with_size(plist_t datanode, const uint8_t* cmpval, size_t n);
+ PLIST_API int plist_data_val_compare_with_size(plist_t datanode, const uint8_t* cmpval, size_t n);
/**
* Helper function to match a given data blob within the value of a
@@ -1171,7 +1187,7 @@ extern "C"
* @return 1 if the node's value contains the given data blob
* or 0 if not.
*/
- int plist_data_val_contains(plist_t datanode, const uint8_t* cmpval, size_t n);
+ PLIST_API int plist_data_val_contains(plist_t datanode, const uint8_t* cmpval, size_t n);
/**
* Sort all PLIST_DICT key/value pairs in a property list lexicographically
@@ -1179,7 +1195,7 @@ extern "C"
*
* @param plist The property list to perform the sorting operation on.
*/
- void plist_sort(plist_t plist);
+ PLIST_API void plist_sort(plist_t plist);
/**
* Free memory allocated by relevant libplist API calls:
@@ -1194,7 +1210,7 @@ extern "C"
* @note Do not use this function to free plist_t nodes, use plist_free()
* instead.
*/
- void plist_mem_free(void* ptr);
+ PLIST_API void plist_mem_free(void* ptr);
/**
* Set debug level for the format parsers.
@@ -1202,7 +1218,7 @@ extern "C"
*
* @param debug Debug level. Currently, only 0 (off) and 1 (enabled) are supported.
*/
- void plist_set_debug(int debug);
+ PLIST_API void plist_set_debug(int debug);
/*@}*/