summaryrefslogtreecommitdiff
path: root/src/arm32/flag/mod.rs
blob: ad9c453aa51a673f2dd5dc8f4220f04546968fcd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
// Copyright 2024 Gabriel Bjørnager Jensen.
//
// This file is part of Pollex.
//
// Pollex is free software: you can redistribute it
// and/or modify it under the terms of the GNU Af-
// fero General Public License as published by the
// Free Software Foundation, either version 3 of
// the License, or (at your option) any later ver-
// sion.
//
// Pollex is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Affero General Public License for more details.
//
// You should have received a copy of the GNU Af-
// fero General Public License along with Pollex.
// If not, see <https://www.gnu.org/licenses/>.

// TODO: This type is usefule for easily being for-
// matted, but is otherwise quite akwardly imple-
// mented (see the constant generic). Could we re-
// it?

use core::fmt::Display;

macro_rules! define_flag {
	{
		vis: $vis:vis,
		name: $name:ident,
		symbol: $symbol:literal,
		doc: $doc:literal $(,)?
	} => {
		#[doc = $doc]
		#[derive(Clone, Copy, Debug, Eq, PartialEq)]
		#[repr(u8)]
		$vis enum $name {
			Off = 0x0,
			On  = 0x1,
		}

		impl $name {
			/// Checks if the flag is on.
			#[inline(always)]
			#[must_use]
			pub const fn is_on(self) -> bool { self as u8 == Self::On as u8 }

			/// Checks if the flag is off.
			#[inline(always)]
			#[must_use]
			pub const fn is_off(self) -> bool { self as u8 == Self::Off as u8 }
		}

		impl Display for $name {
			fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
				const SYMBOL: &str = $symbol;

				if self.is_on() { write!(f, "{SYMBOL}")? };

				Ok(())
			}
		}

		impl From<bool> for $name {
			#[inline(always)]
			fn from(value: bool) -> Self {
				if value {
					Self::On
				} else {
					Self::Off
				}
			}
		}

		impl From<$name> for bool {
			#[inline(always)]
			fn from(value: $name) -> Self { value.is_on() }
		}

		impl From<$name> for u128 {
			#[inline(always)]
			fn from(value: $name) -> Self { Self::from(value.is_on()) }
		}

		impl From<$name> for u16 {
			#[inline(always)]
			fn from(value: $name) -> Self { Self::from(value.is_on()) }
		}

		impl From<$name> for u32 {
			#[inline(always)]
			fn from(value: $name) -> Self { Self::from(value.is_on()) }
		}

		impl From<$name> for u64 {
			#[inline(always)]
			fn from(value: $name) -> Self { Self::from(value.is_on()) }
		}

		impl From<$name> for u8 {
			#[inline(always)]
			fn from(value: $name) -> Self { Self::from(value.is_on()) }
		}

		impl From<$name> for usize {
			#[inline(always)]
			fn from(value: $name) -> Self { Self::from(value.is_on()) }
		}
	};
}

define_flag! {
	vis:    pub,
	name:   Bflag,
	symbol: "B",
	doc:    "A B flag.\n\nThis indicates binary operations on some memory instructions.\n"
}

define_flag! {
	vis:    pub,
	name:   Sflag,
	symbol: "S",
	doc:    "An S flag.\n\nThis indicates setting the status register on some arithmetic instructions.\n"
}

define_flag! {
	vis:    pub,
	name:   Tflag,
	symbol: "T",
	doc:    "An T flag.\n\nThis indicates translation on some memory instructions.\n"
}