Merge pull request #2103 from tanadeau/sr-1052-clang-importer

lattner · lattner · commit d698e4fe918c · 2016-04-12T19:19:30.000-07:00
[WIP][Clang][SR-1052] Imported C decls w/o warn_unused_result get @discardableResult
diff --git a/lib/ClangImporter/ImportDecl.cpp b/lib/ClangImporter/ImportDecl.cpp
@@ -5604,6 +5604,12 @@ void ClangImporter::Implementation::importAttributes(
     MappedDecl->getAttrs().add(new (C) WarnUnusedResultAttr(SourceLoc(),
                                                             SourceLoc(),
                                                             false));
+  } else {
+    if (auto MD = dyn_cast<FuncDecl>(MappedDecl)) {
+      if (!MD->getResultType()->isVoid()) {
+        MD->getAttrs().add(new (C) DiscardableResultAttr(/*implicit*/false));
+      }
+    }
   }
   // Map __attribute__((const)).
   if (ClangDecl->hasAttr<clang::ConstAttr>()) {
diff --git a/test/ClangModules/Inputs/SwiftPrivateAttr.txt b/test/ClangModules/Inputs/SwiftPrivateAttr.txt
@@ -8,19 +8,26 @@ class Foo : NSObject, __PrivProto {
   func __noArgs()
   func __oneArg(_ arg: Int32)
   func __twoArgs(_ arg: Int32, other arg2: Int32)
+  @discardableResult
   class func __foo() -> Self!
+  @discardableResult
   class func __withNoArgs() -> Self!
   convenience init!(__oneArg arg: Int32)
   @available(*, unavailable, message: "use object construction 'Foo(__oneArg:)'")
+  @discardableResult
   class func __withOneArg(_ arg: Int32) -> Self!
   convenience init!(__twoArgs arg: Int32, other arg2: Int32)
   @available(*, unavailable, message: "use object construction 'Foo(__twoArgs:other:)'")
+  @discardableResult
   class func __withTwoArgs(_ arg: Int32, other arg2: Int32) -> Self!
   convenience init!(__ arg: Int32)
   @available(*, unavailable, message: "use object construction 'Foo(__:)'")
+  @discardableResult
   class func __foo(_ arg: Int32) -> Self!
+  @discardableResult
   func objectForKeyedSubscript(_ index: AnyObject!) -> AnyObject!
   func __setObject(_ object: AnyObject!, forKeyedSubscript index: AnyObject!)
+  @discardableResult
   func __objectAtIndexedSubscript(_ index: Int32) -> AnyObject!
   func setObject(_ object: AnyObject!, atIndexedSubscript index: Int32)
   init()
diff --git a/test/IDE/Inputs/mock-sdk/Foo.printed.recursive.txt b/test/IDE/Inputs/mock-sdk/Foo.printed.recursive.txt
@@ -69,8 +69,11 @@ typealias FooTypedef1 = Int32
 var fooIntVar: Int32
 
 /// Aaa.  fooFunc1.  Bbb.
+@discardableResult
 func fooFunc1(_ a: Int32) -> Int32
+@discardableResult
 func fooFunc1AnonymousParam(_: Int32) -> Int32
+@discardableResult
 func fooFunc3(_ a: Int32, _ b: Float, _ c: Double, _ d: UnsafeMutablePointer<Int32>!) -> Int32
 func fooFuncWithBlock(_ blk: ((Float) -> Int32)!)
 func fooFuncWithFunctionPointer(_ fptr: (@convention(c) (Float) -> Int32)!)
@@ -111,8 +114,10 @@ func fooFuncWithComment4()
 func fooFuncWithComment5()
 
 /// Aaa.  redeclaredInMultipleModulesFunc1.  Bbb.
+@discardableResult
 func redeclaredInMultipleModulesFunc1(_ a: Int32) -> Int32
 @available(*, unavailable, message: "Variadic function is unavailable")
+@discardableResult
 func fooFuncUsingVararg(_ a: Int32, _ varargs: Any...) -> Int32
 
 /// Aaa.  FooProtocolBase.  Bbb.
@@ -141,7 +146,9 @@ protocol FooProtocolDerived : FooProtocolBase {
 class FooClassBase {
   class func fooBaseInstanceFunc0()
   func fooBaseInstanceFunc0()
+  @discardableResult
   class func fooBaseInstanceFunc1(_ anObject: AnyObject!) -> FooClassBase!
+  @discardableResult
   func fooBaseInstanceFunc1(_ anObject: AnyObject!) -> FooClassBase!
   init!()
   convenience init!(float f: Float)
@@ -150,6 +157,7 @@ class FooClassBase {
   class func fooBaseClassFunc0()
   /*not inherited*/ init!(_ x: Int32)
   @available(*, unavailable, message: "use object construction 'FooClassBase(_:)'")
+  @discardableResult
   class func fooClassBase(_ x: Int32) -> FooClassBase!
 }
 
@@ -196,17 +204,25 @@ struct _InternalStruct {
   init(x: Int32)
 }
 extension FooClassBase {
+  @discardableResult
   class func _internalMeth1() -> AnyObject!
+  @discardableResult
   func _internalMeth1() -> AnyObject!
 }
 extension FooClassBase {
+  @discardableResult
   class func _internalMeth2() -> AnyObject!
+  @discardableResult
   func _internalMeth2() -> AnyObject!
+  @discardableResult
   class func nonInternalMeth() -> AnyObject!
+  @discardableResult
   func nonInternalMeth() -> AnyObject!
 }
 extension FooClassBase {
+  @discardableResult
   class func _internalMeth3() -> AnyObject!
+  @discardableResult
   func _internalMeth3() -> AnyObject!
 }
 protocol _InternalProt {
@@ -238,6 +254,7 @@ class FooClassWithClassProperties : FooClassBase {
 class FooUnavailableMembers : FooClassBase {
   convenience init!(int i: Int32)
   @available(*, unavailable, message: "use object construction 'FooUnavailableMembers(int:)'")
+  @discardableResult
   class func withInt(_ i: Int32) -> Self!
   @available(*, unavailable, message: "x")
   func unavailable()
@@ -293,6 +310,7 @@ enum SCNFilterMode : Int {
   @available(*, unavailable)
   case SCNNoFiltering
 }
+@discardableResult
 func fooSubFunc1(_ a: Int32) -> Int32
 struct FooSubEnum1 : RawRepresentable, Equatable {
   init(_ rawValue: UInt32)
diff --git a/test/IDE/Inputs/mock-sdk/Foo.printed.txt b/test/IDE/Inputs/mock-sdk/Foo.printed.txt
@@ -85,9 +85,12 @@ typealias FooTypedef1 = Int32
 var fooIntVar: Int32
 
 /// Aaa.  fooFunc1.  Bbb.
+@discardableResult
 func fooFunc1(_ a: Int32) -> Int32
 
+@discardableResult
 func fooFunc1AnonymousParam(_: Int32) -> Int32
+@discardableResult
 func fooFunc3(_ a: Int32, _ b: Float, _ c: Double, _ d: UnsafeMutablePointer<Int32>!) -> Int32
 
 /*
@@ -135,9 +138,11 @@ func fooFuncWithComment4()
 func fooFuncWithComment5()
 
 /// Aaa.  redeclaredInMultipleModulesFunc1.  Bbb.
+@discardableResult
 func redeclaredInMultipleModulesFunc1(_ a: Int32) -> Int32
 
 @available(*, unavailable, message: "Variadic function is unavailable")
+@discardableResult
 func fooFuncUsingVararg(_ a: Int32, _ varargs: Any...) -> Int32 // This comment should not show without decl.
 
 /// Aaa.  FooProtocolBase.  Bbb.
@@ -170,7 +175,9 @@ protocol FooProtocolDerived : FooProtocolBase {
 class FooClassBase {
   class func fooBaseInstanceFunc0()
   func fooBaseInstanceFunc0()
+  @discardableResult
   class func fooBaseInstanceFunc1(_ anObject: AnyObject!) -> FooClassBase!
+  @discardableResult
   func fooBaseInstanceFunc1(_ anObject: AnyObject!) -> FooClassBase!
   init!()
   convenience init!(float f: Float)
@@ -180,6 +187,7 @@ class FooClassBase {
   class func fooBaseClassFunc0()
   /*not inherited*/ init!(_ x: Int32)
   @available(*, unavailable, message: "use object construction 'FooClassBase(_:)'")
+  @discardableResult
   class func fooClassBase(_ x: Int32) -> FooClassBase!
 }
 
@@ -239,20 +247,28 @@ struct _InternalStruct {
 }
 
 extension FooClassBase {
+  @discardableResult
   class func _internalMeth1() -> AnyObject!
+  @discardableResult
   func _internalMeth1() -> AnyObject!
 }
 
 /* Extending FooClassBase with cool stuff */
 extension FooClassBase {
+  @discardableResult
   class func _internalMeth2() -> AnyObject!
+  @discardableResult
   func _internalMeth2() -> AnyObject!
+  @discardableResult
   class func nonInternalMeth() -> AnyObject!
+  @discardableResult
   func nonInternalMeth() -> AnyObject!
 }
 
 extension FooClassBase {
+  @discardableResult
   class func _internalMeth3() -> AnyObject!
+  @discardableResult
   func _internalMeth3() -> AnyObject!
 }
 
@@ -289,6 +305,7 @@ class FooClassWithClassProperties : FooClassBase {
 class FooUnavailableMembers : FooClassBase {
   convenience init!(int i: Int32)
   @available(*, unavailable, message: "use object construction 'FooUnavailableMembers(int:)'")
+  @discardableResult
   class func withInt(_ i: Int32) -> Self!
   
   @available(*, unavailable, message: "x")
diff --git a/test/IDE/import_as_member.swift b/test/IDE/import_as_member.swift
@@ -19,13 +19,17 @@
 // PRINT-NEXT:   static var globalVar: Double
 // PRINT-NEXT:   init(value value: Double)
 // PRINT-NEXT:   init(specialLabel specialLabel: ())
+// PRINT-NEXT:   @discardableResult
 // PRINT-NEXT:   func inverted() -> Struct1
 // PRINT-NEXT:   mutating func invert()
+// PRINT-NEXT:   @discardableResult
 // PRINT-NEXT:   func translate(radians radians: Double) -> Struct1
+// PRINT-NEXT:   @discardableResult
 // PRINT-NEXT:   func scale(_ radians: Double) -> Struct1
 // PRINT-NEXT:   var radius: Double { get nonmutating set }
 // PRINT-NEXT:   var altitude: Double{{$}}
 // PRINT-NEXT:   var magnitude: Double { get }
+// PRINT-NEXT:   @discardableResult
 // PRINT-NEXT:   static func staticMethod() -> Int32
 // PRINT-NEXT:   static var property: Int32
 // PRINT-NEXT:   static var getOnlyProperty: Int32 { get }
diff --git a/test/IDE/infer_import_as_member.swift b/test/IDE/infer_import_as_member.swift
@@ -25,8 +25,10 @@ import InferImportAsMember
 // PRINT-NEXT:    init(specialLabel specialLabel: ())
 //
 // PRINT-LABEL:   /// Methods
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    func invert() -> IAMStruct1
 // PRINT-NEXT:    mutating func invertInPlace()
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    func rotate(radians radians: Double) -> IAMStruct1
 // PRINT-NEXT:    func selfComesLast(x x: Double)
 // PRINT-NEXT:    func selfComesThird(a a: Double, b b: Float, x x: Double)
@@ -38,33 +40,42 @@ import InferImportAsMember
 // PRINT-NEXT:    var length: Double
 //
 // PRINT-LABEL:   /// Various instance functions that can't quite be imported as properties.
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    func getNonPropertyNumParams() -> Float
 // PRINT-NEXT:    func setNonPropertyNumParams(a a: Float, b b: Float)
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    func getNonPropertyType() -> Float
 // PRINT-NEXT:    func setNonPropertyType(x x: Double)
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    func getNonPropertyNoSelf() -> Float
 // PRINT-NEXT:    static func setNonPropertyNoSelf(x x: Double, y y: Double)
 // PRINT-NEXT:    func setNonPropertyNoGet(x x: Double)
 //
 // PRINT-LABEL:   /// Various static functions that can't quite be imported as properties.
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    static func staticGetNonPropertyNumParams() -> Float
 // PRINT-NEXT:    static func staticSetNonPropertyNumParams(a a: Float, b b: Float)
 // PRINT-NEXT:    static func staticGetNonPropertyNumParamsGetter(d d: Double)
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    static func staticGetNonPropertyType() -> Float
 // PRINT-NEXT:    static func staticSetNonPropertyType(x x: Double)
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    static func staticGetNonPropertyNoSelf() -> Float
 // PRINT-NEXT:    static func staticSetNonPropertyNoSelf(x x: Double, y y: Double)
 // PRINT-NEXT:    static func staticSetNonPropertyNoGet(x x: Double)
 //
 // PRINT-LABEL:   /// Static method
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    static func staticMethod() -> Double
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    static func tlaThreeLetterAcronym() -> Double
 //
 // PRINT-LABEL:   /// Static computed properties
 // PRINT-NEXT:    static var staticProperty: Double
 // PRINT-NEXT:    static var staticOnlyProperty: Double { get }
 //
 // PRINT-LABEL:   /// Omit needless words
+// PRINT-NEXT:    @discardableResult
 // PRINT-NEXT:    static func onwNeedlessTypeArgLabel(_ Double: Double) -> Double
 //
 // PRINT-LABEL:   /// Fuzzy
@@ -73,6 +84,7 @@ import InferImportAsMember
 // PRINT-NEXT:    init(fuzzyName fuzzyName: ())
 // PRINT-NEXT:  }
 //
+// PRINT-NEXT:  @discardableResult
 // PRINT-NEXT:  func __IAMStruct1IgnoreMe(_ s: IAMStruct1) -> Double
 //
 // PRINT-LABEL: /// Mutable
diff --git a/test/IDE/print_clang_bool_bridging.swift b/test/IDE/print_clang_bool_bridging.swift
@@ -10,20 +10,29 @@
 
 // stdbool.h uses #define, so this test does as well.
 
+@discardableResult
 func testCBool(_: Bool) -> Bool
+@discardableResult
 func testObjCBool(_: Bool) -> Bool
+@discardableResult
 func testDarwinBoolean(_: Bool) -> Bool
 
 typealias CBoolTypedef = Bool
 typealias ObjCBoolTypedef = ObjCBool
 typealias DarwinBooleanTypedef = DarwinBoolean
 
+@discardableResult
 func testCBoolTypedef(_: CBoolTypedef) -> CBoolTypedef
+@discardableResult
 func testObjCBoolTypedef(_: Bool) -> Bool
+@discardableResult
 func testDarwinBooleanTypedef(_: Bool) -> Bool
 
+@discardableResult
 func testCBoolPointer(_: UnsafeMutablePointer<Bool>) -> UnsafePointer<Bool>
+@discardableResult
 func testObjCBoolPointer(_: UnsafeMutablePointer<ObjCBool>) -> UnsafePointer<ObjCBool>
+@discardableResult
 func testDarwinBooleanPointer(_: UnsafeMutablePointer<DarwinBoolean>) -> UnsafePointer<DarwinBoolean>
 
 typealias CBoolFn = @convention(c) (Bool) -> Bool
@@ -34,12 +43,18 @@ typealias CBoolBlock = (Bool) -> Bool
 typealias ObjCBoolBlock = (Bool) -> Bool
 typealias DarwinBooleanBlock = (Bool) -> Bool
 
+@discardableResult
 func testCBoolFnToBlock(_: @convention(c) (Bool) -> Bool) -> (Bool) -> Bool
+@discardableResult
 func testObjCBoolFnToBlock(_: @convention(c) (ObjCBool) -> ObjCBool) -> (Bool) -> Bool
+@discardableResult
 func testDarwinBooleanFnToBlock(_: @convention(c) (DarwinBoolean) -> DarwinBoolean) -> (Bool) -> Bool
 
+@discardableResult
 func testCBoolFnToBlockTypedef(_: CBoolFn) -> CBoolBlock
+@discardableResult
 func testObjCBoolFnToBlockTypedef(_: ObjCBoolFn) -> ObjCBoolBlock
+@discardableResult
 func testDarwinBooleanFnToBlockTypedef(_: DarwinBooleanFn) -> DarwinBooleanBlock
 
 typealias CBoolFnToBlockType = (CBoolFn) -> CBoolBlock
@@ -59,16 +74,22 @@ class Test : NSObject {
   var propObjCBool: Bool
   var propDarwinBoolean: Bool
   
+  @discardableResult
   func testCBool(_ b: Bool) -> Bool
+  @discardableResult
   func testObjCBool(_ b: Bool) -> Bool
+  @discardableResult
   func testDarwinBoolean(_ b: Bool) -> Bool
   
   var propCBoolBlock: (Bool) -> Bool
   var propObjCBoolBlock: (Bool) -> Bool
   var propDarwinBooleanBlock: (Bool) -> Bool
   
+  @discardableResult
   func testCBoolFn(toBlock fp: @convention(c) (Bool) -> Bool) -> (Bool) -> Bool
+  @discardableResult
   func testObjCBoolFn(toBlock fp: @convention(c) (ObjCBool) -> ObjCBool) -> (Bool) -> Bool
+  @discardableResult
   func testDarwinBooleanFn(toBlock fp: @convention(c) (DarwinBoolean) -> DarwinBoolean) -> (Bool) -> Bool
   
   func produceCBoolBlockTypedef(_ outBlock: AutoreleasingUnsafeMutablePointer<(@convention(block) (Bool) -> Bool)?>)
diff --git a/test/IDE/print_clang_decls.swift b/test/IDE/print_clang_decls.swift
@@ -80,13 +80,14 @@
 // Skip through unavailable typedefs when importing types.
 // TAG_DECLS_AND_TYPEDEFS: @available(*, unavailable, message: "use double")
 // TAG_DECLS_AND_TYPEDEFS-NEXT: typealias real_t = Double
+// TAG_DECLS_AND_TYPEDEFS-NEXT: @discardableResult
 // TAG_DECLS_AND_TYPEDEFS-NEXT: func realSin(_ value: Double) -> Double
 
 // NEGATIVE-NOT: typealias FooStructTypedef2
 
 // FOUNDATION-LABEL: {{^}}/// Aaa.  NSArray.  Bbb.{{$}}
 // FOUNDATION-NEXT: {{^}}class NSArray : NSObject {{{$}}
-// FOUNDATION-NEXT  func objectAtIndex(_ index: Int) -> AnyObject!
+// FOUNDATION-NEXT: subscript(idx: Int) -> AnyObject { get }
 
 // FOUNDATION-LABEL: {{^}}/// Aaa.  NSRuncingMode.  Bbb.{{$}}
 // FOUNDATION-NEXT: {{^}}enum NSRuncingMode : UInt {{{$}}
diff --git a/test/IDE/print_clang_decls_AppKit.swift b/test/IDE/print_clang_decls_AppKit.swift
@@ -19,7 +19,9 @@
 
 // APPKIT-LABEL: {{^}}class NSView : NSObject, NSCoding, NSAccessibility {{{$}}
 // APPKIT-NEXT: init?(coder aDecoder: NSCoder)
+// APPKIT-NEXT: @discardableResult
 // APPKIT-NEXT: func isDescendant(of aView: NSView) -> Bool
+// APPKIT-NEXT: @discardableResult
 // APPKIT-NEXT: func ancestorShared(with aView: NSView) -> NSView?
 // APPKIT-NEXT: func addSubview(_ aView: NSView)
 // APPKIT-NEXT: func addSubview(_ aView: NSView, positioned place: UInt32, relativeTo otherView: NSView?)
diff --git a/test/IDE/print_clang_swift_name.swift b/test/IDE/print_clang_swift_name.swift
diff --git a/test/SourceKit/DocSupport/doc_clang_module.swift.response b/test/SourceKit/DocSupport/doc_clang_module.swift.response
