All Header Files: Use consistently-named & commented inclusion guards

This names the include guards after the file path and comments the
endif at the bottom of the files too. It also instructs autoconf to
generate inclusion guards for the autoconf.h file that it writes out.

This avoids the include guards being named with reserved identifiers.
Identifiers that start with 2 underscores, or 1 underscore and then a
capital letter, should only be declared by system headers.

configure

@@ -2176,6 +2176,11 @@ ac_compiler_gnu=$ac_cv_c_compiler_gnu
 ac_config_headers="$ac_config_headers src/libmowgli/platform/autoconf.h"
 
 
+
+
+
+
+
 ac_aux_dir=
 for ac_dir in "$srcdir" "$srcdir/.." "$srcdir/../.."; do
   if test -f "$ac_dir/install-sh"; then

configure.ac

@@ -7,6 +7,15 @@ AC_CONFIG_SRCDIR([src])
 AC_CONFIG_HEADER([src/libmowgli/platform/autoconf.h])
 AC_CONFIG_MACRO_DIR([m4])
 
+AH_TOP([
+#ifndef MOWGLI_SRC_LIBMOWGLI_PLATFORM_AUTOCONF_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_PLATFORM_AUTOCONF_H_INCLUDE_GUARD 1
+])
+
+AH_BOTTOM([
+#endif /* !MOWGLI_SRC_LIBMOWGLI_PLATFORM_AUTOCONF_H_INCLUDE_GUARD */
+])
+
 AC_CANONICAL_HOST
 AC_CANONICAL_TARGET
 

