/*
    This file is part of Donet.

    Copyright © 2024 Max Rodriguez

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

    Donet 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public
    License along with Donet. If not, see <https://www.gnu.org/licenses/>.
*/

//! Enum and Struct definitions that are used to build the DC File [`AST`].
//! Used by [`crate::parser::parser`].
//!
//! [`AST`]: https://en.wikipedia.org/wiki/Abstract_syntax_tree

use super::lexer::{DCToken, Span};
use crate::dctype::DCTypeEnum;

/// Paired with the `type_declarations` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct Root {
    pub type_declarations: Vec<TypeDeclaration>,
}

/// Paired with the `type_decl` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum TypeDeclaration {
    // A single Python-style DC Import line can translate to
    // multiple [`PythonImport`] structures per symbol imported.
    PythonImport(PythonImport),
    KeywordType(KeywordDefinition),
    StructType(Struct),
    DClassType(DClass),
    TypedefType(TypeDefinition),
    // Returned by productions that parsed certain grammar that may be
    // deprecated but ignored for compatibility & should not be added
    // to the output DC file element structure.
    Ignore,
}

/// Paired with the `python_style_import` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct PythonImport {
    pub span: Span,
    pub module: SymbolWithViews,
    pub class: SymbolWithViews,
}

/// Paired with the `py_module` and `dclass_import`
/// productions in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct SymbolWithViews {
    pub span: Span,
    pub symbol: String,
    pub symbol_views: Vec<ViewSuffix>,
}

/// Paired with the `view_suffixes` production in the Context Free Grammar.
pub type ViewSuffixes = Vec<ViewSuffix>;

/// Paired with the `view_suffix` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct ViewSuffix {
    pub span: Span,
    pub view: String, // 'AI', 'OV', 'UD', etc.
}

/// Paired with the `type_definition` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct TypeDefinition {
    pub span: Span,
    /// Used if deprecated type aliases are found, such as `typedef uint8 bool;`
    pub deprecated: bool,
    pub data_type: NonMethodDataType,
    pub array_range: Option<ArrayRange>,
    pub alias_identifier: Option<String>,
}

/// Paired with the `keyword_type` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct KeywordDefinition {
    pub span: Span,
    pub identifier: String,
    pub historical: bool,
}

/// Paired with the `distributed_class_type` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct DClass {
    pub span: Span,
    pub identifier: String,
    pub parents: Vec<String>,
    pub fields: ClassFields,
}

/// Paired with the `optional_class_fields` production in the Context Free Grammar.
pub type ClassFields = Vec<AtomicOrMolecular>;

/// Paired with the `class_field` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum AtomicOrMolecular {
    Atomic(AtomicField),
    Molecular(MolecularField),
}

/// The Atomic Field variant of the [`AtomicOrMolecular`] enum.
#[derive(Debug, Clone)]
pub struct AtomicField {
    pub span: Span,
    pub identifier: Option<String>,
    pub keywords: Vec<String>,
    pub parameters: MethodBody,
}

impl AtomicField {
    pub fn from_named_field(field: NamedField, kw_list: KeywordList, span: Span) -> Self {
        match field {
            NamedField::ParameterField(pf) => Self {
                span,
                identifier: pf.parameter.identifier.clone(),
                keywords: kw_list,
                parameters: vec![pf.parameter],
            },
            NamedField::MethodAsField(mf) => Self {
                span,
                identifier: Some(mf.identifier),
                keywords: kw_list,
                parameters: mf.parameters,
            },
        }
    }
}

/// Paired with the `molecular_field` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct MolecularField {
    pub span: Span,
    pub identifier: String,
    pub atomic_field_identifiers: Vec<String>,
}

/// Paired with the `parameter_values` production in the Context Free Grammar.
pub type ParameterValues = Vec<TypeValue>;

/// Paired with the `struct_type` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct Struct {
    pub span: Span,
    pub identifier: String,
    pub fields: Vec<StructField>,
}

/// Paired with the `struct_field` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum StructField {
    ParameterField(ParameterField),
    MethodAsField(MethodAsField),
    Switch(Switch),
}

impl From<NamedField> for StructField {
    fn from(value: NamedField) -> Self {
        match value {
            NamedField::ParameterField(pf) => Self::ParameterField(pf),
            NamedField::MethodAsField(mf) => Self::MethodAsField(mf),
        }
    }
}

/// Paired with the `switch_type` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct Switch {
    pub span: Span,
    pub identifier: Option<String>,
    pub key_parameter: ParameterField,
    pub cases: Vec<Case>,
}

/// Paired with the `switch_case` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct Case {
    pub span: Span,
    // `None` condition means this is a default case.
    pub condition: Option<TypeValue>,
    pub fields: Vec<NamedField>,
    pub breaks: bool, // if case ends with a break
}

/// Paired with the `named_field` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum NamedField {
    ParameterField(ParameterField),
    MethodAsField(MethodAsField),
}

/// Paired with the `method_as_field` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct MethodAsField {
    pub span: Span,
    pub identifier: String,
    pub parameters: MethodBody,
}

/// Paired with the `method_body` production in the Context Free Grammar.
pub type MethodBody = Vec<Parameter>;

/// Paired with the `parameter_field` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct ParameterField {
    pub parameter: Parameter,
    pub keywords: KeywordList,
}

impl From<Parameter> for ParameterField {
    fn from(value: Parameter) -> Self {
        Self {
            parameter: value,
            keywords: vec![],
        }
    }
}

