Merge pull request #172 from macvim-dev/feature/quicklook

Import QLStephen to quick-look MacVim file types

Author: splhack

.gitignore

@@ -97,8 +97,13 @@ src/MacVim/PSMTabBarControl/PSMTabBarControl.xcodeproj/*.mode1v3
 src/MacVim/PSMTabBarControl/PSMTabBarControl.xcodeproj/*.pbxuser
 src/MacVim/PSMTabBarControl/PSMTabBarControl.xcodeproj/xcuserdata
 src/MacVim/PSMTabBarControl/build
-src/MacVim/PSMTabBarControl/build
+src/MacVim/qlstephen/QuickLookStephen.xcodeproj/*.mode1
+src/MacVim/qlstephen/QuickLookStephen.xcodeproj/*.mode1v3
+src/MacVim/qlstephen/QuickLookStephen.xcodeproj/*.pbxuser
+src/MacVim/qlstephen/QuickLookStephen.xcodeproj/xcuserdata
+src/MacVim/qlstephen/build
 src/MacVim/build
+src/MacVim/DerivedData
 src/TAGS
 src/Vim
 src/auto/config.cache

src/MacVim/Credits.rtf

@@ -46,6 +46,8 @@ Dmitry Vazhov\
 \
 Thank you to {\field{\*\fldinst{HYPERLINK "http://www.positivespinmedia.com"}}{\fldrslt Positive Spin Media}} for the PSMTabBarControl Framework.\
 \
+Thank you to {\field{\*\fldinst{HYPERLINK "https://whomwah.github.io/qlstephen/"}}{\fldrslt Duncan Robertson}} for the QLStephen QuickLook plugin.\
+\
 Toolbar icons by {\field{\*\fldinst{HYPERLINK "http://www.mattballdesign.com/"}}{\fldrslt Matt Ball}} (free Developer Icons), {\field{\*\fldinst{HYPERLINK "http://www.jonasraskdesign.com/"}}{\fldrslt Jonas Rask}} (Danish Royalty Free icon set), and {\field{\*\fldinst{HYPERLINK "http://www.everaldo.com"}}{\fldrslt Everaldo Coelho}} (Crystal Project Icons, released under LGPL license).\
 \
 Revamped MacVim icon by RIC.\

src/MacVim/MacVim.xcodeproj/project.pbxproj

@@ -65,6 +65,7 @@
 		1DE9B9500D341AB8008FEDD4 /* MMWindow.m in Sources */ = {isa = PBXBuildFile; fileRef = 1DE9B94E0D341AB8008FEDD4 /* MMWindow.m */; };
 		1DED78600C6DE43D0079945F /* vimrc in Copy Vim Runtime Files */ = {isa = PBXBuildFile; fileRef = 1DED785F0C6DE43D0079945F /* vimrc */; };
 		1DFE25A50C527BC4003000F7 /* PSMTabBarControl.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 1D493DB90C52533B00AB718C /* PSMTabBarControl.framework */; };
+		52818B031C1C08CE00F59085 /* QLStephen.qlgenerator in Copy QuickLookPlugin */ = {isa = PBXBuildFile; fileRef = 52818AFF1C1C075300F59085 /* QLStephen.qlgenerator */; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; };
 		8D11072A0486CEB800E47090 /* MainMenu.nib in Resources */ = {isa = PBXBuildFile; fileRef = 29B97318FDCFA39411CA2CEA /* MainMenu.nib */; };
 		8D11072B0486CEB800E47090 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 089C165CFE840E0CC02AAC07 /* InfoPlist.strings */; };
 		8D11072D0486CEB800E47090 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 29B97316FDCFA39411CA2CEA /* main.m */; settings = {ATTRIBUTES = (); }; };
@@ -86,6 +87,20 @@
 			remoteGlobalIDString = 53DF68FC067E5B5A0090B5B0;
 			remoteInfo = PSMTabBarControlFramework;
 		};
+		52818AFE1C1C075300F59085 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 52818AFA1C1C075300F59085 /* QuickLookStephen.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = 8D576316048677EA00EA77CD;
+			remoteInfo = QuickLookStephen;
+		};
+		52818B001C1C084100F59085 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 52818AFA1C1C075300F59085 /* QuickLookStephen.xcodeproj */;
+			proxyType = 1;
+			remoteGlobalIDString = 8D57630D048677EA00EA77CD;
+			remoteInfo = QuickLookStephen;
+		};
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXCopyFilesBuildPhase section */
@@ -124,6 +139,17 @@
 			name = "Copy Vim Runtime Files";
 			runOnlyForDeploymentPostprocessing = 0;
 		};
