Files
carbon-lang/toolchain/parse/dump.h

36 lines
1.0 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 tree id`
// - gdb: `call Dump(tree, id)`
#ifndef CARBON_TOOLCHAIN_PARSE_DUMP_H_
#define CARBON_TOOLCHAIN_PARSE_DUMP_H_
#ifndef NDEBUG
#include <string>
#include "toolchain/lex/token_index.h"
#include "toolchain/parse/node_ids.h"
namespace Carbon::Parse {
class Tree;
auto Dump(const Tree& tree, Lex::TokenIndex token) -> std::string;
auto Dump(const Tree& tree, NodeId node_id) -> std::string;
} // namespace Carbon::Parse
#endif // NDEBUG
#endif // CARBON_TOOLCHAIN_PARSE_DUMP_H_