Code::Blocks - User contributions [en]

Code::Blocks command line arguments

2023-03-28T23:10:53Z

BlueHazzard: Update after (after [r13245]) add user variable command line arguments

[[Category: User Documentation]]
== Using command line arguments ==

=== Windows ===

# Find the Code::Blocks shortcut in the Desktop or Start menu.
# Right click on the icon and select Properties.
# Select the Shortcut tab.
# Append the command line arguments you want to use to the end of the Target text (behind the quote mark).
# Run Code::Blocks by using the shortcut you edited.

'''Example'''

"C:\Program Files\CodeBlocks\codeblocks.exe" /na /nd

=== *nix ===

# Launch a terminal client, such as XTerm, Gnome Terminal or Konsole.
# Type "codeblocks" and then append the command line arguments you want to use.

Note: Code::Blocks can not run on a real console, X11 must be running and you must use a graphical terminal emulator.

'''Example'''

codeblocks --no-splash-screen --debug-log

== Command line arguments ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 1px solid gray"
! Argument
! Function
|-

|-
| ''<filename>''
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
|-

|-
| '''--file='''''<filename>[:line]''
| Open file in Code::Blocks and optionally jump to a specific line.
|-

|-
| '''/h''', '''--help''', '''/?''', '''--?'''
| Shows a help message about the command line arguments.
|-

|-
| '''/na''', '''--no-check-associations'''
| Don't perform any file association checks (Windows only).
|-

|-
| '''/nd''', '''--no-dde'''
| Don't start a [http://en.wikipedia.org/wiki/Dynamic_Data_Exchange DDE] server (Windows only).
|-

|-
| '''/ns''', '''--no-splash-screen'''
| Hides the splash screen when the application is loading.
|-

|-
| '''/d''', '''--debug-log'''
| Display application's debug log.
|-

|-
| '''--prefix='''''<str>''
| Sets the shared data directory prefix.
|-

|-
| '''/p''', '''--personality='''''<str>'', '''--profile='''''<str>''
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
|-

|-
| '''--rebuild'''
| Clean and build the project / workspace.
|-

|-
| '''--build'''
| Build the project / workspace.
|-

|-
| '''--target='''''<str>''
| Sets target for batch build. For example --target="Release".
|-

|-
| '''--no-batch-window-close'''
| Keeps the batch log window visible after the batch build has completed.
|-

|-
| '''--batch-build-notify'''
| Shows a message after the batch build has completed.
|-

|-
| '''--user-data-dir=<path>'''
| specify an alternative directory for user settings and user installed plugins
|-

|-
| '''--script=<str>'''
| specify a script file to run after loading
|-

|-
| '''--target=<str>'''
| the target for the batch build
|-

|-
| '''--clean'''
| clean the project/workspace
|-

|-
| '''--rebuild'''
| clean and then build the project/workspace
|-

|-
| '''--build'''
| just build the project/workspace
|-

|-
| '''--verbose'''
| Enable logging of c::b errors
|-
|'''-S''' setName
|Set <nowiki>''</nowiki>setName<nowiki>''</nowiki> to current active set for global variables (after [r13245])
|-
|'''-D''' <set>.uservar.mem=val
|Set the member ''mem'' of uservariable ''uservar'' in set to value ''val''. This overrides the current set value (after [r13245])
|-

|-
| '''>''' ''<build log file>''
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
|-

|}

Global compiler variables

2023-03-28T23:05:59Z

BlueHazzard: Add information for command line arguments

[[Category:User Documentation]]
== Synopsis ==
Working as a developer on a project which relies on 3rd party libraries involves a lot of unnecessary repetitive tasks, such as setting up build variables according to the local filesystem layout. In the case of project files, care must be taken to not accidentially commit a locally modified copy. If one does not pay attention, this can happen easily for example after changing a build flag to make a release build.

The concept of global compiler variables is an unique new solution for Code::Blocks which addresses this problem.
Global compiler variables allow you to set up a project once, and any number of developers using any number of different filesystem layouts will be able to compile and develop the project. No local layout information ever needs to be changed more than once.

== Names and Members ==
Global compiler variables in Code::Blocks are discriminated from [[per-project variables]] by a leading hash sign. Global compiler variables are structured; every variable consists of a ''name'' and an optional ''member''.
Names are freely definable, while some of the members are built into the IDE. Although you can choose anything for a variable name in principle, it is advisable to pick a known identifier for common packages. This way, the amount of information that the user needs to provide is minimised. The Code::Blocks team provides a [[Recommended global variables|list of recommended variables]] for known packages.

The member <tt>base</tt> resolves to the same value as the variable name uses without a member (alias).

The members <tt>include</tt> and <tt>lib</tt> are by default aliases for ''base''<tt>/include</tt> and ''base''<tt>/lib</tt>, respectively. However, a user can redefine them if another setup is desired.

