xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/vb/VBAnalyzer.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) 2006, 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.vb;
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 Felix Annan
36  */
37 public class VBAnalyzer extends AbstractSourceCodeAnalyzer {
38 
39     /**
40      * Creates a new instance of VBAnalyzer.
41      * @param factory defined instance for the analyzer
42      */
VBAnalyzer(AnalyzerFactory factory)43     protected VBAnalyzer(AnalyzerFactory factory) {
44         super(factory, () -> new JFlexTokenizer(new VBSymbolTokenizer(
45                 AbstractAnalyzer.DUMMY_READER)));
46     }
47 
48     /**
49      * @return {@code null} as there is no aligned language
50      */
51     @Override
getCtagsLang()52     public String getCtagsLang() {
53         return null;
54     }
55 
56     /**
57      * Gets a version number to be used to tag processed documents so that
58      * re-analysis can be re-done later if a stored version number is different
59      * from the current implementation.
60      * @return 20180208_00
61      */
62     @Override
getSpecializedVersionNo()63     protected int getSpecializedVersionNo() {
64         return 20180208_00; // Edit comment above too!
65     }
66 
67     /**
68      * Creates a wrapped {@link VBXref} instance.
69      * @param reader the data to produce xref for
70      * @return a defined instance
71      */
72     @Override
newXref(Reader reader)73     protected JFlexXref newXref(Reader reader) {
74         return new JFlexXref(new VBXref(reader));
75     }
76 }
77