ABitField.h

/*
 * AUI Framework - Declarative UI toolkit for modern C++20
 * Copyright (C) 2020-2025 Alex2772 and Contributors
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include <cstdint>

template <typename T = uint32_t>
class ABitField {
private:
   T mStorage;
 
public:
   ABitField(T storage = static_cast<T>(0)) : mStorage(storage) {}
 
   operator T() {
       return mStorage;
   }
 
   T& value() {
       return mStorage;
   }
 
   const T& value() const {
       return mStorage;
   }

   ABitField& operator<<(T flag) {
       mStorage |= flag;
       return *this;
   }

   ABitField& operator>>(T flag) {
       mStorage &= ~flag;
       return *this;
   }

   bool checkAndSet(T flag) {
       if (!!(mStorage & flag)) {
           mStorage &= ~flag;
           return true;
       }
       return false;
   }

   bool checkAndReset(T flag)
   {
       if (mStorage & flag)
       {
           return false;
       }
       mStorage |= flag;
       return true;
   }

   bool test(T flags) const {
       return (mStorage & flags) == flags;
   }

   bool testAny(T flags) const {
       return bool(mStorage & flags);
   }

   bool operator&(T flags) const {
       return test(flags);
   }
 
   void set(T flag, bool value) {
       if (value) {
           mStorage |= flag;
       } else {
           mStorage &= ~flag;
       }
   }
};

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.