Skip to content

DRAFT: Some issues #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
MinyazevR wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

DRAFT: Some issues #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
524957e
Some issues
MinyazevR Dec 23, 2024
31518a3
Cleanup
MinyazevR Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 62 additions & 24 deletions ...ra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/DataTypeWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public class DataTypeWriter {
private Set<DataType> resolved = new HashSet<>();
private Map<String, DataType> resolvedTypeMap = new HashMap<>();
private Set<Composite> deferredCompositeDeclarations = new HashSet<>();
private Set<FunctionDefinition> deferredFunctionDefenition = new HashSet<>();
private ArrayDeque<DataType> deferredTypeFIFO = new ArrayDeque<>();
private Set<DataType> deferredTypes = new HashSet<>();
private int writerDepth = 0;
Expand Down Expand Up @@ -169,10 +170,14 @@ public void write(DataType[] dataTypes, TaskMonitor monitor)
monitor.initialize(dataTypes.length);
int cnt = 0;
for (DataType dataType : dataTypes) {
if (dataType instanceof FunctionDefinition functionDefinition) {
deferredFunctionDefenition.add(functionDefinition);
}
monitor.checkCancelled();
write(dataType, monitor);
monitor.setProgress(++cnt);
}
writeDeferredFunctionDefinition();
}

/**
Expand All @@ -192,10 +197,14 @@ public void write(List<DataType> dataTypes, TaskMonitor monitor,
monitor.initialize(dataTypes.size());
int cnt = 0;
for (DataType dataType : dataTypes) {
if (dataType instanceof FunctionDefinition functionDefinition) {
deferredFunctionDefenition.add(functionDefinition);
}
monitor.checkCancelled();
write(dataType, monitor, throwExceptionOnInvalidType);
monitor.setProgress(++cnt);
}
writeDeferredFunctionDefinition();
}

private void deferWrite(DataType dt) {
Expand All @@ -222,21 +231,25 @@ void write(DataType dt, TaskMonitor monitor, boolean throwExceptionOnInvalidType
*/
private void doWrite(DataType dt, TaskMonitor monitor, boolean throwExceptionOnInvalidType)
throws IOException, CancelledException {
if (dt == null) {
return;
}
if (dt instanceof FunctionDefinition) {
return;
}
if (dt instanceof FactoryDataType) {
IllegalArgumentException iae =
new IllegalArgumentException("Factory data types may not be written");
if (throwExceptionOnInvalidType) {
throw iae;
}
Msg.error(this, "Factory data types may not be written - type: " + dt);
}
if (dt instanceof Pointer || dt instanceof Array || dt instanceof BitFieldDataType) {
switch (dt) {
case null -> {
return;
}
case FunctionDefinition ignored -> {
return;
}
case FactoryDataType ignored -> {
IllegalArgumentException iae =
new IllegalArgumentException("Factory data types may not be written");
if (throwExceptionOnInvalidType) {
throw iae;
}
Msg.error(this, "Factory data types may not be written - type: " + dt);
}
default -> {
}
}
if (dt instanceof Pointer || dt instanceof Array || dt instanceof BitFieldDataType) {
write(getBaseDataType(dt), monitor);
return;
}
Expand Down Expand Up @@ -283,14 +296,12 @@ private void doWrite(DataType dt, TaskMonitor monitor, boolean throwExceptionOnI
else if (dt instanceof Dynamic) {
writeDynamicBuiltIn((Dynamic) dt, monitor);
}
else if (dt instanceof Structure) {
Structure struct = (Structure) dt;
writeCompositePreDeclaration(struct, monitor);
else if (dt instanceof Structure struct) {
writeCompositePreDeclaration(struct, monitor);
deferredCompositeDeclarations.add(struct);
}
else if (dt instanceof Union) {
Union union = (Union) dt;
writeCompositePreDeclaration(union, monitor);
else if (dt instanceof Union union) {
writeCompositePreDeclaration(union, monitor);
deferredCompositeDeclarations.add(union);
}
else if (dt instanceof Enum) {
Expand Down Expand Up @@ -382,6 +393,17 @@ private void writeDeferredCompositeDeclarations(TaskMonitor monitor)
}
}

private void writeDeferredFunctionDefinition()
throws IOException, CancelledException {
for (FunctionDefinition functionDefinition : deferredFunctionDefenition) {
writer.write(EOL);
writer.write(functionDefinition.getPrototypeString(true));
writer.write(';');
writer.write(EOL);
}
deferredFunctionDefenition.clear();
}

private boolean resortComposites(List<Composite> list, int index) {
int listSize = list.size();
if (listSize <= 0) {
Expand Down Expand Up @@ -452,10 +474,20 @@ private void writeCompositeBody(Composite composite, TaskMonitor monitor)
String compositeType = composite instanceof Structure ? "struct" : "union";

StringBuilder sb = new StringBuilder();

boolean needPragmaPack = composite.isPackingEnabled()
&& !composite.hasDefaultPacking() && composite.hasExplicitPackingValue();

if (needPragmaPack) {
int packingValue = composite.getExplicitPackingValue();
sb.append("#pragma pack(push, ").append(packingValue).append(")");
sb.append(EOL);
}

sb.append(compositeType + " " + composite.getDisplayName() + " {");

String descrip = composite.getDescription();
if (descrip != null && descrip.length() > 0) {
if (descrip != null && !descrip.isEmpty()) {
sb.append(" " + comment(descrip));
}
sb.append(EOL);
Expand All @@ -468,6 +500,12 @@ private void writeCompositeBody(Composite composite, TaskMonitor monitor)
sb.append(annotator.getSuffix(composite, null));
sb.append("};");

if (needPragmaPack) {
sb.append(EOL);
sb.append("#pragma pack(pop)");
sb.append(EOL);
}

writer.write(sb.toString());
writer.write(EOL);
writer.write(EOL);
Expand All @@ -479,7 +517,7 @@ private void writeComponent(DataTypeComponent component, Composite composite, St
sb.append(annotator.getPrefix(composite, component));

String fieldName = component.getFieldName();
if (fieldName == null || fieldName.length() == 0) {
if (fieldName == null || fieldName.isEmpty()) {
fieldName = component.getDefaultFieldName();
}

Expand All @@ -492,7 +530,7 @@ private void writeComponent(DataTypeComponent component, Composite composite, St
sb.append(annotator.getSuffix(composite, component));

String comment = component.getComment();
if (comment != null && comment.length() > 0) {
if (comment != null && !comment.isEmpty()) {
sb.append(" " + comment(comment));
}
sb.append(EOL);
Expand Down