learnxinyminutes-docs/swift.html.markdown

604 lines
15 KiB
Markdown
Raw Normal View History

2014-06-04 07:50:17 +00:00
---
language: swift
contributors:
- ["Grant Timmerman", "http://github.com/grant"]
- ["Christopher Bess", "http://github.com/cbess"]
2015-10-08 03:11:24 +00:00
- ["Joey Huang", "http://github.com/kamidox"]
- ["Anthony Nguyen", "http://github.com/anthonyn60"]
- ["Clayton Walker", "https://github.com/cwalk"]
2015-11-01 00:48:44 +00:00
- ["Fernando Valverde", "http://visualcosita.xyz"]
2014-06-04 07:50:17 +00:00
filename: learnswift.swift
---
Swift is a programming language for iOS and OS X development created by Apple. Designed to coexist with Objective-C and to be more resilient against erroneous code, Swift was introduced in 2014 at Apple's developer conference WWDC. It is built with the LLVM compiler included in Xcode 6+.
2014-06-04 07:50:17 +00:00
The official [Swift Programming Language](https://itunes.apple.com/us/book/swift-programming-language/id881256329) book from Apple is now available via iBooks.
See also Apple's [getting started guide](https://developer.apple.com/library/prerelease/ios/referencelibrary/GettingStarted/DevelopiOSAppsSwift/), which has a complete tutorial on Swift.
2014-06-04 07:50:17 +00:00
```swift
// import a module
import UIKit
//
// MARK: Basics
//
2014-08-24 19:37:09 +00:00
// Xcode supports landmarks to annotate your code and lists them in the jump bar
// MARK: Section mark
2015-11-01 00:48:44 +00:00
// MARK: - Section mark with a separator line
2014-08-24 19:37:09 +00:00
// TODO: Do something soon
// FIXME: Fix this code
2014-08-24 19:37:09 +00:00
2015-08-04 03:10:10 +00:00
// In Swift 2, println and print were combined into one print method. Print automatically appends a new line.
print("Hello, world") // println is now print
print("Hello, world", appendNewLine: false) // printing without appending a newline
// variables (var) value can change after being set
// constants (let) value can NOT be changed after being set
2014-06-04 07:50:17 +00:00
var myVariable = 42
let øπΩ = "value" // unicode variable names
let π = 3.1415926
let convenience = "keyword" // contextual variable name
let weak = "keyword"; let override = "another keyword" // statements can be separated by a semi-colon
let `class` = "keyword" // backticks allow keywords to be used as variable names
2014-06-04 07:50:17 +00:00
let explicitDouble: Double = 70
let intValue = 0007 // 7
let largeIntValue = 77_000 // 77000
let label = "some text " + String(myVariable) // Casting
let piText = "Pi = \(π), Pi 2 = \(π * 2)" // String interpolation
// Build Specific values
// uses -D build configuration
#if false
2015-08-04 03:05:22 +00:00
print("Not printed")
let buildValue = 3
#else
let buildValue = 7
#endif
2015-08-04 03:05:22 +00:00
print("Build value: \(buildValue)") // Build value: 7
/*
2015-10-09 03:27:19 +00:00
Optionals are a Swift language feature that either contains a value,
or contains nil (no value) to indicate that a value is missing.
A question mark (?) after the type marks the value as optional.
Because Swift requires every property to have a value, even nil must be
explicitly stored as an Optional value.
Optional<T> is an enum.
*/
var someOptionalString: String? = "optional" // Can be nil
// same as above, but ? is a postfix operator (syntax candy)
var someOptionalString2: Optional<String> = "optional"
if someOptionalString != nil {
// I am not nil
if someOptionalString!.hasPrefix("opt") {
2015-08-04 03:05:22 +00:00
print("has the prefix")
}
2015-10-08 03:11:24 +00:00
let empty = someOptionalString?.isEmpty
}
someOptionalString = nil
/*
2015-11-01 00:48:44 +00:00
Trying to use ! to access a non-existent optional value triggers a runtime
2015-10-09 03:27:19 +00:00
error. Always make sure that an optional contains a non-nil value before
using ! to force-unwrap its value.
*/
// implicitly unwrapped optional
var unwrappedString: String! = "Value is expected."
// same as above, but ! is a postfix operator (more syntax candy)
var unwrappedString2: ImplicitlyUnwrappedOptional<String> = "Value is expected."
if let someOptionalStringConstant = someOptionalString {
// has `Some` value, non-nil
if !someOptionalStringConstant.hasPrefix("ok") {
// does not have the prefix
}
}
// Swift has support for storing a value of any type.
// AnyObject == id
// Unlike Objective-C `id`, AnyObject works with any value (Class, Int, struct, etc.)
var anyObjectVar: AnyObject = 7
anyObjectVar = "Changed value to a string, not good practice, but possible."
2014-06-04 07:50:17 +00:00
/*
Comment here
2015-10-08 03:11:24 +00:00
/*
Nested comments are also supported
*/
*/
2014-06-04 07:50:17 +00:00
//
// MARK: Collections
//
/*
Array and Dictionary types are structs. So `let` and `var` also indicate
that they are mutable (var) or immutable (let) when declaring these types.
*/
2014-06-04 07:50:17 +00:00
// Array
var shoppingList = ["catfish", "water", "lemons"]
shoppingList[1] = "bottle of water"
let emptyArray = [String]() // let == immutable
let emptyArray2 = Array<String>() // same as above
var emptyMutableArray = [String]() // var == mutable
var explicitEmptyMutableStringArray: [String] = [] // same as above
2014-06-04 07:50:17 +00:00
// Dictionary
var occupations = [
"Malcolm": "Captain",
"kaylee": "Mechanic"
2014-06-04 07:50:17 +00:00
]
occupations["Jayne"] = "Public Relations"
let emptyDictionary = [String: Float]() // let == immutable
let emptyDictionary2 = Dictionary<String, Float>() // same as above
var emptyMutableDictionary = [String: Float]() // var == mutable
var explicitEmptyMutableDictionary: [String: Float] = [:] // same as above
2014-06-04 07:50:17 +00:00
//
// MARK: Control Flow
//
2014-06-04 07:50:17 +00:00
// for loop (array)
let myArray = [1, 1, 2, 3, 5]
for value in myArray {
if value == 1 {
2015-08-04 03:05:22 +00:00
print("One!")
} else {
2015-08-04 03:05:22 +00:00
print("Not one!")
}
2014-06-04 07:50:17 +00:00
}
// for loop (dictionary)
var dict = ["one": 1, "two": 2]
2014-06-04 07:50:17 +00:00
for (key, value) in dict {
2015-08-04 03:05:22 +00:00
print("\(key): \(value)")
2014-06-04 07:50:17 +00:00
}
// for loop (range)
for i in -1...shoppingList.count {
2015-08-04 03:05:22 +00:00
print(i)
2014-06-04 07:50:17 +00:00
}
shoppingList[1...2] = ["steak", "peacons"]
// use ..< to exclude the last number
2014-06-04 07:50:17 +00:00
// while loop
var i = 1
while i < 1000 {
i *= 2
2014-06-04 07:50:17 +00:00
}
// do-while loop
do {
2015-08-04 03:05:22 +00:00
print("hello")
2014-06-04 07:50:17 +00:00
} while 1 == 2
// Switch
// Very powerful, think `if` statements with syntax candy
// They support String, object instances, and primitives (Int, Double, etc)
2014-06-04 07:50:17 +00:00
let vegetable = "red pepper"
switch vegetable {
case "celery":
let vegetableComment = "Add some raisins and make ants on a log."
2014-06-04 07:50:17 +00:00
case "cucumber", "watercress":
let vegetableComment = "That would make a good tea sandwich."
case let localScopeValue where localScopeValue.hasSuffix("pepper"):
let vegetableComment = "Is it a spicy \(localScopeValue)?"
2014-06-04 07:50:17 +00:00
default: // required (in order to cover all possible input)
let vegetableComment = "Everything tastes good in soup."
2014-06-04 07:50:17 +00:00
}
//
// MARK: Functions
//
// Functions are a first-class type, meaning they can be nested
// in functions and can be passed around
2014-06-04 07:50:17 +00:00
// Function with Swift header docs (format as reStructedText)
/**
A greet operation
- A bullet in docs
- Another bullet in the docs
:param: name A name
:param: day A day
:returns: A string containing the name and day value.
*/
2014-06-04 07:50:17 +00:00
func greet(name: String, day: String) -> String {
return "Hello \(name), today is \(day)."
2014-06-04 07:50:17 +00:00
}
greet("Bob", "Tuesday")
// similar to above except for the function parameter behaviors
func greet2(#requiredName: String, externalParamName localParamName: String) -> String {
return "Hello \(requiredName), the day is \(localParamName)"
}
greet2(requiredName:"John", externalParamName: "Sunday")
2014-06-04 07:50:17 +00:00
// Function that returns multiple items in a tuple
func getGasPrices() -> (Double, Double, Double) {
return (3.59, 3.69, 3.79)
2014-06-04 07:50:17 +00:00
}
let pricesTuple = getGasPrices()
let price = pricesTuple.2 // 3.79
// Ignore Tuple (or other) values by using _ (underscore)
let (_, price1, _) = pricesTuple // price1 == 3.69
2015-08-04 03:05:22 +00:00
print(price1 == pricesTuple.1) // true
print("Gas price: \(price)")
2014-06-04 07:50:17 +00:00
// Variadic Args
func setup(numbers: Int...) {
// its an array
let number = numbers[0]
let argCount = numbers.count
}
2014-06-04 07:50:17 +00:00
// Passing and returning functions
func makeIncrementer() -> (Int -> Int) {
func addOne(number: Int) -> Int {
return 1 + number
}
return addOne
2014-06-04 07:50:17 +00:00
}
var increment = makeIncrementer()
increment(7)
// pass by ref
func swapTwoInts(inout a: Int, inout b: Int) {
let tempA = a
a = b
b = tempA
}
var someIntA = 7
var someIntB = 3
swapTwoInts(&someIntA, &someIntB)
2015-08-04 03:05:22 +00:00
print(someIntB) // 7
2014-06-04 07:50:17 +00:00
//
// MARK: Closures
//
var numbers = [1, 2, 6]
// Functions are special case closures ({})
2014-06-04 07:50:17 +00:00
// Closure example.
// `->` separates the arguments and return type
// `in` separates the closure header from the closure body
numbers.map({
(number: Int) -> Int in
let result = 3 * number
return result
})
2014-06-04 07:50:17 +00:00
// When the type is known, like above, we can do this
numbers = numbers.map({ number in 3 * number })
// Or even this
//numbers = numbers.map({ $0 * 3 })
2014-06-04 07:50:17 +00:00
print(numbers) // [3, 6, 18]
// Trailing closure
numbers = sorted(numbers) { $0 > $1 }
print(numbers) // [18, 6, 3]
// Super shorthand, since the < operator infers the types
numbers = sorted(numbers, < )
print(numbers) // [3, 6, 18]
2014-06-04 07:50:17 +00:00
//
// MARK: Structures
//
// Structures and classes have very similar capabilities
struct NamesTable {
let names = [String]()
2015-10-08 03:11:24 +00:00
// Custom subscript
subscript(index: Int) -> String {
return names[index]
}
}
// Structures have an auto-generated (implicit) designated initializer
let namesTable = NamesTable(names: ["Me", "Them"])
let name = namesTable[1]
2015-08-04 03:05:22 +00:00
print("Name is \(name)") // Name is Them
//
// MARK: Classes
//
// Classes, structures and its members have three levels of access control
// They are: internal (default), public, private
public class Shape {
public func getArea() -> Int {
return 0;
}
}
// All methods and properties of a class are public.
// If you just need to store data in a
// structured object, you should use a `struct`
2014-06-04 07:50:17 +00:00
internal class Rect: Shape {
var sideLength: Int = 1
2015-10-08 03:11:24 +00:00
// Custom getter and setter property
private var perimeter: Int {
get {
return 4 * sideLength
}
set {
// `newValue` is an implicit variable available to setters
sideLength = newValue / 4
}
2014-06-04 07:50:17 +00:00
}
2015-10-08 03:11:24 +00:00
// Lazily load a property
// subShape remains nil (uninitialized) until getter called
lazy var subShape = Rect(sideLength: 4)
2015-10-08 03:11:24 +00:00
// If you don't need a custom getter and setter,
// but still want to run code before and after getting or setting
// a property, you can use `willSet` and `didSet`
var identifier: String = "defaultID" {
// the `willSet` arg will be the variable name for the new value
willSet(someIdentifier) {
print(someIdentifier)
}
2014-06-04 07:50:17 +00:00
}
2015-10-08 03:11:24 +00:00
init(sideLength: Int) {
self.sideLength = sideLength
// always super.init last when init custom properties
super.init()
}
2015-10-08 03:11:24 +00:00
func shrink() {
if sideLength > 0 {
--sideLength
}
2014-06-04 07:50:17 +00:00
}
2015-10-08 03:11:24 +00:00
override func getArea() -> Int {
return sideLength * sideLength
}
}
2014-06-04 07:50:17 +00:00
// A simple class `Square` extends `Rect`
class Square: Rect {
convenience init() {
self.init(sideLength: 5)
}
2014-06-04 07:50:17 +00:00
}
var mySquare = Square()
2014-06-04 07:50:17 +00:00
print(mySquare.getArea()) // 25
mySquare.shrink()
print(mySquare.sideLength) // 4
// cast instance
let aShape = mySquare as Shape
// compare instances, not the same as == which compares objects (equal to)
if mySquare === mySquare {
2015-08-04 03:05:22 +00:00
print("Yep, it's mySquare")
}
// Optional init
class Circle: Shape {
var radius: Int
override func getArea() -> Int {
return 3 * radius * radius
}
2015-10-08 03:11:24 +00:00
// Place a question mark postfix after `init` is an optional init
// which can return nil
init?(radius: Int) {
self.radius = radius
super.init()
2015-10-08 03:11:24 +00:00
if radius <= 0 {
return nil
}
}
}
var myCircle = Circle(radius: 1)
2015-08-04 03:05:22 +00:00
print(myCircle?.getArea()) // Optional(3)
print(myCircle!.getArea()) // 3
var myEmptyCircle = Circle(radius: -1)
2015-08-04 03:05:22 +00:00
print(myEmptyCircle?.getArea()) // "nil"
if let circle = myEmptyCircle {
// will not execute since myEmptyCircle is nil
2015-08-04 03:05:22 +00:00
print("circle is not nil")
}
2014-06-04 07:50:17 +00:00
//
// MARK: Enums
//
// Enums can optionally be of a specific type or on their own.
// They can contain methods like classes.
2014-06-04 07:50:17 +00:00
enum Suit {
case Spades, Hearts, Diamonds, Clubs
func getIcon() -> String {
switch self {
case .Spades: return "♤"
case .Hearts: return "♡"
case .Diamonds: return "♢"
case .Clubs: return "♧"
}
2014-06-04 07:50:17 +00:00
}
}
// Enum values allow short hand syntax, no need to type the enum type
// when the variable is explicitly declared
var suitValue: Suit = .Hearts
// Non-Integer enums require direct raw value assignments
enum BookName: String {
case John = "John"
case Luke = "Luke"
}
2015-08-04 03:05:22 +00:00
print("Name: \(BookName.John.rawValue)")
// Enum with associated Values
enum Furniture {
// Associate with Int
case Desk(height: Int)
// Associate with String and Int
case Chair(String, Int)
2015-10-08 03:11:24 +00:00
func description() -> String {
switch self {
case .Desk(let height):
return "Desk with \(height) cm"
case .Chair(let brand, let height):
return "Chair of \(brand) with \(height) cm"
}
}
}
var desk: Furniture = .Desk(height: 80)
2015-08-04 03:05:22 +00:00
print(desk.description()) // "Desk with 80 cm"
var chair = Furniture.Chair("Foo", 40)
2015-08-04 03:05:22 +00:00
print(chair.description()) // "Chair of Foo with 40 cm"
2014-06-04 07:50:17 +00:00
//
// MARK: Protocols
//
2014-06-04 07:50:17 +00:00
// `protocol`s can require that conforming types have specific
// instance properties, instance methods, type methods,
// operators, and subscripts.
protocol ShapeGenerator {
var enabled: Bool { get set }
func buildShape() -> Shape
}
// Protocols declared with @objc allow optional functions,
// which allow you to check for conformance
@objc protocol TransformShape {
optional func reshaped()
optional func canReshape() -> Bool
}
class MyShape: Rect {
var delegate: TransformShape?
2015-10-08 03:11:24 +00:00
func grow() {
sideLength += 2
// Place a question mark after an optional property, method, or
// subscript to gracefully ignore a nil value and return nil
// instead of throwing a runtime error ("optional chaining").
if let allow = self.delegate?.canReshape?() {
// test for delegate then for method
self.delegate?.reshaped?()
}
}
}
//
// MARK: Other
//
// `extension`s: Add extra functionality to an already existing type
// Square now "conforms" to the `Printable` protocol
extension Square: Printable {
var description: String {
return "Area: \(self.getArea()) - ID: \(self.identifier)"
}
}
2015-08-04 03:05:22 +00:00
print("Square: \(mySquare)")
// You can also extend built-in types
extension Int {
var customProperty: String {
return "This is \(self)"
}
2015-10-08 03:11:24 +00:00
func multiplyBy(num: Int) -> Int {
return num * self
}
}
2015-08-04 03:05:22 +00:00
print(7.customProperty) // "This is 7"
print(14.multiplyBy(3)) // 42
// Generics: Similar to Java and C#. Use the `where` keyword to specify the
// requirements of the generics.
2014-06-04 07:50:17 +00:00
func findIndex<T: Equatable>(array: [T], valueToFind: T) -> Int? {
for (index, value) in enumerate(array) {
if value == valueToFind {
return index
}
}
return nil
}
let foundAtIndex = findIndex([1, 2, 3, 4], 3)
2015-08-04 03:05:22 +00:00
print(foundAtIndex == 2) // true
// Operators:
// Custom operators can start with the characters:
// / = - + * % < > ! & | ^ . ~
// or
// Unicode math, symbol, arrow, dingbat, and line/box drawing characters.
prefix operator !!! {}
// A prefix operator that triples the side length when used
prefix func !!! (inout shape: Square) -> Square {
shape.sideLength *= 3
return shape
}
// current value
2015-08-04 03:05:22 +00:00
print(mySquare.sideLength) // 4
// change side length using custom !!! operator, increases size by 3
!!!mySquare
2015-08-04 03:05:22 +00:00
print(mySquare.sideLength) // 12
2015-10-08 07:00:13 +00:00
// Operators can also be generics
infix operator <-> {}
func <-><T: Equatable> (inout a: T, inout b: T) {
let c = a
a = b
b = c
}
var foo: Float = 10
var bar: Float = 20
foo <-> bar
print("foo is \(foo), bar is \(bar)") // "foo is 20.0, bar is 10.0"
```