3 * Copyright (c) 2007 - 2011, Blue Static <http://www.bluestatic.org>
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.
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.
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
17 #import "BSSourceView.h"
19 #import "BSLineNumberRulerView.h"
20 #import "BSSourceViewTextView.h"
22 @interface BSSourceView (Private)
24 - (void)errorHighlightingFile:(NSNotification*)notif;
25 - (void)setPlainTextStringFromFile:(NSString*)filePath;
28 @implementation BSSourceView
30 @synthesize textView = textView_;
31 @synthesize scrollView = scrollView_;
32 @synthesize markers = markers_;
33 @synthesize markedLine = markedLine_;
34 @synthesize delegate = delegate_;
35 @synthesize file = file_;
38 * Initializes the source view with the path of a file
40 - (id)initWithFrame:(NSRect)frame
42 if (self = [super initWithFrame:frame]) {
44 [[NSNotificationCenter defaultCenter]
46 selector:@selector(errorHighlightingFile:)
47 name:NSFileHandleReadToEndOfFileCompletionNotification
54 - (void)setMarkers:(NSSet*)markers {
55 markers_ = [markers copy];
56 [ruler_ setNeedsDisplay:YES];
59 - (void)setMarkedLine:(NSUInteger)markedLine {
60 markedLine_ = markedLine;
61 [ruler_ setNeedsDisplay:YES];
65 * Reads the contents of file at |f| and sets the source viewer and filename
68 - (void)setFile:(NSString*)f
72 if (![[NSFileManager defaultManager] fileExistsAtPath:f]) {
73 [textView_ setString:@""];
77 [self setSource:f completionHandler:nil];
81 * Sets the contents of the SourceView to |source| representing the file at |path|.
83 - (void)setString:(NSString*)source asFile:(NSString*)path
87 // Write the source out as a temporary file so it can be highlighted.
89 NSString* tmpPath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"MacGDBpHighlighter"];
90 [source writeToFile:tmpPath atomically:NO encoding:NSUTF8StringEncoding error:&error];
92 [textView_ setString:source];
96 [self setSource:tmpPath completionHandler:^{
97 [[NSFileManager defaultManager] removeItemAtPath:tmpPath error:NULL];
102 * Flip the coordinates
110 * Tells the text view to scroll to a certain line
112 - (void)scrollToLine:(NSUInteger)line
114 if ([[textView_ textStorage] length] == 0)
117 // go through the document until we find the NSRange for the line we want
118 NSUInteger rangeIndex = 0;
119 for (NSUInteger i = 0; i < line; i++) {
120 rangeIndex = NSMaxRange([[textView_ string] lineRangeForRange:NSMakeRange(rangeIndex, 0)]);
123 // now get the true start/end markers for it
124 NSUInteger lineStart, lineEnd;
125 [[textView_ string] getLineStart:&lineStart
128 forRange:NSMakeRange(rangeIndex - 1, 0)];
129 [textView_ scrollRangeToVisible:[[textView_ string]
130 lineRangeForRange:NSMakeRange(lineStart, lineEnd - lineStart)]];
131 [scrollView_ setNeedsDisplay:YES];
135 * Returns the preferred font for source views.
137 + (NSFont*)sourceFont
139 static NSFont* font = nil;
141 font = [NSFont fontWithName:@"Menlo" size:12];
143 font = [NSFont fontWithName:@"Monaco" size:12.0];
149 * Setup all the subviews for the source metaview
153 // Create the scroll view.
154 scrollView_ = [[NSScrollView alloc] initWithFrame:[self bounds]];
155 [scrollView_ setHasHorizontalScroller:YES];
156 [scrollView_ setHasVerticalScroller:YES];
157 [scrollView_ setAutohidesScrollers:YES];
158 [scrollView_ setBorderType:NSBezelBorder];
159 [scrollView_ setAutoresizingMask:(NSViewWidthSizable | NSViewHeightSizable)];
160 [[scrollView_ contentView] setAutoresizesSubviews:YES];
161 [self addSubview:scrollView_];
163 // add the text view to the scroll view
165 textFrame.origin = NSMakePoint(0.0, 0.0);
166 textFrame.size = [scrollView_ contentSize];
167 textView_ = [[BSSourceViewTextView alloc] initWithFrame:textFrame];
168 [textView_ setSourceView:self];
169 [textView_ setEditable:NO];
170 [textView_ setFont:[[self class] sourceFont]];
171 [textView_ setHorizontallyResizable:YES];
172 [textView_ setVerticallyResizable:YES];
173 [textView_ setMinSize:textFrame.size];
174 [textView_ setMaxSize:NSMakeSize(FLT_MAX, FLT_MAX)];
175 [[textView_ textContainer] setContainerSize:NSMakeSize(FLT_MAX, FLT_MAX)];
176 [[textView_ textContainer] setWidthTracksTextView:NO];
177 [[textView_ textContainer] setHeightTracksTextView:NO];
178 [textView_ setAutoresizingMask:NSViewNotSizable];
179 [scrollView_ setDocumentView:textView_];
182 ruler_ = [[BSLineNumberRulerView alloc] initWithSourceView:self];
183 [scrollView_ setVerticalRulerView:ruler_];
184 [scrollView_ setHasHorizontalRuler:NO];
185 [scrollView_ setHasVerticalRuler:YES];
186 [scrollView_ setRulersVisible:YES];
188 NSArray* types = [NSArray arrayWithObject:NSFilenamesPboardType];
189 [self registerForDraggedTypes:types];
192 NSString* ColorHEXStringINIDirective(NSString* directive, NSColor* color) {
193 CGFloat red, green, blue, alpha;
194 color = [color colorUsingColorSpaceName:NSCalibratedRGBColorSpace];
195 [color getRed:&red green:&green blue:&blue alpha:&alpha];
196 return [NSString stringWithFormat:@"%@=\"#%02x%02x%02x\"", directive, (UInt8)(red * 255), (UInt8)(green * 255), (UInt8)(blue * 255)];
200 * Reads the contents of |filePath| and sets it as the displayed text, after
201 * attempting to highlight it using the PHP binary.
203 - (void)setSource:(NSString*)filePath completionHandler:(void(^)(void))handler
206 // Attempt to use the PHP CLI to highlight the source file as HTML
207 NSPipe* outPipe = [NSPipe pipe];
208 NSPipe* errPipe = [NSPipe pipe];
209 NSTask* task = [[NSTask alloc] init];
211 [task setLaunchPath:@"/usr/bin/php"]; // This is the path to the default Leopard PHP executable
212 [task setArguments:@[
213 @"--syntax-highlight",
214 @"--define", ColorHEXStringINIDirective(@"highlight.string", [NSColor systemRedColor]),
215 @"--define", ColorHEXStringINIDirective(@"highlight.comment", [NSColor systemOrangeColor]),
216 @"--define", ColorHEXStringINIDirective(@"highlight.default", [NSColor systemBlueColor]),
217 @"--define", ColorHEXStringINIDirective(@"highlight.html", [NSColor systemGrayColor]),
220 [task setStandardOutput:outPipe];
221 [task setStandardError:errPipe];
222 [task setTerminationHandler:^(NSTask*) {
223 NSMutableAttributedString* source;
225 if (task.terminationStatus == 0) {
226 NSData* data = [[outPipe fileHandleForReading] readDataToEndOfFile];
228 [[NSMutableAttributedString alloc] initWithHTML:data
229 options:@{ NSCharacterEncodingDocumentAttribute : @(NSUTF8StringEncoding) }
230 documentAttributes:nil];
232 // PHP uses in the highlighted output, which should be converted
233 // back to normal spaces.
234 NSMutableString* stringData = [source mutableString];
235 [stringData replaceOccurrencesOfString:@"\u00A0" withString:@" " options:0 range:NSMakeRange(0, stringData.length)];
237 // Override the default font from Courier.
238 [source addAttributes:@{ NSFontAttributeName : [[self class] sourceFont] }
239 range:NSMakeRange(0, source.length)];
241 NSLog(@"Failed to highlight PHP file %@: %@", filePath, [[errPipe fileHandleForReading] readDataToEndOfFile]);
244 dispatch_async(dispatch_get_main_queue(), ^{
246 [[self->textView_ textStorage] setAttributedString:source];
248 [self setPlainTextStringFromFile:filePath];
251 [self->ruler_ performLayout];
258 } @catch (NSException* exception) {
259 // If the PHP executable is not available then the NSTask will throw an exception
260 NSLog(@"Failed to highlight file: %@", exception);
261 [self setPlainTextStringFromFile:filePath];
266 * Gets the plain-text representation of the file at |filePath| and sets the
267 * contents in the source view.
269 - (void)setPlainTextStringFromFile:(NSString*)filePath
271 NSError* error = nil;
272 NSString* contents = [NSString stringWithContentsOfFile:filePath
273 encoding:NSUTF8StringEncoding
276 NSLog(@"Error reading file at %@: %@", filePath, error);
277 if ([delegate_ respondsToSelector:@selector(error:whileHighlightingFile:)]) {
278 [delegate_ error:error whileHighlightingFile:filePath];
282 [textView_ setString:contents];
285 // Drag Handlers ///////////////////////////////////////////////////////////////
288 * Validates an initiated drag operation.
290 - (NSDragOperation)draggingEntered:(id<NSDraggingInfo>)sender
292 return NSDragOperationCopy;
296 * Performs a dragging operation of files to set the contents of the file.
298 - (BOOL)performDragOperation:(id<NSDraggingInfo>)sender
300 NSPasteboard* pboard = [sender draggingPasteboard];
301 if ([[pboard types] containsObject:NSFilenamesPboardType]) {
302 NSArray* files = [pboard propertyListForType:NSFilenamesPboardType];
304 NSString* filename = [files objectAtIndex:0];
305 [self setFile:filename];