iced_x86/encoder/
enums.rs

1// SPDX-License-Identifier: MIT
2// Copyright (C) 2018-present iced project and contributors
3
4use crate::encoder::iced_constants::IcedConstants;
5use crate::encoder::iced_error::IcedError;
6use core::iter::{ExactSizeIterator, FusedIterator, Iterator};
7use core::{fmt, mem};
8
9// GENERATOR-BEGIN: DisplSize
10// ⚠️This was generated by GENERATOR!🦹‍♂️
11#[derive(Copy, Clone, Eq, PartialEq)]
12#[allow(non_camel_case_types)]
13#[allow(dead_code)]
14pub(crate) enum DisplSize {
15	None,
16	Size1,
17	Size2,
18	Size4,
19	Size8,
20	RipRelSize4_Target32,
21	RipRelSize4_Target64,
22}
23#[rustfmt::skip]
24static GEN_DEBUG_DISPL_SIZE: [&str; 7] = [
25	"None",
26	"Size1",
27	"Size2",
28	"Size4",
29	"Size8",
30	"RipRelSize4_Target32",
31	"RipRelSize4_Target64",
32];
33impl fmt::Debug for DisplSize {
34	#[inline]
35	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
36		write!(f, "{}", GEN_DEBUG_DISPL_SIZE[*self as usize])
37	}
38}
39impl Default for DisplSize {
40	#[must_use]
41	#[inline]
42	fn default() -> Self {
43		DisplSize::None
44	}
45}
46// GENERATOR-END: DisplSize
47
48// GENERATOR-BEGIN: ImmSize
49// ⚠️This was generated by GENERATOR!🦹‍♂️
50#[derive(Copy, Clone, Eq, PartialEq)]
51#[allow(non_camel_case_types)]
52#[allow(dead_code)]
53pub(crate) enum ImmSize {
54	None,
55	Size1,
56	Size2,
57	Size4,
58	Size8,
59	/// `ENTER xxxx,yy`
60	Size2_1,
61	/// `EXTRQ/INSERTQ xx,yy`
62	Size1_1,
63	/// `CALL16 FAR x:y`
64	Size2_2,
65	/// `CALL32 FAR x:y`
66	Size4_2,
67	RipRelSize1_Target16,
68	RipRelSize1_Target32,
69	RipRelSize1_Target64,
70	RipRelSize2_Target16,
71	RipRelSize2_Target32,
72	RipRelSize2_Target64,
73	RipRelSize4_Target32,
74	RipRelSize4_Target64,
75	SizeIbReg,
76	Size1OpCode,
77}
78#[rustfmt::skip]
79static GEN_DEBUG_IMM_SIZE: [&str; 19] = [
80	"None",
81	"Size1",
82	"Size2",
83	"Size4",
84	"Size8",
85	"Size2_1",
86	"Size1_1",
87	"Size2_2",
88	"Size4_2",
89	"RipRelSize1_Target16",
90	"RipRelSize1_Target32",
91	"RipRelSize1_Target64",
92	"RipRelSize2_Target16",
93	"RipRelSize2_Target32",
94	"RipRelSize2_Target64",
95	"RipRelSize4_Target32",
96	"RipRelSize4_Target64",
97	"SizeIbReg",
98	"Size1OpCode",
99];
100impl fmt::Debug for ImmSize {
101	#[inline]
102	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
103		write!(f, "{}", GEN_DEBUG_IMM_SIZE[*self as usize])
104	}
105}
106impl Default for ImmSize {
107	#[must_use]
108	#[inline]
109	fn default() -> Self {
110		ImmSize::None
111	}
112}
113// GENERATOR-END: ImmSize
114
115// GENERATOR-BEGIN: EncoderFlags
116// ⚠️This was generated by GENERATOR!🦹‍♂️
117pub(crate) struct EncoderFlags;
118#[allow(dead_code)]
119impl EncoderFlags {
120	pub(crate) const NONE: u32 = 0x0000_0000;
121	pub(crate) const B: u32 = 0x0000_0001;
122	pub(crate) const X: u32 = 0x0000_0002;
123	pub(crate) const R: u32 = 0x0000_0004;
124	pub(crate) const W: u32 = 0x0000_0008;
125	pub(crate) const MOD_RM: u32 = 0x0000_0010;
126	pub(crate) const SIB: u32 = 0x0000_0020;
127	pub(crate) const REX: u32 = 0x0000_0040;
128	pub(crate) const P66: u32 = 0x0000_0080;
129	pub(crate) const P67: u32 = 0x0000_0100;
130	/// `EVEX.R'`
131	pub(crate) const R2: u32 = 0x0000_0200;
132	pub(crate) const BROADCAST: u32 = 0x0000_0400;
133	pub(crate) const HIGH_LEGACY_8_BIT_REGS: u32 = 0x0000_0800;
134	pub(crate) const DISPL: u32 = 0x0000_1000;
135	pub(crate) const PF0: u32 = 0x0000_2000;
136	pub(crate) const REG_IS_MEMORY: u32 = 0x0000_4000;
137	pub(crate) const MUST_USE_SIB: u32 = 0x0000_8000;
138	pub(crate) const VVVVV_SHIFT: u32 = 0x0000_001B;
139	pub(crate) const VVVVV_MASK: u32 = 0x0000_001F;
140}
141// GENERATOR-END: EncoderFlags
142
143// GENERATOR-BEGIN: LegacyOpCodeTable
144// ⚠️This was generated by GENERATOR!🦹‍♂️
145#[derive(Copy, Clone, Eq, PartialEq)]
146#[allow(non_camel_case_types)]
147#[allow(dead_code)]
148pub(crate) enum LegacyOpCodeTable {
149	MAP0,
150	MAP0F,
151	MAP0F38,
152	MAP0F3A,
153}
154#[rustfmt::skip]
155static GEN_DEBUG_LEGACY_OP_CODE_TABLE: [&str; 4] = [
156	"MAP0",
157	"MAP0F",
158	"MAP0F38",
159	"MAP0F3A",
160];
161impl fmt::Debug for LegacyOpCodeTable {
162	#[inline]
163	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
164		write!(f, "{}", GEN_DEBUG_LEGACY_OP_CODE_TABLE[*self as usize])
165	}
166}
167impl Default for LegacyOpCodeTable {
168	#[must_use]
169	#[inline]
170	fn default() -> Self {
171		LegacyOpCodeTable::MAP0
172	}
173}
174// GENERATOR-END: LegacyOpCodeTable
175
176// GENERATOR-BEGIN: VexOpCodeTable
177// ⚠️This was generated by GENERATOR!🦹‍♂️
178#[derive(Copy, Clone, Eq, PartialEq)]
179#[allow(non_camel_case_types)]
180#[cfg(not(feature = "no_vex"))]
181#[allow(dead_code)]
182pub(crate) enum VexOpCodeTable {
183	MAP0,
184	MAP0F,
185	MAP0F38,
186	MAP0F3A,
187}
188#[cfg(not(feature = "no_vex"))]
189#[rustfmt::skip]
190static GEN_DEBUG_VEX_OP_CODE_TABLE: [&str; 4] = [
191	"MAP0",
192	"MAP0F",
193	"MAP0F38",
194	"MAP0F3A",
195];
196#[cfg(not(feature = "no_vex"))]
197impl fmt::Debug for VexOpCodeTable {
198	#[inline]
199	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
200		write!(f, "{}", GEN_DEBUG_VEX_OP_CODE_TABLE[*self as usize])
201	}
202}
203#[cfg(not(feature = "no_vex"))]
204impl Default for VexOpCodeTable {
205	#[must_use]
206	#[inline]
207	fn default() -> Self {
208		VexOpCodeTable::MAP0
209	}
210}
211// GENERATOR-END: VexOpCodeTable
212
213// GENERATOR-BEGIN: XopOpCodeTable
214// ⚠️This was generated by GENERATOR!🦹‍♂️
215#[derive(Copy, Clone, Eq, PartialEq)]
216#[allow(non_camel_case_types)]
217#[cfg(not(feature = "no_xop"))]
218#[allow(dead_code)]
219pub(crate) enum XopOpCodeTable {
220	MAP8,
221	MAP9,
222	MAP10,
223}
224#[cfg(not(feature = "no_xop"))]
225#[rustfmt::skip]
226static GEN_DEBUG_XOP_OP_CODE_TABLE: [&str; 3] = [
227	"MAP8",
228	"MAP9",
229	"MAP10",
230];
231#[cfg(not(feature = "no_xop"))]
232impl fmt::Debug for XopOpCodeTable {
233	#[inline]
234	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
235		write!(f, "{}", GEN_DEBUG_XOP_OP_CODE_TABLE[*self as usize])
236	}
237}
238#[cfg(not(feature = "no_xop"))]
239impl Default for XopOpCodeTable {
240	#[must_use]
241	#[inline]
242	fn default() -> Self {
243		XopOpCodeTable::MAP8
244	}
245}
246// GENERATOR-END: XopOpCodeTable
247
248// GENERATOR-BEGIN: EvexOpCodeTable
249// ⚠️This was generated by GENERATOR!🦹‍♂️
250#[derive(Copy, Clone, Eq, PartialEq)]
251#[allow(non_camel_case_types)]
252#[cfg(not(feature = "no_evex"))]
253#[allow(dead_code)]
254pub(crate) enum EvexOpCodeTable {
255	MAP0F = 1,
256	MAP0F38,
257	MAP0F3A,
258	MAP5 = 5,
259	MAP6,
260}
261#[cfg(not(feature = "no_evex"))]
262impl Default for EvexOpCodeTable {
263	#[must_use]
264	#[inline]
265	fn default() -> Self {
266		EvexOpCodeTable::MAP0F
267	}
268}
269// GENERATOR-END: EvexOpCodeTable
270
271// GENERATOR-BEGIN: MvexOpCodeTable
272// ⚠️This was generated by GENERATOR!🦹‍♂️
273#[derive(Copy, Clone, Eq, PartialEq)]
274#[allow(non_camel_case_types)]
275#[cfg(feature = "mvex")]
276#[allow(dead_code)]
277pub(crate) enum MvexOpCodeTable {
278	MAP0F = 1,
279	MAP0F38,
280	MAP0F3A,
281}
282#[cfg(feature = "mvex")]
283impl Default for MvexOpCodeTable {
284	#[must_use]
285	#[inline]
286	fn default() -> Self {
287		MvexOpCodeTable::MAP0F
288	}
289}
290// GENERATOR-END: MvexOpCodeTable
291
292// GENERATOR-BEGIN: EncFlags1
293// ⚠️This was generated by GENERATOR!🦹‍♂️
294pub(crate) struct EncFlags1;
295#[allow(dead_code)]
296impl EncFlags1 {
297	pub(crate) const NONE: u32 = 0x0000_0000;
298	pub(crate) const LEGACY_OP_MASK: u32 = 0x0000_007F;
299	pub(crate) const LEGACY_OP0_SHIFT: u32 = 0x0000_0000;
300	pub(crate) const LEGACY_OP1_SHIFT: u32 = 0x0000_0007;
301	pub(crate) const LEGACY_OP2_SHIFT: u32 = 0x0000_000E;
302	pub(crate) const LEGACY_OP3_SHIFT: u32 = 0x0000_0015;
303	pub(crate) const VEX_OP_MASK: u32 = 0x0000_003F;
304	pub(crate) const VEX_OP0_SHIFT: u32 = 0x0000_0000;
305	pub(crate) const VEX_OP1_SHIFT: u32 = 0x0000_0006;
306	pub(crate) const VEX_OP2_SHIFT: u32 = 0x0000_000C;
307	pub(crate) const VEX_OP3_SHIFT: u32 = 0x0000_0012;
308	pub(crate) const VEX_OP4_SHIFT: u32 = 0x0000_0018;
309	pub(crate) const XOP_OP_MASK: u32 = 0x0000_001F;
310	pub(crate) const XOP_OP0_SHIFT: u32 = 0x0000_0000;
311	pub(crate) const XOP_OP1_SHIFT: u32 = 0x0000_0005;
312	pub(crate) const XOP_OP2_SHIFT: u32 = 0x0000_000A;
313	pub(crate) const XOP_OP3_SHIFT: u32 = 0x0000_000F;
314	pub(crate) const EVEX_OP_MASK: u32 = 0x0000_001F;
315	pub(crate) const EVEX_OP0_SHIFT: u32 = 0x0000_0000;
316	pub(crate) const EVEX_OP1_SHIFT: u32 = 0x0000_0005;
317	pub(crate) const EVEX_OP2_SHIFT: u32 = 0x0000_000A;
318	pub(crate) const EVEX_OP3_SHIFT: u32 = 0x0000_000F;
319	pub(crate) const MVEX_OP_MASK: u32 = 0x0000_000F;
320	pub(crate) const MVEX_OP0_SHIFT: u32 = 0x0000_0000;
321	pub(crate) const MVEX_OP1_SHIFT: u32 = 0x0000_0004;
322	pub(crate) const MVEX_OP2_SHIFT: u32 = 0x0000_0008;
323	pub(crate) const MVEX_OP3_SHIFT: u32 = 0x0000_000C;
324	pub(crate) const IGNORES_ROUNDING_CONTROL: u32 = 0x4000_0000;
325	pub(crate) const AMD_LOCK_REG_BIT: u32 = 0x8000_0000;
326}
327// GENERATOR-END: EncFlags1
328
329// GENERATOR-BEGIN: EncFlags2
330// ⚠️This was generated by GENERATOR!🦹‍♂️
331pub(crate) struct EncFlags2;
332#[allow(dead_code)]
333impl EncFlags2 {
334	pub(crate) const NONE: u32 = 0x0000_0000;
335	pub(crate) const OP_CODE_SHIFT: u32 = 0x0000_0000;
336	pub(crate) const OP_CODE_IS2_BYTES: u32 = 0x0001_0000;
337	pub(crate) const TABLE_SHIFT: u32 = 0x0000_0011;
338	pub(crate) const TABLE_MASK: u32 = 0x0000_0007;
339	pub(crate) const MANDATORY_PREFIX_SHIFT: u32 = 0x0000_0014;
340	pub(crate) const MANDATORY_PREFIX_MASK: u32 = 0x0000_0003;
341	pub(crate) const WBIT_SHIFT: u32 = 0x0000_0016;
342	pub(crate) const WBIT_MASK: u32 = 0x0000_0003;
343	pub(crate) const LBIT_SHIFT: u32 = 0x0000_0018;
344	pub(crate) const LBIT_MASK: u32 = 0x0000_0007;
345	pub(crate) const GROUP_INDEX_SHIFT: u32 = 0x0000_001B;
346	pub(crate) const GROUP_INDEX_MASK: u32 = 0x0000_0007;
347	pub(crate) const HAS_MANDATORY_PREFIX: u32 = 0x4000_0000;
348	pub(crate) const HAS_GROUP_INDEX: u32 = 0x8000_0000;
349}
350// GENERATOR-END: EncFlags2
351
352// GENERATOR-BEGIN: EncFlags3
353// ⚠️This was generated by GENERATOR!🦹‍♂️
354pub(crate) struct EncFlags3;
355#[allow(dead_code)]
356impl EncFlags3 {
357	pub(crate) const NONE: u32 = 0x0000_0000;
358	pub(crate) const ENCODING_SHIFT: u32 = 0x0000_0000;
359	pub(crate) const ENCODING_MASK: u32 = 0x0000_0007;
360	pub(crate) const OPERAND_SIZE_SHIFT: u32 = 0x0000_0003;
361	pub(crate) const OPERAND_SIZE_MASK: u32 = 0x0000_0003;
362	pub(crate) const ADDRESS_SIZE_SHIFT: u32 = 0x0000_0005;
363	pub(crate) const ADDRESS_SIZE_MASK: u32 = 0x0000_0003;
364	pub(crate) const TUPLE_TYPE_SHIFT: u32 = 0x0000_0007;
365	pub(crate) const TUPLE_TYPE_MASK: u32 = 0x0000_001F;
366	pub(crate) const DEFAULT_OP_SIZE64: u32 = 0x0000_1000;
367	pub(crate) const HAS_RM_GROUP_INDEX: u32 = 0x0000_2000;
368	pub(crate) const INTEL_FORCE_OP_SIZE64: u32 = 0x0000_4000;
369	pub(crate) const FWAIT: u32 = 0x0000_8000;
370	pub(crate) const BIT16OR32: u32 = 0x0001_0000;
371	pub(crate) const BIT64: u32 = 0x0002_0000;
372	pub(crate) const LOCK: u32 = 0x0004_0000;
373	pub(crate) const XACQUIRE: u32 = 0x0008_0000;
374	pub(crate) const XRELEASE: u32 = 0x0010_0000;
375	pub(crate) const REP: u32 = 0x0020_0000;
376	pub(crate) const REPNE: u32 = 0x0040_0000;
377	pub(crate) const BND: u32 = 0x0080_0000;
378	pub(crate) const HINT_TAKEN: u32 = 0x0100_0000;
379	pub(crate) const NOTRACK: u32 = 0x0200_0000;
380	pub(crate) const BROADCAST: u32 = 0x0400_0000;
381	pub(crate) const ROUNDING_CONTROL: u32 = 0x0800_0000;
382	pub(crate) const SUPPRESS_ALL_EXCEPTIONS: u32 = 0x1000_0000;
383	pub(crate) const OP_MASK_REGISTER: u32 = 0x2000_0000;
384	pub(crate) const ZEROING_MASKING: u32 = 0x4000_0000;
385	pub(crate) const REQUIRE_OP_MASK_REGISTER: u32 = 0x8000_0000;
386}
387// GENERATOR-END: EncFlags3
388
389// GENERATOR-BEGIN: OpCodeInfoFlags1
390// ⚠️This was generated by GENERATOR!🦹‍♂️
391#[cfg(all(feature = "encoder", feature = "op_code_info"))]
392pub(crate) struct OpCodeInfoFlags1;
393#[cfg(all(feature = "encoder", feature = "op_code_info"))]
394#[allow(dead_code)]
395impl OpCodeInfoFlags1 {
396	pub(crate) const NONE: u32 = 0x0000_0000;
397	pub(crate) const CPL0_ONLY: u32 = 0x0000_0001;
398	pub(crate) const CPL3_ONLY: u32 = 0x0000_0002;
399	pub(crate) const INPUT_OUTPUT: u32 = 0x0000_0004;
400	pub(crate) const NOP: u32 = 0x0000_0008;
401	pub(crate) const RESERVED_NOP: u32 = 0x0000_0010;
402	pub(crate) const SERIALIZING_INTEL: u32 = 0x0000_0020;
403	pub(crate) const SERIALIZING_AMD: u32 = 0x0000_0040;
404	pub(crate) const MAY_REQUIRE_CPL0: u32 = 0x0000_0080;
405	pub(crate) const CET_TRACKED: u32 = 0x0000_0100;
406	pub(crate) const NON_TEMPORAL: u32 = 0x0000_0200;
407	pub(crate) const FPU_NO_WAIT: u32 = 0x0000_0400;
408	pub(crate) const IGNORES_MOD_BITS: u32 = 0x0000_0800;
409	pub(crate) const NO66: u32 = 0x0000_1000;
410	pub(crate) const NFX: u32 = 0x0000_2000;
411	pub(crate) const REQUIRES_UNIQUE_REG_NUMS: u32 = 0x0000_4000;
412	pub(crate) const PRIVILEGED: u32 = 0x0000_8000;
413	pub(crate) const SAVE_RESTORE: u32 = 0x0001_0000;
414	pub(crate) const STACK_INSTRUCTION: u32 = 0x0002_0000;
415	pub(crate) const IGNORES_SEGMENT: u32 = 0x0004_0000;
416	pub(crate) const OP_MASK_READ_WRITE: u32 = 0x0008_0000;
417	pub(crate) const MOD_REG_RM_STRING: u32 = 0x0010_0000;
418	pub(crate) const DEC_OPTION_VALUE_MASK: u32 = 0x0000_001F;
419	pub(crate) const DEC_OPTION_VALUE_SHIFT: u32 = 0x0000_0015;
420	pub(crate) const FORCE_OP_SIZE64: u32 = 0x4000_0000;
421	pub(crate) const REQUIRES_UNIQUE_DEST_REG_NUM: u32 = 0x8000_0000;
422}
423// GENERATOR-END: OpCodeInfoFlags1
424
425// GENERATOR-BEGIN: OpCodeInfoFlags2
426// ⚠️This was generated by GENERATOR!🦹‍♂️
427#[cfg(all(feature = "encoder", feature = "op_code_info"))]
428pub(crate) struct OpCodeInfoFlags2;
429#[cfg(all(feature = "encoder", feature = "op_code_info"))]
430#[allow(dead_code)]
431impl OpCodeInfoFlags2 {
432	pub(crate) const NONE: u32 = 0x0000_0000;
433	pub(crate) const REAL_MODE: u32 = 0x0000_0001;
434	pub(crate) const PROTECTED_MODE: u32 = 0x0000_0002;
435	pub(crate) const VIRTUAL8086_MODE: u32 = 0x0000_0004;
436	pub(crate) const COMPATIBILITY_MODE: u32 = 0x0000_0008;
437	pub(crate) const USE_OUTSIDE_SMM: u32 = 0x0000_0010;
438	pub(crate) const USE_IN_SMM: u32 = 0x0000_0020;
439	pub(crate) const USE_OUTSIDE_ENCLAVE_SGX: u32 = 0x0000_0040;
440	pub(crate) const USE_IN_ENCLAVE_SGX1: u32 = 0x0000_0080;
441	pub(crate) const USE_IN_ENCLAVE_SGX2: u32 = 0x0000_0100;
442	pub(crate) const USE_OUTSIDE_VMX_OP: u32 = 0x0000_0200;
443	pub(crate) const USE_IN_VMX_ROOT_OP: u32 = 0x0000_0400;
444	pub(crate) const USE_IN_VMX_NON_ROOT_OP: u32 = 0x0000_0800;
445	pub(crate) const USE_OUTSIDE_SEAM: u32 = 0x0000_1000;
446	pub(crate) const USE_IN_SEAM: u32 = 0x0000_2000;
447	pub(crate) const TDX_NON_ROOT_GEN_UD: u32 = 0x0000_4000;
448	pub(crate) const TDX_NON_ROOT_GEN_VE: u32 = 0x0000_8000;
449	pub(crate) const TDX_NON_ROOT_MAY_GEN_EX: u32 = 0x0001_0000;
450	pub(crate) const INTEL_VM_EXIT: u32 = 0x0002_0000;
451	pub(crate) const INTEL_MAY_VM_EXIT: u32 = 0x0004_0000;
452	pub(crate) const INTEL_SMM_VM_EXIT: u32 = 0x0008_0000;
453	pub(crate) const AMD_VM_EXIT: u32 = 0x0010_0000;
454	pub(crate) const AMD_MAY_VM_EXIT: u32 = 0x0020_0000;
455	pub(crate) const TSX_ABORT: u32 = 0x0040_0000;
456	pub(crate) const TSX_IMPL_ABORT: u32 = 0x0080_0000;
457	pub(crate) const TSX_MAY_ABORT: u32 = 0x0100_0000;
458	pub(crate) const INTEL_DECODER16OR32: u32 = 0x0200_0000;
459	pub(crate) const INTEL_DECODER64: u32 = 0x0400_0000;
460	pub(crate) const AMD_DECODER16OR32: u32 = 0x0800_0000;
461	pub(crate) const AMD_DECODER64: u32 = 0x1000_0000;
462	pub(crate) const INSTR_STR_FMT_OPTION_MASK: u32 = 0x0000_0007;
463	pub(crate) const INSTR_STR_FMT_OPTION_SHIFT: u32 = 0x0000_001D;
464}
465// GENERATOR-END: OpCodeInfoFlags2
466
467// GENERATOR-BEGIN: DecOptionValue
468// ⚠️This was generated by GENERATOR!🦹‍♂️
469#[derive(Copy, Clone, Eq, PartialEq)]
470#[allow(non_camel_case_types)]
471#[cfg(all(feature = "encoder", feature = "op_code_info"))]
472#[allow(dead_code)]
473pub(crate) enum DecOptionValue {
474	None,
475	ALTINST,
476	Cl1invmb,
477	Cmpxchg486A,
478	Cyrix,
479	Cyrix_DMI,
480	Cyrix_SMINT_0F7E,
481	Jmpe,
482	Loadall286,
483	Loadall386,
484	MovTr,
485	MPX,
486	OldFpu,
487	Pcommit,
488	Umov,
489	Xbts,
490	Udbg,
491	KNC,
492}
493#[cfg(all(feature = "encoder", feature = "op_code_info"))]
494#[rustfmt::skip]
495static GEN_DEBUG_DEC_OPTION_VALUE: [&str; 18] = [
496	"None",
497	"ALTINST",
498	"Cl1invmb",
499	"Cmpxchg486A",
500	"Cyrix",
501	"Cyrix_DMI",
502	"Cyrix_SMINT_0F7E",
503	"Jmpe",
504	"Loadall286",
505	"Loadall386",
506	"MovTr",
507	"MPX",
508	"OldFpu",
509	"Pcommit",
510	"Umov",
511	"Xbts",
512	"Udbg",
513	"KNC",
514];
515#[cfg(all(feature = "encoder", feature = "op_code_info"))]
516impl fmt::Debug for DecOptionValue {
517	#[inline]
518	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
519		write!(f, "{}", GEN_DEBUG_DEC_OPTION_VALUE[*self as usize])
520	}
521}
522#[cfg(all(feature = "encoder", feature = "op_code_info"))]
523impl Default for DecOptionValue {
524	#[must_use]
525	#[inline]
526	fn default() -> Self {
527		DecOptionValue::None
528	}
529}
530// GENERATOR-END: DecOptionValue
531
532// GENERATOR-BEGIN: InstrStrFmtOption
533// ⚠️This was generated by GENERATOR!🦹‍♂️
534#[derive(Copy, Clone, Eq, PartialEq)]
535#[allow(non_camel_case_types)]
536#[cfg(all(feature = "encoder", feature = "op_code_info"))]
537#[allow(dead_code)]
538pub(crate) enum InstrStrFmtOption {
539	None,
540	OpMaskIsK1_or_NoGprSuffix,
541	IncVecIndex,
542	NoVecIndex,
543	SwapVecIndex12,
544	SkipOp0,
545	VecIndexSameAsOpIndex,
546}
547#[cfg(all(feature = "encoder", feature = "op_code_info"))]
548#[rustfmt::skip]
549static GEN_DEBUG_INSTR_STR_FMT_OPTION: [&str; 7] = [
550	"None",
551	"OpMaskIsK1_or_NoGprSuffix",
552	"IncVecIndex",
553	"NoVecIndex",
554	"SwapVecIndex12",
555	"SkipOp0",
556	"VecIndexSameAsOpIndex",
557];
558#[cfg(all(feature = "encoder", feature = "op_code_info"))]
559impl fmt::Debug for InstrStrFmtOption {
560	#[inline]
561	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
562		write!(f, "{}", GEN_DEBUG_INSTR_STR_FMT_OPTION[*self as usize])
563	}
564}
565#[cfg(all(feature = "encoder", feature = "op_code_info"))]
566impl Default for InstrStrFmtOption {
567	#[must_use]
568	#[inline]
569	fn default() -> Self {
570		InstrStrFmtOption::None
571	}
572}
573// GENERATOR-END: InstrStrFmtOption
574
575// GENERATOR-BEGIN: WBit
576// ⚠️This was generated by GENERATOR!🦹‍♂️
577#[derive(Copy, Clone, Eq, PartialEq)]
578#[allow(non_camel_case_types)]
579#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
580#[allow(dead_code)]
581pub(crate) enum WBit {
582	W0,
583	W1,
584	WIG,
585	WIG32,
586}
587#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
588#[rustfmt::skip]
589static GEN_DEBUG_WBIT: [&str; 4] = [
590	"W0",
591	"W1",
592	"WIG",
593	"WIG32",
594];
595#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
596impl fmt::Debug for WBit {
597	#[inline]
598	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
599		write!(f, "{}", GEN_DEBUG_WBIT[*self as usize])
600	}
601}
602#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
603impl Default for WBit {
604	#[must_use]
605	#[inline]
606	fn default() -> Self {
607		WBit::W0
608	}
609}
610// GENERATOR-END: WBit
611
612// GENERATOR-BEGIN: LBit
613// ⚠️This was generated by GENERATOR!🦹‍♂️
614#[derive(Copy, Clone, Eq, PartialEq)]
615#[allow(non_camel_case_types)]
616#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
617#[allow(dead_code)]
618pub(crate) enum LBit {
619	L0,
620	L1,
621	LIG,
622	LZ,
623	L128,
624	L256,
625	L512,
626}
627#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
628#[rustfmt::skip]
629static GEN_DEBUG_LBIT: [&str; 7] = [
630	"L0",
631	"L1",
632	"LIG",
633	"LZ",
634	"L128",
635	"L256",
636	"L512",
637];
638#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
639impl fmt::Debug for LBit {
640	#[inline]
641	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
642		write!(f, "{}", GEN_DEBUG_LBIT[*self as usize])
643	}
644}
645#[cfg(any(not(feature = "no_vex"), not(feature = "no_xop"), not(feature = "no_evex"), feature = "mvex"))]
646impl Default for LBit {
647	#[must_use]
648	#[inline]
649	fn default() -> Self {
650		LBit::L0
651	}
652}
653// GENERATOR-END: LBit
654
655// GENERATOR-BEGIN: RepPrefixKind
656// ⚠️This was generated by GENERATOR!🦹‍♂️
657/// `REP`/`REPE`/`REPNE` prefix
658#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
659#[cfg_attr(not(feature = "exhaustive_enums"), non_exhaustive)]
660pub enum RepPrefixKind {
661	/// No `REP`/`REPE`/`REPNE` prefix
662	None = 0,
663	/// `REP`/`REPE` prefix
664	Repe = 1,
665	/// `REPNE` prefix
666	Repne = 2,
667}
668#[rustfmt::skip]
669static GEN_DEBUG_REP_PREFIX_KIND: [&str; 3] = [
670	"None",
671	"Repe",
672	"Repne",
673];
674impl fmt::Debug for RepPrefixKind {
675	#[inline]
676	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
677		write!(f, "{}", GEN_DEBUG_REP_PREFIX_KIND[*self as usize])
678	}
679}
680impl Default for RepPrefixKind {
681	#[must_use]
682	#[inline]
683	fn default() -> Self {
684		RepPrefixKind::None
685	}
686}
687#[allow(non_camel_case_types)]
688#[allow(dead_code)]
689pub(crate) type RepPrefixKindUnderlyingType = u8;
690#[rustfmt::skip]
691impl RepPrefixKind {
692	/// Iterates over all `RepPrefixKind` enum values
693	#[inline]
694	pub fn values() -> impl Iterator<Item = RepPrefixKind> + DoubleEndedIterator + ExactSizeIterator + FusedIterator {
695		// SAFETY: all values 0-max are valid enum values
696		(0..IcedConstants::REP_PREFIX_KIND_ENUM_COUNT).map(|x| unsafe { mem::transmute::<u8, RepPrefixKind>(x as u8) })
697	}
698}
699#[test]
700#[rustfmt::skip]
701fn test_repprefixkind_values() {
702	let mut iter = RepPrefixKind::values();
703	assert_eq!(iter.size_hint(), (IcedConstants::REP_PREFIX_KIND_ENUM_COUNT, Some(IcedConstants::REP_PREFIX_KIND_ENUM_COUNT)));
704	assert_eq!(iter.len(), IcedConstants::REP_PREFIX_KIND_ENUM_COUNT);
705	assert!(iter.next().is_some());
706	assert_eq!(iter.size_hint(), (IcedConstants::REP_PREFIX_KIND_ENUM_COUNT - 1, Some(IcedConstants::REP_PREFIX_KIND_ENUM_COUNT - 1)));
707	assert_eq!(iter.len(), IcedConstants::REP_PREFIX_KIND_ENUM_COUNT - 1);
708
709	let values: Vec<RepPrefixKind> = RepPrefixKind::values().collect();
710	assert_eq!(values.len(), IcedConstants::REP_PREFIX_KIND_ENUM_COUNT);
711	for (i, value) in values.into_iter().enumerate() {
712		assert_eq!(i, value as usize);
713	}
714
715	let values1: Vec<RepPrefixKind> = RepPrefixKind::values().collect();
716	let mut values2: Vec<RepPrefixKind> = RepPrefixKind::values().rev().collect();
717	values2.reverse();
718	assert_eq!(values1, values2);
719}
720#[rustfmt::skip]
721impl TryFrom<usize> for RepPrefixKind {
722	type Error = IcedError;
723	#[inline]
724	fn try_from(value: usize) -> Result<Self, Self::Error> {
725		if value < IcedConstants::REP_PREFIX_KIND_ENUM_COUNT {
726			// SAFETY: all values 0-max are valid enum values
727			Ok(unsafe { mem::transmute(value as u8) })
728		} else {
729			Err(IcedError::new("Invalid RepPrefixKind value"))
730		}
731	}
732}
733#[test]
734#[rustfmt::skip]
735fn test_repprefixkind_try_from_usize() {
736	for value in RepPrefixKind::values() {
737		let converted = <RepPrefixKind as TryFrom<usize>>::try_from(value as usize).unwrap();
738		assert_eq!(converted, value);
739	}
740	assert!(<RepPrefixKind as TryFrom<usize>>::try_from(IcedConstants::REP_PREFIX_KIND_ENUM_COUNT).is_err());
741	assert!(<RepPrefixKind as TryFrom<usize>>::try_from(core::usize::MAX).is_err());
742}
743#[cfg(feature = "serde")]
744#[rustfmt::skip]
745#[allow(clippy::zero_sized_map_values)]
746const _: () = {
747	use core::marker::PhantomData;
748	use serde::de;
749	use serde::{Deserialize, Deserializer, Serialize, Serializer};
750	type EnumType = RepPrefixKind;
751	impl Serialize for EnumType {
752		#[inline]
753		fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
754		where
755			S: Serializer,
756		{
757			serializer.serialize_u8(*self as u8)
758		}
759	}
760	impl<'de> Deserialize<'de> for EnumType {
761		#[inline]
762		fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
763		where
764			D: Deserializer<'de>,
765		{
766			struct Visitor<'de> {
767				marker: PhantomData<EnumType>,
768				lifetime: PhantomData<&'de ()>,
769			}
770			impl<'de> de::Visitor<'de> for Visitor<'de> {
771				type Value = EnumType;
772				#[inline]
773				fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
774					formatter.write_str("enum RepPrefixKind")
775				}
776				#[inline]
777				fn visit_u64<E>(self, v: u64) -> Result<Self::Value, E>
778				where
779					E: de::Error,
780				{
781					if let Ok(v) = <usize as TryFrom<_>>::try_from(v) {
782						if let Ok(value) = <EnumType as TryFrom<_>>::try_from(v) {
783							return Ok(value);
784						}
785					}
786					Err(de::Error::invalid_value(de::Unexpected::Unsigned(v), &"a valid RepPrefixKind variant value"))
787				}
788			}
789			deserializer.deserialize_u8(Visitor { marker: PhantomData::<EnumType>, lifetime: PhantomData })
790		}
791	}
792};
793// GENERATOR-END: RepPrefixKind
iced_x86/encoder/enums.rs

iced_x86/encoder/
enums.rs
