changeset 577:f937857336f3

util: mlk_dir_iter -> mlk_dir
author David Demelier <markand@malikania.fr>
date Sat, 11 Mar 2023 11:15:09 +0100
parents 64150963f567
children f271681ce015
files libmlk-util/mlk/util/dir.c libmlk-util/mlk/util/dir.h tests/test-dir.c
diffstat 3 files changed, 20 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/libmlk-util/mlk/util/dir.c	Sat Mar 11 11:04:11 2023 +0100
+++ b/libmlk-util/mlk/util/dir.c	Sat Mar 11 11:15:09 2023 +0100
@@ -43,7 +43,7 @@
 }
 
 static void
-handle_finish(struct mlk_dir_iter *iter)
+handle_finish(struct mlk_dir *iter)
 {
 	struct self *self = iter->handle;
 
@@ -57,7 +57,7 @@
 }
 
 static int
-handle_open(struct mlk_dir_iter *iter, const char *path)
+handle_open(struct mlk_dir *iter, const char *path)
 {
 	struct self *self;
 
@@ -74,7 +74,7 @@
 }
 
 static int
-handle_next(struct mlk_dir_iter *iter)
+handle_next(struct mlk_dir *iter)
 {
 	struct self *self = iter->handle;
 
@@ -118,7 +118,7 @@
 }
 
 static void
-handle_finish(struct mlk_dir_iter *iter)
+handle_finish(struct mlk_dir *iter)
 {
 	struct self *self = iter->handle;
 
@@ -132,7 +132,7 @@
 }
 
 static int
-handle_open(struct mlk_dir_iter *iter, const char *path)
+handle_open(struct mlk_dir *iter, const char *path)
 {
 	struct self *self;
 	char directory[MAX_PATH];
@@ -165,7 +165,7 @@
 }
 
 static int
-handle_next(struct mlk_dir_iter *iter)
+handle_next(struct mlk_dir *iter)
 {
 	struct self *self = iter->handle;
 	BOOL ret = TRUE;
@@ -194,7 +194,7 @@
 #include <stddef.h>
 
 static int
-handle_open(struct mlk_dir_iter *iter, const char *path)
+handle_open(struct mlk_dir *iter, const char *path)
 {
 	(void)path;
 
@@ -205,7 +205,7 @@
 }
 
 static int
-handle_next(struct mlk_dir_iter *iter)
+handle_next(struct mlk_dir *iter)
 {
 	(void)iter;
 
@@ -213,7 +213,7 @@
 }
 
 static void
-handle_finish(struct mlk_dir_iter *iter)
+handle_finish(struct mlk_dir *iter)
 {
 	(void)iter;
 }
@@ -223,7 +223,7 @@
 #endif
 
 int
-mlk_dir_open(struct mlk_dir_iter *iter, const char *path)
+mlk_dir_open(struct mlk_dir *iter, const char *path)
 {
 	assert(path);
 
@@ -234,7 +234,7 @@
 }
 
 int
-mlk_dir_next(struct mlk_dir_iter *iter)
+mlk_dir_next(struct mlk_dir *iter)
 {
 	assert(iter);
 
@@ -242,7 +242,7 @@
 }
 
 void
-mlk_dir_finish(struct mlk_dir_iter *iter)
+mlk_dir_finish(struct mlk_dir *iter)
 {
 	handle_finish(iter);
 }
--- a/libmlk-util/mlk/util/dir.h	Sat Mar 11 11:04:11 2023 +0100
+++ b/libmlk-util/mlk/util/dir.h	Sat Mar 11 11:15:09 2023 +0100
@@ -34,7 +34,7 @@
  * otherwise ::mlk_dir_finish can be used in case the loop was terminated early
  *
  * ```c
- * struct mlk_dir_iter iter;
+ * struct mlk_dir iter;
  *
  * if (mlk_dir_open(&iter, "/tmp") < 0) {
  *     fprintf(stderr, "unable to open the directory\n");
@@ -54,10 +54,10 @@
 #endif
 
 /**
- * \struct mlk_dir_iter
+ * \struct mlk_dir
  * \brief Directory iterator structure
  */
-struct mlk_dir_iter {
+struct mlk_dir {
 	/**
 	 * (read-only, borrowed)
 	 *
@@ -80,7 +80,7 @@
  * \return 0 on success or -1 on error
  */
 int
-mlk_dir_open(struct mlk_dir_iter *iter, const char *path);
+mlk_dir_open(struct mlk_dir *iter, const char *path);
 
 /**
  * Read the next directory entry.
@@ -90,7 +90,7 @@
  * \return 1 on read or 0 on EOF
  */
 int
-mlk_dir_next(struct mlk_dir_iter *iter);
+mlk_dir_next(struct mlk_dir *iter);
 
 /**
  * Cleanup directory iterator resources.
@@ -102,7 +102,7 @@
  * \param iter the directory iterator
  */
 void
-mlk_dir_finish(struct mlk_dir_iter *iter);
+mlk_dir_finish(struct mlk_dir *iter);
 
 #if defined(__cplusplus)
 }
--- a/tests/test-dir.c	Sat Mar 11 11:04:11 2023 +0100
+++ b/tests/test-dir.c	Sat Mar 11 11:15:09 2023 +0100
@@ -23,7 +23,7 @@
 static void
 test_basics(void)
 {
-	struct mlk_dir_iter iter;
+	struct mlk_dir iter;
 	int a = 0, b = 0, c = 0;
 
 	DT_EQ_INT(mlk_dir_open(&iter, DIRECTORY "/dir"), 0);
@@ -54,7 +54,7 @@
 	 * This test should ensure there are no memory leaks because we break
 	 * the loop while the iterator hasn't completed.
 	 */
-	struct mlk_dir_iter iter;
+	struct mlk_dir iter;
 
 	DT_EQ_INT(mlk_dir_open(&iter, DIRECTORY "/dir"), 0);
 	DT_EQ_INT(mlk_dir_next(&iter), 1);