It is generally recommended to use the syntax <tt>$(#variable.include)</tt> instead of <tt>$(#variable)/include</tt>, as it provides additional flexibility and is otherwise exactly identical in functionality (see [[Global_compiler_variables#Custom_Members_Mini-Tutorial|mini tutorial]]).

The members <tt>cflags</tt> and <tt>lflags</tt> are empty by default and can be used to provide the ability to feed the same consistent set of compiler/linker flags to all builds on one machine.
Beginning with revision 2664 (4 July 2006), Code::Blocks allows you to define custom variable members in addition to the builtin ones.

[[Image:Gcv_ui.png]]

== Constraints ==
*Both set and global compiler variable names may not be empty, must not contain white space, must start with a letter and must consist of alphanumeric characters. Cyrillic or Chinese letters are not alphanumeric characters. If Code::Blocks is given invalid character sequences as name, it may replace them without asking.
*Every variable requires its base to be defined. Everything else is optional, but the base is absolutely mandatory. If you don't define a variable's base, it will not be saved (no matter what other fields you have defined).
*You may not define a custom member that has the same name as a builtin member. Currently, the custom member will overwrite the builtin member, but in general, the behaviour for this case is undefined. If <tt>'libext'</tt> is a custom member we can only write <tt>$(#variable.libext)</tt> and not <tt>$(#variable)/libext</tt>.
*Variable and member values may contain arbitrary character sequences, subject to the following three constraints:
**You may not define a variable by a value that references the same variable or any of its members
**You may not define a member by a value that references the same member
**You may not define a member or variable by a value that references the same variable or member through a cyclic dependency.
Code::Blocks will detect the most obvious cases of recursive definitions (which may happen by accident), but it will not perform an excessive depth analysis of every possible abuse. If you enter crap, then crap is what you will get, you have been warned.

Examples: 
defining <tt>wx.include</tt> as <tt>$(#wx)/include</tt> is redundant, but perfectly legal 
defining <tt>wx.include</tt> as <tt>$(#wx.include)</tt> is illegal and will be detected by Code::Blocks 
defining <tt>wx.include</tt> as <tt>$(#cb.lib)</tt> which again is defined as <tt>$(#wx.include)</tt> will create an infinite loop

== Using Global Compiler Variables ==
All you need to do to start using global compiler variables is to put them in your project! Yes, it is really that easy.

When the IDE detects the presence of an unknown global variable, it will prompt you to enter its value. The value will be saved in your settings, so you never need to enter the information twice.

If you need to modify or delete a variable at a later time, you can do so from the settings menu.

Example:

[[Image:Globvarsdir.png]]

The above image shows both per-procect and global variables. <tt>WX_CFG</tt> is defined in the project, but <tt>WX</tt> is a global user variable.

== Variable Sets ==
Sometimes, you want to use different versions of the same library, or you develop two branches of the same program. Although it is still possible to get around with a global compiler variable, it can become tedious. For this purpose, Code::Blocks supports variable sets. A variable set is an independent collection of variables identified by a name (set names have the same constraints as variable names).

If you wish to switch to a different set of variables, you simply select a different set from the menu. Different sets are not required to have the same variables, and identical variables in different sets are not required to have the same values, or even the same custom members.

Another positive thing about sets is that if you have a dozen variables and you want to have a new set with one of these variables pointing to a different location, you are not required to re-enter all this redundant data again. You can simply create a clone of your current set, this will duplicate all of your variables.

Deleting a set also deletes all variables in that set (but not in another set). The "default" set is always present and cannot be deleted.

== Custom Members Mini-Tutorial ==
As stated above, writing <tt>$(#var.include)</tt> and <tt>$(#var)/include</tt> is exactly the same thing by default.
So why would you want to write something as unintuitive as <tt>$(#var.include)</tt>?

Let's take a standard Boost installation under Windows as an example. Generally, you would expect a fictional package <tt>ACME</tt> to have its include files under <tt>ACME/include</tt> and its libraries under <tt>ACME/lib</tt>. Optionally, it might place its headers into yet another subfolder called <tt>acme</tt>.
Thus, after adding the correct paths to the compiler and linker options, you would expect to <tt>#include <acme/acme.h></tt> and link to <tt>libacme.a</tt> (or whatever it happens to be).

Boost, however, installs headers into <tt>C:\Boost\include\boost-1_33_1\boost</tt> and its libraries under <tt>C:\Boost\lib</tt> by default. It seems impossible to get this under one hood without having to adjust everything on every new PC, especially if you have to work under Linux or some other OS, too.

This is where the true power of global user variables is unveiled. When defining the value of the <tt>#boost</tt> variable, you go one step further than usual. You define the member <tt>include</tt> as <tt>C:\Boost\include\boost-1_33_1\boost</tt> and the member <tt>lib</tt> as <tt>C:\Boost\lib</tt>, respectively.
Your projects using <tt>$(#boost.include)</tt> and <tt>$(#boost.lib)</tt> will magically work on every PC without any modifications. You don't need to know why, you don't want to know why.

== Command line arguments ==
After revision [r13245] it is possible to use command line arguments to override and define global variables and set the current active set.
* '-S' parameter for setting current active set via command line
* '-D' parameter for defining/overriding user variable in form <tt>-D set.variable.member=value</tt> or <tt>-D variable.member=value</tt>

==See also==
* [[Variable expansion]]

Code::Blocks and Makefiles

2023-03-09T20:58:15Z

BlueHazzard: add warning about outdated and remove warning about not using makefiles

[[Category:User Documentation]]
<big style="color:#ff0000">'''WARNING: this article is outdated'''</big>

CB does not, by default, use makefiles it has its own .cbp files which do the same thing automatically. There are a few reasons that you might want to use a makefile. You maybe migrating a project that has a makefile into CB. Another possibility is wanting to take a project out of CB.

Needing to use a pre-processor is not a valid reason to use a makefile as CB has a pre/post build option. From the menu project->build options there appears a tab with pre/post build steps that can be used for this purpose.

This document deals with makefiles using mingw32-make 3.81, CB 8.02 and Wxwidgets 2.8 on Windows Vista, although I’m sure most of it will apply to other configurations.

If you decide that you want to use your own makefile, you need to enter the screen from project->Properties and you will see a tick box for 'this is a custom makefile'. Tick this box, make sure the name just above it is the one you want for your makefile.

You should also look at project->build options. There is a tab called 'Make commands' (you have to scroll the tabs horizontally to get to it). In the field 'build project/target' you should see the line $make -f $makefile $target. Assuming you're in debug mode $target will probably be called 'debug' which is probably not what you want. You should change $target to your output file's name (with the .exe extension and without the leading $).

One other useful addition is in Project->Project Tree->Edit File types and categories. If you add makefiles with the mask *.mak (CB seems to prefer .mak to .mk) you will be able to add your makefile with the extension .mak to the project and it will appear in the project management pane on the left.

Assuming you are going to edit the makefile within CB you should make sure that the editor uses tabs (as opposed to spaces). This is a generic problem with make as it needs to start command lines with a tab character and many editors replace tabs with spaces. To set this in CB, open the settings->editor window and check the tickbox for use tab character.

The real problems start now however. CB’s automatic makefile adds all the headers for Wxwidgets, but if you use a makefile, all this is turned off and you have to do this yourself.

Fortunately CB has another feature that can come to your rescue. If you go to menu Settings->Compiler and Debugger, scroll the tabs horizontally to the right end and you will find the tab ‘other settings’. In there click on the tick box for ‘Save build to HTML …’. This will cause CB to create, at build time, an HTML file that records all the build commands.

If you compile (without using a makefile – so if you’ve already reset everything –sorry) the default Wxwidgets minimum program, you can see the compiler and linker commands that produce this file.

Assuming that you are going to use this as the basis for your project, you can use the content of the HTML file produced as the basis of your makefile.

You can’t just copy it from the HTML viewer in CB (there’s no such facility in CB) but you can load the file into a browser or editor and copy it from there. It can be found in your project directory with <the_same_name_as_your_project>_build_log.HTML. Sadly it will require a little tweaking as shown below.

Here’s a copy of a build file for the basic Wxwidgets program as described above.

<pre>

mingw32-make.exe -f test.mak test.exe

mingw32-g++.exe -pipe -mthreads -D__GNUWIN32__ -D__WXMSW__ -DWXUSINGDLL -DwxUSE_UNICODE -Wall -g -D__WXDEBUG__ -IC:\PF\wxWidgets2.8\include -IC:\PF\wxWidgets2.8\contrib\include -IC:\PF\wxWidgets2.8\lib\gcc_dll\mswud -c C:\Development\test\testApp.cpp -o obj\Debug\testApp.o

mingw32-g++.exe -pipe -mthreads -D__GNUWIN32__ -D__WXMSW__ -DWXUSINGDLL -DwxUSE_UNICODE -Wall -g -D__WXDEBUG__ -IC:\PF\wxWidgets2.8\include -IC:\PF\wxWidgets2.8\contrib\include -IC:\PF\wxWidgets2.8\lib\gcc_dll\mswud -c C:\Development\test\testMain.cpp -o obj\Debug\testMain.o

windres -IC:\PF\wxWidgets2.8\include -IC:\PF\wxWidgets2.8\contrib\include -IC:\PF\wxWidgets2.8\lib\gcc_dll\mswud -iC:\Development\test\resource.rc -o obj\Debug\resource.coff

mingw32-g++.exe -LC:\PF\wxWidgets2.8\lib\gcc_dll -o bin\Debug\test.exe obj\Debug\testApp.o obj\Debug\testMain.o obj\Debug\resource.coff -lwxmsw28ud -mwindows

Process terminated with status 0 (0 minutes, 12 seconds)
0 errors, 0 warnings
</pre>

The above can be converted to the makefile below. I have deliberately left it fairly close to the HTML file output.

<pre>
# test program makefile

Incpath1 = C:\PF\wxWidgets2.8\include
Incpath2 = C:\PF\wxWidgets2.8\contrib\include
Incpath3 = C:\PF\wxWidgets2.8\lib\gcc_dll\mswud

Libpath = C:\PF\wxWidgets2.8\lib\gcc_dll

flags = -pipe -mthreads -D__GNUWIN32__ -D__WXMSW__ -DWXUSINGDLL -DwxUSE_UNICODE -Wall -g -D__WXDEBUG__

CXX = mingw32-g++.exe

test.exe : obj\Debug\testApp.o obj\Debug\testMain.o obj\Debug\resource.coff
$(CXX) -L$(Libpath) -o bin\Debug\test.exe obj\Debug\testApp.o obj\Debug\testMain.o obj\Debug\resource.coff -lwxmsw28ud -mwindows

obj\Debug\testMain.o : C:\Development\test\testMain.cpp
$(CXX) $(flags) -I$(Incpath1) -I$(Incpath2) -I$(Incpath3) -c C:\Development\test\testMain.cpp -o obj\Debug\testMain.o

obj\Debug\testApp.o : C:\Development\test\testApp.cpp
$(CXX) $(flags) -I$(Incpath1) -I$(Incpath2) -I$(Incpath3) -c C:\Development\test\testApp.cpp -o obj\Debug\testApp.o

obj\Debug\resource.coff : C:\Development\test\resource.rc
windres -I$(Incpath1) -I$(Incpath2) -I$(Incpath3) -iC:\Development\test\resource.rc -oobj\Debug\resource.coff

# original output from codeblocks compilation
# note I've had to add compiling the .res file
#
# mingw32-g++.exe -pipe -mthreads -D__GNUWIN32__ -D__WXMSW__ -DWXUSINGDLL -DwxUSE_UNICODE -Wall -Wall -g -D__WXDEBUG__
# -Wall -g -IC:\PF\wxWidgets2.8\include -IC:\PF\wxWidgets2.8\contrib\include -IC:\PF\wxWidgets2.8\lib\gcc_dll\mswud
# -c C:\Development\test\testApp.cpp -o obj\Debug\testApp.o

# mingw32-g++.exe -pipe -mthreads -D__GNUWIN32__ -D__WXMSW__ -DWXUSINGDLL -DwxUSE_UNICODE -Wall -Wall -g -D__WXDEBUG__
# -Wall -g -IC:\PF\wxWidgets2.8\include -IC:\PF\wxWidgets2.8\contrib\include -IC:\PF\wxWidgets2.8\lib\gcc_dll\mswud
# -c C:\Development\test\testMain.cpp -o obj\Debug\testMain.o

# mingw32-g++.exe -LC:\PF\wxWidgets2.8\lib\gcc_dll -o bin\Debug\test.exe obj\Debug\testApp.o obj\Debug\testMain.o
# obj\Debug\resource.res -lwxmsw28ud -mwindows
</pre>

I have written a generic makefile which I have only tested on Windows Vista but that should work with any project started as described above. You have to change the name of the project and set the paths as appropriate (you will probably only need to change Ppath and WXpath).

<pre>
# Generic program makefile
# -- assumes that you name your directory with same name as the project file
# -- eg project test is in <development path>\test\

# Project name and version
Proj := test
Version := Debug

#paths for Project (Ppath) Object files (Opath) and binary path (Bpath)
Ppath := C:\Development\$(Proj)
Opath := obj\$(Version)
Bpath := bin\$(Version)

#Library & header paths
WXpath := C:\PF\wxWidgets2.8
IncWX := $(WXpath)\include
IncCON := $(WXpath)\contrib\include
IncMSW := $(WXpath)\lib\gcc_dll\mswud
Libpath := $(WXpath)\lib\gcc_dll

flags = -pipe -mthreads -D__GNUWIN32__ -D__WXMSW__ -DWXUSINGDLL -DwxUSE_UNICODE -Wall -g -D__WXDEBUG__

CXX = mingw32-g++.exe

Obj := $(Opath)\$(Proj)App.o $(Opath)\$(Proj)Main.o $(Opath)\resource.coff

$(Proj).exe : $(Obj)
$(CXX) -L$(Libpath) -o $(Bpath)\$(Proj).exe $(Obj) -lwxmsw28ud -mwindows

$(Opath)\$(Proj)Main.o : $(Ppath)\$(Proj)Main.cpp
$(CXX) $(flags) -I$(IncWX) -I$(IncCON) -I$(IncMSW) -c $^ -o $@

$(Opath)\$(Proj)App.o : C:\Development\$(Proj)\$(Proj)App.cpp
$(CXX) $(flags) -I$(IncWX) -I$(IncCON) -I$(IncMSW) -c $^ -o $@

$(Opath)\resource.coff : C:\Development\$(Proj)\resource.rc
windres -I$(IncWX) -I$(IncCON) -I$(IncMSW) -i$^ -o $@

.PHONEY : clean

clean:
del $(Bpath)\$(Proj).exe $(Obj) $(Opath)\resource.coff

</pre>
''Note: [[Tools+ reference#Export makefile|exporting a makefile]] of a Code::Blocks project is indirectly possible.''

[[User:Gavrillo|Gavrillo]] 22:34, 21 May 2010 (UTC)

Automatic source paths

2023-02-21T22:30:14Z

BlueHazzard:

== Introduction ==
Automatic source paths is a feature of codeblocks to automatically mirror folders from the source directory to the codeblocks project file.
A use case is for example if a external program creates source files that are used in codeblocks. With automatic source paths codeblocks automatically detects changes (addition and removal of source files) in the given directory and mirrors them to the project file.

== UI ==
The functionality can be accessed over the Project->Automatic source folders menu entry:
[[File:Globs menu.png|frame|center]]
This opens the overview dialog
[[File:Globs ui 1.png|frame|center]]
* '''Path''': The base path in which files are searched for automatic import
* '''Recursive''': Search also in sub folders
* '''Wildcard''': Filter files according this wildcard (for example ''*.cpp'': import only files ending with .cpp
* '''Add''': Add an new path
* '''Delete''': Delete current selected path from the list
* '''Edit''': Edit current selected path from the list
Adding or Editing a path opens the ''Edit path dialog''
[[File:Globs ui 2 2.png|alt=|center|thumb]]
# The path to automatically overwatch
# Open the system path dialog to select the path to automatically overwatch
# Open the global variables dialog to select a global variable that is replaced and overwatched by codeblocks
# If this is checked all sub folder of this path are also overwatched
# A list of wildchards separated by ';' for file extension that are imported for this glob (ex. ''*.h'' to import only header files, ''*.cpp;*.h'' to import cpp and h files
# Select targets where the files found in Path are added
# Checkbox to select all/none targets
# When this box is checked files will be added to the project file. The project file will be modified every time a file is found. This allows to change properties of the file (like target, or linker flags). The properties are saved in the project file and reloaded when the project is reloaded. If this box is left unchecked the files are loaded when codeblocks is running, but not saved to project file. With this unchecked file properties can not be saved and will be lost.

== Example ==
In this example we use the following folder structure:
[[File:Directory 1.png|thumb|center]]
Lets assume that files in ''src'' are added/removed automatically by a third party software. Adding now an ''automatic source folder'' in codeblocks will automatically add/remove files if they are changed on the file system.
[[File:Edit glob example 2.png|thumb|center]]

Automatic source paths

2023-02-21T22:27:55Z

BlueHazzard: Update with new UI

== Introduction ==
Automatic source paths is a feature of codeblocks to automatically mirror folders from the source directory to the codeblocks project file.
A use case is for example if a external program creates source files that are used in codeblocks. With automatic source paths codeblocks automatically detects changes (addition and removal of source files) in the given directory and mirrors them to the project file.

== UI ==
The functionality can be accessed over the Project->Automatic source folders menu entry:
[[File:Globs menu.png|frame|center]]
This opens the overview dialog
[[File:Globs ui 1.png|frame|center]]
* '''Path''': The base path in which files are searched for automatic import
* '''Recursive''': Search also in sub folders
* '''Wildcard''': Filter files according this wildcard (for example ''*.cpp'': import only files ending with .cpp
* '''Add''': Add an new path
* '''Delete''': Delete current selected path from the list
* '''Edit''': Edit current selected path from the list
Adding or Editing a path opens the ''Edit path dialog''
[[File:Globs ui 2 2.png|alt=|center|thumb]]
# The path to automatically overwatch
# Open the system path dialog to select the path to automatically overwatch
# Open the global variables dialog to select a global variable that is replaced and overwatched by codeblocks
# If this is checked all sub folder of this path are also overwatched
# A list of wildchards separated by ';' for file extension that are imported for this glob (ex. ''*.h'' to import only header files, ''*.cpp;*.h'' to import cpp and h files
# Select targets where the files found in Path are added
# Checkbox to select all/none targets
# When this box is checked files will be added to the project file. The project file will be modified every time a file is found. If this box is left unchecked the files are loaded when codeblocks is running, but not saved to project file. With this unchecked file properties can not be saved and will be lost.

== Example ==
In this example we use the following folder structure:
[[File:Directory 1.png|thumb|center]]
Lets assume that files in ''src'' are added/removed automatically by a third party software. Adding now an ''automatic source folder'' in codeblocks will automatically add/remove files if they are changed on the file system.
[[File:Edit glob example 2.png|thumb|center]]

File:Globs ui 2 2.png

2023-02-21T22:22:44Z

BlueHazzard:

new globs ui

User documentation

2023-02-11T20:31:02Z

BlueHazzard: /* Application development */ add automatic source paths

[[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].
* Contributed [http://www.bt4.pl/programy/dla-programistow/code-blocks/ Polish translation].

== Using Code::Blocks ==

'''[[Installing Code::Blocks]]'''
:How to install Code::Blocks (from binary or source).

'''[[Creating a new project]]'''
:How to get started with project setup and management.

'''[[Keyboard Shortcuts]]'''
:List of keyboard shortcuts that can be used in Code::Blocks.

'''[[Basic Tutorial]]'''
:Information useful to make sense of Code::Blocks' settings (for newer users).

'''[[Command line arguments]]'''
:List of command-line arguments that can be used with Code::Blocks.

'''[[Tools+ reference|User-defined tools]]'''
:Integrate external programs into Code::Blocks.

'''[[The build process of Code::Blocks]]'''
:Information about how Code::Blocks actually builds your source code.

'''[[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.

'''[[Code::Blocks and Makefiles]]'''
:Using makefiles with CB is not normally necessary (CB does this automatically) but if you have some compelling reason to use one - here's how.

'''[[Variable expansion]]'''
:CB can use ''dynamic'' variables, that get replaced automatically, on various places, like in the build options or the post and pre build steps

'''[[Manipulating multiple projects at the same time]]'''
:To manipulate options of multiple projects at the same time you can use a contributed plugin named ''Project options manipulator''

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

== Customizing Code::Blocks ==

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

'''[[Syntax highlighting custom colour themes]]'''
:Change the color of the editor, code highlighting

'''[[Code::Blocks Plugins]]'''
:List of plugins that come with Code::Blocks.

'''[[Personalities]]'''
:Customize the Code::Blocks user interface for different workflows.

== Application development ==

* [[Variable expansion|Builtin variables]]
* [[Recommended global variables]]
* [[Code::Blocks variable types synthesis]]
* [[Debugging with Code::Blocks]]
* [[UnitTesting|Unit testing with Code::Blocks]]
* [[Adding support for non C/C++ files to the build system]]
* [[Codeblocks with scons|Integrating the SCons build system]]
* [[Automatic source paths]]

== Compilers ==

* [[Global compiler variables]]
* [[Precompiled headers]]
* [[Installing a supported compiler]]
* [[Installing Cygwin Compiler]]
* [[Installing Fortran Compiler]]
* [[Installing Objective-C Compiler]]
* [[Installing Uniwin remote compiler]]
* [[Using Xming for remote compilation]]
* [[Using STLFilt with MinGW]]
* [[Code::Blocks and Cross Compilers|Using cross compilers]]
* [[Cross Compiling wxWidgets Applications on Linux]]
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
* [[Using the Code::Blocks IDE with SDCC on PIC MCUs]]
* [[Using Code::Blocks with Open Watcom]]
* [[Custom compiler|Creating a custom compiler]] (Unfinished page.)
* [[64Bit Windows|Setting up for 64-bit windows development with Mirosoft compilers]]
* [[Developing 32 bit apps under 64 bit Linux (Ubuntu)]]
* [https://www.orbiterwiki.org/wiki/Free_Compiler_Setup_Under_Linux External: Cross compiler MSVS 2005 under Linux through Wine]

== User interface development ==


* [[wxSmith tutorials|Creating a dialog for wxWidgets with wxSmith]]

== Third-party libraries ==

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

== Third-party Applications ==

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

Automatic source paths

2023-02-11T20:30:16Z

BlueHazzard:

== Introduction ==
Automatic source paths is a feature of codeblocks to automatically mirror folders from the source directory to the codeblocks project file.
A use case is for example if a external program creates source files that are used in codeblocks. With automatic source paths codeblocks automatically detects changes (addition and removal of source files) in the given directory and mirrors them to the project file.

== UI ==
The functionality can be accessed over the Project->Automatic source folders menu entry:
[[File:Globs menu.png|frame|center]]
This opens the overview dialog
[[File:Globs ui 1.png|frame|center]]
* '''Path''': The base path in which files are searched for automatic import
* '''Recursive''': Search also in sub folders
* '''Wildcard''': Filter files according this wildcard (for example ''*.cpp'': import only files ending with .cpp
* '''Add''': Add an new path
* '''Delete''': Delete current selected path from the list
* '''Edit''': Edit current selected path from the list
Adding or Editing a path opens the ''Edit path dialog''
[[File:Globs ui 2.png|thumb|alt=|center]]
# The path to automatically overwatch
# Open the system path dialog to select the path to automatically overwatch
# Open the global variables dialog to select a global variable that is replaced and overwatched by codeblocks
# If this is checked all sub folder of this path are also overwatched
# A list of wildchards separated by ';' for file extension that are imported for this glob (ex. ''*.h'' to import only header files, ''*.cpp;*.h'' to import cpp and h files

== Example ==
In this example we use the following folder structure:
[[File:Directory 1.png|thumb|center]]
Lets assume that files in ''src'' are added/removed automatically by a third party software. Adding now an ''automatic source folder'' in codeblocks will automatically add/remove files if they are changed on the file system.
[[File:Edit glob example.png|thumb|center]]
[[File:Edit glob example 2.png|thumb|center]]

File:Edit glob example 2.png

2023-02-11T20:29:50Z

BlueHazzard:

edit glob example

File:Edit glob example.png

2023-02-11T20:28:36Z

BlueHazzard:

example for adding a src to globs

File:Directory 1.png

2023-02-11T20:23:42Z

BlueHazzard:

globs example directory structure

Automatic source paths

2023-02-11T20:14:20Z

BlueHazzard:

Automatic source paths

2023-02-11T20:13:41Z

BlueHazzard: creation

File:Globs ui 2.png

2023-02-11T20:08:27Z

BlueHazzard:

edit glob ui

File:Globs ui 1.png

2023-02-11T20:02:49Z

BlueHazzard:

globs ui

File:Globs menu.png

2023-02-11T20:00:52Z

BlueHazzard:

Menu overview of glob

Scripting commands

2022-04-15T15:34:18Z

BlueHazzard: Fix naming and add constructor arguments for TinyXml binding

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's built-in commands only. The host application (Code::Blocks) needs to expose parts of its internals to scripts, so scripts can use and control the host.

Code::Blocks has exposed a very large chunk of its SDK to scripts. This makes scripting in Code::Blocks nearly as powerful as native code (C++).

In this page all the exported constants, functions and classes are documented as a quick reference. For detailed documentation on each function/class, refer to the Code::Blocks SDK documentation.

''NOTE: Please remember that [http://www.squirrel-lang.org Squirrel] is typeless. Data types mentioned below are only used for documentation purposes.''

''NOTE: Please keep in mind that if a function has default parameters in C++ (which can be ommitted), you still have to type them for scripts (for e.g. exposed wxWidgets functionality). This means you *have* to use e.g. wxFileName.GetFullPath(wxPATH_NATIVE) instead of e.g only wxFileName.GetFullPath().

''NOTE: Updated to '''12.11'''

== Application object ==
The application object is accessed through the variable named '''<tt>App</tt>'''. Currently it has no bound functions...

== Global functions ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Log || wxString || logs to the application log
|-

|-
| void || LogDebug || wxString || logs to the debug log
|-

|-
| void || LogWarning || wxString || logs a warning
|-

|-
| void || LogError || wxString || logs an error
|-

|-
| int || Message || wxString,wxString,int || arg1=msg, arg2=caption, arg3=buttons; see API docs for cbMessageBox()
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

|-
| void || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

|-
| bool || IsNull || void* ||
|-

|-
| bool || wxLaunchDefaultBrowser || wxString ||
|-

|-
| wxColour || wxGetColourFromUser || [wxColour] ||
|-

|-
| long || wxGetNumberFromUser || wxString,wxString,wxString ||
|-

|-
| wxString || wxGetPasswordFromUser || wxString,wxString,wxString ||
|-

|-
| wxString || wxGetTextFromUser || wxString,wxString,wxString ||
|-

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''Notes:'''
The namespaces are accesses by prepending it's name (e.g. "IO.") to the scripting function, e.g. "IO.DirectoryExists(...)". "::" is only used when declaring the members of the namespace.
The functions in bold are going through the scripts security layer so there is no guarantee calling them will succeed. You should always examine the return value...
There exists one constant too, named ''allowInsecureScripts'', which allow you to test whether Code::Blocks was compiled with the functions going through the security layer.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int || arg1=position
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int, int || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''NOTE: Is instantiated in a script using: local my_wxstring = ::wxString();

== wxArrayString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Add || wxString, size_t || arg1=string, arg2=number of copies to add
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''NOTE: Is instantiated in a script using: local my_wxarraystring = ::wxArrayString();

== wxColour ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| byte || Red || ||
|-

|-
| byte || Green || ||
|-

|-
| byte || Blue || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

|}
''NOTE: Is instantiated in a script using: local my_wxcolour = ::wxColour();

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

|}
''NOTE: Is instantiated in a script using: local my_wxpoint = ::wxPoint();

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

|}
''NOTE: Is instantiated in a script using: local my_wxsize = ::wxSize();

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || const wxString& targetName ||
|-

|-
| void || RenameBuildTarget || const wxString& oldTargetName, const wxString& newTargetName ||
|-

|-
| void || RemoveBuildTarget || const wxString& targetName ||
|-

|-
| const wxArrayString& || GetBuildTargets || ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || const wxString& targetName ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString|| GetCustomBuildCommand|| const wxString& compilerId ||
|-

|-
| void || SetCustomBuildCommand || const wxString& compilerId, const wxString& newBuildCommand ||
|-

|-
| bool || GetUseCustomBuildCommand|| const wxString& compilerId ||
|-

|-
| void || SetUseCustomBuildCommand || const wxString& compilerId, bool useCustomBuildCommand ||
|-

|-
| wxFileName || file || || (variable)
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|-
| wxArrayString || buildTargets || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| void || AddPlatform || int platform || windows,unix,mac
|-

|-
| void || RemovePlatform || int platform ||
|-

|-
| void || SetPlatforms || int platform ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || const wxArrayString& linkerOpts ||
|-

|-
| void || SetLinkLibs || const wxArrayString& linkLibs ||
|-

|-
| void || SetLinkerExecutable || LinkerExecutableOption option ||
|-

|-
| LinkerExecutableOption || GetLinkerExecutable || ||
|-

|-
| void || SetCompilerOptions || const wxArrayString& compilerOpts ||
|-

|-
| void || SetResourceCompilerOptions || const wxArrayString& resourceCompilerOpts ||
|-

|-
| void || SetIncludeDirs || const wxArrayString& includeDirs ||
|-

|-
| void || SetResourceIncludeDirs || const wxString& option ||
|-

|-
| void || SetLibDirs || const wxArrayString& libDirs ||
|-

|-
| void || SetCommandsBeforeBuild || const wxArrayString& commands ||
|-

|-
| void || SetCommandsAfterBuild || const wxArrayString& commands ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetResourceCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool modified ||
|-

|-
| void || AddLinkerOption || const wxString& option ||
|-

|-
| void || AddLinkLib || const wxString& lib ||
|-

|-
| void || AddCompilerOption || const wxString& option ||
|-

|-
| void || AddResourceCompilerOption || const wxString& option ||
|-

|-
| void || AddIncludeDir || const wxString& option ||
|-

|-
| void || AddResourceIncludeDir || const wxString& option ||
|-

|-
| void || AddLibDir || const wxString& option ||
|-

|-
| void || AddCommandsBeforeBuild || const wxString& command ||
|-

|-
| void || AddCommandsAfterBuild || const wxString& command ||
|-

|-
| void || ReplaceLinkerOption || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceLinkLib || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceCompilerOption || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceResourceCompilerOption || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceIncludeDir || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceResourceIncludeDir || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceLibDir || const wxString& option, const wxString& new_option ||
|-

|-
| void || RemoveLinkerOption || const wxString& option ||
|-

|-
| void || RemoveLinkLib || const wxString& lib ||
|-

|-
| void || RemoveCompilerOption || const wxString& option ||
|-

|-
| void || RemoveIncludeDir || const wxString& option ||
|-

|-
| void || RemoveResourceCompilerOption || const wxString& option ||
|-

|-
| void || RemoveResourceIncludeDir || const wxString& option ||
|-

|-
| void || RemoveLibDir || const wxString& option ||
|-

|-
| void || RemoveCommandsBeforeBuild || const wxString& command ||
|-

|-
| void || RemoveCommandsAfterBuild || const wxString& command ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool always ||
|-

|-
| void || SetBuildScripts || const wxArrayString& scripts ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || const wxString& script ||
|-

|-
| void || RemoveBuildScript || const wxString& script ||
|-

|-
| bool || SetVar || const wxString& key, const wxString& value, bool onlyIfExists = false ||
|-

|-
| wxString || GetVar || const wxString& key ||
|-

|-
| bool || UnsetVar || const wxString& key ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetTargetFilenameGenerationPolicy || TargetFilenameGenerationPolicy prefix, TargetFilenameGenerationPolicy extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| wxString || GetFilename || || The full project name (*.cbp)
|-

|-
| wxString || GetTitle || || Target name
|-

|-
| void || SetTitle || wxString title||
|-

|-
| void || SetOutputFilename || wxString filename||
|-

|-
| void || SetWorkingDir || wxString dirname||
|-

|-
| void || SetObjectOutput || wxString dirname||
|-

|-
| void || SetDepsOutput || wxString dirname||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType type||
|-

|-
| void || SetOptionRelation || OptionsRelationType type, OptionsRelation rel ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType pt||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString params||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString app||
|-

|-
| void || SetCompilerID || wxString id||
|-

|-
| wxString || GetCompilerID || ||
|-

|-
| wxString || GetMakeCommandFor || MakeCommand cmd ||
|-

|-
| void || SetMakeCommandFor || MakeCommand cmd, wxString make ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||Returns a list of files whose target depends (separated by ';')
|-

|-
| void || SetExternalDeps || wxString deps||Sets the list of files whose target depends (separated by ';')
|-

|-
| void || SetAdditionalOutputFiles || wxString files||Sets the list of additional output files (separated by ';')
|-

|-
| wxString || GetAdditionalOutputFiles || ||Returns a list of additional output files (separated by ';')
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

|-
| bool || GetCreateDefFile || || True if the target creates a DEF imports file. (valid for dynamic library targets only)
|-

|-
| void || SetCreateDefFile || bool createIt|| Set if the target creates a DEF imports file
|-

|-
| bool || GetCreateStaticLib || || Return true if an import library will be created, false if not (valid for dynamic library targets only)
|-

|-
| void || SetCreateStaticLib || bool ||Set if an import library should be created (valid for dynamic library targets only)
|-

|-
| bool || GetUseConsoleRunner || || Valid only for targets generating a console executable
|-

|-
| void || SetUseConsoleRunner || bool useIt||Valid only for targets generating a console executable
|-

|-
| ProjectFile* || GetFile || int index|| Returns a file from the target
|-

|-
| int || GetFilesCount || || Returns number of files for the target
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || || Return true if the project is modified in any way
|-

|-
| void || SetModified || bool modified|| Mark the project as modified or not
|-

|-
| wxString || GetMakefile || || Returns file name for the Makefile
|-

|-
| void || SetMakefile || wxString makefile || Set Makefile name when using a custom Makefile to build the project
|-

|-
| bool || IsMakefileCustom || || True if the project is using a custom Makefile for compilation, false if not
|-

|-
| void || SetMakefileCustom || bool custom || Mark if the project should use a custom Makefile for compilation
|-

|-
| bool || CloseAllFiles || bool dontsave || Close all project files. If dontsave is true no file would be saved even if modified
|-

|-
| bool || SaveAllFiles || || Save all project files
|-

|-
| bool || Save || || Save the project
|-

|-
| bool || SaveLayout || || Save the project's layout. Layout is the list of open project files, which one is active, where the cursor is located on each one of those, etc
|-

|-
| bool || LoadLayout || || Load the project's layout
|-

|-
| wxString || GetCommonTopLevelPath || || Returns the top-level path common to all project files
|-

|-
| int || GetFilesCount || || Returns number of files in the project
|-

|-
| ProjectFile* || GetFile || int index || Access a file of the project. Index is between 0 and GetFilesCount()
|-

|-
| ProjectFile* || GetFileByFilename || wxString filename, bool isRelative, bool isUnixFilename || Access a file of the project.
|-

|-
| bool || RemoveFile || ProjectFile *file || Remove a file from the project
|-

|-
| ProjectFile* || AddFile || const wxString &targetName, const wxString &fileaname, bool compile, bool link, int weight || See API docs for cbProject::AddFile
|-

|-
| ProjectFile* || AddFile || int targetIndex, const wxString &fileaname, bool compile, bool link, int weight || See API docs for cbProject::AddFile
|-

|-
| int || GetBuildTargetsCount || || Returns the number of targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int index|| Access a build target by index. Index is from 0 to GetBuildTargetsCount
|-

|-
| ProjectBuildTarget* || GetBuildTarget || const wxString &targetName || Access a build target by name
|-

|-
| ProjectBuildTarget* || AddBuildTarget || cont wxString &targetName || Add a new build target
|-

|-
| bool || RenameBuildTarget || int index, const wxString &targetName || Rename a build target
|-

|-
| bool || RenameBuildTarget || const wxString &oldTargetName, const wxString &newTargetName || Rename a build target
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int index, const wxString &newName || Duplicate a build target
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || const wxString &targetName, const wxString &newName || Duplicate a build target
|-

|-
| bool || RemoveBuildTarget || int index || Remove a build target
|-

|-
| bool || RemoveBuildTarget || const wxString &targetName || Remove a build target
|-

|-
| bool || ExportTargetAsProject || int index || Export a target as a new project. In other words, save a copy of the project containing only the specified target. The user will be prompted with a dialog to select the new project name.
|-

|-
| bool || ExportTargetAsProject || wxString targetName || Export a target as new project
|-

|-
| bool || BuildTargetValid || const wxString &name, bool virtualsToo || Is there a build target (virtual or real) by name?
|-

|-
| wxString || GetFirstValidBuildTargetName || bool virtualsToo || Returns the first valid (virtual or real) build target
|-

|-
| void || SetDefaultExecuteTarget || const wxString &name || Set the build target name which will be pre-selected when the "Select target" dialog appears when running the project
|-

|-
| wxString || GetDefaultExecuteTarget || || Returns the name of the build target which will be pre-selected when the "Select target" dialog appears when running the project
|-

|-
| bool || SetActiveBuildTarget || const wxString &name || Set the active build target. If name does not exist, then the first virtual target is set or the first real target, depending which is valid.
|-

|-
| wxString || GetActiveBuildTarget || || The active build target name. Note that this might be a virtual target ||
|-

|-
| int || SelectTarget || int initial, bool evenIfOne || Displays a target selection dialog. When invoked, a selection dialog is presented to the user so that he/she can select one target from the list of this project's targets.
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode mode ||
|-

|-
| void || SetExtendedObjectNamesGeneration || bool ext || Sets object names generation to extended/normal mode. In normal mode (the default), the file foo.cpp generates the foo.o object file. In extended mode, the file foo.cpp generates the foo.cpp.o object file
|-

|-
| bool || GetExtendedObjectNamesGeneration || || Returns true for extended mode, false for normal mode
|-

|-
| void || SetNotes || const wxString &notes || Set notes on the project
|-

|-
| wxString || GetNotes || || Returns the notes on the project
|-

|-
| void || SetShowNotesOnLoad || bool show || Set if to show project notes on load automatically
|-

|-
| bool || GetShowNotesOnLoad || || Returns true if project notes would be shown automatically during load
|-

|-
| void || ShowNotes || bool nonEmptyOnly, bool editable || Show project notes now
|-

|-
| void || AddToExtensions || wxString || Deprecated since rev 11857
|-

|-
| wxArrayString || ExtensionListNodes || const wxString &extension || Returns a list of child nodes to the given extension node. The elements of the list could be passed as extension parameters to all the Extension* methods. Available since rev 11857
|-

|-
| wxArrayString || ExtensionListNodeAttributes || const wxString &extension || Returns a list of with the names of the attributes on the given extension node. Available since rev 11857
|-

|-
| wxString || ExtensionGetNodeAttribute || const wxString &extension, const wxString &attributeName || Returns the value of the given attribute on the given extension node. If the attribute is not found it will return an empty string. Available since rev 11857
|-

|-
| void || ExtensionSetNodeAttribute || const wxString &extension, const wxString &attributeName, const wxString &attributeValue || Set the value of the given attribute on the given extension node. Available since rev 11857
|-

|-
| void || ExtensionRemoveNodeAttribute || const wxString &extension, const wxString &attributeName || Remove the given attribute on the given extension node. Available since rev 11857
|-

|-
| wxString || ExtensionAddNode || const wxString &extension, const wxString &nodeName || Add a child node to the given extension node. Return the extension string for the new node. Available since rev 11857
|-

|-
| void || ExtensionRemoveNode || const wxString &extension || Remove the given extension node. Available since rev 11857
|-

|-
| bool || DefineVirtualBuildTarget || const wxString &alias, const wxArrayString &targets || Define a new virtual build target. A virtual build target is not really a build target itself but it is an alias for a group of other build targets, real or virtual
|-

|-
| bool || HasVirtualBuildTarget|| const wxSring &alias || Does a virtual build target exist?
|-

|-
| bool || RemoveVirtualBuildTarget|| const wxString &alias || Remove a virtual build target. Return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || const wxString &alias || Access a virtual build target's group of build targets. Returns the list of all build targets under the alias
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| const wxString &alias || Access a virtual build target's expanded group of build targets. The difference from GetVirtualBuildTargetGroup() lies in that this function returns the full list of real build targets in this group (by recursively expanding virtual build targets in the group)
|-

|-
| bool || CanAddToVirtualBuildTarget || const wxSring &alias, const wxString &target || Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || const wxString &title || Changes project title. This method overrides CompileTargetBase::SetTitle. It sends additional notification event to plugins and than calls base method.
|-
|}

NOTE: Extension* methods take an extension parameter. This could be used to describe a way to access nodes in the extension xml element in the project file. The extension could be a path separated by '/' characters where every element of the path could be a node name, node name followed by an index or node name followed by attribute match.

Examples:

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"

|-
| _T("debugger") || Finds the first debugger node
|-

|-
| _T("debugger/remote_debugging") || Finds the first child named 'remote_debugging' of the first 'debugger' node
|-

|-
| _T("debugger/remote_debugging[1]") || Finds the second child named 'remote_debugging' of the first 'debugger' node
|-

|-
| _T("debugger/remote_debugging(target=Debug)") || Finds the first child named 'remote_debugging' which has an attribute named target and which has a value 'Debug'
|-
|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== TiXML Binding==
This describes the squirrel interface to read XML files. The base is the TinyXML library and for detailed function description, please refere to the official [https://www.grinninglizard.com/tinyxmldocs/index.html TinyXML documentation]. If a function from this section takes string as Argument it can take wxString or squirrel native strings. If a function returns a string it returns squirrel native strings.

Argument annotation: if multiple types are accepted they are separated with | . For example if a function takes an empty, string or int parameter for the first argument and a string for the second this is described as <syntaxhighlight lang="text">
(void | string | int, string)
</syntaxhighlight>

===TiXMLPrinter ===
{| class="wikitable"
!Return value
!Name
!Arguments
!Remark
|-
|string
|CStr
|
|Return the XML as string
|-
|void
|SetIndent
|string
|Set indentation string
|-
|void
|SetLineBreak
|string
| Set line break type
|}

===TiXMLNode===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
! Remark
|-
|string
|Value
|
|
|-
|void
|SetValue
|string
|
|}

===TiXmlDocument ===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXmlDocument
|constructor
|<nowiki>void | string</nowiki>
|
|-
|bool
|SaveFile
|
|
|-
|bool
|SaveFile
|string
|
|-
|bool
|LoadFile
|<nowiki>void | string</nowiki>
|
|-
|string
|Parse
|string
|
|-
|TiXmlElement
| RootElement
|
|
|-
|bool
|Error
|
|
|-
|string
|ErrorDesc
|
|
|-
|bool
|Accept
|TiXMLPringer
|
|}

=== TiXmlElement===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXmlElement
|constructor
|string, TiXmlElement
|
|-
|string
|Attribute
|string
|
|-
|TiXMLAttribute
|GetAttribute
|string
|
|-
|TiXMLAttribute
| FirstAttribute
|
|
|-
| TiXMLAttribute
| LastAttribute
|
|
|-
|void
|RemoveAttribute
|string
|
|-
|void
|SetAttribute
|<nowiki>(string, string | int | float)</nowiki>
|
|-
|TiXmlElement
|FirstChildElement
|<nowiki>(void | string)</nowiki>
|
|-
| TiXMLNode
|LastChild
|<nowiki>(void | string)</nowiki>
|
|-
|TiXmlElement
|LastChildElement
|<nowiki>(void | string)</nowiki>
|
|-
|TiXmlElement
|NextSiblingElement
|<nowiki>(void | string)</nowiki>
|
|-
| TiXMLNode
|PreviousSibling
|<nowiki>(void | string)</nowiki>
|
|-
|string
|GetText
|
|
|}

===TiXmlAttribute ===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXmlAttribute
|constructor
|<nowiki>(void) | (string, string)</nowiki>
|
|-
|string
| Value
|
|
|-
|string
|Name
|
|
|-
|int
|IntValue
|
|
|-
|float
|DoubleValue
|
|
|-
| TiXmlAttribute
|Next
|
|
|-
|void
|SetValue
|string
|
|-
|void
|SetName
|string
|
|}

===TiXmlHandle===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXmlHandle
|constructor
|<nowiki>TiXmlNode | TiXmlHandle</nowiki>
|
|-
|TiXmlHandle
|FirstChild
|<nowiki>void | string</nowiki>
|
|-
|TiXmlHandle
|FirstChildElement
|<nowiki>void | string</nowiki>
|
|-
|TiXmlNode
|ToNode
|
|
|-
|TiXmlElement
|ToElement
|
|
|-
|TiXmlNode
|Node
|
|
|-
|TiXmlElement
|Element
|
|
|}

==Constants==

{| style="border: 1px solid gray; border-collapse: collapse;" cellspacing="0" cellpadding="3" border="1"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
! Remarks
|-

|-
| PLATFORM||int||this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW||int||All Windows platforms
|-

|-
| PLATFORM_GTK||int||All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
|PLATFORM_MAC||int||All Mac platforms
|-

|-
|PLATFORM_OS2||int||OS/2 platform
|-

|-
|PLATFORM_X11||int||All X11 platforms
|-

|-
|PLATFORM_UNKNOWN||int||Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int||=1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int||=13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int||=13, it will change when the SDK interface breaks
|-
|-
! colspan="3" |Script binding version
|-
|SCRIPTING_VERSION_MAJOR||int||=2, it will change when the script binding interface breaks (for ex. bindings removed, api breaks, function type changed)
|-

|-
|SCRIPTING_VERSION_MINOR||int||=0, it will change when the script binding interface breaks (for ex. new bindings introduced)
|-

|-
|SCRIPTING_VERSION_RELEASE|| int||=0, it will change when the script binding interface breaks (bug fixes)
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Path separator for filenames'''
|-

|-
|wxFILE_SEP_PATH||wxString||Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Message dialog flags'''
|-

|-
|wxOK||int|| Flag for Message() 's third argument (flags).
|-

|-
|wxYES_NO||int|| -"-
|-

|-
| wxCANCEL||int||-"-
|-

|-
|wxICON_QUESTION|| int||-"-
|-

|-
|wxICON_INFORMATION||int||-"-
|-

|-
|wxICON_WARNING||int||-"-
|-

|-
|wxICON_ERROR||int||-"-
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Message dialog return values'''
|-

|-
|wxID_OK|| int||
|-

|-
|wxID_YES ||int||
|-

|-
|wxID_NO||int||
|-

|-
|wxID_CANCEL||int||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum wxPathFormat'''
|-

|-
|wxPATH_NATIVE||enum||
|-

|-
|wxPATH_UNIX||enum||
|-

|-
|wxPATH_BEOS||enum||
|-

|-
|wxPATH_MAC||enum||
|-

|wxPATH_DOS||enum||
|-

|-
| wxPATH_WIN|| enum||
|-

|-
|wxPATH_OS2||enum||
|-

|-
|wxPATH_VM3 ||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME||enum||include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR||enum||terminate the path with the separator
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum wxPathNormalize'''
|-

|-
|wxPATH_NORM_ENV_VARS||enum||replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS||enum||squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE||enum||Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE||enum||if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum||make the path absolute
|-

|-
|wxPATH_NORM_LONG||enum||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT ||enum||resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL|| enum||= 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum OptionsRelationType'''
|-

|-
|ortCompilerOptions|| enum||
|-

|-
| ortLinkerOptions||enum||
|-

|-
|ortIncludeDirs||enum||
|-

|-
|ortLibDirs||enum||
|-

|-
|ortResDirs||enum ||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum OptionsRelation'''
|-

|-
|orUseParentOptionsOnly|| enum||
|-

|-
|orUseTargetOptionsOnly||enum||
|-

|-
|orPrependToParentOptions||enum||
|-

|-
|orAppendToParentOptions||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum TargetType'''
|-

|-
| ttExecutable||enum||
|-

|-
|ttConsoleOnly||enum||
|-

|-
|ttStaticLib||enum||
|-

|-
|ttDynamicLib||enum||
|-

|-
|ttCommandsOnly||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum MakeCommand'''
|-

|-
|mcClean||enum||
|-

|-
|mcDistClean||enum ||
|-

|-
|mcBuild|| enum||
|-

|-
|mcCompileFile||enum||
|-

|-
|mcAskRebuildNeeded||enum||
|-

|-
|mcSilentBuild||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum PCHMode'''
|-

|-
|pchSourceDir||enum||
|-

|-
|pchObjectDir||enum||
|-

|-
|pchSourceFile||enum ||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum PrintScope'''
|-

|-
|psSelection||enum||
|-

|-
|psActiveEditor||enum ||
|-

|-
|psAllOpenEditors||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum PrintColourMode'''
|-

|-
|pcmBlackAndWhite||enum||
|-

|-
| pcmColourOnWhite||enum ||
|-

|-
|pcmInvertColours||enum||
|-

|-
|pcmAsIs||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum TemplateOutputType'''
|-

|-
|wizProject||enum||TemplateOutputType::totProject
|-

|-
|wizTarget || enum||TemplateOutputType::totTarget
|-

|-
|wizFiles ||enum||TemplateOutputType::totFiles
|-

|-
|wizCustom||enum|| TemplateOutputType::totCustom
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum SearchDirs'''
|-

|-
|sdHome||enum||User's home directory
|-

|-
| sdBase||enum||Code::Blocks' installation base
|-

|-
|sdTemp||enum||System-wide temp folder
|-

|-
|sdPath||enum||All dirs in the PATH environment variable
|-

|-
|sdConfig||enum|| Config folder
|-

|-
|sdCurrent||enum||Current working folder
|-

|-
|sdPluginsUser||enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser||enum||Scripts folder in user's dir
|-

|-
|sdDataUser||enum||Data folder in user's dir
|-

|-
|sdAllUser||enum|| Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal||enum||Plugins folder in base dir
|-

|-
|sdScriptsGlobal||enum||Scripts folder in base dir
|-

|-
|sdDataGlobal||enum||Data folder in base dir
|-

|-
|sdAllGlobal||enum||Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown||enum||All known dirs (i.e. all of the above)
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''SupportedPlatforms'''
|-

|-
|spMac||enum||
|-

|-
|spUnix ||enum||
|-

|-
|spWindows||enum||
|-

|-
|spAll||enum||
|

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''TargetFilenameGenerationPolicy'''
|-

|-
|tgfpPlatformDefault||enum||Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum||No automatic generation; let the user specify the full filename
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''ModuleType'''
|-

|-
|mtProjectManager ||enum||
|-

|-
|mtEditorManager||enum||
|-

|-
|mtLogManager||enum||
|-

|-
|mtOpenFilesList||enum||
|-

|-
|mtEditorTab||enum||
|-

|-
|mtUnknown||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''FileTreeDataKind'''
|-

|-
|ftdkUndefined||enum||
|-

|-
|ftdkProject||enum||
|-

|-
|ftdkFolder||enum||
|-

|-
|ftdkFile||enum||
|-

|-
|ftdkVirtualGroup||enum||
|-

|-
|ftdkVirtualFolder||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''File extensions (e.g. "cbp")'''
|-

|-
|EXT_WORKSPACE||wxString||
|-

|-
|EXT_CODEBLOCKS||wxString||
|-

|-
|EXT_DEVCPP||wxString||
|-

|-
|EXT_MSVC6||wxString||
|-

|-
|EXT_MSVC7||wxString||
|-

|-
|EXT_MSVC10||wxString||
|-

|-
| EXT_MSVC6_WORKSPACE||wxString||
|-

|-
|EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM||wxString||
|-

|-
| EXT_D||wxString||
|-

|-
|EXT_F||wxString||
|-

|-
|EXT_F77||wxString||
|-

|-
|EXT_F90||wxString||
|-

|-
|EXT_F95||wxString||
|-

|-
|EXT_FOR||wxString||
|-

|-
|EXT_FPP||wxString||
|-

|-
|EXT_F03||wxString||
|-

|-
|EXT_F08||wxString||
|-

|-
|EXT_JAVA||wxString||
|-

|-
|EXT_C||wxString||
|-

|-
|EXT_CC||wxString||
|-

|-
|EXT_CPP||wxString||
|-

|-
|EXT_CXX||wxString||
|-

|-
|EXT_CPLPL||wxString||
|-

|-
|EXT_INL||wxString||
|-

|-
|EXT_H||wxString||
|-

|-
|EXT_HH||wxString||
|-

|-
|EXT_HPP||wxString||
|-

|-
|EXT_HXX||wxString||
|-

|-
|EXT_HPLPL||wxString||
|-

|-
|EXT_S||wxString||
|-

|-
|EXT_SS||wxString||
|-

|-
|EXT_S62||wxString||
|-

|-
|EXT_OBJECT||wxString||
|-

|-
|EXT_XRCRESOURCE||wxString||
|-

|-
|EXT_STATICLIB||wxString||
|-

|-
|EXT_DYNAMICLIB||wxString||
|-

|-
|EXT_EXECUTABLE||wxString||
|-

|-
|EXT_NATIVE||wxString||
|-

|-
|EXT_RESOURCE||wxString||
|-

|-
|EXT_RESOURCEBIN||wxString||
|-

|-
|EXT_XML||wxString||
|-

|-
|EXT_SCRIPT||wxString||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
|DOT_EXT_WORKSPACE||wxString||
|-

|-
|DOT_EXT_CODEBLOCKS||wxString||
|-

|-
|DOT_EXT_DEVCPP||wxString||
|-

|-
|DOT_EXT_MSVC6||wxString||
|-

|-
|DOT_EXT_MSVC7||wxString||
|-

|-
|DOT_EXT_MSVC10||wxString||
|-

|-
|DOT_EXT_MSVC7_WORKSPACE||wxString||
|-

|-
|DOT_EXT_MSVC6_WORKSPACE||wxString||
|-

|-
|DOT_EXT_D||wxString||
|-

|-
|DOT_EXT_F||wxString||
|-

|-
|DOT_EXT_F77||wxString||
|-

|-
|DOT_EXT_F90||wxString||
|-

|-
|DOT_EXT_F95||wxString||
|-

|-
|DOT_EXT_FOR||wxString||
|-

|-
|DOT_EXT_FPP||wxString||
|-

|-
|DOT_EXT_F03||wxString||
|-

|-
|DOT_EXT_F08||wxString||
|-

|-
|DOT_EXT_JAVA||wxString||
|-

|-
|DOT_EXT_C||wxString||
|-

|-
|DOT_EXT_CC||wxString||
|-

|-
|DOT_EXT_CPP||wxString||
|-

|-
|DOT_EXT_CXX||wxString||
|-

|-
|DOT_EXT_HPP||wxString||
|-

|-
|DOT_EXT_CPLPL||wxString||
|-

|-
|DOT_EXT_H||wxString||
|-

|-
|DOT_EXT_HH||wxString||
|-

|-
|DOT_EXT_HPP||wxString||
|-

|-
|DOT_EXT_HXX||wxString||
|-

|-
|DOT_EXT_HPLPL||wxString||
|-

|-
|DOT_EXT_S||wxString||
|-

|-
|DOT_EXT_SS||wxString||
|-

|-
|DOT_EXT_S62||wxString||
|-

|-
|DOT_EXT_OBJECT||wxString||
|-

|-
|DOT_EXT_XRCRESOURCE||wxString||
|-

|-
|DOT_EXT_STATICLIB||wxString||
|-

|-
|DOT_EXT_DYNAMICLIB||wxString||
|-

|-
|DOT_EXT_EXECUTABLE||wxString||
|-

|-
|DOT_EXT_NATIVE||wxString||
|-

|-
|DOT_EXT_RESOURCE||wxString||
|-

|-
|DOT_EXT_RESOURCEBIN||wxString||
|-

|-
|DOT_EXT_XML||wxString||
|-

|-
|DOT_EXT_SCRIPT||wxString||
|-

|}

==Plugins with script bindings==
[[Environment Variables plugin]] Plugin to change environment variables

==Script example collection==
[[Some examples]]

==See also==

*[[Scripting Code::Blocks|Scripting index]]

Scripting commands

2022-04-15T15:28:03Z

BlueHazzard: Add binding information for TiXML binding

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's built-in commands only. The host application (Code::Blocks) needs to expose parts of its internals to scripts, so scripts can use and control the host.

Code::Blocks has exposed a very large chunk of its SDK to scripts. This makes scripting in Code::Blocks nearly as powerful as native code (C++).

In this page all the exported constants, functions and classes are documented as a quick reference. For detailed documentation on each function/class, refer to the Code::Blocks SDK documentation.

''NOTE: Please remember that [http://www.squirrel-lang.org Squirrel] is typeless. Data types mentioned below are only used for documentation purposes.''

''NOTE: Please keep in mind that if a function has default parameters in C++ (which can be ommitted), you still have to type them for scripts (for e.g. exposed wxWidgets functionality). This means you *have* to use e.g. wxFileName.GetFullPath(wxPATH_NATIVE) instead of e.g only wxFileName.GetFullPath().

''NOTE: Updated to '''12.11'''

== Application object ==
The application object is accessed through the variable named '''<tt>App</tt>'''. Currently it has no bound functions...

== Global functions ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Log || wxString || logs to the application log
|-

|-
| void || LogDebug || wxString || logs to the debug log
|-

|-
| void || LogWarning || wxString || logs a warning
|-

|-
| void || LogError || wxString || logs an error
|-

|-
| int || Message || wxString,wxString,int || arg1=msg, arg2=caption, arg3=buttons; see API docs for cbMessageBox()
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

|-
| void || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

|-
| bool || IsNull || void* ||
|-

|-
| bool || wxLaunchDefaultBrowser || wxString ||
|-

|-
| wxColour || wxGetColourFromUser || [wxColour] ||
|-

|-
| long || wxGetNumberFromUser || wxString,wxString,wxString ||
|-

|-
| wxString || wxGetPasswordFromUser || wxString,wxString,wxString ||
|-

|-
| wxString || wxGetTextFromUser || wxString,wxString,wxString ||
|-

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''Notes:'''
The namespaces are accesses by prepending it's name (e.g. "IO.") to the scripting function, e.g. "IO.DirectoryExists(...)". "::" is only used when declaring the members of the namespace.
The functions in bold are going through the scripts security layer so there is no guarantee calling them will succeed. You should always examine the return value...
There exists one constant too, named ''allowInsecureScripts'', which allow you to test whether Code::Blocks was compiled with the functions going through the security layer.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int || arg1=position
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int, int || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''NOTE: Is instantiated in a script using: local my_wxstring = ::wxString();

== wxArrayString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Add || wxString, size_t || arg1=string, arg2=number of copies to add
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''NOTE: Is instantiated in a script using: local my_wxarraystring = ::wxArrayString();

== wxColour ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| byte || Red || ||
|-

|-
| byte || Green || ||
|-

|-
| byte || Blue || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

|}
''NOTE: Is instantiated in a script using: local my_wxcolour = ::wxColour();

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

|}
''NOTE: Is instantiated in a script using: local my_wxpoint = ::wxPoint();

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

|}
''NOTE: Is instantiated in a script using: local my_wxsize = ::wxSize();

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || const wxString& targetName ||
|-

|-
| void || RenameBuildTarget || const wxString& oldTargetName, const wxString& newTargetName ||
|-

|-
| void || RemoveBuildTarget || const wxString& targetName ||
|-

|-
| const wxArrayString& || GetBuildTargets || ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || const wxString& targetName ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString|| GetCustomBuildCommand|| const wxString& compilerId ||
|-

|-
| void || SetCustomBuildCommand || const wxString& compilerId, const wxString& newBuildCommand ||
|-

|-
| bool || GetUseCustomBuildCommand|| const wxString& compilerId ||
|-

|-
| void || SetUseCustomBuildCommand || const wxString& compilerId, bool useCustomBuildCommand ||
|-

|-
| wxFileName || file || || (variable)
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|-
| wxArrayString || buildTargets || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments in Prototype
!Remarks
|-

|-
| void || AddPlatform || int platform || windows,unix,mac
|-

|-
| void || RemovePlatform || int platform ||
|-

|-
| void || SetPlatforms || int platform ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || const wxArrayString& linkerOpts ||
|-

|-
| void || SetLinkLibs || const wxArrayString& linkLibs ||
|-

|-
| void || SetLinkerExecutable || LinkerExecutableOption option ||
|-

|-
| LinkerExecutableOption || GetLinkerExecutable || ||
|-

|-
| void || SetCompilerOptions || const wxArrayString& compilerOpts ||
|-

|-
| void || SetResourceCompilerOptions || const wxArrayString& resourceCompilerOpts ||
|-

|-
| void || SetIncludeDirs || const wxArrayString& includeDirs ||
|-

|-
| void || SetResourceIncludeDirs || const wxString& option ||
|-

|-
| void || SetLibDirs || const wxArrayString& libDirs ||
|-

|-
| void || SetCommandsBeforeBuild || const wxArrayString& commands ||
|-

|-
| void || SetCommandsAfterBuild || const wxArrayString& commands ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetResourceCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool modified ||
|-

|-
| void || AddLinkerOption || const wxString& option ||
|-

|-
| void || AddLinkLib || const wxString& lib ||
|-

|-
| void || AddCompilerOption || const wxString& option ||
|-

|-
| void || AddResourceCompilerOption || const wxString& option ||
|-

|-
| void || AddIncludeDir || const wxString& option ||
|-

|-
| void || AddResourceIncludeDir || const wxString& option ||
|-

|-
| void || AddLibDir || const wxString& option ||
|-

|-
| void || AddCommandsBeforeBuild || const wxString& command ||
|-

|-
| void || AddCommandsAfterBuild || const wxString& command ||
|-

|-
| void || ReplaceLinkerOption || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceLinkLib || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceCompilerOption || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceResourceCompilerOption || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceIncludeDir || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceResourceIncludeDir || const wxString& option, const wxString& new_option ||
|-

|-
| void || ReplaceLibDir || const wxString& option, const wxString& new_option ||
|-

|-
| void || RemoveLinkerOption || const wxString& option ||
|-

|-
| void || RemoveLinkLib || const wxString& lib ||
|-

|-
| void || RemoveCompilerOption || const wxString& option ||
|-

|-
| void || RemoveIncludeDir || const wxString& option ||
|-

|-
| void || RemoveResourceCompilerOption || const wxString& option ||
|-

|-
| void || RemoveResourceIncludeDir || const wxString& option ||
|-

|-
| void || RemoveLibDir || const wxString& option ||
|-

|-
| void || RemoveCommandsBeforeBuild || const wxString& command ||
|-

|-
| void || RemoveCommandsAfterBuild || const wxString& command ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool always ||
|-

|-
| void || SetBuildScripts || const wxArrayString& scripts ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || const wxString& script ||
|-

|-
| void || RemoveBuildScript || const wxString& script ||
|-

|-
| bool || SetVar || const wxString& key, const wxString& value, bool onlyIfExists = false ||
|-

|-
| wxString || GetVar || const wxString& key ||
|-

|-
| bool || UnsetVar || const wxString& key ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetTargetFilenameGenerationPolicy || TargetFilenameGenerationPolicy prefix, TargetFilenameGenerationPolicy extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| wxString || GetFilename || || The full project name (*.cbp)
|-

|-
| wxString || GetTitle || || Target name
|-

|-
| void || SetTitle || wxString title||
|-

|-
| void || SetOutputFilename || wxString filename||
|-

|-
| void || SetWorkingDir || wxString dirname||
|-

|-
| void || SetObjectOutput || wxString dirname||
|-

|-
| void || SetDepsOutput || wxString dirname||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType type||
|-

|-
| void || SetOptionRelation || OptionsRelationType type, OptionsRelation rel ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType pt||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString params||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString app||
|-

|-
| void || SetCompilerID || wxString id||
|-

|-
| wxString || GetCompilerID || ||
|-

|-
| wxString || GetMakeCommandFor || MakeCommand cmd ||
|-

|-
| void || SetMakeCommandFor || MakeCommand cmd, wxString make ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||Returns a list of files whose target depends (separated by ';')
|-

|-
| void || SetExternalDeps || wxString deps||Sets the list of files whose target depends (separated by ';')
|-

|-
| void || SetAdditionalOutputFiles || wxString files||Sets the list of additional output files (separated by ';')
|-

|-
| wxString || GetAdditionalOutputFiles || ||Returns a list of additional output files (separated by ';')
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

|-
| bool || GetCreateDefFile || || True if the target creates a DEF imports file. (valid for dynamic library targets only)
|-

|-
| void || SetCreateDefFile || bool createIt|| Set if the target creates a DEF imports file
|-

|-
| bool || GetCreateStaticLib || || Return true if an import library will be created, false if not (valid for dynamic library targets only)
|-

|-
| void || SetCreateStaticLib || bool ||Set if an import library should be created (valid for dynamic library targets only)
|-

|-
| bool || GetUseConsoleRunner || || Valid only for targets generating a console executable
|-

|-
| void || SetUseConsoleRunner || bool useIt||Valid only for targets generating a console executable
|-

|-
| ProjectFile* || GetFile || int index|| Returns a file from the target
|-

|-
| int || GetFilesCount || || Returns number of files for the target
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || || Return true if the project is modified in any way
|-

|-
| void || SetModified || bool modified|| Mark the project as modified or not
|-

|-
| wxString || GetMakefile || || Returns file name for the Makefile
|-

|-
| void || SetMakefile || wxString makefile || Set Makefile name when using a custom Makefile to build the project
|-

|-
| bool || IsMakefileCustom || || True if the project is using a custom Makefile for compilation, false if not
|-

|-
| void || SetMakefileCustom || bool custom || Mark if the project should use a custom Makefile for compilation
|-

|-
| bool || CloseAllFiles || bool dontsave || Close all project files. If dontsave is true no file would be saved even if modified
|-

|-
| bool || SaveAllFiles || || Save all project files
|-

|-
| bool || Save || || Save the project
|-

|-
| bool || SaveLayout || || Save the project's layout. Layout is the list of open project files, which one is active, where the cursor is located on each one of those, etc
|-

|-
| bool || LoadLayout || || Load the project's layout
|-

|-
| wxString || GetCommonTopLevelPath || || Returns the top-level path common to all project files
|-

|-
| int || GetFilesCount || || Returns number of files in the project
|-

|-
| ProjectFile* || GetFile || int index || Access a file of the project. Index is between 0 and GetFilesCount()
|-

|-
| ProjectFile* || GetFileByFilename || wxString filename, bool isRelative, bool isUnixFilename || Access a file of the project.
|-

|-
| bool || RemoveFile || ProjectFile *file || Remove a file from the project
|-

|-
| ProjectFile* || AddFile || const wxString &targetName, const wxString &fileaname, bool compile, bool link, int weight || See API docs for cbProject::AddFile
|-

|-
| ProjectFile* || AddFile || int targetIndex, const wxString &fileaname, bool compile, bool link, int weight || See API docs for cbProject::AddFile
|-

|-
| int || GetBuildTargetsCount || || Returns the number of targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int index|| Access a build target by index. Index is from 0 to GetBuildTargetsCount
|-

|-
| ProjectBuildTarget* || GetBuildTarget || const wxString &targetName || Access a build target by name
|-

|-
| ProjectBuildTarget* || AddBuildTarget || cont wxString &targetName || Add a new build target
|-

|-
| bool || RenameBuildTarget || int index, const wxString &targetName || Rename a build target
|-

|-
| bool || RenameBuildTarget || const wxString &oldTargetName, const wxString &newTargetName || Rename a build target
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int index, const wxString &newName || Duplicate a build target
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || const wxString &targetName, const wxString &newName || Duplicate a build target
|-

|-
| bool || RemoveBuildTarget || int index || Remove a build target
|-

|-
| bool || RemoveBuildTarget || const wxString &targetName || Remove a build target
|-

|-
| bool || ExportTargetAsProject || int index || Export a target as a new project. In other words, save a copy of the project containing only the specified target. The user will be prompted with a dialog to select the new project name.
|-

|-
| bool || ExportTargetAsProject || wxString targetName || Export a target as new project
|-

|-
| bool || BuildTargetValid || const wxString &name, bool virtualsToo || Is there a build target (virtual or real) by name?
|-

|-
| wxString || GetFirstValidBuildTargetName || bool virtualsToo || Returns the first valid (virtual or real) build target
|-

|-
| void || SetDefaultExecuteTarget || const wxString &name || Set the build target name which will be pre-selected when the "Select target" dialog appears when running the project
|-

|-
| wxString || GetDefaultExecuteTarget || || Returns the name of the build target which will be pre-selected when the "Select target" dialog appears when running the project
|-

|-
| bool || SetActiveBuildTarget || const wxString &name || Set the active build target. If name does not exist, then the first virtual target is set or the first real target, depending which is valid.
|-

|-
| wxString || GetActiveBuildTarget || || The active build target name. Note that this might be a virtual target ||
|-

|-
| int || SelectTarget || int initial, bool evenIfOne || Displays a target selection dialog. When invoked, a selection dialog is presented to the user so that he/she can select one target from the list of this project's targets.
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode mode ||
|-

|-
| void || SetExtendedObjectNamesGeneration || bool ext || Sets object names generation to extended/normal mode. In normal mode (the default), the file foo.cpp generates the foo.o object file. In extended mode, the file foo.cpp generates the foo.cpp.o object file
|-

|-
| bool || GetExtendedObjectNamesGeneration || || Returns true for extended mode, false for normal mode
|-

|-
| void || SetNotes || const wxString &notes || Set notes on the project
|-

|-
| wxString || GetNotes || || Returns the notes on the project
|-

|-
| void || SetShowNotesOnLoad || bool show || Set if to show project notes on load automatically
|-

|-
| bool || GetShowNotesOnLoad || || Returns true if project notes would be shown automatically during load
|-

|-
| void || ShowNotes || bool nonEmptyOnly, bool editable || Show project notes now
|-

|-
| void || AddToExtensions || wxString || Deprecated since rev 11857
|-

|-
| wxArrayString || ExtensionListNodes || const wxString &extension || Returns a list of child nodes to the given extension node. The elements of the list could be passed as extension parameters to all the Extension* methods. Available since rev 11857
|-

|-
| wxArrayString || ExtensionListNodeAttributes || const wxString &extension || Returns a list of with the names of the attributes on the given extension node. Available since rev 11857
|-

|-
| wxString || ExtensionGetNodeAttribute || const wxString &extension, const wxString &attributeName || Returns the value of the given attribute on the given extension node. If the attribute is not found it will return an empty string. Available since rev 11857
|-

|-
| void || ExtensionSetNodeAttribute || const wxString &extension, const wxString &attributeName, const wxString &attributeValue || Set the value of the given attribute on the given extension node. Available since rev 11857
|-

|-
| void || ExtensionRemoveNodeAttribute || const wxString &extension, const wxString &attributeName || Remove the given attribute on the given extension node. Available since rev 11857
|-

|-
| wxString || ExtensionAddNode || const wxString &extension, const wxString &nodeName || Add a child node to the given extension node. Return the extension string for the new node. Available since rev 11857
|-

|-
| void || ExtensionRemoveNode || const wxString &extension || Remove the given extension node. Available since rev 11857
|-

|-
| bool || DefineVirtualBuildTarget || const wxString &alias, const wxArrayString &targets || Define a new virtual build target. A virtual build target is not really a build target itself but it is an alias for a group of other build targets, real or virtual
|-

|-
| bool || HasVirtualBuildTarget|| const wxSring &alias || Does a virtual build target exist?
|-

|-
| bool || RemoveVirtualBuildTarget|| const wxString &alias || Remove a virtual build target. Return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || const wxString &alias || Access a virtual build target's group of build targets. Returns the list of all build targets under the alias
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| const wxString &alias || Access a virtual build target's expanded group of build targets. The difference from GetVirtualBuildTargetGroup() lies in that this function returns the full list of real build targets in this group (by recursively expanding virtual build targets in the group)
|-

|-
| bool || CanAddToVirtualBuildTarget || const wxSring &alias, const wxString &target || Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || const wxString &title || Changes project title. This method overrides CompileTargetBase::SetTitle. It sends additional notification event to plugins and than calls base method.
|-
|}

NOTE: Extension* methods take an extension parameter. This could be used to describe a way to access nodes in the extension xml element in the project file. The extension could be a path separated by '/' characters where every element of the path could be a node name, node name followed by an index or node name followed by attribute match.

Examples:

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"

|-
| _T("debugger") || Finds the first debugger node
|-

|-
| _T("debugger/remote_debugging") || Finds the first child named 'remote_debugging' of the first 'debugger' node
|-

|-
| _T("debugger/remote_debugging[1]") || Finds the second child named 'remote_debugging' of the first 'debugger' node
|-

|-
| _T("debugger/remote_debugging(target=Debug)") || Finds the first child named 'remote_debugging' which has an attribute named target and which has a value 'Debug'
|-
|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== TiXML Binding==
This describes the squirrel interface to read XML files. The base is the TinyXML library and for detailed function description, please refere to the official [https://www.grinninglizard.com/tinyxmldocs/index.html TinyXML documentation]. If a function from this section takes string as Argument it can take wxString or squirrel native strings. If a function returns a string it returns squirrel native strings.

Argument annotation: if multiple types are accepted they are separated with | . For example if a function takes an empty, string or int parameter for the first argument and a string for the second this is described as <syntaxhighlight lang="text">
(void | string | int, string)
</syntaxhighlight>

===TiXMLPrinter ===
{| class="wikitable"
!Return value
!Name
!Arguments
!Remark
|-
|string
|CStr
|
|Return the XML as string
|-
|void
|SetIndent
|string
|Set indentation string
|-
|void
|SetLineBreak
|string
| Set line break type
|}

===TiXMLNode===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
! Remark
|-
|string
|Value
|
|
|-
|void
|SetValue
|string
|
|}

===TiXMLDocument ===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXMLDocument
|constructor
|
|
|-
|bool
|SaveFile
|
|
|-
|bool
|SaveFile
|string
|
|-
|bool
|LoadFile
|<nowiki>void | string</nowiki>
|
|-
|string
|Parse
|string
|
|-
|TiXMLElement
| RootElement
|
|
|-
|bool
|Error
|
|
|-
|string
|ErrorDesc
|
|
|-
|bool
|Accept
|TiXMLPringer
|
|}

=== TiXMLElement===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXMLElement
|constructor
|
|
|-
|string
|Attribute
|string
|
|-
|TiXMLAttribute
|GetAttribute
|string
|
|-
|TiXMLAttribute
| FirstAttribute
|
|
|-
| TiXMLAttribute
| LastAttribute
|
|
|-
|void
|RemoveAttribute
|string
|
|-
|void
|SetAttribute
|<nowiki>(string, string | int | float)</nowiki>
|
|-
|TiXMLElement
|FirstChildElement
|<nowiki>(void | string)</nowiki>
|
|-
| TiXMLNode
|LastChild
|<nowiki>(void | string)</nowiki>
|
|-
|TiXMLElement
|LastChildElement
|<nowiki>(void | string)</nowiki>
|
|-
|TiXMLElement
|NextSiblingElement
|<nowiki>(void | string)</nowiki>
|
|-
| TiXMLNode
|PreviousSibling
|<nowiki>(void | string)</nowiki>
|
|-
|string
|GetText
|
|
|}

===TiXmlAttribute ===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXmlAttribute
|constructor
|
|
|-
|string
| Value
|
|
|-
|string
|Name
|
|
|-
|int
|IntValue
|
|
|-
|float
|DoubleValue
|
|
|-
| TiXmlAttribute
|Next
|
|
|-
|void
|SetValue
|string
|
|-
|void
|SetName
|string
|
|}

