src/libstd/bitflags.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #![experimental]
  12 #![macro_escape]
  13
  14 //! A typesafe bitmask flag generator.
  15
  16 /// The `bitflags!` macro generates a `struct` that holds a set of C-style
  17 /// bitmask flags. It is useful for creating typesafe wrappers for C APIs.
  18 ///
  19 /// The flags should only be defined for integer types, otherwise unexpected
  20 /// type errors may occur at compile time.
  21 ///
  22 /// # Example
  23 ///
  24 /// ```{.rust}
  25 /// bitflags! {
  26 ///     flags Flags: u32 {
  27 ///         const FLAG_A       = 0b00000001,
  28 ///         const FLAG_B       = 0b00000010,
  29 ///         const FLAG_C       = 0b00000100,
  30 ///         const FLAG_ABC     = FLAG_A.bits
  31 ///                            | FLAG_B.bits
  32 ///                            | FLAG_C.bits,
  33 ///     }
  34 /// }
  35 ///
  36 /// fn main() {
  37 ///     let e1 = FLAG_A | FLAG_C;
  38 ///     let e2 = FLAG_B | FLAG_C;
  39 ///     assert!((e1 | e2) == FLAG_ABC);   // union
  40 ///     assert!((e1 & e2) == FLAG_C);     // intersection
  41 ///     assert!((e1 - e2) == FLAG_A);     // set difference
  42 ///     assert!(!e2 == FLAG_A);           // set complement
  43 /// }
  44 /// ```
  45 ///
  46 /// The generated `struct`s can also be extended with type and trait implementations:
  47 ///
  48 /// ```{.rust}
  49 /// use std::fmt;
  50 ///
  51 /// bitflags! {
  52 ///     flags Flags: u32 {
  53 ///         const FLAG_A   = 0b00000001,
  54 ///         const FLAG_B   = 0b00000010,
  55 ///     }
  56 /// }
  57 ///
  58 /// impl Flags {
  59 ///     pub fn clear(&mut self) {
  60 ///         self.bits = 0;  // The `bits` field can be accessed from within the
  61 ///                         // same module where the `bitflags!` macro was invoked.
  62 ///     }
  63 /// }
  64 ///
  65 /// impl fmt::Show for Flags {
  66 ///     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  67 ///         write!(f, "hi!")
  68 ///     }
  69 /// }
  70 ///
  71 /// fn main() {
  72 ///     let mut flags = FLAG_A | FLAG_B;
  73 ///     flags.clear();
  74 ///     assert!(flags.is_empty());
  75 ///     assert_eq!(format!("{}", flags).as_slice(), "hi!");
  76 /// }
  77 /// ```
  78 ///
  79 /// # Attributes
  80 ///
  81 /// Attributes can be attached to the generated `struct` by placing them
  82 /// before the `flags` keyword.
  83 ///
  84 /// # Derived traits
  85 ///
  86 /// The `PartialEq` and `Clone` traits are automatically derived for the `struct` using
  87 /// the `deriving` attribute. Additional traits can be derived by providing an
  88 /// explicit `deriving` attribute on `flags`.
  89 ///
  90 /// # Operators
  91 ///
  92 /// The following operator traits are implemented for the generated `struct`:
  93 ///
  94 /// - `BitOr`: union
  95 /// - `BitAnd`: intersection
  96 /// - `BitXor`: toggle
  97 /// - `Sub`: set difference
  98 /// - `Not`: set complement
  99 ///
 100 /// # Methods
 101 ///
 102 /// The following methods are defined for the generated `struct`:
 103 ///
 104 /// - `empty`: an empty set of flags
 105 /// - `all`: the set of all flags
 106 /// - `bits`: the raw value of the flags currently stored
 107 /// - `from_bits`: convert from underlying bit representation, unless that
 108 ///                representation contains bits that do not correspond to a flag
 109 /// - `from_bits_truncate`: convert from underlying bit representation, dropping
 110 ///                         any bits that do not correspond to flags
 111 /// - `is_empty`: `true` if no flags are currently stored
 112 /// - `is_all`: `true` if all flags are currently set
 113 /// - `intersects`: `true` if there are flags common to both `self` and `other`
 114 /// - `contains`: `true` all of the flags in `other` are contained within `self`
 115 /// - `insert`: inserts the specified flags in-place
 116 /// - `remove`: removes the specified flags in-place
 117 /// - `toggle`: the specified flags will be inserted if not present, and removed
 118 ///             if they are.
 119 #[macro_export]
 120 macro_rules! bitflags {
 121     ($(#[$attr:meta])* flags $BitFlags:ident: $T:ty {
 122         $($(#[$Flag_attr:meta])* const $Flag:ident = $value:expr),+
 123     }) => {
 124         #[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord, Hash)]
 125         $(#[$attr])*
 126         pub struct $BitFlags {
 127             bits: $T,
 128         }
 129
 130         $($(#[$Flag_attr])* pub const $Flag: $BitFlags = $BitFlags { bits: $value };)+
 131
 132         impl $BitFlags {
 133             /// Returns an empty set of flags.
 134             #[inline]
 135             pub fn empty() -> $BitFlags {
 136                 $BitFlags { bits: 0 }
 137             }
 138
 139             /// Returns the set containing all flags.
 140             #[inline]
 141             pub fn all() -> $BitFlags {
 142                 $BitFlags { bits: $($value)|+ }
 143             }
 144
 145             /// Returns the raw value of the flags currently stored.
 146             #[inline]
 147             pub fn bits(&self) -> $T {
 148                 self.bits
 149             }
 150
 151             /// Convert from underlying bit representation, unless that
 152             /// representation contains bits that do not correspond to a flag.
 153             #[inline]
 154             pub fn from_bits(bits: $T) -> ::std::option::Option<$BitFlags> {
 155                 if (bits & !$BitFlags::all().bits()) != 0 {
 156                     ::std::option::Option::None
 157                 } else {
 158                     ::std::option::Option::Some($BitFlags { bits: bits })
 159                 }
 160             }
 161
 162             /// Convert from underlying bit representation, dropping any bits
 163             /// that do not correspond to flags.
 164             #[inline]
 165             pub fn from_bits_truncate(bits: $T) -> $BitFlags {
 166                 $BitFlags { bits: bits } & $BitFlags::all()
 167             }
 168
 169             /// Returns `true` if no flags are currently stored.
 170             #[inline]
 171             pub fn is_empty(&self) -> bool {
 172                 *self == $BitFlags::empty()
 173             }
 174
 175             /// Returns `true` if all flags are currently set.
 176             #[inline]
 177             pub fn is_all(&self) -> bool {
 178                 *self == $BitFlags::all()
 179             }
 180
 181             /// Returns `true` if there are flags common to both `self` and `other`.
 182             #[inline]
 183             pub fn intersects(&self, other: $BitFlags) -> bool {
 184                 !(*self & other).is_empty()
 185             }
 186
 187             /// Returns `true` all of the flags in `other` are contained within `self`.
 188             #[inline]
 189             pub fn contains(&self, other: $BitFlags) -> bool {
 190                 (*self & other) == other
 191             }
 192
 193             /// Inserts the specified flags in-place.
 194             #[inline]
 195             pub fn insert(&mut self, other: $BitFlags) {
 196                 self.bits |= other.bits;
 197             }
 198
 199             /// Removes the specified flags in-place.
 200             #[inline]
 201             pub fn remove(&mut self, other: $BitFlags) {
 202                 self.bits &= !other.bits;
 203             }
 204
 205             /// Toggles the specified flags in-place.
 206             #[inline]
 207             pub fn toggle(&mut self, other: $BitFlags) {
 208                 self.bits ^= other.bits;
 209             }
 210         }
 211
 212         impl ::std::ops::BitOr for $BitFlags {
 213             type Output = $BitFlags;
 214
 215             /// Returns the union of the two sets of flags.
 216             #[inline]
 217             fn bitor(self, other: $BitFlags) -> $BitFlags {
 218                 $BitFlags { bits: self.bits | other.bits }
 219             }
 220         }
 221
 222         impl ::std::ops::BitXor for $BitFlags {
 223             type Output = $BitFlags;
 224
 225             /// Returns the left flags, but with all the right flags toggled.
 226             #[inline]
 227             fn bitxor(self, other: $BitFlags) -> $BitFlags {
 228                 $BitFlags { bits: self.bits ^ other.bits }
 229             }
 230         }
 231
 232         impl ::std::ops::BitAnd for $BitFlags {
 233             type Output = $BitFlags;
 234
 235             /// Returns the intersection between the two sets of flags.
 236             #[inline]
 237             fn bitand(self, other: $BitFlags) -> $BitFlags {
 238                 $BitFlags { bits: self.bits & other.bits }
 239             }
 240         }
 241
 242         impl ::std::ops::Sub for $BitFlags {
 243             type Output = $BitFlags;
 244
 245             /// Returns the set difference of the two sets of flags.
 246             #[inline]
 247             fn sub(self, other: $BitFlags) -> $BitFlags {
 248                 $BitFlags { bits: self.bits & !other.bits }
 249             }
 250         }
 251
 252         impl ::std::ops::Not for $BitFlags {
 253             type Output = $BitFlags;
 254
 255             /// Returns the complement of this set of flags.
 256             #[inline]
 257             fn not(self) -> $BitFlags {
 258                 $BitFlags { bits: !self.bits } & $BitFlags::all()
 259             }
 260         }
 261     };
 262     ($(#[$attr:meta])* flags $BitFlags:ident: $T:ty {
 263         $($(#[$Flag_attr:meta])* const $Flag:ident = $value:expr),+,
 264     }) => {
 265         bitflags! {
 266             $(#[$attr])*
 267             flags $BitFlags: $T {
 268                 $($(#[$Flag_attr])* const $Flag = $value),+
 269             }
 270         }
 271     };
 272 }
 273
 274 #[cfg(test)]
 275 #[allow(non_upper_case_globals)]
 276 mod tests {
 277     use hash;
 278     use option::Option::{Some, None};
 279
 280     bitflags! {
 281         #[doc = "> The first principle is that you must not fool yourself — and"]
 282         #[doc = "> you are the easiest person to fool."]
 283         #[doc = "> "]
 284         #[doc = "> - Richard Feynman"]
 285         flags Flags: u32 {
 286             const FlagA       = 0b00000001,
 287             #[doc = "<pcwalton> macros are way better at generating code than trans is"]
 288             const FlagB       = 0b00000010,
 289             const FlagC       = 0b00000100,
 290             #[doc = "* cmr bed"]
 291             #[doc = "* strcat table"]
 292             #[doc = "<strcat> wait what?"]
 293             const FlagABC     = FlagA.bits
 294                                | FlagB.bits
 295                                | FlagC.bits,
 296         }
 297     }
 298
 299     bitflags! {
 300         flags AnotherSetOfFlags: i8 {
 301             const AnotherFlag = -1_i8,
 302         }
 303     }
 304
 305     #[test]
 306     fn test_bits(){
 307         assert_eq!(Flags::empty().bits(), 0b00000000);
 308         assert_eq!(FlagA.bits(), 0b00000001);
 309         assert_eq!(FlagABC.bits(), 0b00000111);
 310
 311         assert_eq!(AnotherSetOfFlags::empty().bits(), 0b00);
 312         assert_eq!(AnotherFlag.bits(), !0_i8);
 313     }
 314
 315     #[test]
 316     fn test_from_bits() {
 317         assert!(Flags::from_bits(0) == Some(Flags::empty()));
 318         assert!(Flags::from_bits(0b1) == Some(FlagA));
 319         assert!(Flags::from_bits(0b10) == Some(FlagB));
 320         assert!(Flags::from_bits(0b11) == Some(FlagA | FlagB));
 321         assert!(Flags::from_bits(0b1000) == None);
 322
 323         assert!(AnotherSetOfFlags::from_bits(!0_i8) == Some(AnotherFlag));
 324     }
 325
 326     #[test]
 327     fn test_from_bits_truncate() {
 328         assert!(Flags::from_bits_truncate(0) == Flags::empty());
 329         assert!(Flags::from_bits_truncate(0b1) == FlagA);
 330         assert!(Flags::from_bits_truncate(0b10) == FlagB);
 331         assert!(Flags::from_bits_truncate(0b11) == (FlagA | FlagB));
 332         assert!(Flags::from_bits_truncate(0b1000) == Flags::empty());
 333         assert!(Flags::from_bits_truncate(0b1001) == FlagA);
 334
 335         assert!(AnotherSetOfFlags::from_bits_truncate(0_i8) == AnotherSetOfFlags::empty());
 336     }
 337
 338     #[test]
 339     fn test_is_empty(){
 340         assert!(Flags::empty().is_empty());
 341         assert!(!FlagA.is_empty());
 342         assert!(!FlagABC.is_empty());
 343
 344         assert!(!AnotherFlag.is_empty());
 345     }
 346
 347     #[test]
 348     fn test_is_all() {
 349         assert!(Flags::all().is_all());
 350         assert!(!FlagA.is_all());
 351         assert!(FlagABC.is_all());
 352
 353         assert!(AnotherFlag.is_all());
 354     }
 355
 356     #[test]
 357     fn test_two_empties_do_not_intersect() {
 358         let e1 = Flags::empty();
 359         let e2 = Flags::empty();
 360         assert!(!e1.intersects(e2));
 361
 362         assert!(AnotherFlag.intersects(AnotherFlag));
 363     }
 364
 365     #[test]
 366     fn test_empty_does_not_intersect_with_full() {
 367         let e1 = Flags::empty();
 368         let e2 = FlagABC;
 369         assert!(!e1.intersects(e2));
 370     }
 371
 372     #[test]
 373     fn test_disjoint_intersects() {
 374         let e1 = FlagA;
 375         let e2 = FlagB;
 376         assert!(!e1.intersects(e2));
 377     }
 378
 379     #[test]
 380     fn test_overlapping_intersects() {
 381         let e1 = FlagA;
 382         let e2 = FlagA | FlagB;
 383         assert!(e1.intersects(e2));
 384     }
 385
 386     #[test]
 387     fn test_contains() {
 388         let e1 = FlagA;
 389         let e2 = FlagA | FlagB;
 390         assert!(!e1.contains(e2));
 391         assert!(e2.contains(e1));
 392         assert!(FlagABC.contains(e2));
 393
 394         assert!(AnotherFlag.contains(AnotherFlag));
 395     }
 396
 397     #[test]
 398     fn test_insert(){
 399         let mut e1 = FlagA;
 400         let e2 = FlagA | FlagB;
 401         e1.insert(e2);
 402         assert!(e1 == e2);
 403
 404         let mut e3 = AnotherSetOfFlags::empty();
 405         e3.insert(AnotherFlag);
 406         assert!(e3 == AnotherFlag);
 407     }
 408
 409     #[test]
 410     fn test_remove(){
 411         let mut e1 = FlagA | FlagB;
 412         let e2 = FlagA | FlagC;
 413         e1.remove(e2);
 414         assert!(e1 == FlagB);
 415
 416         let mut e3 = AnotherFlag;
 417         e3.remove(AnotherFlag);
 418         assert!(e3 == AnotherSetOfFlags::empty());
 419     }
 420
 421     #[test]
 422     fn test_operators() {
 423         let e1 = FlagA | FlagC;
 424         let e2 = FlagB | FlagC;
 425         assert!((e1 | e2) == FlagABC);     // union
 426         assert!((e1 & e2) == FlagC);       // intersection
 427         assert!((e1 - e2) == FlagA);       // set difference
 428         assert!(!e2 == FlagA);             // set complement
 429         assert!(e1 ^ e2 == FlagA | FlagB); // toggle
 430         let mut e3 = e1;
 431         e3.toggle(e2);
 432         assert!(e3 == FlagA | FlagB);
 433
 434         let mut m4 = AnotherSetOfFlags::empty();
 435         m4.toggle(AnotherSetOfFlags::empty());
 436         assert!(m4 == AnotherSetOfFlags::empty());
 437     }
 438
 439     #[test]
 440     fn test_lt() {
 441         let mut a = Flags::empty();
 442         let mut b = Flags::empty();
 443
 444         assert!(!(a < b) && !(b < a));
 445         b = FlagB;
 446         assert!(a < b);
 447         a = FlagC;
 448         assert!(!(a < b) && b < a);
 449         b = FlagC | FlagB;
 450         assert!(a < b);
 451     }
 452
 453     #[test]
 454     fn test_ord() {
 455         let mut a = Flags::empty();
 456         let mut b = Flags::empty();
 457
 458         assert!(a <= b && a >= b);
 459         a = FlagA;
 460         assert!(a > b && a >= b);
 461         assert!(b < a && b <= a);
 462         b = FlagB;
 463         assert!(b > a && b >= a);
 464         assert!(a < b && a <= b);
 465     }
 466
 467     #[test]
 468     fn test_hash() {
 469       let mut x = Flags::empty();
 470       let mut y = Flags::empty();
 471       assert!(hash::hash(&x) == hash::hash(&y));
 472       x = Flags::all();
 473       y = FlagABC;
 474       assert!(hash::hash(&x) == hash::hash(&y));
 475     }
 476 }