Add backend Breakpoint support for symbolic breakpoints.
[macgdbp.git] / Source / Breakpoint.m
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 "Breakpoint.h"
18
19 #import "PreferenceNames.h"
20
21 NSString* const kBreakpointTypeFile = @"line";
22 NSString* const kBreakpointTypeFunctionEntry = @"call";
23
24 @implementation Breakpoint {
25 NSString* _type; // weak
26 unsigned long _debuggerId;
27
28 NSString* _file;
29
30 NSString* _functionName;
31 }
32
33 - (instancetype)initWithLine:(NSUInteger)l inFile:(NSString*)f
34 {
35 if ((self = [super init])) {
36 _type = kBreakpointTypeFile;
37 _file = [f copy];
38 _line = l;
39 }
40 return self;
41 }
42
43 - (instancetype)initWithFunctionNamed:(NSString *)function {
44 if ((self = [super init])) {
45 _type = kBreakpointTypeFunctionEntry;
46 _functionName = [function copy];
47 }
48 return self;
49 }
50
51 - (id)initWithDictionary:(NSDictionary*)dict
52 {
53 if ((self = [super init])) {
54 NSString* type = [dict valueForKey:@"type"];
55 if (!type || [type isEqualToString:kBreakpointTypeFile]) {
56 _type = kBreakpointTypeFile;
57 _file = [[dict valueForKey:@"file"] copy];
58 _line = [[dict valueForKey:@"line"] intValue];
59 } else if ([type isEqualToString:kBreakpointTypeFunctionEntry]) {
60 _type = kBreakpointTypeFunctionEntry;
61 _functionName = [[dict valueForKey:@"function"] copy];
62 } else {
63 [NSException raise:NSInvalidArgumentException
64 format:@"Unknown Breakpoint type: %@", type];
65 }
66 }
67 return self;
68 }
69
70 - (void)dealloc
71 {
72 [_file release];
73 [_functionName release];
74 [super dealloc];
75 }
76
77 /**
78 * Returns the transformed path for the breakpoint, as Xdebug needs it
79 */
80 - (NSString*)transformedPath
81 {
82 NSString* path = self.file;
83
84 NSMutableArray* transforms = [[NSUserDefaults standardUserDefaults] mutableArrayValueForKey:kPrefPathReplacements];
85 if (!transforms || [transforms count] < 1)
86 return path;
87
88 for (NSDictionary* replacement in transforms)
89 {
90 path = [path
91 stringByReplacingOccurrencesOfString:[replacement valueForKey:@"local"]
92 withString:[replacement valueForKey:@"remote"]
93 ];
94 }
95
96 return path;
97 }
98
99 /**
100 * Determines if two breakpoints are equal
101 */
102 - (BOOL)isEqual:(id)obj
103 {
104 return ([[obj file] isEqualToString:self.file] && [obj line] == self.line);
105 }
106
107 /**
108 * Returns the hash value of a breakpoint
109 */
110 - (NSUInteger)hash
111 {
112 return ([self.file hash] << 8) + self.line;
113 }
114
115 /**
116 * Returns an NSDictionary of the data so it can be stored in NSUserDefaults
117 */
118 - (NSDictionary*)dictionary
119 {
120 if (_type == kBreakpointTypeFile) {
121 return @{
122 @"type" : _type,
123 @"file" : self.file,
124 @"line" : @(self.line)
125 };
126 } else if (_type == kBreakpointTypeFunctionEntry) {
127 return @{
128 @"type" : _type,
129 @"function" : self.functionName
130 };
131 }
132 return nil;
133 }
134
135 /**
136 * Pretty-print
137 */
138 - (NSString*)description
139 {
140 return [NSString stringWithFormat:@"Breakpoint %@", [[self dictionary] description]];
141 }
142
143 @end