File: DKInterface.h

package info (click to toggle)
dbuskit 0.1.1-14
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,956 kB
  • sloc: objc: 10,543; sh: 9,463; ansic: 200; makefile: 32
file content (137 lines) | stat: -rw-r--r-- 3,792 bytes parent folder | download | duplicates (4)
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
/** Interface for DKInterface class encapsulating D-Bus interface information.
   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>DKMethod class reference</title>
   */

#import "DKIntrospectionNode.h"

@class DKNotificationCenter, NSString, NSMutableDictionary, NSMapTable, DKMethod, DKProperty, DKSignal;

/**
 * DKInterface encapsulates information about D-Bus interfaces. Interfaces
 * members are methods, signals and properties. DKInterface also maintains a
 * lookup table mapping Objective-C selectors to D-Bus methods.
 */
@interface DKInterface: DKIntrospectionNode
{
  NSMutableDictionary *methods;
  NSMutableDictionary *signals;
  NSMutableDictionary *properties;
  NSMapTable *selectorToMethodMap;
}

/**
 * Returns all methods in the interface
 */
- (NSDictionary*)methods;

/**
 * Returns all signals in the interface
 */
- (NSDictionary*)signals;

/**
 * Returns all properties in the interface
 */
- (NSDictionary*)properties;

/**
 * Adds a method to the interface.
 */
- (void) addMethod: (DKMethod*)method;

/**
 * Adds a signal to the interface.
 */
- (void) addSignal: (DKSignal*)signal;

/**
 * Adds a property to the interface.
 */
- (void) addProperty: (DKProperty*)property;

/**
 * Removes a signal from the interface
 */
- (void)removeSignalNamed: (NSString*)signalName;

/**
 * Install the method as responding to the selector into the interface specific
 * dispatch table. It will be added to the interface if it is not already
 * present.
 */
- (void) installMethod: (DKMethod*)method
           forSelector: (SEL)selector;

/**
 * Add all methods present in the interface to the dispatch table, utilizing
 * their default selector names.
 */
- (void)installMethods;

/**
 * Add accessor and mutator methods for all properties to the dispatch table if
 * no method with the same name exists.
 */
- (void)installProperties;

/**
 * Registers all signals in the interface for use with the default
 * DKNotificationCenter.
 */
- (void)registerSignals;

/**
 * Registers all signals in the interface for use with the named
 * DKNotificationCenter.
 */
- (void)registerSignalsWithNotificationCenter: (DKNotificationCenter*)center;

/**
 * Returns the method installed for this selector.
 */
- (DKMethod*) DBusMethodForSelector: (SEL)selector;

/**
 * Returns the description of all methods in the interface as a protocol
 * declaration suitable for an Objective-C header file.
 */
- (NSString*)protocolDeclaration;

/**
 * Returns the Objective-C protocol that corresponds to the interface (if any).
 * The protocol must be registered with the Objective-C runtime.
 */
- (Protocol*)protocol;

/**
 * Returns the interface name with all dots replaced by underscores.
 */
- (NSString*)mangledName;

/**
 * Returns the name of the Objective-C protocol corresponding to the interface.
 * This will utilize the org.gnustep.objc.protocol annotation key if available
 * and return the -mangledName otherwise.
 */
- (NSString*)protocolName;
@end