Package ghidra.program.model.data

Class DataTypeWriter

java.lang.Object

ghidra.program.model.data.DataTypeWriter

public class DataTypeWriter
extends java.lang.Object

A class used to convert data types into ANSI-C. The ANSI-C code should compile on most platforms.

Constructor Summary

Constructors

Constructor	Description
DataTypeWriter(DataTypeManager dtm, java.io.Writer writer)	Constructs a new instance of this class using the given writer.
DataTypeWriter(DataTypeManager dtm, java.io.Writer writer, boolean cppStyleComments)	Constructs a new instance of this class using the given writer.
DataTypeWriter(DataTypeManager dtm, java.io.Writer writer, AnnotationHandler annotator)	Constructs a new instance of this class using the given writer and annotation handler
DataTypeWriter(DataTypeManager dtm, java.io.Writer writer, AnnotationHandler annotator, boolean cppStyleComments)	Constructs a new instance of this class using the given writer and annotation handler

Method Summary

Modifier and Type	Method	Description
void	write(Category category, TaskMonitor monitor)	Converts all data types in the category into ANSI-C code.
void	write(DataType[] dataTypes, TaskMonitor monitor)	Converts all data types in the array into ANSI-C code.
void	write(DataTypeManager dataTypeManager, TaskMonitor monitor)	Converts all data types in the data type manager into ANSI-C code.
void	write(java.util.List<DataType> dataTypes, TaskMonitor monitor)	Converts all data types in the list into ANSI-C code.
void	write(java.util.List<DataType> dataTypes, TaskMonitor monitor, boolean throwExceptionOnInvalidType)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeWriter

public DataTypeWriter(DataTypeManager dtm,
                      java.io.Writer writer)
               throws java.io.IOException

Constructs a new instance of this class using the given writer. The default annotation handler is used.

Parameters:

dtm - data-type manager corresponding to target program or null for default

writer - the writer to use when writing data types

Throws:

java.io.IOException

DataTypeWriter

public DataTypeWriter(DataTypeManager dtm,
                      java.io.Writer writer,
                      boolean cppStyleComments)
               throws java.io.IOException

Constructs a new instance of this class using the given writer. The default annotation handler is used.

Parameters:

dtm - data-type manager corresponding to target program or null for default

writer - the writer to use when writing data types

cppStyleComments - whether to use C++ style comments

Throws:

java.io.IOException

DataTypeWriter

public DataTypeWriter(DataTypeManager dtm,
                      java.io.Writer writer,
                      AnnotationHandler annotator)
               throws java.io.IOException

Constructs a new instance of this class using the given writer and annotation handler

Parameters:

dtm - data-type manager corresponding to target program or null for default

writer - the writer to use when writing data types

annotator - the annotation handler to use to annotate the data types

Throws:

java.io.IOException

DataTypeWriter

public DataTypeWriter(DataTypeManager dtm,
                      java.io.Writer writer,
                      AnnotationHandler annotator,
                      boolean cppStyleComments)
               throws java.io.IOException

Constructs a new instance of this class using the given writer and annotation handler

Parameters:

dtm - data-type manager corresponding to target program or null for default

writer - the writer to use when writing data types

annotator - the annotation handler to use to annotate the data types

cppStyleComments - whether to use C++ style comments

Throws:

java.io.IOException

Method Detail

write

public void write(DataTypeManager dataTypeManager,
                  TaskMonitor monitor)
           throws java.io.IOException,
                  CancelledException

Converts all data types in the data type manager into ANSI-C code.

Parameters:

writer - to writer to write the ANSI-C code

monitor - the task monitor

Throws:

java.io.IOException - if an I/O error occurs when writing the data types to the specified writer

CancelledException

write

public void write(Category category,
                  TaskMonitor monitor)
           throws java.io.IOException,
                  CancelledException

Converts all data types in the category into ANSI-C code.

Parameters:

writer - to writer to write the ANSI-C code

monitor - the task monitor

Throws:

java.io.IOException - if an I/O error occurs when writing the data types to the specified writer

CancelledException

write

public void write(DataType[] dataTypes,
                  TaskMonitor monitor)
           throws java.io.IOException,
                  CancelledException

Converts all data types in the array into ANSI-C code.

Parameters:

writer - to writer to write the C code

monitor - the task monitor

Throws:

java.io.IOException - if an I/O error occurs when writing the data types to the specified writer

CancelledException

write

public void write(java.util.List<DataType> dataTypes,
                  TaskMonitor monitor)
           throws java.io.IOException,
                  CancelledException

Converts all data types in the list into ANSI-C code.

Parameters:

writer - to writer to write the ANSI-C code

monitor - the task monitor

Throws:

java.io.IOException - if an I/O error occurs when writing the data types to the specified writer

CancelledException

write

public void write(java.util.List<DataType> dataTypes,
                  TaskMonitor monitor,
                  boolean throwExceptionOnInvalidType)
           throws java.io.IOException,
                  CancelledException

Throws:

java.io.IOException

CancelledException