Rename "destructor" -> "deinit" (as a keyword) and -> "deinitializer" (in diagnostics).

Swift SVN r14380

Author: DougGregor

Diff for: docs/LangRef.html

@@ -30,7 +30,7 @@ <h2 id="decl">Declarations</h2>
   <pre class="grammar">
     decl ::= <a href="#decl-class">decl-class</a>
     decl ::= <a href="#decl-constructor">decl-constructor</a>
-    decl ::= <a href="#decl-destructor">decl-destructor</a>
+    decl ::= <a href="#decl-deinit">decl-deinit</a>
     decl ::= <a href="#decl-extension">decl-extension</a>
     decl ::= <a href="#decl-func">decl-func</a>
     decl ::= <a href="#decl-import">decl-import</a>
@@ -725,31 +725,31 @@ <h3 id="decl-constructor">constructor Declarations</h3>
   </pre>
 
   <!-- ===================================================================== -->
-  <h3 id="decl-destructor">destructor Declarations</h3>
+  <h3 id="decl-deinit">deinitializer Declarations</h3>
   <!-- ===================================================================== -->
 
   <pre class="grammar">
-    decl-constructor ::= <a href="#attribute-list">attribute-list</a> 'destructor' '(' ')' <a href="#brace-item-list">brace-item-list</a>
+    decl-constructor ::= <a href="#attribute-list">attribute-list</a> 'deinit' '(' ')' <a href="#brace-item-list">brace-item-list</a>
   </pre>
 
-  <p>'destructor' declares a destructor for a class.  This function is called
+  <p>'deinit' declares a deinitializer for a class.  This function is called
      when there are no longer any references to a class object, just before it
-     is destroyed.  Note that destructors can only be declared for classes,
-     and cannot be declared in extensions. Subclass destructors implicitly
-     invoke their superclass destructors after executing.</p>
+     is destroyed.  Note that deinitializers can only be declared for classes,
+     and cannot be declared in extensions. Subclass deinitializers implicitly
+     invoke their superclass deinitializers after executing.</p>
 
   <p>FIXME: We haven't really decided the precise rules here, but it's probably
      a fatal error to either throw an exception or stash a reference to 'self'
