field gates, nesting nest statements, doc comments

Author: macovedj

crates/wit-component/src/encoding/wit/v2.rs

@@ -1,5 +1,5 @@
 use crate::encoding::types::{FunctionKey, ValtypeEncoder};
-use anyhow::{bail, Result};
+use anyhow::Result;
 use indexmap::IndexSet;
 use std::collections::HashMap;
 use std::mem;
@@ -226,6 +226,20 @@ impl InterfaceEncoder<'_> {
                 .export(name, ComponentTypeRef::Func(ty));
         }
         let mut instance = self.pop_instance();
+        self.encode_nested(iface, &mut instance)?;
+
+        let idx = self.outer.type_count();
+        self.outer.ty().instance(&instance);
+        self.import_map.insert(interface, self.instances);
+        self.instances += 1;
+        Ok(idx)
+    }
+
+    fn encode_nested<'a>(
+        &'a mut self,
+        iface: &Interface,
+        instance: &'a mut InstanceType,
+    ) -> Result<&mut InstanceType> {
         for (orig_name, _) in &iface.nested {
             let mut pkg_parts = orig_name.split("/");
             let pkg = pkg_parts.next().expect("expected projection");
@@ -255,23 +269,40 @@ impl InterfaceEncoder<'_> {
                 }
                 inst.encode_valtype(self.resolve, &Type::Id(*id))?;
             }
-            for (_, _) in &nested_iface.nested {
-                bail!("Using `nest` in a nested interface is not yet supported");
-            }
             let ty = instance.ty();
-            let nested = inst.pop_instance();
-            ty.instance(&nested);
+            let nested_instance = &mut inst.pop_instance();
+            for (orig_name, _) in &nested_iface.nested {
+                let mut nest_package_parts = orig_name.split("/");
+                let nest_pkg = nest_package_parts.next().unwrap();
+                let nest_iface = nest_package_parts.next().unwrap();
+                let mut parts = nest_pkg.split(":");
+                let ns = parts.next().unwrap();
+                let name = parts.next().unwrap();
+                let name = PackageName {
+                    namespace: ns.to_string(),
+                    name: name.to_string(),
+                    version: None,
+                };
+                let nest_pkg_id = self.resolve.package_names.get(&name).unwrap();
+                let nested_package = &self.resolve.packages[*nest_pkg_id];
+                let myguy = nested_package.interfaces.get(nest_iface).unwrap();
+                let nest = &self.resolve.interfaces[*myguy];
+                let mut clone = nested_instance.clone();
+                let deep_instance = self.encode_nested(nest, &mut clone)?;
+                let deep_ty = nested_instance.ty();
+                deep_ty.instance(&deep_instance);
+                nested_instance.export(
+                    orig_name,
+                    ComponentTypeRef::Instance(deep_instance.type_count()),
+                );
+            }
+            ty.instance(&nested_instance);
             instance.export(
                 orig_name,
                 ComponentTypeRef::Instance(instance.type_count() - 1),
             );
         }
