From 74ee8905bb19d2811ddaa373f293a092acb33fa1 Mon Sep 17 00:00:00 2001 From: Rico Tzschichholz Date: Wed, 28 Jun 2023 16:44:47 +0200 Subject: [PATCH] codegen: Improve handling of sealed classes Avoid redundant declarations and make *_get_type() show up in public header Fixes https://gitlab.gnome.org/GNOME/vala/issues/1451 --- codegen/valagtypemodule.vala | 45 +-- tests/Makefile.am | 2 + tests/headers/sealed-class.c-expected | 375 +++++++++++++++++++++++ tests/headers/sealed-class.h-expected | 68 ++++ tests/headers/sealed-class.vala | 16 + tests/headers/tests-extra-environment.sh | 1 + 6 files changed, 486 insertions(+), 21 deletions(-) create mode 100644 tests/headers/sealed-class.c-expected create mode 100644 tests/headers/sealed-class.h-expected create mode 100644 tests/headers/sealed-class.vala create mode 100644 tests/headers/tests-extra-environment.sh diff --git a/codegen/valagtypemodule.vala b/codegen/valagtypemodule.vala index 8d4966f05..ec103d2f4 100644 --- a/codegen/valagtypemodule.vala +++ b/codegen/valagtypemodule.vala @@ -64,37 +64,35 @@ public class Vala.GTypeModule : GErrorModule { generate_class_declaration (cl.base_class, decl_space); } + bool final_not_public = (cl.is_opaque || cl.is_sealed) && context.header_filename != null && decl_space.file_type != CCodeFileType.PUBLIC_HEADER; bool is_gtypeinstance = !cl.is_compact; bool is_fundamental = is_gtypeinstance && cl.base_class == null; bool is_gsource = cl.is_subtype_of (gsource_type); - if (is_gtypeinstance) { + if (final_not_public) { + // nothing to do + } else if (is_gtypeinstance) { decl_space.add_include ("glib-object.h"); decl_space.add_type_declaration (new CCodeNewline ()); + var macro = "(%s_get_type ())".printf (get_ccode_lower_case_name (cl, null)); decl_space.add_type_declaration (new CCodeMacroReplacement (get_ccode_type_id (cl), macro)); macro = "(G_TYPE_CHECK_INSTANCE_CAST ((obj), %s, %s))".printf (get_ccode_type_id (cl), get_ccode_name (cl)); decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(obj)".printf (get_ccode_type_cast_function (cl)), macro)); - if (!(cl.is_sealed && decl_space.file_type == CCodeFileType.PUBLIC_HEADER)) { - macro = "(G_TYPE_CHECK_CLASS_CAST ((klass), %s, %s))".printf (get_ccode_type_id (cl), get_ccode_type_name (cl)); - decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(klass)".printf (get_ccode_class_type_function (cl)), macro)); - } + macro = "(G_TYPE_CHECK_CLASS_CAST ((klass), %s, %s))".printf (get_ccode_type_id (cl), get_ccode_type_name (cl)); + decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(klass)".printf (get_ccode_class_type_function (cl)), macro)); macro = "(G_TYPE_CHECK_INSTANCE_TYPE ((obj), %s))".printf (get_ccode_type_id (cl)); decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(obj)".printf (get_ccode_type_check_function (cl)), macro)); - if (!(cl.is_sealed && decl_space.file_type == CCodeFileType.PUBLIC_HEADER)) { - macro = "(G_TYPE_CHECK_CLASS_TYPE ((klass), %s))".printf (get_ccode_type_id (cl)); - decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(klass)".printf (get_ccode_class_type_check_function (cl)), macro)); - } + macro = "(G_TYPE_CHECK_CLASS_TYPE ((klass), %s))".printf (get_ccode_type_id (cl)); + decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(klass)".printf (get_ccode_class_type_check_function (cl)), macro)); - if (!(cl.is_sealed && decl_space.file_type == CCodeFileType.PUBLIC_HEADER)) { - macro = "(G_TYPE_INSTANCE_GET_CLASS ((obj), %s, %s))".printf (get_ccode_type_id (cl), get_ccode_type_name (cl)); - decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(obj)".printf (get_ccode_type_get_function (cl)), macro)); - } + macro = "(G_TYPE_INSTANCE_GET_CLASS ((obj), %s, %s))".printf (get_ccode_type_id (cl), get_ccode_type_name (cl)); + decl_space.add_type_declaration (new CCodeMacroReplacement ("%s(obj)".printf (get_ccode_type_get_function (cl)), macro)); decl_space.add_type_declaration (new CCodeNewline ()); } @@ -104,7 +102,9 @@ public class Vala.GTypeModule : GErrorModule { decl_space.add_type_declaration (new CCodeTypeDefinition ("struct _%s".printf (get_ccode_name (cl)), new CCodeVariableDeclarator (get_ccode_name (cl)))); } - if (is_fundamental) { + if (final_not_public) { + // nothing to do + } else if (is_fundamental) { var ref_fun = new CCodeFunction (get_ccode_ref_function (cl), "gpointer"); var unref_fun = new CCodeFunction (get_ccode_unref_function (cl), "void"); if (cl.is_private_symbol ()) { @@ -211,16 +211,23 @@ public class Vala.GTypeModule : GErrorModule { } } - if (is_gtypeinstance && !(cl.is_sealed && decl_space.file_type == CCodeFileType.PUBLIC_HEADER)) { + if (is_gtypeinstance) { decl_space.add_type_declaration (new CCodeTypeDefinition ("struct _%s".printf (get_ccode_type_name (cl)), new CCodeVariableDeclarator (get_ccode_type_name (cl)))); var type_fun = new ClassRegisterFunction (cl); type_fun.init_from_type (context, in_plugin, true); - decl_space.add_type_member_declaration (type_fun.get_declaration ()); + if (!final_not_public) { + decl_space.add_type_member_declaration (type_fun.get_declaration ()); + } requires_vala_extern = true; } + if (final_not_public) { + // nothing to do + return; + } + var base_class = cl; while (base_class.base_class != null) { base_class = base_class.base_class; @@ -266,10 +273,6 @@ public class Vala.GTypeModule : GErrorModule { generate_class_declaration (cl, decl_space); - if (cl.is_sealed && decl_space.file_type == CCodeFileType.PUBLIC_HEADER) { - return; - } - bool is_gtypeinstance = !cl.is_compact; bool is_fundamental = is_gtypeinstance && cl.base_class == null; @@ -673,7 +676,7 @@ public class Vala.GTypeModule : GErrorModule { } if (!cl.is_internal_symbol () || cl.is_sealed) { - if (!cl.is_opaque) { + if (!cl.is_opaque && !cl.is_sealed) { generate_class_struct_declaration (cl, header_file); } else { generate_class_declaration (cl, header_file); diff --git a/tests/Makefile.am b/tests/Makefile.am index c141df47c..433ad35fc 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -707,6 +707,7 @@ TESTS = \ objects/with-nested-method.vala \ objects/with-nested-signal.vala \ objects/with-nested-unambigous-signal.vala \ + headers/sealed-class.vala \ errors/catch-error-code.vala \ errors/catch-in-finally.vala \ errors/catch-no-error-type.test \ @@ -1504,6 +1505,7 @@ EXTRA_DIST = \ girwriter/tests-extra-environment.sh \ girwriter/combined.vapi \ gtktemplate/tests-extra-environment.sh \ + headers/tests-extra-environment.sh \ parser-keep-going/tests-extra-environment.sh \ linux/tests-extra-environment.sh \ nullability/tests-extra-environment.sh \ diff --git a/tests/headers/sealed-class.c-expected b/tests/headers/sealed-class.c-expected new file mode 100644 index 000000000..579a68cdf --- /dev/null +++ b/tests/headers/sealed-class.c-expected @@ -0,0 +1,375 @@ +/* headers_sealed_class.c generated by valac, the Vala compiler + * generated from headers_sealed_class.vala, do not modify */ + +#include "test.h" +#include +#include +#include + +typedef struct _Foo Foo; +typedef struct _FooClass FooClass; +typedef struct _FooPrivate FooPrivate; +typedef struct _ParamSpecFoo ParamSpecFoo; +typedef struct _Bar Bar; +typedef struct _BarClass BarClass; +typedef struct _BarPrivate BarPrivate; +enum { + BAR_0_PROPERTY, + BAR_NUM_PROPERTIES +}; +static GParamSpec* bar_properties[BAR_NUM_PROPERTIES]; + +struct _Foo { + GTypeInstance parent_instance; + volatile int ref_count; + FooPrivate * priv; +}; + +struct _FooClass { + GTypeClass parent_class; + void (*finalize) (Foo *self); + void (*minim) (Foo* self); +}; + +struct _ParamSpecFoo { + GParamSpec parent_instance; +}; + +struct _Bar { + GObject parent_instance; + BarPrivate * priv; +}; + +struct _BarClass { + GObjectClass parent_class; + void (*minim) (Bar* self); +}; + +static gpointer foo_parent_class = NULL; +static gpointer bar_parent_class = NULL; + +static void foo_real_minim (Foo* self); +static void foo_finalize (Foo * obj); +static GType foo_get_type_once (void); +static void bar_real_minim (Bar* self); +static GType bar_get_type_once (void); +static void _vala_main (void); + +static void +foo_real_minim (Foo* self) +{ +} + +void +foo_minim (Foo* self) +{ + FooClass* _klass_; + g_return_if_fail (IS_FOO (self)); + _klass_ = FOO_GET_CLASS (self); + if (_klass_->minim) { + _klass_->minim (self); + } +} + +void +foo_manam (FooClass* klass) +{ +} + +Foo* +foo_construct (GType object_type) +{ + Foo* self = NULL; + self = (Foo*) g_type_create_instance (object_type); + return self; +} + +Foo* +foo_new (void) +{ + return foo_construct (TYPE_FOO); +} + +static void +value_foo_init (GValue* value) +{ + value->data[0].v_pointer = NULL; +} + +static void +value_foo_free_value (GValue* value) +{ + if (value->data[0].v_pointer) { + foo_unref (value->data[0].v_pointer); + } +} + +static void +value_foo_copy_value (const GValue* src_value, + GValue* dest_value) +{ + if (src_value->data[0].v_pointer) { + dest_value->data[0].v_pointer = foo_ref (src_value->data[0].v_pointer); + } else { + dest_value->data[0].v_pointer = NULL; + } +} + +static gpointer +value_foo_peek_pointer (const GValue* value) +{ + return value->data[0].v_pointer; +} + +static gchar* +value_foo_collect_value (GValue* value, + guint n_collect_values, + GTypeCValue* collect_values, + guint collect_flags) +{ + if (collect_values[0].v_pointer) { + Foo * object; + object = collect_values[0].v_pointer; + if (object->parent_instance.g_class == NULL) { + return g_strconcat ("invalid unclassed object pointer for value type `", G_VALUE_TYPE_NAME (value), "'", NULL); + } else if (!g_value_type_compatible (G_TYPE_FROM_INSTANCE (object), G_VALUE_TYPE (value))) { + return g_strconcat ("invalid object type `", g_type_name (G_TYPE_FROM_INSTANCE (object)), "' for value type `", G_VALUE_TYPE_NAME (value), "'", NULL); + } + value->data[0].v_pointer = foo_ref (object); + } else { + value->data[0].v_pointer = NULL; + } + return NULL; +} + +static gchar* +value_foo_lcopy_value (const GValue* value, + guint n_collect_values, + GTypeCValue* collect_values, + guint collect_flags) +{ + Foo ** object_p; + object_p = collect_values[0].v_pointer; + if (!object_p) { + return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value)); + } + if (!value->data[0].v_pointer) { + *object_p = NULL; + } else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) { + *object_p = value->data[0].v_pointer; + } else { + *object_p = foo_ref (value->data[0].v_pointer); + } + return NULL; +} + +GParamSpec* +param_spec_foo (const gchar* name, + const gchar* nick, + const gchar* blurb, + GType object_type, + GParamFlags flags) +{ + ParamSpecFoo* spec; + g_return_val_if_fail (g_type_is_a (object_type, TYPE_FOO), NULL); + spec = g_param_spec_internal (G_TYPE_PARAM_OBJECT, name, nick, blurb, flags); + G_PARAM_SPEC (spec)->value_type = object_type; + return G_PARAM_SPEC (spec); +} + +gpointer +value_get_foo (const GValue* value) +{ + g_return_val_if_fail (G_TYPE_CHECK_VALUE_TYPE (value, TYPE_FOO), NULL); + return value->data[0].v_pointer; +} + +void +value_set_foo (GValue* value, + gpointer v_object) +{ + Foo * old; + g_return_if_fail (G_TYPE_CHECK_VALUE_TYPE (value, TYPE_FOO)); + old = value->data[0].v_pointer; + if (v_object) { + g_return_if_fail (G_TYPE_CHECK_INSTANCE_TYPE (v_object, TYPE_FOO)); + g_return_if_fail (g_value_type_compatible (G_TYPE_FROM_INSTANCE (v_object), G_VALUE_TYPE (value))); + value->data[0].v_pointer = v_object; + foo_ref (value->data[0].v_pointer); + } else { + value->data[0].v_pointer = NULL; + } + if (old) { + foo_unref (old); + } +} + +void +value_take_foo (GValue* value, + gpointer v_object) +{ + Foo * old; + g_return_if_fail (G_TYPE_CHECK_VALUE_TYPE (value, TYPE_FOO)); + old = value->data[0].v_pointer; + if (v_object) { + g_return_if_fail (G_TYPE_CHECK_INSTANCE_TYPE (v_object, TYPE_FOO)); + g_return_if_fail (g_value_type_compatible (G_TYPE_FROM_INSTANCE (v_object), G_VALUE_TYPE (value))); + value->data[0].v_pointer = v_object; + } else { + value->data[0].v_pointer = NULL; + } + if (old) { + foo_unref (old); + } +} + +static void +foo_class_init (FooClass * klass, + gpointer klass_data) +{ + foo_parent_class = g_type_class_peek_parent (klass); + ((FooClass *) klass)->finalize = foo_finalize; + ((FooClass *) klass)->minim = (void (*) (Foo*)) foo_real_minim; +} + +static void +foo_instance_init (Foo * self, + gpointer klass) +{ + self->ref_count = 1; +} + +static void +foo_finalize (Foo * obj) +{ + Foo * self; + self = G_TYPE_CHECK_INSTANCE_CAST (obj, TYPE_FOO, Foo); + g_signal_handlers_destroy (self); +} + +static GType +foo_get_type_once (void) +{ + static const GTypeValueTable g_define_type_value_table = { value_foo_init, value_foo_free_value, value_foo_copy_value, value_foo_peek_pointer, "p", value_foo_collect_value, "p", value_foo_lcopy_value }; + static const GTypeInfo g_define_type_info = { sizeof (FooClass), (GBaseInitFunc) NULL, (GBaseFinalizeFunc) NULL, (GClassInitFunc) foo_class_init, (GClassFinalizeFunc) NULL, NULL, sizeof (Foo), 0, (GInstanceInitFunc) foo_instance_init, &g_define_type_value_table }; + static const GTypeFundamentalInfo g_define_type_fundamental_info = { (G_TYPE_FLAG_CLASSED | G_TYPE_FLAG_INSTANTIATABLE | G_TYPE_FLAG_DERIVABLE | G_TYPE_FLAG_DEEP_DERIVABLE) }; + GType foo_type_id; + foo_type_id = g_type_register_fundamental (g_type_fundamental_next (), "Foo", &g_define_type_info, &g_define_type_fundamental_info, 0); + return foo_type_id; +} + +GType +foo_get_type (void) +{ + static volatile gsize foo_type_id__once = 0; + if (g_once_init_enter (&foo_type_id__once)) { + GType foo_type_id; + foo_type_id = foo_get_type_once (); + g_once_init_leave (&foo_type_id__once, foo_type_id); + } + return foo_type_id__once; +} + +gpointer +foo_ref (gpointer instance) +{ + Foo * self; + self = instance; + g_atomic_int_inc (&self->ref_count); + return instance; +} + +void +foo_unref (gpointer instance) +{ + Foo * self; + self = instance; + if (g_atomic_int_dec_and_test (&self->ref_count)) { + FOO_GET_CLASS (self)->finalize (self); + g_type_free_instance ((GTypeInstance *) self); + } +} + +static void +bar_real_minim (Bar* self) +{ +} + +void +bar_minim (Bar* self) +{ + BarClass* _klass_; + g_return_if_fail (IS_BAR (self)); + _klass_ = BAR_GET_CLASS (self); + if (_klass_->minim) { + _klass_->minim (self); + } +} + +void +bar_manam (BarClass* klass) +{ +} + +Bar* +bar_construct (GType object_type) +{ + Bar * self = NULL; + self = (Bar*) g_object_new (object_type, NULL); + return self; +} + +Bar* +bar_new (void) +{ + return bar_construct (TYPE_BAR); +} + +static void +bar_class_init (BarClass * klass, + gpointer klass_data) +{ + bar_parent_class = g_type_class_peek_parent (klass); + ((BarClass *) klass)->minim = (void (*) (Bar*)) bar_real_minim; +} + +static void +bar_instance_init (Bar * self, + gpointer klass) +{ +} + +static GType +bar_get_type_once (void) +{ + static const GTypeInfo g_define_type_info = { sizeof (BarClass), (GBaseInitFunc) NULL, (GBaseFinalizeFunc) NULL, (GClassInitFunc) bar_class_init, (GClassFinalizeFunc) NULL, NULL, sizeof (Bar), 0, (GInstanceInitFunc) bar_instance_init, NULL }; + GType bar_type_id; + bar_type_id = g_type_register_static (G_TYPE_OBJECT, "Bar", &g_define_type_info, 0); + return bar_type_id; +} + +GType +bar_get_type (void) +{ + static volatile gsize bar_type_id__once = 0; + if (g_once_init_enter (&bar_type_id__once)) { + GType bar_type_id; + bar_type_id = bar_get_type_once (); + g_once_init_leave (&bar_type_id__once, bar_type_id); + } + return bar_type_id__once; +} + +static void +_vala_main (void) +{ +} + +int +main (int argc, + char ** argv) +{ + _vala_main (); + return 0; +} + diff --git a/tests/headers/sealed-class.h-expected b/tests/headers/sealed-class.h-expected new file mode 100644 index 000000000..f798e069f --- /dev/null +++ b/tests/headers/sealed-class.h-expected @@ -0,0 +1,68 @@ +/* test.h generated by valac, the Vala compiler, do not modify */ + +#ifndef __TEST_H__ +#define __TEST_H__ + +#include +#include + +G_BEGIN_DECLS + +#if !defined(VALA_EXTERN) +#if defined(_WIN32) || defined(__CYGWIN__) +#define VALA_EXTERN __declspec(dllexport) extern +#elif __GNUC__ >= 4 +#define VALA_EXTERN __attribute__((visibility("default"))) extern +#else +#define VALA_EXTERN extern +#endif +#endif + +#define TYPE_FOO (foo_get_type ()) +#define FOO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TYPE_FOO, Foo)) +#define FOO_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_FOO, FooClass)) +#define IS_FOO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TYPE_FOO)) +#define IS_FOO_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TYPE_FOO)) +#define FOO_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TYPE_FOO, FooClass)) + +typedef struct _Foo Foo; +typedef struct _FooClass FooClass; + +#define TYPE_BAR (bar_get_type ()) +#define BAR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TYPE_BAR, Bar)) +#define BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_BAR, BarClass)) +#define IS_BAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TYPE_BAR)) +#define IS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TYPE_BAR)) +#define BAR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TYPE_BAR, BarClass)) + +typedef struct _Bar Bar; +typedef struct _BarClass BarClass; + +VALA_EXTERN gpointer foo_ref (gpointer instance); +VALA_EXTERN void foo_unref (gpointer instance); +VALA_EXTERN GParamSpec* param_spec_foo (const gchar* name, + const gchar* nick, + const gchar* blurb, + GType object_type, + GParamFlags flags); +VALA_EXTERN void value_set_foo (GValue* value, + gpointer v_object); +VALA_EXTERN void value_take_foo (GValue* value, + gpointer v_object); +VALA_EXTERN gpointer value_get_foo (const GValue* value); +VALA_EXTERN GType foo_get_type (void) G_GNUC_CONST ; +G_DEFINE_AUTOPTR_CLEANUP_FUNC (Foo, foo_unref) +VALA_EXTERN void foo_minim (Foo* self); +VALA_EXTERN void foo_manam (FooClass* klass); +VALA_EXTERN Foo* foo_new (void); +VALA_EXTERN Foo* foo_construct (GType object_type); +VALA_EXTERN GType bar_get_type (void) G_GNUC_CONST ; +G_DEFINE_AUTOPTR_CLEANUP_FUNC (Bar, g_object_unref) +VALA_EXTERN void bar_minim (Bar* self); +VALA_EXTERN void bar_manam (BarClass* klass); +VALA_EXTERN Bar* bar_new (void); +VALA_EXTERN Bar* bar_construct (GType object_type); + +G_END_DECLS + +#endif diff --git a/tests/headers/sealed-class.vala b/tests/headers/sealed-class.vala new file mode 100644 index 000000000..254f33d4e --- /dev/null +++ b/tests/headers/sealed-class.vala @@ -0,0 +1,16 @@ +public sealed class Foo { + public virtual void minim () { + } + public class void manam () { + } +} + +public sealed class Bar : Object { + public virtual void minim () { + } + public class void manam () { + } +} + +void main () { +} diff --git a/tests/headers/tests-extra-environment.sh b/tests/headers/tests-extra-environment.sh new file mode 100644 index 000000000..405bfd4b9 --- /dev/null +++ b/tests/headers/tests-extra-environment.sh @@ -0,0 +1 @@ +VALAFLAGS="--header test.h" -- 2.47.2