ANTLR4 C++ Listener未调用重写的enterRule方法求助

使用C++版ANTLR4的Listener遍历语法树时遇到以下问题：

• 程序正常进入ParseTreeWalker::walk()，调用getText()能获取输入的所有Token；
• 重写的visitTerminal方法正常输出，但enterDocument、enterLine方法完全未被触发（断点和std::cout均无输出）；
• 调试时观察到ctx->enterRule(listener)直接返回，且ctx类型显示正确。

附相关代码片段：

生成的BaseListener代码 #

#include "antlr4-runtime.h"
#include "MyDCXParserListener.h"

class  MyDCXParserBaseListener : public MyDCXParserListener {
public:

  virtual void enterDocument(MyDCXParser::DocumentContext * /*ctx*/) override { }
  virtual void exitDocument(MyDCXParser::DocumentContext * /*ctx*/) override { }

  virtual void enterLine(MyDCXParser::LineContext * /*ctx*/) override { }
  virtual void exitLine(MyDCXParser::LineContext * /*ctx*/) override { }
    
  virtual void enterEveryRule(antlr4::ParserRuleContext * /*ctx*/) override { }
  virtual void exitEveryRule(antlr4::ParserRuleContext * /*ctx*/) override { }
  virtual void visitTerminal(antlr4::tree::TerminalNode * /*node*/) override { }
  virtual void visitErrorNode(antlr4::tree::ErrorNode * /*node*/) override { }
};

自定义Listener头文件 #

#include "antlr4-runtime.h"
#include "MyDCXParser.h"
#include "MyDCXParserBaseListener.h"

#include <iostream>
using namespace std;

class MyDCXListener : public MyDCXParserBaseListener
{
private:
public:

    MyDCXListener();
    ~MyDCXListener();

    MyDCXListener(const MyDCXListener&) = delete;
    MyDCXListener& operator=(const MyDCXListener&) = delete;

    void enterDocument(MyDCXParser::DocumentContext * /*ctx*/) override;
    void exitDocument(MyDCXParser::DocumentContext * /*ctx*/) override {}

    void enterLine(MyDCXParser::LineContext * /*ctx*/) override;
    void exitLine(MyDCXParser::LineContext * /*ctx*/) override {}
    
    void visitTerminal(antlr4::tree::TerminalNode *node) override { std::cout << "visitTerminal(): '" << node->getText().c_str() << std::endl; }
};

自定义Listener实现文件 #

#include "MyDCXListener.h"

MyDCXListener::MyDCXListener()
{
}

MyDCXListener::~MyDCXListener()
{
}

void MyDCXListener::enterDocument(MyDCXParser::DocumentContext * ctx)
{
    std::cout << "MyDCXListener::enterDocument()" << std::endl; 
}

void MyDCXListener::enterLine(MyDCXParser::LineContext * ctx)
{
    std::cout << "MyDCXListener::enterLine()" << std::endl; 
}

1. 验证语法规则是否匹配输入 #

ANTLR仅在输入完全匹配对应语法规则时，才会触发Listener的enterXXX/exitXXX方法。可以通过以下方式验证：

• 调用解析器的document()方法后，检查返回的DocumentContext*是否为nullptr，若为空则说明输入未匹配Document规则；
• 开启解析轨迹日志，查看规则触发情况：

  parser.setBuildParseTree(true);
  parser.getInterpreter()->setTrace(true);
  

  运行程序后会输出详细的解析过程，确认Document和Line规则是否被实际触发。

2. 检查Listener实例传递是否正确 #

确保ParseTreeWalker::walk()传入的是自定义MyDCXListener的实例，而非基类MyDCXParserBaseListener的实例：

• 错误示例：

  MyDCXParserBaseListener listener;
  ParseTreeWalker::DEFAULT.walk(&listener, parser.document());
  

• 正确示例：

  MyDCXListener listener;
  ParseTreeWalker::DEFAULT.walk(&listener, parser.document());
  

3. 确认方法重写签名完全一致 #

检查自定义Listener中enterDocument和enterLine的方法签名是否与基类完全匹配：

• 确保参数类型（如MyDCXParser::DocumentContext*）完全一致；
• 确认override关键字正确添加，开启C++11及以上编译选项时，签名不匹配会触发编译警告/错误，可查看编译日志排查。

4. 验证语法树完整性 #

调用语法树的toStringTree方法打印完整结构，确认是否包含Document和Line节点：

std::cout << parser.document()->toStringTree(&parser) << std::endl;

如果输出的语法树中没有对应节点，说明解析过程未生成规则节点，自然不会触发Listener的enter方法。

内容的提问来源于stack exchange，提问作者Jay Zee