xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/verilog/VerilogLexer.java (revision 5d9f3aa0ca3da3a714233f987fa732f62c0965f6)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * See LICENSE.txt included in this distribution for the specific
9  * language governing permissions and limitations under the License.
10  *
11  * When distributing Covered Code, include this CDDL HEADER in each
12  * file and include the License file at LICENSE.txt.
13  * If applicable, add the following below this CDDL HEADER, with the
14  * fields enclosed by brackets "[]" replaced with your own identifying
15  * information: Portions Copyright [yyyy] [name of copyright owner]
16  *
17  * CDDL HEADER END
18  */
19 
20 /*
21  * Copyright (c) 2019, Chris Fraire <cfraire@me.com>.
22  */
23 package org.opengrok.indexer.analysis.verilog;
24 
25 import org.opengrok.indexer.analysis.JFlexJointLexer;
26 import org.opengrok.indexer.analysis.JFlexSymbolMatcher;
27 import org.opengrok.indexer.analysis.Resettable;
28 
29 /**
30  * Represents an abstract base class for SystemVerilog lexers.
31  */
32 @SuppressWarnings("Duplicates")
33 abstract class VerilogLexer extends JFlexSymbolMatcher
34         implements JFlexJointLexer, Resettable {
35 
36     /**
37      * Calls {@link #phLOC()} if the yystate is not COMMENT or SCOMMENT.
38      */
chkLOC()39     public void chkLOC() {
40         if (yystate() != COMMENT() && yystate() != SCOMMENT()) {
41             phLOC();
42         }
43     }
44 
45     /**
46      * Subclasses must override to get the constant value created by JFlex to
47      * represent COMMENT.
48      */
COMMENT()49     abstract int COMMENT();
50 
51     /**
52      * Subclasses must override to get the constant value created by JFlex to
53      * represent SCOMMENT.
54      */
SCOMMENT()55     abstract int SCOMMENT();
56 }
57