Merge pull request #10693 from Geod24/deprecate-body

Fix issue 19325 - Deprecate body keyword
dlang · Dec 23, 2019 · f8d88eb · f8d88eb
2 parents 2634f16 + 3093244
commit f8d88eb
Show file tree

Hide file tree

Showing 32 changed files with 116 additions and 67 deletions.
diff --git a/changelog/body-as-keyword.dd b/changelog/body-as-keyword.dd
@@ -0,0 +1,10 @@
+The keyword `body` is now deprecated
+
+The keyword `body`, used when a function / method has contract,
+has now been deprecated, and `do` should be used instead.
+Using `do` in place of `body` has been supported since 2.075.0,
+after DIP1003 was accepted.
+At the same time, `body` was made a contextual keyword,
+but kept being non-deprecated due to its prevalence.
+According to the deprecation process, `body` will be removed
+from the language in release 2.101.0 at the earliest.
diff --git a/src/dmd/astbase.d b/src/dmd/astbase.d
@@ -6097,7 +6097,7 @@ struct ASTBase
         {
             assert(!!aggrfe ^ !!rangefe);
         }
-        body
+        do
         {
             this.loc = loc;
             this.aggrfe = aggrfe;

diff --git a/src/dmd/compiler.d b/src/dmd/compiler.d
@@ -186,7 +186,8 @@ private struct ModuleComponentRange
  *  True if the given module should be included in the compilation.
  */
 private bool includeImportedModuleCheck(ModuleComponentRange components)
-    in { assert(includeImports); } body
+    in { assert(includeImports); }
+do
 {
     createMatchNodes();
     size_t nodeIndex = 0;

diff --git a/src/dmd/frontend.d b/src/dmd/frontend.d
@@ -385,7 +385,7 @@ in
 {
     assert(diagnosticReporter !is null);
 }
-body
+do
 {
     import dmd.root.file : File, FileBuffer;
 

diff --git a/src/dmd/lexer.d b/src/dmd/lexer.d
@@ -253,7 +253,7 @@ class Lexer
     {
         assert(diagnosticReporter !is null);
     }
-    body
+    do
     {
         this.diagnosticReporter = diagnosticReporter;
         scanloc = Loc(filename, 1, 1);
@@ -1185,7 +1185,7 @@ class Lexer
     {
         assert(handler !is null);
     }
-    body
+    do
     {
         const(char)* p = sequence; // cache sequence reference on stack
         scope(exit) sequence = p;

diff --git a/src/dmd/objc.d b/src/dmd/objc.d
@@ -492,7 +492,7 @@ extern(C++) private final class Supported : Objc
     {
         assert(id.classKind == ClassKind.objc);
     }
-    body
+    do
     {
         // don't report deprecations for the metaclass to avoid duplicated
         // messages.
@@ -566,7 +566,7 @@ extern(C++) private final class Supported : Objc
         assert(fd.selector);
         assert(fd.isMember);
     }
-    body
+    do
     {
         // * final member functions are kept virtual with Objective-C linkage
         //   because the Objective-C runtime always use dynamic dispatch.
@@ -581,7 +581,7 @@ extern(C++) private final class Supported : Objc
     {
         assert(metaclass);
     }
-    body
+    do
     {
         if (cd.classKind == ClassKind.objc && fd.isStatic && !cd.objc.isMeta)
             return cd.objc.metaclass;
@@ -594,7 +594,7 @@ extern(C++) private final class Supported : Objc
     {
         assert(fd.parent.isClassDeclaration);
     }
-    body
+    do
     {
         if (cd.classKind != ClassKind.objc)
             return;
@@ -632,7 +632,7 @@ extern(C++) private final class Supported : Objc
     {
         assert(fd.selectorParameter is null);
     }
-    body
+    do
     {
         if (!fd.selector)
             return null;

diff --git a/src/dmd/objc_glue.d b/src/dmd/objc_glue.d
@@ -262,7 +262,7 @@ extern(C++) final class Supported : ObjcGlue
         assert(classDeclaration !is null);
         assert(classDeclaration.classKind == ClassKind.objc);
     }
-    body
+    do
     {
         if (!classDeclaration.objc.isMeta)
             ObjcClassDeclaration(classDeclaration, false).toObjFile();
@@ -274,7 +274,7 @@ extern(C++) final class Supported : ObjcGlue
     {
         assert(fd);
     }
-    body
+    do
     {
         if (!fd.selector)
             return count;
@@ -619,7 +619,7 @@ static:
     {
         assert(classDeclaration !is null);
     }
-    body
+    do
     {
         return getClassName(ObjcClassDeclaration(classDeclaration, isMeta));
     }
@@ -715,7 +715,7 @@ static:
     {
         assert(type !is null);
     }
-    body
+    do
     {
         enum assertMessage = "imaginary types are not supported by Objective-C";
 
@@ -914,7 +914,7 @@ struct ObjcClassDeclaration
     {
         assert(classDeclaration !is null);
     }
-    body
+    do
     {
         this.classDeclaration = classDeclaration;
         this.isMeta = isMeta;
@@ -1280,7 +1280,7 @@ out(result)
 {
     assert(str.length == result.strlen);
 }
-body
+do
 {
     if (str.length == 0)
         return "".ptr;

diff --git a/src/dmd/parse.d b/src/dmd/parse.d
@@ -840,6 +840,11 @@ final class Parser(AST) : Lexer
                      tk.value == TOK.out_ || tk.value == TOK.do_ ||
                      tk.value == TOK.identifier && tk.ident == Id._body))
                 {
+                    // @@@DEPRECATED@@@
+                    // https://github.com/dlang/DIPs/blob/1f5959abe482b1f9094f6484a7d0a3ade77fc2fc/DIPs/accepted/DIP1003.md
+                    // Deprecated in 2.091 - Can be removed from 2.101
+                    if (tk.value == TOK.identifier && tk.ident == Id._body)
+                        deprecation("Usage of the `body` keyword is deprecated. Use `do` instead.");
                     a = parseDeclarations(true, pAttrs, pAttrs.comment);
                     if (a && a.dim)
                         *pLastDecl = (*a)[a.dim - 1];
@@ -4627,6 +4632,11 @@ final class Parser(AST) : Lexer
                     (tk.value == TOK.leftParentheses || tk.value == TOK.leftCurly || tk.value == TOK.in_ || tk.value == TOK.out_ ||
                      tk.value == TOK.do_ || tk.value == TOK.identifier && tk.ident == Id._body))
                 {
+                    // @@@DEPRECATED@@@
+                    // https://github.com/dlang/DIPs/blob/1f5959abe482b1f9094f6484a7d0a3ade77fc2fc/DIPs/accepted/DIP1003.md
+                    // Deprecated in 2.091 - Can be removed from 2.101
+                    if (tk.value == TOK.identifier && tk.ident == Id._body)
+                        deprecation("Usage of the `body` keyword is deprecated. Use `do` instead.");
                     ts = null;
                 }
                 else
@@ -4991,7 +5001,13 @@ final class Parser(AST) : Lexer
 
         case TOK.identifier:
             if (token.ident == Id._body)
+            {
+                // @@@DEPRECATED@@@
+                // https://github.com/dlang/DIPs/blob/1f5959abe482b1f9094f6484a7d0a3ade77fc2fc/DIPs/accepted/DIP1003.md
+                // Deprecated in 2.091 - Can be removed from 2.101
+                deprecation("Usage of the `body` keyword is deprecated. Use `do` instead.");
                 goto case TOK.do_;
+            }
             goto default;
 
         case TOK.do_:
@@ -7182,7 +7198,13 @@ final class Parser(AST) : Lexer
 
             case TOK.identifier:
                 if (t.ident == Id._body)
+                {
+                    // @@@DEPRECATED@@@
+                    // https://github.com/dlang/DIPs/blob/1f5959abe482b1f9094f6484a7d0a3ade77fc2fc/DIPs/accepted/DIP1003.md
+                    // Deprecated in 2.091 - Can be removed from 2.101
+                    deprecation("Usage of the `body` keyword is deprecated. Use `do` instead.");
                     goto case TOK.do_;
+                }
                 goto default;
 
             case TOK.if_:

diff --git a/src/dmd/root/man.d b/src/dmd/root/man.d
@@ -26,7 +26,7 @@ version (Windows)
     {
         assert(strncmp(url, "http://", 7) == 0 || strncmp(url, "https://", 8) == 0);
     }
-    body
+    do
     {
         ShellExecuteA(null, "open", url, null, null, SW_SHOWNORMAL);
     }
@@ -38,7 +38,7 @@ else version (OSX)
     {
         assert(strncmp(url, "http://", 7) == 0 || strncmp(url, "https://", 8) == 0);
     }
-    body
+    do
     {
         pid_t childpid;
         const(char)*[5] args;
@@ -72,7 +72,7 @@ else version (Posix)
     {
         assert(strncmp(url, "http://", 7) == 0 || strncmp(url, "https://", 8) == 0);
     }
-    body
+    do
     {
         pid_t childpid;
         const(char)*[3] args;

diff --git a/test/compilable/b16967.d b/test/compilable/b16967.d
@@ -1,4 +1,4 @@
-/* 
+/*
  * REQUIRED_ARGS: -c
  * TEST_OUTPUT:
 ---
@@ -27,7 +27,7 @@ out(v)
             break;
     }
 }
-body
+do
 {
     return 42;
 }
diff --git a/test/compilable/interpret3.d b/test/compilable/interpret3.d
@@ -6440,7 +6440,7 @@ label:
             break label;        // doesn't work.
     }
 }
-body
+do
 {
     int x = 0;
 label:
@@ -7772,7 +7772,7 @@ enum KindEnum
     integer,
     arrayOf
 }
- 
+
 struct FullKind
 {
     KindEnum[] contents;

diff --git a/test/fail_compilation/fail17502.d b/test/fail_compilation/fail17502.d
@@ -11,9 +11,9 @@ class Foo
 {
     void foo()
     out (res) { assert(res > 5); }
-    body {}
+    do {}
 
     auto bar()
     out (res) { assert (res > 5); }
-    body { return; }
+    do { return; }
 }
diff --git a/test/fail_compilation/fail2350.d b/test/fail_compilation/fail2350.d
@@ -9,7 +9,7 @@ void test2350()
 in
 {
 }
-body
+do
 {
 	asm { naked; }
 }
diff --git a/test/fail_compilation/fail329.d b/test/fail_compilation/fail329.d
@@ -27,7 +27,7 @@ class A
         assert(x == 7);
         result++;
     }
-    body
+    do
     {
         return i;
     }
@@ -49,7 +49,7 @@ class B : A
         assert(result < 8);
         assert(x == 7);
     }
-    body
+    do
     {
         return i - 1;
     }

diff --git a/test/fail_compilation/fail330.d b/test/fail_compilation/fail330.d
@@ -7,4 +7,4 @@ fail_compilation/fail330.d(9): Error: variable `fail330.fun.result` cannot modif
 
 int fun()
 out(result) { result = 2; }
-body { return 1; }
+do { return 1; }
diff --git a/test/fail_compilation/fail6242.d b/test/fail_compilation/fail6242.d
@@ -6,4 +6,4 @@ fail_compilation/fail6242.d(9): Error: cannot implicitly override base class met
 */
 class A { void fun(int) {} }
 
-class B : A { void fun(int x) in { assert(x > 0); } body {} }
+class B : A { void fun(int x) in { assert(x > 0); } do {} }
diff --git a/test/fail_compilation/fail94.d b/test/fail_compilation/fail94.d
@@ -30,7 +30,7 @@ class B : A
     {
 	printf("B.clone()\n");
     }
-    body { return ia; }
+    do { return ia; }
 }
 
 void main()
@@ -59,4 +59,3 @@ void main()
 void bar(IA delegate() dg)
 {
 }
-
diff --git a/test/fail_compilation/fail9413.d b/test/fail_compilation/fail9413.d
@@ -40,7 +40,7 @@ in
         s = 10; // err
         a = 1;  // OK
     }
-    body
+    do
     {
         x = 10; // err
         y = 1;  // OK
@@ -68,7 +68,7 @@ out(r)
         s = 10; // err
         a = 1;  // OK
     }
-    body
+    do
     {
         x = 10; // err
         r = 10; // err
@@ -79,7 +79,7 @@ out(r)
     x = 10; // err
     r = 10; // err
 }
-body
+do
 {
     return 1;
 }
diff --git a/test/fail_compilation/fail9414a.d b/test/fail_compilation/fail9414a.d
@@ -42,7 +42,7 @@ class C
             s = 10; // err
             a = 1;  // OK
         }
-        body
+        do
         {
             x = 10; // err
             y = 1;  // OK
@@ -70,7 +70,7 @@ class C
             s = 10; // err
             a = 1;  // OK
         }
-        body
+        do
         {
             x = 10; // err
             r = 10; // err
@@ -81,7 +81,7 @@ class C
         x = 10; // err
         r = 10; // err
     }
-    body
+    do
     {
         return 1;
     }