[PATCH wayland] Add a destroy signal to the wl_event_loop object.

[Kristian Høgsberg]

On Fri, Jan 11, 2013 at 09:01:47PM -0600, Jason Ekstrand wrote:
> Add a destroy signal to the wl_event_loop object.
> 
> ---
> Again, this helps me prevent memory leaks.
> 
> This time I used tabs ;-)

Applied, with just a couple of tweaks to the commit message:

 - subject line doesn't end with a '.'  We treat is as a title or
   section header as far as punctuation goes.

 - drop body if it's the same as commit header.  Ideally, describe the
   change in more detail as well as why we're doing it in the body.

It's all similar to what other git projects do (at least kernel, mesa,
X.org, gtk+).  I know I let your previous patch slip through :)

Kristian

>  src/event-loop.c        | 21 ++++++++++++++++++
>  src/wayland-server.h    |  6 ++++++
>  tests/event-loop-test.c | 57 +++++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 84 insertions(+)
> 
> diff --git a/src/event-loop.c b/src/event-loop.c
> index 8db9c7c..25e8f9c 100644
> --- a/src/event-loop.c
> +++ b/src/event-loop.c
> @@ -43,6 +43,8 @@ struct wl_event_loop {
>  	struct wl_list check_list;
>  	struct wl_list idle_list;
>  	struct wl_list destroy_list;
> +
> +	struct wl_signal destroy_signal;
>  };
>  
>  struct wl_event_source_interface {
> @@ -357,12 +359,16 @@ wl_event_loop_create(void)
>  	wl_list_init(&loop->idle_list);
>  	wl_list_init(&loop->destroy_list);
>  
> +	wl_signal_init(&loop->destroy_signal);
> +
>  	return loop;
>  }
>  
>  WL_EXPORT void
>  wl_event_loop_destroy(struct wl_event_loop *loop)
>  {
> +	wl_signal_emit(&loop->destroy_signal, loop);
> +
>  	wl_event_loop_process_destroy_list(loop);
>  	close(loop->epoll_fd);
>  	free(loop);
> @@ -429,3 +435,18 @@ wl_event_loop_get_fd(struct wl_event_loop *loop)
>  {
>  	return loop->epoll_fd;
>  }
> +
> +WL_EXPORT void
> +wl_event_loop_add_destroy_listener(struct wl_event_loop *loop,
> +				   struct wl_listener *listener)
> +{
> +	wl_signal_add(&loop->destroy_signal, listener);
> +}
> +
> +WL_EXPORT struct wl_listener *
> +wl_event_loop_get_destroy_listener(struct wl_event_loop *loop,
> +				   wl_notify_func_t notify)
> +{
> +	wl_signal_get(&loop->destroy_signal, notify);
> +}
> +
> diff --git a/src/wayland-server.h b/src/wayland-server.h
> index 9497fe0..e9db272 100644
> --- a/src/wayland-server.h
> +++ b/src/wayland-server.h
> @@ -84,6 +84,12 @@ struct wl_touch;
>  struct wl_listener;
>  typedef void (*wl_notify_func_t)(struct wl_listener *listener, void *data);
>  
> +void wl_event_loop_add_destroy_listener(struct wl_event_loop *loop,
> +					struct wl_listener * listener);
> +struct wl_listener *wl_event_loop_get_destroy_listener(
> +					struct wl_event_loop *loop,
> +					wl_notify_func_t notify);
> +
>  struct wl_display *wl_display_create(void);
>  void wl_display_destroy(struct wl_display *display);
>  struct wl_event_loop *wl_display_get_event_loop(struct wl_display *display);
> diff --git a/tests/event-loop-test.c b/tests/event-loop-test.c
> index e630cde..702b7b3 100644
> --- a/tests/event-loop-test.c
> +++ b/tests/event-loop-test.c
> @@ -1,5 +1,6 @@
>  /*
>   * Copyright © 2012 Intel Corporation
> + * Copyright © 2012 Jason Ekstrand
>   *
>   * Permission to use, copy, modify, distribute, and sell this software and its
>   * documentation for any purpose is hereby granted without fee, provided that
> @@ -25,6 +26,7 @@
>  #include <unistd.h>
>  #include <signal.h>
>  #include "wayland-server.h"
> +#include "wayland-private.h"
>  #include "test-runner.h"
>  
>  static int
> @@ -185,3 +187,58 @@ TEST(event_loop_timer)
>  	wl_event_source_remove(source);
>  	wl_event_loop_destroy(loop);
>  }
> +
> +struct event_loop_destroy_listener {
> +	struct wl_listener listener;
> +	int done;
> +};
> +
> +static void
> +event_loop_destroy_notify(struct wl_listener *l, void *data)
> +{
> +	struct event_loop_destroy_listener *listener =
> +		container_of(l, struct event_loop_destroy_listener, listener);
> +
> +	listener->done = 1;
> +}
> +
> +TEST(event_loop_destroy)
> +{
> +	struct wl_event_loop *loop;
> +	struct wl_display * display;
> +	struct event_loop_destroy_listener a, b;
> +
> +	loop = wl_event_loop_create();
> +	assert(loop);
> +
> +	a.listener.notify = &event_loop_destroy_notify;
> +	a.done = 0;
> +	wl_event_loop_add_destroy_listener(loop, &a.listener);
> +
> +	assert(wl_event_loop_get_destroy_listener(loop,
> +	       event_loop_destroy_notify) == &a.listener);
> +
> +	b.listener.notify = &event_loop_destroy_notify;
> +	b.done = 0;
> +	wl_event_loop_add_destroy_listener(loop, &b.listener);
> +
> +	wl_list_remove(&a.listener.link);
> +	wl_event_loop_destroy(loop);
> +
> +	assert(!a.done);
> +	assert(b.done);
> +
> +	/* Test to make sure it gets fired on display destruction */
> +	display = wl_display_create();
> +	assert(display);
> +	loop = wl_display_get_event_loop(display);
> +	assert(loop);
> +
> +	a.done = 0;
> +	wl_event_loop_add_destroy_listener(loop, &a.listener);
> +
> +	wl_display_destroy(display);
> +
> +	assert(a.done);
> +}
> +
> -- 
> 1.8.0.1
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel