lsp stuff (#370)

* initial shit Signed-off-by: Jess Frazelle <github@jessfraz.com> more stuff Signed-off-by: Jess Frazelle <github@jessfraz.com> more stuff Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> add lsp here Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> less than a million restarts but still 3 Signed-off-by: Jess Frazelle <github@jessfraz.com> only start once Signed-off-by: Jess Frazelle <github@jessfraz.com> some better stuff Signed-off-by: Jess Frazelle <github@jessfraz.com> initial working Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> working but jank Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> cleaner Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> operator types Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> bump version Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> udpates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> hover working Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> diagnosticcs Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> more capabilities Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> fix clippy Signed-off-by: Jess Frazelle <github@jessfraz.com> huge refactor Signed-off-by: Jess Frazelle <github@jessfraz.com> cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> remove debugging Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> u[dates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> version Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> u[dates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fix ups Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> bump Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> fix Signed-off-by: Jess Frazelle <github@jessfraz.com> fix tests Signed-off-by: Jess Frazelle <github@jessfraz.com> more passing tests Signed-off-by: Jess Frazelle <github@jessfraz.com> more fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> more fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fmt Signed-off-by: Jess Frazelle <github@jessfraz.com> start of parser Signed-off-by: Jess Frazelle <github@jessfraz.com> syntax highlighting is back Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> remove prints Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fix clippy Signed-off-by: Jess Frazelle <github@jessfraz.com> refactor recast Signed-off-by: Jess Frazelle <github@jessfraz.com> fix cljippuy Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates; Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fix whitespace tests Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> Revert "updates" This reverts commit c2c6dceb441ab8d98a590cb27bb462738f7c6df4. fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> bump Signed-off-by: Jess Frazelle <github@jessfraz.com> fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> updaetgs Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> remove printlns Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> whitespace Signed-off-by: Jess Frazelle <github@jessfraz.com> udpates Signed-off-by: Jess Frazelle <github@jessfraz.com> fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> up[dates Signed-off-by: Jess Frazelle <github@jessfraz.com> * cleanups Signed-off-by: Jess Frazelle <github@jessfraz.com> * some style changes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * remove things Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updares Signed-off-by: Jess Frazelle <github@jessfraz.com> * syntax highlighting fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * remove console log --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: Kurt Hutten <k.hutten@protonmail.ch>
2023-09-05 16:02:27 -07:00
parent e992a96d3b
commit 2604449239
53 changed files with 21112 additions and 16803 deletions
--- a/src/wasm-lib/kcl/src/docs.rs
+++ b/src/wasm-lib/kcl/src/docs.rs
@ -1,11 +1,18 @@
 //! Functions for generating docs for our stdlib functions.

 use anyhow::Result;
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
+use tower_lsp::lsp_types::{
+    CompletionItem, CompletionItemKind, CompletionItemLabelDetails, Documentation, InsertTextFormat, MarkupContent,
+    MarkupKind, ParameterInformation, ParameterLabel, SignatureHelp, SignatureInformation,
+};

 use crate::std::Primitive;

-#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, JsonSchema, ts_rs::TS)]
+#[ts(export)]
+#[serde(rename_all = "camelCase")]
 pub struct StdLibFnData {
    /// The name of the function.
    pub name: String,
@ -18,7 +25,7 @@ pub struct StdLibFnData {
    /// The args of the function.
    pub args: Vec<StdLibFnArg>,
    /// The return value of the function.
-    pub return_value: StdLibFnArg,
+    pub return_value: Option<StdLibFnArg>,
    /// If the function is unpublished.
    pub unpublished: bool,
    /// If the function is deprecated.
@ -26,7 +33,9 @@ pub struct StdLibFnData {
 }

 /// This struct defines a single argument to a stdlib function.
-#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, JsonSchema, ts_rs::TS)]
+#[ts(export)]
+#[serde(rename_all = "camelCase")]
 pub struct StdLibFnArg {
    /// The name of the argument.
    pub name: String,
@ -41,23 +50,36 @@ pub struct StdLibFnArg {
 impl StdLibFnArg {
    #[allow(dead_code)]
    pub fn get_type_string(&self) -> Result<(String, bool)> {
-        get_type_string_from_schema(&self.schema)
+        get_type_string_from_schema(&self.schema.clone())
    }

    #[allow(dead_code)]
    pub fn get_autocomplete_string(&self) -> Result<String> {
-        get_autocomplete_string_from_schema(&self.schema)
+        get_autocomplete_string_from_schema(&self.schema.clone())
    }

-    #[allow(dead_code)]
    pub fn description(&self) -> Option<String> {
-        get_description_string_from_schema(&self.schema)
+        get_description_string_from_schema(&self.schema.clone())
+    }
+}
+
+impl From<StdLibFnArg> for ParameterInformation {
+    fn from(arg: StdLibFnArg) -> Self {
+        ParameterInformation {
+            label: ParameterLabel::Simple(arg.name.to_string()),
+            documentation: arg.description().map(|description| {
+                Documentation::MarkupContent(MarkupContent {
+                    kind: MarkupKind::Markdown,
+                    value: description,
+                })
+            }),
+        }
    }
 }

 /// This trait defines functions called upon stdlib functions to generate
 /// documentation for them.
-pub trait StdLibFn {
+pub trait StdLibFn: std::fmt::Debug + Send + Sync {
    /// The name of the function.
    fn name(&self) -> String;

@ -74,7 +96,7 @@ pub trait StdLibFn {
    fn args(&self) -> Vec<StdLibFnArg>;

    /// The return value of the function.
-    fn return_value(&self) -> StdLibFnArg;
+    fn return_value(&self) -> Option<StdLibFnArg>;

    /// If the function is unpublished.
    fn unpublished(&self) -> bool;
@ -85,6 +107,9 @@ pub trait StdLibFn {
    /// The function itself.
    fn std_lib_fn(&self) -> crate::std::StdFn;

+    /// Helper function to clone the boxed trait object.
+    fn clone_box(&self) -> Box<dyn StdLibFn>;
+
    /// Return a JSON struct representing the function.
    fn to_json(&self) -> Result<StdLibFnData> {
        Ok(StdLibFnData {
@ -108,11 +133,139 @@ pub trait StdLibFn {
            }
            signature.push_str(&format!("{}: {}", arg.name, arg.type_));
        }
-        signature.push_str(") -> ");
-        signature.push_str(&self.return_value().type_);
+        signature.push(')');
+        if let Some(return_value) = self.return_value() {
+            signature.push_str(&format!(" -> {}", return_value.type_));
+        }

        signature
    }
+
+    fn to_completion_item(&self) -> CompletionItem {
+        CompletionItem {
+            label: self.name(),
+            label_details: Some(CompletionItemLabelDetails {
+                detail: Some(self.fn_signature().replace(&self.name(), "")),
+                description: None,
+            }),
+            kind: Some(CompletionItemKind::FUNCTION),
+            detail: None,
+            documentation: Some(Documentation::MarkupContent(MarkupContent {
+                kind: MarkupKind::Markdown,
+                value: if !self.description().is_empty() {
+                    format!("{}\n\n{}", self.summary(), self.description())
+                } else {
+                    self.summary()
+                },
+            })),
+            deprecated: Some(self.deprecated()),
+            preselect: None,
+            sort_text: None,
+            filter_text: None,
+            insert_text: Some(format!(
+                "{}({})",
+                self.name(),
+                self.args()
+                    .iter()
+                    .enumerate()
+                    // It is okay to unwrap here since in the `kcl-lib` tests, we would have caught
+                    // any errors in the `self`'s signature.
+                    .map(|(index, item)| {
+                        let format = item.get_autocomplete_string().unwrap();
+                        if item.type_ == "SketchGroup" || item.type_ == "ExtrudeGroup" {
+                            format!("${{{}:{}}}", index + 1, "%")
+                        } else {
+                            format!("${{{}:{}}}", index + 1, format)
+                        }
+                    })
+                    .collect::<Vec<_>>()
+                    .join(",")
+            )),
+            insert_text_format: Some(InsertTextFormat::SNIPPET),
+            insert_text_mode: None,
+            text_edit: None,
+            additional_text_edits: None,
+            command: None,
+            commit_characters: None,
+            data: None,
+            tags: None,
+        }
+    }
+
+    fn to_signature_help(&self) -> SignatureHelp {
+        // Fill this in based on the current positon of the cursor.
+        let active_parameter = None;
+
+        SignatureHelp {
+            signatures: vec![SignatureInformation {
+                label: self.name(),
+                documentation: Some(Documentation::MarkupContent(MarkupContent {
+                    kind: MarkupKind::Markdown,
+                    value: if !self.description().is_empty() {
+                        format!("{}\n\n{}", self.summary(), self.description())
+                    } else {
+                        self.summary()
+                    },
+                })),
+                parameters: Some(self.args().into_iter().map(|arg| arg.into()).collect()),
+                active_parameter,
+            }],
+            active_signature: Some(0),
+            active_parameter,
+        }
+    }
+}
+
+impl JsonSchema for dyn StdLibFn {
+    fn schema_name() -> String {
+        "StdLibFn".to_string()
+    }
+
+    fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
+        gen.subschema_for::<StdLibFnData>()
+    }
+}
+
+impl Serialize for Box<dyn StdLibFn> {
+    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        self.to_json().unwrap().serialize(serializer)
+    }
+}
+
+impl<'de> Deserialize<'de> for Box<dyn StdLibFn> {
+    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
+        let data = StdLibFnData::deserialize(deserializer)?;
+        let stdlib = crate::std::StdLib::new();
+        let stdlib_fn = stdlib
+            .get(&data.name)
+            .ok_or_else(|| serde::de::Error::custom(format!("StdLibFn {} not found", data.name)))?;
+        Ok(stdlib_fn)
+    }
+}
+
+impl ts_rs::TS for dyn StdLibFn {
+    const EXPORT_TO: Option<&'static str> = Some("bindings/StdLibFnData");
+
+    fn name() -> String {
+        "StdLibFnData".to_string()
+    }
+
+    fn dependencies() -> Vec<ts_rs::Dependency>
+    where
+        Self: 'static,
+    {
+        StdLibFnData::dependencies()
+    }
+
+    fn transparent() -> bool {
+        StdLibFnData::transparent()
+    }
+}
+
+impl Clone for Box<dyn StdLibFn> {
+    fn clone(&self) -> Box<dyn StdLibFn> {
+        self.clone_box()
+    }
 }

 pub fn get_description_string_from_schema(schema: &schemars::schema::Schema) -> Option<String> {
@ -152,11 +305,7 @@ pub fn get_type_string_from_schema(schema: &schemars::schema::Schema) -> Result<
                    if let Some(description) = get_description_string_from_schema(prop) {
                        fn_docs.push_str(&format!("\t// {}\n", description));
                    }
-                    fn_docs.push_str(&format!(
-                        "\t\"{}\": {},\n",
-                        prop_name,
-                        get_type_string_from_schema(prop)?.0,
-                    ));
+                    fn_docs.push_str(&format!("\t{}: {},\n", prop_name, get_type_string_from_schema(prop)?.0,));
                }

                fn_docs.push('}');
@ -234,7 +383,7 @@ pub fn get_autocomplete_string_from_schema(schema: &schemars::schema::Schema) ->
                        fn_docs.push_str(&format!("\t// {}\n", description));
                    }
                    fn_docs.push_str(&format!(
-                        "\t\"{}\": {},\n",
+                        "\t{}: {},\n",
                        prop_name,
                        get_autocomplete_string_from_schema(prop)?,
                    ));
@ -282,3 +431,93 @@ pub fn get_autocomplete_string_from_schema(schema: &schemars::schema::Schema) ->
        schemars::schema::Schema::Bool(_) => Ok(Primitive::Bool.to_string()),
    }
 }
+
+pub fn completion_item_from_enum_schema(
+    schema: &schemars::schema::Schema,
+    kind: CompletionItemKind,
+) -> Result<CompletionItem> {
+    // Get the docs for the schema.
+    let description = get_description_string_from_schema(schema).unwrap_or_default();
+    let schemars::schema::Schema::Object(o) = schema else {
+        anyhow::bail!("expected object schema: {:#?}", schema);
+    };
+    let Some(enum_values) = o.enum_values.as_ref() else {
+        anyhow::bail!("expected enum values: {:#?}", o);
+    };
+
+    if enum_values.len() > 1 {
+        anyhow::bail!("expected only one enum value: {:#?}", o);
+    }
+
+    if enum_values.is_empty() {
+        anyhow::bail!("expected at least one enum value: {:#?}", o);
+    }
+
+    let label = enum_values[0].to_string();
+
+    Ok(CompletionItem {
+        label,
+        label_details: None,
+        kind: Some(kind),
+        detail: Some(description.to_string()),
+        documentation: Some(Documentation::MarkupContent(MarkupContent {
+            kind: MarkupKind::Markdown,
+            value: description.to_string(),
+        })),
+        deprecated: Some(false),
+        preselect: None,
+        sort_text: None,
+        filter_text: None,
+        insert_text: None,
+        insert_text_format: None,
+        insert_text_mode: None,
+        text_edit: None,
+        additional_text_edits: None,
+        command: None,
+        commit_characters: None,
+        data: None,
+        tags: None,
+    })
+}
+
+#[cfg(test)]
+mod tests {
+    use pretty_assertions::assert_eq;
+
+    #[test]
+    fn test_serialize_function() {
+        let some_function = crate::abstract_syntax_tree_types::Function::StdLib {
+            func: Box::new(crate::std::sketch::Line),
+        };
+        let serialized = serde_json::to_string(&some_function).unwrap();
+        assert!(serialized.contains(r#"{"type":"StdLib""#));
+    }
+
+    #[test]
+    fn test_deserialize_function() {
+        let some_function_string = r#"{"type":"StdLib","func":{"name":"line","summary":"","description":"","tags":[],"returnValue":{"type":"","required":false,"name":"","schema":{}},"args":[],"unpublished":false,"deprecated":false}}"#;
+        let some_function: crate::abstract_syntax_tree_types::Function =
+            serde_json::from_str(some_function_string).unwrap();
+
+        assert_eq!(
+            some_function,
+            crate::abstract_syntax_tree_types::Function::StdLib {
+                func: Box::new(crate::std::sketch::Line),
+            }
+        );
+    }
+
+    #[test]
+    fn test_deserialize_function_show() {
+        let some_function_string = r#"{"type":"StdLib","func":{"name":"show","summary":"","description":"","tags":[],"returnValue":{"type":"","required":false,"name":"","schema":{}},"args":[],"unpublished":false,"deprecated":false}}"#;
+        let some_function: crate::abstract_syntax_tree_types::Function =
+            serde_json::from_str(some_function_string).unwrap();
+
+        assert_eq!(
+            some_function,
+            crate::abstract_syntax_tree_types::Function::StdLib {
+                func: Box::new(crate::std::Show),
+            }
+        );
+    }
+}