summaryrefslogtreecommitdiffstats
path: root/lib/glcontainers.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/glcontainers.h')
-rw-r--r--lib/glcontainers.h68
1 files changed, 68 insertions, 0 deletions
diff --git a/lib/glcontainers.h b/lib/glcontainers.h
new file mode 100644
index 0000000..56ae099
--- /dev/null
+++ b/lib/glcontainers.h
@@ -0,0 +1,68 @@
+/*
+ * glcontainers.h: interface to common Gnulib container helpers
+ *
+ * Copyright (C) 2019 Colin Watson.
+ *
+ * This file is part of man-db.
+ *
+ * man-db is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * man-db is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with man-db; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef MAN_GLCONTAINERS_H
+#define MAN_GLCONTAINERS_H
+
+#include <stdbool.h>
+#include <stdlib.h>
+
+#include "gl_list.h"
+#include "gl_map.h"
+#include "gl_set.h"
+
+#include "mp.h"
+
+/* These types are compatible with those required by Gnulib container
+ * initialisation.
+ */
+
+bool string_equals (const void *s1, const void *s2);
+size_t string_hash (const void *s);
+void plain_free (const void *s);
+
+/* Convenience functions. */
+
+gl_list_t new_string_list (gl_list_implementation_t implementation,
+ bool allow_duplicates);
+gl_map_t new_string_map (gl_map_implementation_t implementation,
+ gl_mapvalue_dispose_fn vdispose_fn);
+gl_set_t new_string_set (gl_set_implementation_t implementation);
+
+/* Iterator macros. */
+
+#define GL_LIST_FOREACH(list, item) \
+ MPP_DECLARE (1, gl_list_iterator_t list##_iter = gl_list_iterator (list)) \
+ MPP_DECLARE (2, gl_list_node_t list##_node) \
+ MPP_WHILE (3, gl_list_iterator_next (&list##_iter, \
+ (const void **) &item, \
+ &list##_node)) \
+ MPP_FINALLY (4, gl_list_iterator_free (&list##_iter))
+
+#define GL_MAP_FOREACH(map, key, value) \
+ MPP_DECLARE (1, gl_map_iterator_t map##_iter = gl_map_iterator (map)) \
+ MPP_WHILE (2, gl_map_iterator_next (&map##_iter, \
+ (const void **) &key, \
+ (const void **) &value)) \
+ MPP_FINALLY (3, gl_map_iterator_free (&map##_iter))
+
+#endif /* MAN_GLCONTAINERS_H */