ANTLR的IDE——ANTLRWorks2的安装及基本使用

曾经终败给现在 2024-02-19 15:45 5阅读 0赞

##### 1. ANTLRWorks2的简单介绍 #####

###### ① ANTLR官网对ANTLRWorks2的介绍 ######

> ANTLRWorks 2.此IDE是ANTLR v3 / v4语法以及StringTemplate模板的复杂编辑器。  
> 它可以运行ANTLR工具来生成识别器，并可以运行TestRig（在命令行上运行）来测试语法。  
> 要将ANTLR生成的识别器集成到您的应用程序中，您至少还需要运行时库。

###### ② ANTLRWorks 2官网对自己的介绍 ######

*  ANTLRWorks 2是Tunnel Vision Labs使用几种新技术开发的，可以对之前的语法工具进行完全重写。我们用于NetBeans®开发的核心框架最初是为该项目创建的，但很容易扩展到其他语言，并且是我们所有基于NetBeans的应用程序的起点。
 *  对ANTLR的支持——源代码图。编辑ANTLR语法文件时，“语法图”窗口显示当前规则的直观表示。此功能提供语法元素的自然表示，并且是提供自定义功能以增强特定语言的特征的示例。另外，双击源代码图中的元素将立即跳转到相关的源代码。ANTLR的语法图如图所示：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70]
 *  ANTLRWorks 2的编辑提示功能：ANTLRWorks 2提供编辑器提示，以警告开发人员语法编译器当前未检测到的语法中的潜在错误或性能问题。由于此类静态分析对每种语言都是唯一的，因此我们与语言创建者和用户合作，提供最有可能在开发周期早期检测到有问题代码的分析功能。ANTLRWorks中语法的当前分析功能包括以下内容：

（1）ANTLR 4工具报告的错误和警告在编辑器中“实时”显示 
    （2）识别解析器中的隐式标记定义（可能的错误）
    （3）因子标签超出集合（性能提示）
    （4）组集元素（性能提示）

*  antlrworks：**专门用于开发antlr的ide，（不同版本的antlrworks）其内部集成了某个版本的antlr。** 换句话说，你即使下载了antlr-x.x-complete.jar，将其添加到了CLASSPATH中，其也和antlrworks内部的antlr，没有半毛钱关系。即antlrworks用的是自己内部集成的某个版本的antlr。

参考链接：  
[ANTLR Development Tools（ANTLR官网）][ANTLR Development Tools_ANTLR]  
[ANTLRWorks 2][]

##### 2. ANTLRWorks2的下载 #####

*  进入ANTLRWorks2的官网，在右上角点击下载[ANTLRWorks2 V2.1][]。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 1]
 *  该版本是2013年8月28日发行的，内部集成的是`ANTLR 4.1`。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 2]
 *  解压下载的安装包 `2013-07-21-antlrworks-2.1.zip`，进入解压目录下的bin目录，我的是`C:\Users\lucy\Downloads\antlrworks2\bin`，点击`antlrworks2.exe`，即可运行antlrworks2。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 3]

##### 3. ANTLRWorks2的简单使用 #####

###### ① 新建\*.g4文件 ######

*  点击左上角的`新建`按钮，弹出“New File”窗口：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 4]
 *  默认为`ANLTR 4 Combined Grammar`就好，点击`Next`按钮，进入如下页面，输入自己的文件名、保存路径：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 5]
 *  点击“Finish”，完成文件创建：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 6]

###### ② ANTLRWorks2的语法图功能 ######

*  定义数字，由0-9组成（即词法分析器——Lexer），可以重复一次或多次：

grammar Cpp;
    	NUM:[0-9]+;

鼠标放到`NUM:[0-9]+;`行，显示对应的语法图：  
![在这里插入图片描述][20190112115652366.png]

*  定义操作符（即词法分析器——Lexer），包括加减乘除，只允许出现一次：

grammar Cpp;
        NUM:[0-9]+;
        OPERATOR: '-'|'*'|'/';

鼠标放到`OPRATOR：'+'|'-'|'*'|'/';`行，显示对应的语法图：  
![在这里插入图片描述][20190112120225261.png]

