Merge remote-tracking branch 'origin/swift-3-api-guidelines' into swift-3-omit-needless-words

Author: DougGregor

docs/ABI.rst

@@ -939,6 +939,7 @@ Types
   nominal-type-kind ::= 'C'                  // class
   nominal-type-kind ::= 'O'                  // enum
   nominal-type-kind ::= 'V'                  // struct
+  declaration-name ::= context decl-name
   archetype ::= 'Q' index                    // archetype with depth=0, idx=N
   archetype ::= 'Qd' index index             // archetype with depth=M+1, idx=N
   archetype ::= associated-type
@@ -1179,8 +1180,8 @@ using its substitution, ``CS1_``. The
 third argument type will mangle using the substitution for ``zim``,
 ``CS_7zippity``. (It also acquires substitution ``S2_`` which would be used
 if it mangled again.) The result type will mangle using the substitution for
-``zim.zang``, ``CS0_zoo`` (and acquire substitution ``S3_``). The full
-function type thus mangles as ``fTCC3zim4zang4zungCS1_CS_7zippity_CS0_zoo``.
+``zim.zang``, ``CS0_3zoo`` (and acquire substitution ``S3_``). The full
+function type thus mangles as ``fTCC3zim4zang4zungCS1_CS_7zippity_CS0_3zoo``.
 
 ::
 

docs/OptimizationTips.rst

@@ -446,7 +446,7 @@ argument drops from being O(n), depending on the size of the tree to O(1).
 
 ::
 
