refdiff.parsers

Interface LanguagePlugin

public interface LanguagePlugin

A LanguagePlugin is responsible for generating the Code Structure Tree (CST) for a particular programming language.

Method Summary

Modifier and Type	Method and Description
FilePathFilter	getAllowedFilesFilter()
CstRoot	parse(SourceFileSet sources) Analyze the given source files and build a Code Structure Tree (CST), represented by the CstRoot object.

Method Detail

parse

CstRoot parse(SourceFileSet sources)
       throws java.lang.Exception

Analyze the given source files and build a Code Structure Tree (CST), represented by the CstRoot object.

Parameters:

sources - A set of source files that should be analyzed. Note that RefDiff does not pass all files of the project for analysis. Usually, only the files that changed between the revisions under examination are passed to this method. Additionally, RefDiff filters files using the getAllowedFilesFilter method.

Returns:

The CST.

Throws:

java.lang.Exception - when unable to parse the files.

getAllowedFilesFilter

FilePathFilter getAllowedFilesFilter()

Returns:

A FilePathFilter object, which contains a list of file extensions supported by this LanguagePlugin. Additionally, a list of excluded file extensions may be provided. For example, the JavaScript language plugin analyzes .js files, but ignores .min.js files.