Switch __opaque to some, per the latest rev of the proposal

Author: jckarter

include/swift/AST/DiagnosticsSema.def

@@ -1502,7 +1502,7 @@ ERROR(opaque_type_invalid_constraint,none,
       "an 'opaque' type must specify only 'Any', 'AnyObject', protocols, "
       "and/or a base class", ())
 ERROR(inferred_opaque_type,none,
-      "property definition has inferred type %0, involving the '__opaque' "
+      "property definition has inferred type %0, involving the 'some' "
       "return type of another declaration", (Type))
 
 // Extensions

include/swift/Parse/Token.h

@@ -166,9 +166,9 @@ class Token {
           getRawText().equals("__owned"))
         return false;
 
-      // ...or __opaque
-      if (getRawText().equals("__opaque"))
-        return false;
+/*      // ...or some
+      if (getRawText().equals("some"))
+        return false;*/
 
       return true;
     }

lib/AST/ASTPrinter.cpp

@@ -4143,7 +4143,7 @@ class TypePrinter : public TypeVisitor<TypePrinter> {
 
   void visitOpaqueTypeArchetypeType(OpaqueTypeArchetypeType *T) {
     // TODO(opaque): present opaque types with user-facing syntax
-    Printer << "(__opaque " << T->getOpaqueDecl()->getNamingDecl()->printRef();
+    Printer << "(some " << T->getOpaqueDecl()->getNamingDecl()->printRef();
     if (!T->getSubstitutions().empty()) {
       Printer << '<';
       auto replacements = T->getSubstitutions().getReplacementTypes();

lib/Demangling/NodePrinter.cpp

@@ -2260,7 +2260,7 @@ NodePointer NodePrinter::print(NodePointer Node, bool asPrefixContext) {
     Printer << ")";
     return nullptr;
   case Node::Kind::OpaqueReturnType:
-    Printer << "__opaque";
+    Printer << "some";
     return nullptr;
   case Node::Kind::OpaqueReturnTypeOf:
     Printer << "<<opaque return type of ";

lib/Parse/ParseDecl.cpp

@@ -2307,7 +2307,7 @@ bool Parser::parseDeclModifierList(DeclAttributes &Attributes,
 ///     'inout' attribute-list-clause attribute-list
 ///     '__shared' attribute-list-clause attribute-list
 ///     '__owned' attribute-list-clause attribute-list
-///     '__opaque' attribute-list-clause attribute-list
+///     'some' attribute-list-clause attribute-list
 ///   attribute-list-clause:
 ///     '@' attribute
 ///     '@' attribute attribute-list-clause

lib/Parse/ParseType.cpp

@@ -670,7 +670,7 @@ ParserResult<TypeRepr> Parser::parseTypeIdentifier() {
 /// parseTypeSimpleOrComposition
 ///
 ///   type-composition:
-///     '__opaque'? type-simple
+///     'some'? type-simple
 ///     type-composition '&' type-simple
 ParserResult<TypeRepr>
 Parser::parseTypeSimpleOrComposition(Diag<> MessageID,
@@ -681,7 +681,7 @@ Parser::parseTypeSimpleOrComposition(Diag<> MessageID,
   SourceLoc opaqueLoc;
   if (Context.LangOpts.EnableOpaqueResultTypes
       && Tok.is(tok::identifier)
-      && Tok.getRawText() == "__opaque") {
+      && Tok.getRawText() == "some") {
     opaqueLoc = consumeToken();
   }
 
@@ -741,10 +741,10 @@ Parser::parseTypeSimpleOrComposition(Diag<> MessageID,
       consumeToken(); // consume '&'
     }
 
-    // Diagnose invalid `__opaque` after an ampersand.
+    // Diagnose invalid `some` after an ampersand.
     if (Context.LangOpts.EnableOpaqueResultTypes
         && Tok.is(tok::identifier)
-        && Tok.getRawText() == "__opaque") {
+        && Tok.getRawText() == "some") {
       auto badLoc = consumeToken();
 
       // TODO: Fixit to move to beginning of composition.
@@ -894,7 +894,7 @@ ParserResult<TypeRepr> Parser::parseOldStyleProtocolComposition() {
 ///   type-tuple-body:
 ///     type-tuple-element (',' type-tuple-element)* '...'?
 ///   type-tuple-element:
-///     identifier ':' type
+///     identifier? identifier ':' type
 ///     type
 ParserResult<TupleTypeRepr> Parser::parseTypeTupleBody() {
   SyntaxParsingContext TypeContext(SyntaxContext, SyntaxKind::TupleType);
@@ -928,16 +928,20 @@ ParserResult<TupleTypeRepr> Parser::parseTypeTupleBody() {
       Backtracking.emplace(*this);
       ObsoletedInOutLoc = consumeToken(tok::kw_inout);
     }
+                                    
+    // If the label is "some", this could end up being an opaque type
+    // description if there's `some <identifier>` without a following colon,
+    // so we may need to backtrack as well.
+    if (Tok.getText().equals("some")) {
+      Backtracking.emplace(*this);
+    }
 
     // If the tuple element starts with a potential argument label followed by a
     // ':' or another potential argument label, then the identifier is an
     // element tag, and it is followed by a type annotation.
-    if (Tok.canBeArgumentLabel() &&
-        (peekToken().is(tok::colon) || peekToken().canBeArgumentLabel())) {
-      if (Backtracking)
-        // Found obsoleted 'inout' use.
-        Backtracking->cancelBacktrack();
-
+    if (Tok.canBeArgumentLabel()
+        && (peekToken().is(tok::colon)
+            || peekToken().canBeArgumentLabel())) {
       // Consume a name.
       element.NameLoc = consumeArgumentLabel(element.Name);
 
@@ -946,8 +950,19 @@ ParserResult<TupleTypeRepr> Parser::parseTypeTupleBody() {
         element.SecondNameLoc = consumeArgumentLabel(element.SecondName);
 
       // Consume the ':'.
-      if (!consumeIf(tok::colon, element.ColonLoc))
-        diagnose(Tok, diag::expected_parameter_colon);
+      if (consumeIf(tok::colon, element.ColonLoc)) {
+        // If we succeed, then we successfully parsed a label.
+        if (Backtracking)
+          Backtracking->cancelBacktrack();
+      // Otherwise, if we can't backtrack to parse this as a type,
+      // this is a syntax error.
+      } else {
+        if (!Backtracking) {
+          diagnose(Tok, diag::expected_parameter_colon);
+        }
+        element.NameLoc = SourceLoc();
+        element.SecondNameLoc = SourceLoc();
+      }
 
     } else if (Backtracking) {
       // If we don't have labels, 'inout' is not a obsoleted use.

test/IRGen/opaque_result_type.swift

@@ -36,7 +36,7 @@ extension String: P {
   // -- conformance to O
   // CHECK-SAME:         @"get_witness_table S2i18opaque_result_type1OHpyHC
   // CHECK-SAME:  }>
-  func poo() -> __opaque O {
+  func poo() -> some O {
     return 0
   }
 }
@@ -52,7 +52,7 @@ public class C: P, Q {
   // -- conformance to O
   // CHECK-SAME:         @"get_witness_table S2i18opaque_result_type1OHpyHC
   // CHECK-SAME:  }>
-  func poo() -> __opaque O {
+  func poo() -> some O {
     return 0
   }
 
@@ -68,7 +68,7 @@ public class C: P, Q {
   // -- conformance to O2
   // CHECK-SAME:         @"get_witness_table S2i18opaque_result_type2O2HpyHC
   // CHECK-SAME:  }>
-  func qoo() -> __opaque O & O2 {
+  func qoo() -> some O & O2 {
     return 0
   }
 }
@@ -83,7 +83,7 @@ public class C: P, Q {
 // -- conformance to P
 // CHECK-SAME:         @"get_witness_table S2S18opaque_result_type1PHpyHC
 // CHECK-SAME:  }>
-func foo(x: String) -> __opaque P {
+func foo(x: String) -> some P {
   return x
 }
 
@@ -97,7 +97,7 @@ func foo(x: String) -> __opaque P {
 // -- conformance to Q
 // CHECK-SAME:         @"get_witness_table 18opaque_result_type1CCAcA1QHPyHC
 // CHECK-SAME:  }>
-func bar(y: C) -> __opaque Q {
+func bar(y: C) -> some Q {
   return y
 }
 
@@ -113,7 +113,7 @@ func bar(y: C) -> __opaque Q {
 // -- conformance to Q
 // CHECK-SAME:         @"get_witness_table 18opaque_result_type1PRzAA1QRzlxAaC
 // CHECK-SAME:  }>
-func baz<T: P & Q>(z: T) -> __opaque P & Q {
+func baz<T: P & Q>(z: T) -> some P & Q {
   return z
 }
 

test/SILGen/opaque_result_type.swift

@@ -9,37 +9,37 @@ struct AddrOnly: P { var field: P }
 class C: Q {}
 
 // CHECK-LABEL: sil hidden {{.*}}11valueToAddr1xQr
-func valueToAddr(x: String) -> __opaque P {
+func valueToAddr(x: String) -> some P {
   // CHECK: [[UNDERLYING:%.*]] = unchecked_addr_cast %0
   // CHECK: [[VALUE_COPY:%.*]] = copy_value %1
   // CHECK: store [[VALUE_COPY]] to [init] [[UNDERLYING]]
   return x
 }
 
 // CHECK-LABEL: sil hidden {{.*}}10addrToAddr1xQr
-func addrToAddr(x: AddrOnly) -> __opaque P {
+func addrToAddr(x: AddrOnly) -> some P {
   // CHECK: [[UNDERLYING:%.*]] = unchecked_addr_cast %0
   // CHECK: copy_addr %1 to [initialization] [[UNDERLYING]]
   return x
 }
 
 // CHECK-LABEL: sil hidden {{.*}}13genericAddrToE01xQr
-func genericAddrToAddr<T: P>(x: T) -> __opaque P {
+func genericAddrToAddr<T: P>(x: T) -> some P {
   // CHECK: [[UNDERLYING:%.*]] = unchecked_addr_cast %0
   // CHECK: copy_addr %1 to [initialization] [[UNDERLYING]]
   return x
 }
 
 // CHECK-LABEL: sil hidden {{.*}}12valueToValue1xQr
-func valueToValue(x: C) -> __opaque Q {
+func valueToValue(x: C) -> some Q {
   // CHECK: [[VALUE_COPY:%.*]] = copy_value %0
   // CHECK: [[CAST_TO_OPAQUE:%.*]] = unchecked_ref_cast [[VALUE_COPY]]
   // CHECK: return [[CAST_TO_OPAQUE]]
   return x
 }
 
 // CHECK-LABEL: sil hidden {{.*}}13reabstraction1xQr
-func reabstraction(x: @escaping () -> ()) -> __opaque Any {
+func reabstraction(x: @escaping () -> ()) -> some Any {
   // CHECK [[UNDERLYING:%.*]] = unchecked_addr_cast %0 : ${{.*}} to $*@callee_guaranteed () -> @out ()
   // CHECK: [[VALUE_COPY:%.*]] = copy_value %1
   // CHECK: [[VALUE_REABSTRACT:%.*]] = partial_apply [callee_guaranteed] {{%.*}}([[VALUE_COPY]])

test/Serialization/Inputs/OpaqueCrossFileB.swift

@@ -4,6 +4,6 @@ public struct FooImpl: Foo {
   public init() {}
 }
 
-public func anyFoo() -> __opaque Foo {
+public func anyFoo() -> some Foo {
   return FooImpl()
 }