oak-gsgl 0.0.11

use core::fmt;
use oak_core::{Token, TokenType, UniversalTokenRole};

/// A token for the GSGL language.
pub type GsglToken = Token<GsglTokenType>;

/// Token types for the GSGL (Game Shader Graphics Language) language.
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum GsglTokenType {
    /// Root node of the AST.
    Root,
    /// A source file.
    SourceFile,
    /// A function definition.
    FunctionDefinition,
    /// A variable declaration.
    VariableDeclaration,
    /// A struct definition.
    StructDefinition,
    /// A block of code.
    Block,
    /// An `if` statement.
    IfStatement,
    /// A `for` statement.
    ForStatement,
    /// A `while` statement.
    WhileStatement,
    /// A `return` statement.
    ReturnStatement,

    /// `shader` keyword.
    Shader,
    /// `vertex` keyword.
    Vertex,
    /// `fragment` keyword.
    Fragment,
    /// `geometry` keyword.
    Geometry,
    /// `compute` keyword.
    Compute,
    /// `uniform` keyword.
    Uniform,
    /// `attribute` keyword.
    Attribute,
    /// `varying` keyword.
    Varying,
    /// `in` keyword.
    In,
    /// `out` keyword.
    Out,
    /// `inout` keyword.
    Inout,
    /// `const` keyword.
    Const,
    /// `struct` keyword.
    Struct,
    /// `if` keyword.
    If,
    /// `else` keyword.
    Else,
    /// `for` keyword.
    For,
    /// `while` keyword.
    While,
    /// `do` keyword.
    Do,
    /// `break` keyword.
    Break,
    /// `continue` keyword.
    Continue,
    /// `return` keyword.
    Return,
    /// `discard` keyword.
    Discard,
    /// `true` keyword.
    True,
    /// `false` keyword.
    False,

    /// `float` type.
    Float,
    /// `int` type.
    Int,
    /// `bool` type.
    Bool,
    /// `vec2` type.
    Vec2,
    /// `vec3` type.
    Vec3,
    /// `vec4` type.
    Vec4,
    /// `mat2` type.
    Mat2,
    /// `mat3` type.
    Mat3,
    /// `mat4` type.
    Mat4,
    /// `sampler2D` type.
    Sampler2D,
    /// `samplerCube` type.
    SamplerCube,
    /// `void` type.
    Void,

    /// An identifier.
    Identifier,
    /// A number literal.
    Number,
    /// A string literal.
    String,

    /// `+`.
    Plus,
    /// `-`.
    Minus,
    /// `*`.
    Star,
    /// `/`.
    Slash,
    /// `%`.
    Percent,
    /// `=`.
    Assign,
    /// `+=`.
    PlusAssign,
    /// `-=`.
    MinusAssign,
    /// `*=`.
    StarAssign,
    /// `/=`.
    SlashAssign,

    /// `==`.
    Eq,
    /// `!=`.
    Ne,
    /// `<`.
    Lt,
    /// `<=`.
    Le,
    /// `>`.
    Gt,
    /// `>=`.
    Ge,

    /// `&&`.
    And,
    /// `||`.
    Or,
    /// `!`.
    Not,

    /// `&`.
    BitAnd,
    /// `|`.
    BitOr,
    /// `^`.
    BitXor,
    /// `~`.
    BitNot,
    /// `<<`.
    LeftShift,
    /// `>>`.
    RightShift,

    /// `(`.
    LeftParen,
    /// `)`.
    RightParen,
    /// `{`.
    LeftBrace,
    /// `}`.
    RightBrace,
    /// `[`.
    LeftBracket,
    /// `]`.
    RightBracket,
    /// `;`.
    Semicolon,
    /// `,`.
    Comma,
    /// `.`.
    Dot,
    /// `:`.
    Colon,
    /// `?`.
    Question,
    /// `#`.
    Hash,
    /// `@`.
    At,

    /// Preprocessor directive.
    Preprocessor,
    /// `#include`.
    Include,
    /// `#define`.
    Define,
    /// `#ifdef`.
    Ifdef,
    /// `#ifndef`.
    Ifndef,
    /// `#endif`.
    Endif,
    /// `#version`.
    Version,

    /// `sin` function.
    Sin,
    /// `cos` function.
    Cos,
    /// `tan` function.
    Tan,
    /// `sqrt` function.
    Sqrt,
    /// `pow` function.
    Pow,
    /// `exp` function.
    Exp,
    /// `log` function.
    Log,
    /// `abs` function.
    Abs,
    /// `sign` function.
    Sign,
    /// `floor` function.
    Floor,
    /// `ceil` function.
    Ceil,
    /// `fract` function.
    Fract,
    /// `mod` function.
    Mod,
    /// `min` function.
    Min,
    /// `max` function.
    Max,
    /// `clamp` function.
    Clamp,
    /// `mix` function.
    Mix,
    /// `step` function.
    Step,
    /// `smoothstep` function.
    Smoothstep,
    /// `length` function.
    Length,
    /// `distance` function.
    Distance,
    /// `dot` function.
    DotProduct,
    /// `cross` function.
    Cross,
    /// `normalize` function.
    Normalize,
    /// `faceforward` function.
    Faceforward,
    /// `reflect` function.
    Reflect,
    /// `refract` function.
    Refract,

    /// Whitespace.
    Whitespace,
    /// A comment.
    Comment,
    /// A newline.
    Newline,
    /// End of stream.
    Eof,
    /// An error token.
    Error,
}

