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
62 [scrollView_ removeFromSuperview];
63 [textView_ removeFromSuperview];
68 - (void)setMarkers:(NSSet*)markers {
70 markers_ = [markers copy];
72 [ruler_ setNeedsDisplay:YES];
75 - (void)setMarkedLine:(NSUInteger)markedLine {
76 markedLine_ = markedLine;
77 [ruler_ setNeedsDisplay:YES];
81 * Reads the contents of file at |f| and sets the source viewer and filename
84 - (void)setFile:(NSString*)f
91 if (![[NSFileManager defaultManager] fileExistsAtPath:f]) {
92 [textView_ setString:@""];
96 [self setSource:f completionHandler:nil];
100 * Sets the contents of the SourceView to |source| representing the file at |path|.
102 - (void)setString:(NSString*)source asFile:(NSString*)path
109 // Write the source out as a temporary file so it can be highlighted.
110 NSError* error = nil;
111 NSString* tmpPath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"MacGDBpHighlighter"];
112 [source writeToFile:tmpPath atomically:NO encoding:NSUTF8StringEncoding error:&error];
114 [textView_ setString:source];
118 [self setSource:tmpPath completionHandler:^{
119 [[NSFileManager defaultManager] removeItemAtPath:tmpPath error:NULL];
124 * Flip the coordinates
132 * Tells the text view to scroll to a certain line
134 - (void)scrollToLine:(NSUInteger)line
136 if ([[textView_ textStorage] length] == 0)
139 // go through the document until we find the NSRange for the line we want
140 NSUInteger rangeIndex = 0;
141 for (NSUInteger i = 0; i < line; i++) {
142 rangeIndex = NSMaxRange([[textView_ string] lineRangeForRange:NSMakeRange(rangeIndex, 0)]);
145 // now get the true start/end markers for it
146 NSUInteger lineStart, lineEnd;
147 [[textView_ string] getLineStart:&lineStart
150 forRange:NSMakeRange(rangeIndex - 1, 0)];
151 [textView_ scrollRangeToVisible:[[textView_ string]
152 lineRangeForRange:NSMakeRange(lineStart, lineEnd - lineStart)]];
153 [scrollView_ setNeedsDisplay:YES];
157 * Setup all the subviews for the source metaview
161 // Create the scroll view.
162 scrollView_ = [[[NSScrollView alloc] initWithFrame:[self bounds]] autorelease];
163 [scrollView_ setHasHorizontalScroller:YES];
164 [scrollView_ setHasVerticalScroller:YES];
165 [scrollView_ setAutohidesScrollers:YES];
166 [scrollView_ setBorderType:NSBezelBorder];
167 [scrollView_ setAutoresizingMask:(NSViewWidthSizable | NSViewHeightSizable)];
168 [[scrollView_ contentView] setAutoresizesSubviews:YES];
169 [self addSubview:scrollView_];
171 // add the text view to the scroll view
173 textFrame.origin = NSMakePoint(0.0, 0.0);
174 textFrame.size = [scrollView_ contentSize];
175 textView_ = [[[BSSourceViewTextView alloc] initWithFrame:textFrame] autorelease];
176 [textView_ setSourceView:self];
177 [textView_ setEditable:NO];
178 [textView_ setFont:[NSFont fontWithName:@"Monaco" size:10.0]];
179 [textView_ setHorizontallyResizable:YES];
180 [textView_ setVerticallyResizable:YES];
181 [textView_ setMinSize:textFrame.size];
182 [textView_ setMaxSize:NSMakeSize(FLT_MAX, FLT_MAX)];
183 [[textView_ textContainer] setContainerSize:NSMakeSize(FLT_MAX, FLT_MAX)];
184 [[textView_ textContainer] setWidthTracksTextView:NO];
185 [[textView_ textContainer] setHeightTracksTextView:NO];
186 [textView_ setAutoresizingMask:NSViewNotSizable];
187 [scrollView_ setDocumentView:textView_];
190 ruler_ = [[[BSLineNumberRulerView alloc] initWithSourceView:self] autorelease];
191 [scrollView_ setVerticalRulerView:ruler_];
192 [scrollView_ setHasHorizontalRuler:NO];
193 [scrollView_ setHasVerticalRuler:YES];
194 [scrollView_ setRulersVisible:YES];
196 NSArray* types = [NSArray arrayWithObject:NSFilenamesPboardType];
197 [self registerForDraggedTypes:types];
201 * Reads the contents of |filePath| and sets it as the displayed text, after
202 * attempting to highlight it using the PHP binary.
204 - (void)setSource:(NSString*)filePath completionHandler:(void(^)(void))handler
207 // Attempt to use the PHP CLI to highlight the source file as HTML
208 NSPipe* outPipe = [NSPipe pipe];
209 NSPipe* errPipe = [NSPipe pipe];
210 NSTask* task = [[NSTask alloc] init];
212 [task setLaunchPath:@"/usr/bin/php"]; // This is the path to the default Leopard PHP executable
213 [task setArguments:@[ @"-s", filePath ]];
214 [task setStandardOutput:outPipe];
215 [task setStandardError:errPipe];
216 [task setTerminationHandler:^(NSTask*) {
217 dispatch_async(dispatch_get_main_queue(), ^{
218 if (task.terminationStatus == 0) {
219 NSData* data = [[outPipe fileHandleForReading] readDataToEndOfFile];
220 NSMutableAttributedString* source =
221 [[NSMutableAttributedString alloc] initWithHTML:data
222 options:@{ NSCharacterEncodingDocumentAttribute : @(NSUTF8StringEncoding) }
223 documentAttributes:nil];
224 NSMutableString* stringData = [source mutableString];
225 // PHP uses in the highlighted output, which should be converted
226 // back to normal spaces.
227 [stringData replaceOccurrencesOfString:@"\u00A0" withString:@" " options:0 range:NSMakeRange(0, stringData.length)];
228 [[textView_ textStorage] setAttributedString:source];
231 NSLog(@"Failed to highlight PHP file %@: %@", filePath, [[errPipe fileHandleForReading] readDataToEndOfFile]);
232 [self setPlainTextStringFromFile:filePath];
235 [ruler_ performLayout];
244 } @catch (NSException* exception) {
245 // If the PHP executable is not available then the NSTask will throw an exception
246 [self setPlainTextStringFromFile:filePath];
251 * Gets the plain-text representation of the file at |filePath| and sets the
252 * contents in the source view.
254 - (void)setPlainTextStringFromFile:(NSString*)filePath
256 NSError* error = nil;
257 NSString* contents = [NSString stringWithContentsOfFile:filePath
258 encoding:NSUTF8StringEncoding
261 NSLog(@"Error reading file at %@: %@", filePath, error);
264 [textView_ setString:contents];
267 // Drag Handlers ///////////////////////////////////////////////////////////////
270 * Validates an initiated drag operation.
272 - (NSDragOperation)draggingEntered:(id<NSDraggingInfo>)sender
274 return NSDragOperationCopy;
278 * Performs a dragging operation of files to set the contents of the file.
280 - (BOOL)performDragOperation:(id<NSDraggingInfo>)sender
282 NSPasteboard* pboard = [sender draggingPasteboard];
283 if ([[pboard types] containsObject:NSFilenamesPboardType]) {
284 NSArray* files = [pboard propertyListForType:NSFilenamesPboardType];
286 NSString* filename = [files objectAtIndex:0];
287 [self setFile:filename];