Swift Programming Language PDF
Swift Programming Language PDF
About Swift
Swift is a new programming language for iOS and OS X apps that builds on the best of C and Objective-C, without
the constraints of C compatibility. Swift adopts safe programming patterns and adds modern features to make
programming easier, more flexible, and more fun. Swifts clean slate, backed by the mature and much-loved Cocoa
and Cocoa Touch frameworks, is an opportunity to reimagine how software development works.
Swift has been years in the making. Apple laid the foundation for Swift by advancing our existing compiler, debugger,
and framework infrastructure. We simplified memory management with Automatic Reference Counting (ARC). Our
framework stack, built on the solid base of Foundation and Cocoa, has been modernized and standardized
throughout. Objective-C itself has evolved to support blocks, collection literals, and modules, enabling framework
adoption of modern language technologies without disruption. Thanks to this groundwork, we can now introduce a
new language for the future of Apple software development.
Swift feels familiar to Objective-C developers. It adopts the readability of Objective-Cs named parameters and the
power of Objective-Cs dynamic object model. It provides seamless access to existing Cocoa frameworks and mix-
and-match interoperability with Objective-C code. Building from this common ground, Swift introduces many new
features and unifies the procedural and object-oriented portions of the language.
Swift is friendly to new programmers. It is the first industrial-quality systems programming language that is as
expressive and enjoyable as a scripting language. It supports playgrounds, an innovative feature that allows
programmers to experiment with Swift code and see the results immediately, without the overhead of building and
running an app.
Swift combines the best in modern language thinking with wisdom from the wider Apple engineering culture. The
compiler is optimized for performance, and the language is optimized for development, without compromising on
either. Its designed to scale from hello, world to an entire operating system. All this makes Swift a sound future
investment for developers and for Apple.
Swift is a fantastic way to write iOS and OS X apps, and will continue to evolve with new features and capabilities.
Our goals for Swift are ambitious. We cant wait to see what you create with it.
A Swift Tour
Tradition suggests that the first program in a new language should print the words Hello, world on the screen. In
Swift, this can be done in a single line:
println("Hello, world")
If you have written code in C or Objective-C, this syntax looks familiar to youin Swift, this line of code is a
complete program. You dont need to import a separate library for functionality like input/output or string handling.
Code written at global scope is used as the entry point for the program, so you dont need a main function. You also
dont need to write semicolons at the end of every statement.
This tour gives you enough information to start writing code in Swift by showing you how to accomplish a variety of
programming tasks. Dont worry if you dont understand somethingeverything introduced in this tour is explained
in detail in the rest of this book.
N OT E
For the best experience, open this chapter as a playground in Xcode. Playgrounds allow you to edit the
code listings and see the result immediately.
Simple Values
Use let to make a constant and var to make a variable. The value of a constant doesnt need to be known at
compile time, but you must assign it a value exactly once. This means you can use constants to name a value that
you determine once but use in many places.
1 var myVariable = 42
2 myVariable = 50
3 let myConstant = 42
A constant or variable must have the same type as the value you want to assign to it. However, you dont always
have to write the type explicitly. Providing a value when you create a constant or variable lets the compiler infer its
type. In the example above, the compiler infers that myVariable is an integer because its initial value is a integer.
If the initial value doesnt provide enough information (or if there is no initial value), specify the type by writing it after
the variable, separated by a colon.
1 let implicitInteger = 70
2 let implicitDouble = 70.0
3 let explicitDouble: Double = 70
E X P E R I M E N T
Create a constant with an explicit type of Float and a value of 4.
Values are never implicitly converted to another type. If you need to convert a value to a different type, explicitly
make an instance of the desired type.
1 let label = "The width is "
2 let width = 94
3 let widthLabel = label + String(width)
E X P E R I M E N T
Try removing the conversion to String from the last line. What error do you get?
Theres an even simpler way to include values in strings: Write the value in parentheses, and write a backslash (\)
before the parentheses. For example:
1 let apples = 3
2 let oranges = 5
3 let appleSummary = "I have \(apples) apples."
4 let fruitSummary = "I have \(apples + oranges) pieces of fruit."
E X P E R I M E N T
Use \() to include a floating-point calculation in a string and to include someones name in a greeting.
Create arrays and dictionaries using brackets ([]), and access their elements by writing the index or key in
brackets.
1 var shoppingList = ["catfish", "water", "tulips", "blue paint"]
2 shoppingList[1] = "bottle of water"
3
4 var occupations = [
5 "Malcolm": "Captain",
6 "Kaylee": "Mechanic",
7 ]
8 occupations["Jayne"] = "Public Relations"
To create an empty array or dictionary, use the initializer syntax.
1 let emptyArray = String[]()
2 let emptyDictionary = Dictionary<String, Float>()
If type information can be inferred, you can write an empty array as [] and an empty dictionary as [:]for
example, when you set a new value for a variable or pass an argument to a function.
shoppingList = [] // Went shopping and bought everything.
Control Flow
Use if and switch to make conditionals, and use for-in, for, while, and do-while to make loops. Parentheses
around the condition or loop variable are optional. Braces around the body are required.
1 let individualScores = [75, 43, 103, 87, 12]
2 var teamScore = 0
3 for score in individualScores {
4 if score > 50 {
5 teamScore += 3
6 } else {
7 teamScore += 1
8 }
9 }
10 teamScore
In an if statement, the conditional must be a Boolean expressionthis means that code such as if score { ...
} is an error, not an implicit comparison to zero.
You can use if and let together to work with values that might be missing. These values are represented as
optionals. An optional value either contains a value or contains nil to indicate that the value is missing. Write a
question mark (?) after the type of a value to mark the value as optional.
1 var optionalString: String? = "Hello"
2 optionalString == nil
3
4 var optionalName: String? = "John Appleseed"
5 var greeting = "Hello!"
6 if let name = optionalName {
7 greeting = "Hello, \(name)"
8 }
E X P E R I M E N T
Change optionalName to nil. What greeting do you get? Add an else clause that sets a different greeting if
optionalName is nil.
If the optional value is nil, the conditional is false and the code in braces is skipped. Otherwise, the optional value
is unwrapped and assigned to the constant after let, which makes the unwrapped value available inside the block
of code.
Switches support any kind of data and a wide variety of comparison operationsthey arent limited to integers and
tests for equality.
1 let vegetable = "red pepper"
2 switch vegetable {
3 case "celery":
4 let vegetableComment = "Add some raisins and make ants on a log."
5 case "cucumber", "watercress":
6 let vegetableComment = "That would make a good tea sandwich."
7 case let x where x.hasSuffix("pepper"):
8 let vegetableComment = "Is it a spicy \(x)?"
9 default:
10 let vegetableComment = "Everything tastes good in soup."
11 }
E X P E R I M E N T
Try removing the default case. What error do you get?
After executing the code inside the switch case that matched, the program exits from the switch statement.
Execution doesnt continue to the next case, so there is no need to explicitly break out of the switch at the end of
each cases code.
You use for-in to iterate over items in a dictionary by providing a pair of names to use for each key-value pair.
1 let interestingNumbers = [
2 "Prime": [2, 3, 5, 7, 11, 13],
3 "Fibonacci": [1, 1, 2, 3, 5, 8],
4 "Square": [1, 4, 9, 16, 25],
5 ]
6 var largest = 0
7 for (kind, numbers) in interestingNumbers {
8 for number in numbers {
9 if number > largest {
10 largest = number
11 }
12 }
13 }
14 largest
E X P E R I M E N T
Add another variable to keep track of which kind of number was the largest, as well as what that largest
number was.
Use while to repeat a block of code until a condition changes. The condition of a loop can be at the end instead,
ensuring that the loop is run at least once.
1 var n = 2
2 while n < 100 {
3 n = n * 2
4 }
5 n
6
7 var m = 2
8 do {
9 m = m * 2
10 } while m < 100
11 m
You can keep an index in a loopeither by using .. to make a range of indexes or by writing an explicit initialization,
condition, and increment. These two loops do the same thing:
1 var firstForLoop = 0
2 for i in 0..3 {
3 firstForLoop += i
4 }
5 firstForLoop
6
7 var secondForLoop = 0
8 for var i = 0; i < 3; ++i {
9 secondForLoop += 1
10 }
11 secondForLoop
Use .. to make a range that omits its upper value, and use ... to make a range that includes both values.
Functions and Closures
Use func to declare a function. Call a function by following its name with a list of arguments in parentheses. Use ->
to separate the parameter names and types from the functions return type.
1 func greet(name: String, day: String) -> String {
2 return "Hello \(name), today is \(day)."
3 }
4 greet("Bob", "Tuesday")
E X P E R I M E N T
Remove the day parameter. Add a parameter to include todays lunch special in the greeting.
Use a tuple to return multiple values from a function.
1 func getGasPrices() -> (Double, Double, Double) {
2 return (3.59, 3.69, 3.79)
3 }
4 getGasPrices()
Functions can also take a variable number of arguments, collecting them into an array.
1 func sumOf(numbers: Int...) -> Int {
2 var sum = 0
3 for number in numbers {
4 sum += number
5 }
6 return sum
7 }
8 sumOf()
9 sumOf(42, 597, 12)
E X P E R I M E N T
Write a function that calculates the average of its arguments.
Functions can be nested. Nested functions have access to variables that were declared in the outer function. You
can use nested functions to organize the code in a function that is long or complex.
1 func returnFifteen() -> Int {
2 var y = 10
3 func add() {
4 y += 5
5 }
6 add()
7 return y
8 }
9 returnFifteen()
Functions are a first-class type. This means that a function can return another function as its value.
1 func makeIncrementer() -> (Int -> Int) {
2 func addOne(number: Int) -> Int {
3 return 1 + number
4 }
5 return addOne
6 }
7 var increment = makeIncrementer()
8 increment(7)
A function can take another function as one of its arguments.
1 func hasAnyMatches(list: Int[], condition: Int -> Bool) -> Bool {
2 for item in list {
3 if condition(item) {
4 return true
5 }
6 }
7 return false
8 }
9 func lessThanTen(number: Int) -> Bool {
10 return number < 10
11 }
12 var numbers = [20, 19, 7, 12]
13 hasAnyMatches(numbers, lessThanTen)
Functions are actually a special case of closures. You can write a closure without a name by surrounding code with
braces ({}). Use in to separate the arguments and return type from the body.
1 numbers.map({
2 (number: Int) -> Int in
3 let result = 3 * number
4 return result
5 })
E X P E R I M E N T
Rewrite the closure to return zero for all odd numbers.
You have several options for writing closures more concisely. When a closures type is already known, such as the
callback for a delegate, you can omit the type of its parameters, its return type, or both. Single statement closures
implicitly return the value of their only statement.
numbers.map({ number in 3 * number })
You can refer to parameters by number instead of by namethis approach is especially useful in very short
closures. A closure passed as the last argument to a function can appear immediately after the parentheses.
sort([1, 5, 3, 12, 2]) { $0 > $1 }
Objects and Classes
Use class followed by the classs name to create a class. A property declaration in a class is written the same way
as a constant or variable declaration, except that it is in the context of a class. Likewise, method and function
declarations are written the same way.
1 class Shape {
2 var numberOfSides = 0
3 func simpleDescription() -> String {
4 return "A shape with \(numberOfSides) sides."
5 }
6 }
E X P E R I M E N T
Add a constant property with let, and add another method that takes an argument.
Create an instance of a class by putting parentheses after the class name. Use dot syntax to access the properties
and methods of the instance.
1 var shape = Shape()
2 shape.numberOfSides = 7
3 var shapeDescription = shape.simpleDescription()
This version of the Shape class is missing something important: an initializer to set up the class when an instance is
created. Use init to create one.
1 class NamedShape {
2 var numberOfSides: Int = 0
3 var name: String
4
5 init(name: String) {
6 self.name = name
7 }
8
9 func simpleDescription() -> String {
10 return "A shape with \(numberOfSides) sides."
11 }
12 }
Notice how self is used to distinguish the name property from the name argument to the initializer. The arguments to
the initializer are passed like a function call when you create an instance of the class. Every property needs a value
assignedeither in its declaration (as with numberOfSides) or in the initializer (as with name).
Use deinit to create a deinitializer if you need to perform some cleanup before the object is deallocated.
Subclasses include their superclass name after their class name, separated by a colon. There is no requirement for
classes to subclass any standard root class, so you can include or omit a superclass as needed.
Methods on a subclass that override the superclasss implementation are marked with overrideoverriding a
method by accident, without override, is detected by the compiler as an error. The compiler also detects methods
with override that dont actually override any method in the superclass.
1 class Square: NamedShape {
2 var sideLength: Double
3
4 init(sideLength: Double, name: String) {
5 self.sideLength = sideLength
6 super.init(name: name)
7 numberOfSides = 4
8 }
9
10 func area() -> Double {
11 return sideLength * sideLength
12 }
13
14 override func simpleDescription() -> String {
15 return "A square with sides of length \(sideLength)."
16 }
17 }
18 let test = Square(sideLength: 5.2, name: "my test square")
19 test.area()
20 test.simpleDescription()
E X P E R I M E N T
Make another subclass of NamedShape called Circle that takes a radius and a name as arguments to its
initializer. Implement an area and a describe method on the Circle class.
In addition to simple properties that are stored, properties can have a getter and a setter.
1 class EquilateralTriangle: NamedShape {
2 var sideLength: Double = 0.0
3
4 init(sideLength: Double, name: String) {
5 self.sideLength = sideLength
6 super.init(name: name)
7 numberOfSides = 3
8 }
9
10 var perimeter: Double {
11 get {
12 return 3.0 * sideLength
13 }
14 set {
15 sideLength = newValue / 3.0
16 }
17 }
18
19 override func simpleDescription() -> String {
20 return "An equilateral triagle with sides of length \(sideLength)."
21 }
22 }
23 var triangle = EquilateralTriangle(sideLength: 3.1, name: "a triangle")
24 triangle.perimeter
25 triangle.perimeter = 9.9
26 triangle.sideLength
In the setter for perimeter, the new value has the implicit name newValue. You can provide an explicit name in
parentheses after set.
Notice that the initializer for the EquilateralTriangle class has three different steps:
1. Setting the value of properties that the subclass declares.
2. Calling the superclasss initializer.
3. Changing the value of properties defined by the superclass. Any additional setup work that uses methods,
getters, or setters can also be done at this point.
If you dont need to compute the property but still need to provide code that is run before and after setting a new
value, use willSet and didSet. For example, the class below ensures that the side length of its triangle is always
the same as the side length of its square.
1 class TriangleAndSquare {
2 var triangle: EquilateralTriangle {
3 willSet {
4 square.sideLength = newValue.sideLength
5 }
6 }
7 var square: Square {
8 willSet {
9 triangle.sideLength = newValue.sideLength
10 }
11 }
12 init(size: Double, name: String) {
13 square = Square(sideLength: size, name: name)
14 triangle = EquilateralTriangle(sideLength: size, name: name)
15 }
16 }
17 var triangleAndSquare = TriangleAndSquare(size: 10, name: "another test shape")
18 triangleAndSquare.square.sideLength
19 triangleAndSquare.triangle.sideLength
20 triangleAndSquare.square = Square(sideLength: 50, name: "larger square")
21 triangleAndSquare.triangle.sideLength
Methods on classes have one important difference from functions. Parameter names in functions are used only
within the function, but parameters names in methods are also used when you call the method (except for the first
parameter). By default, a method has the same name for its parameters when you call it and within the method itself.
You can specify a second name, which is used inside the method.
1 class Counter {
2 var count: Int = 0
3 func incrementBy(amount: Int, numberOfTimes times: Int) {
4 count += amount * times
5 }
6 }
7 var counter = Counter()
8 counter.incrementBy(2, numberOfTimes: 7)
When working with optional values, you can write ? before operations like methods, properties, and subscripting. If
the value before the ? is nil, everything after the ? is ignored and the value of the whole expression is nil.
Otherwise, the optional value is unwrapped, and everything after the ? acts on the unwrapped value. In both cases,
the value of the whole expression is an optional value.
1 let optionalSquare: Square? = Square(sideLength: 2.5, name: "optional square")
2 let sideLength = optionalSquare?.sideLength
Enumerations and Structures
Use enum to create an enumeration. Like classes and all other named types, enumerations can have methods
associated with them.
1 enum Rank: Int {
2 case Ace = 1
3 case Two, Three, Four, Five, Six, Seven, Eight, Nine, Ten
4 case Jack, Queen, King
5 func simpleDescription() -> String {
6 switch self {
7 case .Ace:
8 return "ace"
9 case .Jack:
10 return "jack"
11 case .Queen:
12 return "queen"
13 case .King:
14 return "king"
15 default:
16 return String(self.toRaw())
17 }
18 }
19 }
20 let ace = Rank.Ace
21 let aceRawValue = ace.toRaw()
E X P E R I M E N T
Write a function that compares two Rank values by comparing their raw values.
In the example above, the raw value type of the enumeration is Int, so you only have to specify the first raw value.
The rest of the raw values are assigned in order. You can also use strings or floating-point numbers as the raw type
of an enumeration.
Use the toRaw and fromRaw functions to convert between the raw value and the enumeration value.
1 if let convertedRank = Rank.fromRaw(3) {
2 let threeDescription = convertedRank.simpleDescription()
3 }
The member values of an enumeration are actual values, not just another way of writing their raw values. In fact, in
cases where there isnt a meaningful raw value, you dont have to provide one.
1 enum Suit {
2 case Spades, Hearts, Diamonds, Clubs
3 func simpleDescription() -> String {
4 switch self {
5 case .Spades:
6 return "spades"
7 case .Hearts:
8 return "hearts"
9 case .Diamonds:
10 return "diamonds"
11 case .Clubs:
12 return "clubs"
13 }
14 }
15 }
16 let hearts = Suit.Hearts
17 let heartsDescription = hearts.simpleDescription()
E X P E R I M E N T
Add a color method to Suit that returns black for spades and clubs, and returns red for hearts and
diamonds.
Notice the two ways that the Hearts member of the enumeration is referred to above: When assigning a value to
the hearts constant, the enumeration member Suit.Hearts is referred to by its full name because the constant
doesnt have an explicit type specified. Inside the switch, the enumeration is referred to by the abbreviated form
.Hearts because the value of self is already known to be a suit. You can use the abbreviated form anytime the
values type is already known.
Use struct to create a structure. Structures support many of the same behaviors as classes, including methods
and initializers. One of the most important differences between structures and classes is that structures are always
copied when they are passed around in your code, but classes are passed by reference.
1 struct Card {
2 var rank: Rank
3 var suit: Suit
4 func simpleDescription() -> String {
5 return "The \(rank.simpleDescription()) of \(suit.simpleDescription())"
6 }
7 }
8 let threeOfSpades = Card(rank: .Three, suit: .Spades)
9 let threeOfSpadesDescription = threeOfSpades.simpleDescription()
E X P E R I M E N T
Add a method to Card that creates a full deck of cards, with one card of each combination of rank and suit.
An instance of an enumeration member can have values associated with the instance. Instances of the same
enumeration member can have different values associated with them. You provide the associated values when you
create the instance. Associated values and raw values are different: The raw value of an enumeration member is
the same for all of its instances, and you provide the raw value when you define the enumeration.
For example, consider the case of requesting the sunrise and sunset time from a server. The server either
responds with the information or it responds with some error information.
1 enum ServerResponse {
2 case Result(String, String)
3 case Error(String)
4 }
5
6 let success = ServerResponse.Result("6:00 am", "8:09 pm")
7 let failure = ServerResponse.Error("Out of cheese.")
8
9 switch success {
10 case let .Result(sunrise, sunset):
11 let serverResponse = "Sunrise is at \(sunrise) and sunset is at \(sunset)."
12 case let .Error(error):
13 let serverResponse = "Failure... \(error)"
14 }
E X P E R I M E N T
Add a third case to ServerResponse and to the switch.
Notice how the sunrise and sunset times are extracted from the ServerResponse value as part of matching the
value against the switch cases.
Protocols and Extensions
Use protocol to declare a protocol.
1 protocol ExampleProtocol {
2 var simpleDescription: String { get }
3 mutating func adjust()
4 }
Classes, enumerations, and structs can all adopt protocols.
1 class SimpleClass: ExampleProtocol {
2 var simpleDescription: String = "A very simple class."
3 var anotherProperty: Int = 69105
4 func adjust() {
5 simpleDescription += " Now 100% adjusted."
6 }
7 }
8 var a = SimpleClass()
9 a.adjust()
10 let aDescription = a.simpleDescription
11
12 struct SimpleStructure: ExampleProtocol {
13 var simpleDescription: String = "A simple structure"
14 mutating func adjust() {
15 simpleDescription += " (adjusted)"
16 }
17 }
18 var b = SimpleStructure()
19 b.adjust()
20 let bDescription = b.simpleDescription
E X P E R I M E N T
Write an enumeration that conforms to this protocol.
Notice the use of the mutating keyword in the declaration of SimpleStructure to mark a method that modifies the
structure. The declaration of SimpleClass doesnt need any of its methods marked as mutating because methods
on a class can always modify the class.
Use extension to add functionality to an existing type, such as new methods and computed properties. You can
use an extension to add protocol conformance to a type that is declared elsewhere, or even to a type that you
imported from a library or framework.
1 extension Int: ExampleProtocol {
2 var simpleDescription: String {
3 return "The number \(self)"
4 }
5 mutating func adjust() {
6 self += 42
7 }
8 }
9 7.simpleDescription
E X P E R I M E N T
Write an extension for the Double type that adds an absoluteValue property.
You can use a protocol name just like any other named typefor example, to create a collection of objects that
have different types but that all conform to a single protocol. When you work with values whose type is a protocol
type, methods outside the protocol definition are not available.
1 let protocolValue: ExampleProtocol = a
2 protocolValue.simpleDescription
3 // protocolValue.anotherProperty // Uncomment to see the error
Even though the variable protocolValue has a runtime type of SimpleClass, the compiler treats it as the given
type of ExampleProtocol. This means that you cant accidentally access methods or properties that the class
implements in addition to its protocol conformance.
Generics
Write a name inside angle brackets to make a generic function or type.
1 func repeat<ItemType>(item: ItemType, times: Int) -> ItemType[] {
2 var result = ItemType[]()
3 for i in 0..times {
4 result += item
5 }
6 return result
7 }
8 repeat("knock", 4)
You can make generic forms of functions and methods, as well as classes, enumerations, and structures.
1 // Reimplement the Swift standard library's optional type
2 enum OptionalValue<T> {
3 case None
4 case Some(T)
5 }
6 var possibleInteger: OptionalValue<Int> = .None
7 possibleInteger = .Some(100)
Use where after the type name to specify a list of requirementsfor example, to require the type to implement a
protocol, to require two types to be the same, or to require a class to have a particular superclass.
1 func anyCommonElements <T, U where T: Sequence, U: Sequence, T.GeneratorType.Element:
Equatable, T.GeneratorType.Element == U.GeneratorType.Element> (lhs: T, rhs: U)
-> Bool {
2 for lhsItem in lhs {
3 for rhsItem in rhs {
4 if lhsItem == rhsItem {
5 return true
6 }
7 }
8 }
9 return false
10 }
11 anyCommonElements([1, 2, 3], [3])
E X P E R I M E N T
Modify the anyCommonElements function to make a function that returns an array of the elements that any two
sequences have in common.
In the simple cases, you can omit where and simply write the protocol or class name after a colon. Writing <T:
Equatable> is the same as writing <T where T: Equatable>.
Language Guide
The Basics
Swift is a new programming language for iOS and OS X app development. Nonetheless, many parts of Swift will be
familiar from your experience of developing in C and Objective-C.
Swift provides its own versions of all fundamental C and Objective-C types, including Int for integers; Double and
Float for floating-point values; Bool for Boolean values; and String for textual data. Swift also provides powerful
versions of the two primary collection types, Array and Dictionary, as described in Collection Types.
Like C, Swift uses variables to store and refer to values by an identifying name. Swift also makes extensive use of
variables whose values cannot be changed. These are known as constants, and are much more powerful than
constants in C. Constants are used throughout Swift to make code safer and clearer in intent when you work with
values that do not need to change.
In addition to familiar types, Swift introduces advanced types not found in Objective-C. These include tuples, which
enable you to create and pass around groupings of values. Tuples can return multiple values from a function as a
single compound value.
Swift also introduces optional types, which handle the absence of a value. Optionals say either there is a value, and
it equals x or there isnt a value at all. Optionals are similar to using nil with pointers in Objective-C, but they
work for any type, not just classes. Optionals are safer and more expressive than nil pointers in Objective-C and
are at the heart of many of Swifts most powerful features.
Optionals are an example of the fact that Swift is a type safe language. Swift helps you to be clear about the types of
values your code can work with. If part of your code expects a String, type safety prevents you from passing it an
Int by mistake. This enables you to catch and fix errors as early as possible in the development process.
Constants and Variables
Constants and variables associate a name (such as maximumNumberOfLoginAttempts or welcomeMessage) with a
value of a particular type (such as the number 10 or the string "Hello"). The value of a constant cannot be
changed once it is set, whereas a variable can be set to a different value in the future.
Declaring Constants and Variables
Constants and variables must be declared before they are used. You declare constants with the let keyword and
variables with the var keyword. Heres an example of how constants and variables can be used to track the
number of login attempts a user has made:
1 let maximumNumberOfLoginAttempts = 10
2 var currentLoginAttempt = 0
This code can be read as:
Declare a new constant called maximumNumberOfLoginAttempts, and give it a value of 10. Then, declare a new
variable called currentLoginAttempt, and give it an initial value of 0.
In this example, the maximum number of allowed login attempts is declared as a constant, because the maximum
value never changes. The current login attempt counter is declared as a variable, because this value must be
incremented after each failed login attempt.
You can declare multiple constants or multiple variables on a single line, separated by commas:
var x = 0.0, y = 0.0, z = 0.0
N OT E
If a stored value in your code is not going to change, always declare it as a constant with the let keyword.
Use variables only for storing values that need to be able to change.
Type Annotations
You can provide a type annotation when you declare a constant or variable, to be clear about the kind of values the
constant or variable can store. Write a type annotation by placing a colon after the constant or variable name,
followed by a space, followed by the name of the type to use.
This example provides a type annotation for a variable called welcomeMessage, to indicate that the variable can
store String values:
var welcomeMessage: String
The colon in the declaration means of type, so the code above can be read as:
Declare a variable called welcomeMessage that is of type String.
The phrase of type String means can store any String value. Think of it as meaning the type of thing (or the
kind of thing) that can be stored.
The welcomeMessage variable can now be set to any string value without error:
welcomeMessage = "Hello"
N OT E
It is rare that you need to write type annotations in practice. If you provide an initial value for a constant or
variable at the point that it is defined, Swift can almost always infer the type to be used for that constant or
variable, as described in Type Safety and Type Inference. In the welcomeMessage example above, no initial
value is provided, and so the type of the welcomeMessage variable is specified with a type annotation rather
than being inferred from an initial value.
Naming Constants and Variables
You can use almost any character you like for constant and variable names, including Unicode characters:
1 let ! = 3.14159
2 let = ""
3 let !"!" = "dogcow"
Constant and variable names cannot contain mathematical symbols, arrows, private-use (or invalid) Unicode code
points, or line- and box-drawing characters. Nor can they begin with a number, although numbers may be included
elsewhere within the name.
Once youve declared a constant or variable of a certain type, you cant redeclare it again with the same name, or
change it to store values of a different type. Nor can you change a constant into a variable or a variable into a
constant.
N OT E
If you need to give a constant or variable the same name as a reserved Swift keyword, you can do so by
surrounding the keyword with back ticks (`) when using it as a name. However, you should avoid using
keywords as names unless you have absolutely no choice.
You can change the value of an existing variable to another value of a compatible type. In this example, the value of
friendlyWelcome is changed from "Hello!" to "Bonjour!":
1 var friendlyWelcome = "Hello!"
2 friendlyWelcome = "Bonjour!"
3 // friendlyWelcome is now "Bonjour!"
Unlike a variable, the value of a constant cannot be changed once it is set. Attempting to do so is reported as an
error when your code is compiled:
1 let languageName = "Swift"
2 languageName = "Swift++"
3 // this is a compile-time error - languageName cannot be changed
Printing Constants and Variables
You can print the current value of a constant or variable with the println function:
1 println(friendlyWelcome)
2 // prints "Bonjour!"
println is a global function that prints a value, followed by a line break, to an appropriate output. If you are working
in Xcode, for example, println prints its output in Xcodes console pane. (A second function, print, performs the
same task without appending a line break to the end of the value to be printed.)
The println function prints any String value you pass to it:
1 println("This is a string")
2 // prints "This is a string"
The println function can print more complex logging messages, in a similar manner to Cocoas NSLog function.
These messages can include the current values of constants and variables.
Swift uses string interpolation to include the name of a constant or variable as a placeholder in a longer string, and to
prompt Swift to replace it with the current value of that constant or variable. Wrap the name in parentheses and
escape it with a backslash before the opening parenthesis:
1 println("The current value of friendlyWelcome is \(friendlyWelcome)")
2 // prints "The current value of friendlyWelcome is Bonjour!"
N OT E
All options you can use with string interpolation are described in String Interpolation.
Comments
Use comments to include non-executable text in your code, as a note or reminder to yourself. Comments are
ignored by the Swift compiler when your code is compiled.
Comments in Swift are very similar to comments in C. Single-line comments begin with two forward-slashes (//):
// this is a comment
You can also write multiline comments, which start with a forward-slash followed by an asterisk (/*) and end with an
asterisk followed by a forward-slash (*/):
1 /* this is also a comment,
2 but written over multiple lines */
Unlike multiline comments in C, multiline comments in Swift can be nested inside other multiline comments. You write
nested comments by starting a multiline comment block and then starting a second multiline comment within the first
block. The second block is then closed, followed by the first block:
1 /* this is the start of the first multiline comment
2 /* this is the second, nested multiline comment */
3 this is the end of the first multiline comment */
Nested multiline comments enable you to comment out large blocks of code quickly and easily, even if the code
already contains multiline comments.
Semicolons
Unlike many other languages, Swift does not require you to write a semicolon (;) after each statement in your code,
although you can do so if you wish. Semicolons are required, however, if you want to write multiple separate
statements on a single line:
1 let cat = " "; println(cat)
2 // prints " "
Integers
Integers are whole numbers with no fractional component, such as 42 and -23. Integers are either signed (positive,
zero, or negative) or unsigned (positive or zero).
Swift provides signed and unsigned integers in 8, 16, 32, and 64 bit forms. These integers follow a naming
convention similar to C, in that an 8-bit unsigned integer is of type UInt8, and a 32-bit signed integer is of type
Int32. Like all types in Swift, these integer types have capitalized names.
Integer Bounds
You can access the minimum and maximum values of each integer type with its min and max properties:
1 let minValue = UInt8.min // minValue is equal to 0, and is of type UInt8
2 let maxValue = UInt8.max // maxValue is equal to 255, and is of type UInt8
The values of these properties are of the appropriate-sized number type (such as UInt8 in the example above) and
can therefore be used in expressions alongside other values of the same type.
Int
In most cases, you dont need to pick a specific size of integer to use in your code. Swift provides an additional
integer type, Int, which has the same size as the current platforms native word size:
Unless you need to work with a specific size of integer, always use Int for integer values in your code. This aids
code consistency and interoperability. Even on 32-bit platforms, Int can store any value between -2,147,483,648
and 2,147,483,647, and is large enough for many integer ranges.
UInt
Swift also provides an unsigned integer type, UInt, which has the same size as the current platforms native word
size:
N OT E
Use UInt only when you specifically need an unsigned integer type with the same size as the platforms
native word size. If this is not the case, Int is preferred, even when the values to be stored are known to be
non-negative. A consistent use of Int for integer values aids code interoperability, avoids the need to
convert between different number types, and matches integer type inference, as described in Type Safety
and Type Inference.
Floating-Point Numbers
Floating-point numbers are numbers with a fractional component, such as 3.14159, 0.1, and -273.15.
Floating-point types can represent a much wider range of values than integer types, and can store numbers that
are much larger or smaller than can be stored in an Int. Swift provides two signed floating-point number types:
On a 32-bit platform, Int is the same size as Int32.
On a 64-bit platform, Int is the same size as Int64.
On a 32-bit platform, UInt is the same size as UInt32.
On a 64-bit platform, UInt is the same size as UInt64.
Double represents a 64-bit floating-point number. Use it when floating-point values must be very large or
particularly precise.
Float represents a 32-bit floating-point number. Use it when floating-point values do not require 64-bit
precision.
N OT E
Double has a precision of at least 15 decimal digits, whereas the precision of Float can be as little as 6
decimal digits. The appropriate floating-point type to use depends on the nature and range of values you
need to work with in your code.
Type Safety and Type Inference
Swift is a type safe language. A type safe language encourages you to be clear about the types of values your code
can work with. If part of your code expects a String, you cant pass it an Int by mistake.
Because Swift is type safe, it performs type checks when compiling your code and flags any mismatched types as
errors. This enables you to catch and fix errors as early as possible in the development process.
Type-checking helps you avoid errors when youre working with different types of values. However, this doesnt
mean that you have to specify the type of every constant and variable that you declare. If you dont specify the type
of value you need, Swift uses type inference to work out the appropriate type. Type inference enables a compiler to
deduce the type of a particular expression automatically when it compiles your code, simply by examining the
values you provide.
Because of type inference, Swift requires far fewer type declarations than languages such as C or Objective-C.
Constants and variables are still explicitly typed, but much of the work of specifying their type is done for you.
Type inference is particularly useful when you declare a constant or variable with an initial value. This is often done
by assigning a literal value (or literal) to the constant or variable at the point that you declare it. (A literal value is a
value that appears directly in your source code, such as 42 and 3.14159 in the examples below.)
For example, if you assign a literal value of 42 to a new constant without saying what type it is, Swift infers that you
want the constant to be an Int, because you have initialized it with a number that looks like an integer:
1 let meaningOfLife = 42
2 // meaningOfLife is inferred to be of type Int
Likewise, if you dont specify a type for a floating-point literal, Swift infers that you want to create a Double:
1 let pi = 3.14159
2 // pi is inferred to be of type Double
Swift always chooses Double (rather than Float) when inferring the type of floating-point numbers.
If you combine integer and floating-point literals in an expression, a type of Double will be inferred from the context:
1 let anotherPi = 3 + 0.14159
2 // anotherPi is also inferred to be of type Double
The literal value of 3 has no explicit type in and of itself, and so an appropriate output type of Double is inferred from
the presence of a floating-point literal as part of the addition.
Numeric Literals
Integer literals can be written as:
All of these integer literals have a decimal value of 17:
1 let decimalInteger = 17
2 let binaryInteger = 0b10001 // 17 in binary notation
3 let octalInteger = 0o21 // 17 in octal notation
4 let hexadecimalInteger = 0x11 // 17 in hexadecimal notation
Floating-point literals can be decimal (with no prefix), or hexadecimal (with a 0x prefix). They must always have a
number (or hexadecimal number) on both sides of the decimal point. They can also have an optional exponent,
indicated by an uppercase or lowercase e for decimal floats, or an uppercase or lowercase p for hexadecimal
floats.
For decimal numbers with an exponent of exp, the base number is multiplied by 10
exp
:
For hexadecimal numbers with an exponent of exp, the base number is multiplied by 2
exp
:
All of these floating-point literals have a decimal value of 12.1875:
1 let decimalDouble = 12.1875
2 let exponentDouble = 1.21875e1
3 let hexadecimalDouble = 0xC.3p0
Numeric literals can contain extra formatting to make them easier to read. Both integers and floats can be padded
A decimal number, with no prefix
A binary number, with a 0b prefix
An octal number, with a 0o prefix
A hexadecimal number, with a 0x prefix
1.25e2 means 1.25 " 10
2
, or 125.0.
with extra zeroes and can contain underscores to help with readability. Neither type of formatting affects the
underlying value of the literal:
1 let paddedDouble = 000123.456
2 let oneMillion = 1_000_000
3 let justOverOneMillion = 1_000_000.000_000_1
Numeric Type Conversion
Use the Int type for all general-purpose integer constants and variables in your code, even if they are known to be
non-negative. Using the default integer type in everyday situations means that integer constants and variables are
immediately interoperable in your code and will match the inferred type for integer literal values.
Use other integer types only when they are are specifically needed for the task at hand, because of explicitly-sized
data from an external source, or for performance, memory usage, or other necessary optimization. Using explicitly-
sized types in these situations helps to catch any accidental value overflows and implicitly documents the nature of
the data being used.
Integer Conversion
The range of numbers that can be stored in an integer constant or variable is different for each numeric type. An
Int8 constant or variable can store numbers between -128 and 127, whereas a UInt8 constant or variable can
store numbers between 0 and 255. A number that will not fit into a constant or variable of a sized integer type is
reported as an error when your code is compiled:
1 let cannotBeNegative: UInt8 = -1
2 // UInt8 cannot store negative numbers, and so this will report an error
3 let tooBig: Int8 = Int8.max + 1
4 // Int8 cannot store a number larger than its maximum value,
5 // and so this will also report an error
Because each numeric type can store a different range of values, you must opt in to numeric type conversion on a
case-by-case basis. This opt-in approach prevents hidden conversion errors and helps make type conversion
intentions explicit in your code.
To convert one specific number type to another, you initialize a new number of the desired type with the existing
value. In the example below, the constant twoThousand is of type UInt16, whereas the constant one is of type
UInt8. They cannot be added together directly, because they are not of the same type. Instead, this example calls
UInt16(one) to create a new UInt16 initialized with the value of one, and uses this value in place of the original:
1 let twoThousand: UInt16 = 2_000
2 let one: UInt8 = 1
3 let twoThousandAndOne = twoThousand + UInt16(one)
Because both sides of the addition are now of type UInt16, the addition is allowed. The output constant
(twoThousandAndOne) is inferred to be of type UInt16, because it is the sum of two UInt16 values.
SomeType(ofInitialValue) is the default way to call the initializer of a Swift type and pass in an initial value.
Behind the scenes, UInt16 has an initializer that accepts a UInt8 value, and so this initializer is used to make a
new UInt16 from an existing UInt8. You cant pass in any type here, howeverit has to be a type for which
UInt16 provides an initializer. Extending existing types to provide initializers that accept new types (including your
own type definitions) is covered in Extensions.
Integer and Floating-Point Conversion
Conversions between integer and floating-point numeric types must be made explicit:
1 let three = 3
2 let pointOneFourOneFiveNine = 0.14159
3 let pi = Double(three) + pointOneFourOneFiveNine
4 // pi equals 3.14159, and is inferred to be of type Double
Here, the value of the constant three is used to create a new value of type Double, so that both sides of the
addition are of the same type. Without this conversion in place, the addition would not be allowed.
The reverse is also true for floating-point to integer conversion, in that an integer type can be initialized with a
Double or Float value:
1 let integerPi = Int(pi)
2 // integerPi equals 3, and is inferred to be of type Int
Floating-point values are always truncated when used to initialize a new integer value in this way. This means that
4.75 becomes 4, and -3.9 becomes -3.
N OT E
The rules for combining numeric constants and variables are different from the rules for numeric literals. The
literal value 3 can be added directly to the literal value 0.14159, because number literals do not have an
explicit type in and of themselves. Their type is inferred only at the point that they are evaluated by the
compiler.
Type Aliases
Type aliases define an alternative name for an existing type. You define type aliases with the typealias keyword.
Type aliases are useful when you want to refer to an existing type by a name that is contextually more appropriate,
such as when working with data of a specific size from an external source:
typealias AudioSample = UInt16
Once you define a type alias, you can use the alias anywhere you might use the original name:
1 var maxAmplitudeFound = AudioSample.min
2 // maxAmplitudeFound is now 0
Here, AudioSample is defined as an alias for UInt16. Because it is an alias, the call to AudioSample.min actually
calls UInt16.min, which provides an initial value of 0 for the maxAmplitudeFound variable.
Booleans
Swift has a basic Boolean type, called Bool. Boolean values are referred to as logical, because they can only ever
be true or false. Swift provides two Boolean constant values, true and false:
1 let orangesAreOrange = true
2 let turnipsAreDelicious = false
The types of orangesAreOrange and turnipsAreDelicious have been inferred as Bool from the fact that they
were initialized with Boolean literal values. As with Int and Double above, you dont need to declare constants or
variables as Bool if you set them to true or false as soon as you create them. Type inference helps make Swift
code more concise and readable when it initializes constants or variables with other values whose type is already
known.
Boolean values are particularly useful when you work with conditional statements such as the if statement:
1 if turnipsAreDelicious {
2 println("Mmm, tasty turnips!")
3 } else {
4 println("Eww, turnips are horrible.")
5 }
6 // prints "Eww, turnips are horrible."
Conditional statements such as the if statement are covered in more detail in Control Flow.
Swifts type safety prevents non-Boolean values from being be substituted for Bool. The following example reports
a compile-time error:
1 let i = 1
2 if i {
3 // this example will not compile, and will report an error
4 }
However, the alternative example below is valid:
1 let i = 1
2 if i == 1 {
3 // this example will compile successfully
4 }
The result of the i == 1 comparison is of type Bool, and so this second example passes the type-check.
Comparisons like i == 1 are discussed in Basic Operators.
As with other examples of type safety in Swift, this approach avoids accidental errors and ensures that the intention
of a particular section of code is always clear.
Tuples
Tuples group multiple values into a single compound value. The values within a tuple can be of any type and do not
have to be of the same type as each other.
In this example, (404, "Not Found") is a tuple that describes an HTTP status code. An HTTP status code is a
special value returned by a web server whenever you request a web page. A status code of 404 Not Found is
returned if you request a webpage that doesnt exist.
1 let http404Error = (404, "Not Found")
2 // http404Error is of type (Int, String), and equals (404, "Not Found")
The (404, "Not Found") tuple groups together an Int and a String to give the HTTP status code two separate
values: a number and a human-readable description. It can be described as a tuple of type (Int, String).
You can create tuples from any permutation of types, and they can contain as many different types as you like.
Theres nothing stopping you from having a tuple of type (Int, Int, Int), or (String, Bool), or indeed any
other permutation you require.
You can decompose a tuples contents into separate constants or variables, which you then access as usual:
1 let (statusCode, statusMessage) = http404Error
2 println("The status code is \(statusCode)")
3 // prints "The status code is 404"
4 println("The status message is \(statusMessage)")
5 // prints "The status message is Not Found"
If you only need some of the tuples values, ignore parts of the tuple with an underscore (_) when you decompose
the tuple:
1 let (justTheStatusCode, _) = http404Error
2 println("The status code is \(justTheStatusCode)")
3 // prints "The status code is 404"
Alternatively, access the individual element values in a tuple using index numbers starting at zero:
1 println("The status code is \(http404Error.0)")
2 // prints "The status code is 404"
3 println("The status message is \(http404Error.1)")
4 // prints "The status message is Not Found"
You can name the individual elements in a tuple when the tuple is defined:
let http200Status = (statusCode: 200, description: "OK")
If you name the elements in a tuple, you can use the element names to access the values of those elements:
1 println("The status code is \(http200Status.statusCode)")
2 // prints "The status code is 200"
3 println("The status message is \(http200Status.description)")
4 // prints "The status message is OK"
Tuples are particularly useful as the return values of functions. A function that tries to retrieve a web page might
return the (Int, String) tuple type to describe the success or failure of the page retrieval. By returning a tuple
with two distinct values, each of a different type, the function provides more useful information about its outcome
than if it could only return a single value of a single type. For more information, see Functions with Multiple Return
Values.
N OT E
Tuples are useful for temporary groups of related values. They are not suited to the creation of complex data
structures. If your data structure is likely to persist beyond a temporary scope, model it as a class or structure,
rather than as a tuple. For more information, see Classes and Structures.
Optionals
You use optionals in situations where a value may be absent. An optional says:
or
There is a value, and it equals x
There isnt a value at all
N OT E
The concept of optionals doesnt exist in C or Objective-C. The nearest thing in Objective-C is the ability to
return nil from a method that would otherwise return an object, with nil meaning the absence of a valid
object. However, this only works for objectsit doesnt work for structs, basic C types, or enumeration
values. For these types, Objective-C methods typically return a special value (such as NSNotFound) to indicate
the absence of a value. This approach assumes that the methods caller knows there is a special value to
test against and remembers to check for it. Swifts optionals let you indicate the absence of a value for any
type at all, without the need for special constants.
Heres an example. Swifts String type has a method called toInt, which tries to convert a String value into an
Int value. However, not every string can be converted into an integer. The string "123" can be converted into the
numeric value 123, but the string "hello, world" does not have an obvious numeric value to convert to.
The example below uses the toInt method to try to convert a String into an Int:
1 let possibleNumber = "123"
2 let convertedNumber = possibleNumber.toInt()
3 // convertedNumber is inferred to be of type "Int?", or "optional Int"
Because the toInt method might fail, it returns an optional Int, rather than an Int. An optional Int is written as
Int?, not Int. The question mark indicates that the value it contains is optional, meaning that it might contain some
Int value, or it might contain no value at all. (It cant contain anything else, such as a Bool value or a String value.
Its either an Int, or its nothing at all.)
If Statements and Forced Unwrapping
You can use an if statement to find out whether an optional contains a value. If an optional does have a value, it
evaluates to true; if it has no value at all, it evaluates to false.
Once youre sure that the optional does contain a value, you can access its underlying value by adding an
exclamation mark (!) to the end of the optionals name. The exclamation mark effectively says, I know that this
optional definitely has a value; please use it. This is known as forced unwrapping of the optionals value:
1 if convertedNumber {
2 println("\(possibleNumber) has an integer value of \(convertedNumber!)")
3 } else {
4 println("\(possibleNumber) could not be converted to an integer")
5 }
6 // prints "123 has an integer value of 123"
For more on the if statement, see Control Flow.
N OT E
Trying to use ! to access a non-existent optional value triggers a runtime error. Always make sure that an
optional contains a non-nil value before using ! to force-unwrap its value.
Optional Binding
You use optional binding to find out whether an optional contains a value, and if so, to make that value available as a
temporary constant or variable. Optional binding can be used with if and while statements to check for a value
inside an optional, and to extract that value into a constant or variable, as part of a single action. if and while
statements are described in more detail in Control Flow.
Write optional bindings for the if statement as follows:
if let constantName = someOptional {
statements
}
You can rewrite the possibleNumber example from above to use optional binding rather than forced unwrapping:
1 if let actualNumber = possibleNumber.toInt() {
2 println("\(possibleNumber) has an integer value of \(actualNumber)")
3 } else {
4 println("\(possibleNumber) could not be converted to an integer")
5 }
6 // prints "123 has an integer value of 123"
This can be read as:
If the optional Int returned by possibleNumber.toInt contains a value, set a new constant called actualNumber
to the value contained in the optional.
If the conversion is successful, the actualNumber constant becomes available for use within the first branch of the
if statement. It has already been initialized with the value contained within the optional, and so there is no need to
use the ! suffix to access its value. In this example, actualNumber is simply used to print the result of the
conversion.
You can use both constants and variables with optional binding. If you wanted to manipulate the value of
actualNumber within the first branch of the if statement, you could write if var actualNumber instead, and the
value contained within the optional would be made available as a variable rather than a constant.
nil
You set an optional variable to a valueless state by assigning it the special value nil:
1 var serverResponseCode: Int? = 404
2 // serverResponseCode contains an actual Int value of 404
3 serverResponseCode = nil
4 // serverResponseCode now contains no value
N OT E
nil cannot be used with non-optional constants and variables. If a constant or variable in your code needs
to be able to cope with the absence of a value under certain conditions, always declare it as an optional
value of the appropriate type.
If you define an optional constant or variable without providing a default value, the constant or variable is
automatically set to nil for you:
1 var surveyAnswer: String?
2 // surveyAnswer is automatically set to nil
N OT E
Swifts nil is not the same as nil in Objective-C. In Objective-C, nil is a pointer to a non-existent object. In
Swift, nil is not a pointerit is the absence of a value of a certain type. Optionals of any type can be set to
nil, not just object types.
Implicitly Unwrapped Optionals
As described above, optionals indicate that a constant or variable is allowed to have no value. Optionals can be
checked with an if statement to see if a value exists, and can be conditionally unwrapped with optional binding to
access the optionals value if it does exist.
Sometimes it is clear from a programs structure that an optional will always have a value, after that value is first set.
In these cases, it is useful to remove the need to check and unwrap the optionals value every time it is accessed,
because it can be safely assumed to have a value all of the time.
These kinds of optionals are defined as implicitly unwrapped optionals. You write an implicitly unwrapped optional by
placing an exclamation mark (String!) rather than a question mark (String?) after the type that you want to make
optional.
Implicitly unwrapped optionals are useful when an optionals value is confirmed to exist immediately after the optional
is first defined and can definitely be assumed to exist at every point thereafter. The primary use of implicitly
unwrapped optionals in Swift is during class initialization, as described in Unowned References and Implicitly
Unwrapped Optional Properties.
An implicitly unwrapped optional is a normal optional behind the scenes, but can also be used like a nonoptional
value, without the need to unwrap the optional value each time it is accessed. The following example shows the
difference in behavior between an optional String and an implicitly unwrapped optional String:
1 let possibleString: String? = "An optional string."
2 println(possibleString!) // requires an exclamation mark to access its value
3 // prints "An optional string."
4
5 let assumedString: String! = "An implicitly unwrapped optional string."
6 println(assumedString) // no exclamation mark is needed to access its value
7 // prints "An implicitly unwrapped optional string."
You can think of an implicitly unwrapped optional as giving permission for the optional to be unwrapped automatically
whenever it is used. Rather than placing an exclamation mark after the optionals name each time you use it, you
place an exclamation mark after the optionals type when you declare it.
N OT E
If you try to access an implicitly unwrapped optional when it does not contain a value, you will trigger a
runtime error. The result is exactly the same as if you place an exclamation mark after a normal optional that
does not contain a value.
You can still treat an implicitly unwrapped optional like a normal optional, to check if it contains a value:
1 if assumedString {
2 println(assumedString)
3 }
4 // prints "An implicitly unwrapped optional string."
You can also use an implicitly unwrapped optional with optional binding, to check and unwrap its value in a single
statement:
1 if let definiteString = assumedString {
2 println(definiteString)
3 }
4 // prints "An implicitly unwrapped optional string."
N OT E
Implicitly unwrapped optionals should not be used when there is a possibility of a variable becoming nil at a
later point. Always use a normal optional type if you need to check for a nil value during the lifetime of a
variable.
Assertions
Optionals enable you to check for values that may or may not exist, and to write code that copes gracefully with the
absence of a value. In some cases, however, it is simply not possible for your code to continue execution if a value
does not exist, or if a provided value does not satisfy certain conditions. In these situations, you can trigger an
assertion in your code to end code execution and to provide an opportunity to debug the cause of the absent or
invalid value.
Debugging with Assertions
An assertion is a runtime check that a logical condition definitely evaluates to true. Literally put, an assertion
asserts that a condition is true. You use an assertion to make sure that an essential condition is satisfied before
executing any further code. If the condition evaluates to true, code execution continues as usual; if the condition
evaluates to false, code execution ends, and your app is terminated.
If your code triggers an assertion while running in a debug environment, such as when you build and run an app in
Xcode, you can see exactly where the invalid state occurred and query the state of your app at the time that the
assertion was triggered. An assertion also lets you provide a suitable debug message as to the nature of the assert.
You write an assertion by calling the global assert function. You pass the assert function an expression that
evaluates to true or false and a message that should be displayed if the result of the condition is false:
1 let age = -3
2 assert(age >= 0, "A person's age cannot be less than zero")
3 // this causes the assertion to trigger, because age is not >= 0
In this example, code execution will continue only if age >= 0 evaluates to true, that is, if the value of age is non-
negative. If the value of age is negative, as in the code above, then age >= 0 evaluates to false, and the assertion
is triggered, terminating the application.
Assertion messages cannot use string interpolation. The assertion message can be omitted if desired, as in the
following example:
assert(age >= 0)
When to Use Assertions
Use an assertion whenever a condition has the potential to be false, but must definitely be true in order for your
code to continue execution. Suitable scenarios for an assertion check include:
See also Subscripts and Functions.
N OT E
Assertions cause your app to terminate and are not a substitute for designing your code in such a way that
invalid conditions are unlikely to arise. Nonetheless, in situations where invalid conditions are possible, an
assertion is an effective way to ensure that such conditions are highlighted and noticed during development,
before your app is published.
An integer subscript index is passed to a custom subscript implementation, but the subscript index value
could be too low or too high.
A value is passed to a function, but an invalid value means that the function cannot fulfill its task.
An optional value is currently nil, but a non-nil value is essential for subsequent code to execute
successfully.
Basic Operators
An operator is a special symbol or phrase that you use to check, change, or combine values. For example, the
addition operator (+) adds two numbers together (as in let i = 1 + 2). More complex examples include the
logical AND operator && (as in if enteredDoorCode && passedRetinaScan) and the increment operator ++i,
which is a shortcut to increase the value of i by 1.
Swift supports most standard C operators and improves several capabilities to eliminate common coding errors.
The assignment operator (=) does not return a value, to prevent it from being mistakenly used when the equal to
operator (==) is intended. Arithmetic operators (+, -, *, /, % and so forth) detect and disallow value overflow, to
avoid unexpected results when working with numbers that become larger or smaller than the allowed value range of
the type that stores them. You can opt in to value overflow behavior by using Swifts overflow operators, as
described in Overflow Operators.
Unlike C, Swift lets you perform remainder (%) calculations on floating-point numbers. Swift also provides two range
operators (a..b and a...b) not found in C, as a shortcut for expressing a range of values.
This chapter describes the common operators in Swift. Advanced Operators covers Swifts advanced operators,
and describes how to define your own custom operators and implement the standard operators for your own
custom types.
Terminology
Operators are unary, binary, or ternary:
The values that operators affect are operands. In the expression 1 + 2, the + symbol is a binary operator and its
two operands are the values 1 and 2.
Assignment Operator
The assignment operator (a = b) initializes or updates the value of a with the value of b:
1 let b = 10
2 var a = 5
Unary operators operate on a single target (such as -a). Unary prefix operators appear immediately
before their target (such as !b), and unary postfix operators appear immediately after their target (such
as i++).
Binary operators operate on two targets (such as 2 + 3) and are infix because they appear in between
their two targets.
Ternary operators operate on three targets. Like C, Swift has only one ternary operator, the ternary
conditional operator (a ? b : c).
3 a = b
4 // a is now equal to 10
If the right side of the assignment is a tuple with multiple values, its elements can be decomposed into multiple
constants or variables at once:
1 let (x, y) = (1, 2)
2 // x is equal to 1, and y is equal to 2
Unlike the assignment operator in C and Objective-C, the assignment operator in Swift does not itself return a value.
The following statement is not valid:
1 if x = y {
2 // this is not valid, because x = y does not return a value
3 }
This feature prevents the assignment operator (=) from being used by accident when the equal to operator (==) is
actually intended. By making if x = y invalid, Swift helps you to avoid these kinds of errors in your code.
Arithmetic Operators
Swift supports the four standard arithmetic operators for all number types:
1 1 + 2 // equals 3
2 5 - 3 // equals 2
3 2 * 3 // equals 6
4 10.0 / 2.5 // equals 4.0
Unlike the arithmetic operators in C and Objective-C, the Swift arithmetic operators do not allow values to overflow
by default. You can opt in to value overflow behavior by using Swifts overflow operators (such as a &+ b). See
Overflow Operators.
The addition operator is also supported for String concatenation:
"hello, " + "world" // equals "hello, world"
Two Character values, or one Character value and one String value, can be added together to make a new
Addition (+)
Subtraction (-)
Multiplication (*)
Division (/)
String value:
1 let dog: Character = " "
2 let cow: Character = " "
3 let dogCow = dog + cow
4 // dogCow is equal to " "
See also Concatenating Strings and Characters.
Remainder Operator
The remainder operator (a % b) works out how many multiples of b will fit inside a and returns the value that is left
over (known as the remainder).
N OT E
The remainder operator (%) is also known as a modulo operator in other languages. However, its behavior in
Swift for negative numbers means that it is, strictly speaking, a remainder rather than a modulo operation.
Heres how the remainder operator works. To calculate 9 % 4, you first work out how many 4s will fit inside 9:
You can fit two 4s inside 9, and the remainder is 1 (shown in orange).
In Swift, this would be written as:
9 % 4 // equals 1
To determine the answer for a % b, the % operator calculates the following equation and returns remainder as its
output:
a = (b " some multiplier) + remainder
where some multiplier is the largest number of multiples of b that will fit inside a.
Inserting 9 and 4 into this equation yields:
9 = (4 " 2) + 1
The same method is applied when calculating the remainder for a negative value of a:
-9 % 4 // equals -1
Inserting -9 and 4 into the equation yields:
-9 = (4 " -2) + -1
giving a remainder value of -1.
The sign of b is ignored for negative values of b. This means that a % b and a % -b always give the same answer.
Floating-Point Remainder Calculations
Unlike the remainder operator in C and Objective-C, Swifts remainder operator can also operate on floating-point
numbers:
8 % 2.5 // equals 0.5
In this example, 8 divided by 2.5 equals 3, with a remainder of 0.5, so the remainder operator returns a Double
value of 0.5.
Increment and Decrement Operators
Like C, Swift provides an increment operator (++) and a decrement operator (--) as a shortcut to increase or
decrease the value of a numeric variable by 1. You can use these operators with variables of any integer or floating-
point type.
1 var i = 0
2 ++i // i now equals 1
Each time you call ++i, the value of i is increased by 1. Essentially, ++i is shorthand for saying i = i + 1.
Likewise, --i can be used as shorthand for i = i - 1.
The ++ and -- symbols can be used as prefix operators or as postfix operators. ++i and i++ are both valid ways to
increase the value of i by 1. Similarly, --i and i-- are both valid ways to decrease the value of i by 1.
Note that these operators modify i and also return a value. If you only want to increment or decrement the value
stored in i, you can ignore the returned value. However, if you do use the returned value, it will be different based
on whether you used the prefix or postfix version of the operator, according to the following rules:
For example:
1 var a = 0
2 let b = ++a
3 // a and b are now both equal to 1
4 let c = a++
5 // a is now equal to 2, but c has been set to the pre-increment value of 1
In the example above, let b = ++a increments a before returning its value. This is why both a and b are equal to
to the new value of 1.
However, let c = a++ increments a after returning its value. This means that c gets the old value of 1, and a is
then updated to equal 2.
Unless you need the specific behavior of i++, it is recommended that you use ++i and --i in all cases, because
they have the typical expected behavior of modifying i and returning the result.
Unary Minus Operator
The sign of a numeric value can be toggled using a prefixed -, known as the unary minus operator:
1 let three = 3
2 let minusThree = -three // minusThree equals -3
3 let plusThree = -minusThree // plusThree equals 3, or "minus minus three"
The unary minus operator (-) is prepended directly before the value it operates on, without any white space.
Unary Plus Operator
The unary plus operator (+) simply returns the value it operates on, without any change:
1 let minusSix = -6
2 let alsoMinusSix = +minusSix // alsoMinusSix equals -6
Although the unary plus operator doesnt actually do anything, you can use it to provide symmetry in your code for
positive numbers when also using the unary minus operator for negative numbers.
If the operator is written before the variable, it increments the variable before returning its value.
If the operator is written after the variable, it increments the variable after returning its value.
Compound Assignment Operators
Like C, Swift provides compound assignment operators that combine assignment (=) with another operation. One
example is the addition assignment operator (+=):
1 var a = 1
2 a += 2
3 // a is now equal to 3
The expression a += 2 is shorthand for a = a + 2. Effectively, the addition and the assignment are combined into
one operator that performs both tasks at the same time.
N OT E
The compound assignment operators do not return a value. You cannot write let b = a += 2, for example.
This behavior is different from the increment and decrement operators mentioned above.
A complete list of compound assignment operators can be found in Expressions.
Comparison Operators
Swift supports all standard C comparison operators:
N OT E
Swift also provides two identity operators (=== and !==), which you use to test whether two object references
both refer to the same object instance. For more information, see Classes and Structures.
Each of the comparison operators returns a Bool value to indicate whether or not the statement is true:
1 1 == 1 // true, because 1 is equal to 1
Equal to (a == b)
Not equal to (a != b)
Greater than (a > b)
Less than (a < b)
Greater than or equal to (a >= b)
Less than or equal to (a <= b)
2 2 != 1 // true, because 2 is not equal to 1
3 2 > 1 // true, because 2 is greater than 1
4 1 < 2 // true, because 1 is less than 2
5 1 >= 1 // true, because 1 is greater than or equal to 1
6 2 <= 1 // false, because 2 is not less than or equal to 1
Comparison operators are often used in conditional statements, such as the if statement:
1 let name = "world"
2 if name == "world" {
3 println("hello, world")
4 } else {
5 println("I'm sorry \(name), but I don't recognize you")
6 }
7 // prints "hello, world", because name is indeed equal to "world"
For more on the if statement, see Control Flow.
Ternary Conditional Operator
The ternary conditional operator is a special operator with three parts, which takes the form question ? answer1
: answer2. It is a shortcut for evaluating one of two expressions based on whether question is true or false. If
question is true, it evaluates answer1 and returns its value; otherwise, it evaluates answer2 and returns its value.
The ternary conditional operator is shorthand for the code below:
1 if question {
2 answer1
3 } else {
4 answer2
5 }
Heres an example, which calculates the pixel height for a table row. The row height should be 50 pixels taller than
the content height if the row has a header, and 20 pixels taller if the row doesnt have a header:
1 let contentHeight = 40
2 let hasHeader = true
3 let rowHeight = contentHeight + (hasHeader ? 50 : 20)
4 // rowHeight is equal to 90
The preceding example is shorthand for the code below:
1 let contentHeight = 40
2 let hasHeader = true
3 var rowHeight = contentHeight
4 if hasHeader {
5 rowHeight = rowHeight + 50
6 } else {
7 rowHeight = rowHeight + 20
8 }
9 // rowHeight is equal to 90
The first examples use of the ternary conditional operator means that rowHeight can be set to the correct value on
a single line of code. This is more concise than the second example, and removes the need for rowHeight to be a
variable, because its value does not need to be modified within an if statement.
The ternary conditional operator provides an efficient shorthand for deciding which of two expressions to consider.
Use the ternary conditional operator with care, however. Its conciseness can lead to hard-to-read code if overused.
Avoid combining multiple instances of the ternary conditional operator into one compound statement.
Range Operators
Swift includes two range operators, which are shortcuts for expressing a range of values.
Closed Range Operator
The closed range operator (a...b) defines a range that runs from a to b, and includes the values a and b.
The closed range operator is useful when iterating over a range in which you want all of the values to be used, such
as with a for-in loop:
1 for index in 1...5 {
2 println("\(index) times 5 is \(index * 5)")
3 }
4 // 1 times 5 is 5
5 // 2 times 5 is 10
6 // 3 times 5 is 15
7 // 4 times 5 is 20
8 // 5 times 5 is 25
For more on for-in loops, see Control Flow.
Half-Closed Range Operator
The half-closed range operator (a..b) defines a range that runs from a to b, but does not include b. It is said to be
half-closed because it contains its first value, but not its final value.
Half-closed ranges are particularly useful when you work with zero-based lists such as arrays, where it is useful to
count up to (but not including) the length of the list:
1 let names = ["Anna", "Alex", "Brian", "Jack"]
2 let count = names.count
3 for i in 0..count {
4 println("Person \(i + 1) is called \(names[i])")
5 }
6 // Person 1 is called Anna
7 // Person 2 is called Alex
8 // Person 3 is called Brian
9 // Person 4 is called Jack
Note that the array contains four items, but 0..count only counts as far as 3 (the index of the last item in the
array), because it is a half-closed range. For more on arrays, see Arrays.
Logical Operators
Logical operators modify or combine the Boolean logic values true and false. Swift supports the three standard
logical operators found in C-based languages:
Logical NOT Operator
The logical NOT operator (!a) inverts a Boolean value so that true becomes false, and false becomes true.
The logical NOT operator is a prefix operator, and appears immediately before the value it operates on, without any
white space. It can be read as not a, as seen in the following example:
1 let allowedEntry = false
2 if !allowedEntry {
3 println("ACCESS DENIED")
4 }
5 // prints "ACCESS DENIED"
The phrase if !allowedEntry can be read as if not allowed entry. The subsequent line is only executed if not
allowed entry is true; that is, if allowedEntry is false.
As in this example, careful choice of Boolean constant and variable names can help to keep code readable and
concise, while avoiding double negatives or confusing logic statements.
Logical NOT (!a)
Logical AND (a && b)
Logical OR (a || b)
Logical AND Operator
The logical AND operator (a && b) creates logical expressions where both values must be true for the overall
expression to also be true.
If either value is false, the overall expression will also be false. In fact, if the first value is false, the second value
wont even be evaluated, because it cant possibly make the overall expression equate to true. This is known as
short-circuit evaluation.
This example considers two Bool values and only allows access if both values are true:
1 let enteredDoorCode = true
2 let passedRetinaScan = false
3 if enteredDoorCode && passedRetinaScan {
4 println("Welcome!")
5 } else {
6 println("ACCESS DENIED")
7 }
8 // prints "ACCESS DENIED"
Logical OR Operator
The logical OR operator (a || b) is an infix operator made from two adjacent pipe characters. You use it to create
logical expressions in which only one of the two values has to be true for the overall expression to be true.
Like the Logical AND operator above, the Logical OR operator uses short-circuit evaluation to consider its
expressions. If the left side of a Logical OR expression is true, the right side is not evaluated, because it cannot
change the outcome of the overall expression.
In the example below, the first Bool value (hasDoorKey) is false, but the second value (knowsOverridePassword)
is true. Because one value is true, the overall expression also evaluates to true, and access is allowed:
1 let hasDoorKey = false
2 let knowsOverridePassword = true
3 if hasDoorKey || knowsOverridePassword {
4 println("Welcome!")
5 } else {
6 println("ACCESS DENIED")
7 }
8 // prints "Welcome!"
Combining Logical Operators
You can combine multiple logical operators to create longer compound expressions:
1 if enteredDoorCode && passedRetinaScan || hasDoorKey || knowsOverridePassword {
2 println("Welcome!")
3 } else {
4 println("ACCESS DENIED")
5 }
6 // prints "Welcome!"
This example uses multiple && and || operators to create a longer compound expression. However, the && and ||
operators still operate on only two values, so this is actually three smaller expressions chained together. It can be
read as:
If weve entered the correct door code and passed the retina scan; or if we have a valid door key; or if we know the
emergency override password, then allow access.
Based on the values of enteredDoorCode, passedRetinaScan, and hasDoorKey, the first two mini-expressions are
false. However, the emergency override password is known, so the overall compound expression still evaluates
to true.
Explicit Parentheses
It is sometimes useful to include parentheses when they are not strictly needed, to make the intention of a complex
expression easier to read. In the door access example above, it is useful to add parentheses around the first part of
the compound expression to make its intent explicit:
1 if (enteredDoorCode && passedRetinaScan) || hasDoorKey || knowsOverridePassword {
2 println("Welcome!")
3 } else {
4 println("ACCESS DENIED")
5 }
6 // prints "Welcome!"
The parentheses make it clear that the first two values are considered as part of a separate possible state in the
overall logic. The output of the compound expression doesnt change, but the overall intention is clearer to the
reader. Readability is always preferred over brevity; use parentheses where they help to make your intentions
clear.
Strings and Characters
A string is an ordered collection of characters, such as "hello, world" or "albatross". Swift strings are
represented by the String type, which in turn represents a collection of values of Character type.
Swifts String and Character types provide a fast, Unicode-compliant way to work with text in your code. The
syntax for string creation and manipulation is lightweight and readable, with a similar syntax to C strings. String
concatenation is as simple as adding together two strings with the + operator, and string mutability is managed by
choosing between a constant or a variable, just like any other value in Swift.
Despite this simplicity of syntax, Swifts String type is a fast, modern string implementation. Every string is
composed of encoding-independent Unicode characters, and provides support for accessing those characters in
various Unicode representations.
Strings can also be used to insert constants, variables, literals, and expressions into longer strings, in a process
known as string interpolation. This makes it easy to create custom string values for display, storage, and printing.
N OT E
Swifts String type is bridged seamlessly to Foundations NSString class. If you are working with the
Foundation framework in Cocoa or Cocoa Touch, the entire NSString API is available to call on any String
value you create, in addition to the String features described in this chapter. You can also use a String
value with any API that requires an NSString instance.
For more information about using String with Foundation and Cocoa, see Using Swift with Cocoa and
Objective-C.
String Literals
You can include predefined String values within your code as string literals. A string literal is a fixed sequence of
textual characters surrounded by a pair of double quotes ("").
A string literal can be used to provide an initial value for a constant or variable:
let someString = "Some string literal value"
Note that Swift infers a type of String for the someString constant, because it is initialized with a string literal value.
String literals can include the following special characters:
The escaped special characters \0 (null character), \\ (backslash), \t (horizontal tab), \n (line feed),
\r (carriage return), \" (double quote) and \' (single quote)
inside the loop are executed. In this case, the loop contains only one statement, which prints an entry from the five-
times-table for the current value of index. After the statement is executed, the value of index is updated to contain
the second value in the range (2), and the println function is called again. This process continues until the end of
the range is reached.
In the example above, index is a constant whose value is automatically set at the start of each iteration of the loop.
As such, it does not have to be declared before it is used. It is implicitly declared simply by its inclusion in the loop
declaration, without the need for a let declaration keyword.
N OT E
The index constant exists only within the scope of the loop. If you want to check the value of index after the
loop completes, or if you want to work with its value as a variable rather than a constant, you must declare it
yourself before its use in the loop.
If you dont need each value from the range, you can ignore the values by using an underscore in place of a
variable name:
1 let base = 3
2 let power = 10
3 var answer = 1
4 for _ in 1...power {
5 answer *= base
6 }
7 println("\(base) to the power of \(power) is \(answer)")
8 // prints "3 to the power of 10 is 59049"
This example calculates the value of one number to the power of another (in this case, 3 to the power of 10). It
multiplies a starting value of 1 (that is, 3 to the power of 0) by 3, ten times, using a half-closed loop that starts with 0
and ends with 9. This calculation doesnt need to know the individual counter values each time through the loopit
simply needs to execute the loop the correct number of times. The underscore character _ (used in place of a loop
variable) causes the individual values to be ignored and does not provide access to the current value during each
iteration of the loop.
Use the for-in loop with an array to iterate over its items:
1 let names = ["Anna", "Alex", "Brian", "Jack"]
2 for name in names {
3 println("Hello, \(name)!")
4 }
5 // Hello, Anna!
6 // Hello, Alex!
7 // Hello, Brian!
8 // Hello, Jack!
You can also iterate over a dictionary to access its key-value pairs. Each item in the dictionary is returned as a
(key, value) tuple when the dictionary is iterated, and you can decompose the (key, value) tuples members
as explicitly named constants for use within in the body of the for-in loop. Here, the dictionarys keys are
decomposed into a constant called animalName, and the dictionarys values are decomposed into a constant called
legCount:
1 let numberOfLegs = ["spider": 8, "ant": 6, "cat": 4]
2 for (animalName, legCount) in numberOfLegs {
3 println("\(animalName)s have \(legCount) legs")
4 }
5 // spiders have 8 legs
6 // ants have 6 legs
7 // cats have 4 legs
Items in a Dictionary may not necessarily be iterated in the same order as they were inserted. The contents of a
Dictionary are inherently unordered, and iterating over them does not guarantee the order in which they will be
retrieved. For more on arrays and dictionaries, see Collection Types.)
In addition to arrays and dictionaries, you can also use the for-in loop to iterate over the Character values in a
string:
1 for character in "Hello" {
2 println(character)
3 }
4 // H
5 // e
6 // l
7 // l
8 // o
For-Condition-Increment
In addition to for-in loops, Swift supports traditional C-style for loops with a condition and an incrementer:
1 for var index = 0; index < 3; ++index {
2 println("index is \(index)")
3 }
4 // index is 0
5 // index is 1
6 // index is 2
Heres the general form of this loop format:
for initialization ; condition ; increment {
statements
}
Semicolons separate the three parts of the loops definition, as in C. However, unlike C, Swift doesnt need
parentheses around the entire initialization; condition; increment block.
The loop is executed as follows:
1. When the loop is first entered, the initialization expression is evaluated once, to set up any constants or
variables that are needed for the loop.
2. The condition expression is evaluated. If it evaluates to false, the loop ends, and code execution continues
after the for loops closing brace (}). If the expression evaluates to true, code execution continues by
executing the statements inside the braces.
3. After all statements are executed, the increment expression is evaluated. It might increase or decrease the
value of a counter, or set one of the initialized variables to a new value based on the outcome of the
statements. After the increment expression has been evaluated, execution returns to step 2, and the
condition expression is evaluated again.
The loop format and execution process described above is shorthand for (and equivalent to) the outline below:
initialization
while condition {
statements
increment
}
Constants and variables declared within the initialization expression (such as var index = 0) are only valid within
the scope of the for loop itself. To retrieve the final value of index after the loop ends, you must declare index
before the loops scope begins:
1 var index: Int
2 for index = 0; index < 3; ++index {
3 println("index is \(index)")
4 }
5 // index is 0
6 // index is 1
7 // index is 2
8 println("The loop statements were executed \(index) times")
9 // prints "The loop statements were executed 3 times"
Note that the final value of index after this loop is completed is 3, not 2. The last time the increment statement
++index is called, it sets index to 3, which causes index < 3 to equate to false, ending the loop.
While Loops
A while loop performs a set of statements until a condition becomes false. These kinds of loops are best used
when the number of iterations is not known before the first iteration begins. Swift provides two kinds of while loop:
While
A while loop starts by evaluating a single condition. If the condition is true, a set of statements is repeated until the
condition becomes false.
Heres the general form of a while loop:
while condition {
statements
}
This example plays a simple game of Snakes and Ladders (also known as Chutes and Ladders):
while evaluates its condition at the start of each pass through the loop.
do-while evaluates its condition at the end of each pass through the loop.
The rules of the game are as follows:
The game board is represented by an array of Int values. Its size is based on a constant called finalSquare,
which is used to initialize the array and also to check for a win condition later in the example. The board is initialized
with 26 zero Int values, not 25 (one each at indices 0 through 25 inclusive):
1 let finalSquare = 25
2 var board = Int[](count: finalSquare + 1, repeatedValue: 0)
Some squares are then set to have more specific values for the snakes and ladders. Squares with a ladder base
have a positive number to move you up the board, whereas squares with a snake head have a negative number to
move you back down the board:
1 board[03] = +08; board[06] = +11; board[09] = +09; board[10] = +02
2 board[14] = -10; board[19] = -11; board[22] = -02; board[24] = -08
Square 3 contains the bottom of a ladder that moves you up to square 11. To represent this, board[03] is equal to
+08, which is equivalent to an integer value of 8 (the difference between 3 and 11). The unary plus operator (+i)
balances with the unary minus operator (-i), and numbers lower than 10 are padded with zeros so that all board
definitions align. (Neither stylistic tweak is strictly necessary, but they lead to neater code.)
The players starting square is square zero, which is just off the bottom left corner of the board. The first dice roll
always moves the player on to the board:
1 var square = 0
2 var diceRoll = 0
3 while square < finalSquare {
4 // roll the dice
5 if ++diceRoll == 7 { diceRoll = 1 }
6 // move by the rolled amount
7 square += diceRoll
8 if square < board.count {
9 // if we're still on the board, move up or down for a snake or a ladder
10 square += board[square]
11 }
12 }
13 println("Game over!")
The board has 25 squares, and the aim is to land on or beyond square 25.
Each turn, you roll a six-sided dice and move by that number of squares, following the horizontal path
indicated by the dotted arrow above.
If your turn ends at the bottom of a ladder, you move up that ladder.
If your turn ends at the head of a snake, you move down that snake.
This example uses a very simple approach to dice rolling. Instead of a random number generator, it starts with a
diceRoll value of 0. Each time through the while loop, diceRoll is incremented with the prefix increment operator
(++i), and is then checked to see if it has become too large. The return value of ++diceRoll is equal to the value of
diceRoll after it is incremented. Whenever this return value equals 7, the dice roll has become too large, and is
reset to a value of 1. This gives a sequence of diceRoll values that is always 1, 2, 3, 4, 5, 6, 1, 2 and so on.
After rolling the dice, the player moves forward by diceRoll squares. Its possible that the dice roll may have
moved the player beyond square 25, in which case the game is over. To cope with this scenario, the code checks
that square is less than the board arrays count property before adding the value stored in board[square] onto
the current square value to move the player up or down any ladders or snakes.
Had this check not been performed, board[square] might try to access a value outside the bounds of the board
array, which would trigger an error. If square is now equal to 26, the code would try to check the value of
board[26], which is larger than the size of the array.
The current while loop execution then ends, and the loops condition is checked to see if the loop should be
executed again. If the player has moved on or beyond square number 25, the loops condition evaluates to false,
and the game ends.
A while loop is appropriate in this case because the length of the game is not clear at the start of the while loop.
Instead, the loop is executed until a particular condition is satisfied.
Do-While
The other variation of the while loop, known as the do-while loop, performs a single pass through the loop block
first, before considering the loops condition. It then continues to repeat the loop until the condition is false.
Heres the general form of a do-while loop:
do {
statements
} while condition
Heres the Snakes and Ladders example again, written as a do-while loop rather than a while loop. The values of
finalSquare, board, square, and diceRoll are initialized in exactly the same way as with a while loop:
1 let finalSquare = 25
2 var board = Int[](count: finalSquare + 1, repeatedValue: 0)
3 board[03] = +08; board[06] = +11; board[09] = +09; board[10] = +02
4 board[14] = -10; board[19] = -11; board[22] = -02; board[24] = -08
5 var square = 0
6 var diceRoll = 0
In this version of the game, the first action in the loop is to check for a ladder or a snake. No ladder on the board
takes the player straight to square 25, and so it is not possible to win the game by moving up a ladder. Therefore, it
is safe to check for a snake or a ladder as the first action in the loop.
At the start of the game, the player is on square zero. board[0] always equals 0, and has no effect:
1 do {
2 // move up or down for a snake or ladder
3 square += board[square]
4 // roll the dice
5 if ++diceRoll == 7 { diceRoll = 1 }
6 // move by the rolled amount
7 square += diceRoll
8 } while square < finalSquare
9 println("Game over!")
After the code checks for snakes and ladders, the dice is rolled, and the player is moved forward by diceRoll
squares. The current loop execution then ends.
The loops condition (while square < finalSquare) is the same as before, but this time it is not evaluated until
the end of the first run through the loop. The structure of the do-while loop is better suited to this game than the
while loop in the previous example. In the do-while loop above, square += board[square] is always executed
immediately after the loops while condition confirms that square is still on the board. This behavior removes the
need for the array bounds check seen in the earlier version of the game.
Conditional Statements
It is often useful to execute different pieces of code based on certain conditions. You might want to run an extra
piece of code when an error occurs, or to display a message when a value becomes too high or too low. To do this,
you make parts of your code conditional.
Swift provides two ways to add conditional branches to your code, known as the if statement and the switch
statement. Typically, you use the if statement to evaluate simple conditions with only a few possible outcomes.
The switch statement is better suited to more complex conditions with multiple possible permutations, and is useful
in situations where pattern-matching can help select an appropriate code branch to execute.
If
In its simplest form, the if statement has a single if condition. It executes a set of statements only if that condition
is true:
1 var temperatureInFahrenheit = 30
2 if temperatureInFahrenheit <= 32 {
3 println("It's very cold. Consider wearing a scarf.")
4 }
5 // prints "It's very cold. Consider wearing a scarf."
The preceding example checks whether the temperature is less than or equal to 32 degrees Fahrenheit (the
freezing point of water). If it is, a message is printed. Otherwise, no message is printed, and code execution
continues after the if statements closing brace.
The if statement can provide an alternative set of statements, known as an else clause, for when the if condition
is false. These statements are indicated by the else keyword:
1 temperatureInFahrenheit = 40
2 if temperatureInFahrenheit <= 32 {
3 println("It's very cold. Consider wearing a scarf.")
4 } else {
5 println("It's not that cold. Wear a t-shirt.")
6 }
7 // prints "It's not that cold. Wear a t-shirt."
One of these two branches is always executed. Because the temperature has increased to 40 degrees Fahrenheit,
it is no longer cold enough to advise wearing a scarf, and so the else branch is triggered instead.
You can chain multiple if statements together, to consider additional clauses:
1 temperatureInFahrenheit = 90
2 if temperatureInFahrenheit <= 32 {
3 println("It's very cold. Consider wearing a scarf.")
4 } else if temperatureInFahrenheit >= 86 {
5 println("It's really warm. Don't forget to wear sunscreen.")
6 } else {
7 println("It's not that cold. Wear a t-shirt.")
8 }
9 // prints "It's really warm. Don't forget to wear sunscreen."
Here, an additional if statement is added to respond to particularly warm temperatures. The final else clause
remains, and prints a response for any temperatures that are neither too warm nor too cold.
The final else clause is optional, however, and can be excluded if the set of conditions does not need to be
complete:
1 temperatureInFahrenheit = 72
2 if temperatureInFahrenheit <= 32 {
3 println("It's very cold. Consider wearing a scarf.")
4 } else if temperatureInFahrenheit >= 86 {
5 println("It's really warm. Don't forget to wear sunscreen.")
6 }
In this example, the temperature is neither too cold nor too warm to trigger the if or else if conditions, and so no
message is printed.
Switch
A switch statement considers a value and compares it against several possible matching patterns. It then
executes an appropriate block of code, based on the first pattern that matches successfully. A switch statement
provides an alternative to the if statement for responding to multiple potential states.
In its simplest form, a switch statement compares a value against one or more values of the same type:
switch some value to consider {
case value 1 :
respond to value 1
case value 2 ,
value 3 :
respond to value 2 or 3
default:
otherwise, do something else
}
Every switch statement consists of multiple possible cases, each of which begins with the case keyword. In
addition to comparing against specific values, Swift provides several ways for each case to specify more complex
matching patterns. These options are described later in this section.
The body of each switch case is a separate branch of code execution, in a similar manner to the branches of an
if statement. The switch statement determines which branch should be selected. This is known as switching on
the value that is being considered.
Every switch statement must be exhaustive. That is, every possible value of the type being considered must be
matched by one of the switch cases. If it is not appropriate to provide a switch case for every possible value, you
can define a default catch-all case to cover any values that are not addressed explicitly. This catch-all case is
indicated by the keyword default, and must always appear last.
This example uses a switch statement to consider a single lowercase character called someCharacter:
1 let someCharacter: Character = "e"
2 switch someCharacter {
3 case "a", "e", "i", "o", "u":
4 println("\(someCharacter) is a vowel")
5 case "b", "c", "d", "f", "g", "h", "j", "k", "l", "m",
6 "n", "p", "q", "r", "s", "t", "v", "w", "x", "y", "z":
7 println("\(someCharacter) is a consonant")
8 default:
9 println("\(someCharacter) is not a vowel or a consonant")
10 }
11 // prints "e is a vowel"
The switch statements first case matches all five lowercase vowels in the English language. Similarly, its second
case matches all lowercase English consonants.
It is not practical to write all other possible characters as part of a switch case, and so this switch statement
provides a default case to match all other characters that are not vowels or consonants. This provision ensures
that the switch statement is exhaustive.
No Implicit Fallthrough
In contrast with switch statements in C and Objective-C, switch statements in Swift do not fall through the bottom
of each case and into the next one by default. Instead, the entire switch statement finishes its execution as soon
as the first matching switch case is completed, without requiring an explicit break statement. This makes the
switch statement safer and easier to use than in C, and avoids executing more than one switch case by mistake.
N OT E
You can still break out of a matched switch case before that case has completed its execution if you need
to. See Break in a Switch Statement for details.
The body of each case must contain at least one executable statement. It is not valid to write the following code,
because the first case is empty:
1 let anotherCharacter: Character = "a"
2 switch anotherCharacter {
3 case "a":
4 case "A":
5 println("The letter A")
6 default:
7 println("Not the letter A")
8 }
9 // this will report a compile-time error
Unlike a switch statement in C, this switch statement does not match both "a" and "A". Rather, it reports a
compile-time error that case "a": does not contain any executable statements. This approach avoids accidental
fallthrough from one case to another, and makes for safer code that is clearer in its intent.
Multiple matches for a single switch case can be separated by commas, and can be written over multiple lines if
the list is long:
switch some value to consider {
case value 1 ,
value 2 :
statements
}
N OT E
To opt in to fallthrough behavior for a particular switch case, use the fallthrough keyword, as described in
Fallthrough.
Range Matching
Values in switch cases can be checked for their inclusion in a range. This example uses number ranges to provide
a natural-language count for numbers of any size:
1 let count = 3_000_000_000_000
2 let countedThings = "stars in the Milky Way"
3 var naturalCount: String
4 switch count {
5 case 0:
6 naturalCount = "no"
7 case 1...3:
8 naturalCount = "a few"
9 case 4...9:
10 naturalCount = "several"
11 case 10...99:
12 naturalCount = "tens of"
13 case 100...999:
14 naturalCount = "hundreds of"
15 case 1000...999_999:
16 naturalCount = "thousands of"
17 default:
18 naturalCount = "millions and millions of"
19 }
20 println("There are \(naturalCount) \(countedThings).")
21 // prints "There are millions and millions of stars in the Milky Way."
Tuples
You can use tuples to test multiple values in the same switch statement. Each element of the tuple can be tested
against a different value or range of values. Alternatively, use the underscore (_) identifier to match any possible
value.
The example below takes an (x, y) point, expressed as a simple tuple of type (Int, Int), and categorizes it on the
graph that follows the example:
1 let somePoint = (1, 1)
2 switch somePoint {
3 case (0, 0):
4 println("(0, 0) is at the origin")
5 case (_, 0):
6 println("(\(somePoint.0), 0) is on the x-axis")
7 case (0, _):
8 println("(0, \(somePoint.1)) is on the y-axis")
9 case (-2...2, -2...2):
10 println("(\(somePoint.0), \(somePoint.1)) is inside the box")
11 default:
12 println("(\(somePoint.0), \(somePoint.1)) is outside of the box")
13 }
14 // prints "(1, 1) is inside the box"
The switch statement determines if the point is at the origin (0, 0); on the red x-axis; on the orange y-axis; inside
the blue 4-by-4 box centered on the origin; or outside of the box.
Unlike C, Swift allows multiple switch cases to consider the same value or values. In fact, the point (0, 0) could
match all four of the cases in this example. However, if multiple matches are possible, the first matching case is
always used. The point (0, 0) would match case (0, 0) first, and so all other matching cases would be ignored.
Value Bindings
A switch case can bind the value or values it matches to temporary constants or variables, for use in the body of
the case. This is known as value binding, because the values are bound to temporary constants or variables
within the cases body.
The example below takes an (x, y) point, expressed as a tuple of type (Int, Int) and categorizes it on the graph
that follows:
1 let anotherPoint = (2, 0)
2 switch anotherPoint {
3 case (let x, 0):
4 println("on the x-axis with an x value of \(x)")
5 case (0, let y):
6 println("on the y-axis with a y value of \(y)")
7 case let (x, y):
8 println("somewhere else at (\(x), \(y))")
9 }
10 // prints "on the x-axis with an x value of 2"
The switch statement determines if the point is on the red x-axis, on the orange y-axis, or elsewhere, on neither
axis.
The three switch cases declare placeholder constants x and y, which temporarily take on one or both tuple values
from anotherPoint. The first case, case (let x, 0), matches any point with a y value of 0 and assigns the
points x value to the temporary constant x. Similarly, the second case, case (0, let y), matches any point with
an x value of 0 and assigns the points y value to the temporary constant y.
Once the temporary constants are declared, they can be used within the cases code block. Here, they are used as
shorthand for printing the values with the println function.
Note that this switch statement does not have a default case. The final case, case let (x, y), declares a tuple
of two placeholder constants that can match any value. As a result, it matches all possible remaining values, and a
default case is not needed to make the switch statement exhaustive.
In the example above, x and y are declared as constants with the let keyword, because there is no need to modify
their values within the body of the case. However, they could have been declared as variables instead, with the var
keyword. If this had been done, a temporary variable would have been created and initialized with the appropriate
value. Any changes to that variable would only have an effect within the body of the case.
Where
A switch case can use a where clause to check for additional conditions.
The example below categorizes an (x, y) point on the following graph:
1 let yetAnotherPoint = (1, -1)
2 switch yetAnotherPoint {
3 case let (x, y) where x == y:
4 println("(\(x), \(y)) is on the line x == y")
5 case let (x, y) where x == -y:
6 println("(\(x), \(y)) is on the line x == -y")
7 case let (x, y):
8 println("(\(x), \(y)) is just some arbitrary point")
9 }
10 // prints "(1, -1) is on the line x == -y"
The switch statement determines if the point is on the green diagonal line where x == y, on the purple diagonal line
where x == -y, or neither.
The three switch cases declare placeholder constants x and y, which temporarily take on the two tuple values
from point. These constants are used as part of a where clause, to create a dynamic filter. The switch case
matches the current value of point only if the where clauses condition evaluates to true for that value.
As in the previous example, the final case matches all possible remaining values, and so a default case is not
needed to make the switch statement exhaustive.
Control Transfer Statements
Control transfer statements change the order in which your code is executed, by transferring control from one piece
of code to another. Swift has four control transfer statements:
The control, break and fallthrough statements are described below. The return statement is described in
Functions.
Continue
continue
break
fallthrough
return
The continue statement tells a loop to stop what it is doing and start again at the beginning of the next iteration
through the loop. It says I am done with the current loop iteration without leaving the loop altogether.
N OT E
In a for-condition-increment loop, the incrementer is still evaluated after calling the continue statement. The
loop itself continues to work as usual; only the code within the loops body is skipped.
The following example removes all vowels and spaces from a lowercase string to create a cryptic puzzle phrase:
1 let puzzleInput = "great minds think alike"
2 var puzzleOutput = ""
3 for character in puzzleInput {
4 switch character {
5 case "a", "e", "i", "o", "u", " ":
6 continue
7 default:
8 puzzleOutput += character
9 }
10 }
11 println(puzzleOutput)
12 // prints "grtmndsthnklk"
The code above calls the continue keyword whenever it matches a vowel or a space, causing the current iteration
of the loop to end immediately and to jump straight to the start of the next iteration. This behavior enables the switch
block to match (and ignore) only the vowel and space characters, rather than requiring the block to match every
character that should get printed.
Break
The break statement ends execution of an entire control flow statement immediately. The break statement can be
used inside a switch statement or loop statement when you want to terminate the execution of the switch or loop
statement earlier than would otherwise be the case.
Break in a Loop Statement
When used inside a loop statement, break ends the loops execution immediately, and transfers control to the first
line of code after the loops closing brace (}). No further code from the current iteration of the loop is executed, and
no further iterations of the loop are started.
Break in a Switch Statement
When used inside a switch statement, break causes the switch statement to end its execution immediately, and
to transfer control to the first line of code after the switch statements closing brace (}).
This behavior can be used to match and ignore one or more cases in a switch statement. Because Swifts switch
statement is exhaustive and does not allow empty cases, it is sometimes necessary to deliberately match and
ignore a case in order to make your intentions explicit. You do this by writing the break statement as the entire body
of the case you want to ignore. When that case is matched by the switch statement, the break statement inside
the case ends the switch statements execution immediately.
N OT E
A switch case that only contains a comment is reported as a compile-time error. Comments are not
statements and do not cause a switch case to be ignored. Always use a break statement to ignore a switch
case.
The following example switches on a Character value and determines whether it represents a number symbol in
one of four languages. Multiple values are covered in a single switch case for brevity:
1 let numberSymbol: Character = "" // Simplified Chinese for the number 3
2 var possibleIntegerValue: Int?
3 switch numberSymbol {
4 case "1", "!", "", "!":
5 possibleIntegerValue = 1
6 case "2", """, "", """:
7 possibleIntegerValue = 2
8 case "3", "#", "", "#":
9 possibleIntegerValue = 3
10 case "4", "$", "", "$":
11 possibleIntegerValue = 4
12 default:
13 break
14 }
15 if let integerValue = possibleIntegerValue {
16 println("The integer value of \(numberSymbol) is \(integerValue).")
17 } else {
18 println("An integer value could not be found for \(numberSymbol).")
19 }
20 // prints "The integer value of is 3."
This example checks numberSymbol to determine whether it is a Latin, Arabic, Chinese, or Thai symbol for the
numbers 1 to 4. If a match is found, one of the switch statements cases sets an optional Int? variable called
possibleIntegerValue to an appropriate integer value.
After the switch statement completes its execution, the example uses optional binding to determine whether a value
was found. The possibleIntegerValue variable has an implicit initial value of nil by virtue of being an optional
type, and so the optional binding will succeed only if possibleIntegerValue was set to an actual value by one of
the switch statements first four cases.
It is not practical to list every possible Character value in the example above, so a default case provides a
catchall for any characters that are not matched. This default case does not need to perform any action, and so it
is written with a single break statement as its body. As soon as the default statement is matched, the break
statement ends the switch statements execution, and code execution continues from the if let statement.
Fallthrough
Switch statements in Swift do not fall through the bottom of each case and into the next one. Instead, the entire
switch statement completes its execution as soon as the first matching case is completed. By contrast, C requires
you to insert an explicit break statement at the end of every switch case to prevent fallthrough. Avoiding default
fallthrough means that Swift switch statements are much more concise and predictable than their counterparts in
C, and thus they avoid executing multiple switch cases by mistake.
If you really need C-style fallthrough behavior, you can opt in to this behavior on a case-by-case basis with the
fallthrough keyword. The example below uses fallthrough to create a textual description of a number:
1 let integerToDescribe = 5
2 var description = "The number \(integerToDescribe) is"
3 switch integerToDescribe {
4 case 2, 3, 5, 7, 11, 13, 17, 19:
5 description += " a prime number, and also"
6 fallthrough
7 default:
8 description += " an integer."
9 }
10 println(description)
11 // prints "The number 5 is a prime number, and also an integer."
This example declares a new String variable called description and assigns it an initial value. The function then
considers the value of integerToDescribe using a switch statement. If the value of integerToDescribe is one of
the prime numbers in the list, the function appends text to the end of description, to note that the number is prime.
It then uses the fallthrough keyword to fall into the default case as well. The default case adds some extra
text to the end of the description, and the switch statement is complete.
If the value of integerToDescribe is not in the list of known prime numbers, it is not matched by the first switch
case at all. There are no other specific cases, and so integerToDescribe is matched by the catchall default
case.
After the switch statement has finished executing, the numbers description is printed using the println function.
In this example, the number 5 is correctly identified as a prime number.
N OT E
The fallthrough keyword does not check the case conditions for the switch case that it causes execution to
fall into. The fallthrough keyword simply causes code execution to move directly to the statements inside the
next case (or default case) block, as in Cs standard switch statement behavior.
Labeled Statements
You can nest loops and switch statements inside other loops and switch statements in Swift to create complex
control flow structures. However, loops and switch statements can both use the break statement to end their
execution prematurely. Therefore, it is sometimes useful to be explicit about which loop or switch statement you
want a break statement to terminate. Similarly, if you have multiple nested loops, it can be useful to be explicit about
which loop the continue statement should affect.
To achieve these aims, you can mark a loop statement or switch statement with a statement label, and use this
label with the break statement or continue statement to end or continue the execution of the labeled statement.
A labeled statement is indicated by placing a label on the same line as the statements introducer keyword, followed
by a colon. Heres an example of this syntax for a while loop, although the principle is the same for all loops and
switch statements:
label name : while condition {
statements
}
The following example uses the break and continue statements with a labeled while loop for an adapted version
of the Snakes and Ladders game that you saw earlier in this chapter. This time around, the game has an extra rule:
If a particular dice roll would take you beyond square 25, you must roll again until you roll the exact number needed
to land on square 25.
The game board is the same as before:
To win, you must land exactly on square 25.
The values of finalSquare, board, square, and diceRoll are initialized in the same way as before:
1 let finalSquare = 25
2 var board = Int[](count: finalSquare + 1, repeatedValue: 0)
3 board[03] = +08; board[06] = +11; board[09] = +09; board[10] = +02
4 board[14] = -10; board[19] = -11; board[22] = -02; board[24] = -08
5 var square = 0
6 var diceRoll = 0
This version of the game uses a while loop and a switch statement to implement the games logic. The while loop
has a statement label called gameLoop, to indicate that it is the main game loop for the Snakes and Ladders game.
The while loops condition is while square != finalSquare, to reflect that you must land exactly on square 25:
1 gameLoop: while square != finalSquare {
2 if ++diceRoll == 7 { diceRoll = 1 }
3 switch square + diceRoll {
4 case finalSquare:
5 // diceRoll will move us to the final square, so the game is over
6 break gameLoop
7 case let newSquare where newSquare > finalSquare:
8 // diceRoll will move us beyond the final square, so roll again
9 continue gameLoop
10 default:
11 // this is a valid move, so find out its effect
12 square += diceRoll
13 square += board[square]
14 }
15 }
16 println("Game over!")
The dice is rolled at the start of each loop. Rather than moving the player immediately, a switch statement is used
to consider the result of the move, and to work out if the move is allowed:
N OT E
If the break statement above did not use the gameLoop label, it would break out of the switch statement, not
the while statement. Using the gameLoop label makes it clear which control statement should be terminated.
Note also that it is not strictly necessary to use the gameLoop label when calling continue gameLoop to jump to
the next iteration of the loop. There is only one loop in the game, and so there is no ambiguity as to which
loop the continue statement will affect. However, there is no harm in using the gameLoop label with the
continue statement. Doing so is consistent with the labels use alongside the break statement, and helps
make the games logic clearer to read and understand.
If the dice roll will move the player onto the final square, the game is over. The break gameLoop
statement transfers control to the first line of code outside of the while loop, which ends the game.
If the dice roll will move the player beyond the final square, the move is invalid, and the player needs to
roll again. The continue gameLoop statement ends the current while loop iteration and begins the next
iteration of the loop.
In all other cases, the dice roll is a valid move. The player moves forward by diceRoll squares, and the
game logic checks for any snakes and ladders. The loop then ends, and control returns to the while
condition to decide whether another turn is required.
Functions
Functions are self-contained chunks of code that perform a specific task. You give a function a name that identifies
what it does, and this name is used to call the function to perform its task when needed.
Swifts unified function syntax is flexible enough to express anything from a simple C-style function with no
parameter names to a complex Objective-C-style method with local and external parameter names for each
parameter. Parameters can provide default values to simplify function calls and can be passed as in-out
parameters, which modify a passed variable once the function has completed its execution.
Every function in Swift has a type, consisting of the functions parameter types and return type. You can use this
type like any other type in Swift, which makes it easy to pass functions as parameters to other functions, and to
return functions from functions. Functions can also be written within other functions to encapsulate useful
functionality within a nested function scope.
Defining and Calling Functions
When you define a function, you can optionally define one or more named, typed values that the function takes as
input (known as parameters), and/or a type of value that the function will pass back as output when it is done
(known as its return type).
Every function has a function name, which describes the task that the function performs. To use a function, you
call that function with its name and pass it input values (known as arguments) that match the types of the
functions parameters. A functions arguments must always be provided in the same order as the functions
parameter list.
The function in the example below is called greetingForPerson, because thats what it doesit takes a persons
name as input and returns a greeting for that person. To accomplish this, you define one input parametera
String value called personNameand a return type of String, which will contain a greeting for that person:
1 func sayHello(personName: String) -> String {
2 let greeting = "Hello, " + personName + "!"
3 return greeting
4 }
All of this information is rolled up into the functions definition, which is prefixed with the func keyword. You indicate
the functions return type with the return arrow -> (a hyphen followed by a right angle bracket), which is followed by
the name of the type to return.
The definition describes what the function does, what it expects to receive, and what it returns when it is done. The
definition makes it easy for the function to be called elsewhere in your code in a clear and unambiguous way:
1 println(sayHello("Anna"))
2 // prints "Hello, Anna!"
3 println(sayHello("Brian"))
4 // prints "Hello, Brian!"
You call the sayHello function by passing it a String argument value in parentheses, such as sayHello("Anna").
Because the function returns a String value, sayHello can be wrapped in a call to the println function to print
that string and see its return value, as shown above.
The body of the sayHello function starts by defining a new String constant called greeting and setting it to a
simple greeting message for personName. This greeting is then passed back out of the function using the return
keyword. As soon as return greeting is called, the function finishes its execution and returns the current value of
greeting.
You can call the sayHello function multiple times with different input values. The example above shows what
happens if it is called with an input value of "Anna", and an input value of "Brian". The function returns a tailored
greeting in each case.
To simplify the body of this function, combine the message creation and the return statement into one line:
1 func sayHelloAgain(personName: String) -> String {
2 return "Hello again, " + personName + "!"
3 }
4 println(sayHelloAgain("Anna"))
5 // prints "Hello again, Anna!"
Function Parameters and Return Values
Function parameters and return values are extremely flexible in Swift. You can define anything from a simple utility
function with a single unnamed parameter to a complex function with expressive parameter names and different
parameter options.
Multiple Input Parameters
Functions can have multiple input parameters, which are written within the functions parentheses, separated by
commas.
This function takes a start and an end index for a half-open range, and works out how many elements the range
contains:
1 func halfOpenRangeLength(start: Int, end: Int) -> Int {
2 return end - start
3 }
4 println(halfOpenRangeLength(1, 10))
5 // prints "9"
Functions Without Parameters
Functions are not required to define input parameters. Heres a function with no input parameters, which always
returns the same String message whenever it is called:
1 func sayHelloWorld() -> String {
2 return "hello, world"
3 }
4 println(sayHelloWorld())
5 // prints "hello, world"
The function definition still needs parentheses after the functions name, even though it does not take any
parameters. The function name is also followed by an empty pair of parentheses when the function is called.
Functions Without Return Values
Functions are not required to define a return type. Heres a version of the sayHello function, called waveGoodbye,
which prints its own String value rather than returning it:
1 func sayGoodbye(personName: String) {
2 println("Goodbye, \(personName)!")
3 }
4 sayGoodbye("Dave")
5 // prints "Goodbye, Dave!"
Because it does not need to return a value, the functions definition does not include the return arrow (->) or a return
type.
N OT E
Strictly speaking, the sayGoodbye function does still return a value, even though no return value is defined.
Functions without a defined return type return a special value of type Void. This is simply an empty tuple, in
effect a tuple with zero elements, which can be written as ().
The return value of a function can be ignored when it is called:
1 func printAndCount(stringToPrint: String) -> Int {
2 println(stringToPrint)
3 return countElements(stringToPrint)
4 }
5 func printWithoutCounting(stringToPrint: String) {
6 printAndCount(stringToPrint)
7 }
8 printAndCount("hello, world")
9 // prints "hello, world" and returns a value of 12
10 printWithoutCounting("hello, world")
11 // prints "hello, world" but does not return a value
The first function, printAndCount, prints a string, and then returns its character count as an Int. The second
function, printWithoutCounting, calls the first function, but ignores its return value. When the second function is
called, the message is still printed by the first function, but the returned value is not used.
N OT E
Return values can be ignored, but a function that says it will return a value must always do so. A function
with a defined return type cannot allow control to fall out of the bottom of the function without returning a
value, and attempting to do so will result in a compile-time error.
Functions with Multiple Return Values
You can use a tuple type as the return type for a function to return multiple values as part of one compound return
value.
The example below defines a function called count, which counts the number of vowels, consonants, and other
characters in a string, based on the standard set of vowels and consonants used in American English:
1 func count(string: String) -> (vowels: Int, consonants: Int, others: Int) {
2 var vowels = 0, consonants = 0, others = 0
3 for character in string {
4 switch String(character).lowercaseString {
5 case "a", "e", "i", "o", "u":
6 ++vowels
7 case "b", "c", "d", "f", "g", "h", "j", "k", "l", "m",
8 "n", "p", "q", "r", "s", "t", "v", "w", "x", "y", "z":
9 ++consonants
10 default:
11 ++others
12 }
13 }
14 return (vowels, consonants, others)
15 }
You can use this count function to count the characters in an arbitrary string, and to retrieve the counted totals as a
tuple of three named Int values:
1 let total = count("some arbitrary string!")
2 println("\(total.vowels) vowels and \(total.consonants) consonants")
3 // prints "6 vowels and 13 consonants"
Note that the tuples members do not need to be named at the point that the tuple is returned from the function,
because their names are already specified as part of the functions return type.
Function Parameter Names
All of the above functions define parameter names for their parameters:
1 func someFunction(parameterName: Int) {
2 // function body goes here, and can use parameterName
3 // to refer to the argument value for that parameter
4 }
However, these parameter names are only used within the body of the function itself, and cannot be used when
calling the function. These kinds of parameter names are known as local parameter names, because they are only
available for use within the functions body.
External Parameter Names
Sometimes its useful to name each parameter when you call a function, to indicate the purpose of each argument
you pass to the function.
If you want users of your function to provide parameter names when they call your function, define an external
parameter name for each parameter, in addition to the local parameter name. You write an external parameter name
before the local parameter name it supports, separated by a space:
1 func someFunction(externalParameterName localParameterName: Int) {
2 // function body goes here, and can use localParameterName
3 // to refer to the argument value for that parameter
4 }
N OT E
If you provide an external parameter name for a parameter, that external name must always be used when
calling the function.
As an example, consider the following function, which joins two strings by inserting a third joiner string between
them:
1 func join(s1: String, s2: String, joiner: String) -> String {
2 return s1 + joiner + s2
3 }
When you call this function, the purpose of the three strings that you pass to the function is unclear:
1 join("hello", "world", ", ")
2 // returns "hello, world"
To make the purpose of these String values clearer, define external parameter names for each join function
parameter:
1 func join(string s1: String, toString s2: String, withJoiner joiner: String)
2 -> String {
3 return s1 + joiner + s2
4 }
In this version of the join function, the first parameter has an external name of string and a local name of s1; the
second parameter has an external name of toString and a local name of s2; and the third parameter has an
external name of withJoiner and a local name of joiner.
You can now use these external parameter names to call the function in a clear and unambiguous way:
1 join(string: "hello", toString: "world", withJoiner: ", ")
2 // returns "hello, world"
The use of external parameter names enables this second version of the join function to be called in an
expressive, sentence-like manner by users of the function, while still providing a function body that is readable and
clear in intent.
N OT E
Consider using external parameter names whenever the purpose of a functions arguments would be unclear
to someone reading your code for the first time. You do not need to specify external parameter names if the
purpose of each parameter is clear and unambiguous when the function is called.
Shorthand External Parameter Names
If you want to provide an external parameter name for a function parameter, and the local parameter name is
already an appropriate name to use, you do not need to write the same name twice for that parameter. Instead,
write the name once, and prefix the name with a hash symbol (#). This tells Swift to use that name as both the local
parameter name and the external parameter name.
This example defines a function called containsCharacter, which defines external parameter names for both of its
parameters by placing a hash symbol before their local parameter names:
1 func containsCharacter(#string: String, #characterToFind: Character) -> Bool {
2 for character in string {
3 if character == characterToFind {
4 return true
5 }
6 }
7 return false
8 }
This functions choice of parameter names makes for a clear, readable function body, while also enabling the
function to be called without ambiguity:
1 let containsAVee = containsCharacter(string: "aardvark", characterToFind: "v")
2 // containsAVee equals true, because "aardvark" contains a "v"
Default Parameter Values
You can define a default value for any parameter as part of a functions definition. If a default value is defined, you
can omit that parameter when calling the function.
N OT E
Place parameters with default values at the end of a functions parameter list. This ensures that all calls to
the function use the same order for their non-default arguments, and makes it clear that the same function is
being called in each case.
Heres a version of the join function from earlier, which provides a default value for its joiner parameter:
1 func join(string s1: String, toString s2: String,
2 withJoiner joiner: String = " ") -> String {
3 return s1 + joiner + s2
4 }
If a string value for joiner is provided when the join function is called, that string value is used to join the two
strings together, as before:
1 join(string: "hello", toString: "world", withJoiner: "-")
2 // returns "hello-world"
However, if no value of joiner is provided when the function is called, the default value of a single space (" ") is
used instead:
1 join(string: "hello", toString: "world")
2 // returns "hello world"
External Names for Parameters with Default Values
In most cases, it is useful to provide (and therefore require) an external name for any parameter with a default
value. This ensures that the argument for that parameter is clear in purpose if a value is provided when the function
is called.
To make this process easier, Swift provides an automatic external name for any defaulted parameter you define, if
you do not provide an external name yourself. The automatic external name is the same as the local name, as if you
had written a hash symbol before the local name in your code.
Heres a version of the join function from earlier, which does not provide external names for any of its parameters,
but still provides a default value for its joiner parameter:
1 func join(s1: String, s2: String, joiner: String = " ") -> String {
2 return s1 + joiner + s2
3 }
In this case, Swift automatically provides an external parameter name of joiner for the defaulted parameter. The
external name must therefore be provided when calling the function, making the parameters purpose clear and
unambiguous:
1 join("hello", "world", joiner: "-")
2 // returns "hello-world"
N OT E
You can opt out of this behavior by writing an underscore (_) instead of an explicit external name when you
define the parameter. However, external names for defaulted parameters are always preferred where
appropriate.
Variadic Parameters
A variadic parameter accepts zero or more values of a specified type. You use a variadic parameter to specify that
the parameter can be passed a varying number of input values when the function is called. Write variadic
parameters by inserting three period characters (...) after the parameters type name.
The values passed to a variadic parameter are made available within the functions body as an array of the
appropriate type. For example, a variadic parameter with a name of numbers and a type of Double... is made
available within the functions body as a constant array called numbers of type Double[].
The example below calculates the arithmetic mean (also known as the average) for a list of numbers of any length:
1 func arithmeticMean(numbers: Double...) -> Double {
2 var total: Double = 0
3 for number in numbers {
4 total += number
5 }
6 return total / Double(numbers.count)
7 }
8 arithmeticMean(1, 2, 3, 4, 5)
9 // returns 3.0, which is the arithmetic mean of these five numbers
10 arithmeticMean(3, 8, 19)
11 // returns 10.0, which is the arithmetic mean of these three numbers
N OT E
A function may have at most one variadic parameter, and it must always appear last in the parameter list, to
avoid ambiguity when calling the function with multiple parameters.
If your function has one or more parameters with a default value, and also has a variadic parameter, place
the variadic parameter after all the defaulted parameters at the very end of the list.
Constant and Variable Parameters
Function parameters are constants by default. Trying to change the value of a function parameter from within the
body of that function results in a compile-time error. This means that you cant change the value of a parameter by
mistake.
However, sometimes it is useful for a function to have a variable copy of a parameters value to work with. You can
avoid defining a new variable yourself within the function by specifying one or more parameters as variable
parameters instead. Variable parameters are available as variables rather than as constants, and give a new
modifiable copy of the parameters value for your function to work with.
Define variable parameters by prefixing the parameter name with the keyword var:
1 func alignRight(var string: String, count: Int, pad: Character) -> String {
2 let amountToPad = count - countElements(string)
3 for _ in 1...amountToPad {
4 string = pad + string
5 }
6 return string
7 }
8 let originalString = "hello"
9 let paddedString = alignRight(originalString, 10, "-")
10 // paddedString is equal to "-----hello"
11 // originalString is still equal to "hello"
This example defines a new function called alignRight, which aligns an input string to the right edge of a longer
output string. Any space on the left is filled with a specified padding character. In this example, the string "hello" is
converted to the string "-----hello".
The alignRight function defines the input parameter string to be a variable parameter. This means that string
is now available as a local variable, initialized with the passed-in string value, and can be manipulated within the
body of the function.
The function starts by working out how many characters need to be added to the left of string in order to right-
align it within the overall string. This value is stored in a local constant called amountToPad. The function then adds
amountToPad copies of the pad character to the left of the existing string and returns the result. It uses the string
variable parameter for all its string manipulation.
N OT E
The changes you make to a variable parameter do not persist beyond the end of each call to the function,
and are not visible outside the functions body. The variable parameter only exists for the lifetime of that
function call.
In-Out Parameters
Variable parameters, as described above, can only be changed within the function itself. If you want a function to
modify a parameters value, and you want those changes to persist after the function call has ended, define that
parameter as an in-out parameter instead.
You write an in-out parameter by placing the inout keyword at the start of its parameter definition. An in-out
parameter has a value that is passed in to the function, is modified by the function, and is passed back out of the
function to replace the original value.
You can only pass a variable as the argument for an in-out parameter. You cannot pass a constant or a literal value
as the argument, because constants and literals cannot be modified. You place an ampersand (&) directly before a
variables name when you pass it as an argument to an inout parameter, to indicate that it can be modified by the
function.
N OT E
In-out parameters cannot have default values, and variadic parameters cannot be marked as inout. If you
mark a parameter as inout, it cannot also be marked as var or let.
Heres an example of a function called swapTwoInts, which has two in-out integer parameters called a and b:
1 func swapTwoInts(inout a: Int, inout b: Int) {
2 let temporaryA = a
3 a = b
4 b = temporaryA
5 }
The swapTwoInts function simply swaps the value of b into a, and the value of a into b. The function performs this
swap by storing the value of a in a temporary constant called temporaryA, assigning the value of b to a, and then
assigning temporaryA to b.
You can call the swapTwoInts function with two variables of type Int to swap their values. Note that the names of
someInt and anotherInt are prefixed with an ampersand when they are passed to the swapTwoInts function:
1 var someInt = 3
2 var anotherInt = 107
3 swapTwoInts(&someInt, &anotherInt)
4 println("someInt is now \(someInt), and anotherInt is now \(anotherInt)")
5 // prints "someInt is now 107, and anotherInt is now 3"
The example above shows that the original values of someInt and anotherInt are modified by the swapTwoInts
function, even though they were originally defined outside of the function.
N OT E
In-out parameters are not the same as returning a value from a function. The swapTwoInts example above
does not define a return type or return a value, but it still modifies the values of someInt and anotherInt. In-
out parameters are an alternative way for a function to have an effect outside of the scope of its function
body.
Function Types
Every function has a specific function type, made up of the parameter types and the return type of the function.
For example:
1 func addTwoInts(a: Int, b: Int) -> Int {
2 return a + b
3 }
4 func multiplyTwoInts(a: Int, b: Int) -> Int {
5 return a * b
6 }
This example defines two simple mathematical functions called addTwoInts and multiplyTwoInts. These
functions each take two Int values, and return an Int value, which is the result of performing an appropriate
mathematical operation.
The type of both of these functions is (Int, Int) -> Int. This can be read as:
A function type that has two parameters, both of type Int, and that returns a value of type Int.
Heres another example, for a function with no parameters or return value:
1 func printHelloWorld() {
2 println("hello, world")
3 }
The type of this function is () -> (), or a function that has no parameters, and returns Void. Functions that dont
specify a return value always return Void, which is equivalent to an empty tuple in Swift, shown as ().
Using Function Types
You use function types just like any other types in Swift. For example, you can define a constant or variable to be of
a function type and assign an appropriate function to that variable:
var mathFunction: (Int, Int) -> Int = addTwoInts
This can be read as:
Define a variable called mathFunction, which has a type of a function that takes two Int values, and returns an
Int value. Set this new variable to refer to the function called addTwoInts.
The addTwoInts function has the same type as the mathFunction variable, and so this assignment is allowed by
Swifts type-checker.
You can now call the assigned function with the name mathFunction:
1 println("Result: \(mathFunction(2, 3))")
2 // prints "Result: 5"
A different function with the same matching type can be assigned to the same variable, in the same way as for non-
function types:
1 mathFunction = multiplyTwoInts
2 println("Result: \(mathFunction(2, 3))")
3 // prints "Result: 6"
As with any other type, you can leave it to Swift to infer the function type when you assign a function to a constant
or variable:
1 let anotherMathFunction = addTwoInts
2 // anotherMathFunction is inferred to be of type (Int, Int) -> Int
Function Types as Parameter Types
You can use a function type such as (Int, Int) -> Int as a parameter type for another function. This enables
you to leave some aspects of a functions implementation for the functions caller to provide when the function is
called.
Heres an example to print the results of the math functions from above:
1 func printMathResult(mathFunction: (Int, Int) -> Int, a: Int, b: Int) {
2 println("Result: \(mathFunction(a, b))")
3 }
4 printMathResult(addTwoInts, 3, 5)
5 // prints "Result: 8"
This example defines a function called printMathResult, which has three parameters. The first parameter is called
mathFunction, and is of type (Int, Int) -> Int. You can pass any function of that type as the argument for this
first parameter. The second and third parameters are called a and b, and are both of type Int. These are used as
the two input values for the provided math function.
When printMathResult is called, it is passed the addTwoInts function, and the integer values 3 and 5. It calls the
provided function with the values 3 and 5, and prints the result of 8.
The role of printMathResult is to print the result of a call to a math function of an appropriate type. It doesnt
matter what that functions implementation actually doesit matters only that the function is of the correct type. This
enables printMathResult to hand off some of its functionality to the caller of the function in a type-safe way.
Function Types as Return Types
You can use a function type as the return type of another function. You do this by writing a complete function type
immediately after the return arrow (->) of the returning function.
The next example defines two simple functions called stepForward and stepBackward. The stepForward function
returns a value one more than its input value, and the stepBackward function returns a value one less than its input
value. Both functions have a type of (Int) -> Int:
1 func stepForward(input: Int) -> Int {
2 return input + 1
3 }
4 func stepBackward(input: Int) -> Int {
5 return input - 1
6 }
Heres a function called chooseStepFunction, whose return type is a function of type (Int) -> Int.
chooseStepFunction returns the stepForward function or the stepBackward function based on a Boolean
parameter called backwards:
1 func chooseStepFunction(backwards: Bool) -> (Int) -> Int {
2 return backwards ? stepBackward : stepForward
3 }
You can now use chooseStepFunction to obtain a function that will step in one direction or the other:
1 var currentValue = 3
2 let moveNearerToZero = chooseStepFunction(currentValue > 0)
3 // moveNearerToZero now refers to the stepBackward() function
The preceding example works out whether a positive or negative step is needed to move a variable called
currentValue progressively closer to zero. currentValue has an initial value of 3, which means that
currentValue > 0 returns true, causing chooseStepFunction to return the stepBackward function. A reference
to the returned function is stored in a constant called moveNearerToZero.
Now that moveNearerToZero refers to the correct function, it can be used to count to zero:
1 println("Counting to zero:")
2 // Counting to zero:
3 while currentValue != 0 {
4 println("\(currentValue)... ")
5 currentValue = moveNearerToZero(currentValue)
6 }
7 println("zero!")
8 // 3...
9 // 2...
10 // 1...
11 // zero!
Nested Functions
All of the functions you have encountered so far in this chapter have been examples of global functions, which are
defined at a global scope. You can also define functions inside the bodies of other functions, known as nested
functions.
Nested functions are hidden from the outside world by default, but can still be called and used by their enclosing
function. An enclosing function can also return one of its nested functions to allow the nested function to be used in
another scope.
You can rewrite the chooseStepFunction example above to use and return nested functions:
1 func chooseStepFunction(backwards: Bool) -> (Int) -> Int {
2 func stepForward(input: Int) -> Int { return input + 1 }
3 func stepBackward(input: Int) -> Int { return input - 1 }
4 return backwards ? stepBackward : stepForward
5 }
6 var currentValue = -4
7 let moveNearerToZero = chooseStepFunction(currentValue > 0)
8 // moveNearerToZero now refers to the nested stepForward() function
9 while currentValue != 0 {
10 println("\(currentValue)... ")
11 currentValue = moveNearerToZero(currentValue)
12 }
13 println("zero!")
14 // -4...
15 // -3...
16 // -2...
17 // -1...
18 // zero!
Closures
Closures are self-contained blocks of functionality that can be passed around and used in your code. Closures in
Swift are similar to blocks in C and Objective-C and to lambdas in other programming languages.
Closures can capture and store references to any constants and variables from the context in which they are
defined. This is known as closing over those constants and variables, hence the name closures. Swift handles all
of the memory management of capturing for you.
N OT E
Dont worry if you are not familiar with the concept of capturing. It is explained in detail below in Capturing
Values.
Global and nested functions, as introduced in Functions, are actually special cases of closures. Closures take one
of three forms:
Swifts closure expressions have a clean, clear style, with optimizations that encourage brief, clutter-free syntax in
common scenarios. These optimizations include:
Closure Expressions
Nested functions, as introduced in Nested Functions, are a convenient means of naming and defining self-contained
blocks of code as part of a larger function. However, it is sometimes useful to write shorter versions of function-like
constructs without a full declaration and name. This is particularly true when you work with functions that take other
functions as one or more of their arguments.
Closure expressions are a way to write inline closures in a brief, focused syntax. Closure expressions provide
several syntax optimizations for writing closures in their simplest form without loss of clarity or intent. The closure
expression examples below illustrate these optimizations by refining a single example of the sort function over
Global functions are closures that have a name and do not capture any values.
Nested functions are closures that have a name and can capture values from their enclosing function.
Closure expressions are unnamed closures written in a lightweight syntax that can capture values from
their surrounding context.
Equal to means that two instances are considered equal or equivalent in value, for some
appropriate meaning of equal, as defined by the types designer.
The structures primary purpose is to encapsulate a few relatively simple data values.
It is reasonable to expect that the encapsulated values will be copied rather than referenced when you
assign or pass around an instance of that structure.
Any properties stored by the structure are themselves value types, which would also be expected to be
copied rather than referenced.
The structure does not need to inherit properties or behavior from another existing type.
Examples of good candidates for structures include:
In all other cases, define a class, and create instances of that class to be managed and passed by reference. In
practice, this means that most custom data constructs should be classes, not structures.
Assignment and Copy Behavior for Collection Types
Swifts Array and Dictionary types are implemented as structures. However, arrays have slightly different
copying behavior from dictionaries and other structures when they are assigned to a constant or variable, and when
they are passed to a function or method.
The behavior described for Array and Dictionary below is different again from the behavior of NSArray and
NSDictionary in Foundation, which are implemented as classes, not structures. NSArray and NSDictionary
instances are always assigned and passed around as a reference to an existing instance, rather than as a copy.
N OT E
The descriptions below refer to the copying of arrays, dictionaries, strings, and other values. Where copying
is mentioned, the behavior you see in your code will always be as if a copy took place. However, Swift only
performs an actual copy behind the scenes when it is absolutely necessary to do so. Swift manages all value
copying to ensure optimal performance, and you should not avoid assignment to try to preempt this
optimization.
Assignment and Copy Behavior for Dictionaries
Whenever you assign a Dictionary instance to a constant or variable, or pass a Dictionary instance as an
argument to a function or method call, the dictionary is copied at the point that the assignment or call takes place.
This process is described in Structures and Enumerations Are Value Types.
If the keys and/or values stored in the Dictionary instance are value types (structures or enumerations), they too
are copied when the assignment or call takes place. Conversely, if the keys and/or values are reference types
(classes or functions), the references are copied, but not the class instances or functions that they refer to. This
copy behavior for a dictionarys keys and values is the same as the copy behavior for a structures stored
properties when the structure is copied.
The example below defines a dictionary called ages, which stores the names and ages of four people. The ages
The size of a geometric shape, perhaps encapsulating a width property and a height property, both of
type Double.
A way to refer to ranges within a series, perhaps encapsulating a start property and a length
property, both of type Int.
A point in a 3D coordinate system, perhaps encapsulating x, y and z properties, each of type Double.
dictionary is then assigned to a new variable called copiedAges and is copied when this assignment takes place.
After the assignment, ages and copiedAges are two separate dictionaries.
1 var ages = ["Peter": 23, "Wei": 35, "Anish": 65, "Katya": 19]
2 var copiedAges = ages
The keys for this dictionary are of type String, and the values are of type Int. Both types are value types in Swift,
and so the keys and values are also copied when the dictionary copy takes place.
You can prove that the ages dictionary has been copied by changing an age value in one of the dictionaries and
checking the corresponding value in the other. If you set the value for "Peter" in the copiedAges dictionary to 24,
the ages dictionary still returns the old value of 23 from before the copy took place:
1 copiedAges["Peter"] = 24
2 println(ages["Peter"])
3 // prints "23"
Assignment and Copy Behavior for Arrays
The assignment and copy behavior for Swifts Array type is more complex than for its Dictionary type. Array
provides C-like performance when you work with an arrays contents and copies an arrays contents only when
copying is necessary.
If you assign an Array instance to a constant or variable, or pass an Array instance as an argument to a function
or method call, the contents of the array are not copied at the point that the assignment or call takes place. Instead,
both arrays share the same sequence of element values. When you modify an element value through one array, the
result is observable through the other.
For arrays, copying only takes place when you perform an action that has the potential to modify the length of the
array. This includes appending, inserting, or removing items, or using a ranged subscript to replace a range of items
in the array. If and when array copying does take place, the copy behavior for an arrays contents is the same as
for a dictionarys keys and values, as described in Assignment and Copy Behavior for Dictionaries.
The example below assigns a new array of Int values to a variable called a. This array is also assigned to two
further variables called b and c:
1 var a = [1, 2, 3]
2 var b = a
3 var c = a
You can retrieve the first value in the array with subscript syntax on either a, b, or c:
1 println(a[0])
2 // 1
3 println(b[0])
4 // 1
5 println(c[0])
6 // 1
If you set an item in the array to a new value with subscript syntax, all three of a, b, and c will return the new value.
Note that the array is not copied when you set a new value with subscript syntax, because setting a single value
with subscript syntax does not have the potential to change the arrays length:
1 a[0] = 42
2 println(a[0])
3 // 42
4 println(b[0])
5 // 42
6 println(c[0])
7 // 42
However, if you append a new item to a, you do modify the arrays length. This prompts Swift to create a new copy
of the array at the point that you append the new value. Henceforth, a is a separate, independent copy of the array.
If you change a value in a after the copy is made, a will return a different value from b and c, which both still
reference the original array contents from before the copy took place:
1 a.append(4)
2 a[0] = 777
3 println(a[0])
4 // 777
5 println(b[0])
6 // 42
7 println(c[0])
8 // 42
Ensuring That an Array Is Unique
It can be useful to ensure that you have a unique copy of an array before performing an action on that arrays
contents, or before passing that array to a function or method. You ensure the uniqueness of an array reference by
calling the unshare method on a variable of array type. (The unshare method cannot be called on a constant
array.)
If multiple variables currently refer to the same array, and you call the unshare method on one of those variables,
the array is copied, so that the variable has its own independent copy of the array. However, no copying takes
place if the variable is already the only reference to the array.
At the end of the previous example, b and c both reference the same array. Call the unshare method on b to make
it become a unique copy:
b.unshare()
If you change the first value in b after calling the unshare method, all three arrays will now report a different value:
1 b[0] = -105
2 println(a[0])
3 // 777
4 println(b[0])
5 // -105
6 println(c[0])
7 // 42
Checking Whether Two Arrays Share the Same Elements
Check whether two arrays or subarrays share the same storage and elements by comparing them with the identity
operators (=== and !==).
The example below uses the identical to operator (===) to check whether b and c still share the same array
elements:
1 if b === c {
2 println("b and c still share the same array elements.")
3 } else {
4 println("b and c now refer to two independent sets of array elements.")
5 }
6 // prints "b and c now refer to two independent sets of array elements."
Alternatively, use the identity operators to check whether two subarrays share the same elements. The example
below compares two identical subarrays from b and confirms that they refer to the same elements:
1 if b[0...1] === b[0...1] {
2 println("These two subarrays share the same elements.")
3 } else {
4 println("These two subarrays do not share the same elements.")
5 }
6 // prints "These two subarrays share the same elements."
Forcing a Copy of an Array
Force an explicit copy of an array by calling the arrays copy method. This method performs a shallow copy of the
array and returns a new array containing the copied items.
The example below defines an array called names, which stores the names of seven people. A new variable called
copiedNames is set to the result of calling the copy method on the names array:
1 var names = ["Mohsen", "Hilary", "Justyn", "Amy", "Rich", "Graham", "Vic"]
2 var copiedNames = names.copy()
You can prove that the names array has been copied by changing an item in one of the arrays and checking the
corresponding item in the other. If you set the first item in the copiedNames array to "Mo" rather than "Mohsen", the
names array still returns the old value of "Mohsen" from before the copy took place:
1 copiedNames[0] = "Mo"
2 println(names[0])
3 // prints "Mohsen"
N OT E
If you simply need to be sure that your reference to an arrays contents is the only reference in existence, call
the unshare method, not the copy method. The unshare method does not make a copy of the array unless it is
necessary to do so. The copy method always copies the array, even if it is already unshared.
Properties
Properties associate values with a particular class, structure, or enumeration. Stored properties store constant and
variable values as part of an instance, whereas computed properties calculate (rather than store) a value.
Computed properties are provided by classes, structures, and enumerations. Stored properties are provided only
by classes and structures.
Stored and computed properties are usually associated with instances of a particular type. However, properties can
also be associated with the type itself. Such properties are known as type properties.
In addition, you can define property observers to monitor changes in a propertys value, which you can respond to
with custom actions. Property observers can be added to stored properties you define yourself, and also to
properties that a subclass inherits from its superclass.
Stored Properties
In its simplest form, a stored property is a constant or variable that is stored as part of an instance of a particular
class or structure. Stored properties can be either variable stored properties (introduced by the var keyword) or
constant stored properties (introduced by the let keyword).
You can provide a default value for a stored property as part of its definition, as described in Default Property
Values. You can also set and modify the initial value for a stored property during initialization. This is true even for
constant stored properties, as described in Modifying Constant Properties During Initialization.
The example below defines a structure called FixedLengthRange, which describes a range of integers whose
range length cannot be changed once it is created:
1 struct FixedLengthRange {
2 var firstValue: Int
3 let length: Int
4 }
5 var rangeOfThreeItems = FixedLengthRange(firstValue: 0, length: 3)
6 // the range represents integer values 0, 1, and 2
7 rangeOfThreeItems.firstValue = 6
8 // the range now represents integer values 6, 7, and 8
Instances of FixedLengthRange have a variable stored property called firstValue and a constant stored
property called length. In the example above, length is initialized when the new range is created and cannot be
changed thereafter, because it is a constant property.
Stored Properties of Constant Structure Instances
If you create an instance of a structure and assign that instance to a constant, you cannot modify the instances
properties, even if they were declared as variable properties:
1 let rangeOfFourItems = FixedLengthRange(firstValue: 0, length: 4)
2 // this range represents integer values 0, 1, 2, and 3
3 rangeOfFourItems.firstValue = 6
4 // this will report an error, even thought firstValue is a variable property
Because rangeOfFourItems is declared as a constant (with the let keyword), it is not possible to change its
firstValue property, even though firstValue is a variable property.
This behavior is due to structures being value types. When an instance of a value type is marked as a constant, so
are all of its properties.
The same is not true for classes, which are reference types. If you assign an instance of a reference type to a
constant, you can still change that instances variable properties.
Lazy Stored Properties
A lazy stored property is a property whose initial value is not calculated until the first time it is used. You indicate a
lazy stored property by writing the @lazy attribute before its declaration.
N OT E
You must always declare a lazy property as a variable (with the var keyword), because its initial value may
not be retrieved until after instance initialization completes. Constant properties must always have a value
before initialization completes, and therefore cannot be declared as lazy.
Lazy properties are useful when the initial value for a property is dependent on outside factors whose values are not
known until after an instances initialization is complete. Lazy properties are also useful when the initial value for a
property requires complex or computationally expensive setup that should not be performed unless or until it is
needed.
The example below uses a lazy stored property to avoid unnecessary initialization of a complex class. This
example defines two classes called DataImporter and DataManager, neither of which is shown in full:
1 class DataImporter {
2 /*
3 DataImporter is a class to import data from an external file.
4 The class is assumed to take a non-trivial amount of time to initialize.
5 */
6 var fileName = "data.txt"
7 // the DataImporter class would provide data importing functionality here
8 }
9
10 class DataManager {
11 @lazy var importer = DataImporter()
12 var data = String[]()
13 // the DataManager class would provide data management functionality here
14 }
15
16 let manager = DataManager()
17 manager.data += "Some data"
18 manager.data += "Some more data"
19 // the DataImporter instance for the importer property has not yet been created
The DataManager class has a stored property called data, which is initialized with a new, empty array of String
values. Although the rest of its functionality is not shown, the purpose of this DataManager class is to manage and
provide access to this array of String data.
Part of the functionality of the DataManager class is the ability to import data from a file. This functionality is provided
by the DataImporter class, which is assumed to take a non-trivial amount of time to initialize. This might be
because a DataImporter instance needs to open a file and read its contents into memory when the DataImporter
instance is initialized.
It is possible for a DataManager instance to manage its data without ever importing data from a file, so there is no
need to create a new DataImporter instance when the DataManager itself is created. Instead, it makes more
sense to create the DataImporter instance if and when it is first used.
Because it is marked with the @lazy attribute, the DataImporter instance for the importer property is only created
when the importer property is first accessed, such as when its fileName property is queried:
1 println(manager.importer.fileName)
2 // the DataImporter instance for the importer property has now been created
3 // prints "data.txt"
Stored Properties and Instance Variables
If you have experience with Objective-C, you may know that it provides two ways to store values and references
as part of a class instance. In addition to properties, you can use instance variables as a backing store for the
values stored in a property.
Swift unifies these concepts into a single property declaration. A Swift property does not have a corresponding
instance variable, and the backing store for a property is not accessed directly. This approach avoids confusion
about how the value is accessed in different contexts and simplifies the propertys declaration into a single, definitive
statement. All information about the propertyincluding its name, type, and memory management characteristics
is defined in a single location as part of the types definition.
Computed Properties
In addition to stored properties, classes, structures, and enumerations can define computed properties, which do
not actually store a value. Instead, they provide a getter and an optional setter to retrieve and set other properties
and values indirectly.
1 struct Point {
2 var x = 0.0, y = 0.0
3 }
4 struct Size {
5 var width = 0.0, height = 0.0
6 }
7 struct Rect {
8 var origin = Point()
9 var size = Size()
10 var center: Point {
11 get {
12 let centerX = origin.x + (size.width / 2)
13 let centerY = origin.y + (size.height / 2)
14 return Point(x: centerX, y: centerY)
15 }
16 set(newCenter) {
17 origin.x = newCenter.x - (size.width / 2)
18 origin.y = newCenter.y - (size.height / 2)
19 }
20 }
21 }
22 var square = Rect(origin: Point(x: 0.0, y: 0.0),
23 size: Size(width: 10.0, height: 10.0))
24 let initialSquareCenter = square.center
25 square.center = Point(x: 15.0, y: 15.0)
26 println("square.origin is now at (\(square.origin.x), \(square.origin.y))")
27 // prints "square.origin is now at (10.0, 10.0)"
This example defines three structures for working with geometric shapes:
The Rect structure also provides a computed property called center. The current center position of a Rect can
always be determined from its origin and size, and so you dont need to store the center point as an explicit
Point value. Instead, Rect defines a custom getter and setter for a computed variable called center, to enable you
to work with the rectangles center as if it were a real stored property.
Point encapsulates an (x, y) coordinate.
Size encapsulates a width and a height.
Rect defines a rectangle by an origin point and a size.
The preceding example creates a new Rect variable called square. The square variable is initialized with an origin
point of (0, 0), and a width and height of 10. This square is represented by the blue square in the diagram below.
The square variables center property is then accessed through dot syntax (square.center), which causes the
getter for center to be called, to retrieve the current property value. Rather than returning an existing value, the
getter actually calculates and returns a new Point to represent the center of the square. As can be seen above,
the getter correctly returns a center point of (5, 5).
The center property is then set to a new value of (15, 15), which moves the square up and to the right, to the
new position shown by the orange square in the diagram below. Setting the center property calls the setter for
center, which modifies the x and y values of the stored origin property, and moves the square to its new position.
Shorthand Setter Declaration
If a computed propertys setter does not define a name for the new value to be set, a default name of newValue is
used. Heres an alternative version of the Rect structure, which takes advantage of this shorthand notation:
1 struct AlternativeRect {
2 var origin = Point()
3 var size = Size()
4 var center: Point {
5 get {
6 let centerX = origin.x + (size.width / 2)
7 let centerY = origin.y + (size.height / 2)
8 return Point(x: centerX, y: centerY)
9 }
10 set {
11 origin.x = newValue.x - (size.width / 2)
12 origin.y = newValue.y - (size.height / 2)
13 }
14 }
15 }
Read-Only Computed Properties
A computed property with a getter but no setter is known as a read-only computed property. A read-only computed
property always returns a value, and can be accessed through dot syntax, but cannot be set to a different value.
N OT E
You must declare computed propertiesincluding read-only computed propertiesas variable properties with
the var keyword, because their value is not fixed. The let keyword is only used for constant properties, to
indicate that their values cannot be changed once they are set as part of instance initialization.
You can simplify the declaration of a read-only computed property by removing the get keyword and its braces:
1 struct Cuboid {
2 var width = 0.0, height = 0.0, depth = 0.0
3 var volume: Double {
4 return width * height * depth
5 }
6 }
7 let fourByFiveByTwo = Cuboid(width: 4.0, height: 5.0, depth: 2.0)
8 println("the volume of fourByFiveByTwo is \(fourByFiveByTwo.volume)")
9 // prints "the volume of fourByFiveByTwo is 40.0"
This example defines a new structure called Cuboid, which represents a 3D rectangular box with width, height,
and depth properties. This structure also has a read-only computed property called volume, which calculates and
returns the current volume of the cuboid. It doesnt make sense for volume to be settable, because it would be
ambiguous as to which values of width, height, and depth should be used for a particular volume value.
Nonetheless, it is useful for a Cuboid to provide a read-only computed property to enable external users to discover
its current calculated volume.
Property Observers
Property observers observe and respond to changes in a propertys value. Property observers are called every
time a propertys value is set, even if the new value is the same as the propertys current value.
You can add property observers to any stored properties you define, apart from lazy stored properties. You can
also add property observers to any inherited property (whether stored or computed) by overriding the property
within a subclass. Property overriding is described in Overriding.
N OT E
You dont need to define property observers for non-overridden computed properties, because you can
observe and respond to changes to their value from directly within the computed propertys setter.
You have the option to define either or both of these observers on a property:
If you implement a willSet observer, it is passed the new property value as a constant parameter. You can
specify a name for this parameter as part of your willSet implementation. If you choose not to write the parameter
name and parentheses within your implementation, the parameter will still be made available with a default parameter
name of newValue.
Similarly, if you implement a didSet observer, it will be passed a constant parameter containing the old property
value. You can name the parameter if you wish, or use the default parameter name of oldValue.
N OT E
willSet and didSet observers are not called when a property is first initialized. They are only called when the
propertys value is set outside of an initialization context.
Heres an example of willSet and didSet in action. The example below defines a new class called StepCounter,
which tracks the total number of steps that a person takes while walking. This class might be used with input data
from a pedometer or other step counter to keep track of a persons exercise during their daily routine.
1 class StepCounter {
2 var totalSteps: Int = 0 {
3 willSet(newTotalSteps) {
4 println("About to set totalSteps to \(newTotalSteps)")
willSet is called just before the value is stored.
didSet is called immediately after the new value is stored.
5 }
6 didSet {
7 if totalSteps > oldValue {
8 println("Added \(totalSteps - oldValue) steps")
9 }
10 }
11 }
12 }
13 let stepCounter = StepCounter()
14 stepCounter.totalSteps = 200
15 // About to set totalSteps to 200
16 // Added 200 steps
17 stepCounter.totalSteps = 360
18 // About to set totalSteps to 360
19 // Added 160 steps
20 stepCounter.totalSteps = 896
21 // About to set totalSteps to 896
22 // Added 536 steps
The StepCounter class declares a totalSteps property of type Int. This is a stored property with willSet and
didSet observers.
The willSet and didSet observers for totalSteps are called whenever the property is assigned a new value.
This is true even if the new value is the same as the current value.
This examples willSet observer uses a custom parameter name of newTotalSteps for the upcoming new value.
In this example, it simply prints out the value that is about to be set.
The didSet observer is called after the value of totalSteps is updated. It compares the new value of totalSteps
against the old value. If the total number of steps has increased, a message is printed to indicate how many new
steps have been taken. The didSet observer does not provide a custom parameter name for the old value, and the
default name of oldValue is used instead.
N OT E
If you assign a value to a property within its own didSet observer, the new value that you assign will replace
the one that was just set.
Global and Local Variables
The capabilities described above for computing and observing properties are also available to global variables and
local variables. Global variables are variables that are defined outside of any function, method, closure, or type
context. Local variables are variables that are defined within a function, method, or closure context.
The global and local variables you have encountered in previous chapters have all been stored variables. Stored
variables, like stored properties, provide storage for a value of a certain type and allow that value to be set and
retrieved.
However, you can also define computed variables and define observers for stored variables, in either a global or
local scope. Computed variables calculate rather than store a value, and are written in the same way as computed
properties.
N OT E
Global constants and variables are always computed lazily, in a similar manner to Lazy Stored Properties.
Unlike lazy stored properties, global constants and variables do not need to be marked with the @lazy
attribute.
Local constants and variables are never computed lazily.
Type Properties
Instance properties are properties that belong to an instance of a particular type. Every time you create a new
instance of that type, it has its own set of property values, separate from any other instance.
You can also define properties that belong to the type itself, not to any one instance of that type. There will only ever
be one copy of these properties, no matter how many instances of that type you create. These kinds of properties
are called type properties.
Type properties are useful for defining values that are universal to all instances of a particular type, such as a
constant property that all instances can use (like a static constant in C), or a variable property that stores a value
that is global to all instances of that type (like a static variable in C).
For value types (that is, structures and enumerations), you can define stored and computed type properties. For
classes, you can define computed type properties only.
Stored type properties for value types can be variables or constants. Computed type properties are always
declared as variable properties, in the same way as computed instance properties.
N OT E
Unlike stored instance properties, you must always give stored type properties a default value. This is
because the type itself does not have an initializer that can assign a value to a stored type property at
initialization time.
Type Property Syntax
In C and Objective-C, you define static constants and variables associated with a type as global static variables. In
Swift, however, type properties are written as part of the types definition, within the types outer curly braces, and
each type property is explicitly scoped to the type it supports.
You define type properties for value types with the static keyword, and type properties for class types with the
class keyword. The example below shows the syntax for stored and computed type properties:
1 struct SomeStructure {
2 static var storedTypeProperty = "Some value."
3 static var computedTypeProperty: Int {
4 // return an Int value here
5 }
6 }
7 enum SomeEnumeration {
8 static var storedTypeProperty = "Some value."
9 static var computedTypeProperty: Int {
10 // return an Int value here
11 }
12 }
13 class SomeClass {
14 class var computedTypeProperty: Int {
15 // return an Int value here
16 }
17 }
N OT E
The computed type property examples above are for read-only computed type properties, but you can also
define read-write computed type properties with the same syntax as for computed instance properties.
Querying and Setting Type Properties
Type properties are queried and set with dot syntax, just like instance properties. However, type properties are
queried and set on the type, not on an instance of that type. For example:
1 println(SomeClass.computedTypeProperty)
2 // prints "42"
3
4 println(SomeStructure.storedTypeProperty)
5 // prints "Some value."
6 SomeStructure.storedTypeProperty = "Another value."
7 println(SomeStructure.storedTypeProperty)
8 // prints "Another value."
The examples that follow use two stored type properties as part of a structure that models an audio level meter for a
number of audio channels. Each channel has an integer audio level between 0 and 10 inclusive.
The figure below illustrates how two of these audio channels can be combined to model a stereo audio level meter.
When a channels audio level is 0, none of the lights for that channel are lit. When the audio level is 10, all of the
lights for that channel are lit. In this figure, the left channel has a current level of 9, and the right channel has a
current level of 7:
The audio channels described above are represented by instances of the AudioChannel structure:
1 struct AudioChannel {
2 static let thresholdLevel = 10
3 static var maxInputLevelForAllChannels = 0
4 var currentLevel: Int = 0 {
5 didSet {
6 if currentLevel > AudioChannel.thresholdLevel {
7 // cap the new audio level to the threshold level
8 currentLevel = AudioChannel.thresholdLevel
9 }
10 if currentLevel > AudioChannel.maxInputLevelForAllChannels {
11 // store this as the new overall maximum input level
12 AudioChannel.maxInputLevelForAllChannels = currentLevel
13 }
14 }
15 }
16 }
The AudioChannel structure defines two stored type properties to support its functionality. The first,
thresholdLevel, defines the maximum threshold value an audio level can take. This is a constant value of 10 for
all AudioChannel instances. If an audio signal comes in with a higher value than 10, it will be capped to this
threshold value (as described below).
The second type property is a variable stored property called maxInputLevelForAllChannels. This keeps track
of the maximum input value that has been received by any AudioChannel instance. It starts with an initial value of 0.
The AudioChannel structure also defines a stored instance property called currentLevel, which represents the
channels current audio level on a scale of 0 to 10.
The currentLevel property has a didSet property observer to check the value of currentLevel whenever it is
set. This observer performs two checks:
N OT E
In the first of these two checks, the didSet observer sets currentLevel to a different value. This does not,
however, cause the observer to be called again.
You can use the AudioChannel structure to create two new audio channels called leftChannel and
rightChannel, to represent the audio levels of a stereo sound system:
1 var leftChannel = AudioChannel()
2 var rightChannel = AudioChannel()
If you set the currentLevel of the left channel to 7, you can see that the maxInputLevelForAllChannels type
property is updated to equal 7:
1 leftChannel.currentLevel = 7
If the new value of currentLevel is greater than the allowed thresholdLevel, the property observer
caps currentLevel to thresholdLevel.
If the new value of currentLevel (after any capping) is higher than any value previously received by
any AudioChannel instance, the property observer stores the new currentLevel value in the
maxInputLevelForAllChannels static property.
2 println(leftChannel.currentLevel)
3 // prints "7"
4 println(AudioChannel.maxInputLevelForAllChannels)
5 // prints "7"
If you try to set the currentLevel of the right channel to 11, you can see that the right channels currentLevel
property is capped to the maximum value of 10, and the maxInputLevelForAllChannels type property is updated
to equal 10:
1 rightChannel.currentLevel = 11
2 println(rightChannel.currentLevel)
3 // prints "10"
4 println(AudioChannel.maxInputLevelForAllChannels)
5 // prints "10"
Methods
Methods are functions that are associated with a particular type. Classes, structures, and enumerations can all
define instance methods, which encapsulate specific tasks and functionality for working with an instance of a given
type. Classes, structures, and enumerations can also define type methods, which are associated with the type
itself. Type methods are similar to class methods in Objective-C.
The fact that structures and enumerations can define methods in Swift is a major difference from C and Objective-
C. In Objective-C, classes are the only types that can define methods. In Swift, you can choose whether to define a
class, structure, or enumeration, and still have the flexibility to define methods on the type you create.
Instance Methods
Instance methods are functions that belong to instances of a particular class, structure, or enumeration. They
support the functionality of those instances, either by providing ways to access and modify instance properties, or
by providing functionality related to the instances purpose. Instance methods have exactly the same syntax as
functions, as described in Functions.
You write an instance method within the opening and closing braces of the type it belongs to. An instance method
has implicit access to all other instance methods and properties of that type. An instance method can be called only
on a specific instance of the type it belongs to. It cannot be called in isolation without an existing instance.
Heres an example that defines a simple Counter class, which can be used to count the number of times an action
occurs:
1 class Counter {
2 var count = 0
3 func increment() {
4 count++
5 }
6 func incrementBy(amount: Int) {
7 count += amount
8 }
9 func reset() {
10 count = 0
11 }
12 }
The Counter class defines three instance methods:
increment increments the counter by 1.
incrementBy(amount: Int) increments the counter by an specified integer amount.
reset resets the counter to zero.
The Counter class also declares a variable property, count, to keep track of the current counter value.
You call instance methods with the same dot syntax as properties:
1 let counter = Counter()
2 // the initial counter value is 0
3 counter.increment()
4 // the counter's value is now 1
5 counter.incrementBy(5)
6 // the counter's value is now 6
7 counter.reset()
8 // the counter's value is now 0
Local and External Parameter Names for Methods
Function parameters can have both a local name (for use within the functions body) and an external name (for use
when calling the function), as described in External Parameter Names. The same is true for method parameters,
because methods are just functions that are associated with a type. However, the default behavior of local names
and external names is different for functions and methods.
Methods in Swift are very similar to their counterparts in Objective-C. As in Objective-C, the name of a method in
Swift typically refers to the methods first parameter using a preposition such as with, for, or by, as seen in the
incrementBy method from the preceding Counter class example. The use of a preposition enables the method to
be read as a sentence when it is called. Swift makes this established method naming convention easy to write by
using a different default approach for method parameters than it uses for function parameters.
Specifically, Swift gives the first parameter name in a method a local parameter name by default, and gives the
second and subsequent parameter names both local and external parameter names by default. This convention
matches the typical naming and calling convention you will be familiar with from writing Objective-C methods, and
makes for expressive method calls without the need to qualify your parameter names.
Consider this alternative version of the Counter class, which defines a more complex form of the incrementBy
method:
1 class Counter {
2 var count: Int = 0
3 func incrementBy(amount: Int, numberOfTimes: Int) {
4 count += amount * numberOfTimes
5 }
6 }
This incrementBy method has two parametersamount and numberOfTimes. By default, Swift treats amount as a
local name only, but treats numberOfTimes as both a local and an external name. You call the method as follows:
1 let counter = Counter()
2 counter.incrementBy(5, numberOfTimes: 3)
3 // counter value is now 15
You dont need to define an external parameter name for the first argument value, because its purpose is clear from
the function name incrementBy. The second argument, however, is qualified by an external parameter name to
make its purpose clear when the method is called.
This default behavior effectively treats the method as if you had written a hash symbol (#) before the
numberOfTimes parameter:
1 func incrementBy(amount: Int, #numberOfTimes: Int) {
2 count += amount * numberOfTimes
3 }
The default behavior described above mean that method definitions in Swift are written with the same grammatical
style as Objective-C, and are called in a natural, expressive way.
Modifying External Parameter Name Behavior for Methods
Sometimes its useful to provide an external parameter name for a methods first parameter, even though this is not
the default behavior. You can either add an explicit external name yourself, or you can prefix the first parameters
name with a hash symbol to use the local name as an external name too.
Conversely, if you do not want to provide an external name for the second or subsequent parameter of a method,
override the default behavior by using an underscore character (_) as an explicit external parameter name for that
parameter.
The self Property
Every instance of a type has an implicit property called self, which is exactly equivalent to the instance itself. You
use this implicit self property to refer to the current instance within its own instance methods.
The increment method in the example above could have been written like this:
1 func increment() {
2 self.count++
3 }
In practice, you dont need to write self in your code very often. If you dont explicitly write self, Swift assumes
that you are referring to a property or method of the current instance whenever you use a known property or
method name within a method. This assumption is demonstrated by the use of count (rather than self.count)
inside the three instance methods for Counter.
The main exception to this rule occurs when a parameter name for an instance method has the same name as a
property of that instance. In this situation, the parameter name takes precedence, and it becomes necessary to
refer to the property in a more qualified way. You use the implicit self property to distinguish between the
parameter name and the property name.
Here, self disambiguates between a method parameter called x and an instance property that is also called x:
1 struct Point {
2 var x = 0.0, y = 0.0
3 func isToTheRightOfX(x: Double) -> Bool {
4 return self.x > x
5 }
6 }
7 let somePoint = Point(x: 4.0, y: 5.0)
8 if somePoint.isToTheRightOfX(1.0) {
9 println("This point is to the right of the line where x == 1.0")
10 }
11 // prints "This point is to the right of the line where x == 1.0"
Without the self prefix, Swift would assume that both uses of x referred to the method parameter called x.
Modifying Value Types from Within Instance Methods
Structures and enumerations are value types. By default, the properties of a value type cannot be modified from
within its instance methods.
However, if you need to modify the properties of your structure or enumeration within a particular method, you can
opt in to mutating behavior for that method. The method can then mutate (that is, change) its properties from within
the method, and any changes that it makes are written back to the original structure when the method ends. The
method can also assign a completely new instance to its implicit self property, and this new instance will replace
the existing one when the method ends.
You can opt in to this behavior by placing the mutating keyword before the func keyword for that method:
1 struct Point {
2 var x = 0.0, y = 0.0
3 mutating func moveByX(deltaX: Double, y deltaY: Double) {
4 x += deltaX
5 y += deltaY
6 }
7 }
8 var somePoint = Point(x: 1.0, y: 1.0)
9 somePoint.moveByX(2.0, y: 3.0)
10 println("The point is now at (\(somePoint.x), \(somePoint.y))")
11 // prints "The point is now at (3.0, 4.0)"
The Point structure above defines a mutating moveByX method, which moves a Point instance by a certain
amount. Instead of returning a new point, this method actually modifies the point on which it is called. The mutating
keyword is added to its definition to enable it to modify its properties.
Note that you cannot call a mutating method on a constant of structure type, because its properties cannot be
changed, even if they are variable properties, as described in Stored Properties of Constant Structure Instances:
1 let fixedPoint = Point(x: 3.0, y: 3.0)
2 fixedPoint.moveByX(2.0, y: 3.0)
3 // this will report an error
Assigning to self Within a Mutating Method
Mutating methods can assign an entirely new instance to the implicit self property. The Point example shown
above could have been written in the following way instead:
1 struct Point {
2 var x = 0.0, y = 0.0
3 mutating func moveByX(deltaX: Double, y deltaY: Double) {
4 self = Point(x: x + deltaX, y: y + deltaY)
5 }
6 }
This version of the mutating moveByX method creates a brand new structure whose x and y values are set to the
target location. The end result of calling this alternative version of the method will be exactly the same as for calling
the earlier version.
Mutating methods for enumerations can set the implicit self parameter to be a different member from the same
enumeration:
1 enum TriStateSwitch {
2 case Off, Low, High
3 mutating func next() {
4 switch self {
5 case Off:
6 self = Low
7 case Low:
8 self = High
9 case High:
10 self = Off
11 }
12 }
13 }
14 var ovenLight = TriStateSwitch.Low
15 ovenLight.next()
16 // ovenLight is now equal to .High
17 ovenLight.next()
18 // ovenLight is now equal to .Off
This example defines an enumeration for a three-state switch. The switch cycles between three different power
states (Off, Low and High) every time its next method is called.
Type Methods
Instance methods, as described above, are methods that are called on an instance of a particular type. You can
also define methods that are called on the type itself. These kinds of methods are called type methods. You indicate
type methods for classes by writing the keyword class before the methods func keyword, and type methods for
structures and enumerations by writing the keyword static before the methods func keyword.
N OT E
In Objective-C, you can define type-level methods only for Objective-C classes. In Swift, you can define type-
level methods for all classes, structures, and enumerations. Each type method is explicitly scoped to the type
it supports.
Type methods are called with dot syntax, like instance methods. However, you call type methods on the type, not
on an instance of that type. Heres how you call a type method on a class called SomeClass:
1 class SomeClass {
2 class func someTypeMethod() {
3 // type method implementation goes here
4 }
5 }
6 SomeClass.someTypeMethod()
Within the body of a type method, the implicit self property refers to the type itself, rather than an instance of that
type. For structures and enumerations, this means that you can use self to disambiguate between static
properties and static method parameters, just as you do for instance properties and instance method parameters.
More generally, any unqualified method and property names that you use within the body of a type method will refer
to other type-level methods and properties. A type method can call another type method with the other methods
name, without needing to prefix it with the type name. Similarly, type methods on structures and enumerations can
access static properties by using the static propertys name without a type name prefix.
The example below defines a structure called LevelTracker, which tracks a players progress through the different
levels or stages of a game. It is a single-player game, but can store information for multiple players on a single
device.
All of the games levels (apart from level one) are locked when the game is first played. Every time a player finishes
a level, that level is unlocked for all players on the device. The LevelTracker structure uses static properties and
methods to keep track of which levels of the game have been unlocked. It also tracks the current level for an
individual player.
1 struct LevelTracker {
2 static var highestUnlockedLevel = 1
3 static func unlockLevel(level: Int) {
4 if level > highestUnlockedLevel { highestUnlockedLevel = level }
5 }
6 static func levelIsUnlocked(level: Int) -> Bool {
7 return level <= highestUnlockedLevel
8 }
9 var currentLevel = 1
10 mutating func advanceToLevel(level: Int) -> Bool {
11 if LevelTracker.levelIsUnlocked(level) {
12 currentLevel = level
13 return true
14 } else {
15 return false
16 }
17 }
18 }
The LevelTracker structure keeps track of the highest level that any player has unlocked. This value is stored in a
static property called highestUnlockedLevel.
LevelTracker also defines two type functions to work with the highestUnlockedLevel property. The first is a type
function called unlockLevel, which updates the value of highestUnlockedLevel whenever a new level is
unlocked. The second is a convenience type function called levelIsUnlocked, which returns true if a particular
level number is already unlocked. (Note that these type methods can access the highestUnlockedLevel static
property without your needing to write it as LevelTracker.highestUnlockedLevel.)
In addition to its static property and type methods, LevelTracker tracks an individual players progress through the
game. It uses an instance property called currentLevel to track the level that a player is currently playing.
To help manage the currentLevel property, LevelTracker defines an instance method called advanceToLevel.
Before updating currentLevel, this method checks whether the requested new level is already unlocked. The
advanceToLevel method returns a Boolean value to indicate whether or not it was actually able to set
currentLevel.
The LevelTracker structure is used with the Player class, shown below, to track and update the progress of an
individual player:
1 class Player {
2 var tracker = LevelTracker()
3 let playerName: String
4 func completedLevel(level: Int) {
5 LevelTracker.unlockLevel(level + 1)
6 tracker.advanceToLevel(level + 1)
7 }
8 init(name: String) {
9 playerName = name
10 }
11 }
The Player class creates a new instance of LevelTracker to track that players progress. It also provides a
method called completedLevel, which is called whenever a player completes a particular level. This method
unlocks the next level for all players and updates the players progress to move them to the next level. (The
Boolean return value of advanceToLevel is ignored, because the level is known to have been unlocked by the call
to LevelTracker.unlockLevel on the previous line.)
You can create a instance of the Player class for a new player, and see what happens when the player completes
level one:
1 var player = Player(name: "Argyrios")
2 player.completedLevel(1)
3 println("highest unlocked level is now \(LevelTracker.highestUnlockedLevel)")
4 // prints "highest unlocked level is now 2"
If you create a second player, whom you try to move to a level that is not yet unlocked by any player in the game,
the attempt to set the players current level fails:
1 player = Player(name: "Beto")
2 if player.tracker.advanceToLevel(6) {
3 println("player is now on level 6")
4 } else {
5 println("level 6 has not yet been unlocked")
6 }
7 // prints "level 6 has not yet been unlocked"
Subscripts
Classes, structures, and enumerations can define subscripts, which are shortcuts for accessing the member
elements of a collection, list, or sequence. You use subscripts to set and retrieve values by index without needing
separate methods for setting and retrieval. For example, you access elements in an Array instance as
someArray[index] and elements in a Dictionary instance as someDictionary[key].
You can define multiple subscripts for a single type, and the appropriate subscript overload to use is selected based
on the type of index value you pass to the subscript. Subscripts are not limited to a single dimension, and you can
define subscripts with multiple input parameters to suit your custom types needs.
Subscript Syntax
Subscripts enable you to query instances of a type by writing one or more values in square brackets after the
instance name. Their syntax is similar to both instance method syntax and computed property syntax. You write
subscript definitions with the subscript keyword, and specify one or more input parameters and a return type, in
the same way as instance methods. Unlike instance methods, subscripts can be read-write or read-only. This
behavior is communicated by a getter and setter in the same way as for computed properties:
1 subscript(index: Int) -> Int {
2 get {
3 // return an appropriate subscript value here
4 }
5 set(newValue) {
6 // perform a suitable setting action here
7 }
8 }
The type of newValue is the same as the return value of the subscript. As with computed properties, you can
choose not to specify the setters (newValue) parameter. A default parameter called newValue is provided to your
setter if you do not provide one yourself.
As with read-only computed properties, you can drop the get keyword for read-only subscripts:
1 subscript(index: Int) -> Int {
2 // return an appropriate subscript value here
3 }
Heres an example of a read-only subscript implementation, which defines a TimesTable structure to represent an
n-times-table of integers:
1 struct TimesTable {
2 let multiplier: Int
3 subscript(index: Int) -> Int {
4 return multiplier * index
5 }
6 }
7 let threeTimesTable = TimesTable(multiplier: 3)
8 println("six times three is \(threeTimesTable[6])")
9 // prints "six times three is 18"
In this example, a new instance of TimesTable is created to represent the three-times-table. This is indicated by
passing a value of 3 to the structures initializer as the value to use for the instances multiplier parameter.
You can query the threeTimesTable instance by calling its subscript, as shown in the call to
threeTimesTable[6]. This requests the sixth entry in the three-times-table, which returns a value of 18, or 3 times
6.
N OT E
An n-times-table is based on a fixed mathematical rule. It is not appropriate to set
threeTimesTable[someIndex] to a new value, and so the subscript for TimesTable is defined as a read-only
subscript.
Subscript Usage
The exact meaning of subscript depends on the context in which it is used. Subscripts are typically used as a
shortcut for accessing the member elements in a collection, list, or sequence. You are free to implement subscripts
in the most appropriate way for your particular class or structures functionality.
For example, Swifts Dictionary type implements a subscript to set and retrieve the values stored in a
Dictionary instance. You can set a value in a dictionary by providing a key of the dictionarys key type within
subscript braces, and assigning a value of the dictionarys value type to the subscript:
1 var numberOfLegs = ["spider": 8, "ant": 6, "cat": 4]
2 numberOfLegs["bird"] = 2
The example above defines a variable called numberOfLegs and initializes it with a dictionary literal containing three
key-value pairs. The type of the numberOfLegs dictionary is inferred to be Dictionary<String, Int>. After
creating the dictionary, this example uses subscript assignment to add a String key of "bird" and an Int value of
2 to the dictionary.
For more information about Dictionary subscripting, see Accessing and Modifying a Dictionary.
N OT E
Swifts Dictionary type implements its key-value subscripting as a subscript that takes and receives an
optional type. For the numberOfLegs dictionary above, the key-value subscript takes and returns a value of
type Int?, or optional int. The Dictionary type uses an optional subscript type to model the fact that not
every key will have a value, and to give a way to delete a value for a key by assigning a nil value for that
key.
Subscript Options
Subscripts can take any number of input parameters, and these input parameters can be of any type. Subscripts
can also return any type. Subscripts can use variable parameters and variadic parameters, but cannot use in-out
parameters or provide default parameter values.
A class or structure can provide as many subscript implementations as it needs, and the appropriate subscript to
be used will be inferred based on the types of the value or values that are contained within the subscript braces at
the point that the subscript is used. This definition of multiple subscripts is known as subscript overloading.
While it is most common for a subscript to take a single parameter, you can also define a subscript with multiple
parameters if it is appropriate for your type. The following example defines a Matrix structure, which represents a
two-dimensional matrix of Double values. The Matrix structures subscript takes two integer parameters:
1 struct Matrix {
2 let rows: Int, columns: Int
3 var grid: Double[]
4 init(rows: Int, columns: Int) {
5 self.rows = rows
6 self.columns = columns
7 grid = Array(count: rows * columns, repeatedValue: 0.0)
8 }
9 func indexIsValidForRow(row: Int, column: Int) -> Bool {
10 return row >= 0 && row < rows && column >= 0 && column < columns
11 }
12 subscript(row: Int, column: Int) -> Double {
13 get {
14 assert(indexIsValidForRow(row, column: column), "Index out of range")
15 return grid[(row * columns) + column]
16 }
17 set {
18 assert(indexIsValidForRow(row, column: column), "Index out of range")
19 grid[(row * columns) + column] = newValue
20 }
21 }
22 }
Matrix provides an initializer that takes two parameters called rows and columns, and creates an array that is
large enough to store rows * columns values of type Double. Each position in the matrix is given an initial value of
0.0. To achieve this, the arrays size, and an initial cell value of 0.0, are passed to an array initializer that creates
and initializes a new array of the correct size. This initializer is described in more detail in Creating and Initializing an
Array.
You can construct a new Matrix instance by passing an appropriate row and column count to its initializer:
var matrix = Matrix(rows: 2, columns: 2)
The preceding example creates a new Matrix instance with two rows and two columns. The grid array for this
Matrix instance is effectively a flattened version of the matrix, as read from top left to bottom right:
Values in the matrix can be set by passing row and column values into the subscript, separated by a comma:
1 matrix[0, 1] = 1.5
2 matrix[1, 0] = 3.2
These two statements call the subscripts setter to set a value of 1.5 in the top right position of the matrix (where
row is 0 and column is 1), and 3.2 in the bottom left position (where row is 1 and column is 0):
The Matrix subscripts getter and setter both contain an assertion to check that the subscripts row and column
values are valid. To assist with these assertions, Matrix includes a convenience method called indexIsValid,
which checks whether the requested row or column is outside the bounds of the matrix:
1 func indexIsValidForRow(row: Int, column: Int) -> Bool {
2 return row >= 0 && row < rows && column >= 0 && column < columns
3 }
An assertion is triggered if you try to access a subscript that is outside of the matrix bounds:
1 let someValue = matrix[2, 2]
2 // this triggers an assert, because [2, 2] is outside of the matrix bounds
Inheritance
A class can inherit methods, properties, and other characteristics from another class. When one class inherits from
another, the inheriting class is known as a subclass, and the class it inherits from is known as its superclass.
Inheritance is a fundamental behavior that differentiates classes from other types in Swift.
Classes in Swift can call and access methods, properties, and subscripts belonging to their superclass and can
provide their own overriding versions of those methods, properties, and subscripts to refine or modify their
behavior. Swift helps to ensure your overrides are correct by checking that the override definition has a matching
superclass definition.
Classes can also add property observers to inherited properties in order to be notified when the value of a property
changes. Property observers can be added to any property, regardless of whether it was originally defined as a
stored or computed property.
Defining a Base Class
Any class that does not inherit from another class is known as a base class.
N OT E
Swift classes do not inherit from a universal base class. Classes you define without specifying a superclass
automatically become base classes for you to build upon.
The example below defines a base class called Vehicle. This base class declares two properties
(numberOfWheels and maxPassengers) that are universal to all vehicles. These properties are used by a method
called description, which returns a String description of the vehicles characteristics:
1 class Vehicle {
2 var numberOfWheels: Int
3 var maxPassengers: Int
4 func description() -> String {
5 return "\(numberOfWheels) wheels; up to \(maxPassengers) passengers"
6 }
7 init() {
8 numberOfWheels = 0
9 maxPassengers = 1
10 }
11 }
The Vehicle class also defines an initializer to set up its properties. Initializers are described in detail in Initialization,
but a brief introduction is required here in order to illustrate how inherited properties can be modified by subclasses.
You use initializers to create a new instance of a type. Although initializers are not methods, they are written in a
very similar syntax to instance methods. An initializer prepares a new instance for use, and ensures that all
properties of the instance have valid initial values.
In its simplest form, an initializer is like an instance method with no parameters, written using the init keyword:
1 init() {
2 // perform some initialization here
3 }
To create a new instance of Vehicle, call this initializer with initializer syntax, written as TypeName followed by
empty parentheses:
let someVehicle = Vehicle()
The initializer for Vehicle sets some initial property values (numberOfWheels = 0 and maxPassengers = 1) for an
arbitrary vehicle.
The Vehicle class defines common characteristics for an arbitrary vehicle, but is not much use in itself. To make it
more useful, you need to refine it to describe more specific kinds of vehicle.
Subclassing
Subclassing is the act of basing a new class on an existing class. The subclass inherits characteristics from the
existing class, which you can refine. You can also add new characteristics to the subclass.
To indicate that a class has a superclass, write the superclass name after the original class name, separated by a
colon:
1 class SomeClass: SomeSuperclass {
2 // class definition goes here
3 }
The next example defines a second, more specific vehicle called Bicycle. This new class is based on the existing
capabilities of Vehicle. You indicate this by placing the name of the class the subclass builds upon (Vehicle) after
its own name (Bicycle), separated by a colon.
This can be read as:
Define a new class called Bicycle, which inherits the characteristics of Vehicle:
1 class Bicycle: Vehicle {
2 init() {
3 super.init()
4 numberOfWheels = 2
5 }
6 }
Bicycle is a subclass of Vehicle, and Vehicle is the superclass of Bicycle. The new Bicycle class
automatically gains all characteristics of Vehicle, such as its maxPassengers and numberOfWheels properties.
You can tailor those characteristics and add new ones to better match the requirements of the Bicycle class.
The Bicycle class also defines an initializer to set up its tailored characteristics. The initializer for Bicycle calls
super.init(), the initializer for the Bicycle classs superclass, Vehicle, and ensures that all of the inherited
properties are initialized by Vehicle before Bicycle tries to modify them.
N OT E
Unlike Objective-C, initializers are not inherited by default in Swift. For more information, see Initializer
Inheritance and Overriding.
The default value of maxPassengers provided by Vehicle is already correct for a bicycle, and so it is not changed
within the initializer for Bicycle. The original value of numberOfWheels is not correct, however, and is replaced with
a new value of 2.
As well as inheriting the properties of Vehicle, Bicycle also inherits its methods. If you create an instance of
Bicycle, you can call its inherited description method to see how its properties have been updated:
1 let bicycle = Bicycle()
2 println("Bicycle: \(bicycle.description())")
3 // Bicycle: 2 wheels; up to 1 passengers
Subclasses can themselves be subclassed:
1 class Tandem: Bicycle {
2 init() {
3 super.init()
4 maxPassengers = 2
5 }
6 }
This example creates a subclass of Bicycle for a two-seater bicycle known as a tandem. Tandem inherits the two
properties from Bicycle, which in turn inherits these properties from Vehicle. Tandem doesnt change the number
of wheelsits still a bicycle, after allbut it does update maxPassengers to have the correct value for a tandem.
N OT E
Subclasses are only allowed to modify variable properties of superclasses during initialization. You cant
modify inherited constant properties of subclasses.
Creating an instance of Tandem and printing its description shows how its properties have been updated:
1 let tandem = Tandem()
2 println("Tandem: \(tandem.description())")
3 // Tandem: 2 wheels; up to 2 passengers
Note that the description method is also inherited by Tandem. Instance methods of a class are inherited by any
and all subclasses of that class.
Overriding
A subclass can provide its own custom implementation of an instance method, class method, instance property, or
subscript that it would otherwise inherit from a superclass. This is known as overriding.
To override a characteristic that would otherwise be inherited, you prefix your overriding definition with the
override keyword. Doing so clarifies that you intend to provide an override and have not provided a matching
definition by mistake. Overriding by accident can cause unexpected behavior, and any overrides without the
override keyword are diagnosed as an error when your code is compiled.
The override keyword also prompts the Swift compiler to check that your overriding classs superclass (or one of
its parents) has a declaration that matches the one you provided for the override. This check ensures that your
overriding definition is correct.
Accessing Superclass Methods, Properties, and Subscripts
When you provide a method, property, or subscript override for a subclass, it is sometimes useful to use the
existing superclass implementation as part of your override. For example, you can refine the behavior of that
existing implementation or store a modified value in an existing inherited variable.
Where this is appropriate, you access the superclass version of a method, property, or subscript by using the
super prefix:
An overridden method named someMethod can call the superclass version of someMethod by calling
super.someMethod() within the overriding method implementation.
An overridden property called someProperty can access the superclass version of someProperty as
super.someProperty within the overriding getter or setter implementation.
An overridden subscript for someIndex can access the superclass version of the same subscript as
super[someIndex] from within the overriding subscript implementation.
Overriding Methods
You can override an inherited instance or class method to provide a tailored or alternative implementation of the
method within your subclass.
The following example defines a new subclass of Vehicle called Car, which overrides the description method it
inherits from Vehicle:
1 class Car: Vehicle {
2 var speed: Double = 0.0
3 init() {
4 super.init()
5 maxPassengers = 5
6 numberOfWheels = 4
7 }
8 override func description() -> String {
9 return super.description() + "; "
10 + "traveling at \(speed) mph"
11 }
12 }
Car declares a new stored Double property called speed. This property defaults to 0.0, meaning zero miles per
hour. Car also has a custom initializer, which sets the maximum number of passengers to 5, and the default
number of wheels to 4.
Car overrides its inherited description method by providing a method with the same declaration as the
description method from Vehicle. The overriding method definition is prefixed with the override keyword.
Rather than providing a completely custom implementation of description, the overriding method actually starts by
calling super.description to retrieve the description provided by Vehicle. It then appends some additional
information about the cars current speed.
If you create a new instance of Car, and print the output of its description method, you can see that the
description has indeed changed:
1 let car = Car()
2 println("Car: \(car.description())")
3 // Car: 4 wheels; up to 5 passengers; traveling at 0.0 mph
Overriding Properties
You can override an inherited instance or class property to provide your own custom getter and setter for that
property, or to add property observers to enable the overriding property to observe when the underlying property
value changes.
Overriding Property Getters and Setters
You can provide a custom getter (and setter, if appropriate) to override any inherited property, regardless of
whether the inherited property is implemented as a stored or computed property at its source. The stored or
computed nature of an inherited property is not known by a subclassit only knows that the inherited property has
a certain name and type. You must always state both the name and the type of the property you are overriding, to
enable the compiler to check that your override matches a superclass property with the same name and type.
You can present an inherited read-only property as a read-write property by providing both a getter and a setter in
your subclass property override. You cannot, however, present an inherited read-write property as a read-only
property.
N OT E
If you provide a setter as part of a property override, you must also provide a getter for that override. If you
dont want to modify the inherited propertys value within the overriding getter, you can simply pass through
the inherited value by returning super.someProperty from the getter, as in the SpeedLimitedCar example
below.
The following example defines a new class called SpeedLimitedCar, which is a subclass of Car. The
SpeedLimitedCar class represents a car that has been fitted with a speed-limiting device, which prevents the car
from traveling faster than 40mph. You implement this limitation by overriding the inherited speed property:
1 class SpeedLimitedCar: Car {
2 override var speed: Double {
3 get {
4 return super.speed
5 }
6 set {
7 super.speed = min(newValue, 40.0)
8 }
9 }
10 }
Whenever you set the speed property of a SpeedLimitedCar instance, the propertys setter implementation checks
the new value and limits it to 40mph. It does this by setting the underlying speed property of its superclass to be the
smaller of newValue and 40.0. The smaller of these two values is determined by passing them to the min function,
which is a global function provided by the Swift standard library. The min function takes two or more values and
returns the smallest one of those values.
If you try to set the speed property of a SpeedLimitedCar instance to more than 40mph, and then print the output
of its description method, you see that the speed has been limited:
1 let limitedCar = SpeedLimitedCar()
2 limitedCar.speed = 60.0
3 println("SpeedLimitedCar: \(limitedCar.description())")
4 // SpeedLimitedCar: 4 wheels; up to 5 passengers; traveling at 40.0 mph
Overriding Property Observers
You can use property overriding to add property observers to an inherited property. This enables you to be notified
when the value of the inherited property changes, regardless of how that property was originally implemented. For
more information on property observers, see Property Observers.
N OT E
You cannot add property observers to inherited constant stored properties or inherited read-only computed
properties. The value of these properties cannot be set, and so it is not appropriate to provide a willSet or
didSet implementation as part of an override.
Note also that you cannot provide both an overriding setter and an overriding property observer. If you want
to observe changes to a propertys value, and you are already providing a custom setter for that property,
you can simply observe any value changes from within the custom setter.
The following example defines a new class called AutomaticCar, which is a subclass of Car. The AutomaticCar
class represents a car with an automatic gearbox, which automatically selects an appropriate gear to use based on
the current speed. AutomaticCar also provides a custom description method to print the current gear.
1 class AutomaticCar: Car {
2 var gear = 1
3 override var speed: Double {
4 didSet {
5 gear = Int(speed / 10.0) + 1
6 }
7 }
8 override func description() -> String {
9 return super.description() + " in gear \(gear)"
10 }
11 }
Whenever you set the speed property of an AutomaticCar instance, the propertys didSet observer automatically
sets the gear property to an appropriate choice of gear for the new speed. Specifically, the property observer
chooses a gear which is the new speed value divided by 10, rounded down to the nearest integer, plus 1. A speed
of 10.0 produces a gear of 1, and a speed of 35.0 produces a gear of 4:
1 let automatic = AutomaticCar()
2 automatic.speed = 35.0
3 println("AutomaticCar: \(automatic.description())")
4 // AutomaticCar: 4 wheels; up to 5 passengers; traveling at 35.0 mph in gear 4
Preventing Overrides
You can prevent a method, property, or subscript from being overridden by marking it as final. Do this by writing the
@final attribute before its introducer keyword (such as @final var, @final func, @final class func, and
@final subscript).
Any attempts to override a final method, property, or subscript in a subclass are reported as a compile-time error.
Methods, properties or subscripts that you add to a class in an extension can also be marked as final within the
extensions definition.
You can mark an entire class as final by writing the @final attribute before the class keyword in its class definition
(@final class). Any attempts to subclass a final class will be reported as a compile-time error.
Initialization
Initialization is the process of preparing an instance of a class, structure, or enumeration for use. This process
involves setting an initial value for each stored property on that instance and performing any other setup or
initialization that is required before the new instance is ready to for use.
You implement this initialization process by defining initializers, which are like special methods that can be called to
create a new instance of a particular type. Unlike Objective-C initializers, Swift initializers do not return a value. Their
primary role is to ensure that new instances of a type are correctly initialized before they are used for the first time.
Instances of class types can also implement a deinitializer, which performs any custom cleanup just before an
instance of that class is deallocated. For more information about deinitializers, see Deinitialization.
Setting Initial Values for Stored Properties
Classes and structures must set all of their stored properties to an appropriate initial value by the time an instance
of that class or structure is created. Stored properties cannot be left in an indeterminate state.
You can set an initial value for a stored property within an initializer, or by assigning a default property value as part
of the propertys definition. These actions are described in the following sections.
N OT E
When you assign a default value to a stored property, or set its initial value within an initializer, the value of
that property is set directly, without calling any property observers.
Initializers
Initializers are called to create a new instance of a particular type. In its simplest form, an initializer is like an
instance method with no parameters, written using the init keyword.
The example below defines a new structure called Fahrenheit to store temperatures expressed in the Fahrenheit
scale. The Fahrenheit structure has one stored property, temperature, which is of type Double:
1 struct Fahrenheit {
2 var temperature: Double
3 init() {
4 temperature = 32.0
5 }
6 }
7 var f = Fahrenheit()
8 println("The default temperature is \(f.temperature) Fahrenheit")
9 // prints "The default temperature is 32.0 Fahrenheit"
The structure defines a single initializer, init, with no parameters, which initializes the stored temperature with a
value of 32.0 (the freezing point of water when expressed in the Fahrenheit scale).
Default Property Values
You can set the initial value of a stored property from within an initializer, as shown above. Alternatively, specify a
default property value as part of the propertys declaration. You specify a default property value by assigning an
initial value to the property when it is defined.
N OT E
If a property always takes the same initial value, provide a default value rather than setting a value within an
initializer. The end result is the same, but the default value ties the propertys initialization more closely to its
declaration. It makes for shorter, clearer initializers and enables you to infer the type of the property from its
default value. The default value also makes it easier for you to take advantage of default initializers and
initializer inheritance, as described later in this chapter.
You can write the Fahrenheit structure from above in a simpler form by providing a default value for its
temperature property at the point that the property is declared:
1 struct Fahrenheit {
2 var temperature = 32.0
3 }
Customizing Initialization
You can customize the initialization process with input parameters and optional property types, or by modifying
constant properties during initialization, as described in the following sections.
Initialization Parameters
You can provide initialization parameters as part of an initializers definition, to define the types and names of values
that customize the initialization process. Initialization parameters have the same capabilities and syntax as function
and method parameters.
The following example defines a structure called Celsius, which stores temperatures expressed in the Celsius
scale. The Celsius structure implements two custom initializers called init(fromFahrenheit:) and
init(fromKelvin:), which initialize a new instance of the structure with a value from a different temperature scale:
1 struct Celsius {
2 var temperatureInCelsius: Double = 0.0
3 init(fromFahrenheit fahrenheit: Double) {
4 temperatureInCelsius = (fahrenheit - 32.0) / 1.8
5 }
6 init(fromKelvin kelvin: Double) {
7 temperatureInCelsius = kelvin - 273.15
8 }
9 }
10 let boilingPointOfWater = Celsius(fromFahrenheit: 212.0)
11 // boilingPointOfWater.temperatureInCelsius is 100.0
12 let freezingPointOfWater = Celsius(fromKelvin: 273.15)
13 // freezingPointOfWater.temperatureInCelsius is 0.0
The first initializer has a single initialization parameter with an external name of fromFahrenheit and a local name of
fahrenheit. The second initializer has a single initialization parameter with an external name of fromKelvin and a
local name of kelvin. Both initializers convert their single argument into a value in the Celsius scale and store this
value in a property called temperatureInCelsius.
Local and External Parameter Names
As with function and method parameters, initialization parameters can have both a local name for use within the
initializers body and an external name for use when calling the initializer.
However, initializers do not have an identifying function name before their parentheses in the way that functions and
methods do. Therefore, the names and types of an initializers parameters play a particularly important role in
identifying which initializer should be called. Because of this, Swift provides an automatic external name for every
parameter in an initializer if you dont provide an external name yourself. This automatic external name is the same
as the local name, as if you had written a hash symbol before every initialization parameter.
N OT E
If you do not want to provide an external name for a parameter in an initializer, provide an underscore (_) as
an explicit external name for that parameter to override the default behavior described above.
The following example defines a structure called Color, with three constant properties called red, green, and blue.
These properties store a value between 0.0 and 1.0 to indicate the amount of red, green, and blue in the color.
Color provides an initializer with three appropriately named parameters of type Double:
1 struct Color {
2 let red = 0.0, green = 0.0, blue = 0.0
3 init(red: Double, green: Double, blue: Double) {
4 self.red = red
5 self.green = green
6 self.blue = blue
7 }
8 }
Whenever you create a new Color instance, you call its initializer using external names for each of the three color
components:
let magenta = Color(red: 1.0, green: 0.0, blue: 1.0)
Note that it is not possible to call this initializer without using the external names. External names must always be
used in an intializer if they are defined, and omitting them is a compile-time error:
1 let veryGreen = Color(0.0, 1.0, 0.0)
2 // this reports a compile-time error - external names are required
Optional Property Types
If your custom type has a stored property that is logically allowed to have no valueperhaps because its value
cannot be set during initialization, or because it is allowed to have no value at some later pointdeclare the
property with an optional type. Properties of optional type are automatically initialized with a value of nil, indicating
that the property is deliberately intended to have no value yet during initialization.
The following example defines a class called SurveyQuestion, with an optional String property called response:
1 class SurveyQuestion {
2 var text: String
3 var response: String?
4 init(text: String) {
5 self.text = text
6 }
7 func ask() {
8 println(text)
9 }
10 }
11 let cheeseQuestion = SurveyQuestion(text: "Do you like cheese?")
12 cheeseQuestion.ask()
13 // prints "Do you like cheese?"
14 cheeseQuestion.response = "Yes, I do like cheese."
The response to a survey question cannot be known until it is asked, and so the response property is declared with
a type of String?, or optional String. It is automatically assigned a default value of nil, meaning no string yet,
when a new instance of SurveyQuestion is initialized.
Modifying Constant Properties During Initialization
You can modify the value of a constant property at any point during initialization, as long as it is set to a definite
value by the time initialization finishes.
N OT E
For class instances, a constant property can only be modified during initialization by the class that introduces
it. It cannot be modified by a subclass.
You can revise the SurveyQuestion example from above to use a constant property rather than a variable
property for the text property of the question, to indicate that the question does not change once an instance of
SurveyQuestion is created. Even though the text property is now a constant, it can still be set within the classs
initializer:
1 class SurveyQuestion {
2 let text: String
3 var response: String?
4 init(text: String) {
5 self.text = text
6 }
7 func ask() {
8 println(text)
9 }
10 }
11 let beetsQuestion = SurveyQuestion(text: "How about beets?")
12 beetsQuestion.ask()
13 // prints "How about beets?"
14 beetsQuestion.response = "I also like beets. (But not with cheese.)"
Default Initializers
Swift provides a default initializer for any structure or base class that provides default values for all of its properties
and does not provide at least one initializer itself. The default initializer simply creates a new instance with all of its
properties set to their default values.
This example defines a class called ShoppingListItem, which encapsulates the name, quantity, and purchase
state of an item in a shopping list:
1 class ShoppingListItem {
2 var name: String?
3 var quantity = 1
4 var purchased = false
5 }
6 var item = ShoppingListItem()
Because all properties of the ShoppingListItem class have default values, and because it is a base class with no
superclass, ShoppingListItem automatically gains a default initializer implementation that creates a new instance
with all of its properties set to their default values. (The name property is an optional String property, and so it
automatically receives a default value of nil, even though this value is not written in the code.) The example above
uses the default initializer for the ShoppingListItem class to create a new instance of the class with initializer
syntax, written as ShoppingListItem(), and assigns this new instance to a variable called item.
Memberwise Initializers for Structure Types
In addition to the default initializers mentioned above, structure types automatically receive a memberwise initializer
if they provide default values for all of their stored properties and do not define any of their own custom initializers.
The memberwise initializer is a shorthand way to initialize the member properties of new structure instances. Initial
values for the properties of the new instance can be passed to the memberwise initializer by name.
The example below defines a structure called Size with two properties called width and height. Both properties
are inferred to be of type Double by assigning a default value of 0.0.
Because both stored properties have a default value, the Size structure automatically receives an
init(width:height:) memberwise initializer, which you can use to initialize a new Size instance:
1 struct Size {
2 var width = 0.0, height = 0.0
3 }
4 let twoByTwo = Size(width: 2.0, height: 2.0)
Initializer Delegation for Value Types
Initializers can call other initializers to perform part of an instances initialization. This process, known as initializer
delegation, avoids duplicating code across multiple initializers.
The rules for how initializer delegation works, and for what forms of delegation are allowed, are different for value
types and class types. Value types (structures and enumerations) do not support inheritance, and so their initializer
delegation process is relatively simple, because they can only delegate to another initializer that they provide
themselves. Classes, however, can inherit from other classes, as described in Inheritance. This means that
classes have additional responsibilities for ensuring that all stored properties they inherit are assigned a suitable
value during initialization. These responsibilities are described in Class Inheritance and Initialization below.
For value types, you use self.init to refer to other initializers from the same value type when writing your own
custom initializers. You can only call self.init from within an initializer.
Note that if you define a custom initializer for a value type, you will no longer have access to the default initializer (or
the memberwise structure initializer, if it is a structure) for that type. This constraint prevents a situation in which
you provide a more complex initializer that performs additional essential setup is circumvented by someone
accidentally using one of the automatic initializers instead.
N OT E
If you want your custom value type to be initializable with the default initializer and memberwise initializer, and
also with your own custom initializers, write your custom initializers in an extension rather than as part of the
value types original implementation. For more information, see Extensions.
The following example defines a custom Rect structure to represent a geometric rectangle. The example requires
two supporting structures called Size and Point, both of which provide default values of 0.0 for all of their
properties:
1 struct Size {
2 var width = 0.0, height = 0.0
3 }
4 struct Point {
5 var x = 0.0, y = 0.0
6 }
You can initialize the Rect structure below in one of three waysby using its default zero-initialized origin and
size property values, by providing a specific origin point and size, or by providing a specific center point and size.
These initialization options are represented by three custom initializers that are part of the Rect structures
definition:
1 struct Rect {
2 var origin = Point()
3 var size = Size()
4 init() {}
5 init(origin: Point, size: Size) {
6 self.origin = origin
7 self.size = size
8 }
9 init(center: Point, size: Size) {
10 let originX = center.x - (size.width / 2)
11 let originY = center.y - (size.height / 2)
12 self.init(origin: Point(x: originX, y: originY), size: size)
13 }
14 }
The first Rect initializer, init(), is functionally the same as the default initializer that the structure would have
received if it did not have its own custom initializers. This initializer has an empty body, represented by an empty
pair of curly braces {}, and does not perfom any initialization. Calling this initializer returns a Rect instance whose
origin and size properties are both initialized with the default values of Point(x: 0.0, y: 0.0) and
Size(width: 0.0, height: 0.0) from their property definitions:
1 let basicRect = Rect()
2 // basicRect's origin is (0.0, 0.0) and its size is (0.0, 0.0)
The second Rect initializer, init(origin:size:), is functionally the same as the memberwise initializer that the
structure would have received if it did not have its own custom initializers. This initializer simply assigns the origin
and size argument values to the appropriate stored properties:
1 let originRect = Rect(origin: Point(x: 2.0, y: 2.0),
2 size: Size(width: 5.0, height: 5.0))
3 // originRect's origin is (2.0, 2.0) and its size is (5.0, 5.0)
The third Rect initializer, init(center:size:), is slightly more complex. It starts by calculating an appropriate
origin point based on a center point and a size value. It then calls (or delegates) to the init(origin:size:)
initializer, which stores the new origin and size values in the appropriate properties:
1 let centerRect = Rect(center: Point(x: 4.0, y: 4.0),
2 size: Size(width: 3.0, height: 3.0))
3 // centerRect's origin is (2.5, 2.5) and its size is (3.0, 3.0)
The init(center:size:) initializer could have assigned the new values of origin and size to the appropriate
properties itself. However, it is more convenient (and clearer in intent) for the init(center:size:) initializer to
take advantage of an existing initializer that already provides exactly that functionality.
N OT E
For an alternative way to write this example without defining the init() and init(origin:size:) initializers
yourself, see Extensions.
Class Inheritance and Initialization
All of a classs stored propertiesincluding any properties the class inherits from its superclassmust be assigned
an initial value during initialization.
Swift defines two kinds of initializers for class types to help ensure all stored properties receive an initial value.
These are known as designated initializers and convenience initializers.
Designated Initializers and Convenience Initializers
Designated initializers are the primary initializers for a class. A designated initializer fully initializes all properties
introduced by that class and calls an appropriate superclass initializer to continue the initialization process up the
superclass chain.
Classes tend to have very few designated initializers, and it is quite common for a class to have only one.
Designated initializers are funnel points through which initialization takes place, and through which the initialization
process continues up the superclass chain.
Every class must have at least one designated initializer. In some cases, this requirement is satisfied by inheriting
one or more designated initializers from a superclass, as described in Automatic Initializer Inheritance below.
Convenience initializers are secondary, supporting initializers for a class. You can define a convenience initializer to
call a designated initializer from the same class as the convenience initializer with some of the designated initializers
parameters set to default values. You can also define a convenience initializer to create an instance of that class for
a specific use case or input value type.
You do not have to provide convenience initializers if your class does not require them. Create convenience
initializers whenever a shortcut to a common initialization pattern will save time or make initialization of the class
clearer in intent.
Initializer Chaining
To simplify the relationships between designated and convenience initializers, Swift applies the following three rules
for delegation calls between initializers:
Designated initializers must call a designated initializer from their immediate superclass.
Convenience initializers must call another initializer available in the same class.
Convenience initializers must ultimately end up calling a designated initializer.
A simple way to remember this is:
These rules are illustrated in the figure below:
Rule 1
Rule 2
Rule 3
Designated initializers must always delegate up.
Convenience initializers must always delegate across.
Here, the superclass has a single designated initializer and two convenience initializers. One convenience initializer
calls another convenience initializer, which in turn calls the single designated initializer. This satisfies rules 2 and 3
from above. The superclass does not itself have a further superclass, and so rule 1 does not apply.
The subclass in this figure has two designated initializers and one convenience initializer. The convenience initializer
must call one of the two designated initializers, because it can only call another initializer from the same class. This
satisfies rules 2 and 3 from above. Both designated initializers must call the single designated initializer from the
superclass, to satisfy rule 1 from above.
N OT E
These rules dont affect how users of your classes create instances of each class. Any initializer in the
diagram above can be used to create a fully-initialized instance of the class they belong to. The rules only
affect how you write the classs implementation.
The figure below shows a more complex class hierarchy for four classes. It illustrates how the designated
initializers in this hierarchy act as funnel points for class initialization, simplifying the interrelationships among
classes in the chain:
Two-Phase Initialization
Class initialization in Swift is a two-phase process. In the first phase, each stored property is assigned an initial
value by the class that introduced it. Once the initial state for every stored property has been determined, the
second phase begins, and each class is given the opportunity to customize its stored properties further before the
new instance is considered ready for use.
The use of a two-phase initialization process makes initialization safe, while still giving complete flexibility to each
class in a class hierarchy. Two-phase initialization prevents property values from being accessed before they are
initialized, and prevents property values from being set to a different value by another initializer unexpectedly.
N OT E
Swifts two-phase initialization process is similar to initialization in Objective-C. The main difference is that
during phase 1, Objective-C assigns zero or null values (such as 0 or nil) to every property. Swifts
initialization flow is more flexible in that it lets you set custom initial values, and can cope with types for which
0 or nil is not a valid default value.
Swifts compiler performs four helpful safety-checks to make sure that two-phase initialization is completed without
error:
A designated initializer must ensure that all of the properties introduced by its class are initialized before it
delegates up to a superclass initializer.
As mentioned above, the memory for an object is only considered fully initialized once the initial state of all of its
stored properties is known. In order for this rule to be satisfied, a designated initializer must make sure that all its
own properties are initialized before it hands off up the chain.
A designated initializer must delegate up to a superclass initializer before assigning a value to an inherited
property. If it doesnt, the new value the designated initializer assigns will be overwritten by the superclass
as part of its own initialization.
A convenience initializer must delegate to another initializer before assigning a value to any property
(including properties defined by the same class). If it doesnt, the new value the convenience initializer
assigns will be overwritten by its own classs designated initializer.
An initializer cannot call any instance methods, read the values of any instance properties, or refer to self
as a value until after the first phase of initialization is complete.
The class instance is not fully valid until the first phase ends. Properties can only be accessed, and methods can
only be called, once the class instance is known to be valid at the end of the first phase.
Heres how two-phase initialization plays out, based on the four safety checks above:
Phase 1
Phase 2
Safety check 1
Safety check 2
Safety check 3
Safety check 4
A designated or convenience initializer is called on a class.
Memory for a new instance of that class is allocated. The memory is not yet initialized.
A designated initializer for that class confirms that all stored properties introduced by that class have a
value. The memory for these stored properties is now initialized.
The designated initializer hands off to a superclass initializer to perform the same task for its own stored
properties.
This continues up the class inheritance chain until the top of the chain is reached.
Once the top of the chain is reached, and the final class in the chain has ensured that all of its stored
properties have a value, the instances memory is considered to be fully initialized, and phase 1 is
complete.
Working back down from the top of the chain, each designated initializer in the chain has the option to
Heres how phase 1 looks for an initialization call for a hypothetical subclass and superclass:
In this example, initialization begins with a call to a convenience initializer on the subclass. This convenience
initializer cannot yet modify any properties. It delegates across to a designated initializer from the same class.
The designated initializer makes sure that all of the subclasss properties have a value, as per safety check 1. It
then calls a designated initializer on its superclass to continue the initialization up the chain.
The superclasss designated initializer makes sure that all of the superclass properties have a value. There are no
further superclasses to initialize, and so no further delegation is needed.
As soon as all properties of the superclass have an initial value, its memory is considered fully initialized, and Phase
1 is complete.
Heres how phase 2 looks for the same initialization call:
customize the instance further. Initializers are now able to access self and can modify its properties,
call its instance methods, and so on.
Finally, any convenience initializers in the chain have the option to customize the instance and to work
with self.
The superclasss designated initializer now has an opportunity to customize the instance further (although it does
not have to).
Once the superclasss designated initializer is finished, the subclasss designated initializer can perform additional
customization (although again, it does not have to).
Finally, once the subclasss designated initializer is finished, the convenience initializer that was originally called can
perform additional customization.
Initializer Inheritance and Overriding
Unlike subclasses in Objective-C, Swift subclasses do not not inherit their superclass initializers by default. Swifts
approach prevents a situation in which a simple initializer from a superclass is automatically inherited by a more
specialized subclass and is used to create a new instance of the subclass that is not fully or correctly initialized.
If you want your custom subclass to present one or more of the same initializers as its superclassperhaps to
perform some customization during initializationyou can provide an overriding implementation of the same
initializer within your custom subclass.
If the initializer you are overriding is a designated initializer, you can override its implementation in your subclass and
call the superclass version of the initializer from within your overriding version.
If the initializer you are overriding is a convenience initializer, your override must call another designated initializer
from its own subclass, as per the rules described above in Initializer Chaining.
N OT E
Unlike methods, properties, and subscripts, you do not need to write the override keyword when overriding
an initializer.
Automatic Initializer Inheritance
As mentioned above, subclasses do not not inherit their superclass initializers by default. However, superclass
initializers are automatically inherited if certain conditions are met. In practice, this means that you do not need to
write initializer overrides in many common scenarios, and can inherit your superclass initializers with minimal effort
whenever it is safe to do so.
Assuming that you provide default values for any new properties you introduce in a subclass, the following two rules
apply:
If your subclass doesnt define any designated initializers, it automatically inherits all of its superclass
designated initializers.
If your subclass provides an implementation of all of its superclass designated initializerseither by
inheriting them as per rule 1, or by providing a custom implementation as part of its definitionthen it
automatically inherits all of the superclass convenience initializers.
These rules apply even if your subclass adds further convenience initializers.
N OT E
A subclass can implement a superclass designated initializer as a subclass convenience initializer as part of
satisfying rule 2.
Syntax for Designated and Convenience Initializers
Designated initializers for classes are written in the same way as simple initializers for value types:
init( parameters ) {
statements
}
Convenience initializers are written in the same style, but with the convenience keyword placed before the init
keyword, separated by a space:
convenience init( parameters ) {
statements
}
Rule 1
Rule 2
Designated and Convenience Initializers in Action
The following example shows designated initializers, convenience initializers, and automatic initializer inheritance in
action. This example defines a hierarchy of three classes called Food, RecipeIngredient, and
ShoppingListItem, and demonstrates how their initializers interact.
The base class in the hierarchy is called Food, which is a simple class to encapsulate the name of a foodstuff. The
Food class introduces a single String property called name and provides two initializers for creating Food
instances:
1 class Food {
2 var name: String
3 init(name: String) {
4 self.name = name
5 }
6 convenience init() {
7 self.init(name: "[Unnamed]")
8 }
9 }
The figure below shows the initializer chain for the Food class:
Classes do not have a default memberwise initializer, and so the Food class provides a designated initializer that
takes a single argument called name. This initializer can be used to create a new Food instance with a specific
name:
1 let namedMeat = Food(name: "Bacon")
2 // namedMeat's name is "Bacon"
The init(name: String) initializer from the Food class is provided as a designated initializer, because it ensures
that all stored properties of a new Food instance are fully initialized. The Food class does not have a superclass,
and so the init(name: String) initializer does not need to call super.init() to complete its initialization.
The Food class also provides a convenience initializer, init(), with no arguments. The init() initializer provides a
default placeholder name for a new food by delegating across to the Food classs init(name: String) with a name
value of [Unnamed]:
1 let mysteryMeat = Food()
2 // mysteryMeat's name is "[Unnamed]"
The second class in the hierarchy is a subclass of Food called RecipeIngredient. The RecipeIngredient class
models an ingredient in a cooking recipe. It introduces an Int property called quantity (in addition to the name
property it inherits from Food) and defines two initializers for creating RecipeIngredient instances:
1 class RecipeIngredient: Food {
2 var quantity: Int
3 init(name: String, quantity: Int) {
4 self.quantity = quantity
5 super.init(name: name)
6 }
7 convenience init(name: String) {
8 self.init(name: name, quantity: 1)
9 }
10 }
The figure below shows the initializer chain for the RecipeIngredient class:
The RecipeIngredient class has a single designated initializer, init(name: String, quantity: Int), which
can be used to populate all of the properties of a new RecipeIngredient instance. This initializer starts by
assigning the passed quantity argument to the quantity property, which is the only new property introduced by
RecipeIngredient. After doing so, the initializer delegates up to the init(name: String) initializer of the Food
class. This process satisfies safety check 1 from Two-Phase Initialization above.
RecipeIngredient also defines a convenience initializer, init(name: String), which is used to create a
RecipeIngredient instance by name alone. This convenience initializer assumes a quantity of 1 for any
RecipeIngredient instance that is created without an explicit quantity. The definition of this convenience initializer
makes RecipeIngredient instances quicker and more convenient to create, and avoids code duplication when
creating several single-quantity RecipeIngredient instances. This convenience initializer simply delegates across
to the classs designated initializer.
Note that the init(name: String) convenience initializer provided by RecipeIngredient takes the same
parameters as the init(name: String) designated initializer from Food. Even though RecipeIngredient
provides this initializer as a convenience initializer, RecipeIngredient has nonetheless provided an implementation
of all of its superclasss designated initializers. Therefore, RecipeIngredient automatically inherits all of its
superclasss convenience initializers too.
In this example, the superclass for RecipeIngredient is Food, which has a single convenience initializer called
init(). This initializer is therefore inherited by RecipeIngredient. The inherited version of init() functions in
exactly the same way as the Food version, except that it delegates to the RecipeIngredient version of
init(name: String) rather than the Food version.
All three of these initializers can be used to create new RecipeIngredient instances:
1 let oneMysteryItem = RecipeIngredient()
2 let oneBacon = RecipeIngredient(name: "Bacon")
3 let sixEggs = RecipeIngredient(name: "Eggs", quantity: 6)
The third and final class in the hierarchy is a subclass of RecipeIngredient called ShoppingListItem. The
ShoppingListItem class models a recipe ingredient as it appears in a shopping list.
Every item in the shopping list starts out as unpurchased. To represent this fact, ShoppingListItem introduces a
Boolean property called purchased, with a default value of false. ShoppingListItem also adds a computed
description property, which provides a textual description of a ShoppingListItem instance:
1 class ShoppingListItem: RecipeIngredient {
2 var purchased = false
3 var description: String {
4 var output = "\(quantity) x \(name.lowercaseString)"
5 output += purchased ? " #" : " $"
6 return output
7 }
8 }
N OT E
ShoppingListItem does not define an initializer to provide an initial value for purchased, because items in a
shopping list (as modeled here) always start out unpurchased.
Because it provides a default value for all of the properties it introduces and does not define any initializers itself,
ShoppingListItem automatically inherits all of the designated and convenience initializers from its superclass.
The figure below shows the overall initializer chain for all three classes:
You can use all three of the inherited initializers to create a new ShoppingListItem instance:
1 var breakfastList = [
2 ShoppingListItem(),
3 ShoppingListItem(name: "Bacon"),
4 ShoppingListItem(name: "Eggs", quantity: 6),
5 ]
6 breakfastList[0].name = "Orange juice"
7 breakfastList[0].purchased = true
8 for item in breakfastList {
9 println(item.description)
10 }
11 // 1 x orange juice #
12 // 1 x bacon $
13 // 6 x eggs $
Here, a new array called breakfastList is created from an array literal containing three new ShoppingListItem
instances. The type of the array is inferred to be ShoppingListItem[]. After the array is created, the name of the
ShoppingListItem at the start of the array is changed from "[Unnamed]" to "Orange juice" and it is marked as
having been purchased. Printing the description of each item in the array shows that their default states have been
set as expected.
Setting a Default Property Value with a Closure or Function
If a stored propertys default value requires some customization or setup, you can use a closure or global function
to provide a customized default value for that property. Whenever a new instance of the type that the property
belongs to is initialized, the closure or function is called, and its return value is assigned as the propertys default
value.
These kinds of closures or functions typically create a temporary value of the same type as the property, tailor that
value to represent the desired initial state, and then return that temporary value to be used as the propertys default
value.
Heres a skeleton outline of how a closure can be used to provide a default property value:
1 class SomeClass {
2 let someProperty: SomeType = {
3 // create a default value for someProperty inside this closure
4 // someValue must be of the same type as SomeType
5 return someValue
6 }()
7 }
Note that the closures end curly brace is followed by an empty pair of parentheses. This tells Swift to execute the
closure immediately. If you omit these parentheses, you are trying to assign the closure itself to the property, and
not the return value of the closure.
N OT E
If you use a closure to initialize a property, remember that the rest of the instance has not yet been initialized
at the point that the closure is executed. This means that you cannot access any other property values from
within your closure, even if those properties have default values. You also cannot use the implicit self
property, or call any of the instances methods.
The example below defines a structure called Checkerboard, which models a board for the game of Checkers (also
known as Draughts):
The game of Checkers is played on a ten-by-ten board, with alternating black and white squares. To represent this
game board, the Checkerboard structure has a single property called boardColors, which is an array of 100 Bool
values. A value of true in the array represents a black square and a value of false represents a white square.
The first item in the array represents the top left square on the board and the last item in the array represents the
bottom right square on the board.
The boardColors array is initialized with a closure to set up its color values:
1 struct Checkerboard {
2 let boardColors: Bool[] = {
3 var temporaryBoard = Bool[]()
4 var isBlack = false
5 for i in 1...10 {
6 for j in 1...10 {
7 temporaryBoard.append(isBlack)
8 isBlack = !isBlack
9 }
10 isBlack = !isBlack
11 }
12 return temporaryBoard
13 }()
14 func squareIsBlackAtRow(row: Int, column: Int) -> Bool {
15 return boardColors[(row * 10) + column]
16 }
17 }
Whenever a new Checkerboard instance is created, the closure is executed, and the default value of boardColors
is calculated and returned. The closure in the example above calculates and sets the appropriate color for each
square on the board in a temporary array called temporaryBoard, and returns this temporary array as the
closures return value once its setup is complete. The returned array value is stored in boardColors and can be
queried with the squareIsBlackAtRow utility function:
1 let board = Checkerboard()
2 println(board.squareIsBlackAtRow(0, column: 1))
3 // prints "true"
4 println(board.squareIsBlackAtRow(9, column: 9))
5 // prints "false"
Deinitialization
A deinitializer is called immediately before a class instance is deallocated. You write deinitializers with the deinit
keyword, similar to how intializers are written with the init keyword. Deinitializers are only available on class types.
How Deinitialization Works
Swift automatically deallocates your instances when they are no longer needed, to free up resources. Swift handles
the memory management of instances through automatic reference counting (ARC), as described in Automatic
Reference Counting. Typically you dont need to perform manual clean-up when your instances are deallocated.
However, when you are working with your own resources, you might need to perform some additional clean-up
yourself. For example, if you create a custom class to open a file and write some data to it, you might need to close
the file before the class instance is deallocated.
Class definitions can have at most one deinitializer per class. The deinitializer does not take any parameters and is
written without parentheses:
1 deinit {
2 // perform the deinitialization
3 }
Deinitializers are called automatically, just before instance deallocation takes place. You are not allowed to call a
deinitializer yourself. Superclass deinitializers are inherited by their subclasses, and the superclass deinitializer is
called automatically at the end of a subclass deinitializer implementation. Superclass deinitializers are always called,
even if a subclass does not provide its own deinitializer.
Because an instance is not deallocated until after its deinitializer is called, a deinitializer can access all properties of
the instance it is called on and can modify its behavior based on those properties (such as looking up the name of a
file that needs to be closed).
Deinitializers in Action
Heres an example of a deinitializer in action. This example defines two new types, Bank and Player, for a simple
game. The Bank structure manages a made-up currency, which can never have more than 10,000 coins in
circulation. There can only ever be one Bank in the game, and so the Bank is implemented as a structure with static
properties and methods to store and manage its current state:
1 struct Bank {
2 static var coinsInBank = 10_000
3 static func vendCoins(var numberOfCoinsToVend: Int) -> Int {
4 numberOfCoinsToVend = min(numberOfCoinsToVend, coinsInBank)
5 coinsInBank -= numberOfCoinsToVend
6 return numberOfCoinsToVend
7 }
8 static func receiveCoins(coins: Int) {
9 coinsInBank += coins
10 }
11 }
Bank keeps track of the current number of coins it holds with its coinsInBank property. It also offers two methods
vendCoins and receiveCoinsto handle the distribution and collection of coins.
vendCoins checks that there are enough coins in the bank before distributing them. If there are not enough coins,
Bank returns a smaller number than the number that was requested (and returns zero if no coins are left in the
bank). vendCoins declares numberOfCoinsToVend as a variable parameter, so that the number can be modified
within the methods body without the need to declare a new variable. It returns an integer value to indicate the actual
number of coins that were provided.
The receiveCoins method simply adds the received number of coins back into the banks coin store.
The Player class describes a player in the game. Each player has a certain number of coins stored in their purse
at any time. This is represented by the players coinsInPurse property:
1 class Player {
2 var coinsInPurse: Int
3 init(coins: Int) {
4 coinsInPurse = Bank.vendCoins(coins)
5 }
6 func winCoins(coins: Int) {
7 coinsInPurse += Bank.vendCoins(coins)
8 }
9 deinit {
10 Bank.receiveCoins(coinsInPurse)
11 }
12 }
Each Player instance is initialized with a starting allowance of a specified number of coins from the bank during
initialization, although a Player instance may receive fewer than that number if not enough coins are available.
The Player class defines a winCoins method, which retrieves a certain number of coins from the bank and adds
them to the players purse. The Player class also implements a deinitializer, which is called just before a Player
instance is deallocated. Here, the deinitializer simply returns all of the players coins to the bank:
1 var playerOne: Player? = Player(coins: 100)
2 println("A new player has joined the game with \(playerOne!.coinsInPurse) coins")
3 // prints "A new player has joined the game with 100 coins"
4 println("There are now \(Bank.coinsInBank) coins left in the bank")
5 // prints "There are now 9900 coins left in the bank"
A new Player instance is created, with a request for 100 coins if they are available. This Player instance is stored
in an optional Player variable called playerOne. An optional variable is used here, because players can leave the
game at any point. The optional lets you track whether there is currently a player in the game.
Because playerOne is an optional, it is qualified with an exclamation mark (!) when its coinsInPurse property is
accessed to print its default number of coins, and whenever its winCoins method is called:
1 playerOne!.winCoins(2_000)
2 println("PlayerOne won 2000 coins & now has \(playerOne!.coinsInPurse) coins")
3 // prints "PlayerOne won 2000 coins & now has 2100 coins"
4 println("The bank now only has \(Bank.coinsInBank) coins left")
5 // prints "The bank now only has 7900 coins left"
Here, the player has won 2,000 coins. The players purse now contains 2,100 coins, and the bank has only 7,900
coins left.
1 playerOne = nil
2 println("PlayerOne has left the game")
3 // prints "PlayerOne has left the game"
4 println("The bank now has \(Bank.coinsInBank) coins")
5 // prints "The bank now has 10000 coins"
The player has now left the game. This is indicated by setting the optional playerOne variable to nil, meaning no
Player instance. At the point that this happens, the playerOne variables reference to the Player instance is
broken. No other properties or variables are still referring to the Player instance, and so it is deallocated in order to
free up its memory. Just before this happens, its deinitializer is called automatically, and its coins are returned to the
bank.
Automatic Reference Counting
Swift uses Automatic Reference Counting (ARC) to track and manage your apps memory usage. In most cases,
this means that memory management just works in Swift, and you do not need to think about memory
management yourself. ARC automatically frees up the memory used by class instances when those instances are
no longer needed.
However, in a few cases ARC requires more information about the relationships between parts of your code in
order to manage memory for you. This chapter describes those situations and shows how you enable ARC to
manage all of your apps memory.
N OT E
Reference counting only applies to instances of classes. Structures and enumerations are value types, not
reference types, and are not stored and passed by reference.
How ARC Works
Every time you create a new instance of a class, ARC allocates a chunk of memory to store information about that
instance. This memory holds information about the type of the instance, together with the values of any stored
properties associated with that instance.
Additionally, when an instance is no longer needed, ARC frees up the memory used by that instance so that the
memory can be used for other purposes instead. This ensures that class instances do not take up space in
memory when they are no longer needed.
However, if ARC were to deallocate an instance that was still in use, it would no longer be possible to access that
instances properties, or call that instances methods. Indeed, if you tried to access the instance, your app would
most likely crash.
To make sure that instances dont disappear while they are still needed, ARC tracks how many properties,
constants, and variables are currently referring to each class instance. ARC will not deallocate an instance as long
as at least one active reference to that instance still exists.
To make this possible, whenever you assign a class instance to a property, constant, or variable, that property,
constant, or variable makes a strong reference to the instance. The reference is called a strong reference
because it keeps a firm hold on that instance, and does not allow it to be deallocated for as long as that strong
reference remains.
ARC in Action
Heres an example of how Automatic Reference Counting works. This example starts with a simple class called
Person, which defines a stored constant property called name:
1 class Person {
2 let name: String
3 init(name: String) {
4 self.name = name
5 println("\(name) is being initialized")
6 }
7 deinit {
8 println("\(name) is being deinitialized")
9 }
10 }
The Person class has an initializer that sets the instances name property and prints a message to indicate that
initialization is underway. The Person class also has a deinitializer that prints a message when an instance of the
class is deallocated.
The next code snippet defines three variables of type Person?, which are used to set up multiple references to a
new Person instance in subsequent code snippets. Because these variables are of an optional type (Person?, not
Person), they are automatically initialized with a value of nil, and do not currently reference a Person instance.
1 var reference1: Person?
2 var reference2: Person?
3 var reference3: Person?
You can now create a new Person instance and assign it to one of these three variables:
1 reference1 = Person(name: "John Appleseed")
2 // prints "John Appleseed is being initialized"
Note that the message "John Appleseed is being initialized" is printed at the point that you call the Person
classs initializer. This confirms that initialization has taken place.
Because the new Person instance has been assigned to the reference1 variable, there is now a strong reference
from reference1 to the new Person instance. Because there is at least one strong reference, ARC makes sure
that this Person is kept in memory and is not deallocated.
If you assign the same Person instance to two more variables, two more strong references to that instance are
established:
1 reference2 = reference1
2 reference3 = reference1
There are now three strong references to this single Person instance.
If you break two of these strong references (including the original reference) by assigning nil to two of the
variables, a single strong reference remains, and the Person instance is not deallocated:
1 reference1 = nil
2 reference2 = nil
ARC does not deallocate the Person instance until the third and final strong reference is broken, at which point it is
clear that you are no longer using the Person instance:
1 reference3 = nil
2 // prints "John Appleseed is being deinitialized"
Strong Reference Cycles Between Class Instances
In the examples above, ARC is able to track the number of references to the new Person instance you create and
to deallocate that Person instance when it is no longer needed.
However, it is possible to write code in which an instance of a class never gets to a point where it has zero strong
references. This can happen if two class instances hold a strong reference to each other, such that each instance
keeps the other alive. This is known as a strong reference cycle.
You resolve strong reference cycles by defining some of the relationships between classes as weak or unowned
references instead of as strong references. This process is described in Resolving Strong Reference Cycles
Between Class Instances. However, before you learn how to resolve a strong reference cycle, it is useful to
understand how such a cycle is caused.
Heres an example of how a strong reference cycle can be created by accident. This example defines two classes
called Person and Apartment, which model a block of apartments and its residents:
1 class Person {
2 let name: String
3 init(name: String) { self.name = name }
4 var apartment: Apartment?
5 deinit { println("\(name) is being deinitialized") }
6 }
7
8 class Apartment {
9 let number: Int
10 init(number: Int) { self.number = number }
11 var tenant: Person?
12 deinit { println("Apartment #\(number) is being deinitialized") }
13 }
Every Person instance has a name property of type String and an optional apartment property that is initially nil.
The apartment property is optional, because a person may not always have an apartment.
Similarly, every Apartment instance has a number property of type Int and has an optional tenant property that is
initially nil. The tenant property is optional because an apartment may not always have a tenant.
Both of these classes also define a deinitializer, which prints the fact that an instance of that class is being
deinitialized. This enables you to see whether instances of Person and Apartment are being deallocated as
expected.
This next code snippet defines two variables of optional type called john and number73, which will be set to a
specific Apartment and Person instance below. Both of these variables have an initial value of nil, by virtue of
being optional:
1 var john: Person?
2 var number73: Apartment?
You can now create a specific Person instance and Apartment instance and assign these new instances to the
john and number73 variables:
1 john = Person(name: "John Appleseed")
2 number73 = Apartment(number: 73)
Heres how the strong references look after creating and assigning these two instances. The john variable now has
a strong reference to the new Person instance, and the number73 variable has a strong reference to the new
Apartment instance:
You can now link the two instances together so that the person has an apartment, and the apartment has a tenant.
Note that an exclamation mark (!) is used to unwrap and access the instances stored inside the john and
number73 optional variables, so that the properties of those instances can be set:
1 john!.apartment = number73
2 number73!.tenant = john
Heres how the strong references look after you link the two instances together:
Unfortunately, linking these two instances creates a strong reference cycle between them. The Person instance
now has a strong reference to the Apartment instance, and the Apartment instance has a strong reference to the
Person instance. Therefore, when you break the strong references held by the john and number73 variables, the
reference counts do not drop to zero, and the instances are not deallocated by ARC:
1 john = nil
2 number73 = nil
Note that neither deinitializer was called when you set these two variables to nil. The strong reference cycle
prevents the Person and Apartment instances from ever being deallocated, causing a memory leak in your app.
Heres how the strong references look after you set the john and number73 variables to nil:
The strong references between the Person instance and the Apartment instance remain and cannot be broken.
Resolving Strong Reference Cycles Between Class Instances
Swift provides two ways to resolve strong reference cycles when you work with properties of class type: weak
references and unowned references.
Weak and unowned references enable one instance in a reference cycle to refer to the other instance without
keeping a strong hold on it. The instances can then refer to each other without creating a strong reference cycle.
Use a weak reference whenever it is valid for that reference to become nil at some point during its lifetime.
Conversely, use an unowned reference when you know that the reference will never be nil once it has been set
during initialization.
Weak References
A weak reference is a reference that does not keep a strong hold on the instance it refers to, and so does not stop
ARC from disposing of the referenced instance. This behavior prevents the reference from becoming part of a
strong reference cycle. You indicate a weak reference by placing the weak keyword before a property or variable
declaration.
Use a weak reference to avoid reference cycles whenever it is possible for that reference to have no value at
some point in its life. If the reference will always have a value, use an unowned reference instead, as described in
Unowned References. In the Apartment example above, it is appropriate for an apartment to be able to have no
tenant at some point in its lifetime, and so a weak reference is an appropriate way to break the reference cycle in
this case.
N OT E
Weak references must be declared as variables, to indicate that their value can change at runtime. A weak
reference cannot be declared as a constant.
Because weak references are allowed to have no value, you must declare every weak reference as having an
optional type. Optional types are the preferred way to represent the possibility for no value in Swift.
Because a weak reference does not keep a strong hold on the instance it refers to, it is possible for that instance to
be deallocated while the weak reference is still referring to it. Therefore, ARC automatically sets a weak reference to
nil when the instance that it refers to is deallocated. You can check for the existence of a value in the weak
reference, just like any other optional value, and you will never end up with a reference to an invalid instance that no
longer exists.
The example below is identical to the Person and Apartment example from above, with one important difference.
This time around, the Apartment types tenant property is declared as a weak reference:
1 class Person {
2 let name: String
3 init(name: String) { self.name = name }
4 var apartment: Apartment?
5 deinit { println("\(name) is being deinitialized") }
6 }
7
8 class Apartment {
9 let number: Int
10 init(number: Int) { self.number = number }
11 weak var tenant: Person?
12 deinit { println("Apartment #\(number) is being deinitialized") }
13 }
The strong references from the two variables (john and number73) and the links between the two instances are
created as before:
1 var john: Person?
2 var number73: Apartment?
3
4 john = Person(name: "John Appleseed")
5 number73 = Apartment(number: 73)
6
7 john!.apartment = number73
8 number73!.tenant = john
Heres how the references look now that youve linked the two instances together:
The Person instance still has a strong reference to the Apartment instance, but the Apartment instance now has a
weak reference to the Person instance. This means that when you break the strong reference held by the john
variables, there are no more strong references to the Person instance:
Because there are no more strong references to the Person instance, it is deallocated:
1 john = nil
2 // prints "John Appleseed is being deinitialized"
The only remaining strong reference to the Apartment instance is from the number73 variable. If you break that
strong reference, there are no more strong references to the Apartment instance:
Because there are no more strong references to the Apartment instance, it too is deallocated:
1 number73 = nil
2 // prints "Apartment #73 is being deinitialized"
The final two code snippets above show that the deinitializers for the Person instance and Apartment instance print
their deinitialized messages after the john and number73 variables are set to nil. This proves that the reference
cycle has been broken.
Unowned References
Like weak references, an unowned reference does not keep a strong hold on the instance it refers to. Unlike a
weak reference, however, an unowned reference is assumed to always have a value. Because of this, an unowned
reference is always defined as a non-optional type. You indicate an unowned reference by placing the unowned
keyword before a property or variable declaration.
Because an unowned reference is non-optional, you dont need to unwrap the unowned reference each time it is
used. An unowned reference can always be accessed directly. However, ARC cannot set the reference to nil
when the instance it refers to is deallocated, because variables of a non-optional type cannot be set to nil.
N OT E
If you try to access an unowned reference after the instance that it references is deallocated, you will trigger
a runtime error. Use unowned references only when you are sure that the reference will always refer to an
instance.
Note also that Swift guarantees your app will crash if you try to access an unowned reference after the
instance it references is deallocated. You will never encounter unexpected behavior in this situation. Your
app will always crash reliably, although you should, of course, prevent it from doing so.
The following example defines two classes, Customer and CreditCard, which model a bank customer and a
possible credit card for that customer. These two classes each store an instance of the other class as a property.
This relationship has the potential to create a strong reference cycle.
The relationship between Customer and CreditCard is slightly different from the relationship between Apartment
and Person seen in the weak reference example above. In this data model, a customer may or may not have a
credit card, but a credit card will always be associated with a customer. To represent this, the Customer class has
an optional card property, but the CreditCard class has a non-optional customer property.
Furthermore, a new CreditCard instance can only be created by passing a number value and a customer instance
to a custom CreditCard initializer. This ensures that a CreditCard instance always has a customer instance
associated with it when the CreditCard instance is created.
Because a credit card will always have a customer, you define its customer property as an unowned reference, to
avoid a strong reference cycle:
1 class Customer {
2 let name: String
3 var card: CreditCard?
4 init(name: String) {
5 self.name = name
6 }
7 deinit { println("\(name) is being deinitialized") }
8 }
9
10 class CreditCard {
11 let number: Int
12 unowned let customer: Customer
13 init(number: Int, customer: Customer) {
14 self.number = number
15 self.customer = customer
16 }
17 deinit { println("Card #\(number) is being deinitialized") }
18 }
This next code snippet defines an optional Customer variable called john, which will be used to store a reference to
a specific customer. This variable has an initial value of nil, by virtue of being optional:
var john: Customer?
You can now create a Customer instance, and use it to initialize and assign a new CreditCard instance as that
customers card property:
1 john = Customer(name: "John Appleseed")
2 john!.card = CreditCard(number: 1234_5678_9012_3456, customer: john!)
Heres how the references look, now that youve linked the two instances:
The Customer instance now has a strong reference to the CreditCard instance, and the CreditCard instance has
an unowned reference to the Customer instance.
Because of the unowned customer reference, when you break the strong reference held by the john variable,
there are no more strong references to the Customer instance:
Because there are no more strong references to the Customer instance, it is deallocated. After this happens, there
are no more strong references to the CreditCard instance, and it too is deallocated:
1 john = nil
2 // prints "John Appleseed is being deinitialized"
3 // prints "Card #1234567890123456 is being deinitialized"
The final code snippet above shows that the deinitializers for the Customer instance and CreditCard instance both
print their deinitialized messages after the john variable is set to nil.
Unowned References and Implicitly Unwrapped Optional Properties
The examples for weak and unowned references above cover two of the more common scenarios in which it is
necessary to break a strong reference cycle.
The Person and Apartment example shows a situation where two properties, both of which are allowed to be nil,
have the potential to cause a strong reference cycle. This scenario is best resolved with a weak reference.
The Customer and CreditCard example shows a situation where one property that is allowed to be nil and
another property that cannot be nil have the potential to cause a strong reference cycle. This scenario is best
resolved with an unowned reference.
However, there is a third scenario, in which both properties should always have a value, and neither property
should ever be nil once initialization is complete. In this scenario, it is useful to combine an unowned property on
one class with an implicitly unwrapped optional property on the other class.
This enables both properties to be accessed directly (without optional unwrapping) once initialization is complete,
while still avoiding a reference cycle. This section shows you how to set up such a relationship.
The example below defines two classes, Country and City, each of which stores an instance of the other class as
a property. In this data model, every country must always have a capital city, and every city must always belong to
a country. To represent this, the Country class has a capitalCity property, and the City class has a country
property:
1 class Country {
2 let name: String
3 let capitalCity: City!
4 init(name: String, capitalName: String) {
5 self.name = name
6 self.capitalCity = City(name: capitalName, country: self)
7 }
8 }
9
10 class City {
11 let name: String
12 unowned let country: Country
13 init(name: String, country: Country) {
14 self.name = name
15 self.country = country
16 }
17 }
To set up the interdependency between the two classes, the initializer for City takes a Country instance, and
stores this instance in its country property.
The initializer for City is called from within the initializer for Country. However, the initializer for Country cannot
pass self to the City initializer until a new Country instance is fully initialized, as described in Two-Phase
Initialization.
To cope with this requirement, you declare the capitalCity property of Country as an implicitly unwrapped
optional property, indicated by the exclamation mark at the end of its type annotation (City!). This means that the
capitalCity property has a default value of nil, like any other optional, but can be accessed without the need to
unwrap its value as described in Implicitly Unwrapped Optionals.
Because capitalCity has a default nil value, a new Country instance is considered fully initialized as soon as
the Country instance sets its name property within its initializer. This means that the Country initializer can start to
reference and pass around the implicit self property as soon as the name property is set. The Country initializer
can therefore pass self as one of the parameters for the City initializer when the Country initializer is setting its
own capitalCity property.
All of this means that you can create the Country and City instances in a single statement, without creating a
strong reference cycle, and the capitalCity property can be accessed directly, without needing to use an
exclamation mark to unwrap its optional value:
1 var country = Country(name: "Canada", capitalName: "Ottawa")
2 println("\(country.name)'s capital city is called \(country.capitalCity.name)")
3 // prints "Canada's capital city is called Ottawa"
In the example above, the use of an implicitly unwrapped optional means that all of the two-phase class initializer
requirements are satisfied. The capitalCity property can be used and accessed like a non-optional value once
initialization is complete, while still avoiding a strong reference cycle.
Strong Reference Cycles for Closures
You saw above how a strong reference cycle can be created when two class instance properties hold a strong
reference to each other. You also saw how to use weak and unowned references to break these strong reference
cycles.
A strong reference cycle can also occur if you assign a closure to a property of a class instance, and the body of
that closure captures the instance. This capture might occur because the closures body accesses a property of
the instance, such as self.someProperty, or because the closure calls a method on the instance, such as
self.someMethod(). In either case, these accesses cause the closure to capture self, creating a strong
reference cycle.
This strong reference cycle occurs because closures, like classes, are reference types. When you assign a
closure to a property, you are assigning a reference to that closure. In essence, its the same problem as above
two strong references are keeping each other alive. However, rather than two class instances, this time its a class
instance and a closure that are keeping each other alive.
Swift provides an elegant solution to this problem, known as a closure capture list. However, before you learn how
to break a strong reference cycle with a closure capture list, it is useful to understand how such a cycle can be
caused.
The example below shows how you can create a strong reference cycle when using a closure that references
self. This example defines a class called HTMLElement, which provides a simple model for an individual element
within an HTML document:
1 class HTMLElement {
2
3 let name: String
4 let text: String?
5
6 @lazy var asHTML: () -> String = {
7 if let text = self.text {
8 return "<\(self.name)>\(text)</\(self.name)>"
9 } else {
10 return "<\(self.name) />"
11 }
12 }
13
14 init(name: String, text: String? = nil) {
15 self.name = name
16 self.text = text
17 }
18
19 deinit {
20 println("\(name) is being deinitialized")
21 }
22
23 }
The HTMLElement class defines a name property, which indicates the name of the element, such as "p" for a
paragraph element, or "br" for a line break element. HTMLElement also defines an optional text property, which
you can set to a string that represents the text to be rendered within that HTML element.
In addition to these two simple properties, the HTMLElement class defines a lazy property called asHTML. This
property references a closure that combines name and text into an HTML string fragment. The asHTML property is
of type () -> String, or a function that takes no parameters, and returns a String value.
By default, the asHTML property is assigned a closure that returns a string representation of an HTML tag. This tag
contains the optional text value if it exists, or no text content if text does not exist. For a paragraph element, the
closure would return "<p>some text</p>" or "<p />", depending on whether the text property equals "some
text" or nil.
The asHTML property is named and used somewhat like an instance method. However, because asHTML is a
closure property rather than an instance method, you can replace the default value of the asHTML property with a
custom closure, if you want to change the HTML rendering for a particular HTML element.
N OT E
The asHTML property is declared as a lazy property, because it is only needed if and when the element
actually needs to be rendered as a string value for some HTML output target. The fact that asHTML is a lazy
property means that you can refer to self within the default closure, because the lazy property will not be
accessed until after initialization has been completed and self is known to exist.
The HTMLElement class provides a single initializer, which takes a name argument and (if desired) a text argument
to initialize a new element. The class also defines a deinitializer, which prints a message to show when an
HTMLElement instance is deallocated.
Heres how you use the HTMLElement class to create and print a new instance:
1 var paragraph: HTMLElement? = HTMLElement(name: "p", text: "hello, world")
2 println(paragraph!.asHTML())
3 // prints "<p>hello, world</p>"
N OT E
The paragraph variable above is defined as an optional HTMLElement, so that it can be set to nil below to
demonstrate the presence of a strong reference cycle.
Unfortunately, the HTMLElement class, as written above, creates a strong reference cycle between an
HTMLElement instance and the closure used for its default asHTML value. Heres how the cycle looks:
The instances asHTML property holds a strong reference to its closure. However, because the closure refers to
self within its body (as a way to reference self.name and self.text), the closure captures self, which means
that it holds a strong reference back to the HTMLElement instance. A strong reference cycle is created between the
two. (For more information about capturing values in a closure, see Capturing Values.)
N OT E
Even though the closure refers to self multiple times, it only captures one strong reference to the
HTMLElement instance.
If you set the paragraph variable to nil and break its strong reference to the HTMLElement instance, neither the
HTMLElement instance nor its closure are deallocated, because of the strong reference cycle:
paragraph = nil
Note that the message in the HTMLElement deinitializer is not printed, which shows that the HTMLElement instance
is not deallocated.
Resolving Strong Reference Cycles for Closures
You resolve a strong reference cycle between a closure and a class instance by defining a capture list as part of
the closures definition. A capture list defines the rules to use when capturing one or more reference types within the
closures body. As with strong reference cycles between two class instances, you declare each captured reference
to be a weak or unowned reference rather than a strong reference. The appropriate choice of weak or unowned
depends on the relationships between the different parts of your code.
N OT E
Swift requires you to write self.someProperty or self.someMethod (rather than just someProperty or someMethod)
whenever you refer to a member of self within a closure. This helps you remember that its possible to
capture self by accident.
Defining a Capture List
Each item in a capture list is a pairing of the weak or unowned keyword with a reference to a class instance (such as
self or someInstance). These pairings are written within a pair of square braces, separated by commas.
Place the capture list before a closures parameter list and return type if they are provided:
1 @lazy var someClosure: (Int, String) -> String = {
2 [unowned self] (index: Int, stringToProcess: String) -> String in
3 // closure body goes here
4 }
If a closure does not specify a parameter list or return type because they can be inferred from context, place the
capture list at the very start of the closure, followed by the in keyword:
1 @lazy var someClosure: () -> String = {
2 [unowned self] in
3 // closure body goes here
4 }
Weak and Unowned References
Define a capture in a closure as an unowned reference when the closure and the instance it captures will always
refer to each other, and will always be deallocated at the same time.
Conversely, define a capture as a weak reference when the captured reference may become nil at some point in
the future. Weak references are always of an optional type, and automatically become nil when the instance they
reference is deallocated. This enables you to check for their existence within the closures body.
N OT E
If the captured reference will never become nil, it should always be captured as an unowned reference,
rather than a weak reference.
An unowned reference is the appropriate capture method to use to resolve the strong reference cycle in the
HTMLElement example from earlier. Heres how you write the HTMLElement class to avoid the cycle:
1 class HTMLElement {
2
3 let name: String
4 let text: String?
5
6 @lazy var asHTML: () -> String = {
7 [unowned self] in
8 if let text = self.text {
9 return "<\(self.name)>\(text)</\(self.name)>"
10 } else {
11 return "<\(self.name) />"
12 }
13 }
14
15 init(name: String, text: String? = nil) {
16 self.name = name
17 self.text = text
18 }
19
20 deinit {
21 println("\(name) is being deinitialized")
22 }
23
24 }
This implementation of HTMLElement is identical to the previous implementation, apart from the addition of a capture
list within the asHTML closure. In this case, the capture list is [unowned self], which means capture self as an
unowned reference rather than a strong reference.
You can create and print an HTMLElement instance as before:
1 var paragraph: HTMLElement? = HTMLElement(name: "p", text: "hello, world")
2 println(paragraph!.asHTML())
3 // prints "<p>hello, world</p>"
Heres how the references look with the capture list in place:
This time, the capture of self by the closure is an unowned reference, and does not keep a strong hold on the
HTMLElement instance it has captured. If you set the strong reference from the paragraph variable to nil, the
HTMLElement instance is deallocated, as can be seen from the printing of its deinitializer message in the example
below:
1 paragraph = nil
2 // prints "p is being deinitialized"
Optional Chaining
Optional chaining is a process for querying and calling properties, methods, and subscripts on an optional that might
currently be nil. If the optional contains a value, the property, method, or subscript call succeeds; if the optional is
nil, the property, method, or subscript call returns nil. Multiple queries can be chained together, and the entire
chain fails gracefully if any link in the chain is nil.
N OT E
Optional chaining in Swift is similar to messaging nil in Objective-C, but in a way that works for any type, and
that can be checked for success or failure.
Optional Chaining as an Alternative to Forced Unwrapping
You specify optional chaining by placing a question mark (?) after the optional value on which you wish to call a
property, method or subscript if the optional is non-nil. This is very similar to placing an exclamation mark (!) after
an optional value to force the unwrapping of its value. The main difference is that optional chaining fails gracefully
when the optional is nil, whereas forced unwrapping triggers a runtime error when the optional is nil.
To reflect the fact that optional chaining can be called on a nil value, the result of an optional chaining call is always
an optional value, even if the property, method, or subscript you are querying returns a non-optional value. You can
use this optional return value to check whether the optional chaining call was successful (the returned optional
contains a value), or did not succeed due to a nil value in the chain (the returned optional value is nil).
Specifically, the result of an optional chaining call is of the same type as the expected return value, but wrapped in
an optional. A property that normally returns an Int will return an Int? when accessed through optional chaining.
The next several code snippets demonstrate how optional chaining differs from forced unwrapping and enables you
to check for success.
First, two classes called Person and Residence are defined:
1 class Person {
2 var residence: Residence?
3 }
4
5 class Residence {
6 var numberOfRooms = 1
7 }
Residence instances have a single Int property called numberOfRooms, with a default value of 1. Person instances
have an optional residence property of type Residence?.
If you create a new Person instance, its residence property is default initialized to nil, by virtue of being optional.
In the code below, john has a residence property value of nil:
let john = Person()
If you try to access the numberOfRooms property of this persons residence, by placing an exclamation mark after
residence to force the unwrapping of its value, you trigger a runtime error, because there is no residence value to
unwrap:
1 let roomCount = john.residence!.numberOfRooms
2 // this triggers a runtime error
The code above succeeds when john.residence has a non-nil value and will set roomCount to an Int value
containing the appropriate number of rooms. However, this code always triggers a runtime error when residence is
nil, as illustrated above.
Optional chaining provides an alternative way to access the value of numberOfRooms. To use optional chaining, use
a question mark in place of the exclamation mark:
1 if let roomCount = john.residence?.numberOfRooms {
2 println("John's residence has \(roomCount) room(s).")
3 } else {
4 println("Unable to retrieve the number of rooms.")
5 }
6 // prints "Unable to retrieve the number of rooms."
This tells Swift to chain on the optional residence property and to retrieve the value of numberOfRooms if
residence exists.
Because the attempt to access numberOfRooms has the potential to fail, the optional chaining attempt returns a
value of type Int?, or optional Int. When residence is nil, as in the example above, this optional Int will also be
nil, to reflect the fact that it was not possible to access numberOfRooms.
Note that this is true even though numberOfRooms is a non-optional Int. The fact that it is queried through an
optional chain means that the call to numberOfRooms will always return an Int? instead of an Int.
You can assign a Residence instance to john.residence, so that it no longer has a nil value:
john.residence = Residence()
john.residence now contains an actual Residence instance, rather than nil. If you try to access numberOfRooms
with the same optional chaining as before, it will now return an Int? that contains the default numberOfRooms value
of 1:
1 if let roomCount = john.residence?.numberOfRooms {
2 println("John's residence has \(roomCount) room(s).")
3 } else {
4 println("Unable to retrieve the number of rooms.")
5 }
6 // prints "John's residence has 1 room(s)."
Defining Model Classes for Optional Chaining
You can use optional chaining with calls to properties, methods, and subscripts that are more than one level deep.
This enables you to drill down into subproperties within complex models of interrelated types, and to check whether
it is possible to access properties, methods, and subscripts on those subproperties.
The code snippets below define four model classes for use in several subsequent examples, including examples of
multilevel optional chaining. These classes expand upon the Person and Residence model from above by adding a
Room and Address class, with associated properties, methods, and subscripts.
The Person class is defined in the same way as before:
1 class Person {
2 var residence: Residence?
3 }
The Residence class is more complex than before. This time, the Residence class defines a variable property
called rooms, which is initialized with an empty array of type Room[]:
1 class Residence {
2 var rooms = Room[]()
3 var numberOfRooms: Int {
4 return rooms.count
5 }
6 subscript(i: Int) -> Room {
7 return rooms[i]
8 }
9 func printNumberOfRooms() {
10 println("The number of rooms is \(numberOfRooms)")
11 }
12 var address: Address?
13 }
Because this version of Residence stores an array of Room instances, its numberOfRooms property is implemented
as a computed property, not a stored property. The computed numberOfRooms property simply returns the value of
the count property from the rooms array.
As a shortcut to accessing its rooms array, this version of Residence provides a read-only subscript, which starts
by asserting that the index passed to the subscript is valid. If the index is valid, the subscript returns the room at the
requested index in the rooms array.
This version of Residence also provides a method called printNumberOfRooms, which simply prints the number of
rooms in the residence.
Finally, Residence defines an optional property called address, with a type of Address?. The Address class type
for this property is defined below.
The Room class used for the rooms array is a simple class with one property called name, and an initializer to set that
property to a suitable room name:
1 class Room {
2 let name: String
3 init(name: String) { self.name = name }
4 }
The final class in this model is called Address. This class has three optional properties of type String?. The first
two properties, buildingName and buildingNumber, are alternative ways to identify a particular building as part of
an address. The third property, street, is used to name the street for that address:
1 class Address {
2 var buildingName: String?
3 var buildingNumber: String?
4 var street: String?
5 func buildingIdentifier() -> String? {
6 if buildingName {
7 return buildingName
8 } else if buildingNumber {
9 return buildingNumber
10 } else {
11 return nil
12 }
13 }
14 }
The Address class also provides a method called buildingIdentifier, which has a return type of String?. This
method checks the buildingName and buildingNumber properties and returns buildingName if it has a value, or
buildingNumber if it has a value, or nil if neither property has a value.
Calling Properties Through Optional Chaining
As demonstrated in Optional Chaining as an Alternative to Forced Unwrapping, you can use optional chaining to
access a property on an optional value, and to check if that property access is successful. You cannot, however,
set a propertys value through optional chaining.
Use the classes defined above to create a new Person instance, and try to access its numberOfRooms property as
before:
1 let john = Person()
2 if let roomCount = john.residence?.numberOfRooms {
3 println("John's residence has \(roomCount) room(s).")
4 } else {
5 println("Unable to retrieve the number of rooms.")
6 }
7 // prints "Unable to retrieve the number of rooms."
Because john.residence is nil, this optional chaining call fails in the same way as before, without error.
Calling Methods Through Optional Chaining
You can use optional chaining to call a method on an optional value, and to check whether that method call is
successful. You can do this even if that method does not define a return value.
The printNumberOfRooms method on the Residence class prints the current value of numberOfRooms. Heres how
the method looks:
1 func printNumberOfRooms() {
2 println("The number of rooms is \(numberOfRooms)")
3 }
This method does not specify a return type. However, functions and methods with no return type have an implicit
return type of Void, as described in Functions Without Return Values.
If you call this method on an optional value with optional chaining, the methods return type will be Void?, not Void,
because return values are always of an optional type when called through optional chaining. This enables you to
use an if statement to check whether it was possible to call the printNumberOfRooms method, even though the
method does not itself define a return value. The implicit return value from the printNumberOfRooms will be equal to
Void if the method was called succesfully through optional chaining, or nil if was not:
1 if john.residence?.printNumberOfRooms() {
2 println("It was possible to print the number of rooms.")
3 } else {
4 println("It was not possible to print the number of rooms.")
5 }
6 // prints "It was not possible to print the number of rooms."
Calling Subscripts Through Optional Chaining
You can use optional chaining to try to retrieve a value from a subscript on an optional value, and to check whether
that subscript call is successful. You cannot, however, set a subscript through optional chaining.
N OT E
When you access a subscript on an optional value through optional chaining, you place the question mark
before the subscripts braces, not after. The optional chaining question mark always follows immediately after
the part of the expression that is optional.
The example below tries to retrieve the name of the first room in the rooms array of the john.residence property
using the subscript defined on the Residence class. Because john.residence is currently nil, the subscript call
fails:
1 if let firstRoomName = john.residence?[0].name {
2 println("The first room name is \(firstRoomName).")
3 } else {
4 println("Unable to retrieve the first room name.")
5 }
6 // prints "Unable to retrieve the first room name."
The optional chaining question mark in this subscript call is placed immediately after john.residence, before the
subscript brackets, because john.residence is the optional value on which optional chaining is being attempted.
If you create and assign an actual Residence instance to john.residence, with one or more Room instances in its
rooms array, you can use the Residence subscript to access the actual items in the rooms array through optional
chaining:
1 let johnsHouse = Residence()
2 johnsHouse.rooms += Room(name: "Living Room")
3 johnsHouse.rooms += Room(name: "Kitchen")
4 john.residence = johnsHouse
5
6 if let firstRoomName = john.residence?[0].name {
7 println("The first room name is \(firstRoomName).")
8 } else {
9 println("Unable to retrieve the first room name.")
10 }
11 // prints "The first room name is Living Room."
Linking Multiple Levels of Chaining
You can link together multiple levels of optional chaining to drill down to properties, methods, and subscripts deeper
within a model. However, multiple levels of optional chaining do not add more levels of optionality to the returned
value.
To put it another way:
Therefore:
The example below tries to access the street property of the address property of the residence property of
john. There are two levels of optional chaining in use here, to chain through the residence and address
properties, both of which are of optional type:
1 if let johnsStreet = john.residence?.address?.street {
2 println("John's street name is \(johnsStreet).")
3 } else {
4 println("Unable to retrieve the address.")
5 }
6 // prints "Unable to retrieve the address."
The value of john.residence currently contains a valid Residence instance. However, the value of
john.residence.address is currently nil. Because of this, the call to john.residence?.address?.street fails.
Note that in the example above, you are trying to retrieve the value of the street property. The type of this property
is String?. The return value of john.residence?.address?.street is therefore also String?, even though two
levels of optional chaining are applied in addition to the underlying optional type of the property.
If you set an actual Address instance as the value for john.street.address, and set an an actual value for the
addresss street property, you can access the value of property through the multi-level optional chaining:
1 let johnsAddress = Address()
2 johnsAddress.buildingName = "The Larches"
3 johnsAddress.street = "Laurel Street"
4 john.residence!.address = johnsAddress
5
If the type you are trying to retrieve is not optional, it will become optional because of the optional
chaining.
If the type you are trying to retrieve is already optional, it will not become more optional because of the
chaining.
If you try to retrieve an Int value through optional chaining, an Int? is always returned, no matter how
many levels of chaining are used.
Similarly, if you try to retrieve an Int? value through optional chaining, an Int? is always returned, no
matter how many levels of chaining are used.
The as version of the downcast operator forces the downcast to the protocol type and triggers a runtime
error if the downcast does not succeed.
This example defines a protocol called HasArea, with a single property requirement of a gettable Double property
called area:
1 @objc protocol HasArea {
2 var area: Double { get }
3 }
N OT E
You can check for protocol conformance only if your protocol is marked with the @objc attribute, as seen for
the HasArea protocol above. This attribute indicates that the protocol should be exposed to Objective-C code
and is described in Using Swift with Cocoa and Objective-C. Even if you are not interoperating with Objective-
C, you need to mark your protocols with the @objc attribute if you want to be able to check for protocol
conformance.
Note also that @objc protocols can be adopted only by classes, and not by structures or enumerations. If you
mark your protocol as @objc in order to check for conformance, you will be able to apply that protocol only to
class types.
Here are two classes, Circle and Country, both of which conform to the HasArea protocol:
1 class Circle: HasArea {
2 let pi = 3.1415927
3 var radius: Double
4 var area: Double { return pi * radius * radius }
5 init(radius: Double) { self.radius = radius }
6 }
7 class Country: HasArea {
8 var area: Double
9 init(area: Double) { self.area = area }
10 }
The Circle class implements the area property requirement as a computed property, based on a stored radius
property. The Country class implements the area requirement directly as a stored property. Both classes correctly
conform to the HasArea protocol.
Heres a class called Animal, which does not conform to the HasArea protocol:
1 class Animal {
2 var legs: Int
3 init(legs: Int) { self.legs = legs }
4 }
The Circle, Country and Animal classes do not have a shared base class. Nonetheless, they are all classes, and
so instances of all three types can be used to initialize an array that stores values of type AnyObject:
1 let objects: AnyObject[] = [
2 Circle(radius: 2.0),
3 Country(area: 243_610),
4 Animal(legs: 4)
5 ]
The objects array is initialized with an array literal containing a Circle instance with a radius of 2 units; a Country
instance initialized with the surface area of the United Kingdom in square kilometers; and an Animal instance with
four legs.
The objects array can now be iterated, and each object in the array can be checked to see if it conforms to the
HasArea protocol:
1 for object in objects {
2 if let objectWithArea = object as? HasArea {
3 println("Area is \(objectWithArea.area)")
4 } else {
5 println("Something that doesn't have an area")
6 }
7 }
8 // Area is 12.5663708
9 // Area is 243610.0
10 // Something that doesn't have an area
Whenever an object in the array conforms to the HasArea protocol, the optional value returned by the as? operator
is unwrapped with optional binding into a constant called objectWithArea. The objectWithArea constant is known
to be of type HasArea, and so its area property can be accessed and printed in a type-safe way.
Note that the underlying objects are not changed by the casting process. They continue to be a Circle, a Country
and an Animal. However, at the point that they are stored in the objectWithArea constant, they are only known to
be of type HasArea, and so only their area property can be accessed.
Optional Protocol Requirements
You can define optional requirements for protocols, These requirements do not have to be implemented by types
that conform to the protocol. Optional requirements are prefixed by the @optional keyword as part of the protocols
definition.
An optional protocol requirement can be called with optional chaining, to account for the possibility that the
requirement was not implemented by a type that conforms to the protocol. For information on optional chaining, see
Optional Chaining.
You check for an implementation of an optional requirement by writing a question mark after the name of the
requirement when it is called, such as someOptionalMethod?(someArgument). Optional property requirements,
and optional method requirements that return a value, will always return an optional value of the appropriate type
when they are accessed or called, to reflect the fact that the optional requirement may not have been implemented.
N OT E
Optional protocol requirements can only be specified if your protocol is marked with the @objc attribute. Even
if you are not interoperating with Objective-C, you need to mark your protocols with the @objc attribute if you
want to specify optional requirements.
Note also that @objc protocols can be adopted only by classes, and not by structures or enumerations. If you
mark your protocol as @objc in order to specify optional requirements, you will only be able to apply that
protocol to class types.
The following example defines an integer-counting class called Counter, which uses an external data source to
provide its increment amount. This data source is defined by the CounterDataSource protocol, which has two
optional requirements:
1 @objc protocol CounterDataSource {
2 @optional func incrementForCount(count: Int) -> Int
3 @optional var fixedIncrement: Int { get }
4 }
The CounterDataSource protocol defines an optional method requirement called incrementForCount and an
optional property requirement called fixedIncrement. These requirements define two different ways for data
sources to provide an appropriate increment amount for a Counter instance.
N OT E
Strictly speaking, you can write a custom class that conforms to CounterDataSource without implementing
either protocol requirement. They are both optional, after all. Although technically allowed, this wouldnt make
for a very good data source.
The Counter class, defined below, has an optional dataSource property of type CounterDataSource?:
1 @objc class Counter {
2 var count = 0
3 var dataSource: CounterDataSource?
4 func increment() {
5 if let amount = dataSource?.incrementForCount?(count) {
6 count += amount
7 } else if let amount = dataSource?.fixedIncrement? {
8 count += amount
9 }
10 }
11 }
The Counter class stores its current value in a variable property called count. The Counter class also defines a
method called increment, which increments the count property every time the method is called.
The increment method first tries to retrieve an increment amount by looking for an implementation of the
incrementForCount method on its data source. The increment method uses optional chaining to try to call
incrementForCount, and passes the current count value as the methods single argument.
Note two levels of optional chaining at play here. Firstly, it is possible that dataSource may be nil, and so
dataSource has a question mark after its name to indicate that incrementForCount should only be called if
dataSource is non-nil. Secondly, even if dataSource does exist, there is no guarantee that it implements
incrementForCount, because it is an optional requirement. This is why incrementForCount is also written with a
question mark after its name.
Because the call to incrementForCount can fail for either of these two reasons, the call returns an optional Int
value. This is true even though incrementForCount is defined as returning a non-optional Int value in the definition
of CounterDataSource.
After calling incrementForCount, the optional Int that it returns is unwrapped into a constant called amount, using
optional binding. If the optional Int does contain a valuethat is, if the delegate and method both exist, and the
method returned a valuethe unwrapped amount is added onto the stored count property, and incrementation is
complete.
If it is not possible to retrieve a value from the incrementForCount methodeither because dataSource is nil, or
because the data source does not implement incrementForCountthen the increment method tries to retrieve a
value from the data sources fixedIncrement property instead. The fixedIncrement property is also an optional
requirement, and so its name is also written using optional chaining with a question mark on the end, to indicate that
the attempt to access the propertys value can fail. As before, the returned value is an optional Int value, even
though fixedIncrement is defined as a non-optional Int property as part of the CounterDataSource protocol
definition.
Heres a simple CounterDataSource implementation where the data source returns a constant value of 3 every
time it is queried. It does this by implementing the optional fixedIncrement property requirement:
1 class ThreeSource: CounterDataSource {
2 let fixedIncrement = 3
3 }
You can use an instance of ThreeSource as the data source for a new Counter instance:
1 var counter = Counter()
2 counter.dataSource = ThreeSource()
3 for _ in 1...4 {
4 counter.increment()
5 println(counter.count)
6 }
7 // 3
8 // 6
9 // 9
10 // 12
The code above creates a new Counter instance; sets its data source to be a new ThreeSource instance; and
calls the counters increment method four times. As expected, the counters count property increases by three
each time increment is called.
Heres a more complex data source called TowardsZeroSource, which makes a Counter instance count up or
down towards zero from its current count value:
1 class TowardsZeroSource: CounterDataSource {
2 func incrementForCount(count: Int) -> Int {
3 if count == 0 {
4 return 0
5 } else if count < 0 {
6 return 1
7 } else {
8 return -1
9 }
10 }
11 }
The TowardsZeroSource class implements the optional incrementForCount method from the
CounterDataSource protocol and uses the count argument value to work out which direction to count in. If count
is already zero, the method returns 0 to indicate that no further counting should take place.
You can use an instance of TowardsZeroSource with the existing Counter instance to count from -4 to zero. Once
the counter reaches zero, no more counting takes place:
1 counter.count = -4
2 counter.dataSource = TowardsZeroSource()
3 for _ in 1...5 {
4 counter.increment()
5 println(counter.count)
6 }
7 // -3
8 // -2
9 // -1
10 // 0
11 // 0
Generics
Generic code enables you to write flexible, reusable functions and types that can work with any type, subject to
requirements that you define. You can write code that avoids duplication and expresses its intent in a clear,
abstracted manner.
Generics are one of the most powerful features of Swift, and much of the Swift standard library is built with generic
code. In fact, youve been using generics throughout this Language Guide, even if you didnt realize it. For example,
Swifts Array and Dictionary types are both generic collections. You can create an array that holds Int values, or
an array that holds String values, or indeed an array for any other type that can be created in Swift. Similarly, you
can create a dictionary to store values of any specified type, and there are no limitations on what that type can be.
The Problem That Generics Solve
Heres a standard, non-generic function called swapTwoInts, which swaps two Int values:
1 func swapTwoInts(inout a: Int, inout b: Int) {
2 let temporaryA = a
3 a = b
4 b = temporaryA
5 }
This function makes use of in-out parameters to swap the values of a and b, as described in In-Out Parameters.
The swapTwoInts function swaps the original value of b into a, and the original value of a into b. You can call this
function to swap the values in two Int variables:
1 var someInt = 3
2 var anotherInt = 107
3 swapTwoInts(&someInt, &anotherInt)
4 println("someInt is now \(someInt), and anotherInt is now \(anotherInt)")
5 // prints "someInt is now 107, and anotherInt is now 3"
The swapTwoInts function is useful, but it can only be used with Int values. If you want to swap two String
values, or two Double values, you have to write more functions, such as the swapTwoStrings and
swapTwoDoubles functions shown below:
1 func swapTwoStrings(inout a: String, inout b: String) {
2 let temporaryA = a
3 a = b
4 b = temporaryA
5 }
6
7 func swapTwoDoubles(inout a: Double, inout b: Double) {
8 let temporaryA = a
9 a = b
10 b = temporaryA
11 }
You may have noticed that the bodies of the swapTwoInts, swapTwoStrings, and swapTwoDoubles functions are
identical. The only difference is the type of the values that they accept (Int, String, and Double).
It would be much more useful, and considerably more flexible, to write a single function that could swap two values
of any type. This is the kind of problem that generic code can solve. (A generic version of these functions is defined
below.)
N OT E
In all three functions, it is important that the types of a and b are defined to be the same as each other. If a
and b were not of the same type, it would not be possible to swap their values. Swift is a type-safe language,
and does not allow (for example) a variable of type String and a variable of type Double to swap values with
each other. Attempting to do so would be reported as a compile-time error.
Generic Functions
Generic functions can work with any type. Heres a generic version of the swapTwoInts function from above, called
swapTwoValues:
1 func swapTwoValues<T>(inout a: T, inout b: T) {
2 let temporaryA = a
3 a = b
4 b = temporaryA
5 }
The body of the swapTwoValues function is identical to the body of the swapTwoInts function. However, the first line
of swapTwoValues is slightly different from swapTwoInts. Heres how the first lines compare:
1 func swapTwoInts(inout a: Int, inout b: Int)
2 func swapTwoValues<T>(inout a: T, inout b: T)
The generic version of the function uses a placeholder type name (called T, in this case) instead of an actual type
name (such as Int, String, or Double). The placeholder type name doesnt say anything about what T must be,
but it does say that both a and b must be of the same type T, whatever T represents. The actual type to use in place
of T will be determined each time the swapTwoValues function is called.
The other difference is that the generic functions name (swapTwoValues) is followed by the placeholder type name
(T) inside angle brackets (<T>). The brackets tell Swift that T is a placeholder type name within the swapTwoValues
function definition. Because T is a placeholder, Swift does not look for an actual type called T.
The swapTwoValues function can now be called in the same way as swapTwoInts, except that it can be passed two
values of any type, as long as both of those values are of the same type as each other. Each time swapTwoValues
is called, the type to use for T is inferred from the types of values passed to the function.
In the two examples below, T is inferred to be Int and String respectively:
1 var someInt = 3
2 var anotherInt = 107
3 swapTwoValues(&someInt, &anotherInt)
4 // someInt is now 107, and anotherInt is now 3
5
6 var someString = "hello"
7 var anotherString = "world"
8 swapTwoValues(&someString, &anotherString)
9 // someString is now "world", and anotherString is now "hello"
N OT E
The swapTwoValues function defined above is inspired by a generic function called swap, which is part of the
Swift standard library, and is automatically made available for you to use in your apps. If you need the
behavior of the swapTwoValues function in your own code, you can use Swifts existing swap function rather
than providing your own implementation.
Type Parameters
In the swapTwoValues example above, the placeholder type T is an example of a type parameter. Type parameters
specify and name a placeholder type, and are written immediately after the functions name, between a pair of
matching angle brackets (such as <T>).
Once specified, a type parameter can be used to define the type of a functions parameters (such as the a and b
parameters of the swapTwoValues function); or as the functions return type; or as a type annotation within the body
of the function. In each case, the placeholder type represented by the type parameter is replaced with an actual
type whenever the function is called. (In the swapTwoValues example above, T was replaced with Int the first time
the function was called, and was replaced with String the second time it was called.)
You can provide more than one type parameter by writing multiple type parameter names within the angle brackets,
separated by commas.
Naming Type Parameters
In simple cases where a generic function or generic type needs to refer to a single placeholder type (such as the
swapTwoValues generic function above, or a generic collection that stores a single type, such as Array), it is
traditional to use the single-character name T for the type parameter. However, you are can use any valid identifier
as the type parameter name.
If you are defining more complex generic functions, or generic types with multiple parameters, it can be useful to
provide more descriptive type parameter names. For example, Swifts Dictionary type has two type parameters
one for its keys and one for its values. If you were writing Dictionary yourself, you might name these two type
parameters KeyType and ValueType to remind you of their purpose as you use them within your generic code.
N OT E
Always give type parameters UpperCamelCase names (such as T and KeyType) to indicate that they are a
placeholder for a type, not a value.
Generic Types
In addition to generic functions, Swift enables you to define your own generic types. These are custom classes,
structures, and enumerations that can work with any type, in a similar way to Array and Dictionary.
This section shows you how to write a generic collection type called Stack. A stack is an ordered set of values,
similar to an array, but with a more restricted set of operations than Swifts Array type. An array allows new items to
be inserted and removed at any location in the array. A stack, however, allows new items to be appended only to
the end of the collection (known as pushing a new value on to the stack). Similarly, a stack allows items to be
removed only from the end of the collection (known as popping a value off the stack).
N OT E
The concept of a stack is used by the UINavigationController class to model the view controllers in its
navigation hierarchy. You call the UINavigationController class pushViewController:animated: method to
add (or push) a view controller on to the navigation stack, and its popViewControllerAnimated: method to
remove (or pop) a view controller from the navigation stack. A stack is a useful collection model whenever you
need a strict last in, first out approach to managing a collection.
The illustration below shows the push / pop behavior for a stack:
1. There are currently three values on the stack.
2. A fourth value is pushed on to the top of the stack.
3. The stack now holds four values, with the most recent one at the top.
4. The top item in the stack is removed, or popped.
5. After popping a value, the stack once again holds three values.
Heres how to write a non-generic version of a stack, in this case for a stack of Int values:
1 struct IntStack {
2 var items = Int[]()
3 mutating func push(item: Int) {
4 items.append(item)
5 }
6 mutating func pop() -> Int {
7 return items.removeLast()
8 }
9 }
This structure uses an Array property called items to store the values in the stack. Stack provides two methods,
push and pop, to push and pop values on and off the stack. These methods are marked as mutating, because
they need to modify (or mutate) the structures items array.
The IntStack type shown above can only be used with Int values, however. It would be much more useful to
define a generic Stack class, that can manage a stack of any type of value.
Heres a generic version of the same code:
1 struct Stack<T> {
2 var items = T[]()
3 mutating func push(item: T) {
4 items.append(item)
5 }
6 mutating func pop() -> T {
7 return items.removeLast()
8 }
9 }
Note how the generic version of Stack is essentially the same as the non-generic version, but with a placeholder
type parameter called T instead of an actual type of Int. This type parameter is written within a pair of angle
brackets (<T>) immediately after the structures name.
T defines a placeholder name for some type T to be provided later on. This future type can be referred to as T
anywhere within the structures definition. In this case, T is used as a placeholder in three places:
You create instances of Stack in a similar way to Array and Dictionary, by writing the actual type to be used for
this specific stack within angle brackets after the type name when creating a new instance with initializer syntax:
1 var stackOfStrings = Stack<String>()
2 stackOfStrings.push("uno")
3 stackOfStrings.push("dos")
4 stackOfStrings.push("tres")
5 stackOfStrings.push("cuatro")
6 // the stack now contains 4 strings
Heres how stackOfStrings looks after pushing these four values on to the stack:
To create a property called items, which is initialized with an empty array of values of type T
To specify that the push method has a single parameter called item, which must be of type T
To specify that the value returned by the pop method will be a value of type T
Popping a value from the stack returns and removes the top value, "cuatro":
1 let fromTheTop = stackOfStrings.pop()
2 // fromTheTop is equal to "cuatro", and the stack now contains 3 strings
Heres how the stack looks after popping its top value:
Because it is a generic type, Stack can be used to create a stack of any valid type in Swift, in a similar manner to
Array and Dictionary.
Type Constraints
The swapTwoValues function and the Stack type can work with any type. However, it is sometimes useful to
enforce certain type constraints on the types that can be used with generic functions and generic types. Type
constraints specify that a type parameter must inherit from a specific class, or conform to a particular protocol or
protocol composition.
For example, Swifts Dictionary type places a limitation on the types that can be used as keys for a dictionary. As
described in Dictionaries, the type of a dictionarys keys must be hashable. That is, it must provide a way to make
itself uniquely representable. Dictionary needs its keys to be hashable so that it can check whether it already
contains a value for a particular key. Without this requirement, Dictionary could not tell whether it should insert or
replace a value for a particular key, nor would it be able to find a value for a given key that is already in the
dictionary.
This requirement is enforced by a type constraint on the key type for Dictionary, which specifies that the key type
must conform to the Hashable protocol, a special protocol defined in the Swift standard library. All of Swifts basic
types (such as String, Int, Double, and Bool) are hashable by default.
You can define your own type constraints when creating custom generic types, and these constraints provide much
of the power of generic programming. Abstract concepts like Hashable characterize types in terms of their
conceptual characteristics, rather than their explicit type.
Type Constraint Syntax
You write type constraints by placing a single class or protocol constraint after a type parameters name, separated
by a colon, as part of the type parameter list. The basic syntax for type constraints on a generic function is shown
below (although the syntax is the same for generic types):
1 func someFunction<T: SomeClass, U: SomeProtocol>(someT: T, someU: U) {
2 // function body goes here
3 }
The hypothetical function above has two type parameters. The first type parameter, T, has a type constraint that
requires T to be a subclass of SomeClass. The second type parameter, U, has a type constraint that requires U to
conform to the protocol SomeProtocol.
Type Constraints in Action
Heres a non-generic function called findStringIndex, which is given a String value to find and an array of
String values within which to find it. The findStringIndex function returns an optional Int value, which will be the
index of the first matching string in the array if it is found, or nil if the string cannot be found:
1 func findStringIndex(array: String[], valueToFind: String) -> Int? {
2 for (index, value) in enumerate(array) {
3 if value == valueToFind {
4 return index
5 }
6 }
7 return nil
8 }
The findStringIndex function can be used to find a string value in an array of strings:
1 let strings = ["cat", "dog", "llama", "parakeet", "terrapin"]
2 if let foundIndex = findStringIndex(strings, "llama") {
3 println("The index of llama is \(foundIndex)")
4 }
5 // prints "The index of llama is 2"
The principle of finding the index of a value in an array isnt useful only for strings, however. You can write the same
functionality as a generic function called findIndex, by replacing any mention of strings with values of some type T
instead.
Heres how you might expect a generic version of findStringIndex, called findIndex, to be written. Note that the
return type of this function is still Int?, because the function returns an optional index number, not an optional value
from the array. Be warned, thoughthis function does not compile, for reasons explained after the example:
1 func findIndex<T>(array: T[], valueToFind: T) -> Int? {
2 for (index, value) in enumerate(array) {
3 if value == valueToFind {
4 return index
5 }
6 }
7 return nil
8 }
This function does not compile as written above. The problem lies with the equality check, if value ==
valueToFind. Not every type in Swift can be compared with the equal to operator (==). If you create your own
class or structure to represent a complex data model, for example, then the meaning of equal to for that class or
structure is not something that Swift can guess for you. Because of this, it is not possible to guarantee that this code
will work for every possible type T, and an appropriate error is reported when you try to compile the code.
All is not lost, however. The Swift standard library defines a protocol called Equatable, which requires any
conforming type to implement the equal to operator (==) and the not equal to operator (!=) to compare any two
values of that type. All of Swifts standard types automatically support the Equatable protocol.
Any type that is Equatable can be used safely with the findIndex function, because it is guaranteed to support the
equal to operator. To express this fact, you write a type constraint of Equatable as part of the type parameters
definition when you define the function:
1 func findIndex<T: Equatable>(array: T[], valueToFind: T) -> Int? {
2 for (index, value) in enumerate(array) {
3 if value == valueToFind {
4 return index
5 }
6 }
7 return nil
8 }
The single type parameter for findIndex is written as T: Equatable, which means any type T that conforms to
the Equatable protocol.
The findIndex function now compiles successfully and can be used with any type that is Equatable, such as
Double or String:
1 let doubleIndex = findIndex([3.14159, 0.1, 0.25], 9.3)
2 // doubleIndex is an optional Int with no value, because 9.3 is not in the array
3 let stringIndex = findIndex(["Mike", "Malcolm", "Andrea"], "Andrea")
4 // stringIndex is an optional Int containing a value of 2
Associated Types
When defining a protocol, it is sometimes useful to declare one or more associated types as part of the protocols
definition. An associated type gives a placeholder name (or alias) to a type that is used as part of the protocol. The
actual type to use for that associated type is not specified until the protocol is adopted. Associated types are
specified with the typealias keyword.
Associated Types in Action
Heres an example of a protocol called Container, which declares an associated type called ItemType:
1 protocol Container {
2 typealias ItemType
3 mutating func append(item: ItemType)
4 var count: Int { get }
5 subscript(i: Int) -> ItemType { get }
6 }
The Container protocol defines three required capabilities that any container must provide:
This protocol doesnt specify how the items in the container should be stored or what type they are allowed to be.
The protocol only specifies the three bits of functionality that any type must provide in order to be considered a
Container. A conforming type can provide additional functionality, as long as it satisfies these three requirements.
It must be possible to add a new item to the container with an append method.
It must be possible to access a count of the items in the container through a count property that returns
an Int value.
It must be possible to retrieve each item in the container with a subscript that takes an Int index value.
Any type that conforms to the Container protocol must be able to specify the type of values it stores. Specifically, it
must ensure that only items of the right type are added to the container, and it must be clear about the type of the
items returned by its subscript.
To define these requirements, the Container protocol needs a way to refer to the type of the elements that a
container will hold, without knowing what that type is for a specific container. The Container protocol needs to
specify that any value passed to the append method must have the same type as the containers element type, and
that the value returned by the containers subscript will be of the same type as the containers element type.
To achieve this, the Container protocol declares an associated type called ItemType, written as typealias
ItemType. The protocol does not define what ItemType is an alias forthat information is left for any conforming
type to provide. Nonetheless, the ItemType alias provides a way to refer to the type of the items in a Container,
and to define a type for use with the append method and subscript, to ensure that the expected behavior of any
Container is enforced.
Heres a version of the non-generic IntStack type from earlier, adapted to conform to the Container protocol:
1 struct IntStack: Container {
2 // original IntStack implementation
3 var items = Int[]()
4 mutating func push(item: Int) {
5 items.append(item)
6 }
7 mutating func pop() -> Int {
8 return items.removeLast()
9 }
10 // conformance to the Container protocol
11 typealias ItemType = Int
12 mutating func append(item: Int) {
13 self.push(item)
14 }
15 var count: Int {
16 return items.count
17 }
18 subscript(i: Int) -> Int {
19 return items[i]
20 }
21 }
The IntStack type implements all three of the Container protocols requirements, and in each case wraps part of
the IntStack types existing functionality to satisfy these requirements.
Moreover, IntStack specifies that for this implementation of Container, the appropriate ItemType to use is a type
of Int. The definition of typealias ItemType = Int turns the abstract type of ItemType into a concrete type of
Int for this implementation of the Container protocol.
Thanks to Swifts type inference, you dont actually need to declare a concrete ItemType of Int as part of the
definition of IntStack. Because IntStack conforms to all of the requirements of the Container protocol, Swift can
infer the appropriate ItemType to use, simply by looking at the type of the append methods item parameter and the
return type of the subscript. Indeed, if you delete the typealias ItemType = Int line from the code above,
everything still works, because it is clear what type should be used for ItemType.
You can also make the generic Stack type conform to the Container protocol:
1 struct Stack<T>: Container {
2 // original Stack<T> implementation
3 var items = T[]()
4 mutating func push(item: T) {
5 items.append(item)
6 }
7 mutating func pop() -> T {
8 return items.removeLast()
9 }
10 // conformance to the Container protocol
11 mutating func append(item: T) {
12 self.push(item)
13 }
14 var count: Int {
15 return items.count
16 }
17 subscript(i: Int) -> T {
18 return items[i]
19 }
20 }
This time, the placeholder type parameter T is used as the type of the append methods item parameter and the
return type of the subscript. Swift can therefore infer that T is the appropriate type to use as the ItemType for this
particular container.
Extending an Existing Type to Specify an Associated Type
You can extend an existing type to add conformance to a protocol, as described in Adding Protocol Conformance
with an Extension. This includes a protocol with an associated type.
Swifts Array type already provides an append method, a count property, and a subscript with an Int index to
retrieve its elements. These three capabilities match the requirements of the Container protocol. This means that
you can extend Array to conform to the Container protocol simply by declaring that Array adopts the protocol.
You do this with an empty extension, as described in Declaring Protocol Adoption with an Extension:
extension Array: Container {}
Arrays existing append method and subscript enable Swift to infer the appropriate type to use for ItemType, just as
for the generic Stack type above. After defining this extension, you can use any Array as a Container.
Where Clauses
Type constraints, as described in Type Constraints, enable you to define requirements on the type parameters
associated with a generic function or type.
It can also be useful to define requirements for associated types. You do this by defining where clauses as part of a
type parameter list. A where clause enables you to require that an associated type conforms to a certain protocol,
and/or that certain type parameters and associated types be the same. You write a where clause by placing the
where keyword immediately after the list of type parameters, followed by one or more constraints for associated
types, and/or one or more equality relationships between types and associated types.
The example below defines a generic function called allItemsMatch, which checks to see if two Container
instances contain the same items in the same order. The function returns a Boolean value of true if all items match
and a value of false if they do not.
The two containers to be checked do not have to be the same type of container (although they can be), but they do
have to hold the same type of items. This requirement is expressed through a combination of type constraints and
where clauses:
1 func allItemsMatch<
2 C1: Container, C2: Container
3 where C1.ItemType == C2.ItemType, C1.ItemType: Equatable>
4 (someContainer: C1, anotherContainer: C2) -> Bool {
5
6 // check that both containers contain the same number of items
7 if someContainer.count != anotherContainer.count {
8 return false
9 }
10
11 // check each pair of items to see if they are equivalent
12 for i in 0..someContainer.count {
13 if someContainer[i] != anotherContainer[i] {
14 return false
15 }
16 }
17
18 // all items match, so return true
19 return true
20
21 }
This function takes two arguments called someContainer and anotherContainer. The someContainer argument
is of type C1, and the anotherContainer argument is of type C2. Both C1 and C2 are placeholder type parameters
for two container types to be determined when the function is called.
The functions type parameter list places the following requirements on the two type parameters:
The third and fourth requirements are defined as part of a where clause, and are written after the where keyword as
part of the functions type parameter list.
These requirements mean:
The third and fourth requirements combine to mean that the items in anotherContainer can also be checked with
the != operator, because they are exactly the same type as the items in someContainer.
These requirements enable the allItemsMatch function to compare the two containers, even if they are of a
different container type.
The allItemsMatch function starts by checking that both containers contain the same number of items. If they
contain a different number of items, there is no way that they can match, and the function returns false.
After making this check, the function iterates over all of the items in someContainer with a for-in loop and the half-
closed range operator (..). For each item, the function checks whether the item from someContainer is not equal
to the corresponding item in anotherContainer. If the two items are not equal, then the two containers do not
match, and the function returns false.
If the loop finishes without finding a mismatch, the two containers match, and the function returns true.
Heres how the allItemsMatch function looks in action:
1 var stackOfStrings = Stack<String>()
2 stackOfStrings.push("uno")
3 stackOfStrings.push("dos")
4 stackOfStrings.push("tres")
C1 must conform to the Container protocol (written as C1: Container).
C2 must also conform to the Container protocol (written as C2: Container).
The ItemType for C1 must be the same as the ItemType for C2 (written as C1.ItemType ==
C2.ItemType).
The ItemType for C1 must conform to the Equatable protocol (written as C1.ItemType: Equatable).
someContainer is a container of type C1.
anotherContainer is a container of type C2.
someContainer and anotherContainer contain the same type of items.
The items in someContainer can be checked with the not equal operator (!=) to see if they are different
from each other.
5
6 var arrayOfStrings = ["uno", "dos", "tres"]
7
8 if allItemsMatch(stackOfStrings, arrayOfStrings) {
9 println("All items match.")
10 } else {
11 println("Not all items match.")
12 }
13 // prints "All items match."
The example above creates a Stack instance to store String values, and pushes three strings onto the stack. The
example also creates an Array instance initialized with an array literal containing the same three strings as the
stack. Even though the stack and the array are of a different type, they both conform to the Container protocol,
and both contain the same type of values. You can therefore call the allItemsMatch function with these two
containers as its arguments. In the example above, the allItemsMatch function correctly reports that all of the
items in the two containers match.
Advanced Operators
In addition to the operators described in Basic Operators, Swift provides several advanced operators that perform
more complex value manipulation. These include all of the bitwise and bit shifting operators you will be familiar with
from C and Objective-C.
Unlike arithmetic operators in C, arithmetic operators in Swift do not overflow by default. Overflow behavior is
trapped and reported as an error. To opt in to overflow behavior, use Swifts second set of arithmetic operators that
overflow by default, such as the overflow addition operator (&+). All of these overflow operators begin with an
ampersand (&).
When you define your own structures, classes, and enumerations, it can be useful to provide your own
implementations of the standard Swift operators for these custom types. Swift makes it easy to provide tailored
implementations of these operators and to determine exactly what their behavior should be for each type you
create.
Youre not just limited to the predefined operators. Swift gives you the freedom to define your own custom infix,
prefix, postfix, and assignment operators, with custom precedence and associativity values. These operators can
be used and adopted in your code just like any of the predefined operators, and you can even extend existing types
to support the custom operators you define.
Bitwise Operators
Bitwise operators enable you to manipulate the individual raw data bits within a data structure. They are often used
in low-level programming, such as graphics programming and device driver creation. Bitwise operators can also be
useful when you work with raw data from external sources, such as encoding and decoding data for communication
over a custom protocol.
Swift supports all of the bitwise operators found in C, as described below.
Bitwise NOT Operator
The bitwise NOT operator (~) inverts all bits in a number:
The bitwise NOT operator is a prefix operator, and appears immediately before the value it operates on, without any
white space:
1 let initialBits: UInt8 = 0b00001111
2 let invertedBits = ~initialBits // equals 11110000
UInt8 integers have eight bits and can store any value between 0 and 255. This example initializes a UInt8 integer
with the binary value 00001111, which has its first four bits set to 0, and its second four bits set to 1. This is
equivalent to a decimal value of 15.
The bitwise NOT operator is then used to create a new constant called invertedBits, which is equal to
initialBits, but with all of the bits inverted. Zeroes become ones, and ones become zeroes. The value of
invertedBits is 11110000, which is equal to an unsigned decimal value of 240.
Bitwise AND Operator
The bitwise AND operator (&) combines the bits of two numbers. It returns a new number whose bits are set to 1
only if the bits were equal to 1 in both input numbers:
In the example below, the values of firstSixBits and lastSixBits both have four middle bits equal to 1. The
bitwise AND operator combines them to make the number 00111100, which is equal to an unsigned decimal value of
60:
1 let firstSixBits: UInt8 = 0b11111100
2 let lastSixBits: UInt8 = 0b00111111
3 let middleFourBits = firstSixBits & lastSixBits // equals 00111100
Bitwise OR Operator
The bitwise OR operator (|) compares the bits of two numbers. The operator returns a new number whose bits are
set to 1 if the bits are equal to 1 in either input number:
In the example below, the values of someBits and moreBits have different bits set to 1. The bitwise OR operator
combines them to make the number 11111110, which equals an unsigned decimal of 254:
1 let someBits: UInt8 = 0b10110010
2 let moreBits: UInt8 = 0b01011110
3 let combinedbits = someBits | moreBits // equals 11111110
Bitwise XOR Operator
The bitwise XOR operator, or exclusive OR operator (^), compares the bits of two numbers. The operator returns
a new number whose bits are set to 1 where the input bits are different and are set to 0 where the input bits are the
same:
In the example below, the values of firstBits and otherBits each have a bit set to 1 in a location that the other
does not. The bitwise XOR operator sets both of these bits to 1 in its output value. All of the other bits in firstBits
and otherBits match and are set to 0 in the output value:
1 let firstBits: UInt8 = 0b00010100
2 let otherBits: UInt8 = 0b00000101
3 let outputBits = firstBits ^ otherBits // equals 00010001
Bitwise Left and Right Shift Operators
The bitwise left shift operator (<<) and bitwise right shift operator (>>) move all bits in a number to the left or the right
by a certain number of places, according to the rules defined below.
Bitwise left and right shifts have the effect of multiplying or dividing an integer number by a factor of two. Shifting an
integers bits to the left by one position doubles its value, whereas shifting it to the right by one position halves its
value.
Shifting Behavior for Unsigned Integers
The bit-shifting behavior for unsigned integers is as follows:
1. Existing bits are moved to the left or right by the requested number of places.
2. Any bits that are moved beyond the bounds of the integers storage are discarded.
3. Zeroes are inserted in the spaces left behind after the original bits are moved to the left or right.
This approach is known as a logical shift.
The illustration below shows the results of 11111111 << 1 (which is 11111111 shifted to the left by 1 place), and
11111111 >> 1 (which is 11111111 shifted to the right by 1 place). Blue numbers are shifted, gray numbers are
discarded, and orange zeroes are inserted:
Heres how bit shifting looks in Swift code:
1 let shiftBits: UInt8 = 4 // 00000100 in binary
2 shiftBits << 1 // 00001000
3 shiftBits << 2 // 00010000
4 shiftBits << 5 // 10000000
5 shiftBits << 6 // 00000000
6 shiftBits >> 2 // 00000001
You can use bit shifting to encode and decode values within other data types:
1 let pink: UInt32 = 0xCC6699
2 let redComponent = (pink & 0xFF0000) >> 16 // redComponent is 0xCC, or 204
3 let greenComponent = (pink & 0x00FF00) >> 8 // greenComponent is 0x66, or 102
4 let blueComponent = pink & 0x0000FF // blueComponent is 0x99, or 153
This example uses a UInt32 constant called pink to store a Cascading Style Sheets color value for the color pink.
The CSS color value #CC6699 is written as 0xCC6699 in Swifts hexadecimal number representation. This color is
then decomposed into its red (CC), green (66), and blue (99) components by the bitwise AND operator (&) and the
bitwise right shift operator (>>).
The red component is obtained by performing a bitwise AND between the numbers 0xCC6699 and 0xFF0000. The
zeroes in 0xFF0000 effectively mask the second and third bytes of 0xCC6699, causing the 6699 to be ignored and
leaving 0xCC0000 as the result.
This number is then shifted 16 places to the right (>> 16). Each pair of characters in a hexadecimal number uses 8
bits, so a move 16 places to the right will convert 0xCC0000 into 0x0000CC. This is the same as 0xCC, which has a
decimal value of 204.
Similarly, the green component is obtained by performing a bitwise AND between the numbers 0xCC6699 and
0x00FF00, which gives an output value of 0x006600. This output value is then shifted eight places to the right, giving
a a value of 0x66, which has a decimal value of 102.
Finally, the blue component is obtained by performing a bitwise AND between the numbers 0xCC6699 and
0x0000FF, which gives an output value of 0x000099. Theres no need to shift this to the right, as 0x000099 already
equals 0x99, which has a decimal value of 153.
Shifting Behavior for Signed Integers
The shifting behavior is more complex for signed integers than for unsigned integers, because of the way signed
integers are represented in binary. (The examples below are based on 8-bit signed integers for simplicity, but the
same principles apply for signed integers of any size.)
Signed integers use their first bit (known as the sign bit) to indicate whether the integer is positive or negative. A sign
bit of 0 means positive, and a sign bit of 1 means negative.
The remaining bits (known as the value bits) store the actual value. Positive numbers are stored in exactly the
same way as for unsigned integers, counting upwards from 0. Heres how the bits inside an Int8 look for the
number 4:
The sign bit is 0 (meaning positive), and the seven value bits are just the number 4, written in binary notation.
Negative numbers, however, are stored differently. They are stored by subtracting their absolute value from 2 to the
power of n, where n is the number of value bits. An eight-bit number has seven value bits, so this means 2 to the
power of 7, or 128.
Heres how the bits inside an Int8 look for the number -4:
This time, the sign bit is 1 (meaning negative), and the seven value bits have a binary value of 124 (which is 128 -
4):
The encoding for negative numbers is known as a twos complement representation. It may seem an unusual way
to represent negative numbers, but it has several advantages.
First, you can add -1 to -4, simply by performing a standard binary addition of all eight bits (including the sign bit),
and discarding anything that doesnt fit in the eight bits once youre done:
Second, the twos complement representation also lets you shift the bits of negative numbers to the left and right like
positive numbers, and still end up doubling them for every shift you make to the left, or halving them for every shift
you make to the right. To achieve this, an extra rule is used when signed integers are shifted to the right:
This action ensures that signed integers have the same sign after they are shifted to the right, and is known as an
arithmetic shift.
Because of the special way that positive and negative numbers are stored, shifting either of them to the right moves
them closer to zero. Keeping the sign bit the same during this shift means that negative integers remain negative as
their value moves closer to zero.
Overflow Operators
If you try to insert a number into an integer constant or variable that cannot hold that value, by default Swift reports
an error rather than allowing an invalid value to be created. This behavior gives extra safety when you work with
numbers that are too large or too small.
For example, the Int16 integer type can hold any signed integer number between -32768 and 32767. Trying to set
a UInt16 constant or variable to a number outside of this range causes an error:
When you shift signed integers to the right, apply the same rules as for unsigned integers, but fill any
empty bits on the left with the sign bit, rather than with a zero.
Alternative grammar productions are separated by vertical bars (|). When alternative productions are too
long to read easily, they are broken into multiple grammar production rules on new lines.
In a few cases, regular font text is used to describe the right-hand side of a grammar production rule.
Optional syntactic categories and literals are marked by a trailing subscript, opt.
|
Lexical Structure
The lexical structure of Swift describes what sequence of characters form valid tokens of the language. These valid
tokens form the lowest-level building blocks of the language and are used to describe the rest of the language in
subsequent chapters.
In most cases, tokens are generated from the characters of a Swift source file by considering the longest possible
substring from the input text, within the constraints of the grammar that are specified below. This behavior is
referred to as longest match or maximal munch.
Whitespace and Comments
Whitespace has two uses: to separate tokens in the source file and to help determine whether an operator is a
prefix or postfix (see Operators), but is otherwise ignored. The following characters are considered whitespace:
space (U+0020), line feed (U+000A), carriage return (U+000D), horizontal tab (U+0009), vertical tab (U+000B),
form feed (U+000C) and null (U+0000).
Comments are treated as whitespace by the compiler. Single line comments begin with // and continue until the end
of the line. Multiline comments begin with /* and end with */. Nesting is allowed, but the comment markers must be
balanced.
Identifiers
Identifiers begin with an upper case or lower case letter A through Z, an underscore (_), a noncombining
alphanumeric Unicode character in the Basic Multilingual Plane, or a character outside the Basic Multilingual Plan
that isnt in a Private Use Area. After the first character, digits and combining Unicode characters are also allowed.
To use a reserved word as an identifier, put a backtick (`) before and after it. For example, class is not a valid
identifier, but `class` is valid. The backticks are not considered part of the identifier; `x` and x have the same
meaning.
Inside a closure with no explicit parameter names, the parameters are implicitly named $0, $1, $2, and so on. These
names are valid identifiers within the scope of the closure.
GR A M M A R OF A N I D E N T I F I E R
identifier ! identifier-head identifier-characters
opt
identifier ! ` identifier-head identifier-characters
opt
`
identifier ! implicit-parameter-name
identifier-list ! identifier identifier , identifier-list
identifier-head ! Upper- or lowercase letter A through Z
identifier-head ! U+00A8, U+00AA, U+00AD, U+00AF, U+00B2U+00B5, or U+00B7U+00BA
identifier-head ! U+00BCU+00BE, U+00C0U+00D6, U+00D8U+00F6, or U+00F8U+00FF
identifier-head ! U+0100U+02FF, U+0370U+167F, U+1681U+180D, or U+180FU+1DBF
identifier-head ! U+1E00U+1FFF
|
identifier-head ! U+200BU+200D, U+202AU+202E, U+203FU+2040, U+2054, or U+2060U+206F
identifier-head ! U+2070U+20CF, U+2100U+218F, U+2460U+24FF, or U+2776U+2793
identifier-head ! U+2C00U+2DFF or U+2E80U+2FFF
identifier-head ! U+3004U+3007, U+3021U+302F, U+3031U+303F, or U+3040U+D7FF
identifier-head ! U+F900U+FD3D, U+FD40U+FDCF, U+FDF0U+FE1F, or U+FE30U+FE44
identifier-head ! U+FE47U+FFFD
identifier-head ! U+10000U+1FFFD, U+20000U+2FFFD, U+30000U+3FFFD, or U+40000U+4FFFD
identifier-head ! U+50000U+5FFFD, U+60000U+6FFFD, U+70000U+7FFFD, or U+80000U+8FFFD
identifier-head ! U+90000U+9FFFD, U+A0000U+AFFFD, U+B0000U+BFFFD, or U+C0000U+CFFFD
identifier-head ! U+D0000U+DFFFD or U+E0000U+EFFFD
identifier-character ! Digit 0 through 9
identifier-character ! U+0300U+036F, U+1DC0U+1DFF, U+20D0U+20FF, or U+FE20U+FE2F
identifier-character ! identifier-head
identifier-characters ! identifier-character identifier-characters
opt
implicit-parameter-name ! $ decimal-digits
Keywords
The following keywords are reserved and may not be used as identifiers, unless theyre escaped with backticks, as
described above in Identifiers.
Literals
A literal is the source code representation of a value of an integer, floating-point number, or string type. The following
are examples of literals:
1 42 // Integer literal
2 3.14159 // Floating-point literal
3 "Hello, world!" // String literal
GR A M M A R OF A L I T E R A L
literal ! integer-literal floating-point-literal string-literal
Keywords used in declarations: class, deinit, enum, extension, func, import, init, let, protocol,
static, struct, subscript, typealias, and var.
Keywords used in statements: break, case, continue, default, do, else, fallthrough, if, in, for,
return, switch, where, and while.
Keywords used in expressions and types: as, dynamicType, is, new, super, self, Self, Type,
__COLUMN__, __FILE__, __FUNCTION__, and __LINE__.
Keywords reserved in particular contexts: associativity, didSet, get, infix, inout, left,
mutating, none, nonmutating, operator, override, postfix, precedence, prefix, right, set,
unowned, unowned(safe), unowned(unsafe), weak and willSet. Outside the context in which they
appear in the grammar, they can be used as identifiers.
| |
Integer Literals
Integer literals represent integer values of unspecified precision. By default, integer literals are expressed in
decimal; you can specify an alternate base using a prefix. Binary literals begin with 0b, octal literals begin with 0o,
and hexadecimal literals begin with 0x.
Decimal literals contain the digits 0 through 9. Binary literals contain 0 and 1, octal literals contain 0 through 7, and
hexadecimal literals contain 0 through 9 as well as A through F in upper- or lowercase.
Negative integers literals are expressed by prepending a minus sign (-) to an integer literal, as in -42.
Underscores (_) are allowed between digits for readability, but are ignored and therefore dont affect the value of the
literal. Integer literals can begin with leading zeros (0), but are likewise ignored and dont affect the base or value of
the literal.
Unless otherwise specified, the default type of an integer literal is the Swift standard library type Int. The Swift
standard library also defines types for various sizes of signed and unsigned integers, as described in Integers.
GR A M M A R OF A N I N T E GE R L I T E R A L
integer-literal ! binary-literal
integer-literal ! octal-literal
integer-literal ! decimal-literal
integer-literal ! hexadecimal-literal
binary-literal ! 0b binary-digit binary-literal-characters
opt
binary-digit ! Digit 0 or 1
binary-literal-character ! binary-digit _
binary-literal-characters ! binary-literal-character binary-literal-characters
opt
octal-literal ! 0o octal-digit octal-literal-characters
opt
octal-digit ! Digit 0 through 7
octal-literal-character ! octal-digit _
octal-literal-characters ! octal-literal-character octal-literal-characters
opt
decimal-literal ! decimal-digit decimal-literal-characters
opt
decimal-digit ! Digit 0 through 9
decimal-digits ! decimal-digit decimal-digits
opt
decimal-literal-character ! decimal-digit _
decimal-literal-characters ! decimal-literal-character decimal-literal-characters
opt
hexadecimal-literal ! 0x hexadecimal-digit hexadecimal-literal-characters
opt
hexadecimal-digit ! Digit 0 through 9, a through f, or A through F
hexadecimal-literal-character ! hexadecimal-digit _
hexadecimal-literal-characters ! hexadecimal-literal-character hexadecimal-literal-characters
opt
Floating-Point Literals
|
|
|
|
Floating-point literals represent floating-point values of unspecified precision.
By default, floating-point literals are expressed in decimal (with no prefix), but they can also be expressed in
hexadecimal (with a 0x prefix).
Decimal floating-point literals consist of a sequence of decimal digits followed by either a decimal fraction, a decimal
exponent, or both. The decimal fraction consists of a decimal point (.) followed by a sequence of decimal digits. The
exponent consists of an upper- or lowercase e prefix followed by sequence of decimal digits that indicates what
power of 10 the value preceding the e is multiplied by. For example, 1.25e2 represents 1.25 ! 10
2
, which evaluates
to 125.0. Similarly, 1.25e-2 represents 1.25 ! 10
-2
, which evaluates to 0.0125.
Hexadecimal floating-point literals consist of a 0x prefix, followed by an optional hexadecimal fraction, followed by a
hexadecimal exponent. The hexadecimal fraction consists of a decimal point followed by a sequence of
hexadecimal digits. The exponent consists of an upper- or lowercase p prefix followed by sequence of decimal
digits that indicates what power of 2 the value preceding the p is multiplied by. For example, 0xFp2 represents 15 !
2
2
, which evaluates to 60. Similarly, 0xFp-2 represents 15 ! 2
-2
, which evaluates to 3.75.
Unlike with integer literals, negative floating-point numbers are expressed by applying the unary minus operator (-)
to a floating-point literal, as in -42.0. The result is an expression, not a floating-point integer literal.
Underscores (_) are allowed between digits for readability, but are ignored and therefore dont affect the value of the
literal. Floating-point literals can begin with leading zeros (0), but are likewise ignored and dont affect the base or
value of the literal.
Unless otherwise specified, the default type of a floating-point literal is the Swift standard library type Double, which
represents a 64-bit floating-point number. The Swift standard library also defines a Float type, which represents a
32-bit floating-point number.
GR A M M A R OF A F L OAT I N G- P OI N T L I T E R A L
floating-point-literal ! decimal-literal decimal-fraction
opt
decimal-exponent
opt
floating-point-literal ! hexadecimal-literal hexadecimal-fraction
opt
hexadecimal-exponent
decimal-fraction ! . decimal-literal
decimal-exponent ! floating-point-e sign
opt
decimal-literal
hexadecimal-fraction ! . hexadecimal-literal
opt
hexadecimal-exponent ! floating-point-p sign
opt
hexadecimal-literal
floating-point-e ! e E
floating-point-p ! p P
sign ! + -
String Literals
A string literal is a sequence of characters surrounded by double quotes, with the following form:
|
|
|
" characters "
String literals cannot contain an unescaped double quote ("), an unescaped backslash (\), a carriage return, or a
line feed.
Special characters can be included in string literals using the following escape sequences:
Characters can also be expressed by \x followed by two hexadecimal digits, \u followed by four hexadecimal digits,
or \U followed by eight hexadecimal digits. The digits in these escape sequences identify a Unicode codepoint.
The value of an expression can be inserted into a string literal by placing the expression in parentheses after a
backslash (\). The interpolated expression must not contain an unescaped double quote ("), an unescaped
backslash (\), a carriage return, or a line feed. The expression must evaluate to a value of a type that the String
class has an initializer for.
For example, all the following string literals have the same value:
1 "1 2 3"
2 "1 2 \(3)"
3 "1 2 \(1 + 2)"
4 var x = 3; "1 2 \(x)"
The default type of a string literal is String. The characters that make up a string are of type Character. For more
information about the String and Character types, see Strings and Characters.
GR A M M A R OF A S T R I N G L I T E R A L
string-literal ! " quoted-text "
quoted-text ! quoted-text-item quoted-text
opt
quoted-text-item ! escaped-character
quoted-text-item ! \( expression )
quoted-text-item ! Any Unicode extended grapheme cluster except " , \ , U+000A, or U+000D
escaped-character ! \0 \\ \t \n \r \" \'
escaped-character ! \x hexadecimal-digit hexadecimal-digit
escaped-character ! \u hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-digit
escaped-character ! \U hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-
Null Character (\0)
Backslash (\\)
Horizontal Tab (\t)
Line Feed (\n)
Carriage Return (\r)
Double Quote (\")
Single Quote (\')
| | | | | |
digit hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-digit
Operators
The Swift standard library defines a number of operators for your use, many of which are discussed in Basic
Operators and Advanced Operators. The present section describes which characters can be used as operators.
Operators are made up of one or more of the following characters: /, =, -, +, !, *, %, <, >, &, |, ^, ~, and .. That
said, the tokens =, ->, //, /*, */, ., and the unary prefix operator & are reserved. These tokens cant be
overloaded, nor can they be used to define custom operators.
The whitespace around an operator is used to determine whether an operator is used as a prefix operator, a postfix
operator, or a binary operator. This behavior is summarized in the following rules:
For the purposes of these rules, the characters (, [, and { before an operator, the characters ), ], and } after an
operator, and the characters ,, ;, and : are also considered whitespace.
There is one caveat to the rules above. If the ! or ? operator has no whitespace on the left, it is treated as a postfix
operator, regardless of whether it has whitespace on the right. To use the ? operator as syntactic sugar for the
Optional type, it must not have whitespace on the left. To use it in the conditional (? :) operator, it must have
whitespace around both sides.
In certain constructs, operators with a leading < or > may be split into two or more tokens. The remainder is treated
the same way and may be split again. As a result, there is no need to use whitespace to disambiguate between the
closing > characters in constructs like Dictionary<String, Array<Int>>. In this example, the closing >
characters are not treated as a single token that may then be misinterpreted as a bit shift >> operator.
To learn how to define new, custom operators, see Custom Operators and Operator Declaration. To learn how to
overload existing operators, see Operator Functions.
GR A M M A R OF OP E R AT OR S
operator ! operator-character operator
opt
operator-character ! / = - + ! * % < > & | ^ ~ .
binary-operator ! operator
If an operator has whitespace around both sides or around neither side, it is treated as a binary operator.
As an example, the + operator in a+b and a + b is treated as a binary operator.
If an operator has whitespace on the left side only, it is treated as a prefix unary operator. As an
example, the ++ operator in a ++b is treated as a prefix unary operator.
If an operator has whitespace on the right side only, it is treated as a postfix unary operator. As an
example, the ++ operator in a++ b is treated as a postfix unary operator.
If an operator has no whitespace on the left but is followed immediately by a dot (.), it is treated as a
postfix unary operator. As an example, the ++ operator in a++.b is treated as a postfix unary operator
(a++ . b rather than a ++ .b).
| | | | | | | | | | | | |
prefix-operator ! operator
postfix-operator ! operator
Types
In Swift, there are two kinds of types: named types and compound types. A named type is a type that can be given
a particular name when it is defined. Named types include classes, structures, enumerations, and protocols. For
example, instances of a user-defined class named MyClass have the type MyClass. In addition to user-defined
named types, the Swift standard library defines many commonly used named types, including those that represent
arrays, dictionaries, and optional values.
Data types that are normally considered basic or primitive in other languagessuch as types that represent
numbers, characters, and stringsare actually named types, defined and implemented in the Swift standard library
using structures. Because they are named types, you can extend their behavior to suit the needs of your program,
using an extension declaration, discussed in Extensions and Extension Declaration.
A compound type is a type without a name, defined in the Swift language itself. There are two compound types:
function types and tuple types. A compound type may contain named types and other compound types. For
instance, the tuple type (Int, (Int, Int)) contains two elements: The first is the named type Int, and the
second is another compound type (Int, Int).
This chapter discusses the types defined in the Swift language itself and describes the type inference behavior of
Swift.
GR A M M A R OF A T Y P E
type ! array-type function-type type-identifier tuple-type optional-type implicitly-
unwrapped-optional-type protocol-composition-type metatype-type
Type Annotation
A type annotation explicitly specifies the type of a variable or expression. Type annotations begin with a colon (:)
and end with a type, as the following examples show:
1 let someTuple: (Double, Double) = (3.14159, 2.71828)
2 func someFunction(a: Int) { /* ... */ }
In the first example, the expression someTuple is specified to have the tuple type (Double, Double). In the
second example, the parameter a to the function someFunction is specified to have the type Int.
Type annotations can contain an optional list of type attributes before the type.
GR A M M A R OF A T Y P E A N N OT AT I ON
type-annotation ! : attributes
opt
type
Type Identifier
| | | | |
| |
A type identifier refers to either a named type or a type alias of a named or compound type.
Most of the time, a type identifier directly refers to a named type with the same name as the identifier. For example,
Int is a type identifier that directly refers to the named type Int, and the type identifier Dictionary<String, Int>
directly refers to the named type Dictionary<String, Int>.
There are two cases in which a type identifier does not refer to a type with the same name. In the first case, a type
identifier refers to a type alias of a named or compound type. For instance, in the example below, the use of Point
in the type annotation refers to the tuple type (Int, Int).
1 typealias Point = (Int, Int)
2 let origin: Point = (0, 0)
In the second case, a type identifier uses dot (.) syntax to refer to named types declared in other modules or
nested within other types. For example, the type identifier in the following code references the named type MyType
that is declared in the ExampleModule module.
var someValue: ExampleModule.MyType
GR A M M A R OF A T Y P E I D E N T I F I E R
type-identifier ! type-name generic-argument-clause
opt
type-name generic-argument-
clause
opt
. type-identifier
type-name ! identifier
Tuple Type
A tuple type is a comma-separated list of zero or more types, enclosed in parentheses.
You can use a tuple type as the return type of a function to enable the function to return a single tuple containing
multiple values. You can also name the elements of a tuple type and use those names to refer to the values of the
individual elements. An element name consists of an identifier followed immediately by a colon (:). For an example
that demonstrates both of these features, see Functions with Multiple Return Values.
Void is a typealias for the the empty tuple type, (). If there is only one element inside the parentheses, the type is
simply the type of that element. For example, the type of (Int) is Int, not (Int). As a result, you can label a tuple
element only when the tuple type has two or more elements.
GR A M M A R OF A T U P L E T Y P E
tuple-type ! ( tuple-type-body
opt
)
tuple-type-body ! tuple-type-element-list ...
opt
tuple-type-element-list ! tuple-type-element tuple-type-element , tuple-type-element-list
tuple-type-element ! attributes
opt
inout
opt
type inout
opt
element-name type-annotation
element-name ! identifier
|
|
|
Function Type
A function type represents the type of a function, method, or closure and consists of a parameter and return type
separated by an arrow (->):
parameter type -> return type
Because the parameter type and the return type can be a tuple type, function types support functions and methods
that take multiple paramaters and return multiple values.
You can apply the auto_closure attribute to a function type that has a parameter type of () and that returns the
type of an expression (see Type Attributes). An autoclosure function captures an implicit closure over the specified
expression, instead of the expression itself. The following example uses the auto_closure attribute in defining a
very simple assert function:
1 func simpleAssert(condition: @auto_closure () -> Bool, message: String) {
2 if !condition() {
3 println(message)
4 }
5 }
6 let testNumber = 5
7 simpleAssert(testNumber % 2 == 0, "testNumber isn't an even number.")
8 // prints "testNumber isn't an even number."
A function type can have a variadic parameter as the last parameter in its parameter type. Syntactically, a variadic
parameter consists of a base type name followed immediately by three dots (...), as in Int.... A variadic
parameter is treated as an array that contains elements of the base type name. For instance, the variadic
parameter Int... is treated as Int[]. For an example that uses a variadic parameter, see Variadic Parameters.
To specify an in-out parameter, prefix the parameter type with the inout keyword. You cant mark a variadic
parameter or a return type with the inout keyword. In-out parameters are discussed in In-Out Parameters.
The type of a curried function is equivalent to a nested function type. For example, the type of the curried function
addTwoNumbers()() below is Int -> Int -> Int:
1 func addTwoNumbers(a: Int)(b: Int) -> Int {
2 return a + b
3 }
4 addTwoNumbers(4)(5) // Returns 9
The function types of a curried function are grouped from right to left. For instance, the function type Int -> Int -
> Int is understood as Int -> (Int -> Int)that is, a function that takes an Int and returns another function
that takes and return an Int. For example, you can rewrite the curried function addTwoNumbers()() as the
following nested function:
1 func addTwoNumbers(a: Int) -> (Int -> Int) {
2 func addTheSecondNumber(b: Int) -> Int {
3 return a + b
4 }
5 return addTheSecondNumber
6 }
7 addTwoNumbers(4)(5) // Returns 9
GR A M M A R OF A F U N C T I ON T Y P E
function-type ! type -> type
Array Type
The Swift language uses square brackets ([]) immediately after the name of a type as syntactic sugar for the
named type Array<T>, which is defined in the Swift standard library. In other words, the following two declarations
are equivalent:
1 let someArray: String[] = ["Alex", "Brian", "Dave"]
2 let someArray: Array<String> = ["Alex", "Brian", "Dave"]
In both cases, the constant someArray is declared as an array of strings. The elements of an array can be
accessed using square brackets as well: someArray[0] refers to the element at index 0, "Alex".
As the above example also shows, you can use square brackets to create an array using an array literal. Empty
array literals are written using an empty pair of square brackets and can be used to create an empty array of a
specified type.
var emptyArray: Double[] = []
You can create multidimensional arrays by chaining multiple sets of square brackets to the name of the base type of
the elements. For example, you can create a three-dimensional array of integers using three sets of square
brackets:
var array3D: Int[][][] = [[[1, 2], [3, 4]], [[5, 6], [7, 8]]]
When accessing the elements in a multidimensional array, the left-most subscript index refers to the element at that
index in the outermost array. The next subscript index to the right refers to the element at that index in the array
thats nested one level in. And so on. This means that in the example above, array3D[0] refers to [[1, 2], [3,
4]], array3D[0][1] refers to [3, 4], and array3D[0][1][1] refers to the value 4.
For a detailed discussion of the Swift standard library Array type, see Arrays.
GR A M M A R OF A N A R R AY T Y P E
array-type ! type [ ] array-type [ ] |
Optional Type
The Swift language defines the postfix ? as syntactic sugar for the named type Optional<T>, which is defined in the
Swift standard library. In other words, the following two declarations are equivalent:
1 var optionalInteger: Int?
2 var optionalInteger: Optional<Int>
In both cases, the variable optionalInteger is declared to have the type of an optional integer. Note that no
whitespace may appear between the type and the ?.
The type Optional<T> is an enumeration with two cases, None and Some(T), which are used to represent values
that may or may not be present. Any type can be explicitly declared to be (or implicitly converted to) an optional
type. When declaring an optional type, be sure to use parentheses to properly scope the ? operator. As an
example, to declare an optional array of integers, write the type annotation as (Int[])?; writing Int[]? produces
an error.
If you dont provide an initial value when you declare an optional variable or property, its value automatically defaults
to nil.
Optionals conform to the LogicValue protocol and therefore may occur in a Boolean context. In that context, if an
instance of an optional type T? contains any value of type T (that is, its value is Optional.Some(T)), the optional
type evaluates to true. Otherwise, it evaluates to false.
If an instance of an optional type contains a value, you can access that value using the postfix operator !, as shown
below:
1 optionalInteger = 42
2 optionalInteger! // 42
Using the ! operator to unwrap an optional that has a value of nil results in a runtime error.
You can also use optional chaining and optional binding to conditionally perform an operation on an optional
expression. If the value is nil, no operation is performed and therefore no runtime error is produced.
For more information and to see examples that show how to use optional types, see Optionals.
GR A M M A R OF A N OP T I ON A L T Y P E
optional-type ! type ?
Implicitly Unwrapped Optional Type
The Swift language defines the postfix ! as syntactic sugar for the named type
ImplicitlyUnwrappedOptional<T>, which is defined in the Swift standard library. In other words, the following two
declarations are equivalent:
1 var implicitlyUnwrappedString: String!
2 var implicitlyUnwrappedString: ImplicitlyUnwrappedOptional<String>
In both cases, the variable implicitlyUnwrappedString is declared to have the type of an implicitly unwrapped
optional string. Note that no whitespace may appear between the type and the !.
You can use implicitly unwrapped optionals in all the same places in your code that you can use optionals. For
instance, you can assign values of implicitly unwrapped optionals to variables, constants, and properties of
optionals, and vice versa.
As with optionals, if you dont provide an initial value when you declare an implicitly unwrapped optional variable or
property, its value automatically defaults to nil.
Because the value of an implicitly unwrapped optional is automatically unwrapped when you use it, theres no need
to use the ! operator to unwrap it. That said, if you try to use an implicitly unwrapped optional that has a value of
nil, youll get a runtime error.
Use optional chaining to conditionally perform an operation on an implicitly unwrapped optional expression. If the
value is nil, no operation is performed and therefore no runtime error is produced.
For more information about implicitly unwrapped optional types, see Implicitly Unwrapped Optionals.
GR A M M A R OF A N I M P L I C I T LY U N W R A P P E D OP T I ON A L T Y P E
implicitly-unwrapped-optional-type ! type !
Protocol Composition Type
A protocol composition type describes a type that conforms to each protocol in a list of specified protocols. Protocol
composition types may be used in type annotations and in generic parameters.
Protocol composition types have the following form:
protocol< Protocol 1 , Protocol 2 >
A protocol composition type allows you to specify a value whose type conforms to the requirements of multiple
protocols without having to explicitly define a new, named protocol that inherits from each protocol you want the type
to conform to. For example, specifying a protocol composition type protocol<ProtocolA, ProtocolB,
ProtocolC> is effectively the same as defining a new protocol ProtocolD that inherits from ProtocolA,
ProtocolB, and ProtocolC, but without having to introduce a new name.
Each item in a protocol composition list must be either the name of protocol or a type alias of a protocol composition
type. If the list is empty, it specifies the empty protocol composition type, which every type conforms to.
GR A M M A R OF A P R OT OC OL C OM P OS I T I ON T Y P E
protocol-composition-type ! protocol < protocol-identifier-list
opt
>
protocol-identifier-list ! protocol-identifier protocol-identifier , protocol-identifier-list
protocol-identifier ! type-identifier
Metatype Type
A metatype type refers to the type of any type, including class types, structure types, enumeration types, and
protocol types.
The metatype of a class, structure, or enumeration type is the name of that type followed by .Type. The metatype
of a protocol typenot the concrete type that conforms to the protocol at runtimeis the name of that protocol
followed by .Protocol. For example, the metatype of the class type SomeClass is SomeClass.Type and the
metatype of the protocol SomeProtocol is SomeProtocol.Protocol.
You can use the postfix self expression to access a type as a value. For example, SomeClass.self returns
SomeClass itself, not an instance of SomeClass. And SomeProtocol.self returns SomeProtocol itself, not an
instance of a type that conforms to SomeProtocol at runtime. You can use a dynamicType expression with an
instance of a type to access that instances runtime type as a value, as the following example shows:
1 class SomeBaseClass {
2 class func printClassName() {
3 println("SomeBaseClass")
4 }
5 }
6 class SomeSubClass: SomeBaseClass {
7 override class func printClassName() {
8 println("SomeSubClass")
9 }
10 }
11 let someInstance: SomeBaseClass = SomeSubClass()
12 // someInstance is of type SomeBaseClass at compile time, but
13 // someInstance is of type SomeSubClass at runtime
14 someInstance.dynamicType.printClassName()
15 // prints "SomeSubClass"
GR A M M A R OF A M E T AT Y P E T Y P E
metatype-type ! type . Type type . Protocol
Type Inheritance Clause
|
|
A type inheritance clause is used to specify which class a named type inherits from and which protocols a named
type conforms to. A type inheritance clause begins with a colon (:), followed by a comma-separated list of type
identifiers.
Class types may inherit from a single superclass and conform to any number of protocols. When defining a class,
the name of the superclass must appear first in the list of type identifiers, followed by any number of protocols the
class must conform to. If the class does not inherit from another class, the list may begin with a protocol instead.
For an extended discussion and several examples of class inheritance, see Inheritance.
Other named types may only inherit from or conform to a list of protocols. Protocol types may inherit from any
number of other protocols. When a protocol type inherits from other protocols, the set of requirements from those
other protocols are aggregated together, and any type that inherits from the current protocol must conform to all of
those requirements.
A type inheritance clause in an enumeration definition may be either a list of protocols, or in the case of an
enumeration that assigns raw values to its cases, a single, named type that specifies the type of those raw values.
For an example of an enumeration definition that uses a type inheritance clause to specify the type of its raw values,
see Raw Values.
GR A M M A R OF A T Y P E I N H E R I T A N C E C L A U S E
type-inheritance-clause ! : type-inheritance-list
type-inheritance-list ! type-identifier type-identifier , type-inheritance-list
Type Inference
Swift uses type inference extensively, allowing you to omit the type or part of the type of many variables and
expressions in your code. For example, instead of writing var x: Int = 0, you can omit the type completely and
simply write var x = 0the compiler correctly infers that x names a value of type Int. Similarly, you can omit part
of a type when the full type can be inferred from context. For instance, if you write let dict: Dictionary =
["A": 1], the compiler infers that dict has the type Dictionary<String, Int>.
In both of the examples above, the type information is passed up from the leaves of the expression tree to its root.
That is, the type of x in var x: Int = 0 is inferred by first checking the type of 0 and then passing this type
information up to the root (the variable x).
In Swift, type information can also flow in the opposite directionfrom the root down to the leaves. In the following
example, for instance, the explicit type annotation (: Float) on the constant eFloat causes the numeric literal
2.71828 to have type Float instead of type Double.
1 let e = 2.71828 // The type of e is inferred to be Double.
2 let eFloat: Float = 2.71828 // The type of eFloat is Float.
Type inference in Swift operates at the level of a single expression or statement. This means that all of the
information needed to infer an omitted type or part of a type in an expression must be accessible from type-
checking the expression or one of its subexpressions.
|
Expressions
In Swift, there are four kinds of expressions: prefix expressions, binary expressions, primary expressions, and
postfix expressions. Evaluating an expression returns a value, causes a side effect, or both.
Prefix and binary expressions let you apply operators to smaller expressions. Primary expressions are
conceptually the simplest kind of expression, and they provide a way to access values. Postfix expressions, like
prefix and binary expressions, let you build up more complex expressions using postfixes such as function calls
and member access. Each kind of expression is described in detail in the sections below.
GR A M M A R OF A N E X P R E S S I ON
expression ! prefix-expression binary-expressions
opt
expression-list ! expression expression , expression-list
Prefix Expressions
Prefix expressions combine an optional prefix operator with an expression. Prefix operators take one argument, the
expression that follows them.
The Swift standard library provides the following prefix operators:
For information about the behavior of these operators, see Basic Operators and Advanced Operators.
In addition to the standard library operators listed above, you use & immediately before the name of a variable thats
being passed as an in-out argument to a function call expression. For more information and to see an example, see
In-Out Parameters.
GR A M M A R OF A P R E F I X E X P R E S S I ON
prefix-expression ! prefix-operator
opt
postfix-expression
prefix-expression ! in-out-expression
in-out-expression ! & identifier
Binary Expressions
|
++ Increment
-- Decrement
! Logical NOT
~ Bitwise NOT
+ Unary plus
- Unary minus
Binary expressions combine an infix binary operator with the expression that it takes as its left-hand and right-hand
arguments. It has the following form:
left-hand argument operator right-hand argument
The Swift standard library provides the following binary operators:
A closure may omit names for its parameters. Its parameters are then implicitly named $ followed by
their position: $0, $1, $2, and so on.
A closure that consists of only a single expression is understood to return the value of that expression.
The contents of this expression is also considered when performing type inference on the surrounding
expression.
8 return x + y
9 }
10
11 myFunction { return $0 + $1 }
12
13 myFunction { $0 + $1 }
For information about passing a closure as an argument to a function, see Function Call Expression.
A closure expression can explicitly specify the values that it captures from the surrounding scope using a capture
list. A capture list is written as a comma separated list surrounded by square brackets, before the list of
parameters. If you use a capture list, you must also use the in keyword, even if you omit the parameter names,
parameter types, and return type.
Each entry in the capture list can be marked as weak or unowned to capture a weak or unowned reference to the
value.
1 myFunction { print(self.title) } // strong capture
2 myFunction { [weak self] in print(self!.title) } // weak capture
3 myFunction { [unowned self] in print(self.title) } // unowned capture
You can also bind arbitrary expression to named values in the capture list. The expression is evaluated when the
closure is formed, and captured with the specified strength. For example:
1 // Weak capture of "self.parent" as "parent"
2 myFunction { [weak parent = self.parent] in print(parent!.title) }
For more information and examples of closure expressions, see Closure Expressions.
GR A M M A R OF A C L OS U R E E X P R E S S I ON
closure-expression ! { closure-signature
opt
statements }
closure-signature ! parameter-clause function-result
opt
in
closure-signature ! identifier-list function-result
opt
in
closure-signature ! capture-list parameter-clause function-result
opt
in
closure-signature ! capture-list identifier-list function-result
opt
in
closure-signature ! capture-list in
capture-list ! [ capture-specifier expression ]
capture-specifier ! weak unowned unowned(safe) unowned(unsafe)
Implicit Member Expression
An implicit member expression is an abbreviated way to access a member of a type, such as an enumeration case
or a class method, in a context where type inference can determine the implied type. It has the following form:
| | |
. member name
For example:
1 var x = MyEnumeration.SomeValue
2 x = .AnotherValue
GR A M M A R OF A I M P L I C I T M E M B E R E X P R E S S I ON
implicit-member-expression ! . identifier
Parenthesized Expression
A parenthesized expression consists of a comma-separated list of expressions surrounded by parentheses. Each
expression can have an optional identifier before it, separated by a colon (:). It has the following form:
( identifier 1 : expression 1 , identifier 2 : expression 2 , ... )
Use parenthesized expressions to create tuples and to pass arguments to a function call. If there is only one value
inside the parenthesized expression, the type of the parenthesized expression is the type of that value. For
example, the type of the parenthesized expression (1) is Int, not (Int).
GR A M M A R OF A PA R E N T H E S I Z E D E X P R E S S I ON
parenthesized-expression ! ( expression-element-list
opt
)
expression-element-list ! expression-element expression-element , expression-element-list
expression-element ! expression identifier : expression
Wildcard Expression
A wildcard expression is used to explicitly ignore a value during an assignment. For example, in the following
assignment 10 is assigned to x and 20 is ignored:
1 (x, _) = (10, 20)
2 // x is 10, 20 is ignored
GR A M M A R OF A W I L D C A R D E X P R E S S I ON
wildcard-expression ! _
Postfix Expressions
Postfix expressions are formed by applying a postfix operator or other postfix syntax to an expression.
Syntactically, every primary expression is also a postfix expression.
|
|
The Swift standard library provides the following postfix operators:
For information about the behavior of these operators, see Basic Operators and Advanced Operators.
GR A M M A R OF A P OS T F I X E X P R E S S I ON
postfix-expression ! primary-expression
postfix-expression ! postfix-expression postfix-operator
postfix-expression ! function-call-expression
postfix-expression ! initializer-expression
postfix-expression ! explicit-member-expression
postfix-expression ! postfix-self-expression
postfix-expression ! dynamic-type-expression
postfix-expression ! subscript-expression
postfix-expression ! forced-value-expression
postfix-expression ! optional-chaining-expression
Function Call Expression
A function call expression consists of a function name followed by a comma-separated list of the functions
arguments in parentheses. Function call expressions have the following form:
function name ( argument value 1 , argument value 2 )
The function name can be any expression whose value is of a function type.
If the function definition includes names for its parameters, the function call must include names before its argument
values separated by a colon (:). This kind of function call expression has the following form:
function name ( argument name 1 : argument value 1 , argument name 2 :
argument value 2 )
A function call expression can include a trailing closure in the form of a closure expression immediately after the
closing parenthesis. The trailing closure is understood as an argument to the function, added after the last
parenthesized argument. The following function calls are equivalent:
1 // someFunction takes an integer and a closure as its arguments
2 someFunction(x, {$0 == 13})
3 someFunction(x) {$0 == 13}
If the trailing closure is the functions only argument, the parentheses can be omitted.
++ Increment
-- Decrement
1 // someFunction takes a closure as its only argument
2 myData.someMethod() {$0 == 13}
3 myData.someMethod {$0 == 13}
GR A M M A R OF A F U N C T I ON C A L L E X P R E S S I ON
function-call-expression ! postfix-expression parenthesized-expression
function-call-expression ! postfix-expression parenthesized-expression
opt
trailing-closure
trailing-closure ! closure-expression
Initializer Expression
An initializer expression provides access to a types initializer. It has the following form:
expression .init( initializer arguments )
You use the initializer expression in a function call expression to initialize a new instance of a type. Unlike functions,
an initializer cant be used as a value. For example:
1 var x = SomeClass.someClassFunction // ok
2 var y = SomeClass.init // error
You also use an initializer expression to delegate to the initializer of a superclass.
1 class SomeSubClass: SomeSuperClass {
2 init() {
3 // subclass initialization goes here
4 super.init()
5 }
6 }
GR A M M A R OF A N I N I T I A L I Z E R E X P R E S S I ON
initializer-expression ! postfix-expression . init
Explicit Member Expression
A explicit member expression allows access to the members of a named type, a tuple, or a module. It consists of a
period (.) between the item and the identifier of its member.
expression . member name
The members of a named type are named as part of the types declaration or extension. For example:
1 class SomeClass {
2 var someProperty = 42
3 }
4 let c = SomeClass()
5 let y = c.someProperty // Member access
The members of a tuple are implicitly named using integers in the order they appear, starting from zero. For
example:
1 var t = (10, 20, 30)
2 t.0 = t.1
3 // Now t is (20, 20, 30)
The members of a module access the top-level declarations of that module.
GR A M M A R OF A N E X P L I C I T M E M B E R E X P R E S S I ON
explicit-member-expression ! postfix-expression . decimal-digit
explicit-member-expression ! postfix-expression . identifier generic-argument-clause
opt
Postfix Self Expression
A postfix self expression consists of an expression or the name of a type, immediately followed by .self. It has
the following forms:
expression .self
type .self
The first form evaluates to the value of the expression. For example, x.self evaluates to x.
The second form evaluates to the value of the type. Use this form to access a type as a value. For example,
because SomeClass.self evaluates to the SomeClass type itself, you can pass it to a function or method that
accepts a type-level argument.
GR A M M A R OF A S E L F E X P R E S S I ON
postfix-self-expression ! postfix-expression . self
Dynamic Type Expression
A dynamicType expression consists of an expression, immediately followed by .dynamicType. It has the following
form:
expression .dynamicType
The expression cant be the name of a type. The entire dynamicType expression evaluates to the value of the
runtime type of the expression, as the following example shows:
1 class SomeBaseClass {
2 class func printClassName() {
3 println("SomeBaseClass")
4 }
5 }
6 class SomeSubClass: SomeBaseClass {
7 override class func printClassName() {
8 println("SomeSubClass")
9 }
10 }
11 let someInstance: SomeBaseClass = SomeSubClass()
12 // someInstance is of type SomeBaseClass at compile time, but
13 // someInstance is of type SomeSubClass at runtime
14 someInstance.dynamicType.printClassName()
15 // prints "SomeSubClass"
GR A M M A R OF A D Y N A M I C T Y P E E X P R E S S I ON
dynamic-type-expression ! postfix-expression . dynamicType
Subscript Expression
A subscript expression provides subscript access using the getter and setter of the corresponding subscript
declaration. It has the following form:
expression [ index expressions ]
To evaluate the value of a subscript expression, the subscript getter for the expressions type is called with the
index expressions passed as the subscript parameters. To set its value, the subscript setter is called in the same
way.
For information about subscript declarations, see Protocol Subscript Declaration.
GR A M M A R OF A S U B S C R I P T E X P R E S S I ON
subscript-expression ! postfix-expression [ expression-list ]
Forced-Value Expression
A forced-value expression unwraps an optional value that you are certain is not nil. It has the following form:
expression !
If the value of the expression is not nil, the optional value is unwrapped and returned with the corresponding
nonoptional type. Otherwise, a runtime error is raised.
GR A M M A R OF A F OR C E D - VA L U E E X P R E S S I ON
forced-value-expression ! postfix-expression !
Optional-Chaining Expression
An optional-chaining expression provides a simplified syntax for using optional values in postfix expressions. It has
the following form:
expression ?
On its own, the postfix ? operator simply returns the value of its argument as an optional.
Postfix expressions that contain an optional-chaining expression are evaluated in a special way. If the optional-
chaining expression is nil, all of the other operations in the postfix expression are ignored and the entire postfix
expression evaluates to nil. If the optional-chaining expression is not nil, the value of the optional-chaining
expression is unwrapped and used to evaluate the rest of the postfix expression. In either case, the value of the
postfix expression is still of an optional type.
If a postfix expression that contains an optional-chaining expression is nested inside other postfix expressions, only
the outermost expression returns an optional type. In the example below, when c is not nil, its value is unwrapped
and used to evaluate both .property and .performAction(), and the entire expression
c?.property.performAction() has a value of an optional type.
1 var c: SomeClass?
2 var result: Bool? = c?.property.performAction()
The following example shows the behavior of the example above without using optional chaining.
1 if let unwrappedC = c {
2 result = unwrappedC.property.performAction()
3 }
GR A M M A R OF A N OP T I ON A L - C H A I N I N G E X P R E S S I ON
optional-chaining-expression ! postfix-expression ?
Statements
In Swift, there are two kinds of statements: simple statements and control flow statements. Simple statements are
the most common and consist of either an expression or a declaration. Control flow statements are used to control
the flow of execution in a program. There are three types of control flow statements in Swift: loop statements,
branch statements, and control transfer statements.
Loop statements allow a block of code to be executed repeatedly, branch statements allow a certain block of code
to be executed only when certain conditions are met, and control transfer statements provide a way to alter the
order in which code is executed. Each type of control flow statement is described in detail below.
A semicolon (;) can optionally appear after any statement and is used to separate multiple statements if they
appear on the same line.
GR A M M A R OF A S T AT E M E N T
statement ! expression ;
opt
statement ! declaration ;
opt
statement ! loop-statement ;
opt
statement ! branch-statement ;
opt
statement ! labeled-statement
statement ! control-transfer-statement ;
opt
statements ! statement statements
opt
Loop Statements
Loop statements allow a block of code to be executed repeatedly, depending on the conditions specified in the loop.
Swift has four loop statements: a for statement, a for-in statement, a while statement, and a do-while
statement.
Control flow in a loop statement can be changed by a break statement and a continue statement and is discussed
in Break Statement and Continue Statement below.
GR A M M A R OF A L OOP S T AT E M E N T
loop-statement ! for-statement
loop-statement ! for-in-statement
loop-statement ! while-statement
loop-statement ! do-while-statement
For Statement
A for statement allows a block of code to be executed repeatedly while incrementing a counter, as long as a
condition remains true.
A for statement has the following form:
for initialization ; condition ; increment {
statements
}
The semicolons between the initialization, condition, and increment are required. The braces around the statements
in the body of the loop are also required.
A for statement is executed as follows:
1. The initialization is evaluated only once. It is typically used to declare and initialize any variables that are
needed for the remainder of the loop.
2. The condition expression is evaluated.
If true, the program executes the statements, and execution continues to step 3. If false, the program
does not execute the statements or the increment expression, and the program is finished executing the
for statement.
3. The increment expression is evaluated, and execution returns to step 2.
Variables defined within the initialization are valid only within the scope of the for statement itself.
The value of the condition expression must have a type that conforms to the LogicValue protocol.
GR A M M A R OF A F OR S T AT E M E N T
for-statement ! for for-init
opt
; expression
opt
; expression
opt
code-block
for-statement ! for ( for-init
opt
; expression
opt
; expression
opt
) code-block
for-init ! variable-declaration expression-list
For-In Statement
A for-in statement allows a block of code to be executed once for each item in a collection (or any type) that
conforms to the Sequence protocol.
A for-in statement has the following form:
for item in collection {
statements
}
The generate method is called on the collection expression to obtain a value of a generator typethat is, a type
that conforms to the Generator protocol. The program begins executing a loop by calling the next method on the
|
stream. If the value returned is not None, it is assigned to the item pattern, the program executes the statements,
and then continues execution at the beginning of the loop. Otherwise, the program does not perform assignment or
execute the statements, and it is finished executing the for-in statement.
GR A M M A R OF A F OR - I N S T AT E M E N T
for-in-statement ! for pattern in expression code-block
While Statement
A while statement allows a block of code to be executed repeatedly, as long as a condition remains true.
A while statement has the following form:
while condition {
statements
}
A while statement is executed as follows:
1. The condition is evaluated.
If true, execution continues to step 2. If false, the program is finished executing the while statement.
2. The program executes the statements, and execution returns to step 1.
Because the value of the condition is evaluated before the statements are executed, the statements in a while
statement can be executed zero or more times.
The value of the condition must have a type that conforms to the LogicValue protocol. The condition can also be
an optional binding declaration, as discussed in Optional Binding.
GR A M M A R OF A W H I L E S T AT E M E N T
while-statement ! while while-condition code-block
while-condition ! expression declaration
Do-While Statement
A do-while statement allows a block of code to be executed one or more times, as long as a condition remains
true.
A do-while statement has the following form:
do {
|
statements
} while condition
A do-while statement is executed as follows:
1. The program executes the statements, and execution continues to step 2.
2. The condition is evaluated.
If true, execution returns to step 1. If false, the program is finished executing the do-while statement.
Because the value of the condition is evaluated after the statements are executed, the statements in a do-while
statement are executed at least once.
The value of the condition must have a type that conforms to the LogicValue protocol. The condition can also be
an optional binding declaration, as discussed in Optional Binding.
GR A M M A R OF A D O- W H I L E S T AT E M E N T
do-while-statement ! do code-block while while-condition
Branch Statements
Branch statements allow the program to execute certain parts of code depending on the value of one or more
conditions. The values of the conditions specified in a branch statement control how the program branches and,
therefore, what block of code is executed. Swift has two branch statements: an if statement and a switch
statement.
Control flow in a switch statement can be changed by a break statement and is discussed in Break Statement
below.
GR A M M A R OF A B R A N C H S T AT E M E N T
branch-statement ! if-statement
branch-statement ! switch-statement
If Statement
An if statement is used for executing code based on the evaluation of one or more conditions.
There are two basic forms of an if statement. In each form, the opening and closing braces are required.
The first form allows code to be executed only when a condition is true and has the following form:
if condition {
statements
}
The second form of an if statement provides an additional else clause (introduced by the else keyword) and is
used for executing one part of code when the condition is true and another part code when the same condition is
false. When a single else clause is present, an if statement has the following form:
if condition {
statements to execute if condition is true
} else {
statements to execute if condition is false
}
The else clause of an if statement can contain another if statement to test more than one condition. An if
statement chained together in this way has the following form:
if condition 1 {
statements to execute if condition 1 is true
} else if condition 2 {
statements to execute if condition 2 is true
} else {
statements to execute if both conditions are false
}
The value of any condition in an if statement must have a type that conforms to the LogicValue protocol. The
condition can also be an optional binding declaration, as discussed in Optional Binding.
GR A M M A R OF A N I F S T AT E M E N T
if-statement ! if if-condition code-block else-clause
opt
if-condition ! expression declaration
else-clause ! else code-block else if-statement
Switch Statement
A switch statement allows certain blocks of code to be executed depending on the value of a control expression.
A switch statement has the following form:
switch control expression {
|
|
case pattern 1 :
statements
case pattern 2 where condition :
statements
case pattern 3 where condition ,
pattern 4 where condition :
statements
default:
statements
}
The control expression of the switch statement is evaluated and then compared with the patterns specified in each
case. If a match is found, the program executes the statements listed within the scope of that case. The scope of
each case cant be empty. As a result, you must include at least one statement following the colon (:) of each case
label. Use a single break statement if you dont intend to execute any code in the body of a matched case.
The values of expressions your code can branch on is very flexible. For instance, in addition to the values of scalar
types, such as integers and characters, your code can branch on the values of any type, including floating-point
numbers, strings, tuples, instances of custom classes, and optionals. The value of the control expression can even
be matched to the value of a case in an enumeration and checked for inclusion in a specified range of values. For
examples of how to use these various types of values in switch statements, see Switch in the Control Flow
chapter.
A switch case can optionally contain a guard expression after each pattern. A guard expression is introduced by
the keyword where followed by an expression, and is used to provide an additional condition before a pattern in a
case is considered matched to the control expression. If a guard expression is present, the statements within the
relevant case are executed only if the value of the control expression matches one of the patterns of the case and
the guard expression evaluates to true. For instance, a control expression matches the case in the example below
only if it is a tuple that contains two elements of the same value, such as (1, 1).
case let (x, y) where x == y:
As the above example shows, patterns in a case can also bind constants using the keyword let (they can also
bind variables using the keyword var). These constants (or variables) can then be referenced in a corresponding
guard expression and throughout the rest of the code within the scope of the case. That said, if the case contains
multiple patterns that match the control expression, none of those patterns can contain constant or variable
bindings.
A switch statement can also include a default case, introduced by the keyword default. The code within a default
case is executed only if no other cases match the control expression. A switch statement can include only one
default case, which must appear at the end of the switch statement.
Although the actual execution order of pattern-matching operations, and in particular the evaluation order of patterns
in cases, is unspecified, pattern matching in a switch statement behaves as if the evaluation is performed in source
orderthat is, the order in which they appear in source code. As a result, if multiple cases contain patterns that
evaluate to the same value, and thus can match the value of the control expression, the program executes only the
code within the first matching case in source order.
Switch Statements Must Be Exhaustive
In Swift, every possible value of the control expressions type must match the value of at least one pattern of a
case. When this simply isnt feasible (for instance, when the control expressions type is Int), you can include a
default case to satisfy the requirement.
Execution Does Not Fall Through Cases Implicitly
After the code within a matched case has finished executing, the program exits from the switch statement.
Program execution does not continue or fall through to the next case or default case. That said, if you want
execution to continue from one case to the next, explicitly include a fallthrough statement, which simply consists
of the keyword fallthrough, in the case from which you want execution to continue. For more information about
the fallthrough statement, see Fallthrough Statement below.
GR A M M A R OF A S W I T C H S T AT E M E N T
switch-statement ! switch expression { switch-cases
opt
}
switch-cases ! switch-case switch-cases
opt
switch-case ! case-label statements default-label statements
switch-case ! case-label ; default-label ;
case-label ! case case-item-list :
case-item-list ! pattern guard-clause
opt
pattern guard-clause
opt
, case-item-list
default-label ! default :
guard-clause ! where guard-expression
guard-expression ! expression
Labeled Statement
You can prefix a loop statement or a switch statement with a statement label, which consists of the name of the
label followed immediately by a colon (:). Use statement labels with break and continue statements to be explicit
about how you want to change control flow in a loop statement or a switch statement, as discussed in Break
Statement and Continue Statement below.
The scope of a labeled statement is the entire statement following the statement label. You can nest labeled
statements, but the name of each statement label must be unique.
For more information and to see examples of how to use statement labels, see Labeled Statements in the Control
Flow chapter.
|
|
|
GR A M M A R OF A L A B E L E D S T AT E M E N T
labeled-statement ! statement-label loop-statement statement-label switch-statement
statement-label ! label-name :
label-name ! identifier
Control Transfer Statements
Control transfer statements can change the order in which code in your program is executed by unconditionally
transferring program control from one piece of code to another. Swift has four control transfer statements: a break
statement, a continue statement, a fallthrough statement, and a return statement.
GR A M M A R OF A C ON T R OL T R A N S F E R S T AT E M E N T
control-transfer-statement ! break-statement
control-transfer-statement ! continue-statement
control-transfer-statement ! fallthrough-statement
control-transfer-statement ! return-statement
Break Statement
A break statement ends program execution of a loop or a switch statement. A break statement can consist of only
the keyword break, or it can consist of the keyword break followed by the name of a statement label, as shown
below.
break
break label name
When a break statement is followed by the name of a statement label, it ends program execution of the loop or
switch statement named by that label.
When a break statement is not followed by the name of a statement label, it ends program execution of the switch
statement or the innermost enclosing loop statement in which it occurs.
In both cases, program control is then transferred to the first line of code following the enclosing loop or switch
statement, if any.
For examples of how to use a break statement, see Break and Labeled Statements in the Control Flow chapter.
GR A M M A R OF A B R E A K S T AT E M E N T
break-statement ! break label-name
opt
Continue Statement
|
A continue statement ends program execution of the current iteration of a loop statement but does not stop
execution of the loop statement. A continue statement can consist of only the keyword continue, or it can consist
of the keyword continue followed by the name of a statement label, as shown below.
continue
continue label name
When a continue statement is followed by the name of a statement label, it ends program execution of the current
iteration of the loop statement named by that label.
When a continue statement is not followed by the name of a statement label, it ends program execution of the
current iteration of the innermost enclosing loop statement in which it occurs.
In both cases, program control is then transferred to the condition of the enclosing loop statement.
In a for statement, the increment expression is still evaluated after the continue statement is executed, because
the increment expression is evaluated after the execution of the loops body.
For examples of how to use a continue statement, see Continue and Labeled Statements in the Control Flow
chapter.
GR A M M A R OF A C ON T I N U E S T AT E M E N T
continue-statement ! continue label-name
opt
Fallthrough Statement
A fallthrough statement consists of the fallthrough keyword and occurs only in a case block of a switch
statement. A fallthrough statement causes program execution to continue from one case in a switch statement
to the next case. Program execution continues to the next case even if the patterns of the case label do not match
the value of the switch statements control expression.
A fallthrough statement can appear anywhere inside a switch statement, not just as the last statement of a case
block, but it cant be used in the final case block. It also cannot transfer control into a case block whose pattern
contains value binding patterns.
For an example of how to use a fallthrough statement in a switch statement, see Control Transfer Statements in
the Control Flow chapter.
GR A M M A R OF A F A L LT H R OU GH S T AT E M E N T
fallthrough-statement ! fallthrough
Return Statement
A return statement occurs only in the body of a function or method definition and causes program execution to
return to the calling function or method. Program execution continues at the point immediately following the function
or method call.
A return statement can consist of only the keyword return, or it can consist of the keyword return followed by
an expression, as shown below.
return
return expression
When a return statement is followed by an expression, the value of the expression is returned to the calling
function or method. If the value of the expression does not match the value of the return type declared in the
function or method declaration, the expressions value is converted to the return type before it is returned to the
calling function or method.
When a return statement is not followed by an expression, it can be used only to return from a function or method
that does not return a value (that is, when the return type of the function or method is Void or ()).
GR A M M A R OF A R E T U R N S T AT E M E N T
return-statement ! return expression
opt
Declarations
A declaration introduces a new name or construct into your program. For example, you use declarations to
introduce functions and methods, variables and constants, and to define new, named enumeration, structure, class,
and protocol types. You can also use a declaration to extend the the behavior of an existing named type and to
import symbols into your program that are declared elsewhere.
In Swift, most declarations are also definitions in the sense that they are implemented or initialized at the same time
they are declared. That said, because protocols dont implement their members, most protocol members are
declarations only. For convenience and because the distinction isnt that important in Swift, the term declaration
covers both declarations and definitions.
GR A M M A R OF A D E C L A R AT I ON
declaration ! import-declaration
declaration ! constant-declaration
declaration ! variable-declaration
declaration ! typealias-declaration
declaration ! function-declaration
declaration ! enum-declaration
declaration ! struct-declaration
declaration ! class-declaration
declaration ! protocol-declaration
declaration ! initializer-declaration
declaration ! deinitializer-declaration
declaration ! extension-declaration
declaration ! subscript-declaration
declaration ! operator-declaration
declarations ! declaration declarations
opt
declaration-specifiers ! declaration-specifier declaration-specifiers
opt
declaration-specifier ! class mutating nonmutating override static unowned
unowned(safe) unowned(unsafe) weak
Module Scope
The module scope defines the code thats visible to other code in Swift source files that are part of the same
module. The top-level code in a Swift source file consists of zero or more statements, declarations, and
expressions. Variables, constants, and other named declarations that are declared at the top-level of a source file
are visible to code in every source file that is part of the same module.
GR A M M A R OF A T OP - L E V E L D E C L A R AT I ON
top-level-declaration ! statements
opt
Code Blocks
A code block is used by a variety of declarations and control structures to group statements together. It has the
| | | | | |
| |
following form:
{
statements
}
The statements inside a code block include declarations, expressions, and other kinds of statements and are
executed in order of their appearance in source code.
GR A M M A R OF A C OD E B L OC K
code-block ! { statements
opt
}
Import Declaration
An import declaration lets you access symbols that are declared outside the current file. The basic form imports the
entire module; it consists of the import keyword followed by a module name:
import module
Providing more detail limits which symbols are importedyou can specify a specific submodule or a specific
declaration within a module or submodule. When this detailed form is used, only the imported symbol (and not the
module that declares it) is made available in the current scope.
import import kind module . symbol name
import module . submodule
GR A M M A R OF A N I M P OR T D E C L A R AT I ON
import-declaration ! attributes
opt
import import-kind
opt
import-path
import-kind ! typealias struct class enum protocol var func
import-path ! import-path-identifier import-path-identifier . import-path
import-path-identifier ! identifier operator
Constant Declaration
A constant declaration introduces a constant named value into your program. Constant declarations are declared
using the keyword let and have the following form:
let constant name : type = expression
| | | | | |
|
|
A constant declaration defines an immutable binding between the constant name and the value of the initializer
expression; after the value of a constant is set, it cannot be changed. That said, if a constant is initialized with a
class object, the object itself can change, but the binding between the constant name and the object it refers to
cant.
When a constant is declared at global scope, it must be initialized with a value. When a constant declaration occurs
in the context of a class or structure declaration, it is considered a constant property. Constant declarations are not
computed properties and therefore do not have getters or setters.
If the constant name of a constant declaration is a tuple pattern, the name of each item in the tuple is bound to the
corresponding value in the initializer expression.
let (firstNumber, secondNumber) = (10, 42)
In this example, firstNumber is a named constant for the value 10, and secondNumber is a named constant for the
value 42. Both constants can now be used independently:
1 println("The first number is \(firstNumber).")
2 // prints "The first number is 10."
3 println("The second number is \(secondNumber).")
4 // prints "The second number is 42."
The type annotation (: type) is optional in a constant declaration when the type of the constant name can be
inferred, as described in Type Inference.
To declare a static constant property, mark the declaration with the static keyword. Static properties are
discussed in Type Properties.
For more information about constants and for guidance about when to use them, see Constants and Variables and
Stored Properties.
GR A M M A R OF A C ON S T A N T D E C L A R AT I ON
constant-declaration ! attributes
opt
declaration-specifiers
opt
let pattern-initializer-list
pattern-initializer-list ! pattern-initializer pattern-initializer , pattern-initializer-list
pattern-initializer ! pattern initializer
opt
initializer ! = expression
Variable Declaration
A variable declaration introduces a variable named value into your program and is declared using the keyword var.
Variable declarations have several forms that declare different kinds of named, mutable values, including stored and
computed variables and properties, stored variable and property observers, and static variable properties. The
appropriate form to use depends on the scope at which the variable is declared and the kind of variable you intend
to declare.
|
N OT E
You can also declare properties in the context of a protocol declaration, as described in Protocol Property
Declaration.
You can override a property in a subclass by prefixing the subclasss property declaration with the override
keyword, as described in Overriding.
Stored Variables and Stored Variable Properties
The following form declares a stored variable or stored variable property:
var variable name : type = expression
You define this form of a variable declaration at global scope, the local scope of a function, or in the context of a
class or structure declaration. When a variable declaration of this form is declared at global scope or the local scope
of a function, it is referred to as a stored variable. When it is declared in the context of a class or structure
declaration, it is referred to as a stored variable property.
The initializer expression cant be present in a protocol declaration, but in all other contexts, the initializer expression
is optional. That said, if no initializer expression is present, the variable declaration must include an explicit type
annotation (: type).
As with constant declarations, if the variable name is a tuple pattern, the name of each item in the tuple is bound to
the corresponding value in the initializer expression.
As their names suggest, the value of a stored variable or a stored variable property is stored in memory.
Computed Variables and Computed Properties
The following form declares a computed variable or computed property:
var variable name : type {
get {
statements
}
set( setter name ) {
statements
}
}
You define this form of a variable declaration at global scope, the local scope of a function, or in the context of a
class, structure, enumeration, or extension declaration. When a variable declaration of this form is declared at global
scope or the local scope of a function, it is referred to as a computed variable. When it is declared in the context of a
class, structure, or extension declaration, it is referred to as a computed property.
The getter is used to read the value, and the setter is used to write the value. The setter clause is optional, and
when only a getter is needed, you can omit both clauses and simply return the requested value directly, as
described in Read-Only Computed Properties. But if you provide a setter clause, you must also provide a getter
clause.
The setter name and enclosing parentheses is optional. If you provide a setter name, it is used as the name of the
parameter to the setter. If you do not provide a setter name, the default parameter name to the setter is newValue,
as described in Shorthand Setter Declaration.
Unlike stored named values and stored variable properties, the value of a computed named value or a computed
property is not stored in memory.
For more information and to see examples of computed properties, see Computed Properties.
Stored Variable Observers and Property Observers
You can also declare a stored variable or property with willSet and didSet observers. A stored variable or
property declared with observers has the following form:
var variable name : type = expression {
willSet( setter name ) {
statements
}
didSet( setter name {
statements
}
}
You define this form of a variable declaration at global scope, the local scope of a function, or in the context of a
class or structure declaration. When a variable declaration of this form is declared at global scope or the local scope
of a function, the observers are referred to as stored variable observers. When it is declared in the context of a
class or structure declaration, the observers are referred to as property observers.
You can add property observers to any stored property. You can also add property observers to any inherited
property (whether stored or computed) by overriding the property within a subclass, as described in Overriding
Property Observers.
The initializer expression is optional in the context of a class or structure declaration, but required elsewhere. The
type annotation is required in all variable declarations that include observers, regardless of the context in which they
are declared.
The willSet and didSet observers provide a way to observe (and to respond appropriately) when the value of a
variable or property is being set. The observers are not called when the variable or property is first initialized.
Instead, they are called only when the value is set outside of an initialization context.
A willSet observer is called just before the value of the variable or property is set. The new value is passed to the
willSet observer as a constant, and therefore it cant be changed in the implementation of the willSet clause.
The didSet observer is called immediately after the new value is set. In contrast to the willSet observer, the old
value of the variable or property is passed to the didSet observer in case you still need access to it. That said, if
you assign a value to a variable or property within its own didSet observer clause, that new value that you assign
will replace the one that was just set and passed to the willSet observer.
The setter name and enclosing parentheses in the willSet and didSet clauses are optional. If you provide setter
names, they are used as the parameter names to the willSet and didSet observers. If you do not provide setter
names, the default parameter name to the willSet observer is newValue and the default parameter name to the
didSet observer is oldValue.
The didSet clause is optional when you provide a willSet clause. Likewise, the willSet clause is optional when
you provide a didSet clause.
For more information and to see an example of how to use property observers, see Property Observers.
Class and Static Variable Properties
To declare a class computed property, mark the declaration with the class keyword. To declare a static variable
property, mark the declaration with the static keyword. Class and static properties are discussed in Type
Properties.
GR A M M A R OF A VA R I A B L E D E C L A R AT I ON
variable-declaration ! variable-declaration-head pattern-initializer-list
variable-declaration ! variable-declaration-head variable-name type-annotation code-block
variable-declaration ! variable-declaration-head variable-name type-annotation getter-setter-block
variable-declaration ! variable-declaration-head variable-name type-annotation getter-setter-keyword-
block
variable-declaration ! variable-declaration-head variable-name type-annotation initializer
opt
willSet-
didSet-block
variable-declaration-head ! attributes
opt
declaration-specifiers
opt
var
variable-name ! identifier
getter-setter-block ! { getter-clause setter-clause
opt
}
getter-setter-block ! { setter-clause getter-clause }
getter-clause ! attributes
opt
get code-block
setter-clause ! attributes
opt
set setter-name
opt
code-block
setter-name ! ( identifier )
getter-setter-keyword-block ! { getter-keyword-clause setter-keyword-clause
opt
}
getter-setter-keyword-block ! { setter-keyword-clause getter-keyword-clause }
getter-keyword-clause ! attributes
opt
get
setter-keyword-clause ! attributes
opt
set
willSet-didSet-block ! { willSet-clause didSet-clause
opt
}
willSet-didSet-block ! { didSet-clause willSet-clause }
willSet-clause ! attributes
opt
willSet setter-name
opt
code-block
didSet-clause ! attributes
opt
didSet setter-name
opt
code-block
Type Alias Declaration
A type alias declaration introduces a named alias of an existing type into your program. Type alias declarations
begin with the keyword typealias and have the following form:
typealias name = existing type
After a type alias is declared, the aliased name can be used instead of the existing type everywhere in your
program. The existing type can be a named type or a compound type. Type aliases do not create new types; they
simply allow a name to refer to an existing type.
See also Protocol Associated Type Declaration.
GR A M M A R OF A T Y P E A L I A S D E C L A R AT I ON
typealias-declaration ! typealias-head typealias-assignment
typealias-head ! typealias typealias-name
typealias-name ! identifier
typealias-assignment ! = type
Function Declaration
A :newTerm`function declaration` introduces a function or method into your program. A function declared in the
context of class, structure, enumeration, or protocol is referred to as a method. Function declarations are declared
using the keyword func and have the following form:
func function name ( parameters ) -> return type {
statements
}
If the function has a return type of Void, the return type can be omitted as follows:
func function name ( parameters ) {
statements
}
The type of each parameter must be includedit cant be inferred. By default, the parameters to a function are
constants. Write var in front of a parameters name to make it a variable, scoping any changes made to the variable
just to the function body, or write inout to make those changes also apply to the argument that was passed in the
callers scope. For a discussion of in-out parameters, see In-Out Parameters.
Functions can return multiple values using a tuple type as the return type of the function.
A function definition can appear inside another function declaration. This kind of function is known as a nested
function. For a discussion of nested functions, see Nested Functions.
Parameter Names
Function parameters are a comma separated list where each parameter has one of several forms. The order of
arguments in a function call must match the order of parameters in the functions declaration. The simplest entry in a
parameter list has the following form:
parameter name : parameter type
For function parameters, the parameter name is used within the function body, but is not used when calling the
function. For method parameters, the parameter name is used as within the function body, and is also used as a
label for the argument when calling the method. The name of a methods first parameter is used only within the
function body, like the parameter of a function. For example:
1 func f(x: Int, y: String) -> String {
2 return y + String(x)
3 }
4 f(7, "hello") // x and y have no name
5
6 class C {
7 func f(x: Int, y: String) -> String {
8 return y + String(x)
9 }
10 }
11 let c = C()
12 c.f(7, y: "hello") // x has no name, y has a name
You can override the default behavior for how parameter names are used with one of the following forms:
external parameter name local parameter name : parameter type
# parameter name : parameter type
_ local parameter name : parameter type
A second name before the local parameter name gives the parameter an external name, which can be different than
the local parameter name. The external parameter name must be used when the function is called. The
corresponding argument must have the external name in function or method calls.
A hash symbol (#) before a parameter name indicates that the name should be used as both an external and a local
parameter name. It has the same meaning as writing the local parameter name twice. The corresponding argument
must have this name in function or method calls.
An underscore (_) before a local parameter name gives that parameter no name to be used in function calls. The
corresponding argument must have no name in function or method calls.
Special Kinds of Parameters
Parameters can be ignored, take a variable number of values, and provide default values using the following forms:
_ : <#parameter type#.
parameter name : parameter type ...
parameter name : parameter type = default argument value
A parameter named with an underscore (_) is explicitly ignored an cant be accessed within the body of the function.
A parameter with a base type name followed immediately by three dots (...) is understood as a variadic parameter.
A function can have at most one variadic parameter, which must be its last parameter. A variadic parameter is
treated as an array that contains elements of the base type name. For instance, the variadic parameter Int... is
treated as Int[]. For an example that uses a variadic parameter, see Variadic Parameters.
A parameter with an equals sign (=) and an expression after its type is understood to have a default value of the
given expression. If the parameter is omitted when calling the function, the default value is used instead. If the
parameter is not omitted, it must have its name in the function call. For example, f() and f(x: 7) are both valid
calls to a function with a single default parameter named x, but f(7) is invalid because it provides a value without a
name.
Special Kinds of Methods
Methods on an enumeration or a structure that modify self must be marked with the mutating keyword at the start
of the function declaration.
Methods that override a superclass method must be marked with the override keyword at the start of the function
declaration. It is an error to override a method without the override keyword or to use the override keyword on a
method that doesnt override a superclass method.
Methods associated with a type rather than an instance of a type must be marked with the static attribute for
enumerations and structures or the class attribute for classes.
Curried Functions and Methods
Curried functions and methods have the following form:
func function name ( parameters )( parameters ) -> return type {
statements
}
A function declared this way is understood as a function whose return type is another function. For example, the
following two declarations are equivalent:
1 func addTwoNumbers(a: Int)(b: Int) -> Int {
2 return a + b
3 }
4 func addTwoNumbers(a: Int) -> (Int -> Int) {
5 func addTheSecondNumber(b: Int) -> Int {
6 return a + b
7 }
8 return addTheSecondNumber
9 }
10
11 addTwoNumbers(4)(5) // Returns 9
Multiple levels of currying are allowed.
GR A M M A R OF A F U N C T I ON D E C L A R AT I ON
function-declaration ! function-head function-name generic-parameter-clause
opt
function-
signature function-body
function-head ! attributes
opt
declaration-specifiers
opt
func
function-name ! identifier operator
function-signature ! parameter-clauses function-result
opt
function-result ! -> attributes
opt
type
function-body ! code-block
parameter-clauses ! parameter-clause parameter-clauses
opt
parameter-clause ! ( ) ( parameter-list ...
opt
)
parameter-list ! parameter parameter , parameter-list
|
|
|
parameter ! inout
opt
let
opt
#
opt
parameter-name local-parameter-name
opt
type-
annotation default-argument-clause
opt
parameter ! inout
opt
var #
opt
parameter-name local-parameter-name
opt
type-annotation default-
argument-clause
opt
parameter ! attributes
opt
type
parameter-name ! identifier _
local-parameter-name ! identifier _
default-argument-clause ! = expression
Enumeration Declaration
An enumeration declaration introduces a named enumeration type into your program.
Enumeration declarations have two basic forms and are declared using the keyword enum. The body of an
enumeration declared using either form contains zero or more valuescalled enumeration casesand any number
of declarations, including computed properties, instance methods, static methods, initializers, type aliases, and even
other enumeration, structure, and class declarations. Enumeration declarations cant contain destructor or protocol
declarations.
Unlike classes and structures, enumeration types do not have an implicitly provided default initializer; all initializers
must be declared explicitly. Initializers can delegate to other initializers in the enumeration, but the initialization
process is complete only after an initializer assigns one of the enumeration cases to self.
Like structures but unlike classes, enumerations are value types; instances of an enumeration are copied when
assigned to variables or constants, or when passed as arguments to a function call. For information about value
types, see Structures and Enumerations Are Value Types.
You can extend the behavior of an enumeration type with an extension declaration, as discussed in Extension
Declaration.
Enumerations with Cases of Any Type
The following form declares an enumeration type that contains enumeration cases of any type:
enum enumeration name {
case enumeration case 1
case enumeration case 2 ( associated value types )
}
Enumerations declared in this form are sometimes called discriminated unions in other programming languages.
In this form, each case block consists of the keyword case followed by one or more enumeration cases, separated
by commas. The name of each case must be unique. Each case can also specify that it stores values of a given
type. These types are specified in the associated value types tuple, immediately following the name of the case. For
|
|
more information and to see examples of cases with associated value types, see Associated Values.
Enumerations with Raw Cases Values
The following form declares an enumeration type that contains enumeration cases of the same basic type:
enum enumeration name : raw value type {
case enumeration case 1 = raw value 1
case enumeration case 2 = raw value 2
}
In this form, each case block consists of the keyword case, followed by one or more enumeration cases, separated
by commas. Unlike the cases in the first form, each case has an underlying value, called a raw value, of the same
basic type. The type of these values is specified in the raw value type and must represent a literal integer, floating-
point number, character, or string.
Each case must have a unique name and be assigned a unique raw value. If the raw value type is specified as Int
and you dont assign a value to the cases explicitly, they are implicitly assigned the values 0, 1, 2, and so on. Each
unassigned case of type Int is implicitly assigned a raw value that is automatically incremented from the raw value
of the previous case.
1 enum ExampleEnum: Int {
2 case A, B, C = 5, D
3 }
In the above example, the value of ExampleEnum.A is 0 and the value of ExampleEnum.B is 1. And because the
value of ExampleEnum.C is explicitly set to 5, the value of ExampleEnum.D is automatically incremented from 5 and
is therefore 6.
The raw value of an enumeration case can be accessed by calling its toRaw method, as in
ExampleEnum.B.toRaw(). You can also use a raw value to find a corresponding case, if there is one, by calling the
fromRaw method, which returns an optional case. For more information and to see examples of cases with raw
value types, see Raw Values.
Accessing Enumeration Cases
To reference the case of an enumeration type, use dot (.) syntax, as in EnumerationType.EnumerationCase.
When the enumeration type can be inferred from context, you can omit it (the dot is still required), as described in
Enumeration Syntax and Implicit Member Expression.
To check the values of enumeration cases, use a switch statement, as shown in Matching Enumeration Values
with a Switch Statement. The enumeration type is pattern-matched against the enumeration case patterns in the
case blocks of the switch statement, as described in Enumeration Case Pattern.
GR A M M A R OF A N E N U M E R AT I ON D E C L A R AT I ON
enum-declaration ! attributes
opt
union-style-enum attributes
opt
raw-value-style-enum
union-style-enum ! enum-name generic-parameter-clause
opt
{ union-style-enum-members
opt
}
union-style-enum-members ! union-style-enum-member union-style-enum-members
opt
union-style-enum-member ! declaration union-style-enum-case-clause
union-style-enum-case-clause ! attributes
opt
case union-style-enum-case-list
union-style-enum-case-list ! union-style-enum-case union-style-enum-case , union-style-enum-
case-list
union-style-enum-case ! enum-case-name tuple-type
opt
enum-name ! identifier
enum-case-name ! identifier
raw-value-style-enum ! enum-name generic-parameter-clause
opt
: type-identifier { raw-value-style-
enum-members
opt
}
raw-value-style-enum-members ! raw-value-style-enum-member raw-value-style-enum-members
opt
raw-value-style-enum-member ! declaration raw-value-style-enum-case-clause
raw-value-style-enum-case-clause ! attributes
opt
case raw-value-style-enum-case-list
raw-value-style-enum-case-list ! raw-value-style-enum-case raw-value-style-enum-case , raw-
value-style-enum-case-list
raw-value-style-enum-case ! enum-case-name raw-value-assignment
opt
raw-value-assignment ! = literal
Structure Declaration
A structure declaration introduces a named structure type into your program. Structure declarations are declared
using the keyword struct and have the following form:
struct structure name : adopted protocols {
declarations
}
The body of a structure contains zero or more declarations. These declarations can include both stored and
computed properties, static properties, instance methods, static methods, initializers, type aliases, and even other
structure, class, and enumeration declarations. Structure declarations cant contain destructor or protocol
declarations. For a discussion and several examples of structures that include various kinds of declarations, see
Classes and Structures.
Structure types can adopt any number of protocols, but cant inherit from classes, enumerations, or other
structures.
There are three ways create an instance of a previously declared structure:
|
|
|
|
|
Call one of the initializers declared within the structure, as described in Initializers.
If no initializers are declared, call the structures memberwise initializer, as described in Memberwise
Initializers for Structure Types.
Although properties and methods declared in the superclass are inherited by the current class, designated
initializers declared in the superclass are not. That said, if the current class overrides all of the superclasss
designated initializers, it inherits the superclasss convenience initializers. Swift classes do not inherit from a
universal base class.
There are two ways create an instance of a previously declared class:
Access properties of a class instance with dot (.) syntax, as described in Accessing Properties.
Classes are reference types; instances of a class are referred to, rather than copied, when assigned to variables or
constants, or when passed as arguments to a function call. For information about reference types, see Structures
and Enumerations Are Value Types.
You can extend the behavior of a class type with an extension declaration, as discussed in Extension Declaration.
GR A M M A R OF A C L A S S D E C L A R AT I ON
class-declaration ! attributes
opt
class class-name generic-parameter-clause
opt
type-inheritance-
clause
opt
class-body
class-name ! identifier
class-body ! { declarations
opt
}
Protocol Declaration
A protocol declaration introduces a named protocol type into your program. Protocol declarations are declared using
the keyword protocol and have the following form:
protocol protocol name : inherited protocols {
protocol member declarations
}
The body of a protocol contains zero or more protocol member declarations, which describe the conformance
requirements that any type adopting the protocol must fulfill. In particular, a protocol can declare that conforming
types must implement certain properties, methods, initializers, and subscripts. Protocols can also declare special
kinds of type aliases, called associated types, that can specify relationships among the various declarations of the
protocol. The protocol member declarations are discussed in detail below.
Protocol types can inherit from any number of other protocols. When a protocol type inherits from other protocols,
the set of requirements from those other protocols are aggregated, and any type that inherits from the current
protocol must conform to all those requirements. For an example of how to use protocol inheritance, see Protocol
Inheritance.
Call one of the initializers declared within the class, as described in Initializers.
If no initializers are declared, and all properties of the class declaration were given initial values, call the
classs default initializer, as described in Default Initializers.
N OT E
You can also aggregate the conformance requirements of multiple protocols using protocol composition
types, as described in Protocol Composition Type and Protocol Composition.
You can add protocol conformance to a previously declared type by adopting the protocol in an extension
declaration of that type. In the extension, you must implement all of the adopted protocols requirements. If the type
already implements all of the requirements, you can leave the body of the extension declaration empty.
By default, types that conform to a protocol must implement all properties, methods, and subscripts declared in the
protocol. That said, you can mark these protocol member declarations with the optional attribute to specify that
their implementation by a conforming type is optional. The optional attribute can be applied only to protocols that
are marked with the objc attribute. As a result, only class types can adopt and conform to a protocol that contains
optional member requirements. For more information about how to use the optional attribute and for guidance
about how to access optional protocol membersfor example, when youre not sure whether a conforming type
implements themsee Optional Protocol Requirements.
To restrict the adoption of a protocol to class types only, mark the entire protocol declaration with the
class_protocol attribute. Any protocol that inherits from a protocol marked with the class_protocol attribute can
likewise be adopted only by a class type.
N OT E
If a protocol is already marked with the objc attribute, the class_protocol attribute is implicitly applied to that
protocol; theres no need to mark the protocol with the class_protocol attribute explicitly.
Protocols are named types, and thus they can appear in all the same places in your code as other named types, as
discussed in Protocols as Types. However, you cant construct an instance of a protocol, because protocols do not
actually provide the implementations for the requirements they specify.
You can use protocols to declare which methods a delegate of a class or structure should implement, as described
in Delegation.
GR A M M A R OF A P R OT OC OL D E C L A R AT I ON
protocol-declaration ! attributes
opt
protocol protocol-name type-inheritance-clause
opt
protocol-body
protocol-name ! identifier
protocol-body ! { protocol-member-declarations
opt
}
protocol-member-declaration ! protocol-property-declaration
protocol-member-declaration ! protocol-method-declaration
protocol-member-declaration ! protocol-initializer-declaration
protocol-member-declaration ! protocol-subscript-declaration
protocol-member-declaration ! protocol-associated-type-declaration
protocol-member-declarations ! protocol-member-declaration protocol-member-declarations
opt
Protocol Property Declaration
Protocols declare that conforming types must implement a property by including a protocol property declaration in
the body of the protocol declaration. Protocol property declarations have a special form of a variable declaration:
var property name : type { get set }
As with other protocol member declarations, these property declarations declare only the getter and setter
requirements for types that conform to the protocol. As a result, you dont implement the getter or setter directly in
the protocol in which it is declared.
The getter and setter requirements can be satisfied by a conforming type in a variety of ways. If a property
declaration includes both the get and set keywords, a conforming type can implement it with a stored variable
property or a computed property that is both readable and writeable (that is, one that implements both a getter and a
setter). However, that property declaration cant be implemented as a constant property or a read-only computed
property. If a property declaration includes only the get keyword, it can be implemented as any kind of property.
For examples of conforming types that implement the property requirements of a protocol, see Property
Requirements.
See also Variable Declaration.
GR A M M A R OF A P R OT OC OL P R OP E R T Y D E C L A R AT I ON
protocol-property-declaration ! variable-declaration-head variable-name type-annotation getter-setter-
keyword-block
Protocol Method Declaration
Protocols declare that conforming types must implement a method by including a protocol method declaration in the
body of the protocol declaration. Protocol method declarations have the same form as function declarations, with
two exceptions: They dont include a function body, and you cant provide any default parameter values as part of
the function declaration. For examples of conforming types that implement the method requirements of a protocol,
see Method Requirements.
To declare a class or static method requirement in a protocol declaration, mark the method declaration with the
class keyword. Classes that implement this method also declare the method with the class keyword. Structures
that implement it must declare the method with the static keyword instead. If youre implementing the method in an
extension, use the class keyword if youre extending a class and the static keyword if youre extending a
structure.
See also Function Declaration.
GR A M M A R OF A P R OT OC OL M E T H OD D E C L A R AT I ON
protocol-method-declaration ! function-head function-name generic-parameter-clause
opt
function-
signature
Protocol Initializer Declaration
Protocols declare that conforming types must implement an initializer by including a protocol initializer declaration in
the body of the protocol declaration. Protocol initializer declarations have the same form as initializer declarations,
except they dont include the initializers body.
See also Initializer Declaration.
GR A M M A R OF A P R OT OC OL I N I T I A L I Z E R D E C L A R AT I ON
protocol-initializer-declaration ! initializer-head generic-parameter-clause
opt
parameter-clause
Protocol Subscript Declaration
Protocols declare that conforming types must implement a subscript by including a protocol subscript declaration in
the body of the protocol declaration. Protocol property declarations have a special form of a subscript declaration:
subscript ( parameters ) -> return type { get set }
Subscript declarations only declare the minimum getter and setter implementation requirements for types that
conform to the protocol. If the subscript declaration includes both the get and set keywords, a conforming type
must implement both a getter and a setter clause. If the subscript declaration includes only the get keyword, a
conforming type must implement at least a getter clause and optionally can implement a setter clause.
See also Subscript Declaration.
GR A M M A R OF A P R OT OC OL S U B S C R I P T D E C L A R AT I ON
protocol-subscript-declaration ! subscript-head subscript-result getter-setter-keyword-block
Protocol Associated Type Declaration
Protocols declare associated types using the keyword typealias. An associated type provides an alias for a type
that is used as part of a protocols declaration. Accosiated types are similiar to type paramters in generic parameter
clauses, but theyre associated with Self in the protocol in which theyre declared. In that context, Self refers to
the eventual type that conforms to the protocol. For more information and examples, see Associated Types.
See also Type Alias Declaration.
GR A M M A R OF A P R OT OC OL A S S OC I AT E D T Y P E D E C L A R AT I ON
protocol-associated-type-declaration ! typealias-head type-inheritance-clause
opt
typealias-
assignment
opt
Initializer Declaration
An initializer declaration introduces an initializer for a class, structure, or enumeration into your program. Initializer
declarations are declared using the keyword init and have two basic forms.
Structure, enumeration, and class types can have any number of initializers, but the rules and associated behavior
for class initializers are different. Unlike structures and enumerations, classes have two kinds of initializers:
designated initializers and convenience initializers, as described in Initialization.
The following form declares initializers for structures, enumerations, and designated initializers of classes:
init( parameters ) {
statements
}
A designated initializer of a class initializes all of the classs properties directly. It cant call any other initializers of the
same class, and if the class has a superclass, it must call one of the superclasss designated initializers. If the class
inherits any properties from its superclass, one of the superclasss designated initializers must be called before any
of these properties can be set or modified in the current class.
Designated initializers can be declared in the context of a class declaration only and therefore cant be added to a
class using an extension declaration.
Initializers in structures and enumerations can call other declared initializers to delegate part or all of the initialization
process.
To declare convenience initializers for a class, prefix the initializer declaration with the context-sensitive keyword
convenience.
convenience init( parameters ) {
statements
}
Convenience initializers can delegate the initialization process to another convenience initializer or to one of the
classs designated initializers. That said, the initialization processes must end with a call to a designated initializer
that ultimately initializes the classs properties. Convenience initializers cant call a superclasss initializers.
You can mark designated and convenience initializers with the required attribute to require that every subclass
implement the initializer. Because designated initializers are not inherited by subclasses, they must be implemented
directly. Required convenience initializers can be either implemented explicitly or inherited when the subclass
directly implements all of the superclasss designated initializers (or overrides the designated initializers with
convenience initializers). Unlike methods, properties, and subscripts, you dont need to mark overridden initializers
with the override keyword.
To see examples of initializers in various type declarations, see Initialization.
GR A M M A R OF A N I N I T I A L I Z E R D E C L A R AT I ON
initializer-declaration ! initializer-head generic-parameter-clause
opt
parameter-clause initializer-body
initializer-head ! attributes
opt
convenience
opt
init
initializer-body ! code-block
Deinitializer Declaration
A deinitializer declaration declares a deinitializer for a class type. Deinitializers take no parameters and have the
following form:
deinit {
statements
}
A deinitializer is called automatically when there are no longer any references to a class object, just before the class
object is deallocated. A deinitializer can be declared only in the body of a class declarationbut not in an extension
of a classand each class can have at most one.
A subclass inherits its superclasss deinitializer, which is implicitly called just before the subclass object is
deallocated. The subclass object is not deallocated until all deinitializers in its inheritance chain have finished
executing.
Deinitializers are not called directly.
For an example of how to use a deinitializer in a class declaration, see Deinitialization.
GR A M M A R OF A D E I N I T I A L I Z E R D E C L A R AT I ON
deinitializer-declaration ! attributes
opt
deinit code-block
Extension Declaration
An extension declaration allows you to extend the behavior of existing class, structure, and enumeration types.
Extension declarations begin with the keyword extension and have the following form:
extension type : adopted protocols {
declarations
}
The body of an extension declaration contains zero or more declarations. These declarations can include computed
properties, computed static properties, instance methods, static and class methods, initializers, subscript
declarations, and even class, structure, and enumeration declarations. Extension declarations cant contain
destructor or protocol declarations, store properties, property observers, or other extension declarations. For a
discussion and several examples of extensions that include various kinds of declarations, see Extensions.
Extension declarations can add protocol conformance to an existing class, structure, and enumeration type in the
adopted protocols. Extension declarations cant add class inheritance to an existing class, and therefore the type-
inheritance-clause in an extension declaration contains only a list of protocols.
Properties, methods, and initializers of an existing type cant be overridden in an extension of that type.
Extension declarations can contain initializer declarations. That said, if the type youre extending is defined in
another module, an initializer declaration must delegate to an initializer already defined in that module to ensure
members of that type are properly initialized.
GR A M M A R OF A N E X T E N S I ON D E C L A R AT I ON
extension-declaration ! extension type-identifier type-inheritance-clause
opt
extension-body
extension-body ! { declarations
opt
}
Subscript Declaration
A subscript declaration allows you to add subscripting support for objects of a particular type and are typically used
to provide a convenient syntax for accessing the elements in a collection, list, or sequence. Subscript declarations
are declared using the keyword subscript and have the following form:
subscript ( parameters ) -> return type {
get {
statements
}
set( setter name ) {
statements
}
}
Subscript declarations can appear only in the context of a class, structure, enumeration, extension, or protocol
declaration.
The parameters specify one or more indexes used to access elements of the corresponding type in a subscript
expression (for example, the i in the expression object[i]). Although the indexes used to access the elements
can be of any type, each parameter must include a type annotation to specify the type of each index. The return
type specifies the type of the element being accessed.
As with computed properties, subscript declarations support reading and writing the value of the accessed
elements. The getter is used to read the value, and the setter is used to write the value. The setter clause is
optional, and when only a getter is needed, you can omit both clauses and simply return the requested value
directly. That said, if you provide a setter clause, you must also provide a getter clause.
The setter name and enclosing parentheses are optional. If you provide a setter name, it is used as the name of the
parameter to the setter. If you do not provide a setter name, the default parameter name to the setter is value. That
type of the setter name must be the same as the return type.
You can overload a subscript declaration in the type in which it is declared, as long as the parameters or the return
type differ from the one youre overloading. You can also override a subscript declaration inherited from a
superclass. When you do so, you must mark the overridden subscript declaration with the override keyword.
You can also declare subscripts in the context of a protocol declaration, as described in Protocol Subscript
Declaration.
For more information about subscripting and to see examples of subscript declarations, see Subscripts.
GR A M M A R OF A S U B S C R I P T D E C L A R AT I ON
subscript-declaration ! subscript-head subscript-result code-block
subscript-declaration ! subscript-head subscript-result getter-setter-block
subscript-declaration ! subscript-head subscript-result getter-setter-keyword-block
subscript-head ! attributes
opt
subscript parameter-clause
subscript-result ! -> attributes
opt
type
Operator Declaration
An operator declaration introduces a new infix, prefix, or postfix operator into your program and is declared using
the contextual keyword operator.
You can declare operators of three different fixities: infix, prefix, and postfix. The fixity of an operator specifies the
relative position of an operator to its operands.
There are three basic forms of an operator declaration, one for each fixity. The fixity of the operator is specified by
including the contextual keyword infix, prefix, or postfix between operator and the name of the operator. In
each form, the name of the operator can contain only the operator characters defined in Operators.
The following form declares a new infix operator:
operator infix operator name {
precedence precedence level
associativity associativity
}
An infix operator is a binary operator that is written between its two operands, such as the familiar addition operator
(+) in the expression 1 + 2.
Infix operators can optionally specify a precedence, associativity, or both.
The precedence of an operator specifies how tightly an operator binds to its operands in the absence of grouping
parentheses. You specify the precedence of an operator by writing the contextual keyword precedence followed by
the precedence level. The precedence level can be any whole number (decimal integer) from 0 to 255; unlike
decimal integer literals, it cant contain any underscore characters. Although the precedence level is a specific
number, it is significant only relative to another operator. That is, when two operators compete with each other for
their operands, such as in the expression 2 + 3 * 5, the operator with the higher precedence level binds more
tightly to its operands.
The associativity of an operator specifies how a sequence of operators with the same precedence level are
grouped together in the absence of grouping parentheses. You specify the associativity of an operator by writing the
contextual keyword associativity followed by the associativity, which is one of the contextual keywords left,
right, or none. Operators that are left-associative group left-to-right. For example, the subtraction operator (-) is
left-associative, and therefore the expression 4 - 5 - 6 is grouped as (4 - 5) - 6 and evaluates to -7.
Operators that are right-associative group right-to-left, and operators that are specified with an associativity of none
dont associate at all. Nonassociative operators of the same precedence level cant appear adjacent to each to
other. For example, 1 < 2 < 3 is not a valid expression.
Infix operators that are declared without specifying a precedence or associativity are initialized with a precedence
level of 100 and an associativity of none.
The following form declares a new prefix operator:
operator prefix operator name {}
A prefix operator is a unary operator that is written immediately before its operand, such as the prefix increment
operator (++) is in the expression ++i.
Prefix operators declarations dont specify a precedence level. Prefix operators are nonassociative.
The following form declares a new postfix operator:
operator postfix operator name {}
A postfix operator is a unary operator that is written immediately after its operand, such as the postfix increment
operator (++) is in the expression i++.
As with prefix operators, postfix operator declarations dont specify a precedence level. Postfix operators are
nonassociative.
After declaring a new operator, you implement it by declaring a function that has the same name as the operator. To
see an example of how to create and implement a new operator, see Custom Operators.
GR A M M A R OF A N OP E R AT OR D E C L A R AT I ON
operator-declaration ! prefix-operator-declaration postfix-operator-declaration infix-operator- | |
declaration
prefix-operator-declaration ! operator prefix operator { }
postfix-operator-declaration ! operator postfix operator { }
infix-operator-declaration ! operator infix operator { infix-operator-attributes
opt
}
infix-operator-attributes ! precedence-clause
opt
associativity-clause
opt
precedence-clause ! precedence precedence-level
precedence-level ! Digit 0 through 255
associativity-clause ! associativity associativity
associativity ! left right none | |
Attributes
Attributes provide more information about a declaration or type. There are two kinds of attributes in Swift, those that
apply to declarations and those that apply to types. For instance, the required attributewhen applied to a
designated or convenience initializer declaration of a classindicates that every subclass must implement that
initializer. And the noreturn attributewhen applied to a function or method typeindicates that the function or
method doesnt return to its caller.
You specify an attribute by writing the @ symbol followed by the attributes name and any arguments that the
attribute accepts:
@ attribute name
@ attribute name ( attribute arguments )
Some declaration attributes accept arguments that specify more information about the attribute and how it applies to
a particular declaration. These attribute arguments are enclosed in parentheses, and their format is defined by the
attribute they belong to.
Declaration Attributes
You can apply a declaration attribute to declarations only. However, you can also apply the noreturn attribute to a
function or method type.
Apply this attribute to functions that overload a compound assignment operator. Functions that overload a
compound assignment operator must mark their initial input parameter as inout. For an example of how to
use the assignment attribute, see Compound Assignment Operators.
Apply this attribute to a protocol to indicate that the protocol can be adopted by class types only.
If you apply the objc attribute to a protocol, the class_protocol attribute is implicitly applied to that
protocol; theres no need to mark the protocol with the class_protocol attribute explicitly.
Apply this attribute to an import declaration to export the imported module, submodule, or declaration from
the current module. If another module imports the current module, that other module can access the items
exported by the current module.
Apply this attribute to a class or to a property, method, or subscript member of a class. Its applied to a
class to indicate that the class cant be subclassed. Its applied to a property, method, or subscript of a
class to indicate that that class member cant be overridden in any subclass.
assignment
class_protocol
exported
final
Apply this attribute to a stored variable property of a class or structure to indicate that the propertys initial
value is calculated and stored at most once, when the property is first accessed. For an example of how to
use the lazy attribute, see Lazy Stored Properties.
Apply this attribute to a function or method declaration to indicate that the corresponding type of that
function or method, T, is @noreturn T. You can mark a function or method type with this attribute to
indicate that the function or method doesnt return to its caller.
You can override a function or method that is not marked with the noreturn attribute with a function or
method that is. That said, you cant override a function or method that is marked with the noreturn attribute
with a function or method that is not. Similar rules apply when you implement a protocol method in a
conforming type.
Apply this attribute to a stored variable property of a class. This attribute causes the propertys setter to be
synthesized with a copy of the propertys valuereturned by the copyWithZone methodinstead of the
value of the property itself. The type of the property must conform to the NSCopying protocol.
The NSCopying attribute behaves in a way similar to the Objective-C copy property attribute.
Apply this attribute to a stored variable property of a class that inherits from NSManagedObject to indicate
that the storage and implementation of the property are provided dynamically by Core Data at runtime
based on the associated entity description.
Apply this attribute to any declaration that can be represented in Objective-Cfor example, non-nested
classes, protocols, properties and methods (including getters and setters) of classes and protocols,
initializers, deinitializers, and subscripts. The objc attribute tells the compiler that a declaration is available
to use in Objective-C code.
If you apply the objc attribute to a class or protocol, its implicitly applied to the members of that class or
protocol. The compiler also implicitly adds the objc attribute to a class that inherits from another class
marked with the objc attribute. Protocols marked with the objc attribute cant inherit from protocols that
arent.
The objc attribute optionally accepts a single attribute argument, which consists of an identifier. Use this
attribute when you want to expose a different name to Objective-C for the entity the objc attribute applies
to. You can use this argument to name classes, protocols, methods, getters, setters, and initializers. The
example below exposes the getter for the enabled property of the ExampleClass to Objective-C code as
isEnabled rather than just as the name of the property itself.
1 @objc
2 class ExampleClass {
3 var enabled: Bool {
lazy
noreturn
NSCopying
NSManaged
objc
4 @objc(isEnabled) get {
5 // Return the appropriate value
6 }
7 }
8 }
Apply this attribute to a protocols property, method, or subscript members to indicate that a conforming
type isnt required to implement those members.
You can apply the optional attribute only to protocols that are marked with the objc attribute. As a result,
only class types can adopt and conform to a protocol that contains optional member requirements. For
more information about how to use the optional attribute and for guidance about how to access optional
protocol membersfor example, when youre not sure whether a conforming type implements themsee
Optional Protocol Requirements.
Apply this attribute to a designated or convenience initializer of a class to indicate that every subclass must
implement that initializer.
Required designated initializers must be implemented explicitly. Required convenience initializers can be
either implemented explicitly or inherited when the subclass directly implements all of the superclasss
designated initializers (or when the subclass overrides the designated initializers with convenience
initializers).
Declaration Attributes Used by Interface Builder
Interface Builder attributes are declaration attributes used by Interface Builder to synchronize with Xcode. Swift
provides the following Interface Builder attributes: IBAction, IBDesignable, IBInspectable, and IBOutlet.
These attributes are conceptually the same as their Objective-C counterparts.
You apply the IBOutlet and IBInspectable attributes to property declarations of a class. You apply the IBAction
attribute to method declarations of a class and the IBDesignable attribute to class declarations.
Type Attributes
You can apply type attributes to types only. However, you can also apply the noreturn attribute to a function or
method declaration.
This attribute is used to delay the evaluation of an expression by automatically wrapping that expression in
a closure with no arguments. Apply this attribute to a function or method type that takes no arguments and
that returns the type of the expression. For an example of how to use the auto_closure attribute, see
Function Type.
optional
required
auto_closure
noreturn
Apply this attribute to the type of a function or method to indicate that the function or method doesnt return
to its caller. You can also mark a function or method declaration with this attribute to indicate that the
corresponding type of that function or method, T, is @noreturn T.
GR A M M A R OF A N AT T R I B U T E
attribute ! @ attribute-name attribute-argument-clause
opt
attribute-name ! identifier
attribute-argument-clause ! ( balanced-tokens
opt
)
attributes ! attribute attributes
opt
balanced-tokens ! balanced-token balanced-tokens
opt
balanced-token ! ( balanced-tokens
opt
)
balanced-token ! [ balanced-tokens
opt
]
balanced-token ! { balanced-tokens
opt
}
balanced-token ! Any identifier, keyword, literal, or operator
balanced-token ! Any punctuation except ( , ) , [ , ] , { , or }
noreturn
Patterns
A pattern represents the structure of a single value or a composite value. For example, the structure of a tuple (1,
2) is a comma-separated list of two elements. Because patterns represent the structure of a value rather than any
one particular value, you can match them with a variety of values. For instance, the pattern (x, y) matches the
tuple (1, 2) and any other two-element tuple. In addition matching a pattern with a value, you can extract part or all
of a composite value and bind each part to a constant or variable name.
In Swift, patterns occur in variable and constant declarations (on their left-hand side), in for-in statements, and in
switch statements (in their case labels). Although any pattern can occur in the case labels of a switch statement,
in the other contexts, only wildcard patterns, identifier patterns, and patterns containing those two patterns can
occur.
You can specify a type annotation for a wildcard pattern, an identifier pattern, and a tuple pattern to constraint the
pattern to match only values of a certain type.
GR A M M A R OF A PAT T E R N
pattern ! wildcard-pattern type-annotation
opt
pattern ! identifier-pattern type-annotation
opt
pattern ! value-binding-pattern
pattern ! tuple-pattern type-annotation
opt
pattern ! enum-case-pattern
pattern ! type-casting-pattern
pattern ! expression-pattern
Wildcard Pattern
A wildcard pattern matches and ignores any value and consists of an underscore (_). Use a wildcard pattern when
you dont care about the values being matched against. For example, the following code iterates through the closed
range 1..3, ignoring the current value of the range on each iteration of the loop:
1 for _ in 1...3 {
2 // Do something three times.
3 }
GR A M M A R OF A W I L D C A R D PAT T E R N
wildcard-pattern ! _
Identifier Pattern
An identifier pattern matches any value and binds the matched value to a variable or constant name. For example,
in the following constant declaration, someValue is an identifier pattern that matches the value 42 of type Int:
let someValue = 42
When the match succeeds, the value 42 is bound (assigned) to the constant name someValue.
When the pattern on the left-hand side of a variable or constant declaration is an identifier pattern, the identifier
pattern is implicitly a subpattern of a value-binding pattern.
GR A M M A R OF A N I D E N T I F I E R PAT T E R N
identifier-pattern ! identifier
Value-Binding Pattern
A value-binding pattern binds matched values to variable or constant names. Value-binding patterns that bind a
matched value to the name of a constant begin with the keyword let; those that bind to the name of variable begin
with the keyword var.
Identifiers patterns within a value-binding pattern bind new named variables or constants to their matching values.
For example, you can decompose the elements of a tuple and bind the value of each element to a corresponding
identifier pattern.
1 let point = (3, 2)
2 switch point {
3 // Bind x and y to the elements of point.
4 case let (x, y):
5 println("The point is at (\(x), \(y)).")
6 }
7 // prints "The point is at (3, 2)."
In the example above, let distributes to each identifier pattern in the tuple pattern (x, y). Because of this behavior,
the switch cases case let (x, y): and case (let x, let y): match the same values.
GR A M M A R OF A VA L U E - B I N D I N G PAT T E R N
value-binding-pattern ! var pattern let pattern
Tuple Pattern
A tuple pattern is a comma-separated list of zero or more patterns, enclosed in parentheses. Tuple patterns match
values of corresponding tuple types.
You can constrain a tuple pattern to match certain kinds of tuple types by using type annotations. For example, the
tuple pattern (x, y): (Int, Int) in the constant declaration let (x, y): (Int, Int) = (1, 2) matches only
tuple types in which both elements are of type Int. To constrain only some elements of a tuple pattern, provide type
annotations directly to those individual elements. For example, the tuple pattern in let (x: String, y) matches
|
any two-element tuple type, as long as the first element is of type String.
When a tuple pattern is used as the pattern in a for-in statement or in a variable or constant declaration, it can
contain only wildcard patterns, identifier patterns, or other tuple patterns that contain those. For example, the
following code isnt valid because the element 0 in the tuple pattern (x, 0) is an expression pattern:
1 let points = [(0, 0), (1, 0), (1, 1), (2, 0), (2, 1)]
2 // This code isn't valid.
3 for (x, 0) in points {
4 /* ... */
5 }
The parentheses around a tuple pattern that contains a single element have no effect. The pattern matches values
of that single elements type. For example, the following are equivalent:
1 let a = 2 // a: Int = 2
2 let (a) = 2 // a: Int = 2
3 let (a): Int = 2 // a: Int = 2
GR A M M A R OF A T U P L E PAT T E R N
tuple-pattern ! ( tuple-pattern-element-list
opt
)
tuple-pattern-element-list ! tuple-pattern-element tuple-pattern-element , tuple-pattern-element-list
tuple-pattern-element ! pattern
Enumeration Case Pattern
An enumeration case pattern matches a case of an existing enumeration type. Enumeration case patterns appear
only in switch statement case labels.
If the enumeration case youre trying to match has any associated values, the corresponding enumeration case
pattern must specify a tuple pattern that contains one element for each associated value. For an example that uses
a switch statement to match enumeration cases containing associated values, see Associated Values.
GR A M M A R OF A N E N U M E R AT I ON C A S E PAT T E R N
enum-case-pattern ! type-identifier
opt
. enum-case-name tuple-pattern
opt
Type-Casting Patterns
There are two type-casting patterns, the is pattern and the as pattern. Both type-casting patterns appear only in
switch statement case labels. The is and as patterns have the following form:
is type
|
pattern as type
The is pattern matches a value if the type of that value at runtime is the same as the type specified in the right-hand
side of the is patternor a subclass of that type. The is pattern behaves like the is operator in that they both
perform a type cast but discard the returned type.
The as pattern matches a value if the type of that value at runtime is the same as the type specified in the right-hand
side of the as patternor a subclass of that type. If the match succeeds, the type of the matched value is cast to
the pattern specified in the left-hand side of the as pattern.
For an example that uses a switch statement to match values with is and as patterns, see Type Casting for Any
and AnyObject.
GR A M M A R OF A T Y P E C A S T I N G PAT T E R N
type-casting-pattern ! is-pattern as-pattern
is-pattern ! is type
as-pattern ! pattern as type
Expression Pattern
An expression pattern represents the value of an expression. Expression patterns appear only in switch statement
case labels.
The expression represented by the expression pattern is compared with the value of an input expression using the
Swift standard library ~= operator. The matches succeeds if the ~= operator returns true. By default, the ~=
operator compares two values of the same type using the == operator. It can also match an integer value with a
range of integers in an Range object, as the following example shows:
1 let point = (1, 2)
2 switch point {
3 case (0, 0):
4 println("(0, 0) is at the origin.")
5 case (-2...2, -2...2):
6 println("(\(point.0), \(point.1)) is near the origin.")
7 default:
8 println("The point is at (\(point.0), \(point.1)).")
9 }
10 // prints "(1, 2) is near the origin."
You can overload the ~= operator to provide custom expression matching behavior. For example, you can rewrite
the above example to compare the point expression with a string representations of points.
1 // Overload the ~= operator to match a string with an integer
2 func ~=(pattern: String, value: Int) -> Bool {
|
3 return pattern == "\(value)"
4 }
5 switch point {
6 case ("0", "0"):
7 println("(0, 0) is at the origin.")
8 case ("-2...2", "-2...2"):
9 println("(\(point.0), \(point.1)) is near the origin.")
10 default:
11 println("The point is at (\(point.0), \(point.1)).")
12 }
13 // prints "(1, 2) is near the origin."
GR A M M A R OF A N E X P R E S S I ON PAT T E R N
expression-pattern ! expression
Generic Parameters and Arguments
This chapter describes parameters and arguments for generic types, functions, and initializers. When you declare a
generic type, function, or initializer, you specify the type parameters that the generic type, function, or initializer can
work with. These type parameters act as placeholders that are replaced by actual concrete type arguments when
an instance of a generic type is created or a generic function or initializer is called.
For an overview of generics in Swift, see Generics.
Generic Parameter Clause
A generic parameter clause specifies the type parameters of a generic type or function, along with any associated
constraints and requirements on those parameters. A generic parameter clause is enclosed in angle brackets (<>)
and has one of the following forms:
< generic parameter list >
< generic parameter list where requirements >
The generic parameter list is a comma-separated list of generic parameters, each of which has the following form:
type parameter : constraint
A generic parameter consists of a type parameter followed by an optional constraint. A type parameter is simply the
name of a placeholder type (for instance, T, U, V, KeyType, ValueType, and so on). You have access to the type
parameters (and any of their associated types) in the rest of the type, function, or initializer declaration, including in
the signature of the function or initializer.
The constraint specifies that a type parameter inherits from a specific class or conforms to a protocol or protocol
composition. For instance, in the generic function below, the generic parameter T: Comparable indicates that any
type argument substituted for the type parameter T must conform to the Comparable protocol.
1 func simpleMin<T: Comparable>(x: T, y: T) -> T {
2 if x < y {
3 return y
4 }
5 return x
6 }
Because Int and Double, for example, both conform to the Comparable protocol, this function accepts arguments
of either type. In contrast with generic types, you dont specify a generic argument clause when you use a generic
function or initializer. The type arguments are instead inferred from the type of the arguments passed to the function
or initializer.
1 simpleMin(17, 42) // T is inferred to be Int
2 simpleMin(3.14159, 2.71828) // T is inferred to be Double
Where Clauses
You can specify additional requirements on type parameters and their associated types by including a where clause
after the generic parameter list. A where clause consists of the keyword where, followed by a comma-separated list
of one or more requirements.
The requirements in a where clause specify that a type parameter inherits from a class or conforms to a protocol or
protocol composition. Although the where clause provides syntactic sugar for expressing simple constraints on type
parameters (for instance, T: Comparable is equivalent to T where T: Comparable and so on), you can use it to
provide more complex constraints on type parameters and their associated types. For instance, you can express
the constraints that a generic type T inherits from a class C and conforms to a protocol P as <T where T: C, T:
P>.
As mentioned above, you can constrain the associated types of type parameters to conform to protocols. For
example, the generic parameter clause <T: Generator where T.Element: Equatable> specifies that T
conforms to the Generator protocol and the associated type of T, T.Element, conforms to the Equatable protocol
(T has the associated type Element because Generator declares Element and T conforms to Generator).
You can also specify the requirement that two types be identical, using the == operator. For example, the generic
parameter clause <T: Generator, U: Generator where T.Element == U.Element> expresses the constraints
that T and U conform to the Generator protocol and that their associated types must be identical.
Any type argument substituted for a type parameter must meet all the constraints and requirements placed on the
type parameter.
You can overload a generic function or initializer by providing different constraints, requirements, or both on the type
parameters in the generic parameter clause. When you call an overloaded generic function or initializer, the compiler
uses these constraints to resolve which overloaded function or initializer to invoke.
You can subclass a generic class, but the subclass must also be a generic class.
GR A M M A R OF A GE N E R I C PA R A M E T E R C L A U S E
generic-parameter-clause ! < generic-parameter-list requirement-clause
opt
>
generic-parameter-list ! generic-parameter generic-parameter , generic-parameter-list
generic-parameter ! type-name
generic-parameter ! type-name : type-identifier
generic-parameter ! type-name : protocol-composition-type
requirement-clause ! where requirement-list
requirement-list ! requirement requirement , requirement-list
requirement ! conformance-requirement same-type-requirement
conformance-requirement ! type-identifier : type-identifier
conformance-requirement ! type-identifier : protocol-composition-type
same-type-requirement ! type-identifier == type-identifier
|
|
|
Generic Argument Clause
A generic argument clause specifies the type arguments of a generic type. A generic argument clause is enclosed
in angle brackets (<>) and has the following form:
< generic argument list >
The generic argument list is a comma-separated list of type arguments. A type argument is the name of an actual
concrete type that replaces a corresponding type parameter in the generic parameter clause of a generic type. The
result is a specialized version of that generic type. As an example, the Swift standard library defines a generic
dictionary type as:
1 struct Dictionary<KeyType: Hashable, ValueType>: Collection,
DictionaryLiteralConvertible {
2 /* ... */
3 }
The specialized version of the generic Dictionary type, Dictionary<String, Int> is formed by replacing the
generic parameters KeyType: Hashable and ValueType with the concrete type arguments String and Int. Each
type argument must satisfy all the constraints of the generic parameter it replaces, including any additional
requirements specified in a where clause. In the example above, the KeyType type parameter is constrained to
conform to the Hashable protocol and therefore String must also conform to the Hashable protocol.
You can also replace a type parameter with a type argument that is itself a specialized version of a generic type
(provided it satisfies the appropriate constraints and requirements). For example, you can replace the type
parameter T in Array<T> with a specialized version of an array, Array<Int>, to form an array whose elements are
themselves arrays of integers.
let arrayOfArrays: Array<Array<Int>> = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
As mentioned in Generic Parameter Clause, you dont use a generic argument clause to specify the type arguments
of a generic function or initializer.
GR A M M A R OF A GE N E R I C A R GU M E N T C L A U S E
generic-argument-clause ! < generic-argument-list >
generic-argument-list ! generic-argument generic-argument , generic-argument-list
generic-argument ! type
|
Summary of the Grammar
Statements
GR A M M A R OF A S T AT E M E N T
statement ! expression ;
opt
statement ! declaration ;
opt
statement ! loop-statement ;
opt
statement ! branch-statement ;
opt
statement ! labeled-statement
statement ! control-transfer-statement ;
opt
statements ! statement statements
opt
GR A M M A R OF A L OOP S T AT E M E N T
loop-statement ! for-statement
loop-statement ! for-in-statement
loop-statement ! while-statement
loop-statement ! do-while-statement
GR A M M A R OF A F OR S T AT E M E N T
for-statement ! for for-init
opt
; expression
opt
; expression
opt
code-block
for-statement ! for ( for-init
opt
; expression
opt
; expression
opt
) code-block
for-init ! variable-declaration expression-list
GR A M M A R OF A F OR - I N S T AT E M E N T
for-in-statement ! for pattern in expression code-block
GR A M M A R OF A W H I L E S T AT E M E N T
while-statement ! while while-condition code-block
while-condition ! expression declaration
GR A M M A R OF A D O- W H I L E S T AT E M E N T
do-while-statement ! do code-block while while-condition
GR A M M A R OF A B R A N C H S T AT E M E N T
branch-statement ! if-statement
branch-statement ! switch-statement
GR A M M A R OF A N I F S T AT E M E N T
if-statement ! if if-condition code-block else-clause
opt
if-condition ! expression declaration
|
|
|
else-clause ! else code-block else if-statement
GR A M M A R OF A S W I T C H S T AT E M E N T
switch-statement ! switch expression { switch-cases
opt
}
switch-cases ! switch-case switch-cases
opt
switch-case ! case-label statements default-label statements
switch-case ! case-label ; default-label ;
case-label ! case case-item-list :
case-item-list ! pattern guard-clause
opt
pattern guard-clause
opt
, case-item-list
default-label ! default :
guard-clause ! where guard-expression
guard-expression ! expression
GR A M M A R OF A L A B E L E D S T AT E M E N T
labeled-statement ! statement-label loop-statement statement-label switch-statement
statement-label ! label-name :
label-name ! identifier
GR A M M A R OF A C ON T R OL T R A N S F E R S T AT E M E N T
control-transfer-statement ! break-statement
control-transfer-statement ! continue-statement
control-transfer-statement ! fallthrough-statement
control-transfer-statement ! return-statement
GR A M M A R OF A B R E A K S T AT E M E N T
break-statement ! break label-name
opt
GR A M M A R OF A C ON T I N U E S T AT E M E N T
continue-statement ! continue label-name
opt
GR A M M A R OF A F A L LT H R OU GH S T AT E M E N T
fallthrough-statement ! fallthrough
GR A M M A R OF A R E T U R N S T AT E M E N T
return-statement ! return expression
opt
Generic Parameters and Arguments
GR A M M A R OF A GE N E R I C PA R A M E T E R C L A U S E
generic-parameter-clause ! < generic-parameter-list requirement-clause
opt
>
generic-parameter-list ! generic-parameter generic-parameter , generic-parameter-list
generic-parameter ! type-name
|
|
|
|
|
|
generic-parameter ! type-name : type-identifier
generic-parameter ! type-name : protocol-composition-type
requirement-clause ! where requirement-list
requirement-list ! requirement requirement , requirement-list
requirement ! conformance-requirement same-type-requirement
conformance-requirement ! type-identifier : type-identifier
conformance-requirement ! type-identifier : protocol-composition-type
same-type-requirement ! type-identifier == type-identifier
GR A M M A R OF A GE N E R I C A R GU M E N T C L A U S E
generic-argument-clause ! < generic-argument-list >
generic-argument-list ! generic-argument generic-argument , generic-argument-list
generic-argument ! type
Declarations
GR A M M A R OF A D E C L A R AT I ON
declaration ! import-declaration
declaration ! constant-declaration
declaration ! variable-declaration
declaration ! typealias-declaration
declaration ! function-declaration
declaration ! enum-declaration
declaration ! struct-declaration
declaration ! class-declaration
declaration ! protocol-declaration
declaration ! initializer-declaration
declaration ! deinitializer-declaration
declaration ! extension-declaration
declaration ! subscript-declaration
declaration ! operator-declaration
declarations ! declaration declarations
opt
declaration-specifiers ! declaration-specifier declaration-specifiers
opt
declaration-specifier ! class mutating nonmutating override static unowned
unowned(safe) unowned(unsafe) weak
GR A M M A R OF A T OP - L E V E L D E C L A R AT I ON
top-level-declaration ! statements
opt
GR A M M A R OF A C OD E B L OC K
code-block ! { statements
opt
}
GR A M M A R OF A N I M P OR T D E C L A R AT I ON
import-declaration ! attributes
opt
import import-kind
opt
import-path
|
|
|
| | | | | |
| |
import-kind ! typealias struct class enum protocol var func
import-path ! import-path-identifier import-path-identifier . import-path
import-path-identifier ! identifier operator
GR A M M A R OF A C ON S T A N T D E C L A R AT I ON
constant-declaration ! attributes
opt
declaration-specifiers
opt
let pattern-initializer-list
pattern-initializer-list ! pattern-initializer pattern-initializer , pattern-initializer-list
pattern-initializer ! pattern initializer
opt
initializer ! = expression
GR A M M A R OF A VA R I A B L E D E C L A R AT I ON
variable-declaration ! variable-declaration-head pattern-initializer-list
variable-declaration ! variable-declaration-head variable-name type-annotation code-block
variable-declaration ! variable-declaration-head variable-name type-annotation getter-setter-block
variable-declaration ! variable-declaration-head variable-name type-annotation getter-setter-keyword-
block
variable-declaration ! variable-declaration-head variable-name type-annotation initializer
opt
willSet-
didSet-block
variable-declaration-head ! attributes
opt
declaration-specifiers
opt
var
variable-name ! identifier
getter-setter-block ! { getter-clause setter-clause
opt
}
getter-setter-block ! { setter-clause getter-clause }
getter-clause ! attributes
opt
get code-block
setter-clause ! attributes
opt
set setter-name
opt
code-block
setter-name ! ( identifier )
getter-setter-keyword-block ! { getter-keyword-clause setter-keyword-clause
opt
}
getter-setter-keyword-block ! { setter-keyword-clause getter-keyword-clause }
getter-keyword-clause ! attributes
opt
get
setter-keyword-clause ! attributes
opt
set
willSet-didSet-block ! { willSet-clause didSet-clause
opt
}
willSet-didSet-block ! { didSet-clause willSet-clause }
willSet-clause ! attributes
opt
willSet setter-name
opt
code-block
didSet-clause ! attributes
opt
didSet setter-name
opt
code-block
GR A M M A R OF A T Y P E A L I A S D E C L A R AT I ON
typealias-declaration ! typealias-head typealias-assignment
typealias-head ! typealias typealias-name
typealias-name ! identifier
typealias-assignment ! = type
GR A M M A R OF A F U N C T I ON D E C L A R AT I ON
function-declaration ! function-head function-name generic-parameter-clause
opt
function-
signature function-body
function-head ! attributes
opt
declaration-specifiers
opt
func
| | | | | |
|
|
|
function-name ! identifier operator
function-signature ! parameter-clauses function-result
opt
function-result ! -> attributes
opt
type
function-body ! code-block
parameter-clauses ! parameter-clause parameter-clauses
opt
parameter-clause ! ( ) ( parameter-list ...
opt
)
parameter-list ! parameter parameter , parameter-list
parameter ! inout
opt
let
opt
#
opt
parameter-name local-parameter-name
opt
type-
annotation default-argument-clause
opt
parameter ! inout
opt
var #
opt
parameter-name local-parameter-name
opt
type-annotation default-
argument-clause
opt
parameter ! attributes
opt
type
parameter-name ! identifier _
local-parameter-name ! identifier _
default-argument-clause ! = expression
GR A M M A R OF A N E N U M E R AT I ON D E C L A R AT I ON
enum-declaration ! attributes
opt
union-style-enum attributes
opt
raw-value-style-enum
union-style-enum ! enum-name generic-parameter-clause
opt
{ union-style-enum-members
opt
}
union-style-enum-members ! union-style-enum-member union-style-enum-members
opt
union-style-enum-member ! declaration union-style-enum-case-clause
union-style-enum-case-clause ! attributes
opt
case union-style-enum-case-list
union-style-enum-case-list ! union-style-enum-case union-style-enum-case , union-style-enum-
case-list
union-style-enum-case ! enum-case-name tuple-type
opt
enum-name ! identifier
enum-case-name ! identifier
raw-value-style-enum ! enum-name generic-parameter-clause
opt
: type-identifier { raw-value-style-
enum-members
opt
}
raw-value-style-enum-members ! raw-value-style-enum-member raw-value-style-enum-members
opt
raw-value-style-enum-member ! declaration raw-value-style-enum-case-clause
raw-value-style-enum-case-clause ! attributes
opt
case raw-value-style-enum-case-list
raw-value-style-enum-case-list ! raw-value-style-enum-case raw-value-style-enum-case , raw-
value-style-enum-case-list
raw-value-style-enum-case ! enum-case-name raw-value-assignment
opt
raw-value-assignment ! = literal
GR A M M A R OF A S T R U C T U R E D E C L A R AT I ON
struct-declaration ! attributes
opt
struct struct-name generic-parameter-clause
opt
type-inheritance-
clause
opt
struct-body
struct-name ! identifier
struct-body ! { declarations
opt
}
GR A M M A R OF A C L A S S D E C L A R AT I ON
class-declaration ! attributes
opt
class class-name generic-parameter-clause
opt
type-inheritance-
|
|
|
|
|
|
|
|
|
|
clause
opt
class-body
class-name ! identifier
class-body ! { declarations
opt
}
GR A M M A R OF A P R OT OC OL D E C L A R AT I ON
protocol-declaration ! attributes
opt
protocol protocol-name type-inheritance-clause
opt
protocol-body
protocol-name ! identifier
protocol-body ! { protocol-member-declarations
opt
}
protocol-member-declaration ! protocol-property-declaration
protocol-member-declaration ! protocol-method-declaration
protocol-member-declaration ! protocol-initializer-declaration
protocol-member-declaration ! protocol-subscript-declaration
protocol-member-declaration ! protocol-associated-type-declaration
protocol-member-declarations ! protocol-member-declaration protocol-member-declarations
opt
GR A M M A R OF A P R OT OC OL P R OP E R T Y D E C L A R AT I ON
protocol-property-declaration ! variable-declaration-head variable-name type-annotation getter-setter-
keyword-block
GR A M M A R OF A P R OT OC OL M E T H OD D E C L A R AT I ON
protocol-method-declaration ! function-head function-name generic-parameter-clause
opt
function-
signature
GR A M M A R OF A P R OT OC OL I N I T I A L I Z E R D E C L A R AT I ON
protocol-initializer-declaration ! initializer-head generic-parameter-clause
opt
parameter-clause
GR A M M A R OF A P R OT OC OL S U B S C R I P T D E C L A R AT I ON
protocol-subscript-declaration ! subscript-head subscript-result getter-setter-keyword-block
GR A M M A R OF A P R OT OC OL A S S OC I AT E D T Y P E D E C L A R AT I ON
protocol-associated-type-declaration ! typealias-head type-inheritance-clause
opt
typealias-
assignment
opt
GR A M M A R OF A N I N I T I A L I Z E R D E C L A R AT I ON
initializer-declaration ! initializer-head generic-parameter-clause
opt
parameter-clause initializer-body
initializer-head ! attributes
opt
convenience
opt
init
initializer-body ! code-block
GR A M M A R OF A D E I N I T I A L I Z E R D E C L A R AT I ON
deinitializer-declaration ! attributes
opt
deinit code-block
GR A M M A R OF A N E X T E N S I ON D E C L A R AT I ON
extension-declaration ! extension type-identifier type-inheritance-clause
opt
extension-body
extension-body ! { declarations
opt
}
GR A M M A R OF A S U B S C R I P T D E C L A R AT I ON
subscript-declaration ! subscript-head subscript-result code-block
subscript-declaration ! subscript-head subscript-result getter-setter-block
subscript-declaration ! subscript-head subscript-result getter-setter-keyword-block
subscript-head ! attributes
opt
subscript parameter-clause
subscript-result ! -> attributes
opt
type
GR A M M A R OF A N OP E R AT OR D E C L A R AT I ON
operator-declaration ! prefix-operator-declaration postfix-operator-declaration infix-operator-
declaration
prefix-operator-declaration ! operator prefix operator { }
postfix-operator-declaration ! operator postfix operator { }
infix-operator-declaration ! operator infix operator { infix-operator-attributes
opt
}
infix-operator-attributes ! precedence-clause
opt
associativity-clause
opt
precedence-clause ! precedence precedence-level
precedence-level ! Digit 0 through 255
associativity-clause ! associativity associativity
associativity ! left right none
Patterns
GR A M M A R OF A PAT T E R N
pattern ! wildcard-pattern type-annotation
opt
pattern ! identifier-pattern type-annotation
opt
pattern ! value-binding-pattern
pattern ! tuple-pattern type-annotation
opt
pattern ! enum-case-pattern
pattern ! type-casting-pattern
pattern ! expression-pattern
GR A M M A R OF A W I L D C A R D PAT T E R N
wildcard-pattern ! _
GR A M M A R OF A N I D E N T I F I E R PAT T E R N
identifier-pattern ! identifier
GR A M M A R OF A VA L U E - B I N D I N G PAT T E R N
value-binding-pattern ! var pattern let pattern
GR A M M A R OF A T U P L E PAT T E R N
tuple-pattern ! ( tuple-pattern-element-list
opt
)
tuple-pattern-element-list ! tuple-pattern-element tuple-pattern-element , tuple-pattern-element-list
tuple-pattern-element ! pattern
| |
| |
|
|
GR A M M A R OF A N E N U M E R AT I ON C A S E PAT T E R N
enum-case-pattern ! type-identifier
opt
. enum-case-name tuple-pattern
opt
GR A M M A R OF A T Y P E C A S T I N G PAT T E R N
type-casting-pattern ! is-pattern as-pattern
is-pattern ! is type
as-pattern ! pattern as type
GR A M M A R OF A N E X P R E S S I ON PAT T E R N
expression-pattern ! expression
Attributes
GR A M M A R OF A N AT T R I B U T E
attribute ! @ attribute-name attribute-argument-clause
opt
attribute-name ! identifier
attribute-argument-clause ! ( balanced-tokens
opt
)
attributes ! attribute attributes
opt
balanced-tokens ! balanced-token balanced-tokens
opt
balanced-token ! ( balanced-tokens
opt
)
balanced-token ! [ balanced-tokens
opt
]
balanced-token ! { balanced-tokens
opt
}
balanced-token ! Any identifier, keyword, literal, or operator
balanced-token ! Any punctuation except ( , ) , [ , ] , { , or }
Expressions
GR A M M A R OF A N E X P R E S S I ON
expression ! prefix-expression binary-expressions
opt
expression-list ! expression expression , expression-list
GR A M M A R OF A P R E F I X E X P R E S S I ON
prefix-expression ! prefix-operator
opt
postfix-expression
prefix-expression ! in-out-expression
in-out-expression ! & identifier
GR A M M A R OF A B I N A R Y E X P R E S S I ON
binary-expression ! binary-operator prefix-expression
binary-expression ! assignment-operator prefix-expression
binary-expression ! conditional-operator prefix-expression
binary-expression ! type-casting-operator
|
|
binary-expressions ! binary-expression binary-expressions
opt
GR A M M A R OF A N A S S I GN M E N T OP E R AT OR
assignment-operator ! =
GR A M M A R OF A C ON D I T I ON A L OP E R AT OR
conditional-operator ! ? expression :
GR A M M A R OF A T Y P E - C A S T I N G OP E R AT OR
type-casting-operator ! is type as ?
opt
type
GR A M M A R OF A P R I M A R Y E X P R E S S I ON
primary-expression ! identifier generic-argument-clause
opt
primary-expression ! literal-expression
primary-expression ! self-expression
primary-expression ! superclass-expression
primary-expression ! closure-expression
primary-expression ! parenthesized-expression
primary-expression ! implicit-member-expression
primary-expression ! wildcard-expression
GR A M M A R OF A L I T E R A L E X P R E S S I ON
literal-expression ! literal
literal-expression ! array-literal dictionary-literal
literal-expression ! __FILE__ __LINE__ __COLUMN__ __FUNCTION__
array-literal ! [ array-literal-items
opt
]
array-literal-items ! array-literal-item ,
opt
array-literal-item , array-literal-items
array-literal-item ! expression
dictionary-literal ! [ dictionary-literal-items ] [ : ]
dictionary-literal-items ! dictionary-literal-item ,
opt
dictionary-literal-item , dictionary-literal-items
dictionary-literal-item ! expression : expression
GR A M M A R OF A S E L F E X P R E S S I ON
self-expression ! self
self-expression ! self . identifier
self-expression ! self [ expression ]
self-expression ! self . init
GR A M M A R OF A S U P E R C L A S S E X P R E S S I ON
superclass-expression ! superclass-method-expression superclass-subscript-expression
superclass-initializer-expression
superclass-method-expression ! super . identifier
superclass-subscript-expression ! super [ expression ]
superclass-initializer-expression ! super . init
GR A M M A R OF A C L OS U R E E X P R E S S I ON
|
|
| | |
|
|
|
| |
closure-expression ! { closure-signature
opt
statements }
closure-signature ! parameter-clause function-result
opt
in
closure-signature ! identifier-list function-result
opt
in
closure-signature ! capture-list parameter-clause function-result
opt
in
closure-signature ! capture-list identifier-list function-result
opt
in
closure-signature ! capture-list in
capture-list ! [ capture-specifier expression ]
capture-specifier ! weak unowned unowned(safe) unowned(unsafe)
GR A M M A R OF A I M P L I C I T M E M B E R E X P R E S S I ON
implicit-member-expression ! . identifier
GR A M M A R OF A PA R E N T H E S I Z E D E X P R E S S I ON
parenthesized-expression ! ( expression-element-list
opt
)
expression-element-list ! expression-element expression-element , expression-element-list
expression-element ! expression identifier : expression
GR A M M A R OF A W I L D C A R D E X P R E S S I ON
wildcard-expression ! _
GR A M M A R OF A P OS T F I X E X P R E S S I ON
postfix-expression ! primary-expression
postfix-expression ! postfix-expression postfix-operator
postfix-expression ! function-call-expression
postfix-expression ! initializer-expression
postfix-expression ! explicit-member-expression
postfix-expression ! postfix-self-expression
postfix-expression ! dynamic-type-expression
postfix-expression ! subscript-expression
postfix-expression ! forced-value-expression
postfix-expression ! optional-chaining-expression
GR A M M A R OF A F U N C T I ON C A L L E X P R E S S I ON
function-call-expression ! postfix-expression parenthesized-expression
function-call-expression ! postfix-expression parenthesized-expression
opt
trailing-closure
trailing-closure ! closure-expression
GR A M M A R OF A N I N I T I A L I Z E R E X P R E S S I ON
initializer-expression ! postfix-expression . init
GR A M M A R OF A N E X P L I C I T M E M B E R E X P R E S S I ON
explicit-member-expression ! postfix-expression . decimal-digit
explicit-member-expression ! postfix-expression . identifier generic-argument-clause
opt
GR A M M A R OF A S E L F E X P R E S S I ON
| | |
|
|
postfix-self-expression ! postfix-expression . self
GR A M M A R OF A D Y N A M I C T Y P E E X P R E S S I ON
dynamic-type-expression ! postfix-expression . dynamicType
GR A M M A R OF A S U B S C R I P T E X P R E S S I ON
subscript-expression ! postfix-expression [ expression-list ]
GR A M M A R OF A F OR C E D - VA L U E E X P R E S S I ON
forced-value-expression ! postfix-expression !
GR A M M A R OF A N OP T I ON A L - C H A I N I N G E X P R E S S I ON
optional-chaining-expression ! postfix-expression ?
Lexical Structure
GR A M M A R OF A N I D E N T I F I E R
identifier ! identifier-head identifier-characters
opt
identifier ! ` identifier-head identifier-characters
opt
`
identifier ! implicit-parameter-name
identifier-list ! identifier identifier , identifier-list
identifier-head ! Upper- or lowercase letter A through Z
identifier-head ! U+00A8, U+00AA, U+00AD, U+00AF, U+00B2U+00B5, or U+00B7U+00BA
identifier-head ! U+00BCU+00BE, U+00C0U+00D6, U+00D8U+00F6, or U+00F8U+00FF
identifier-head ! U+0100U+02FF, U+0370U+167F, U+1681U+180D, or U+180FU+1DBF
identifier-head ! U+1E00U+1FFF
identifier-head ! U+200BU+200D, U+202AU+202E, U+203FU+2040, U+2054, or U+2060U+206F
identifier-head ! U+2070U+20CF, U+2100U+218F, U+2460U+24FF, or U+2776U+2793
identifier-head ! U+2C00U+2DFF or U+2E80U+2FFF
identifier-head ! U+3004U+3007, U+3021U+302F, U+3031U+303F, or U+3040U+D7FF
identifier-head ! U+F900U+FD3D, U+FD40U+FDCF, U+FDF0U+FE1F, or U+FE30U+FE44
identifier-head ! U+FE47U+FFFD
identifier-head ! U+10000U+1FFFD, U+20000U+2FFFD, U+30000U+3FFFD, or U+40000U+4FFFD
identifier-head ! U+50000U+5FFFD, U+60000U+6FFFD, U+70000U+7FFFD, or U+80000U+8FFFD
identifier-head ! U+90000U+9FFFD, U+A0000U+AFFFD, U+B0000U+BFFFD, or U+C0000U+CFFFD
identifier-head ! U+D0000U+DFFFD or U+E0000U+EFFFD
identifier-character ! Digit 0 through 9
identifier-character ! U+0300U+036F, U+1DC0U+1DFF, U+20D0U+20FF, or U+FE20U+FE2F
identifier-character ! identifier-head
identifier-characters ! identifier-character identifier-characters
opt
implicit-parameter-name ! $ decimal-digits
GR A M M A R OF A L I T E R A L
literal ! integer-literal floating-point-literal string-literal
|
| |
GR A M M A R OF A N I N T E GE R L I T E R A L
integer-literal ! binary-literal
integer-literal ! octal-literal
integer-literal ! decimal-literal
integer-literal ! hexadecimal-literal
binary-literal ! 0b binary-digit binary-literal-characters
opt
binary-digit ! Digit 0 or 1
binary-literal-character ! binary-digit _
binary-literal-characters ! binary-literal-character binary-literal-characters
opt
octal-literal ! 0o octal-digit octal-literal-characters
opt
octal-digit ! Digit 0 through 7
octal-literal-character ! octal-digit _
octal-literal-characters ! octal-literal-character octal-literal-characters
opt
decimal-literal ! decimal-digit decimal-literal-characters
opt
decimal-digit ! Digit 0 through 9
decimal-digits ! decimal-digit decimal-digits
opt
decimal-literal-character ! decimal-digit _
decimal-literal-characters ! decimal-literal-character decimal-literal-characters
opt
hexadecimal-literal ! 0x hexadecimal-digit hexadecimal-literal-characters
opt
hexadecimal-digit ! Digit 0 through 9, a through f, or A through F
hexadecimal-literal-character ! hexadecimal-digit _
hexadecimal-literal-characters ! hexadecimal-literal-character hexadecimal-literal-characters
opt
GR A M M A R OF A F L OAT I N G- P OI N T L I T E R A L
floating-point-literal ! decimal-literal decimal-fraction
opt
decimal-exponent
opt
floating-point-literal ! hexadecimal-literal hexadecimal-fraction
opt
hexadecimal-exponent
decimal-fraction ! . decimal-literal
decimal-exponent ! floating-point-e sign
opt
decimal-literal
hexadecimal-fraction ! . hexadecimal-literal
opt
hexadecimal-exponent ! floating-point-p sign
opt
hexadecimal-literal
floating-point-e ! e E
floating-point-p ! p P
sign ! + -
GR A M M A R OF A S T R I N G L I T E R A L
string-literal ! " quoted-text "
quoted-text ! quoted-text-item quoted-text
opt
quoted-text-item ! escaped-character
quoted-text-item ! \( expression )
quoted-text-item ! Any Unicode extended grapheme cluster except " , \ , U+000A, or U+000D
escaped-character ! \0 \\ \t \n \r \" \'
escaped-character ! \x hexadecimal-digit hexadecimal-digit
escaped-character ! \u hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-digit
escaped-character ! \U hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-
|
|
|
|
|
|
|
| | | | | |
digit hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-digit
GR A M M A R OF OP E R AT OR S
operator ! operator-character operator
opt
operator-character ! / = - + ! * % < > & | ^ ~ .
binary-operator ! operator
prefix-operator ! operator
postfix-operator ! operator
Types
GR A M M A R OF A T Y P E
type ! array-type function-type type-identifier tuple-type optional-type implicitly-
unwrapped-optional-type protocol-composition-type metatype-type
GR A M M A R OF A T Y P E A N N OT AT I ON
type-annotation ! : attributes
opt
type
GR A M M A R OF A T Y P E I D E N T I F I E R
type-identifier ! type-name generic-argument-clause
opt
type-name generic-argument-
clause
opt
. type-identifier
type-name ! identifier
GR A M M A R OF A T U P L E T Y P E
tuple-type ! ( tuple-type-body
opt
)
tuple-type-body ! tuple-type-element-list ...
opt
tuple-type-element-list ! tuple-type-element tuple-type-element , tuple-type-element-list
tuple-type-element ! attributes
opt
inout
opt
type inout
opt
element-name type-annotation
element-name ! identifier
GR A M M A R OF A F U N C T I ON T Y P E
function-type ! type -> type
GR A M M A R OF A N A R R AY T Y P E
array-type ! type [ ] array-type [ ]
GR A M M A R OF A N OP T I ON A L T Y P E
optional-type ! type ?
GR A M M A R OF A N I M P L I C I T LY U N W R A P P E D OP T I ON A L T Y P E
implicitly-unwrapped-optional-type ! type !
| | | | | | | | | | | | |
| | | | |
| |
|
|
|
|
GR A M M A R OF A P R OT OC OL C OM P OS I T I ON T Y P E
protocol-composition-type ! protocol < protocol-identifier-list
opt
>
protocol-identifier-list ! protocol-identifier protocol-identifier , protocol-identifier-list
protocol-identifier ! type-identifier
GR A M M A R OF A M E T AT Y P E T Y P E
metatype-type ! type . Type type . Protocol
GR A M M A R OF A T Y P E I N H E R I T A N C E C L A U S E
type-inheritance-clause ! : type-inheritance-list
type-inheritance-list ! type-identifier type-identifier , type-inheritance-list
|
|
|
Copyright and Notices
I M P OR TA N T
This is a preliminary document for an API or technology in development. Apple is supplying this information to
help you plan for the adoption of the technologies and programming interfaces described herein for use on
Apple-branded products. This information is subject to change, and software implemented according to this
document should be tested with final operating system software and final documentation. Newer versions of
this document may be provided with future seeds of the API or technology.
Apple Inc.
Copyright 2014 Apple Inc.
All rights reserved.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any
means, mechanical, electronic, photocopying, recording, or otherwise, without prior written permission of Apple Inc.,
with the following exceptions: Any person is hereby authorized to store documentation on a single computer or
device for personal use only and to print copies of documentation for personal use provided that the documentation
contains Apples copyright notice.
No licenses, express or implied, are granted with respect to any of the technology described in this document.
Apple retains all intellectual property rights associated with the technology described in this document. This
document is intended to assist application developers to develop applications only for Apple-branded products.
Apple Inc.
1 Infinite Loop
Cupertino, CA 95014
408-996-1010
Apple, the Apple logo, Bonjour, Cocoa, Cocoa Touch, Logic, Numbers, Objective-C, OS X, Shake, and Xcode are
trademarks of Apple Inc., registered in the U.S. and other countries.
Retina is a trademark of Apple Inc.
Times is a registered trademark of Heidelberger Druckmaschinen AG, available from Linotype Library GmbH.
IOS is a trademark or registered trademark of Cisco in the U.S. and other countries and is used under license.
Even though Apple has reviewed this document, APPLE MAKES NO WARRANTY OR REPRESENTATION,
EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THIS DOCUMENT, ITS QUALITY, ACCURACY,
MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. AS A RESULT, THIS DOCUMENT IS
PROVIDED AS IS, AND YOU, THE READER, ARE ASSUMING THE ENTIRE RISK AS TO ITS QUALITY AND
ACCURACY.
IN NO EVENT WILL APPLE BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES RESULTING FROM ANY DEFECT, ERROR OR INACCURACY IN THIS
DOCUMENT, even if advised of the possibility of such damages.
THE WARRANTY AND REMEDIES SET FORTH ABOVE ARE EXCLUSIVE AND IN LIEU OF ALL OTHERS, ORAL
OR WRITTEN, EXPRESS OR IMPLIED. No Apple dealer, agent, or employee is authorized to make any
modification, extension, or addition to this warranty.
Some jurisdictions do not allow the exclusion or limitation of implied warranties or liability for incidental or
consequential damages, so the above limitation or exclusion may not apply to you.
www.th7.cn