*  定义表达式（即语法分析器，Parser）：

grammar Cpp;
       PROG: exp;
       exp: NUM OPERATOR NUM;
       NUM:[0-9]+;
       OPERATOR: '-'|'*'|'/';

鼠标放到`exp: NUM OPERATOR NUM;`行，显示对应的语法图：  
![exp: NUM OPERATOR NUM;][exp_ NUM OPERATOR NUM]

*  文法定义的可视化：  
    ![在这里插入图片描述][20190112123529674.png]  
    **PS：** 本人探索发现：不知道是不是版本的问题，V2.1中使用`ANLTR 4 Combined Grammar`生成的文件，跟某些参考博客中不一样，V2.1中只显示`Parser Rules`。如果使用`ANLTR 4 Lexer Grammar`或`ANLTR 4 Parser Grammar`生成文件，`Parser Rules`和`Lexer Rules`都会显示。但是，在`ANLTR 4 Lexer Grammar`中定义parser规则会有错误提示，在`ANLTR 4 Parser Grammar`中定义Lexer规则也会有错误提示。

###### ③ 语法解析 ######

*  点击`Run-->Run in TestRig`，弹出如下窗口。在新窗口中输入要进行解析的文件，里面是待解析的内容；选择用哪个语法解析器进行解析，最后点击`Finish`。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 7]
 *  hello.txt中的内容为`101+2689`，解析出来的语法树（以弹窗的形式显示）如下。对应的命令为  
    `grun Cpp r -gui`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 8]
 *  TestRig的终端显示的信如下，对应的命令为`grun Cpp r -tree`：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 9]

###### ④ 小小的语法总结 ######

*  使用`大写字母`对`lexer`进行命名，使用`小写字母`对`parser`进行命名。
 *  使用`*`表示`0-N次重复`，使用`+`表示`1-N次重复`。

参考链接：  
[YouTube视频——ANTLRWorks（安装及使用教程）][YouTube_ANTLRWorks]  
[【总结】使用ANTLR和ANTLRWorks的开发心得和注意事项][ANTLR_ANTLRWorks]  
[【记录】尝试使用ANTLRWorks 2.0去进行ANTLR开发][ANTLRWorks 2.0_ANTLR]  
[Antlr 4.0和AntlrWorks开发环境配置][Antlr 4.0_AntlrWorks]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/e91b405322064553b763f3fcac6d2f70.png
[ANTLR Development Tools_ANTLR]: https://www.antlr.org/tools.html
[ANTLRWorks 2]: http://tunnelvisionlabs.com/products/demo/antlrworks
[ANTLRWorks2 V2.1]: http://tunnelvisionlabs.com/downloads/antlr/2013-07-21-antlrworks-2.1.zip
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/ec6e392d40194c218d847853242a8028.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/293c306a5919459ba42be5020b2c08fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/bc7bdb239c504303a0721e93de3d3070.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/c2bfacc7ec634484ac1efabebe68609c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/4e0620150e1749e2bbd7860a059eee95.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/151ce19ed2cd4326a5d30c0a1e43f704.png
[20190112115652366.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/d81776e578fb4b2b95a6e7241d5ca3fd.png
[20190112120225261.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/c2e2529f877441cba24bf90b100a145c.png
[exp_ NUM OPERATOR NUM]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/e338121199614a5086f460a6f9deb316.png
[20190112123529674.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/10dd410ac66b4d54a443d5c5508a69ac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/8888bac219f747d5949b178f4241326e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/ec821201585d4a54a5a8ea4636a08a29.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ0NTQ1Mzg_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/7a8bb45b6a234bcfae574c35fa331aa5.png
[YouTube_ANTLRWorks]: https://www.youtube.com/watch?v=THVzlzVUUdk
[ANTLR_ANTLRWorks]: https://www.crifan.com/summary_use_antlr_antlrworks_develop/
[ANTLRWorks 2.0_ANTLR]: https://www.crifan.com/try_with_antlrworks_2_to_do_antlr_dev/
[Antlr 4.0_AntlrWorks]: https://blog.csdn.net/shine_journey/article/details/17952163