carbon-lang/toolchain/check/dump.cpp

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

// This library contains functions to assist dumping objects to stderr during
// interactive debugging. Functions named `Dump` are intended for direct use by
// developers, and should use overload resolution to determine which will be
// invoked. The debugger should do namespace resolution automatically. For
// example:
//
// - lldb: `dump context id`
// - gdb: `call Dump(context, id)`

#ifndef NDEBUG

#include "toolchain/lex/dump.h"

#include <string>

#include "common/check.h"
#include "common/raw_string_ostream.h"
#include "toolchain/check/context.h"
#include "toolchain/lex/tokenized_buffer.h"
#include "toolchain/parse/dump.h"
#include "toolchain/parse/tree.h"
#include "toolchain/sem_ir/dump.h"
#include "toolchain/sem_ir/file.h"
#include "toolchain/sem_ir/ids.h"

namespace Carbon::Check {

LLVM_DUMP_METHOD static auto Dump(const Context& context) -> std::string {
  return SemIR::Dump(context.sem_ir());
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, Lex::TokenIndex token)
    -> std::string {
  return Parse::Dump(context.parse_tree(), token);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, Parse::NodeId node_id)
    -> std::string {
  return Parse::Dump(context.parse_tree(), node_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::RawBundleId bundle_id) -> std::string {
  return SemIR::Dump(context.sem_ir(), bundle_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, SemIR::GeneratedFunctionId generated_function_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), generated_function_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::ClangDeclId clang_decl_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), clang_decl_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, SemIR::ClangDeclSignatureId clang_decl_signature_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), clang_decl_signature_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::ClassId class_id) -> std::string {
  return SemIR::Dump(context.sem_ir(), class_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::ConstantId const_id) -> std::string {
  return SemIR::Dump(context.sem_ir(), const_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, SemIR::DeclaredFacetTypeId declared_facet_type_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), declared_facet_type_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::EntityNameId entity_name_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), entity_name_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::FunctionId function_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), function_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::GenericId generic_id) -> std::string {
  return SemIR::Dump(context.sem_ir(), generic_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, IdentifiedFacetTypeId identified_facet_type_id)
    -> std::string {
  RawStringOstream out;
  out << identified_facet_type_id;
  if (!identified_facet_type_id.has_value()) {
    return out.TakeStr();
  }

  const auto& identified_facet_type =
      context.identified_facet_types().Get(identified_facet_type_id);
  for (auto [i, req_impl] :
       llvm::enumerate(identified_facet_type.required_impls())) {
    auto [self, req_interface] = req_impl;
    out << "\n  - self: " << DumpConstantSummary(context.sem_ir(), self);
    out << "\n    impls: "
        << DumpInterfaceSummary(context.sem_ir(), req_interface.interface_id);
    if (req_interface.specific_id.has_value()) {
      out << "; "
          << DumpSpecificSummary(context.sem_ir(), req_interface.specific_id);
    }
    if (req_interface == identified_facet_type.impl_as_target_interface()) {
      out << "\n     - `impl as` target";
    }
  }
  if (!identified_facet_type.is_valid_impl_as_target()) {
    out << "\n  - " << identified_facet_type.num_interfaces_to_impl()
        << " possible `impl as` targets";
  }
  return out.TakeStr();
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, SemIR::ImplId impl_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), impl_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::ImportIRInstId import_ir_inst_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), import_ir_inst_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  const SemIR::Inst& inst) -> std::string {
  return SemIR::Dump(context.sem_ir(), inst);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::InstBlockId inst_block_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), inst_block_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, SemIR::InstId inst_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), inst_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::InterfaceId interface_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), interface_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, SemIR::LocId loc_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), loc_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, SemIR::NameId name_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), name_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  const SemIR::NameScope& name_scope)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), name_scope);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::NameScopeId name_scope_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), name_scope_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::NamedConstraintId named_constraint_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), named_constraint_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, SemIR::RequireImplsBlockId require_impls_block_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), require_impls_block_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::RequireImplsId require_impls_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), require_impls_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context,
                                  SemIR::SpecificId specific_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), specific_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, const SemIR::SpecificInterface& specific_interface)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), specific_interface);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, SemIR::SpecificInterfaceId specific_interface_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), specific_interface_id);
}

LLVM_DUMP_METHOD static auto Dump(
    const Context& context, SemIR::StructTypeFieldsId struct_type_fields_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), struct_type_fields_id);
}

LLVM_DUMP_METHOD static auto Dump(const Context& context, SemIR::TypeId type_id)
    -> std::string {
  return SemIR::Dump(context.sem_ir(), type_id);
}

LLVM_DUMP_METHOD static auto MakeIdentifiedFacetTypeId(int id)
    -> IdentifiedFacetTypeId {
  return IdentifiedFacetTypeId(id);
}

}  // namespace Carbon::Check

#endif  // NDEBUG