capability.h

// Copyright 2024 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
 
#include <cstdint>
 
#include "pw_assert/assert.h"
 
namespace pw::allocator {
 
enum Capability : uint32_t {
  // clang-format off
  kImplementsGetRequestedLayout = 1 << 0,
  kImplementsGetUsableLayout    = 1 << 1,
  kImplementsGetAllocatedLayout = 1 << 2,
  kImplementsGetCapacity        = 1 << 4,
  kImplementsRecognizes         = 1 << 5,
  kSkipsDestroy                 = 1 << 6,
  // clang-format on
};
 
class Capabilities {
 public:
  constexpr Capabilities() : capabilities_(0) {}
  constexpr Capabilities(uint32_t capabilities) : capabilities_(capabilities) {}
 
  constexpr bool has(Capability capability) const {
    return (capabilities_ & capability) == capability;
  }
 
  constexpr uint32_t get() const { return capabilities_; }
 
 private:
  const uint32_t capabilities_;
};
 
inline constexpr bool operator==(const Capabilities& lhs,
                                 const Capabilities& rhs) {
  return lhs.get() == rhs.get();
}
 
inline constexpr bool operator!=(const Capabilities& lhs,
                                 const Capabilities& rhs) {
  return lhs.get() != rhs.get();
}
 
inline constexpr Capabilities operator|(const Capabilities& lhs,
                                        const Capabilities& rhs) {
  return Capabilities(lhs.get() | rhs.get());
}
 
inline constexpr Capabilities operator&(const Capabilities& lhs,
                                        const Capabilities& rhs) {
  return Capabilities(lhs.get() & rhs.get());
}
 
inline constexpr Capabilities operator^(const Capabilities& lhs,
                                        const Capabilities& rhs) {
  return Capabilities(lhs.get() ^ rhs.get());
}
 
}  // namespace pw::allocator