-
-        let idx = self.outer.type_count();
-        self.outer.ty().instance(&instance);
-        self.import_map.insert(interface, self.instances);
-        self.instances += 1;
-        Ok(idx)
+        Ok(instance)
     }
 
     fn push_instance(&mut self) {

crates/wit-component/src/printing.rs

@@ -84,6 +84,8 @@ impl WitPrinter {
                 self.output.push_str(" {\n");
                 let nested = &resolve.interfaces[*id].nested;
                 for item in nested {
+                    self.print_stability(&item.1.stability);
+                    self.print_docs(&item.1.docs);
                     self.output.push_str("nest ");
                     self.print_name(item.0);
                     self.output.push_str(";\n")

crates/wit-component/tests/interfaces/doc-comments.wat

@@ -66,7 +66,7 @@
     )
   )
   (export (;5;) "coverage-world" (type 4))
-  (@custom "package-docs" "\00{\22docs\22:\22package docs;\22,\22worlds\22:{\22coverage-world\22:{\22docs\22:\22world docs\22,\22interfaces\22:{\22i\22:{\22docs\22:\22world inline interface docs\22,\22funcs\22:{\22f\22:\22inline interface func docs\22},\22types\22:{\22t\22:{\22docs\22:\22inline interface typedef docs\22}}}},\22types\22:{\22t\22:{\22docs\22:\22world typedef docs\22}},\22funcs\22:{\22imp\22:\22world func import docs\22,\22exp\22:\22world func export docs\22}}},\22interfaces\22:{\22coverage-iface\22:{\22docs\22:\22interface docs\22,\22funcs\22:{\22[constructor]res\22:\22constructor docs\22,\22[method]res.m\22:\22method docs\22,\22[static]res.s\22:\22static func docs\22,\22f\22:\22interface func docs\22},\22types\22:{\22t\22:{\22docs\22:\22basic typedef docs\22},\22r\22:{\22docs\22:\22record typedef docs\22,\22items\22:{\22f1\22:\22record field docs\22}},\22fl\22:{\22items\22:{\22f1\22:\22flag docs\22}},\22v\22:{\22items\22:{\22c1\22:\22variant case docs\22}},\22e\22:{\22items\22:{\22c1\22:\22enum case docs\22}}}},\22other-comment-forms\22:{\22docs\22:\22other comment forms\5cn    multi-line block\22,\22funcs\22:{\22multiple-lines-split\22:\22one doc line\5cnnon-doc in the middle\5cnanother doc line\22,\22mixed-forms\22:\22mixed forms; line doc\5cnplus block doc\5cn      multi-line\22}}}}")
+  (@custom "package-docs" "\00{\22docs\22:\22package docs;\22,\22worlds\22:{\22coverage-world\22:{\22docs\22:\22world docs\22,\22interfaces\22:{\22i\22:{\22docs\22:\22world inline interface docs\22,\22funcs\22:{\22f\22:\22inline interface func docs\22},\22types\22:{\22t\22:{\22docs\22:\22inline interface typedef docs\22}},\22nested\22:{}}},\22types\22:{\22t\22:{\22docs\22:\22world typedef docs\22}},\22funcs\22:{\22imp\22:\22world func import docs\22,\22exp\22:\22world func export docs\22}}},\22interfaces\22:{\22coverage-iface\22:{\22docs\22:\22interface docs\22,\22funcs\22:{\22[constructor]res\22:\22constructor docs\22,\22[method]res.m\22:\22method docs\22,\22[static]res.s\22:\22static func docs\22,\22f\22:\22interface func docs\22},\22types\22:{\22t\22:{\22docs\22:\22basic typedef docs\22},\22r\22:{\22docs\22:\22record typedef docs\22,\22items\22:{\22f1\22:\22record field docs\22}},\22fl\22:{\22items\22:{\22f1\22:\22flag docs\22}},\22v\22:{\22items\22:{\22c1\22:\22variant case docs\22}},\22e\22:{\22items\22:{\22c1\22:\22enum case docs\22}}},\22nested\22:{}},\22other-comment-forms\22:{\22docs\22:\22other comment forms\5cn    multi-line block\22,\22funcs\22:{\22multiple-lines-split\22:\22one doc line\5cnnon-doc in the middle\5cnanother doc line\22,\22mixed-forms\22:\22mixed forms; line doc\5cnplus block doc\5cn      multi-line\22},\22nested\22:{}}}}")
   (@producers
     (processed-by "wit-component" "$CARGO_PKG_VERSION")
   )

crates/wit-component/tests/interfaces/nested.wat

@@ -21,6 +21,13 @@
             (instance
               (type (;0;) (record (field "foo" string)))
               (export (;1;) "nestrecord" (type (eq 0)))
+              (type (;2;)
+                (instance
+                  (type (;0;) (record (field "foo" string)))
+                  (export (;1;) "nestrecord" (type (eq 0)))
+                )
+              )
+              (export (;0;) "foo:nestnest/deep" (instance (type 2)))
             )
           )
           (export (;0;) "foo:nestee/things" (instance (type 5)))
@@ -102,7 +109,7 @@
     )
   )
   (export (;5;) "my-world" (type 4))
-  (@custom "package-docs" "\01{\22interfaces\22:{\22something\22:{\22types\22:{\22my-record\22:{\22stability\22:{\22stable\22:{\22since\22:\221.0.0\22}}}}}}}")
+  (@custom "package-docs" "\01{\22interfaces\22:{\22something\22:{\22types\22:{\22my-record\22:{\22stability\22:{\22stable\22:{\22since\22:\221.0.0\22}}}},\22nested\22:{\22foo:nestee/things\22:{\22docs\22:{\22contents\22:\22nesting can be documented\22},\22stability\22:\22unknown\22},\22foo:nestee/more\22:{\22docs\22:{\22contents\22:null},\22stability\22:{\22stable\22:{\22since\22:\221.0.0\22}}}}}}}")
   (@producers
     (processed-by "wit-component" "$CARGO_PKG_VERSION")
   )

