1 /* GSequencer - Advanced GTK Sequencer
2  * Copyright (C) 2005-2019 Joël Krähemann
3  *
4  * This file is part of GSequencer.
5  *
6  * GSequencer is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GSequencer is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with GSequencer.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef __AGS_CONNECTABLE_H__
21 #define __AGS_CONNECTABLE_H__
22 
23 #include <glib.h>
24 #include <glib-object.h>
25 
26 #include <libxml/tree.h>
27 
28 #include <ags/lib/ags_uuid.h>
29 
30 G_BEGIN_DECLS
31 
32 #define AGS_TYPE_CONNECTABLE                    (ags_connectable_get_type())
33 #define AGS_CONNECTABLE(obj)                    (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_CONNECTABLE, AgsConnectable))
34 #define AGS_CONNECTABLE_INTERFACE(vtable)       (G_TYPE_CHECK_CLASS_CAST((vtable), AGS_TYPE_CONNECTABLE, AgsConnectableInterface))
35 #define AGS_IS_CONNECTABLE(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_CONNECTABLE))
36 #define AGS_IS_CONNECTABLE_INTERFACE(vtable)    (G_TYPE_CHECK_CLASS_TYPE((vtable), AGS_TYPE_CONNECTABLE))
37 #define AGS_CONNECTABLE_GET_INTERFACE(obj)      (G_TYPE_INSTANCE_GET_INTERFACE((obj), AGS_TYPE_CONNECTABLE, AgsConnectableInterface))
38 
39 typedef struct _AgsConnectable AgsConnectable;
40 typedef struct _AgsConnectableInterface AgsConnectableInterface;
41 
42 struct _AgsConnectableInterface
43 {
44   GTypeInterface ginterface;
45 
46   AgsUUID* (*get_uuid)(AgsConnectable *connectable);
47   gboolean (*has_resource)(AgsConnectable *connectable);
48 
49   gboolean (*is_ready)(AgsConnectable *connectable);
50   void (*add_to_registry)(AgsConnectable *connectable);
51   void (*remove_from_registry)(AgsConnectable *connectable);
52 
53   xmlNode* (*list_resource)(AgsConnectable *connectable);
54 
55   xmlNode* (*xml_compose)(AgsConnectable *connectable);
56   void (*xml_parse)(AgsConnectable *connectable,
57 		    xmlNode *node);
58 
59   gboolean (*is_connected)(AgsConnectable *connectable);
60   void (*connect)(AgsConnectable *connectable);
61   void (*disconnect)(AgsConnectable *connectable);
62 
63   void (*connect_connection)(AgsConnectable *connectable,
64 			     GObject *connection);
65   void (*disconnect_connection)(AgsConnectable *connectable,
66 				GObject *connection);
67 };
68 
69 GType ags_connectable_get_type();
70 
71 AgsUUID* ags_connectable_get_uuid(AgsConnectable *connectable);
72 gboolean ags_connectable_has_resource(AgsConnectable *connectable);
73 
74 gboolean ags_connectable_is_ready(AgsConnectable *connectable);
75 void ags_connectable_add_to_registry(AgsConnectable *connectable);
76 void ags_connectable_remove_from_registry(AgsConnectable *connectable);
77 
78 xmlNode* ags_connectable_list_resource(AgsConnectable *connectable);
79 
80 xmlNode* ags_connectable_xml_compose(AgsConnectable *connectable);
81 void ags_connectable_xml_parse(AgsConnectable *connectable,
82 			       xmlNode *node);
83 
84 gboolean ags_connectable_is_connected(AgsConnectable *connectable);
85 void ags_connectable_connect(AgsConnectable *connectable);
86 void ags_connectable_disconnect(AgsConnectable *connectable);
87 
88 void ags_connectable_connect_connection(AgsConnectable *connectable,
89 					GObject *connection);
90 void ags_connectable_disconnect_connection(AgsConnectable *connectable,
91 					   GObject *connection);
92 
93 G_END_DECLS
94 
95 #endif /*__AGS_CONNECTABLE_H__*/
96