Function types (#6891)

* Change Fn to fn for function types

Signed-off-by: Nick Cameron <[email protected]>

* Support args and return types in function types

Signed-off-by: Nick Cameron <[email protected]>

* Use fancy function types in the docs

Signed-off-by: Nick Cameron <[email protected]>

---------

Signed-off-by: Nick Cameron <[email protected]>

Author: nrc

docs/kcl-std/functions/std-array-map.md

@@ -10,7 +10,7 @@ Apply a function to every element of a list.
 ```kcl
 map(
   @array: [any],
-  f: Fn,
+  f: fn(any): any,
 ): [any]
 ```
 
@@ -22,7 +22,7 @@ Given a list like `[a, b, c]`, and a function like `f`, returns
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
 | `array` | [`[any]`](/docs/kcl-std/types/std-types-any) | Input array. The output array is this input array, but every element has had the function `f` run on it. | Yes |
-| `f` | [`Fn`](/docs/kcl-std/types/std-types-Fn) | A function. The output array is just the input array, but `f` has been run on every item. | Yes |
+| `f` | [`fn(any): any`](/docs/kcl-std/types/std-types-fn) | A function. The output array is just the input array, but `f` has been run on every item. | Yes |
 
 ### Returns
 

docs/kcl-std/functions/std-array-reduce.md

@@ -11,7 +11,7 @@ layout: manual
 reduce(
   @array: [any],
   initial: any,
-  f: Fn,
+  f: fn(any, accum: any): any,
 ): [any]
 ```
 
@@ -24,7 +24,7 @@ using the previous value and the element.
 |----------|------|-------------|----------|
 | `array` | [`[any]`](/docs/kcl-std/types/std-types-any) | Each element of this array gets run through the function `f`, combined with the previous output from `f`, and then used for the next run. | Yes |
 | `initial` | [`any`](/docs/kcl-std/types/std-types-any) | The first time `f` is run, it will be called with the first item of `array` and this initial starting value. | Yes |
-| `f` | [`Fn`](/docs/kcl-std/types/std-types-Fn) | Run once per item in the input `array`. This function takes an item from the array, and the previous output from `f` (or `initial` on the very first run). The final time `f` is run, its output is returned as the final output from `reduce`. | Yes |
+| `f` | [`fn(any, accum: any): any`](/docs/kcl-std/types/std-types-fn) | Run once per item in the input `array`. This function takes an item from the array, and the previous output from `f` (or `initial` on the very first run). The final time `f` is run, its output is returned as the final output from `reduce`. | Yes |
 
 ### Returns
 

docs/kcl-std/index.md

@@ -140,13 +140,13 @@ See also the [types overview](/docs/kcl-lang/types)
 
 * [**Primitive types**](/docs/kcl-lang/types)
   * [`End`](/docs/kcl-lang/types#End)
-  * [`Fn`](/docs/kcl-std/types/std-types-Fn)
   * [`ImportedGeometry`](/docs/kcl-std/types/std-types-ImportedGeometry)
   * [`Start`](/docs/kcl-lang/types#Start)
   * [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator)
   * [`TagIdentifier`](/docs/kcl-lang/types#TagIdentifier)
   * [`any`](/docs/kcl-std/types/std-types-any)
   * [`bool`](/docs/kcl-std/types/std-types-bool)
+  * [`fn`](/docs/kcl-std/types/std-types-fn)
   * [`number`](/docs/kcl-std/types/std-types-number)
   * [`string`](/docs/kcl-std/types/std-types-string)
   * [`tag`](/docs/kcl-std/types/std-types-tag)

docs/kcl-std/modules/std-types.md

@@ -17,7 +17,6 @@ Types can (optionally) be used to describe a function's arguments and returned v
 * [`Axis3d`](/docs/kcl-std/types/std-types-Axis3d)
 * [`Edge`](/docs/kcl-std/types/std-types-Edge)
 * [`Face`](/docs/kcl-std/types/std-types-Face)
-* [`Fn`](/docs/kcl-std/types/std-types-Fn)
 * [`Helix`](/docs/kcl-std/types/std-types-Helix)
 * [`ImportedGeometry`](/docs/kcl-std/types/std-types-ImportedGeometry)
 * [`Plane`](/docs/kcl-std/types/std-types-Plane)
@@ -27,6 +26,7 @@ Types can (optionally) be used to describe a function's arguments and returned v
 * [`Solid`](/docs/kcl-std/types/std-types-Solid)
 * [`any`](/docs/kcl-std/types/std-types-any)
 * [`bool`](/docs/kcl-std/types/std-types-bool)
+* [`fn`](/docs/kcl-std/types/std-types-fn)
 * [`number`](/docs/kcl-std/types/std-types-number)
 * [`string`](/docs/kcl-std/types/std-types-string)
 * [`tag`](/docs/kcl-std/types/std-types-tag)

docs/kcl-std/types/std-types-Fn.md renamed to docs/kcl-std/types/std-types-fn.md

@@ -1,5 +1,5 @@
 ---
-title: "Fn"
+title: "fn"
 subtitle: "Type in std::types"
 excerpt: "The type of any function in KCL."
 layout: manual

rust/kcl-lib/src/docs/gen_std_tests.rs

@@ -674,6 +674,8 @@ fn cleanup_type_string(input: &str, fmt_for_text: bool) -> String {
 
             if fmt_for_text && ty.starts_with("number") {
                 format!("[{prefix}{ty}{suffix}](/docs/kcl-std/types/std-types-number)")
+            } else if fmt_for_text && ty.starts_with("fn") {
+                format!("[{prefix}{ty}{suffix}](/docs/kcl-std/types/std-types-fn)")
             } else if fmt_for_text && SPECIAL_TYPES.contains(&ty) {
                 format!("[{prefix}{ty}{suffix}](/docs/kcl-lang/types#{ty})")
             } else if fmt_for_text && DECLARED_TYPES.contains(&ty) {

rust/kcl-lib/src/docs/mod.rs

@@ -39,7 +39,7 @@ const DECLARED_TYPES: [&str; 17] = [
     "Axis2d",
     "Axis3d",
     "ImportedGeometry",
-    "Fn",
+    "fn",
 ];
 
 lazy_static::lazy_static! {

rust/kcl-lib/src/execution/types.rs

@@ -183,7 +183,7 @@ impl RuntimeType {
             AstPrimitiveType::Named(name) => Self::from_alias(&name.name, exec_state, source_range)?,
             AstPrimitiveType::Tag => RuntimeType::Primitive(PrimitiveType::Tag),
             AstPrimitiveType::ImportedGeometry => RuntimeType::Primitive(PrimitiveType::ImportedGeometry),
-            AstPrimitiveType::Function => RuntimeType::Primitive(PrimitiveType::Function),
+            AstPrimitiveType::Function(_) => RuntimeType::Primitive(PrimitiveType::Function),
         })
     }
 

rust/kcl-lib/src/parsing/ast/digest.rs

@@ -2,8 +2,8 @@ use sha2::{Digest as DigestTrait, Sha256};
 
 use crate::parsing::ast::types::{
     Annotation, ArrayExpression, ArrayRangeExpression, AscribedExpression, BinaryExpression, BinaryPart, BodyItem,
-    CallExpressionKw, DefaultParamVal, ElseIf, Expr, ExpressionStatement, FunctionExpression, Identifier, IfExpression,
-    ImportItem, ImportSelector, ImportStatement, ItemVisibility, KclNone, LabelledExpression, Literal,
+    CallExpressionKw, DefaultParamVal, ElseIf, Expr, ExpressionStatement, FunctionExpression, FunctionType, Identifier,
+    IfExpression, ImportItem, ImportSelector, ImportStatement, ItemVisibility, KclNone, LabelledExpression, Literal,
     LiteralIdentifier, LiteralValue, MemberExpression, MemberObject, Name, ObjectExpression, ObjectProperty, Parameter,
     PipeExpression, PipeSubstitution, PrimitiveType, Program, ReturnStatement, TagDeclarator, Type, TypeDeclaration,
     UnaryExpression, VariableDeclaration, VariableDeclarator, VariableKind,
@@ -233,13 +233,28 @@ impl PrimitiveType {
             PrimitiveType::Boolean => hasher.update(b"bool"),
             PrimitiveType::Tag => hasher.update(b"tag"),
             PrimitiveType::ImportedGeometry => hasher.update(b"ImportedGeometry"),
-            PrimitiveType::Function => hasher.update(b"Fn"),
+            PrimitiveType::Function(f) => hasher.update(f.compute_digest()),
         }
 
         hasher.finalize().into()
     }
 }
 
+impl FunctionType {
+    compute_digest!(|slf, hasher| {
+        if let Some(u) = &mut slf.unnamed_arg {
+            hasher.update(u.compute_digest());
+        }
+        slf.named_args.iter_mut().for_each(|(a, t)| {
+            a.compute_digest();
+            t.compute_digest();
+        });
+        if let Some(r) = &mut slf.return_type {
+            hasher.update(r.compute_digest());
+        }
+    });
+}
+
 impl Parameter {
     compute_digest!(|slf, hasher| {
         hasher.update(slf.identifier.compute_digest());

rust/kcl-lib/src/parsing/ast/types/mod.rs

@@ -3199,8 +3199,8 @@ pub enum PrimitiveType {
     Tag,
     /// Imported from other CAD system.
     ImportedGeometry,
-    /// `Fn`, type of functions.
-    Function,
+    /// `fn`, type of functions.
+    Function(FunctionType),
     /// An identifier used as a type (not really a primitive type, but whatever).
     Named(Node<Identifier>),
 }
@@ -3215,7 +3215,6 @@ impl PrimitiveType {
             ("number", None) => Some(PrimitiveType::Number(NumericSuffix::None)),
             ("number", Some(s)) => Some(PrimitiveType::Number(s)),
             ("ImportedGeometry", None) => Some(PrimitiveType::ImportedGeometry),
-            ("Fn", None) => Some(PrimitiveType::Function),
             _ => None,
         }
     }
@@ -3236,12 +3235,57 @@ impl fmt::Display for PrimitiveType {
             PrimitiveType::Boolean => write!(f, "bool"),
             PrimitiveType::Tag => write!(f, "tag"),
             PrimitiveType::ImportedGeometry => write!(f, "ImportedGeometry"),
-            PrimitiveType::Function => write!(f, "Fn"),
+            PrimitiveType::Function(t) => {
+                write!(f, "fn")?;
+                if t.unnamed_arg.is_some() || !t.named_args.is_empty() || t.return_type.is_some() {
+                    write!(f, "(")?;
+                    if let Some(u) = &t.unnamed_arg {
+                        write!(f, "{u}")?;
+                        if !t.named_args.is_empty() {
+                            write!(f, ", ")?;
+                        }
+                    }
+                    for (i, (a, t)) in t.named_args.iter().enumerate() {
+                        if i != 0 {
+                            write!(f, ", ")?;
+                        }
+                        write!(f, "{}: {t}", a.name)?;
+                    }
+                    write!(f, ")")?;
+                    if let Some(r) = &t.return_type {
+                        write!(f, ": {r}")?;
+                    }
+                }
+                Ok(())
+            }
             PrimitiveType::Named(n) => write!(f, "{}", n.name),
         }
     }
 }
 
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
+#[ts(export)]
+pub struct FunctionType {
+    pub unnamed_arg: Option<BoxNode<Type>>,
+    pub named_args: Vec<(Node<Identifier>, Node<Type>)>,
+    pub return_type: Option<BoxNode<Type>>,
+
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    #[ts(optional)]
+    pub digest: Option<Digest>,
+}
+
+impl FunctionType {
+    pub fn empty_fn_type() -> Self {
+        FunctionType {
+            unnamed_arg: None,
+            named_args: Vec::new(),
+            return_type: None,
+            digest: None,
+        }
+    }
+}
+
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
 #[ts(export)]
 #[serde(tag = "type")]
@@ -3293,7 +3337,7 @@ impl fmt::Display for Type {
                     } else {
                         write!(f, ",")?;
                     }
-                    write!(f, "{}: ", p.identifier.name)?;
+                    write!(f, " {}:", p.identifier.name)?;
                     if let Some(ty) = &p.type_ {
                         write!(f, " {}", ty.inner)?;
                     }