Analyzer plugin framework #2660
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| * CDDL HEADER START | ||
| * | ||
| * The contents of this file are subject to the terms of the | ||
| * Common Development and Distribution License (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * | ||
| * See LICENSE.txt included in this distribution for the specific | ||
| * language governing permissions and limitations under the License. | ||
| * | ||
| * When distributing Covered Code, include this CDDL HEADER in each | ||
| * file and include the License file at LICENSE.txt. | ||
| * If applicable, add the following below this CDDL HEADER, with the | ||
| * fields enclosed by brackets "[]" replaced with your own identifying | ||
| * information: Portions Copyright [yyyy] [name of copyright owner] | ||
| * | ||
| * CDDL HEADER END | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. | ||
| */ | ||
| package org.opengrok.indexer.analysis; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.Comparator; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.SortedMap; | ||
| import java.util.SortedSet; | ||
| import java.util.TreeMap; | ||
| import java.util.TreeSet; | ||
|
|
||
| /** | ||
| * A class wrapping information about used analyzers. | ||
| */ | ||
| public class AnalyzersInfo { | ||
|
|
||
| /** | ||
| * Descending string length comparator for magics | ||
| */ | ||
| private static final Comparator<String> DESCENDING_LENGTH_COMPARATOR = | ||
| Comparator.comparingInt(String::length).thenComparing(String::toString); | ||
|
|
||
| /** | ||
| * Modified when | ||
| * {@link AnalyzerFramework#addExtension(String, AnalyzerFactory)} | ||
| * or | ||
| * {@link AnalyzerFramework#addPrefix(String, AnalyzerFactory)} | ||
| * are called to augment the value in {@link AnalyzerGuru#getVersionNo()}. | ||
| */ | ||
| public final SortedSet<String> customizations; | ||
|
There was a problem hiding this comment. Could you please add getters? It just does't feel right this way. There was a problem hiding this comment. I intentionally don’t want to use getters as this class does no provide any functionality so final properties are enough There was a problem hiding this comment. Even simple DTO classes are always written with getters/setters. There was a problem hiding this comment. I’ve seen codes which don’t follow that. If this is code style for opengrok I can change it of course. |
||
|
|
||
| /** | ||
| * Map from file names to analyzer factories. | ||
| */ | ||
| public final Map<String, AnalyzerFactory> fileNames; | ||
|
|
||
| /** | ||
| * Map from file extensions to analyzer factories. | ||
| */ | ||
| public final Map<String, AnalyzerFactory> extensions; | ||
|
|
||
| /** | ||
| * Map from file prefixes to analyzer factories. | ||
| */ | ||
| public final Map<String, AnalyzerFactory> prefixes; | ||
|
|
||
| /** | ||
| * Map from magic strings to analyzer factories. | ||
| */ | ||
| public final SortedMap<String, AnalyzerFactory> magics; | ||
|
|
||
| /** | ||
| * List of matcher objects which can be used to determine which analyzer | ||
| * factory to use. | ||
| */ | ||
| public final List<FileAnalyzerFactory.Matcher> matchers; | ||
|
|
||
| /** | ||
| * List of all registered {@code FileAnalyzerFactory} instances. | ||
| */ | ||
| public final List<AnalyzerFactory> factories; | ||
|
|
||
| /** | ||
| * A map of {@link FileAnalyzer#getFileTypeName()} to human readable analyzer name. | ||
| */ | ||
| public final Map<String, String> fileTypeDescriptions; | ||
|
|
||
| /** | ||
| * Maps from {@link FileAnalyzer#getFileTypeName()} to | ||
| * {@link FileAnalyzerFactory} | ||
| */ | ||
| public final Map<String, AnalyzerFactory> filetypeFactories; | ||
|
|
||
| /** | ||
| * Maps from {@link FileAnalyzer#getFileTypeName()} to | ||
| * {@link FileAnalyzer#getVersionNo()} | ||
| */ | ||
| public final Map<String, Long> analyzerVersions; | ||
|
|
||
|
|
||
| /** | ||
| * Construct an empty analyzers info. | ||
| */ | ||
| public AnalyzersInfo() { | ||
| this( | ||
| new TreeSet<>(), | ||
| new HashMap<>(), | ||
| new HashMap<>(), | ||
| new HashMap<>(), | ||
| new TreeMap<>(DESCENDING_LENGTH_COMPARATOR), | ||
| new ArrayList<>(), | ||
| new ArrayList<>(), | ||
| new HashMap<>(), | ||
| new HashMap<>(), | ||
| new HashMap<>() | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Construct the analyzers info with given collections. | ||
| * | ||
| * @param customizations the customization keys set | ||
| * @param fileNames map of filenames to analyzers factories | ||
| * @param extensions map of extensions to analyzers factories | ||
| * @param prefixes map of prefixes to analyzers factories | ||
| * @param magics map of magics to analyzers factories | ||
| * @param matchers a list of matchers for analyzers factories | ||
| * @param factories a list of analyzers factories | ||
| * @param fileTypeDescriptions map of analyzer names to analyzer descriptions | ||
| * @param filetypeFactories map of file type to analyzers factories | ||
| * @param analyzerVersions map of analyzer names to analyzer versions | ||
| */ | ||
| private AnalyzersInfo( | ||
| SortedSet<String> customizations, | ||
| Map<String, AnalyzerFactory> fileNames, | ||
| Map<String, AnalyzerFactory> extensions, | ||
| Map<String, AnalyzerFactory> prefixes, | ||
| SortedMap<String, AnalyzerFactory> magics, | ||
| List<FileAnalyzerFactory.Matcher> matchers, | ||
| List<AnalyzerFactory> factories, | ||
| Map<String, String> fileTypeDescriptions, | ||
| Map<String, AnalyzerFactory> filetypeFactories, | ||
| Map<String, Long> analyzerVersions | ||
| ) { | ||
| this.customizations = customizations; | ||
| this.fileNames = fileNames; | ||
| this.extensions = extensions; | ||
| this.prefixes = prefixes; | ||
| this.magics = magics; | ||
| this.matchers = matchers; | ||
| this.factories = factories; | ||
| this.fileTypeDescriptions = fileTypeDescriptions; | ||
| this.filetypeFactories = filetypeFactories; | ||
| this.analyzerVersions = analyzerVersions; | ||
| } | ||
|
|
||
| /** | ||
| * Make the object unmodifiable. | ||
| * | ||
| * @return a new object reference with all properties wrapped as unmodifiable collections | ||
| */ | ||
| public AnalyzersInfo freeze() { | ||
| return new AnalyzersInfo( | ||
| Collections.unmodifiableSortedSet(this.customizations), | ||
| Collections.unmodifiableMap(this.fileNames), | ||
| Collections.unmodifiableMap(this.extensions), | ||
| Collections.unmodifiableMap(this.prefixes), | ||
| Collections.unmodifiableSortedMap(this.magics), | ||
| Collections.unmodifiableList(this.matchers), | ||
| Collections.unmodifiableList(this.factories), | ||
| Collections.unmodifiableMap(this.fileTypeDescriptions), | ||
| Collections.unmodifiableMap(this.filetypeFactories), | ||
| Collections.unmodifiableMap(this.analyzerVersions) | ||
| ); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * CDDL HEADER START | ||
| * | ||
| * The contents of this file are subject to the terms of the | ||
| * Common Development and Distribution License (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * | ||
| * See LICENSE.txt included in this distribution for the specific | ||
| * language governing permissions and limitations under the License. | ||
| * | ||
| * When distributing Covered Code, include this CDDL HEADER in each | ||
| * file and include the License file at LICENSE.txt. | ||
| * If applicable, add the following below this CDDL HEADER, with the | ||
| * fields enclosed by brackets "[]" replaced with your own identifying | ||
| * information: Portions Copyright [yyyy] [name of copyright owner] | ||
| * | ||
| * CDDL HEADER END | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. | ||
| */ | ||
| package org.opengrok.indexer.analysis; | ||
|
|
||
| public interface IAnalyzerPlugin { | ||
|
There was a problem hiding this comment. Could you please delete the There was a problem hiding this comment. No doubt for that. The trouble here is that we’ve already exposed one interface for plugins with I so this is consistent with the current code. We should make a change in a future to transfer both cases to the correct name but it’d be a breaking change and I think it shouldn’t be part of this pr. |
||
|
|
||
| AnalyzerFactory getFactory(); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing attributions?