carbon-lang/toolchain/sem_ir/dump.h

// 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: `expr Dump(tokens, id)`
// - gdb: `call Dump(tokens, id)`

#ifndef CARBON_TOOLCHAIN_SEM_IR_DUMP_H_
#define CARBON_TOOLCHAIN_SEM_IR_DUMP_H_

#ifndef NDEBUG

#include "toolchain/sem_ir/file.h"

namespace Carbon::SemIR {

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, EntityNameId entity_name_id) -> std::string;
auto Dump(const File& file, FacetTypeId facet_type_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, 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, 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, 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_