DWARF/types/ClassLike.hpp

Go to the documentation of this file.

/* Copyright 2022 - 2026 R. Thomas
 *
 * 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
 *
 *     http://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.
 */
#ifndef LIEF_DWARF_TYPE_STRUCTURE_H
#define LIEF_DWARF_TYPE_STRUCTURE_H
 
#include "LIEF/DWARF/Function.hpp"
#include "LIEF/DWARF/Type.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/visibility.h"
 
#include <string_view>
 
namespace LIEF::dwarf::types {
 
namespace details {
class Member;
}

class LIEF_API ClassLike : public Type {
  public:
  template<typename... Args,
           typename = std::enable_if_t<std::is_constructible_v<Type, Args&&...>>>
  ClassLike(Args&&... args) :
    Type(std::forward<Args>(args)...) {}

  class LIEF_API Member {
    public:
    Member(std::unique_ptr<details::Member> impl);
    Member(Member&& other) noexcept;
    Member& operator=(Member&& other) noexcept;
 
    Member(const Member&) = delete;
    Member& operator=(const Member&) = delete;

    std::string_view name() const LIEF_LIFETIMEBOUND;

    result<uint64_t> offset() const;

    result<uint64_t> bit_offset() const;

    result<uint64_t> bit_size() const;

    std::unique_ptr<Type> type() const LIEF_LIFETIMEBOUND;
 
    bool is_external() const;
 
    bool is_declaration() const;
 
    ~Member();
 
    private:
    std::unique_ptr<details::Member> impl_;
  };
 
  ClassLike(const ClassLike&) = delete;
  ClassLike& operator=(const ClassLike&) = delete;
 
  ClassLike(ClassLike&&) noexcept = default;
  ClassLike& operator=(ClassLike&&) noexcept = default;
 
  using functions_it = iterator_range<Function::Iterator>;
 
  static bool classof(const Type* type) {
    const auto kind = type->kind();
    return kind == Type::KIND::CLASS || kind == Type::KIND::STRUCT ||
           kind == Type::KIND::UNION;
  }

  std::vector<Member> members() const LIEF_LIFETIMEBOUND;

  std::unique_ptr<Member> find_member(uint64_t offset) const LIEF_LIFETIMEBOUND;

  functions_it functions() const LIEF_LIFETIMEBOUND;
 
  ~ClassLike() override;
};

class LIEF_API Structure : public ClassLike {
  public:
  template<typename... Args,
           typename =
               std::enable_if_t<std::is_constructible_v<ClassLike, Args&&...>>>
  Structure(Args&&... args) :
    ClassLike(std::forward<Args>(args)...) {}
 
  Structure(const Structure&) = delete;
  Structure& operator=(const Structure&) = delete;
 
  Structure(Structure&&) noexcept = default;
  Structure& operator=(Structure&&) noexcept = default;
 
  static bool classof(const Type* type) {
    return type->kind() == Type::KIND::STRUCT;
  }
 
  ~Structure() override;
};

class LIEF_API Class : public ClassLike {
  public:
  template<typename... Args,
           typename =
               std::enable_if_t<std::is_constructible_v<ClassLike, Args&&...>>>
  Class(Args&&... args) :
    ClassLike(std::forward<Args>(args)...) {}
 
  Class(const Class&) = delete;
  Class& operator=(const Class&) = delete;
 
  Class(Class&&) noexcept = default;
  Class& operator=(Class&&) noexcept = default;
 
  static bool classof(const Type* type) {
    return type->kind() == Type::KIND::CLASS;
  }
 
  ~Class() override;
};

class LIEF_API Union : public ClassLike {
  public:
  template<typename... Args,
           typename =
               std::enable_if_t<std::is_constructible_v<ClassLike, Args&&...>>>
  Union(Args&&... args) :
    ClassLike(std::forward<Args>(args)...) {}
 
  Union(const Union&) = delete;
  Union& operator=(const Union&) = delete;
 
  Union(Union&&) noexcept = default;
  Union& operator=(Union&&) noexcept = default;
 
  static bool classof(const Type* type) {
    return type->kind() == Type::KIND::UNION;
  }
 
  ~Union() override;
};

class LIEF_API Packed : public ClassLike {
  public:
  template<typename... Args,
           typename =
               std::enable_if_t<std::is_constructible_v<ClassLike, Args&&...>>>
  Packed(Args&&... args) :
    ClassLike(std::forward<Args>(args)...) {}
 
  Packed(const Packed&) = delete;
  Packed& operator=(const Packed&) = delete;
 
  Packed(Packed&&) noexcept = default;
  Packed& operator=(Packed&&) noexcept = default;
 
  static bool classof(const Type* type) {
    return type->kind() == Type::KIND::PACKED;
  }
 
  ~Packed() override;
};
 
}
 
 
#endif