]> src.bluestatic.org Git - macgdbp.git/blob - Source/DebuggerModel.h
Add a README.md.
[macgdbp.git] / Source / DebuggerModel.h
1 /*
2 * MacGDBp
3 * Copyright (c) 2015, Blue Static <https://www.bluestatic.org>
4 *
5 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
6 * General Public License as published by the Free Software Foundation; either version 2 of the
7 * License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
10 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along with this program; if not,
14 * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17 #import <Foundation/Foundation.h>
18
19 @class BreakpointManager;
20 @class StackFrame;
21
22 // This class represents the state of an active debugging session. It is
23 // typically updated by the DebuggerBackEnd in response to various commands.
24 // All of the properties are KVO-compliant.
25 @interface DebuggerModel : NSObject
26
27 // Maintains state about breakpoints.
28 @property(readonly, nonatomic) BreakpointManager* breakpointManager;
29
30 // Whether or not the debugger is currently connected.
31 @property(readonly, nonatomic) BOOL connected;
32
33 // A human-readable representation of the debugger state. E.g., "Break" or
34 // "Stopped".
35 @property(copy, nonatomic) NSString* status;
36
37 // A string representing the last error message, or nil for no error.
38 @property(copy, nonatomic) NSString* lastError;
39
40 // An array of StackFrame objects for the current call stack.
41 @property(readonly, nonatomic) NSArray<StackFrame*>* stack;
42
43 // Helper accessor for |stack.count|.
44 @property(readonly, nonatomic) NSUInteger stackDepth;
45
46 // Informs the model that the debugger is listening for new connections.
47 - (void)onListeningOnPort:(uint16_t)port;
48
49 // Informs the model that a new connection was initiated. This clears any data
50 // in the model.
51 - (void)onNewConnection;
52
53 // Informs the model that the connection was terminated.
54 - (void)onDisconnect;
55
56 // Replaces the current stack with |newStack|. This will attempt to preserve
57 // any already loaded frames.
58 - (void)updateStack:(NSArray<StackFrame*>*)newStack;
59
60 @end