[move] Add further support for enums in Move model (#18980)

MystenLabs · Aug 14, 2024 · 9c4652f · 9c4652f
1 parent c5766bc
commit 9c4652f
Show file tree

Hide file tree

Showing 8 changed files with 310 additions and 49 deletions.
diff --git a/external-crates/move/crates/move-docgen/tests/sources/enums_test.move b/external-crates/move/crates/move-docgen/tests/sources/enums_test.move
@@ -2,7 +2,7 @@
 #[allow(unused)]
 module 0x42::m {
     /// This is a doc comment above an enum
-    public enum Enum {
+    public enum Enum has drop {
         /// This is a doc comment above a variant
         A,
         B(),
@@ -20,13 +20,28 @@ module 0x42::m {
         B,
     }
 
-    public struct X { x: Enum }
+    public struct X has drop { x: Enum }
     public struct Y(Enum)
 
     public struct XG { x: GenericEnum<Enum> }
     public struct YG(GenericEnum<Enum>)
 
     public struct XGG<T> { x: GenericEnum<T> }
     public struct YGG<T>(GenericEnum<T>)
+
+    public struct VecMap<K: copy, V> has copy, drop, store {
+        contents: vector<Entry<K, V>>,
+    }
+
+    /// An entry in the map
+    public struct Entry<K: copy, V> has copy, drop, store {
+        key: K,
+        value: V,
+    }
+
+    /// Doc comments `type_: VecMap<u64, X>`
+    fun f(x: VecMap<u64, X>): u64 {
+        0
+    }
 }
 
diff --git a/external-crates/move/crates/move-docgen/tests/sources/enums_test.spec_inline.md b/external-crates/move/crates/move-docgen/tests/sources/enums_test.spec_inline.md
@@ -12,8 +12,11 @@ This is a doc comment above an annotation.
 -  [Struct `YG`](#0x42_m_YG)
 -  [Struct `XGG`](#0x42_m_XGG)
 -  [Struct `YGG`](#0x42_m_YGG)
+-  [Struct `VecMap`](#0x42_m_VecMap)
+-  [Struct `Entry`](#0x42_m_Entry)
 -  [Enum `Enum`](#0x42_m_Enum)
 -  [Enum `GenericEnum`](#0x42_m_GenericEnum)
+-  [Function `f`](#0x42_m_f)
 
 
 <pre><code></code></pre>
@@ -26,7 +29,7 @@ This is a doc comment above an annotation.
 
 
 
-<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_X">X</a>
+<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_X">X</a> <b>has</b> drop
 </code></pre>
 
 
@@ -180,6 +183,67 @@ This is a doc comment above an annotation.
 </dl>
 
 
+</details>
+
+<a name="0x42_m_VecMap"></a>
+
+## Struct `VecMap`
+
+
+
+<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_VecMap">VecMap</a>&lt;K: <b>copy</b>, V&gt; <b>has</b> <b>copy</b>, drop, store
+</code></pre>
+
+
+
+<details>
+<summary>Fields</summary>
+
+
+<dl>
+<dt>
+<code>contents: vector&lt;<a href="enums_test.md#0x42_m_Entry">m::Entry</a>&lt;K, V&gt;&gt;</code>
+</dt>
+<dd>
+
+</dd>
+</dl>
+
+
+</details>
+
+<a name="0x42_m_Entry"></a>
+
+## Struct `Entry`
+
+An entry in the map
+
+
+<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_Entry">Entry</a>&lt;K: <b>copy</b>, V&gt; <b>has</b> <b>copy</b>, drop, store
+</code></pre>
+
+
+
+<details>
+<summary>Fields</summary>
+
+
+<dl>
+<dt>
+<code>key: K</code>
+</dt>
+<dd>
+
+</dd>
+<dt>
+<code>value: V</code>
+</dt>
+<dd>
+
+</dd>
+</dl>
+
+
 </details>
 
 <a name="0x42_m_Enum"></a>
@@ -189,7 +253,7 @@ This is a doc comment above an annotation.
 This is a doc comment above an enum
 
 
-<pre><code><b>public</b> enum Enum
+<pre><code><b>public</b> enum Enum <b>has</b> drop
 </code></pre>
 
 
@@ -315,4 +379,29 @@ Variant <code>B</code>
 </dl>
 
 
+</details>
+
+<a name="0x42_m_f"></a>
+
+## Function `f`
+
+Doc comments <code>type_: <a href="enums_test.md#0x42_m_VecMap">VecMap</a>&lt;u64, <a href="enums_test.md#0x42_m_X">X</a>&gt;</code>
+
+
+<pre><code><b>fun</b> <a href="enums_test.md#0x42_m_f">f</a>(x: <a href="enums_test.md#0x42_m_VecMap">m::VecMap</a>&lt;u64, <a href="enums_test.md#0x42_m_X">m::X</a>&gt;): u64
+</code></pre>
+
+
+
+<details>
+<summary>Implementation</summary>
+
+
+<pre><code><b>fun</b> <a href="enums_test.md#0x42_m_f">f</a>(x: <a href="enums_test.md#0x42_m_VecMap">VecMap</a>&lt;u64, <a href="enums_test.md#0x42_m_X">X</a>&gt;): u64 {
+    0
+}
+</code></pre>
+
+
+
 </details>
diff --git a/...-crates/move/crates/move-docgen/tests/sources/enums_test.spec_inline_no_fold.md b/...-crates/move/crates/move-docgen/tests/sources/enums_test.spec_inline_no_fold.md
@@ -12,8 +12,11 @@ This is a doc comment above an annotation.
 -  [Struct `YG`](#0x42_m_YG)
 -  [Struct `XGG`](#0x42_m_XGG)
 -  [Struct `YGG`](#0x42_m_YGG)
+-  [Struct `VecMap`](#0x42_m_VecMap)
+-  [Struct `Entry`](#0x42_m_Entry)
 -  [Enum `Enum`](#0x42_m_Enum)
 -  [Enum `GenericEnum`](#0x42_m_GenericEnum)
+-  [Function `f`](#0x42_m_f)
 
 
 <pre><code></code></pre>
@@ -26,7 +29,7 @@ This is a doc comment above an annotation.
 
 
 
-<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_X">X</a>
+<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_X">X</a> <b>has</b> drop
 </code></pre>
 
 
@@ -164,14 +167,69 @@ This is a doc comment above an annotation.
 </dl>
 
 
+<a name="0x42_m_VecMap"></a>
+
+## Struct `VecMap`
+
+
+
+<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_VecMap">VecMap</a>&lt;K: <b>copy</b>, V&gt; <b>has</b> <b>copy</b>, drop, store
+</code></pre>
+
+
+
+##### Fields
+
+
+<dl>
+<dt>
+<code>contents: vector&lt;<a href="enums_test.md#0x42_m_Entry">m::Entry</a>&lt;K, V&gt;&gt;</code>
+</dt>
+<dd>
+
+</dd>
+</dl>
+
+
+<a name="0x42_m_Entry"></a>
+
+## Struct `Entry`
+
+An entry in the map
+
+
+<pre><code><b>struct</b> <a href="enums_test.md#0x42_m_Entry">Entry</a>&lt;K: <b>copy</b>, V&gt; <b>has</b> <b>copy</b>, drop, store
+</code></pre>
+
+
+
+##### Fields
+
+
+<dl>
+<dt>
+<code>key: K</code>
+</dt>
+<dd>
+
+</dd>
+<dt>
+<code>value: V</code>
+</dt>
+<dd>
+
+</dd>
+</dl>
+
+
 <a name="0x42_m_Enum"></a>
 
 ## Enum `Enum`
 
 This is a doc comment above an enum
 
 
-<pre><code><b>public</b> enum Enum
+<pre><code><b>public</b> enum Enum <b>has</b> drop
 </code></pre>
 
 
@@ -291,3 +349,24 @@ Variant <code>B</code>
 
 </dd>
 </dl>
+
+
+<a name="0x42_m_f"></a>
+
+## Function `f`
+
+Doc comments <code>type_: <a href="enums_test.md#0x42_m_VecMap">VecMap</a>&lt;u64, <a href="enums_test.md#0x42_m_X">X</a>&gt;</code>
+
+
+<pre><code><b>fun</b> <a href="enums_test.md#0x42_m_f">f</a>(x: <a href="enums_test.md#0x42_m_VecMap">m::VecMap</a>&lt;u64, <a href="enums_test.md#0x42_m_X">m::X</a>&gt;): u64
+</code></pre>
+
+
+
+##### Implementation
+
+
+<pre><code><b>fun</b> <a href="enums_test.md#0x42_m_f">f</a>(x: <a href="enums_test.md#0x42_m_VecMap">VecMap</a>&lt;u64, <a href="enums_test.md#0x42_m_X">X</a>&gt;): u64 {
+    0
+}
+</code></pre>