xref: /OpenGrok/opengrok-indexer/src/main/jflex/analysis/swift/SwiftXref.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) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
22*d219b4ceSAdam Hornacek  * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
23*d219b4ceSAdam Hornacek  */
24*d219b4ceSAdam Hornacek 
25*d219b4ceSAdam Hornacek package org.opengrok.indexer.analysis.swift;
26*d219b4ceSAdam Hornacek 
27*d219b4ceSAdam Hornacek import java.io.IOException;
28*d219b4ceSAdam Hornacek import org.opengrok.indexer.analysis.JFlexSymbolMatcher;
29*d219b4ceSAdam Hornacek import org.opengrok.indexer.analysis.ScopeAction;
30*d219b4ceSAdam Hornacek import org.opengrok.indexer.util.StringUtils;
31*d219b4ceSAdam Hornacek import org.opengrok.indexer.web.HtmlConsts;
32*d219b4ceSAdam Hornacek %%
33*d219b4ceSAdam Hornacek %public
34*d219b4ceSAdam Hornacek %class SwiftXref
35*d219b4ceSAdam Hornacek %extends JFlexSymbolMatcher
36*d219b4ceSAdam Hornacek %unicode
37*d219b4ceSAdam Hornacek %int
38*d219b4ceSAdam Hornacek %char
39*d219b4ceSAdam Hornacek %include ../CommonLexer.lexh
40*d219b4ceSAdam Hornacek %include ../CommonXref.lexh
41*d219b4ceSAdam Hornacek %{
42*d219b4ceSAdam Hornacek   /* Must match {WhiteSpace} regex */
43*d219b4ceSAdam Hornacek   private final static String WHITE_SPACE = "[ \\t\\f]+";
44*d219b4ceSAdam Hornacek 
45*d219b4ceSAdam Hornacek   private int nestedComment;
46*d219b4ceSAdam Hornacek 
47*d219b4ceSAdam Hornacek   @Override
reset()48*d219b4ceSAdam Hornacek   public void reset() {
49*d219b4ceSAdam Hornacek       super.reset();
50*d219b4ceSAdam Hornacek       nestedComment = 0;
51*d219b4ceSAdam Hornacek   }
52*d219b4ceSAdam Hornacek 
53*d219b4ceSAdam Hornacek   @Override
yypop()54*d219b4ceSAdam Hornacek   public void yypop() throws IOException {
55*d219b4ceSAdam Hornacek       onDisjointSpanChanged(null, yychar);
56*d219b4ceSAdam Hornacek       super.yypop();
57*d219b4ceSAdam Hornacek   }
58*d219b4ceSAdam Hornacek 
chkLOC()59*d219b4ceSAdam Hornacek   protected void chkLOC() {
60*d219b4ceSAdam Hornacek       switch (yystate()) {
61*d219b4ceSAdam Hornacek           case COMMENT:
62*d219b4ceSAdam Hornacek           case SCOMMENT:
63*d219b4ceSAdam Hornacek           case SDOC:
64*d219b4ceSAdam Hornacek               break;
65*d219b4ceSAdam Hornacek           default:
66*d219b4ceSAdam Hornacek               phLOC();
67*d219b4ceSAdam Hornacek               break;
68*d219b4ceSAdam Hornacek       }
69*d219b4ceSAdam Hornacek   }
70*d219b4ceSAdam Hornacek %}
71*d219b4ceSAdam Hornacek 
72*d219b4ceSAdam Hornacek File = [a-zA-Z]{FNameChar}* "." ([Jj][Aa][Vv][Aa] |
73*d219b4ceSAdam Hornacek     [Pp][Rr][Oo][Pp][Ee][Rr][Tt][Ii][Ee][Ss] | [Pp][Rr][Oo][Pp][Ss] |
74*d219b4ceSAdam Hornacek     [Xx][Mm][Ll] | [Cc][Oo][Nn][Ff] | [Tt][Xx][Tt] | [Hh][Tt][Mm][Ll]? |
75*d219b4ceSAdam Hornacek     [Ii][Nn][Ii] | [Jj][Nn][Ll][Pp] | [Jj][Aa][Dd] | [Dd][Ii][Ff][Ff] |
76*d219b4ceSAdam Hornacek     [Pp][Aa][Tt][Cc][Hh])
77*d219b4ceSAdam Hornacek 
78*d219b4ceSAdam Hornacek /* TODO support markdown in comments
79*d219b4ceSAdam Hornacek SdocWithClassArg = "@throws" | "@exception"
80*d219b4ceSAdam Hornacek SdocWithParamNameArg = "@param"
81*d219b4ceSAdam Hornacek 
82*d219b4ceSAdam Hornacek ClassName = "class"{WhiteSpace}({Identifier} ".")* {Identifier}
83*d219b4ceSAdam Hornacek ParamName = {Identifier} | "<" {Identifier} ">"
84*d219b4ceSAdam Hornacek */
85*d219b4ceSAdam Hornacek 
86*d219b4ceSAdam Hornacek %state  STRING COMMENT SCOMMENT SDOC TSTRING
87*d219b4ceSAdam Hornacek 
88*d219b4ceSAdam Hornacek %include ../Common.lexh
89*d219b4ceSAdam Hornacek %include ../CommonURI.lexh
90*d219b4ceSAdam Hornacek %include ../CommonPath.lexh
91*d219b4ceSAdam Hornacek %include Swift.lexh
92*d219b4ceSAdam Hornacek %%
93*d219b4ceSAdam Hornacek <YYINITIAL>{
94*d219b4ceSAdam Hornacek  \{     { chkLOC(); onScopeChanged(ScopeAction.INC, yytext(), yychar); }
95*d219b4ceSAdam Hornacek  \}     { chkLOC(); onScopeChanged(ScopeAction.DEC, yytext(), yychar); }
96*d219b4ceSAdam Hornacek  \;     { chkLOC(); onScopeChanged(ScopeAction.END, yytext(), yychar); }
97*d219b4ceSAdam Hornacek 
98*d219b4ceSAdam Hornacek {Identifier} {
99*d219b4ceSAdam Hornacek     chkLOC();
100*d219b4ceSAdam Hornacek     String id = yytext();
101*d219b4ceSAdam Hornacek     onFilteredSymbolMatched(id, yychar, Consts.kwd);
102*d219b4ceSAdam Hornacek }
103*d219b4ceSAdam Hornacek 
104*d219b4ceSAdam Hornacek  [`] {Identifier} [`]    {
105*d219b4ceSAdam Hornacek     chkLOC();
106*d219b4ceSAdam Hornacek     String capture = yytext();
107*d219b4ceSAdam Hornacek     String id = capture.substring(1, capture.length() - 1);
108*d219b4ceSAdam Hornacek     onNonSymbolMatched("`", yychar);
109*d219b4ceSAdam Hornacek     onFilteredSymbolMatched(id, yychar, null);
110*d219b4ceSAdam Hornacek     onNonSymbolMatched("`", yychar);
111*d219b4ceSAdam Hornacek  }
112*d219b4ceSAdam Hornacek 
113*d219b4ceSAdam Hornacek  {ImplicitIdentifier} {
114*d219b4ceSAdam Hornacek     chkLOC();
115*d219b4ceSAdam Hornacek     onKeywordMatched(yytext(), yychar);
116*d219b4ceSAdam Hornacek  }
117*d219b4ceSAdam Hornacek 
118*d219b4ceSAdam Hornacek "<" ({File}|{FPath}) ">" {
119*d219b4ceSAdam Hornacek         chkLOC();
120*d219b4ceSAdam Hornacek         onNonSymbolMatched("<", yychar);
121*d219b4ceSAdam Hornacek         String path = yytext();
122*d219b4ceSAdam Hornacek         path = path.substring(1, path.length() - 1);
123*d219b4ceSAdam Hornacek         onFilelikeMatched(path, yychar + 1);
124*d219b4ceSAdam Hornacek         onNonSymbolMatched(">", yychar + 1 + path.length());
125*d219b4ceSAdam Hornacek }
126*d219b4ceSAdam Hornacek 
127*d219b4ceSAdam Hornacek /*{Hier}
128*d219b4ceSAdam Hornacek         { onPathlikeMatched(yytext(), '.', false, yychar); }
129*d219b4ceSAdam Hornacek */
130*d219b4ceSAdam Hornacek  {Number}        {
131*d219b4ceSAdam Hornacek     chkLOC();
132*d219b4ceSAdam Hornacek     onDisjointSpanChanged(HtmlConsts.NUMBER_CLASS, yychar);
133*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
134*d219b4ceSAdam Hornacek     onDisjointSpanChanged(null, yychar);
135*d219b4ceSAdam Hornacek  }
136*d219b4ceSAdam Hornacek 
137*d219b4ceSAdam Hornacek  \"     {
138*d219b4ceSAdam Hornacek     chkLOC();
139*d219b4ceSAdam Hornacek     yypush(STRING);
140*d219b4ceSAdam Hornacek     onDisjointSpanChanged(HtmlConsts.STRING_CLASS, yychar);
141*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
142*d219b4ceSAdam Hornacek  }
143*d219b4ceSAdam Hornacek  \"\"\"    {
144*d219b4ceSAdam Hornacek     chkLOC();
145*d219b4ceSAdam Hornacek     yypush(TSTRING);
146*d219b4ceSAdam Hornacek     onDisjointSpanChanged(HtmlConsts.STRING_CLASS, yychar);
147*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
148*d219b4ceSAdam Hornacek  }
149*d219b4ceSAdam Hornacek  "/**" / [^/]    {
150*d219b4ceSAdam Hornacek     if (nestedComment++ == 0) {
151*d219b4ceSAdam Hornacek         yypush(SDOC);
152*d219b4ceSAdam Hornacek         onDisjointSpanChanged(HtmlConsts.COMMENT_CLASS, yychar);
153*d219b4ceSAdam Hornacek     }
154*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
155*d219b4ceSAdam Hornacek  }
156*d219b4ceSAdam Hornacek  "//"    {
157*d219b4ceSAdam Hornacek     yypush(SCOMMENT);
158*d219b4ceSAdam Hornacek     onDisjointSpanChanged(HtmlConsts.COMMENT_CLASS, yychar);
159*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
160*d219b4ceSAdam Hornacek  }
161*d219b4ceSAdam Hornacek }
162*d219b4ceSAdam Hornacek 
163*d219b4ceSAdam Hornacek <STRING> {
164*d219b4ceSAdam Hornacek  \\[\"\\]    { chkLOC(); onNonSymbolMatched(yytext(), yychar); }
165*d219b4ceSAdam Hornacek  \"     {
166*d219b4ceSAdam Hornacek     chkLOC();
167*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
168*d219b4ceSAdam Hornacek     yypop();
169*d219b4ceSAdam Hornacek  }
170*d219b4ceSAdam Hornacek }
171*d219b4ceSAdam Hornacek 
172*d219b4ceSAdam Hornacek <TSTRING> {
173*d219b4ceSAdam Hornacek  \"\"\"    {
174*d219b4ceSAdam Hornacek     chkLOC();
175*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
176*d219b4ceSAdam Hornacek     yypop();
177*d219b4ceSAdam Hornacek  }
178*d219b4ceSAdam Hornacek }
179*d219b4ceSAdam Hornacek 
180*d219b4ceSAdam Hornacek <STRING, TSTRING> {
181*d219b4ceSAdam Hornacek     {WhspChar}*{EOL}    {
182*d219b4ceSAdam Hornacek         onDisjointSpanChanged(null, yychar);
183*d219b4ceSAdam Hornacek         onEndOfLineMatched(yytext(), yychar);
184*d219b4ceSAdam Hornacek         onDisjointSpanChanged(HtmlConsts.STRING_CLASS, yychar);
185*d219b4ceSAdam Hornacek     }
186*d219b4ceSAdam Hornacek }
187*d219b4ceSAdam Hornacek 
188*d219b4ceSAdam Hornacek <YYINITIAL, COMMENT, SDOC> {
189*d219b4ceSAdam Hornacek  "/*"    {
190*d219b4ceSAdam Hornacek     if (nestedComment++ == 0) {
191*d219b4ceSAdam Hornacek         yypush(COMMENT);
192*d219b4ceSAdam Hornacek         onDisjointSpanChanged(HtmlConsts.COMMENT_CLASS, yychar);
193*d219b4ceSAdam Hornacek     }
194*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
195*d219b4ceSAdam Hornacek  }
196*d219b4ceSAdam Hornacek }
197*d219b4ceSAdam Hornacek 
198*d219b4ceSAdam Hornacek <COMMENT, SDOC> {
199*d219b4ceSAdam Hornacek  "*/"    {
200*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), yychar);
201*d219b4ceSAdam Hornacek     if (--nestedComment == 0) {
202*d219b4ceSAdam Hornacek         yypop();
203*d219b4ceSAdam Hornacek     }
204*d219b4ceSAdam Hornacek  }
205*d219b4ceSAdam Hornacek  {WhspChar}*{EOL}    {
206*d219b4ceSAdam Hornacek     onDisjointSpanChanged(null, yychar);
207*d219b4ceSAdam Hornacek     onEndOfLineMatched(yytext(), yychar);
208*d219b4ceSAdam Hornacek     onDisjointSpanChanged(HtmlConsts.COMMENT_CLASS, yychar);
209*d219b4ceSAdam Hornacek  }
210*d219b4ceSAdam Hornacek }
211*d219b4ceSAdam Hornacek 
212*d219b4ceSAdam Hornacek /* TODO: support markdown in comments
213*d219b4ceSAdam Hornacek <SDOC> {
214*d219b4ceSAdam Hornacek   {SdocWithParamNameArg} {WhiteSpace} {ParamName} |
215*d219b4ceSAdam Hornacek   {SdocWithClassArg} {WhiteSpace} {ClassName} {
216*d219b4ceSAdam Hornacek     String text = yytext();
217*d219b4ceSAdam Hornacek     String[] tokens = text.split(WHITE_SPACE, 2);
218*d219b4ceSAdam Hornacek     onNonSymbolMatched(tokens[0], EmphasisHint.STRONG, yychar);
219*d219b4ceSAdam Hornacek     onNonSymbolMatched(text.substring(tokens[0].length(), text.length() -
220*d219b4ceSAdam Hornacek         tokens[1].length()), yychar);
221*d219b4ceSAdam Hornacek     onNonSymbolMatched(tokens[1], EmphasisHint.EM, yychar);
222*d219b4ceSAdam Hornacek   }
223*d219b4ceSAdam Hornacek   "@" {Identifier} {
224*d219b4ceSAdam Hornacek     onNonSymbolMatched(yytext(), EmphasisHint.STRONG, yychar);
225*d219b4ceSAdam Hornacek   }
226*d219b4ceSAdam Hornacek }
227*d219b4ceSAdam Hornacek */
228*d219b4ceSAdam Hornacek 
229*d219b4ceSAdam Hornacek <SCOMMENT> {
230*d219b4ceSAdam Hornacek   {WhspChar}*{EOL} {
231*d219b4ceSAdam Hornacek     yypop();
232*d219b4ceSAdam Hornacek     onEndOfLineMatched(yytext(), yychar);
233*d219b4ceSAdam Hornacek   }
234*d219b4ceSAdam Hornacek }
235*d219b4ceSAdam Hornacek 
236*d219b4ceSAdam Hornacek <YYINITIAL, STRING, COMMENT, SCOMMENT, SDOC, TSTRING> {
237*d219b4ceSAdam Hornacek {WhspChar}*{EOL}    { onEndOfLineMatched(yytext(), yychar); }
238*d219b4ceSAdam Hornacek  [[\s]--[\n]]    { onNonSymbolMatched(yytext(), yychar); }
239*d219b4ceSAdam Hornacek  [^\n]    { chkLOC(); onNonSymbolMatched(yytext(), yychar); }
240*d219b4ceSAdam Hornacek }
241*d219b4ceSAdam Hornacek 
242*d219b4ceSAdam Hornacek <STRING, COMMENT, SCOMMENT, SDOC, TSTRING> {
243*d219b4ceSAdam Hornacek  {FPath}    {
244*d219b4ceSAdam Hornacek     chkLOC();
245*d219b4ceSAdam Hornacek     onPathlikeMatched(yytext(), '/', false, yychar);
246*d219b4ceSAdam Hornacek  }
247*d219b4ceSAdam Hornacek 
248*d219b4ceSAdam Hornacek {File}
249*d219b4ceSAdam Hornacek         {
250*d219b4ceSAdam Hornacek         chkLOC();
251*d219b4ceSAdam Hornacek         String path = yytext();
252*d219b4ceSAdam Hornacek         onFilelikeMatched(path, yychar);
253*d219b4ceSAdam Hornacek  }
254*d219b4ceSAdam Hornacek 
255*d219b4ceSAdam Hornacek {FNameChar}+ "@" {FNameChar}+ "." {FNameChar}+
256*d219b4ceSAdam Hornacek         {
257*d219b4ceSAdam Hornacek           chkLOC();
258*d219b4ceSAdam Hornacek           onEmailAddressMatched(yytext(), yychar);
259*d219b4ceSAdam Hornacek         }
260*d219b4ceSAdam Hornacek }
261*d219b4ceSAdam Hornacek 
262*d219b4ceSAdam Hornacek <STRING, SCOMMENT, TSTRING> {
263*d219b4ceSAdam Hornacek     {BrowseableURI}    {
264*d219b4ceSAdam Hornacek         chkLOC();
265*d219b4ceSAdam Hornacek         onUriMatched(yytext(), yychar);
266*d219b4ceSAdam Hornacek     }
267*d219b4ceSAdam Hornacek }
268*d219b4ceSAdam Hornacek 
269*d219b4ceSAdam Hornacek <COMMENT, SDOC> {
270*d219b4ceSAdam Hornacek     {BrowseableURI}    {
271*d219b4ceSAdam Hornacek         onUriMatched(yytext(), yychar, StringUtils.END_C_COMMENT);
272*d219b4ceSAdam Hornacek     }
273*d219b4ceSAdam Hornacek }
274