impl GsglTokenType {
    /// Checks if the kind is a keyword.
    pub fn is_keyword(self) -> bool {
        matches!(
            self,
            Self::Shader
                | Self::Vertex
                | Self::Fragment
                | Self::Geometry
                | Self::Compute
                | Self::Uniform
                | Self::Attribute
                | Self::Varying
                | Self::In
                | Self::Out
                | Self::Inout
                | Self::Const
                | Self::Struct
                | Self::If
                | Self::Else
                | Self::For
                | Self::While
                | Self::Do
                | Self::Break
                | Self::Continue
                | Self::Return
                | Self::Discard
                | Self::True
                | Self::False
        )
    }

    /// Checks if the kind is a data type.
    pub fn is_type(self) -> bool {
        matches!(self, Self::Float | Self::Int | Self::Bool | Self::Vec2 | Self::Vec3 | Self::Vec4 | Self::Mat2 | Self::Mat3 | Self::Mat4 | Self::Sampler2D | Self::SamplerCube | Self::Void)
    }

    /// Checks if the kind is an operator.
    pub fn is_operator(self) -> bool {
        matches!(
            self,
            Self::Plus
                | Self::Minus
                | Self::Star
                | Self::Slash
                | Self::Percent
                | Self::Assign
                | Self::PlusAssign
                | Self::MinusAssign
                | Self::StarAssign
                | Self::SlashAssign
                | Self::Eq
                | Self::Ne
                | Self::Lt
                | Self::Le
                | Self::Gt
                | Self::Ge
                | Self::And
                | Self::Or
                | Self::Not
                | Self::BitAnd
                | Self::BitOr
                | Self::BitXor
                | Self::BitNot
                | Self::LeftShift
                | Self::RightShift
        )
    }
}

