//! file for represent the available configuration properties within Zork++

//! for setting up the target compiler

use serde::{Deserialize, Serialize};

use crate::project_model;

/// [`CompilerAttribute`] - Configuration properties for

/// targeting one of the available compilers within Zork++

///

/// * `cpp_compiler` - One of the available compilers within Zork++

///     They are represented by an enumerated type named [`CppCompiler`],

///     that holds the different options where the user can choose

///

/// * `driver_path` - The specific command line terminal identifier that will

///     call the compiler's binary. ie: clang++-15 will call a specific installation

///     of Clang in the host machine corresponding to the version 15 of the compiler.

///     This entry is particularly useful in Unix based OS or MinGW environments,

///     where multiple versions of the compiler lives at the same time, and their drivers

///     are identified by some sort of name like the one in the example of above

///

/// * `cpp_standard` - An string defining the version of the ISO

///     C++ standard that should be used on the compilation process

///

/// * `std_lib` - The concrete C++ standard library (vendor specific)

///     to link the built code against

///

/// * `extra_args` - A comma separated list of strings that will be passed

///     to the generated command lines. This ones here will be placed in every

///     command line generated by Zork++.

///     For example, if *['-O3', '-Wall']*

///     are included here, this will be wired in the main command line (the executable),

///     the ones generated for compile modules (both interfaces and implementations)

///     and for the command line generated for build the specified test suite and

///     the test executable

///

/// ### Tests

///

/// ```rust

/// use zork::config_file::compiler::{

///     CompilerAttribute, CppCompiler, LanguageLevel, StdLib

/// };

///

/// const CONFIG_FILE_MOCK: &str = r#"

///     #[compiler]

///     cpp_compiler = 'CLANG'

///     cpp_standard = '20'

///     driver_path = 'clang++-19'

///     std_lib = 'libcpp'

///     std_lib_installed_dir = '/usr/include/c++/v1'

///     extra_args = ['-O3', '-Wall']

///"#;

///

/// let config: CompilerAttribute = toml::from_str(CONFIG_FILE_MOCK)

///    .expect("A failure happened parsing the Zork toml file");

///

/// assert_eq!(config.cpp_compiler, CppCompiler::CLANG);

/// assert_eq!(config.cpp_standard, LanguageLevel::CPP20);

/// assert_eq!(config.driver_path, Some("clang++-19"));

/// assert_eq!(config.std_lib, Some(StdLib::LIBCPP));

/// assert_eq!(config.std_lib_installed_dir, Some("/usr/include/c++/v1"));

/// assert_eq!(config.extra_args, Some(vec!["-O3", "-Wall"]));

/// assert_eq!(config.system_headers_path, None);

/// ```

///

/// > Note: TOML table are toml commented (#) to allow us to parse

/// > the inner attributes as the direct type that they belongs to.

/// > That commented tables aren't the real TOML, they are just there

/// > for testing and exemplification purposes of the inner attributes

/// > of the configuration file.

///

/// For a test over a real example, please look at the

/// [`zork::config_file::ZorkConfigFile`] doc-test

#[serde(deny_unknown_fields)]

pub struct CompilerAttribute<'a> {

    #[serde(borrow)]

    #[serde(borrow)]

    #[serde(borrow)]

    #[serde(borrow)]

}

/// The C++ compilers available within Zork++

    #[serde(alias = "CLANG", alias = "Clang", alias = "clang")]

    #[default]

    #[serde(alias = "MSVC", alias = "Msvc", alias = "msvc")]

    MSVC,

    #[serde(alias = "GCC", alias = "Gcc", alias = "gcc")]

    GCC,

}

// Clippy warns to prefer implementing the From trait instead of Into.

// That would require that the project model know about config_file details, which is ugly.

#[allow(clippy::from_over_into)]

impl Into<project_model::compiler::CppCompiler> for CppCompiler {

        }

}

/// The C++ ISO standard levels of the language, represented as an

/// enumerated type in Rust

///

/// Variants *2A* and *2B* represents Clang's way of

/// use the latest features available

///

/// Variant *LATEST* is the `MSVC` specific way of set the language

/// standard level to the latest features available in Microsoft's compiler

    #[serde(alias = "20")]

    #[default]

    #[serde(alias = "23")]

    CPP23,

    #[serde(alias = "2a")]

    CPP2A,

    #[serde(alias = "2b")]

    CPP2B,

    #[serde(alias = "latest")]

    LATEST,

}

// Clippy warns to prefer implementing the From trait instead of Into.

// That would require that the project model know about config_file details, which is ugly.

#[allow(clippy::from_over_into)]

impl Into<project_model::compiler::LanguageLevel> for LanguageLevel {

        }

}

/// The standard library (compiler specific) that the user

/// desires to link against

    #[serde(alias = "libstdc++", alias = "gccstdlib", alias = "libstdcpp")]

    STDLIBCPP,

    #[serde(alias = "libc++", alias = "libcpp")]

    LIBCPP,

}

// Clippy warns to prefer implementing the From trait instead of Into.

// That would require that the project model know about config_file details, which is ugly.

#[allow(clippy::from_over_into)]

impl Into<project_model::compiler::StdLib> for StdLib {

        }

}