DWARF/CompilationUnit.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_COMPILATION_UNIT_H
#define LIEF_DWARF_COMPILATION_UNIT_H
#include <string_view>
#include <memory>
#include <string>
#include <vector>
 
#include "LIEF/DWARF/Function.hpp"
#include "LIEF/DWARF/Type.hpp"
#include "LIEF/DebugDeclOpt.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/range.hpp"
#include "LIEF/visibility.h"
 
 
namespace LIEF::dwarf {
 
namespace details {
class CompilationUnit;
class CompilationUnitIt;
}

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

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

  using functions_it = iterator_range<Function::Iterator>;

  using types_it = iterator_range<Type::Iterator>;

  using vars_it = iterator_range<Variable::Iterator>;

  class Language {
    public:
    enum LANG : uint32_t {
      UNKNOWN = 0,
      C,
      CPP,
      RUST,
      DART,
      MODULA,
      FORTRAN,
      SWIFT,
      D,
      JAVA,
      COBOL,
    };

    LANG lang = UNKNOWN;

    uint32_t version = 0;
 
    Language() = default;
    Language(LANG lang, uint32_t version) :
      lang(lang),
      version(version) {}
    Language(LANG lang) :
      Language(lang, 0) {}
 
    Language(const Language&) = default;
    Language& operator=(const Language&) = default;
    Language(Language&&) = default;
    Language& operator=(Language&&) = default;
    ~Language() = default;
  };
  CompilationUnit(std::unique_ptr<details::CompilationUnit> impl);
  ~CompilationUnit();

  std::string_view name() const LIEF_LIFETIMEBOUND;

  std::string_view producer() const LIEF_LIFETIMEBOUND;

  std::string_view compilation_dir() const LIEF_LIFETIMEBOUND;

  Language language() const;

  uint64_t low_address() const;

  uint64_t high_address() const;

  uint64_t size() const;

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

  std::unique_ptr<Function>
      find_function(std::string_view name) const LIEF_LIFETIMEBOUND;

  std::unique_ptr<Function> find_function(uint64_t addr) const LIEF_LIFETIMEBOUND;

  std::unique_ptr<Variable> find_variable(uint64_t addr) const LIEF_LIFETIMEBOUND;

  std::unique_ptr<Variable>
      find_variable(std::string_view name) const LIEF_LIFETIMEBOUND;

  functions_it functions() const LIEF_LIFETIMEBOUND;

  functions_it imported_functions() const LIEF_LIFETIMEBOUND;

  types_it types() const LIEF_LIFETIMEBOUND;

  vars_it variables() const LIEF_LIFETIMEBOUND;

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