Package ghidra.app.services

Interface Analyzer

All Superinterfaces:

ExtensionPoint

All Known Implementing Classes:

AbstractAnalyzer, AbstractBinaryFormatAnalyzer, AnalyzerAdapter, AppleSingleDoubleAnalyzer, CoffAnalyzer, CoffArchiveAnalyzer, CondenseFillerBytesAnalyzer, ElfAnalyzer, GhidraScriptAnalyzerAdapter, MachoAnalyzer, PefAnalyzer, PortableExecutableAnalyzer

public interface Analyzer
extends ExtensionPoint

NOTE: ALL ANALYZER CLASSES MUST END IN "Analyzer". If not, the ClassSearcher will not find them. Interface to perform automatic analysis.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Method Summary

Modifier and Type	Method	Description
boolean	added(Program program, AddressSetView set, TaskMonitor monitor, MessageLog log)	Called when the requested information type has been added.
void	analysisEnded(Program program)	Called when an auto-analysis session ends.
boolean	canAnalyze(Program program)	Can this analyzer work on this program.
AnalyzerType	getAnalysisType()	Get the type of analysis this analyzer performs
boolean	getDefaultEnablement(Program program)	Returns true if this analyzer should be enabled by default.
java.lang.String	getDescription()	Get a longer description of what this analyzer does.
java.lang.String	getName()	Get the name of this analyzer
AnalysisPriority	getPriority()	Get the priority that this analyzer should run at.
boolean	isPrototype()	Returns true if this analyzer is a prototype.
void	optionsChanged(Options options, Program program)	Analyzers should initialize their options from the values in the given Options, providing appropriate default values.
void	registerOptions(Options options, Program program)
boolean	removed(Program program, AddressSetView set, TaskMonitor monitor, MessageLog log)	Called when the requested information type has been removed.
boolean	supportsOneTimeAnalysis()	Returns true if it makes sense for this analyzer to directly invoked on an address or addressSet.

Method Detail

getName

java.lang.String getName()

Get the name of this analyzer

Returns:

analyzer name

getAnalysisType

AnalyzerType getAnalysisType()

Get the type of analysis this analyzer performs

Returns:

analyze type

getDefaultEnablement

boolean getDefaultEnablement(Program program)

Returns true if this analyzer should be enabled by default. Generally useful analyzers should return true. Specialized analyzers should return false;

supportsOneTimeAnalysis

boolean supportsOneTimeAnalysis()

Returns true if it makes sense for this analyzer to directly invoked on an address or addressSet. The AutoAnalyzer plug-in will automatically create an action for each analyzer that returns true.

getDescription

java.lang.String getDescription()

Get a longer description of what this analyzer does.

Returns:

analyzer description

getPriority

AnalysisPriority getPriority()

Get the priority that this analyzer should run at.

Returns:

analyzer priority

canAnalyze

boolean canAnalyze(Program program)

Can this analyzer work on this program.

Parameters:

program - program to be analyzed

Returns:

true if this analyzer can analyze this program

added

boolean added(Program program,
              AddressSetView set,
              TaskMonitor monitor,
              MessageLog log)
       throws CancelledException

Called when the requested information type has been added. (ie: function added.)

Parameters:

program - program to analyze

set - AddressSet of locations that have been added

monitor - monitor that indicates progress and indicates whether the user canceled the analysis

log - a message log to record analysis information

Returns:

true if the analysis succeeded

Throws:

CancelledException

removed

boolean removed(Program program,
                AddressSetView set,
                TaskMonitor monitor,
                MessageLog log)
         throws CancelledException

Called when the requested information type has been removed. (ie: function removed.)

Parameters:

program - program to analyze

set - AddressSet of locations that have been added

monitor - monitor that indicates progress and indicates whether the user canceled the analysis

log - a message log to record analysis information

Returns:

true if the analysis succeeded

Throws:

CancelledException

optionsChanged

void optionsChanged(Options options,
                    Program program)

Analyzers should initialize their options from the values in the given Options, providing appropriate default values.

Parameters:

options - the property list that contains the options

program - program to be analyzed

analysisEnded

void analysisEnded(Program program)

Called when an auto-analysis session ends. This notifies the analyzer so it can clean up any resources that only needed to be maintained during a single auto-analysis session.

Parameters:

program - the program that was just completed being analyzed

isPrototype

boolean isPrototype()

Returns true if this analyzer is a prototype.

Returns:

true if this analyzer is a prototype

registerOptions

void registerOptions(Options options,
                     Program program)