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, 2020, Chris Fraire <cfraire@me.com>. 22 */ 23 package org.opengrok.indexer.analysis.verilog; 24 25 import org.opengrok.indexer.analysis.AbstractAnalyzer; 26 import org.opengrok.indexer.analysis.FileAnalyzerFactory; 27 import org.opengrok.indexer.analysis.JFlexTokenizer; 28 import org.opengrok.indexer.analysis.JFlexXref; 29 import org.opengrok.indexer.analysis.plain.AbstractSourceCodeAnalyzer; 30 31 import java.io.Reader; 32 33 /** 34 * Represents an analyzer for the SystemVerilog language. 35 */ 36 public class VerilogAnalyzer extends AbstractSourceCodeAnalyzer { 37 38 /** 39 * Creates a new instance of {@link VerilogAnalyzer}. 40 * @param factory instance 41 */ VerilogAnalyzer(FileAnalyzerFactory factory)42 protected VerilogAnalyzer(FileAnalyzerFactory factory) { 43 super(factory, () -> new JFlexTokenizer(new VerilogSymbolTokenizer( 44 AbstractAnalyzer.DUMMY_READER))); 45 } 46 47 /** 48 * @return {@code "SystemVerilog"} 49 */ 50 @Override getCtagsLang()51 public String getCtagsLang() { 52 return "SystemVerilog"; 53 } 54 55 /** 56 * Gets a version number to be used to tag processed documents so that 57 * re-analysis can be re-done later if a stored version number is different 58 * from the current implementation. 59 * @return 20190117_04 60 */ 61 @Override getSpecializedVersionNo()62 protected int getSpecializedVersionNo() { 63 return 20190117_04; // Edit comment above too! 64 } 65 66 /** 67 * Creates a wrapped {@link VerilogXref} instance. 68 * @return a defined instance 69 */ 70 @Override newXref(Reader reader)71 protected JFlexXref newXref(Reader reader) { 72 return new JFlexXref(new VerilogXref(reader)); 73 } 74 } 75