Source/BSSourceView.mm

   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 "BSSourceView.h"
  18
  19 #import "BSLineNumberRulerView.h"
  20 #import "BSSourceViewTextView.h"
  21
  22 @interface BSSourceView (Private)
  23 - (void)setupViews;
  24 - (void)errorHighlightingFile:(NSNotification*)notif;
  25 - (void)setPlainTextStringFromFile:(NSString*)filePath;
  26 @end
  27
  28 @implementation BSSourceView
  29
  30 @synthesize textView = textView_;
  31 @synthesize scrollView = scrollView_;
  32 @synthesize markers = markers_;
  33 @synthesize markedLine = markedLine_;
  34 @synthesize delegate = delegate_;
  35 @synthesize file = file_;
  36
  37 /**
  38  * Initializes the source view with the path of a file
  39  */
  40 - (id)initWithFrame:(NSRect)frame
  41 {
  42   if (self = [super initWithFrame:frame]) {
  43     [self setupViews];
  44     [[NSNotificationCenter defaultCenter]
  45       addObserver:self
  46       selector:@selector(errorHighlightingFile:)
  47       name:NSFileHandleReadToEndOfFileCompletionNotification
  48       object:nil
  49     ];
  50   }
  51   return self;
  52 }
  53
  54 - (void)setMarkers:(NSSet*)markers {
  55   markers_ = [markers copy];
  56   [ruler_ setNeedsDisplay:YES];
  57 }
  58
  59 - (void)setMarkedLine:(NSUInteger)markedLine {
  60   markedLine_ = markedLine;
  61   [ruler_ setNeedsDisplay:YES];
  62   [textView_ setNeedsDisplay:YES];
  63 }
  64
  65 /**
  66  * Reads the contents of file at |f| and sets the source viewer and filename
  67  * as such.
  68  */
  69 - (void)setFile:(NSString*)f
  70 {
  71   file_ = f;
  72
  73   if (![[NSFileManager defaultManager] fileExistsAtPath:f]) {
  74     [textView_ setString:@""];
  75     return;
  76   }
  77
  78   [self setSource:f completionHandler:nil];
  79 }
  80
  81 /**
  82  * Sets the contents of the SourceView to |source| representing the file at |path|.
  83  */
  84 - (void)setString:(NSString*)source asFile:(NSString*)path
  85 {
  86   file_ = path;
  87
  88   // Write the source out as a temporary file so it can be highlighted.
  89   NSError* error = nil;
  90   NSString* tmpPath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"MacGDBpHighlighter"];
  91   [source writeToFile:tmpPath atomically:NO encoding:NSUTF8StringEncoding error:&error];
  92   if (error) {
  93     [textView_ setString:source];
  94     return;
  95   }
  96
  97   [self setSource:tmpPath completionHandler:^{
  98     [[NSFileManager defaultManager] removeItemAtPath:tmpPath error:NULL];
  99   }];
 100 }
 101
 102 /**
 103  * Flip the coordinates
 104  */
 105 - (BOOL)isFlipped
 106 {
 107   return YES;
 108 }
 109
 110 /**
 111  * Tells the text view to scroll to a certain line
 112  */
 113 - (void)scrollToLine:(NSUInteger)line
 114 {
 115   if ([[textView_ textStorage] length] == 0)
 116     return;
 117
 118   // go through the document until we find the NSRange for the line we want
 119   NSUInteger rangeIndex = 0;
 120   for (NSUInteger i = 0; i < line; i++) {
 121     rangeIndex = NSMaxRange([[textView_ string] lineRangeForRange:NSMakeRange(rangeIndex, 0)]);
 122   }
 123
 124   // now get the true start/end markers for it
 125   NSUInteger lineStart, lineEnd;
 126   [[textView_ string] getLineStart:&lineStart
 127                                end:NULL
 128                        contentsEnd:&lineEnd
 129                           forRange:NSMakeRange(rangeIndex - 1, 0)];
 130   [textView_ scrollRangeToVisible:[[textView_ string]
 131                 lineRangeForRange:NSMakeRange(lineStart, lineEnd - lineStart)]];
 132 }
 133
 134 /**
 135  * Returns the preferred font for source views.
 136  */
 137 + (NSFont*)sourceFont
 138 {
 139   static NSFont* font = nil;
 140   if (!font) {
 141     font = [NSFont fontWithName:@"Menlo" size:12];
 142     if (!font)
 143       font = [NSFont fontWithName:@"Monaco" size:12.0];
 144   }
 145   return font;
 146 }
 147
 148 /**
 149  * Setup all the subviews for the source metaview
 150  */
 151 - (void)setupViews
 152 {
 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_];
 162
 163   // add the text view to the scroll view
 164   NSRect textFrame;
 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_];
 180
 181   // Set up the ruler.
 182   ruler_ = [[BSLineNumberRulerView alloc] initWithSourceView:self];
 183   [scrollView_ setVerticalRulerView:ruler_];
 184   [scrollView_ setHasHorizontalRuler:NO];
 185   [scrollView_ setHasVerticalRuler:YES];
 186   [scrollView_ setRulersVisible:YES];
 187
 188   NSArray* types = [NSArray arrayWithObject:NSFilenamesPboardType];
 189   [self registerForDraggedTypes:types];
 190 }
 191
 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)];
 197 }
 198
 199 /**
 200  * Reads the contents of |filePath| and sets it as the displayed text, after
 201  * attempting to highlight it using the PHP binary.
 202  */
 203 - (void)setSource:(NSString*)filePath completionHandler:(void(^)(void))handler
 204 {
 205   @try {
 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];
 210
 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]),
 218       filePath
 219     ]];
 220     [task setStandardOutput:outPipe];
 221     [task setStandardError:errPipe];
 222     [task setTerminationHandler:^(NSTask* taskBlock) {
 223       if (task.terminationStatus != 0) {
 224         NSLog(@"Failed to highlight PHP file %@. Termination status=%d. stderr: %@",
 225               filePath, taskBlock.terminationStatus, [[errPipe fileHandleForReading] readDataToEndOfFile]);
 226       }
 227     }];
 228     [task launch];
 229
 230     // Start reading the stdout pipe immediately. This is separate from the
 231     // terminiationHandler, since a large file could be greater than
 232     // the pipe buffer.
 233     NSMutableAttributedString* source;
 234     NSData* data = [[outPipe fileHandleForReading] readDataToEndOfFile];
 235     if (data.length) {
 236       source = [[NSMutableAttributedString alloc] initWithHTML:data
 237                                                        options:@{ NSCharacterEncodingDocumentAttribute : @(NSUTF8StringEncoding) }
 238                                             documentAttributes:nil];
 239
 240       // PHP uses &nbsp; in the highlighted output, which should be converted
 241       // back to normal spaces.
 242       NSMutableString* stringData = [source mutableString];
 243       [stringData replaceOccurrencesOfString:@"\u00A0" withString:@" " options:0 range:NSMakeRange(0, stringData.length)];
 244
 245       // Override the default font from Courier.
 246       [source addAttributes:@{ NSFontAttributeName : [[self class] sourceFont] }
 247                       range:NSMakeRange(0, source.length)];
 248     }
 249
 250     if (source) {
 251       [[textView_ textStorage] setAttributedString:source];
 252     } else {
 253       [self setPlainTextStringFromFile:filePath];
 254     }
 255
 256     [ruler_ performLayout];
 257
 258     if (handler) {
 259       handler();
 260     }
 261   } @catch (NSException* exception) {
 262     // If the PHP executable is not available then the NSTask will throw an exception
 263     NSLog(@"Failed to highlight file: %@", exception);
 264     [self setPlainTextStringFromFile:filePath];
 265   }
 266 }
 267
 268 /**
 269  * Gets the plain-text representation of the file at |filePath| and sets the
 270  * contents in the source view.
 271  */
 272 - (void)setPlainTextStringFromFile:(NSString*)filePath
 273 {
 274   NSError* error = nil;
 275   NSString* contents = [NSString stringWithContentsOfFile:filePath
 276                                                  encoding:NSUTF8StringEncoding
 277                                                     error:&error];
 278   if (error) {
 279     NSLog(@"Error reading file at %@: %@", filePath, error);
 280     if ([delegate_ respondsToSelector:@selector(error:whileHighlightingFile:)]) {
 281       [delegate_ error:error whileHighlightingFile:filePath];
 282     }
 283     return;
 284   }
 285   [textView_ setString:contents];
 286 }
 287
 288 // Drag Handlers ///////////////////////////////////////////////////////////////
 289
 290 /**
 291  * Validates an initiated drag operation.
 292  */
 293 - (NSDragOperation)draggingEntered:(id<NSDraggingInfo>)sender
 294 {
 295   return NSDragOperationCopy;
 296 }
 297
 298 /**
 299  * Performs a dragging operation of files to set the contents of the file.
 300  */
 301 - (BOOL)performDragOperation:(id<NSDraggingInfo>)sender
 302 {
 303   NSPasteboard* pboard = [sender draggingPasteboard];
 304   if ([[pboard types] containsObject:NSFilenamesPboardType]) {
 305     NSArray* files = [pboard propertyListForType:NSFilenamesPboardType];
 306     if ([files count]) {
 307       NSString* filename = [files objectAtIndex:0];
 308       [self setFile:filename];
 309       return YES;
 310     }
 311   }
 312   return NO;
 313 }
 314
 315 @end