Support CfxLua

.github/workflows/test.yml

@@ -35,10 +35,14 @@ jobs:
         run: |
           cd full-moon
           cargo test --features luajit
+      - name: Test (CfxLua feature)
+        run: |
+          cd full-moon
+          cargo test --features cfxlua
       - name: Test (all features)
         run: |
           cd full-moon
-          cargo test --features luau,lua52,lua53,lua54,luajit
+          cargo test --features luau,lua52,lua53,lua54,luajit,cfxlua
       - name: Test (no default features)
         run: |
           cd full-moon

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-  "rust-analyzer.cargo.features": ["luau", "lua52", "lua53", "lua54", "luau"]
+  "rust-analyzer.cargo.features": ["luau", "lua52", "lua53", "lua54", "luau", "cfxlua"]
 }

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Added
+- Implemented CFX Lua as a feature flag - `cfxlua`
+  - Compound Operators: `+=, -=, *=, /=, <<=, >>=, &=, |=, and ^=`
+  - Safe Navigation e.g. `t?.x?.y == nil`
+  - In Unpacking e.g. `local a, b, c = t` is equivalent to `local a, b, c = t.a, t.b, t.c`
+  - Set Constructors e.g. `t = { .x, .y }` is equivalent to `t = { x = true, y = true }`
+  - C-Style Comments (single & multiline) e.g. `/* comment */`
+  - Compile Time Jenkins' Hashes e.g. ``` `Hello, World!` -> 1395890823``` 
+
 ## [1.2.0] - 2025-01-09
 
 ### Added

README.md

@@ -5,7 +5,7 @@
 	</h1>
 </div>
 