-     in a destructor.  Not sure what happens when we cause the reference count
-     of another object to reach zero inside a destructor.  We might eventually
-     allow destructors in extensions once we have ivars in extensions.</p>
+     in a deinitializer.  Not sure what happens when we cause the reference count
+     of another object to reach zero inside a deinitializer.  We might eventually
+     allow deinitializers in extensions once we have ivars in extensions.</p>
 
   <p>A simple example:</p>
 
   <pre class="example">
     class X {
       var fd : Int
-      destructor() {
+      deinit() {
         close(fd)
       }
     }

Diff for: docs/classes.rst

@@ -21,10 +21,10 @@ Syntax overview
     class func getAMyclass() -> MyClass {
       return new MyClass
     }
-    constructor() {
+    init() {
       MyVar = 10
     }
-    destructor() {
+    deinit() {
       // Misc finalization
     }
   }

Diff for: include/swift/AST/Decl.h

@@ -3626,7 +3626,7 @@ class ConstructorDecl : public AbstractFunctionDecl {
 /// \code
 /// struct X {
 ///   var fd : Int
-///   destructor() {
+///   deinit() {
 ///      close(fd)
 ///   }
 /// }

Diff for: include/swift/AST/DiagnosticsParse.def

@@ -296,13 +296,15 @@ ERROR(expected_lparen_initializer,decl_parsing,PointsToFirstBadToken,
 
 // Destructor
 ERROR(destructor_decl_outside_class,decl_parsing,none,
-      "'destructor' functions may only be declared within a class", ())
+      "'deinitializer' functions may only be declared within a class", ())
 ERROR(expected_lparen_destructor,decl_parsing,none,
-      "expected an empty parameter list for destructor", ())
+      "expected an empty parameter list for deinitializer", ())
 ERROR(destructor_parameter_nonempty_tuple,decl_parsing,none,
-      "destructors don't have parameters", ())
+      "deinitializers don't have parameters", ())
 ERROR(expected_lbrace_destructor,decl_parsing,PointsToFirstBadToken,
-      "expected '{' for destructor", ())
+      "expected '{' for deinitializer", ())
+ERROR(destructor_is_deinit,decl_parsing,none,
+      "'destructor' is now written as 'deinit'", ())
 
 // Operator
 ERROR(operator_decl_inner_scope,decl_parsing,none,
@@ -529,6 +531,7 @@ ERROR(unsupported_unparenthesized_array_optional,type_parsing,none,
 // Dynamic Self
 ERROR(dynamic_self_is_self,type_parsing,none,
       "'DynamicSelf' is now called 'Self'", ())
+
 //------------------------------------------------------------------------------
 // Pattern parsing diagnostics
 //------------------------------------------------------------------------------

Diff for: include/swift/AST/KnownIdentifiers.def

@@ -23,8 +23,7 @@
 #  error Must define IDENTIFIER_WITH_NAME(Name, IdStr) before including this x-macro file
 #endif
 
-IDENTIFIER(destructor)
-IDENTIFIER(DynamicSelf)
+IDENTIFIER(deinit)
 IDENTIFIER(init)
 IDENTIFIER(self)
 IDENTIFIER(Self)

Diff for: include/swift/Parse/Tokens.def

@@ -32,6 +32,7 @@
 
 // Keywords that start decls.
 KEYWORD(class)
+KEYWORD(deinit)
 KEYWORD(destructor)
 KEYWORD(enum)
 KEYWORD(extension)

Diff for: lib/AST/ASTDumper.cpp

@@ -724,7 +724,7 @@ static void printContext(raw_ostream &os, DeclContext *dc) {
     if (isa<ConstructorDecl>(AFD))
       os << "init";
     if (isa<DestructorDecl>(AFD))
-      os << "destructor";
+      os << "deinit";
     break;
   }
   }

Diff for: lib/AST/ASTPrinter.cpp

@@ -892,7 +892,7 @@ void PrintAST::visitDestructorDecl(DestructorDecl *decl) {
   recordDeclLoc(decl);
   printAttributes(decl->getAttrs());
   printImplicitObjCNote(decl);
-  Printer << "destructor() ";
+  Printer << "deinit() ";
 
   if (!Options.FunctionDefinitions || !decl->getBody()) {
     return;

Diff for: lib/AST/Decl.cpp

@@ -1001,7 +1001,7 @@ ClassDecl::ClassDecl(SourceLoc ClassLoc, Identifier Name, SourceLoc NameLoc,
 }
 
 DestructorDecl *ClassDecl::getDestructor() {
-  auto name = getASTContext().Id_destructor;
+  auto name = getASTContext().Id_deinit;
   auto results = lookupDirect(name);
   assert(!results.empty() && "Class without destructor?");
   assert(results.size() == 1 && "More than one destructor?");

Diff for: lib/Basic/Demangle.cpp

@@ -2332,10 +2332,10 @@ void NodePrinter::print(Node *pointer, bool asContext, bool suppressType) {
     printEntity(false, true, "init");
     return;
   case Node::Kind::Destructor:
-    printEntity(false, false, "destructor");
+    printEntity(false, false, "deinit");
     return;
   case Node::Kind::Deallocator:
-    printEntity(false, false, "__deallocating_destructor");
+    printEntity(false, false, "__deallocating_deinit");
     return;
   case Node::Kind::IVarInitializer:
     printEntity(false, false, "__ivar_initializer");

Diff for: lib/Parse/ParseDecl.cpp

@@ -536,6 +536,7 @@ static bool isStartOfModifiedDecl(const Token &Tok, const Token &Tok2,
   return
        (Tok2.is(tok::kw_func) || Tok2.is(tok::kw_val) || Tok2.is(tok::kw_var) ||
         Tok2.is(tok::kw_init) || Tok2.is(tok::kw_destructor) ||
+        Tok2.is(tok::kw_deinit) ||
         Tok2.is(tok::kw_subscript) || Tok2.is(tok::kw_struct) ||
         Tok2.is(tok::kw_enum) || Tok2.is(tok::kw_class) ||
         Tok2.is(tok::kw_protocol) || Tok2.is(tok::kw_typealias));
@@ -557,6 +558,7 @@ bool Parser::isStartOfDecl(const Token &Tok, const Token &Tok2) {
   case tok::kw_import:
   case tok::kw_subscript:
   case tok::kw_init:
+  case tok::kw_deinit:
   case tok::kw_destructor:
   case tok::kw_func:
   case tok::pound_if:
@@ -702,6 +704,7 @@ ParserStatus Parser::parseDecl(SmallVectorImpl<Decl*> &Entries,
     DeclResult = parseDeclConstructor(Flags, Attributes);
     Status = DeclResult;
     break;
+  case tok::kw_deinit:
   case tok::kw_destructor:
     DeclResult = parseDeclDestructor(Flags, Attributes);
     Status = DeclResult;
@@ -2947,7 +2950,15 @@ Parser::parseDeclConstructor(ParseDeclOptions Flags,
 
 ParserResult<DestructorDecl> Parser::
 parseDeclDestructor(ParseDeclOptions Flags, DeclAttributes &Attributes) {
-  SourceLoc DestructorLoc = consumeToken(tok::kw_destructor);
+  SourceLoc DestructorLoc;
+  if (Tok.is(tok::kw_destructor)) {
+    diagnose(Tok, diag::destructor_is_deinit)
+      .fixItReplace(SourceLoc(Tok.getLoc()), "deinit");
+
+    DestructorLoc = consumeToken(tok::kw_destructor);
+  } else {
+    DestructorLoc = consumeToken(tok::kw_deinit);
+  }
 
   ParserResult<Pattern> Params;
   if (Tok.is(tok::l_paren)) {
@@ -3003,7 +3014,7 @@ parseDeclDestructor(ParseDeclOptions Flags, DeclAttributes &Attributes) {
                                                  CurDeclContext, &SelfDecl);
 
   Scope S(this, ScopeKind::DestructorBody);
-  auto *DD = new (Context) DestructorDecl(Context.Id_destructor, DestructorLoc,
+  auto *DD = new (Context) DestructorDecl(Context.Id_deinit, DestructorLoc,
                                           SelfPattern, CurDeclContext);
   // No need to setLocalDiscriminator.
   addToScope(SelfDecl);

Diff for: lib/Parse/ParseSIL.cpp

@@ -222,7 +222,12 @@ bool SILParser::parseSILIdentifier(Identifier &Result, SourceLoc &Loc,
     Result = P.Context.getIdentifier(P.Tok.getText());
     break;
   case tok::kw_destructor:
-    Result = P.Context.Id_destructor;
+    P.diagnose(P.Tok, diag::destructor_is_deinit)
+      .fixItReplace(SourceLoc(P.Tok.getLoc()), "deinit");
+    // fall through
+
+  case tok::kw_deinit:
+    Result = P.Context.Id_deinit;
     break;
   case tok::kw_init:
     Result = P.Context.Id_init;
@@ -672,7 +677,7 @@ static ValueDecl *lookupMember(Parser &P, Type Ty, Identifier Name) {
   SmallVector<ValueDecl *, 4> Lookup;
   unsigned options = NL_QualifiedDefault;
   // FIXME: a bit of a hack.
-  if (Name == P.Context.Id_destructor || Name == P.Context.Id_init)
+  if (Name == P.Context.Id_deinit || Name == P.Context.Id_init)
     options = options & ~NL_VisitSupertypes;
   P.SF.lookupQualified(Ty, Name, options, nullptr, Lookup);
   assert(Lookup.size() == 1);

Diff for: lib/Sema/TypeCheckDecl.cpp

@@ -3423,7 +3423,7 @@ void TypeChecker::addImplicitDestructor(ClassDecl *CD) {
   VarDecl *selfDecl;
   Pattern *selfPat = buildImplicitSelfParameter(CD->getLoc(), CD, &selfDecl);
 
-  auto *DD = new (Context) DestructorDecl(Context.Id_destructor, CD->getLoc(),
+  auto *DD = new (Context) DestructorDecl(Context.Id_deinit, CD->getLoc(),
                                           selfPat, CD);
 
   DD->setImplicit();

Diff for: lib/Serialization/Deserialization.cpp

@@ -2084,7 +2084,7 @@ Decl *ModuleFile::getDecl(DeclID DID, Optional<DeclContext *> ForcedContext,
     if (declOrOffset.isComplete())
       break;
 
-    auto dtor = new (ctx) DestructorDecl(ctx.Id_destructor, SourceLoc(),
+    auto dtor = new (ctx) DestructorDecl(ctx.Id_deinit, SourceLoc(),
                                          /*selfpat*/nullptr, parent);
     declOrOffset = dtor;
 

Diff for: test/IRGen/objc_dealloc.sil

@@ -17,7 +17,7 @@ func onDestruct() { }
 
 class SwiftGizmo : Gizmo {
   var x : X
-  destructor()
+  deinit()
 }
 sil @_TFCSo10SwiftGizmoD : $@cc(method) @thin (SwiftGizmo) -> ()
 
@@ -91,7 +91,7 @@ bb0(%0 : $SwiftGizmo):
   // CHECK-NEXT: store %objc_class* bitcast (%swift.type* getelementptr inbounds (%swift.full_heapmetadata* bitcast ({ void ([[SGIZMO]]*)*, i8**, i64, %objc_class*, %swift.opaque*, %swift.opaque*, i64, { i64, i8*, i64, i64, i8*, i64, i64 }*, i64, i64 }* @_TMdCSo10SwiftGizmo to %swift.full_heapmetadata*), i32 0, i32 2) to %objc_class*), %objc_class** [[OBJC_SUPER_CLASS]], align 8
   // CHECK-NEXT: [[DEALLOC_SEL:%[a-zA-Z0-9]+]] = load i8** @"\01L_selector(dealloc)", align 8
   // CHECK-NEXT: call void bitcast (void ()* @objc_msgSendSuper2 to void (%objc_super*, i8*)*)(%objc_super* [[OBJC_SUPER]], i8* [[DEALLOC_SEL]])
-  %5 = super_method %0 : $SwiftGizmo, #Gizmo.destructor!deallocator.foreign : $@cc(objc_method) @thin (Gizmo) -> () // user: %7
+  %5 = super_method %0 : $SwiftGizmo, #Gizmo.deinit!deallocator.foreign : $@cc(objc_method) @thin (Gizmo) -> () // user: %7
   %6 = upcast %0 : $SwiftGizmo to $Gizmo          // user: %7
   %7 = apply %5(%6) : $@cc(objc_method) @thin (Gizmo) -> ()
 

Diff for: test/SILPasses/dead_alloc_elim.sil

@@ -10,7 +10,7 @@ import Builtin
 class TrivialDestructor {
   var int : Builtin.Int32
   var ptr : Builtin.ObjectPointer
-  destructor() { }
+  deinit() { }
 }
 
 sil @_TFC4main17TrivialDestructorD : $@cc(method) @thin (@owned TrivialDestructor) -> () {
@@ -184,7 +184,7 @@ sil @trivial_destructor_side_effect_use
 class NonTrivialDestructor {
   var ptr : Builtin.ObjectPointer
 
-  destructor() { }
+  deinit() { }
 }
 
 sil @_TFC4main17NonTrivialDestructorD : $@cc(method) @thin (@owned NonTrivialDestructor) -> () {
@@ -216,7 +216,7 @@ sil @non_trivial_destructor_refcount_on_different_value : $@thin () -> () {
 class NonTrivialDestructor2 {
   var ptr : NonTrivialDestructor
 
-  destructor() { }
+  deinit() { }
 }
 
 // Test if dealloc_ref on a different value disrupts the algorithm.
@@ -246,7 +246,7 @@ sil @non_trivial_destructor_deallocref_on_different_value : $@thin () -> () {
 class NonTrivialDestructor3 {
   var ptr : Builtin.ObjectPointer
 
-  destructor() { }
+  deinit() { }
 }
 
 // Make sure a non-builtin apply disrupts the algorithm.
@@ -277,7 +277,7 @@ sil @non_trivial_destructor_unknown_apply : $@thin () -> () {
 class NonTrivialObjCDestructor {
   var ptr : Builtin.ObjectPointer
 
-  destructor() { }
+  deinit() { }
 }
 
 // Make sure we do not handle objc_methods

Diff for: utils/buildbot-release-notes.txt

@@ -130,6 +130,9 @@
 
 * 'DynamicSelf' is now called 'Self'; the semantics are unchanged.
 
+* 'destructor' has been replaced with 'deinit', to emphasize that it
+  is related to 'init'. We will refer to these as 'deinitializers'.
+
 2014-02-19
 ----------
 

Diff for: utils/sil-mode.el

@@ -25,7 +25,7 @@
    ;; Integer literals
    '("\\b[-]?[0-9]+\\b" . font-lock-preprocessor-face)
    ;; Decl and type keywords
-   `(,(regexp-opt '("class" "init" "destructor" "extension" "func"
+   `(,(regexp-opt '("class" "init" "deinit" "extension" "func"
                     "import" "protocol" "static" "struct" "subscript"
                     "typealias" "enum" "var" "where"  "sil_vtable"
                     "sil_global" "private" "sil_witness_table")