Apple Developer Tools IDE User Manual

 About Xcode 4
Developer tools for Mac OS X 10.6 Snow Leopard and iOS 4
Contents
Introduction
What’s New
About SDKs
Installation
Deprecation Notice
Introduction
Xcode is the complete developer toolset for creating applications for Mac, iPhone, and iPad.
This package installs the Xcode IDE, the Instruments analysis tool, iOS Simulator, and OS
framework bundles in the form of Mac OS X SDKs and iOS SDKs.
What’s New in Xcode 4
•
Xcode 4 has a brand new, single window interface for all major workflows
•
Interface Builder is now integrated within the main Xcode IDE
•
•
Assistant shows a paired editor with complementary files, e.g.: header or UI controller
Version editor shows a live comparison through SCM history, using Git or Subversion
•
•
Live Issues display coding errors as you type, and Fix-it can correct the mistake for you
Tabs save a unique screen layout for each task, e.g. debugging, editing, designing
•
LLVM compiler 2.0 includes full support for C, Objective-C, and now C++
•
•
LLDB debugger is faster, and uses less memory than the GDB debugging engine
Instruments adds System Trace, and new iOS instruments including OpenGL ES
Compatibility: Xcode 4 requires an Intel-based Mac running Mac OS X 10.6.6 or later, and
includes SDKs for Mac OS X 10.6 and iOS 4.3. To develop apps targeting prior versions of
Mac OS X or iOS, see the section titled About SDKs and the iOS Simulator below.
Xcode 4 does not support developing for PowerPC; you must continue to use Xcode 3.2.6 to
develop applications for the PowerPC architecture. The Custom Install section below has
instructions to install both Xcode 4 and Xcode 3.2.6 on the same Mac.
Developer Resources: The Mac and iOS Developer Programs provide access to the App
Store, additional support and documentation, as well as provisioning resources to enable
testing and deployment on an iPhone, iPod touch, or iPad device. For more information visit:
for iOS:!
for Mac: !
http://developer.apple.com/programs/ios/
http://developer.apple.com/programs/mac/
For discussions about any Apple developer software, including pre-release products, please
visit the Apple Developer Forums, at: http://devforums.apple.com/
New in Xcode 4
•
Xcode 4 uses a completely new, single window interface for organizing your project. It
is now possible to create a workspace that can contain multiple projects, as well as
references to files elsewhere on disk. Common Xcode operations such as search and
replace will execute across all files within a workspace. Xcode 4 does not require the
use of a workspace, and is compatible with Xcode 3.2 projects.
•
The Jump Bar is a path control at the top of the editor windows that allows you to click
at any location within the bar and quickly jump to peers of that folder or file.
•
The Navigator pane on the left of the window, opened by the menu View -> Navigators,
contains access to all the active information in your current project(s). Source files,
build errors, logs, debugging stack traces, and more are collected here.
•
The Utility pane on the right of the window, opened by the menu View -> Utilities,
contains file inspectors, Quick Help for the selected text, and libraries of file templates,
code snippets, Interface Builder objects, and your system media.
•
Interface Builder is now integrated into the Xcode window. Selecting a .xib/.nib file via
the Jump Bar or Project Navigator will open the IB editor. File and object inspectors are
available via the View -> Utilities menu item. It is now possible to drag connections from
objects on the design canvas directly to code in the accompanying source editor. A
small dialog will ask if you wish to create an action or outlet, or you can select existing
code to receive the connection. The interface will be connected for you, and the code
stub will be generated, if necessary, at the point where you dragged the connection.
•
Assistant editor (View -> Editor menu, or toolbar button) will split the Xcode 4 single
editor window into a pair of windows, with your primary document on the left, and a
complementary file on the right. You can use the button on the far left of the Jump Bar
at the top of the editor pane to tell the Assistant what type of files you would like to see:
counterparts, sub/superclasses, actions or outlets, or others. The Assistant can also
auto-select files you may wish to see, as you are coding.
•
Version editor (View -> Editor menu, or toolbar button) is part of the completely rebuilt
source control management (SCM) support of Xcode 4. The Version editor makes it
easy to compare two versions of a file, see commit logs, check blame, and even zoom
back along the commit timeline. Xcode’s SCM support also adds support for branching
and merging, as well as full support for Git to go along with Subversion. The repository
browser is now located in the Organizer window, along with documentation and device
management.
•
Fix-it works in conjunction with Xcode build errors to present you not just the error, but
also an option to immediately fix the problem without writing any code. If a Fix-it is
available, clicking the error indicator beside the code will show a pop-up window listing
the available fixes. Pick the appropriate fix, and Xcode will repair the mistake for you.
•
Live Issues detect and alert you to coding errors as you type; there is no need to build
the project first. Live Issues also work with Fix-it, making it easy to see your mistake,
correct it, and continue coding without missing a beat.
•
The Product -> Analyze menu item can be thought of as “super warnings”, detected by
using Xcode’s built-in static analyzer. The Analyze command will do a deep inspection
of your code, walking down most possible code paths, to identify potential coding
mistakes and logical errors. Found problems can be viewed in the editor as message
bubbles which, when clicked, will display arrows that walk through the steps that can
create the error. The static analyzer performs an in-depth analysis of application
behavior, and is a great complement to the Live Issues and Fix-it features.
•
Schemes allow you to preconfigure the build, deploy, run, and test products and
configurations for each of the most common tasks during development. For instance,
the default scheme setup will configure your project to build in Debug mode when you
execute the Run command (CMD-R), allowing you to debug by simply turning on
breakpoints. The same scheme will build for Release when you perform the Profile or
Archive command. Schemes are setup for you automatically when you create a new
project, and you can use the “Manage Schemes” menu to set them up however you like.
•
New optional LLVM compiler 2.0 uses the much faster Clang front-end parser coupled
with the LLVM back-end compiler for the fastest available compile time, and best
performing generated code for C/C++ and Objective-C. For maximum compatibility with
GCC use the default LLVM GCC 4.2 compiler which employs the LLVM back-end for
superior code generation, but uses the GCC front end parser.
NOTE: to choose the LLVM compiler, click on your project item in the Project
navigator, choose a project or target, and select the Build Settings tab. The build
option “C/C++ Compiler Version” is used to select which compiler to use.
•
New optional LLDB debugger is available to replace the default GDB debugging engine,
providing a faster launch time, and less memory overhead. To enable LLDB, from the
Xcode menu bar select Product -> Edit “My Scheme”. The default “Launch” scheme
has an option for Debugger which can be selected to GDB (default) or LLDB, to be run
when Xcode launches the debugger.
•
Instruments now offers the ability to set a time filter, and to zoom in/out with accuracy to
the nanosecond. New keyboard shortcuts include:
!
!
•
- Time Filter:! (option + mouse click and drag)
- Zoom in: ! (shift + mouse click and drag)
- Zoom out:! (control + mouse click and drag)
Instruments’ new System Trace template configures to simultaneously record system
calls, virtual memory operations, and scheduling events. The System Trace template
combined with the new Thread Strategy view makes understanding the behavior of your
overall system even easier. Workflows using the single-window interface of Xcode 4
Xcode 4 includes new features to make your workflows more automated, and easier to
manage on screen: tabs, editor panes, and behaviors. These features work together to
scale the single window interface of Xcode 4 to effectively use available screen real
estate, from the smallest MacBook Air, up to Macs equipped with multiple monitors.
•
Editors: The built-in editor modes, Standard, Assistant, and Version, are designed to
present the most critical information, in context, as you work. In addition to these
standard editor layouts, clicking the icon on the far-right of the Jump Bar will split the
current editor pane. The split editors have their own history, and Assistant editor splits
can each present counterparts as you work in the primary editor. The General
preferences pane configures document open behaviors, such as option-click to open in
the Assistant editor, or double-click to open the document in a new window or tab.
•
Tabs: Much like in Safari, each Xcode 4 tab is an independent view of the complete
work area. Selecting File -> New Tab (or pressing CMD-T) will create a new tab view of
your current workspace, with its own Navigator/Utility geometry, debug area, and editor
layout. Tabs and their customized layout are preserved between launches of Xcode 4,
and double clicking the tab’s label will give it a permanent name. For computers with a
lot of screen space, tear a tab off and move it wherever you like. Configure a tab for
Interface Builder design tasks, debugging activities, code editing, and more.
•
Behaviors: Certain tasks are common during development, among them Build, Test,
and Run. The Behaviors preferences panel configures specific actions or changes in
state within the IDE when you perform these tasks. For example, when a Run starts,
Xcode can automatically switch to a tab called Debug (or the IDE will create the tab for
you). As described above, each tab can be independently configured, making it easy to
trigger a different Xcode layout depending on the behavior active at the time.
About SDKs and the iOS Simulator
This package includes two types of SDKs: Mac OS X and iOS. The Mac OS X SDKs include
frameworks and headers that allow you to target the corresponding Mac OS X version number.
The iOS SDK works similarly, but also includes frameworks to target the iOS Simulator.
There are two important settings in the build system related to SDKs and the OS you are
targeting: the Base SDK, and the Mac OS X or iOS Deployment Target.
•
Base SDK defines the set of frameworks used to build your application. Keeping this
set to Latest will automatically migrate your project to the newest SDK available.
•
Deployment Target refers to the minimum OS you wish to support with your
application, for example the previous major release.
To build your app to work on older OSs, for instance Mac OS X 10.5 Leopard, set the project
setting Base SDK to “Latest”, and set Mac OS X Deployment Target to “Mac OS X 10.5”.
NOTE: for final qualification on a specific version of iOS you must test on a device.
For the latest security information visit: http://support.apple.com/kb/HT1222
For more detailed information please see the complete Xcode release notes.
Installation
The Xcode and iOS SDK installer provides several options for configuring the installation from
the “Customize...” button:
•
Essentials: contains all required components of Xcode, installed by default in /
Developer or another directory of your choice, including external volumes.
Xcode Toolset: installs the core Xcode IDE, the Mac OS X SDKs, and many
other developer tools. This is a required package and cannot be un-selected.
iOS SDK: contains the iOS frameworks, tools, and iOS Simulator. If you do not
agree to the iOS license agreement, this package will be unavailable. If unselected, Xcode will install with only the Mac OS X SDKs.
•
System Tools: installs system-level tools for performance analysis, and for system
monitoring from within the Instruments application.
•
UNIX Development: command-line tools such as compilers, linkers, and build tools.
The components are always placed in /usr with only one version installed at a time.
•
Documentation: checked by default, Xcode will download developer documentation in
the background for offline reading, and automatically download documentation updates
as well. If unchecked, the documentation will be read from the web instead of the local
disk. The download setting can be changed after install via Preferences.
Throughout this document <Xcode> refers to the path in which the Developer Tools
Essentials components are installed, which defaults to /Developer. You can have multiple
versions of the Xcode toolset installed. You can move or rename the <Xcode> directory, but
must not alter its internal structure.
NOTE: Only one version of the System Tools and the UNIX Development components can be
installed on a computer at a time. The last installed set of these components replaces any
previously installed set.
Custom Install: Step-by-Step
By default, Xcode 4 installs in the folder /Developer - but if you wish to install it in a different
folder, allowing it to co-exist with previous Xcode 3.2 installations, you can change this
location. You do this by selecting "Custom Install" and specifying a new <Xcode> directory, or
rename the existing Xcode home directory ( /Developer ) before installing this new version.
See step 4 below.
!
1.
Boot into a partition with the required version of Mac OS X installed.
2.
Download the Xcode installation package.
3.
Double-click on the .mpkg Installer package (icon is an open brown box).
4.
To install Xcode in a directory other than the default /Developer, you must specify a
new <Xcode> directory name on the “Custom Install” pane
⁃
Select the folder icon under “Location” next to the “Essentials” package.
-!
⁃
⁃
⁃
Select “Other...” at the top of the pop-up.
Navigate to the location for the new <Xcode> folder. Select “New Folder”.
Enter a folder name in the “New Folder” window; Select “Create”.
Finally, select “Choose” at the bottom of the selection pane.
5.
Authenticate as an administrative user. The first user you create when setting up Mac
OS X has administrator privileges by default.
Once you have installed the Xcode developer tools, you can access the documentation by
launching Xcode and choosing any of the items in the Help menu. Developer applications such
as Xcode, Instruments, and Interface Builder are installed in <Xcode>/Applications.
Uninstalling Xcode Developer Tools
To uninstall Xcode developer tools on the boot volume along with the <Xcode> directory, from
a Terminal window type:
$ sudo <Xcode>/Library/uninstall-devtools --mode=all
To remove the underlying developer content on the boot volume, but leave the <Xcode>
directory and supporting files untouched, from a Terminal window type:
$ sudo <Xcode>/Library/uninstall-devtools --mode=systemsupport
To just remove the UNIX development support on the boot volume, but leave the <Xcode>
directory and supporting files untouched, from a Terminal window type:
$ sudo <Xcode>/Library/uninstall-devtools --mode=unixdev
Finally, to just uninstall the <Xcode> directory you can simply drag it to the trash, or from a
Terminal window type:
$ sudo <Xcode>/Library/uninstall-devtools --mode=xcodedir
NOTE: The uninstaller that ships with previous versions of the Xcode developer tools will not
clean everything off of your system properly. You should use the one installed with these
Xcode developer tools.
Deprecation Notice
Plug-ins (IBPlugins) for Interface Builder 3.x, for integrating custom controls and inspectors,
are not supported within Xcode 4. The Xcode 4 design canvas, inspectors, library, and other
integrated Interface Builder functionality cannot be used with these plugins to edit existing, or
design new .xib/.nib files. Projects that contain existing files originally designed with these
plugins continue to build in Xcode 4. If you need to actively support these .xib/.nib files, it is
recommended that you also install Xcode 3.2, as described in the Custom Install section.
Copyright © 2010-2011 Apple Inc. All rights reserved. Apple, the Apple logo, Mac, Mac OS, Macintosh, iPhone,
and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries.
IOS is a trademark or registered trademark of Cisco in the U.S and other countries and is used under license.
">