antlr.v4.runtime.tree.ParseTreeListener source code

1 /*
2  * [The "BSD license"]
3  *  Copyright (c) 2012 Terence Parr
4  *  Copyright (c) 2012 Sam Harwell
5  *  Copyright (c) 2017 Egbert Voigt
6  *  All rights reserved.
7  *
8  *  Redistribution and use in source and binary forms, with or without
9  *  modification, are permitted provided that the following conditions
10  *  are met:
11  *
12  *  1. Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer.
14  *  2. Redistributions in binary form must reproduce the above copyright
15  *     notice, this list of conditions and the following disclaimer in the
16  *     documentation and/or other materials provided with the distribution.
17  *  3. The name of the author may not be used to endorse or promote products
18  *     derived from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 module antlr.v4.runtime.tree.ParseTreeListener;
33 
34 import antlr.v4.runtime.ParserRuleContext;
35 import antlr.v4.runtime.tree.ErrorNode;
36 import antlr.v4.runtime.tree.TerminalNode;
37 
38 // Interface ParseTreeListener
39 /**
40  * @uml
41  * This interface describes the minimal core of methods triggered
42  * by {@link ParseTreeWalker}. E.g.,
43  *
44  *     ParseTreeWalker walker = new ParseTreeWalker();
45  *          walker.walk(myParseTreeListener, myParseTree); <-- triggers events in your listener
46  *
47  * If you want to trigger events in multiple listeners during a single
48  * ree walk, you can use the ParseTreeDispatcher object available at
49  *
50  *         https://github.com/antlr/antlr4/issues/841
51  */
52 interface ParseTreeListener
53 {
54 
55     public void visitTerminal(TerminalNode node);
56 
57     public void visitErrorNode(ErrorNode node);
58 
59     public void enterEveryRule(ParserRuleContext ctx);
60 
61     public void exitEveryRule(ParserRuleContext ctx);
62 
63 }