Add flags to functions that might logically be expanded in the future

Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>

3 files changed, 14 insertions, 5 deletions

diff --git a/include/sqfs/data_reader.h b/include/sqfs/data_reader.h
index 58022c9..c967a70 100644
--- a/include/sqfs/data_reader.h
+++ b/include/sqfs/data_reader.h
@@ -62,13 +62,15 @@ extern "C" {
  *             underlying filesystem image.
  * @param block_size The data block size from the super block.
  * @param cmp A compressor to use for uncompressing blocks read from disk.
+ * @param flags Currently must be 0 or the function will fail.
  *
  * @return A pointer to a new data reader object. NULL means
  *         allocation failure.
  */
 SQFS_API sqfs_data_reader_t *sqfs_data_reader_create(sqfs_file_t *file,
 						     size_t block_size,
-						     sqfs_compressor_t *cmp);
+						     sqfs_compressor_t *cmp,
+						     sqfs_u32 flags);
 
 /**
  * @brief Read and decode the fragment table from disk.
diff --git a/include/sqfs/dir_reader.h b/include/sqfs/dir_reader.h
index 52e97fd..cf9f2a1 100644
--- a/include/sqfs/dir_reader.h
+++ b/include/sqfs/dir_reader.h
@@ -161,12 +161,14 @@ extern "C" {
  *              resolving table positions.
  * @param cmp A compressor to use for unpacking meta data blocks.
  * @param file The input file to read from.
+ * @param flags Currently must be zero or the function fails.
  *
  * @return A new directory reader on success, NULL on allocation failure.
  */
 SQFS_API sqfs_dir_reader_t *sqfs_dir_reader_create(const sqfs_super_t *super,
 						   sqfs_compressor_t *cmp,
-						   sqfs_file_t *file);
+						   sqfs_file_t *file,
+						   sqfs_u32 flags);
 
 /**
  * @brief Navigate a directory reader to the location of a directory
@@ -181,11 +183,13 @@ SQFS_API sqfs_dir_reader_t *sqfs_dir_reader_create(const sqfs_super_t *super,
  *
  * @param rd A pointer to a directory reader.
  * @param inode An directory or extended directory inode.
+ * @param flags Currently must be zero or the function fails.
  *
  * @return Zero on success, an @ref SQFS_ERROR value on failure.
  */
 SQFS_API int sqfs_dir_reader_open_dir(sqfs_dir_reader_t *rd,
-				      const sqfs_inode_generic_t *inode);
+				      const sqfs_inode_generic_t *inode,
+				      sqfs_u32 flags);
 
 /**
  * @brief Reset a directory reader back to the beginning of the listing.
diff --git a/include/sqfs/xattr_writer.h b/include/sqfs/xattr_writer.h
index 4b93118..8820e51 100644
--- a/include/sqfs/xattr_writer.h
+++ b/include/sqfs/xattr_writer.h
@@ -61,9 +61,11 @@ extern "C" {
  *
  * @memberof sqfs_xattr_writer_t
  *
+ * @param flags Currently must be zero or the function fails.
+ *
  * @return A pointer to a new xattr writer, NULL on allocation failure.
  */
-SQFS_API sqfs_xattr_writer_t *sqfs_xattr_writer_create(void);
+SQFS_API sqfs_xattr_writer_t *sqfs_xattr_writer_create(sqfs_u32 flags);
 
 /**
  * @brief Begin recording a block of key-value pairs.
@@ -74,10 +76,11 @@ SQFS_API sqfs_xattr_writer_t *sqfs_xattr_writer_create(void);
  * @ref sqfs_xattr_writer_end when you are done.
  *
  * @param xwr A pointer to an xattr writer instance.
+ * @param flags Currently must be zero, or the function will fail.
  *
  * @return Zero on success, a negative @ref SQFS_ERROR value on failure.
  */
-SQFS_API int sqfs_xattr_writer_begin(sqfs_xattr_writer_t *xwr);
+SQFS_API int sqfs_xattr_writer_begin(sqfs_xattr_writer_t *xwr, sqfs_u32 flags);
 
 /**
  * @brief Add a key-value pair to the current block.