深入理解 fnmatch 函数的实现
0、背景
fnmatch 函数是 C 标准库和 POSIX 中用于匹配文件路径的工具,它使得我们能够根据模式字符串对文件名进行模式匹配。常见的用途包括在文件系统中查找符合某种模式(如通配符)的文件。例如,fnmatch(“.txt", “file1.txt”) 应该返回 true,而 fnmatch(".txt”, “file1.pdf”) 应该返回 false。该函数中模式和规则和shell中模式的规则类似,该函数可以用做简单的字符串匹配,如果需要复杂的字符串匹配,需要使用正则表达式进行匹配。
1、fnmatch函数概述
fnmatch 函数的原型通常如下:
#include <fnmatch.h>
int fnmatch(const char *pattern, const char *string, int flags);
参数说明:
- pattern:这是包含模式匹配的通配符的字符串(例如 *.txt),它指示了要匹配的文件名的模式。
- string:要进行匹配的文件名或字符串。
- flags:指定匹配的选项(如是否区分大小写,是否支持正则表达式等)。常见的 flags 包括:
FNM_CASEFOLD:忽略大小写。
FNM_PATHNAME:仅匹配路径分隔符(通常是 /)的部分。
FNM_PERIOD:.只能以明文进行匹配,不可以再使用?或*进行匹配。
FNM_NOESCAPE:不允许使用转义字符
返回值: - 如果字符串 string 与 pattern 匹配,则返回 0。
- 如果不匹配,则返回非零值(通常为 1)。
- 如果出现错误,则返回 -1。
常见用途: - 在 Unix/Linux 系统中,它通常用于文件名通配符匹配。
- 在编写 shell 程序或命令行工具时,经常用来处理文件查找和匹配操作。
2、fnmatch的匹配规则
在深入了解 fnmatch 的实现之前,我们需要理解它如何进行模式匹配。fnmatch 使用的匹配规则类似于传统的 Unix shell 通配符规则。
- *:匹配零个或多个字符。
- ?:匹配一个字符。
- []:匹配指定范围内的一个字符(例如 [a-z] 匹配所有小写字母)。
- \:转义字符,允许匹配实际的 *、? 或其他特殊字符。
3、fnmatch 函数的实现原理
该函数的主要工作流程如下:
1、遍历模式字符:逐个检查模式中的字符,根据规则判断是通配符(*、? 等)还是普通字符。
2、处理通配符:
- *:可以匹配零个或多个字符,因此需要递归地尝试不同的匹配方式。
- ?:匹配一个字符,可以直接比较当前字符是否匹配。
- []:检查字符是否在给定范围内。
- \:跳过转义字符,匹配下一个字符。
3、字符匹配:当遇到普通字符时,直接比较当前字符和模式字符。
4、返回结果:当所有字符都成功匹配时返回 0;否则返回 1。
下面代码实现了一个简化版的fnmatch函数。
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <iostream>
// 匹配函数:简化版 fnmatch 实现
int fnmatch(const char *pattern, const char *string, int flags = 0) {
while (*pattern) {
if (*pattern == '*') {
// '*' 匹配零个或多个字符
if (*(pattern + 1) == '\0') {
return 0; // 如果 '*' 后面没有字符,说明匹配成功
}
// 尝试匹配零个或多个字符
while (*string) {
if (fnmatch(pattern + 1, string, flags) == 0) {
return 0;
}
string++;
}
return 1; // 如果没有匹配到,返回 1
} else if (*pattern == '?') {
// '?' 匹配一个字符
if (*string) {
pattern++;
string++;
} else {
return 1; // 如果 string 已结束,但模式还没有结束,返回不匹配
}
} else if (*pattern == '[') {
// 字符集匹配,如 [a-z] 或 [0-9]
const char *closing_bracket = strchr(pattern, ']');
if (!closing_bracket) {
return 1; // 如果没有找到匹配的 ']'
}
// 检查字符是否在字符集范围内
int matched = 0;
pattern++; // 跳过 '['
while (pattern < closing_bracket) {
if (*pattern == '-') {
if(*(pattern-1) != '[' && *(pattern + 1) != ']' && *(pattern - 1) < *string && *(pattern + 1) > *string) {
matched = 1;
break;
}
} else if (*pattern == *string) {
matched = 1;
break;
}
pattern++;
}
if (!matched) {
return 1; // 如果字符不在字符集内,返回不匹配
}
pattern = closing_bracket + 1;
string++;
} else {
// 普通字符匹配
if (*pattern == *string) {
pattern++;
string++;
} else {
return 1; // 如果普通字符不匹配,返回 1
}
}
}
// 如果模式和字符串都遍历完,表示完全匹配
return (*pattern == '\0' && *string == '\0') ? 0 : 1;
}
int main() {
// 测试用例
printf("Test 1: %d\n", fnmatch("*.txt", "file.txt")); // Expected output: 0 (match)
printf("Test 2: %d\n", fnmatch("file?.txt", "file1.txt")); // Expected output: 0 (match)
printf("Test 3: %d\n", fnmatch("file[0-9].txt", "file5.txt")); // Expected output: 0 (match)
printf("Test 4: %d\n", fnmatch("file[0-9].txt", "fileA.txt")); // Expected output: 1 (no match)
printf("Test 5: %d\n", fnmatch("file?.txt", "file12.txt")); // Expected output: 1 (no match)
return 0;
}
4、结论
fnmatch 是一个功能强大的文件名匹配函数,它可以处理常见的通配符模式,并且在许多操作系统中得到了广泛应用。在实现时,它使用递归回溯的方式处理通配符(如 * 和 ?),并且支持字符集范围匹配([])。如果是简单的字符串匹配,可以使用这个函数,如果是复杂的字符串匹配,建议使用前面介绍的正则表达式库。因为fastdds源码中用到了这个函数实现字符串匹配,学习总结一下,接下来就要啃fastdds中的核心rtps了,加油,小安。