基于Xcode8插件开发~一键检测处理头文件引用
Xcode8开放了新的一个Extension:Xcode Source Editor Extension,目的是让开发者可以正规的自主为IDE编写插件,虽然说系统现提供的功能还比较拮据,但是不妨碍我们了解和使用,本文主要介绍Xcode Source Editor Extension的功能,并演示一个简单的插件的实现~
一、实现功能
1.删除无用的类头文件,要求类名和文件名一致
2.删除重复导入的头文件,只保留一个
二、编写代码
1.新建项目,然后新建一个Target,类型选择Xcode Source Editor Extension,完成之后设置target的签名和项目的签名一致。
2.在info.plist中可以修改插件显示名称Bundle name和其它对Extension的设置。
3.系统默认为我们生成SourceEditorCommand文件,此处我们也可以在info里边修改配置项,类似于项目中系统生成的Main.storyboard。插件的重点基本在:
- (void)performCommandWithInvocation:(XCSourceEditorCommandInvocation *)invocation completionHandler:(void (^)(NSError * _Nullable nilOrError))completionHandler
用户调用我们的插件时,系统会回调这个方法,
XCSourceEditorCommandInvocation
Information about the source editor command that the user invoked, such as the identifier of the command, the text buffer on which the command is to operate, and whether the command has been canceled by Xcode or the user.
其中invocation.buffer是编辑器的全部文本
/** 当前编辑器的全部文件内容 */
@property (readonly, strong) NSMutableArray <NSString *> *lines;
/** 是当前选中的文本 */
@property (readonly, strong) NSMutableArray <XCSourceTextRange *> *selections;
我们在回调方法中编写如下代码:
//headerDict存放文本中所有的头文件
NSMutableDictionary <NSString*, NSNumber *>*headerDict = [NSMutableDictionary dictionary];
//willCheckDict存放将要删除的头文件
NSMutableDictionary <NSNumber*, NSString *>*willCheckDict = [NSMutableDictionary dictionary];
//遍历编辑器每一行
for (int idx = 0; idx < invocation.buffer.lines.count; idx++) {
NSString *lineCode = invocation.buffer.lines[idx];
//若willCheckDict文件不为空,则进行是否使用了该头文件的判断
if (willCheckDict.count > 0) {
[willCheckDict enumerateKeysAndObjectsUsingBlock:^(NSNumber * _Nonnull key, NSString * _Nonnull checkString, BOOL * _Nonnull stop) {
if ([lineCode containsString:checkString]) {
if (![lineCode containsString:@"#import"]) {
if ([headerDict[checkString] isEqualToNumber: @1]) {
//若使用了该头文件,则从willCheckDict字典中提出该项
[willCheckDict removeObjectForKey:key];
//同时设置该头文件已经检查过,若后续仍出现该头文件,则可以进行删除
headerDict[checkString] = @0;
}
}
}
}];
}
//检测代码是否含有#import为头文件标志;+号我们认为是类扩展的标志
if ([lineCode containsString:@"#import"] && ![lineCode containsString:@"+"]) {
//解析获取类名
NSRange range1 = [lineCode rangeOfString:@"\""];
NSRange range2 = [lineCode rangeOfString:@"\"" options:NSBackwardsSearch];
NSRange zeroRange = NSMakeRange(0, 0);
if (!(NSEqualRanges(range1, zeroRange) || NSEqualRanges(range2, zeroRange))) {
NSRange findRange = NSMakeRange(range1.location + 1, range2.location - range1.location - 3);
NSString *classString = [lineCode substringWithRange:findRange];
willCheckDict[@(idx)] = classString;
headerDict[classString] = @1;
}
}
}
//取出需要删除的行
NSMutableIndexSet *index = [NSMutableIndexSet indexSet];
[willCheckDict.allKeys enumerateObjectsUsingBlock:^(NSNumber * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
[index addIndex:obj.integerValue];
}];
//删除不符合条件的行
[invocation.buffer.lines removeObjectsAtIndexes:index];
//通知系统完成
completionHandler(nil);
三、测试结果
1.运行,选择Xcode8
2.可以看见灰色的Xcode实例。随便选择一个项目打开
3.测试。测试文件中含有未使用的头文件和冗余的头文件
4.Editor中选择插件运行
5.检验运行结果
啦啦啦,多余的头文件已经被成功检测到并且移除了了~
四、总结
至此,我们完成并测试通过了一个简单的Xcode插件的编写。主要目的是简单了解和使用Xcode8的插件,如果觉得有用,可以找到product里边的文件复制出来打开,然后在系统设置辅助功能中启用,最后在Xcode中绑定快捷键即可食用。当然,功能十分简陋,还请大神勿怪~
不足:受限于系统现有API,运行插件时,只能获取到当前编辑的文件,无法获取整个项目文件来分析,故很多功能暂时无法实现,如支持更加智能的检测等等,以后系统若能提供项目空间的文件访问和GUI支持,则插件可以发挥更大作用~
知识链:
WWDC2016
iOS 10 Day By Day: Xcode Source Editor Extensions
使用 Xcode Source Editor Extension开发Xcode 8 插件
欢迎加群讨论其它~:578874451
基于Xcode8插件开发~一键检测处理头文件引用的更多相关文章
- ArcCore重构-头文件引用问题的初步解决
基于官方arc-stable-9c57d86f66be,AUTOSAR版本3.1.5 基本问题 1. 头文件引用混乱,所有头文件通过从搜索路径(-I)中引用,存在名称污染问题,需加入路径信息: ...
- vscode中c/c++头文件引用找不到飘红
正在进行 GTK 学习, 但是在 vscode GTK 的头文件找不到(头文件引用底下飘红, 逼死强迫症), 影响敲字键入速度. 解决一下该问题-- vscode中c/c++头文件引用找不到(#inc ...
- 一键生成JNI头文件方法二
经常使用java的同学一定都接触过JNI(Java Native Interface)吧.JNI为我们提供了java<---->C/C++之间的接口,使得我们可以在java中调用C程序,以 ...
- Object-c 语法 - 头文件引用(@class/#import/#include)
一. Objective-C 中 #import 和 #include 的区别 预编译指令 Objective-C:#import:由gcc编译器支持 C,C++:#include 在 Objecti ...
- C语言头文件引用
1,引用分为两种 firs:include<fileName.h> 引用系统头文件一般用<>. second:include"fileName.h" 引用自 ...
- vc++中 .H 头文件引用的顺序与符号关系
在使用 #include "math.h" 和 #include <math.h>时,引号 与尖括号的区别如下 此时math.h_1 在工程文件中 math.h_2 ...
- VS2010 正则批量替换头文件路径
最近在项目实践中,需要统一对工程头文件进行重构,具体要求是,将之前 #include "../../abc/def.h" 类似的头文件引用路径 替换为#include &q ...
- 系统头文件cmath,cstdlib报错
>C:\Program Files (x86)\Microsoft Visual Studio\\Community\VC\Tools\MSVC\\include\cstdlib(): erro ...
- 引用其他头文件时出现这种错误,莫名其妙,error C2065: “ColorMatrix”: 未声明的标识符
今天做项目时,直接拷贝了另一个工程里的头文件和源文件,然后运行时就出现这种问题,莫名其妙,在原程序里运行一点问题就没有,但是在新工程里就是error. >e:\c++\button_fly2\b ...
随机推荐
- Firebug Console 与命令行全集
Console API 当打开 firebug (也包括 Chrome 等浏览器的自带调试工具),window 下面会注册一个叫做 console 的对象,它提供多种方法向控制台输出信息,供开发人员调 ...
- 定制化jQuery
毋庸置疑,jQuery很强大,很方便,但是......越来越臃肿,怎么办?,jquery只基于模块化开发的,可以通过工具定制jquery,选择你需要的模块即可. 下面这个网站可以帮你完成定制 http ...
- css---使用class和id
网页现在的新标准是W3C.目前的模式是html+css+javascript,如何理解呢,就是html是网页的结构,CSS是网页的样式,javascript是行为.结构就是盖房子先要把结构建出来,然后 ...
- Eclipse 安装插件
Eclipse 安装插件 本文介绍Eclipse插件的安装方法.Eclipse插件的安装方法大体有三种:直接复制.使用link文件,以及使用eclipse自带的图形界面的插件安装方法. AD: 做为当 ...
- Fruit Feast
Fruit Feast 题目描述 Bessie has broken into Farmer John's house again! She has discovered a pile of lemo ...
- offsetTop、clientTop、scrollTop、offsetTop各属性介绍
HTML精确定位:scrollLeft,scrollWidth,clientWidth,offsetWidth scrollHeight: 获取对象的滚动高度. scrollLeft:设置或获取位于对 ...
- nginx 设置进程title
刚好看到nginx设置进程title的源码,因此做一些总结. linux进程实际是以argv[0]处的值来作为进程的title的,因此若需要修改进程的title只需要修改argv[0]处的值即可. 简 ...
- Java——异常谜题
1.谜题36 try和finally语句,代码如下,判断输出 public class Indecisive { public static void main(String[] args) { S ...
- rsync+inotify实现数据的实时备份
一.rsync概述 1.1.rsync的优点与不足 rsync与传统的cp.tar备份方式相比,rsync具有安全性高.备份迅速.支持增量备份等优点,通过rsync可以解决对实时性要求不高的数据备份需 ...
- NBUT 1457 Sona
莫队算法+离散化 1.map会TLE,必须离散化做 2.long long会WA,__int64定义 %I64d输出输出能AC 3.注意输入的序列会爆int #include<cstdio> ...