Code::Blocks - User contributions [en]

Using Xming for remote compilation

2009-11-13T15:56:04Z

Scaryjeff: More detailed introduction

[[Category:User Documentation]]
== Introduction ==

This article explains how to set up true remote compilation, without using any local file stores. Note that it assumes a custom makefile, and that to actually edit your files in C::B, the remote source directories must be shared, and mapped to a local drive.
Typically this will use a samba share on the remote system, but it is possible to map FTP or SFTP servers to windows drives as well.

The method described is for remote compiling where C::B is running on a windows system, and the remote compilation is to take place on a linux system. An instance of C::B running on Linux or Mac should be able to use a similar method, using 'ssh' as the 'make' command, employing a 'keys' file to avoid being prompted for an ssh password.

== Method ==

'''Step 1'''

Download and install Xming (windows X server) from http://sourceforge.net/projects/xming/ . It will sit in the systray.

'''Step 2'''

Open or create your project, and choose any compiler you have installed that actually works (i.e. doesn't give you an 'Invalid Compiler' message when you try to build). The easiest way to achieve this is to use the C::B installer that includes MinGW. It doesn't matter if your remote compiler is completely different to the one you choose here.

'''Step 3:'''

In the project properties, "Project Settings", select "This is a custom Makefile", <OK>. Now in the project build options, "'Make' Commands", enter:
$make -X -ssh RemoteUser@RemoteIP -pw RemotePassword ''make all'' -C /path/to/remote/makefile/
Note that your remote password is stored in plaintext, not everyone will like this! Also, the path to the remote makefile is relative to the root of the remote machine, for example /home/username/myproject. 

The ''make all'' is specific to my Makefile. You can obviously modify this for the different build types implemented in your Makefile. I set all the make commands to be the same, with the exception of "Clean project/target", where I used ''make clean'', which is implemented in my Makefile. Do this for all the build profiles (in my case, "Debug" and "Release"). <OK>.

'''Step 4 (nightly builds only)'''

If you are using a C::B build newer than January 2009, you may need to fill in the "Ask if rebuild is needed" make command in the "'Make' Commands" tab. This is the same command as in step 3, but with ''make -q'' in place of ''make all''. For the 11/11/09 nightly build, I had to use ''make-q'' (i.e. without the space) for this to work. You must also change "Settings", "Compiler and debugger", "Global compiler settings", "Other settings", "Compiler logging" to "Full command line", or else you will receive a "Nothing to be done." message when you try to build.

'''Step 5'''

In "Settings", "Compiler and debugger", "Global compiler settings", "Toolchain executables", change the "Make program" to "plink.exe", and add the Xming install path in the "Additional paths" tab (typically "C:\Program Files\Xming").

'''Step 6'''

Build the project. The first time you do this, you will be prompted with a "PuTTY Security Alert". Click "Yes" and the remote server will be added to your list of trusted hosts. Note that if you have used PuTTY before, this can go wrong. If you are being prompted for a username and password, try deleting the registry key "HKEY_CURRENT_USER/Software/Simon Tatham/PuTTY". Note that this could mess up your PuTTY configurations (it might not; this was not checked).

Using Xming for remote compilation

2009-11-13T15:48:12Z

Scaryjeff: added category

[[Category:User Documentation]]
== Introduction ==

This article explains how to set up true remote compilation, without using any local file stores. Note that it assumes a custom makefile, and is for remote compiling where C::B is running on a windows system, and the remote compilation is to take place on a linux system. An instance of C::B running on Linux or Mac should be able to use a similar method, using 'ssh' as the 'make' command, employing a 'keys' file to avoid being prompted for an ssh password.

== Method ==

'''Step 1'''

Download and install Xming (windows X server) from http://sourceforge.net/projects/xming/ . It will sit in the systray.

'''Step 2'''

Open or create your project, and choose any compiler you have installed that actually works (i.e. doesn't give you an 'Invalid Compiler' message when you try to build). The easiest way to achieve this is to use the C::B installer that includes MinGW. It doesn't matter if your remote compiler is completely different to the one you choose here.

'''Step 3:'''

In the project properties, "Project Settings", select "This is a custom Makefile", <OK>. Now in the project build options, "'Make' Commands", enter:
$make -X -ssh RemoteUser@RemoteIP -pw RemotePassword ''make all'' -C /path/to/remote/makefile/
Note that your remote password is stored in plaintext, not everyone will like this! Also, the path to the remote makefile is relative to the root of the remote machine, for example /home/username/myproject. 

The ''make all'' is specific to my Makefile. You can obviously modify this for the different build types implemented in your Makefile. I set all the make commands to be the same, with the exception of "Clean project/target", where I used ''make clean'', which is implemented in my Makefile. Do this for all the build profiles (in my case, "Debug" and "Release"). <OK>.

'''Step 4 (nightly builds only)'''

If you are using a C::B build newer than January 2009, you may need to fill in the "Ask if rebuild is needed" make command in the "'Make' Commands" tab. This is the same command as in step 3, but with ''make -q'' in place of ''make all''. For the 11/11/09 nightly build, I had to use ''make-q'' (i.e. without the space) for this to work. You must also change "Settings", "Compiler and debugger", "Global compiler settings", "Other settings", "Compiler logging" to "Full command line", or else you will receive a "Nothing to be done." message when you try to build.

'''Step 5'''

In "Settings", "Compiler and debugger", "Global compiler settings", "Toolchain executables", change the "Make program" to "plink.exe", and add the Xming install path in the "Additional paths" tab (typically "C:\Program Files\Xming").

'''Step 6'''

Build the project. The first time you do this, you will be prompted with a "PuTTY Security Alert". Click "Yes" and the remote server will be added to your list of trusted hosts. Note that if you have used PuTTY before, this can go wrong. If you are being prompted for a username and password, try deleting the registry key "HKEY_CURRENT_USER/Software/Simon Tatham/PuTTY". Note that this could mess up your PuTTY configurations (it might not; this was not checked).

Installing a supported compiler

2009-11-13T15:47:28Z

Scaryjeff: Added remote compilation section

[[Category:User Documentation]]
When you launch Code::Blocks for the first time, it will scan the system for any supported compilers. Once this scan has finished, Code::Blocks will have been correctly configured for any detected compilers. Code::Blocks will also have default configurations even for compilers that were not found.

This article is a guide for obtaining, installing, and configuring the various compilers that Code::Blocks can use.

== Windows ==

Once you've installed a new compiler, be sure to read the Compiler-neutral setup steps at the end of this article.

At the time of this writing, Code::Blocks supports the following compilers in Windows:
* [http://www.mingw.org MinGW GCC C/C++ Free Compiler, including G77 (Fortran)]
* [http://mspgcc.sourceforge.net/ MSP430 GCC C/C++]
* [http://www.hightec-rt.com/ TriCore GCC C/C++]
* [http://www.hightec-rt.com/ PowerPC GCC C/C++]
* [http://msdn.microsoft.com/visualc/vctoolkit2003 Microsoft's Visual C++ Free Toolkit 2003]
* [http://www.borland.com/products/downloads/download_cbuilder.html Borland's C/C++ Free Compiler 5.5]
* [http://www.digitalmars.com/ Digital Mars Free C/C++ Compiler]
* [http://store.scitechsoft.com/product_info.php?products_id=37/ OpenWatcom Free C/C++ Compiler]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel C/C++ Compiler]

=== MinGW/GCC ===
The official MinGW website is at [http://www.mingw.org mingw.org]. A MinGW-bundled version of the latest Code::Blocks release is available from the [https://www.codeblocks.org/downloads/5#windows Code::Blocks download page]. If you install this version, the GCC compiler will be automatically detected and set as the default. Also you can use the TDM's GCC/mingw32 Builds from [/index.php/topic,10508.0.html] or [http://www.tdragon.net/recentgcc/].

'''Note''': In any case, if you don't install MinGW in C:\MinGW, you'll need to update the configuration of GCC in Code::Blocks.

==== Official MinGW.org ====
You can install '''MinGW''' yourself, by using an automatic downloader/installer or by downloading and unpacking the required packages by hand from [http://www.mingw.org mingw.org], here: [http://sourceforge.net/projects/mingw/files/].

Packages required (suggested) for MinGW/GCC v3.4.5:
* Compiler:
** gcc-build-3.4.5-20060117-3.tar.gz
** gcc-core-3.4.5-20060117-3.tar.gz
** gcc-g++-3.4.5-20060117-3.tar.gz
* Components:
** binutils-2.19.1-mingw32-bin.tar.gz
** gdb-6.8-mingw-3.tar.bz2
** mingw32-make-3.81-20080326.tar.gz
** mingwrt-3.16-mingw32-dev.tar.gz
** mingwrt-3.16-mingw32-dll.tar.gz
** w32api-3.13-mingw32-dev.tar.gz

Packages required (suggested) for MinGW/GCC v4.4.0:
* Compiler:
** gcc-full-4.4.0-mingw32-bin-2.tar.lzma
* Components:
** binutils-2.19.1-mingw32-bin.tar.gz
** gdb-6.8-mingw-3.tar.bz2
** mingw32-make-3.81-20080326.tar.gz
** mingwrt-3.16-mingw32-dev.tar.gz
** mingwrt-3.16-mingw32-dll.tar.gz
** w32api-3.13-mingw32-dev.tar.gz

==== (Unofficial) TDM - "Twilight Dragon Media" ====
These packages are called '''TDM's GCC/mingw32 Builds''' and can be obtained from [/index.php/topic,10508.0.html] or [http://www.tdragon.net/recentgcc/].

Packages required (suggested) for TDM's GCC/mingw32 Builds v4.4.0:
...which can be found here: [http://sourceforge.net/projects/tdm-gcc/files/] under: TDM-GCC 4.4 series -> Previous Releases -> 4.4.0-tdm-1 (r2) SJLJ.
* Compiler:
** gcc-4.4.0-tdm-1-core-2.zip
** gcc-4.4.0-tdm-1-g++-2.zip
* Components:
** binutils-2.19.1-mingw32-bin.tar.gz
** gdb-6.8-mingw-3.tar.bz2
** mingw32-make-3.81-20080326.tar.gz
** mingwrt-3.16-mingw32-dev.tar.gz
** mingwrt-3.16-mingw32-dll.tar.gz
** w32api-3.13-mingw32-dev.tar.gz

=== Microsoft Visual C++ ===
The official Visual C++ website is at [http://msdn.microsoft.com/en-us/visualc/default.aspx http://msdn.microsoft.com/en-us/visualc/default.aspx].

Code::Blocks will work with any edition of Visual C++ since the 2003 edition (MSVC 7.1). The commercial editions of Visual Studio may require additional configuration in Code::Blocks to work correctly. You can also download the most recent "Express" edition of Visual C++ for free from [http://www.microsoft.com/express/vc/ microsoft.com/express/vc]. If you choose an "Express" edition of Visual C++, it is highly recommended that you also install Microsoft's Platform SDK in order to develop programs for Windows.

=== Borland C++ Compiler 5.5 ===
NOTE: ''At some point, you will be asked to register with Borland and fill out a survey. Registration is free.''

Go to [http://www.borland.com/products/downloads/download_cbuilder.html# Borland's downloads] and click on the link labeled "Compiler". After you accept the license agreement, you will be provided with download links to the setup file.

=== Digital Mars C/C++ Free Compiler ===
Go to [http://www.digitalmars.com/download/dmcpp.html DigitalMars]. Accept the license agreement and you'll be redirected to a page containing download links.

In that page, download:
*The '''Digital Mars C/C++ Compiler''' (<tt>dm8**c.zip</tt>)
*The '''Basic Utilities''' (<tt>bup.zip</tt>)
*The '''STLport''' library (<tt>stlport.zip</tt>)

Open <tt>dm\bin\sc.ini</tt> in a text editor, and replace the line
INCLUDE="%@P%\..\include";"%@P%\..\mfc\include";%INCLUDE%
with
INCLUDE="%@P%\..\stlport\stlport";"%@P%\..\include";"%@P%\..\mfc\include";%INCLUDE%

=== Intel C++ Compiler ===
Please note that on Windows platform, Intel C/C++ compiler requires ''Microsoft Visual C++[http://www.microsoft.com/express/download/offline.aspx]'' to be present in your system in order to function properly. It will not compile any C++ program without it. You should also note that ''Windows SDK[http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&DisplayLang=en]'' shall be installed in order to compile Windows app.

Code::Blocks (C::B) is now able to detect (from svn revision 4967 onwards) Intel C/C++ compiler and it'll then automatically setup the MSVC compiler so that the Intel compiler works as intended. However if you wish to manually install the Intel C/C++ compiler, then follow the following steps.

* Go to '''Settings > Compilers and debuggers''' and then select '''Intel C/C++ compiler'''.
* Click on the '''Toolchain executables''' tab. Point to the installation directory, e.g. <tt>C:\Program Files\Intel\Compiler\C++\10.1.020\IA32</tt> , inside the ''Compiler's installation directory'' textbox.
* Click on the '''Additional Paths''' tab and fill in the directories pointing to MSVC bin directory and the Windows SDK directory. It may look like-
C:\Program Files\Microsoft Visual Studio 8\VC\bin
C:\Program Files\Microsoft Visual Studio 8\Common7\IDE
C:\Program Files\Microsoft SDKs\Windows\v6.0\bin
* Click on the '''Search directories''' tab and add the include directories containing headers offered by Intel C/C++ compiler, MSVC compiler and the Windows SDK headers to '''Compiler''' and '''Resource compiler'''. It may look like-
C:\Program Files\Intel\Compiler\C++\10.1.020\IA32\include
C:\Program Files\Microsoft Visual Studio 8\VC\include
C:\Program Files\Microsoft SDKs\Windows\v6.0\Include
* Click on the '''Linker''' tab under '''Search directories''' tab and add the directories containing libraries offered by Intel C/C++ compiler, MSVC compiler and the Windows SDK. It may look like-
C:\Program Files\Intel\Compiler\C++\10.1.020\IA32\lib
C:\Program Files\Microsoft Visual Studio 8\VC\lib
C:\Program Files\Microsoft SDKs\Windows\v6.0\Lib

Click on the '''OK''' button to save the settings. Now you should be able to use Intel C/C++ compilers on Windows with C::B.

Note: The directories specified above may be different on your PC.

== Linux ==

At the time of this writing, Code::Blocks supports the following compilers in Linux:
* [http://gcc.gnu.org/ GNU GCC C/C++ Free Compiler]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel C/C++ Compiler]

=== Downloading the GNU GCC compiler & GDB debugger ===

Under Linux you'll, most probably, already have everything that is needed in order to compile. All major Linux distributions (RedHat, Debian, SuSE, Mandriva, Gentoo, ArchLinux, etc) come with GCC & GDB preinstalled. To make sure you have have gcc installed, go to your terminal and type 'gcc -v'. In case you have GCC installed, you will get GCC's compile options and version number.

==Mac OS X==
The Mac OS X port efforts has began recently, but it should be a matter of time until these compilers will be supported:
* [http://gcc.gnu.org/ GNU GCC]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel Compiler beta (not yet released to public)]
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]

=== Downloading the GNU GCC compiler & GDB debugger ===

Under Mac you'll need to install Xcode Tools from http://developer.apple.com/tools/

This will install Apple versions of:

http://www.gnu.org/software/gcc/
http://www.gnu.org/software/gdb/
http://www.gnu.org/software/make/

== Compiler-neutral setup steps ==

Now that you have downloaded the setup file of the compiler of your choice, launch its installation by double-clicking on the setup file. The actual installation process is really simple. Just press "Next" all the way and you 're done.

If you installed the compiler on its default installation directory, there is nothing more to configure. Launch Code::Blocks and you 're all set :)

If that is not the case, launch Code::Blocks. If it is the first time you launch it, the compiler auto-detection will be launched.
If your compiler was not auto-detected, go to "Settings->Compiler and Debugger->Global Compiler settings->Toolchain executables", select the compiler you installed and press "Auto-detect".
If you get a message saying that the compiler was auto-detected, congratulations!
If not, then press the button with the three dots next to the "Auto-detect" button and select the installation directory of your compiler manually.

NOTE: ''The compiler's installation directory is exactly this: the installation directory. Not the "bin" subdirectory nor any other.''

== Remote Compilation ==
Remote compilation is not directly supported by Code::Blocks, however, the following articles explain two remote compilation systems, which use 3rd party programs to provide this funcionality:

[[Installing Uniwin remote compiler]] 
[[Using Xming for remote compilation]]

User documentation

2009-11-13T15:30:25Z

Scaryjeff: /* Compilers */

[[Category:Code::Blocks Documentation]]
[[Category:User Documentation]]
== Official user document ==
The Official Code::Blocks user document can be found [https://www.codeblocks.org/user-manual here]

== Articles for Code::Blocks users ==

'''[[Installing Code::Blocks]]'''

:How to install Code::Blocks (from binary or source)

'''[[Keyboard Shortcuts]]'''

:List of keyboard shortcuts that can be used in Code::Blocks

'''[[Command line arguments]]'''

:List of command-line arguments that can be used with Code::Blocks.

'''[[Personalities]]'''

:Customize the Code::Blocks user interface for different workflows.

'''[[Code::Blocks Plugins]]'''

:List of plugins that come with Code::Blocks.

'''[[The build process of Code::Blocks]]'''

:Information about how Code::Blocks actually builds your source code.

'''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

'''[[wxSmith tutorials]]'''
:Information about how to use wxSmith RAD editor

'''[[Building an Non-Unicode Win32 Code::Blocks]]'''
:Information about how to modify the Code::Blocks project files for an Non-Unicode build of Code::Blocks.

'''[[Miscellaneous]]'''
:Miscellaneous things related to the user development experience. This is a catch all place.

== Application development ==

* [[Builtin variables]]
* [[Recommended global variables]]
* [[Code::Blocks variable types synthesis]]
* [[Debugging with Code::Blocks]]
* [[Adding support for non C/C++ files to the build system]]

== Compilers ==

* [[Global compiler variables]]
* [[Precompiled headers]]
* [[Installing a supported compiler]]
* [[Installing Cygwin Compiler]]
* [[Installing Fortran Compiler]]
* [[Installing Uniwin remote compiler]]
* [[Using Xming for remote compilation]]
* [[Code::Blocks_and_Cross_Compilers|Using cross compilers]]
* [[Cross_Compiling_wxWidgets_Applications_on_Linux|Cross compiling wxWidgets applications on Linux]]
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
* [[64Bit Windows|Setting up for 64-bit windows development with Mirosoft compilers]]
* [[Using the Code::Blocks IDE with SDCC on PIC MCUs]]
* [[Using Code::Blocks with Open Watcom]]

== User interface development ==

* [[WxSmith Tutorial & Pointers|Creating a dialog for wxWidgets with wxSmith]]

== Third-party libraries ==

* [[BoostWindowsQuickRef|Using Boost with Code::Blocks (Windows)]]
* [[WxWindowsQuickRef|Using wxWidgets with Code::Blocks (Windows)]]
* [[Using SDL with Code::Blocks]]
* [[Using GLFW with Code::Blocks]]
* [[Using Allegro with Code::Blocks]]

== Third-party Applications ==

* [[KiCadBuildQuickRef|How-to build KiCad with Code::Blocks]]

Using Xming for remote compilation

2009-11-13T15:29:36Z

Scaryjeff: First version of page.

== Introduction ==

This article explains how to set up true remote compilation, without using any local file stores. Note that it assumes a custom makefile, and is for remote compiling where C::B is running on a windows system, and the remote compilation is to take place on a linux system. An instance of C::B running on Linux or Mac should be able to use a similar method, using 'ssh' as the 'make' command, employing a 'keys' file to avoid being prompted for an ssh password.

== Method ==

'''Step 1'''

Download and install Xming (windows X server) from http://sourceforge.net/projects/xming/ . It will sit in the systray.

'''Step 2'''

Open or create your project, and choose any compiler you have installed that actually works (i.e. doesn't give you an 'Invalid Compiler' message when you try to build). The easiest way to achieve this is to use the C::B installer that includes MinGW. It doesn't matter if your remote compiler is completely different to the one you choose here.

'''Step 3:'''

In the project properties, "Project Settings", select "This is a custom Makefile", <OK>. Now in the project build options, "'Make' Commands", enter:
$make -X -ssh RemoteUser@RemoteIP -pw RemotePassword ''make all'' -C /path/to/remote/makefile/
Note that your remote password is stored in plaintext, not everyone will like this! Also, the path to the remote makefile is relative to the root of the remote machine, for example /home/username/myproject. 

The ''make all'' is specific to my Makefile. You can obviously modify this for the different build types implemented in your Makefile. I set all the make commands to be the same, with the exception of "Clean project/target", where I used ''make clean'', which is implemented in my Makefile. Do this for all the build profiles (in my case, "Debug" and "Release"). <OK>.

'''Step 4 (nightly builds only)'''

If you are using a C::B build newer than January 2009, you may need to fill in the "Ask if rebuild is needed" make command in the "'Make' Commands" tab. This is the same command as in step 3, but with ''make -q'' in place of ''make all''. For the 11/11/09 nightly build, I had to use ''make-q'' (i.e. without the space) for this to work. You must also change "Settings", "Compiler and debugger", "Global compiler settings", "Other settings", "Compiler logging" to "Full command line", or else you will receive a "Nothing to be done." message when you try to build.

'''Step 5'''

In "Settings", "Compiler and debugger", "Global compiler settings", "Toolchain executables", change the "Make program" to "plink.exe", and add the Xming install path in the "Additional paths" tab (typically "C:\Program Files\Xming").

'''Step 6'''

Build the project. The first time you do this, you will be prompted with a "PuTTY Security Alert". Click "Yes" and the remote server will be added to your list of trusted hosts. Note that if you have used PuTTY before, this can go wrong. If you are being prompted for a username and password, try deleting the registry key "HKEY_CURRENT_USER/Software/Simon Tatham/PuTTY". Note that this could mess up your PuTTY configurations (it might not; this was not checked).