Package ghidra.app.util.bin.format.pe

Class DebugDataDirectory

java.lang.Object

ghidra.app.util.bin.format.pe.DataDirectory

ghidra.app.util.bin.format.pe.DebugDataDirectory

All Implemented Interfaces:

PeMarkupable, StructConverter

public class DebugDataDirectory
extends DataDirectory

Points to an array of IMAGE_DEBUG_DIRECTORY structures.

Field Summary

Fields inherited from class ghidra.app.util.bin.format.pe.DataDirectory

hasParsed, IMAGE_SIZEOF_IMAGE_DIRECTORY_ENTRY, ntHeader, reader, size, TITLE, virtualAddress

Fields inherited from interface ghidra.app.util.bin.StructConverter

ASCII, BYTE, DWORD, IBO32, POINTER, QWORD, STRING, UTF16, UTF8, VOID, WORD

Constructor Summary

Constructors

Constructor	Description
DebugDataDirectory()	DO NOT USE THIS CONSTRUCTOR, USE create*(GenericFactory ...) FACTORY METHODS INSTEAD.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDirectoryName()
DebugDirectoryParser	getParser()	Returns the debug parser used by this debug directory.
void	markup(Program program, boolean isBinary, TaskMonitor monitor, MessageLog log, NTHeader ntHeader)	Marks up a PE structure.
boolean	parse()	Parses this data directory.
DataType	toDataType()	This method should return a datatype representing the data stored in this directory.
void	writeBytes(java.io.RandomAccessFile raf, DataConverter dc, PortableExecutable template)	Directories that are not contained inside of sections should override this method to write their bytes into the specified file.

Methods inherited from class ghidra.app.util.bin.format.pe.DataDirectory

createDirectoryBookmark, createFragment, createTerminatedString, getPointer, getSize, getVirtualAddress, hasParsedCorrectly, processDataDirectory, setBookmark, setEolComment, setPlateComment, setPreComment, setSize, setVirtualAddress, toString, va

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugDataDirectory

public DebugDataDirectory()

DO NOT USE THIS CONSTRUCTOR, USE create*(GenericFactory ...) FACTORY METHODS INSTEAD.

Method Detail

getDirectoryName

public java.lang.String getDirectoryName()

Specified by:

getDirectoryName in class DataDirectory

parse

public boolean parse()
              throws java.io.IOException

Description copied from class: DataDirectory

Parses this data directory.

Specified by:

parse in class DataDirectory

Returns:

True if parsing completed successfully; otherwise, false.

Throws:

java.io.IOException - If there was an IO problem while parsing.

markup

public void markup(Program program,
                   boolean isBinary,
                   TaskMonitor monitor,
                   MessageLog log,
                   NTHeader ntHeader)
            throws DuplicateNameException,
                   CodeUnitInsertionException,
                   DataTypeConflictException,
                   java.io.IOException

Description copied from interface: PeMarkupable

Marks up a PE structure.

Parameters:

program - The program to markup.

isBinary - True if the program is binary; otherwise, false.

monitor - The monitor.

log - The log.

ntHeader - The PE's NT Header structure.

Throws:

DuplicateNameException

CodeUnitInsertionException

java.io.IOException

DataTypeConflictException

getParser

public DebugDirectoryParser getParser()

Returns the debug parser used by this debug directory.

Returns:

the debug parser used by this debug directory

toDataType

public DataType toDataType()
                    throws DuplicateNameException,
                           java.io.IOException

Description copied from class: DataDirectory

This method should return a datatype representing the data stored in this directory.

Specified by:

toDataType in interface StructConverter

Specified by:

toDataType in class DataDirectory

Returns:

returns a structure datatype representing the implementor of this interface

Throws:

DuplicateNameException - when a datatype of the same name already exists

java.io.IOException

See Also:

StructConverter.toDataType()

writeBytes

public void writeBytes(java.io.RandomAccessFile raf,
                       DataConverter dc,
                       PortableExecutable template)
                throws java.io.IOException

Description copied from class: DataDirectory

Directories that are not contained inside of sections should override this method to write their bytes into the specified file.

Overrides:

writeBytes in class DataDirectory

Parameters:

raf - the random access file used for output

dc - the data converter for endianness

template - the original unadulterated PE

Throws:

java.io.IOException - if an I/O error occurs

See Also:

DataDirectory.writeBytes(java.io.RandomAccessFile, ghidra.util.DataConverter, ghidra.app.util.bin.format.pe.PortableExecutable)