gcc/rust/checks/errors/borrowck/rust-bir-dump.h

// Copyright (C) 2020-2026 Free Software Foundation, Inc.

// This file is part of GCC.

// GCC is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 3, or (at your option) any later
// version.

// GCC is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
// for more details.

// You should have received a copy of the GNU General Public License
// along with GCC; see the file COPYING3.  If not see
// <http://www.gnu.org/licenses/>.

#ifndef RUST_BIR_DUMP_H
#define RUST_BIR_DUMP_H

#include "rust-system.h"
#include "rust-bir-place.h"
#include "rust-bir-visitor.h"
#include "rust-bir.h"

namespace Rust {
namespace BIR {

/** Prints the BIR to a stream in a format resembling rustc's MIR. */
class Dump : public Visitor
{
  std::ostream &stream;
  Function &func;
  const std::string &name;

  IndexVec<BasicBlockId, BasicBlockId> bb_fold_map;
  IndexVec<PlaceId, PlaceId> place_map;

  PlaceId statement_place = INVALID_PLACE;
  BasicBlockId statement_bb = INVALID_BB;
  bool bb_terminated = false;

public:
  Dump (std::ostream &os, Function &func, const std::string &name)
    : stream (os), func (func), name (name),
      bb_fold_map (func.basic_blocks.size ()), place_map (func.place_db.size ())
  {}
  void go (bool enable_simplify_cfg = false);

protected:
  void visit (const Statement &stmt) override;
  void visit_place (PlaceId place_id);
  void visit_move_place (PlaceId place_id);
  void visit (const BorrowExpr &expr) override;
  void visit_lifetime (PlaceId place_id);
  void visit (const InitializerExpr &expr) override;
  void visit (const CallExpr &expr) override;
  void visit (const Operator<1> &expr) override;
  void visit (const Operator<2> &expr) override;
  void visit (const Assignment &expr) override;
  void visit_scope (ScopeId id, size_t depth = 1);

  std::ostream &indent (size_t depth);
};

} // namespace BIR
} // namespace Rust

#endif // RUST_BIR_DUMP_H