-A lossless Lua 5.1 / 5.2 / 5.3 / 5.4 / [Luau](https://luau-lang.org/) parser written in Rust.
+A lossless Lua 5.1 / 5.2 / 5.3 / 5.4 / [Luau](https://luau-lang.org/) / [CfxLua](https://docs.fivem.net/docs/scripting-manual/runtimes/lua/) parser written in Rust.
 
 
 ## Lossless?

full-moon/Cargo.toml

@@ -7,12 +7,12 @@ license = "MPL-2.0"
 readme = "README.md"
 repository = "https://github.com/Kampfkarren/full-moon"
 categories = ["parsing"]
-keywords = ["lua", "parser", "lua51", "lua52", "luau"]
+keywords = ["lua", "parser", "lua51", "lua52", "luau", "cfxlua"]
 edition = "2021"
 
 [package.metadata.docs.rs]
-# Build Locally: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --features luau,lua52,lua53,lua54,luajit  --no-deps --open
-features = ["luau", "lua52", "lua53", "lua54", "luajit"]
+# Build Locally: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --features luau,lua52,lua53,lua54,luajit,cfxlua  --no-deps --open
+features = ["luau", "lua52", "lua53", "lua54", "luajit", "cfxlua"]
 rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
@@ -23,6 +23,7 @@ lua52 = []
 lua53 = ["lua52"]
 lua54 = ["lua53"]
 luajit = []
+cfxlua = ["lua54"]
 no-source-tests = []
 
 [dependencies]

full-moon/src/ast/compound.rs

@@ -0,0 +1,140 @@
+use crate::ast::{Expression, Var};
+use crate::tokenizer::{Symbol, TokenReference};
+use derive_more::Display;
+use full_moon_derive::{Node, Visit};
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Debug, Display, PartialEq, Eq, Node, Visit)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
+#[non_exhaustive]
+#[allow(missing_docs)]
+#[display("{_0}")]
+/// Compound operators, such as X += Y or X -= Y
+pub enum CompoundOp {
+    PlusEqual(TokenReference),
+    MinusEqual(TokenReference),
+    StarEqual(TokenReference),
+    SlashEqual(TokenReference),
+    CaretEqual(TokenReference),
+
+    // luau sepcific
+    DoubleSlashEqual(TokenReference),
+    PercentEqual(TokenReference),
+    TwoDotsEqual(TokenReference),
+
+    // cfxlua sepcific
+    LeftShift(TokenReference),
+    RightShift(TokenReference),
+    BitwiseAndAssignment(TokenReference),
+    BitwiseOrAssignment(TokenReference),
+}
+
+impl CompoundOp {
+    /// The token associated with the operator
+    pub fn token(&self) -> &TokenReference {
+        match self {
+            Self::PlusEqual(token)
+            | Self::MinusEqual(token)
+            | Self::StarEqual(token)
+            | Self::SlashEqual(token)
+            | Self::DoubleSlashEqual(token)
+            | Self::PercentEqual(token)
+            | Self::CaretEqual(token)
+            | Self::TwoDotsEqual(token)
+            | Self::LeftShift(token)
+            | Self::RightShift(token)
+            | Self::BitwiseAndAssignment(token)
+            | Self::BitwiseOrAssignment(token) => token,
+        }
+    }
+
+    pub(crate) fn from_token(token: TokenReference) -> Self {
+        if token.is_symbol(Symbol::PlusEqual) {
+            return Self::PlusEqual(token);
+        } else if token.is_symbol(Symbol::MinusEqual) {
+            return Self::MinusEqual(token);
+        } else if token.is_symbol(Symbol::StarEqual) {
+            return Self::StarEqual(token);
+        } else if token.is_symbol(Symbol::SlashEqual) {
+            return Self::SlashEqual(token);
+        } else if token.is_symbol(Symbol::CaretEqual) {
+            return Self::CaretEqual(token);
+        }
+
+        #[cfg(feature = "luau")]
+        if token.is_symbol(Symbol::DoubleSlashEqual) {
+            return Self::DoubleSlashEqual(token);
+        } else if token.is_symbol(Symbol::PercentEqual) {
+            return Self::PercentEqual(token);
+        } else if token.is_symbol(Symbol::TwoDotsEqual) {
+            return Self::TwoDotsEqual(token);
+        }
+
+        #[cfg(feature = "cfxlua")]
+        if token.is_symbol(Symbol::LeftShift) {
+            return Self::LeftShift(token);
+        } else if token.is_symbol(Symbol::RightShift) {
+            return Self::RightShift(token);
+        } else if token.is_symbol(Symbol::BitwiseAndAssignment) {
+            return Self::BitwiseAndAssignment(token);
+        } else if token.is_symbol(Symbol::BitwiseOrAssignment) {
+            return Self::BitwiseOrAssignment(token);
+        }
+
+        unreachable!("converting an unknown token into a compound operator")
+    }
+}
+
+/// A Compound Assignment statement, such as `x += 1` or `x -= 1`
+#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
+#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
+#[display("{lhs}{compound_operator}{rhs}")]
+pub struct CompoundAssignment {
+    pub(crate) lhs: Var,
+    pub(crate) compound_operator: CompoundOp,
+    pub(crate) rhs: Expression,
+}
+
+impl CompoundAssignment {
+    /// Creates a new CompoundAssignment from the left and right hand side
+    pub fn new(lhs: Var, compound_operator: CompoundOp, rhs: Expression) -> Self {
+        Self {
+            lhs,
+            compound_operator,
+            rhs,
+        }
+    }
+
+    /// The variable assigned to, the `x` part of `x += 1`
+    pub fn lhs(&self) -> &Var {
+        &self.lhs
+    }
+
+    /// The operator used, the `+=` part of `x += 1`
+    pub fn compound_operator(&self) -> &CompoundOp {
+        &self.compound_operator
+    }
+
+    /// The value being assigned, the `1` part of `x += 1`
+    pub fn rhs(&self) -> &Expression {
+        &self.rhs
+    }
+
+    /// Returns a new CompoundAssignment with the given variable being assigned to
+    pub fn with_lhs(self, lhs: Var) -> Self {
+        Self { lhs, ..self }
+    }
+
+    /// Returns a new CompoundAssignment with the given operator used
+    pub fn with_compound_operator(self, compound_operator: CompoundOp) -> Self {
+        Self {
+            compound_operator,
+            ..self
+        }
+    }
+
+    /// Returns a new CompoundAssignment with the given value being assigned
+    pub fn with_rhs(self, rhs: Expression) -> Self {
+        Self { rhs, ..self }
+    }
+}

full-moon/src/ast/luau.rs

@@ -893,114 +893,9 @@ impl ExportedTypeFunction {
     }
 }
 
