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 #include "BSLineNumberRulerView.h"
21 @interface BSSourceView (Private)
23 - (void)errorHighlightingFile:(NSNotification*)notif;
24 - (void)setPlainTextStringFromFile:(NSString*)filePath;
27 @implementation BSSourceView
29 @synthesize textView = textView_;
30 @synthesize scrollView = scrollView_;
31 @synthesize markers = markers_;
32 @synthesize markedLine;
37 * Initializes the source view with the path of a file
39 - (id)initWithFrame:(NSRect)frame
41 if (self = [super initWithFrame:frame])
44 [[NSNotificationCenter defaultCenter]
46 selector:@selector(errorHighlightingFile:)
47 name:NSFileHandleReadToEndOfFileCompletionNotification
61 [scrollView_ removeFromSuperview];
62 [textView_ removeFromSuperview];
68 * Sets the file name as well as the text of the source view
70 - (void)setFile:(NSString*)f
78 if (![[NSFileManager defaultManager] fileExistsAtPath:f])
80 [textView_ setString:@""];
86 // Attempt to use the PHP CLI to highlight the source file as HTML
87 NSPipe* outPipe = [NSPipe pipe];
88 NSPipe* errPipe = [NSPipe pipe];
89 NSTask* task = [[NSTask new] autorelease];
91 [task setLaunchPath:@"/usr/bin/php"]; // This is the path to the default Leopard PHP executable
92 [task setArguments:[NSArray arrayWithObjects:@"-s", f, nil]];
93 [task setStandardOutput:outPipe];
94 [task setStandardError:errPipe];
97 [[errPipe fileHandleForReading] readToEndOfFileInBackgroundAndNotify];
99 NSData* data = [[outPipe fileHandleForReading] readDataToEndOfFile];
100 NSAttributedString* source = [[NSAttributedString alloc] initWithHTML:data documentAttributes:NULL];
101 [[textView_ textStorage] setAttributedString:source];
104 @catch (NSException* exception)
106 // If the PHP executable is not available then the NSTask will throw an exception
107 [self setPlainTextStringFromFile:f];
110 [ruler_ performLayout];
114 * Sets the contents of the SourceView via a string rather than loading from a path
116 - (void)setString:(NSString*)source asFile:(NSString*)path
118 // create the temp file
119 NSError* error = nil;
120 NSString* tmpPath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"MacGDBpHighlighter"];
121 [source writeToFile:tmpPath atomically:NO encoding:NSUTF8StringEncoding error:&error];
124 [textView_ setString:source];
128 // highlight the temporary file
129 [self setFile:tmpPath];
131 // delete the temp file
132 [[NSFileManager defaultManager] removeItemAtPath:tmpPath error:NULL];
134 // plop in our fake path so nobody knows the difference
141 [ruler_ performLayout];
145 * If an error occurs in reading the highlighted PHP source, this will merely set the string
147 - (void)errorHighlightingFile:(NSNotification*)notif
149 NSData* data = [[notif userInfo] objectForKey:NSFileHandleNotificationDataItem];
150 if ([data length] > 0) // there's something on stderr, so the PHP CLI failed
151 [self setPlainTextStringFromFile:file];
155 * Flip the coordinates
163 * Tells the text view to scroll to a certain line
165 - (void)scrollToLine:(int)line
167 if ([[textView_ textStorage] length] == 0)
170 // go through the document until we find the NSRange for the line we want
172 for (int i = 0; i < line; i++)
174 rangeIndex = NSMaxRange([[textView_ string] lineRangeForRange:NSMakeRange(rangeIndex, 0)]);
177 // now get the true start/end markers for it
178 unsigned lineStart, lineEnd;
179 [[textView_ string] getLineStart:&lineStart end:NULL contentsEnd:&lineEnd forRange:NSMakeRange(rangeIndex - 1, 0)];
180 [textView_ scrollRangeToVisible:[[textView_ string] lineRangeForRange:NSMakeRange(lineStart, lineEnd - lineStart)]];
182 [scrollView_ setNeedsDisplay:YES];
186 * Setup all the subviews for the source metaview
190 // Create the scroll view.
191 scrollView_ = [[[NSScrollView alloc] initWithFrame:[self bounds]] autorelease];
192 [scrollView_ setHasHorizontalScroller:YES];
193 [scrollView_ setHasVerticalScroller:YES];
194 [scrollView_ setAutohidesScrollers:YES];
195 [scrollView_ setBorderType:NSBezelBorder];
196 [scrollView_ setAutoresizingMask:(NSViewWidthSizable | NSViewHeightSizable)];
197 [[scrollView_ contentView] setAutoresizesSubviews:YES];
198 [self addSubview:scrollView_];
200 // add the text view to the scroll view
202 textFrame.origin = NSMakePoint(0.0, 0.0);
203 textFrame.size = [scrollView_ contentSize];
204 textView_ = [[[NSTextView alloc] initWithFrame:textFrame] autorelease];
205 [textView_ setEditable:NO];
206 [textView_ setFont:[NSFont fontWithName:@"Monaco" size:10.0]];
207 [textView_ setHorizontallyResizable:YES];
208 [textView_ setVerticallyResizable:YES];
209 [textView_ setMinSize:textFrame.size];
210 [textView_ setMaxSize:NSMakeSize(FLT_MAX, FLT_MAX)];
211 [[textView_ textContainer] setContainerSize:NSMakeSize(FLT_MAX, FLT_MAX)];
212 [[textView_ textContainer] setWidthTracksTextView:NO];
213 [[textView_ textContainer] setHeightTracksTextView:NO];
214 [textView_ setAutoresizingMask:NSViewNotSizable];
215 [scrollView_ setDocumentView:textView_];
218 ruler_ = [[[BSLineNumberRulerView alloc] initWithSourceView:self] autorelease];
219 [scrollView_ setVerticalRulerView:ruler_];
220 [scrollView_ setHasHorizontalRuler:NO];
221 [scrollView_ setHasVerticalRuler:YES];
222 [scrollView_ setRulersVisible:YES];
224 NSArray* types = [NSArray arrayWithObject:NSFilenamesPboardType];
225 [self registerForDraggedTypes:types];
229 * Gets the plain-text representation of the file at |filePath| and sets the
230 * contents in the source view.
232 - (void)setPlainTextStringFromFile:(NSString*)filePath
235 NSString* contents = [NSString stringWithContentsOfFile:filePath
236 encoding:NSUTF8StringEncoding
239 NSLog(@"Error reading file at %@: %@", filePath, error);
242 [textView_ setString:contents];
245 // Drag Handlers ///////////////////////////////////////////////////////////////
248 * Validates an initiated drag operation.
250 - (NSDragOperation)draggingEntered:(id<NSDraggingInfo>)sender
252 if ([delegate respondsToSelector:@selector(sourceView:acceptsDropOfFile:)])
253 return NSDragOperationCopy;
254 return NSDragOperationNone;
258 * Performs a dragging operation of files to set the contents of the file.
260 - (BOOL)performDragOperation:(id<NSDraggingInfo>)sender
262 NSPasteboard* pboard = [sender draggingPasteboard];
263 if ([[pboard types] containsObject:NSFilenamesPboardType]) {
264 NSArray* files = [pboard propertyListForType:NSFilenamesPboardType];
266 NSString* filename = [files objectAtIndex:0];
267 if ([delegate respondsToSelector:@selector(sourceView:acceptsDropOfFile:)] &&
268 [delegate sourceView:self acceptsDropOfFile:filename]) {
269 [self setFile:filename];