xref: /OpenGrok/opengrok-indexer/src/main/jflex/analysis/ruby/RubySymbolTokenizer.lex (revision d219b4cea555a12b602d2d5518daa22134ad4879)
1*d219b4ceSAdam Hornacek /*
2*d219b4ceSAdam Hornacek  * CDDL HEADER START
3*d219b4ceSAdam Hornacek  *
4*d219b4ceSAdam Hornacek  * The contents of this file are subject to the terms of the
5*d219b4ceSAdam Hornacek  * Common Development and Distribution License (the "License").
6*d219b4ceSAdam Hornacek  * You may not use this file except in compliance with the License.
7*d219b4ceSAdam Hornacek  *
8*d219b4ceSAdam Hornacek  * See LICENSE.txt included in this distribution for the specific
9*d219b4ceSAdam Hornacek  * language governing permissions and limitations under the License.
10*d219b4ceSAdam Hornacek  *
11*d219b4ceSAdam Hornacek  * When distributing Covered Code, include this CDDL HEADER in each
12*d219b4ceSAdam Hornacek  * file and include the License file at LICENSE.txt.
13*d219b4ceSAdam Hornacek  * If applicable, add the following below this CDDL HEADER, with the
14*d219b4ceSAdam Hornacek  * fields enclosed by brackets "[]" replaced with your own identifying
15*d219b4ceSAdam Hornacek  * information: Portions Copyright [yyyy] [name of copyright owner]
16*d219b4ceSAdam Hornacek  *
17*d219b4ceSAdam Hornacek  * CDDL HEADER END
18*d219b4ceSAdam Hornacek  */
19*d219b4ceSAdam Hornacek 
20*d219b4ceSAdam Hornacek /*
21*d219b4ceSAdam Hornacek  * Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
22*d219b4ceSAdam Hornacek  * Portions Copyright (c) 2017, 2019, Chris Fraire <cfraire@me.com>.
23*d219b4ceSAdam Hornacek  */
24*d219b4ceSAdam Hornacek 
25*d219b4ceSAdam Hornacek /*
26*d219b4ceSAdam Hornacek  * Gets Ruby symbols - ignores comments, strings, keywords
27*d219b4ceSAdam Hornacek  */
28*d219b4ceSAdam Hornacek 
29*d219b4ceSAdam Hornacek package org.opengrok.indexer.analysis.ruby;
30*d219b4ceSAdam Hornacek 
31*d219b4ceSAdam Hornacek import java.io.IOException;
32*d219b4ceSAdam Hornacek import java.util.regex.Pattern;
33*d219b4ceSAdam Hornacek import org.opengrok.indexer.util.StringUtils;
34*d219b4ceSAdam Hornacek import org.opengrok.indexer.web.HtmlConsts;
35*d219b4ceSAdam Hornacek %%
36*d219b4ceSAdam Hornacek %public
37*d219b4ceSAdam Hornacek %class RubySymbolTokenizer
38*d219b4ceSAdam Hornacek %extends RubyLexer
39*d219b4ceSAdam Hornacek %unicode
40*d219b4ceSAdam Hornacek %int
41*d219b4ceSAdam Hornacek %char
42*d219b4ceSAdam Hornacek %include ../CommonLexer.lexh
43*d219b4ceSAdam Hornacek %{
44*d219b4ceSAdam Hornacek     private String lastSymbol;
45*d219b4ceSAdam Hornacek 
46*d219b4ceSAdam Hornacek     /**
47*d219b4ceSAdam Hornacek      * Resets the Ruby tracked state; {@inheritDoc}
48*d219b4ceSAdam Hornacek      */
49*d219b4ceSAdam Hornacek     @Override
reset()50*d219b4ceSAdam Hornacek     public void reset() {
51*d219b4ceSAdam Hornacek         super.reset();
52*d219b4ceSAdam Hornacek         lastSymbol = null;
53*d219b4ceSAdam Hornacek     }
54*d219b4ceSAdam Hornacek 
55*d219b4ceSAdam Hornacek     @Override
offer(String value)56*d219b4ceSAdam Hornacek     public void offer(String value) throws IOException {
57*d219b4ceSAdam Hornacek         // noop
58*d219b4ceSAdam Hornacek     }
59*d219b4ceSAdam Hornacek 
60*d219b4ceSAdam Hornacek     @Override
offerSymbol(String value,int captureOffset,boolean ignoreKwd)61*d219b4ceSAdam Hornacek     public boolean offerSymbol(String value, int captureOffset,
62*d219b4ceSAdam Hornacek         boolean ignoreKwd)
63*d219b4ceSAdam Hornacek             throws IOException {
64*d219b4ceSAdam Hornacek         if (nameLength(value) <= 0) {
65*d219b4ceSAdam Hornacek             lastSymbol = null;
66*d219b4ceSAdam Hornacek         } else if (ignoreKwd || !Consts.kwd.contains(value)) {
67*d219b4ceSAdam Hornacek             lastSymbol = value;
68*d219b4ceSAdam Hornacek             onSymbolMatched(value, yychar + captureOffset);
69*d219b4ceSAdam Hornacek             return true;
70*d219b4ceSAdam Hornacek         } else {
71*d219b4ceSAdam Hornacek             lastSymbol = null;
72*d219b4ceSAdam Hornacek         }
73*d219b4ceSAdam Hornacek         return false;
74*d219b4ceSAdam Hornacek     }
75*d219b4ceSAdam Hornacek 
76*d219b4ceSAdam Hornacek     @Override
skipSymbol()77*d219b4ceSAdam Hornacek     public void skipSymbol() {
78*d219b4ceSAdam Hornacek         lastSymbol = null;
79*d219b4ceSAdam Hornacek     }
80*d219b4ceSAdam Hornacek 
81*d219b4ceSAdam Hornacek     @Override
offerKeyword(String value)82*d219b4ceSAdam Hornacek     public void offerKeyword(String value) throws IOException {
83*d219b4ceSAdam Hornacek         lastSymbol = null;
84*d219b4ceSAdam Hornacek     }
85*d219b4ceSAdam Hornacek 
86*d219b4ceSAdam Hornacek     @Override
startNewLine()87*d219b4ceSAdam Hornacek     public void startNewLine() throws IOException {
88*d219b4ceSAdam Hornacek         // noop
89*d219b4ceSAdam Hornacek     }
90*d219b4ceSAdam Hornacek 
91*d219b4ceSAdam Hornacek     @Override
disjointSpan(String className)92*d219b4ceSAdam Hornacek     public void disjointSpan(String className) throws IOException {
93*d219b4ceSAdam Hornacek         // noop
94*d219b4ceSAdam Hornacek     }
95*d219b4ceSAdam Hornacek 
96*d219b4ceSAdam Hornacek     @Override
phLOC()97*d219b4ceSAdam Hornacek     public void phLOC() {
98*d219b4ceSAdam Hornacek         // noop
99*d219b4ceSAdam Hornacek     }
100*d219b4ceSAdam Hornacek 
101*d219b4ceSAdam Hornacek     /**
102*d219b4ceSAdam Hornacek      * If the state is YYINITIAL, then transitions to INTRA; otherwise does
103*d219b4ceSAdam Hornacek      * nothing, because other transitions would have saved the state.
104*d219b4ceSAdam Hornacek      */
maybeIntraState()105*d219b4ceSAdam Hornacek     public void maybeIntraState() {
106*d219b4ceSAdam Hornacek         if (yystate() == YYINITIAL) yybegin(INTRA);
107*d219b4ceSAdam Hornacek     }
108*d219b4ceSAdam Hornacek 
takeAllContent()109*d219b4ceSAdam Hornacek     protected boolean takeAllContent() {
110*d219b4ceSAdam Hornacek         return false;
111*d219b4ceSAdam Hornacek     }
112*d219b4ceSAdam Hornacek 
returnOnSymbol()113*d219b4ceSAdam Hornacek     protected boolean returnOnSymbol() {
114*d219b4ceSAdam Hornacek         return lastSymbol != null;
115*d219b4ceSAdam Hornacek     }
116*d219b4ceSAdam Hornacek 
skipLink(String url,Pattern p)117*d219b4ceSAdam Hornacek     protected void skipLink(String url, Pattern p) {
118*d219b4ceSAdam Hornacek         int n = StringUtils.countPushback(url, p);
119*d219b4ceSAdam Hornacek         if (n > 0) yypushback(n);
120*d219b4ceSAdam Hornacek     }
121*d219b4ceSAdam Hornacek 
122*d219b4ceSAdam Hornacek     /**
123*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent QUOxLxN.
124*d219b4ceSAdam Hornacek      */
125*d219b4ceSAdam Hornacek     @Override
QUOxLxN()126*d219b4ceSAdam Hornacek     int QUOxLxN() { return QUOxLxN; }
127*d219b4ceSAdam Hornacek 
128*d219b4ceSAdam Hornacek     /**
129*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent QUOxN.
130*d219b4ceSAdam Hornacek      */
131*d219b4ceSAdam Hornacek     @Override
QUOxN()132*d219b4ceSAdam Hornacek     int QUOxN() { return QUOxN; }
133*d219b4ceSAdam Hornacek 
134*d219b4ceSAdam Hornacek     /**
135*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent QUOxL.
136*d219b4ceSAdam Hornacek      */
137*d219b4ceSAdam Hornacek     @Override
QUOxL()138*d219b4ceSAdam Hornacek     int QUOxL() { return QUOxL; }
139*d219b4ceSAdam Hornacek 
140*d219b4ceSAdam Hornacek     /**
141*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent QUO.
142*d219b4ceSAdam Hornacek      */
143*d219b4ceSAdam Hornacek     @Override
QUO()144*d219b4ceSAdam Hornacek     int QUO() { return QUO; }
145*d219b4ceSAdam Hornacek 
146*d219b4ceSAdam Hornacek     /**
147*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent HEREinxN.
148*d219b4ceSAdam Hornacek      */
149*d219b4ceSAdam Hornacek     @Override
HEREinxN()150*d219b4ceSAdam Hornacek     int HEREinxN() { return HEREinxN; }
151*d219b4ceSAdam Hornacek 
152*d219b4ceSAdam Hornacek     /**
153*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent HERExN.
154*d219b4ceSAdam Hornacek      */
155*d219b4ceSAdam Hornacek     @Override
HERExN()156*d219b4ceSAdam Hornacek     int HERExN() { return HERExN; }
157*d219b4ceSAdam Hornacek 
158*d219b4ceSAdam Hornacek     /**
159*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent HEREin.
160*d219b4ceSAdam Hornacek      */
161*d219b4ceSAdam Hornacek     @Override
HEREin()162*d219b4ceSAdam Hornacek     int HEREin() { return HEREin; }
163*d219b4ceSAdam Hornacek 
164*d219b4ceSAdam Hornacek     /**
165*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent HERE.
166*d219b4ceSAdam Hornacek      */
167*d219b4ceSAdam Hornacek     @Override
HERE()168*d219b4ceSAdam Hornacek     int HERE() { return HERE; }
169*d219b4ceSAdam Hornacek 
170*d219b4ceSAdam Hornacek     /**
171*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent SCOMMENT.
172*d219b4ceSAdam Hornacek      */
173*d219b4ceSAdam Hornacek     @Override
SCOMMENT()174*d219b4ceSAdam Hornacek     int SCOMMENT() { return SCOMMENT; }
175*d219b4ceSAdam Hornacek 
176*d219b4ceSAdam Hornacek     /**
177*d219b4ceSAdam Hornacek      * Gets the constant value created by JFlex to represent POD.
178*d219b4ceSAdam Hornacek      */
179*d219b4ceSAdam Hornacek     @Override
POD()180*d219b4ceSAdam Hornacek     int POD() { return POD; }
181*d219b4ceSAdam Hornacek %}
182*d219b4ceSAdam Hornacek 
183*d219b4ceSAdam Hornacek %include ../Common.lexh
184*d219b4ceSAdam Hornacek %include ../CommonURI.lexh
185*d219b4ceSAdam Hornacek %include ../CommonPath.lexh
186*d219b4ceSAdam Hornacek %include RubyProductions.lexh
187