src/libmowgli/base/argstack.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_ARGSTACK_H__
-#define __MOWGLI_ARGSTACK_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_ARGSTACK_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_ARGSTACK_H_INCLUDE_GUARD 1
 
 typedef enum
 {
@@ -58,4 +58,4 @@ extern int mowgli_argstack_pop_numeric(mowgli_argstack_t *);
 extern mowgli_boolean_t mowgli_argstack_pop_boolean(mowgli_argstack_t *);
 extern void *mowgli_argstack_pop_pointer(mowgli_argstack_t *);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_ARGSTACK_H_INCLUDE_GUARD */

src/libmowgli/base/bitvector.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_BITVECTOR_H__
-#define __MOWGLI_BITVECTOR_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_BITVECTOR_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_BITVECTOR_H_INCLUDE_GUARD 1
 
 typedef struct
 {
@@ -38,4 +38,4 @@ extern mowgli_bitvector_t *mowgli_bitvector_combine(mowgli_bitvector_t *bv1, mow
 extern mowgli_bitvector_t *mowgli_bitvector_xor(mowgli_bitvector_t *bv1, mowgli_bitvector_t *bv2);
 extern mowgli_boolean_t mowgli_bitvector_compare(mowgli_bitvector_t *bv1, mowgli_bitvector_t *bv2);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_BITVECTOR_H_INCLUDE_GUARD */

src/libmowgli/base/formatter.h

@@ -21,11 +21,11 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_FORMATTER_H__
-#define __MOWGLI_FORMATTER_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_FORMATTER_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_FORMATTER_H_INCLUDE_GUARD 1
 
 extern void mowgli_formatter_format(char *buf, size_t bufstr, const char *fmtstr, const char *descstr, ...);
 extern void mowgli_formatter_print(const char *fmtstr, const char *descstr, ...);
 extern void mowgli_formatter_format_from_argstack(char *buf, size_t bufstr, const char *fmtstr, const char *descstr, mowgli_argstack_t *stack);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_FORMATTER_H_INCLUDE_GUARD */

src/libmowgli/base/hash.h

@@ -21,10 +21,10 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_HASH_H__
-#define __MOWGLI_HASH_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_HASH_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_HASH_H_INCLUDE_GUARD 1
 
 extern int mowgli_fnv_hash_string(const char *data);
 extern int mowgli_fnv_hash(unsigned int *data);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_HASH_H_INCLUDE_GUARD */

src/libmowgli/base/hook.h

@@ -22,8 +22,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_HOOK_H__
-#define __MOWGLI_HOOK_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_HOOK_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_HOOK_H_INCLUDE_GUARD 1
 
 typedef void (*mowgli_hook_function_t)(void *hook_data, void *user_data);
 
@@ -45,4 +45,4 @@ extern int mowgli_hook_associate(const char *name, mowgli_hook_function_t func,
 extern int mowgli_hook_dissociate(const char *name, mowgli_hook_function_t func);
 extern void mowgli_hook_call(const char *name, void *hook_data);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_HOOK_H_INCLUDE_GUARD */

src/libmowgli/base/memslice.h

@@ -18,9 +18,9 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_MEMSLICE_H__
-#define __MOWGLI_MEMSLICE_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_MEMSLICE_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_MEMSLICE_H_INCLUDE_GUARD 1
 
 mowgli_allocation_policy_t *mowgli_memslice_get_policy(void);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_MEMSLICE_H_INCLUDE_GUARD */

src/libmowgli/base/mowgli_signal.h

@@ -21,11 +21,11 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_SIGNAL_H__
-#define __MOWGLI_SIGNAL_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_MOWGLI_SIGNAL_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_MOWGLI_SIGNAL_H_INCLUDE_GUARD 1
 
 typedef void (*mowgli_signal_handler_t)(int);
 
 extern mowgli_signal_handler_t mowgli_signal_install_handler(int signum, mowgli_signal_handler_t handler);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_MOWGLI_SIGNAL_H_INCLUDE_GUARD */

src/libmowgli/base/random.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_RANDOM_H__
-#define __MOWGLI_RANDOM_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_BASE_RANDOM_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_BASE_RANDOM_H_INCLUDE_GUARD 1
 
 /* mowgli_random_t contains state data which is private */
 struct mowgli_random_;
@@ -40,4 +40,4 @@ extern void mowgli_random_reseed(mowgli_random_t *self, unsigned int seed);
 extern unsigned int mowgli_random_int(mowgli_random_t *self);
 extern int mowgli_random_int_ranged(mowgli_random_t *self, int begin, int end);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_BASE_RANDOM_H_INCLUDE_GUARD */

src/libmowgli/container/dictionary.h

@@ -22,8 +22,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_DICTIONARY_H__
-#define __MOWGLI_DICTIONARY_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CONTAINER_DICTIONARY_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CONTAINER_DICTIONARY_H_INCLUDE_GUARD 1
 
 struct mowgli_dictionary_;	/* defined in src/dictionary.c */
 
@@ -154,4 +154,4 @@ extern void *mowgli_dictionary_delete(mowgli_dictionary_t *dtree, const void *ke
 
 void mowgli_dictionary_stats(mowgli_dictionary_t *dict, void (*cb)(const char *line, void *privdata), void *privdata);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CONTAINER_DICTIONARY_H_INCLUDE_GUARD */

src/libmowgli/container/index.h

@@ -18,8 +18,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_INDEX_H__
-#define __MOWGLI_INDEX_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CONTAINER_INDEX_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CONTAINER_INDEX_H_INCLUDE_GUARD 1
 
 struct mowgli_index_;
 
@@ -44,4 +44,4 @@ void mowgli_index_sort(mowgli_index_t *index, int (*compare)(const void *a, cons
 void mowgli_index_sort_with_data(mowgli_index_t *index, int(*compare)
 				 (const void *a, const void *b, void *data), void *data);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CONTAINER_INDEX_H_INCLUDE_GUARD */

src/libmowgli/container/list.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_LIST_H__
-#define __MOWGLI_LIST_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CONTAINER_LIST_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CONTAINER_LIST_H_INCLUDE_GUARD 1
 
 /* macros for linked lists */
 #define MOWGLI_LIST_FOREACH(n, head) \
@@ -77,4 +77,4 @@ extern void mowgli_list_concat(mowgli_list_t *l, mowgli_list_t *l2);
 extern void mowgli_list_reverse(mowgli_list_t *l);
 extern void mowgli_list_sort(mowgli_list_t *l, mowgli_list_comparator_t comp, void *opaque);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CONTAINER_LIST_H_INCLUDE_GUARD */

src/libmowgli/container/patricia.h

@@ -32,8 +32,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_PATRICIA_H__
-#define __MOWGLI_PATRICIA_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CONTAINER_PATRICIA_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CONTAINER_PATRICIA_H_INCLUDE_GUARD 1
 
 struct mowgli_patricia_;/* defined in src/patricia.c */
 
@@ -145,4 +145,4 @@ void *mowgli_patricia_elem_get_data(mowgli_patricia_elem_t *elem);
 unsigned int mowgli_patricia_size(mowgli_patricia_t *dict);
 void mowgli_patricia_stats(mowgli_patricia_t *dict, void (*cb)(const char *line, void *privdata), void *privdata);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CONTAINER_PATRICIA_H_INCLUDE_GUARD */

src/libmowgli/container/queue.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_QUEUE_H__
-#define __MOWGLI_QUEUE_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CONTAINER_QUEUE_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CONTAINER_QUEUE_H_INCLUDE_GUARD 1
 
 typedef mowgli_iterator_t mowgli_queue_t;
 
@@ -40,4 +40,4 @@ extern void *mowgli_queue_pop_head(mowgli_queue_t **n);
 extern void *mowgli_queue_pop_tail(mowgli_queue_t **n);
 extern int mowgli_queue_length(mowgli_queue_t *head);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CONTAINER_QUEUE_H_INCLUDE_GUARD */

src/libmowgli/core/alloc.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_ALLOC_H__
-#define __MOWGLI_ALLOC_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_ALLOC_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_ALLOC_H_INCLUDE_GUARD 1
 
 extern void *mowgli_alloc_array_using_policy(mowgli_allocation_policy_t *policy, size_t size, size_t count);
 extern void *mowgli_alloc_using_policy(mowgli_allocation_policy_t *policy, size_t size);
@@ -35,4 +35,4 @@ extern char *mowgli_strdup(const char *in);
 extern char *mowgli_strndup(const char *in, size_t size);
 extern void mowgli_free(void *ptr);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_ALLOC_H_INCLUDE_GUARD */

src/libmowgli/core/allocation_policy.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_ALLOCATION_POLICY_H__
-#define __MOWGLI_ALLOCATION_POLICY_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_ALLOCATION_POLICY_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_ALLOCATION_POLICY_H_INCLUDE_GUARD 1
 
 typedef void *(*mowgli_allocation_func_t)(size_t size);
 typedef void (*mowgli_deallocation_func_t)(void *ptr);
@@ -41,4 +41,4 @@ mowgli_allocation_policy_t *mowgli_allocation_policy_lookup(const char *name);
 void mowgli_allocator_set_policy(mowgli_allocation_policy_t *policy);
 void mowgli_allocator_set_policy_by_name(const char *name);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_ALLOCATION_POLICY_H_INCLUDE_GUARD */

src/libmowgli/core/allocator.h

@@ -21,9 +21,9 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_ALLOCATOR_H__
-#define __MOWGLI_ALLOCATOR_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_ALLOCATOR_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_ALLOCATOR_H_INCLUDE_GUARD 1
 
 extern mowgli_allocation_policy_t *mowgli_allocator_malloc;
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_ALLOCATOR_H_INCLUDE_GUARD */

src/libmowgli/core/assert.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_ASSERT_H__
-#define __MOWGLI_ASSERT_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_ASSERT_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_ASSERT_H_INCLUDE_GUARD 1
 
 #define _assert_msg(exp) "assertion '" #exp  "' failed."
 
@@ -57,4 +57,4 @@
 
 #define return_null_if_fail(exp) return_val_if_fail(exp, NULL)
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_ASSERT_H_INCLUDE_GUARD */

src/libmowgli/core/bootstrap.h

@@ -21,9 +21,9 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_BOOTSTRAP_H__
-#define __MOWGLI_BOOTSTRAP_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_BOOTSTRAP_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_BOOTSTRAP_H_INCLUDE_GUARD 1
 
 extern void mowgli_bootstrap(void);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_BOOTSTRAP_H_INCLUDE_GUARD */

src/libmowgli/core/heap.h

@@ -24,8 +24,8 @@
  * Legal note: code devised from claro.base.block module r288 (Pre MPL)
  */
 
-#ifndef __MOWGLI_HEAP_H__
-#define __MOWGLI_HEAP_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_HEAP_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_HEAP_H_INCLUDE_GUARD 1
 
 typedef struct mowgli_heap_ mowgli_heap_t;
 typedef struct mowgli_block_ mowgli_block_t;
@@ -45,4 +45,4 @@ extern void mowgli_heap_destroy(mowgli_heap_t *heap);
 extern void *mowgli_heap_alloc(mowgli_heap_t *heap);
 extern void mowgli_heap_free(mowgli_heap_t *heap, void *data);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_HEAP_H_INCLUDE_GUARD */

src/libmowgli/core/iterator.h

@@ -21,8 +21,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_ITERATOR_H__
-#define __MOWGLI_ITERATOR_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_ITERATOR_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_ITERATOR_H_INCLUDE_GUARD 1
 
 typedef struct _mowgli_iterator
 {
@@ -41,4 +41,4 @@ typedef struct _mowgli_iterator
 #define MOWGLI_ITER_FOREACH_SAFE(n, tn, head) \
 	for (n = (head), tn = n ? n->next : NULL; n != NULL; n = tn, tn = n ? n->next : NULL)
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_ITERATOR_H_INCLUDE_GUARD */

src/libmowgli/core/logger.h

@@ -22,8 +22,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_LOGGER_H__
-#define __MOWGLI_LOGGER_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_LOGGER_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_LOGGER_H_INCLUDE_GUARD 1
 
 typedef void (*mowgli_log_cb_t)(const char *);
 
@@ -59,4 +59,4 @@ extern MOWGLI_COLD(MOWGLI_PRINTF(void mowgli_log_prefix_real(const char *file,
 # define _MOWGLI_FUNCNAME __func__
 #endif
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_LOGGER_H_INCLUDE_GUARD */

src/libmowgli/core/mowgli_string.h

@@ -22,8 +22,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_STRING_H__
-#define __MOWGLI_STRING_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_MOWGLI_STRING_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_MOWGLI_STRING_H_INCLUDE_GUARD 1
 
 typedef struct mowgli_string_
 {
@@ -50,4 +50,4 @@ extern size_t mowgli_strlcat(char *dest, const char *src, size_t count);
 extern size_t mowgli_strlcpy(char *dest, const char *src, size_t count);
 extern ssize_t mowgli_writef(mowgli_descriptor_t fd, const char *fmt, ...);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_MOWGLI_STRING_H_INCLUDE_GUARD */

src/libmowgli/core/process.h

@@ -18,8 +18,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MOWGLI_PROCESS_H__
-#define __MOWGLI_PROCESS_H__
+#ifndef MOWGLI_SRC_LIBMOWGLI_CORE_PROCESS_H_INCLUDE_GUARD
+#define MOWGLI_SRC_LIBMOWGLI_CORE_PROCESS_H_INCLUDE_GUARD 1
 
 typedef void (*mowgli_process_start_fn_t)(void *data);
 
@@ -35,4 +35,4 @@ extern mowgli_process_t *mowgli_process_clone(mowgli_process_start_fn_t start_fn
 extern mowgli_process_t *mowgli_process_spawn(const char *path, char *const argv[]);
 extern void mowgli_process_kill(mowgli_process_t *process);
 
-#endif
+#endif /* MOWGLI_SRC_LIBMOWGLI_CORE_PROCESS_H_INCLUDE_GUARD */