前言
本部分介绍这份代码的背后故事,想看干货可直接跳过。
前几天,良许正在开心的写代码,突然,一个帝都的小伙加了我,向我请教如何写字符串替换的程序,类似于记事本里的文本替换功能。我一看这个需求,不是很难,就告诉了他思路。但他经验有限,一时写不出来,就希望我能帮他写好。
良许是一个乐于助人的人,但帮人写代码这个事……真的不是我所想的,因为这样对方得不到成长。看他一愁莫展的样子,我想到了当年我转行时的样子,遇到困难,想自己解决却无能为力,每次都是我的恩师出手相助,才让我脱离困境。
我很理解他的处境,跟我当年何其相似。于是我心一软,牺牲了自己的午睡时间,帮他把代码写好。不仅如此,晚上还花了二十分钟的时间,帮他把代码讲解清楚。
然后我想到,这个代码或许其他人也有需要,于是我把这个代码及思路共享出来,帮助有需要的人。
需求
将一个文本里的内容读出来,把里面的某个字符串替换成另一个字符串,再将内容回写回文本里。
这个需求很简单,使用更高级的语言,比如Python,Java,可能只需一两句话就可以了,但对C语言来说可能就比较没那么好实现。这里涉及到一些指针的应用,对指针要求比较高一些。
思路分析
开辟两块内存,分别用于存储处理前的字符串(ori_str)及处理后的字符串(rst_str)。替换的时候,将无需替换的字符串拷备至rst_str,再将新字符串填入到需要替换的字符串的位置,如下图示:
代码详解
完整的代码请在公众号内回复:0605,即可获取。
1. 前半部分,包括入参检查、打开文件、计算文本长度、由文本长度开辟内存空间、读取文件内容,这些都不是很难,在此稍微介绍几个语句:
1.1 计算文本长度
在读取文本之前,一开始并不知道文本长度多少,所以没办法知道需要开辟多少空间。为了获取文件长度,可使用lseek函数,具体用法如下:
1int file_len = lseek(fd, 0, SEEK_END); 2lseek(fd, 0, SEEK_SET);
1.2 清空文件
文本处理完毕之后,要将结果回写回文件,所以在此之前应该清空文件,否则可能原先的文本会有所残留,不会达到预期效果。
可以使用ftruncate函数清空文件,但要注意,清空完之后文件指针是指到文件末尾,需手动把文件指针移回文件头部,否则写入文件的时候,会在原先的文件末尾再追加写入,不符合我们的预期。
1ftruncate(fd, 0);
2. 替换的时候,新字符串(new_str)与旧字符串(old_str)长度不一致,所以处理之后的字符串(rst_str)长度不一定跟处理前的字符串(ori_str)长度相同。那要分配多少空间给rst_str呢?我们可以这样计算rst_str的长度rst_str_len:
1int rst_str_len = file_len + n * abs(strlen(new_str) - strlen(old_str)) + 1;
其中n为匹配的字符串的个数。简而言之,就是计算new_str与old_str长度的差值,再乘以匹配的字符串个数n,然后加上处理前字符串长度,就是rst_str的长度。多加一个1是为了预留一个字符的空间用于存放'\0'。
对于n的计算,单独写了个substr_count函数来进行。原理很简单,就是在while循环里不断调用strstr来找到匹配的字符串,找到一个就n++,直到文件末尾。
3. 本程序的关键在于str_replace函数的while循环。这部分文字描述太苍白,直接上图:
1while ((end_ptr = strstr(begin_ptr, old_str)) != NULL) { 2 memcpy(cpy_str, begin_ptr, end_ptr - begin_ptr); 3 cpy_str += (end_ptr - begin_ptr); 4 memcpy(cpy_str, new_str, strlen(new_str)); 5 cpy_str += strlen(new_str); 6 end_ptr += strlen(old_str); 7 begin_ptr = end_ptr; 8} 9strcpy(cpy_str, begin_ptr);
4. 字符串处理完毕之后,将rst_str回写到文件即可。回写之前别忘了将文本指针指回文件起始位置,因为我们之前调用了ftruncate,文件指针此时正在文件末尾。