Apply swift naming conventions and update unavailable message

vdka · vdka · commit e24e47d47ae5 · 2017-09-10T11:14:14.000+10:00
diff --git a/Sources/LLVM/Constant.swift b/Sources/LLVM/Constant.swift
@@ -142,14 +142,12 @@ extension Constant where Repr == Floating {
 
 extension Constant where Repr == Struct {
 
-  /// - note: See the LLVM Reference manual's section on `bitcast`
-  @available(*, unavailable, message: "You cannot cast an aggregate type")
+  @available(*, unavailable, message: "You cannot cast an aggregate type. See the LLVM Reference manual's section on `bitcast`")
   public func cast<T: IntegralConstantRepresentation>(to type: IntType) -> Constant<T> {
     fatalError()
   }
 
-  /// - note: See the LLVM Reference manual's section on `bitcast`
-  @available(*, unavailable, message: "You cannot cast an aggregate type")
+  @available(*, unavailable, message: "You cannot cast an aggregate type. See the LLVM Reference manual's section on `bitcast`")
   public func cast(to type: FloatType) -> Constant<Floating> {
     fatalError()
   }
@@ -278,7 +276,7 @@ extension Constant where Repr == Signed {
   ///   behavior of the resulting constant value.
   ///
   /// - returns: A constant value representing the sum of the two operands.
-  public func add(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
+  public func adding(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
     return Constant.add(self, rhs, overflowBehavior: overflowBehavior)
   }
 }
@@ -292,7 +290,7 @@ extension Constant where Repr == Unsigned {
   ///   behavior of the resulting constant value.
   ///
   /// - returns: A constant value representing the sum of the two operands.
-  public func add(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
+  public func adding(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
     return Constant.add(self, rhs, overflowBehavior: overflowBehavior)
   }
 }
@@ -304,7 +302,7 @@ extension Constant where Repr == Floating {
   /// - parameter rhs: The second summand value (the addend).
   ///
   /// - returns: A constant value representing the sum of the two operands.
-  public func add(_ rhs: Constant) -> Constant {
+  public func adding(_ rhs: Constant) -> Constant {
     return Constant.add(self, rhs)
   }
 }
@@ -373,7 +371,7 @@ extension Constant where Repr == Unsigned {
   ///   behavior of the resulting constant value.
   ///
   /// - returns: A constant value representing the difference of the two operands.
-  public func subtract(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
+  public func subtracting(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
     return Constant.subtract(self, rhs, overflowBehavior: overflowBehavior)
   }
 }
@@ -387,7 +385,7 @@ extension Constant where Repr == Signed {
   ///   behavior of the resulting constant value.
   ///
   /// - returns: A constant value representing the difference of the two operands.
-  public func subtract(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
+  public func subtracting(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
     return Constant.subtract(self, rhs, overflowBehavior: overflowBehavior)
   }
 }
@@ -399,7 +397,7 @@ extension Constant where Repr == Floating {
   /// - parameter rhs: The second value (the subtrahend).
   ///
   /// - returns: A constant value representing the difference of the two operands.
-  public func subtract(_ rhs: Constant) -> Constant {
+  public func subtracting(_ rhs: Constant) -> Constant {
     return Constant.subtract(self, rhs)
   }
 }
@@ -468,7 +466,7 @@ extension Constant where Repr == Unsigned {
   ///   behavior of the resulting constant value.
   ///
   /// - returns: A constant value representing the product of the two operands.
-  public func multiply(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
+  public func multiplying(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
     return Constant.multiply(self, rhs, overflowBehavior: overflowBehavior)
   }
 }
@@ -482,7 +480,7 @@ extension Constant where Repr == Signed {
   ///   behavior of the resulting constant value.
   ///
   /// - returns: A constant value representing the product of the two operands.
-  public func multiply(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
+  public func multiplying(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {
     return Constant.multiply(self, rhs, overflowBehavior: overflowBehavior)
   }
 }
@@ -495,7 +493,7 @@ extension Constant where Repr == Floating {
   /// - parameter rhs: The second factor value (the multiplicand).
   ///
   /// - returns: A constant value representing the product of the two operands.
-  public func multiply(_ rhs: Constant) -> Constant {
+  public func multiplying(_ rhs: Constant) -> Constant {
     return Constant.multiply(self, rhs)
   }
 }
@@ -550,7 +548,7 @@ extension Constant where Repr == Unsigned {
   ///
   /// - returns: A constant value representing the quotient of the first and 
   ///   second operands.
-  public func divide(_ rhs: Constant) -> Constant {
+  public func dividing(_ rhs: Constant) -> Constant {
     return Constant.divide(self, rhs)
   }
 }
@@ -564,7 +562,7 @@ extension Constant where Repr == Signed {
   ///
   /// - returns: A constant value representing the quotient of the first and 
   ///   second operands.
-  public func divide(_ rhs: Constant) -> Constant {
+  public func dividing(_ rhs: Constant) -> Constant {
     return Constant.divide(self, rhs)
   }
 }
@@ -578,7 +576,7 @@ extension Constant where Repr == Floating {
   ///
   /// - returns: A constant value representing the quotient of the first and 
   ///   second operands.
-  public func divide(_ rhs: Constant) -> Constant {
+  public func dividing(_ rhs: Constant) -> Constant {
     return Constant.divide(self, rhs)
   }
 }
diff --git a/Tests/LLVMTests/ConstantSpec.swift b/Tests/LLVMTests/ConstantSpec.swift
@@ -20,9 +20,9 @@ class ConstantSpec : XCTestCase {
       builder.positionAtEnd(of: entry)
 
       // SIGNEDCONST-NOT: %{{[0-9]+}} = add i64 %%{{[0-9]+}}, %%{{[0-9]+}}
-      let val1 = builder.buildAdd(constant.add(constant), constant.multiply(constant))
+      let val1 = builder.buildAdd(constant.adding(constant), constant.multiplying(constant))
       // SIGNEDCONST-NOT: %{{[0-9]+}} = sub i64 %%{{[0-9]+}}, %%{{[0-9]+}}
-      let val2 = builder.buildSub(constant.subtract(constant), constant.divide(constant))
+      let val2 = builder.buildSub(constant.subtracting(constant), constant.dividing(constant))
       // SIGNEDCONST-NOT: %{{[0-9]+}} = mul i64 %%{{[0-9]+}}, %%{{[0-9]+}}
       let val3 = builder.buildMul(val1, val2)
       // SIGNEDCONST-NOT: %{{[0-9]+}} = mul i64 %%{{[0-9]+}}, %%{{[0-9]+}}
@@ -50,9 +50,9 @@ class ConstantSpec : XCTestCase {
       builder.positionAtEnd(of: entry)
 
       // UNSIGNEDCONST-NOT: %{{[0-9]+}} = add i64 %%{{[0-9]+}}, %%{{[0-9]+}}
-      let val1 = builder.buildAdd(constant.add(constant), constant.multiply(constant))
+      let val1 = builder.buildAdd(constant.adding(constant), constant.multiplying(constant))
       // UNSIGNEDCONST-NOT: %{{[0-9]+}} = sub i64 %%{{[0-9]+}}, %%{{[0-9]+}}
-      let val2 = builder.buildSub(constant.subtract(constant), constant.divide(constant))
+      let val2 = builder.buildSub(constant.subtracting(constant), constant.dividing(constant))
       // UNSIGNEDCONST-NOT: %{{[0-9]+}} = mul i64 %%{{[0-9]+}}, %%{{[0-9]+}}
       let val3 = builder.buildMul(val1, val2)
 
@@ -78,9 +78,9 @@ class ConstantSpec : XCTestCase {
       builder.positionAtEnd(of: entry)
 
       // FLOATINGCONST-NOT: %{{[0-9]+}} = add double %%{{[0-9]+}}, %%{{[0-9]+}}
-      let val1 = builder.buildAdd(constant.add(constant), constant.multiply(constant))
+      let val1 = builder.buildAdd(constant.adding(constant), constant.multiplying(constant))
       // FLOATINGCONST-NOT: %{{[0-9]+}} = sub double %%{{[0-9]+}}, %%{{[0-9]+}}
-      let val2 = builder.buildSub(constant.subtract(constant), constant.divide(constant))
+      let val2 = builder.buildSub(constant.subtracting(constant), constant.dividing(constant))
       // FLOATINGCONST-NOT: %{{[0-9]+}} = mul double %%{{[0-9]+}}, %%{{[0-9]+}}
       let val3 = builder.buildMul(val1, val2)
 

Original file line number	Diff line number	Diff line change
`@@ -142,14 +142,12 @@ extension Constant where Repr == Floating {`
`142`	`142`
`143`	`143`	`extension Constant where Repr == Struct {`
`144`	`144`
`145`		- /// - note: See the LLVM Reference manual's section on `bitcast`
`146`		`- @available(*, unavailable, message: "You cannot cast an aggregate type")`
	`145`	+ @available(*, unavailable, message: "You cannot cast an aggregate type. See the LLVM Reference manual's section on `bitcast`")
`147`	`146`	`public func cast<T: IntegralConstantRepresentation>(to type: IntType) -> Constant<T> {`
`148`	`147`	`fatalError()`
`149`	`148`	`}`
`150`	`149`
`151`		- /// - note: See the LLVM Reference manual's section on `bitcast`
`152`		`- @available(*, unavailable, message: "You cannot cast an aggregate type")`
	`150`	+ @available(*, unavailable, message: "You cannot cast an aggregate type. See the LLVM Reference manual's section on `bitcast`")
`153`	`151`	`public func cast(to type: FloatType) -> Constant<Floating> {`
`154`	`152`	`fatalError()`
`155`	`153`	`}`
`@@ -278,7 +276,7 @@ extension Constant where Repr == Signed {`
`278`	`276`	`/// behavior of the resulting constant value.`
`279`	`277`	`///`
`280`	`278`	`/// - returns: A constant value representing the sum of the two operands.`
`281`		`- public func add(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
	`279`	`+ public func adding(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
`282`	`280`	`return Constant.add(self, rhs, overflowBehavior: overflowBehavior)`
`283`	`281`	`}`
`284`	`282`	`}`
`@@ -292,7 +290,7 @@ extension Constant where Repr == Unsigned {`
`292`	`290`	`/// behavior of the resulting constant value.`
`293`	`291`	`///`
`294`	`292`	`/// - returns: A constant value representing the sum of the two operands.`
`295`		`- public func add(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
	`293`	`+ public func adding(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
`296`	`294`	`return Constant.add(self, rhs, overflowBehavior: overflowBehavior)`
`297`	`295`	`}`
`298`	`296`	`}`
`@@ -304,7 +302,7 @@ extension Constant where Repr == Floating {`
`304`	`302`	`/// - parameter rhs: The second summand value (the addend).`
`305`	`303`	`///`
`306`	`304`	`/// - returns: A constant value representing the sum of the two operands.`
`307`		`- public func add(_ rhs: Constant) -> Constant {`
	`305`	`+ public func adding(_ rhs: Constant) -> Constant {`
`308`	`306`	`return Constant.add(self, rhs)`
`309`	`307`	`}`
`310`	`308`	`}`
`@@ -373,7 +371,7 @@ extension Constant where Repr == Unsigned {`
`373`	`371`	`/// behavior of the resulting constant value.`
`374`	`372`	`///`
`375`	`373`	`/// - returns: A constant value representing the difference of the two operands.`
`376`		`- public func subtract(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
	`374`	`+ public func subtracting(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
`377`	`375`	`return Constant.subtract(self, rhs, overflowBehavior: overflowBehavior)`
`378`	`376`	`}`
`379`	`377`	`}`
`@@ -387,7 +385,7 @@ extension Constant where Repr == Signed {`
`387`	`385`	`/// behavior of the resulting constant value.`
`388`	`386`	`///`
`389`	`387`	`/// - returns: A constant value representing the difference of the two operands.`
`390`		`- public func subtract(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
	`388`	`+ public func subtracting(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
`391`	`389`	`return Constant.subtract(self, rhs, overflowBehavior: overflowBehavior)`
`392`	`390`	`}`
`393`	`391`	`}`
`@@ -399,7 +397,7 @@ extension Constant where Repr == Floating {`
`399`	`397`	`/// - parameter rhs: The second value (the subtrahend).`
`400`	`398`	`///`
`401`	`399`	`/// - returns: A constant value representing the difference of the two operands.`
`402`		`- public func subtract(_ rhs: Constant) -> Constant {`
	`400`	`+ public func subtracting(_ rhs: Constant) -> Constant {`
`403`	`401`	`return Constant.subtract(self, rhs)`
`404`	`402`	`}`
`405`	`403`	`}`
`@@ -468,7 +466,7 @@ extension Constant where Repr == Unsigned {`
`468`	`466`	`/// behavior of the resulting constant value.`
`469`	`467`	`///`
`470`	`468`	`/// - returns: A constant value representing the product of the two operands.`
`471`		`- public func multiply(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
	`469`	`+ public func multiplying(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
`472`	`470`	`return Constant.multiply(self, rhs, overflowBehavior: overflowBehavior)`
`473`	`471`	`}`
`474`	`472`	`}`
`@@ -482,7 +480,7 @@ extension Constant where Repr == Signed {`
`482`	`480`	`/// behavior of the resulting constant value.`
`483`	`481`	`///`
`484`	`482`	`/// - returns: A constant value representing the product of the two operands.`
`485`		`- public func multiply(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
	`483`	`+ public func multiplying(_ rhs: Constant, overflowBehavior: OverflowBehavior = .default) -> Constant {`
`486`	`484`	`return Constant.multiply(self, rhs, overflowBehavior: overflowBehavior)`
`487`	`485`	`}`
`488`	`486`	`}`
`@@ -495,7 +493,7 @@ extension Constant where Repr == Floating {`
`495`	`493`	`/// - parameter rhs: The second factor value (the multiplicand).`
`496`	`494`	`///`
`497`	`495`	`/// - returns: A constant value representing the product of the two operands.`
`498`		`- public func multiply(_ rhs: Constant) -> Constant {`
	`496`	`+ public func multiplying(_ rhs: Constant) -> Constant {`
`499`	`497`	`return Constant.multiply(self, rhs)`
`500`	`498`	`}`
`501`	`499`	`}`
`@@ -550,7 +548,7 @@ extension Constant where Repr == Unsigned {`
`550`	`548`	`///`
`551`	`549`	`/// - returns: A constant value representing the quotient of the first and`
`552`	`550`	`/// second operands.`
`553`		`- public func divide(_ rhs: Constant) -> Constant {`
	`551`	`+ public func dividing(_ rhs: Constant) -> Constant {`
`554`	`552`	`return Constant.divide(self, rhs)`
`555`	`553`	`}`
`556`	`554`	`}`
`@@ -564,7 +562,7 @@ extension Constant where Repr == Signed {`
`564`	`562`	`///`
`565`	`563`	`/// - returns: A constant value representing the quotient of the first and`
`566`	`564`	`/// second operands.`
`567`		`- public func divide(_ rhs: Constant) -> Constant {`
	`565`	`+ public func dividing(_ rhs: Constant) -> Constant {`
`568`	`566`	`return Constant.divide(self, rhs)`
`569`	`567`	`}`
`570`	`568`	`}`
`@@ -578,7 +576,7 @@ extension Constant where Repr == Floating {`
`578`	`576`	`///`
`579`	`577`	`/// - returns: A constant value representing the quotient of the first and`
`580`	`578`	`/// second operands.`
`581`		`- public func divide(_ rhs: Constant) -> Constant {`
	`579`	`+ public func dividing(_ rhs: Constant) -> Constant {`
`582`	`580`	`return Constant.divide(self, rhs)`
`583`	`581`	`}`
`584`	`582`	`}`