From ce9ce43efd707a85cc792ff2cc417603a53d4d1d Mon Sep 17 00:00:00 2001
From: Nikias Bassen
Date: Wed, 19 Apr 2023 17:49:07 +0200
Subject: Add plist_read_from_file() to interface, update plist_from_memory()

plist_read_from_file() is a convenience function that will open a
given file, checks its size, allocates a buffer large enough to
hold the full contents, and reads from file to fill the buffer.
Then, it calls plist_from_memory() to convert the data to plist
format.
A (breaking) change had to be made so that plist_from_memory() will
also return the parsed format in its 4th argument (if non-NULL).
---
 include/plist/plist.h | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

(limited to 'include')

diff --git a/include/plist/plist.h b/include/plist/plist.h
index b635996..9b16c58 100644
--- a/include/plist/plist.h
+++ b/include/plist/plist.h
@@ -44,6 +44,7 @@ extern "C"
 #include <stdint.h>
 #endif
 
+/*{{{ deprecation macros */
 #ifdef __llvm__
   #if defined(__has_extension)
     #if (__has_extension(attribute_deprecated_with_message))
@@ -72,6 +73,7 @@ extern "C"
   #define PLIST_WARN_DEPRECATED(x)
   #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
 #endif
+/*}}}*/
 
 #include <sys/types.h>
 #include <stdarg.h>
@@ -819,7 +821,8 @@ extern "C"
 
     /**
      * Import the #plist_t structure from memory data.
-     * This method will look at the first bytes of plist_data
+     *
+     * This function will look at the first bytes of plist_data
      * to determine if plist_data contains a binary, JSON, OpenStep, or XML plist
      * and tries to parse the data in the appropriate format.
      * @note This is just a convenience function and the format detection is
@@ -831,9 +834,25 @@ extern "C"
      * @param plist_data A pointer to the memory buffer containing plist data.
      * @param length Length of the buffer to read.
      * @param plist A pointer to the imported plist.
+     * @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);
+
+    /**
+     * Import the #plist_t structure directly from file.
+     *
+     * This function will look at the first bytes of the file data
+     * to determine if it contains a binary, JSON, OpenStep, or XML plist
+     * and tries to parse the data in the appropriate format.
+     * Uses #plist_read_from_data() internally.
+     *
+     * @param filename The name of the file to parse.
+     * @param plist A pointer to the imported plist.
+     * @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_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.
-- 
cgit v1.1-32-gdbae