Xcode Project - Revision history

Dan Tobias: /* Links and references */

2015-06-09T04:22:03Z

‎Links and references

Dan Tobias at 00:05, 16 January 2015

2015-01-16T00:05:27Z

Dan Tobias: /* Project-related files outside the .xcodeproj file */

2014-06-03T15:45:34Z

‎Project-related files outside the .xcodeproj file

Dan Tobias at 16:22, 26 February 2013

2013-02-26T16:22:58Z

Dan Tobias: /* Project-related files outside the .xcodeproj file */

2013-02-01T19:06:36Z

‎Project-related files outside the .xcodeproj file

Dan Tobias: Created page with "{{FormatInfo |subcat=Development |extensions={{ext|xcodeproj}} }} '''Xcode''' is Apple's development environment for creating apps for OS X and iOS. It runs on OS X systems (..."

2013-01-27T15:20:50Z

Created page with "{{FormatInfo |subcat=Development |extensions={{ext|xcodeproj}} }} '''Xcode''' is Apple's development environment for creating apps for OS X and iOS. It runs on OS X systems (..."

New page

{{FormatInfo
|subcat=Development
|extensions={{ext|xcodeproj}}
}}

'''Xcode''' is Apple's development environment for creating apps for OS X and iOS. It runs on OS X systems (current Macintosh platforms) but also cross-compiles and simulates the running of apps for iOS (for iPhones, iPads, etc.).

An Xcode project file, with the extension '''.xcodeproj''', is actually a subdirectory (folder). This is common in OS X file formats these days; the Finder treats them as single files and opens the appropriate application (Xcode in this case) when they are clicked, but they can be seen as directories when you go into the Unix-based command-line terminal (where you can use the "cd" command to enter these directories, and the "ls" command to list them, like any other directory), or when you access them over a network from a non-Apple operating system.

The .xcodeproj file/directory/folder contains various files related to the development project it is part of. However, the actual program source files aren't in it. There is, in fact, an entire cluster of files and directories that are created by Xcode in conjunction with a newly-created project, and only some of them are within the .xcodeproj "file".

== Project-related files outside the .xcodeproj file ==

When you create a project called "MyProject", Xcode will create a directory (a regular one, which looks and acts like a folder to Finder, not a special kind of directory like the .xcodeproj file which acts like a single file) called ''MyProject'' beneath whatever location you selected in which the project should be placed (your desktop, your user home directory, some subdirectory of it, etc.). All files related to the project get placed within this directory.

Within this directory is found these items (they may vary depending on the version of Xcode and the target operating system of the app, as well as other characteristics of the project):

* Another subdirectory also named ''MyProject''. This has the rather redundant path ''MyProject/MyProject''. All the "content" files of your project such as program sources end up placed within this. Under this directory are:
** '''.m''' and '''.h''' source files of [[Objective-C]]
** ''MyProject'''''-info.plist''', a file with some overall settings of the project/app, expressed in [[Property List/XML]] format.
** ''MyProject'''''-Prefix.pch''', a [[precompiled header file]] with global headers to be prefixed to the source files
** Language-specific '''.lproj''' subdirectories (e.g., ''en.lproj'' for English); there may be several if the app is being localized for multiple languages. Under this directory are:
*** [[Strings File]]s ('''.strings''') giving localized strings to be used in the program for a particular language (e.g., ''Localizable.strings'', ''InfoPlist.strings''). These are in the [[UTF-8]] text-based format of strings files here, but get converted to other formats ([[UTF-16]] or binary) to be placed within the app file when a project is built.
*** [[Nib file]]s, [[Xib file]]s, or [[Storyboard file]]s, depending on the Xcode version and target OS. These set up user interfaces.
*** '''Credits.rtf''': this [[RTF]] (Rich Text Format) file gives program credits to be shown within the help menu of the app.
* ''MyProject''''' Tests''': Another directory parallel to the one with all the project source files but within the top-level directory of the project; it contains files of similar types to the project sources, but instead of containing the app sources themselves, it contains sources for automated tests to be run on the app.
* ''MyProject'''''.xcodeproj''': Finally you get to the Xcode project file itself, actually a subdirectory. Its contents are described in the next section.

== Contents of the .xcodeproj file ==

