Added bool and flag inversion

MauriceKayser · MauriceKayser · commit 187f7a0df8d1 · 2021-02-01T00:00:00.000Z
Added `core::ops::*` implementation generation
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
+/.idea/
+/.vs/
 /target/
-Cargo.lock
+Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,7 +5,7 @@ keywords = ["bit", "bitfield", "bitfields", "bitflag", "bitflags", "bitmask", "f
 license = "MIT/Apache-2.0"
 name = "bitfield"
 readme = "README.md"
-version = "1.5.0"
+version = "1.6.0"
 
 [lib]
 proc-macro = true
diff --git a/README.md b/README.md
@@ -13,4 +13,4 @@ It supports:
 - Compile-time overlap and boundary checking.
 
 For more specific documentation look at the documentation of the macros, or at the files in
-`examples/*`.
+`examples/*`.
diff --git a/examples/gnu_io_channel.rs b/examples/gnu_io_channel.rs
@@ -101,18 +101,18 @@ fn main() {
         reserved1: 0 as _, reserved2: 0 as _,
 
         flags: Flags::new()
+            + Flag::DoEncode   // Same as: `.set_flag(Flag::DoEncode, true)`
+            + Flag::IsWritable // Same as: `.set_flag(Flag::IsWritable, true)`
     };
 
-    // Check and update flags.
-    channel.flags = channel.flags
-        .set(Flag::DoEncode, true)
-        .set(Flag::IsWritable, true);
-
-    if !channel.flags.has(Flag::CloseOnUnref) {
-        channel.flags = channel.flags.set(Flag::CloseOnUnref, true);
+    // Check and update flag.
+    if channel.flags.has(Flag::DoEncode) {
+        channel.flags -= Flag::DoEncode; // Same as: `.set_flag(Flag::DoEncode, false)`
     }
+    // Invert flag.
+    channel.flags ^= Flag::CloseOnUnref; // Same as: `.invert_flag(Flag::CloseOnUnref)`
 
-    assert_eq!(&format!("{}", &channel.flags), "DoEncode | CloseOnUnref | IsWritable");
+    assert_eq!(&format!("{}", &channel.flags), "CloseOnUnref | IsWritable");
 
     println!("Flags: {}", &channel.flags);
 }
diff --git a/examples/vga_text_mode.rs b/examples/vga_text_mode.rs
@@ -58,7 +58,7 @@ fn main() {
         .set_blink(true);
 
     if !char.styles.foreground_bright() {
-        char.styles = char.styles.set_foreground_bright(true);
+        char.styles = char.styles.invert_foreground_bright();
     }
 
     assert_eq!(&format!("{:#?}", &char),
diff --git a/examples/windows_memory_protection.rs b/examples/windows_memory_protection.rs
@@ -47,17 +47,7 @@ struct Protection {
 
 // Getters for specific access flags.
 impl Protection {
-    #[cfg(const_trait_impl)]
-    const fn copy_on_write(&self) -> bool {
-        match self.access() {
-            Ok(Access::ReadWriteCopy) |
-            Ok(Access::ExecuteReadWriteCopy) => true,
-            _ => false
-        }
-    }
-
-    // TODO: Remove when https://github.com/rust-lang/rfcs/pull/2632 is merged.
-    #[cfg(not(const_trait_impl))]
+    // TODO: Add `const` when https://github.com/rust-lang/rfcs/pull/2632 is merged.
     fn copy_on_write(&self) -> bool {
         match self.access() {
             Ok(Access::ReadWriteCopy) |
@@ -66,19 +56,7 @@ impl Protection {
         }
     }
 
-    #[cfg(const_trait_impl)]
-    const fn execute(&self) -> bool {
-        match self.access() {
-            Ok(Access::Execute) |
-            Ok(Access::ExecuteRead) |
-            Ok(Access::ExecuteReadWrite) |
-            Ok(Access::ExecuteReadWriteCopy) => true,
-            _ => false
-        }
-    }
-
-    // TODO: Remove when https://github.com/rust-lang/rfcs/pull/2632 is merged.
-    #[cfg(not(const_trait_impl))]
+    // TODO: Add `const` when https://github.com/rust-lang/rfcs/pull/2632 is merged.
     fn execute(&self) -> bool {
         match self.access() {
             Ok(Access::Execute) |
@@ -89,23 +67,7 @@ impl Protection {
         }
     }
 
-    #[cfg(const_trait_impl)]
-    const fn read(&self) -> bool {
-        match self.access() {
-            Ok(Access::Read) |
-            Ok(Access::ReadWrite) |
-            Ok(Access::ReadWriteCopy) |
-            Ok(Access::ExecuteRead) |
-            Ok(Access::ExecuteReadWrite) |
-            Ok(Access::ExecuteReadWriteCopy) => true,
-            #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
-            Ok(Access::Execute) => true,
-            _ => false
-        }
-    }
-
-    // TODO: Remove when https://github.com/rust-lang/rfcs/pull/2632 is merged.
-    #[cfg(not(const_trait_impl))]
+    // TODO: Add `const` when https://github.com/rust-lang/rfcs/pull/2632 is merged.
     fn read(&self) -> bool {
         match self.access() {
             Ok(Access::Read) |
@@ -120,19 +82,7 @@ impl Protection {
         }
     }
 
-    #[cfg(const_trait_impl)]
-    const fn write(&self) -> bool {
-        match self.access() {
-            Ok(Access::ReadWrite) |
-            Ok(Access::ReadWriteCopy) |
-            Ok(Access::ExecuteReadWrite) |
-            Ok(Access::ExecuteReadWriteCopy) => true,
-            _ => false
-        }
-    }
-
-    // TODO: Remove when https://github.com/rust-lang/rfcs/pull/2632 is merged.
-    #[cfg(not(const_trait_impl))]
+    // TODO: Add `const` when https://github.com/rust-lang/rfcs/pull/2632 is merged.
     fn write(&self) -> bool {
         match self.access() {
             Ok(Access::ReadWrite) |
@@ -198,10 +148,10 @@ enum FlagUnknown {
 
 fn main() {
     let protection = Protection::new()
-        .set_access(Access::ExecuteReadWrite)
-        .set_flag(Flag::Guard, true)
-        .set_flag(Flag::NoCache, true)
-        .set_flag_alloc(FlagAlloc::TargetsInvalid, true);
+        + Access::ExecuteReadWrite   // Same as: `.set_access(Access::ExecuteReadWrite)`
+        + Flag::Guard                // Same as: `.set_flag(Flag::Guard, true)`
+        + Flag::NoCache              // Same as: `.set_flag(Flag::NoCache, true)`
+        + FlagAlloc::TargetsInvalid; // Same as: `.set_flag_alloc(FlagAlloc::TargetsInvalid, true)`
 
     assert_eq!(
         protection.0,
diff --git a/examples/windows_message_box.rs b/examples/windows_message_box.rs
@@ -94,12 +94,12 @@ enum Modality {
 
 fn main() {
     let styles = Styles::new()
-        .set_button(Button::CancelTryContinue)
-        .set_icon(Icon::Exclamation)
-        .set_default_button(DefaultButton::Two)
-        .set_modality(Modality::Task)
-        .set_style(Style::Foreground, true)
-        .set_style(Style::TopMost, true);
+        + Button::CancelTryContinue // Same as: `.set_button(Button::CancelTryContinue)`
+        + Icon::Exclamation         // Same as: `.set_icon(Icon::Exclamation)`
+        + DefaultButton::Two        // Same as: `.set_default_button(DefaultButton::Two)`
+        + Modality::Task            // Same as: `.set_modality(Modality::Task)`
+        + Style::Foreground         // Same as: `.set_style(Style::Foreground, true)`
+        + Style::TopMost;           // Same as: `.set_style(Style::TopMost, true)`
 
     assert_eq!(
         styles.0,
diff --git a/examples/windows_object_access.rs b/examples/windows_object_access.rs
@@ -376,16 +376,16 @@ enum Thread {
 
 fn main() {
     let directory = AccessDirectory::new()
-        .set_object(Directory::List, true)
-        .set_object(Directory::Traverse, true)
-        .set_standard(Standard::Delete, true)
-        .set_standard(Standard::Synchronize, true);
+        + Directory::List        // Same as: `.set_object(Directory::List, true)`
+        + Directory::Traverse    // Same as: `.set_object(Directory::Traverse, true)`
+        + Standard::Delete       // Same as: `.set_standard(Standard::Delete, true)`
+        + Standard::Synchronize; // Same as: `.set_standard(Standard::Synchronize, true)`
 
     let file = AccessFile::new()
-        .set_object(File::Write, true)
-        .set_object(File::WriteAttributes, true)
-        .set_standard(Standard::Delete, true)
-        .set_standard(Standard::Synchronize, true);
+        + File::Write            // Same as: `.set_object(File::Write, true)`
+        + File::WriteAttributes  // Same as: `.set_object(File::WriteAttributes, true)`
+        + Standard::Delete       // Same as: `.set_standard(Standard::Delete, true)`
+        + Standard::Synchronize; // Same as: `.set_standard(Standard::Synchronize, true)`
 
     for flag in Standard::iter() {
         assert_eq!(
diff --git a/examples/x86_debug_registers.rs b/examples/x86_debug_registers.rs
@@ -136,10 +136,10 @@ enum BreakPointLength {
 fn main() {
     // Set a break point:
     let control = DebugControl::new() // = GetDR7();
-        .set_flag(Control::ExactInstructionLocal, true)
-        .set_flag(Control::DebugRegister0Local, true)
-        .set_type0(BreakPointType::Execute)
-        .set_length0(BreakPointLength::One);
+        .set_type0(BreakPointType::Execute) // Not possible as `+ BreakPointType::Execute`, because `BreakPointType` is used more than once.
+        .set_length0(BreakPointLength::One) // Not possible as `+ BreakPointLength::One`, because `BreakPointLength` is used more than once.
+        + Control::ExactInstructionLocal // Same as: `.set_flag(Control::ExactInstructionLocal, true)`
+        + Control::DebugRegister0Local;  // Same as: `.set_flag(Control::DebugRegister0Local, true)`
 
     println!("{:#?}", &control);
 
diff --git a/src/bitfield/generate.rs b/src/bitfield/generate.rs
diff --git a/src/enumeration/generate.rs b/src/enumeration/generate.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/tests/bitfield.rs b/tests/bitfield.rs

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ fn main() {`
`58`	`58`	`.set_blink(true);`
`59`	`59`
`60`	`60`	`if !char.styles.foreground_bright() {`
`61`		`- char.styles = char.styles.set_foreground_bright(true);`
	`61`	`+ char.styles = char.styles.invert_foreground_bright();`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`assert_eq!(&format!("{:#?}", &char),`