Skip to content

A Regex engine which is implemented in a traditional way and able to generate graphics of finite automation.

Notifications You must be signed in to change notification settings

cucurryx/regex-engine

Repository files navigation

regex-engine

简介

这是一个简单的正则引擎,支持大部分纯正则表达式的语法。主要功能就是解析一个正则表达式,来得到一个自动机,并优化。然后根据这个自动机来对字符串来进行匹配,判断是否符合正则表达式。实现方式采用了regex -> nfa -> dfa -> minimal dfa的经典实现方式。

另外,为了更加直观地观察我们生成的自动机,借助于GraphViz工具,还实现了图形化NFA和DFA的功能。

编译环境

编译器: gcc 7.2.0 GNU Make 4.1 Built for x86_64-pc-linux-gnu

依赖安装(ubuntu)

  • gcc安装: sudo apt-get install gcc
  • make安装: sudo apt-get install make
  • graphviz安装: sudo apt-get install graphviz
  • google-test安装: 参见文档

使用说明

建议在Linux环境下使用,make test编译测试文件,./test运行测试。make regex_engine编译正则引擎,./regex_engine运行,输入正则表达式,然后输入字符串判断是否匹配。

对于输入的每个正则表达式,都会生成对应的图保存在graph目录下,但是只是.dot文件,需要使用GraphViz工具来生成图像。

如果需要生成图像,需要安装GraphViz这个程序。如果在Linux环境下安装,可以使用sudo apt-get install graphviz安装。

GraphViz根据dot文件来生成图像,.dot文件保存在graph目录下,使用命令dot <filename> -T png -o graphname.png来生成.png格式的图像。

或者,可以运行python脚本generate_graph.py来自动生成图像。

程序结构

Regex expression ===> NFA ===> DFA ===> Minimal DFA ===> Recognizer

使用递归下降的方法来parse正则表达式,用Thompson算法构造出NFA。然后,使用子集构造算法从NFA构造出DFA。最后,使用Hopcroft’s Algorithm来简化DFA。利用最后得到的自动机,来进行匹配。

parse部分参考了这篇文章的正则表达式语法描述:

<RE>	::=	<union> | <simple-RE>
<union>	::=	<RE> "|" <simple-RE>
<simple-RE>	::=	<concatenation> | <basic-RE>
<concatenation>	::=	<simple-RE> <basic-RE>
<basic-RE>	::=	<star> | <plus> | <elementary-RE>
<star>	::=	<elementary-RE> "*"
<plus>	::=	<elementary-RE> "+"
<elementary-RE>	::=	<group> | <any> | <eos> | <char> | <set>
<group>	::=	"(" <RE> ")"
<any>	::=	"."
<eos>	::=	"$"
<char>	::=	any non metacharacter | "\" metacharacter
<set>	::=	<positive-set> | <negative-set>
<positive-set>	::=	"[" <set-items> "]"
<negative-set>	::=	"[^" <set-items> "]"
<set-items>	::=	<set-item> | <set-item> <set-items>
<set-items>	::=	<range> | <char>
<range>	::=	<char> "-" <char>
  • NFA的数据结构和构造NFA相关函数在nfa.h和nfa.cc中声明和实现
  • DFA在dfa.h和dfa.cc中实现。
  • Regex的parser在parser.h和parser.cc中实现

另外,./test.cc中包含了对各个部分的测试。

示例

Command-line

xvvx-regex> (a|b)c
string to match: ac
match!
xvvx-regex> ([a-z])+\*
string to match: abcde*
match!
xvvx-regex> (a?\?)?
string to match: a?
match!

图像生成

使用这段代码调用接口来生成图:

    //接口调用部分
    RegexParser parser;
    Nfa *nfa = parser.ParseToNfa("a|b|c*");
    graph_generator::GenerateGraph("example", nfa);

然后在shell中使用GraphViz工具:

 dot graphs/example.dot -Tpng -o graphs/example_nfa.png

最后在graphs目录下,可以看到我们生成的图像:

example_nfa.png

通过子集构造算法得到的DFA图像: example_dfa.png

TODO

  • 用内存池来管理内存,NFA结点直接从内存池获取内存。
  • 支持正向预查、反向预查、匿名捕获、命名捕获、边界和非贪婪重复等扩展正则表达式的功能。
  • 生成表示NFA和DFA的图像。

About

A Regex engine which is implemented in a traditional way and able to generate graphics of finite automation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages