Code::Blocks - User contributions [en]

Linking the plugin to a Nightly Build

2008-09-12T11:46:51Z

Techtonik: + some screens

[[Category:Plugin development]]
This article describes how to assemble your plugin to work with officially released Code::Blocks distribution (either nightly or not) on Windows. It's accomplished by linking your plugin against the DLL's shipped with Code::Blocks.

=Introduction=
Is useful to know how to compile Code::Blocks sources from scratch to link with our plugin, but when we want to share it with the community then we need to link it against the latest nightly build or final release of Code::Blocks. This is a simple procedure that many people don't know at first. Enjoy :)

=Procedure=

====Step One - Get Binaries ====
Download and install version of Code::Blocks you would like to link your plugin with. You may choose either official release available from https://www.codeblocks.org/downloads/5 or latest nightly from this forum - /index.php/board,20.0.html

====Step Two - Get Sources ====
To ensure your plugin will run smoothly with chosen C::B version you need headers and libraries of this version as well as headers and libraries for wxWidgets library used by this Code::Blocks.

Headers and libraries alone constitute SDK. In CB case headers are distributed with sources, libraries come with CB or can be recompiled from source if needed. Get sources for your required version of Code::Blocks from [https://www.codeblocks.org/downloads/7 SVN] if you haven't done so already.

wxWidgets libraries need to be [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#Compile_wxWidgets_in_Unicode_mode compiled] (or configured) or else you will most probably get "wx/setup.h: No such file or directory" message. Get version used to build your C::B at http://wxwidgets.org

====Step Three - Build Plugin ====
Try to compile the plugin after building wxWidgets. It is ok if you got a message "cannot find -lcodeblocks" from ld.exe It means that codeblocks library for linking plugin is missing, because library paths were not setup correctly. Next step will fix this.

====Step Four - Link Everything Together ====

After having your plugin compiled (or up and running if you prefer) you will need to edit the project build options and add the directory where your official release or nightly is residing to the linker. Project -> Build Options... -> Search directories -> Linker

[[Image:05_search_directories.png|none]]

Then add names of the needed libraries to the linker to assemble the plugin. These are wxmsw28u_gcc_cb.dll and codeblocks.dll. You don't need to write the .dll extension or the lib prefix (if present) so they will look like this on the linker options:

*codeblocks
*wxmsw28u_gcc_cb

[[Image:05_linker_settings.png|none]]
<br clear="all" />

====Step Five - Package ====
Wrap your plugin in .cbplugin archive as described in [[Managing Plug-in Resources]] page.

=Conclusion=
You should now be able to compile the plugin and load it to the current nightly without the symbols error. A problem that many developers confront after compiling the plugin with a compilation that differs from the official one.

Good Luck!

File:05 search directories.png

2008-09-12T11:45:33Z

Techtonik:

File:05 linker settings.png

2008-09-12T11:32:21Z

Techtonik:

Linking the plugin to a Nightly Build

2008-09-12T11:13:58Z

Techtonik: /* Procedure */ + expand with comments

[[Category:Plugin development]]
'''Work in Progress!!!'''<br /><br />
This article describes how to assemble your plugin to work with officially released Code::Blocks distribution (either nightly or not) on Windows. It's accomplished by linking your plugin against the DLL's shipped with Code::Blocks.

=Introduction=
Is useful to know how to compile Code::Blocks sources from scratch to link with our plugin, but when we want to share it with the community then we need to link it against the latest nightly build or final release of Code::Blocks. This is a simple procedure that many people don't know at first. Enjoy :)

=Procedure=

====Step One - Get Binaries ====
Download and install version of Code::Blocks you would like to link your plugin with. You may choose either official release available from https://www.codeblocks.org/downloads/5 or latest nightly from this forum - /index.php/board,20.0.html

====Step Two - Get Sources ====
To ensure your plugin will run smoothly with chosen C::B version you need headers and libraries of this version as well as headers and libraries for wxWidgets library used by this Code::Blocks.

Headers and libraries alone constitute SDK. In CB case headers are distributed with sources, libraries come with CB or can be recompiled from source if needed. Get sources for your required version of Code::Blocks from [https://www.codeblocks.org/downloads/7 SVN] if you haven't done so already.

wxWidgets libraries need to be [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#Compile_wxWidgets_in_Unicode_mode compiled] (or configured) or else you will most probably get "wx/setup.h: No such file or directory" message. Get version used to build your C::B at http://wxwidgets.org

====Step Three - Build Plugin ====
Try to compile the plugin after building wxWidgets. It is ok if you got a message "cannot find -lcodeblocks" from ld.exe It means that codeblocks library for linking plugin is missing, because library paths were not setup correctly. Next step will fix this.

====Step Four - Link Everything Together ====
After having your plugin compiled (or up and running if you prefer) you will need to edit the project build options and add the directory where your official release or nightly is residing to the linker. Project -> Build Options... -> Search directories -> Linker

Then add the needed libraries to the linker to compile the plugin. These are wxmsw28u_gcc_cb.dll and codeblocks.dll. You don't need to write the .dll extension or the lib word (if present) so they will look like this on the linker options:

*codeblocks
*wxmsw28u_gcc_cb

====Step Five - Package ====
Wrap your plugin in .cbplugin archive as described in [[Managing Plug-in Resources]] page. That's all.

=Conclusion=
You should now be able to compile the plugin and load it to the current nightly without the symbols error. A problem that many developers confront after compiling the plugin with a compilation that differs from the official one.

This was a quick howto so is maybe missing info, I will update it later as add some images. Good Luck!

Linking the plugin to a Nightly Build

2008-09-12T08:19:20Z

Techtonik: /* Step One */ + SDK is merged with CB sources

Linking the plugin to a Nightly Build

2008-09-10T16:20:58Z

Techtonik: reworded introduction: TODO steps 2 and 3 with screens

Managing Plug-in Resources

2008-09-01T12:56:59Z

Techtonik: /* Prerequisites */

[[Category:Plugin development]]

==Prerequisites==

You may want to read the tutorial [[Creating a simple "Hello_World" plugin]] before starting this tutorial

This tutorial assumes you have a working version of Code::Blocks installed and some knowledge of how to deal with projects, in particular how to compile them. To use the Code::Blocks SDK you must also have a working version of wxWidgets installed. For more information see
[[Compiling wxWidgets 2.8.6 to develop Code::Blocks (MSW)|Compiling wxWidgets 2.8.6 to develop Code::Blocks]]

''' REVISE THIS...'''To develop Code::Blocks plugins you will also need a copy of the Code::Blocks SDK, which can be found on the Code::Blocks [https://www.codeblocks.org/downloads.shtml download page]. Install this to somewhere sensible that you will remember later on. Personally I keep the SDK in a folder called CodeBlocks\sdk (which contains the include/ and lib/ from in the zip). This means that the header files refered to in the tutorial would be found under ''Codeblocks\sdk\include'', so ''cbPlugin.h'' is ''Codeblocks\sdk\include\cbPlugin.h'' for example.

==Overview==

This tutorial will show you how to package and access Resources (toolbars, forms, dialogs and bitmaps) and other static data in your plug-in.

==Plugin File Structure==

Every plugin in its undeployed state is simply a nested file structure in compressed archive form (zip). The typical structure of a plugin (which we'll call "myplugin" in this tutorial) is as follows:

+myplugin.cbplugin
+myplugin.dll
+myplugin.png
+myplugin-off.png
+myplugin.zip
+manifest.xml
+XML Based Resources
+Extra Files

The essential components of this structure are created automatically when you build a plugin project created with the CB Plugin Wizard. What are these files?

* '''myplugin.cbplugin''': this is simply a zip archive containing all of the plugins files and resources. It is given a cbplugin extension to make it easy for the Code::Blocks plugin installer to recognize.
* '''myplugin.dll''' (or _libmy-plugin.so_ on linux): the compiled shared library containing you plugins executable content
* '''myplugin.png''': this is an 80x80 bitmap displayed by default in the image list in "Environment Settings" when the plugins configuration has the focus (for plugins that have a configuaration panel). ''This file is optional''
* '''myplugin-off.png''': this is an 80x80 bitmap displayed by default in the image list in "Environment Settings" when the plugins configuration does not have the focus(for plugins that have a configuaration panel). ''This file is optional''
* '''myplugin.zip''': a compressed archive file containing the file manifest.xml and resources
* '''manifest.xml''': a file containing information about the plugin. (see the [[Creating a simple "Hello_World" plugin]])
* '''XML Based Resources''': One or more wxWidgets XML based resource files (XRC files) such as toolbars, dialogs and forms. You can also place binary bitmap images in this archive if they are accompanied by an XRC descriptor file. ''XML Resources are optional''
* '''Extra Files''': Place other static, non-XRC resources here. You should keep these files to a mimimum because they are copied to the shared space of the users Code::Blocks installation. ''These files are optional''

In this tutorial we will discuss the use of XML Based Resources and Extra Files

===Tutorial: Creating a New Plugin and Examining Its Structure===

We will use this tutorial to demonstrate concepts associated with plugin resource management throughout the article. Before you start, make sure you have installed wxWidgets, compiled a recent nightly build or have a current Code::Blocks release with a copy of the SDK installed. (TODO: Links to relevant instructions)

1. Select file -> new -> project

2. Select projects, code::blocks plugin, then click "GO"

3. Project title "Plugin_XRC_Example", then click "Next"

4. Plugin Name "XRC_Example", Plugin Type "Generic", Check "Creates Menu Entries", then click "Next"

5. Click Next/Finish on the remaining items (I'm assuming you will use wxWidgets 2.8.X, the GCC compiler)

6. You should now have a new plugin project. Compile and make sure it works correctly. Specifically you should see in the build log window:

Running target post-build steps
zip -j9 XRC_Example.zip manifest.xml
adding: manifest.xml (188 bytes security) (deflated 52%)
zip -j9 XRC_Example.cbplugin XRC_Example.dll XRC_Example.zip
adding: XRC_Example.dll
(188 bytes security) (deflated 83%)
adding: XRC_Example.zip (188 bytes security) (deflated 8%)

As you can see, Code::Blocks automatically creates a minimal XRC_Example.cbplugin file for you. If you have a GUI Archive tool such as 7-zip or WinZIP, you should be able to browse to your project, open XRC_Example.cbplugin with your archive tool and confirm it conforms to the minimal structure. In the remainder of the tutorial we will add additional resources to this simple plugin.

==Working with XML Based wxWidgets Resources==

===What is XRC and why would I want to use it?===

XRC is a standardized way of describing wxWidgets forms (including panels and dialogs), menus, toolbars and bitmap lists in a human readable XML format. A simple example is the XRC file for the compiler toolbar (found in the CB source at: <tt>src/plugins/compilergcc/resources/compiler_toolbar.xrc</tt>):

<?xml version="1.0" ?>
<resource>
<object class="wxToolBarAddOn" name="compiler_toolbar">
<object class="tool" name="idCompilerMenuCompile">
<tooltip>Build</tooltip>
<longhelp>Build the active project</longhelp>
<bitmap>images/compile.png</bitmap>
</object>
<object class="tool" name="idCompilerMenuRun">
<tooltip>Run</tooltip>
<longhelp>Run the active project</longhelp>
<bitmap>images/run.png</bitmap>
</object>
...
...
...
<object class="separator"/>
<object class="wxStaticText" name="idToolTargetLabel">
<label>Build target:</label>
</object>
<object class="wxChoice" name="idToolTarget">
<content/>
<size>160,-1</size>
</object>
</object>
</resource>

As you can see, this file specifies that it is an XML file in the first line, that it contains resources denoted by the <resource> and </resource> tags in the second and last lines respectively. Within the resource tags, the XRC file specifies a sequence of objects laid out in a hierarchical structure. Each object belongs to a class (specified with the attribute class, and corresponding to a wxWidgets form or control class) and has a unique identifier. In this file there is only one base level object, named "compiler_toolbar" derived from the Code::Blocks class "wxToolBarAddOn", a Code::Blocks extension of the wxWidgets type "wxToolbar". Note that base level objects are restricted to a handful of types, namely:

* Frames
* Dialogs
* Panels
* MenuBars
* Menus
* Toolbars
* Bitmaps
* Icons

In contrast, the objects owned by base level objects run the entire gamut of wxWidgets controls. In the case of the Compiler toolbar, it owns a sequence of standard bitmap toolbar buttons (idCompilerMenuCompile, idCompilerMenuRun etc), a static text control (idToolTargetLabel) and a choice box (idToolTarget). Panels and dialogs will also contain layout objects derived from classes such as <tt>wxSizer</tt>. In addition to the basic class and name attributes, base and lower level objects in an XRC file will specify additional detail about their structure, such as associated images, sizing and layout (basically giving you the same control over the intialization of an object as if you had executed its constructor in your c++ code).

While somewhat verbose, the XML-based XRC file is far more readable than the terse 50+ lines of equivalent C++ code required to create a toolbar, load its images and assign unique ids. XRC files can be loaded and displayed in a few lines of C++. You still retain the ability to access individual controls loaded from the XRC. We'll deal with these issues shortly.

In addition to its readability, XRC offers the advantage of separating form layout (contained in the XRC file) from form logic (coded into your plugin binary). XRC files are loaded each time you start your plugin, which allows you to make changes to the layout of a form without the need to recompile you plugin.

A definitive description of the XRC syntax is described in the wxWidgets wiki at http://www.wxwidgets.org/wiki/index.php/Using_XML_Resources_with_XRC

===Creating XRC files for use in your plugin===

While you can create your own XRC widget layouts by coding the XML in a simple text editor, it is far easier to use a GUI program to create the layout, XML and accompanying C++ code for you. For example, in Code::Blocks you can use the wxSmith plugin (TODO: link) to design your XRC forms and accompanying C++ classes for your plugin. wxFormBuilder (TODO: link) is another alternative.

====Tutorial Continued: Creation of an XRC Panel using wxSmith====

Now we will add a simple XRC-based panel to our plugin using wxSmith:

7. Select wxSmith -> Add panel

8. Use the class name "TaskPanel", check "XRC file", then press OK

9. The management window should now show a "Resources" tab and open a new editor window displaying an empty panel with a toolbar containing widgets below it. (TODO: screen shot)

10. From the widget toolbar, select "Layout" tab, then choose wxBoxSizer and click anywhere in the panel. After you click the panel, it will be resized and you should see a border indicating the presence of a sizer. A Box Sizer is a container for widgets, that lays out the widgets in either a horizontal or vertical layout. (TODO: Link to more info on sizers)

11. From the widget toolbar, select "Standard" tab, then choose wxComboBox and click within the sizer. This adds a ComboBox to the sizer

12. Choose wxTextCtrl and click within the sizer. This adds a Text Control to the sizer (it should be located to the right of the combo box)

13. In the resources tab, click on the wxBoxSizer entry in the widget tree. Properties for the Box Sizer should appear in the bottom half of this tab. Change the orientation property to wxVertical.

14. Now click on the wxTextCtrl entry in the widget tree, open the styles property and check "wxTE_MULTILINE". Also check the "Expand" property, which will expand the control to the full width of the panel.

15. Now click on the wxComboBox entry in the widget tree, change the proportion property to zero. This tells the Box Sizer to only expand the Text Control when the size of the panel changes (the Text Control has a positive proportion). Also check the "Expand" property.

16. Save your work. This will save the panel and create the XRC file "TaskPanel.xrc" and C++ header and sources TaskPanel.cpp/TaskPanel.h. You should now have a panel that looks like the following screen shot:

(TODO: Add screen shot)

17. Close the wxSmith editor.

===Working with XRC files in your plugin===

After you have created your XRC file defining your objects, you will want to be able to use them in your plugin. To do this, we generally want to create a new C++ class associated with each resource object. In the constructor of each class we will use wxWidgets resource loader to find, load and create an instance of the object. Optionally we will associate the widgets contained within each object with member variables.

wxWidgets library offers a global XRC manager <tt>wxXmlResource</tt> and a number of convenience functions and macros for working with objects defined in XRC files. In general, for each object defined in XRC you will:

* Define a C++ class that corresponds to the object (e.g. Create a class derived from wxDialog for each Dialog defined in the XRC)
* Call wxXmlResource::Get()->LoadXXXX(this, parent, "object_name", [class_derived_from]) in the constructor of your class (where LoadXXXX will be one of LoadBitmap, LoadDialog, LoadPanel, LoadObject etc)
* Access controls of the object using the macro: XRCCTRL(this, "control_name", controlclass) (or alternatively using XRCID and the FindWindow(XRCID("control_name")) method (see the next part of the tutorial below))
* Use the XRCID("control_name") macro to refer to an object's controls in Event tables. For example: EVT_TEXT(XRCID("ID_TEXTCTRL1"), TaskPanel::TextChange)

TODO: wxWidgets links for more info

==== Tutorial Continued: Associate XRC Objects and Controls with C++ Classes and Members ====
In this part of the tutorial, we will see how wxSmith maps XRC objects to C++ Classes.

18. It will be helpful to add the XRC file to the project (if it wasn't added already). Select project -> add file and select "TaskPanel.xrc"

19. From the management pane, choose "Projects" tab, expand the resources folder of the project and you should see the newly added XRC file

20. Let's take a look at the contents of the XRC file. Right click on the XRC file, select open with, internal editor. The contents of the file should look something like:

<?xml version="1.0" encoding="utf-8" ?>
<resource xmlns="http://www.wxwidgets.org/wxxrc">
<object class="wxPanel" name="TaskPanel">
<object class="wxBoxSizer">
<orient>wxVERTICAL</orient>
<object class="sizeritem">
<object class="wxComboBox" name="ID_COMBOBOX1" />
<flag>wxALL|wxEXPAND|wxALIGN_CENTER_HORIZONTAL|wxALIGN_CENTER_VERTICAL</flag>
<border>5</border>
</object>
<object class="sizeritem">
<object class="wxTextCtrl" name="ID_TEXTCTRL1">
<value>Text</value>
<style>wxTE_MULTILINE</style>
</object>
<flag>wxALL|wxEXPAND|wxALIGN_CENTER_HORIZONTAL|wxALIGN_CENTER_VERTICAL</flag>
<border>5</border>
<option>1</option>
</object>
</object>
</object>
</resource>

We see our base object is a wxPanel called TaskPanel and it contains a box sizer with two widgets "ID_COMBOBOX1" and "ID_TEXTCTRL1". Close the XRC file.

21. wxSmith will already have added TaskPanel.cpp and TaskPanel.h to your project.
TaskPanel.h defines a minimal TaskPanel class (I've taken the liberty of trimming some of the file contents) and defines pointers to the two controls in the Panel

class TaskPanel: public wxPanel
{
public:
TaskPanel(wxWindow* parent);
virtual ~TaskPanel();
//(*Declarations(TaskPanel)
wxComboBox* ComboBox1;
wxTextCtrl* TextCtrl1;
//*)
DECLARE_EVENT_TABLE()
};

Open TaskPanel.cpp and you should see the following implementations:

BEGIN_EVENT_TABLE(TaskPanel,wxPanel)
//(*EventTable(TaskPanel)
//*)
END_EVENT_TABLE()

TaskPanel::TaskPanel(wxWindow* parent)
{
//(*Initialize(TaskPanel)
wxXmlResource::Get()->LoadObject(this,parent,_T("TaskPanel"),_T("wxPanel"));
ComboBox1 = (wxComboBox*)FindWindow(XRCID("ID_COMBOBOX1"));
TextCtrl1 = (wxTextCtrl*)FindWindow(XRCID("ID_TEXTCTRL1"));
//*)
}

TaskPanel::~TaskPanel()
{
//(*Destroy(TaskPanel)
//*)
}

The good news is wxSmith takes care of the hard work involved in creating a class corresponding to your XML object and its controls. This is all done in the TaskPanel constructor. The line

wxXmlResource::Get()->LoadObject(this,parent,_T("TaskPanel"),_T("wxPanel"));

will search among the codeblocks resources (including all plugin resources) for an XRC object named <tt>TaskPanel</tt> and create an instance of it derived from the wxPanel class. The call to LoadObject is used in place of a call to the wxPanel constructor ('''make sure that if you edit this code you do not call the wxPanel constructor. Moreover, do not edit inside the comment blocks //(* and //*) as these are wxSmith controlled portions of your code and will be overwritten each time you save your GUI Layouts in the wxSmith editor''')
The next two lines

ComboBox1 = (wxComboBox*)FindWindow(XRCID("ID_COMBOBOX1"));
TextCtrl1 = (wxTextCtrl*)FindWindow(XRCID("ID_TEXTCTRL1"));

create member pointers to the Combo Box and Text Control widgets, making it easy for you to refer to those widgets in your programming logic. Notice that there is no need to release anything in the TaskPanel class destructor.

===="But what if I don't want to use wxSmith?"====

No problem. Other GUI builders can also create the necessary code to define and instantiate your XRC objects as C++ Classes, which should closely correspond to the code generated by wxSmith. You will need to manually add the XRC objects and C++ files that were created by these builders to your plugin project.

If you don't want to use automatically generated code at all, that's fine too, but you will then need to create the Class by hand using appropriate calls to LoadDialog, LoadPanel, LoadObject and friends.

====Tutorial Continued: Programming your XRC objects and controls====

CONTENT COMING SOON

====Tutorial Continued: Adding the XRC file to your cbplugin bundle====

CONTENT COMING SOON

==Working with Extra Files==

MORE CONTENT COMING SOON...

==Further Information==

It is essential to learn how wxWidgets works if you seriously plan on working on plugins, since most of Code::Blocks depends on it, and you will find it easier to add and manipulate components if you have a firm grasp of its principles. More information on this can be found in the wxWidgets [http://www.wxwidgets.org/docs.htm documentation]. Another good place to learn from is the source code from the existing Code::Blocks plugins, which can be downloaded along with the rest of the Code::Blocks source code from the [https://www.codeblocks.org/downloads.shtml download page].

Installing Code::Blocks from source on Windows

2008-08-28T06:38:19Z

Techtonik: /* Compile Code::Blocks */

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

Since November 2007 MinGW-GCC 4.2.1

=== wxWidgets ===

[http://wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 19 July 2008 wxWidgets 2.8.8 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4<br/>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 preferrable to the manual parsing of the entries file that is used as fallback.

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 builtin fallback mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format.<br>
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the commandline tool into <tt>PATH</tt> for a successful build.<br>
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [https://wiki.codeblocks.org/index.php?title=Mingw#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...".

In the top box, enter svn://svn.berlios.de/codeblocks/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 svn://svn.berlios.de/codeblocks/trunk

== Building ==

=== 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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc USE_XRC=1 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.

''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 ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilaton 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).

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.
The stripped ("production") executable is found in <tt>output</tt> 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.<br>
Congratulations, you own a freshly built version of Code::Blocks!

For future updates, go into the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect).<br/>
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).<br/>
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.<br/>
''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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc USE_XRC=1 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 compilaton 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 [http://en.wikipedia.org/wiki/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 nighty 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.

Installing Code::Blocks from source on Windows

2008-08-28T06:37:50Z

Techtonik: /* Compile Code::Blocks */

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

Since November 2007 MinGW-GCC 4.2.1

=== wxWidgets ===

[http://wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 19 July 2008 wxWidgets 2.8.8 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4<br/>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 preferrable to the manual parsing of the entries file that is used as fallback.

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 builtin fallback mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format.<br>
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the commandline tool into <tt>PATH</tt> for a successful build.<br>
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [https://wiki.codeblocks.org/index.php?title=Mingw#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...".

In the top box, enter svn://svn.berlios.de/codeblocks/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 svn://svn.berlios.de/codeblocks/trunk

== Building ==

=== 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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc USE_XRC=1 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.

''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 ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilaton 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).

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.
The stripped ("production") executable is found in <tt>output</tt> 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.<br>
Congratulations, you own a freshly built version of Code::Blocks!

For future updates, go into the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect).<br/>
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).<br/>
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.<br/>
''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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc USE_XRC=1 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 compilaton has finished, copy wxmsw26u_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 [http://en.wikipedia.org/wiki/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 nighty 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.

Installing Code::Blocks from source on Windows

2008-08-28T06:35:41Z

Techtonik: /* wxWidgets */ - old wxWidgets reference

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

Since November 2007 MinGW-GCC 4.2.1

=== wxWidgets ===

[http://wxwidgets.org/ wxWidgets.org]

Code::Blocks uses
* since 19 July 2008 wxWidgets 2.8.8 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

* since 28 November 2007 wxWidgets 2.8.7 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since November 2007 wxWidgets 2.8.6 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since May 2007 wxWidgets 2.8.4<br/>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 preferrable to the manual parsing of the entries file that is used as fallback.

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 builtin fallback mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format.<br>
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the commandline tool into <tt>PATH</tt> for a successful build.<br>
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [https://wiki.codeblocks.org/index.php?title=Mingw#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...".

In the top box, enter svn://svn.berlios.de/codeblocks/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 svn://svn.berlios.de/codeblocks/trunk

== Building ==

=== 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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc USE_XRC=1 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.

''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 ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilaton has finished, copy <tt>lib\gcc_dll\wxmsw26u_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).

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.
The stripped ("production") executable is found in <tt>output</tt> 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.<br>
Congratulations, you own a freshly built version of Code::Blocks!

For future updates, go into the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect).<br/>
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).<br/>
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.<br/>
''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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc USE_XRC=1 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 compilaton has finished, copy wxmsw26u_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 [http://en.wikipedia.org/wiki/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 nighty 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.

Installing Code::Blocks from source on Windows

2008-08-25T12:58:16Z

Techtonik: /* Prerequisites */ RC2 is older than 8.02

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

Since November 2007 MinGW-GCC 4.2.1

=== wxWidgets ===

[http://wxwidgets.org/ wxWidgets.org]

Code::Blocks officially supports wxWidgets 2.6.3 (although any 2.6+ version probably works).<br/>
Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.6.3-1.zip wxMSW-2.6.3-1.zip].

Code::Blocks uses
* since May 2007 wxWidgets 2.8.4<br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

* since November 2007 wxWidgets 2.8.6 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.6.zip wxMSW-2.8.6.zip]

* since 28 November 2007 wxWidgets 2.8.7 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.7.zip wxMSW-2.8.7.zip]

* since 19 July 2008 wxWidgets 2.8.8 <br/>Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.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 preferrable to the manual parsing of the entries file that is used as fallback.

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 builtin fallback mechanism in <tt>autorevision</tt> has been updated to the new 1.4 format and will no longer work with the old format.<br>
Therefore, if you use a Subversion client from the 1.0-1.3 line, you ''must'' put the commandline tool into <tt>PATH</tt> for a successful build.<br>
If you use Subversion 1.4, then it is good practice nevertheless, but you can do without, too.

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [https://wiki.codeblocks.org/index.php?title=Mingw#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...".

In the top box, enter svn://svn.berlios.de/codeblocks/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 svn://svn.berlios.de/codeblocks/trunk

== Building ==

=== 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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc USE_XRC=1 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.

''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 ====

Open the project CodeBlocks.cbp. You will be prompted to define the global variable $(#wx). Enter the location where you unpacked wxWidgets.

Hit the blue gear and lean back. Compilation may take 3-5 minutes, depending on the speed of your computer.

After the compilaton has finished, copy <tt>lib\gcc_dll\wxmsw26u_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).

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.
The stripped ("production") executable is found in <tt>output</tt> 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.<br>
Congratulations, you own a freshly built version of Code::Blocks!

For future updates, go into the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect).<br/>
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).<br/>
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.<br/>
''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 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc USE_XRC=1 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 compilaton has finished, copy wxmsw26u_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 [http://en.wikipedia.org/wiki/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 nighty 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.

Developer documentation

2008-06-29T18:58:21Z

Techtonik: + direct links to source repository

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
{{Layout_box2|1=
'''Code repository'''<br/>
* Web-interface by ViewVC: http://svn.berlios.de/viewcvs/codeblocks/trunk/<br/>
* Subversion URL: <nowiki>http://svn.berlios.de/svnroot/repos/codeblocks/trunk</nowiki>
}}

'''Articles for Code::Blocks developers.'''

* '''[http://launchpad.net/products/codeblocks/ Translation]'''
:Code::Blocks uses Launchpad to coordinate translation efforts.

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit to BerliOS (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

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

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''<u>Documentation</u>'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
:Also see http://developer.berlios.de/projects/codeblocks/ (under the downloads section).

== Plug-In development ==

* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]