Creating a new project - Revision history

Alpha: Fixed grammar.

2013-02-12T02:00:30Z

Fixed grammar.

Alpha: Added removing file note.

2011-10-14T21:49:16Z

Added removing file note.

Alpha: Added "red text" note.

2011-10-03T23:25:06Z

Added "red text" note.

Alpha: Added programming note.

2011-10-02T17:21:08Z

Added programming note.

Alpha: Small grammar fix.

2011-09-30T01:13:56Z

Small grammar fix.

Alpha: Removed duplicated "and" (thanks Freem).

2011-09-23T22:05:23Z

Removed duplicated "and" (thanks Freem).

Alpha: /* Removing a file */

2011-08-19T21:21:12Z

Removing a file

Alpha at 18:18, 19 August 2011

2011-08-19T18:18:19Z

Alpha: /* Adding a new build target */

2011-08-18T02:21:04Z

Adding a new build target

Alpha at 02:09, 18 August 2011

2011-08-18T02:09:11Z

@@ Line 46: / Line 46: @@
 [[File:NewFile.png]]
-Select '''C/C++ source''' and click '''Go'''. Continue through the following dialogs very much like the original project creation, selecting '''C++''' when prompted for a language. On the final page, you will be presented with several options. The first box will determine the new filename and location (as noted, the full path is required). You may optionally use the '''...''' button to bring up a file browser window to save the file's location. Checking '''Add file to active project''' will store the filename in the '''Sources''' folder of the '''Projects''' tab of the '''Management''' panel. Checking any of the build targets will alert Code::Blocks that the file should be compiled and linked into the selected target(s). This can be useful if, for example, the file contains debug specific code, as it will allow the inclusion (or exclusion) from the a the appropriate build target. In this example, however, the hello function is of key importance, and is required in each target, so select all the boxes and click '''Finish''' to generate the file.
+Select '''C/C++ source''' and click '''Go'''. Continue through the following dialogs very much like the original project creation, selecting '''C++''' when prompted for a language. On the final page, you will be presented with several options. The first box will determine the new filename and location (as noted, the full path is required). You may optionally use the '''...''' button to bring up a file browser window to save the file's location. Checking '''Add file to active project''' will store the filename in the '''Sources''' folder of the '''Projects''' tab of the '''Management''' panel. Checking any of the build targets will alert Code::Blocks that the file should be compiled and linked into the selected target(s). This can be useful if, for example, the file contains debug specific code, as it will allow the inclusion to (or exclusion from) the appropriate build target(s). In this example, however, the hello function is of key importance, and is required in each target, so select all the boxes and click '''Finish''' to generate the file.
 [[File:Hello.cpp.png]]
@@ Line 117: / Line 117: @@
 ==Modifying build options==
-Build targets have come up several times so far. Changing between the two default generated ones - '''Debug''' and '''Release''' - can simply be done through the drop-down list on the '''Compiler Toolbar'''. Each of these targets has the ability to be a different type (for example: static library; console application), contain a different set of source files, custom variables different build flags (for example: debug symbols ''-p''; size optimization ''-Os''; link time optimization ''-flto''), and several other options.
+Build targets have come up several times so far. Changing between the two default generated ones - '''Debug''' and '''Release''' - can simply be done through the drop-down list on the '''Compiler Toolbar'''. Each of these targets has the ability to be a different type (for example: static library; console application), contain a different set of source files, custom variables, different build flags (for example: debug symbols ''-p''; size optimization ''-Os''; link time optimization ''-flto''), and several other options.
 [[File:TargetSelect.png]]

← Older revision		Revision as of 21:49, 14 October 2011
Line 113:		Line 113:

	[[File:RemoveFile.png]]		[[File:RemoveFile.png]]
		+
		+	''Note: removing a file from a project does '''not''' physically delete it; Code::Blocks only removes it from the project management.''

	==Modifying build options==		==Modifying build options==

← Older revision		Revision as of 23:25, 3 October 2011
Line 5:		Line 5:

	[[File:ProjectWizard.png]]		[[File:ProjectWizard.png]]
		+
		+	''Note: red text instead of black text below any of the icons signifies it is using a customized [[Wizard scripts\|wizard script]].''

	The console application wizard will appear next. Continue through the menus, selecting '''C++''' when prompted for a language. In the next screen, give the project a name and type or select a destination folder. As seen below, Code::Blocks will generate the remaining entries from these two.		The console application wizard will appear next. Continue through the menus, selecting '''C++''' when prompted for a language. In the next screen, give the project a name and type or select a destination folder. As seen below, Code::Blocks will generate the remaining entries from these two.

@@ Line 36: / Line 36: @@
      cout << "Hello world!" << endl;
 </source>
-into a separate file. To add the new file to the project, bring up the file template wizard through either ''File->New->File...'' or ''Main Toolbar->New file (button)->File...''
+into a separate file.
 [[File:NewFile.png]]

@@ Line 142: / Line 142: @@
 [[File:VirtualTargets.png]]
-Now if the virtual target '''Releases''' will be available from the '''Compiler Toolbar'''; building this should result in the following output.
+The virtual target '''Releases''' will now be available from the '''Compiler Toolbar'''; building this should result in the following output.
 <small><tt>-------------- Build: Release in HelloWorld ---------------<br>

@@ Line 10: / Line 10: @@
 [[File:ConsoleApplication.png]]
-Finally, the wizard will ask if this project should use the default compiler (normally GCC) and the two default builds: '''Debug''' and '''Release'''. All of these settings are fine. Press finish and and the project will be generated. The main window will turn gray, but that is not a problem, the source file needs only to be opened. In the '''Projects''' tab of the '''Management''' pane on the left expand the folders and double click on the source file '''main.cpp''' to open it in the editor.
+Finally, the wizard will ask if this project should use the default compiler (normally GCC) and the two default builds: '''Debug''' and '''Release'''. All of these settings are fine. Press finish and the project will be generated. The main window will turn gray, but that is not a problem, the source file needs only to be opened. In the '''Projects''' tab of the '''Management''' pane on the left expand the folders and double click on the source file '''main.cpp''' to open it in the editor.
 [[File:SelectSource.png]]

@@ Line 104: / Line 104: @@
 See [[the build process of Code::Blocks]] for what occurs behind the scenes during a compile.
 ===Removing a file===
-Using the above steps, add a new C++ source file, '''useless.cpp''', to the project. Removing this unneeded file from the project is straightforward. Simply right-click on '''useless.cpp''' in the '''Projects''' tab of the '''Management''' pane and select '''Remove file from project'''.[[File:RemoveFile.png]]
+Using the above steps, add a new C++ source file, '''useless.cpp''', to the project. Removing this unneeded file from the project is straightforward. Simply right-click on '''useless.cpp''' in the '''Projects''' tab of the '''Management''' pane and select '''Remove file from project'''.
 ==Modifying build options==
 Build targets have come up several times so far. Changing between the two default generated ones - '''Debug''' and '''Release''' - can simply be done through the drop-down list on the '''Compiler Toolbar'''. Each of these targets has the ability to be a different type (for example: static library; console application), contain a different set of source files, custom variables different build flags (for example: debug symbols ''-p''; size optimization ''-Os''; link time optimization ''-flto''), and several other options.

@@ Line 2: / Line 2: @@
 This page is a guide to many of the beginning (and some intermediate) features of the creation and modification of a Code::Blocks project. If this is your first experience with Code::Blocks, here is a good starting point.
 ==The project wizard==
 Launch the Project Wizard through ''File->New->Project...'' to start a new project. Here there are many pre-configured templates for various types of projects, including the option to create custom templates. Select '''Console application''', as this is the most common for general purposes, an click '''Go'''.
 The console application wizard will appear next. Continue through the menus, selecting '''C++''' when prompted for a language. In the next screen, give the project a name and type or select a destination folder. As seen below, Code::Blocks will generate the remaining entries from these two.
@@ Line 9: / Line 10: @@
 [[File:ConsoleApplication.png]]
-[[File:SelectSource.png|right]]Finally, the wizard will ask if this project should use the default compiler (normally GCC) and the two default builds: '''Debug''' and '''Release'''. All of these settings are fine. Press finish and and the project will be generated. The main window will turn gray, but that is not a problem, the source file needs only to be opened. In the '''Projects''' tab of the '''Management''' pane on the left expand the folders and double click on the source file '''main.cpp''' to open it in the editor. This file contains the following standard code.
+Finally, the wizard will ask if this project should use the default compiler (normally GCC) and the two default builds: '''Debug''' and '''Release'''. All of these settings are fine. Press finish and and the project will be generated. The main window will turn gray, but that is not a problem, the source file needs only to be opened. In the '''Projects''' tab of the '''Management''' pane on the left expand the folders and double click on the source file '''main.cpp''' to open it in the editor.
 ''main.cpp''
@@ Line 34: / Line 39: @@
 [[File:NewFile.png]]
-[[File:Hello.cpp.png|right]]
 Select '''C/C++ source''' and click '''Go'''. Continue through the following dialogs very much like the original project creation, selecting '''C++''' when prompted for a language. On the final page, you will be presented with several options. The first box will determine the new filename and location (as noted, the full path is required). You may optionally use the '''...''' button to bring up a file browser window to save the file's location. Checking '''Add file to active project''' will store the filename in the '''Sources''' folder of the '''Projects''' tab of the '''Management''' panel. Checking any of the build targets will alert Code::Blocks that the file should be compiled and linked into the selected target(s). This can be useful if, for example, the file contains debug specific code, as it will allow the inclusion (or exclusion) from the a the appropriate build target. In this example, however, the hello function is of key importance, and is required in each target, so select all the boxes and click '''Finish''' to generate the file.
 The newly created file should open automatically; if it does not, open it by double clicking on its file in the '''Projects''' tab of the '''Management''' panel. Now add in code for the function '''main.cpp''' will call.
@@ Line 62: / Line 69: @@
 #endif // HELLO_H_INCLUDED
 </source>
-[[File:TargetBelonging.png|right]]
 Save this file as a header ('''hello.h''') in the same directory as the other source files in this project. Back in Code::Blocks, click ''Project->Add files...'' to open a file browser. Here you may select one or multiple files (using combinations of ''Ctrl'' and ''Shift''). (The option ''Project->Add files recursively...'' will search through all the subdirectories in the given folder, selecting the relevant files for inclusion.)  Select '''hello.h''', and click '''Open''' to bring up a dialog requesting to which build targets the file(s) should belong. For this example, select both targets.
 ''Note: if the current project has only one build target, this dialog will be skipped.''
@@ Line 97: / Line 106: @@
 Using the above steps, add a new C++ source file, '''useless.cpp''', to the project. Removing this unneeded file from the project is straightforward. Simply right-click on '''useless.cpp''' in the '''Projects''' tab of the '''Management''' pane and select '''Remove file from project'''.[[File:RemoveFile.png]]
 ==Modifying build options==
 Build targets have come up several times so far. Changing between the two default generated ones - '''Debug''' and '''Release''' - can simply be done through the drop-down list on the '''Compiler Toolbar'''. Each of these targets has the ability to be a different type (for example: static library; console application), contain a different set of source files, custom variables different build flags (for example: debug symbols ''-p''; size optimization ''-Os''; link time optimization ''-flto''), and several other options.
 Open ''Project->Properties...'' to access the main properties of the active project, '''HelloWorld'''. Most of the settings on the first tab, '''Project settings''', are rarely changed. '''Title:''' allows the name of the project to be changed. If '''Platforms:''' is changed to something other than its default '''All''', Code:Blocks will only allow the project to build on the selected targets. This is useful if, for example, the source code contains Windows API, and would therefore be invalid anywhere but Windows (or any other operating system specific situations). The '''Makefile:''' options are used only if the project should use a makefile instead of Code::Blocks' internal build system (see [[Code::Blocks and Makefiles]] for further details).
 ===Adding a new build target===
 Switch to the '''Build targets''' tab. Click '''Add''' to create a new build target and name it '''Release Small'''. The highlight in the left hand column should automatically switch to the new target (if not, click on it to change the focus). As the default setting for '''Type:''' -  "GUI application" - is incorrect for the '''HelloWorld''' program, change it to "Console application" via the drop-down list. The output filename '''HelloWorld.exe''' is fine except in that it will cause the executable to be output in the main directory. Add the path "bin\ReleaseSmall\" (Windows) or "bin/ReleaseSmall/" (Linux) in front of it to change the directory (it is a relative path from the root of the project). The '''Execution working dir:''' refers to where the program will be executed when '''Run''' or '''Build and run''' are selected. The default setting "." is fine (it refers to the project's directory). The '''Objects output dir:''' needs to be changed to "obj\ReleaseSmall\" (Windows) or "obj/ReleaseSmall/" (Linux) in order to be consistent with the remainder of the project. The '''Build target files:''' currently has nothing selected. This is a problem, as nothing will be compiled if this target is built. Check all the boxes.
 The next step is to change the target's settings. Click '''Build options...''' to access the settings. The first tab the comes up has a series of compiler flags accessible through check boxes. Select "Strip all symbols from binary" and "Optimize generated code for size". The flags here contain many of the more common options, however, custom arguments may be passed. Switch to the '''Other options''' sub-tab and add the following switches.
@@ Line 124: / Line 135: @@
 ===Virtual Targets===
-[[File:VirtualTargets.png|right]]
+Click '''OK''' to accept these changes and return to the previous dialog. Now that there are two release builds, it will take two separate runs of '''Build''' or '''Build and run''' to compile both. Fortunately, Code::Blocks provides the option to chain multiple builds together. Click '''Virtual targets...''', then '''Add'''. Name the virtual target '''Releases''' and click '''OK'''. In the right-hand '''Build targets contained''' box, select both '''Release''' and '''Release small'''. Close out of this box and hit '''OK''' on the main window.
 Click '''OK''' to accept these changes and return to the previous dialog. Now that there are two release builds, it will take two separate runs of '''Build''' or '''Build and run''' to compile both. Fortunately, Code::Blocks provides the option to chain multiple builds together. Click '''Virtual targets...''', then '''Add'''. Name the virtual target '''Releases''' and click '''OK'''. In the right-hand '''Build targets contained''' box, select both '''Release''' and '''Release small'''. Close out of this box and hit '''OK''' on the main window. Now if the virtual target '''Releases''' will be available from the '''Compiler Toolbar'''; building this should result in the following output.
 <small><tt>-------------- Build: Release in HelloWorld ---------------<br>

@@ Line 107: / Line 107: @@
 The next step is to change the target's settings. Click '''Build options...''' to access the settings. The first tab the comes up has a series of compiler flags accessible through check boxes. Select "Strip all symbols from binary" and "Optimize generated code for size". The flags here contain many of the more common options, however, custom arguments may be passed. Switch to the '''Other options''' sub-tab and add the following switches.
-<tt>-ffunction-sections<br>
+<tt>-fno-rtti<br>
 -fdata-sections<br>
 -flto</tt>
@@ Line 120: / Line 122: @@
 to the '''Other linker options:''' tab. (For further details on what these switches do, see the GCC documentation on [http://gcc.gnu.org/onlinedocs/gcc-4.5.3/gcc/Optimize-Options.html optimization options] and [http://gcc.gnu.org/onlinedocs/gcc-4.5.3/gcc/Link-Options.html linker options].)
 ===Virtual Targets===
 [[File:VirtualTargets.png|right]]

@@ Line 1: / Line 1: @@
 [[Category: User Documentation]]
-'''This is a work in progress, and may be missing key details.'''
+This page is a guide to many of the beginning (and some intermediate) features of the creation and modification of a Code::Blocks project. If this is your first experience with Code::Blocks, here is a good starting point.
 ==The project wizard==
 [[File:ProjectWizard.png|right]]
@@ Line 94: / Line 94: @@
 See [[the build process of Code::Blocks]] for what occurs behind the scenes during a compile.
 ==Modifying build options==
 [[File:TargetSelect.png|right]]
 Build targets have come up several times so far. Changing between the two default generated ones - '''Debug''' and '''Release''' - can simply be done through the drop-down list on the '''Compiler Toolbar'''. Each of these targets has the ability to be a different type (for example: static library; console application), contain a different set of source files, custom variables different build flags (for example: debug symbols ''-p''; size optimization ''-Os''; link time optimization ''-flto''), and several other options.
 Open ''Project->Properties...'' to access the main properties of the active project, '''HelloWorld'''. Most of the settings on the first tab, '''Project settings''', are rarely changed. '''Title:''' allows the name of the project to be changed. If '''Platforms:''' is changed to something other than its default '''All''', Code:Blocks will only allow the project to build on the selected targets. This is useful if, for example, the source code contains Windows API, and would therefore be invalid anywhere but Windows (or any other operating system specific situations). The '''Makefile:''' options are used only if the project should use a makefile instead of Code::Blocks' internal build system (see [[Code::Blocks and Makefiles]] for further details).
 [[File:TargetOptions.png|right]]
-Switch to the '''Build targets''' tab. Click '''Add''' to create a new build target and name it '''Release Small'''. The highlight in the left hand column should automatically switch to the new target (if not, click on it to change the focus). As the default setting for '''Type:''' -  "GUI application" - is incorrect for the '''HelloWorld''' program, change it to "Console application" via the drop-down list. The output filename '''HelloWorld.exe''' is fine except in that it will cause the executable to be output in the main directory. Replace it with '''bin\ReleaseSmall\HelloWorld.exe''' (Windows) or '''bin/ReleaseSmall/HelloWorld.exe''' (Linux) to change the directory (it is a relative path from the root of the project).
+Switch to the '''Build targets''' tab. Click '''Add''' to create a new build target and name it '''Release Small'''. The highlight in the left hand column should automatically switch to the new target (if not, click on it to change the focus). As the default setting for '''Type:''' -  "GUI application" - is incorrect for the '''HelloWorld''' program, change it to "Console application" via the drop-down list. The output filename '''HelloWorld.exe''' is fine except in that it will cause the executable to be output in the main directory. Add the path "bin\ReleaseSmall\" (Windows) or "bin/ReleaseSmall/" (Linux) in front of it to change the directory (it is a relative path from the root of the project). The '''Execution working dir:''' refers to where the program will be executed when '''Run''' or '''Build and run''' are selected. The default setting "." is fine (it refers to the project's directory). The '''Objects output dir:''' needs to be changed to "obj\ReleaseSmall\" (Windows) or "obj/ReleaseSmall/" (Linux) in order to be consistent with the remainder of the project. The '''Build target files:''' currently has nothing selected. This is a problem, as nothing will be compiled if this target is built. Check all the boxes.