1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
//! Debug printer.
use core::fmt::{self, Write as _};
#[cfg(not(feature = "std"))]
use alloc::vec::Vec;
#[cfg(feature = "std")]
use std::vec::Vec;
use crate::{
arena::Arena,
id::NodeId,
traverse::{NodeEdge, Traverse},
};
//use crate::dynamic::hierarchy::traverse::{DepthFirstTraverser, DftEvent};
//use crate::dynamic::hierarchy::Hierarchy;
/// State of an indent block.
#[derive(Clone, Copy)]
struct IndentedBlockState {
/// Whether this is the last item.
is_last_item: bool,
/// Whether the line is the first line.
is_first_line: bool,
}
impl IndentedBlockState {
/// Returns the indent string for the indent type.
#[inline]
fn as_str(self) -> &'static str {
match (self.is_last_item, self.is_first_line) {
(false, true) => "|-- ",
(false, false) => "| ",
(true, true) => "`-- ",
(true, false) => " ",
}
}
/// Returns the leading part of the indent string.
#[inline]
fn as_str_leading(self) -> &'static str {
match (self.is_last_item, self.is_first_line) {
(false, true) => "|--",
(false, false) => "|",
(true, true) => "`--",
(true, false) => "",
}
}
/// Returns the trailing whitespaces part of the indent string.
#[inline]
fn as_str_trailing_spaces(self) -> &'static str {
match (self.is_last_item, self.is_first_line) {
(_, true) => " ",
(false, false) => " ",
(true, false) => " ",
}
}
/// Returns whether the indent string consists of only whitespaces.
#[inline]
#[must_use]
fn is_all_whitespace(self) -> bool {
self.is_last_item && !self.is_first_line
}
}
/// State of the line writing.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum LineState {
/// Before any character of the indent is written to the current line.
BeforeIndent,
/// Indents are partially written.
///
/// More precisely, trailing whitespaces are not yet written.
PartialIndent,
/// Writing content.
Content,
}
/// Indent writer for the debug printer.
struct IndentWriter<'a, 'b> {
/// Backend formatter.
fmt: &'b mut fmt::Formatter<'a>,
/// State of the line writing.
line_state: LineState,
/// Indents.
indents: Vec<IndentedBlockState>,
/// The number of pending whitespace-only indents.
pending_ws_only_indent_level: usize,
}
impl<'a, 'b> IndentWriter<'a, 'b> {
/// Creates a new `PadAdapter`.
#[inline]
fn new(fmt: &'b mut fmt::Formatter<'a>) -> Self {
Self {
fmt,
line_state: LineState::BeforeIndent,
indents: Vec::new(),
pending_ws_only_indent_level: 0,
}
}
/// Opens the next item.
///
/// Writes a newline if necessary and prepares to write the next item.
///
/// This should **not** be called for the root item.
fn open_item(&mut self, is_last_item: bool) -> fmt::Result {
if self.line_state != LineState::BeforeIndent {
self.fmt.write_char('\n')?;
self.line_state = LineState::BeforeIndent;
self.pending_ws_only_indent_level = 0;
}
if let Some(indent) = self.indents.last_mut() {
indent.is_first_line = false;
}
self.indents.push(IndentedBlockState {
is_last_item,
is_first_line: true,
});
Ok(())
}
/// Closes the current item.
///
/// Returns `Ok(())` if an item is successfully closed.
/// Returns `Err(())` if there are no items that can be closed, i.e. the
/// current item is the root.
#[inline]
fn close_item(&mut self) -> Result<(), ()> {
match self.indents.pop() {
Some(_) => Ok(()),
None => Err(()),
}
}
/// Writes the indent except for the trailing whitespaces.
fn write_indent_partial(&mut self) -> fmt::Result {
self.pending_ws_only_indent_level = self
.indents
.iter()
.rev()
.take_while(|i| i.is_all_whitespace())
.count();
let ws_indent_first_level = self.indents.len() - self.pending_ws_only_indent_level;
let indents_to_print = &self.indents[..ws_indent_first_level];
if let Some(last) = indents_to_print.last() {
for indent in &indents_to_print[..(indents_to_print.len() - 1)] {
self.fmt.write_str(indent.as_str())?;
}
self.fmt.write_str(last.as_str_leading())?;
}
Ok(())
}
/// Writes the rest of the indents which are partially written.
fn complete_partial_indent(&mut self) -> fmt::Result {
debug_assert_eq!(self.line_state, LineState::PartialIndent);
if let Some(last_non_ws_indent_level) =
(self.indents.len() - self.pending_ws_only_indent_level).checked_sub(1)
{
self.fmt
.write_str(self.indents[last_non_ws_indent_level].as_str_trailing_spaces())?;
}
for _ in 0..self.pending_ws_only_indent_level {
self.fmt.write_str(" ")?;
}
self.pending_ws_only_indent_level = 0;
Ok(())
}
}
impl fmt::Write for IndentWriter<'_, '_> {
fn write_str(&mut self, mut s: &str) -> fmt::Result {
while !s.is_empty() {
// There remains something to print.
if self.line_state == LineState::BeforeIndent {
self.write_indent_partial()?;
self.line_state = LineState::PartialIndent;
}
let (line_end, ends_with_newline) = match s.find('\n') {
Some(pos) => (pos + 1, true),
None => (s.len(), false),
};
let content = &s[..line_end];
if !content.is_empty() {
debug_assert_ne!(
self.line_state,
LineState::BeforeIndent,
"[consistency] indent must be written since there are something to write"
);
if self.line_state == LineState::PartialIndent {
self.complete_partial_indent()?;
}
if let Some(level) = self.indents.last_mut() {
level.is_first_line = level.is_first_line && !ends_with_newline;
}
self.fmt.write_str(content)?;
self.line_state = if ends_with_newline {
LineState::BeforeIndent
} else {
LineState::Content
};
}
s = &s[line_end..];
}
Ok(())
}
}
/// Tree printer for debugging.
///
/// This is provided mainly for debugging purpose. Node that the output format
/// is not guaranteed to be stable, and any format changes won't be considered
/// as breaking changes.
///
/// For usage and output examples, see
/// [`NodeId::debug_pretty_print`][`crate::NodeId::debug_pretty_print`] method.
#[derive(Clone, Copy)]
pub struct DebugPrettyPrint<'a, T> {
/// Root node ID of the (sub)tree to print.
id: &'a NodeId,
/// Arena the node belongs to.
arena: &'a Arena<T>,
}
impl<'a, T> DebugPrettyPrint<'a, T> {
/// Creates a new `DebugPrettyPrint` object for the node.
#[inline]
pub(crate) fn new(id: &'a NodeId, arena: &'a Arena<T>) -> Self {
Self { id, arena }
}
}
impl<'a, T: fmt::Display> fmt::Display for DebugPrettyPrint<'a, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let is_alternate = f.alternate();
let mut writer = IndentWriter::new(f);
let mut traverser = self.id.traverse(self.arena);
// Print the first (root) node.
traverser.next();
{
let data = self.arena[*self.id].get();
if is_alternate {
write!(writer, "{:#}", data)?
} else {
write!(writer, "{}", data)?
}
}
// Print the descendants.
while let Some(id) = prepare_next_node_printing(&mut writer, &mut traverser)? {
let data = traverser.arena()[id].get();
if is_alternate {
write!(writer, "{:#}", data)?
} else {
write!(writer, "{}", data)?
}
}
Ok(())
}
}
impl<'a, T: fmt::Debug> fmt::Debug for DebugPrettyPrint<'a, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let is_alternate = f.alternate();
let mut writer = IndentWriter::new(f);
let mut traverser = self.id.traverse(self.arena);
// Print the first (root) node.
traverser.next();
{
let data = self.arena[*self.id].get();
if is_alternate {
write!(writer, "{:#?}", data)?
} else {
write!(writer, "{:?}", data)?
}
}
// Print the descendants.
while let Some(id) = prepare_next_node_printing(&mut writer, &mut traverser)? {
let data = traverser.arena()[id].get();
if is_alternate {
write!(writer, "{:#?}", data)?
} else {
write!(writer, "{:?}", data)?
}
}
Ok(())
}
}
/// Prepares printing of next node.
///
/// Internally, this searches next node open and adjust indent level and prefix.
fn prepare_next_node_printing<T>(
writer: &mut IndentWriter<'_, '_>,
traverser: &mut Traverse<'_, T>,
) -> Result<Option<NodeId>, fmt::Error> {
// Not using `for ev in traverser` in order to access to `traverser`
// directly in the loop.
while let Some(ev) = traverser.next() {
let id = match ev {
NodeEdge::Start(id) => id,
NodeEdge::End(_) => {
if writer.close_item().is_ok() {
// Closed a non-root node.
continue;
} else {
// Closed the root node.
break;
}
}
};
let is_last_sibling = traverser.arena()[id].next_sibling().is_none();
writer.open_item(is_last_sibling)?;
return Ok(Some(id));
}
Ok(None)
}