The Swift Programming Language
C++ Swift Python CMake Objective-C Objective-C++ Other
Latest commit ab37419 Jan 24, 2017 @swift-ci swift-ci committed on GitHub Merge pull request #6989 from eeckstein/more-mangling
Permalink
Failed to load latest commit information.
.github Reduce boilerplate in the GitHub PR template Aug 27, 2016
apinotes [APINotes] Source compatibility for nullability on array parameters. (#… Nov 15, 2016
benchmark Add benchmarks for initializing Characters from literals. Jan 18, 2017
bindings/xml Nesting parameter/returns/throws doc comments for closure parameters Apr 10, 2016
cmake [gardening] Fix recently introduced typos Jan 22, 2017
docs [gardening] Fix recently introduced typos Jan 22, 2017
include Mangling: prepare for using new mangling for USR and debug-info type … Jan 24, 2017
lib Merge pull request #6989 from eeckstein/more-mangling Jan 24, 2017
stdlib Adding CustomDebugStringConvertible conformance to CGVector Jan 23, 2017
test Merge pull request #6985 from Fruneau/anonymous-field-constructor-master Jan 24, 2017
tools Mangling: prepare for using new mangling for USR and debug-info type … Jan 24, 2017
unittests [gardening] 2016 → 2017 Jan 6, 2017
utils Merge pull request #6977 from practicalswift/pep8-gardening-ii Jan 23, 2017
validation-test Merge pull request #6948 from matthewcarroll/SR-3599-Better-Recovery-… Jan 24, 2017
.clang-format Add a .clang-format file Feb 14, 2014
.dir-locals.el [emacs-support] support use of fci-mode Oct 18, 2016
.gitignore Add GYB support for Windows Dec 22, 2016
.pep8 [gardening] Add utils/scale-test to .pep8 Oct 16, 2016
CHANGELOG.md [gardening] Fix a vs an typos. Jan 21, 2017
CMakeLists.txt Merge pull request #3841 from tinysun212/pr-swiftc-cygwin-2 Jan 20, 2017
CODE_OWNERS.TXT update code owner for SILOptimizer Jul 29, 2016
CONTRIBUTING.md Reduce boilerplate in the GitHub PR template Aug 27, 2016
LICENSE.txt [gardening] Fix accidental trailing whitespace. Oct 29, 2016
README.md Add additional pre-requisites needed for building on Linux Nov 22, 2016

README.md

Swift logo

Swift Programming Language

Swift Package
macOS Build Status Build Status
Ubuntu 16.04 Build Status Build Status
Ubuntu 16.10 Build Status Build Status

Welcome to Swift!

Swift is a high-performance system programming language. It has a clean and modern syntax, offers seamless access to existing C and Objective-C code and frameworks, and is memory safe by default.

Although inspired by Objective-C and many other languages, Swift is not itself a C-derived language. As a complete and independent language, Swift packages core features like flow control, data structures, and functions, with high-level constructs like objects, protocols, closures, and generics. Swift embraces modules, eliminating the need for headers and the code duplication they entail.

Documentation

To read the documentation, start by installing the Sphinx documentation generator tool by running the command:

easy_install -U Sphinx

Once complete, you can build the Swift documentation by changing directory into docs and typing make. This compiles the .rst files in the docs directory into HTML in the docs/_build/html directory.

Many of the docs are out of date, but you can see some historical design documents in the docs directory.

Another source of documentation is the standard library itself, located in stdlib. Much of the language is actually implemented in the library (including Int), and the standard library gives some examples of what can be expressed today.

Getting Started

These instructions give the most direct path to a working Swift development environment. Options for doing things differently are discussed below.

System Requirements

macOS, Ubuntu Linux LTS, and the latest Ubuntu Linux release are the current supported host development operating systems.

For macOS, you need the latest Xcode.

For Ubuntu, you'll need the following development dependencies:

sudo apt-get install git cmake ninja-build clang python uuid-dev libicu-dev icu-devtools libbsd-dev libedit-dev libxml2-dev libsqlite3-dev swig libpython-dev libncurses5-dev pkg-config libblocksruntime-dev libcurl4-openssl-dev autoconf libtool systemtap-sdt-dev

Note: LLDB currently requires at least swig-1.3.40 but will successfully build with version 2 shipped with Ubuntu.

Ubuntu 14.04 LTS is no longer supported. Unsupported build instructions for Ubuntu 14.04 LTS can be found here

Getting Sources for Swift and Related Projects

First create a directory for all of the Swift sources:

mkdir swift-source
cd swift-source

Note: This is important since update-checkout (see below) checks out repositories next to the Swift source directory. This means that if one clones Swift and has other unrelated repositories, update-checkout may not clone those repositories and will update them instead.

Via HTTPS For those checking out sources as read-only, HTTPS works best:

git clone https://github.com/apple/swift.git
./swift/utils/update-checkout --clone

Via SSH For those who plan on regularly making direct commits, cloning over SSH may provide a better experience (which requires uploading SSH keys to GitHub):

git clone git@github.com:apple/swift.git
./swift/utils/update-checkout --clone-with-ssh

CMake

CMake is the core infrastructure used to configure builds of Swift and its companion projects; at least version 3.4.3 is required. Your favorite Linux distribution likely already has a CMake package you can install. On macOS, you can download the CMake Binary Distribution, bundled as an application, copy it to /Applications, and add the embedded command line tools to your PATH:

export PATH=/Applications/CMake.app/Contents/bin:$PATH

Ninja

Ninja is the current recommended build system for building Swift and is the default configuration generated by CMake. If you're on macOS or don't install it as part of your Linux distribution, clone it next to the other projects and it will be bootstrapped automatically:

Build from source

Via HTTPS

git clone https://github.com/ninja-build/ninja.git && cd ninja
git checkout release
cat README

Via SSH

git clone git@github.com:ninja-build/ninja.git && cd ninja
git checkout release
cat README

Install via third-party packaging tool (macOS only)

Homebrew

brew install cmake ninja

MacPorts

sudo port install cmake ninja

Building Swift

The build-script is a high-level build automation script that supports basic options such as building a Swift-compatible LLDB, building the Swift Package Manager, building for iOS, running tests after builds, and more. It also supports presets, which you can define for common combinations of build options.

To find out more:

utils/build-script -h

Note: Arguments after "--" above are forwarded to build-script-impl, which is the ultimate shell script that invokes the actual build and test commands.

A basic command to build Swift with optimizations and run basic tests with Ninja:

utils/build-script -r -t

Developing Swift in Xcode

build-script can also generate Xcode projects:

utils/build-script -x

The Xcode IDE can be used to edit the Swift source code, but it is not currently fully supported as a build environment for SDKs other than macOS. If you need to work with other SDKs, you'll need to create a second build using Ninja.

Testing Swift

See docs/Testing.rst.

Contributing to Swift

Contributions to Swift are welcomed and encouraged! Please see the Contributing to Swift guide.

To be a truly great community, Swift.org needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make the Swift community welcoming to everyone.

To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and we think it articulates our values well. For more, see the Code of Conduct.