DWARF/Function.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_FUNCTION_H
#define LIEF_DWARF_FUNCTION_H
 
#include <string_view>
#include <memory>
#include <string>
 
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/errors.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/DWARF/LexicalBlock.hpp"
#include "LIEF/DWARF/Type.hpp"
#include "LIEF/DWARF/Variable.hpp"
#include "LIEF/asm/Instruction.hpp"
#include "LIEF/range.hpp"
 
 
namespace LIEF::dwarf {
 
class Scope;
class Parameter;
 
namespace details {
class Function;
class FunctionIt;
}

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

    LIEF_API std::unique_ptr<Function> yield();
 
    private:
    void load() const;
 
    std::unique_ptr<details::FunctionIt> impl_;
    mutable std::unique_ptr<Function> cached_;
  };

  using vars_it = iterator_range<Variable::Iterator>;
  using parameters_t = std::vector<std::unique_ptr<Parameter>>;
  using thrown_types_t = std::vector<std::unique_ptr<Type>>;
 
  using lexical_blocks_it = iterator_range<LexicalBlock::Iterator>;
 
  using instructions_it = iterator_range<assembly::Instruction::Iterator>;
 
  Function(std::unique_ptr<details::Function> impl);

  std::string_view name() const LIEF_LIFETIMEBOUND;

  std::string_view linkage_name() const LIEF_LIFETIMEBOUND;

  result<uint64_t> address() const;

  vars_it variables() const LIEF_LIFETIMEBOUND;

  bool is_artificial() const;

  bool is_external() const;

  uint64_t size() const;

  std::vector<range_t> ranges() const;

  debug_location_t debug_location() const;

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

  parameters_t parameters() const LIEF_LIFETIMEBOUND;

  thrown_types_t thrown_types() const LIEF_LIFETIMEBOUND;

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

  instructions_it instructions() const LIEF_LIFETIMEBOUND;

  lexical_blocks_it lexical_blocks() const LIEF_LIFETIMEBOUND;

  std::string_view description() const LIEF_LIFETIMEBOUND;

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