1 /* GIMP - The GNU Image Manipulation Program
2  * Copyright (C) 1995 Spencer Kimball and Peter Mattis
3  *
4  * gimpasync.h
5  * Copyright (C) 2018 Ell
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __GIMP_ASYNC_H__
22 #define __GIMP_ASYNC_H__
23 
24 
25 #define GIMP_TYPE_ASYNC            (gimp_async_get_type ())
26 #define GIMP_ASYNC(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_ASYNC, GimpAsync))
27 #define GIMP_ASYNC_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_ASYNC, GimpAsyncClass))
28 #define GIMP_IS_ASYNC(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_ASYNC))
29 #define GIMP_IS_ASYNC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_ASYNC))
30 #define GIMP_ASYNC_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_ASYNC, GimpAsyncClass))
31 
32 
33 typedef void (* GimpAsyncCallback) (GimpAsync *async,
34                                     gpointer   data);
35 
36 
37 typedef struct _GimpAsyncPrivate GimpAsyncPrivate;
38 typedef struct _GimpAsyncClass   GimpAsyncClass;
39 
40 struct _GimpAsync
41 {
42   GObject           parent_instance;
43 
44   GimpAsyncPrivate *priv;
45 };
46 
47 struct _GimpAsyncClass
48 {
49   GObjectClass  parent_class;
50 
51   /*  signals  */
52   void   (* waiting) (GimpAsync *async);
53 };
54 
55 
56 GType       gimp_async_get_type                (void) G_GNUC_CONST;
57 
58 GimpAsync * gimp_async_new                     (void);
59 
60 gboolean    gimp_async_is_synced               (GimpAsync         *async);
61 
62 void        gimp_async_add_callback            (GimpAsync         *async,
63                                                 GimpAsyncCallback  callback,
64                                                 gpointer           data);
65 void        gimp_async_add_callback_for_object (GimpAsync         *async,
66                                                 GimpAsyncCallback  callback,
67                                                 gpointer           data,
68                                                 gpointer           gobject);
69 void        gimp_async_remove_callback         (GimpAsync         *async,
70                                                 GimpAsyncCallback  callback,
71                                                 gpointer           data);
72 
73 gboolean    gimp_async_is_stopped              (GimpAsync         *async);
74 
75 void        gimp_async_finish                  (GimpAsync         *async,
76                                                 gpointer           result);
77 void        gimp_async_finish_full             (GimpAsync         *async,
78                                                 gpointer           result,
79                                                 GDestroyNotify     result_destroy_func);
80 gboolean    gimp_async_is_finished             (GimpAsync         *async);
81 gpointer    gimp_async_get_result              (GimpAsync         *async);
82 
83 void        gimp_async_abort                   (GimpAsync         *async);
84 
85 gboolean    gimp_async_is_canceled             (GimpAsync         *async);
86 
87 void        gimp_async_cancel_and_wait         (GimpAsync         *async);
88 
89 
90 /*  stats  */
91 
92 gint        gimp_async_get_n_running           (void);
93 
94 
95 #endif /* __GIMP_ASYNC_H__ */
96