DWARF/Type.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_H
#define LIEF_DWARF_TYPE_H
 
#include <string_view>
#include <memory>
 
#include "LIEF/DebugDeclOpt.hpp"
#include "LIEF/canbe_unique.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/debug_loc.hpp"
#include "LIEF/errors.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/visibility.h"
 
 
namespace LIEF::dwarf {
class Scope;
 
namespace details {
class Type;
class TypeIt;
}

class LIEF_API Type {
  public:
  class Iterator final
    : public iterator_facade_base<Iterator, std::bidirectional_iterator_tag, Type,
                                  std::ptrdiff_t, const Type*, const Type&> {
    public:
    using implementation = details::TypeIt;
    using iterator_facade_base::operator++;
    using iterator_facade_base::operator--;
 
    LIEF_API Iterator();
 
    LIEF_API Iterator(std::unique_ptr<details::TypeIt> impl);
 
    LIEF_API Iterator(const Iterator&);
    LIEF_API Iterator& operator=(const Iterator&);
 
    LIEF_API Iterator(Iterator&&) noexcept;
    LIEF_API Iterator& operator=(Iterator&&) noexcept;
 
    LIEF_API ~Iterator();
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS);
    friend bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API Iterator& operator++();
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API Iterator& operator--();
 
    LIEF_API const Type& operator*() const LIEF_LIFETIMEBOUND;
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API const Type* operator->() const LIEF_LIFETIMEBOUND;

    LIEF_API std::unique_ptr<Type> yield();
 
    private:
    void load() const;
 
    std::unique_ptr<details::TypeIt> impl_;
    mutable std::unique_ptr<Type> cached_;
  };
 
  LIEF_LOCAL Type(std::unique_ptr<details::Type> impl);
  LIEF_LOCAL Type(details::Type& impl);
 
  Type(const Type&) = delete;
  Type& operator=(const Type&) = delete;
 
  Type(Type&&) noexcept;
  Type& operator=(Type&&) noexcept;
 
  virtual ~Type();
 
  enum class KIND {
    UNKNOWN = 0,
    UNSPECIFIED,
    BASE,
    CONST_KIND,
    CLASS,
    ARRAY,
    POINTER,
    STRUCT,
    UNION,
    TYPEDEF,
    REF,
    SET_TYPE,
    STRING,
    SUBROUTINE,
    POINTER_MEMBER,
    PACKED,
    FILE,
    THROWN,
    VOLATILE,
    RESTRICT,
    INTERFACE,
    SHARED,
    RVALREF,
    TEMPLATE_ALIAS,
    COARRAY,
    DYNAMIC,
    ATOMIC,
    IMMUTABLE,
    ENUM,
  };
 
  KIND kind() const;

  bool is_unspecified() const {
    return kind() == KIND::UNSPECIFIED;
  }

  result<std::string_view> name() const LIEF_LIFETIMEBOUND;

  result<uint64_t> size() const;

  debug_location_t location() const;

  std::unique_ptr<Scope> scope() const LIEF_LIFETIMEBOUND;

  std::string to_decl(const DeclOpt& opt = DeclOpt()) const;
 
  template<class T>
  const T* as() const LIEF_LIFETIMEBOUND {
    if (T::classof(this)) {
      return static_cast<const T*>(this);
    }
    return nullptr;
  }
 
  static std::unique_ptr<Type>
      create(std::unique_ptr<details::Type> impl LIEF_LIFETIMEBOUND);
 
  protected:
  LIEF::details::canbe_unique<details::Type> impl_;
};
 
}
 
#endif