Variable.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_VARIABLE_H
#define LIEF_DWARF_VARIABLE_H
 
#include <string_view>
#include <memory>
#include <vector>
 
#include "LIEF/DWARF/Location.hpp"
#include "LIEF/DWARF/Type.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 Variable;
class VariableIt;
}

class LIEF_API Variable {
  public:
  class Iterator final
    : public iterator_facade_base<Iterator, std::bidirectional_iterator_tag,
                                  Variable, std::ptrdiff_t, const Variable*,
                                  const Variable&> {
    public:
    using implementation = details::VariableIt;
    using iterator_facade_base::operator++;
    using iterator_facade_base::operator--;
 
    LIEF_API Iterator();
 
    LIEF_API Iterator(std::unique_ptr<details::VariableIt> 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 Variable& operator*() const LIEF_LIFETIMEBOUND;
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API const Variable* operator->() const LIEF_LIFETIMEBOUND;

    LIEF_API std::unique_ptr<Variable> yield();
 
    private:
    void load() const;
 
    std::unique_ptr<details::VariableIt> impl_;
    mutable std::unique_ptr<Variable> cached_;
  };
 
  Variable(std::unique_ptr<details::Variable> impl);

  std::string_view name() const LIEF_LIFETIMEBOUND;

  std::string_view linkage_name() const LIEF_LIFETIMEBOUND;

  result<int64_t> address() const;

  result<uint64_t> size() const;

  bool is_constexpr() const;

  bool is_stack_based() const;

  std::unique_ptr<Location> location() const;

  std::unique_ptr<Location> location(uint64_t pc) const;

  std::vector<LocationEntry> locations() const;

  debug_location_t debug_location() const;

  std::unique_ptr<Type> type() const LIEF_LIFETIMEBOUND;

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

  std::string_view description() const LIEF_LIFETIMEBOUND;

  std::string to_decl(const DeclOpt& opt = DeclOpt()) const;
 
  ~Variable();
 
  private:
  std::unique_ptr<details::Variable> impl_;
};
 
}
 
#endif