Oolite 1.91.0.7644-241112-7f5034b
Loading...
Searching...
No Matches
OODebuggerInterface.h
Go to the documentation of this file.
1/*
2
3OODebuggerInterface.h
4
5Protocols for communication between OODebugMonitor and OODebuggerInterface.
6
7
8Oolite Debug Support
9
10Copyright (C) 2007-2013 Jens Ayton
11
12Permission is hereby granted, free of charge, to any person obtaining a copy
13of this software and associated documentation files (the "Software"), to deal
14in the Software without restriction, including without limitation the rights
15to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16copies of the Software, and to permit persons to whom the Software is
17furnished to do so, subject to the following conditions:
18
19The above copyright notice and this permission notice shall be included in all
20copies or substantial portions of the Software.
21
22THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28SOFTWARE.
29
30*/
31
32
33@class OODebugMonitor;
34
35// Interface for debugger.
36
37@protocol OODebuggerInterface <NSObject>
38
39// Sent to establish connection.
40- (BOOL)connectDebugMonitor:(in OODebugMonitor *)debugMonitor
41 errorMessage:(out NSString **)message;
42
43// Sent to close connection.
44- (void)disconnectDebugMonitor:(in OODebugMonitor *)debugMonitor
45 message:(in NSString *)message;
46
47// Sent to print to the JavaScript console.
48// colorKey is intended to be used to look up a foreground/background colour pair
49// in the configuration. EmphasisRange is to specify a bold section of text.
50- (oneway void)debugMonitor:(in OODebugMonitor *)debugMonitor
51 jsConsoleOutput:(in NSString *)output
52 colorKey:(in NSString *)colorKey
53 emphasisRange:(in NSRange)emphasisRange;
54
55// Sent to clear the JavaScript console.
56- (oneway void)debugMonitorClearConsole:(in OODebugMonitor *)debugMonitor;
57
58// Sent to show the console, for instance in response to a warning or error message.
59- (oneway void)debugMonitorShowConsole:(in OODebugMonitor *)debugMonitor;
60
61// Sent once when the debugger is connected.
62- (oneway void)debugMonitor:(in OODebugMonitor *)debugMonitor
63 noteConfiguration:(in NSDictionary *)configuration;
64
65// Sent when configuration changes. newValue may be nil.
66- (oneway void)debugMonitor:(in OODebugMonitor *)debugMonitor
67noteChangedConfigrationValue:(in id)newValue
68 forKey:(in NSString *)key;
69
70@end