Keyword search plugin for Safari
Objective-C Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
DBBackgroundView.framework
English.lproj
JRSwizzle @ a846539
Keystone.xcodeproj
docs
.gitmodules
ActionView.h
ActionView.m
AddCompletionController.h
AddCompletionController.m
AdditionalCompletionTableDataSource.h
AdditionalCompletionTableDataSource.m
BookmarkSources.h
BookmarksControllerAdditions.h
BookmarksControllerAdditions.m
BookmarksControllerObjC.h
BrowserWindowController+JavaScript.h
BrowserWindowController+JavaScript.m
BrowserWindowControllerAdditions.h
BrowserWindowControllerAdditions.m
CompletionAdapter.h
CompletionControllerAdditions.h
CompletionControllerAdditions.m
CompletionControllers.h
CompletionHandler.h
CompletionListTableView.h
CompletionServer.h
CompletionServer.m
CompletionWindow.h
DefaultsDomain.h
DefaultsDomain.m
DropOverlayView.h
DropOverlayView.m
FakeCompletionItem.h
FakeCompletionItem.m
Info.plist
KeystoneController.h
KeystoneController.m
KeystoneTests-Info.plist
Keystone_Prefix.pch
LocationTextField.h
NSPreferences.h
NSWindow+EndEditingGracefully.h
NSWindow+EndEditingGracefully.m
QueryCompletionItem.h
QueryCompletionItem.m
README.md
SheetRequest.h
SheetRequest.m
SortedArray.h
SortedArray.m
SortedArrayTests.m
TextCell.h
UpdateController.h
UpdateController.m
drop.pdf
keystone.icns

README.md

Keystone

Keystone is a SIMBL plugin that provides keyword search for Safari. That is, you can type 'wiki Safari' into the location bar, and get the Wikipedia page for "Safari".

Building

Keystone is currently set up to build with Xcode 3.1 or later; it is still using the Xcode 3 series in order to build for Mac OS X v10.5 (for PowerPC Macs as well as 32- and 64-bit Intel). It should be possible to build Keystone for Mac OS X v10.6 or later using Xcode 4.

Keystone has integrated support for Sparkle, but it's carefully cordoned off from the actual Sparkle framework to avoid conflicts if someone else has already loaded it. (In particular, WebKit nightly builds have been known to use Sparkle for updates.)

It should be possible to build Keystone without Sparkle support with minimal source modifications.

Disclaimer

This should go without saying, but Keystone is basically a hack that has broken and will continue to break with every major update to Safari. Fortunately, it should detect if it's on an untested version of Safari and warn you if things might go wrong.

For really major updates (e.g. new OS), SIMBL will refuse to load Keystone at all. If you want to experiment with newer versions of Safari, you can change the MaxBundleVersion listed under SIMBLTargetApplications in the Info.plist file.

Keystone is not undergoing active development. Read why.

Credits

Keystone uses the following code snippets or libraries, from coders much wiser than I. Thank you all!

  • Dave Batton's DBBackgroundView, which I've been using for a long time for drawing colors, images, and gradients behind my main content. It seems to no longer be easily available on the internet, so I'm including the compiled framework here.

  • Daniel Jalkut's "gracefully ending editing" category on NSWindow, which saves a user's changes when a window closes.

  • Andy Matuschak's Sparkle update framework.

  • John Rentzsch's JRSwizzle for method injection, modified with some convenience macros.

License

Copyright (c) 2009-2012 Jordy Rose

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior authorization.