From 7c4db66eb34eebecc6b17fe86375e081b49bff00 Mon Sep 17 00:00:00 2001 From: Iñigo Martínez Date: Thu, 29 Jul 2021 23:45:52 +0200 Subject: build: Rename template files The template files in the `build-aux` directory used in enums sources and headers generation use the `{$name}-template.[ch]` pattern. However, the examples in the official guide[0] and usually GNOME and Freedesktop packages use the `{$name}.[ch].template` pattern. Due to this, the name of the template files and build commands have been changed. [0] https://developer.gnome.org/gobject/stable/glib-mkenums.html --- build-aux/Makefile.am | 10 +-- build-aux/mm-enums-template.c | 114 ---------------------------------- build-aux/mm-enums-template.h | 35 ----------- build-aux/mm-enums-types.c.template | 114 ++++++++++++++++++++++++++++++++++ build-aux/mm-enums-types.h.template | 35 +++++++++++ build-aux/mm-errors-quarks-template.c | 42 ------------- build-aux/mm-errors-quarks.c.template | 42 +++++++++++++ build-aux/mm-errors-template.c | 40 ------------ build-aux/mm-errors-template.h | 23 ------- build-aux/mm-errors-types.c.template | 40 ++++++++++++ build-aux/mm-errors-types.h.template | 23 +++++++ 11 files changed, 259 insertions(+), 259 deletions(-) delete mode 100644 build-aux/mm-enums-template.c delete mode 100644 build-aux/mm-enums-template.h create mode 100644 build-aux/mm-enums-types.c.template create mode 100644 build-aux/mm-enums-types.h.template delete mode 100644 build-aux/mm-errors-quarks-template.c create mode 100644 build-aux/mm-errors-quarks.c.template delete mode 100644 build-aux/mm-errors-template.c delete mode 100644 build-aux/mm-errors-template.h create mode 100644 build-aux/mm-errors-types.c.template create mode 100644 build-aux/mm-errors-types.h.template (limited to 'build-aux') diff --git a/build-aux/Makefile.am b/build-aux/Makefile.am index c27e0f05..acb7afe4 100644 --- a/build-aux/Makefile.am +++ b/build-aux/Makefile.am @@ -1,8 +1,8 @@ EXTRA_DIST = \ header-generator.xsl \ - mm-enums-template.h \ - mm-enums-template.c \ - mm-errors-template.h \ - mm-errors-template.c \ - mm-errors-quarks-template.c + mm-enums-types.h.template \ + mm-enums-types.c.template \ + mm-errors-types.h.template \ + mm-errors-types.c.template \ + mm-errors-quarks.c.template diff --git a/build-aux/mm-enums-template.c b/build-aux/mm-enums-template.c deleted file mode 100644 index 2a7f264b..00000000 --- a/build-aux/mm-enums-template.c +++ /dev/null @@ -1,114 +0,0 @@ -/*** BEGIN file-header ***/ - -/*** END file-header ***/ - -/*** BEGIN file-production ***/ -/* enumerations from "@filename@" */ -/*** END file-production ***/ - -/*** BEGIN value-header ***/ -static const G@Type@Value @enum_name@_values[] = { -/*** END value-header ***/ -/*** BEGIN value-production ***/ - { @VALUENAME@, "@VALUENAME@", "@valuenick@" }, -/*** END value-production ***/ -/*** BEGIN value-tail ***/ - { 0, NULL, NULL } -}; - -/* Define type-specific symbols */ -#undef __MM_IS_ENUM__ -#undef __MM_IS_FLAGS__ -#define __MM_IS_@TYPE@__ - -GType -@enum_name@_get_type (void) -{ - static gsize g_define_type_id_initialized = 0; - - if (g_once_init_enter (&g_define_type_id_initialized)) { - GType g_define_type_id = - g_@type@_register_static (g_intern_static_string ("@EnumName@"), - @enum_name@_values); - g_once_init_leave (&g_define_type_id_initialized, g_define_type_id); - } - - return g_define_type_id_initialized; -} - -/** - * @enum_name@_get_string: - * @val: a @EnumName@. - * - * Gets the nickname string for the #@EnumName@ specified at @val. - * - * Returns: (transfer none): a string with the nickname, or %NULL if not found. Do not free the returned value. - */ -#if defined __MM_IS_ENUM__ -const gchar * -@enum_name@_get_string (@EnumName@ val) -{ - guint i; - - for (i = 0; @enum_name@_values[i].value_nick; i++) { - if ((gint)val == @enum_name@_values[i].value) - return @enum_name@_values[i].value_nick; - } - - return NULL; -} -#endif /* __MM_IS_ENUM_ */ - -/** - * @enum_name@_build_string_from_mask: - * @mask: bitmask of @EnumName@ values. - * - * Builds a string containing a comma-separated list of nicknames for - * each #@EnumName@ in @mask. - * - * Returns: (transfer full): a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). - */ -#if defined __MM_IS_FLAGS__ -gchar * -@enum_name@_build_string_from_mask (@EnumName@ mask) -{ - guint i; - gboolean first = TRUE; - GString *str = NULL; - - for (i = 0; @enum_name@_values[i].value_nick; i++) { - /* We also look for exact matches */ - if (mask == @enum_name@_values[i].value) { - if (str) - g_string_free (str, TRUE); - return g_strdup (@enum_name@_values[i].value_nick); - } - - /* Build list with single-bit masks */ - if (mask & @enum_name@_values[i].value) { - guint c; - gulong number = @enum_name@_values[i].value; - - for (c = 0; number; c++) - number &= number - 1; - - if (c == 1) { - if (!str) - str = g_string_new (""); - g_string_append_printf (str, "%s%s", - first ? "" : ", ", - @enum_name@_values[i].value_nick); - if (first) - first = FALSE; - } - } - } - - return (str ? g_string_free (str, FALSE) : NULL); -} -#endif /* __MM_IS_FLAGS__ */ - -/*** END value-tail ***/ - -/*** BEGIN file-tail ***/ -/*** END file-tail ***/ diff --git a/build-aux/mm-enums-template.h b/build-aux/mm-enums-template.h deleted file mode 100644 index 652c53dc..00000000 --- a/build-aux/mm-enums-template.h +++ /dev/null @@ -1,35 +0,0 @@ -/*** BEGIN file-header ***/ - -#include - -G_BEGIN_DECLS -/*** END file-header ***/ - -/*** BEGIN file-production ***/ - -/* enumerations from "@filename@" */ -/*** END file-production ***/ - -/*** BEGIN value-header ***/ -GType @enum_name@_get_type (void) G_GNUC_CONST; -#define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ()) - -/* Define type-specific symbols */ -#undef __MM_IS_ENUM__ -#undef __MM_IS_FLAGS__ -#define __MM_IS_@TYPE@__ - -#if defined __MM_IS_ENUM__ -const gchar *@enum_name@_get_string (@EnumName@ val); -#endif - -#if defined __MM_IS_FLAGS__ -gchar *@enum_name@_build_string_from_mask (@EnumName@ mask); -#endif - -/*** END value-header ***/ - -/*** BEGIN file-tail ***/ -G_END_DECLS - -/*** END file-tail ***/ diff --git a/build-aux/mm-enums-types.c.template b/build-aux/mm-enums-types.c.template new file mode 100644 index 00000000..2a7f264b --- /dev/null +++ b/build-aux/mm-enums-types.c.template @@ -0,0 +1,114 @@ +/*** BEGIN file-header ***/ + +/*** END file-header ***/ + +/*** BEGIN file-production ***/ +/* enumerations from "@filename@" */ +/*** END file-production ***/ + +/*** BEGIN value-header ***/ +static const G@Type@Value @enum_name@_values[] = { +/*** END value-header ***/ +/*** BEGIN value-production ***/ + { @VALUENAME@, "@VALUENAME@", "@valuenick@" }, +/*** END value-production ***/ +/*** BEGIN value-tail ***/ + { 0, NULL, NULL } +}; + +/* Define type-specific symbols */ +#undef __MM_IS_ENUM__ +#undef __MM_IS_FLAGS__ +#define __MM_IS_@TYPE@__ + +GType +@enum_name@_get_type (void) +{ + static gsize g_define_type_id_initialized = 0; + + if (g_once_init_enter (&g_define_type_id_initialized)) { + GType g_define_type_id = + g_@type@_register_static (g_intern_static_string ("@EnumName@"), + @enum_name@_values); + g_once_init_leave (&g_define_type_id_initialized, g_define_type_id); + } + + return g_define_type_id_initialized; +} + +/** + * @enum_name@_get_string: + * @val: a @EnumName@. + * + * Gets the nickname string for the #@EnumName@ specified at @val. + * + * Returns: (transfer none): a string with the nickname, or %NULL if not found. Do not free the returned value. + */ +#if defined __MM_IS_ENUM__ +const gchar * +@enum_name@_get_string (@EnumName@ val) +{ + guint i; + + for (i = 0; @enum_name@_values[i].value_nick; i++) { + if ((gint)val == @enum_name@_values[i].value) + return @enum_name@_values[i].value_nick; + } + + return NULL; +} +#endif /* __MM_IS_ENUM_ */ + +/** + * @enum_name@_build_string_from_mask: + * @mask: bitmask of @EnumName@ values. + * + * Builds a string containing a comma-separated list of nicknames for + * each #@EnumName@ in @mask. + * + * Returns: (transfer full): a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + */ +#if defined __MM_IS_FLAGS__ +gchar * +@enum_name@_build_string_from_mask (@EnumName@ mask) +{ + guint i; + gboolean first = TRUE; + GString *str = NULL; + + for (i = 0; @enum_name@_values[i].value_nick; i++) { + /* We also look for exact matches */ + if (mask == @enum_name@_values[i].value) { + if (str) + g_string_free (str, TRUE); + return g_strdup (@enum_name@_values[i].value_nick); + } + + /* Build list with single-bit masks */ + if (mask & @enum_name@_values[i].value) { + guint c; + gulong number = @enum_name@_values[i].value; + + for (c = 0; number; c++) + number &= number - 1; + + if (c == 1) { + if (!str) + str = g_string_new (""); + g_string_append_printf (str, "%s%s", + first ? "" : ", ", + @enum_name@_values[i].value_nick); + if (first) + first = FALSE; + } + } + } + + return (str ? g_string_free (str, FALSE) : NULL); +} +#endif /* __MM_IS_FLAGS__ */ + +/*** END value-tail ***/ + +/*** BEGIN file-tail ***/ +/*** END file-tail ***/ diff --git a/build-aux/mm-enums-types.h.template b/build-aux/mm-enums-types.h.template new file mode 100644 index 00000000..652c53dc --- /dev/null +++ b/build-aux/mm-enums-types.h.template @@ -0,0 +1,35 @@ +/*** BEGIN file-header ***/ + +#include + +G_BEGIN_DECLS +/*** END file-header ***/ + +/*** BEGIN file-production ***/ + +/* enumerations from "@filename@" */ +/*** END file-production ***/ + +/*** BEGIN value-header ***/ +GType @enum_name@_get_type (void) G_GNUC_CONST; +#define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ()) + +/* Define type-specific symbols */ +#undef __MM_IS_ENUM__ +#undef __MM_IS_FLAGS__ +#define __MM_IS_@TYPE@__ + +#if defined __MM_IS_ENUM__ +const gchar *@enum_name@_get_string (@EnumName@ val); +#endif + +#if defined __MM_IS_FLAGS__ +gchar *@enum_name@_build_string_from_mask (@EnumName@ mask); +#endif + +/*** END value-header ***/ + +/*** BEGIN file-tail ***/ +G_END_DECLS + +/*** END file-tail ***/ diff --git a/build-aux/mm-errors-quarks-template.c b/build-aux/mm-errors-quarks-template.c deleted file mode 100644 index 4386a601..00000000 --- a/build-aux/mm-errors-quarks-template.c +++ /dev/null @@ -1,42 +0,0 @@ -/*** BEGIN file-header ***/ - -#include - -/*** END file-header ***/ - -/*** BEGIN file-production ***/ -/* enumerations from "@filename@" */ -/*** END file-production ***/ - -/*** BEGIN value-header ***/ - -#define ERROR_PREFIX @ENUMNAME@_DBUS_PREFIX -static const GDBusErrorEntry @enum_name@_entries[] = { -/*** END value-header ***/ - -/*** BEGIN value-production ***/ - { @VALUENAME@, ERROR_PREFIX ".@valuenick@" }, -/*** END value-production ***/ - -/*** BEGIN value-tail ***/ -}; -#undef ERROR_PREFIX - -GQuark -@enum_name@_quark (void) -{ - static volatile gsize quark_volatile = 0; - - if (!quark_volatile) - g_dbus_error_register_error_domain ("@enum_name@_quark", - &quark_volatile, - @enum_name@_entries, - G_N_ELEMENTS (@enum_name@_entries)); - - return (GQuark) quark_volatile; -} - -/*** END value-tail ***/ - -/*** BEGIN file-tail ***/ -/*** END file-tail ***/ diff --git a/build-aux/mm-errors-quarks.c.template b/build-aux/mm-errors-quarks.c.template new file mode 100644 index 00000000..4386a601 --- /dev/null +++ b/build-aux/mm-errors-quarks.c.template @@ -0,0 +1,42 @@ +/*** BEGIN file-header ***/ + +#include + +/*** END file-header ***/ + +/*** BEGIN file-production ***/ +/* enumerations from "@filename@" */ +/*** END file-production ***/ + +/*** BEGIN value-header ***/ + +#define ERROR_PREFIX @ENUMNAME@_DBUS_PREFIX +static const GDBusErrorEntry @enum_name@_entries[] = { +/*** END value-header ***/ + +/*** BEGIN value-production ***/ + { @VALUENAME@, ERROR_PREFIX ".@valuenick@" }, +/*** END value-production ***/ + +/*** BEGIN value-tail ***/ +}; +#undef ERROR_PREFIX + +GQuark +@enum_name@_quark (void) +{ + static volatile gsize quark_volatile = 0; + + if (!quark_volatile) + g_dbus_error_register_error_domain ("@enum_name@_quark", + &quark_volatile, + @enum_name@_entries, + G_N_ELEMENTS (@enum_name@_entries)); + + return (GQuark) quark_volatile; +} + +/*** END value-tail ***/ + +/*** BEGIN file-tail ***/ +/*** END file-tail ***/ diff --git a/build-aux/mm-errors-template.c b/build-aux/mm-errors-template.c deleted file mode 100644 index 8370adf1..00000000 --- a/build-aux/mm-errors-template.c +++ /dev/null @@ -1,40 +0,0 @@ -/*** BEGIN file-header ***/ -/*** END file-header ***/ - -/*** BEGIN file-production ***/ -/* enumerations from "@filename@" */ -/*** END file-production ***/ - -/*** BEGIN value-header ***/ - -/* @enum_name@_quark() implemented in mm-errors-quarks.c */ - -GType -@enum_name@_get_type (void) -{ - static gsize g_define_type_id_initialized = 0; - - if (g_once_init_enter (&g_define_type_id_initialized)) - { - static const G@Type@Value values[] = { -/*** END value-header ***/ - -/*** BEGIN value-production ***/ - { @VALUENAME@, "@VALUENAME@", "@valuenick@" }, -/*** END value-production ***/ - -/*** BEGIN value-tail ***/ - { 0, NULL, NULL } - }; - GType g_define_type_id = - g_@type@_register_static (g_intern_static_string ("@EnumName@"), values); - g_once_init_leave (&g_define_type_id_initialized, g_define_type_id); - } - - return g_define_type_id_initialized; -} - -/*** END value-tail ***/ - -/*** BEGIN file-tail ***/ -/*** END file-tail ***/ diff --git a/build-aux/mm-errors-template.h b/build-aux/mm-errors-template.h deleted file mode 100644 index 72c90cf5..00000000 --- a/build-aux/mm-errors-template.h +++ /dev/null @@ -1,23 +0,0 @@ -/*** BEGIN file-header ***/ - -#include - -G_BEGIN_DECLS -/*** END file-header ***/ - -/*** BEGIN file-production ***/ - -/* enumerations from "@filename@" */ -/*** END file-production ***/ - -/*** BEGIN value-header ***/ -GQuark @enum_name@_quark (void); /* implemented in mm-errors-quarks.c */ -GType @enum_name@_get_type (void) G_GNUC_CONST; -#define @ENUMNAME@ (@enum_name@_quark ()) -#define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ()) -/*** END value-header ***/ - -/*** BEGIN file-tail ***/ -G_END_DECLS - -/*** END file-tail ***/ diff --git a/build-aux/mm-errors-types.c.template b/build-aux/mm-errors-types.c.template new file mode 100644 index 00000000..8370adf1 --- /dev/null +++ b/build-aux/mm-errors-types.c.template @@ -0,0 +1,40 @@ +/*** BEGIN file-header ***/ +/*** END file-header ***/ + +/*** BEGIN file-production ***/ +/* enumerations from "@filename@" */ +/*** END file-production ***/ + +/*** BEGIN value-header ***/ + +/* @enum_name@_quark() implemented in mm-errors-quarks.c */ + +GType +@enum_name@_get_type (void) +{ + static gsize g_define_type_id_initialized = 0; + + if (g_once_init_enter (&g_define_type_id_initialized)) + { + static const G@Type@Value values[] = { +/*** END value-header ***/ + +/*** BEGIN value-production ***/ + { @VALUENAME@, "@VALUENAME@", "@valuenick@" }, +/*** END value-production ***/ + +/*** BEGIN value-tail ***/ + { 0, NULL, NULL } + }; + GType g_define_type_id = + g_@type@_register_static (g_intern_static_string ("@EnumName@"), values); + g_once_init_leave (&g_define_type_id_initialized, g_define_type_id); + } + + return g_define_type_id_initialized; +} + +/*** END value-tail ***/ + +/*** BEGIN file-tail ***/ +/*** END file-tail ***/ diff --git a/build-aux/mm-errors-types.h.template b/build-aux/mm-errors-types.h.template new file mode 100644 index 00000000..72c90cf5 --- /dev/null +++ b/build-aux/mm-errors-types.h.template @@ -0,0 +1,23 @@ +/*** BEGIN file-header ***/ + +#include + +G_BEGIN_DECLS +/*** END file-header ***/ + +/*** BEGIN file-production ***/ + +/* enumerations from "@filename@" */ +/*** END file-production ***/ + +/*** BEGIN value-header ***/ +GQuark @enum_name@_quark (void); /* implemented in mm-errors-quarks.c */ +GType @enum_name@_get_type (void) G_GNUC_CONST; +#define @ENUMNAME@ (@enum_name@_quark ()) +#define @ENUMPREFIX@_TYPE_@ENUMSHORT@ (@enum_name@_get_type ()) +/*** END value-header ***/ + +/*** BEGIN file-tail ***/ +G_END_DECLS + +/*** END file-tail ***/ -- cgit v1.2.3-70-g09d2