+		52818B021C1C088000F59085 /* Copy QuickLookPlugin */ = {
+			isa = PBXCopyFilesBuildPhase;
+			buildActionMask = 2147483647;
+			dstPath = ../Library/QuickLook;
+			dstSubfolderSpec = 6;
+			files = (
+				52818B031C1C08CE00F59085 /* QLStephen.qlgenerator in Copy QuickLookPlugin */,
+			);
+			name = "Copy QuickLookPlugin";
+			runOnlyForDeploymentPostprocessing = 0;
+		};
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
@@ -209,6 +235,7 @@
 		29B97324FDCFA39411CA2CEA /* AppKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = AppKit.framework; path = /System/Library/Frameworks/AppKit.framework; sourceTree = "<absolute>"; };
 		29B97325FDCFA39411CA2CEA /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = /System/Library/Frameworks/Foundation.framework; sourceTree = "<absolute>"; };
 		32CA4F630368D1EE00C91783 /* MacVim_Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MacVim_Prefix.pch; sourceTree = "<group>"; };
+		52818AFA1C1C075300F59085 /* QuickLookStephen.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = QuickLookStephen.xcodeproj; path = qlstephen/QuickLookStephen.xcodeproj; sourceTree = "<group>"; };
 		8D1107310486CEB800E47090 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist; path = Info.plist; sourceTree = "<group>"; };
 		8D1107320486CEB800E47090 /* MacVim.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = MacVim.app; sourceTree = BUILT_PRODUCTS_DIR; };
 /* End PBXFileReference section */
@@ -367,6 +394,7 @@
 				29B97317FDCFA39411CA2CEA /* Resources */,
 				1DE602460C587F760055263D /* Vim Resources */,
 				29B97323FDCFA39411CA2CEA /* Frameworks */,
+				52818AF81C1C073400F59085 /* QuickLook Plugin */,
 				19C28FACFE9D520D11CA2CBB /* Products */,
 			);
 			name = MacVim;
@@ -406,6 +434,22 @@
 			name = Frameworks;
 			sourceTree = "<group>";
 		};
+		52818AF81C1C073400F59085 /* QuickLook Plugin */ = {
+			isa = PBXGroup;
+			children = (
+				52818AFA1C1C075300F59085 /* QuickLookStephen.xcodeproj */,
+			);
+			name = "QuickLook Plugin";
+			sourceTree = "<group>";
+		};
+		52818AFB1C1C075300F59085 /* Products */ = {
+			isa = PBXGroup;
+			children = (
+				52818AFF1C1C075300F59085 /* QLStephen.qlgenerator */,
+			);
+			name = Products;
+			sourceTree = "<group>";
+		};
 /* End PBXGroup section */
 
 /* Begin PBXNativeTarget section */
@@ -418,13 +462,15 @@
 				8D11072E0486CEB800E47090 /* Frameworks */,
 				1D0DCAD80BA3604D00B6CCFA /* Copy Executables */,
 				1D9EB2840C366D7B0074B739 /* Copy Frameworks */,
+				52818B021C1C088000F59085 /* Copy QuickLookPlugin */,
 				1DE608B80C58807F0055263D /* Copy Vim Runtime Files */,
 				1D1C31F00EFFBFD6003FE9A5 /* Make Document Icons */,
 			);
 			buildRules = (
 			);
 			dependencies = (
 				1D493DCD0C5254A400AB718C /* PBXTargetDependency */,
+				52818B011C1C084100F59085 /* PBXTargetDependency */,
 			);
 			name = MacVim;
 			productInstallPath = "$(HOME)/Applications";
@@ -458,6 +504,10 @@
 					ProductGroup = 1D493DB40C52533B00AB718C /* Products */;
 					ProjectRef = 1D493DB30C52533B00AB718C /* PSMTabBarControl.xcodeproj */;
 				},
