Skip to content

Commit

Permalink
stucts window: Add endianness toggle and "jump to pointed offset" link
Browse files Browse the repository at this point in the history
  • Loading branch information
@crumblingstatue
crumblingstatue committed Nov 3, 2024
1 parent fdd084f commit a1fedf0
Show file tree
Hide file tree
Showing 2 changed files with 200 additions and 61 deletions.
73 changes: 52 additions & 21 deletions src/gui/windows/structs_window.rs
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
use {super::WindowOpen, crate::struct_meta_item::StructMetaItem, core::f32};
use {
super::WindowOpen,
crate::struct_meta_item::{Endian, StructMetaItem, StructTy},
core::f32,
};

#[derive(Default)]
pub struct StructsWindow {
pub open: WindowOpen,
struct_text_buf: String,
parsed_struct: Option<StructMetaItem>,
error_label: String,
}

fn read_ty_as_usize_at(data: &[u8], ty: &StructTy, offset: usize) -> Option<usize> {
ty.read_usize(data.get(offset..)?)
}

impl super::Window for StructsWindow {
Expand All @@ -13,40 +23,61 @@ impl super::Window for StructsWindow {
.desired_width(f32::INFINITY)
.hint_text("Rust struct definition"),
);
egui::ScrollArea::vertical().max_height(300.0).show(ui, |ui| {
if ui.button("Parse").clicked() {
match structparse::Struct::parse(&self.struct_text_buf) {
Ok(struct_) => match StructMetaItem::new(struct_) {
Ok(struct_) => {
for (off, field) in struct_.fields_with_offsets() {
ui.horizontal(|ui| {
if ui.link(off.to_string()).clicked() {
app.search_focus(off);
}
ui.label(format!(
"{}: {} [size: {}]",
field.name,
field.ty,
field.ty.size()
));
if ui.button("select").clicked() {
app.hex_ui.select_a = Some(off);
app.hex_ui.select_b = Some(off + field.ty.size());
}
});
}
self.parsed_struct = Some(struct_);
}
Err(e) => {
ui.label(format!("Resolve error: {e}"));
self.error_label = format!("Resolve error: {e}");
}
},
Err(e) => {
ui.label(format!("Parse error: {e}"));
self.error_label = format!("Parse error: {e}");
}
}
}
egui::ScrollArea::vertical().max_height(300.0).show(ui, |ui| {
if let Some(struct_) = &mut self.parsed_struct {
struct_ui(struct_, ui, app);
}
if !self.error_label.is_empty() {
ui.label(egui::RichText::new(&self.error_label).color(egui::Color32::RED));
}
});
}

fn title(&self) -> &str {
"Structs"
}
}

fn struct_ui(struct_: &mut StructMetaItem, ui: &mut egui::Ui, app: &mut crate::app::App) {
for (off, field) in struct_.fields_with_offsets_mut() {
ui.horizontal(|ui| {
if ui.link(off.to_string()).clicked() {
app.search_focus(off);
}
ui.label(format!(
"{}: {} [size: {}]",
field.name,
field.ty,
field.ty.size()
));
let en = field.ty.endian_mut();
if ui.checkbox(&mut matches!(en, Endian::Be), en.label()).clicked() {
en.toggle();
}
if ui.button("select").clicked() {
app.hex_ui.select_a = Some(off);
app.hex_ui.select_b = Some(off + field.ty.size());
}
if let Some(val) = read_ty_as_usize_at(&app.data, &field.ty, off) {
if ui.link(val.to_string()).on_hover_text("Jump to pointed-to offset").clicked() {
app.search_focus(val);
}
}
});
}
}
188 changes: 148 additions & 40 deletions src/struct_meta_item.rs
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
use serde::{Deserialize, Serialize};
use {
crate::meta::value_type::{
EndianedPrimitive as _, I16Be, I16Le, I32Be, I32Le, I64Be, I64Le, U16Be, U16Le, U32Be,
U32Le, U64Be, U64Le, I8, U8,
},
serde::{Deserialize, Serialize},
};

#[derive(Serialize, Deserialize, Clone)]
pub struct StructMetaItem {
Expand All @@ -15,13 +21,14 @@ impl StructMetaItem {
fields: fields?,
})
}
pub fn fields_with_offsets(&self) -> impl Iterator<Item = (usize, &StructField)> {
pub fn fields_with_offsets_mut(&mut self) -> impl Iterator<Item = (usize, &mut StructField)> {
let mut offset = 0;
let mut fields = self.fields.iter();
let mut fields = self.fields.iter_mut();
std::iter::from_fn(move || {
let field = fields.next()?;
let item = (offset, field);
offset += field.ty.size();
let ty_size = field.ty.size();
let item = (offset, &mut *field);
offset += ty_size;
Some(item)
})
}
Expand All @@ -38,14 +45,46 @@ fn try_resolve_ty(ty: structparse::Ty) -> anyhow::Result<StructTy> {
match ty {
structparse::Ty::Ident(ident) => {
let ty = match ident {
"i8" => StructTy::I8,
"u8" => StructTy::U8,
"i16" => StructTy::I16,
"u16" => StructTy::U16,
"i32" => StructTy::I32,
"u32" => StructTy::U32,
"i64" => StructTy::I64,
"u64" => StructTy::U64,
"i8" => StructTy::IntegerPrimitive {
size: IPrimSize::S8,
signed: true,
endian: Endian::Le,
},
"u8" => StructTy::IntegerPrimitive {
size: IPrimSize::S8,
signed: false,
endian: Endian::Le,
},
"i16" => StructTy::IntegerPrimitive {
size: IPrimSize::S16,
signed: true,
endian: Endian::Le,
},
"u16" => StructTy::IntegerPrimitive {
size: IPrimSize::S16,
signed: false,
endian: Endian::Le,
},
"i32" => StructTy::IntegerPrimitive {
size: IPrimSize::S32,
signed: true,
endian: Endian::Le,
},
"u32" => StructTy::IntegerPrimitive {
size: IPrimSize::S32,
signed: false,
endian: Endian::Le,
},
"i64" => StructTy::IntegerPrimitive {
size: IPrimSize::S64,
signed: true,
endian: Endian::Le,
},
"u64" => StructTy::IntegerPrimitive {
size: IPrimSize::S64,
signed: false,
endian: Endian::Le,
},
_ => anyhow::bail!("Unknown type"),
};
Ok(ty)
Expand All @@ -63,47 +102,116 @@ pub struct StructField {
pub ty: StructTy,
}

#[derive(Serialize, Deserialize, Clone)]
pub enum Endian {
Le,
Be,
}

impl Endian {
pub fn label(&self) -> &'static str {
match self {
Endian::Le => "le",
Endian::Be => "be",
}
}

pub(crate) fn toggle(&mut self) {
*self = match self {
Endian::Le => Endian::Be,
Endian::Be => Endian::Le,
}
}
}

#[derive(Serialize, Deserialize, Clone)]
pub enum IPrimSize {
S8,
S16,
S32,
S64,
}

#[derive(Serialize, Deserialize, Clone)]
pub enum StructTy {
I8,
U8,
I16,
U16,
I32,
U32,
I64,
U64,
Array { item_ty: Box<StructTy>, len: usize },
IntegerPrimitive {
size: IPrimSize,
signed: bool,
endian: Endian,
},

Array {
item_ty: Box<StructTy>,
len: usize,
},
}

impl StructTy {
pub fn size(&self) -> usize {
match self {
StructTy::I8 | StructTy::U8 => 1,
StructTy::I16 | StructTy::U16 => 2,
StructTy::I32 | StructTy::U32 => 4,
StructTy::I64 | StructTy::U64 => 8,
StructTy::Array { item_ty, len } => item_ty.size() * *len,
Self::IntegerPrimitive { size, .. } => match size {
IPrimSize::S8 => 1,
IPrimSize::S16 => 2,
IPrimSize::S32 => 4,
IPrimSize::S64 => 8,
},
Self::Array { item_ty, len } => item_ty.size() * *len,
}
}
pub fn read_usize(&self, data: &[u8]) -> Option<usize> {
match self {
StructTy::IntegerPrimitive {
size,
signed,
endian,
} => {
macro_rules! from_byte_slice {
($t:ty) => {
<$t>::from_byte_slice(&data[..self.size()]).and_then(|i| i.try_into().ok())
};
}
match (size, signed, endian) {
(IPrimSize::S8, true, Endian::Le) => from_byte_slice!(I8),
(IPrimSize::S8, true, Endian::Be) => from_byte_slice!(I8),
(IPrimSize::S8, false, Endian::Le) => from_byte_slice!(U8),
(IPrimSize::S8, false, Endian::Be) => from_byte_slice!(U8),
(IPrimSize::S16, true, Endian::Le) => from_byte_slice!(I16Le),
(IPrimSize::S16, true, Endian::Be) => from_byte_slice!(I16Be),
(IPrimSize::S16, false, Endian::Le) => from_byte_slice!(U16Le),
(IPrimSize::S16, false, Endian::Be) => from_byte_slice!(U16Be),
(IPrimSize::S32, true, Endian::Le) => from_byte_slice!(I32Le),
(IPrimSize::S32, true, Endian::Be) => from_byte_slice!(I32Be),
(IPrimSize::S32, false, Endian::Le) => from_byte_slice!(U32Le),
(IPrimSize::S32, false, Endian::Be) => from_byte_slice!(U32Be),
(IPrimSize::S64, true, Endian::Le) => from_byte_slice!(I64Le),
(IPrimSize::S64, true, Endian::Be) => from_byte_slice!(I64Be),
(IPrimSize::S64, false, Endian::Le) => from_byte_slice!(U64Le),
(IPrimSize::S64, false, Endian::Be) => from_byte_slice!(U64Be),
}
}
StructTy::Array { .. } => None,
}
}
pub fn endian_mut(&mut self) -> &mut Endian {
match self {
StructTy::IntegerPrimitive { endian, .. } => endian,
StructTy::Array { item_ty, .. } => item_ty.endian_mut(),
}
}
}

impl std::fmt::Display for StructTy {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let label = match self {
StructTy::I8 => "i8",
StructTy::U8 => "u8",
StructTy::I16 => "i16",
StructTy::U16 => "u16",
StructTy::I32 => "i32",
StructTy::U32 => "u32",
StructTy::I64 => "i64",
StructTy::U64 => "u64",
match self {
StructTy::IntegerPrimitive { signed, endian, .. } => {
let sign = if *signed { "i" } else { "u" };
let size = self.size() * 8;
let endian = endian.label();
write!(f, "{sign}{size}-{endian}")
}
StructTy::Array { item_ty, len } => {
write!(f, "[{item_ty}; {len}]")?;
return Ok(());
write!(f, "[{item_ty}; {len}]")
}
};
f.write_str(label)
}
}
}

0 comments on commit a1fedf0

Please sign in to comment.