===TiXmlHandle===
{| class="wikitable"
|+
!Return value
!Name
!Arguments
!Remark
|-
|TiXmlHandle
|constructor
|
|
|-
|TiXmlHandle
|FirstChild
|<nowiki>void | string</nowiki>
|
|-
|TiXmlHandle
|FirstChildElement
|<nowiki>void | string</nowiki>
|
|-
|TiXMLNode
|ToNode
|
|
|-
|TiXMLElement
|ToElement
|
|
|-
|TiXMLNode
|Node
|
|
|-
|TiXMLElement
|Element
|
|
|}

==Constants==

{| style="border: 1px solid gray; border-collapse: collapse;" cellspacing="0" cellpadding="3" border="1"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
! Remarks
|-

|-
| PLATFORM||int||this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW||int||All Windows platforms
|-

|-
| PLATFORM_GTK||int||All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
|PLATFORM_MAC||int||All Mac platforms
|-

|-
|PLATFORM_OS2||int||OS/2 platform
|-

|-
|PLATFORM_X11||int||All X11 platforms
|-

|-
|PLATFORM_UNKNOWN||int||Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int||=1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int||=13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int||=13, it will change when the SDK interface breaks
|-
|-
! colspan="3" |Script binding version
|-
|SCRIPTING_VERSION_MAJOR||int||=2, it will change when the script binding interface breaks (for ex. bindings removed, api breaks, function type changed)
|-

|-
|SCRIPTING_VERSION_MINOR||int||=0, it will change when the script binding interface breaks (for ex. new bindings introduced)
|-

|-
|SCRIPTING_VERSION_RELEASE|| int||=0, it will change when the script binding interface breaks (bug fixes)
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Path separator for filenames'''
|-

|-
|wxFILE_SEP_PATH||wxString||Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Message dialog flags'''
|-

|-
|wxOK||int|| Flag for Message() 's third argument (flags).
|-

|-
|wxYES_NO||int|| -"-
|-

|-
| wxCANCEL||int||-"-
|-

|-
|wxICON_QUESTION|| int||-"-
|-

|-
|wxICON_INFORMATION||int||-"-
|-

|-
|wxICON_WARNING||int||-"-
|-

|-
|wxICON_ERROR||int||-"-
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''Message dialog return values'''
|-

|-
|wxID_OK|| int||
|-

|-
|wxID_YES ||int||
|-

|-
|wxID_NO||int||
|-

|-
|wxID_CANCEL||int||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum wxPathFormat'''
|-

|-
|wxPATH_NATIVE||enum||
|-

|-
|wxPATH_UNIX||enum||
|-

|-
|wxPATH_BEOS||enum||
|-

|-
|wxPATH_MAC||enum||
|-

|wxPATH_DOS||enum||
|-

|-
| wxPATH_WIN|| enum||
|-

|-
|wxPATH_OS2||enum||
|-

|-
|wxPATH_VM3 ||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME||enum||include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR||enum||terminate the path with the separator
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum wxPathNormalize'''
|-

|-
|wxPATH_NORM_ENV_VARS||enum||replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS||enum||squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE||enum||Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE||enum||if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum||make the path absolute
|-

|-
|wxPATH_NORM_LONG||enum||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT ||enum||resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL|| enum||= 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum OptionsRelationType'''
|-

|-
|ortCompilerOptions|| enum||
|-

|-
| ortLinkerOptions||enum||
|-

|-
|ortIncludeDirs||enum||
|-

|-
|ortLibDirs||enum||
|-

|-
|ortResDirs||enum ||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum OptionsRelation'''
|-

|-
|orUseParentOptionsOnly|| enum||
|-

|-
|orUseTargetOptionsOnly||enum||
|-

|-
|orPrependToParentOptions||enum||
|-

|-
|orAppendToParentOptions||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum TargetType'''
|-

|-
| ttExecutable||enum||
|-

|-
|ttConsoleOnly||enum||
|-

|-
|ttStaticLib||enum||
|-

|-
|ttDynamicLib||enum||
|-

|-
|ttCommandsOnly||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum MakeCommand'''
|-

|-
|mcClean||enum||
|-

|-
|mcDistClean||enum ||
|-

|-
|mcBuild|| enum||
|-

|-
|mcCompileFile||enum||
|-

|-
|mcAskRebuildNeeded||enum||
|-

|-
|mcSilentBuild||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum PCHMode'''
|-

|-
|pchSourceDir||enum||
|-

|-
|pchObjectDir||enum||
|-

|-
|pchSourceFile||enum ||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum PrintScope'''
|-

|-
|psSelection||enum||
|-

|-
|psActiveEditor||enum ||
|-

|-
|psAllOpenEditors||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum PrintColourMode'''
|-

|-
|pcmBlackAndWhite||enum||
|-

|-
| pcmColourOnWhite||enum ||
|-

|-
|pcmInvertColours||enum||
|-

|-
|pcmAsIs||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum TemplateOutputType'''
|-

|-
|wizProject||enum||TemplateOutputType::totProject
|-

|-
|wizTarget || enum||TemplateOutputType::totTarget
|-

|-
|wizFiles ||enum||TemplateOutputType::totFiles
|-

|-
|wizCustom||enum|| TemplateOutputType::totCustom
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''enum SearchDirs'''
|-

|-
|sdHome||enum||User's home directory
|-

|-
| sdBase||enum||Code::Blocks' installation base
|-

|-
|sdTemp||enum||System-wide temp folder
|-

|-
|sdPath||enum||All dirs in the PATH environment variable
|-

|-
|sdConfig||enum|| Config folder
|-

|-
|sdCurrent||enum||Current working folder
|-

|-
|sdPluginsUser||enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser||enum||Scripts folder in user's dir
|-

|-
|sdDataUser||enum||Data folder in user's dir
|-

|-
|sdAllUser||enum|| Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal||enum||Plugins folder in base dir
|-

|-
|sdScriptsGlobal||enum||Scripts folder in base dir
|-

|-
|sdDataGlobal||enum||Data folder in base dir
|-

|-
|sdAllGlobal||enum||Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown||enum||All known dirs (i.e. all of the above)
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''SupportedPlatforms'''
|-

|-
|spMac||enum||
|-

|-
|spUnix ||enum||
|-

|-
|spWindows||enum||
|-

|-
|spAll||enum||
|

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''TargetFilenameGenerationPolicy'''
|-

|-
|tgfpPlatformDefault||enum||Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum||No automatic generation; let the user specify the full filename
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''ModuleType'''
|-

|-
|mtProjectManager ||enum||
|-

|-
|mtEditorManager||enum||
|-

|-
|mtLogManager||enum||
|-

|-
|mtOpenFilesList||enum||
|-

|-
|mtEditorTab||enum||
|-

|-
|mtUnknown||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''FileTreeDataKind'''
|-

|-
|ftdkUndefined||enum||
|-

|-
|ftdkProject||enum||
|-

|-
|ftdkFolder||enum||
|-

|-
|ftdkFile||enum||
|-

|-
|ftdkVirtualGroup||enum||
|-

|-
|ftdkVirtualFolder||enum||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''File extensions (e.g. "cbp")'''
|-

|-
|EXT_WORKSPACE||wxString||
|-

|-
|EXT_CODEBLOCKS||wxString||
|-

|-
|EXT_DEVCPP||wxString||
|-

|-
|EXT_MSVC6||wxString||
|-

|-
|EXT_MSVC7||wxString||
|-

|-
|EXT_MSVC10||wxString||
|-

|-
| EXT_MSVC6_WORKSPACE||wxString||
|-

|-
|EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM||wxString||
|-

|-
| EXT_D||wxString||
|-

|-
|EXT_F||wxString||
|-

|-
|EXT_F77||wxString||
|-

|-
|EXT_F90||wxString||
|-

|-
|EXT_F95||wxString||
|-

|-
|EXT_FOR||wxString||
|-

|-
|EXT_FPP||wxString||
|-

|-
|EXT_F03||wxString||
|-

|-
|EXT_F08||wxString||
|-

|-
|EXT_JAVA||wxString||
|-

|-
|EXT_C||wxString||
|-

|-
|EXT_CC||wxString||
|-

|-
|EXT_CPP||wxString||
|-

|-
|EXT_CXX||wxString||
|-

|-
|EXT_CPLPL||wxString||
|-

|-
|EXT_INL||wxString||
|-

|-
|EXT_H||wxString||
|-

|-
|EXT_HH||wxString||
|-

|-
|EXT_HPP||wxString||
|-

|-
|EXT_HXX||wxString||
|-

|-
|EXT_HPLPL||wxString||
|-

|-
|EXT_S||wxString||
|-

|-
|EXT_SS||wxString||
|-

|-
|EXT_S62||wxString||
|-

|-
|EXT_OBJECT||wxString||
|-

|-
|EXT_XRCRESOURCE||wxString||
|-

|-
|EXT_STATICLIB||wxString||
|-

|-
|EXT_DYNAMICLIB||wxString||
|-

|-
|EXT_EXECUTABLE||wxString||
|-

|-
|EXT_NATIVE||wxString||
|-

|-
|EXT_RESOURCE||wxString||
|-

|-
|EXT_RESOURCEBIN||wxString||
|-

|-
|EXT_XML||wxString||
|-

|-
|EXT_SCRIPT||wxString||
|-

|-
| colspan="3" style="background: #f8f8f8;" align="center" |'''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
|DOT_EXT_WORKSPACE||wxString||
|-

|-
|DOT_EXT_CODEBLOCKS||wxString||
|-

|-
|DOT_EXT_DEVCPP||wxString||
|-

|-
|DOT_EXT_MSVC6||wxString||
|-

|-
|DOT_EXT_MSVC7||wxString||
|-

|-
|DOT_EXT_MSVC10||wxString||
|-

|-
|DOT_EXT_MSVC7_WORKSPACE||wxString||
|-

|-
|DOT_EXT_MSVC6_WORKSPACE||wxString||
|-

|-
|DOT_EXT_D||wxString||
|-

|-
|DOT_EXT_F||wxString||
|-

|-
|DOT_EXT_F77||wxString||
|-

|-
|DOT_EXT_F90||wxString||
|-

|-
|DOT_EXT_F95||wxString||
|-

|-
|DOT_EXT_FOR||wxString||
|-

|-
|DOT_EXT_FPP||wxString||
|-

|-
|DOT_EXT_F03||wxString||
|-

|-
|DOT_EXT_F08||wxString||
|-

|-
|DOT_EXT_JAVA||wxString||
|-

|-
|DOT_EXT_C||wxString||
|-

|-
|DOT_EXT_CC||wxString||
|-

|-
|DOT_EXT_CPP||wxString||
|-

|-
|DOT_EXT_CXX||wxString||
|-

|-
|DOT_EXT_HPP||wxString||
|-

|-
|DOT_EXT_CPLPL||wxString||
|-

|-
|DOT_EXT_H||wxString||
|-

|-
|DOT_EXT_HH||wxString||
|-

|-
|DOT_EXT_HPP||wxString||
|-

|-
|DOT_EXT_HXX||wxString||
|-

|-
|DOT_EXT_HPLPL||wxString||
|-

|-
|DOT_EXT_S||wxString||
|-

|-
|DOT_EXT_SS||wxString||
|-

|-
|DOT_EXT_S62||wxString||
|-

|-
|DOT_EXT_OBJECT||wxString||
|-

|-
|DOT_EXT_XRCRESOURCE||wxString||
|-

|-
|DOT_EXT_STATICLIB||wxString||
|-

|-
|DOT_EXT_DYNAMICLIB||wxString||
|-

|-
|DOT_EXT_EXECUTABLE||wxString||
|-

|-
|DOT_EXT_NATIVE||wxString||
|-

|-
|DOT_EXT_RESOURCE||wxString||
|-

|-
|DOT_EXT_RESOURCEBIN||wxString||
|-

|-
|DOT_EXT_XML||wxString||
|-

|-
|DOT_EXT_SCRIPT||wxString||
|-

|}

