xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/csharp/CSharpAnalyzer.java (revision 0e4c55544f8ea0a68e8bae37b0e502097e008ec1)
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) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
22  * Portions Copyright (c) 2017, 2020, Chris Fraire <cfraire@me.com>.
23  */
24 package org.opengrok.indexer.analysis.csharp;
25 
26 import java.io.Reader;
27 import org.opengrok.indexer.analysis.AbstractAnalyzer;
28 import org.opengrok.indexer.analysis.AnalyzerFactory;
29 import org.opengrok.indexer.analysis.JFlexTokenizer;
30 import org.opengrok.indexer.analysis.JFlexXref;
31 import org.opengrok.indexer.analysis.plain.AbstractSourceCodeAnalyzer;
32 
33 /**
34  *
35  * @author Christoph Hofmann
36  */
37 public class CSharpAnalyzer extends AbstractSourceCodeAnalyzer {
38 
CSharpAnalyzer(AnalyzerFactory factory)39     protected CSharpAnalyzer(AnalyzerFactory factory) {
40         super(factory, () -> new JFlexTokenizer(new CSharpSymbolTokenizer(
41                 AbstractAnalyzer.DUMMY_READER)));
42     }
43 
44     /**
45      * @return {@code "C#"}
46      */
47     @Override
getCtagsLang()48     public String getCtagsLang() {
49         return "C#";
50     }
51 
52     /**
53      * Gets a version number to be used to tag processed documents so that
54      * re-analysis can be re-done later if a stored version number is different
55      * from the current implementation.
56      * @return 20180208_00
57      */
58     @Override
getSpecializedVersionNo()59     protected int getSpecializedVersionNo() {
60         return 20180208_00; // Edit comment above too!
61     }
62 
63     /**
64      * Creates a wrapped {@link CSharpXref} instance.
65      * @param reader the data to produce xref for
66      * @return a defined instance
67      */
68     @Override
newXref(Reader reader)69     protected JFlexXref newXref(Reader reader) {
70         return new JFlexXref(new CSharpXref(reader));
71     }
72 
73     @Override
supportsScopes()74     protected boolean supportsScopes() {
75         return true;
76     }
77 }
78