impl GsglTokenType {
    /// Returns the string representation of this token type.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::Root => "ROOT",
            Self::SourceFile => "SOURCE_FILE",
            Self::Shader => "shader",
            Self::Vertex => "vertex",
            Self::Fragment => "fragment",
            Self::Geometry => "geometry",
            Self::Compute => "compute",
            Self::Uniform => "uniform",
            Self::Attribute => "attribute",
            Self::Varying => "varying",
            Self::In => "in",
            Self::Out => "out",
            Self::Inout => "inout",
            Self::Const => "const",
            Self::Struct => "struct",
            Self::If => "if",
            Self::Else => "else",
            Self::For => "for",
            Self::While => "while",
            Self::Do => "do",
            Self::Break => "break",
            Self::Continue => "continue",
            Self::Return => "return",
            Self::Discard => "discard",
            Self::True => "true",
            Self::False => "false",
            Self::Float => "float",
            Self::Int => "int",
            Self::Bool => "bool",
            Self::Vec2 => "vec2",
            Self::Vec3 => "vec3",
            Self::Vec4 => "vec4",
            Self::Mat2 => "mat2",
            Self::Mat3 => "mat3",
            Self::Mat4 => "mat4",
            Self::Sampler2D => "sampler2D",
            Self::SamplerCube => "samplerCube",
            Self::Void => "void",
            Self::Identifier => "IDENTIFIER",
            Self::Number => "NUMBER",
            Self::String => "STRING",
            Self::Plus => "+",
            Self::Minus => "-",
            Self::Star => "*",
            Self::Slash => "/",
            Self::Percent => "%",
            Self::Assign => "=",
            Self::PlusAssign => "+=",
            Self::MinusAssign => "-=",
            Self::StarAssign => "*=",
            Self::SlashAssign => "/=",
            Self::Eq => "==",
            Self::Ne => "!=",
            Self::Lt => "<",
            Self::Le => "<=",
            Self::Gt => ">",
            Self::Ge => ">=",
            Self::And => "&&",
            Self::Or => "||",
            Self::Not => "!",
            Self::BitAnd => "&",
            Self::BitOr => "|",
            Self::BitXor => "^",
            Self::BitNot => "~",
            Self::LeftShift => "<<",
            Self::RightShift => ">>",
            Self::LeftParen => "(",
            Self::RightParen => ")",
            Self::LeftBrace => "{",
            Self::RightBrace => "}",
            Self::LeftBracket => "[",
            Self::RightBracket => "]",
            Self::Semicolon => ";",
            Self::Comma => ",",
            Self::Dot => ".",
            Self::Colon => ":",
            Self::Question => "?",
            Self::Preprocessor => "PREPROCESSOR",
            Self::Include => "include",
            Self::Define => "define",
            Self::Ifdef => "ifdef",
            Self::Ifndef => "ifndef",
            Self::Endif => "endif",
            Self::Version => "version",
            Self::Sin => "sin",
            Self::Cos => "cos",
            Self::Tan => "tan",
            Self::Sqrt => "sqrt",
            Self::Pow => "pow",
            Self::Exp => "exp",
            Self::Log => "log",
            Self::Abs => "abs",
            Self::Sign => "sign",
            Self::Floor => "floor",
            Self::Ceil => "ceil",
            Self::Fract => "fract",
            Self::Mod => "mod",
            Self::Min => "min",
            Self::Max => "max",
            Self::Clamp => "clamp",
            Self::Mix => "mix",
            Self::Step => "step",
            Self::Smoothstep => "smoothstep",
            Self::Length => "length",
            Self::Distance => "distance",
            Self::DotProduct => "dot",
            Self::Cross => "cross",
            Self::Normalize => "normalize",
            Self::Faceforward => "faceforward",
            Self::Reflect => "reflect",
            Self::Refract => "refract",
            Self::Whitespace => "WHITESPACE",
            Self::Comment => "COMMENT",
            Self::Newline => "NEWLINE",
            Self::Eof => "EOF",
            Self::Error => "ERROR",
            _ => "UNKNOWN",
        }
    }
}

impl fmt::Display for GsglTokenType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl fmt::Debug for GsglTokenType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt::Display::fmt(self, f)
    }
}

impl TokenType for GsglTokenType {
    type Role = UniversalTokenRole;
    const END_OF_STREAM: Self = Self::Eof;

    fn is_ignored(&self) -> bool {
        matches!(self, Self::Whitespace | Self::Comment | Self::Newline)
    }

    fn role(&self) -> Self::Role {
        if self.is_keyword() {
            return UniversalTokenRole::Keyword;
        }
        if self.is_type() {
            return UniversalTokenRole::Keyword;
        }
        if self.is_operator() {
            return UniversalTokenRole::Operator;
        }

        match self {
            Self::Identifier => UniversalTokenRole::Name,
            Self::Number => UniversalTokenRole::Literal,
            Self::String => UniversalTokenRole::Literal,
            Self::True | Self::False => UniversalTokenRole::Literal,
            Self::Comment => UniversalTokenRole::Comment,
            Self::LeftParen | Self::RightParen | Self::LeftBrace | Self::RightBrace | Self::LeftBracket | Self::RightBracket => UniversalTokenRole::Punctuation,
            _ => UniversalTokenRole::None,
        }
    }
}