crates/wit-component/tests/interfaces/nested/deps/nestee.wit

@@ -1,6 +1,9 @@
 package foo:nestee;
 
 interface things {
+  //nesting can be documented
+  @since(version = 1.0.0)
+  nest foo:nestnest/deep;
   record nestrecord {
     foo: string
   }

crates/wit-component/tests/interfaces/nested/nested.wit

@@ -2,7 +2,9 @@ package foo:thing;
 
 interface something {
   use foo:nestee/usable.{usable-record};
+  //nesting can be documented
   nest foo:nestee/things;
+  @since(version = 1.0.0)
   nest foo:nestee/more;
   @since(version = 1.0.0)
   record my-record {

crates/wit-component/tests/interfaces/nested/thing.wit.print

@@ -1,7 +1,9 @@
 package foo:thing;
 
 interface something {
+  /// nesting can be documented
   nest foo:nestee/things;
+  @since(version = 1.0.0)
   nest foo:nestee/more;
   use foo:nestee/usable.{usable-record};
 

crates/wit-component/tests/interfaces/resources.wat

@@ -180,7 +180,7 @@
     )
   )
   (export (;11;) "implicit-own-handles3" (type 10))
-  (@custom "package-docs" "\00{\22worlds\22:{\22implicit-own-handles3\22:{\22types\22:{\22a\22:{\22docs\22:\22there should only be one `list` type despite there looking like two\5cnlist types here\22}}}},\22interfaces\22:{\22implicit-own-handles2\22:{\22types\22:{\22a\22:{\22docs\22:\22the `own` return and list param should be the same `own`\22},\22b\22:{\22docs\22:\22same as above, even when the `list<b>` implicitly-defined `own` comes\5cnbefore an explicitly defined `own`\22},\22c\22:{\22docs\22:\22same as the above, the `own` argument should have the same type as the\5cnreturn value\22}}}}}")
+  (@custom "package-docs" "\00{\22worlds\22:{\22implicit-own-handles3\22:{\22types\22:{\22a\22:{\22docs\22:\22there should only be one `list` type despite there looking like two\5cnlist types here\22}}}},\22interfaces\22:{\22implicit-own-handles2\22:{\22types\22:{\22a\22:{\22docs\22:\22the `own` return and list param should be the same `own`\22},\22b\22:{\22docs\22:\22same as above, even when the `list<b>` implicitly-defined `own` comes\5cnbefore an explicitly defined `own`\22},\22c\22:{\22docs\22:\22same as the above, the `own` argument should have the same type as the\5cnreturn value\22}},\22nested\22:{}}}}")
   (@producers
     (processed-by "wit-component" "$CARGO_PKG_VERSION")
   )

crates/wit-component/tests/interfaces/wasi-http.wat

@@ -562,13 +562,18 @@ enum InterfaceItem<'a> {
 }
 
 struct Nest<'a> {
+    docs: Docs<'a>,
     id: PackageName<'a>,
     name: Id<'a>,
-    // attributes: Vec<Attribute<'a>>,
+    attributes: Vec<Attribute<'a>>,
 }
 
 impl<'a> Nest<'a> {
-    fn parse(tokens: &mut Tokenizer<'a>, _attributes: Vec<Attribute<'a>>) -> Result<Self> {
+    fn parse(
+        tokens: &mut Tokenizer<'a>,
+        docs: Docs<'a>,
+        attributes: Vec<Attribute<'a>>,
+    ) -> Result<Self> {
         tokens.eat(Token::Nest)?;
         let id = parse_id(tokens)?;
         tokens.expect(Token::Colon)?;
@@ -590,8 +595,9 @@ impl<'a> Nest<'a> {
                 name: pkg_name,
                 version,
             },
+            docs,
             name,
-            // attributes,
+            attributes,
         })
     }
 }
@@ -1032,7 +1038,9 @@ impl<'a> InterfaceItem<'a> {
                 NamedFunc::parse(tokens, docs, attributes).map(InterfaceItem::Func)
             }
             Some((_span, Token::Use)) => Use::parse(tokens, attributes).map(InterfaceItem::Use),
-            Some((_span, Token::Nest)) => Nest::parse(tokens, attributes).map(InterfaceItem::Nest),
+            Some((_span, Token::Nest)) => {
+                Nest::parse(tokens, docs, attributes).map(InterfaceItem::Nest)
+            }
             other => Err(err_expected(tokens, "`type`, `resource` or `func`", other).into()),
         }
     }