doku 0.21.1

use super::*;

#[derive(Debug)]
pub struct Ctxt<'fmt, 'ty, 'out> {
    pub ty: &'ty Type,
    pub val: Option<&'ty Value>,
    pub vis: Visibility,
    pub fmt: &'fmt Formatting,
    pub out: &'out mut Output,
    pub is_key: bool,
    pub name: Option<String>,

    /// Parent of `ty`.
    ///
    /// # Example
    ///
    /// When processing `usize` of `Option<usize>`, this `Option<usize>` would
    /// be the parent.
    pub parent: Option<&'ty Type>,

    /// When present, overrides `ty.example`; used to propagate examples through
    /// optional values.
    pub example: Option<Example>,

    /// When enabled, `ty` will be printed as flat / transparent.
    ///
    /// # Example
    ///
    /// Without `flat`:
    ///
    /// ```toml
    /// a = "string"
    ///
    /// [inner-struct]
    /// b = "string"
    /// c = "string"
    /// ```
    ///
    /// With `flat`:
    ///
    /// ```toml
    /// a = "string"
    /// b = "string"
    /// c = "string"
    /// ```
    pub flat: bool,

    /// Incremented each time `Ctxt::nested()` is called; used to detect
    /// recursion.
    pub depth: u8,
}

// TODO try to generalize
impl<'fmt, 'ty, 'out> Ctxt<'fmt, 'ty, 'out> {
    /// Clones `self`, but preserves the same `self.out` (hence the returned
    /// object has to have a shorter output borrow's lifetime - `out2`).
    pub fn nested<'out2>(&'out2 mut self) -> Ctxt<'fmt, 'ty, 'out2> {
        Ctxt {
            ty: self.ty,
            val: self.val,
            vis: self.vis,
            fmt: self.fmt,
            out: self.out,
            is_key: false,
            name: None,
            parent: self.parent,
            example: self.example,
            flat: self.flat,
            depth: self.depth.checked_add(1).expect(
                "Seems like the printer got stuck; this might indicate a bug \
                 in Doku or a recursive type in your code-base",
            ),
        }
    }

    pub fn with_ty(mut self, ty: &'ty Type) -> Self {
        self.parent = Some(self.ty);

        // When we have a struct with a flattened field, all the inner fields of
        // _that_ type are not subject for flattening anymore:
        //
        // ```
        // struct T1 {
        //   #[doku(flatten)]
        //   f: T2,
        // }
        //
        // struct T2 {
        //   f: T3, // <- gets flattened
        // }
        //
        // struct T3 {
        //   f1: ..., // <- doesn't get flattened
        //   f2: ..., // <- doesn't get flattened
        // }
        //
        // ```
        //
        // There's one edge-case here though - when we flatten a transparent
        // field, the `flat` flag has to be carried further, because otherwise
        // we'd essentially ignore the transparency requirement.
        let keep_flat = matches!(
            self.ty.kind,
            TypeKind::Struct {
                transparent: true,
                fields: _,
            }
        );

        self.ty = ty;
        self.flat = self.flat && keep_flat;
        self.example = None;
        self
    }

    pub fn with_val(mut self, val: Option<&'ty Value>) -> Self {
        self.val = val;
        self
    }

    pub fn with_fmt<'fmt2>(
        self,
        fmt: &'fmt2 Formatting,
    ) -> Ctxt<'fmt2, 'ty, 'out> {
        Ctxt {
            ty: self.ty,
            val: self.val,
            vis: self.vis,
            fmt,
            out: self.out,
            is_key: false,
            name: self.name,
            parent: self.parent,
            example: self.example,
            flat: self.flat,
            depth: self.depth,
        }
    }

    pub fn with_example(mut self, example: Option<impl Into<Example>>) -> Self {
        self.example = example.map(Into::into);
        self
    }

    pub fn with_flat(mut self) -> Self {
        self.flat = true;
        self
    }

    pub fn set_is_key(mut self) -> Self {
        self.is_key = true;
        self
    }

    pub fn with_name(mut self, name: Option<String>) -> Self {
        self.name = name;
        self
    }

    pub fn name_for_child(&self, child_name: &str) -> String {
        match self.name.as_deref() {
            Some(name) => format!("{}.{}", name, child_name),
            None => child_name.to_owned(),
        }
    }

    pub fn example(&self) -> Option<Example> {
        self.example.or(self.ty.example)
    }

    pub fn first_example(&self) -> Option<&'static str> {
        self.example().and_then(Example::first)
    }

    pub fn literal_example(&self) -> Option<&'static str> {
        self.example().and_then(|example| {
            if let Example::Literal(example) = example {
                Some(example)
            } else {
                None
            }
        })
    }

    pub fn should_indent(&self) -> bool {
        self.parent.is_some() && self.fmt.indent_style.indent_table_fields
    }

    pub fn print(self) {
        if !self
            .vis
            .allows(self.ty.serializable, self.ty.deserializable)
        {
            return;
        }

        let requires_custom_formatting =
            self.ty.metas.iter().any(|meta| {
                meta.key() == "fmt" || meta.key().starts_with("fmt.")
            });

        if requires_custom_formatting {
            let fmt = self.fmt.customize(self.ty.metas.iter());

            self.with_fmt(&fmt).print_inner();
        } else {
            self.print_inner();
        }
    }

    fn print_inner(mut self) {
        if let Some(example) = self.literal_example() {
            self.print_comment();
            self.out.write(example);
            return;
        } else if self.name.is_some() && self.should_write_table_name() {
            self.out.space_between_tables();
            self.print_comment();
            self.out.write_table_name(
                self.name.as_deref().unwrap(),
                self.has_array_parent(),
            );
        } else {
            self.print_comment();
        }

        match &self.ty.kind {
            TypeKind::Bool => self.print_bool(),
            TypeKind::Float => self.print_float(),
            TypeKind::Integer => self.print_integer(),
            TypeKind::String => self.print_string(),
            TypeKind::Array { ty, size } => self.print_array(ty, *size),
            TypeKind::Enum { tag, variants } => self.print_enum(*tag, variants),
            TypeKind::Struct {
                fields,
                transparent,
            } => self.print_struct(fields, *transparent, None),
            TypeKind::Tuple { fields } => self.print_tuple(fields),
            TypeKind::Map { key, value } => self.print_map(key, value),
            TypeKind::Optional { ty } => self.print_optional(ty),
        }
    }

    pub fn print_current_name(&mut self) {
        if self.should_write_table_name() {
            if let Some(name) = self.name.as_deref() {
                self.out.space_between_tables();
                self.out.write_table_name(name, self.has_array_parent());
            }
        }
    }

    pub fn print_child_name(&mut self, key: &str, is_table: bool) {
        if is_table {
            let child_name = self.name_for_child(key);
            self.out.write_table_name(child_name, false);
        } else {
            self.out.write_key_and_separator(key);
        }
    }

    pub fn has_array_parent(&self) -> bool {
        matches!(self.parent.map(|p| &p.kind), Some(TypeKind::Array { .. }))
    }
}