Merge pull request #2928 from onflow/sainati/merge-stable-cadence-des…

…tructors

Merge destructor removal into stable cadence

encoding/ccf/ccf_test.go

@@ -5218,10 +5218,6 @@ func TestEncodeResource(t *testing.T) {
 					init(bar: @Bar) {
 						self.bar <- bar
 					}
-
-					destroy() {
-						destroy self.bar
-					}
 				}
 
 				fun main(): @Foo {

encoding/json/encoding_test.go

@@ -1264,10 +1264,6 @@ func TestEncodeResource(t *testing.T) {
                 init(bar: @Bar) {
                     self.bar <- bar
                 }
-
-                destroy() {
-                    destroy self.bar
-                }
             }
 
             fun main(): @Foo {

runtime/ast/composite.go

@@ -43,6 +43,12 @@ type CompositeLikeDeclaration interface {
 	Kind() common.CompositeKind
 }
 
+const ResourceDestructionDefaultEventName = "ResourceDestroyed"
+
+func IsResourceDestructionDefaultEvent(identifier string) bool {
+	return identifier == ResourceDestructionDefaultEventName
+}
+
 type CompositeDeclaration struct {
 	Members      *Members
 	DocString    string
@@ -280,6 +286,11 @@ func (d *CompositeDeclaration) ConformanceList() []*NominalType {
 	return d.Conformances
 }
 
+func (d *CompositeDeclaration) IsResourceDestructionDefaultEvent() bool {
+	return d.CompositeKind == common.CompositeKindEvent &&
+		IsResourceDestructionDefaultEvent(d.Identifier.Identifier)
+}
+
 // FieldDeclarationFlags
 
 type FieldDeclarationFlags uint8

runtime/ast/expression_test.go

@@ -4414,6 +4414,7 @@ func TestFunctionExpression_MarshalJSON(t *testing.T) {
                             "StartPos": {"Offset": 7, "Line": 8, "Column": 9},
                             "EndPos": {"Offset": 5, "Line": 5, "Column": 7}
                         },
+						"DefaultArgument": null,
                         "StartPos": {"Offset": 10, "Line": 11, "Column": 12},
                         "EndPos": {"Offset": 5, "Line": 5, "Column": 7}
                     }

runtime/ast/function_declaration_test.go

@@ -241,6 +241,7 @@ func TestFunctionDeclaration_MarshalJSON(t *testing.T) {
                             "StartPos": {"Offset": 7, "Line": 8, "Column": 9},
                             "EndPos": {"Offset": 5, "Line": 5, "Column": 7}
                         },
+						"DefaultArgument": null,
                         "StartPos": {"Offset": 10, "Line": 11, "Column": 12},
                         "EndPos": {"Offset": 5, "Line": 5, "Column": 7}
                     }
@@ -715,6 +716,7 @@ func TestSpecialFunctionDeclaration_MarshalJSON(t *testing.T) {
                                 "StartPos": {"Offset": 7, "Line": 8, "Column": 9},
                                 "EndPos": {"Offset": 5, "Line": 5, "Column": 7}
                             },
+							"DefaultArgument": null,
                             "StartPos": {"Offset": 10, "Line": 11, "Column": 12},
                             "EndPos": {"Offset": 5, "Line": 5, "Column": 7}
                         }

runtime/ast/memberindices.go

@@ -37,10 +37,6 @@ type memberIndices struct {
 	_specialFunctions []*SpecialFunctionDeclaration
 	// Use `Initializers()` instead
 	_initializers []*SpecialFunctionDeclaration
-	// Semantically only one destructor is allowed,
-	// but the program might illegally declare multiple.
-	// Use `Destructors()` instead
-	_destructors []*SpecialFunctionDeclaration
 	// Use `Functions()`
 	_functions []*FunctionDeclaration
 	// Use `FunctionsByIdentifier()` instead
@@ -109,11 +105,6 @@ func (i *memberIndices) Initializers(declarations []Declaration) []*SpecialFunct
 	return i._initializers
 }
 
