Package ghidra.program.model.lang

Class LanguageCompilerSpecPair

java.lang.Object

ghidra.program.model.lang.LanguageCompilerSpecPair

All Implemented Interfaces:

Comparable<LanguageCompilerSpecPair>

public final class LanguageCompilerSpecPair
extends Object
implements Comparable<LanguageCompilerSpecPair>

Represents an opinion's processor language and compiler.

See Also:

• LanguageID
• CompilerSpecID

Field Summary

Fields

Modifier and Type	Field	Description
final CompilerSpecID	compilerSpecID
final LanguageID	languageID

Constructor Summary

Constructors

Constructor	Description
LanguageCompilerSpecPair(LanguageID languageID, CompilerSpecID compilerSpecID)	Creates a new language and compiler pair.
LanguageCompilerSpecPair(String languageID, String compilerSpecID)	Creates a new language and compiler pair.

Method Summary

Modifier and Type	Method	Description
int	compareTo(LanguageCompilerSpecPair o)
boolean	equals(Object obj)
CompilerSpec	getCompilerSpec()	Gets the CompilerSpec for this object's CompilerSpecID.
CompilerSpec	getCompilerSpec(LanguageService languageService)	Gets the CompilerSpec for this object's CompilerSpecID, using the given language service to do the lookup.
CompilerSpecDescription	getCompilerSpecDescription()	Gets the CompilerSpecDescription for this object's CompilerSpecID.
CompilerSpecDescription	getCompilerSpecDescription(LanguageService languageService)	Gets the CompilerSpecDescription for this object's CompilerSpecID.
CompilerSpecID	getCompilerSpecID()	Get the compiler spec ID
Language	getLanguage()	Gets the Language for this object's LanguageID.
Language	getLanguage(LanguageService languageService)	Gets the Language for this object's LanguageID, using the given language service to do the lookup.
LanguageDescription	getLanguageDescription()	Gets the LanguageDescription for this object's LanguageID.
LanguageDescription	getLanguageDescription(LanguageService languageService)	Gets the LanguageDescription for this object's LanguageID.
LanguageID	getLanguageID()	Get the language ID
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

languageID

public final LanguageID languageID

compilerSpecID

public final CompilerSpecID compilerSpecID

Constructor Details

LanguageCompilerSpecPair

public LanguageCompilerSpecPair(String languageID,
 String compilerSpecID)

Creates a new language and compiler pair.

Parameters:

languageID - The language ID string (x86:LE:32:default, 8051:BE:16:default, etc).

compilerSpecID - The compiler spec ID string (gcc, borlandcpp, etc).

Throws:

IllegalArgumentException - if the language or compiler ID strings are null or empty.

LanguageCompilerSpecPair

public LanguageCompilerSpecPair(LanguageID languageID,
 CompilerSpecID compilerSpecID)

Creates a new language and compiler pair.

Parameters:

languageID - The language ID.

compilerSpecID - The compiler spec ID.

Throws:

IllegalArgumentException - if the language or compiler ID is null.

Method Details

getLanguageID

public LanguageID getLanguageID()

Get the language ID

Returns:

language ID

getCompilerSpecID

public CompilerSpecID getCompilerSpecID()

Get the compiler spec ID

Returns:

compiler spec ID

getLanguage

public Language getLanguage()
                     throws LanguageNotFoundException

Gets the Language for this object's LanguageID.

Returns:

The Language for this object's LanguageID.

Throws:

LanguageNotFoundException - if no Language could be found for this object's LanguageID.

getCompilerSpec

public CompilerSpec getCompilerSpec()
                             throws CompilerSpecNotFoundException,
LanguageNotFoundException

Gets the CompilerSpec for this object's CompilerSpecID.

Returns:

The CompilerSpec for this object's CompilerSpecID.

Throws:

LanguageNotFoundException - if no Language could be found for this object's LanguageID.

CompilerSpecNotFoundException - if no CompilerSpec could be found for this object's CompilerSpecID.

getLanguage

public Language getLanguage(LanguageService languageService)
                     throws LanguageNotFoundException

Gets the Language for this object's LanguageID, using the given language service to do the lookup.

Parameters:

languageService - The language service to use for language lookup.

Returns:

The Language for this object's LanguageID, using the given language service to do the lookup.

Throws:

LanguageNotFoundException - if no Language could be found for this object's LanguageID using the given language service.

getCompilerSpec

public CompilerSpec getCompilerSpec(LanguageService languageService)
                             throws CompilerSpecNotFoundException,
LanguageNotFoundException

Gets the CompilerSpec for this object's CompilerSpecID, using the given language service to do the lookup.

Parameters:

languageService - The language service to use for compiler lookup.

Returns:

The CompilerSpec for this object's CompilerSpecID, using the given language service to do the lookup.

Throws:

LanguageNotFoundException - if no Language could be found for this object's LanguageID using the given language service.

CompilerSpecNotFoundException - if no CompilerSpec could be found for this object's CompilerSpecID using the given language service.

getLanguageDescription

public LanguageDescription getLanguageDescription()
                                           throws LanguageNotFoundException

Gets the LanguageDescription for this object's LanguageID.

Returns:

The LanguageDescription for this object's LanguageID.

Throws:

LanguageNotFoundException - if no LanguageDescription could be found for this object's LanguageID.

getCompilerSpecDescription

public CompilerSpecDescription getCompilerSpecDescription()
                                                   throws LanguageNotFoundException,
CompilerSpecNotFoundException

Gets the CompilerSpecDescription for this object's CompilerSpecID.

Returns:

The CompilerSpecDescription for this object's CompilerSpecID.

Throws:

LanguageNotFoundException - if no LanguageDescription could be found for this object's LanguageID.

CompilerSpecNotFoundException - if no CompilerSpecDescription could be found for this object's CompilerSpecID.

getLanguageDescription

public LanguageDescription getLanguageDescription(LanguageService languageService)
                                           throws LanguageNotFoundException

Gets the LanguageDescription for this object's LanguageID.

Parameters:

languageService - The language service to use for description lookup.

Returns:

The LanguageDescription for this object's LanguageID.

Throws:

LanguageNotFoundException - if no LanguageDescription could be found for this object's LanguageID using the given language service.

getCompilerSpecDescription

public CompilerSpecDescription getCompilerSpecDescription(LanguageService languageService)
                                                   throws LanguageNotFoundException,
CompilerSpecNotFoundException

Gets the CompilerSpecDescription for this object's CompilerSpecID.

Parameters:

languageService - The language service to use for description lookup.

Returns:

The CompilerSpecDescription for this object's CompilerSpecID.

Throws:

LanguageNotFoundException - if no LanguageDescription could be found for this object's LanguageID.

CompilerSpecNotFoundException - if no CompilerSpecDescription could be found for this object's CompilerSpecID using the given language service.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(LanguageCompilerSpecPair o)

Specified by:

compareTo in interface Comparable<LanguageCompilerSpecPair>