Package ghidra.app.util.bin.format.dwarf

Class DWARFAbbreviation

java.lang.Object

ghidra.app.util.bin.format.dwarf.DWARFAbbreviation

public class DWARFAbbreviation
extends Object

This class represents the 'schema' for a DWARF DIE record.

A raw DWARF DIE record specifies its abbreviation code (pointing to an instance of this class) and the corresponding DWARFAbbreviation instance has the information about how the raw DIE is laid out.

Constructor Summary

Constructors

Constructor	Description
DWARFAbbreviation(int abbreviationCode, int tagId, boolean hasChildren, DWARFAttribute.AttrDef[] attributes)

Method Summary

Modifier and Type	Method	Description
DWARFAttribute.AttrDef	findAttribute(DWARFAttribute attributeId)	Get the attribute with the given attribute key.
int	getAbbreviationCode()	Get the abbreviation code.
DWARFAttribute.AttrDef	getAttributeAt(int index)	Get the attribute at the given index.
int	getAttributeCount()	Return number of attribute values.
DWARFAttribute.AttrDef[]	getAttributes()	Return a live list of the attributes.
DWARFTag	getTag()	Get the tag value.
String	getTagName()
boolean	hasChildren()	Checks to see if this abbreviation has any DIE children.
static DWARFAbbreviation	read(BinaryReader reader, DWARFProgram prog, TaskMonitor monitor)	Reads a DWARFAbbreviation from the stream.
static Map<Integer,DWARFAbbreviation>	readAbbreviations(BinaryReader reader, DWARFProgram prog, TaskMonitor monitor)	Reads a list of DWARFAbbreviation, stopping when the end-of-list marker is encountered.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DWARFAbbreviation

public DWARFAbbreviation(int abbreviationCode,
 int tagId,
 boolean hasChildren,
 DWARFAttribute.AttrDef[] attributes)

Method Details

read

public static DWARFAbbreviation read(BinaryReader reader,
 DWARFProgram prog,
 TaskMonitor monitor)
                              throws IOException,
CancelledException

Reads a DWARFAbbreviation from the stream.

Parameters:

reader - BinaryReader stream

prog - DWARFProgram

monitor - TaskMonitor

Returns:

DWARFAbbreviation, or null if the stream was at a end-of-list marker

Throws:

IOException - if error reading

CancelledException - if canceled

readAbbreviations

public static Map<Integer,DWARFAbbreviation> readAbbreviations(BinaryReader reader,
 DWARFProgram prog,
 TaskMonitor monitor)
                                                        throws IOException,
CancelledException

Reads a list of DWARFAbbreviation, stopping when the end-of-list marker is encountered.

Parameters:

reader - BinaryReader .debug_abbr stream

prog - DWARFProgram

monitor - TaskMonitor

Returns:

map of abbrCode -> abbr instance

Throws:

IOException - if error reading

CancelledException - if cancelled

toString

public String toString()

Overrides:

toString in class Object

getAbbreviationCode

public int getAbbreviationCode()

Get the abbreviation code.

Returns:

the abbreviation code

getTag

public DWARFTag getTag()

Get the tag value.

Returns:

the tag value

getTagName

public String getTagName()

hasChildren

public boolean hasChildren()

Checks to see if this abbreviation has any DIE children.

Returns:

true if this abbreviation has DIE children

getAttributes

public DWARFAttribute.AttrDef[] getAttributes()

Return a live list of the attributes.

Returns:

list of attributes

getAttributeCount

public int getAttributeCount()

Return number of attribute values.

Returns:

number of attribute values

getAttributeAt

public DWARFAttribute.AttrDef getAttributeAt(int index)

Get the attribute at the given index.

Parameters:

index - index of the attribute

Returns:

attribute specification

findAttribute

public DWARFAttribute.AttrDef findAttribute(DWARFAttribute attributeId)

Get the attribute with the given attribute key.

Parameters:

attributeId - attribute key

Returns:

attribute specification