-  struct tree : P {
+  struct Tree : P {
     var node : [P?]
     init() {
       node = [ thing ]

docs/proposals/Accessors.rst

@@ -1107,7 +1107,7 @@ Are these conditions true?
 
 Recall that an addressor is invoked for an l-value of the form::
 
-  base.memory
+  base.pointee
 
 or::
 

docs/proposals/OptimizerEffects.rst

@@ -413,7 +413,7 @@ It will see the following calls because methods with attributes are not inlined.
     for i in 0 .. A.size {
       makeUnique(&A)
       addr = getElementAddr(i, &A)
-      addr.memory = value
+      addr.pointee = value
       f()
     }
   }

include/swift/AST/ASTContext.h

@@ -425,8 +425,8 @@ class ASTContext {
   /// Retrieve the declaration of Swift.Unmanaged<T>.
   NominalTypeDecl *getUnmanagedDecl() const;
 
-  /// Retrieve the declaration of the "memory" property of a pointer type.
-  VarDecl *getPointerMemoryPropertyDecl(PointerTypeKind ptrKind) const;
+  /// Retrieve the declaration of the "pointee" property of a pointer type.
+  VarDecl *getPointerPointeePropertyDecl(PointerTypeKind ptrKind) const;
 
   /// Retrieve the declaration of Swift.Void.
   TypeAliasDecl *getVoidDecl() const;

include/swift/AST/Attr.def

@@ -240,6 +240,8 @@ SIMPLE_DECL_ATTR(indirect, Indirect,
 SIMPLE_DECL_ATTR(warn_unqualified_access, WarnUnqualifiedAccess,
                  OnFunc /*| OnVar*/ | LongAttribute, 61)
 
+DECL_ATTR(_migration_id, MigrationId, OnAnyDecl, 62)
+
 #undef TYPE_ATTR
 #undef DECL_ATTR_ALIAS
 #undef SIMPLE_DECL_ATTR

include/swift/AST/Attr.h

@@ -1148,6 +1148,31 @@ class WarnUnusedResultAttr : public DeclAttribute {
   }
 };
 
+/// The internal @_migration_id attribute, which is used to keep track of stdlib
+/// changes for migration purposes.
+class MigrationIdAttr : public DeclAttribute {
+  StringRef Ident;
+  StringRef PatternId;
+
+public:
+  MigrationIdAttr(SourceLoc atLoc, SourceLoc attrLoc, SourceLoc lParenLoc,
+                  StringRef ident, StringRef patternId,
+                  SourceLoc rParenLoc, bool implicit)
+    : DeclAttribute(DAK_MigrationId, attrLoc,
+                    SourceRange(atLoc, rParenLoc), implicit),
+      Ident(ident), PatternId(patternId) {}
+
+  /// Retrieve the migration identifier associated with the symbol.
+  StringRef getIdent() const { return Ident; }
+
+  /// Retrieve pattern identifier associated with the symbol.
+  StringRef getPatternId() const { return PatternId; }
+
+  static bool classof(const DeclAttribute *DA) {
+    return DA->getKind() == DAK_MigrationId;
+  }
+};
+
 /// \brief Attributes that may be applied to declarations.
 class DeclAttributes {
   /// Linked list of declaration attributes.

include/swift/AST/Decl.h

@@ -2242,16 +2242,6 @@ class ValueDecl : public Decl {
   /// If \p DC is null, returns true only if this declaration is public.
   bool isAccessibleFrom(const DeclContext *DC) const;
 
-  /// Get the innermost declaration context that can provide generic
-  /// parameters used within this declaration.
-  DeclContext *getPotentialGenericDeclContext();
-
-  /// Get the innermost declaration context that can provide generic
-  /// parameters used within this declaration.
-  const DeclContext *getPotentialGenericDeclContext() const {
-    return const_cast<ValueDecl *>(this)->getPotentialGenericDeclContext();
-  }
-
   /// Retrieve the "interface" type of this value, which is the type used when
   /// the declaration is viewed from the outside. For a generic function,
   /// this will have generic function type using generic parameters rather than
@@ -4568,11 +4558,7 @@ class AbstractFunctionDecl : public ValueDecl, public DeclContext {
   /// and return the type to be used for the 'self' argument of the type, or an
   /// empty Type() if no 'self' argument should exist.  This can
   /// only be used after name binding has resolved types.
-  ///
-  /// \param outerGenericParams If non-NULL, and this function is an instance
-  /// of a generic type, will be set to the generic parameter list of that
-  /// generic type.
-  Type computeSelfType(GenericParamList **outerGenericParams = nullptr);
+  Type computeSelfType();
 
   /// \brief If this is a method in a type or extension thereof, compute
   /// and return the type to be used for the 'self' argument of the interface

include/swift/AST/DeclContext.h

@@ -364,6 +364,11 @@ class alignas(1 << DeclContextAlignInBits) DeclContext {
   /// or a concrete type nested inside a generic type context.
   bool isGenericTypeContext() const;
 
+  /// Determine the maximum depth of the current generic type context's generic
+  /// parameters. If the current context is not a generic type context, returns
+  /// the maximum depth of any generic parameter in this context.
+  unsigned getGenericTypeContextDepth() const;
+
   /// Returns true if lookups within this context could affect downstream files.
   ///
   /// \param functionsAreNonCascading If true, functions are considered non-

include/swift/AST/DiagnosticsParse.def

@@ -126,8 +126,8 @@ ERROR(lex_expected_binary_exponent_in_hex_float_literal,lexing,none,
       "hexadecimal floating point literal must end with an exponent", ())
 ERROR(lex_unexpected_block_comment_end,lexing,none,
       "unexpected end of block comment", ())
-ERROR(lex_unary_equal_is_reserved,lexing,none,
-      "%select{prefix|postfix}0 '=' is reserved", (unsigned))
+ERROR(lex_unary_equal,lexing,none,
+      "'=' must have consistent whitespace on both sides", ())
 ERROR(lex_unary_postfix_dot_is_reserved,lexing,none,
       "postfix '.' is reserved", ())
 ERROR(lex_editor_placeholder,lexing,none,
@@ -364,6 +364,9 @@ ERROR(operator_decl_inner_scope,decl_parsing,none,
       "'operator' may only be declared at file scope", ())
 ERROR(expected_operator_name_after_operator,decl_parsing,PointsToFirstBadToken,
       "expected operator name in operator declaration", ())
+ERROR(identifier_when_expecting_operator,decl_parsing,PointsToFirstBadToken,
+      "%0 is considered to be an identifier, not an operator", (Identifier))
+
 ERROR(operator_decl_no_fixity,decl_parsing,none,
       "operator must be declared as 'prefix', 'postfix', or 'infix'", ())
 ERROR(expected_lbrace_after_operator,decl_parsing,PointsToFirstBadToken,
@@ -1174,6 +1177,20 @@ WARNING(attr_warn_unused_result_unknown_parameter,attribute_parsing,none,
 ERROR(attr_warn_unused_result_expected_rparen,attribute_parsing,none,
       "expected ')' after 'warn_unused_result' attribute", ())
 
+// _migration_id
+WARNING(attr_migration_id_expected_name,attribute_parsing,none,
+        "expected parameter 'pattern'", ())
+WARNING(attr_migration_id_unknown_parameter,attribute_parsing,none,
+        "unknown parameter '%0' in '_migration_id' attribute", (StringRef))
+ERROR(attr_migration_id_expected_eq,attribute_parsing,none,
+      "expected '=' following '%0' parameter", (StringRef))
+ERROR(attr_migration_id_expected_string,attribute_parsing,none,
+      "expected a string following '=' for '%0' parameter", (StringRef))
+WARNING(attr_migration_id_duplicate_parameter,attribute_parsing,none,
+      "duplicate '%0' parameter; previous value will be ignored", (StringRef))
+ERROR(attr_migration_id_expected_rparen,attribute_parsing,none,
+      "expected ')' after '_migration_id' attribute", ())
+
 //------------------------------------------------------------------------------
 // Generics parsing diagnostics
 //------------------------------------------------------------------------------

include/swift/AST/DiagnosticsSIL.def

@@ -60,8 +60,8 @@ ERROR(invalid_sil_builtin,sil_gen,none,
 ERROR(could_not_find_bridge_type,sil_gen,none,
       "could not find Objective-C bridge type for type %0; "
       "did you forget to import Foundation?", (Type))
-ERROR(could_not_find_pointer_memory_property,sil_gen,none,
-      "could not find 'memory' property of pointer type %0", (Type))
+ERROR(could_not_find_pointer_pointee_property,sil_gen,none,
+      "could not find 'pointee' property of pointer type %0", (Type))
 
 ERROR(writeback_overlap_property,sil_gen,none,
       "inout writeback to computed property %0 occurs in multiple arguments to"

include/swift/AST/DiagnosticsSema.def

@@ -420,23 +420,42 @@ ERROR(ambiguous_module_type,sema_nb,none,
 ERROR(use_nonmatching_operator,sema_nb,none,
       "%0 is not a %select{binary|prefix unary|postfix unary}1 operator",
       (Identifier, unsigned))
+
+ERROR(unspaced_binary_operator_fixit,sema_nb,none,
+      "missing whitespace between %0 and %1 operators",
+      (Identifier, Identifier, bool))
+ERROR(unspaced_binary_operator,sema_nb,none,
+      "ambiguous missing whitespace between unary and binary operators", ())
+NOTE(unspaced_binary_operators_candidate,sema_nb,none,
+     "could be %select{binary|postfix}2 %0 and %select{prefix|binary}2 %1",
+     (Identifier, Identifier, bool))
+ERROR(unspaced_unary_operator,sema_nb,none,
+      "unary operators may not be juxtaposed; parenthesize inner expression",
+      ())
+
+
 ERROR(use_unresolved_identifier,sema_nb,none,
-      "use of unresolved identifier %0", (Identifier))
+      "use of unresolved %select{identifier|operator}1 %0", (Identifier, bool))
 ERROR(use_undeclared_type,sema_nb,none,
       "use of undeclared type %0", (Identifier))
 ERROR(use_undeclared_type_did_you_mean,sema_nb,none,
-"use of undeclared type %0; did you mean to use '%1'?", (Identifier, StringRef))
+      "use of undeclared type %0; did you mean to use '%1'?", (Identifier, StringRef))
 NOTE(note_remapped_type,sema_nb,none,
-  "did you mean to use '%0'?", (StringRef))
+     "did you mean to use '%0'?", (StringRef))
 ERROR(identifier_init_failure,sema_nb,none,
-  "could not infer type for %0", (Identifier))
+      "could not infer type for %0", (Identifier))
 ERROR(pattern_used_in_type,sema_nb,none,
       "%0 used within its own type", (Identifier))
 NOTE(note_module_as_type,sema_nb,none,
      "cannot use module %0 as a type", (Identifier))
 
 ERROR(use_unknown_object_literal,sema_nb,none,
      "use of unknown object literal name %0", (Identifier))
+ERROR(object_literal_default_type_missing,sema_nb,none,
+     "could not infer type of %0 literal", (StringRef))
+NOTE(object_literal_resolve_import,sema_nb,none,
+     "import %0 to use '%1' as the default %2 literal type",
+     (StringRef, StringRef, StringRef))
 
 ERROR(use_non_type_value,sema_nb,none,
       "%0 is not a type", (Identifier))

include/swift/AST/GenericSignature.h

@@ -202,9 +202,10 @@ class GenericSignature : public llvm::FoldingSetNode {
   /// Determine the superclass bound on the given dependent type.
   Type getSuperclassBound(Type type, ModuleDecl &mod);
 
+  using ConformsToArray = SmallVector<ProtocolDecl *, 2>;
   /// Determine the set of protocols to which the given dependent type
   /// must conform.
-  SmallVector<ProtocolDecl *, 2> getConformsTo(Type type, ModuleDecl &mod);
+  ConformsToArray getConformsTo(Type type, ModuleDecl &mod);
 
   /// Determine whether the given dependent type is equal to a concrete type.
   bool isConcreteType(Type type, ModuleDecl &mod);

include/swift/AST/IRGenOptions.h

@@ -126,9 +126,6 @@ class IRGenOptions {
   /// Whether we should embed the bitcode file.
   IRGenEmbedMode EmbedMode : 2;
 
-  /// For resilient access to super's members for testing.
-  unsigned ForceResilientSuperDispatch: 1;
-
   /// List of backend command-line options for -embed-bitcode.
   std::vector<uint8_t> CmdArgs;
 
@@ -138,8 +135,7 @@ class IRGenOptions {
                    DisableLLVMARCOpts(false), DisableLLVMSLPVectorizer(false),
                    DisableFPElim(true), Playground(false),
                    EmitStackPromotionChecks(false), GenerateProfile(false),
-                   EmbedMode(IRGenEmbedMode::None),
-                   ForceResilientSuperDispatch(false)
+                   EmbedMode(IRGenEmbedMode::None)
                    {}
 
   /// Gets the name of the specified output filename.

include/swift/AST/Identifier.h

@@ -109,9 +109,6 @@ class Identifier {
   /// isOperatorContinuationCodePoint - Return true if the specified code point
   /// is a valid operator code point.
   static bool isOperatorContinuationCodePoint(uint32_t C) {
-    // '.' is a special case. It can only appear in '..'.
-    if (C == '.')
-      return false;
     if (isOperatorStartCodePoint(C))
       return true;
 

include/swift/AST/KnownIdentifiers.def

@@ -27,7 +27,7 @@ IDENTIFIER(allocWithZone)
 IDENTIFIER(atIndexedSubscript)
 IDENTIFIER_(bridgeToObjectiveC)
 IDENTIFIER_WITH_NAME(code_, "_code")
-IDENTIFIER(CVarArgType)
+IDENTIFIER(CVarArg)
 IDENTIFIER(Darwin)
 IDENTIFIER(dealloc)
 IDENTIFIER(deinit)

include/swift/Basic/DemangleNodes.def

@@ -128,6 +128,7 @@ NODE(QualifiedArchetype)
 NODE(ReabstractionThunk)
 NODE(ReabstractionThunkHelper)
 NODE(ReturnType)
+NODE(SILBoxType)
 NODE(SelfTypeRef)
 CONTEXT_NODE(Setter)
 NODE(SpecializationPassID)

include/swift/Option/FrontendOptions.td

@@ -190,9 +190,6 @@ def emit_verbose_sil : Flag<["-"], "emit-verbose-sil">,
 def use_native_super_method : Flag<["-"], "use-native-super-method">,
   HelpText<"Use super_method for super calls in native classes">;
 
-def force_resilient_super_dispatch: Flag<["-"], "force-resilient-super-dispatch">,
-  HelpText<"Assume all super member accesses are resilient">;
-
 def disable_self_type_mangling : Flag<["-"], "disable-self-type-mangling">,
   HelpText<"Disable including Self type in method type manglings">;
 

include/swift/Parse/Lexer.h

@@ -240,6 +240,15 @@ class Lexer {
     restoreState(S);
   }
 
+  /// \brief Retrieve the Token referred to by \c Loc.
+  ///
+  /// \param SM The source manager in which the given source location
+  /// resides.
+  ///
+  /// \param Loc The source location of the beginning of a token.
+  static Token getTokenAtLocation(const SourceManager &SM, SourceLoc Loc);
+
+
   /// \brief Retrieve the source location that points just past the
   /// end of the token referred to by \c Loc.
   ///
@@ -299,6 +308,10 @@ class Lexer {
   /// reserved word.
   static tok kindOfIdentifier(StringRef Str, bool InSILMode);
 
+  /// \brief Determines if the given string is a valid operator identifier,
+  /// without escaping characters.
+  static bool isOperator(StringRef string);
+
   SourceLoc getLocForStartOfBuffer() const {
     return SourceLoc(llvm::SMLoc::getFromPointer(BufferStart));
   }

include/swift/Runtime/Concurrent.h

@@ -145,7 +145,7 @@ template <class KeyTy, class ValueTy> struct ConcurrentMapNode {
 /// The method findOrAllocateNode searches the binary tree in search of the
 /// exact Key value. If it finds an edge that points to NULL that should
 /// contain the value then it tries to compare and swap the new node into
-/// place. If it looses the race to a different thread it de-allocates
+/// place. If it loses the race to a different thread it de-allocates
 /// the node and starts the search again since the new node should
 /// be placed (or found) on the new link. See findOrAllocateNode for more
 /// details.
@@ -164,7 +164,7 @@ template <class KeyTy, class ValueTy> class ConcurrentMap {
   /// accelerating the search of the same value again and again.
   std::atomic<NodeTy *> LastSearch;
 
-  /// Search a for a node with key value \p. If the node does not exist then
+  /// Search for a node with key value \p. If the node does not exist then
   /// allocate a new bucket and add it to the tree.
   ConcurrentList<ValueTy> &findOrAllocateNode(KeyTy Key) {
     // Try looking at the last node we searched.

include/swift/SILOptimizer/PassManager/PassManager.h

@@ -17,6 +17,7 @@
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/Support/ErrorHandling.h"
+#include <vector>
 
 #ifndef SWIFT_SILOPTIMIZER_PASSMANAGER_PASSMANAGER_H
 #define SWIFT_SILOPTIMIZER_PASSMANAGER_PASSMANAGER_H
@@ -41,6 +42,9 @@ class SILPassManager {
   /// A list of registered analysis.
   llvm::SmallVector<SILAnalysis *, 16> Analysis;
 
+  /// The worklist of functions to be processed by function passes.
+  std::vector<SILFunction *> FunctionWorklist;
+
   // Name of the current optimization stage for diagnostics.
   std::string StageName;
 
@@ -164,7 +168,11 @@ class SILPassManager {
   /// Run the passes in \p FuncTransforms. Return true
   /// if the pass manager requested to stop the execution
   /// of the optimization cycle (this is a debug feature).
-  bool runFunctionPasses(PassList FuncTransforms);
+  void runFunctionPasses(PassList FuncTransforms);
+
+  /// A helper function that returns (based on SIL stage and debug
+  /// options) whether we should continue running passes.
+  bool continueTransforming();
 
   /// Displays the call graph in an external dot-viewer.
   /// This function is meant for use from the debugger.

include/swift/Serialization/ModuleFormat.h

@@ -1339,6 +1339,13 @@ namespace decls_block {
                // strings, separated by the prior index
   >;
 
+  using MigrationIdDeclAttrLayout = BCRecordLayout<
+    MigrationId_DECL_ATTR,
+    BCVBR<6>,  // index at the end of the ident,
+    BCBlob     // blob contains the ident and pattern
+               // strings, separated by the prior index
+  >;
+
 #define SIMPLE_DECL_ATTR(X, CLASS, ...) \
   using CLASS##DeclAttrLayout = BCRecordLayout< \
     CLASS##_DECL_ATTR, \