打造一个头文件引用修复工具(修复引用文件路径为绝对路径)

前言

由于Xcode的习惯,很多OC代码中.h文件引用都是只写文件的,因为Xcode会自动查找该文件的真实位置再传递给编译器编译,但这种做法有个限制,就是必须把.h文件引用到项目中,不然会找到,笔者的问题也就源于此,出于个人习惯,我不喜欢把不需要修改的文件引用到项目中,特别是编译好的库,一般情况下都是只引用.a文件,然后包含一个头文件全部搞掂,即方便后期维护第三方库,也方便文件管理,鉴于手动修改的文件实在太多了,这种没含量的浪费时间行为,还是交给CPU吧,于是便有了此文.

(特别说明,此工具的作用是把#import "header.h",扩展为#import "../../include/header.h"的形式,如果没这个需求就不用向下看了)

正文

假设源引用是#import "header.h",然后该文件放在上两层的include目录中(也就是../../include/header.h),先整理一下思路,要找到.h文件,第一种是暴力法,枚举整个项目目录,把找到的文件填充进去,但感觉不是很好(感觉会有隐性BUG),第二种是先列举所有可用文件列表,再从列表中匹配,这种方法可自定义程度高,本文采用此法.

进行项目目录,用命令行find . -name "*.h">~/Desktop/1.txt && find . -name "*.m">>~/Desktop/1.txt把所有可能的文件生成列表(若有其它格式,继续添加,如.mm),打开.txt./替换为完整的路径,然后把文本拆解为单行的数组,也就是完整的文件路径,对每个文件进行读取,查找引用,替换引用,重新保存,过程如下:

  • 1.查找源文件目录中是否存在引用文件,若有,则优先使用.
  • 2.查找子目录中是否存在引用文件,若有,则优先使用.
  • 3.如源文件目录和子目录都找不到,则搜索切换到父目录重新执行,若枚举完所有路径都找不到,那就写入出错日志(代码中未实现,可自行添加).

代码如下,有什么疑问欢迎和我交流.

@interface SCCodeHelper : NSObject
+ (void)fixHeaderWithSourceFiles: (NSArray *)sourceFiles; // 参数为可用的文件列表
@end

// SCModel为一个简易模型转换对象,可在我的github找到
@interface SCCoderFixImportHeaderInfo : SCModel
@property (nonatomic, strong) NSString *codeFile;
@property (nonatomic, strong) NSMutableString *codeString;

@property (nonatomic, strong) NSArray *validHeaders;
@property (nonatomic, strong) NSString *originImportLine;

@property (nonatomic, strong, readonly) NSString *headerFileName;
@property (nonatomic, strong, readonly) NSString *codeFileDir;
@property (nonatomic, strong, readonly) NSString *codeFileName;
@end

@implementation SCCoderFixImportHeaderInfo
- (void)setValidHeaders:(NSArray *)validHeaders
{
    _validHeaders = validHeaders;
    _headerFileName = [_validHeaders.firstObject lastPathComponent];
}

- (void)setCodeFile:(NSString *)codeFile
{
    _codeFile = codeFile;
    _codeFileDir = [_codeFile regexpReplace:@"/[^/]+$" replace:@""];
    _codeFileName = [_codeFile lastPathComponent];
}
@end

@implementation SCCodeHelper
+ (void)fixHeaderWithSourceFiles: (NSArray *)sourceFiles
{
    NSArray *ebx = sourceFiles;
    
    SCCoderFixImportHeaderInfo *info = NewClass(SCCoderFixImportHeaderInfo);
    
    for (NSString *ecx in ebx)
    {
        if (0 == ecx.length) continue;
        
        NSMutableString *code = [NSMutableString stringWithContentsOfFile:ecx encoding:NSUTF8StringEncoding error:NULL];
        if (0 == code.length) continue;
        
        NSMutableDictionary *imports = [self getImports:code];
        if (0 == imports.count) continue;
        
        for (NSString *file in imports.allKeys)
        {
            NSArray *finds = [self find:file map:sourceFiles];
            if (0 == finds.count) continue;
            
            info.codeFile = ecx;
            info.codeString = code;
            info.validHeaders = finds;
            info.originImportLine = imports[file];
            
            BOOL state = [self fixCodeWithModel:info fbackLevel:0];
            if (state) [code writeToFile:ecx atomically:YES encoding:NSUTF8StringEncoding error:NULL];
            BreakPointHere;
        }
        
        BreakPointHere;
    }
}

+ (BOOL)fixCodeWithModel: (SCCoderFixImportHeaderInfo *)info fbackLevel: (NSUInteger)fbackLevel
{
    NSString *codeFileName = info.codeFileName;
    NSString *headerFileName = info.headerFileName;
    NSString *originImportLine = info.originImportLine;
    NSString *codeFileDir = info.codeFileDir;
    NSMutableString *codeString = info.codeString;
    NSArray *validHeaders = info.validHeaders;
    
    // 跳过绝对路径
    if (StringHasSubstring(originImportLine, @"/")) return NO;
    
    BOOL codeChanged = NO;
    BOOL result = NO;
    
    if (fbackLevel)
    {
        for (NSUInteger a = 0; a < fbackLevel; ++a)
        {
            codeFileDir = [codeFileDir regexpReplace:@"/[^/]+$" replace:@""];
        }
        BreakPointHere;
    }
    
    {
        // 看看同目录
        NSString *ebx = [NSString stringWithFormat:@"%@/%@", codeFileDir, headerFileName];
        for (NSString *eax in validHeaders)
        {
            if (NO == IsSameString(eax, ebx)) continue;
            
            NSString *ecx = @"";
            if (fbackLevel)
            {
                for (NSUInteger a = 0; a < fbackLevel; ++a)
                {
                    ecx = [NSString stringWithFormat:@"../%@", ecx];
                }
            }
            NSString *line = [NSString stringWithFormat:@"#import \"%@%@\"", ecx, headerFileName];
            
            if (NO == StringHasSubstring(originImportLine, line))
            {
                MLog(@"src: %@", codeFileName);
                MLog(@"fix: %@", originImportLine);
                MLog(@"to : %@", line);
                MLog(@"=========================================================");
                [codeString replaceOccurrencesOfString:originImportLine withString:line options:0 range:NSMakeRange(0, codeString.length)];
                codeChanged = YES;
            }
            
            result = YES;
            break;
        }
        
        if (result) return codeChanged;
    }
    
    // 看看子目录
    {
        for (NSString *eax in validHeaders)
        {
            if (NO == StringHasSubstring(eax, codeFileDir)) continue;
            
            NSString *buffer = [eax stringByReplacingOccurrencesOfString:codeFileDir withString:@""];
            buffer = [buffer regexpReplace:@"^/" replace:@""];
            
            NSString *ecx = @"";
            if (fbackLevel)
            {
                for (NSUInteger a = 0; a < fbackLevel; ++a)
                {
                    ecx = [NSString stringWithFormat:@"../%@", ecx];
                }
            }
            
            NSString *line = [NSString stringWithFormat:@"#import \"%@%@\"", ecx, buffer];
            
            if (NO == StringHasSubstring(originImportLine, line))
            {
                MLog(@"src: %@", codeFileName);
                MLog(@"fix: %@", originImportLine);
                MLog(@"to : %@", line);
                MLog(@"=========================================================");
                [codeString replaceOccurrencesOfString:originImportLine withString:line options:0 range:NSMakeRange(0, codeString.length)];
                codeChanged = YES;
            }
            
            result = YES;
            break;
        }
        
        if (result) return codeChanged;
    }
    
    // 看看上层目录
    {
        if (NO == [codeFileDir isEqualToString:@"/"])
        {
            codeChanged = [self fixCodeWithModel:info fbackLevel:fbackLevel+1];
            return codeChanged;
        }
    }
    
    LogAnything(codeFileDir);
    LogAnything(info.validHeaders);
    BreakPointHere;
    return NO;
}

+ (NSMutableArray *)find: (NSString *)file map: (NSArray *)map
{
    NSMutableArray *result = NewMutableArray();
    
    for (NSString *name in map)
    {
        NSString *eax = [NSString stringWithFormat:@"/%@", file];
        if ([name hasSuffix:eax])
        {
            [result addObject:name];
        }
    }
    
    if (0 == result.count) return nil;
    return result;
}

+ (NSMutableDictionary *)getImports: (NSString *)code
{
    NSArray *imps = [code regexpMatch:@"[\\r\\n]\\s*#import\\s+\\x22[^\\x22]+\\x22"];
    
    NSMutableDictionary *result = nil;
    if (imps.count) result = NewMutableDictionary();
    
    for (NSString *eax in imps)
    {
        NSString *file = [eax regexpMatch:@"\\x22[^\\x22]+\\x22"][0];
        file = [file stringByReplacingOccurrencesOfString:@"\"" withString:@""];
        
        result[file] = [eax regexpReplace:@"[\\r\\n]+" replace:@""];
    }
    
    return result;
}
@end
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容