==Plugins with script bindings==
[[Environment Variables plugin]] Plugin to change environment variables

==Script example collection==
[[Some examples]]

==See also==

*[[Scripting Code::Blocks|Scripting index]]

Build scripts

2022-01-18T07:34:01Z

BlueHazzard: base is a keyword in squirrel, so we need a other name for the parameter

[[Category:Scripting Code::Blocks]]

Build scripts can help configuring build options and reusing these configurations.

What you need to do is create as many build scripts are needed and attach them to projects or build targets.

Let's see an example build script for the GNU GCC compiler:

// file: build_debug_symbols.script

function SetBuildOptions(cbase)
{
// enable debugging symbols
cbase.AddCompilerOption(_T("-g"));
// disable all optimizations
cbase.AddCompilerOption(_T("-O0"));
}

The "cbase" parameter in this function is a CompiletargetBase instance. SetBuildOptions(cbase) is called before the project/target is built. Each build script ''must define this function'', even if it is not needed (in which case you can leave it with an empty body).

This specific script enables the generation of debugging symbols for the build target it is attached to. You could similarly have other build scripts for different configuration sets like optimizations, architecture, C++ options, C++ standards, etc.

Great. Now you have created your own set of build scripts. How do you attach them to project/targets? Simple: "Project->Properties->Scripts". Select the project or target to attach a script to and click "Add". If you want to detach a script, click "Remove".
You can also change the order scripts are ran with the two little arrows on the right side.
Finally, you can press "Validate all scripts" to make sure that the attached build scripts are valid.

If you choose to go the build scripts way for your project, please don't use the project build options dialog (unless maybe for global project settings). If you do, things may not work as expected and you will unrightfully blame Code::Blocks for this ;).

Well, that's all there is to it!

''NOTE: I 've been told that this is like MS Visual Studio's "properties". I wouldn't know since I don't use it myself. But maybe this similarity (if it really exists) helps you grasp the concept better.''

== See also ==

* [[Scripting commands]]

FAQ-Compiling (general)

2014-04-01T11:29:54Z

BlueHazzard: make the rebuild location more clear

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: What compiler can I use with Code::Blocks? ====

'''A:''' Code::Blocks philosophy is to be able to use any compiler on earth! Well, almost.

As a matter of fact it largely depends on the used compiler plugin. Some provided with the default Code::Blocks installation are GNU GCC (MinGW/Cygwin), MS Visual C++ Free Toolkit 2003, Borland's C++ Compiler 5.5, DigitalMars Free Compiler., OpenWatcom, Small Device C Compiler (SDCC) and others.

==== Q: My project should be compiled with a custom makefile. Is it possible with Code::Blocks? ====

'''A:''' Yes, you can. You need to change one settings with Code::Blocks 8.02:

In your project's Properties, check "This is a custom makefile".

And that's it! :)

==== Q: I have downloaded MS VC++ Toolkit 2003 for a compiler. How do I tell Code::Blocks that it is my compiler? ====

'''A:''' Click on "Project/Build options" and select the compiler you want for your project/target.

==== Q: Microsoft calls MSVCRT.DLL a "Known DLL." How do I know if I can/should use it? ====

