Files
carbon-lang/toolchain/sem_ir/dump.h
T
Dana Jansens 2f808e0d0b Add debugger dumping for SpecificInterface (#7971)
This allows you to `dump` the SpecificInterface directly instead of
having to dump its components always, for the common cases where we have
a SpecificInterface rather than a SpecificInterfaceId.

It looks like:
```
interface: interface50000000: {name: name0, parent_scope: name_scope0, require_impls_block_id: require_block_empty, core_interface: Copy} `Copy`
  - specific_id: specific<none>
```
2026-10-15 14:59:11 +00:00

79 lines
3.6 KiB
C++

// 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 file id`
// - gdb: `call Dump(file, id)`
//
// When adding a new ID type, if it corresponds to a collection in `File`, also
// update the following places:
// - Add a `Dump` function in this header and `toolchain/sem_ir/dump.cpp`.
// - Add a forwarding `Dump` function in `toolchain/check/dump.cpp`.
// - Add a `Make<NewIdType>` function in `toolchain/sem_ir/dump.cpp`.
// - Add the `Make<NewIdType>` function to the `id_types` map in
// `scripts/lldbinit.py`.
#ifndef CARBON_TOOLCHAIN_SEM_IR_DUMP_H_
#define CARBON_TOOLCHAIN_SEM_IR_DUMP_H_
#include "toolchain/sem_ir/ids.h"
#ifndef NDEBUG
#include "toolchain/sem_ir/file.h"
namespace Carbon::SemIR {
auto Dump(const File& file) -> std::string;
auto Dump(const File& file, RawBundleId bundle_id) -> std::string;
auto Dump(const File& file, GeneratedFunctionId generated_function_id)
-> std::string;
auto Dump(const File& file, ClangDeclId clang_decl_id) -> std::string;
auto Dump(const File& file, ClangDeclSignatureId clang_decl_signature_id)
-> std::string;
auto Dump(const File& file, ClassId class_id) -> std::string;
auto Dump(const File& file, ConstantId const_id) -> std::string;
auto Dump(const File& file, CppOverloadSetId overload_set_id) -> std::string;
auto Dump(const File& file, DeclaredFacetTypeId declared_facet_type_id)
-> std::string;
auto Dump(const File& file, EntityNameId entity_name_id) -> std::string;
auto Dump(const File& file, FieldId field_id) -> std::string;
auto Dump(const File& file, FunctionId function_id) -> std::string;
auto Dump(const File& file, GenericId generic_id) -> std::string;
auto Dump(const File& file, IdentifiedFacetTypeId identified_facet_type_id)
-> std::string;
auto Dump(const File& file, ImplId impl_id) -> std::string;
auto Dump(const File& file, ImportIRInstId import_inst_id) -> std::string;
auto Dump(const File& file, const Inst& inst) -> std::string;
auto Dump(const File& file, InstBlockId inst_block_id) -> std::string;
auto Dump(const File& file, InstId inst_id) -> std::string;
auto Dump(const File& file, InterfaceId interface_id) -> std::string;
auto Dump(const File& file, LocId loc_id) -> std::string;
auto Dump(const File& file, NameId name_id) -> std::string;
auto Dump(const File& file, const NameScope& name_scope) -> std::string;
auto Dump(const File& file, NameScopeId name_scope_id) -> std::string;
auto Dump(const File& file, NamedConstraintId named_constraint_id)
-> std::string;
auto Dump(const File& file, RequireImplsBlockId require_impls_block_id)
-> std::string;
auto Dump(const File& file, RequireImplsId require_impls_id) -> std::string;
auto Dump(const File& file, SpecificId specific_id) -> std::string;
auto Dump(const File& file, const SpecificInterface& specific_interface_id)
-> std::string;
auto Dump(const File& file, SpecificInterfaceId specific_interface_id)
-> std::string;
auto Dump(const File& file, StructTypeFieldsId struct_type_fields_id)
-> std::string;
auto Dump(const File& file, TypeId type_id) -> std::string;
} // namespace Carbon::SemIR
#endif // NDEBUG
#endif // CARBON_TOOLCHAIN_SEM_IR_DUMP_H_