-#[derive(Clone, Debug, Display, PartialEq, Eq, Node, Visit)]
-#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
-#[non_exhaustive]
-#[allow(missing_docs)]
-#[display("{_0}")]
-/// Compound operators, such as X += Y or X -= Y
-pub enum CompoundOp {
-    PlusEqual(TokenReference),
-    MinusEqual(TokenReference),
-    StarEqual(TokenReference),
-    SlashEqual(TokenReference),
-    DoubleSlashEqual(TokenReference),
-    PercentEqual(TokenReference),
-    CaretEqual(TokenReference),
-    TwoDotsEqual(TokenReference),
-}
-
-impl CompoundOp {
-    /// The token associated with the operator
-    pub fn token(&self) -> &TokenReference {
-        match self {
-            Self::PlusEqual(token)
-            | Self::MinusEqual(token)
-            | Self::StarEqual(token)
-            | Self::SlashEqual(token)
-            | Self::DoubleSlashEqual(token)
-            | Self::PercentEqual(token)
-            | Self::CaretEqual(token)
-            | Self::TwoDotsEqual(token) => token,
-        }
-    }
-
-    pub(crate) fn from_token(token: TokenReference) -> Self {
-        if token.is_symbol(Symbol::PlusEqual) {
-            Self::PlusEqual(token)
-        } else if token.is_symbol(Symbol::MinusEqual) {
-            Self::MinusEqual(token)
-        } else if token.is_symbol(Symbol::StarEqual) {
-            Self::StarEqual(token)
-        } else if token.is_symbol(Symbol::SlashEqual) {
-            Self::SlashEqual(token)
-        } else if token.is_symbol(Symbol::DoubleSlashEqual) {
-            Self::DoubleSlashEqual(token)
-        } else if token.is_symbol(Symbol::PercentEqual) {
-            Self::PercentEqual(token)
-        } else if token.is_symbol(Symbol::CaretEqual) {
-            Self::CaretEqual(token)
-        } else if token.is_symbol(Symbol::TwoDotsEqual) {
-            Self::TwoDotsEqual(token)
-        } else {
-            unreachable!("converting an unknown token into a compound operator")
-        }
-    }
-}
-
-/// A Compound Assignment statement, such as `x += 1` or `x -= 1`
-#[derive(Clone, Debug, Display, PartialEq, Node, Visit)]
-#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
-#[display("{lhs}{compound_operator}{rhs}")]
-pub struct CompoundAssignment {
-    pub(crate) lhs: Var,
-    pub(crate) compound_operator: CompoundOp,
-    pub(crate) rhs: Expression,
-}
-
-impl CompoundAssignment {
-    /// Creates a new CompoundAssignment from the left and right hand side
-    pub fn new(lhs: Var, compound_operator: CompoundOp, rhs: Expression) -> Self {
-        Self {
-            lhs,
-            compound_operator,
-            rhs,
-        }
-    }
-
-    /// The variable assigned to, the `x` part of `x += 1`
-    pub fn lhs(&self) -> &Var {
-        &self.lhs
-    }
-
-    /// The operator used, the `+=` part of `x += 1`
-    pub fn compound_operator(&self) -> &CompoundOp {
-        &self.compound_operator
-    }
-
-    /// The value being assigned, the `1` part of `x += 1`
-    pub fn rhs(&self) -> &Expression {
-        &self.rhs
-    }
-
-    /// Returns a new CompoundAssignment with the given variable being assigned to
-    pub fn with_lhs(self, lhs: Var) -> Self {
-        Self { lhs, ..self }
-    }
-
-    /// Returns a new CompoundAssignment with the given operator used
-    pub fn with_compound_operator(self, compound_operator: CompoundOp) -> Self {
-        Self {
-            compound_operator,
-            ..self
-        }
-    }
-
-    /// Returns a new CompoundAssignment with the given value being assigned
-    pub fn with_rhs(self, rhs: Expression) -> Self {
-        Self { rhs, ..self }
-    }
-}
+/*
+    CompoundOp and CompoundAssignment have been moved to `compound.rs´, since CfxLua makes use of them as well.
+*/
 
 /// An if statement
 #[derive(Clone, Debug, Display, PartialEq, Node, Visit)]