diff --git a/docs/reference/gobject/glib-mkenums.xml b/docs/reference/gobject/glib-mkenums.xml
index e1683860a..2200328ed 100644
--- a/docs/reference/gobject/glib-mkenums.xml
+++ b/docs/reference/gobject/glib-mkenums.xml
@@ -195,6 +195,14 @@ Specifies the word separation used in the *_get_type()
function. For instance, /*< underscore_name=gnome_vfs_uri_hide_options >*/.
+
+since
+
+Specifies the version tag that will be used to substitute the @enumsince@
+keyword in the template, useful when documenting methods generated from the enums
+(e.g. Since: @enumsince@). (Since: 2.66)
+
+
The following options can be specified per value definition:
@@ -219,7 +227,7 @@ typedef enum /*< skip >*/
{
PREFIX_FOO
} PrefixThisEnumWillBeSkipped;
-typedef enum /*< flags,prefix=PREFIX >*/
+typedef enum /*< flags,prefix=PREFIX,since=1.0 >*/
{
PREFIX_THE_ZEROTH_VALUE, /*< skip >*/
PREFIX_THE_FIRST_VALUE,
diff --git a/gobject/glib-mkenums.in b/gobject/glib-mkenums.in
index 91ad77942..a44efed19 100755
--- a/gobject/glib-mkenums.in
+++ b/gobject/glib-mkenums.in
@@ -130,6 +130,7 @@ option_lowercase_name = '' # DEPRECATED. A lower case name to use as part
# one that we guess. For instance, when an enum
# uses abnormal capitalization and we can not
# guess where to put the underscores.
+option_since = '' # User provided version info for the enum.
seenbitshift = 0 # Have we seen bitshift operators?
enum_prefix = None # Prefix for this enumeration
enumname = '' # Name for this enumeration
@@ -256,6 +257,7 @@ help_epilog = '''Production text substitutions:
\u0040ENUMNAME\u0040 PREFIX_THE_XENUM
\u0040ENUMSHORT\u0040 THE_XENUM
\u0040ENUMPREFIX\u0040 PREFIX
+ \u0040enumsince\u0040 the user-provided since value given
\u0040VALUENAME\u0040 PREFIX_THE_XVALUE
\u0040valuenick\u0040 the-xvalue
\u0040valuenum\u0040 the integer value (limited support, Since: 2.26)
@@ -515,11 +517,13 @@ def process_file(curfilename):
flags = int(flags)
option_lowercase_name = options.get('lowercase_name', None)
option_underscore_name = options.get('underscore_name', None)
+ option_since = options.get('since', None)
else:
enum_prefix = None
flags = None
option_lowercase_name = None
option_underscore_name = None
+ option_since = None
if option_lowercase_name is not None:
if option_underscore_name is not None:
@@ -620,6 +624,11 @@ def process_file(curfilename):
enumlong = enumname_prefix + "_" + enumshort
enumsym = enumlong.lower()
+ if option_since is not None:
+ enumsince = option_since
+ else:
+ enumsince = ""
+
if firstenum:
firstenum = False
@@ -641,6 +650,7 @@ def process_file(curfilename):
prod = prod.replace('\u0040ENUMSHORT\u0040', enumshort)
prod = prod.replace('\u0040ENUMNAME\u0040', enumlong)
prod = prod.replace('\u0040ENUMPREFIX\u0040', enumname_prefix)
+ prod = prod.replace('\u0040enumsince\u0040', enumsince)
if flags:
prod = prod.replace('\u0040type\u0040', 'flags')
else:
@@ -663,6 +673,7 @@ def process_file(curfilename):
prod = prod.replace('\u0040ENUMSHORT\u0040', enumshort)
prod = prod.replace('\u0040ENUMNAME\u0040', enumlong)
prod = prod.replace('\u0040ENUMPREFIX\u0040', enumname_prefix)
+ prod = prod.replace('\u0040enumsince\u0040', enumsince)
if flags:
prod = prod.replace('\u0040type\u0040', 'flags')
else:
@@ -729,6 +740,7 @@ def process_file(curfilename):
prod = prod.replace('\u0040ENUMSHORT\u0040', enumshort)
prod = prod.replace('\u0040ENUMNAME\u0040', enumlong)
prod = prod.replace('\u0040ENUMPREFIX\u0040', enumname_prefix)
+ prod = prod.replace('\u0040enumsince\u0040', enumsince)
if flags:
prod = prod.replace('\u0040type\u0040', 'flags')
else:
diff --git a/gobject/tests/mkenums.py b/gobject/tests/mkenums.py
index 5f28b9cc6..22a100505 100644
--- a/gobject/tests/mkenums.py
+++ b/gobject/tests/mkenums.py
@@ -153,6 +153,7 @@ enum_name: @enum_name@
ENUMNAME: @ENUMNAME@
ENUMSHORT: @ENUMSHORT@
ENUMPREFIX: @ENUMPREFIX@
+enumsince: @enumsince@
type: @type@
Type: @Type@
TYPE: @TYPE@
@@ -165,6 +166,7 @@ enum_name: @enum_name@
ENUMNAME: @ENUMNAME@
ENUMSHORT: @ENUMSHORT@
ENUMPREFIX: @ENUMPREFIX@
+enumsince: @enumsince@
type: @type@
Type: @Type@
TYPE: @TYPE@
@@ -187,6 +189,7 @@ enum_name: @enum_name@
ENUMNAME: @ENUMNAME@
ENUMSHORT: @ENUMSHORT@
ENUMPREFIX: @ENUMPREFIX@
+enumsince: @enumsince@
type: @type@
Type: @Type@
TYPE: @TYPE@
@@ -225,7 +228,7 @@ file-tail
def assertSingleEnum(self, result, enum_name_camel, enum_name_lower,
enum_name_upper, enum_name_short, enum_prefix,
- type_lower, type_camel, type_upper,
+ enum_since, type_lower, type_camel, type_upper,
value_name, value_nick, value_num):
"""Assert that out (from runMkenumsWithHeader()) contains a single
enum and value matching the given arguments."""
@@ -235,6 +238,7 @@ file-tail
'enum_name_upper': enum_name_upper,
'enum_name_short': enum_name_short,
'enum_prefix': enum_prefix,
+ 'enum_since': enum_since,
'type_lower': type_lower,
'type_camel': type_camel,
'type_upper': type_upper,
@@ -258,6 +262,7 @@ enum_name: {enum_name_lower}
ENUMNAME: {enum_name_upper}
ENUMSHORT: {enum_name_short}
ENUMPREFIX: {enum_prefix}
+enumsince: {enum_since}
type: {type_lower}
Type: {type_camel}
TYPE: {type_upper}
@@ -267,6 +272,7 @@ enum_name: {enum_name_lower}
ENUMNAME: {enum_name_upper}
ENUMSHORT: {enum_name_short}
ENUMPREFIX: {enum_prefix}
+enumsince: {enum_since}
type: {type_lower}
Type: {type_camel}
TYPE: {type_upper}
@@ -283,6 +289,7 @@ enum_name: {enum_name_lower}
ENUMNAME: {enum_name_upper}
ENUMSHORT: {enum_name_short}
ENUMPREFIX: {enum_prefix}
+enumsince: {enum_since}
type: {type_lower}
Type: {type_camel}
TYPE: {type_upper}
@@ -360,7 +367,7 @@ comment: {standard_bottom_comment}
self.assertEqual('', result.err)
self.assertSingleEnum(result, 'SomeEnumIdentifier',
'some_enum_identifier', 'SOME_ENUM_IDENTIFIER',
- 'ENUM_IDENTIFIER', 'SOME', 'enum', 'Enum',
+ 'ENUM_IDENTIFIER', 'SOME', '', 'enum', 'Enum',
'ENUM', 'ENUM_VALUE', 'value', '0')
def test_non_utf8_encoding(self):
@@ -375,7 +382,7 @@ comment: {standard_bottom_comment}
self.assertIn('WARNING: UnicodeWarning: ', result.err)
self.assertSingleEnum(result, 'SomeEnumIdentifier',
'some_enum_identifier', 'SOME_ENUM_IDENTIFIER',
- 'ENUM_IDENTIFIER', 'SOME', 'enum', 'Enum',
+ 'ENUM_IDENTIFIER', 'SOME', '', 'enum', 'Enum',
'ENUM', 'ENUM_VALUE', 'value', '0')
def test_reproducible(self):
@@ -430,7 +437,7 @@ comment: {standard_bottom_comment}
self.assertEqual('', result.err)
self.assertSingleEnum(result, 'GeglSamplerType',
'gegl_sampler_type', 'GEGL_SAMPLER_TYPE',
- 'SAMPLER_TYPE', 'GEGL', 'enum', 'Enum',
+ 'SAMPLER_TYPE', 'GEGL', '', 'enum', 'Enum',
'ENUM', 'GEGL_SAMPLER_NEAREST', 'nearest', '0')
def test_filename_basename_in_fhead_ftail(self):
@@ -477,6 +484,20 @@ comment
comment: {standard_bottom_comment}
'''.format(**result.subs).strip(), result.out)
+ def test_since(self):
+ """Test user-provided 'since' version handling
+ https://gitlab.gnome.org/GNOME/glib/-/merge_requests/1492"""
+ h_contents = '''
+ typedef enum { /*< since=1.0 >*/
+ QMI_WMS_MESSAGE_PROTOCOL_CDMA = 0,
+ } QmiWmsMessageProtocol;
+ '''
+ result = self.runMkenumsWithHeader(h_contents)
+ self.assertEqual('', result.err)
+ self.assertSingleEnum(result, 'QmiWmsMessageProtocol',
+ 'qmi_wms_message_protocol', 'QMI_WMS_MESSAGE_PROTOCOL',
+ 'WMS_MESSAGE_PROTOCOL', 'QMI', '1.0', 'enum', 'Enum',
+ 'ENUM', 'QMI_WMS_MESSAGE_PROTOCOL_CDMA', 'cdma', '0')
class TestRspMkenums(TestMkenums):
'''Run all tests again in @rspfile mode'''