PDB/DebugInfo.hpp

Go to the documentation of this file.

/* Copyright 2022 - 2025 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_PDB_INFO_H
#define LIEF_PDB_INFO_H
#include <memory>
#include <string>
#include <ostream>
 
#include "LIEF/iterators.hpp"
#include "LIEF/Abstract/DebugInfo.hpp"
 
#include "LIEF/PDB/CompilationUnit.hpp"
#include "LIEF/PDB/PublicSymbol.hpp"
#include "LIEF/PDB/Type.hpp"
 
#include "LIEF/visibility.h"
 
namespace LIEF {
namespace pdb {
class Function;

class LIEF_API DebugInfo : public LIEF::DebugInfo {
  public:
  using LIEF::DebugInfo::DebugInfo;

  using compilation_units_it = iterator_range<CompilationUnit::Iterator>;

  using public_symbols_it = iterator_range<PublicSymbol::Iterator>;

  using types_it = iterator_range<Type::Iterator>;

  static std::unique_ptr<DebugInfo> from_file(const std::string& pdb_path);
 
  FORMAT format() const override {
    return LIEF::DebugInfo::FORMAT::PDB;
  }
 
  static bool classof(const LIEF::DebugInfo* info) {
    return info->format() == LIEF::DebugInfo::FORMAT::PDB;
  }

  compilation_units_it compilation_units() const;

  public_symbols_it public_symbols() const;

  types_it types() const;

  std::unique_ptr<Type> find_type(const std::string& name) const;

  std::unique_ptr<PublicSymbol> find_public_symbol(const std::string& name) const;

  optional<uint64_t> find_function_address(const std::string& name) const override;

  uint32_t age() const;

  std::string guid() const;

  std::string to_string() const;
 
  friend LIEF_API
    std::ostream& operator<<(std::ostream& os, const DebugInfo& dbg)
  {
    os << dbg.to_string();
    return os;
  }
 
  ~DebugInfo() override = default;
};
 

inline std::unique_ptr<DebugInfo> load(const std::string& pdb_path) {
  return DebugInfo::from_file(pdb_path);
}
 
}
}
#endif