dprint-core 0.41.0

use fnv::FnvHashMap;
use bumpalo::Bump;

use super::collections::*;
use super::WriteItem;
use super::print_items::*;
use super::writer::*;

struct SavePoint<'a> {
    #[cfg(debug_assertions)]
    /// Name for debugging purposes.
    pub name: &'static str,
    pub new_line_group_depth: u16,
    pub force_no_newlines_depth: u8,
    pub writer_state: WriterState<'a>,
    pub possible_new_line_save_point: Option<&'a SavePoint<'a>>,
    pub node: Option<PrintItemPath>,
    pub look_ahead_condition_save_points: FnvHashMap<usize, &'a SavePoint<'a>>,
    pub look_ahead_info_save_points: FnvHashMap<usize, &'a SavePoint<'a>>,
    pub next_node_stack: Vec<Option<PrintItemPath>>,
}

struct PrintItemContainer<'a> {
    items: &'a Vec<PrintItem>,
    index: i32,
}

impl<'a> Clone for PrintItemContainer<'a> {
    fn clone(&self) -> PrintItemContainer<'a> {
        PrintItemContainer {
            items: self.items,
            index: self.index,
        }
    }
}

#[cfg(feature = "tracing")]
pub struct PrintTracingResult<'a> {
    pub traces: Vec<Trace>,
    pub writer_nodes: Vec<&'a GraphNode<'a, WriteItem<'a>>>,
}

/// Options for printing.
pub struct PrinterOptions {
    /// The width the printer will attempt to keep the line under.
    pub max_width: u32,
    /// The number of columns to count when indenting or using a tab.
    pub indent_width: u8,
    #[cfg(feature = "tracing")]
    pub enable_tracing: bool,
}

// todo: Needs slight redesign. See issue #71 and #195.

pub struct Printer<'a> {
    bump: &'a Bump,
    possible_new_line_save_point: Option<&'a SavePoint<'a>>,
    new_line_group_depth: u16,
    force_no_newlines_depth: u8,
    current_node: Option<PrintItemPath>,
    writer: Writer<'a>,
    resolved_conditions: FnvHashMap<usize, Option<bool>>,
    resolved_infos: FnvHashMap<usize, WriterInfo>,
    look_ahead_condition_save_points: FnvHashMap<usize, &'a SavePoint<'a>>,
    look_ahead_info_save_points: FastCellMap<'a, usize, SavePoint<'a>>,
    next_node_stack: Vec<Option<PrintItemPath>>,
    conditions_for_infos: FnvHashMap<usize, FnvHashMap<usize, (&'a Condition, &'a SavePoint<'a>)>>,
    max_width: u32,
    skip_moving_next: bool,
    resolving_save_point: Option<&'a SavePoint<'a>>,
    stored_info_positions: FnvHashMap<usize, (u32, u32)>,
    #[cfg(feature = "tracing")]
    traces: Option<Vec<Trace>>,
    #[cfg(feature = "tracing")]
    start_time: std::time::Instant,
}

