sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

gir: Correct usage of the closure annotation

Browse source 
Quoting Ebassi https://www.bassi.io/articles/2023/02/20/bindable-api-2023/:

    Whenever you’re describing a function that takes a callback, you
    should always annotate the callback argument with the argument that
    contains the user data using the (closure argument) annotation

    You should not annotate the data argument with a unary (closure).

    The unary (closure) is meant to be used when annotating the callback
    type

Recently gobject-introspection became a bit more strict with this and
that generated some warnings:

    Warning: Cogl: invalid "closure" annotation: only valid on callback
    parameters

This commit fix all the closure annotations.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/4058>
This commit is contained in:
Sebastian Wick 2024-10-01 15:39:18 +02:00
parent b218fc5b7f
commit 077eb80a8d
5 changed files with 14 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
clutter/clutter/clutter-actor.c
View file

@ -11013,8 +11013,8 @@ typedef enum
* @self: a #ClutterActor
* @child: a #ClutterActor
* @flags: control flags for actions
* @add_func: delegate function
* @data: (closure): data to pass to @add_func
* @add_func (closure data): delegate function
* @data: data to pass to @add_func
*
* Adds @child to the list of children of @self.
*

5
clutter/clutter/clutter-timeline.c
View file

@ -2202,8 +2202,9 @@ clutter_timeline_get_repeat_count (ClutterTimeline *timeline)
/**
* clutter_timeline_set_progress_func:
* @timeline: a #ClutterTimeline
* @func: (scope notified) (allow-none): a progress function, or %NULL
* @data: (closure): data to pass to @func
* @func: (scope notified) (allow-none) (closure data): a progress function,
* or %NULL
* @data: data to pass to @func
* @notify: a function to be called when the progress function is removed
* or the timeline is disposed
*

5
cogl/cogl/cogl-onscreen.h
View file

@ -348,8 +348,9 @@ GType cogl_frame_closure_get_type (void);
/**
* cogl_onscreen_add_frame_callback:
* @onscreen: A #CoglOnscreen framebuffer
* @callback: (scope notified): A callback function to call for frame events
* @user_data: (closure): A private pointer to be passed to @callback
* @callback: (scope notified) (closure user_data): A callback function
* to call for frame events
* @user_data: A private pointer to be passed to @callback
* @destroy: (allow-none): An optional callback to destroy @user_data
* when the @callback is removed or @onscreen is freed.
*

7
cogl/cogl/cogl-pipeline.h
View file

@ -122,10 +122,9 @@ typedef gboolean (*CoglPipelineLayerCallback) (CoglPipeline *pipeline,
/**
* cogl_pipeline_foreach_layer:
* @pipeline: A #CoglPipeline object
* @callback: (scope call): A #CoglPipelineLayerCallback to be
* called for each layer index
* @user_data: (closure): Private data that will be passed to the
* callback
* @callback: (scope call) (closure user_data): A #CoglPipelineLayerCallback
* to be called for each layer index
* @user_data: Private data that will be passed to the callback
*
* Iterates all the layer indices of the given @pipeline.
*/

5
src/tests/clutter-test-utils.c
View file

@ -219,8 +219,9 @@ clutter_test_add_data (const char *test_path,
/**
* clutter_test_add_data_full:
* @test_path: unique path for identifying the test
* @test_func: (scope notified): function containing the test
* @test_data: (closure): data to pass to the test function
* @test_func: (scope notified) (closure test_data): function
* containing the test
* @test_data: data to pass to the test function
* @test_notify: function called when the test function ends
*
* Adds a test unit to the Clutter test environment.