Microsoft does not clearly describe what [http://msdn2.microsoft.com/en-us/library/abx4dbyh.aspx 'Known DLL'] means. A [http://www.zlib.net/DLL_FAQ.txt zLib FAQ entry] makes it much more clear. The short answer is that MSVCRT.DLL is a protected system component and to preserve system integrity it cannot be updated by any end user product installers but may be updated from time to time by system updates. If it works use it. If it doesn't you'll need use a non protected library such as MSVCR70 or MSVCR80 which not only can be updated but private versions can be installed. A small and simple C program is likely to work just fine with MSVCRT.DLL. A large and complex C++ program is more likely to need the additional functionality of MSVCR.

The MSVCRT.LIB that ships with 32 bit compiler Visual C++ Toolkit 2003 dynamically links to MSVCR71.DLL which is not present in a freshly installed Windows XP system. MSVCR only appears after some software package that needs it such as [http://www.adobe.com/ Adobe Acrobat Reader] is installed. This means that programs that depend on MSVCR must redistribute it or risk not working on a substantial percentage of systems for reasons not obvious to either the affected end users or the program supplier.

For projects that can safely use MSVCRT and where it is impractical to redistribute MSVCR, a Win32 MSVCRT.LIB that links to MSVCRT.DLL is available in any [http://www.microsoft.com/whdc/devtools/ddk/default.mspx Device Driver Kit]. It is best to preserve the MSVCRT.LIB provided by the compiler and alter the name of the MSVCRT.LIB extracted from a DDK. List your newly named MSVCRTxx in the lib. If you use MSVCRT.LIB from the Windows 2003 DDK you may encounter the link '''error LNK2001: unresolved external symbol ___security_cookie'''. This can be solved by switching to the MSVCRT.LIB in the Windows XP DDK or by linking '''bufferoverflowU.lib''' found in the Windows SDK. A Win64 MSVCRT.LIB that links to MSVCRT.DLL is available in the Windows SDK or Platform [http://www.microsoft.com/downloads/details.aspx?FamilyId=E15438AC-60BE-41BD-AA14-7F1E0F19CA0D&displaylang=en PSDK].

To prevent problems it is recommended to include both /MD and /NODEFAULTLIB:MSVCRT switches so that problems come up at link time instead of random crashes at run time. Be sure to load your programs into [http://www.dependencywalker.com/ Dependancy Walker] to ensure that functions aren't being linked into both MSVCRxx.DLL and MSVCRT.DLL. It is essential that malloc, calloc, realloc, free, and related memory allocation functions all import from the same DLL.

Source: [http://wiki.tcl.tk/11431 TCL Wiki]

==== Q: How can I use a DLL without DEF or LIB files? ====

'''A:''' I tried to find a solution, and the following script solved the problem for me. I used a cygwin environment for ''tclsh'' and ''sed'', but the MinGW tools for ''objdump'' and ''dlltool''. See here [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

TODO: Someone might add some informations about problems

Request: Is MinGW or Code::Blocks able to support automatic generation of import libraries ?

See also: http://www.mingw.org/wiki/CreateImportLibraries

See also: http://wyw.dcweb.cn/stdcall.htm

==== Q: Where are the libraries for the OpenGL, Ogre3D, SDL, QT, wxWidgets etc. projects? ====

'''A:''' They're not bundled. The templates were provided for your convenience, but you need to download the libraries on your own.
In common terms, "batteries not included" :)

==== Q: Is it possible to use Visual C++ 6.0 with Code::Blocks? ====

'''A:''' Yes. See [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]] for a detailed description on using VC++ 6.0 with Code::Blocks.

==== Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist? ====

'''A:''' You can specify them for your global environment or just for your project.

For global environment : 
- Menu Settings/Compiler and debugger 
- In the Global compiler settings, select the directories tab 
- Add the required paths for compiler and linker. 
 
For your project : 
- Right click on the project then select Build options 
- Select the directories tab 
- Add the required paths for compiler and linker. 
- Add your specific libraries in the linker tab. 
- Pay attention to project settings and target settings.
==== Q: How do I use both Debug and Release builds of wx libraries? ====
'''A:''' I would use the default method of doing it and the default folder naming.

Using these C::B custom varibles
WX_SUFFIX="" // ANSI Release
WX_SUFFIX="d" // ANSI Debug
WX_SUFFIX="u" // Unicode Release
WX_SUFFIX="ud" // Unicode debug

I use WX_CFG when I am using a special configuration
WX_CFG="rc3"

Remember, the CodeBlocks globel variable WX needs to point to the wxWidgets folder.

Example minGW build command for "Unicode debug" 2.8.0 RC3

mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

"VENDOR=" just puts rc3 in the DLL name; "CFG=" sets which folder the DLL is placed in. In this case in lib\gcc_dllrc3

Before using CFG in the mingw32-make build you need to do one prior wxWidget build without using it; else the build errors out. (See note below.)

"__WXDEBUG__" must be defined (in the codeblocks project setting) if you wish to link against the debug version of wxWidgets DLL. Else you will get a runtime error, when you try to run your project output.

Contributed by Tim S

Note:
*I have never gotten the following command to work
mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*unless I have first run this command on the same wxWidgets folders
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*I am guessing that the build without the CFG creates a file or directory needed by the build with the CFG.

==== Q: How do I add version information to windows executables and dll's? ====
'''A:''' You need to create a resource file with the extension .rc and write the version info there. Then add that file to the Code::Blocks project you are working on.

Sample content of a resource file that you can use and modify for your needs:
<source lang="cpp" enclose="div">
LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US

VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,0,0,1
PRODUCTVERSION 1,0,0,1
FILEFLAGSMASK 0x3fL // VS_FFI_FILEFLAGSMASK
#ifdef _DEBUG
FILEFLAGS 0x1L // VS_FF_DEBUG|VS_FF_PRIVATEBUILD|VS_FF_PRERELEASE
#else
FILEFLAGS 0x0L // final version
#endif
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
FILESUBTYPE VFT2_UNKNOWN // not used
{
BLOCK "StringFileInfo"
{
BLOCK "040904E4" // Lang=US English, CharSet=Windows Multilingual
{
VALUE "Build", "August 2007\0"
VALUE "Comments", "Free for personal use only.\0"
VALUE "CompanyName", "Fake Company\0"
VALUE "Developer", "The Developer\0"
VALUE "FileDescription", "Application implementing something\0"
VALUE "FileVersion", "1.0.000\0"
VALUE "InternalName", "AppInternalName\0"
VALUE "LegalCopyright", "Copyright (C) 2007 Fake Company\0"
VALUE "LegalTrademarks", "All rights reserved.\0"
VALUE "OriginalFilename", "TheEXE.exe\0"
VALUE "PrivateBuild", "\0"
VALUE "ProductName", "The EXE\0"
VALUE "ProductVersion", "1.0.000\0"
VALUE "SpecialBuild", "\0"
VALUE "Support", "TheEXE at fake-domain.com\0"
VALUE "Users", "Unlimited.\0"
} // BLOCK "040904E4"
} // BLOCK "StringFileInfo"
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x409, 1252 // 1252 = 0x04E4
} // BLOCK "VarFileInfo"
}
</source>

Also you can use the the [[AutoVersioning plugin]] to assist you on the generation of version information. For documentation of the syntax and values used on windows resource files, you can visit the following websites:
*http://msdn2.microsoft.com/en-us/library/aa380599.aspx
*http://www.cygwin.com/cygwin-ug-net/windres.html

==== Q: Code::Blocks does not force relink if the library is changed? ====

'''A:''' Open ''Project->Properties...->Build targets (tab)'' and select the executable. Click ''Dependencies...'' and add the name of the library (including its relative path) to ''External dependency files''. Also see [[The build process of Code::Blocks#Using project dependencies|inter-project dependencies]].

''Example:'' <tt>output\myLibrary\libdostuff.a</tt>

==== Q: How do I report a compilation problem on the forums? ====

'''A:''' Try building the project from command line. If the same error comes up, it is a problem with either the source file, the compiler, or the compiler setup. If this is the case, you are unlikely to receive support for it on the Code::Blocks forums, however, [[FAQ-Compiling (errors)#Q: How do I troubleshoot a compiler problem?|How do I troubleshoot a compiler problem?]] may help.

If it works fine building from command line, it is either a problem with your project, Code::Blocks' setup, or possibly an actual bug. When posting this problem, include the name of your compiler, operating system, Code::Blocks version, compiler log (go to ''Settings->Compiler and debugger...->Build options (tab)'' and check ''Save build log'' and ''Always output the full command line''), and, if it caused Code::Blocks to crash, the <tt>codeblocks.RPT</tt> file (located in the Code::Blocks installation directory).

''Template: Paste the following template into your post, editing the relevant sections.''
I am running Code::Blocks version ''Code::BlocksVersionNumber'' on ''MyOperatingSystem''
(version ''OperatingSystemVersionNumber''). The compiler I use is ''CompilerName''
version ''CompilerVersionNumber''.

When I ...
''Steps to reproduce problem.''

''Description of problem.''
... happens.

Build log:
[code]
''Paste '''full''' build log here. (It is found in the 'Build log' tab). Please make always a 'rebuild' (Menu: Build->Rebuild) or a 'clean' and 'build' before you copy the full build log. ''
[/code]

Crash report:
[code]
''Paste the contents of'' codeblocks.RPT ''here (if Code::Blocks crashed).''
[/code]

''(Although the following is not necessary, showing that you''
''have tried increases the probability of a response.)''
I have already tried ...
''List of attempted solutions.''
... but none of them worked.

==== Q: All of the Build related options are grayed out? ====

'''A:''' Code::Blocks checks the file extension for individual files before allowing them to be compiled. Save your file with the correct file extension (<tt>*.c</tt> or <tt>*.cpp</tt>).

More often it is useful to [[Creating a new project|create a project]] so that Code::Blocks can manage the entire build.

----

Return to '''[[FAQ]]'''.

Code::Blocks command line arguments

2014-02-11T11:59:24Z

BlueHazzard: +1

[[Category: User Documentation]]
== Using command line arguments ==

=== Windows ===

# Find the Code::Blocks shortcut in the Desktop or Start menu.
# Right click on the icon and select Properties.
# Select the Shortcut tab.
# Append the command line arguments you want to use to the end of the Target text (behind the quote mark).
# Run Code::Blocks by using the shortcut you edited.

'''Example'''

"C:\Program Files\CodeBlocks\codeblocks.exe" /na /nd

=== *nix ===

# Launch a terminal client, such as XTerm, Gnome Terminal or Konsole.
# Type "codeblocks" and then append the command line arguments you want to use.

Note: Code::Blocks can not run on a real console, X11 must be running and you must use a graphical terminal emulator.

'''Example'''

codeblocks --no-splash-screen --debug-log

== Command line arguments ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 1px solid gray"
! Argument
! Function
|-

|-
| ''<filename>''
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
|-

|-
| '''--file='''''<filename>[:line]''
| Open file in Code::Blocks and optionally jump to a specific line.
|-

|-
| '''/h''', '''--help''', '''/?''', '''--?'''
| Shows a help message about the command line arguments.
|-

|-
| '''/na''', '''--no-check-associations'''
| Don't perform any file association checks (Windows only).
|-

|-
| '''/nd''', '''--no-dde'''
| Don't start a [http://en.wikipedia.org/wiki/Dynamic_Data_Exchange DDE] server (Windows only).
|-

|-
| '''/ns''', '''--no-splash-screen'''
| Hides the splash screen when the application is loading.
|-

|-
| '''/d''', '''--debug-log'''
| Display application's debug log.
|-

|-
| '''--prefix='''''<str>''
| Sets the shared data directory prefix.
|-

|-
| '''/p''', '''--personality='''''<str>'', '''--profile='''''<str>''
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
|-

|-
| '''--rebuild'''
| Clean and build the project / workspace.
|-

|-
| '''--build'''
| Build the project / workspace.
|-

|-
| '''--target='''''<str>''
| Sets target for batch build. For example --target="Release".
|-

|-
| '''--no-batch-window-close'''
| Keeps the batch log window visible after the batch build has completed.
|-

|-
| '''--batch-build-notify'''
| Shows a message after the batch build has completed.
|-

|-
| '''--user-data-dir=<path>'''
| specify an alternative directory for user settings and user installed plugins
|-

|-
| '''--script=<str>'''
| specify a script file to run after loading
|-

|-
| '''--target=<str>'''
| the target for the batch build
|-

|-
| '''--clean'''
| clean the project/workspace
|-

|-
| '''--rebuild'''
| clean and then build the project/workspace
|-

|-
| '''--build'''
| just build the project/workspace
|-

|-
| '''--verbose'''
| Enable logging of c::b errors
|-

|-
| '''>''' ''<build log file>''
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
|-

|}

Code::Blocks command line arguments

2014-02-11T11:53:26Z

BlueHazzard: Add other options

[[Category: User Documentation]]
== Using command line arguments ==

=== Windows ===

# Find the Code::Blocks shortcut in the Desktop or Start menu.
# Right click on the icon and select Properties.
# Select the Shortcut tab.
# Append the command line arguments you want to use to the end of the Target text (behind the quote mark).
# Run Code::Blocks by using the shortcut you edited.

'''Example'''

"C:\Program Files\CodeBlocks\codeblocks.exe" /na /nd

=== *nix ===

# Launch a terminal client, such as XTerm, Gnome Terminal or Konsole.
# Type "codeblocks" and then append the command line arguments you want to use.

Note: Code::Blocks can not run on a real console, X11 must be running and you must use a graphical terminal emulator.

'''Example'''

codeblocks --no-splash-screen --debug-log

== Command line arguments ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 1px solid gray"
! Argument
! Function
|-

|-
| ''<filename>''
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
|-

|-
| '''--file='''''<filename>[:line]''
| Open file in Code::Blocks and optionally jump to a specific line.
|-

|-
| '''/h''', '''--help''', '''/?''', '''--?'''
| Shows a help message about the command line arguments.
|-

|-
| '''/na''', '''--no-check-associations'''
| Don't perform any file association checks (Windows only).
|-

|-
| '''/nd''', '''--no-dde'''
| Don't start a [http://en.wikipedia.org/wiki/Dynamic_Data_Exchange DDE] server (Windows only).
|-

|-
| '''/ns''', '''--no-splash-screen'''
| Hides the splash screen when the application is loading.
|-

|-
| '''/d''', '''--debug-log'''
| Display application's debug log.
|-

|-
| '''--prefix='''''<str>''
| Sets the shared data directory prefix.
|-

|-
| '''/p''', '''--personality='''''<str>'', '''--profile='''''<str>''
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
|-

|-
| '''--rebuild'''
| Clean and build the project / workspace.
|-

|-
| '''--build'''
| Build the project / workspace.
|-

|-
| '''--target='''''<str>''
| Sets target for batch build. For example --target="Release".
|-

|-
| '''--no-batch-window-close'''
| Keeps the batch log window visible after the batch build has completed.
|-

|-
| '''--batch-build-notify'''
| Shows a message after the batch build has completed.
|-

|-
| '''--user-data-dir=<path>'''
| specify an alternative directory for user settings and user installed plugins
|-

|-
| '''--script=<str>'''
| specify a script file to run after loading
|-

|-
| '''--target=<str>'''
| the target for the batch build
|-

|-
| '''--clean'''
| clean the project/workspace
|-

|-
| '''--rebuild'''
| clean and then build the project/workspace
|-

|-
| '''--build'''
| just build the project/workspace
|-

|-
| '''>''' ''<build log file>''
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
|-

|}

Code::Blocks command line arguments

2014-02-11T11:33:04Z

BlueHazzard: Added command line parameter user-data-dir

[[Category: User Documentation]]
== Using command line arguments ==

=== Windows ===

# Find the Code::Blocks shortcut in the Desktop or Start menu.
# Right click on the icon and select Properties.
# Select the Shortcut tab.
# Append the command line arguments you want to use to the end of the Target text (behind the quote mark).
# Run Code::Blocks by using the shortcut you edited.

'''Example'''

"C:\Program Files\CodeBlocks\codeblocks.exe" /na /nd

=== *nix ===

# Launch a terminal client, such as XTerm, Gnome Terminal or Konsole.
# Type "codeblocks" and then append the command line arguments you want to use.

Note: Code::Blocks can not run on a real console, X11 must be running and you must use a graphical terminal emulator.

'''Example'''

codeblocks --no-splash-screen --debug-log

== Command line arguments ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 1px solid gray"
! Argument
! Function
|-

|-
| ''<filename>''
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
|-

|-
| '''--file='''''<filename>[:line]''
| Open file in Code::Blocks and optionally jump to a specific line.
|-

|-
| '''/h''', '''--help''', '''/?''', '''--?'''
| Shows a help message about the command line arguments.
|-

|-
| '''/na''', '''--no-check-associations'''
| Don't perform any file association checks (Windows only).
|-

|-
| '''/nd''', '''--no-dde'''
| Don't start a [http://en.wikipedia.org/wiki/Dynamic_Data_Exchange DDE] server (Windows only).
|-

|-
| '''/ns''', '''--no-splash-screen'''
| Hides the splash screen when the application is loading.
|-

|-
| '''/d''', '''--debug-log'''
| Display application's debug log.
|-

|-
| '''--prefix='''''<str>''
| Sets the shared data directory prefix.
|-

|-
| '''/p''', '''--personality='''''<str>'', '''--profile='''''<str>''
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
|-

|-
| '''--rebuild'''
| Clean and build the project / workspace.
|-

|-
| '''--build'''
| Build the project / workspace.
|-

|-
| '''--target='''''<str>''
| Sets target for batch build. For example --target="Release".
|-

|-
| '''--no-batch-window-close'''
| Keeps the batch log window visible after the batch build has completed.
|-

|-
| '''--batch-build-notify'''
| Shows a message after the batch build has completed.
|-

|-
| '''>''' ''<build log file>''
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
|-

|-
| '''--user-data-dir=<path>'''
| specify an alternative directory for user settings and user installed plugins
|-

|}

FAQ-Compiling (general)

2014-01-19T21:01:03Z

BlueHazzard: /* Q: How do I report a compilation problem on the forums? */

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: What compiler can I use with Code::Blocks? ====

'''A:''' Code::Blocks philosophy is to be able to use any compiler on earth! Well, almost.

As a matter of fact it largely depends on the used compiler plugin. Some provided with the default Code::Blocks installation are GNU GCC (MinGW/Cygwin), MS Visual C++ Free Toolkit 2003, Borland's C++ Compiler 5.5, DigitalMars Free Compiler., OpenWatcom, Small Device C Compiler (SDCC) and others.

==== Q: My project should be compiled with a custom makefile. Is it possible with Code::Blocks? ====

'''A:''' Yes, you can. You need to change one settings with Code::Blocks 8.02:

In your project's Properties, check "This is a custom makefile".

And that's it! :)

==== Q: I have downloaded MS VC++ Toolkit 2003 for a compiler. How do I tell Code::Blocks that it is my compiler? ====

'''A:''' Click on "Project/Build options" and select the compiler you want for your project/target.

==== Q: Microsoft calls MSVCRT.DLL a "Known DLL." How do I know if I can/should use it? ====

Microsoft does not clearly describe what [http://msdn2.microsoft.com/en-us/library/abx4dbyh.aspx 'Known DLL'] means. A [http://www.zlib.net/DLL_FAQ.txt zLib FAQ entry] makes it much more clear. The short answer is that MSVCRT.DLL is a protected system component and to preserve system integrity it cannot be updated by any end user product installers but may be updated from time to time by system updates. If it works use it. If it doesn't you'll need use a non protected library such as MSVCR70 or MSVCR80 which not only can be updated but private versions can be installed. A small and simple C program is likely to work just fine with MSVCRT.DLL. A large and complex C++ program is more likely to need the additional functionality of MSVCR.

The MSVCRT.LIB that ships with 32 bit compiler Visual C++ Toolkit 2003 dynamically links to MSVCR71.DLL which is not present in a freshly installed Windows XP system. MSVCR only appears after some software package that needs it such as [http://www.adobe.com/ Adobe Acrobat Reader] is installed. This means that programs that depend on MSVCR must redistribute it or risk not working on a substantial percentage of systems for reasons not obvious to either the affected end users or the program supplier.

For projects that can safely use MSVCRT and where it is impractical to redistribute MSVCR, a Win32 MSVCRT.LIB that links to MSVCRT.DLL is available in any [http://www.microsoft.com/whdc/devtools/ddk/default.mspx Device Driver Kit]. It is best to preserve the MSVCRT.LIB provided by the compiler and alter the name of the MSVCRT.LIB extracted from a DDK. List your newly named MSVCRTxx in the lib. If you use MSVCRT.LIB from the Windows 2003 DDK you may encounter the link '''error LNK2001: unresolved external symbol ___security_cookie'''. This can be solved by switching to the MSVCRT.LIB in the Windows XP DDK or by linking '''bufferoverflowU.lib''' found in the Windows SDK. A Win64 MSVCRT.LIB that links to MSVCRT.DLL is available in the Windows SDK or Platform [http://www.microsoft.com/downloads/details.aspx?FamilyId=E15438AC-60BE-41BD-AA14-7F1E0F19CA0D&displaylang=en PSDK].

To prevent problems it is recommended to include both /MD and /NODEFAULTLIB:MSVCRT switches so that problems come up at link time instead of random crashes at run time. Be sure to load your programs into [http://www.dependencywalker.com/ Dependancy Walker] to ensure that functions aren't being linked into both MSVCRxx.DLL and MSVCRT.DLL. It is essential that malloc, calloc, realloc, free, and related memory allocation functions all import from the same DLL.

Source: [http://wiki.tcl.tk/11431 TCL Wiki]

==== Q: How can I use a DLL without DEF or LIB files? ====

'''A:''' I tried to find a solution, and the following script solved the problem for me. I used a cygwin environment for ''tclsh'' and ''sed'', but the MinGW tools for ''objdump'' and ''dlltool''. See here [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

TODO: Someone might add some informations about problems

Request: Is MinGW or Code::Blocks able to support automatic generation of import libraries ?

See also: http://www.mingw.org/wiki/CreateImportLibraries

See also: http://wyw.dcweb.cn/stdcall.htm

==== Q: Where are the libraries for the OpenGL, Ogre3D, SDL, QT, wxWidgets etc. projects? ====

'''A:''' They're not bundled. The templates were provided for your convenience, but you need to download the libraries on your own.
In common terms, "batteries not included" :)

==== Q: Is it possible to use Visual C++ 6.0 with Code::Blocks? ====

'''A:''' Yes. See [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]] for a detailed description on using VC++ 6.0 with Code::Blocks.

==== Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist? ====

'''A:''' You can specify them for your global environment or just for your project.

For global environment : 
- Menu Settings/Compiler and debugger 
- In the Global compiler settings, select the directories tab 
- Add the required paths for compiler and linker. 
 
For your project : 
- Right click on the project then select Build options 
- Select the directories tab 
- Add the required paths for compiler and linker. 
- Add your specific libraries in the linker tab. 
- Pay attention to project settings and target settings.
==== Q: How do I use both Debug and Release builds of wx libraries? ====
'''A:''' I would use the default method of doing it and the default folder naming.

Using these C::B custom varibles
WX_SUFFIX="" // ANSI Release
WX_SUFFIX="d" // ANSI Debug
WX_SUFFIX="u" // Unicode Release
WX_SUFFIX="ud" // Unicode debug

I use WX_CFG when I am using a special configuration
WX_CFG="rc3"

Remember, the CodeBlocks globel variable WX needs to point to the wxWidgets folder.

Example minGW build command for "Unicode debug" 2.8.0 RC3

mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

"VENDOR=" just puts rc3 in the DLL name; "CFG=" sets which folder the DLL is placed in. In this case in lib\gcc_dllrc3

Before using CFG in the mingw32-make build you need to do one prior wxWidget build without using it; else the build errors out. (See note below.)

"__WXDEBUG__" must be defined (in the codeblocks project setting) if you wish to link against the debug version of wxWidgets DLL. Else you will get a runtime error, when you try to run your project output.

Contributed by Tim S

Note:
*I have never gotten the following command to work
mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*unless I have first run this command on the same wxWidgets folders
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*I am guessing that the build without the CFG creates a file or directory needed by the build with the CFG.

==== Q: How do I add version information to windows executables and dll's? ====
'''A:''' You need to create a resource file with the extension .rc and write the version info there. Then add that file to the Code::Blocks project you are working on.

Sample content of a resource file that you can use and modify for your needs:
<source lang="cpp" enclose="div">
LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US

VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,0,0,1
PRODUCTVERSION 1,0,0,1
FILEFLAGSMASK 0x3fL // VS_FFI_FILEFLAGSMASK
#ifdef _DEBUG
FILEFLAGS 0x1L // VS_FF_DEBUG|VS_FF_PRIVATEBUILD|VS_FF_PRERELEASE
#else
FILEFLAGS 0x0L // final version
#endif
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
FILESUBTYPE VFT2_UNKNOWN // not used
{
BLOCK "StringFileInfo"
{
BLOCK "040904E4" // Lang=US English, CharSet=Windows Multilingual
{
VALUE "Build", "August 2007\0"
VALUE "Comments", "Free for personal use only.\0"
VALUE "CompanyName", "Fake Company\0"
VALUE "Developer", "The Developer\0"
VALUE "FileDescription", "Application implementing something\0"
VALUE "FileVersion", "1.0.000\0"
VALUE "InternalName", "AppInternalName\0"
VALUE "LegalCopyright", "Copyright (C) 2007 Fake Company\0"
VALUE "LegalTrademarks", "All rights reserved.\0"
VALUE "OriginalFilename", "TheEXE.exe\0"
VALUE "PrivateBuild", "\0"
VALUE "ProductName", "The EXE\0"
VALUE "ProductVersion", "1.0.000\0"
VALUE "SpecialBuild", "\0"
VALUE "Support", "TheEXE at fake-domain.com\0"
VALUE "Users", "Unlimited.\0"
} // BLOCK "040904E4"
} // BLOCK "StringFileInfo"
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x409, 1252 // 1252 = 0x04E4
} // BLOCK "VarFileInfo"
}
</source>

Also you can use the the [[AutoVersioning plugin]] to assist you on the generation of version information. For documentation of the syntax and values used on windows resource files, you can visit the following websites:
*http://msdn2.microsoft.com/en-us/library/aa380599.aspx
*http://www.cygwin.com/cygwin-ug-net/windres.html

==== Q: Code::Blocks does not force relink if the library is changed? ====

'''A:''' Open ''Project->Properties...->Build targets (tab)'' and select the executable. Click ''Dependencies...'' and add the name of the library (including its relative path) to ''External dependency files''. Also see [[The build process of Code::Blocks#Using project dependencies|inter-project dependencies]].

''Example:'' <tt>output\myLibrary\libdostuff.a</tt>

==== Q: How do I report a compilation problem on the forums? ====

'''A:''' Try building the project from command line. If the same error comes up, it is a problem with either the source file, the compiler, or the compiler setup. If this is the case, you are unlikely to receive support for it on the Code::Blocks forums, however, [[FAQ-Compiling (errors)#Q: How do I troubleshoot a compiler problem?|How do I troubleshoot a compiler problem?]] may help.

If it works fine building from command line, it is either a problem with your project, Code::Blocks' setup, or possibly an actual bug. When posting this problem, include the name of your compiler, operating system, Code::Blocks version, compiler log (go to ''Settings->Compiler and debugger...->Build options (tab)'' and check ''Save build log'' and ''Always output the full command line''), and, if it caused Code::Blocks to crash, the <tt>codeblocks.RPT</tt> file (located in the Code::Blocks installation directory).

''Template: Paste the following template into your post, editing the relevant sections.''
I am running Code::Blocks version ''Code::BlocksVersionNumber'' on ''MyOperatingSystem''
(version ''OperatingSystemVersionNumber''). The compiler I use is ''CompilerName''
version ''CompilerVersionNumber''.

When I ...
''Steps to reproduce problem.''

''Description of problem.''
... happens.

Build log:
[code]
''Paste '''full''' build log here. (It is found in the 'Build log' tab). Please make always a 'rebuild' or a 'clean' and 'build' before you copy the full build log. ''
[/code]

Crash report:
[code]
''Paste the contents of'' codeblocks.RPT ''here (if Code::Blocks crashed).''
[/code]

''(Although the following is not necessary, showing that you''
''have tried increases the probability of a response.)''
I have already tried ...
''List of attempted solutions.''
... but none of them worked.

==== Q: All of the Build related options are grayed out? ====

'''A:''' Code::Blocks checks the file extension for individual files before allowing them to be compiled. Save your file with the correct file extension (<tt>*.c</tt> or <tt>*.cpp</tt>).

More often it is useful to [[Creating a new project|create a project]] so that Code::Blocks can manage the entire build.

----

Return to '''[[FAQ]]'''.

FAQ-Compiling (errors)

2014-01-19T20:58:31Z

BlueHazzard: /* Q: How do I troubleshoot a compiler problem? */

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: How do I troubleshoot a compiler problem? ====

'''A:''' I would start by turning on full Compiler logging.

This is done by selecting the "Full command line" option Under menu "Settings" -> "Compiler" -> Global compiler settings -> [the compiler you use] -> "Other Setting" tab, "Compiler logging". In 12.11 and newer this is enabled by default.

This option will make Code::Blocks output the exact commands it uses to compile your code.

Things to remember:

* Look at the "Build Log" NOT the "Build Message" tab
* Do a re-build instead of build in order to get a full build log.
* You should review all the commands and their options;
* If you have compiled your app before, do a ''re-''build (or ''clean'' before build) to see all compiling / linking steps;
* If you don't know what an option or a command does please read the documentation for the compiler/linker you're using;
* Look for missing commands;
* For every source file (<tt>.cpp</tt>; <tt>.c</tt>; <tt>.d</tt>; etc) in your project, you must have at least one command in the log. This command must produce an object file (file extension <tt>.o</tt> if using gcc/g++ and <tt>.obj</tt> if using Visual Studio);
* Every object file should be linked in the final executable, if not there are undefined symbols errors;
* Remember the file extension matters: <tt>*.c</tt> is compiled as C file, <tt>*.cpp</tt> is compiled as C++ file. [http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html Read more]
* If you have no luck, you can try to ask in the forum, but '''read''' first [https://wiki.codeblocks.org/index.php?title=FAQ-Compiling_%28general%29#Q:_How_do_I_report_a_compilation_problem_on_the_forums.3F "How do I report a compilation problem on the forums"]

==== Q: What do I need to know when using 3rd party libs? ====
Here are some basics about typical mistakes done when working with third party libs, including wxWidgets. The following is valid for ''every'' third party SDK / toolbox / component you want to use and describes what steps your have to do:

* Download the sources of the component OR a ready-to-use development version. The difference: While the first requires you to compile the component yourself it will definitely work with your compiler. The latter must be compiled in a compatible way: So a compatible compiler, compatible OS, compatible settings. Inspect the components docs about how to get what you want.
* Place the component sources and compiled parts anywhere you want It is not required to copy such parts to any other folder you might think - in fact, this may even be dangerous in case you overwrite existing files.
* Create a project where you want to use your component.
* In the ''compiler'' settings, point to the folder, where the include files of your component are. For WX this is special, as usually you include like #include <wx/foo.h>. So do ''not'' point to [Component_Folder]\include\wx, but to [Component_Folder]\include instead.
* Note that the compiler only needs to know the interfaces / classes / structures / methods, it will not throw an error about undefined references or alike. The compiler will only complain in case it cannot find references in terms of include files. If thats the case, adjust your project's compiler settings. Keep in mind that you do need to fulfil the requirements of your component itself, too. Thus, wxChart for example will need for wxWidgets, too. So - you may need to do the same process for wxWidgets, too before you can use wxChart - unless you have done that already.
* In the ''linker'' settings, point to the folder where you have your compiled library. A library usually ends with *.a or *.lib. Note that there are generally two types of libs: Static libs (after linking you are done) and Dynamic libs (where you link against an import lib but require another dynamic lib at runtime).
* In the linker settings add the library/libraries you need to link against in the ''right order'' to the list of libs to link against. ''Order matters'' - again, dependencies must be taken into account. Inspect the developers guide of the component to know the dependencies. On Windows, this may include the MSDN, too which tells you what libraries you need to link against for certain symbols you or the library may make use of.
* The linker will never complain about includes it cannot find. Because the linker just links object files or library files together. But the linker may complain about unresolved symbols which you need to provide. So if that happens, either your setup is missing a lib, or the order is wrong.

Again, this is valid for all third party stuff you want to use. Its heavily ''platform'' and ''compiler'' dependent. The IDE should be less of concern for you. Every IDE can be setup in a way it will compile and link your stuff unless you provide everything needed as explained above.

If you don't understand parts written here it is ''strongly'' recommended you start with a book about general programming in C/C++ that covers library handling in more detail.

For the example wxChart in the end is not easy for starters. Usually you need to compile wxWidgets before, then wxChart and usually not all dependencies are explained in the docs and it behaves differently on different OS'es / compilers. Also, wcChart can be compiled in many flavours - so you need to make sure the flavour matches a) your needs and b) the way you compiled wxWidgets.

==== Q: My simple C++ program throws up lots of errors - what is going on? ====

If you have a C++ program like this:

#include <iostream>
int main() {
std::cout << "hello world\n";
}

and when you compile it you get errors like this:

fatal error: iostream: No such file or directory

then you have probably given your source file a .c extension. If you do that, the GCC compiler (and others) will probably attempt to compile the file as a C program, not as C++. You should always give your C++ source files the extension .cpp to make sure the compiler handles them correctly.

==== Q: I imported a MSVCToolkit project/workspace, but Code::Blocks insists on trying to use GCC. What's wrong? ====

'''A:''' A little documentation problem ^^;. The "default compiler" is usually GCC, so when you imported it with "the default compiler", you told it to use GCC. To fix this situation, go to "Project", "Build Options" and select VC++ Toolkit as your compiler.

Another possibility is to put the Microsoft compiler as the default one. To do this, choose '''''Settings - Compiler''''', choose the Microsoft compiler in the '''''Selected Compiler''''' section (top of dialog box) and press the '''''Set as default''''' button.

From now onwards, for all new projects the Microsoft compiler will be taken by default.

==== Q: When compiling a wxWidgets project, I get several "variable 'vtable for xxxx' can't be auto-imported". What's wrong? ====

'''A:''' You need to add WXUSINGDLL in "Project->Build options->Compiler #defines" and rebuild your project (or create a new project and use the "Using wxWidgets DLL" project option which adds "-DWXUSINGDLL" to Project->Build options->Other options).
Other errors with the same resolution are:
'unresolved external symbol "char const * const wxEmptyString" (?wxEmptyString@@3PBDB)' or similar.
If you were using 1.0-finalbeta and were trying to build a statically linked wxWidgets project, the cause of the problem was some faulty templates. But that's fixed now.

==== Q: I can't compile a multithreaded app with VC Toolkit! Where are the libraries? ====

'''A:''' Sorry, no fix for your problem...

Your problem doesn't come from CodeBlocks. It exists, because the free VC toolkit (VCTK) doesn't provide all the libraries and tools which come with Visual C++ (VC) which isn't free, unfortunately.

Try buying a full-fledged VC++, or even better, download [http://www.mingw.org/ MinGW]

The libraries that can be obtained free of charge are:

Paths:
(VCT3) Visual C++ Toolkit 2003 - C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
(PSDK) Platform SDK - C:\Program Files\Microsoft Platform SDK\Lib
(NSDK) .NET 1.1 SDK - C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib

C runtime libs:
LIBC.LIB Single-threaded, static link (VCT3, NSDK)
LIBCMT.LIB Multithreaded, static link (VCT3, NSDK)
MSVCRT.LIB Multithreaded, dynamic link (import library for MSVCR71.DLL) (NSDK)
LIBCD.LIB Single-threaded, static link (debug) (VCT3, NSDK)
LIBCMTD.LIB Multithreaded, static link (debug) (NSDK)
MSVCRTD.LIB Multithreaded, dynamic link (import library for MSVCR71D.DLL) (debug) (NSDK)

C++ libs:
LIBCP.LIB Single-threaded, static link (VCT3, PSDK)
LIBCPMT.LIB Multithreaded, static link (VCT3)
MSVCPRT.LIB Multithreaded, dynamic link (import library for MSVCP71.dll) (none)
LIBCPD.LIB Single-threaded, static link (debug) (VCT3)
LIBCPMTD.LIB Multithreaded, static link (debug) (none)
MSVCPRTD.LIB Multithreaded, dynamic link (import library for MSVCP71D.DLL) (debug) (none)

Try setting the library linker directories to:
C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
C:\Program Files\Microsoft Platform SDK\Lib
C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
in that order.

The ones listed as (none) above are actually present in the IA64 and AMD64 subdirectories of the PSDK lib directory. Not sure if these would work on 32-bit windows, however, they may if they are
meant to work in 32-bit compatibility mode on the 64-bit processors. Worth a try. Otherwise, you
can link statically to the C++ library instead of using MSVCP71.dll. If you really want to link against MSVCP71.dll you can try to create MSVCP71.LIB from the dll using lib.exe and sed. Search google for "exports.sed" for detailed steps.

See also: [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

See also: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_c_run.2d.time_libraries.asp

See also: http://sapdb.2scale.net/moin.cgi/MS_20C_2b_2b_20Toolkit

==== Q: I get this error when compiling: Symbol "isascii" was not found in "codeblocks.dll" ====

'''A:''' Make sure you didn't mix up the MSVC headers or libs with the MinGW ones.

==== Q: My build fails with multiple ''undefined reference'' errors? ====

''Example:''
undefined reference to `WSACleanup@8
undefined reference to `WSACleanup@0

'''A:''' Most of the time it is because the required library is not linked with your project. Go to ''Project->Build options...->Linker settings (tab)'' and add the required library or libraries.

If the error includes a line number, it is likely that this is a problem with your code. Track down down your function declarations and implementations. Ensure they all match up, are spelled correctly, and have the correct scope resolution.

''VERY'' often you can get help by just googling for the name of the undefined reference, for this example its "WSACleanup". Usually one of the first links is the SDK documentation, like [http://msdn.microsoft.com/en-us/library/windows/desktop/ms741549%28v=vs.85%29.aspx this from MSDN for WSACleanup]. You'll find there a lot useful information, including what libraries you need to link against, as for the exsample:
'''Requirements'''
* Minimum supported client: Windows 2000 Professional
* Minimum supported server: Windows 2000 Server
* Header: '''Winsock2.h'''
* Library: '''Ws2_32'''.lib
* DLL: '''Ws2_32.dll'''
The header file '''Winsock2.h''' you need to include in your sources. Most likely you have done that already because otherwise you would have gotten a compiler error unable to find the function declaration. The library you need to link against, you can remove any prefix like "lib" and the file extension like ".lib", ".a" or ".so" - so just type "'''Ws2_32'''" in the linker options. Also make sure you have added the path to that library in the linker include path's options, otherwise the linker will complain that it cannot find that library you want to link against. You also know, that you should distribute '''Ws2_32.dll''' for the runtime version of you app, luckily this one usually ships with Windows anyways, so no need to do something here.

==== Q: My build fails in the compile/link/run step with a ''Permission denied'' error? ====

'''A:''' There are several possible causes for this:

# The output directory does not have read/write access.
#* Either change control settings on the output directory, or move the project to different location.
# A previous instance of the executable failed to terminate properly.
#* Open your system's equivalent of Process/Task Manager, search the list for the name of the executable Code::Blocks is trying to output, and terminate it.
#* Logging off or rebooting will achieve the same effect.
# The executable is open.
#* If the executable is open in a hex-editor or actively being run, close it.
# Security software is interfering.
#* The target file is locked while an antivirus programming is scanning it; either wait a few seconds for the antivirus scan to finish, set an exception in the antivirus settings, or (temporarily) disable the antivirus program.
#* Firewalls with very strict settings sometimes block execution; try reducing the firewall's settings or adding an exception.
#* Switching security software may have left traces behind that are interfering; hunt down the remnants of the old antivirus/firewall software and remove them.
# The file/library cannot be found.
#* Double check all of the compiler and linker [[FAQ-Compiling (general)#Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist?|search directories]] (including any [[Global compiler variables|variables]] they may be using) are properly setup.
# Code::Blocks was improperly installed.
#* Mixing binaries from a stable release and a nightly build (or even two different nightly builds) is highly likely to cause a slew of problems; [[Installing Code::Blocks|reinstall Code::Blocks]] in an empty directory.
# Multiple installed compilers are interfering with each other.
#* If they are not required to keep, completely remove all but the most used compiler.
#* If several compilers are required, ensure that '''none''' of them are in the ''system'' path (this is so that Code::Blocks will be able to manage all paths).
#* Also, do not place any compilers in their default installation path (for example <tt>C:\MinGW</tt>), as some compilers are hard-coded to look for headers in a default path ''before'' searching their own respective directories.
# On windows 7, the service "Application Experience" is not running [http://stackoverflow.com/questions/7655471/ld-exe-cannot-open-output-file-permission-denied#answer-7904469 as explained on stackoverflow].
See also: [/index.php/topic,15047.0.html Permission denied forums discussion]

==== Q: My build fails to link due to ''multiple definition of xyz'' errors? ====

'''A:''' GCC 4.6.1 mingw target (Windows) is known to occasionally (and erroneously) report this if link-time optimization (<tt>-flto</tt>) is used.

First, of course, check that no token has been defined multiple times. If the source code is clean, and yet the errors persist, adding linker switch (''Project->Build options...->Linker settings (tab)'')
-Wl,--allow-multiple-definition
will enable the code to link.

See also: [http://sourceware.org/bugzilla/show_bug.cgi?id=12762 Bug 12762]

==== Q: How can I change the language of the compiler (gcc) output to english? ====

'''A:''' Codeblocks 12.11 or higher: Settings->Environment->Environment Variables. Add "LC_ALL" with value "C". ->Set Now -> Ok

Since a few releases gcc is localized. This can make difficult to find (google ;) ) solutions for specific problems. With this setting the output is again in english.

!! this can break displaying of non-aschii characters so you can also use LC_ALL = en_US.utf8 (/index.php/topic,17579.msg120613.html#msg120613)

----

Return to '''[[FAQ]]'''.

FAQ-Compiling (errors)

2014-01-19T20:57:37Z

BlueHazzard: Add a link to the template for reporting compiler errors in he forum

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: How do I troubleshoot a compiler problem? ====

'''A:''' I would start by turning on full Compiler logging.

This is done by selecting the "Full command line" option Under menu "Settings" -> "Compiler" -> Global compiler settings -> [the compiler you use] -> "Other Setting" tab, "Compiler logging". In 12.11 and newer this is enabled by default.

This option will make Code::Blocks output the exact commands it uses to compile your code.

Things to remember:

* Look at the "Build Log" NOT the "Build Message" tab
* Do a re-build instead of build in order to get a full build log.
* You should review all the commands and their options;
* If you have compiled your app before, do a ''re-''build (or ''clean'' before build) to see all compiling / linking steps;
* If you don't know what an option or a command does please read the documentation for the compiler/linker you're using;
* Look for missing commands;
* For every source file (<tt>.cpp</tt>; <tt>.c</tt>; <tt>.d</tt>; etc) in your project, you must have at least one command in the log. This command must produce an object file (file extension <tt>.o</tt> if using gcc/g++ and <tt>.obj</tt> if using Visual Studio);
* Every object file should be linked in the final executable, if not there are undefined symbols errors;
* Remember the file extension matters: <tt>*.c</tt> is compiled as C file, <tt>*.cpp</tt> is compiled as C++ file. [http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html Read more]
* If you have no luck, you can try to ask in the forum, but '''read''' first [https://wiki.codeblocks.org/index.php?title=FAQ-Compiling_%28general%29#Q:_How_do_I_report_a_compilation_problem_on_the_forums.3F "how i report a compiler prolem"]

==== Q: What do I need to know when using 3rd party libs? ====
Here are some basics about typical mistakes done when working with third party libs, including wxWidgets. The following is valid for ''every'' third party SDK / toolbox / component you want to use and describes what steps your have to do:

* Download the sources of the component OR a ready-to-use development version. The difference: While the first requires you to compile the component yourself it will definitely work with your compiler. The latter must be compiled in a compatible way: So a compatible compiler, compatible OS, compatible settings. Inspect the components docs about how to get what you want.
* Place the component sources and compiled parts anywhere you want It is not required to copy such parts to any other folder you might think - in fact, this may even be dangerous in case you overwrite existing files.
* Create a project where you want to use your component.
* In the ''compiler'' settings, point to the folder, where the include files of your component are. For WX this is special, as usually you include like #include <wx/foo.h>. So do ''not'' point to [Component_Folder]\include\wx, but to [Component_Folder]\include instead.
* Note that the compiler only needs to know the interfaces / classes / structures / methods, it will not throw an error about undefined references or alike. The compiler will only complain in case it cannot find references in terms of include files. If thats the case, adjust your project's compiler settings. Keep in mind that you do need to fulfil the requirements of your component itself, too. Thus, wxChart for example will need for wxWidgets, too. So - you may need to do the same process for wxWidgets, too before you can use wxChart - unless you have done that already.
* In the ''linker'' settings, point to the folder where you have your compiled library. A library usually ends with *.a or *.lib. Note that there are generally two types of libs: Static libs (after linking you are done) and Dynamic libs (where you link against an import lib but require another dynamic lib at runtime).
* In the linker settings add the library/libraries you need to link against in the ''right order'' to the list of libs to link against. ''Order matters'' - again, dependencies must be taken into account. Inspect the developers guide of the component to know the dependencies. On Windows, this may include the MSDN, too which tells you what libraries you need to link against for certain symbols you or the library may make use of.
* The linker will never complain about includes it cannot find. Because the linker just links object files or library files together. But the linker may complain about unresolved symbols which you need to provide. So if that happens, either your setup is missing a lib, or the order is wrong.

Again, this is valid for all third party stuff you want to use. Its heavily ''platform'' and ''compiler'' dependent. The IDE should be less of concern for you. Every IDE can be setup in a way it will compile and link your stuff unless you provide everything needed as explained above.

If you don't understand parts written here it is ''strongly'' recommended you start with a book about general programming in C/C++ that covers library handling in more detail.

For the example wxChart in the end is not easy for starters. Usually you need to compile wxWidgets before, then wxChart and usually not all dependencies are explained in the docs and it behaves differently on different OS'es / compilers. Also, wcChart can be compiled in many flavours - so you need to make sure the flavour matches a) your needs and b) the way you compiled wxWidgets.

==== Q: My simple C++ program throws up lots of errors - what is going on? ====

If you have a C++ program like this:

#include <iostream>
int main() {
std::cout << "hello world\n";
}

and when you compile it you get errors like this:

fatal error: iostream: No such file or directory

then you have probably given your source file a .c extension. If you do that, the GCC compiler (and others) will probably attempt to compile the file as a C program, not as C++. You should always give your C++ source files the extension .cpp to make sure the compiler handles them correctly.

==== Q: I imported a MSVCToolkit project/workspace, but Code::Blocks insists on trying to use GCC. What's wrong? ====

'''A:''' A little documentation problem ^^;. The "default compiler" is usually GCC, so when you imported it with "the default compiler", you told it to use GCC. To fix this situation, go to "Project", "Build Options" and select VC++ Toolkit as your compiler.

Another possibility is to put the Microsoft compiler as the default one. To do this, choose '''''Settings - Compiler''''', choose the Microsoft compiler in the '''''Selected Compiler''''' section (top of dialog box) and press the '''''Set as default''''' button.

From now onwards, for all new projects the Microsoft compiler will be taken by default.

==== Q: When compiling a wxWidgets project, I get several "variable 'vtable for xxxx' can't be auto-imported". What's wrong? ====

'''A:''' You need to add WXUSINGDLL in "Project->Build options->Compiler #defines" and rebuild your project (or create a new project and use the "Using wxWidgets DLL" project option which adds "-DWXUSINGDLL" to Project->Build options->Other options).
Other errors with the same resolution are:
'unresolved external symbol "char const * const wxEmptyString" (?wxEmptyString@@3PBDB)' or similar.
If you were using 1.0-finalbeta and were trying to build a statically linked wxWidgets project, the cause of the problem was some faulty templates. But that's fixed now.

==== Q: I can't compile a multithreaded app with VC Toolkit! Where are the libraries? ====

'''A:''' Sorry, no fix for your problem...

Your problem doesn't come from CodeBlocks. It exists, because the free VC toolkit (VCTK) doesn't provide all the libraries and tools which come with Visual C++ (VC) which isn't free, unfortunately.

Try buying a full-fledged VC++, or even better, download [http://www.mingw.org/ MinGW]

The libraries that can be obtained free of charge are:

Paths:
(VCT3) Visual C++ Toolkit 2003 - C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
(PSDK) Platform SDK - C:\Program Files\Microsoft Platform SDK\Lib
(NSDK) .NET 1.1 SDK - C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib

C runtime libs:
LIBC.LIB Single-threaded, static link (VCT3, NSDK)
LIBCMT.LIB Multithreaded, static link (VCT3, NSDK)
MSVCRT.LIB Multithreaded, dynamic link (import library for MSVCR71.DLL) (NSDK)
LIBCD.LIB Single-threaded, static link (debug) (VCT3, NSDK)
LIBCMTD.LIB Multithreaded, static link (debug) (NSDK)
MSVCRTD.LIB Multithreaded, dynamic link (import library for MSVCR71D.DLL) (debug) (NSDK)

C++ libs:
LIBCP.LIB Single-threaded, static link (VCT3, PSDK)
LIBCPMT.LIB Multithreaded, static link (VCT3)
MSVCPRT.LIB Multithreaded, dynamic link (import library for MSVCP71.dll) (none)
LIBCPD.LIB Single-threaded, static link (debug) (VCT3)
LIBCPMTD.LIB Multithreaded, static link (debug) (none)
MSVCPRTD.LIB Multithreaded, dynamic link (import library for MSVCP71D.DLL) (debug) (none)

Try setting the library linker directories to:
C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
C:\Program Files\Microsoft Platform SDK\Lib
C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
in that order.

The ones listed as (none) above are actually present in the IA64 and AMD64 subdirectories of the PSDK lib directory. Not sure if these would work on 32-bit windows, however, they may if they are
meant to work in 32-bit compatibility mode on the 64-bit processors. Worth a try. Otherwise, you
can link statically to the C++ library instead of using MSVCP71.dll. If you really want to link against MSVCP71.dll you can try to create MSVCP71.LIB from the dll using lib.exe and sed. Search google for "exports.sed" for detailed steps.

See also: [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

See also: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_c_run.2d.time_libraries.asp

See also: http://sapdb.2scale.net/moin.cgi/MS_20C_2b_2b_20Toolkit

==== Q: I get this error when compiling: Symbol "isascii" was not found in "codeblocks.dll" ====

'''A:''' Make sure you didn't mix up the MSVC headers or libs with the MinGW ones.

==== Q: My build fails with multiple ''undefined reference'' errors? ====

''Example:''
undefined reference to `WSACleanup@8
undefined reference to `WSACleanup@0

'''A:''' Most of the time it is because the required library is not linked with your project. Go to ''Project->Build options...->Linker settings (tab)'' and add the required library or libraries.

If the error includes a line number, it is likely that this is a problem with your code. Track down down your function declarations and implementations. Ensure they all match up, are spelled correctly, and have the correct scope resolution.

''VERY'' often you can get help by just googling for the name of the undefined reference, for this example its "WSACleanup". Usually one of the first links is the SDK documentation, like [http://msdn.microsoft.com/en-us/library/windows/desktop/ms741549%28v=vs.85%29.aspx this from MSDN for WSACleanup]. You'll find there a lot useful information, including what libraries you need to link against, as for the exsample:
'''Requirements'''
* Minimum supported client: Windows 2000 Professional
* Minimum supported server: Windows 2000 Server
* Header: '''Winsock2.h'''
* Library: '''Ws2_32'''.lib
* DLL: '''Ws2_32.dll'''
The header file '''Winsock2.h''' you need to include in your sources. Most likely you have done that already because otherwise you would have gotten a compiler error unable to find the function declaration. The library you need to link against, you can remove any prefix like "lib" and the file extension like ".lib", ".a" or ".so" - so just type "'''Ws2_32'''" in the linker options. Also make sure you have added the path to that library in the linker include path's options, otherwise the linker will complain that it cannot find that library you want to link against. You also know, that you should distribute '''Ws2_32.dll''' for the runtime version of you app, luckily this one usually ships with Windows anyways, so no need to do something here.

==== Q: My build fails in the compile/link/run step with a ''Permission denied'' error? ====

'''A:''' There are several possible causes for this:

# The output directory does not have read/write access.
#* Either change control settings on the output directory, or move the project to different location.
# A previous instance of the executable failed to terminate properly.
#* Open your system's equivalent of Process/Task Manager, search the list for the name of the executable Code::Blocks is trying to output, and terminate it.
#* Logging off or rebooting will achieve the same effect.
# The executable is open.
#* If the executable is open in a hex-editor or actively being run, close it.
# Security software is interfering.
#* The target file is locked while an antivirus programming is scanning it; either wait a few seconds for the antivirus scan to finish, set an exception in the antivirus settings, or (temporarily) disable the antivirus program.
#* Firewalls with very strict settings sometimes block execution; try reducing the firewall's settings or adding an exception.
#* Switching security software may have left traces behind that are interfering; hunt down the remnants of the old antivirus/firewall software and remove them.
# The file/library cannot be found.
#* Double check all of the compiler and linker [[FAQ-Compiling (general)#Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist?|search directories]] (including any [[Global compiler variables|variables]] they may be using) are properly setup.
# Code::Blocks was improperly installed.
#* Mixing binaries from a stable release and a nightly build (or even two different nightly builds) is highly likely to cause a slew of problems; [[Installing Code::Blocks|reinstall Code::Blocks]] in an empty directory.
# Multiple installed compilers are interfering with each other.
#* If they are not required to keep, completely remove all but the most used compiler.
#* If several compilers are required, ensure that '''none''' of them are in the ''system'' path (this is so that Code::Blocks will be able to manage all paths).
#* Also, do not place any compilers in their default installation path (for example <tt>C:\MinGW</tt>), as some compilers are hard-coded to look for headers in a default path ''before'' searching their own respective directories.
# On windows 7, the service "Application Experience" is not running [http://stackoverflow.com/questions/7655471/ld-exe-cannot-open-output-file-permission-denied#answer-7904469 as explained on stackoverflow].
See also: [/index.php/topic,15047.0.html Permission denied forums discussion]

==== Q: My build fails to link due to ''multiple definition of xyz'' errors? ====

'''A:''' GCC 4.6.1 mingw target (Windows) is known to occasionally (and erroneously) report this if link-time optimization (<tt>-flto</tt>) is used.

First, of course, check that no token has been defined multiple times. If the source code is clean, and yet the errors persist, adding linker switch (''Project->Build options...->Linker settings (tab)'')
-Wl,--allow-multiple-definition
will enable the code to link.

See also: [http://sourceware.org/bugzilla/show_bug.cgi?id=12762 Bug 12762]

==== Q: How can I change the language of the compiler (gcc) output to english? ====

'''A:''' Codeblocks 12.11 or higher: Settings->Environment->Environment Variables. Add "LC_ALL" with value "C". ->Set Now -> Ok

Since a few releases gcc is localized. This can make difficult to find (google ;) ) solutions for specific problems. With this setting the output is again in english.

!! this can break displaying of non-aschii characters so you can also use LC_ALL = en_US.utf8 (/index.php/topic,17579.msg120613.html#msg120613)

----

Return to '''[[FAQ]]'''.

FAQ-Compiling (general)

2013-11-06T13:34:52Z

BlueHazzard: Add more detail to find the full build log

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: What compiler can I use with Code::Blocks? ====

'''A:''' Code::Blocks philosophy is to be able to use any compiler on earth! Well, almost.

As a matter of fact it largely depends on the used compiler plugin. Some provided with the default Code::Blocks installation are GNU GCC (MinGW/Cygwin), MS Visual C++ Free Toolkit 2003, Borland's C++ Compiler 5.5, DigitalMars Free Compiler., OpenWatcom, Small Device C Compiler (SDCC) and others.

==== Q: My project should be compiled with a custom makefile. Is it possible with Code::Blocks? ====

'''A:''' Yes, you can. You need to change one settings with Code::Blocks 8.02:

In your project's Properties, check "This is a custom makefile".

And that's it! :)

==== Q: I have downloaded MS VC++ Toolkit 2003 for a compiler. How do I tell Code::Blocks that it is my compiler? ====

'''A:''' Click on "Project/Build options" and select the compiler you want for your project/target.

==== Q: Microsoft calls MSVCRT.DLL a "Known DLL." How do I know if I can/should use it? ====

Microsoft does not clearly describe what [http://msdn2.microsoft.com/en-us/library/abx4dbyh.aspx 'Known DLL'] means. A [http://www.zlib.net/DLL_FAQ.txt zLib FAQ entry] makes it much more clear. The short answer is that MSVCRT.DLL is a protected system component and to preserve system integrity it cannot be updated by any end user product installers but may be updated from time to time by system updates. If it works use it. If it doesn't you'll need use a non protected library such as MSVCR70 or MSVCR80 which not only can be updated but private versions can be installed. A small and simple C program is likely to work just fine with MSVCRT.DLL. A large and complex C++ program is more likely to need the additional functionality of MSVCR.

The MSVCRT.LIB that ships with 32 bit compiler Visual C++ Toolkit 2003 dynamically links to MSVCR71.DLL which is not present in a freshly installed Windows XP system. MSVCR only appears after some software package that needs it such as [http://www.adobe.com/ Adobe Acrobat Reader] is installed. This means that programs that depend on MSVCR must redistribute it or risk not working on a substantial percentage of systems for reasons not obvious to either the affected end users or the program supplier.

For projects that can safely use MSVCRT and where it is impractical to redistribute MSVCR, a Win32 MSVCRT.LIB that links to MSVCRT.DLL is available in any [http://www.microsoft.com/whdc/devtools/ddk/default.mspx Device Driver Kit]. It is best to preserve the MSVCRT.LIB provided by the compiler and alter the name of the MSVCRT.LIB extracted from a DDK. List your newly named MSVCRTxx in the lib. If you use MSVCRT.LIB from the Windows 2003 DDK you may encounter the link '''error LNK2001: unresolved external symbol ___security_cookie'''. This can be solved by switching to the MSVCRT.LIB in the Windows XP DDK or by linking '''bufferoverflowU.lib''' found in the Windows SDK. A Win64 MSVCRT.LIB that links to MSVCRT.DLL is available in the Windows SDK or Platform [http://www.microsoft.com/downloads/details.aspx?FamilyId=E15438AC-60BE-41BD-AA14-7F1E0F19CA0D&displaylang=en PSDK].

To prevent problems it is recommended to include both /MD and /NODEFAULTLIB:MSVCRT switches so that problems come up at link time instead of random crashes at run time. Be sure to load your programs into [http://www.dependencywalker.com/ Dependancy Walker] to ensure that functions aren't being linked into both MSVCRxx.DLL and MSVCRT.DLL. It is essential that malloc, calloc, realloc, free, and related memory allocation functions all import from the same DLL.

Source: [http://wiki.tcl.tk/11431 TCL Wiki]

==== Q: How can I use a DLL without DEF or LIB files? ====

'''A:''' I tried to find a solution, and the following script solved the problem for me. I used a cygwin environment for ''tclsh'' and ''sed'', but the MinGW tools for ''objdump'' and ''dlltool''. See here [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

TODO: Someone might add some informations about problems

Request: Is MinGW or Code::Blocks able to support automatic generation of import libraries ?

See also: http://www.mingw.org/wiki/CreateImportLibraries

See also: http://wyw.dcweb.cn/stdcall.htm

==== Q: Where are the libraries for the OpenGL, Ogre3D, SDL, QT, wxWidgets etc. projects? ====

'''A:''' They're not bundled. The templates were provided for your convenience, but you need to download the libraries on your own.
In common terms, "batteries not included" :)

==== Q: Is it possible to use Visual C++ 6.0 with Code::Blocks? ====

'''A:''' Yes. See [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]] for a detailed description on using VC++ 6.0 with Code::Blocks.

==== Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist? ====

'''A:''' You can specify them for your global environment or just for your project.

For global environment : 
- Menu Settings/Compiler and debugger 
- In the Global compiler settings, select the directories tab 
- Add the required paths for compiler and linker. 
 
For your project : 
- Right click on the project then select Build options 
- Select the directories tab 
- Add the required paths for compiler and linker. 
- Add your specific libraries in the linker tab. 
- Pay attention to project settings and target settings.
==== Q: How do I use both Debug and Release builds of wx libraries? ====
'''A:''' I would use the default method of doing it and the default folder naming.

Using these C::B custom varibles
WX_SUFFIX="" // ANSI Release
WX_SUFFIX="d" // ANSI Debug
WX_SUFFIX="u" // Unicode Release
WX_SUFFIX="ud" // Unicode debug

I use WX_CFG when I am using a special configuration
WX_CFG="rc3"

Remember, the CodeBlocks globel variable WX needs to point to the wxWidgets folder.

Example minGW build command for "Unicode debug" 2.8.0 RC3

mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

"VENDOR=" just puts rc3 in the DLL name; "CFG=" sets which folder the DLL is placed in. In this case in lib\gcc_dllrc3

Before using CFG in the mingw32-make build you need to do one prior wxWidget build without using it; else the build errors out. (See note below.)

"__WXDEBUG__" must be defined (in the codeblocks project setting) if you wish to link against the debug version of wxWidgets DLL. Else you will get a runtime error, when you try to run your project output.

Contributed by Tim S

Note:
*I have never gotten the following command to work
mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*unless I have first run this command on the same wxWidgets folders
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*I am guessing that the build without the CFG creates a file or directory needed by the build with the CFG.

==== Q: How do I add version information to windows executables and dll's? ====
'''A:''' You need to create a resource file with the extension .rc and write the version info there. Then add that file to the Code::Blocks project you are working on.

Sample content of a resource file that you can use and modify for your needs:
<source lang="cpp" enclose="div">
LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US

VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,0,0,1
PRODUCTVERSION 1,0,0,1
FILEFLAGSMASK 0x3fL // VS_FFI_FILEFLAGSMASK
#ifdef _DEBUG
FILEFLAGS 0x1L // VS_FF_DEBUG|VS_FF_PRIVATEBUILD|VS_FF_PRERELEASE
#else
FILEFLAGS 0x0L // final version
#endif
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
FILESUBTYPE VFT2_UNKNOWN // not used
{
BLOCK "StringFileInfo"
{
BLOCK "040904E4" // Lang=US English, CharSet=Windows Multilingual
{
VALUE "Build", "August 2007\0"
VALUE "Comments", "Free for personal use only.\0"
VALUE "CompanyName", "Fake Company\0"
VALUE "Developer", "The Developer\0"
VALUE "FileDescription", "Application implementing something\0"
VALUE "FileVersion", "1.0.000\0"
VALUE "InternalName", "AppInternalName\0"
VALUE "LegalCopyright", "Copyright (C) 2007 Fake Company\0"
VALUE "LegalTrademarks", "All rights reserved.\0"
VALUE "OriginalFilename", "TheEXE.exe\0"
VALUE "PrivateBuild", "\0"
VALUE "ProductName", "The EXE\0"
VALUE "ProductVersion", "1.0.000\0"
VALUE "SpecialBuild", "\0"
VALUE "Support", "TheEXE at fake-domain.com\0"
VALUE "Users", "Unlimited.\0"
} // BLOCK "040904E4"
} // BLOCK "StringFileInfo"
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x409, 1252 // 1252 = 0x04E4
} // BLOCK "VarFileInfo"
}
</source>

Also you can use the the [[AutoVersioning plugin]] to assist you on the generation of version information. For documentation of the syntax and values used on windows resource files, you can visit the following websites:
*http://msdn2.microsoft.com/en-us/library/aa380599.aspx
*http://www.cygwin.com/cygwin-ug-net/windres.html

==== Q: Code::Blocks does not force relink if the library is changed? ====

'''A:''' Open ''Project->Properties...->Build targets (tab)'' and select the executable. Click ''Dependencies...'' and add the name of the library (including its relative path) to ''External dependency files''. Also see [[The build process of Code::Blocks#Using project dependencies|inter-project dependencies]].

''Example:'' <tt>output\myLibrary\libdostuff.a</tt>

==== Q: How do I report a compilation problem on the forums? ====

'''A:''' Try building the project from command line. If the same error comes up, it is a problem with either the source file, the compiler, or the compiler setup. If this is the case, you are unlikely to receive support for it on the Code::Blocks forums, however, [[FAQ-Compiling (errors)#Q: How do I troubleshoot a compiler problem?|How do I troubleshoot a compiler problem?]] may help.

If it works fine building from command line, it is either a problem with your project, Code::Blocks' setup, or possibly an actual bug. When posting this problem, include the name of your compiler, operating system, Code::Blocks version, compiler log (go to ''Settings->Compiler and debugger...->Build options (tab)'' and check ''Save build log'' and ''Always output the full command line''), and, if it caused Code::Blocks to crash, the <tt>codeblocks.RPT</tt> file (located in the Code::Blocks installation directory).

''Template: Paste the following template into your post, editing the relevant sections.''
I am running Code::Blocks version ''Code::BlocksVersionNumber'' on ''MyOperatingSystem''
(version ''OperatingSystemVersionNumber''). The compiler I use is ''CompilerName''
version ''CompilerVersionNumber''.

When I ...
''Steps to reproduce problem.''

''Description of problem.''
... happens.

Build log:
[code]
''Paste '''full''' build log here. (It is found in the 'Build log' tab). Please make always a 'rebuild' or a 'clean' and 'build' before you copy the build log. ''
[/code]

Crash report:
[code]
''Paste the contents of'' codeblocks.RPT ''here (if Code::Blocks crashed).''
[/code]

''(Although the following is not necessary, showing that you''
''have tried increases the probability of a response.)''
I have already tried ...
''List of attempted solutions.''
... but none of them worked.

==== Q: All of the Build related options are grayed out? ====

'''A:''' Code::Blocks checks the file extension for individual files before allowing them to be compiled. Save your file with the correct file extension (<tt>*.c</tt> or <tt>*.cpp</tt>).

More often it is useful to [[Creating a new project|create a project]] so that Code::Blocks can manage the entire build.

----

Return to '''[[FAQ]]'''.

Installing Code::Blocks from source on Windows

2013-07-21T15:23:07Z

BlueHazzard: added a link to the alternative source download....

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Prerequisites ==

=== Note for RC2 users ===

The older Code::Blocks RC2 does not support global compiler variables which were added after RC2 was released and is unable to read project files generated with post-RC2 versions.
To build Code::Blocks, you need a post-RC2 build, such as ''8.02'' or any of the ''nightly builds'' obtainable by [/index.php?board=20.0 searching the forum].

=== MinGW compiler ===

At the present time, Code::Blocks only compiles successfully with the MinGW compiler (or any other gcc for that matter). You will need a complete, working [[MinGW installation]] or [http://www.tdragon.net/recentgcc/ TDM-MinGW package].

'''Do not''' use the barebones MinGW with GCC 4.5.1 as you'll run (with this specific version) into [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43601 a linker bug] (which happened to me on Vista SP1 32-bit on 2011-02-28); the solution is to use the TDM-GCC 4.5.1 package, or later.

=== wxWidgets ===

[http://www.wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 02 April 2011 wxWidgets 2.8.12 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.12.zip wxMSW-2.8.12.zip]

* since 28 March 2009 wxWidgets 2.8.10 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.10.zip wxMSW-2.8.10.zip]

* since 18 October 2008 wxWidgets 2.8.9 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.9.zip wxMSW-2.8.9.zip]

* since 19 July 2008 wxWidgets 2.8.8 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

For latest infos check forum: [/index.php?topic=3299.0 Important changes to the nightly builds]

You do ''not'' need MSYS (''in fact, if you have MSYS, make sure it is not in your PATH when building wxWidgets'').

You can get the c::b source from svn or download it directly from http://sourceforge.net/p/codeblocks/code -> "Download Snapshot"

=== SVN client ===

In order to check out the Code::Blocks sources you will need a SVN client.
For convenience, it is recommended that you install [http://tortoisesvn.net/downloads TortoiseSVN] on your machine, as this is a lot more comfortable. However, if you get a bad feeling when some program is messing with your Explorer menu, then you can use the [http://subversion.tigris.org/project_packages.html svn command-line client] equally well.

It is generally a good idea to install the command-line client (and adding it to PATH) even if you use TortoiseSVN for convenience. The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn</tt> binary if it is available. This is preferable to the manual parsing of the entries file that is used as fall-back.

Please do note that working copies checked out with the 1.4 version of Subversion are no longer compatible with earlier versions (Subversion will transparently update existing repositories).

The built-in fall-back mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format. 
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the command line tool into <tt>PATH</tt> for a successful build. 
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== svn.exe ===
If you want to show the SVN number in your code::blocks dialog box.

[[Image:Svn number.png|300*300px]]

You should also let svn.exe exist in the PATH of your windows system.
A command line SVN package can be download here [http://www.open.collab.net/downloads/subversion/ CollabNet Subversion Command-Line Client v1.6 (for Windows)].

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [[MinGW installation#Other developer tools|tools page]], you'll be fine.

The zip program coming with cygwin will ''not'' work properly. You do ''not'' need WinZip.

Make sure the zip binary is in your PATH so the <tt>update.bat</tt> script will be able to find it (alternatively, you can edit the batch file, setting the ZIPCMD variable to something else).

The easiest way is to put zip.exe into <tt>bin</tt> inside your MinGW installation directory (that folder is normally in the path).

=== Code::Blocks sources ===

You will also (obviously) need the Code::Blocks sources.

Using ''TortoiseSVN'', make a folder where you want to store the sources, right-click on the folder, and select "SVN Checkout...".

'''!! The URL in this image is wrong !!''' Look at the description under the image:

[[Image:Win svn checkout.png]]

In the top box, enter svn://svn.code.sf.net/p/codeblocks/code/trunk and hit the OK button.

Using ''svn'', you have to open a command prompt ("DOS Window"). Make a folder, change directory, and run svn:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Unicode Build ==

=== Compile wxWidgets in Unicode mode ===

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets:

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

If you are using a recent version of MinGW you may find that the object files are too large and that the linker runs out of memory. To fix this problem you need to edit config.gcc so that inline functions are not exported, by modifying the CFLAGS and CXXFLAGS lines to:

CFLAGS ?= -fno-keep-inline-dllexport

CXXFLAGS ?= -fno-keep-inline-dllexport

''remark: If you want to use wxWidgets not only for building Code::Blocks, but also for writing wxWidgets programs, and if you want to use the debugger in those programs, you have to compile a debug build of wxWidgets as well.''
''Use the same commands as for the release build, but replace "release" by "debug".''

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

=== Compile Code::Blocks ===
Now, before this step, you have prepared all the stuff to build code::blocks. It's very interesting that we use code::blocks to build code::blocks binaries.

==== Open project====
Open the project file '''CodeBlocks.cbp'''.
*You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

[[Image:Global_variable.png]]

[[Image:Global_variable2.png]]

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field.

====Compile project====
Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

[[Image:Win build button.png]]

[[Image:Win build target.png]]

[[Image:Win build finish.png]]

====Copy wxWidgets support DLL====
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw28u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>src\devel</tt> directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into dll hell).

[[Image:Win output folder.png]]

[[Image:Win copy dll.png]]

====Runing script file====
Run <tt>src\update.bat</tt> (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.

[[Image:Win run bat.png]]

The stripped ("production") executable is found in <tt>output</tt> folder together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel</tt> folder. 
Congratulations, you own a freshly built version of Code::Blocks!

[[Image:Win final folder.png]]

====Note for future updates====
Go to the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect). 
Then open and build the project as described before (and any contrib plugins that you wish to use), and re-run <tt>src\update.bat</tt>.

=== Install Code::Blocks ===

Copy the folder output to where you want Code::Blocks to reside.

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins.workspace''' contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). 

[[Image:Contribute plugin.png]]

When you open the contrib plugins workspace, you will be asked to define the <tt>$(#cb)</tt> global compiler variable. This is the path that contains the sdk folder normally this is codeblocks\src. The build process uses this information to place the plugins and data files into the correct place. Enter the location of the Code::Blocks sources in the same way as for the <tt>$(#wx)</tt> variable earlier.

Don't forget to run update.bat again after building the contrib plugins.

== ANSI Build ==

<div style="background-color: #f7d9d9; border: 1px solid #000">
<div style="margin: 5px;">

==== DEPRECATION WARNING: ====
As of February 2006, the official default build for Code::Blocks is '''Unicode''' (see above). Although ANSI builds are technically possible, we discourage their use unless there is a good reason. 
''Support for ANSI builds is likely to be dropped after Version 1.0 is out.''

There is hardly any good argument against using a Unicode build if your OS supports Unicode, even if you do not understand any other language than English, as a Unicode version guarantees that it will be able to work with whatever languages you may possibly encounter in the future -- at a very reasonable cost.

However, if you absolutely don't care about Unicode or if you are bound to use Windows 95, then you may want to build an ANSI version nevertheless.

</div>
</div>

==== Compile wxWidgets in ANSI mode ====

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

==== Compile Code::Blocks ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx) if you have not used it before. Enter the location where you unpacked wxWidgets.

'''Important:''' The project file is set to compile an Unicode version of Code::Blocks by default. To make an ANSI build, you have to make the following two changes to build options before compiling:
1. In the "Compiler" tab, under "#defines", remove the entry wxUSE_UNICODE.
2. Under "Custom variables", set the variable WX_SUFFIX to empty (default value: u).

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilation has finished, copy wxmsw28u_gcc_custom.dll from lib\gcc_dll inside the wxWidgets directory to the devel directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into [[wikipedia:DLL Hell|dll hell]]).
Run update.bat (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.
The location of executable is src\output in C::B tree. From here you'll not need the nightly build anymore.

One little note for svn updates and rebuilds : just go into the codeblocks root directory and do '''svn update''' (or use Turtoise svn).

Then run the src/output/codeblocks.exe, reload project, build it, reload plugins workspace, build it, quit codeblocks and re-run update.bat. You'll have an up-to-date C::B in 3 minutes !

==== Install Code::Blocks ====

Copy the folder output to where you want Code::Blocks to reside.

==== Compile contributed (or your own) plugins ====

The workspace file ContribPlugins.workspace contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). Don't forget to run update.bat again after building the contrib plugins.

Note that the Nassi Shneiderman plugin (part of the contrib plugins) has a dependency on [http://www.boost.org boost] which is needed to compile this plugin. Boost does not need to be compiled therefore.

Installing Code::Blocks from source on Windows

2013-07-21T15:13:03Z

BlueHazzard: add the cb_release_type to the "open project" chapter

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Prerequisites ==

=== Note for RC2 users ===

The older Code::Blocks RC2 does not support global compiler variables which were added after RC2 was released and is unable to read project files generated with post-RC2 versions.
To build Code::Blocks, you need a post-RC2 build, such as ''8.02'' or any of the ''nightly builds'' obtainable by [/index.php?board=20.0 searching the forum].

=== MinGW compiler ===

At the present time, Code::Blocks only compiles successfully with the MinGW compiler (or any other gcc for that matter). You will need a complete, working [[MinGW installation]] or [http://www.tdragon.net/recentgcc/ TDM-MinGW package].

'''Do not''' use the barebones MinGW with GCC 4.5.1 as you'll run (with this specific version) into [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43601 a linker bug] (which happened to me on Vista SP1 32-bit on 2011-02-28); the solution is to use the TDM-GCC 4.5.1 package, or later.

=== wxWidgets ===

[http://www.wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 02 April 2011 wxWidgets 2.8.12 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.12.zip wxMSW-2.8.12.zip]

* since 28 March 2009 wxWidgets 2.8.10 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.10.zip wxMSW-2.8.10.zip]

* since 18 October 2008 wxWidgets 2.8.9 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.9.zip wxMSW-2.8.9.zip]

* since 19 July 2008 wxWidgets 2.8.8 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

For latest infos check forum: [/index.php?topic=3299.0 Important changes to the nightly builds]

You do ''not'' need MSYS (''in fact, if you have MSYS, make sure it is not in your PATH when building wxWidgets'').

=== SVN client ===

In order to check out the Code::Blocks sources you will need a SVN client.
For convenience, it is recommended that you install [http://tortoisesvn.net/downloads TortoiseSVN] on your machine, as this is a lot more comfortable. However, if you get a bad feeling when some program is messing with your Explorer menu, then you can use the [http://subversion.tigris.org/project_packages.html svn command-line client] equally well.

It is generally a good idea to install the command-line client (and adding it to PATH) even if you use TortoiseSVN for convenience. The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn</tt> binary if it is available. This is preferable to the manual parsing of the entries file that is used as fall-back.

Please do note that working copies checked out with the 1.4 version of Subversion are no longer compatible with earlier versions (Subversion will transparently update existing repositories).

The built-in fall-back mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format. 
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the command line tool into <tt>PATH</tt> for a successful build. 
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== svn.exe ===
If you want to show the SVN number in your code::blocks dialog box.

[[Image:Svn number.png|300*300px]]

You should also let svn.exe exist in the PATH of your windows system.
A command line SVN package can be download here [http://www.open.collab.net/downloads/subversion/ CollabNet Subversion Command-Line Client v1.6 (for Windows)].

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [[MinGW installation#Other developer tools|tools page]], you'll be fine.

The zip program coming with cygwin will ''not'' work properly. You do ''not'' need WinZip.

Make sure the zip binary is in your PATH so the <tt>update.bat</tt> script will be able to find it (alternatively, you can edit the batch file, setting the ZIPCMD variable to something else).

The easiest way is to put zip.exe into <tt>bin</tt> inside your MinGW installation directory (that folder is normally in the path).

=== Code::Blocks sources ===

You will also (obviously) need the Code::Blocks sources.

Using ''TortoiseSVN'', make a folder where you want to store the sources, right-click on the folder, and select "SVN Checkout...".

'''!! The URL in this image is wrong !!''' Look at the description under the image:

[[Image:Win svn checkout.png]]

In the top box, enter svn://svn.code.sf.net/p/codeblocks/code/trunk and hit the OK button.

Using ''svn'', you have to open a command prompt ("DOS Window"). Make a folder, change directory, and run svn:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Unicode Build ==

=== Compile wxWidgets in Unicode mode ===

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets:

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

If you are using a recent version of MinGW you may find that the object files are too large and that the linker runs out of memory. To fix this problem you need to edit config.gcc so that inline functions are not exported, by modifying the CFLAGS and CXXFLAGS lines to:

CFLAGS ?= -fno-keep-inline-dllexport

CXXFLAGS ?= -fno-keep-inline-dllexport

''remark: If you want to use wxWidgets not only for building Code::Blocks, but also for writing wxWidgets programs, and if you want to use the debugger in those programs, you have to compile a debug build of wxWidgets as well.''
''Use the same commands as for the release build, but replace "release" by "debug".''

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

=== Compile Code::Blocks ===
Now, before this step, you have prepared all the stuff to build code::blocks. It's very interesting that we use code::blocks to build code::blocks binaries.

==== Open project====
Open the project file '''CodeBlocks.cbp'''.
*You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

[[Image:Global_variable.png]]

[[Image:Global_variable2.png]]

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field.

====Compile project====
Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

[[Image:Win build button.png]]

[[Image:Win build target.png]]

[[Image:Win build finish.png]]

====Copy wxWidgets support DLL====
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw28u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>src\devel</tt> directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into dll hell).

[[Image:Win output folder.png]]

[[Image:Win copy dll.png]]

====Runing script file====
Run <tt>src\update.bat</tt> (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.

[[Image:Win run bat.png]]

The stripped ("production") executable is found in <tt>output</tt> folder together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel</tt> folder. 
Congratulations, you own a freshly built version of Code::Blocks!

[[Image:Win final folder.png]]

====Note for future updates====
Go to the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect). 
Then open and build the project as described before (and any contrib plugins that you wish to use), and re-run <tt>src\update.bat</tt>.

=== Install Code::Blocks ===

Copy the folder output to where you want Code::Blocks to reside.

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins.workspace''' contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). 

[[Image:Contribute plugin.png]]

When you open the contrib plugins workspace, you will be asked to define the <tt>$(#cb)</tt> global compiler variable. This is the path that contains the sdk folder normally this is codeblocks\src. The build process uses this information to place the plugins and data files into the correct place. Enter the location of the Code::Blocks sources in the same way as for the <tt>$(#wx)</tt> variable earlier.

Don't forget to run update.bat again after building the contrib plugins.

== ANSI Build ==

<div style="background-color: #f7d9d9; border: 1px solid #000">
<div style="margin: 5px;">

==== DEPRECATION WARNING: ====
As of February 2006, the official default build for Code::Blocks is '''Unicode''' (see above). Although ANSI builds are technically possible, we discourage their use unless there is a good reason. 
''Support for ANSI builds is likely to be dropped after Version 1.0 is out.''

There is hardly any good argument against using a Unicode build if your OS supports Unicode, even if you do not understand any other language than English, as a Unicode version guarantees that it will be able to work with whatever languages you may possibly encounter in the future -- at a very reasonable cost.

However, if you absolutely don't care about Unicode or if you are bound to use Windows 95, then you may want to build an ANSI version nevertheless.

</div>
</div>

==== Compile wxWidgets in ANSI mode ====

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

==== Compile Code::Blocks ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx) if you have not used it before. Enter the location where you unpacked wxWidgets.

'''Important:''' The project file is set to compile an Unicode version of Code::Blocks by default. To make an ANSI build, you have to make the following two changes to build options before compiling:
1. In the "Compiler" tab, under "#defines", remove the entry wxUSE_UNICODE.
2. Under "Custom variables", set the variable WX_SUFFIX to empty (default value: u).

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilation has finished, copy wxmsw28u_gcc_custom.dll from lib\gcc_dll inside the wxWidgets directory to the devel directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into [[wikipedia:DLL Hell|dll hell]]).
Run update.bat (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.
The location of executable is src\output in C::B tree. From here you'll not need the nightly build anymore.

One little note for svn updates and rebuilds : just go into the codeblocks root directory and do '''svn update''' (or use Turtoise svn).

Then run the src/output/codeblocks.exe, reload project, build it, reload plugins workspace, build it, quit codeblocks and re-run update.bat. You'll have an up-to-date C::B in 3 minutes !

==== Install Code::Blocks ====

Copy the folder output to where you want Code::Blocks to reside.

==== Compile contributed (or your own) plugins ====

The workspace file ContribPlugins.workspace contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). Don't forget to run update.bat again after building the contrib plugins.

Note that the Nassi Shneiderman plugin (part of the contrib plugins) has a dependency on [http://www.boost.org boost] which is needed to compile this plugin. Boost does not need to be compiled therefore.

Installing Code::Blocks from source on Windows

2013-07-21T14:45:15Z

BlueHazzard:

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Prerequisites ==

=== Note for RC2 users ===

The older Code::Blocks RC2 does not support global compiler variables which were added after RC2 was released and is unable to read project files generated with post-RC2 versions.
To build Code::Blocks, you need a post-RC2 build, such as ''8.02'' or any of the ''nightly builds'' obtainable by [/index.php?board=20.0 searching the forum].

=== MinGW compiler ===

At the present time, Code::Blocks only compiles successfully with the MinGW compiler (or any other gcc for that matter). You will need a complete, working [[MinGW installation]] or [http://www.tdragon.net/recentgcc/ TDM-MinGW package].

'''Do not''' use the barebones MinGW with GCC 4.5.1 as you'll run (with this specific version) into [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43601 a linker bug] (which happened to me on Vista SP1 32-bit on 2011-02-28); the solution is to use the TDM-GCC 4.5.1 package, or later.

=== wxWidgets ===

[http://www.wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 02 April 2011 wxWidgets 2.8.12 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.12.zip wxMSW-2.8.12.zip]

* since 28 March 2009 wxWidgets 2.8.10 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.10.zip wxMSW-2.8.10.zip]

* since 18 October 2008 wxWidgets 2.8.9 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.9.zip wxMSW-2.8.9.zip]

* since 19 July 2008 wxWidgets 2.8.8 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

For latest infos check forum: [/index.php?topic=3299.0 Important changes to the nightly builds]

You do ''not'' need MSYS (''in fact, if you have MSYS, make sure it is not in your PATH when building wxWidgets'').

=== SVN client ===

In order to check out the Code::Blocks sources you will need a SVN client.
For convenience, it is recommended that you install [http://tortoisesvn.net/downloads TortoiseSVN] on your machine, as this is a lot more comfortable. However, if you get a bad feeling when some program is messing with your Explorer menu, then you can use the [http://subversion.tigris.org/project_packages.html svn command-line client] equally well.

It is generally a good idea to install the command-line client (and adding it to PATH) even if you use TortoiseSVN for convenience. The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn</tt> binary if it is available. This is preferable to the manual parsing of the entries file that is used as fall-back.

Please do note that working copies checked out with the 1.4 version of Subversion are no longer compatible with earlier versions (Subversion will transparently update existing repositories).

The built-in fall-back mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format. 
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the command line tool into <tt>PATH</tt> for a successful build. 
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== svn.exe ===
If you want to show the SVN number in your code::blocks dialog box.

[[Image:Svn number.png|300*300px]]

You should also let svn.exe exist in the PATH of your windows system.
A command line SVN package can be download here [http://www.open.collab.net/downloads/subversion/ CollabNet Subversion Command-Line Client v1.6 (for Windows)].

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [[MinGW installation#Other developer tools|tools page]], you'll be fine.

The zip program coming with cygwin will ''not'' work properly. You do ''not'' need WinZip.

Make sure the zip binary is in your PATH so the <tt>update.bat</tt> script will be able to find it (alternatively, you can edit the batch file, setting the ZIPCMD variable to something else).

The easiest way is to put zip.exe into <tt>bin</tt> inside your MinGW installation directory (that folder is normally in the path).

=== Code::Blocks sources ===

You will also (obviously) need the Code::Blocks sources.

Using ''TortoiseSVN'', make a folder where you want to store the sources, right-click on the folder, and select "SVN Checkout...".

'''!! The URL in this image is wrong !!''' Look at the description under the image:

[[Image:Win svn checkout.png]]

In the top box, enter svn://svn.code.sf.net/p/codeblocks/code/trunk and hit the OK button.

Using ''svn'', you have to open a command prompt ("DOS Window"). Make a folder, change directory, and run svn:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Unicode Build ==

=== Compile wxWidgets in Unicode mode ===

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets:

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

If you are using a recent version of MinGW you may find that the object files are too large and that the linker runs out of memory. To fix this problem you need to edit config.gcc so that inline functions are not exported, by modifying the CFLAGS and CXXFLAGS lines to:

CFLAGS ?= -fno-keep-inline-dllexport

CXXFLAGS ?= -fno-keep-inline-dllexport

''remark: If you want to use wxWidgets not only for building Code::Blocks, but also for writing wxWidgets programs, and if you want to use the debugger in those programs, you have to compile a debug build of wxWidgets as well.''
''Use the same commands as for the release build, but replace "release" by "debug".''

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

=== Compile Code::Blocks ===
Now, before this step, you have prepared all the stuff to build code::blocks. It's very interesting that we use code::blocks to build code::blocks binaries.

==== Open project====
Open the project file '''CodeBlocks.cbp'''. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

[[Image:Global_variable.png]]

[[Image:Global_variable2.png]]

====Compile project====
Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

[[Image:Win build button.png]]

[[Image:Win build target.png]]

[[Image:Win build finish.png]]

====Copy wxWidgets support DLL====
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw28u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>src\devel</tt> directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into dll hell).

[[Image:Win output folder.png]]

[[Image:Win copy dll.png]]

====Runing script file====
Run <tt>src\update.bat</tt> (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.

[[Image:Win run bat.png]]

The stripped ("production") executable is found in <tt>output</tt> folder together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel</tt> folder. 
Congratulations, you own a freshly built version of Code::Blocks!

[[Image:Win final folder.png]]

====Note for future updates====
Go to the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect). 
Then open and build the project as described before (and any contrib plugins that you wish to use), and re-run <tt>src\update.bat</tt>.

=== Install Code::Blocks ===

Copy the folder output to where you want Code::Blocks to reside.

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins.workspace''' contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). 

[[Image:Contribute plugin.png]]

When you open the contrib plugins workspace, you will be asked to define the <tt>$(#cb)</tt> global compiler variable. This is the path that contains the sdk folder normally this is codeblocks\src. The build process uses this information to place the plugins and data files into the correct place. Enter the location of the Code::Blocks sources in the same way as for the <tt>$(#wx)</tt> variable earlier.

Don't forget to run update.bat again after building the contrib plugins.

== ANSI Build ==

<div style="background-color: #f7d9d9; border: 1px solid #000">
<div style="margin: 5px;">

==== DEPRECATION WARNING: ====
As of February 2006, the official default build for Code::Blocks is '''Unicode''' (see above). Although ANSI builds are technically possible, we discourage their use unless there is a good reason. 
''Support for ANSI builds is likely to be dropped after Version 1.0 is out.''

There is hardly any good argument against using a Unicode build if your OS supports Unicode, even if you do not understand any other language than English, as a Unicode version guarantees that it will be able to work with whatever languages you may possibly encounter in the future -- at a very reasonable cost.

However, if you absolutely don't care about Unicode or if you are bound to use Windows 95, then you may want to build an ANSI version nevertheless.

</div>
</div>

==== Compile wxWidgets in ANSI mode ====

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

==== Compile Code::Blocks ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx) if you have not used it before. Enter the location where you unpacked wxWidgets.

'''Important:''' The project file is set to compile an Unicode version of Code::Blocks by default. To make an ANSI build, you have to make the following two changes to build options before compiling:
1. In the "Compiler" tab, under "#defines", remove the entry wxUSE_UNICODE.
2. Under "Custom variables", set the variable WX_SUFFIX to empty (default value: u).

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilation has finished, copy wxmsw28u_gcc_custom.dll from lib\gcc_dll inside the wxWidgets directory to the devel directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into [[wikipedia:DLL Hell|dll hell]]).
Run update.bat (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.
The location of executable is src\output in C::B tree. From here you'll not need the nightly build anymore.

One little note for svn updates and rebuilds : just go into the codeblocks root directory and do '''svn update''' (or use Turtoise svn).

Then run the src/output/codeblocks.exe, reload project, build it, reload plugins workspace, build it, quit codeblocks and re-run update.bat. You'll have an up-to-date C::B in 3 minutes !

==== Install Code::Blocks ====

Copy the folder output to where you want Code::Blocks to reside.

==== Compile contributed (or your own) plugins ====

The workspace file ContribPlugins.workspace contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). Don't forget to run update.bat again after building the contrib plugins.

Note that the Nassi Shneiderman plugin (part of the contrib plugins) has a dependency on [http://www.boost.org boost] which is needed to compile this plugin. Boost does not need to be compiled therefore.

Installing Code::Blocks from source on Windows

2013-07-21T14:43:19Z

BlueHazzard: added warning for wrong url in image

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Prerequisites ==

=== Note for RC2 users ===

The older Code::Blocks RC2 does not support global compiler variables which were added after RC2 was released and is unable to read project files generated with post-RC2 versions.
To build Code::Blocks, you need a post-RC2 build, such as ''8.02'' or any of the ''nightly builds'' obtainable by [/index.php?board=20.0 searching the forum].

=== MinGW compiler ===

At the present time, Code::Blocks only compiles successfully with the MinGW compiler (or any other gcc for that matter). You will need a complete, working [[MinGW installation]] or [http://www.tdragon.net/recentgcc/ TDM-MinGW package].

'''Do not''' use the barebones MinGW with GCC 4.5.1 as you'll run (with this specific version) into [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43601 a linker bug] (which happened to me on Vista SP1 32-bit on 2011-02-28); the solution is to use the TDM-GCC 4.5.1 package, or later.

=== wxWidgets ===

[http://www.wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 02 April 2011 wxWidgets 2.8.12 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.12.zip wxMSW-2.8.12.zip]

* since 28 March 2009 wxWidgets 2.8.10 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.10.zip wxMSW-2.8.10.zip]

* since 18 October 2008 wxWidgets 2.8.9 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.9.zip wxMSW-2.8.9.zip]

* since 19 July 2008 wxWidgets 2.8.8 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

For latest infos check forum: [/index.php?topic=3299.0 Important changes to the nightly builds]

You do ''not'' need MSYS (''in fact, if you have MSYS, make sure it is not in your PATH when building wxWidgets'').

=== SVN client ===

In order to check out the Code::Blocks sources you will need a SVN client.
For convenience, it is recommended that you install [http://tortoisesvn.net/downloads TortoiseSVN] on your machine, as this is a lot more comfortable. However, if you get a bad feeling when some program is messing with your Explorer menu, then you can use the [http://subversion.tigris.org/project_packages.html svn command-line client] equally well.

It is generally a good idea to install the command-line client (and adding it to PATH) even if you use TortoiseSVN for convenience. The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn</tt> binary if it is available. This is preferable to the manual parsing of the entries file that is used as fall-back.

Please do note that working copies checked out with the 1.4 version of Subversion are no longer compatible with earlier versions (Subversion will transparently update existing repositories).

The built-in fall-back mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format. 
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the command line tool into <tt>PATH</tt> for a successful build. 
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== svn.exe ===
If you want to show the SVN number in your code::blocks dialog box.

[[Image:Svn number.png|300*300px]]

You should also let svn.exe exist in the PATH of your windows system.
A command line SVN package can be download here [http://www.open.collab.net/downloads/subversion/ CollabNet Subversion Command-Line Client v1.6 (for Windows)].

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [[MinGW installation#Other developer tools|tools page]], you'll be fine.

The zip program coming with cygwin will ''not'' work properly. You do ''not'' need WinZip.

Make sure the zip binary is in your PATH so the <tt>update.bat</tt> script will be able to find it (alternatively, you can edit the batch file, setting the ZIPCMD variable to something else).

The easiest way is to put zip.exe into <tt>bin</tt> inside your MinGW installation directory (that folder is normally in the path).

=== Code::Blocks sources ===

You will also (obviously) need the Code::Blocks sources.

Using ''TortoiseSVN'', make a folder where you want to store the sources, right-click on the folder, and select "SVN Checkout...".

!! The URL in this image is wrong !! Look at the description under the image:

[[Image:Win svn checkout.png]]

In the top box, enter svn://svn.code.sf.net/p/codeblocks/code/trunk and hit the OK button.

Using ''svn'', you have to open a command prompt ("DOS Window"). Make a folder, change directory, and run svn:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Unicode Build ==

=== Compile wxWidgets in Unicode mode ===

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets:

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

If you are using a recent version of MinGW you may find that the object files are too large and that the linker runs out of memory. To fix this problem you need to edit config.gcc so that inline functions are not exported, by modifying the CFLAGS and CXXFLAGS lines to:

CFLAGS ?= -fno-keep-inline-dllexport

CXXFLAGS ?= -fno-keep-inline-dllexport

''remark: If you want to use wxWidgets not only for building Code::Blocks, but also for writing wxWidgets programs, and if you want to use the debugger in those programs, you have to compile a debug build of wxWidgets as well.''
''Use the same commands as for the release build, but replace "release" by "debug".''

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

=== Compile Code::Blocks ===
Now, before this step, you have prepared all the stuff to build code::blocks. It's very interesting that we use code::blocks to build code::blocks binaries.

==== Open project====
Open the project file '''CodeBlocks.cbp'''. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

[[Image:Global_variable.png]]

[[Image:Global_variable2.png]]

====Compile project====
Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

[[Image:Win build button.png]]

[[Image:Win build target.png]]

[[Image:Win build finish.png]]

====Copy wxWidgets support DLL====
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw28u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>src\devel</tt> directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into dll hell).

[[Image:Win output folder.png]]

[[Image:Win copy dll.png]]

====Runing script file====
Run <tt>src\update.bat</tt> (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.

[[Image:Win run bat.png]]

The stripped ("production") executable is found in <tt>output</tt> folder together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel</tt> folder. 
Congratulations, you own a freshly built version of Code::Blocks!

[[Image:Win final folder.png]]

====Note for future updates====
Go to the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect). 
Then open and build the project as described before (and any contrib plugins that you wish to use), and re-run <tt>src\update.bat</tt>.

=== Install Code::Blocks ===

Copy the folder output to where you want Code::Blocks to reside.

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins.workspace''' contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). 

[[Image:Contribute plugin.png]]

When you open the contrib plugins workspace, you will be asked to define the <tt>$(#cb)</tt> global compiler variable. This is the path that contains the sdk folder normally this is codeblocks\src. The build process uses this information to place the plugins and data files into the correct place. Enter the location of the Code::Blocks sources in the same way as for the <tt>$(#wx)</tt> variable earlier.

Don't forget to run update.bat again after building the contrib plugins.

== ANSI Build ==

<div style="background-color: #f7d9d9; border: 1px solid #000">
<div style="margin: 5px;">

==== DEPRECATION WARNING: ====
As of February 2006, the official default build for Code::Blocks is '''Unicode''' (see above). Although ANSI builds are technically possible, we discourage their use unless there is a good reason. 
''Support for ANSI builds is likely to be dropped after Version 1.0 is out.''

There is hardly any good argument against using a Unicode build if your OS supports Unicode, even if you do not understand any other language than English, as a Unicode version guarantees that it will be able to work with whatever languages you may possibly encounter in the future -- at a very reasonable cost.

However, if you absolutely don't care about Unicode or if you are bound to use Windows 95, then you may want to build an ANSI version nevertheless.

</div>
</div>

==== Compile wxWidgets in ANSI mode ====

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

==== Compile Code::Blocks ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx) if you have not used it before. Enter the location where you unpacked wxWidgets.

'''Important:''' The project file is set to compile an Unicode version of Code::Blocks by default. To make an ANSI build, you have to make the following two changes to build options before compiling:
1. In the "Compiler" tab, under "#defines", remove the entry wxUSE_UNICODE.
2. Under "Custom variables", set the variable WX_SUFFIX to empty (default value: u).

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilation has finished, copy wxmsw28u_gcc_custom.dll from lib\gcc_dll inside the wxWidgets directory to the devel directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into [[wikipedia:DLL Hell|dll hell]]).
Run update.bat (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.
The location of executable is src\output in C::B tree. From here you'll not need the nightly build anymore.

One little note for svn updates and rebuilds : just go into the codeblocks root directory and do '''svn update''' (or use Turtoise svn).

Then run the src/output/codeblocks.exe, reload project, build it, reload plugins workspace, build it, quit codeblocks and re-run update.bat. You'll have an up-to-date C::B in 3 minutes !

==== Install Code::Blocks ====

Copy the folder output to where you want Code::Blocks to reside.

==== Compile contributed (or your own) plugins ====

The workspace file ContribPlugins.workspace contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). Don't forget to run update.bat again after building the contrib plugins.

Note that the Nassi Shneiderman plugin (part of the contrib plugins) has a dependency on [http://www.boost.org boost] which is needed to compile this plugin. Boost does not need to be compiled therefore.

Installing Code::Blocks from source on Windows

2013-07-21T14:40:55Z

BlueHazzard: fixed svn url

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Prerequisites ==

=== Note for RC2 users ===

The older Code::Blocks RC2 does not support global compiler variables which were added after RC2 was released and is unable to read project files generated with post-RC2 versions.
To build Code::Blocks, you need a post-RC2 build, such as ''8.02'' or any of the ''nightly builds'' obtainable by [/index.php?board=20.0 searching the forum].

=== MinGW compiler ===

At the present time, Code::Blocks only compiles successfully with the MinGW compiler (or any other gcc for that matter). You will need a complete, working [[MinGW installation]] or [http://www.tdragon.net/recentgcc/ TDM-MinGW package].

'''Do not''' use the barebones MinGW with GCC 4.5.1 as you'll run (with this specific version) into [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43601 a linker bug] (which happened to me on Vista SP1 32-bit on 2011-02-28); the solution is to use the TDM-GCC 4.5.1 package, or later.

=== wxWidgets ===

[http://www.wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 02 April 2011 wxWidgets 2.8.12 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.12.zip wxMSW-2.8.12.zip]

* since 28 March 2009 wxWidgets 2.8.10 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.10.zip wxMSW-2.8.10.zip]

* since 18 October 2008 wxWidgets 2.8.9 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.9.zip wxMSW-2.8.9.zip]

* since 19 July 2008 wxWidgets 2.8.8 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

For latest infos check forum: [/index.php?topic=3299.0 Important changes to the nightly builds]

You do ''not'' need MSYS (''in fact, if you have MSYS, make sure it is not in your PATH when building wxWidgets'').

=== SVN client ===

In order to check out the Code::Blocks sources you will need a SVN client.
For convenience, it is recommended that you install [http://tortoisesvn.net/downloads TortoiseSVN] on your machine, as this is a lot more comfortable. However, if you get a bad feeling when some program is messing with your Explorer menu, then you can use the [http://subversion.tigris.org/project_packages.html svn command-line client] equally well.

It is generally a good idea to install the command-line client (and adding it to PATH) even if you use TortoiseSVN for convenience. The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn</tt> binary if it is available. This is preferable to the manual parsing of the entries file that is used as fall-back.

Please do note that working copies checked out with the 1.4 version of Subversion are no longer compatible with earlier versions (Subversion will transparently update existing repositories).

The built-in fall-back mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format. 
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the command line tool into <tt>PATH</tt> for a successful build. 
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== svn.exe ===
If you want to show the SVN number in your code::blocks dialog box.

[[Image:Svn number.png|300*300px]]

You should also let svn.exe exist in the PATH of your windows system.
A command line SVN package can be download here [http://www.open.collab.net/downloads/subversion/ CollabNet Subversion Command-Line Client v1.6 (for Windows)].

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [[MinGW installation#Other developer tools|tools page]], you'll be fine.

The zip program coming with cygwin will ''not'' work properly. You do ''not'' need WinZip.

Make sure the zip binary is in your PATH so the <tt>update.bat</tt> script will be able to find it (alternatively, you can edit the batch file, setting the ZIPCMD variable to something else).

The easiest way is to put zip.exe into <tt>bin</tt> inside your MinGW installation directory (that folder is normally in the path).

=== Code::Blocks sources ===

You will also (obviously) need the Code::Blocks sources.

Using ''TortoiseSVN'', make a folder where you want to store the sources, right-click on the folder, and select "SVN Checkout...".

[[Image:Win svn checkout.png]]

In the top box, enter svn://svn.code.sf.net/p/codeblocks/code/trunk and hit the OK button.

Using ''svn'', you have to open a command prompt ("DOS Window"). Make a folder, change directory, and run svn:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Unicode Build ==

=== Compile wxWidgets in Unicode mode ===

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets:

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

If you are using a recent version of MinGW you may find that the object files are too large and that the linker runs out of memory. To fix this problem you need to edit config.gcc so that inline functions are not exported, by modifying the CFLAGS and CXXFLAGS lines to:

CFLAGS ?= -fno-keep-inline-dllexport

CXXFLAGS ?= -fno-keep-inline-dllexport

''remark: If you want to use wxWidgets not only for building Code::Blocks, but also for writing wxWidgets programs, and if you want to use the debugger in those programs, you have to compile a debug build of wxWidgets as well.''
''Use the same commands as for the release build, but replace "release" by "debug".''

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

=== Compile Code::Blocks ===
Now, before this step, you have prepared all the stuff to build code::blocks. It's very interesting that we use code::blocks to build code::blocks binaries.

==== Open project====
Open the project file '''CodeBlocks.cbp'''. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

[[Image:Global_variable.png]]

[[Image:Global_variable2.png]]

====Compile project====
Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

[[Image:Win build button.png]]

[[Image:Win build target.png]]

[[Image:Win build finish.png]]

====Copy wxWidgets support DLL====
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw28u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>src\devel</tt> directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into dll hell).

[[Image:Win output folder.png]]

[[Image:Win copy dll.png]]

====Runing script file====
Run <tt>src\update.bat</tt> (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.

[[Image:Win run bat.png]]

The stripped ("production") executable is found in <tt>output</tt> folder together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel</tt> folder. 
Congratulations, you own a freshly built version of Code::Blocks!

[[Image:Win final folder.png]]

====Note for future updates====
Go to the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect). 
Then open and build the project as described before (and any contrib plugins that you wish to use), and re-run <tt>src\update.bat</tt>.

=== Install Code::Blocks ===

Copy the folder output to where you want Code::Blocks to reside.

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins.workspace''' contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). 

[[Image:Contribute plugin.png]]

When you open the contrib plugins workspace, you will be asked to define the <tt>$(#cb)</tt> global compiler variable. This is the path that contains the sdk folder normally this is codeblocks\src. The build process uses this information to place the plugins and data files into the correct place. Enter the location of the Code::Blocks sources in the same way as for the <tt>$(#wx)</tt> variable earlier.

Don't forget to run update.bat again after building the contrib plugins.

== ANSI Build ==

<div style="background-color: #f7d9d9; border: 1px solid #000">
<div style="margin: 5px;">

==== DEPRECATION WARNING: ====
As of February 2006, the official default build for Code::Blocks is '''Unicode''' (see above). Although ANSI builds are technically possible, we discourage their use unless there is a good reason. 
''Support for ANSI builds is likely to be dropped after Version 1.0 is out.''

There is hardly any good argument against using a Unicode build if your OS supports Unicode, even if you do not understand any other language than English, as a Unicode version guarantees that it will be able to work with whatever languages you may possibly encounter in the future -- at a very reasonable cost.

However, if you absolutely don't care about Unicode or if you are bound to use Windows 95, then you may want to build an ANSI version nevertheless.

</div>
</div>

==== Compile wxWidgets in ANSI mode ====

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

==== Compile Code::Blocks ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx) if you have not used it before. Enter the location where you unpacked wxWidgets.

'''Important:''' The project file is set to compile an Unicode version of Code::Blocks by default. To make an ANSI build, you have to make the following two changes to build options before compiling:
1. In the "Compiler" tab, under "#defines", remove the entry wxUSE_UNICODE.
2. Under "Custom variables", set the variable WX_SUFFIX to empty (default value: u).

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilation has finished, copy wxmsw28u_gcc_custom.dll from lib\gcc_dll inside the wxWidgets directory to the devel directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into [[wikipedia:DLL Hell|dll hell]]).
Run update.bat (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.
The location of executable is src\output in C::B tree. From here you'll not need the nightly build anymore.

One little note for svn updates and rebuilds : just go into the codeblocks root directory and do '''svn update''' (or use Turtoise svn).

Then run the src/output/codeblocks.exe, reload project, build it, reload plugins workspace, build it, quit codeblocks and re-run update.bat. You'll have an up-to-date C::B in 3 minutes !

==== Install Code::Blocks ====

Copy the folder output to where you want Code::Blocks to reside.

==== Compile contributed (or your own) plugins ====

The workspace file ContribPlugins.workspace contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). Don't forget to run update.bat again after building the contrib plugins.

Note that the Nassi Shneiderman plugin (part of the contrib plugins) has a dependency on [http://www.boost.org boost] which is needed to compile this plugin. Boost does not need to be compiled therefore.

FAQ-Compiling (errors)

2013-03-12T18:16:38Z

BlueHazzard:

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: How do I troubleshoot a compiler problem? ====

'''A:''' I would start by turning on full Compiler logging.

This is done by selecting the "Full command line" option Under menu "Settings" -> "Compiler" -> Global compiler settings -> [the compiler you use] -> "Other Setting" tab, "Compiler logging". In 12.11 and newer this is enabled by default.

This option will make Code::Blocks output the exact commands it uses to compile your code.

Things to remember:

* You should review all the commands and their options;
* If you have compiled your app before, do a ''re-''build (or ''clean'' before build) to see all compiling / linking steps;
* If you don't know what an option or a command does please read the documentation for the compiler/linker you're using;
* Look for missing commands;
* For every source file (<tt>.cpp</tt>; <tt>.c</tt>; <tt>.d</tt>; etc) in your project, you must have at least one command in the log. This command must produce an object file (file extension <tt>.o</tt> if using gcc/g++ and <tt>.obj</tt> if using Visual Studio);
* Every object file should be linked in the final executable, if not there are undefined symbols errors;
* Remember the file extension matters: <tt>*.c</tt> is compiled as C file, <tt>*.cpp</tt> is compiled as C++ file. [http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html Read more]

==== Q: What do I need to know when using 3rd party libs? ====
Here are some basics about typical mistakes done when working with third party libs, including wxWidgets. The following is valid for ''every'' third party SDK / toolbox / component you want to use and describes what steps your have to do:

* Download the sources of the component OR a ready-to-use development version. The difference: While the first requires you to compile the component yourself is will definitely work with your compiler. The latter must be compiled in a compatible way: So a compatible compiler, compatible OS, compatible settings. Inspect the components docs about how to get what you want.
* Place the component sources and compiled parts anywhere you want It is not required to copy such parts to any other folder you might think - in fact, this may even be dangerous in case you overwrite existing files.
* Create a project where you want to use your component.
* In the ''compiler'' settings, point to the folder, where the include files of your component are. For WX this is special, as usually you include like #include <wx/foo.h>. So do ''not'' point to [Component_Folder]\include\wx, but to [Component_Folder]\include instead.
* Note that the compiler only needs to know the interfaces / classes / structures / methods, it will not throw an error about undefined references or alike. The compiler will only complain in case it cannot find references in terms of include files. If thats the case, adjust your project's compiler settings. Keep in mind that you do need to fulfil the requirements of your component itself, too. Thus, wxChart for example will need for wxWidgets, too. So - you may need to do the same process for wxWidgets, too before you can use wxChart - unless you have done that already.
* In the ''linker'' settings, point to the folder where you have your compiled library. A library usually ends with *.a or *.lib. Note that there are generally two types of libs: Static libs (after linking you are done) and Dynamic libs (where you link against an import lib but require another dynamic lib at runtime).
* In the linker settings add the library/libraries you need to link against in the ''right order'' to the list of libs to link against. ''Order matters'' - again, dependencies must be taken into account. Inspect the developers guide of the component to know the dependencies. On Windows, this may include the MSDN, too which tells you what libraries you need to link against for certain symbols you or the library may make use of.
* The linker will never complain about includes it cannot find. Because the linker just links object files or library files together. But the linker may complain about unresolved symbols which you need to provide. So if that happens, either your setup is missing a lib, or the order is wrong.

Again, this is valid for all third party stuff you want to use. Its heavily ''platform'' and ''compiler'' dependent. The IDE should be less of concern for you. Every IDE can be setup in a way it will compile and link your stuff unless you provide everything needed as explained above.

If you don't understand parts written here it is ''strongly'' recommended you start with a book about general programming in C/C++ that covers library handling in more detail.

For the example wxChart in the end is not easy for starters. Usually you need to compile wxWidgets before, then wxChart and usually not all dependencies are explained in the docs and it behaves differently on different OS'es / compilers. Also, wcChart can be compiled in many flavours - so you need to make sure the flavour matches a) your needs and b) the way you compiled wxWidgets.

==== Q: My simple C++ program throws up lots of errors - what is going on? ====

If you have a C++ program like this:

#include <iostream>
int main() {
std::cout << "hello world\n";
}

and when you compile it you get errors like this:

fatal error: iostream: No such file or directory

then you have probably given your source file a .c extension. If you do that, the GCC compiler (and others) will probably attempt to compile the file as a C program, not as C++. You should always give your C++ source files the extension .cpp to make sure the compiler handles them correctly.

==== Q: I imported a MSVCToolkit project/workspace, but Code::Blocks insists on trying to use GCC. What's wrong? ====

'''A:''' A little documentation problem ^^;. The "default compiler" is usually GCC, so when you imported it with "the default compiler", you told it to use GCC. To fix this situation, go to "Project", "Build Options" and select VC++ Toolkit as your compiler.

Another possibility is to put the Microsoft compiler as the default one. To do this, choose '''''Settings - Compiler''''', choose the Microsoft compiler in the '''''Selected Compiler''''' section (top of dialog box) and press the '''''Set as default''''' button.

From now onwards, for all new projects the Microsoft compiler will be taken by default.

==== Q: When compiling a wxWidgets project, I get several "variable 'vtable for xxxx' can't be auto-imported". What's wrong? ====

'''A:''' You need to add WXUSINGDLL in "Project->Build options->Compiler #defines" and rebuild your project (or create a new project and use the "Using wxWidgets DLL" project option which adds "-DWXUSINGDLL" to Project->Build options->Other options).
Other errors with the same resolution are:
'unresolved external symbol "char const * const wxEmptyString" (?wxEmptyString@@3PBDB)' or similar.
If you were using 1.0-finalbeta and were trying to build a statically linked wxWidgets project, the cause of the problem was some faulty templates. But that's fixed now.

==== Q: I can't compile a multithreaded app with VC Toolkit! Where are the libraries? ====

'''A:''' Sorry, no fix for your problem...

Your problem doesn't come from CodeBlocks. It exists, because the free VC toolkit (VCTK) doesn't provide all the libraries and tools which come with Visual C++ (VC) which isn't free, unfortunately.

Try buying a full-fledged VC++, or even better, download [http://www.mingw.org/ MinGW]

The libraries that can be obtained free of charge are:

Paths:
(VCT3) Visual C++ Toolkit 2003 - C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
(PSDK) Platform SDK - C:\Program Files\Microsoft Platform SDK\Lib
(NSDK) .NET 1.1 SDK - C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib

C runtime libs:
LIBC.LIB Single-threaded, static link (VCT3, NSDK)
LIBCMT.LIB Multithreaded, static link (VCT3, NSDK)
MSVCRT.LIB Multithreaded, dynamic link (import library for MSVCR71.DLL) (NSDK)
LIBCD.LIB Single-threaded, static link (debug) (VCT3, NSDK)
LIBCMTD.LIB Multithreaded, static link (debug) (NSDK)
MSVCRTD.LIB Multithreaded, dynamic link (import library for MSVCR71D.DLL) (debug) (NSDK)

C++ libs:
LIBCP.LIB Single-threaded, static link (VCT3, PSDK)
LIBCPMT.LIB Multithreaded, static link (VCT3)
MSVCPRT.LIB Multithreaded, dynamic link (import library for MSVCP71.dll) (none)
LIBCPD.LIB Single-threaded, static link (debug) (VCT3)
LIBCPMTD.LIB Multithreaded, static link (debug) (none)
MSVCPRTD.LIB Multithreaded, dynamic link (import library for MSVCP71D.DLL) (debug) (none)

Try setting the library linker directories to:
C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
C:\Program Files\Microsoft Platform SDK\Lib
C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
in that order.

The ones listed as (none) above are actually present in the IA64 and AMD64 subdirectories of the PSDK lib directory. Not sure if these would work on 32-bit windows, however, they may if they are
meant to work in 32-bit compatibility mode on the 64-bit processors. Worth a try. Otherwise, you
can link statically to the C++ library instead of using MSVCP71.dll. If you really want to link against MSVCP71.dll you can try to create MSVCP71.LIB from the dll using lib.exe and sed. Search google for "exports.sed" for detailed steps.

See also: [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

See also: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_c_run.2d.time_libraries.asp

See also: http://sapdb.2scale.net/moin.cgi/MS_20C_2b_2b_20Toolkit

==== Q: I get this error when compiling: Symbol "isascii" was not found in "codeblocks.dll" ====

'''A:''' Make sure you didn't mix up the MSVC headers or libs with the MinGW ones.

==== Q: My build fails with multiple ''undefined reference'' errors? ====

''Example:''
undefined reference to `WSACleanup@8
undefined reference to `WSACleanup@0

'''A:''' Most of the time it is because the required library is not linked with your project. Go to ''Project->Build options...->Linker settings (tab)'' and add the required library or libraries.

If the error includes a line number, it is likely that this is a problem with your code. Track down down your function declarations and implementations. Ensure they all match up, are spelled correctly, and have the correct scope resolution.

''VERY'' often you can get help by just googling for the name of the undefined reference, for this example its "WSACleanup". Usually one of the first links is the SDK documentation, like [http://msdn.microsoft.com/en-us/library/windows/desktop/ms741549%28v=vs.85%29.aspx this from MSDN for WSACleanup]. You'll find there a lot useful information, including what libraries you need to link against, as for the exsample:
'''Requirements'''
* Minimum supported client: Windows 2000 Professional
* Minimum supported server: Windows 2000 Server
* Header: '''Winsock2.h'''
* Library: '''Ws2_32'''.lib
* DLL: '''Ws2_32.dll'''
The header file '''Winsock2.h''' you need to include in your sources. Most likely you have done that already because otherwise you would have gotten a compiler error unable to find the function declaration. The library you need to link against, you can remove any prefix like "lib" and the file extension like ".lib", ".a" or ".so" - so just type "'''Ws2_32'''" in the linker options. Also make sure you have added the path to that library in the linker include path's options, otherwise the linker will complain that it cannot find that library you want to link against. You also know, that you should distribute '''Ws2_32.dll''' for the runtime version of you app, luckily this one usually ships with Windows anyways, so no need to do something here.

==== Q: My build fails in the compile/link/run step with a ''Permission denied'' error? ====

'''A:''' There are several possible causes for this:

# The output directory does not have read/write access.
#* Either change control settings on the output directory, or move the project to different location.
# A previous instance of the executable failed to terminate properly.
#* Open your system's equivalent of Process/Task Manager, search the list for the name of the executable Code::Blocks is trying to output, and terminate it.
#* Logging off or rebooting will achieve the same effect.
# The executable is open.
#* If the executable is open in a hex-editor or actively being run, close it.
# Security software is interfering.
#* The target file is locked while an antivirus programming is scanning it; either wait a few seconds for the antivirus scan to finish, set an exception in the antivirus settings, or (temporarily) disable the antivirus program.
#* Firewalls with very strict settings sometimes block execution; try reducing the firewall's settings or adding an exception.
#* Switching security software may have left traces behind that are interfering; hunt down the remnants of the old antivirus/firewall software and remove them.
# The file/library cannot be found.
#* Double check all of the compiler and linker [[FAQ-Compiling (general)#Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist?|search directories]] (including any [[Global compiler variables|variables]] they may be using) are properly setup.
# Code::Blocks was improperly installed.
#* Mixing binaries from a stable release and a nightly build (or even two different nightly builds) is highly likely to cause a slew of problems; [[Installing Code::Blocks|reinstall Code::Blocks]] in an empty directory.
# Multiple installed compilers are interfering with each other.
#* If they are not required to keep, completely remove all but the most used compiler.
#* If several compilers are required, ensure that '''none''' of them are in the ''system'' path (this is so that Code::Blocks will be able to manage all paths).
#* Also, do not place any compilers in their default installation path (for example <tt>C:\MinGW</tt>), as some compilers are hard-coded to look for headers in a default path ''before'' searching their own respective directories.
# On windows 7, the service "Application Experience" is not running [http://stackoverflow.com/questions/7655471/ld-exe-cannot-open-output-file-permission-denied#answer-7904469 as explained on stackoverflow].
See also: [/index.php/topic,15047.0.html Permission denied forums discussion]

==== Q: My build fails to link due to ''multiple definition of xyz'' errors? ====

'''A:''' GCC 4.6.1 mingw target (Windows) is known to occasionally (and erroneously) report this if link-time optimization (<tt>-flto</tt>) is used.

First, of course, check that no token has been defined multiple times. If the source code is clean, and yet the errors persist, adding linker switch (''Project->Build options...->Linker settings (tab)'')
-Wl,--allow-multiple-definition
will enable the code to link.

See also: [http://sourceware.org/bugzilla/show_bug.cgi?id=12762 Bug 12762]

==== Q: How can I change the language of the compiler (gcc) output to english? ====

'''A:''' Codeblocks 12.11 or higher: Settings->Environment->Environment Variables. Add "LC_ALL" with value "C". ->Set Now -> Ok

Since a few releases gcc is localized. This can make difficult to find (google ;) ) solutions for specific problems. With this setting the output is again in english.

!! this can break displaying of non-aschii characters so you can also use LC_ALL = en_US.utf8 (/index.php/topic,17579.msg120613.html#msg120613)

----

Return to '''[[FAQ]]'''.

FAQ-Compiling (errors)

2013-03-04T21:30:44Z

BlueHazzard: Add a solution to change the language from gcc back to english

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: How do I troubleshoot a compiler problem? ====

'''A:''' I would start by turning on full Compiler logging.

This is done by selecting the "Full command line" option Under menu "Settings" -> "Compiler" -> Global compiler settings -> [the compiler you use] -> "Other Setting" tab, "Compiler logging". In 12.11 and newer this is enabled by default.

This option will make Code::Blocks output the exact commands it uses to compile your code.

Things to remember:

* You should review all the commands and their options;
* If you have compiled your app before, do a ''re-''build (or ''clean'' before build) to see all compiling / linking steps;
* If you don't know what an option or a command does please read the documentation for the compiler/linker you're using;
* Look for missing commands;
* For every source file (<tt>.cpp</tt>; <tt>.c</tt>; <tt>.d</tt>; etc) in your project, you must have at least one command in the log. This command must produce an object file (file extension <tt>.o</tt> if using gcc/g++ and <tt>.obj</tt> if using Visual Studio);
* Every object file should be linked in the final executable, if not there are undefined symbols errors;
* Remember the file extension matters: <tt>*.c</tt> is compiled as C file, <tt>*.cpp</tt> is compiled as C++ file. [http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html Read more]

==== Q: What do I need to know when using 3rd party libs? ====
Here are some basics about typical mistakes done when working with third party libs, including wxWidgets. The following is valid for ''every'' third party SDK / toolbox / component you want to use and describes what steps your have to do:

* Download the sources of the component OR a ready-to-use development version. The difference: While the first requires you to compile the component yourself is will definitely work with your compiler. The latter must be compiled in a compatible way: So a compatible compiler, compatible OS, compatible settings. Inspect the components docs about how to get what you want.
* Place the component sources and compiled parts anywhere you want It is not required to copy such parts to any other folder you might think - in fact, this may even be dangerous in case you overwrite existing files.
* Create a project where you want to use your component.
* In the ''compiler'' settings, point to the folder, where the include files of your component are. For WX this is special, as usually you include like #include <wx/foo.h>. So do ''not'' point to [Component_Folder]\include\wx, but to [Component_Folder]\include instead.
* Note that the compiler only needs to know the interfaces / classes / structures / methods, it will not throw an error about undefined references or alike. The compiler will only complain in case it cannot find references in terms of include files. If thats the case, adjust your project's compiler settings. Keep in mind that you do need to fulfil the requirements of your component itself, too. Thus, wxChart for example will need for wxWidgets, too. So - you may need to do the same process for wxWidgets, too before you can use wxChart - unless you have done that already.
* In the ''linker'' settings, point to the folder where you have your compiled library. A library usually ends with *.a or *.lib. Note that there are generally two types of libs: Static libs (after linking you are done) and Dynamic libs (where you link against an import lib but require another dynamic lib at runtime).
* In the linker settings add the library/libraries you need to link against in the ''right order'' to the list of libs to link against. ''Order matters'' - again, dependencies must be taken into account. Inspect the developers guide of the component to know the dependencies. On Windows, this may include the MSDN, too which tells you what libraries you need to link against for certain symbols you or the library may make use of.
* The linker will never complain about includes it cannot find. Because the linker just links object files or library files together. But the linker may complain about unresolved symbols which you need to provide. So if that happens, either your setup is missing a lib, or the order is wrong.

Again, this is valid for all third party stuff you want to use. Its heavily ''platform'' and ''compiler'' dependent. The IDE should be less of concern for you. Every IDE can be setup in a way it will compile and link your stuff unless you provide everything needed as explained above.

If you don't understand parts written here it is ''strongly'' recommended you start with a book about general programming in C/C++ that covers library handling in more detail.

For the example wxChart in the end is not easy for starters. Usually you need to compile wxWidgets before, then wxChart and usually not all dependencies are explained in the docs and it behaves differently on different OS'es / compilers. Also, wcChart can be compiled in many flavours - so you need to make sure the flavour matches a) your needs and b) the way you compiled wxWidgets.

==== Q: My simple C++ program throws up lots of errors - what is going on? ====

If you have a C++ program like this:

#include <iostream>
int main() {
std::cout << "hello world\n";
}

and when you compile it you get errors like this:

fatal error: iostream: No such file or directory

then you have probably given your source file a .c extension. If you do that, the GCC compiler (and others) will probably attempt to compile the file as a C program, not as C++. You should always give your C++ source files the extension .cpp to make sure the compiler handles them correctly.

==== Q: I imported a MSVCToolkit project/workspace, but Code::Blocks insists on trying to use GCC. What's wrong? ====

'''A:''' A little documentation problem ^^;. The "default compiler" is usually GCC, so when you imported it with "the default compiler", you told it to use GCC. To fix this situation, go to "Project", "Build Options" and select VC++ Toolkit as your compiler.

Another possibility is to put the Microsoft compiler as the default one. To do this, choose '''''Settings - Compiler''''', choose the Microsoft compiler in the '''''Selected Compiler''''' section (top of dialog box) and press the '''''Set as default''''' button.

From now onwards, for all new projects the Microsoft compiler will be taken by default.

==== Q: When compiling a wxWidgets project, I get several "variable 'vtable for xxxx' can't be auto-imported". What's wrong? ====

'''A:''' You need to add WXUSINGDLL in "Project->Build options->Compiler #defines" and rebuild your project (or create a new project and use the "Using wxWidgets DLL" project option which adds "-DWXUSINGDLL" to Project->Build options->Other options).
Other errors with the same resolution are:
'unresolved external symbol "char const * const wxEmptyString" (?wxEmptyString@@3PBDB)' or similar.
If you were using 1.0-finalbeta and were trying to build a statically linked wxWidgets project, the cause of the problem was some faulty templates. But that's fixed now.

==== Q: I can't compile a multithreaded app with VC Toolkit! Where are the libraries? ====

'''A:''' Sorry, no fix for your problem...

Your problem doesn't come from CodeBlocks. It exists, because the free VC toolkit (VCTK) doesn't provide all the libraries and tools which come with Visual C++ (VC) which isn't free, unfortunately.

Try buying a full-fledged VC++, or even better, download [http://www.mingw.org/ MinGW]

The libraries that can be obtained free of charge are:

Paths:
(VCT3) Visual C++ Toolkit 2003 - C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
(PSDK) Platform SDK - C:\Program Files\Microsoft Platform SDK\Lib
(NSDK) .NET 1.1 SDK - C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib

C runtime libs:
LIBC.LIB Single-threaded, static link (VCT3, NSDK)
LIBCMT.LIB Multithreaded, static link (VCT3, NSDK)
MSVCRT.LIB Multithreaded, dynamic link (import library for MSVCR71.DLL) (NSDK)
LIBCD.LIB Single-threaded, static link (debug) (VCT3, NSDK)
LIBCMTD.LIB Multithreaded, static link (debug) (NSDK)
MSVCRTD.LIB Multithreaded, dynamic link (import library for MSVCR71D.DLL) (debug) (NSDK)

C++ libs:
LIBCP.LIB Single-threaded, static link (VCT3, PSDK)
LIBCPMT.LIB Multithreaded, static link (VCT3)
MSVCPRT.LIB Multithreaded, dynamic link (import library for MSVCP71.dll) (none)
LIBCPD.LIB Single-threaded, static link (debug) (VCT3)
LIBCPMTD.LIB Multithreaded, static link (debug) (none)
MSVCPRTD.LIB Multithreaded, dynamic link (import library for MSVCP71D.DLL) (debug) (none)

Try setting the library linker directories to:
C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
C:\Program Files\Microsoft Platform SDK\Lib
C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib
in that order.

The ones listed as (none) above are actually present in the IA64 and AMD64 subdirectories of the PSDK lib directory. Not sure if these would work on 32-bit windows, however, they may if they are
meant to work in 32-bit compatibility mode on the 64-bit processors. Worth a try. Otherwise, you
can link statically to the C++ library instead of using MSVCP71.dll. If you really want to link against MSVCP71.dll you can try to create MSVCP71.LIB from the dll using lib.exe and sed. Search google for "exports.sed" for detailed steps.

See also: [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

See also: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_c_run.2d.time_libraries.asp

See also: http://sapdb.2scale.net/moin.cgi/MS_20C_2b_2b_20Toolkit

==== Q: I get this error when compiling: Symbol "isascii" was not found in "codeblocks.dll" ====

'''A:''' Make sure you didn't mix up the MSVC headers or libs with the MinGW ones.

==== Q: My build fails with multiple ''undefined reference'' errors? ====

''Example:''
undefined reference to `WSACleanup@8
undefined reference to `WSACleanup@0

'''A:''' Most of the time it is because the required library is not linked with your project. Go to ''Project->Build options...->Linker settings (tab)'' and add the required library or libraries.

If the error includes a line number, it is likely that this is a problem with your code. Track down down your function declarations and implementations. Ensure they all match up, are spelled correctly, and have the correct scope resolution.

''VERY'' often you can get help by just googling for the name of the undefined reference, for this example its "WSACleanup". Usually one of the first links is the SDK documentation, like [http://msdn.microsoft.com/en-us/library/windows/desktop/ms741549%28v=vs.85%29.aspx this from MSDN for WSACleanup]. You'll find there a lot useful information, including what libraries you need to link against, as for the exsample:
'''Requirements'''
* Minimum supported client: Windows 2000 Professional
* Minimum supported server: Windows 2000 Server
* Header: '''Winsock2.h'''
* Library: '''Ws2_32'''.lib
* DLL: '''Ws2_32.dll'''
The header file '''Winsock2.h''' you need to include in your sources. Most likely you have done that already because otherwise you would have gotten a compiler error unable to find the function declaration. The library you need to link against, you can remove any prefix like "lib" and the file extension like ".lib", ".a" or ".so" - so just type "'''Ws2_32'''" in the linker options. Also make sure you have added the path to that library in the linker include path's options, otherwise the linker will complain that it cannot find that library you want to link against. You also know, that you should distribute '''Ws2_32.dll''' for the runtime version of you app, luckily this one usually ships with Windows anyways, so no need to do something here.

==== Q: My build fails in the compile/link/run step with a ''Permission denied'' error? ====

'''A:''' There are several possible causes for this:

# The output directory does not have read/write access.
#* Either change control settings on the output directory, or move the project to different location.
# A previous instance of the executable failed to terminate properly.
#* Open your system's equivalent of Process/Task Manager, search the list for the name of the executable Code::Blocks is trying to output, and terminate it.
#* Logging off or rebooting will achieve the same effect.
# The executable is open.
#* If the executable is open in a hex-editor or actively being run, close it.
# Security software is interfering.
#* The target file is locked while an antivirus programming is scanning it; either wait a few seconds for the antivirus scan to finish, set an exception in the antivirus settings, or (temporarily) disable the antivirus program.
#* Firewalls with very strict settings sometimes block execution; try reducing the firewall's settings or adding an exception.
#* Switching security software may have left traces behind that are interfering; hunt down the remnants of the old antivirus/firewall software and remove them.
# The file/library cannot be found.
#* Double check all of the compiler and linker [[FAQ-Compiling (general)#Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist?|search directories]] (including any [[Global compiler variables|variables]] they may be using) are properly setup.
# Code::Blocks was improperly installed.
#* Mixing binaries from a stable release and a nightly build (or even two different nightly builds) is highly likely to cause a slew of problems; [[Installing Code::Blocks|reinstall Code::Blocks]] in an empty directory.
# Multiple installed compilers are interfering with each other.
#* If they are not required to keep, completely remove all but the most used compiler.
#* If several compilers are required, ensure that '''none''' of them are in the ''system'' path (this is so that Code::Blocks will be able to manage all paths).
#* Also, do not place any compilers in their default installation path (for example <tt>C:\MinGW</tt>), as some compilers are hard-coded to look for headers in a default path ''before'' searching their own respective directories.
# On windows 7, the service "Application Experience" is not running [http://stackoverflow.com/questions/7655471/ld-exe-cannot-open-output-file-permission-denied#answer-7904469 as explained on stackoverflow].
See also: [/index.php/topic,15047.0.html Permission denied forums discussion]

==== Q: My build fails to link due to ''multiple definition of xyz'' errors? ====

'''A:''' GCC 4.6.1 mingw target (Windows) is known to occasionally (and erroneously) report this if link-time optimization (<tt>-flto</tt>) is used.

First, of course, check that no token has been defined multiple times. If the source code is clean, and yet the errors persist, adding linker switch (''Project->Build options...->Linker settings (tab)'')
-Wl,--allow-multiple-definition
will enable the code to link.

See also: [http://sourceware.org/bugzilla/show_bug.cgi?id=12762 Bug 12762]

==== Q: How can I change the language of the compiler (gcc) output to english? ====

'''A:''' Codeblocks 12.11 or higher: Settings->Environment->Environment Variables. Add "LC_ALL" with value "C". ->Set Now -> Ok

Since a few releases gcc is localized. This can make difficult to find (google ;) ) solutions for specific problems. With this setting the output is again in english.

----

Return to '''[[FAQ]]'''.