summaryrefslogtreecommitdiff
path: root/src/lib/eldbus/eldbus_introspection.h
blob: 4fc297830d44c4feb1e23f49689ae7d78acd0c2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#ifndef _ELDBUS_INTROSPECTION_INTROSPECTION_H
#define _ELDBUS_INTROSPECTION_INTROSPECTION_H

#include <Eina.h>
#include <Eo.h>

#include "eldbus_types.eot.h"
#include "eldbus_model_arguments.eo.h"

// DTD conversion form: http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd

typedef struct _Eldbus_Introspection_Node Eldbus_Introspection_Node;
typedef struct _Eldbus_Introspection_Interface Eldbus_Introspection_Interface;
typedef struct _Eldbus_Introspection_Method Eldbus_Introspection_Method;
typedef struct _Eldbus_Introspection_Signal Eldbus_Introspection_Signal;
typedef struct _Eldbus_Introspection_Property Eldbus_Introspection_Property;
typedef struct _Eldbus_Introspection_Annotation Eldbus_Introspection_Annotation;

typedef enum
{
   ELDBUS_INTROSPECTION_PROPERTY_ACCESS_READ,
   ELDBUS_INTROSPECTION_PROPERTY_ACCESS_WRITE,
   ELDBUS_INTROSPECTION_PROPERTY_ACCESS_READWRITE,
} Eldbus_Introspection_Property_Access;

struct _Eldbus_Introspection_Node
{
   Eina_Stringshare *name; // optional
   Eina_List *nodes;
   Eina_List *interfaces;
};

struct _Eldbus_Introspection_Interface
{
   Eina_Stringshare *name;
   Eina_List *methods;
   Eina_List *signals;
   Eina_List *properties;
   Eina_List *annotations;
};

struct _Eldbus_Introspection_Method
{
   Eina_Stringshare *name;
   Eina_List *arguments;
   Eina_List *annotations;
};

struct _Eldbus_Introspection_Signal
{
   Eina_Stringshare *name;
   Eina_List *arguments;
   Eina_List *annotations;
};

struct _Eldbus_Introspection_Property
{
   Eina_Stringshare *name;
   Eina_Stringshare *type;
   Eldbus_Introspection_Property_Access access;
   Eina_List *annotations;
};

struct _Eldbus_Introspection_Annotation
{
   Eina_Stringshare *name;
   Eina_Stringshare *value;
};

/**
 * @brief Parses the introspection xml abstracting it to an object tree
 *
 * @param xml The introspection xml
 * @return The introspection object tree
 *
 * @since 1.17
 */
EAPI Eldbus_Introspection_Node *eldbus_introspection_parse(const char *xml);

/**
 * @brief Frees the introspection object tree
 *
 * @param node The root node of introspection tree
 *
 * @since 1.17
 */
EAPI void eldbus_introspection_node_free(Eldbus_Introspection_Node *node);

/**
 * @brief Finds an interface by name
 *
 * @param interfaces The list of interfaces of type @c Eldbus_Introspection_Interface
 * @param name The interfaces's name to search for
 * @return Returns the interface found or @c NULL if not
 *
 * @since 1.17
 */
EAPI Eldbus_Introspection_Interface *eldbus_introspection_interface_find(Eina_List *interfaces, const char *name);

/**
 * @brief Finds a property by name
 *
 * @param properties The list of properties of type @c Eldbus_Introspection_Property
 * @param name The properties's name to search for
 * @return Returns the property found or @c NULL if not
 *
 * @since 1.17
 */
EAPI Eldbus_Introspection_Property *eldbus_introspection_property_find(Eina_List *properties, const char *name);

/**
 * @brief Finds an argument by name
 *
 * @param arguments The list of arguments of type @c Eldbus_Introspection_Property
 * @param name The arguments's name to search for
 * @return Returns the argument found or @c NULL if not
 *
 * @since 1.17
 */
EAPI Eldbus_Introspection_Argument *eldbus_introspection_argument_find(Eina_List *arguments, const char *name);

#endif