首页 > 代码库 > 写个自己的Xcode4插件
写个自己的Xcode4插件
转自:http://joeyio.com/ios/2013/07/25/write_xcode4_plugin_of_your_own/
刚写iOS程序的时候就知道Xcode支持第三方插件,比如ColorSense等很实用的插件,但Xcode的插件开发没有官方的文档支持,一直觉得很神秘,那今天就来揭开它的面纱。
在Xcode启动的时候,它会检查插件目录(~/Library/Application Support/Developer/Shared/Xcode/Plug-ins
)下所有的插件(扩展名为.xcplugin
的bundle文件)并加载他们。其实到这里我们就猜到了,我们做的插件最终会是一个扩展名为.xcplugin
的bundle文件,放在插件目录下供Xcode加载。
OK,我们先做一个简单的插件,需要很简单的几个步骤即可完成,我的环境是Xcode 4.6.3 (4H1503)。
1. 新创建一个Xcode Project
Xcode插件其实就是一个Mac OS X bundle,所以可以参考下图创建一个Bundle。
给Project起个名字,并确保不要勾选Use automatic reference counting
,因为Xcode是使用GC来管理内存的,所以Xcode的插件也需要是用GC来管理内存的。Framework选择Cocoa
。
2. 设置Target Info
像下图一样设置这些信息
XC4Compatible
=YES
XCPluginHasUI
=NO
XCGCReady
=YES
Principal Class
=Plugin
(这个设置为你插件的名字
,本例中命名为Plugin
)
前三个可能Info里缺省没有,可以自己添加,都选Boolean
类型,最后一个Principal Class
是String
类型。
3. 设置Build Settings
然后打开Build Setting Tab,设置这些:
- 设置
Installation Build Products Location
为${HOME}
,Xcode会自动转换为你当前用户的Home路径 - 设置
Installation Directory
为/Library/Application Support/Developer/Shared/Xcode/Plug-ins
, Xcode会把拼接Installation Build Products Location
和Installation Directory
为一个绝对路径来查找你的插件 - 设置
Deployment Location
为YES
- 设置
Set Wrapper extension
为xcplugin
##4. 添加 User-Defined 设置
- 设置
GCC_ENABLE_OBJC_GC
为supported
- 设置
GCC_MODEL_TUNING
为G5
有了这些设置,每次build这个Projct的时候,Xcode就会把build后的插件copy到plugin文件夹下,然后我们需要重启Xcode来重新加载新build的插件。开发插件相对来说简单一些,调试插件就比较纠结了,唯一的办法就是build之后,重启Xcode,来加载最新build的插件。
准备工作已经结束,下面开始实现我们的插件。
5. 实现我们的插件
在第二步的时候我们设置了一个Principal Class
,那么在Xcode里新建Objective-C类,名字和Principal Class
设置的值保持一致。在实现文件中添加上+ (void) pluginDidLoad: (NSBundle*) plugin
方法。 该方法会在Xcode加载插件的时候被调用,可以用来做一些初始化的操作。通常这个类是一个单例,并Observe了NSApplicationDidFinishLaunchingNotification
,用来获得Xcode加载完毕的通知。
+ (void) pluginDidLoad: (NSBundle*) plugin { static id sharedPlugin = nil; static dispatch_once_t once; dispatch_once(&once, ^{ sharedPlugin = [[self alloc] init]; });}- (id)init { if (self = [super init]) { [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationDidFinishLaunching:) name:NSApplicationDidFinishLaunchingNotification object:nil]; } return self;}
一旦接收到Xcode加载完毕的通知,就可以Observe需要的其他notification或者在菜单中添加菜单项或者访问Code Editor之类的UI组件。
在我们的这个简单例子中,我们就在Edit
下添加一个叫做Custom Plugin
的菜单项,并设置一个? + c
快捷键。它的功能是使用NSAlert
显示出我们在代码编辑器中选中的文本。我们需要通过观察NSTextViewDidChangeSelectionNotification
并访问接收参数中的NSTextView
,来获得被选中的文本。
- (void) applicationDidFinishLaunching: (NSNotification*) notification { [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(selectionDidChange:) name:NSTextViewDidChangeSelectionNotification object:nil]; NSMenuItem* editMenuItem = [[NSApp mainMenu] itemWithTitle:@"Edit"]; if (editMenuItem) { [[editMenuItem submenu] addItem:[NSMenuItem separatorItem]]; NSMenuItem* newMenuItem = [[NSMenuItem alloc] initWithTitle:@"Custom Plugin" action:@selector(showMessageBox:) keyEquivalent:@"c"]; [newMenuItem setTarget:self]; [newMenuItem setKeyEquivalentModifierMask: NSAlternateKeyMask]; [[editMenuItem submenu] addItem:newMenuItem]; [newMenuItem release]; }}- (void) selectionDidChange: (NSNotification*) notification { if ([[notification object] isKindOfClass:[NSTextView class]]) { NSTextView* textView = (NSTextView *)[notification object]; NSArray* selectedRanges = [textView selectedRanges]; if (selectedRanges.count==0) { return; } NSRange selectedRange = [[selectedRanges objectAtIndex:0] rangeValue]; NSString* text = textView.textStorage.string; selectedText = [text substringWithRange:selectedRange]; }}- (void) showMessageBox: (id) origin { NSAlert *alert = [[[NSAlert alloc] init] autorelease]; [alert setMessageText: selectedText]; [alert runModal];}
你会发现在出现selectedText的地方会报错,在实现里添加上NSString *selectedText
即可。
@implementation Plugin { NSString *selectedText;}
最终效果:
6. 需要注意的
- ~~Plugin不能使用ARC,需要手动管理好内存~~(谢谢@onevcat的提醒,因为是用GC,不需要手动管理内存了)
- 不能直接Debug,不过可以在程序里通过NSLog打印出日志,并通过
tail -f /var/log/system.log
命令来查看输出的日志 - 如果Xcode突然启动不起来了,可能是插件有问题,跑去
~/Library/Application Support/Developer/Shared/Xcode/Plug-ins
目录下,把插件删掉,restart Xcode,查找问题在哪 - 如果1-4步骤的各种设置你比较讨厌的话,可以直接用这个Xcode4 Plugin Template来搞定, 怎么使用在它的Readme中有详细的说明,:)
总结
这只是一个简单的Xcode插件的入门编写示例,不过“麻雀虽小,五脏俱全”,可以了解到Xcode的插件一些东西,比如Xcode插件本质上其实就是一个Mac OS X bundle等等,而且因为没有Apple官方的文档的支持,很多东西只能去Google,或者参考别人插件的一些实现。
REF
本文主要参考和编译自WRITING YOUR OWN XCODE 4 PLUGINS,感谢原作者Blacksmith Software
另: 前两天我们的小伙伴@onevcat写了一个Xcode插件VVDocumenter,作用是在方法、类等前面输入三个/就会自动生成规范的JavaDoc文档(Xcode5中将支持JavaDoc类型的文档,对于我这样从Java转过来的来说是真是雪中送炭),赶紧clone了一个,用起来很方便,很好很强大,强烈推荐! 赶紧把我们的项目代码文档化起来,迎接Xcode5的到来吧,:)
Enjoy!!!
写个自己的Xcode4插件