linker_symbol.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 <type_traits>
 
#include "lib/stdcompat/bit.h"
 
namespace pw {
 
template <class T = uintptr_t>
class LinkerSymbol {
 public:
  LinkerSymbol() = delete;
  ~LinkerSymbol() = delete;
  LinkerSymbol(const LinkerSymbol&) = delete;
  LinkerSymbol(const LinkerSymbol&&) = delete;
  LinkerSymbol& operator=(const LinkerSymbol&) = delete;
  LinkerSymbol& operator=(const LinkerSymbol&&) = delete;
 
  T value() const {
    static_assert(std::is_integral_v<T> || std::is_enum_v<T>);
    static_assert(sizeof(T) <= sizeof(uintptr_t));
    return static_cast<T>(raw_value());
  }
 
 private:
  uintptr_t raw_value() const { return cpp20::bit_cast<uintptr_t>(this); }
};
 
}  // namespace pw