-func (i *memberIndices) Destructors(declarations []Declaration) []*SpecialFunctionDeclaration {
-	i.once.Do(i.initializer(declarations))
-	return i._destructors
-}
-
 func (i *memberIndices) Fields(declarations []Declaration) []*FieldDeclaration {
 	i.once.Do(i.initializer(declarations))
 	return i._fields
@@ -175,7 +166,6 @@ func (i *memberIndices) init(declarations []Declaration) {
 	i._functionsByIdentifier = make(map[string]*FunctionDeclaration)
 
 	i._specialFunctions = make([]*SpecialFunctionDeclaration, 0)
-	i._destructors = make([]*SpecialFunctionDeclaration, 0)
 	i._initializers = make([]*SpecialFunctionDeclaration, 0)
 
 	i._composites = make([]*CompositeDeclaration, 0)
@@ -211,8 +201,6 @@ func (i *memberIndices) init(declarations []Declaration) {
 			switch declaration.Kind {
 			case common.DeclarationKindInitializer:
 				i._initializers = append(i._initializers, declaration)
-			case common.DeclarationKindDestructor:
-				i._destructors = append(i._destructors, declaration)
 			}
 
 		case *EntitlementDeclaration:

runtime/ast/memberindices_test.go

@@ -54,10 +54,7 @@ func TestMemberIndices(t *testing.T) {
 	specialFunctionA := &SpecialFunctionDeclaration{
 		Kind: common.DeclarationKindInitializer,
 	}
-	specialFunctionB := &SpecialFunctionDeclaration{
-		Kind: common.DeclarationKindDestructor,
-	}
-	specialFunctionC := &SpecialFunctionDeclaration{}
+	specialFunctionB := &SpecialFunctionDeclaration{}
 
 	compositeA := &CompositeDeclaration{
 		Identifier: Identifier{Identifier: "A"},
@@ -98,7 +95,6 @@ func TestMemberIndices(t *testing.T) {
 			interfaceB,
 			compositeA,
 			functionB,
-			specialFunctionC,
 			compositeB,
 			specialFunctionA,
 			interfaceA,
@@ -141,7 +137,6 @@ func TestMemberIndices(t *testing.T) {
 			require.Equal(t,
 				[]*SpecialFunctionDeclaration{
 					specialFunctionB,
-					specialFunctionC,
 					specialFunctionA,
 				},
 				members.SpecialFunctions(),

runtime/ast/members.go

@@ -116,19 +116,6 @@ func (m *Members) Initializers() []*SpecialFunctionDeclaration {
 	return m.indices.Initializers(m.declarations)
 }
 
-func (m *Members) Destructors() []*SpecialFunctionDeclaration {
-	return m.indices.Destructors(m.declarations)
-}
-
-// Destructor returns the first destructor, if any
-func (m *Members) Destructor() *SpecialFunctionDeclaration {
-	destructors := m.Destructors()
-	if len(destructors) == 0 {
-		return nil
-	}
-	return destructors[0]
-}
-
 func (m *Members) FieldPosition(name string, compositeKind common.CompositeKind) Position {
 	if compositeKind == common.CompositeKindEvent {
 		parameters := m.Initializers()[0].FunctionDeclaration.ParameterList.ParametersByIdentifier()

runtime/ast/parameter.go

@@ -21,29 +21,34 @@ package ast
 import (
 	"encoding/json"
 
+	"github.com/turbolent/prettier"
+
 	"github.com/onflow/cadence/runtime/common"
 )
 
 type Parameter struct {
-	TypeAnnotation *TypeAnnotation
-	Label          string
-	Identifier     Identifier
-	StartPos       Position `json:"-"`
+	TypeAnnotation  *TypeAnnotation
+	DefaultArgument Expression
+	Label           string
+	Identifier      Identifier
+	StartPos        Position `json:"-"`
 }
 
 func NewParameter(
 	gauge common.MemoryGauge,
 	label string,
 	identifier Identifier,
 	typeAnnotation *TypeAnnotation,
+	defaultArgument Expression,
 	startPos Position,
 ) *Parameter {
 	common.UseMemory(gauge, common.ParameterMemoryUsage)
 	return &Parameter{
-		Label:          label,
-		Identifier:     identifier,
-		TypeAnnotation: typeAnnotation,
-		StartPos:       startPos,
+		Label:           label,
+		Identifier:      identifier,
+		TypeAnnotation:  typeAnnotation,
+		DefaultArgument: defaultArgument,
+		StartPos:        startPos,
 	}
 }
 
@@ -65,9 +70,16 @@ func (p *Parameter) StartPosition() Position {
 }
 
 func (p *Parameter) EndPosition(memoryGauge common.MemoryGauge) Position {
+	if p.HasDefaultArgument() {
+		return p.DefaultArgument.EndPosition(memoryGauge)
+	}
 	return p.TypeAnnotation.EndPosition(memoryGauge)
 }
 
+func (p *Parameter) HasDefaultArgument() bool {
+	return p.DefaultArgument != nil
+}
+
 func (p *Parameter) MarshalJSON() ([]byte, error) {
 	type Alias Parameter
 	return json.Marshal(&struct {
@@ -78,3 +90,35 @@ func (p *Parameter) MarshalJSON() ([]byte, error) {
 		Alias: (*Alias)(p),
 	})
 }
+
+const parameterDefaultArgumentSeparator = "="
+
+func (p *Parameter) Doc() prettier.Doc {
+	var parameterDoc prettier.Concat
+
+	if p.Label != "" {
+		parameterDoc = append(
+			parameterDoc,
+			prettier.Text(p.Label),
+			prettier.Space,
+		)
+	}
+
+	parameterDoc = append(
+		parameterDoc,
+		prettier.Text(p.Identifier.Identifier),
+		typeSeparatorSpaceDoc,
+		p.TypeAnnotation.Doc(),
+	)
+
+	if p.DefaultArgument != nil {
+		parameterDoc = append(parameterDoc,
+			prettier.Space,
+			prettier.Text(parameterDefaultArgumentSeparator),
+			prettier.Space,
+			p.DefaultArgument.Doc(),
+		)
+	}
+
+	return parameterDoc
+}

runtime/ast/parameterlist.go

@@ -92,24 +92,7 @@ func (l *ParameterList) Doc() prettier.Doc {
 	parameterDocs := make([]prettier.Doc, 0, len(l.Parameters))
 
 	for _, parameter := range l.Parameters {
-		var parameterDoc prettier.Concat
-
-		if parameter.Label != "" {
-			parameterDoc = append(
-				parameterDoc,
-				prettier.Text(parameter.Label),
-				prettier.Space,
-			)
-		}
-
-		parameterDoc = append(
-			parameterDoc,
-			prettier.Text(parameter.Identifier.Identifier),
-			typeSeparatorSpaceDoc,
-			parameter.TypeAnnotation.Doc(),
-		)
-
-		parameterDocs = append(parameterDocs, parameterDoc)
+		parameterDocs = append(parameterDocs, parameter.Doc())
 	}
 
 	return prettier.WrapParentheses(

runtime/common/declarationkind.go

@@ -44,7 +44,6 @@ const (
 	DeclarationKindEvent
 	DeclarationKindField
 	DeclarationKindInitializer
-	DeclarationKindDestructor
 	DeclarationKindStructureInterface
 	DeclarationKindResourceInterface
 	DeclarationKindContractInterface
@@ -117,8 +116,6 @@ func (k DeclarationKind) Name() string {
 		return "field"
 	case DeclarationKindInitializer:
 		return "initializer"
-	case DeclarationKindDestructor:
-		return "destructor"
 	case DeclarationKindAttachment:
 		return "attachment"
 	case DeclarationKindStructureInterface:
@@ -176,8 +173,6 @@ func (k DeclarationKind) Keywords() string {
 		return "event"
 	case DeclarationKindInitializer:
 		return "init"
-	case DeclarationKindDestructor:
-		return "destroy"
 	case DeclarationKindAttachment:
 		return "attachment"
 	case DeclarationKindStructureInterface:

runtime/convertValues_test.go

@@ -1687,10 +1687,6 @@ func TestRuntimeExportNestedResourceValueFromScript(t *testing.T) {
             init(bar: @Bar) {
                 self.bar <- bar
             }
-
-            destroy() {
-                destroy self.bar
-            }
         }
 
         access(all) fun main(): @Foo {

runtime/environment.go

@@ -980,7 +980,7 @@ func (e *interpreterEnvironment) newCompositeValueFunctionsHandler() interpreter
 		inter *interpreter.Interpreter,
 		locationRange interpreter.LocationRange,
 		compositeValue *interpreter.CompositeValue,
-	) map[string]interpreter.FunctionValue {
+	) *interpreter.FunctionOrderedMap {
 
 		handler := e.compositeValueFunctionsHandlers[compositeValue.TypeID()]
 		if handler == nil {

runtime/ft_test.go

@@ -274,10 +274,6 @@ access(all) contract FlowToken: FungibleToken {
             vault.balance = 0.0
             destroy vault
         }
-
-        destroy() {
-            FlowToken.totalSupply = FlowToken.totalSupply - self.balance
-        }
     }
 
     // createEmptyVault