impl<'a> Printer<'a> {
    pub fn new(
        bump: &'a Bump,
        start_node: Option<PrintItemPath>,
        options: PrinterOptions,
    ) -> Printer<'a> {
        Printer {
            bump,
            possible_new_line_save_point: None,
            new_line_group_depth: 0,
            force_no_newlines_depth: 0,
            current_node: start_node,
            writer: Writer::new(bump, WriterOptions {
                indent_width: options.indent_width,
                #[cfg(feature = "tracing")]
                enable_tracing: options.enable_tracing,
            }),
            resolved_conditions: FnvHashMap::default(),
            resolved_infos: FnvHashMap::default(),
            look_ahead_condition_save_points: FnvHashMap::default(),
            look_ahead_info_save_points: FastCellMap::new(),
            conditions_for_infos: FnvHashMap::default(),
            next_node_stack: Vec::new(),
            max_width: options.max_width,
            skip_moving_next: false,
            resolving_save_point: None,
            stored_info_positions: FnvHashMap::default(),
            #[cfg(feature = "tracing")]
            traces: if options.enable_tracing { Some(Vec::new()) } else { None },
            #[cfg(feature = "tracing")]
            start_time: std::time::Instant::now(),
        }
    }

    /// Turns the print items into a collection of writer items according to the options.
    pub fn print(mut self) -> impl Iterator<Item = &'a WriteItem<'a>> {
        self.inner_print();
        self.writer.get_items()
    }

    /// Turns the print items into a collection of writer items according to the options along with traces.
    #[cfg(feature = "tracing")]
    pub fn print_for_tracing(mut self) -> PrintTracingResult<'a> {
        self.inner_print();

        PrintTracingResult {
            traces: self.traces.expect("Should have set enable_tracing to true when creating the printer."),
            writer_nodes: self.writer.get_nodes(),
        }
    }

    fn inner_print(&mut self) {
        while let Some(current_node) = &self.current_node {
            let current_node = unsafe { &*current_node.get_node() }; // ok because values won't be mutated while printing
            self.handle_print_node(current_node);

            #[cfg(feature = "tracing")]
            self.create_trace(current_node);

            // println!("{}", self.writer.to_string_for_debugging());

            if self.skip_moving_next {
                self.skip_moving_next = false;
            } else if let Some(current_node) = self.current_node {
                self.current_node = current_node.get_next();
            }

            while self.current_node.is_none() && !self.next_node_stack.is_empty() {
                self.current_node = self.next_node_stack.pop().flatten();
            }
        }

        #[cfg(debug_assertions)]
        self.verify_no_look_ahead_save_points();
        #[cfg(debug_assertions)]
        self.ensure_counts_zero();
    }

    #[cfg(feature = "tracing")]
    fn create_trace(&mut self, current_node: &PrintNode) {
        if let Some(traces) = self.traces.as_mut() {
            traces.push(Trace {
                nanos: (std::time::Instant::now() - self.start_time).as_nanos(),
                print_node_id: current_node.print_node_id,
                writer_node_id: self.writer.get_current_node_id(),
            });
        }
    }

    pub fn get_writer_info(&self) -> WriterInfo {
        WriterInfo {
            line_start_indent_level: self.writer.get_line_start_indent_level(),
            line_start_column_number: self.writer.get_line_start_column_number(),
            line_number: self.writer.get_line_number(),
            column_number: self.writer.get_line_column(),
            indent_level: self.writer.get_indentation_level(),
        }
    }

    pub fn get_resolved_info(&self, info: &Info) -> Option<&WriterInfo> {
        let resolved_info = self.resolved_infos.get(&info.get_unique_id());
        if resolved_info.is_none() && !self.look_ahead_info_save_points.contains_key(&info.get_unique_id()) {
            let save_point = self.get_save_point_for_restoring_condition(&info.get_name());
            self.look_ahead_info_save_points.insert(info.get_unique_id(), save_point);
        }

        resolved_info
    }

    pub fn clear_info(&mut self, info: &Info) {
        self.resolved_infos.remove(&info.get_unique_id());
    }

    pub fn get_resolved_condition(&mut self, condition_reference: &ConditionReference) -> Option<bool> {
        if !self.resolved_conditions.contains_key(&condition_reference.id) && !self.look_ahead_condition_save_points.contains_key(&condition_reference.id) {
            let save_point = self.get_save_point_for_restoring_condition(&condition_reference.get_name());
            self.look_ahead_condition_save_points.insert(condition_reference.id, save_point);
        }

        let result = self.resolved_conditions.get(&condition_reference.id)?;
        result.map(|x| x.to_owned())
    }

    pub fn has_info_moved(&mut self, info: &Info) -> Option<bool> {
        let position = self.get_resolved_info(&info)?.get_line_and_column();
        let stored_position = self.stored_info_positions.get(&info.get_unique_id());
        if let Some(stored_position) = stored_position {
            if position != *stored_position {
                self.stored_info_positions.insert(info.get_unique_id(), position);
                return Some(true);
            }
        } else {
            self.stored_info_positions.insert(info.get_unique_id(), position);
        }
        Some(false)
    }

    #[inline]
    fn handle_print_node(&mut self, print_node: &PrintNode) {
        match &print_node.item {
            PrintItem::String(text) => self.handle_string(text),
            PrintItem::Condition(condition) => self.handle_condition(condition, &print_node.next),
            PrintItem::Info(info) => self.handle_info(info),
            PrintItem::Signal(signal) => self.handle_signal(signal),
            PrintItem::RcPath(rc_path) => self.handle_rc_path(rc_path, &print_node.next),
        }
    }

    fn write_new_line(&mut self) {
        self.writer.new_line();
        self.possible_new_line_save_point = None;
    }

    fn create_save_point(&self, _name: &'static str, next_node: Option<PrintItemPath>) -> &'a SavePoint<'a> {
        self.bump.alloc(SavePoint {
            #[cfg(debug_assertions)]
            name: _name,
            possible_new_line_save_point: self.possible_new_line_save_point.clone(),
            new_line_group_depth: self.new_line_group_depth,
            force_no_newlines_depth: self.force_no_newlines_depth,
            node: next_node,
            writer_state: self.writer.get_state(),
            look_ahead_condition_save_points: self.look_ahead_condition_save_points.clone(),
            look_ahead_info_save_points: self.look_ahead_info_save_points.clone_map(),
            next_node_stack: self.next_node_stack.clone(),
        })
    }

    #[inline]
    fn get_save_point_for_restoring_condition(&self, name: &'static str) -> &'a SavePoint<'a> {
        if let Some(save_point) = &self.resolving_save_point {
            save_point
        } else {
            self.create_save_point(name, self.current_node.clone())
        }
    }

    fn mark_possible_new_line_if_able(&mut self) {
        if let Some(new_line_save_point) = &self.possible_new_line_save_point {
            if self.new_line_group_depth > new_line_save_point.new_line_group_depth {
                return;
            }
        }

        let next_node = self.current_node.as_ref().unwrap().get_next();
        self.possible_new_line_save_point = Some(self.create_save_point("newline", next_node));
    }

    #[inline]
    fn is_above_max_width(&self, offset: u32) -> bool {
        self.writer.get_line_column() + offset > self.max_width
    }

    fn update_state_to_save_point(&mut self, save_point: &'a SavePoint<'a>, is_for_new_line: bool) {
        self.writer.set_state(save_point.writer_state.clone());
        self.possible_new_line_save_point = if is_for_new_line { None } else { save_point.possible_new_line_save_point.clone() };
        self.current_node = save_point.node.clone();
        self.new_line_group_depth = save_point.new_line_group_depth;
        self.force_no_newlines_depth = save_point.force_no_newlines_depth;
        self.look_ahead_condition_save_points = save_point.look_ahead_condition_save_points.clone();
        self.look_ahead_info_save_points.replace_map(save_point.look_ahead_info_save_points.clone());
        self.next_node_stack = save_point.next_node_stack.clone();

        if is_for_new_line {
            self.write_new_line();
        }

        self.skip_moving_next = true;
    }

    #[inline]
    fn handle_signal(&mut self, signal: &Signal) {
        match signal {
            Signal::NewLine => if self.allow_new_lines() { self.write_new_line() },
            Signal::Tab => self.writer.tab(),
            Signal::ExpectNewLine => {
                // just always allow this for now since it's most likely a comment...
                self.writer.mark_expect_new_line();
                self.possible_new_line_save_point = None;
            }
            Signal::PossibleNewLine => if self.allow_new_lines() { self.mark_possible_new_line_if_able() },
            Signal::SpaceOrNewLine => {
                if self.allow_new_lines() {
                    if self.is_above_max_width(1) {
                        let optional_save_state = std::mem::replace(&mut self.possible_new_line_save_point, None);
                        if optional_save_state.is_none() {
                            self.write_new_line();
                        } else if let Some(save_state) = optional_save_state {
                            if save_state.new_line_group_depth >= self.new_line_group_depth {
                                self.write_new_line();
                            } else {
                                self.update_state_to_save_point(save_state, true);
                                return;
                            }
                        }
                    } else {
                        self.mark_possible_new_line_if_able();
                        self.writer.space_if_not_trailing();
                    }
                } else {
                    self.writer.space_if_not_trailing();
                }
            }
            Signal::QueueStartIndent => self.writer.queue_indent(),
            Signal::StartIndent => self.writer.start_indent(),
            Signal::FinishIndent => self.writer.finish_indent(),
            Signal::StartNewLineGroup => self.new_line_group_depth += 1,
            Signal::FinishNewLineGroup => self.new_line_group_depth -= 1,
            Signal::SingleIndent => self.writer.single_indent(),
            Signal::StartIgnoringIndent => self.writer.start_ignoring_indent(),
            Signal::FinishIgnoringIndent => self.writer.finish_ignoring_indent(),
            Signal::StartForceNoNewLines => self.force_no_newlines_depth += 1,
            Signal::FinishForceNoNewLines => self.force_no_newlines_depth -= 1,
            Signal::SpaceIfNotTrailing => self.writer.space_if_not_trailing(),
        }
    }

    #[inline]
    fn handle_info(&mut self, info: &Info) {
        let info_id = info.get_unique_id();
        self.resolved_infos.insert(info_id, self.get_writer_info());
        let option_save_point = self.look_ahead_info_save_points.remove(&info_id);
        if let Some(save_point) = option_save_point {
            self.update_state_to_save_point(save_point, false);
            return;
        }

        // check if there are any conditions that should be re-evaluated based on this info update
        if self.conditions_for_infos.contains_key(&info_id) {
            // todo: avoid this clone
            let conditions_for_info = self.conditions_for_infos.get(&info_id).unwrap().clone();
            for (condition, save_point) in conditions_for_info.values() {
                let condition_id = condition.get_unique_id();

                if let Some(resolved_condition_value) = self.resolved_conditions.get(&condition_id).map(|x| x.to_owned()).flatten() {
                    self.resolving_save_point.replace(save_point);
                    let mut context = ConditionResolverContext::new(self, save_point.writer_state.get_writer_info(self.writer.get_indent_width()));
                    let condition_value = condition.resolve(&mut context);
                    self.resolving_save_point.take();
                    if let Some(condition_value) = condition_value {
                        if condition_value != resolved_condition_value {
                            self.update_state_to_save_point(save_point, false);
                            return;
                        }
                    } else {
                        self.resolved_conditions.remove(&condition_id);
                    }
                }
            }
        }
    }

    #[inline]
    fn handle_condition(&mut self, condition: &'a Condition, next_node: &Option<PrintItemPath>) {
        let condition_id = condition.get_unique_id();
        if let Some(dependent_infos) = &condition.dependent_infos {
            for info in dependent_infos {
                let info_id = info.get_unique_id();
                let save_point = self.get_save_point_for_restoring_condition(condition.get_name());
                let conditions_for_info = if let Some(conditions) = self.conditions_for_infos.get_mut(&info_id) {
                    conditions
                } else {
                    self.conditions_for_infos.insert(info_id, Default::default());
                    self.conditions_for_infos.get_mut(&info_id).unwrap()
                };

                let condition_id = condition.get_unique_id();
                conditions_for_info.insert(condition_id, (condition, save_point));
            }
        }

        let condition_value = condition.resolve(&mut ConditionResolverContext::new(self, self.get_writer_info()));
        if condition.is_stored {
            self.resolved_conditions.insert(condition_id, condition_value);
        }

        let save_point = self.look_ahead_condition_save_points.get(&condition_id);
        if condition_value.is_some() && save_point.is_some() {
            let save_point = self.look_ahead_condition_save_points.remove(&condition_id);
            self.update_state_to_save_point(save_point.unwrap(), false);
            return;
        }

        if condition_value.is_some() && condition_value.unwrap() {
            if let Some(true_path) = condition.true_path {
                self.current_node = Some(true_path.clone());
                self.next_node_stack.push(next_node.clone());
                self.skip_moving_next = true;
            }
        } else {
            if let Some(false_path) = condition.false_path {
                self.current_node = Some(false_path.clone());
                self.next_node_stack.push(next_node.clone());
                self.skip_moving_next = true;
            }
        }
    }

    #[inline]
    fn handle_rc_path(&mut self, print_item_path: &PrintItemPath, next_node: &Option<PrintItemPath>) {
        self.next_node_stack.push(next_node.clone());
        self.current_node = Some(print_item_path);
        self.skip_moving_next = true;
    }

    #[inline]
    fn handle_string(&mut self, text: &'a StringContainer) {
        #[cfg(debug_assertions)]
        self.validate_string(&text.text);

        if self.possible_new_line_save_point.is_some() && self.is_above_max_width(text.char_count) && self.allow_new_lines() {
            let save_point = std::mem::replace(&mut self.possible_new_line_save_point, Option::None);
            self.update_state_to_save_point(save_point.unwrap(), true);
        } else {
            self.writer.write(text);
        }
    }

    #[inline]
    fn allow_new_lines(&self) -> bool {
        self.force_no_newlines_depth == 0
    }

    #[cfg(debug_assertions)]
    fn validate_string(&self, text: &str) {
        // The parser_helpers::parse_raw_string(...) helper function might be useful if you get either of these panics.
        if text.contains('\t') {
            panic!("Debug panic! Found a tab in the string. Before sending the string to the printer it needs to be broken up and the tab sent as a PrintItem::Tab. {0}", text);
        }
        if text.contains('\n') {
            panic!("Debug panic! Found a newline in the string. Before sending the string to the printer it needs to be broken up and the newline sent as a PrintItem::NewLine. {0}", text);
        }
    }

    #[cfg(debug_assertions)]
    fn verify_no_look_ahead_save_points(&self) {
        // The look ahead save points should be empty when printing is finished. If it's not
        // then that indicates that the parser tried to resolve a condition or info that was
        // never added to the print items. In this scenario, the look ahead hash maps will
        // be cloned when creating a save point and contain items that don't need to exist
        // in them thus having an unnecessary performance impact.
        if let Some(save_point) = self.look_ahead_condition_save_points.values().next() {
            self.panic_for_save_point_existing(save_point)
        }
        if let Some(save_point) = self.look_ahead_info_save_points.get_any_item() {
            self.panic_for_save_point_existing(&save_point)
        }
    }

    #[cfg(debug_assertions)]
    fn panic_for_save_point_existing(&self, save_point: &SavePoint<'a>) {
        panic!(
            concat!(
                "Debug panic! '{}' was never added to the print items in this scenario. This can ",
                "have slight performance implications in large files."
            ),
            save_point.name
        );
    }

    #[cfg(debug_assertions)]
    fn ensure_counts_zero(&self) {
        if self.new_line_group_depth != 0 {
            panic!("Debug panic! The new line group depth was not zero after printing. {0}", self.new_line_group_depth);
        }
        if self.force_no_newlines_depth != 0 {
            panic!("Debug panic! The force no newlines depth was not zero after printing. {0}", self.force_no_newlines_depth);
        }
        if self.writer.get_indentation_level() != 0 {
            panic!("Debug panic! The writer indentation level was not zero after printing. {0}", self.writer.get_indentation_level());
        }
        if self.writer.get_ignore_indent_count() != 0 {
            panic!("Debug panic! The writer ignore indent count was not zero after printing. {0}", self.writer.get_ignore_indent_count());
        }
    }
}