+				{
+					ProductGroup = 52818AFB1C1C075300F59085 /* Products */;
+					ProjectRef = 52818AFA1C1C075300F59085 /* QuickLookStephen.xcodeproj */;
+				},
 			);
 			projectRoot = "";
 			targets = (
@@ -474,6 +524,13 @@
 			remoteRef = 1D493DB80C52533B00AB718C /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
+		52818AFF1C1C075300F59085 /* QLStephen.qlgenerator */ = {
+			isa = PBXReferenceProxy;
+			fileType = wrapper.cfbundle;
+			path = QLStephen.qlgenerator;
+			remoteRef = 52818AFE1C1C075300F59085 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
 /* End PBXReferenceProxy section */
 
 /* Begin PBXResourcesBuildPhase section */
@@ -574,6 +631,11 @@
 			name = PSMTabBarControlFramework;
 			targetProxy = 1D493DCC0C5254A400AB718C /* PBXContainerItemProxy */;
 		};
+		52818B011C1C084100F59085 /* PBXTargetDependency */ = {
+			isa = PBXTargetDependency;
+			name = QuickLookStephen;
+			targetProxy = 52818B001C1C084100F59085 /* PBXContainerItemProxy */;
+		};
 /* End PBXTargetDependency section */
 
 /* Begin PBXVariantGroup section */

src/MacVim/qlstephen/English.lproj/InfoPlist.strings

@@ -0,0 +1,55 @@
+#include <CoreFoundation/CoreFoundation.h>
+#include <CoreServices/CoreServices.h>
+#include <QuickLook/QuickLook.h>
+
+#import <Foundation/Foundation.h>
+
+#import "QLSFileAttributes.h"
+
+
+// Generate a preview for the document with the given url
+OSStatus GeneratePreviewForURL(void *thisInterface,
+                               QLPreviewRequestRef request,
+                               CFURLRef url,
+                               CFStringRef contentTypeUTI,
+                               CFDictionaryRef options) {
+  @autoreleasepool {
+    if (QLPreviewRequestIsCancelled(request))
+      return noErr;
+
+    QLSFileAttributes *magicAttributes =
+        [QLSFileAttributes attributesForItemAtURL:(__bridge NSURL *)url];
+
+    if (!magicAttributes) {
+      NSLog(@"QLStephen: Could not determine attribtues of file %@", url);
+      return noErr;
+    }
+
+    if (!magicAttributes.isTextFile) {
+      return noErr;
+    }
+
+    if (magicAttributes.fileEncoding == kCFStringEncodingInvalidId) {
+      NSLog(@"QLStephen: Could not determine encoding of file %@", url);
+      return noErr;
+    }
+
+    NSDictionary *previewProperties = @{
+      (NSString *)kQLPreviewPropertyStringEncodingKey : @( magicAttributes.fileEncoding ),
+      (NSString *)kQLPreviewPropertyWidthKey      : @700,
+      (NSString *)kQLPreviewPropertyHeightKey     : @800
+    };
+
+    QLPreviewRequestSetURLRepresentation(
+        request,
+        url,
+        kUTTypePlainText,
+        (__bridge CFDictionaryRef)previewProperties);
+
+    return noErr;
+  }
+}
+
+void CancelPreviewGeneration(void* thisInterface, QLPreviewRequestRef preview) {
+  // implement only if supported
+}

src/MacVim/qlstephen/GeneratePreviewForURL.m

@@ -0,0 +1,164 @@
+#include <CoreFoundation/CoreFoundation.h>
+#include <CoreServices/CoreServices.h>
+#include <QuickLook/QuickLook.h>
+
+#import <Foundation/Foundation.h>
+#import "RegexKitLite.h"
+
+#import "QLSFileAttributes.h"
+
+
+/**
+ * This dictionary is used for a file with no extension. It maps the MIME type
+ * (as returned by file(1)) onto an appropriate thumbnail badge.
+ */
+static NSDictionary *mimeTypeToBadgeMap() {
+  return @{
+    @"application/xml": @"xml",
+    @"text/x-c"       : @"C",
+    @"text/x-c++"     : @"C++",
+    @"text/x-shellscript" : @"shell",
+    @"text/x-php"     : @"php",
+    @"text/x-python"  : @"python",
+    @"text/x-perl"    : @"perl",
+    @"text/x-ruby"    : @"ruby"
+  };
+}
+
+/**
+ * Some formats, e.g. Makefiles, have well-known names and no extension.
+ */
+static NSDictionary *filenameRegexToBadgeMap() {
+  return @{
+    @"Makefile" : @"make"
+  };
+}
+
+/**
+ * @return the string that should be used to badge the thumbnail.
+ */
+static NSString *ThumbnailBadgeForItemWithAttributes(
+    QLSFileAttributes *attributes) {
+  
+  NSString *fileExtension = attributes.url.pathExtension;
+  NSString *fileName = attributes.url.lastPathComponent;
+  __block NSString *badge;
+
+  // Do we have a file extension? If so, use it as a badge if it's not too
+  // long.
+  if (![fileExtension isEqualToString:@""]) {
+    badge = fileExtension;
+
+    // Is the file extension too long to be reasonably displayed in a
+    // thumbnail? If so, fall back on the additional tests.
+
+    // FIXME: use some better test to determine an appropriate length.
+    // FIXME: perhaps we should truncate the extension (at the end? in the
+    //        middle?) to fit as much in the thumbnail as possible.
+
+    if (badge.length >= 10)
+      badge = nil;
+  }
+
+  // Do we have a well-known MIME type? Note that we only do this test if we
+  // have no file extension. file(1) might wrongly guess the MIME type, and it
+  // would be annoying if the file extension were to say one thing and the
+  // badge another.
+  if (!badge && [fileExtension isEqualToString:@""]) {
+    NSDictionary *map = mimeTypeToBadgeMap();
+    badge = map[attributes.mimeType];
+  }
+  
+  // Does the filename match a known pattern? If so, use the appropriate badge.
+  if (!badge && [fileExtension isEqualToString:@""]) {
+    NSDictionary *map = filenameRegexToBadgeMap();
+
+    [map enumerateKeysAndObjectsUsingBlock:
+      ^(NSString *regex, NSString *candidateBadge, BOOL *stop) {
+        if ([fileName rkl_isMatchedByRegex:regex]) {
+          badge = candidateBadge;
+          *stop = true;
+        }
+    }];
+  }
+
+  // Do we have an executable text file? If so, assume it's a script of some
+  // sort.
+  if (!badge) {
+    NSFileManager *fm = [NSFileManager new];
+    BOOL isExecutable = [fm isExecutableFileAtPath:attributes.url.path];
+    if (isExecutable)
+      badge = @"script";
+  }
+
+  // No other tests passed? Just badge it with "txt". I would use "text",
+  // except that the OS X text QuickLook generator uses "txt", and we ought
+  // to be consistent with it.
+  if (!badge) {
+    badge = @"txt";
+  }
+
+  return [badge uppercaseString];
+}
+
+
+/* -----------------------------------------------------------------------------
+ Generate a thumbnail for file
+
+ This function's job is to create thumbnail for designated file as fast as
+ possible
+ -------------------------------------------------------------------------- */
+OSStatus GenerateThumbnailForURL(void *thisInterface,
+                                 QLThumbnailRequestRef request,
+                                 CFURLRef url,
+                                 CFStringRef contentTypeUTI,
+                                 CFDictionaryRef options,
+                                 CGSize maxSize) {
+  @autoreleasepool {
+    if (QLThumbnailRequestIsCancelled(request))
+      return noErr;
+
+    QLSFileAttributes *magicAttributes
+        = [QLSFileAttributes attributesForItemAtURL:(__bridge NSURL *)url];
+
+    if (!magicAttributes) {
+      NSLog(@"QLStephen: Could not determine attribtues of file %@", url);
+      return noErr;
+    }
+
+    if (!magicAttributes.isTextFile) {
+//      NSLog(@"QLStephen: I don't think %@ is a text file", url);
+      return noErr;
+    }
+
+    if (magicAttributes.fileEncoding == kCFStringEncodingInvalidId) {
+      NSLog(@"QLStephen: Could not determine encoding of file %@", url);
+      return noErr;
+    }
+
+    NSDictionary *previewProperties = @{
+      (NSString *)kQLPreviewPropertyStringEncodingKey : @( magicAttributes.fileEncoding )
+    };
+
+    NSString *badge = ThumbnailBadgeForItemWithAttributes(magicAttributes);
+
+    NSDictionary *properties = @{
+      (NSString *)kQLThumbnailPropertyExtensionKey : badge
+    };
+
+
+    QLThumbnailRequestSetThumbnailWithURLRepresentation(
+        request,
+        url,
+        kUTTypePlainText,
+        (__bridge CFDictionaryRef)previewProperties,
+        (__bridge CFDictionaryRef)properties);
+
+    return noErr;
+  }
+}
+
+void CancelThumbnailGeneration(void* thisInterface,
+                               QLThumbnailRequestRef thumbnail) {
+  // implement only if supported
+}