iced_x86/formatter/
fmt_opt_provider.rs

1// SPDX-License-Identifier: MIT
2// Copyright (C) 2018-present iced project and contributors
3
4use crate::*;
5use core::mem;
6
7/// Can override options used by a [`Formatter`]
8///
9/// [`Formatter`]: trait.Formatter.html
10pub trait FormatterOptionsProvider {
11	/// Called by the formatter. The method can override any options before the formatter uses them.
12	///
13	/// # Arguments
14	///
15	/// - `instruction`: Instruction
16	/// - `operand`: Operand number, 0-based. This is a formatter operand and isn't necessarily the same as an instruction operand.
17	/// - `instruction_operand`: Instruction operand number, 0-based, or `None` if it's an operand created by the formatter.
18	/// - `options`: Options. Only those options that will be used by the formatter are initialized.
19	/// - `number_options`: Number formatting options
20	fn operand_options(
21		&mut self, instruction: &Instruction, operand: u32, instruction_operand: Option<u32>, options: &mut FormatterOperandOptions,
22		number_options: &mut NumberFormattingOptions<'_>,
23	);
24}
25
26pub(super) struct FormatterOperandOptionsFlags;
27impl FormatterOperandOptionsFlags {
28	#[cfg(any(feature = "intel", feature = "masm", feature = "nasm"))]
29	pub(super) const NONE: u32 = 0x0000_0000;
30	pub(super) const NO_BRANCH_SIZE: u32 = 0x0000_0001;
31	const RIP_RELATIVE_ADDRESSES: u32 = 0x0000_0002;
32	const MEMORY_SIZE_SHIFT: u32 = 30;
33	const MEMORY_SIZE_MASK: u32 = 3 << FormatterOperandOptionsFlags::MEMORY_SIZE_SHIFT;
34}
35
36/// Operand options
37#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Hash)]
38pub struct FormatterOperandOptions {
39	flags: u32, // FormatterOperandOptionsFlags
40}
41
42impl FormatterOperandOptions {
43	#[cfg(any(feature = "intel", feature = "masm", feature = "nasm"))]
44	#[must_use]
45	#[inline]
46	pub(super) const fn new(flags: u32) -> Self {
47		Self { flags }
48	}
49
50	#[must_use]
51	#[inline]
52	pub(super) const fn with_memory_size_options(options: MemorySizeOptions) -> Self {
53		Self { flags: (options as u32) << FormatterOperandOptionsFlags::MEMORY_SIZE_SHIFT }
54	}
55
56	/// Show branch size (eg. `SHORT`, `NEAR PTR`)
57	#[must_use]
58	#[inline]
59	pub const fn branch_size(&self) -> bool {
60		(self.flags & FormatterOperandOptionsFlags::NO_BRANCH_SIZE) == 0
61	}
62
63	/// Show branch size (eg. `SHORT`, `NEAR PTR`)
64	///
65	/// # Arguments
66	///
67	/// - `value`: New value
68	#[inline]
69	pub fn set_branch_size(&mut self, value: bool) {
70		if value {
71			self.flags &= !FormatterOperandOptionsFlags::NO_BRANCH_SIZE;
72		} else {
73			self.flags |= FormatterOperandOptionsFlags::NO_BRANCH_SIZE;
74		}
75	}
76
77	/// If `true`, show `RIP` relative addresses as `[rip+12345678h]`, else show the linear address eg. `[1029384756AFBECDh]`
78	#[must_use]
79	#[inline]
80	pub const fn rip_relative_addresses(&self) -> bool {
81		(self.flags & FormatterOperandOptionsFlags::RIP_RELATIVE_ADDRESSES) != 0
82	}
83
84	/// If `true`, show `RIP` relative addresses as `[rip+12345678h]`, else show the linear address eg. `[1029384756AFBECDh]`
85	///
86	/// # Arguments
87	///
88	/// - `value`: New value
89	#[inline]
90	pub fn set_rip_relative_addresses(&mut self, value: bool) {
91		if value {
92			self.flags |= FormatterOperandOptionsFlags::RIP_RELATIVE_ADDRESSES;
93		} else {
94			self.flags &= !FormatterOperandOptionsFlags::RIP_RELATIVE_ADDRESSES;
95		}
96	}
97
98	/// Memory size options
99	#[must_use]
100	#[inline]
101	pub fn memory_size_options(&self) -> MemorySizeOptions {
102		// SAFETY: the bits can only be a valid enum value
103		unsafe { mem::transmute((self.flags >> FormatterOperandOptionsFlags::MEMORY_SIZE_SHIFT) as MemorySizeOptionsUnderlyingType) }
104	}
105
106	/// Memory size options
107	///
108	/// # Arguments
109	///
110	/// - `value`: New value
111	#[inline]
112	pub fn set_memory_size_options(&mut self, value: MemorySizeOptions) {
113		self.flags =
114			(self.flags & !FormatterOperandOptionsFlags::MEMORY_SIZE_MASK) | ((value as u32) << FormatterOperandOptionsFlags::MEMORY_SIZE_SHIFT)
115	}
116}
iced_x86/formatter/fmt_opt_provider.rs

iced_x86/formatter/
fmt_opt_provider.rs