/// Paired with the `dc_keyword_list` production in the Context Free Grammar.
pub type KeywordList = Vec<String>;

/// Paired with the `parameter` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct Parameter {
    pub span: Span,
    pub data_type: NonMethodDataType,
    pub identifier: Option<String>,
    pub default_value: Option<TypeValue>,
}

impl From<NonMethodType> for Parameter {
    fn from(value: NonMethodType) -> Self {
        Self {
            span: value.span,
            data_type: value.data_type,
            identifier: value.identifier,
            default_value: None,
        }
    }
}

/// Paired with the `nonmethod_type` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct NonMethodType {
    pub span: Span,
    pub identifier: Option<String>,
    pub data_type: NonMethodDataType,
}

#[derive(Debug, Clone)]
pub enum NonMethodDataType {
    NumericType(NumericType),
    StructType(String),
    TypeWithArray(TypeWithArray),
}

/// Paired with the `type_with_array` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct TypeWithArray {
    pub span: Span,
    pub data_type: ArrayableType,
    pub array_ranges: Vec<ArrayRange>,
}

#[derive(Debug, Clone)]
pub enum ArrayableType {
    Numeric(NumericType),
    Struct(String),
    Sized(SizedTypeToken),
}

/// Paired with the `array_expansion` production in the Context Free Grammar.
pub type ArrayExpansion = (TypeValue, u32);

/// Paired with the `type_or_sized_value` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum TypeOrSizedValue {
    Type(TypeValue),
    Sized(DCToken),
}

/// Paired with the `type_value` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum TypeValue {
    I64(i64),
    Char(char),
    String(String),
    ArrayValue(Vec<ArrayExpansion>),
}

/// Paired with the `numeric_type` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub struct NumericType {
    pub span: Span,
    pub base_type: DCTypeEnum,
    // Transforms
    pub cast: Option<DataType>,
    pub modulus: Option<f64>,
    pub divisor: Option<f64>,
    pub range: Option<NumericRange>,
}

impl NumericType {
    pub fn from_type(value: DCTypeEnum, span: Span) -> Self {
        Self {
            span,
            base_type: value,
            cast: None,
            modulus: None,
            divisor: None,
            range: None,
        }
    }

    pub fn add_modulus(&mut self, value: Number) {
        match value {
            Number::Decimal(dl) => {
                self.modulus = Some(dl as f64);
            }
            Number::Float(fl) => {
                self.modulus = Some(fl);
            }
        }
    }

    pub fn add_divisor(&mut self, value: Number) {
        match value {
            Number::Decimal(dl) => {
                self.divisor = Some(dl as f64);
            }
            Number::Float(fl) => {
                self.divisor = Some(fl);
            }
        }
    }
}

/// Paired with the `numeric_range` production in the Context Free Grammar.
pub type NumericRange = std::ops::Range<f64>;

/// Paired with the `array_range` production in the Context Free Grammar.
pub type ArrayRange = std::ops::Range<f64>;

/// Paired with the `sized_type_token` production in the Context Free Grammar.
#[derive(Debug, Clone)]
pub enum SizedTypeToken {
    String,
    Blob,
    Blob32,
    Int8Array,
    Int16Array,
    Int32Array,
    UInt8Array,
    UInt16Array,
    UInt32Array,
    UInt32UInt8Array,
}

/// Paired with the `char_or_number` production in the Context Free Grammar.
#[derive(Debug, Clone, Copy)]
pub enum CharOrNumber {
    Char(char),
    I64(i64),
    F64(f64),
}

/// Paired with the 'number' production in the Context Free Grammar.
pub enum Number {
    Decimal(i64),
    Float(f64),
}

/// Paired with the `char_or_u16` production in the Context Free Grammar.
#[derive(Debug, Clone, Copy)]
pub enum CharOrU16 {
    Char(char),
    U16(u16),
}

#[derive(Debug, Clone)]
pub struct DataType {
    pub span: Span,
    pub token: DCToken,
    pub dctype: DCTypeEnum,
}

impl DataType {
    pub fn from_token(value: DCToken, span: Span) -> Self {
        Self {
            span,
            token: value.clone(),
            dctype: match value {
                DCToken::Float32T => DCTypeEnum::TFloat32,
                DCToken::Float64T => DCTypeEnum::TFloat64,
                DCToken::Int8T => DCTypeEnum::TInt8,
                DCToken::Int16T => DCTypeEnum::TInt16,
                DCToken::Int32T => DCTypeEnum::TInt32,
                DCToken::Int64T => DCTypeEnum::TInt64,
                DCToken::UInt8T => DCTypeEnum::TUInt8,
                DCToken::UInt16T => DCTypeEnum::TUInt16,
                DCToken::UInt32T => DCTypeEnum::TUInt32,
                DCToken::UInt64T => DCTypeEnum::TUInt64,
                DCToken::Int8ArrayT => DCTypeEnum::TArray,
                DCToken::Int16ArrayT => DCTypeEnum::TArray,
                DCToken::Int32ArrayT => DCTypeEnum::TArray,
                DCToken::UInt8ArrayT => DCTypeEnum::TArray,
                DCToken::UInt16ArrayT => DCTypeEnum::TArray,
                DCToken::UInt32ArrayT => DCTypeEnum::TArray,
                DCToken::UInt32UInt8ArrayT => DCTypeEnum::TArray,
                _ => panic!("DC token matches no production in CFG."),
            },
        }
    }
}