* '''project.pbxproj''': The main "project file within the project file". It is in a format which somewhat resembles [[C]] program code, but made extremely cryptic through the use of lots of raw hexadecimal constants. Lots of settings related to the project are configured here.
* '''project.xcworkspace''': A subdirectory that stores things related to user workspaces within the project.
** '''contents.xcworkspacedata''': An [[XML]] file listing the top-level-entity projects that are part of this project.
** '''xcuserdata''': A subdirectory containing data relating to specific users of the project.
*** ''username'''''.xcuserdatad''': Subdirectories named with the username of the developer; there may be multiple such directories in a multi-user project. Each of these stores data related to a particular user's workspace status.
**** '''UserInterfaceState.xcuserstate''': A [[Property List/Binary]] file giving the state of the user's workspace (what files are open, the cursor position in them, etc.)
* '''xcuserdata''': Another directory with user-specific info, this one directly within the project file/directory.
** '''xcuserdata''': A subdirectory containing data relating to specific users of the project.
*** '''xcschemes''': A directory within the user space.
**** ''MyProject'''''.xcscheme''': An [[XML]] file.
**** '''xcschememanagement.plist''': A [[Property List/XML]] file.

== Links and references ==

* Stack Overflow discussions on the meaning and relevance of these files:
** [http://stackoverflow.com/questions/10956312/is-the-project-xcworkspace-file-important Is the project xcworkspace file important?]
** [http://stackoverflow.com/questions/5931788/iphone-dev-how-important-is-project-pbxproj How important is pbxproj?]
** [http://stackoverflow.com/questions/6770472/what-do-all-the-changes-to-xuserstate-and-xcscheme-files-represent What do all the changes to xuserstate and xscheme files represent?]
** [http://stackoverflow.com/questions/2845211/ios-prefix-pch-best-practices Discussion of -prefix.pch best practices]

[[Category:Macintosh]]

← Older revision		Revision as of 16:22, 26 February 2013
Line 51:		Line 51:

	[[Category:Macintosh]]		[[Category:Macintosh]]
		+	[[Category:Apple]]

@@ Line 50: / Line 50: @@
 ** [http://stackoverflow.com/questions/6770472/what-do-all-the-changes-to-xuserstate-and-xcscheme-files-represent What do all the changes to xuserstate and xscheme files represent?]
 ** [http://stackoverflow.com/questions/2845211/ios-prefix-pch-best-practices Discussion of -prefix.pch best practices]
 [[Category:Macintosh]]
 [[Category:Apple]]

@@ Line 6: / Line 6: @@
 '''Xcode''' is Apple's development environment for creating apps for OS X and iOS. It runs on OS X systems (current Macintosh platforms) but also cross-compiles and simulates the running of apps for iOS (for iPhones, iPads, etc.).
-An Xcode project file, with the extension '''.xcodeproj''', is actually a subdirectory (folder). This is common in OS X file formats these days; the Finder treats them as single files and opens the appropriate application (Xcode in this case) when they are clicked, but they can be seen as directories when you go into the Unix-based command-line terminal (where you can use the "cd" command to enter these directories, and the "ls" command to list them, like any other directory), or when you access them over a network from a non-Apple operating system.
+An Xcode project file, with the extension '''.xcodeproj''', is actually a subdirectory (folder). This is common in OS X file formats these days (and is known as a [[Bundle file (OS X)|bundle file]]); the Finder treats them as single files and opens the appropriate application (Xcode in this case) when they are clicked, but they can be seen as directories when you go into the Unix-based command-line terminal (where you can use the "cd" command to enter these directories, and the "ls" command to list them, like any other directory), or when you access them over a network from a non-Apple operating system.
 The .xcodeproj file/directory/folder contains various files related to the development project it is part of. However, the actual program source files aren't in it. There is, in fact, an entire cluster of files and directories that are created by Xcode in conjunction with a newly-created project, and only some of them are within the .xcodeproj "file".

@@ Line 18: / Line 18: @@
 * Another subdirectory also  named ''MyProject''. This has the rather redundant path ''MyProject/MyProject''. All the "content" files of your project such as program sources end up placed within this. Under this directory are:
 ** '''.m''' and '''.h''' source files of [[Objective-C]]
 ** Other resources used in the project such as graphic files, if the developer put them into the project directory instead of just referencing them elsewhere.
 ** ''MyProject'''''-info.plist''', a file with some overall settings of the project/app, expressed in [[Property List/XML]] format.