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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/** Interface for DKArgument class for boxing and unboxing D-Bus types.
Copyright (C) 2010 Free Software Foundation, Inc.
Written by: Niels Grewe <niels.grewe@halbordnung.de>
Created: June 2010
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02111 USA.
<title>DKArgument class reference</title>
*/
#import "DKIntrospectionNode.h"
#include <dbus/dbus.h>
@class NSString, NSInvocation, NSMutableArray, DKProxy;
extern NSString *kDKArgumentDirectionIn;
extern NSString *kDKArgumentDirectionOut;
/**
* DKArgument encapsulates D-Bus argument information and handles
* serializing/unserializing to/from D-Bus to Objective-C.
*/
@interface DKArgument: DKIntrospectionNode
{
int DBusType;
Class objCEquivalent;
}
/**
* Registers the selector to be used for unboxing objects to specific
* D-Bus types. The method named by the selector may not take any arguments and
* its return value can not exceed 8 bytes.
*/
+ (void)registerUnboxingSelector: (SEL)selector
forDBusType: (int)type;
/**
* Initializes the argument with the single complete D-Bus type signature
* described by <var>characters</var>. Returns <code>nil</code> if the signature
* is malformed or does contain more than one complete signature.
*/
- (id) initWithDBusSignature: (const char*)characters
name: (NSString*)name
parent: (id)parent;
/**
* Return whether the argument is a complex one that is made up by further
* types.
*/
- (BOOL) isContainerType;
/**
* Return the type char to be used if the argument is not boxed to an
* Objective-C type.
*/
- (const char*) unboxedObjCTypeChar;
/**
* Return the size of the unboxed type.
*/
- (size_t) unboxedObjCTypeSize;
/**
* Return the class that will represent an argument of this type.
*/
- (Class) objCEquivalent;
/**
* Returns the D-Bus type of the argument.
*/
- (int) DBusType;
/**
* Return the D-Bus type signature equivalent to the argument.
*/
- (NSString*) DBusTypeSignature;
/**
* Tries to unbox the value into the buffer and returns YES if successful. Since
* libdbus makes guarantees that all primitive types will fit into 8 bytes of
* memory, the buffer can be statically sized to 64bit width. For string
* arguments, the address of the unboxed string is stored in the buffer.
*/
- (BOOL) unboxValue: (id)value
intoBuffer: (long long*)buffer;
/**
* Returns a boxed representation of the value in buffer according to the type
* of the DKArgument.
*/
- (id) boxedValueForValueAt: (void*)buffer;
/**
* Used unmarshalling D-Bus messages into NSInvocations. The index argument can
* indicate the return value if set to -1. This method does not advance the
* iterator.
*/
- (void) unmarshallFromIterator: (DBusMessageIter*)iter
intoInvocation: (NSInvocation*)inv
atIndex: (NSInteger)index
boxing: (BOOL)doBox;
/**
* Returns the boxed equivalent of the value at the iterator. This method does
* not advance the iterator.
*/
-(id) unmarshalledObjectFromIterator: (DBusMessageIter*)iter;
/**
* Returns a standin for a proxy for an object path argument. This method is
* only needed by the notification center.
*/
-(id) unmarshalledProxyStandinFromIterator: (DBusMessageIter*)iter;
/**
* Marshall a value from an NSInvocation into an D-Bus message iterator set up
* for writing. index indicates the index of the argument (in the invocation) to
* be marshalled into the D-Bus format (-1 indicates the return value).
*/
- (void) marshallArgumentAtIndex: (NSInteger)index
fromInvocation: (NSInvocation*)inv
intoIterator: (DBusMessageIter*)iter
boxing: (BOOL)doBox;
/**
* Unboxes the object into D-Bus format and appends it to a D-Bus message by
* means of the specified iterator.
*/
- (void) marshallObject: (id)object
intoIterator: (DBusMessageIter*)iter;
@end
/**
* Encapsulates arguments that have sub-types and may require more complex
* strategies to box and unbox.
*/
@interface DKContainerTypeArgument: DKArgument
{
NSMutableArray *children;
}
/**
* Return all sub-arguments that make up this argument.
*/
- (NSArray*) children;
@end;
|
