Add support for function return breakpoints.
[macgdbp.git] / Source / Breakpoint.h
1 /*
2 * MacGDBp
3 * Copyright (c) 2007 - 2011, Blue Static <http://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 <Cocoa/Cocoa.h>
18
19 extern NSString* const kBreakpointTypeFile;
20 extern NSString* const kBreakpointTypeFunctionEntry;
21 extern NSString* const kBreakpointTypeFunctionReturn;
22
23 // This represents a breakpoint at a certain file and line number. It also
24 // maintains the identifier that the backend assigns to the breakpoint.
25 @interface Breakpoint : NSObject
26
27 // The type of breakpoint, one of the kBreakpointType constants above.
28 @property (readonly) NSString* type;
29
30 // The unique identifier assigned by the debugger engine, only valid while
31 // connected.
32 @property (readwrite, assign) unsigned long debuggerId;
33
34 @property(nonatomic, readonly) NSString* displayValue;
35
36 // kBreakpointTypeFile:
37 @property (readonly) NSString* file;
38 @property (readonly) unsigned long line;
39
40 // kBreakpointTypeFunctionEntry:
41 @property (readonly) NSString* functionName;
42
43 + (instancetype)breakpointAtLine:(unsigned long)line inFile:(NSString*)file;
44 + (instancetype)breakpointOnFunctionNamed:(NSString*)name type:(NSString*)type;
45
46 // Initializer from NSUserDefaults.
47 - (instancetype)initWithDictionary:(NSDictionary*)dict;
48
49 - (NSString*)transformedPath;
50
51 // Creates a dictionary representation for use in NSUserDefaults.
52 - (NSDictionary*)dictionary;
53
54 @end