Code::Blocks - User contributions [en]

Installing Code::Blocks from source on Windows

2025-09-25T07:25:08Z

Ollydbg: the new cb_cpp_std global variable

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Overview ==

=== Self-Hosting ===

The build process described on this page is a kind of "[https://en.wikipedia.org/wiki/Self-hosting Self-Hosting]." You use an existing version of Code::Blocks to compile the next version. When that version is proven to function correctly it is used to compile the next, and so on.

== Prerequisites ==

=== Bootstrap Code::Blocks ===

A properly working Code::Blocks is required to compile the next SVN version. A [[Installing_Code::Blocks_nightly_build_on_Windows | Nightly Build]] is a good candidate to use. It will be paired with a MinGW compiler in the next item.

=== MinGW Compiler ===

At the present time, Code::Blocks only compiles successfully with a MinGW compiler toolchain on Windows. You will need a complete, working [[MinGW installation]].

=== wxWidgets ===

wxWidgets is the "[https://en.wikipedia.org/wiki/Graphical_user_interface graphical user interface toolkit]" that Code::Blocks is built on top of.

For information about wxWidgets, see their official site ➡ [https://www.wxwidgets.org/ wxWidgets.org]

You can use any version of wxWidgets >= 3.1.3, but the latest stable release will work better. At this moment it is wx3.2.4, download it in [https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.4/wxWidgets-3.2.4.zip zip] or [https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.4/wxWidgets-3.2.4.7z 7z] format.

=== Utilities ===

ZIP and SVN functions are not required to run Code::Blocks but ZIP is required to build it and a SVN client is strongly recommended but not absolutely necessary.

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. Some toolchains include it, if yours does not then the recommended one can be found on the [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

Make sure <tt>zip.exe</tt> is in your [https://en.wikipedia.org/wiki/PATH_(variable) PATH] as it is used both during the compilation in your current version of Code::Blocks and also by the <tt>update.bat</tt> script.

==== SVN ====

It is recommended, but not required, that you install a SVN client. If you are a absolute beginner in programming skip this part and go to [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_Sources Code::Blocks Sources]. An example would be [http://tortoisesvn.net/downloads TortoiseSVN] if you would like an all-in-one SVN solution. ''TortoiseSVN'' includes optional command-line client tools, which you should install as they provide a command-line SVN client. Choosing to install the command-line client tools will automatically add them to your PATH. However, if you do not wish to have the ''TortoiseSVN'' Explorer extensions in your right-click context menu or just don't feel a need for a graphical client in particular then you can use another: [http://subversion.apache.org/packages.html SVN command-line client] equally well. Just make sure that whichever client you install has its executable in your PATH.

The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn.exe</tt> binary if it is available (in your PATH) and also uses the SVN meta-data generated by a SVN checkout. If you have both a SVN command-line client in your PATH, and the meta-data, the resulting build of Code::Blocks will show the revision on the loading splash window, the Start here page, and in the About dialog (shown here in the About dialog, indicated by the red arrow):

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

If you don't wish to use a SVN utility, you can download a snapshot from [https://sourceforge.net/p/codeblocks/code/HEAD/tree/ here] clicking on "Download Snapshot". Now you can go on to the [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Build_wxWidgets_Support_Library next section]

The last item is to acquire the Code::Blocks source code. Follow the appropriate instructions for whether you have a graphical or command line SVN client.

==== TortoiseSVN ====

If you prefer a graphical SVN client you can use ''TortoiseSVN'' - make a directory where you want to store the sources, right-click on the directory, and select "'''SVN Checkout'''," and as shown you will get a checkout dialog:

[[Image:Tor_SVN.png]]

In the URL of the repository box, enter <tt><nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki></tt> and verify the checkout directory is where you would like it to be. The example given here is "''C:\cb_svn''" - once satisfied with the arguments click the OK button to process the checkout.

==== Command-Line SVN ====

If you do not wish to use a graphical SVN client then a command-line equivalent to the above is to use the <tt>svn</tt> command - open a command prompt, make a directory, change into that directory, and then checkout a copy of the repository:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Build wxWidgets Support Library ==

=== Configure Build Options ===

Please note that support has been removed for wxWidgets < 3.1.3 because it lacks Direct2D support.

Unpack the wxWidgets zip file to a directory of your choice, open a command-line prompt, and navigate to the directory <tt>build/msw</tt> inside the wxWidgets directory. In this directory there is a text file named <tt>config.gcc</tt> which you can edit with notepad to control the build options. There are two lines to note, <tt>CFLAGS ?=</tt> and <tt>CXXFLAGS ?=</tt>. The options given here will go in either or both of those lines.

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

Some versions of the MinGW Windows Runtime Library will cause an error during compilation. See [https://sourceforge.net/p/tdm-gcc/bugs/269/ Bug #269]. If this is the case with the toolchain you are using then try this workaround:

-D_WIN32_IE=0x0603

To silence warnings that can significantly slow down the compilation process:

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

All of these options apply to both <tt>CFLAGS</tt> and <tt>CXXFLAGS</tt> so the two lines containing all the options would look like this:

CFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

CXXFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

=== Build wxWidgets Library ===

First you must edit include\wx\msw\setup.h; locate a line containing

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

If you can not find setup.h please copy setup0.h to setup.h

At a command-line, inside the <tt>build/msw</tt> directory, use the following commands to build wxWidgets:

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

or, if you want to build using multiple threads:

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

If your compiler toolchain is not in your PATH (it should be on a development machine), then put it in your path first:

set PATH=X:\path\to\toolchain\bin;%PATH%

Where "'''''X'''''" is the drive letter, and "'''''\path\to\toolchain\bin'''''" is where your toolchain is located.

If your compilation fails for any reason then make sure to run the ''clean'' line before trying again.

== Build Code::Blocks ==

=== Self-Hosting ===

All the preparation work is now complete and we can actually perform a self-hosting compile of the next Code::Blocks with our current one. If you do not make any changes to your non-Code::Blocks prepared items, like your MinGW compiler version, and the wxWidgets library, then when building subsequent SVN versions of Code::Blocks you can keep all the preparation from a previous build and start with this section. When restarting from this point you can refresh your current Code::Blocks local source with ''TortoiseSVN''. Right-click on your local source directory, go to "TortoiseSVN" in the context-menu, then choose "update to revision." The "head" is always the latest version. If you are using a command-line SVN, just run <tt>svn update</tt> in the root of your local source directory.

=== Open project ===
This guide uses wx3.1, you can use wx3.2 just replacing 31 with 32 where needed.

Open the project file '''CodeBlocks_wx31.cbp''' (or '''CodeBlocks_wx31_64.cbp''' for 64-bit mode).
*You will be prompted to define the global variable $(#wx31). In the base field, enter the root of the location where you unpacked wxWidgets.

*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 as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

If you would like to build Code::Blocks against with the wx 3.3.1+ library, you need to set another global variable named '''cb_cpp_std''', and currently, you should set it to '''-std=gnu++11'''

=== Prevent unnecessary warnings ===

Building Code::Blocks against the wxWidgets library will generate an excessive amount of warnings during the compilation. This can significantly impact the time it takes to compile both the main project and the contributors workspace as each warning has to be printed to the build log. To silence these warnings, go to Compiler Settings:

[[Image:Compiler_Settings.png]]

And under the "Compiler settings" tab (red arrow), "Other compiler options" sub-tab (green arrow), enter "<tt>-Wno-unused-local-typedefs</tt>" (blue arrow), and you may also add "<tt>-Wno-deprecated-declarations</tt>" on its own line here too.

[[Image:Unused_Local_Typedefs.png]]

=== Compile project ===
Make sure that "All" is selected as the target (blue arrow), and then click the Build icon (red arrow).

[[Image:Compile_All.png]]

If everything builds correctly your build messages should end with no errors.

[[Image:Build_Log.png]]

=== Copy wxWidgets support DLL ===
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw31u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>devel31</tt> (or <tt>devel31_64</tt> for 64-bit) directory in the Code::Blocks <tt>src</tt> directory. If you are confident enough you can copy it instead to System32 (on 32 bits Windows) or SysWOW64 (on 64 bits Windows).

[[Image:Update_Devel_Output.png]]

The <tt>devel31</tt> directory is created by compiling the Code::Blocks project in Code::Blocks.

=== Generate Production Output ===
Move to the <tt>src</tt> directory) and run <tt>update_31.bat</tt>. This will pack the resource files and copy the executables, libraries, and plugins to the <tt>output_31</tt> directory. It will also create the <tt>output_31</tt> directory if it does not exist. If you are compiling the 64-bit version please call <tt>update_31_64.bat</tt> and use folders <tt>devel_31_64</tt> and <tt>output_31_64</tt>.

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory 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_31</tt> directory.

[[Image:Update_Output.png]]

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) 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 Build menu if you want them all).

The NassiShneiderman plugin has a dependency on the "[http://www.boost.org/ Boost]" library. If you do not wish to use that plugin and therefore not need the library, just right-click on that plugin and choose "close project."

Don't forget to run <tt>update_31.bat</tt> or <tt>update_31_64.bat</tt> again after building the contributed plugins.

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

Copy or move the <tt>output_31</tt> or <tt>output_31_64</tt> directory to where you want Code::Blocks to reside. Then you probably want to rename the directory to something else. You can also optionally right-click on <tt>codeblocks.exe</tt> and choose "Create shortcut" and then rename that shortcut to your liking and move it to another location such as your desktop for easy access.

If you want to run Code::Blocks on a machine without your compiler toolchain being in the PATH then you will likely have to include, in the same directory as the <tt>codeblocks.exe</tt> is fine, support .dll files from your compiler toolchain. The easiest way to determine the required files is to not have your compiler toolchain in your PATH and repeatedly run Code::Blocks and copy over each .dll it says is missing until all have been found.

Developer documentation

2025-02-12T09:26:41Z

Ollydbg: /* Debugging C::B */ distribute separate debug files

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
{{Layout_box2|1=
'''Official Code repository Subversion''' 
* Web-interface by ViewVC: http://sourceforge.net/p/codeblocks/code/log/
* Subversion URL: <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki> or <nowiki>http://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

'''Mirror by Carsten Arnholm''' (Read-only; )
* Web-interface: https://github.com/arnholm/codeblocks_sfmirror
* Git URL: see the above page.

'''Mirror by biplab''' (Read-only; refreshed every 10 minutes. As 2022-09-12, it looks dead.)
* Subversion URL: <nowiki>svn://cb.biplab.in/codeblocks/trunk</nowiki> 
* Web-interface: http://cb.biplab.in/websvn/
* Git URL: git://cb.biplab.in/codeblocks.git
* Web-interface:http://cb.biplab.in/cgit/

'''Mirror by Jens''' (Read-only; refreshed every 10 minutes. As 2022-09-12, it looks dead.)
* Web-interface: http://cgit.jenslody.de/
* Git URL: git://jenslody.de/git/codeblocks
* the above Web-interface link contains many other mirrors such as wxWidgets trunk, git mirror, and git mirror of codeblocks.github

'''Mirror by Obf''' (Read-only; refreshed manually. As 2022-09-12, it looks dead.)
* Web-interface: https://github.com/obfuscated/codeblocks_sf
* Git URL: see the above page.
}}

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

* '''Documentation'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [https://forums.codeblocks.org/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

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

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[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]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [https://forums.codeblocks.org/index.php/topic,16096.msg128152.html#msg128152 Re: Read-only Git, SVN Repo for Code::Blocks], also stahta01 has a nice instruction about how to use git, see [https://forums.codeblocks.org/index.php/topic,19533.msg133422.html#msg133422 Development How to use a Code::Blocks Git Repo].

If you want to create a SVN style patch from git, see: [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530 This forum post].

It's possible to build Code::Blocks through GitHub Actions, see [https://wiki.codeblocks.org/index.php/Building_Code::Blocks_through_GitHub_Actions Building Code::Blocks through GitHub Actions].

== Debugging C::B ==

* When C::B crashes, it will generate a call-stack file "codeblocks.RPT", at the crash point (see [[FAQ-Compiling_(general)#Q: How do I report a compilation problem on the forums?|this]] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface that works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]. You can use the project option plugin to change all the custom variable WX_SUFFIX from "u" to "ud" in the workspace, so that you can build C::B against wx debug library, see discussion here: [https://forums.codeblocks.org/index.php/topic,25959.0.html How to globally set the "custom variables" in the cbp files under a workspace].
* to accelerate the debugging process for many plugins(when GDB load a lot of plugins with debug information, it will be slow), there is a special profile named "debug-plugin", a profile file is just a configure file named "debug-plugin.conf", when you start with this profile, you can exclude other plugins, and only load the plugins you needed, see discussion here: [https://forums.codeblocks.org/index.php/topic,25161.0.html How to exclude the other plugins when debugging]
* if you application or the debugee C::B is built against release version of wxWidgets library, how to debug the wxWidgets symbols, the method is to use the gcc's option "-femit-class-debug-always", see forum discussion here: [https://forums.codeblocks.org/index.php/topic,25731.0.html How to add gcc option "-femit-class-debug-always" to a single cpp file in cbp]
* to catch more debug information on the crash, we can distribute separate debug files, see discussion here: [https://forums.codeblocks.org/index.php/topic,25712.0.html new idea: ship the debug symbols in a separate file when we distribute C::B]

Developer documentation

2025-02-12T08:56:09Z

Ollydbg: /* Debugging C::B */ use the -femit-class-debug-always for debugging

Developer documentation

2025-02-05T09:49:58Z

Ollydbg: /* Debugging C::B */ add some debug tips

Developer documentation

2024-08-20T03:59:33Z

Ollydbg: add new github mirror of our source code

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
{{Layout_box2|1=
'''Official Code repository Subversion''' 
* Web-interface by ViewVC: http://sourceforge.net/p/codeblocks/code/log/
* Subversion URL: <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki> or <nowiki>http://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

'''Mirror by Carsten Arnholm''' (Read-only; )
* Web-interface: https://github.com/arnholm/codeblocks_sfmirror
* Git URL: see the above page.

'''Mirror by biplab''' (Read-only; refreshed every 10 minutes. As 2022-09-12, it looks dead.)
* Subversion URL: <nowiki>svn://cb.biplab.in/codeblocks/trunk</nowiki> 
* Web-interface: http://cb.biplab.in/websvn/
* Git URL: git://cb.biplab.in/codeblocks.git
* Web-interface:http://cb.biplab.in/cgit/

'''Mirror by Jens''' (Read-only; refreshed every 10 minutes. As 2022-09-12, it looks dead.)
* Web-interface: http://cgit.jenslody.de/
* Git URL: git://jenslody.de/git/codeblocks
* the above Web-interface link contains many other mirrors such as wxWidgets trunk, git mirror, and git mirror of codeblocks.github

'''Mirror by Obf''' (Read-only; refreshed manually. As 2022-09-12, it looks dead.)
* Web-interface: https://github.com/obfuscated/codeblocks_sf
* Git URL: see the above page.
}}

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

* '''Documentation'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [https://forums.codeblocks.org/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

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

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[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]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [https://forums.codeblocks.org/index.php/topic,16096.msg128152.html#msg128152 Re: Read-only Git, SVN Repo for Code::Blocks], also stahta01 has a nice instruction about how to use git, see [https://forums.codeblocks.org/index.php/topic,19533.msg133422.html#msg133422 Development How to use a Code::Blocks Git Repo].

If you want to create a SVN style patch from git, see: [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530 This forum post].

== Debugging C::B ==

* When C::B crashes, it will generate a call-stack file "codeblocks.RPT", at the crash point (see [[FAQ-Compiling_(general)#Q: How do I report a compilation problem on the forums?|this]] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface that works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Configure GDB pretty printer for Msys2

2023-07-03T06:30:56Z

Ollydbg: How to add the wxWidgets' pretty printer

This is my way to use gdb python pretty printer for the libstdcxx under msys2.
Suppose you use 64bit gcc compiler. My msys2 is installed under F:\msys64

In the Menu->Settings->Debugger settings. Open the debugger plugin setting dialog.

Then, in the "Executable path" field, select "F:\msys64\mingw64\bin\gdb.exe"
in the "Debugger initialization commands" field, put the following text in the edit control.

<pre>
source F:\msys64\mingw64\etc\gdbinit
</pre>

I see that I have to modify the file "F:\msys64\mingw64\etc\gdbinit" file: below is the original code

<pre>
python
import sys
sys.path.insert(0, sys.path[0] + '/../../gcc-9.2.0/python')
from libstdcxx.v6.printers import register_libstdcxx_printers
end
</pre>

But you have to add one line before the "end" statement like below to let the register_libstdcxx_printers function get executed.

<pre>
python
import sys
sys.path.insert(0, sys.path[0] + '/../../gcc-9.2.0/python')
from libstdcxx.v6.printers import register_libstdcxx_printers
register_libstdcxx_printers(None)
end
</pre>

BTW: It is the same thing to add the python pretty printer for wxWidgets. You can use this file:

<pre>https://github.com/wxWidgets/wxWidgets/blob/master/misc/gdb/print.py</pre>

=Use predefined macros for the paths=
Under Code::Blocks, you can used some predefined path macros.

For example, you don't need to write
<pre>
source F:\msys64\mingw64\etc\gdbinit
</pre>
Instead, you can use this:
<pre>
source $(TARGET_COMPILER_DIR)etc\gdbinit
</pre>
Since you have already defined the compiler master path in the "Menu->Settings->Compiler->Toolchain executables" as "F:\msys2\mingw64", so the second way is more portable. Also, to mention gdb.exe, you can use
<pre>
$(TARGET_COMPILER_DIR)bin\gdb.exe
</pre>

=Add the pretty printer for wxWidgets=
Here is the full gdbinit content when using latest gcc under msys2/mingw64

<pre>
python
import sys
sys.path.insert(0, sys.path[0] + '/../../gcc-12.2.0/python')
from libstdcxx.v6.printers import register_libstdcxx_printers
register_libstdcxx_printers (None)

sys.path.insert(0, sys.path[0] + '/../../../etc')
import wxprint

end
</pre>

Note that the two lines were added to the original gdbinit(note once you use pacman to upgrade you gcc, this gdbinit file will get overwritten)

<pre>
sys.path.insert(0, sys.path[0] + '/../../../etc')
import wxprint
</pre>

Here, the "wxprint" is a file named "wxprint.py", which is just the same file as: https://github.com/wxWidgets/wxWidgets/blob/master/misc/gdb/print.py, I just put this "wxprint.py" in the same folder as the gdbinit file.

=Useful Links=
[https://forums.codeblocks.org/index.php?topic=23590.0 Debugger: use gdb python pretty printer for the libstdcxx under msys2]

Configure GDB pretty printer for Msys2

2023-07-03T06:21:40Z

Ollydbg: use TARGET_COMPILER_DIR macros

Developer documentation

2022-09-12T04:40:01Z

Ollydbg: Some mirrors were dead

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
{{Layout_box2|1=
'''Official Code repository Subversion''' 
* Web-interface by ViewVC: http://sourceforge.net/p/codeblocks/code/log/
* Subversion URL: <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki> or <nowiki>http://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

'''Mirror by biplab''' (Read-only; refreshed every 10 minutes. As 2022-09-12, it looks dead.)
* Subversion URL: <nowiki>svn://cb.biplab.in/codeblocks/trunk</nowiki> 
* Web-interface: http://cb.biplab.in/websvn/
* Git URL: git://cb.biplab.in/codeblocks.git
* Web-interface:http://cb.biplab.in/cgit/

'''Mirror by Jens''' (Read-only; refreshed every 10 minutes. As 2022-09-12, it looks dead.)
* Web-interface: http://cgit.jenslody.de/
* Git URL: git://jenslody.de/git/codeblocks
* the above Web-interface link contains many other mirrors such as wxWidgets trunk, git mirror, and git mirror of codeblocks.github

'''Mirror by Obf''' (Read-only; refreshed manually. As 2022-09-12, it looks dead.)
* Web-interface: https://github.com/obfuscated/codeblocks_sf
* Git URL: see the above page.
}}

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

* '''Documentation'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

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

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[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]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [https://forums.codeblocks.org/index.php/topic,16096.msg128152.html#msg128152 Re: Read-only Git, SVN Repo for Code::Blocks], also stahta01 has a nice instruction about how to use git, see [https://forums.codeblocks.org/index.php/topic,19533.msg133422.html#msg133422 Development How to use a Code::Blocks Git Repo].

If you want to create a SVN style patch from git, see: [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530 This forum post].

== Debugging C::B ==

* When C::B crashes, it will generate a call-stack file "codeblocks.RPT", at the crash point (see [[FAQ-Compiling_(general)#Q: How do I report a compilation problem on the forums?|this]] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface that works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Configure GDB pretty printer for Msys2

2022-04-17T04:04:10Z

Ollydbg: fix link format

Main Page

2022-01-22T09:36:00Z

Ollydbg: update compiler and links, thanks AndrewCot

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is a free, open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++/Fortran.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/binaries 20.03]
* Nightly builds: [https://forums.codeblocks.org/index.php/board,20.0.html Forum board]
* Source code: [https://www.codeblocks.org/downloads/source 20.03]
* Source code: [https://www.codeblocks.org/downloads/svn Current trunk]
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [https://forums.codeblocks.org/ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3ABug_Report+or+_type%3AUndefined bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3AFeature_Request+or+_type%3AUndefined features] or browse [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3APatch+or+_type%3AUndefined patches] or browse [http://alpha0010.github.io/cb-history/patches.html old patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)* [https://www.mingw-w64.org/ MinGW-w64] (Win)
* [https://github.com/jmeubank/tdm-gcc/ TDM GCC] (Win)
* [https://www.msys2.org/ MSYS2] (Win)
* [https://www.cygwin.com/ Cygwin] (Win)
* [https://winlibs.com/ WinLibs GCC] (Win)
* [https://osdn.net/projects/mingw/ MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore and PowerPC GCC] (Win32, Linux)
* [https://developer.apple.com/xcode/ Apple XCode (GCC)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [https://visualstudio.microsoft.com/vs/community/ Microsoft Visual Community Edition] (Win)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [https://github.com/open-watcom/open-watcom-v2 OpenWatcom V2] (Win32)
* [https://software.intel.com/en-us/c-compilers Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://dlang.org/ Digital Mars D] (Win32, Linux, Mac OS X)
* [https://gdcproject.org/ GDC D Compiler] (Linux)
* [https://github.com/ldc-developers/ldc/ LLVM D Compiler] (Win32, Linux, Mac OS X)
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

CB Clangd Client

2022-01-22T07:31:16Z

Ollydbg: update format

The home page of this plugin is: https://sourceforge.net/projects/cb-clangd-client/

The main developer is Pecan.

It uses [https://clangd.llvm.org/ clangd] through [https://en.wikipedia.org/wiki/Language_Server_Protocol Language Server Protocol].

The related forum discussion is: — [https://forums.codeblocks.org/index.php/topic,24357.msg166136.html Code completion using LSP and clangd]

CB Clangd Client

2022-01-22T07:28:16Z

Ollydbg: create a new page for the clangd based code completion plugin

The home page of this plugin is: https://sourceforge.net/projects/cb-clangd-client/

The main developer is Pecan.

It use the What is clangd? — <nowiki>https://clangd.llvm.org/</nowiki> as a Language Server Protocol - Wikipedia — <nowiki>https://en.wikipedia.org/wiki/Language_Server_Protocol</nowiki>

The related forum discussion is: Code completion using LSP and clangd — <nowiki>https://forums.codeblocks.org/index.php/topic,24357.msg166136.html#msg166136</nowiki>

Code::Blocks Plugins

2022-01-22T07:24:02Z

Ollydbg: /* Core Plugins */ add a new clangd based CC

[[Category: User Documentation]]
== General ==

Code::Blocks' features can be extend by using '''plugins''', most of them listed on this page. There are generally three types of plugins:
# Core plugins - developed and maintained by the core C::B team.
# Contrib plugins - developed and maintained by the community and proven to be very valuable. So they are integrated into the C::B SVN.
# 3rd party plugins - developed and maintained by the community but not (yet?) in the C::B repository. Theses plugins often have their own repository or are being posted (including the source code) in the forums.

'''If you are looking for plugins:'''
# Look in the official release. Notice that the installer / package manager might require you to enable some of the plugins specifically. So READ carefully.
# Search the forums for announcements, especially the forums at [/index.php/board,14.0.html].
# There might be information on the WiKi concerning other plugins on this page and '''[[Announcement_for_plugins/patches|here]]'''.

For Windows users, the default behavior of the current installer (10.05) does '''not''' install contrib plugins. You need to manually check the "contrib plugin" checkbox when asked for selected components to install. There is no way to install them manually afterwards.

'''If you are developing plugins:'''

* Please read [https://wiki.codeblocks.org/index.php/Managing_Plug-in_Resources this page] for creating and producing a plugin.
* You will need to store the source code for the plugin for other developers to have access to it. You can do this on SourceForge or Github or your favorite source code repository web site.
* Setup your own webpage on a file sharing platform that can be used for documenting and distribution of the plugin. This will allow users to download the plugin to install on their Code::Blocks installation.

Once you have a working and production ready plugin for other developers to use then you can do the following:
* Read [https://wiki.codeblocks.org/index.php/Announcement_for_plugins/patches this page] for information on how to announce you have a plugin on the Code::Blocks forum.
* In your announcement in the [https://forums.codeblocks.org/index.php/board,14.0.html forum] please also ask for your plugin to be added to the Code::Blocks wiki [https://wiki.codeblocks.org/index.php?title=Code::Blocks_Plugins plugin page] with the details you would like to see on the page.

== Core Plugins ==

The core plugins are installed by default and offer the basic functions of Code::Blocks. The core plugins are maintained / developed by the official development team.

'''[[Abbreviations plugin|Abbreviations]]'''
:Code::Blocks AutoComplete plugin.

'''[[Autosave plugin|Autosave]]'''

:Saves project files between intervals.

'''[[Class Wizard plugin|Class Wizard]]'''

:Provides wizard for creating new classes.

'''[[Code Completion plugin|Code Completion]]'''

:Provides code completion functionality and class browser.

'''[[CB Clangd Client|CB Clangd Client]]'''

:Provides code completion functionality and class browser by Clangd through LSP.

'''[[Compiler plugin|Compiler]]'''

:Provides support for various compilers in one interface.

'''[[Debugger plugin|Debugger]]'''

:Provides support for various debuggers in one interface.

'''[[File Extension Handler plugin|File Extensions Handler]]'''

:Adds extra file extension handlers.

'''[[Header Guard plugin|Header Guard]]''' ''(Disabled by default.)''

:Create header guards (if needed) on file save.

'''[[LogHacker plugin|LogHacker]]''' ''(Disabled by default.)''

:Manipulate loggers.

'''[[ModPoller plugin|ModPoller]]''' ''(Disabled by default.)''

:Frequently check for external modification.

'''[[Open Files List plugin|Open Files List]]'''

:Manages a list of all opened files (editors).

'''[[Projects Importer plugin|Projects Importer]]'''

:Imports projects from other IDE's, e.g. MS Visual Studio and DevC++.

'''[[Scripted Wizard plugin|Scripted Wizard]]'''

:Provides scripted wizard functionality.

'''[[Source Code Formatter plugin|Source Code Formatter]]''' (AStyle)

:Formats source code files with specific style.

'''[[Tidycmt plugin|Tidycmt]]''' ''(Disabled by default.)''

:Formats comments on file save.

'''[[To-Do List plugin|To-Do List]]'''

:Adds to-do items to source code.

'''[[WinXP Look'n'Feel plugin|WinXP Look'n'Feel]]'''

:Creates manifest file which enables the version 6.0 of the Common Controls on Windows XP.

== Contrib Plugins ==

The user-''contrib''uted plugins are not installed by default and offer extended functionality for Code::Blocks. The contrib plugins are maintained / developed by third-party developers.

'''[[Aligner plugin|Aligner]]'''

:Code alignment.

'''[[AutoVersioning plugin|Auto Versioning]]'''

:Helps you keep track of your project version and status.

'''[[Browse Tracker plugin|Browse Tracker]]'''

:Browse to previous source positions.

'''[[C::B Games plugin|C::B Games]]'''

:Games in a integrated development environment? You bet.

'''[[CCCC plugin|CCCC]]'''

:Integrates CCCC tool for measurement of source code metrics (http://sourceforge.net/projects/cccc/) into Code::Blocks.

'''[[Code Profiler plugin|Code Profiler]]'''

:Provides graphical interface to GNU GProf profiler.

'''[[Code Snippets plugin|Code Snippets]]'''

:Manages small pieces of code (i.e. snippets).

'''[[Code Statistics plugin|Code Statistics]]'''

:Shows various statistics from source code files.

'''[[Copy Strings to Clipboard plugin|Copy Strings to Clipboard]]'''

:Copies literal strings from the current editor to clipboard.

'''[[CppCheck plugin|CppCheck]]'''

:Integrates the static code analyzer Cppcheck into Code::Blocks.

'''[[Cscope plugin|Cscope]]'''

:Integrates Cscope (http://cscope.sourceforge.net/) into Code::Blocks.

'''[[DevPak Installer plugin|DevPak Installer]]'''

:Installs and updates DevC++ DevPaks.

'''[[DoxyBlocks plugin|DoxyBlocks]]'''

:This plugin provides doxygen integration for Code::Blocks.

'''[[DragScroll plugin|DragScroll]]'''

:Enables dragging and scrolling with mouse.

'''[[EditorConfig plugin|EditorConfig]]'''

:This plugin implements the http://EditorConfig.org/ file format.

'''[[Editor Tweaks plugin|Editor Tweaks]]'''

:This plugin provides some additional tweaks for Code::Blocks editor.

'''[[Environment Variables plugin|Environment Variables]]'''

:Sets environment variables within the focus of Code::Blocks.

'''[[File Manager plugin|File Manager]]'''

:This plugin provides a simple file manager as a tab in the Code::Blocks management pane.

'''[[Header Fixup plugin|Header Fixup]]'''

:Adds missing includes/forward declarations to C++ source files.

'''[[Help plugin|Help]]'''

:Integrates third-party help files to the interface.

'''[[HexEditor plugin|HexEditor]]'''

:Opens files in a Code::Blocks integrated HexEditor.

'''[[Incremental Search plugin|Incremental Search]]'''

:Searches and highlights a marked text incrementally within the open editor.

'''[[Keyboard Shortcuts plugin|Keyboard Shortcuts]]'''

:Manages menu shortcuts.

'''[[Koders plugin|Koders]]'''

:Queries the Koders webpage for keywords.

'''[[Library finder plugin|Library finder]]'''

:Tool for automatically searching for installed libraries, and adding them to the project.

'''[[NassiShneiderman plugin|NassiShneiderman]]'''

:Allows the creation of Nassi Shneiderman diagrams within Code::Blocks.

'''[[RegEx Testbed plugin|RegEx Testbed]]'''

:Regular expressions testbed.

'''[[ReopenEditor plugin|ReopenEditor]]'''

:Reopen a closed editor via hotkey, menu-item, or from a list.

'''[[Rndgen plugin|Rndgen]]'''

:Generates random values (numbers or strings) when saving a file.

'''[[SmartIndent plugin|SmartIndent]]'''

:A suite of plugins that supply smart indenting for various languages.

'''[[Source Exporter plugin|Source Exporter]]'''

:Exports source code files to other formats such as HTML and PDF.

'''[[SpellChecker plugin|SpellChecker]]'''

:A plugin to check the spelling of strings and comments.

'''[[Symbol Table plugin|Symbol Table]]'''

:A simple graphical interface to the GNU symbol table displayer (nm).

'''[[ThreadSearch plugin|ThreadSearch]]'''

:Multi-threaded 'Search in files' with preview window.

'''[[Tools+ plugin|Tools+]]'''

:Creation and management of custom tools.

'''[[Valgrind plugin|Valgrind]]'''

:Valgrind analysis tools integration. (Valgrind does not run on Windows)

'''[[wxSmith plugin|wxSmith]]'''

:RAD tool for creating wxWidgets dialogs.

== 3rd Party Plugins ==

3rd party plugins - developed and maintained by the community but not (yet?) in the C::B repository. The contrib plugins are maintained / developed by third-party developers.

'''[[DisplayEvents plugin|DisplayEvents]]'''

:Display events that are registered with <tt>RegisterEventSink</tt>, in the Code::Blocks Debug log.

'''[[Fortran Project plugin|Fortran Project]]'''

:This plugin provides symbol browser and code-completion for Fortran files.

'''[[IPDefend Toolkit plugin|IPDefend Toolkit]]'''

:This plugin enables creation of a licensed application in an easy way. Available at [http://www.comsytec.com/ipdefend.php]

'''[[KeyMacs plugin|KeyMacs]]'''

:KeyMacs (or Keyboard Macros) plugin enables Recording, Playback, and editing of keystroke macros.

'''[[OccurrenceHighlighter plugin|OccurrenceHighlighter]]'''

:This plugin highlights all occurrences of keywords on a list.

'''[[Python plugins|Python]]'''

:A set of plugins that provide a user interface for debugging python programs, completion hints for python code, and a python interpreter in a dockable window.

'''[[Rss::Blocks plugin|Rss::Blocks]]'''

:This plugin is an rss feeds reader. Available at [http://sourceforge.net/projects/rssblocks/ sourceforge/rssblocks]

'''[[TRACE32 Debugger plugin|TRACE32 Debugger]]'''

:Extends the Debugger plugin of Code::Blocks to work with the TRACE32 Debuggers. TRACE32 documentation "int_codeblock.pdf" and debuggert32.cbplugin are located on the enclosed SW CD on purchase of TRACE32

'''[[EPS Debugger for STM32 plugin|EPS Debugger for STM32]]'''

:Developing embedded applications for STM32 with ST Link 2. Available at [http://www.comsytec.eu/epsdebugger.php]

'''[[Vim emulator plugin|Vim Plugin]]'''

:Emulate the Vim's shortkeys in Code::Blocks editor. Available at [https://github.com/zmj64351508/cbvike cbvike on Github]

If you have questions -> ask in the [/index.php/board,14.0.html forums].

'''[[OpenFilesListPlus Plugin]]'''

:Enhanced version of the OpenFilesList plugin. Available at [https://github.com/earlgrey-bis/cb-OpenFilesListPlus on Github]

'''[[SourceTrail Plugin]]'''

:Interface to [https://www.sourcetrail.com/ on SourceTrail]. Available at [https://github.com/martim01/sourcetrail on Github]

If you have questions -> ask in the [/index.php/topic,23588.0.html forums].

'''[[cbSystemView]]'''

:A plugin to use SVD files for embedded development. Available at [https://github.com/bluehazzard/cbSystemView on Github]

'''[[cbMemoryView]]'''

:A plugin to view memory locations with multiple tabs. Available at [https://github.com/bluehazzard/cbMemoryView on Github]

'''[[cbBuildTools ]]'''

:A little plugin that displays the targets in a tree, for easy building. Available at [https://github.com/bluehazzard/cbBuildTools on Github]

==See also==
* [[Announcement for plugins/patches|Announcement for plugins/patches]] These are not stable plugins in many cases

Main Page

2022-01-22T07:04:14Z

Ollydbg: update links

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is a free, open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++/Fortran.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/binaries 20.03]
* Nightly builds: [https://forums.codeblocks.org/index.php/board,20.0.html Forum board]
* Source code: [https://www.codeblocks.org/downloads/source 20.03]
* Source code: [https://www.codeblocks.org/downloads/svn Current trunk]
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [https://forums.codeblocks.org/ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3ABug_Report+or+_type%3AUndefined bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3AFeature_Request+or+_type%3AUndefined features] or browse [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3APatch+or+_type%3AUndefined patches] or browse [http://alpha0010.github.io/cb-history/patches.html old patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [https://osdn.net/projects/mingw/ MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore and PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://open-watcom.github.io/ OpenWatcom] (Win32)
* [https://software.intel.com/en-us/c-compilers Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://dlang.org/ Digital Mars D]
* [https://gdcproject.org/ GDC D Compiler]
* [https://github.com/ldc-developers/ldc/ LLVM D Compiler]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Main Page

2022-01-22T06:59:50Z

Ollydbg: update mingw site

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is a free, open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++/Fortran.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/binaries 20.03]
* Nightly builds: [https://forums.codeblocks.org/index.php/board,20.0.html Forum board]
* Source code: [https://www.codeblocks.org/downloads/source 20.03]
* Source code: [https://www.codeblocks.org/downloads/svn Current trunk]
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [https://forums.codeblocks.org/ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3ABug_Report+or+_type%3AUndefined bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3AFeature_Request+or+_type%3AUndefined features] or browse [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3APatch+or+_type%3AUndefined patches] or browse [http://alpha0010.github.io/cb-history/patches.html old patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [https://osdn.net/projects/mingw/ MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore and PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page OpenWatcom] (Win32)
* [https://software.intel.com/en-us/c-compilers Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://dlang.org/ Digital Mars D]
* [http://dgcc.sourceforge.net/ GDC D Compiler]
* [https://github.com/ldc-developers/ldc/ LLVM D Compiler]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Main Page

2021-10-28T07:40:25Z

Ollydbg: add the forum link

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is a free, open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++/Fortran.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/binaries 20.03]
* [/index.php?board=20.0 Nightly builds] (updated each night)
* [[Compiled_packages_of_Code::Blocks|Official and third-party binaries]] (for various distributions)
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [https://forums.codeblocks.org/ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3ABug_Report+or+_type%3AUndefined bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3AFeature_Request+or+_type%3AUndefined features] or browse [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3APatch+or+_type%3AUndefined patches] or browse [http://alpha0010.github.io/cb-history/patches.html old patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [http://www.mingw.org MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore and PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page OpenWatcom] (Win32)
* [https://software.intel.com/en-us/c-compilers Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://dlang.org/ Digital Mars D]
* [http://dgcc.sourceforge.net/ GDC D Compiler]
* [https://github.com/ldc-developers/ldc/ LLVM D Compiler]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Configure GDB pretty printer for Msys2

2021-03-20T12:01:33Z

Ollydbg: a new page for configure the pretty printer for msys2

Pretty Printers

2021-03-20T11:36:43Z

Ollydbg: add a new stub for pretty printer for msys2

[[Category: User Documentation]]
GDB Pretty Printers for STL display nicely formatted variables in the hover pop-up and watch window, for all STL containers (vectors, maps, etc).
----
[[File:Pprint1.png|border|Popup example]] 
==Test with GDB==

*Ensure GDB is python-enabled. For Linux (tested with recent Ubuntu), it is enabled by default. For Windows, MinGW's GDB is not python enabled. One option is to install [http://sourceforge.net/projects/mingwbuilds/ MinGW-Builds] over MinGW (consider backing up MinGW first). This updates GCC to 4.7.2 and includes a Python enabled GDB.
<ol>
To test, launch GDB from console:
<pre>
(gdb) python print sys.version
</pre>
If python is enabled, the version will be printed (probably 2.7.x), otherwise, a message will indicate python scripting is not supported.
</ol>
*Download printers.py (if necessary)
:Windows users with MinGW should already have this file in /MinGW/share/gcc-4.7.2/python/libstdcxx/v6.
:Linux users can download printers.py [http://gcc.gnu.org/svn/gcc/trunk/libstdc++-v3/python/libstdcxx/v6/printers.py here]. Save as <tt>/home/username/gdb_printers/printers.py</tt>.
*Create a GDB [http://sourceware.org/gdb/onlinedocs/gdb/Command-Files.html Command File] to enable the printer. Store in <tt>c:\mingw\bin\pp.gdb</tt> (windows) or <tt>/home/username/gdb_printers/pp.gdb</tt> (linux). Below is a sample command file. Replace the path c:/MinGW/share... with your path to printers.py.
<blockquote><pre>
python
import sys
sys.path.insert(0, 'c:/MinGW/share/gcc-4.7.2/python/libstdcxx/v6')
from printers import register_libstdcxx_printers
register_libstdcxx_printers (None)
end
</pre></blockquote>
*Test
#Set a breakpoint in a program and debug
#Run the command file from GDB (can use Codeblocks->debugger tab->command, or in GDB from the console) (substitute your path if necessary)
<ol><pre>(gdb) source c:\MinGW\bin\pp.gdb</pre></ol>
<ol start="3">
<li>Test the printer - example:</li>
</ol>
<ol><pre>(gdb) print words2
$1 = std::vector of length 3, capacity 4 = {"one", "two", "three"}
</pre></ol>

==Add to Codeblocks==
Once the command file is working correctly, there are two steps to activate in Codeblocks:
#Set debugger initialization command (substitute your path as necessary): <tt>Codeblocks->Settings->Debugger->Default->Debugger initialization commands</tt>
<ol><pre>source c:\MinGW\bin\pp.gdb</pre>
NOTE: A bug in the Linux version of Codeblocks may prevent entering anything in the Debugger Initialization Commands field. A work-around is to open a CBP project file via a file manager, which in turn launches Codeblocks and seems to resolve the issue.
</ol>
<ol start="2">
<li>Disable Codeblocks handling of watch values (needed only for versions older than 17.12):</li>
</ol>
<ol><tt>Codeblocks->Settings->Debugger->Default->Enable Watch Scripts = Unchecked</tt></ol>

===Other Info===
Links:

[http://sourceware.org/gdb/onlinedocs/gdb/Python-API.html GDB Python API]

[http://sourceware.org/gdb/onlinedocs/gdb/Pretty-Printing.html GDB Pretty Printing]

===To Do===
The third column in the Codeblocks popup and watch window displays a long unformatted string. Codeblocks is calling the GDB whatis command. Can this command be Pretty-Printed?

==See also==
* [[Debugging with Code::Blocks]]
* [[Debugger scripts]]
* [[Configure GDB pretty printer for Msys2]]

Plugin structure of C::B

2015-10-06T08:57:26Z

Ollydbg: /* Overview */ add a dependency graph

[[Category:Plugin development]]
==Overview==
C::B can have many plugins working together, this page will describe how they get communication with each other.
Normally, the src target(codeblock.exe) is the main executable, and the sdk target(codeblocks.dll) is the main dll, and all the plguins(such as compiler.dll, codecompletion.dll) are directly communicated with the main dll.
The method we used here is described as the "The sub-DLL solution" in the following links.
==plugin dependency==
As described above, the dependency are as shown in the image below.
The arrow means the dependency graph means all the plugin dlls have dependency on the SDK(codeblocks.dll), as well as the main executable(codeblocks.exe).

[[File:Plugin-dependency.png]]

==Links==
[http://edll.sourceforge.net/ Enhanced Dynamic Linking for MS-Windows]

File:Plugin-dependency.png

2015-10-06T08:52:36Z

Ollydbg: C::B plugin dependency

C::B plugin dependency

Plugin structure of C::B

2015-10-05T15:09:59Z

Ollydbg: new content about the plugin structure

Developer documentation

2015-10-05T15:02:55Z

Ollydbg: /* Plug-In development */ add a new page about the plugin structure

Developer documentation

2015-09-29T14:56:28Z

Ollydbg: remove the strike lines

Developer documentation

2015-09-29T14:54:25Z

Ollydbg: correct the link title

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
{{Layout_box2|1=
'''Official Code repository Subversion''' 
* Web-interface by ViewVC: http://sourceforge.net/p/codeblocks/code/log/
* Subversion URL: <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki> or <nowiki>http://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

'''Mirror by biplab''' (Read-only; refreshed every 10 minutes.)
* Subversion URL: <nowiki>svn://cb.biplab.in/codeblocks/trunk</nowiki> 
* Web-interface: http://cb.biplab.in/websvn/
* Git URL: git://cb.biplab.in/codeblocks.git
* Web-interface:http://cb.biplab.in/cgit/

'''Mirror by Jens''' (Read-only; refreshed every 10 minutes.)
* Web-interface: http://cgit.jenslody.de/
* Git URL: git://jenslody.de/git/codeblocks
* the above Web-interface link contains many other mirrors such as wxWidgets trunk, git mirror, and git mirror of codeblocks.github

'''Mirror by Obf''' (Read-only; refreshed manually.)
* Web-interface: https://github.com/obfuscated/codeblocks_sf
* Git URL: see the above page.
}}

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

* '''Documentation'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
<strike>
:Also see http://developer.berlios.de/projects/codeblocks/ (under the downloads section).
:Checkout the SDK documentation at http://developer.berlios.de/project/showfiles.php?group_id=5358 as CHM file(s).
</strike>
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

* '''[http://launchpad.net/products/codeblocks/ Translation]'''
:Code::Blocks uses Launchpad to coordinate translation efforts.
:See also [/index.php/topic,1022.msg132499.html#msg132499 Code::Blocks' translation]

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

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== 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]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [/index.php/topic,16096.msg128152.html#msg128152 Re: Read-only Git, SVN Repo for Code::Blocks], also stahta01 has a nice instruction about how to use git, see [/index.php/topic,19533.msg133422.html#msg133422 Development How to use a Code::Blocks Git Repo].

If you want to create a SVN style patch from git, see: [/index.php/topic,19391.msg132530.html#msg132530 This forum post].

== Debugging C::B ==

* When C::B crashed, it will generate a call-stack file "codeblocks.RPT", at the crash point, this is a text file, you can open it, if your C::B contains the debug information, it will have file and line information about each call. If it is a stripped version, but you have the debug version of C::B, you can try to run the [/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is a address2line UI interface works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2015-09-27T06:20:43Z

Ollydbg: /* Building wxWidgets Code */ mention a patch and a compiler option to build wx3

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

'''NOTE:''' If you are building wx3.0.2 with GCC 4.9.x or GCC 5.x, you will get compiler error, thus a patch is need, see discussion here: [/index.php/topic,20607.msg140163/topicseen.html#msg140163 Build C::B against wx3.02 with gcc 5.2 under Windows]

'''NOTE:''' There is an compiler option needed if you want to suppress the compiler warnings, see: [/index.php/topic,20382.msg140167.html#msg140167 Re: TDM-GCC 5 series (Latest: 5.1.0 - 2015-06-28)]

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference ===
* Forum discussion:[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]
* [[Installing Code::Blocks from source on Windows]]
* Note that PCH is disabled in Codeblocks_wx30.cbp, because it cause GCC build error (a bug in GCC 4.8.x [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=56926 Bug 56926 – Crash (without ICE) while compiling Boost.Math]), see discussions here: [/index.php/topic,18412.msg126028.html#msg126028 Re: wxWidgets 3.0 and Code::Blocks files question?] and [/index.php/topic,18568.msg127102.html#msg127102 Patches for Compiling Code::Blocks against wxWidgets 3.0 using MinGW GCC 4.8.1]. As of 2015-09-27, there is a gcc suite which have PCH crash issue fixed, see forum post [/index.php/topic,18568.msg140107.html#msg140107 Re: Patches for Compiling Code::Blocks against wxWidgets 3.0 using MinGW GCC 4.8.1]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2015-09-27T06:16:16Z

Ollydbg: /* Reference */ mention a gcc compiler suite which fix the PCH issue

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference ===
* Forum discussion:[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]
* [[Installing Code::Blocks from source on Windows]]
* Note that PCH is disabled in Codeblocks_wx30.cbp, because it cause GCC build error (a bug in GCC 4.8.x [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=56926 Bug 56926 – Crash (without ICE) while compiling Boost.Math]), see discussions here: [/index.php/topic,18412.msg126028.html#msg126028 Re: wxWidgets 3.0 and Code::Blocks files question?] and [/index.php/topic,18568.msg127102.html#msg127102 Patches for Compiling Code::Blocks against wxWidgets 3.0 using MinGW GCC 4.8.1]. As of 2015-09-27, there is a gcc suite which have PCH crash issue fixed, see forum post [/index.php/topic,18568.msg140107.html#msg140107 Re: Patches for Compiling Code::Blocks against wxWidgets 3.0 using MinGW GCC 4.8.1]

Developer documentation

2014-10-01T15:08:48Z

Ollydbg: add git urls.

Developer documentation

2014-09-17T05:20:50Z

Ollydbg: /* Developing C::B with Git */add stahta01's nice article

Creating a patch to submit (Patch Tracker)

2014-09-17T05:16:41Z

Ollydbg: the tickets system is now in SF, so update all the address.

[[Category:Developer Documentation]]
== Introduction ==
You want to contribute to Code::Blocks? - Thank you! That is really appreciated. Hence you can help us even more if you read the following paragraphs carefully.

First of all please make sure the feature you are implementing is not already implemented in the "nightly builds" of Code::Blocks ([/index.php/board,20.0.html /index.php/board,20.0.html]). Furthermore browse through the list of available patches at the Code::Blocks project page at SourceForge (see section "Patch submission" below on how to gain access). If you are unsure, don't hesitate to ask in the forum ([ ]) for advise.

You can make it easier for the developers to integrate your patches if you follow the advices of this page. Patches can be created in different formats. The format that is used by Code::Blocks is called a "unified diff". Hence 3rd party tools may still create a different patch format although it may be labelled as "unified diff". To avoid unnecessary incompatibilities the best way to provide a patch is to '''use the Subversion (SVN) diff''' (using the command line tool or a SVN GUI application).

== What is required? ==
Not too much, you might already have the required tools installed.
You'll need a subversion client software. You can download a current version for your OS at the Subversion project webpage here: [http://subversion.tigris.org http://subversion.tigris.org]. If you want to apply or test your patches you'll also need either '''svn''' version ≥ 1.7.0 or the '''patch''' program; you can download patch and find more information about it at the [http://www.gnu.org/software/patch/ GNU patch website].

It is a good idea to apply your code to the most up-to-date sources of Code::Blocks as they are available at the SVN repository. You'll find the instructions how to obtain the sources here: [https://www.codeblocks.org/downloads/7 https://www.codeblocks.org/downloads/7]. Once you've created your local sandbox you can start integrating your changes into it. Thus you may modify existing files or add new ones. When you have finished please make sure you've verified your implementation (feature(s)) work properly. Now it's time to create the patch.

== Patch creation ==
If you have added new files you first have to register them with your sandbox. Thus go into the directory you've added new files and type at the command line:
: <tt>svn add filename(s)</tt>
...whereas "filename(s)" needs to be replaced with the files you've added. Of course if you are not using the command line version of SVN you can easily use the "Add" feature of your prefered SVN GUI. If you've completed adding all your new files to your sandbox you are ready to create the patch.

First of all go to the top-level directory of your sandbox (the first directory that has a hidden ".svn" folder with content). This is done because the patch file generated by the following command is relative to the directory where it's performed. This is the command to create the patch file:
: <tt>svn diff > my.patch</tt>

You can change the name of the patch (''my.patch'' in the example) with a more descriptive name but make sure you leave the file extension ".patch" as this avoids conflicts while submitting the patch. The creation of the ''difference file'' (the patch file) may take some time, please be patient.

Once the patch file is created please make sure it contains content! Otherwise make sure you followed the steps above or ask in the forum ([ ]) for support.

''Note: if the created patch is much larger than expected (it should be similar in size to the amount of code you changed/added) it is likely that extraneous white space changes are being picked up. In this case, please use the following command to create the patch file:''
: <tt>svn diff -x -w > my.patch</tt>

=== Patch application and testing ===
In order to apply a patch you need the patch program ([http://gnuwin32.sourceforge.net/packages/patch.htm Windows] [http://savannah.gnu.org/projects/patch/ Linux]). Make sure you are in the same directory the patch was created and then type the following command:
: <tt>patch --unified --strip=0 --forward --input=my.patch</tt>

Or, if you are using svn version ≥ 1.7.0, the command:
: <tt>svn patch my.patch</tt>

This will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

'''Important note:''' If you are working under Windows you may have to convert the patch file to dos line-ending format. You can do that using "unix2dos my.patch".

== Patch submission ==
By now you are ready to submit your work to the Patch Tracker at [https://sourceforge.net/p/codeblocks/tickets/?source=navbar Tickets] - the developer platform for Code::Blocks. If you haven't done so already, you need to register with Sourceforge to gain the right to submit patches to projects. The membership is free and appreciated. Select the "Tickests" section ([https://sourceforge.net/p/codeblocks/tickets/?source=navbar Tickets]) of the Code::Blocks project page. Click on "Submit A Patch" and fill out the form that appears. For now you only need to select a category for your patch, a '''descriptive''' summary and the patch itself. Make sure you enable the checkbox "Upload Patch" and provide the patch file you've just created. Then you are ready for submission - click on the "Submit patch" button on the bottom of the page.

You should now see the current list of patches with your patch at the top. Please note you can add additional comments or updates to your patch by simply clicking on the patch in the list and fill out the form that appears.

'''Thank you very much for your submission!'''

Creating a patch to submit to BerliOS (Patch Tracker)

2014-09-17T05:10:21Z

Ollydbg: moved Creating a patch to submit to BerliOS (Patch Tracker) to Creating a patch to submit (Patch Tracker): BerliOS is closed, we now use Sourceforce as patch tracker

#REDIRECT [[Creating a patch to submit (Patch Tracker)]]

Creating a patch to submit (Patch Tracker)

2014-09-17T05:10:21Z

Ollydbg: moved Creating a patch to submit to BerliOS (Patch Tracker) to Creating a patch to submit (Patch Tracker): BerliOS is closed, we now use Sourceforce as patch tracker

[[Category:Developer Documentation]]
== Introduction ==
You want to contribute to Code::Blocks? - Thank you! That is really appreciated. Hence you can help us even more if you read the following paragraphs carefully.

First of all please make sure the feature you are implementing is not already implemented in the "nightly builds" of Code::Blocks ([/index.php/board,20.0.html /index.php/board,20.0.html]). Furthermore browse through the list of available patches at the Code::Blocks project page at BerliOS (see section "Patch submission" below on how to gain access). If you are unsure, don't hesitate to ask in the forum ([ ]) for advise.

You can make it easier for the developers to integrate your patches if you follow the advices of this page. Patches can be created in different formats. The format that is used by Code::Blocks is called a "unified diff". Hence 3rd party tools may still create a different patch format although it may be labelled as "unified diff". To avoid unnecessary incompatibilities the best way to provide a patch is to '''use the Subversion (SVN) diff''' (using the command line tool or a SVN GUI application).

== What is required? ==
Not too much, you might already have the required tools installed.
You'll need a subversion client software. You can download a current version for your OS at the Subversion project webpage here: [http://subversion.tigris.org http://subversion.tigris.org]. If you want to apply or test your patches you'll also need either '''svn''' version ≥ 1.7.0 or the '''patch''' program; you can download patch and find more information about it at the [http://www.gnu.org/software/patch/ GNU patch website].

It is a good idea to apply your code to the most up-to-date sources of Code::Blocks as they are available at the SVN repository. You'll find the instructions how to obtain the sources here: [https://www.codeblocks.org/downloads/7 https://www.codeblocks.org/downloads/7]. Once you've created your local sandbox you can start integrating your changes into it. Thus you may modify existing files or add new ones. When you have finished please make sure you've verified your implementation (feature(s)) work properly. Now it's time to create the patch.

== Patch creation ==
If you have added new files you first have to register them with your sandbox. Thus go into the directory you've added new files and type at the command line:
: <tt>svn add filename(s)</tt>
...whereas "filename(s)" needs to be replaced with the files you've added. Of course if you are not using the command line version of SVN you can easily use the "Add" feature of your prefered SVN GUI. If you've completed adding all your new files to your sandbox you are ready to create the patch.

First of all go to the top-level directory of your sandbox (the first directory that has a hidden ".svn" folder with content). This is done because the patch file generated by the following command is relative to the directory where it's performed. This is the command to create the patch file:
: <tt>svn diff > my.patch</tt>

You can change the name of the patch (''my.patch'' in the example) with a more descriptive name but make sure you leave the file extension ".patch" as this avoids conflicts while submitting the patch. The creation of the ''difference file'' (the patch file) may take some time, please be patient.

Once the patch file is created please make sure it contains content! Otherwise make sure you followed the steps above or ask in the forum ([ ]) for support.

''Note: if the created patch is much larger than expected (it should be similar in size to the amount of code you changed/added) it is likely that extraneous white space changes are being picked up. In this case, please use the following command to create the patch file:''
: <tt>svn diff -x -w > my.patch</tt>

=== Patch application and testing ===
In order to apply a patch you need the patch program ([http://gnuwin32.sourceforge.net/packages/patch.htm Windows] [http://savannah.gnu.org/projects/patch/ Linux]). Make sure you are in the same directory the patch was created and then type the following command:
: <tt>patch --unified --strip=0 --forward --input=my.patch</tt>

Or, if you are using svn version ≥ 1.7.0, the command:
: <tt>svn patch my.patch</tt>

This will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

'''Important note:''' If you are working under Windows you may have to convert the patch file to dos line-ending format. You can do that using "unix2dos my.patch".

== Patch submission ==
By now you are ready to submit your work to the Patch Tracker at BerliOS ([http://developer.berlios.de/projects/codeblocks http://developer.berlios.de/projects/codeblocks/]) - the developer platform for Code::Blocks. If you haven't done so already, you need to register with BerliOS to gain the right to submit patches to projects. The membership is free and appreciated. Select the "Patches" section ([http://developer.berlios.de/patch/?group_id=5358 http://developer.berlios.de/patch/?group_id=5358]) of the Code::Blocks project page. Click on "Submit A Patch" and fill out the form that appears. For now you only need to select a category for your patch, a '''descriptive''' summary and the patch itself. Make sure you enable the checkbox "Upload Patch" and provide the patch file you've just created. Then you are ready for submission - click on the "Submit patch" button on the bottom of the page.

You should now see the current list of patches with your patch at the top. Please note you can add additional comments or updates to your patch by simply clicking on the patch in the list and fill out the form that appears.

'''Thank you very much for your submission!'''

Code Completion Design

2014-09-08T15:22:31Z

Ollydbg: add a new section

[[Category:Developer Documentation]]
==How to build==
===Get the source code===
When you download the svn source code of code::blocks,(see here [[Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_sources]] the source code of CodeCompletion plugin was already included.

Here is the screen shot when I opened the codecompletion source code in C::B's source navigator view.

[[Image:Devcc1.png|300x300px| Code completion source tree opened in code::blocks]]

===Build the code completion plug-in===
If you only want to build the Code Completion plug-in, you can select it in the "build target list" (Note: by default, the Build target option was "ALL", which means all the targets in the current workspace will be build), see the screen shot below:

[[Image:Buildcc.PNG|frame|none| Code completion build target option in code::blocks]]

Don't forget to run the batch script file "update.bat" after you build the target, this procedure will update your output folder package and strip the debug information. See the wiki page [[Installing_Code::Blocks_from_source_on_Windows]] for more information.

===A brief description of every project files===
From now on, we use '''CC''' as an abbreviation for '''code completion plug-in'''.
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| ccdebuginfo.cpp || a dialog for debugging CC, can be opened by double click on the code browser tree entry with shift and ctrl key pressed
|-
| ccoptionsdlg.cpp|| code completion options dialog, can be opened by menu->setting->editor->code completion and symbols browser
|-
| ccoptionsprjdlg.cpp|| setting the additional parser search path
|-
| classbrowser.cpp||viewing the symbols tree ctrl(token tree).
|-
| classbrowserbuilderthread.cpp|| a thread to build the class browser tree above
|-
| codecompletion.cpp ||The Main file need by code completion plug-in, maintain all the CC's GUI and native parser
|-
| insertclassmethoddlg.cpp|| a dialog to insert class method, can be open by context menu in editor
|-
| nativeparser.cpp||a class derived from wxEvtHandler, NativeParser class has a member variable "Parser m_Parser";
|-
| selectincludefile.cpp|| select multiply matched token names before any jump to declaration or jump to implementation.
|-
|parser/parser.cpp|| Parser class was also derived from wxEvtHandler, can start batch parse... this class has member variables like :cbThreadPool m_Pool(which will create a thread from thread pool for each file need passed);TokenTree* m_pTokens(contains all the Token database);
|-
|parser/parserthread.cpp||will do the syntax analysis for every file in a project, it has a Tokenizer as member variable
|-
|parser/token.cpp|| definition of the "Token" class, and TokenTree(which means the Token dababase)
|-
|parser/tokenizer.cpp|| tokenizer will return every wxString it regard as a symbol by GetToken(), also do a replacement before return
|-
|parser/searchtree.cpp|| implement the patricia search tree using by TokenTree
|-
|Header files|| no description needed
|}
==Structure of CodeCompletion plugin==
[[Image:CodeCompletionPluginStructure.png| Code completion plugin Structure]]

The above image show the main structure of our CodeCompletion plugins. The main class are:
* CodeCompletion: this is the class for main plugin), it handle event sent from the C::B core. Toolbar handling was done in this class.
* NativeParser: as a main member variable of the CodeCompletion class, this class is like the Parser manager class, it create/delete Parser instances when a project load/closed.
* Parser: this class is mainly for handling Tokens. Parser class hold a TokenTree which record all the Tokens. Parser class also hold a thread pool, it can either run the parsing task in the pool(this means the parsing task will be done in a separate thread), or directly by a function call.
* Parserthread: The class derived from the worker thread(cbThreadedTask class), it member function DoParse() is the function for parsing.

Besides that, when trying to show the suggestion list(auto completion list, or code completion list), the NativeParser need to analyze the current the current statement structure, and query the symbol(token) information from the Tokentree, this is mostly done in ResolveExpression() member function.

Some important note: when all Parserthread instances finish parsing job in the pool, the thread pool will send an event to its parent(in this case, it is the Parser class), so the Parser know that the parsing is done, or the Parser can assign another parsing jobs to the thread pool.

==Low level parser(Lexical analysis, Tokenize)==
For someone haven't heard what does "Token" and "Tokenize" mean, you should read the wikibooks article [http://en.wikibooks.org/wiki/C%2B%2B_Programming/Compiler#Compilation A brief explain of what does a parser do] and [http://en.wikipedia.org/wiki/Lexical_analysis Tokenize on wikipedia]. Shortly, a Tokenizer regards your C++ or C source code as a large array of characters (sometimes, we call it a string), then this big string can be divided to small atomic strings----a '''token''' (Each token has a unique meanings and can't be divided into sub-strings. A token can be a symbol, an identifier, a keyword, a digital number, etc), meanwhile "white spaces" and "comments" were ignored by the Tokenizer.

for a simple c++ program like below
<source lang = "c">
int main()
{
std::cout << "hello world" << std::endl;
return 0;
}
</source>
After tokenizing, it should give these 15 tokens
<source lang = "cpp">
1 = string "int"
2 = string "main"
3 = opening parenthesis
4 = closing parenthesis
5 = opening brace
6 = string "std"
7 = namespace operator
8 = string "cout"
9 = << operator
10 = string ""hello world""
11 = string "endl"
12 = semicolon
13 = string "return"
14 = number 0
15 = closing brace
</source>

===Tokenizer class===
A class named '''Tokenizer''' was implemented in "tokenizer.h" and "tokenizer.cpp". Seen from the Tokenizer's level, a token is just a [http://docs.wxwidgets.org/stable/wx_unicode.html unicode] wxString. There are several steps to run an instance of Tokenizer.
===preparing the big string===
From the previous section, you know the Tokenizer is just a string cutter. So, the first step is preparing the big string. The string can either be loaded from a source file or a memory buffer. Currently, the Unicode wxString is used.(since we are all using Unicode build of code::blocks, and ANSI mode is outdated and deprecated).
===Get or Peek a token===
'''Tokenizer''' contains a '''file position indicator'''----m_TokenIndex(see [http://en.wikipedia.org/wiki/Fopen File Open In C language]) pointing to the current position of string. So, you can '''Get''' a token or '''Peek''' a token. Here is the function prototype
<source lang = "cpp">
//Get the current token string started from m_TokenIndex,
//After that, increase the m_Tokenindex
wxString GetToken();

//Peak the current token string and but do *NOT* increase the m_TokenIndex
wxString PeekToken();
</source>

For example, if the Tokenizer parses the example code above, you can see how these two methods work.

*After initializing the Tokenizer(preparing the big string), You firstly call the GetToken() function, which will return the first token "int" and increase the m_TokenIndex one step to "int".

*Then, if you call the PeekToken(), which will return a token "main", but the tokenindex was still remaining point to "int".

*If you call the GetToken() again, it will return a "main" immediately and increase the file pointer to "main".

Note: Internally, the Tokenizer class use a '''undo and peek cache''' to do the trick. Once a token is peeked, it is saved in '''m_Peek''' member, so, next time you call GetToken(), it just immediately return the cached value without calling the "DoGetToken()" procedure again.

[[Image:Cb token cache.png]]

===Nested Value of braces===
As you know, braces are exist in pairs, such as "{" and "}", or "[" and "]", Also, these braces can be embeded. So the Tokenizer keep a value '''m_NestLevel''' to indicate how deep you stays. If the Tokenizer meets a '''{''', it will increase the nestValue, and if it meets a '''}''', it will decrease the m_NestLevel. See the pseudo code in Tokenizer.cpp below:
<source lang = "cpp">
if (CurrentChar() == '{')
++m_NestLevel;
else if (CurrentChar() == '}')
--m_NestLevel;
</source>

===SkipUnwanted tokens===
A '''bool''' member variable '''m_SkipUnwantedTokens''' determines whether a regular assignments statement will be omitted or not. For example, a piece of code below:
<source lang = "cpp">
a = b + c;
</source>

If m_SkipUnwantedTokens == true, then once SkipUnwanted() meets the "=" symbol, it will go on skipping every characters until it meets ''',''' or ''';''' or '''}''', so this statement will be omitted by the Tokenizer.

Sometimes, this behavior becomes a nightmare when parsing the statement like default argument in template. Or the default arguments in function.
<source lang = "cpp">
// assignment statement in template arguments
template<class T = int>
class abc {
T m_a;
......
......
}

// assignment statement in function arguments

void foo( int arg1 = 60 )
{
bla bla;
}
</source>
If the Tokenizer finds that an equation sign '''=''', it will skip any character until it meets a '''}''', so, the class declaration or function body will be totally skipped in the unexpected way. In this case, we should manually '''disable''' this functionality by setting m_SkipUnwantedTokens = false to let the Tokenizer parse these statements correctly.

That's why you will see many situations when you enter a function, you should save the m_SkipUnwantedTokens statues and disabled it, when you leave a function, you should manually restore it.(See function implementation in ParseThread.cpp)

===Return a correct token, Macro replacement===
Special token should be replaced for parsing correctly. For example, in the standard c++ header (mingw), there are a string named "_GLIBCXX_STD", this should be replaced to "std". See the dialog below.

[[Image:Cc std replacement.png|400x400px|]]

The inline function in the Tokenizer class will check whether a token should be replaced before return.

<source lang = "cpp">
wxString Tokenizer::MacroReplace(const wxString str)
{
wxStringHashMap::const_iterator it = s_Replacements.find(str);

if (it != s_Replacements.end())
{
// match one!
wxString key = it->first;
wxString value = it->second;
TRACE(_T("MacroReplace() : Replacing '%s' with '%s' (file='%s')."), key.wx_str(), value.wx_str(), m_Filename.wx_str());
if (value[0]=='+' && CurrentChar()=='(')
{
unsigned int start = m_TokenIndex;
m_Buffer[start] = ' ';
bool fillSpace = false;
while (m_Buffer[start]!=')')
{
if (m_Buffer[start]==',')
fillSpace = true;

if (fillSpace==true)
m_Buffer[start]=' ';

start++;
}
m_Buffer[start] = '{';
return value.Remove(0,1);
}
else if (value[0] == '-')
{
unsigned int lenKey = key.Len();
value = value.Remove(0,1);
unsigned int lenValue = value.Len();

for (unsigned int i=1; i<=lenKey; i++)
{
if (i < lenValue)
m_Buffer[m_TokenIndex-i] = value[lenValue-i];
else
m_Buffer[m_TokenIndex-i] = ' ';
}

int firstSpace = value.First(' ');
// adjust m_TokenIndex
m_TokenIndex = m_TokenIndex - lenValue + firstSpace;

return value.Mid(0,firstSpace);
}
else
return value;
}

return str;
}

</source>

[[Image:Cc replace dialog.png|400x400px|none| Code completion build target option in code::blocks]]

Setting the replacement mapping. Note that before return a token, a replacement map was searched to check if it matches any entry in the map, so, the bigger this map goes, the slower it will do parsing.

Note: Code Completion plug-in is not a preprocessor, so it is difficult to deal with the source mixed with many macro, or some strange macros. This is something like Ctags' replacement options "?I identifier?list" in [http://ctags.sourceforge.net/ctags.html#OPERATIONAL%20DETAILS ctags option detial] or [http://codelite.org/LiteEditor/FAQ Code Completion macro FAQ]

For discussion of Ctags, the related thread is [/index.php/topic,10564.msg72424.html#msg72424 Re: namespaces and code completion] and [/index.php/topic,11187.msg77135.html#msg77135 Re: New code completion remarks/issues]

===replacement rules===
====directly replacement AAAAA -> BBBBB====
You can define a rule:
AAAAA -> BBBBB

Which means, if the tokenizer meet a string "AAAAA", then it will returned a string "BBBBB"
====directly replacement AAAAA -> Empty String====
You can define a rule:
AAAAA -> Empty String

The token "AAAAA" is skipped when parsing.

==== AAAAA -> +BBBBB====
For example, when

<source lang = "cpp">
_GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)

/// See bits/stl_deque.h's _Deque_base for an explanation.
template<typename _Tp, typename _Alloc>
struct _Vector_base
{
typedef typename _Alloc::template rebind<_Tp>::other _Tp_alloc_type;

......

_GLIBCXX_END_NESTED_NAMESPACE
</source>

We should replace the string "_GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)"
to "namespace std {", here, we introduce two replacement rules:
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| _GLIBCXX_BEGIN_NESTED_NAMESPACE || +namespace
|-
| _GLIBCXX_END_NESTED_NAMESPACE || }
|}

In this rule, we firstly replace the "_GLIBCXX_BEGIN_NESTED_NAMESPACE" with the "namespace", then, we reserve the "std", and change the closing parenthesis to an opening brace. (See the image above), also, every token string "_GLIBCXX_END_NESTED_NAMESPACE" will be replaced by "}".
[[File:CCreplacement_rule.png]]

So, the code becomes to like below:
<source lang = "cpp">
namespace std {

/// See bits/stl_deque.h's _Deque_base for an explanation.
template<typename _Tp, typename _Alloc>
struct _Vector_base
{
typedef typename _Alloc::template rebind<_Tp>::other _Tp_alloc_type;

......

}
</source>
==== AAAAA -> -BBBBB====

For example, when
<source lang = "cpp">
_GLIBCXX_BEGIN_NAMESPACE_TR1
...
...
_GLIBCXX_END_NAMESPACE_TR1
</source>

We should replace the string "_GLIBCXX_BEGIN_NAMESPACE_TR1"
to "namespace tr1 {", here, we introduce two replacement rules:
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| _GLIBCXX_BEGIN_NAMESPACE_TR1 || -namespace tr1 {
|-
| _GLIBCXX_END_NAMESPACE_TR1 || }
|}

In this rule, we firstly replace the "_GLIBCXX_BEGIN_NAMESPACE_TR1" with the "namespace", then, add aditional string "tr1 {"

So, the code becomes:
<source lang = "cpp">
namespace tr1 {
...
...
}
</source>

==== AAAAA -> *====
In this case, we call it a "strip the next "(" and ")" rule. for example:

The rule syntax is:

XXXXXX -> *

For example, In the source code below:
<source lang = "cpp">
CVAPI(void) cvFxxxx();
CVAPI(cvMat *) cvFyyy();
</source>

will become to (if I add a replacement rule CVAPI -> *)

<source lang = "cpp">
void cvFxxxx();
cvMat * cvFyyy();
</source>

==== AAAAA -> @====
With this rule, you can trigger the tokenizer to work in macro replacement mode, so if you have the code
<source lang = "cpp">
#define _EXFUN(name, proto) name proto

FILE * _EXFUN(fopen, (const char *__restrict _name, const char *__restrict _type));
</source>
You can add a rule _EXFUN -> @, so that the tokenizer will go to macro replacement mode if he see a _EXFUN. See details in [/index.php/topic,19278.msg131810.html#msg131810 Is it possible for the parser to support newlib prototypes?]

==High level parser(Syntax Analysis)==
This is the main flow of a parser.

[[Image:Parser_Flow.gif]]
===parser thread===
Basically, we can say, the low level parser(Tokenizer) moves its pointer character by character, and return a wxString(token) to feed the high level parser(Syntax analyzer).All the syntax analysis was done in ParserThread. A thread must be created to parse a source file. see parserthread.cpp and parserthread.h, a thread will be allocated from thread pool. For example, a file contains these statement:
<source lang = "cpp">
void f1();
int f2(char c);
float f3(void * p);
int f1;
double f2;
</source>
After the ParserThread finished its parsing, it will recognize five tokens, which has the keyword "f1","f2" and "f3", note, tokens can have the same names, but they differ from different types( variables, functions...).

===Token class===
How can a large number of tokens be recorded? A '''Token'''(note: it as a capital means it's class type) class was introduced to recorded every token. For boosting the speed of allocating Tokens, the "new" and "delete" operator were overloaded in its base class BlockAllocated. See the [http://en.wikipedia.org/wiki/Memory_pool memory pool] page on wikipedia as a reference.
<source lang = "cpp">
class Token : public BlockAllocated<Token, 10000>
{
......
wxString m_Type; // this is the return value (if any): e.g. const wxString&
wxString m_ActualType; // this is what the parser believes is the actual return value: e.g. wxString
wxString m_Name;
wxString m_Args;
wxString m_AncestorsString; // all ancestors comma-separated list
unsigned int m_File;
unsigned int m_Line;
unsigned int m_ImplFile;
unsigned int m_ImplLine; // where the token was met
unsigned int m_ImplLineStart; // if token is impl, opening brace line
unsigned int m_ImplLineEnd; // if token is impl, closing brace line
TokenScope m_Scope;
TokenKind m_TokenKind;
bool m_IsOperator;
bool m_IsLocal; // found in a local file?
bool m_IsTemp; // if true, the tree deletes it in FreeTemporaries()
bool m_IsConst; // the member method is const (yes/no)

int m_ParentIndex;
TokenIdxSet m_Children;
TokenIdxSet m_Ancestors;
TokenIdxSet m_DirectAncestors;
TokenIdxSet m_Descendants;
......

};
</source>
You can see the Token class contains all the information needed for recording its locating, its type or class derived hierarchy...

For example, in the source code in[Low level parser(Lexical analysis)]. A Token for "main" should contains it's name (obviously , m_Name="main" ), then m_File will record which file dose this Token exist. m_Line will give the line number of "main" in this source file, and so on.

===Memory Pool--BlockAllocated class===
In BlockAllocated class, there is only a static member say "static BlockAllocator<T, pool_size, debug> allocator;" to keep all the pre-allocated memory for all derived class.

'''10000''' means a pool of 10000 Tokens were allocated in the memory pool, so, dynamically allocate a Token object will be fast and efficient.

[[Image:Cb blockalloc.png|frame|none| Operator new overloading for fast allocate in the heap]]

===ParserThread===
The function Parse() will do the most job of syntax analysis. See the pseudo code below.
<source lang = "cpp">
ParserThread::Parse()
{
......
do
{
......
DoParse();
......

}while(false);

return result;
}

</source>

In the DoParse(), it checks the token from Tokenizer. For example, if the token words = "enum", then, the ParserThread::HandleEnum() will do the job to parse this enum block.

===A simple look ahead parser===
We can explain a little about it parser, the member variable '''m_Str''' of class ParserThread will be considered as a '''type stack''', for example, we want to parse the statement below:

<source lang = "cpp">
symbolA symbolB symbolC symbolD;
</source>

Only symbolD can be recognized as a variable, and it has a type of "symbolA symbolB symbolC". When the parser meets each symbol, it will look ahead to see the next token is whether ";", if not, the current token will '''pushed''' to m_Str. These iteration will be ended when the parser look ahead one step from symbolD and find the next token is a ";".

===DoParse Examples===
====Handling class declaration====
The main routing of handling class was in
ParserThread::HandleClass function
If the parserThread meet these statement
<source lang = "cpp">
class AAA{
int m_a;
int m_b;
} ;
</source>
It will surely add a Token of "AAA", it's type is "class".

What about these statements
<source lang = "cpp">
class AAA{
int m_a;
int m_b;
} x,y,z;
</source>
The parserThread should firstly add a Token "AAA", then it should regard "x", "y", "z" are three variables of type "AAA". This was done by "ReadVarNames()" function, it will read every comma separated variables after a class declaration.

====Handling typedef statement====
Sometimes, you can see these code blocks:
<source lang = "cpp">
typedef class AAA{
int m_a;
int m_b;
} BBB,CCC;
</source>
If the parser meets the keyword "typedef", firstly it set the "m_ParsingTypedef = ture" to indicate that we are parsing a typedef statement.

Next, it meets a keyword "class", which also indicate it is a class declaration. So, the HandleClass function will do the task. A Token of "class AAA" will be added to the TokenTree. Wait a minute, how can we deal with "BBB" and "CCC", this is not the same case as previous code, we can't regard "BBB","CCC" as variables. In this case, another function "ReadClsName()" will be called. For simplicity of TokenTree, we just regard "BBB" and "CCC" as derived class of "AAA".

How does the parserThread know between these two cases. Here is the code:

<source lang = "cpp">
if (m_ParsingTypedef)
{
m_Str.Clear();
ReadClsNames(newToken->m_Name);
// m_ParsingTypedef = false;
break;

}
else
{
m_Str = newToken->m_Name;
ReadVarNames();
m_Str.Clear();
break;
}
</source>

That's the whole thing I would like to write about handling class and handling typedef.

==TokenTree&SearchTree==
Maybe, you would ask a question: where do these Tokens store? The answer is that all the Tokens will be recorded in "TokenTree class".

When a certain Token is identified(whether it's a global variable, a class declaration, a class member function, and so on), it will be inserted to a database(TokenTree).

Furthermore, for fast Token query, Tokens should be sorted by it's wxString m_Name member;

A '''compact Patricia tree'''(see the wikipedia [http://en.wikipedia.org/wiki/Radix_tree Patricia tree on wikipedia]) is built to hold all their names.

For example, If you add three item to the TokenTree.
<source lang = "cpp">
mytree->AddItem(_T("physics"),_T("1 - uno"));
mytree->AddItem(_T("physiology"),_T("2 - dos"));
mytree->AddItem(_T("psychic"),_T("3 - tres"));
</source>

The Patricia tree structure will show as below, the edge of a tree contains a "label string" and the number in parentheses refers to a node Id.

<source lang = "cpp">
- "" (0)
\- "p" (4)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sychic" (5)
</source>
===Animation of Patricia tree===
A web page gives an animation of building a Patricia tree, you can see how the tree node added. See here [http://bootstrapping.wordpress.com/2008/01/24/prefix-searching-with-radix-tree/ Prefix searching with Radix Tree]

A better animation demo of Patricia tree can be found in [http://people.cis.ksu.edu/%7Erhowell/viewer/viewer.html Search Tree Viewer]. In this page, you can select the tree type, and enter some strings, then the tree will dynamically show in the window.

===SearchTree Node===
A Node should contains at least several essential element. They are:
# An edge: in the image below, the gray filled area shows a Node, since each edge belong to the next node, for example, the Node has an edge "abcd".
# SearchTreeItemMap: because our searchTree is a compact Patricia tree which means an edge contains many items. Such as, "ab" , "abc", "abcd" all the suffix string belong to the edge "abcd"
# SearchTreeLinkMap: This is an associated container map<wxChar,NodeId>, which store all "pointers" to its child Node. In the example below, "e" points to a Node of "efg", while "x" points to "xyz".
# Node depth: depth of Search Tree Node is defined by the string length from the "root node". See a depth of each node on the search tree above. For example, the Node of "hysi" has a m_Depth = 5 ("" + "p" + "hysi" = 5).

===Node Lable===
For example, the node "hysi" (2) has two children, they are "cs" (1) and "ology" (3), show below.

[[Image:Cb tree node lable.png]]

For more information, see the forum discussion here. [/index.php/topic,1696.0.html rickg22's SearchTree development] as a reference.

===How a new item is added to the tree===
When you add a new key (string) to the tree, some node should be splited, and new node need to be added. For example [/index.php/topic,1696.msg12617.html#msg12617 this post]show some details.

Suppose we have two nodes in the tree, the node id is 0 (root node) and 1, the tree hold only one key string(item) "physics":
<source lang = "cpp">
Adding word: physics
1 items in the tree
- "" (0)
\- "physics" (1)
</source>
Now, if another key string "physiology" is added to the tree, we now firstly check "physiology" is already in the tree, if not, we need to find the common string "physi", so the node 1 should be splited after the common string, so you get the following result.
<source lang = "cpp">
Adding word: physiology
2 items in the tree
- "" (0)
\- "physi" (2)
+- "cs" (1)
\- "ology" (3)
</source>
Here, the middle node "physi" is added. the original node 1's lable is shorten to "cs", and a new node "ology" is added as a new child node to the middle node.

In the other case, the new added item does not cause a new node to be added to the tree, only a node need to be extended by its ledge. For example:
<source lang = "cpp">
6 items in the tree
- "" (0)
\- "p" (4)
+- "aranormal" (8)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sych" (6)
+- "i" (9)
| +- "atrist" (10)
| \- "cs" (5)
\- "otic" (7)

</source>
Now, you add a new item "psychiatrists", pay attention to the node 10 in the above tree, we have already an item "psychiatrist", when the new item "psychiatrists" is added, we can just extend the node 10's edge from "artrist" to "artrists", thus no new node is needed.
<source lang = "cpp">
7 items in the tree
- "" (0)
\- "p" (4)
+- "aranormal" (8)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sych" (6)
+- "i" (9)
| +- "atrists" (10)
| \- "cs" (5)
\- "otic" (7)
</source>
Note that now, the node 20 now contains two items. It is a map (depth -> item).
<source lang = "cpp">
depth -> item
12 -> "psychiatrist"
13 -> "psychiatrists"
</source>

===How to query a Token by a keyword===
The parser collect all the Token information, and stored them in the TokenTree, the GUI function can query keywords from the database to show function tips or to build a Class Browser tree.

For example, if you want to find all the Tokens named "ab". In the picture above from TokenDatabase(TokenTree). we can search on the Patricia tree containing all the Tokens names, finaly, we find a tree node with a edge "abcd". So, "ab" is in it's Node's items list. Then, we can find a TokenIdxSet in a vector<TokenIdxSet>, this TokenIdxSet has all the index named by "ab", so, we can get the result like: There are many Tokens named "ab".Token "ab" may be a member varialbe name in a class, or a global function name...

<source lang = "cpp">
ClassA::ab
ClassB::ab
void ab()
....
</source>

[[Image:CCTokenTree1.png]]

==Flexible Parser structure==
The Parser class( in Parser.cpp and Parser.h ) has re-factored to support every project associate with a Parser object (svn revision > 6268 ). Which means: One Parser object per project, so, every project (xxx.cbp) will hold its own Token macro defines and Token trees.

Due to the new introduced conditional preprocessor handling mechanism, the same source file may give different Tokens due to the different macro defines in different project. Also, CC support parsing on the files which does not belong to any project.

#You open a project in CB, then all the files belong to the project( related to the project) will be parsed in CC.
#Now, you open another file( we call it a "separate file" later) which is not belong to the current project nor any other opened project.
#Then the CC will create a "temporary parser" named "NONE“ parser, and add this separate file to the "NONE" parser.
#So, you can still see the class tree when viewing the separate file.
#Once you close this separate file, the "NONE" parser will automatically be removed.

The main idea is: Now, We can let the CC do parse on some separate files
and support class browsing in Symbol browser.

==Automatic Code Completion==
===Find the search scope===

[[Image:CC SearchScope.png]]

For example, when you are editing, and the caret position was located at "E" as shown in the above image, the first thing doing an automatic code completion is find the '''search scope'''.

Here are some steps to get the initial(first) search scope:

*First, you need to correct all the "using namespace XXXX" directives at the beginning the the current source file.(labeled with "A"), this means all the child tokens of "namespace Scintilla" should be searched.
*Secondly, find the function body where the current caret position locates. eg, the above code, the caret is in the "RunStyles::RunFromPosition()" function, so the function parameter variable "position"(labeled with "C" and the local variable "run" (labeled as "D") is also a matching Tokens.
*Thirdly, look at the "B", this means we are in the class named "RunStyles", so, "RunStyles" is also a search scope.
*Finally, don't forget the global namespace scope, because the tokens of this scope are exposed to everywhere of the source.

===Break up the current statement===
<source lang = "cpp">
VariableA.m_VariableB.Functi
</source>
If you are entering the above statement, the caret is behind the "Functi". Then the whole line will be break up to several "parsing component".

There are three components: "'''VariableA'''" , "'''m_VariableB'''" and "'''Functi'''". In the next section, I will introduce that the AI matching routing will start from matching the first component with the initial(first) search scope.

===Do an AI match===
Doing an AI match is just like a walking on a tree, and find the final matching result.See the image below:

[[image:CC AI Match.png]]

'''Here is the matching algorithm''':

Now, suppose we have an initial "search scope", and a "component" array.

The AI match algorithm starts from matching the "sub search scopes" with the first "component", then, the matched "sub search scope"(red rectangle) will be the initial "search scope" again matching with the second "component", this matching routing is running continuously until we matches with the final component. Then we get the whole matching result, that will be show as a auto code completion list.

==Code completion debugging support==
===Debug Log output===
If you want to debug your plug-in, you may need to Logout the debug message to the "Code::Blocks Debug" panel. Here is the sample code:

<source lang = "cpp">
Manager::Get()->GetLogManager()->DebugLog(_("XXXXX "));

wxString name;
wxString args;
wxString m_Str;
//.....
Manager::Get()->GetLogManager()->DebugLog(F(_T("Add token name='")+name+_T("', args='")+args+_T("', return type='") + m_Str+ _T("'")));

</source>

Also, you need start the Code::Blocks with the command line argument. For example in windows.

'''codeblocks.exe --debug-log'''

then a Code::blocks debug panel will be shown to display the log.
[[Image:CbDebugLog.png|frame|none| Debug Log output panel]]

===TRACE macro support===
As you can see in the source file like "tokenizer.cpp" or "parserthread.cpp", there is a macro definition in the beginning of the source.

<source lang = "cpp">
#define CC_CODECOMPLETION_DEBUG_OUTPUT 0

#if CC_CODECOMPLETION_DEBUG_OUTPUT == 1
#define TRACE(format, args...) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args))
#define TRACE2(format, args...)
#elif CC_CODECOMPLETION_DEBUG_OUTPUT == 2
#define TRACE(format, args...) \
do \
{ \
if (g_EnableDebugTrace) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args)); \
} \
while (false)
#define TRACE2(format, args...) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args))
#else
#define TRACE(format, args...)
#define TRACE2(format, args...)
#endif
</source>
This is a quite complex macro definition. So, if CC_CODECOMPLETION_DEBUG_OUTPUT is defined as 0, these debugging macros were disabled. If CC_CODECOMPLETION_DEBUG_OUTPUT is defined as 1, only the TRACE macro will be defined, so you can plot some messages to the Debug log. It is always the parser will parser many files, so the debug messages will be flooding. If we only interest in the debug message when we are parsing a specific source file, the best way was define CC_CODECOMPLETION_DEBUG_OUTPUT as 2. Now, TRACE macro will plot the message only in one source file. The source file name can be specified in token.cpp
<source lang = "cpp">
const wxString g_DebugTraceFile = _T("myfile.cpp");
</source>
This way, only the debug message when parsing "myfile.cpp" will be traced.

===Code-Completion debug tool dialog===
When you press '''shift''' and '''ctrl''' key and double click on any entry of the navigator tree entry, a debug tool dialog will pop up to give a more detail about the selected token. You can query its information such as its member variables, its Ancestors and so on.

[[Image:CcDebugToolDialog.png]]

===Debug Smart Sense log output ===
When you hold the'''shift''' and '''ctrl''' key and right click on any entry of the navigator tree entry, the context menu will have a "Debug SmartSense" menu entry shown. You can click it to enable it. See the image blow. Then, all the debug log information when doing an Auto-completion will be shown in the "Debug Log" panel.

[[File:Cc debug smartsense.png]]

==Mutexs and lockers in CC==
We need lockers to avoid multiply thread issues of wxString. More detailed can be found: [/index.php/topic,17543.0.html wxString and the locker issue in our CC code], to avoid such issue, we need lockers.
There are three main kind of lockers.
<nowiki>wxMutex s_ParserMutex;
wxMutex s_TokenTreeMutex;
wxMutex m_ClassBrowserBuilderThreadMutex;</nowiki>
The first one was to protect multiply access to Parser objects, this is a static variable. The second one tries to forbid the multiply access to the TokenTree, the last one is used to build the symbol browser tree(usually show in the left docked panels of the C::B main frame)

The associated Macros are below:
<source lang = "c">
// For tracking, either uncomment:
//#define CC_ENABLE_LOCKER_TRACK
// ...or:
#define CC_ENABLE_LOCKER_ASSERT
// ..or none of the above.

#if defined(CC_ENABLE_LOCKER_TRACK)
// TRACKING MUTXES
// [1] Implementations for tracking mutexes:
#define THREAD_LOCKER_MTX_LOCK(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Lock() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_LOCK_SUCCESS(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Lock().Success() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_UNLOCK(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Unlock() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_UNLOCK_SUCCESS(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Unlock().Success() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_FAIL(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Fail() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
// [2] Cumulative convenient macros for tracking mutexes [USE THESE!]:
#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) \
{ \
THREAD_LOCKER_MTX_LOCK(M); \
if (M.Lock()==wxMUTEX_NO_ERROR) \
THREAD_LOCKER_MTX_LOCK_SUCCESS(M); \
else \
THREAD_LOCKER_MTX_FAIL(M); \
}
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) \
{ \
THREAD_LOCKER_MTX_UNLOCK(M); \
if (M.Unlock()==wxMUTEX_NO_ERROR) \
THREAD_LOCKER_MTX_UNLOCK_SUCCESS(M); \
else \
THREAD_LOCKER_MTX_FAIL(M); \
}
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK

// TRACKING CRITICAL SECIONS
// [2] Implementations for tracking critical sections:
#define THREAD_LOCKER_CS_ENTER(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Enter() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_CS_ENTERED(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Entered() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_CS_LEAVE(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Leave() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
// [2] Cumulative convenient macros for tracking critical sections [USE THESE!]:
#define CC_LOCKER_TRACK_CS_ENTER(CS) \
{ \
THREAD_LOCKER_CS_ENTER(CS); \
CS.Enter(); \
THREAD_LOCKER_CS_ENTERED(CS); \
}
#define CC_LOCKER_TRACK_CS_LEAVE(CS) \
{ \
THREAD_LOCKER_CS_LEAVE(CS); \
CS.Leave(); \
}
#elif defined CC_ENABLE_LOCKER_ASSERT
#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();

#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) cbAssert(M.Lock()==wxMUTEX_NO_ERROR);
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) cbAssert(M.Unlock()==wxMUTEX_NO_ERROR);
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#else
#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();

#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) M.Lock();
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) M.Unlock();
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#endif
</source>

Each mutex need a Lock and Unlock macro, like for mutex for Parser, we need CC_LOCKER_TRACK_P_MTX_LOCK and CC_LOCKER_TRACK_P_MTX_UNLOCK.

==Usefull Links==

*A discussion on search tree in the forum [/index.php/topic,1696.0.html] and [/index.php/topic,1581.0.html].

*Another opensource IDE [http://vcfbuilder.org/?q=node/139 VCF builder]or[https://sourceforge.net/projects/vcfbuilder/ vcfbuilder on sf], By the way , VCF use a CodeStore based on [http://www.antlr.org/ antlr parser] to deal with parsing, the whole source code can be check out from
<pre>svn co https://vcfbuilder.svn.sourceforge.net/svnroot/vcfbuilder vcfbuilder</pre>

*online book[http://www.macs.hw.ac.uk/~alison/alg/details.html Data Structures and Algorithms II Course ] and [http://www.macs.hw.ac.uk/~alison/alg/lectures.html pdf lectures]

*A forum discussion on why a standard perprocessor and parser works slowly. [/index.php/topic,2494.msg19801.html#msg19801 parsing iostream header takes 5 seconds]

*[http://www.codelite.org CodeLite] is another open source IDE using wxWidgets, use Ctags as a indexing service, and do context expression syntactic analysis generated from Lex and Yacc tools.See the explanation in forum message by it's author eranif [/index.php/topic,10087.msg70875.html#msg70875 How does Codelite's CC work with CTags and Yacc&Lex]

*Hopefully, we can use the patricia tree from the standard library, see here:[http://gcc.gnu.org/onlinedocs/libstdc++/ext/pb_ds/trie_based_containers.html trie]

* a blog from KDE4's developer, it explain the code completion in KDE4, see here:[http://zwabel.wordpress.com/ zwabel' blog]

* QT creator source code from [http://qt.gitorious.org/qt-creator/qt-creator/trees/master QT-creator source]

* [http://websvn.kde.org/trunk/KDE/kdevelop/ Kdevelop source code] and it's [http://websvn.kde.org/trunk/KDE/kdevelop/languages/cpp/parser/ parser]

* [http://stackoverflow.com/questions/1220099/how-does-code-completion-work How does code completion work? - Stack Overflow]

* [/index.php/topic,11724.0.html Just a reminder Codelite IDE now have improved it's parser]

*[http://padator.org/software-yacfe.php Yacfe, a parser with proprocessor enabled]

*[/index.php/topic,1581.msg11701.html#msg11701 A Mini C++ interpreter] from the book "The Art of C++ by Herbert Schildt", source code can be download [http://books.mcgraw-hill.com/downloads/products/0072255129/0072255129_code.zip here]

*[http://www.macs.hw.ac.uk/~alison/alg/lectures/l7.pdf Lecture 7: Parsing (intro) (pdf)] and [http://www.macs.hw.ac.uk/~alison/alg/lectures/l8.pdf Lecture 8: Recursive Descent Parsing (pdf)] from [http://www.macs.hw.ac.uk/~alison/alg/lectures.html Data Structures and Algorithms II]

*There are some online "Compiler design" books listed in [http://www.freetechbooks.com/compiler-design-and-construction-f14.html Free Online Compiler Design and Construction Books :: FreeTechBooks.com], and the best one I think is : [http://www.diku.dk/hjemmesider/ansatte/torbenm/Basics/index.html Basics of Compiler Design], and you can get a basic understanding.

*[http://wiki.eclipse.org/CDT/designs/Overview_of_Parsing CDT/designs/Overview of Parsing].

* [http://en.literateprograms.org/Radix_tree_(C) Radix tree (C) - LiteratePrograms]

* LLVM's online tutorials on how to write a simple compiler [http://llvm.org/docs/tutorial/index.html LLVM Tutorial]

* Roberto Raggi's new parser[https://github.com/robertoraggi/cplusplus cplusplus 5 My experimental C++ front end], note Roberto Raggi is the author of the parser for both Qtcreator and Kdeveloper IDE.

* KDevelop are discussing clang now, see [http://milianw.de/blog/katekdevelop-sprint-2014-let-there-be-clang Kate/KDevelop Sprint 2014: Let There Be Clang | Milian Wolff]

Developer documentation

2014-07-17T05:14:35Z

Ollydbg: /* Developing C::B with Git */ SVN style patch

Code Completion Design

2014-06-24T02:59:04Z

Ollydbg: add a new user defined macro replacement rule AAAAA->@

[[Category:Developer Documentation]]
==How to build==
===Get the source code===
When you download the svn source code of code::blocks,(see here [[Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_sources]] the source code of CodeCompletion plugin was already included.

Here is the screen shot when I opened the codecompletion source code in C::B's source navigator view.

[[Image:Devcc1.png|300x300px| Code completion source tree opened in code::blocks]]

===Build the code completion plug-in===
If you only want to build the Code Completion plug-in, you can select it in the "build target list" (Note: by default, the Build target option was "ALL", which means all the targets in the current workspace will be build), see the screen shot below:

[[Image:Buildcc.PNG|frame|none| Code completion build target option in code::blocks]]

Don't forget to run the batch script file "update.bat" after you build the target, this procedure will update your output folder package and strip the debug information. See the wiki page [[Installing_Code::Blocks_from_source_on_Windows]] for more information.

===A brief description of every project files===
From now on, we use '''CC''' as an abbreviation for '''code completion plug-in'''.
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| ccdebuginfo.cpp || a dialog for debugging CC, can be opened by double click on the code browser tree entry with shift and ctrl key pressed
|-
| ccoptionsdlg.cpp|| code completion options dialog, can be opened by menu->setting->editor->code completion and symbols browser
|-
| ccoptionsprjdlg.cpp|| setting the additional parser search path
|-
| classbrowser.cpp||viewing the symbols tree ctrl(token tree).
|-
| classbrowserbuilderthread.cpp|| a thread to build the class browser tree above
|-
| codecompletion.cpp ||The Main file need by code completion plug-in, maintain all the CC's GUI and native parser
|-
| insertclassmethoddlg.cpp|| a dialog to insert class method, can be open by context menu in editor
|-
| nativeparser.cpp||a class derived from wxEvtHandler, NativeParser class has a member variable "Parser m_Parser";
|-
| selectincludefile.cpp|| select multiply matched token names before any jump to declaration or jump to implementation.
|-
|parser/parser.cpp|| Parser class was also derived from wxEvtHandler, can start batch parse... this class has member variables like :cbThreadPool m_Pool(which will create a thread from thread pool for each file need passed);TokenTree* m_pTokens(contains all the Token database);
|-
|parser/parserthread.cpp||will do the syntax analysis for every file in a project, it has a Tokenizer as member variable
|-
|parser/token.cpp|| definition of the "Token" class, and TokenTree(which means the Token dababase)
|-
|parser/tokenizer.cpp|| tokenizer will return every wxString it regard as a symbol by GetToken(), also do a replacement before return
|-
|parser/searchtree.cpp|| implement the patricia search tree using by TokenTree
|-
|Header files|| no description needed
|}
==Structure of CodeCompletion plugin==
[[Image:CodeCompletionPluginStructure.png| Code completion plugin Structure]]

The above image show the main structure of our CodeCompletion plugins. The main class are:
* CodeCompletion: this is the class for main plugin), it handle event sent from the C::B core. Toolbar handling was done in this class.
* NativeParser: as a main member variable of the CodeCompletion class, this class is like the Parser manager class, it create/delete Parser instances when a project load/closed.
* Parser: this class is mainly for handling Tokens. Parser class hold a TokenTree which record all the Tokens. Parser class also hold a thread pool, it can either run the parsing task in the pool(this means the parsing task will be done in a separate thread), or directly by a function call.
* Parserthread: The class derived from the worker thread(cbThreadedTask class), it member function DoParse() is the function for parsing.

Besides that, when trying to show the suggestion list(auto completion list, or code completion list), the NativeParser need to analyze the current the current statement structure, and query the symbol(token) information from the Tokentree, this is mostly done in ResolveExpression() member function.

Some important note: when all Parserthread instances finish parsing job in the pool, the thread pool will send an event to its parent(in this case, it is the Parser class), so the Parser know that the parsing is done, or the Parser can assign another parsing jobs to the thread pool.

==Low level parser(Lexical analysis, Tokenize)==
For someone haven't heard what does "Token" and "Tokenize" mean, you should read the wikibooks article [http://en.wikibooks.org/wiki/C%2B%2B_Programming/Compiler#Compilation A brief explain of what does a parser do] and [http://en.wikipedia.org/wiki/Lexical_analysis Tokenize on wikipedia]. Shortly, a Tokenizer regards your C++ or C source code as a large array of characters (sometimes, we call it a string), then this big string can be divided to small atomic strings----a '''token''' (Each token has a unique meanings and can't be divided into sub-strings. A token can be a symbol, an identifier, a keyword, a digital number, etc), meanwhile "white spaces" and "comments" were ignored by the Tokenizer.

for a simple c++ program like below
<source lang = "c">
int main()
{
std::cout << "hello world" << std::endl;
return 0;
}
</source>
After tokenizing, it should give these 15 tokens
<source lang = "cpp">
1 = string "int"
2 = string "main"
3 = opening parenthesis
4 = closing parenthesis
5 = opening brace
6 = string "std"
7 = namespace operator
8 = string "cout"
9 = << operator
10 = string ""hello world""
11 = string "endl"
12 = semicolon
13 = string "return"
14 = number 0
15 = closing brace
</source>

===Tokenizer class===
A class named '''Tokenizer''' was implemented in "tokenizer.h" and "tokenizer.cpp". Seen from the Tokenizer's level, a token is just a [http://docs.wxwidgets.org/stable/wx_unicode.html unicode] wxString. There are several steps to run an instance of Tokenizer.
===preparing the big string===
From the previous section, you know the Tokenizer is just a string cutter. So, the first step is preparing the big string. The string can either be loaded from a source file or a memory buffer. Currently, the Unicode wxString is used.(since we are all using Unicode build of code::blocks, and ANSI mode is outdated and deprecated).
===Get or Peek a token===
'''Tokenizer''' contains a '''file position indicator'''----m_TokenIndex(see [http://en.wikipedia.org/wiki/Fopen File Open In C language]) pointing to the current position of string. So, you can '''Get''' a token or '''Peek''' a token. Here is the function prototype
<source lang = "cpp">
//Get the current token string started from m_TokenIndex,
//After that, increase the m_Tokenindex
wxString GetToken();

//Peak the current token string and but do *NOT* increase the m_TokenIndex
wxString PeekToken();
</source>

For example, if the Tokenizer parses the example code above, you can see how these two methods work.

*After initializing the Tokenizer(preparing the big string), You firstly call the GetToken() function, which will return the first token "int" and increase the m_TokenIndex one step to "int".

*Then, if you call the PeekToken(), which will return a token "main", but the tokenindex was still remaining point to "int".

*If you call the GetToken() again, it will return a "main" immediately and increase the file pointer to "main".

Note: Internally, the Tokenizer class use a '''undo and peek cache''' to do the trick. Once a token is peeked, it is saved in '''m_Peek''' member, so, next time you call GetToken(), it just immediately return the cached value without calling the "DoGetToken()" procedure again.

[[Image:Cb token cache.png]]

===Nested Value of braces===
As you know, braces are exist in pairs, such as "{" and "}", or "[" and "]", Also, these braces can be embeded. So the Tokenizer keep a value '''m_NestLevel''' to indicate how deep you stays. If the Tokenizer meets a '''{''', it will increase the nestValue, and if it meets a '''}''', it will decrease the m_NestLevel. See the pseudo code in Tokenizer.cpp below:
<source lang = "cpp">
if (CurrentChar() == '{')
++m_NestLevel;
else if (CurrentChar() == '}')
--m_NestLevel;
</source>

===SkipUnwanted tokens===
A '''bool''' member variable '''m_SkipUnwantedTokens''' determines whether a regular assignments statement will be omitted or not. For example, a piece of code below:
<source lang = "cpp">
a = b + c;
</source>

If m_SkipUnwantedTokens == true, then once SkipUnwanted() meets the "=" symbol, it will go on skipping every characters until it meets ''',''' or ''';''' or '''}''', so this statement will be omitted by the Tokenizer.

Sometimes, this behavior becomes a nightmare when parsing the statement like default argument in template. Or the default arguments in function.
<source lang = "cpp">
// assignment statement in template arguments
template<class T = int>
class abc {
T m_a;
......
......
}

// assignment statement in function arguments

void foo( int arg1 = 60 )
{
bla bla;
}
</source>
If the Tokenizer finds that an equation sign '''=''', it will skip any character until it meets a '''}''', so, the class declaration or function body will be totally skipped in the unexpected way. In this case, we should manually '''disable''' this functionality by setting m_SkipUnwantedTokens = false to let the Tokenizer parse these statements correctly.

That's why you will see many situations when you enter a function, you should save the m_SkipUnwantedTokens statues and disabled it, when you leave a function, you should manually restore it.(See function implementation in ParseThread.cpp)

===Return a correct token, Macro replacement===
Special token should be replaced for parsing correctly. For example, in the standard c++ header (mingw), there are a string named "_GLIBCXX_STD", this should be replaced to "std". See the dialog below.

[[Image:Cc std replacement.png|400x400px|]]

The inline function in the Tokenizer class will check whether a token should be replaced before return.

<source lang = "cpp">
wxString Tokenizer::MacroReplace(const wxString str)
{
wxStringHashMap::const_iterator it = s_Replacements.find(str);

if (it != s_Replacements.end())
{
// match one!
wxString key = it->first;
wxString value = it->second;
TRACE(_T("MacroReplace() : Replacing '%s' with '%s' (file='%s')."), key.wx_str(), value.wx_str(), m_Filename.wx_str());
if (value[0]=='+' && CurrentChar()=='(')
{
unsigned int start = m_TokenIndex;
m_Buffer[start] = ' ';
bool fillSpace = false;
while (m_Buffer[start]!=')')
{
if (m_Buffer[start]==',')
fillSpace = true;

if (fillSpace==true)
m_Buffer[start]=' ';

start++;
}
m_Buffer[start] = '{';
return value.Remove(0,1);
}
else if (value[0] == '-')
{
unsigned int lenKey = key.Len();
value = value.Remove(0,1);
unsigned int lenValue = value.Len();

for (unsigned int i=1; i<=lenKey; i++)
{
if (i < lenValue)
m_Buffer[m_TokenIndex-i] = value[lenValue-i];
else
m_Buffer[m_TokenIndex-i] = ' ';
}

int firstSpace = value.First(' ');
// adjust m_TokenIndex
m_TokenIndex = m_TokenIndex - lenValue + firstSpace;

return value.Mid(0,firstSpace);
}
else
return value;
}

return str;
}

</source>

[[Image:Cc replace dialog.png|400x400px|none| Code completion build target option in code::blocks]]

Setting the replacement mapping. Note that before return a token, a replacement map was searched to check if it matches any entry in the map, so, the bigger this map goes, the slower it will do parsing.

Note: Code Completion plug-in is not a preprocessor, so it is difficult to deal with the source mixed with many macro, or some strange macros. This is something like Ctags' replacement options "?I identifier?list" in [http://ctags.sourceforge.net/ctags.html#OPERATIONAL%20DETAILS ctags option detial] or [http://codelite.org/LiteEditor/FAQ Code Completion macro FAQ]

For discussion of Ctags, the related thread is [/index.php/topic,10564.msg72424.html#msg72424 Re: namespaces and code completion] and [/index.php/topic,11187.msg77135.html#msg77135 Re: New code completion remarks/issues]

===replacement rules===
====directly replacement AAAAA -> BBBBB====
You can define a rule:
AAAAA -> BBBBB

Which means, if the tokenizer meet a string "AAAAA", then it will returned a string "BBBBB"
==== AAAAA -> +BBBBB====
For example, when

<source lang = "cpp">
_GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)

/// See bits/stl_deque.h's _Deque_base for an explanation.
template<typename _Tp, typename _Alloc>
struct _Vector_base
{
typedef typename _Alloc::template rebind<_Tp>::other _Tp_alloc_type;

......

_GLIBCXX_END_NESTED_NAMESPACE
</source>

We should replace the string "_GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)"
to "namespace std {", here, we introduce two replacement rules:
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| _GLIBCXX_BEGIN_NESTED_NAMESPACE || +namespace
|-
| _GLIBCXX_END_NESTED_NAMESPACE || }
|}

In this rule, we firstly replace the "_GLIBCXX_BEGIN_NESTED_NAMESPACE" with the "namespace", then, we reserve the "std", and change the closing parenthesis to an opening brace. (See the image above), also, every token string "_GLIBCXX_END_NESTED_NAMESPACE" will be replaced by "}".
[[File:CCreplacement_rule.png]]

So, the code becomes to like below:
<source lang = "cpp">
namespace std {

/// See bits/stl_deque.h's _Deque_base for an explanation.
template<typename _Tp, typename _Alloc>
struct _Vector_base
{
typedef typename _Alloc::template rebind<_Tp>::other _Tp_alloc_type;

......

}
</source>
==== AAAAA -> -BBBBB====

For example, when
<source lang = "cpp">
_GLIBCXX_BEGIN_NAMESPACE_TR1
...
...
_GLIBCXX_END_NAMESPACE_TR1
</source>

We should replace the string "_GLIBCXX_BEGIN_NAMESPACE_TR1"
to "namespace tr1 {", here, we introduce two replacement rules:
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| _GLIBCXX_BEGIN_NAMESPACE_TR1 || -namespace tr1 {
|-
| _GLIBCXX_END_NAMESPACE_TR1 || }
|}

In this rule, we firstly replace the "_GLIBCXX_BEGIN_NAMESPACE_TR1" with the "namespace", then, add aditional string "tr1 {"

So, the code becomes:
<source lang = "cpp">
namespace tr1 {
...
...
}
</source>

==== AAAAA -> *====
In this case, we call it a "strip the next "(" and ")" rule. for example:

The rule syntax is:

XXXXXX -> *

For example, In the source code below:
<source lang = "cpp">
CVAPI(void) cvFxxxx();
CVAPI(cvMat *) cvFyyy();
</source>

will become to (if I add a replacement rule CVAPI -> *)

<source lang = "cpp">
void cvFxxxx();
cvMat * cvFyyy();
</source>

==== AAAAA -> @====
With this rule, you can trigger the tokenizer to work in macro replacement mode, so if you have the code
<source lang = "cpp">
#define _EXFUN(name, proto) name proto

FILE * _EXFUN(fopen, (const char *__restrict _name, const char *__restrict _type));
</source>
You can add a rule _EXFUN -> @, so that the tokenizer will go to macro replacement mode if he see a _EXFUN. See details in [/index.php/topic,19278.msg131810.html#msg131810 Is it possible for the parser to support newlib prototypes?]

==High level parser(Syntax Analysis)==
This is the main flow of a parser.

[[Image:Parser_Flow.gif]]
===parser thread===
Basically, we can say, the low level parser(Tokenizer) moves its pointer character by character, and return a wxString(token) to feed the high level parser(Syntax analyzer).All the syntax analysis was done in ParserThread. A thread must be created to parse a source file. see parserthread.cpp and parserthread.h, a thread will be allocated from thread pool. For example, a file contains these statement:
<source lang = "cpp">
void f1();
int f2(char c);
float f3(void * p);
int f1;
double f2;
</source>
After the ParserThread finished its parsing, it will recognize five tokens, which has the keyword "f1","f2" and "f3", note, tokens can have the same names, but they differ from different types( variables, functions...).

===Token class===
How can a large number of tokens be recorded? A '''Token'''(note: it as a capital means it's class type) class was introduced to recorded every token. For boosting the speed of allocating Tokens, the "new" and "delete" operator were overloaded in its base class BlockAllocated. See the [http://en.wikipedia.org/wiki/Memory_pool memory pool] page on wikipedia as a reference.
<source lang = "cpp">
class Token : public BlockAllocated<Token, 10000>
{
......
wxString m_Type; // this is the return value (if any): e.g. const wxString&
wxString m_ActualType; // this is what the parser believes is the actual return value: e.g. wxString
wxString m_Name;
wxString m_Args;
wxString m_AncestorsString; // all ancestors comma-separated list
unsigned int m_File;
unsigned int m_Line;
unsigned int m_ImplFile;
unsigned int m_ImplLine; // where the token was met
unsigned int m_ImplLineStart; // if token is impl, opening brace line
unsigned int m_ImplLineEnd; // if token is impl, closing brace line
TokenScope m_Scope;
TokenKind m_TokenKind;
bool m_IsOperator;
bool m_IsLocal; // found in a local file?
bool m_IsTemp; // if true, the tree deletes it in FreeTemporaries()
bool m_IsConst; // the member method is const (yes/no)

int m_ParentIndex;
TokenIdxSet m_Children;
TokenIdxSet m_Ancestors;
TokenIdxSet m_DirectAncestors;
TokenIdxSet m_Descendants;
......

};
</source>
You can see the Token class contains all the information needed for recording its locating, its type or class derived hierarchy...

For example, in the source code in[Low level parser(Lexical analysis)]. A Token for "main" should contains it's name (obviously , m_Name="main" ), then m_File will record which file dose this Token exist. m_Line will give the line number of "main" in this source file, and so on.

===Memory Pool--BlockAllocated class===
In BlockAllocated class, there is only a static member say "static BlockAllocator<T, pool_size, debug> allocator;" to keep all the pre-allocated memory for all derived class.

'''10000''' means a pool of 10000 Tokens were allocated in the memory pool, so, dynamically allocate a Token object will be fast and efficient.

[[Image:Cb blockalloc.png|frame|none| Operator new overloading for fast allocate in the heap]]

===ParserThread===
The function Parse() will do the most job of syntax analysis. See the pseudo code below.
<source lang = "cpp">
ParserThread::Parse()
{
......
do
{
......
DoParse();
......

}while(false);

return result;
}

</source>

In the DoParse(), it checks the token from Tokenizer. For example, if the token words = "enum", then, the ParserThread::HandleEnum() will do the job to parse this enum block.

===A simple look ahead parser===
We can explain a little about it parser, the member variable '''m_Str''' of class ParserThread will be considered as a '''type stack''', for example, we want to parse the statement below:

<source lang = "cpp">
symbolA symbolB symbolC symbolD;
</source>

Only symbolD can be recognized as a variable, and it has a type of "symbolA symbolB symbolC". When the parser meets each symbol, it will look ahead to see the next token is whether ";", if not, the current token will '''pushed''' to m_Str. These iteration will be ended when the parser look ahead one step from symbolD and find the next token is a ";".

===DoParse Examples===
====Handling class declaration====
The main routing of handling class was in
ParserThread::HandleClass function
If the parserThread meet these statement
<source lang = "cpp">
class AAA{
int m_a;
int m_b;
} ;
</source>
It will surely add a Token of "AAA", it's type is "class".

What about these statements
<source lang = "cpp">
class AAA{
int m_a;
int m_b;
} x,y,z;
</source>
The parserThread should firstly add a Token "AAA", then it should regard "x", "y", "z" are three variables of type "AAA". This was done by "ReadVarNames()" function, it will read every comma separated variables after a class declaration.

====Handling typedef statement====
Sometimes, you can see these code blocks:
<source lang = "cpp">
typedef class AAA{
int m_a;
int m_b;
} BBB,CCC;
</source>
If the parser meets the keyword "typedef", firstly it set the "m_ParsingTypedef = ture" to indicate that we are parsing a typedef statement.

Next, it meets a keyword "class", which also indicate it is a class declaration. So, the HandleClass function will do the task. A Token of "class AAA" will be added to the TokenTree. Wait a minute, how can we deal with "BBB" and "CCC", this is not the same case as previous code, we can't regard "BBB","CCC" as variables. In this case, another function "ReadClsName()" will be called. For simplicity of TokenTree, we just regard "BBB" and "CCC" as derived class of "AAA".

How does the parserThread know between these two cases. Here is the code:

<source lang = "cpp">
if (m_ParsingTypedef)
{
m_Str.Clear();
ReadClsNames(newToken->m_Name);
// m_ParsingTypedef = false;
break;

}
else
{
m_Str = newToken->m_Name;
ReadVarNames();
m_Str.Clear();
break;
}
</source>

That's the whole thing I would like to write about handling class and handling typedef.

==TokenTree&SearchTree==
Maybe, you would ask a question: where do these Tokens store? The answer is that all the Tokens will be recorded in "TokenTree class".

When a certain Token is identified(whether it's a global variable, a class declaration, a class member function, and so on), it will be inserted to a database(TokenTree).

Furthermore, for fast Token query, Tokens should be sorted by it's wxString m_Name member;

A '''compact Patricia tree'''(see the wikipedia [http://en.wikipedia.org/wiki/Radix_tree Patricia tree on wikipedia]) is built to hold all their names.

For example, If you add three item to the TokenTree.
<source lang = "cpp">
mytree->AddItem(_T("physics"),_T("1 - uno"));
mytree->AddItem(_T("physiology"),_T("2 - dos"));
mytree->AddItem(_T("psychic"),_T("3 - tres"));
</source>

The Patricia tree structure will show as below, the edge of a tree contains a "label string" and the number in parentheses refers to a node Id.

<source lang = "cpp">
- "" (0)
\- "p" (4)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sychic" (5)
</source>
===Animation of Patricia tree===
A web page gives an animation of building a Patricia tree, you can see how the tree node added. See here [http://bootstrapping.wordpress.com/2008/01/24/prefix-searching-with-radix-tree/ Prefix searching with Radix Tree]

A better animation demo of Patricia tree can be found in [http://people.cis.ksu.edu/%7Erhowell/viewer/viewer.html Search Tree Viewer]. In this page, you can select the tree type, and enter some strings, then the tree will dynamically show in the window.

===SearchTree Node===
A Node should contains at least several essential element. They are:
# An edge: in the image below, the gray filled area shows a Node, since each edge belong to the next node, for example, the Node has an edge "abcd".
# SearchTreeItemMap: because our searchTree is a compact Patricia tree which means an edge contains many items. Such as, "ab" , "abc", "abcd" all the suffix string belong to the edge "abcd"
# SearchTreeLinkMap: This is an associated container map<wxChar,NodeId>, which store all "pointers" to its child Node. In the example below, "e" points to a Node of "efg", while "x" points to "xyz".
# Node depth: depth of Search Tree Node is defined by the string length from the "root node". See a depth of each node on the search tree above. For example, the Node of "hysi" has a m_Depth = 5 ("" + "p" + "hysi" = 5).

===Node Lable===
For example, the node "hysi" (2) has two children, they are "cs" (1) and "ology" (3), show below.

[[Image:Cb tree node lable.png]]

For more information, see the forum discussion here. [/index.php/topic,1696.0.html rickg22's SearchTree development] as a reference.

===How a new item is added to the tree===
When you add a new key (string) to the tree, some node should be splited, and new node need to be added. For example [/index.php/topic,1696.msg12617.html#msg12617 this post]show some details.

Suppose we have two nodes in the tree, the node id is 0 (root node) and 1, the tree hold only one key string(item) "physics":
<source lang = "cpp">
Adding word: physics
1 items in the tree
- "" (0)
\- "physics" (1)
</source>
Now, if another key string "physiology" is added to the tree, we now firstly check "physiology" is already in the tree, if not, we need to find the common string "physi", so the node 1 should be splited after the common string, so you get the following result.
<source lang = "cpp">
Adding word: physiology
2 items in the tree
- "" (0)
\- "physi" (2)
+- "cs" (1)
\- "ology" (3)
</source>
Here, the middle node "physi" is added. the original node 1's lable is shorten to "cs", and a new node "ology" is added as a new child node to the middle node.

In the other case, the new added item does not cause a new node to be added to the tree, only a node need to be extended by its ledge. For example:
<source lang = "cpp">
6 items in the tree
- "" (0)
\- "p" (4)
+- "aranormal" (8)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sych" (6)
+- "i" (9)
| +- "atrist" (10)
| \- "cs" (5)
\- "otic" (7)

</source>
Now, you add a new item "psychiatrists", pay attention to the node 10 in the above tree, we have already an item "psychiatrist", when the new item "psychiatrists" is added, we can just extend the node 10's edge from "artrist" to "artrists", thus no new node is needed.
<source lang = "cpp">
7 items in the tree
- "" (0)
\- "p" (4)
+- "aranormal" (8)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sych" (6)
+- "i" (9)
| +- "atrists" (10)
| \- "cs" (5)
\- "otic" (7)
</source>
Note that now, the node 20 now contains two items. It is a map (depth -> item).
<source lang = "cpp">
depth -> item
12 -> "psychiatrist"
13 -> "psychiatrists"
</source>

===How to query a Token by a keyword===
The parser collect all the Token information, and stored them in the TokenTree, the GUI function can query keywords from the database to show function tips or to build a Class Browser tree.

For example, if you want to find all the Tokens named "ab". In the picture above from TokenDatabase(TokenTree). we can search on the Patricia tree containing all the Tokens names, finaly, we find a tree node with a edge "abcd". So, "ab" is in it's Node's items list. Then, we can find a TokenIdxSet in a vector<TokenIdxSet>, this TokenIdxSet has all the index named by "ab", so, we can get the result like: There are many Tokens named "ab".Token "ab" may be a member varialbe name in a class, or a global function name...

<source lang = "cpp">
ClassA::ab
ClassB::ab
void ab()
....
</source>

[[Image:CCTokenTree1.png]]

==Flexible Parser structure==
The Parser class( in Parser.cpp and Parser.h ) has re-factored to support every project associate with a Parser object (svn revision > 6268 ). Which means: One Parser object per project, so, every project (xxx.cbp) will hold its own Token macro defines and Token trees.

Due to the new introduced conditional preprocessor handling mechanism, the same source file may give different Tokens due to the different macro defines in different project. Also, CC support parsing on the files which does not belong to any project.

#You open a project in CB, then all the files belong to the project( related to the project) will be parsed in CC.
#Now, you open another file( we call it a "separate file" later) which is not belong to the current project nor any other opened project.
#Then the CC will create a "temporary parser" named "NONE“ parser, and add this separate file to the "NONE" parser.
#So, you can still see the class tree when viewing the separate file.
#Once you close this separate file, the "NONE" parser will automatically be removed.

The main idea is: Now, We can let the CC do parse on some separate files
and support class browsing in Symbol browser.

==Automatic Code Completion==
===Find the search scope===

[[Image:CC SearchScope.png]]

For example, when you are editing, and the caret position was located at "E" as shown in the above image, the first thing doing an automatic code completion is find the '''search scope'''.

Here are some steps to get the initial(first) search scope:

*First, you need to correct all the "using namespace XXXX" directives at the beginning the the current source file.(labeled with "A"), this means all the child tokens of "namespace Scintilla" should be searched.
*Secondly, find the function body where the current caret position locates. eg, the above code, the caret is in the "RunStyles::RunFromPosition()" function, so the function parameter variable "position"(labeled with "C" and the local variable "run" (labeled as "D") is also a matching Tokens.
*Thirdly, look at the "B", this means we are in the class named "RunStyles", so, "RunStyles" is also a search scope.
*Finally, don't forget the global namespace scope, because the tokens of this scope are exposed to everywhere of the source.

===Break up the current statement===
<source lang = "cpp">
VariableA.m_VariableB.Functi
</source>
If you are entering the above statement, the caret is behind the "Functi". Then the whole line will be break up to several "parsing component".

There are three components: "'''VariableA'''" , "'''m_VariableB'''" and "'''Functi'''". In the next section, I will introduce that the AI matching routing will start from matching the first component with the initial(first) search scope.

===Do an AI match===
Doing an AI match is just like a walking on a tree, and find the final matching result.See the image below:

[[image:CC AI Match.png]]

'''Here is the matching algorithm''':

Now, suppose we have an initial "search scope", and a "component" array.

The AI match algorithm starts from matching the "sub search scopes" with the first "component", then, the matched "sub search scope"(red rectangle) will be the initial "search scope" again matching with the second "component", this matching routing is running continuously until we matches with the final component. Then we get the whole matching result, that will be show as a auto code completion list.

==Code completion debugging support==
===Debug Log output===
If you want to debug your plug-in, you may need to Logout the debug message to the "Code::Blocks Debug" panel. Here is the sample code:

<source lang = "cpp">
Manager::Get()->GetLogManager()->DebugLog(_("XXXXX "));

wxString name;
wxString args;
wxString m_Str;
//.....
Manager::Get()->GetLogManager()->DebugLog(F(_T("Add token name='")+name+_T("', args='")+args+_T("', return type='") + m_Str+ _T("'")));

</source>

Also, you need start the Code::Blocks with the command line argument. For example in windows.

'''codeblocks.exe --debug-log'''

then a Code::blocks debug panel will be shown to display the log.
[[Image:CbDebugLog.png|frame|none| Debug Log output panel]]

===TRACE macro support===
As you can see in the source file like "tokenizer.cpp" or "parserthread.cpp", there is a macro definition in the beginning of the source.

<source lang = "cpp">
#define CC_CODECOMPLETION_DEBUG_OUTPUT 0

#if CC_CODECOMPLETION_DEBUG_OUTPUT == 1
#define TRACE(format, args...) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args))
#define TRACE2(format, args...)
#elif CC_CODECOMPLETION_DEBUG_OUTPUT == 2
#define TRACE(format, args...) \
do \
{ \
if (g_EnableDebugTrace) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args)); \
} \
while (false)
#define TRACE2(format, args...) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args))
#else
#define TRACE(format, args...)
#define TRACE2(format, args...)
#endif
</source>
This is a quite complex macro definition. So, if CC_CODECOMPLETION_DEBUG_OUTPUT is defined as 0, these debugging macros were disabled. If CC_CODECOMPLETION_DEBUG_OUTPUT is defined as 1, only the TRACE macro will be defined, so you can plot some messages to the Debug log. It is always the parser will parser many files, so the debug messages will be flooding. If we only interest in the debug message when we are parsing a specific source file, the best way was define CC_CODECOMPLETION_DEBUG_OUTPUT as 2. Now, TRACE macro will plot the message only in one source file. The source file name can be specified in token.cpp
<source lang = "cpp">
const wxString g_DebugTraceFile = _T("myfile.cpp");
</source>
This way, only the debug message when parsing "myfile.cpp" will be traced.

===Code-Completion debug tool dialog===
When you press '''shift''' and '''ctrl''' key and double click on any entry of the navigator tree entry, a debug tool dialog will pop up to give a more detail about the selected token. You can query its information such as its member variables, its Ancestors and so on.

[[Image:CcDebugToolDialog.png]]

===Debug Smart Sense log output ===
When you hold the'''shift''' and '''ctrl''' key and right click on any entry of the navigator tree entry, the context menu will have a "Debug SmartSense" menu entry shown. You can click it to enable it. See the image blow. Then, all the debug log information when doing an Auto-completion will be shown in the "Debug Log" panel.

[[File:Cc debug smartsense.png]]

==Mutexs and lockers in CC==
We need lockers to avoid multiply thread issues of wxString. More detailed can be found: [/index.php/topic,17543.0.html wxString and the locker issue in our CC code], to avoid such issue, we need lockers.
There are three main kind of lockers.
<nowiki>wxMutex s_ParserMutex;
wxMutex s_TokenTreeMutex;
wxMutex m_ClassBrowserBuilderThreadMutex;</nowiki>
The first one was to protect multiply access to Parser objects, this is a static variable. The second one tries to forbid the multiply access to the TokenTree, the last one is used to build the symbol browser tree(usually show in the left docked panels of the C::B main frame)

The associated Macros are below:
<source lang = "c">
// For tracking, either uncomment:
//#define CC_ENABLE_LOCKER_TRACK
// ...or:
#define CC_ENABLE_LOCKER_ASSERT
// ..or none of the above.

#if defined(CC_ENABLE_LOCKER_TRACK)
// TRACKING MUTXES
// [1] Implementations for tracking mutexes:
#define THREAD_LOCKER_MTX_LOCK(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Lock() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_LOCK_SUCCESS(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Lock().Success() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_UNLOCK(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Unlock() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_UNLOCK_SUCCESS(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Unlock().Success() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_FAIL(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Fail() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
// [2] Cumulative convenient macros for tracking mutexes [USE THESE!]:
#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) \
{ \
THREAD_LOCKER_MTX_LOCK(M); \
if (M.Lock()==wxMUTEX_NO_ERROR) \
THREAD_LOCKER_MTX_LOCK_SUCCESS(M); \
else \
THREAD_LOCKER_MTX_FAIL(M); \
}
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) \
{ \
THREAD_LOCKER_MTX_UNLOCK(M); \
if (M.Unlock()==wxMUTEX_NO_ERROR) \
THREAD_LOCKER_MTX_UNLOCK_SUCCESS(M); \
else \
THREAD_LOCKER_MTX_FAIL(M); \
}
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK

// TRACKING CRITICAL SECIONS
// [2] Implementations for tracking critical sections:
#define THREAD_LOCKER_CS_ENTER(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Enter() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_CS_ENTERED(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Entered() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_CS_LEAVE(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Leave() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
// [2] Cumulative convenient macros for tracking critical sections [USE THESE!]:
#define CC_LOCKER_TRACK_CS_ENTER(CS) \
{ \
THREAD_LOCKER_CS_ENTER(CS); \
CS.Enter(); \
THREAD_LOCKER_CS_ENTERED(CS); \
}
#define CC_LOCKER_TRACK_CS_LEAVE(CS) \
{ \
THREAD_LOCKER_CS_LEAVE(CS); \
CS.Leave(); \
}
#elif defined CC_ENABLE_LOCKER_ASSERT
#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();

#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) cbAssert(M.Lock()==wxMUTEX_NO_ERROR);
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) cbAssert(M.Unlock()==wxMUTEX_NO_ERROR);
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#else
#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();

#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) M.Lock();
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) M.Unlock();
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#endif
</source>

Each mutex need a Lock and Unlock macro, like for mutex for Parser, we need CC_LOCKER_TRACK_P_MTX_LOCK and CC_LOCKER_TRACK_P_MTX_UNLOCK.

==Usefull Links==

*A discussion on search tree in the forum [/index.php/topic,1696.0.html] and [/index.php/topic,1581.0.html].

*Another opensource IDE [http://vcfbuilder.org/?q=node/139 VCF builder]or[https://sourceforge.net/projects/vcfbuilder/ vcfbuilder on sf], By the way , VCF use a CodeStore based on [http://www.antlr.org/ antlr parser] to deal with parsing, the whole source code can be check out from
<pre>svn co https://vcfbuilder.svn.sourceforge.net/svnroot/vcfbuilder vcfbuilder</pre>

*online book[http://www.macs.hw.ac.uk/~alison/alg/details.html Data Structures and Algorithms II Course ] and [http://www.macs.hw.ac.uk/~alison/alg/lectures.html pdf lectures]

*A forum discussion on why a standard perprocessor and parser works slowly. [/index.php/topic,2494.msg19801.html#msg19801 parsing iostream header takes 5 seconds]

*[http://www.codelite.org CodeLite] is another open source IDE using wxWidgets, use Ctags as a indexing service, and do context expression syntactic analysis generated from Lex and Yacc tools.See the explanation in forum message by it's author eranif [/index.php/topic,10087.msg70875.html#msg70875 How does Codelite's CC work with CTags and Yacc&Lex]

*Hopefully, we can use the patricia tree from the standard library, see here:[http://gcc.gnu.org/onlinedocs/libstdc++/ext/pb_ds/trie_based_containers.html trie]

* a blog from KDE4's developer, it explain the code completion in KDE4, see here:[http://zwabel.wordpress.com/ zwabel' blog]

* QT creator source code from [http://qt.gitorious.org/qt-creator/qt-creator/trees/master QT-creator source]

* [http://websvn.kde.org/trunk/KDE/kdevelop/ Kdevelop source code] and it's [http://websvn.kde.org/trunk/KDE/kdevelop/languages/cpp/parser/ parser]

* [http://stackoverflow.com/questions/1220099/how-does-code-completion-work How does code completion work? - Stack Overflow]

* [/index.php/topic,11724.0.html Just a reminder Codelite IDE now have improved it's parser]

*[http://padator.org/software-yacfe.php Yacfe, a parser with proprocessor enabled]

*[/index.php/topic,1581.msg11701.html#msg11701 A Mini C++ interpreter] from the book "The Art of C++ by Herbert Schildt", source code can be download [http://books.mcgraw-hill.com/downloads/products/0072255129/0072255129_code.zip here]

*[http://www.macs.hw.ac.uk/~alison/alg/lectures/l7.pdf Lecture 7: Parsing (intro) (pdf)] and [http://www.macs.hw.ac.uk/~alison/alg/lectures/l8.pdf Lecture 8: Recursive Descent Parsing (pdf)] from [http://www.macs.hw.ac.uk/~alison/alg/lectures.html Data Structures and Algorithms II]

*There are some online "Compiler design" books listed in [http://www.freetechbooks.com/compiler-design-and-construction-f14.html Free Online Compiler Design and Construction Books :: FreeTechBooks.com], and the best one I think is : [http://www.diku.dk/hjemmesider/ansatte/torbenm/Basics/index.html Basics of Compiler Design], and you can get a basic understanding.

*[http://wiki.eclipse.org/CDT/designs/Overview_of_Parsing CDT/designs/Overview of Parsing].

* [http://en.literateprograms.org/Radix_tree_(C) Radix tree (C) - LiteratePrograms]

* LLVM's online tutorials on how to write a simple compiler [http://llvm.org/docs/tutorial/index.html LLVM Tutorial]

* Roberto Raggi's new parser[https://github.com/robertoraggi/cplusplus cplusplus 5 My experimental C++ front end], note Roberto Raggi is the author of the parser for both Qtcreator and Kdeveloper IDE.

* KDevelop are discussing clang now, see [http://milianw.de/blog/katekdevelop-sprint-2014-let-there-be-clang Kate/KDevelop Sprint 2014: Let There Be Clang | Milian Wolff]

Main Page

2014-06-22T14:43:55Z

Ollydbg: fix typo

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is a free, open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++/Fortran.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/26 13.12]
* [/index.php?board=20.0 Nightly builds] (updated each night)
* [[Compiled_packages_of_Code::Blocks|Official and third-party binaries]] (for various distributions)
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ features] or browse [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ patches] or browse [http://alpha0010.github.io/cb-history/patches.html old patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [http://www.mingw.org MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore GCC] (Win32, Linux)
* [http://www.hightec-rt.com PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page OpenWatcom] (Win32)
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/219754.htm Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://www.digitalmars.com/d/dcompiler.html Digital Mars D]
* [http://dgcc.sourceforge.net/ GDC D Compiler]
* [http://dsource.org/projects/ldc/ LLVM D Compiler]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Developer documentation

2014-06-15T03:43:46Z

Ollydbg: git svn description

Main Page

2014-06-12T05:37:42Z

Ollydbg: minor change descriptions

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is a free, open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++/Fortran.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/26 13.12]
* [/index.php?board=20.0 Nightly builds] (updated each night)
* [[Compiled_packages_of_Code::Blocks|Official and third-party binaries]] (for various distributions)
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ features] or browse old [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ patches] or browse old [http://alpha0010.github.io/cb-history/patches.html patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [http://www.mingw.org MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore GCC] (Win32, Linux)
* [http://www.hightec-rt.com PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page OpenWatcom] (Win32)
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/219754.htm Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://www.digitalmars.com/d/dcompiler.html Digital Mars D]
* [http://dgcc.sourceforge.net/ GDC D Compiler]
* [http://dsource.org/projects/ldc/ LLVM D Compiler]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Main Page

2014-06-12T04:15:41Z

Ollydbg: bugs features and patches are on SF now, also update the old issued maintained by alpha on github

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is an open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/26 13.12]
* [/index.php?board=20.0 Nightly builds] (updated each night)
* [[Compiled_packages_of_Code::Blocks|Official and third-party binaries]] (for various distributions)
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ features] or browse old [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/ patches] or browse old [http://alpha0010.github.io/cb-history/patches.html patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [http://www.mingw.org MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore GCC] (Win32, Linux)
* [http://www.hightec-rt.com PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page OpenWatcom] (Win32)
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/219754.htm Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://www.digitalmars.com/d/dcompiler.html Digital Mars D]
* [http://dgcc.sourceforge.net/ GDC D Compiler]
* [http://dsource.org/projects/ldc/ LLVM D Compiler]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Developer documentation

2014-04-08T02:29:06Z

Ollydbg: /* Debugging C::B */ link to wx debug library

Code Completion Design

2014-02-17T15:16:42Z

Ollydbg: /* Usefull Links */ add parser links

[[Category:Developer Documentation]]
==How to build==
===Get the source code===
When you download the svn source code of code::blocks,(see here [[Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_sources]] the source code of CodeCompletion plugin was already included.

Here is the screen shot when I opened the codecompletion source code in C::B's source navigator view.

[[Image:Devcc1.png|300x300px| Code completion source tree opened in code::blocks]]

===Build the code completion plug-in===
If you only want to build the Code Completion plug-in, you can select it in the "build target list" (Note: by default, the Build target option was "ALL", which means all the targets in the current workspace will be build), see the screen shot below:

[[Image:Buildcc.PNG|frame|none| Code completion build target option in code::blocks]]

Don't forget to run the batch script file "update.bat" after you build the target, this procedure will update your output folder package and strip the debug information. See the wiki page [[Installing_Code::Blocks_from_source_on_Windows]] for more information.

===A brief description of every project files===
From now on, we use '''CC''' as an abbreviation for '''code completion plug-in'''.
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| ccdebuginfo.cpp || a dialog for debugging CC, can be opened by double click on the code browser tree entry with shift and ctrl key pressed
|-
| ccoptionsdlg.cpp|| code completion options dialog, can be opened by menu->setting->editor->code completion and symbols browser
|-
| ccoptionsprjdlg.cpp|| setting the additional parser search path
|-
| classbrowser.cpp||viewing the symbols tree ctrl(token tree).
|-
| classbrowserbuilderthread.cpp|| a thread to build the class browser tree above
|-
| codecompletion.cpp ||The Main file need by code completion plug-in, maintain all the CC's GUI and native parser
|-
| insertclassmethoddlg.cpp|| a dialog to insert class method, can be open by context menu in editor
|-
| nativeparser.cpp||a class derived from wxEvtHandler, NativeParser class has a member variable "Parser m_Parser";
|-
| selectincludefile.cpp|| select multiply matched token names before any jump to declaration or jump to implementation.
|-
|parser/parser.cpp|| Parser class was also derived from wxEvtHandler, can start batch parse... this class has member variables like :cbThreadPool m_Pool(which will create a thread from thread pool for each file need passed);TokenTree* m_pTokens(contains all the Token database);
|-
|parser/parserthread.cpp||will do the syntax analysis for every file in a project, it has a Tokenizer as member variable
|-
|parser/token.cpp|| definition of the "Token" class, and TokenTree(which means the Token dababase)
|-
|parser/tokenizer.cpp|| tokenizer will return every wxString it regard as a symbol by GetToken(), also do a replacement before return
|-
|parser/searchtree.cpp|| implement the patricia search tree using by TokenTree
|-
|Header files|| no description needed
|}
==Structure of CodeCompletion plugin==
[[Image:CodeCompletionPluginStructure.png| Code completion plugin Structure]]

The above image show the main structure of our CodeCompletion plugins. The main class are:
* CodeCompletion: this is the class for main plugin), it handle event sent from the C::B core. Toolbar handling was done in this class.
* NativeParser: as a main member variable of the CodeCompletion class, this class is like the Parser manager class, it create/delete Parser instances when a project load/closed.
* Parser: this class is mainly for handling Tokens. Parser class hold a TokenTree which record all the Tokens. Parser class also hold a thread pool, it can either run the parsing task in the pool(this means the parsing task will be done in a separate thread), or directly by a function call.
* Parserthread: The class derived from the worker thread(cbThreadedTask class), it member function DoParse() is the function for parsing.

Besides that, when trying to show the suggestion list(auto completion list, or code completion list), the NativeParser need to analyze the current the current statement structure, and query the symbol(token) information from the Tokentree, this is mostly done in ResolveExpression() member function.

Some important note: when all Parserthread instances finish parsing job in the pool, the thread pool will send an event to its parent(in this case, it is the Parser class), so the Parser know that the parsing is done, or the Parser can assign another parsing jobs to the thread pool.

==Low level parser(Lexical analysis, Tokenize)==
For someone haven't heard what does "Token" and "Tokenize" mean, you should read the wikibooks article [http://en.wikibooks.org/wiki/C%2B%2B_Programming/Compiler#Compilation A brief explain of what does a parser do] and [http://en.wikipedia.org/wiki/Lexical_analysis Tokenize on wikipedia]. Shortly, a Tokenizer regards your C++ or C source code as a large array of characters (sometimes, we call it a string), then this big string can be divided to small atomic strings----a '''token''' (Each token has a unique meanings and can't be divided into sub-strings. A token can be a symbol, an identifier, a keyword, a digital number, etc), meanwhile "white spaces" and "comments" were ignored by the Tokenizer.

for a simple c++ program like below
<source lang = "c">
int main()
{
std::cout << "hello world" << std::endl;
return 0;
}
</source>
After tokenizing, it should give these 15 tokens
<source lang = "cpp">
1 = string "int"
2 = string "main"
3 = opening parenthesis
4 = closing parenthesis
5 = opening brace
6 = string "std"
7 = namespace operator
8 = string "cout"
9 = << operator
10 = string ""hello world""
11 = string "endl"
12 = semicolon
13 = string "return"
14 = number 0
15 = closing brace
</source>

===Tokenizer class===
A class named '''Tokenizer''' was implemented in "tokenizer.h" and "tokenizer.cpp". Seen from the Tokenizer's level, a token is just a [http://docs.wxwidgets.org/stable/wx_unicode.html unicode] wxString. There are several steps to run an instance of Tokenizer.
===preparing the big string===
From the previous section, you know the Tokenizer is just a string cutter. So, the first step is preparing the big string. The string can either be loaded from a source file or a memory buffer. Currently, the Unicode wxString is used.(since we are all using Unicode build of code::blocks, and ANSI mode is outdated and deprecated).
===Get or Peek a token===
'''Tokenizer''' contains a '''file position indicator'''----m_TokenIndex(see [http://en.wikipedia.org/wiki/Fopen File Open In C language]) pointing to the current position of string. So, you can '''Get''' a token or '''Peek''' a token. Here is the function prototype
<source lang = "cpp">
//Get the current token string started from m_TokenIndex,
//After that, increase the m_Tokenindex
wxString GetToken();

//Peak the current token string and but do *NOT* increase the m_TokenIndex
wxString PeekToken();
</source>

For example, if the Tokenizer parses the example code above, you can see how these two methods work.

*After initializing the Tokenizer(preparing the big string), You firstly call the GetToken() function, which will return the first token "int" and increase the m_TokenIndex one step to "int".

*Then, if you call the PeekToken(), which will return a token "main", but the tokenindex was still remaining point to "int".

*If you call the GetToken() again, it will return a "main" immediately and increase the file pointer to "main".

Note: Internally, the Tokenizer class use a '''undo and peek cache''' to do the trick. Once a token is peeked, it is saved in '''m_Peek''' member, so, next time you call GetToken(), it just immediately return the cached value without calling the "DoGetToken()" procedure again.

[[Image:Cb token cache.png]]

===Nested Value of braces===
As you know, braces are exist in pairs, such as "{" and "}", or "[" and "]", Also, these braces can be embeded. So the Tokenizer keep a value '''m_NestLevel''' to indicate how deep you stays. If the Tokenizer meets a '''{''', it will increase the nestValue, and if it meets a '''}''', it will decrease the m_NestLevel. See the pseudo code in Tokenizer.cpp below:
<source lang = "cpp">
if (CurrentChar() == '{')
++m_NestLevel;
else if (CurrentChar() == '}')
--m_NestLevel;
</source>

===SkipUnwanted tokens===
A '''bool''' member variable '''m_SkipUnwantedTokens''' determines whether a regular assignments statement will be omitted or not. For example, a piece of code below:
<source lang = "cpp">
a = b + c;
</source>

If m_SkipUnwantedTokens == true, then once SkipUnwanted() meets the "=" symbol, it will go on skipping every characters until it meets ''',''' or ''';''' or '''}''', so this statement will be omitted by the Tokenizer.

Sometimes, this behavior becomes a nightmare when parsing the statement like default argument in template. Or the default arguments in function.
<source lang = "cpp">
// assignment statement in template arguments
template<class T = int>
class abc {
T m_a;
......
......
}

// assignment statement in function arguments

void foo( int arg1 = 60 )
{
bla bla;
}
</source>
If the Tokenizer finds that an equation sign '''=''', it will skip any character until it meets a '''}''', so, the class declaration or function body will be totally skipped in the unexpected way. In this case, we should manually '''disable''' this functionality by setting m_SkipUnwantedTokens = false to let the Tokenizer parse these statements correctly.

That's why you will see many situations when you enter a function, you should save the m_SkipUnwantedTokens statues and disabled it, when you leave a function, you should manually restore it.(See function implementation in ParseThread.cpp)

===Return a correct token, Macro replacement===
Special token should be replaced for parsing correctly. For example, in the standard c++ header (mingw), there are a string named "_GLIBCXX_STD", this should be replaced to "std". See the dialog below.

[[Image:Cc std replacement.png|400x400px|]]

The inline function in the Tokenizer class will check whether a token should be replaced before return.

<source lang = "cpp">
wxString Tokenizer::MacroReplace(const wxString str)
{
wxStringHashMap::const_iterator it = s_Replacements.find(str);

if (it != s_Replacements.end())
{
// match one!
wxString key = it->first;
wxString value = it->second;
TRACE(_T("MacroReplace() : Replacing '%s' with '%s' (file='%s')."), key.wx_str(), value.wx_str(), m_Filename.wx_str());
if (value[0]=='+' && CurrentChar()=='(')
{
unsigned int start = m_TokenIndex;
m_Buffer[start] = ' ';
bool fillSpace = false;
while (m_Buffer[start]!=')')
{
if (m_Buffer[start]==',')
fillSpace = true;

if (fillSpace==true)
m_Buffer[start]=' ';

start++;
}
m_Buffer[start] = '{';
return value.Remove(0,1);
}
else if (value[0] == '-')
{
unsigned int lenKey = key.Len();
value = value.Remove(0,1);
unsigned int lenValue = value.Len();

for (unsigned int i=1; i<=lenKey; i++)
{
if (i < lenValue)
m_Buffer[m_TokenIndex-i] = value[lenValue-i];
else
m_Buffer[m_TokenIndex-i] = ' ';
}

int firstSpace = value.First(' ');
// adjust m_TokenIndex
m_TokenIndex = m_TokenIndex - lenValue + firstSpace;

return value.Mid(0,firstSpace);
}
else
return value;
}

return str;
}

</source>

[[Image:Cc replace dialog.png|400x400px|none| Code completion build target option in code::blocks]]

Setting the replacement mapping. Note that before return a token, a replacement map was searched to check if it matches any entry in the map, so, the bigger this map goes, the slower it will do parsing.

Note: Code Completion plug-in is not a preprocessor, so it is difficult to deal with the source mixed with many macro, or some strange macros. This is something like Ctags' replacement options "?I identifier?list" in [http://ctags.sourceforge.net/ctags.html#OPERATIONAL%20DETAILS ctags option detial] or [http://codelite.org/LiteEditor/FAQ Code Completion macro FAQ]

For discussion of Ctags, the related thread is [/index.php/topic,10564.msg72424.html#msg72424 Re: namespaces and code completion] and [/index.php/topic,11187.msg77135.html#msg77135 Re: New code completion remarks/issues]

===replacement rules===
====directly replacement AAAAA -> BBBBB====
You can define a rule:
AAAAA -> BBBBB

Which means, if the tokenizer meet a string "AAAAA", then it will returned a string "BBBBB"
==== AAAAA -> +BBBBB====
For example, when

<source lang = "cpp">
_GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)

/// See bits/stl_deque.h's _Deque_base for an explanation.
template<typename _Tp, typename _Alloc>
struct _Vector_base
{
typedef typename _Alloc::template rebind<_Tp>::other _Tp_alloc_type;

......

_GLIBCXX_END_NESTED_NAMESPACE
</source>

We should replace the string "_GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)"
to "namespace std {", here, we introduce two replacement rules:
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| _GLIBCXX_BEGIN_NESTED_NAMESPACE || +namespace
|-
| _GLIBCXX_END_NESTED_NAMESPACE || }
|}

In this rule, we firstly replace the "_GLIBCXX_BEGIN_NESTED_NAMESPACE" with the "namespace", then, we reserve the "std", and change the closing parenthesis to an opening brace. (See the image above), also, every token string "_GLIBCXX_END_NESTED_NAMESPACE" will be replaced by "}".
[[File:CCreplacement_rule.png]]

So, the code becomes to like below:
<source lang = "cpp">
namespace std {

/// See bits/stl_deque.h's _Deque_base for an explanation.
template<typename _Tp, typename _Alloc>
struct _Vector_base
{
typedef typename _Alloc::template rebind<_Tp>::other _Tp_alloc_type;

......

}
</source>
==== AAAAA -> -BBBBB====

For example, when
<source lang = "cpp">
_GLIBCXX_BEGIN_NAMESPACE_TR1
...
...
_GLIBCXX_END_NAMESPACE_TR1
</source>

We should replace the string "_GLIBCXX_BEGIN_NAMESPACE_TR1"
to "namespace tr1 {", here, we introduce two replacement rules:
{|border="1" cellpadding="1" cellspacing="0" style="font-size: 100%; border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100% table-layout: unfixed;"
|-
| _GLIBCXX_BEGIN_NAMESPACE_TR1 || -namespace tr1 {
|-
| _GLIBCXX_END_NAMESPACE_TR1 || }
|}

In this rule, we firstly replace the "_GLIBCXX_BEGIN_NAMESPACE_TR1" with the "namespace", then, add aditional string "tr1 {"

So, the code becomes:
<source lang = "cpp">
namespace tr1 {
...
...
}
</source>

==== AAAAA -> *====
In this case, we call it a "strip the next "(" and ")" rule. for example:

The rule syntax is:

XXXXXX -> *

For example, In the source code below:
<source lang = "cpp">
CVAPI(void) cvFxxxx();
CVAPI(cvMat *) cvFyyy();
</source>

will become to (if I add a replacement rule CVAPI -> *)

<source lang = "cpp">
void cvFxxxx();
cvMat * cvFyyy();
</source>

==High level parser(Syntax Analysis)==
This is the main flow of a parser.

[[Image:Parser_Flow.gif]]
===parser thread===
Basically, we can say, the low level parser(Tokenizer) moves its pointer character by character, and return a wxString(token) to feed the high level parser(Syntax analyzer).All the syntax analysis was done in ParserThread. A thread must be created to parse a source file. see parserthread.cpp and parserthread.h, a thread will be allocated from thread pool. For example, a file contains these statement:
<source lang = "cpp">
void f1();
int f2(char c);
float f3(void * p);
int f1;
double f2;
</source>
After the ParserThread finished its parsing, it will recognize five tokens, which has the keyword "f1","f2" and "f3", note, tokens can have the same names, but they differ from different types( variables, functions...).

===Token class===
How can a large number of tokens be recorded? A '''Token'''(note: it as a capital means it's class type) class was introduced to recorded every token. For boosting the speed of allocating Tokens, the "new" and "delete" operator were overloaded in its base class BlockAllocated. See the [http://en.wikipedia.org/wiki/Memory_pool memory pool] page on wikipedia as a reference.
<source lang = "cpp">
class Token : public BlockAllocated<Token, 10000>
{
......
wxString m_Type; // this is the return value (if any): e.g. const wxString&
wxString m_ActualType; // this is what the parser believes is the actual return value: e.g. wxString
wxString m_Name;
wxString m_Args;
wxString m_AncestorsString; // all ancestors comma-separated list
unsigned int m_File;
unsigned int m_Line;
unsigned int m_ImplFile;
unsigned int m_ImplLine; // where the token was met
unsigned int m_ImplLineStart; // if token is impl, opening brace line
unsigned int m_ImplLineEnd; // if token is impl, closing brace line
TokenScope m_Scope;
TokenKind m_TokenKind;
bool m_IsOperator;
bool m_IsLocal; // found in a local file?
bool m_IsTemp; // if true, the tree deletes it in FreeTemporaries()
bool m_IsConst; // the member method is const (yes/no)

int m_ParentIndex;
TokenIdxSet m_Children;
TokenIdxSet m_Ancestors;
TokenIdxSet m_DirectAncestors;
TokenIdxSet m_Descendants;
......

};
</source>
You can see the Token class contains all the information needed for recording its locating, its type or class derived hierarchy...

For example, in the source code in[Low level parser(Lexical analysis)]. A Token for "main" should contains it's name (obviously , m_Name="main" ), then m_File will record which file dose this Token exist. m_Line will give the line number of "main" in this source file, and so on.

===Memory Pool--BlockAllocated class===
In BlockAllocated class, there is only a static member say "static BlockAllocator<T, pool_size, debug> allocator;" to keep all the pre-allocated memory for all derived class.

'''10000''' means a pool of 10000 Tokens were allocated in the memory pool, so, dynamically allocate a Token object will be fast and efficient.

[[Image:Cb blockalloc.png|frame|none| Operator new overloading for fast allocate in the heap]]

===ParserThread===
The function Parse() will do the most job of syntax analysis. See the pseudo code below.
<source lang = "cpp">
ParserThread::Parse()
{
......
do
{
......
DoParse();
......

}while(false);

return result;
}

</source>

In the DoParse(), it checks the token from Tokenizer. For example, if the token words = "enum", then, the ParserThread::HandleEnum() will do the job to parse this enum block.

===A simple look ahead parser===
We can explain a little about it parser, the member variable '''m_Str''' of class ParserThread will be considered as a '''type stack''', for example, we want to parse the statement below:

<source lang = "cpp">
symbolA symbolB symbolC symbolD;
</source>

Only symbolD can be recognized as a variable, and it has a type of "symbolA symbolB symbolC". When the parser meets each symbol, it will look ahead to see the next token is whether ";", if not, the current token will '''pushed''' to m_Str. These iteration will be ended when the parser look ahead one step from symbolD and find the next token is a ";".

===DoParse Examples===
====Handling class declaration====
The main routing of handling class was in
ParserThread::HandleClass function
If the parserThread meet these statement
<source lang = "cpp">
class AAA{
int m_a;
int m_b;
} ;
</source>
It will surely add a Token of "AAA", it's type is "class".

What about these statements
<source lang = "cpp">
class AAA{
int m_a;
int m_b;
} x,y,z;
</source>
The parserThread should firstly add a Token "AAA", then it should regard "x", "y", "z" are three variables of type "AAA". This was done by "ReadVarNames()" function, it will read every comma separated variables after a class declaration.

====Handling typedef statement====
Sometimes, you can see these code blocks:
<source lang = "cpp">
typedef class AAA{
int m_a;
int m_b;
} BBB,CCC;
</source>
If the parser meets the keyword "typedef", firstly it set the "m_ParsingTypedef = ture" to indicate that we are parsing a typedef statement.

Next, it meets a keyword "class", which also indicate it is a class declaration. So, the HandleClass function will do the task. A Token of "class AAA" will be added to the TokenTree. Wait a minute, how can we deal with "BBB" and "CCC", this is not the same case as previous code, we can't regard "BBB","CCC" as variables. In this case, another function "ReadClsName()" will be called. For simplicity of TokenTree, we just regard "BBB" and "CCC" as derived class of "AAA".

How does the parserThread know between these two cases. Here is the code:

<source lang = "cpp">
if (m_ParsingTypedef)
{
m_Str.Clear();
ReadClsNames(newToken->m_Name);
// m_ParsingTypedef = false;
break;

}
else
{
m_Str = newToken->m_Name;
ReadVarNames();
m_Str.Clear();
break;
}
</source>

That's the whole thing I would like to write about handling class and handling typedef.

==TokenTree&SearchTree==
Maybe, you would ask a question: where do these Tokens store? The answer is that all the Tokens will be recorded in "TokenTree class".

When a certain Token is identified(whether it's a global variable, a class declaration, a class member function, and so on), it will be inserted to a database(TokenTree).

Furthermore, for fast Token query, Tokens should be sorted by it's wxString m_Name member;

A '''compact Patricia tree'''(see the wikipedia [http://en.wikipedia.org/wiki/Radix_tree Patricia tree on wikipedia]) is built to hold all their names.

For example, If you add three item to the TokenTree.
<source lang = "cpp">
mytree->AddItem(_T("physics"),_T("1 - uno"));
mytree->AddItem(_T("physiology"),_T("2 - dos"));
mytree->AddItem(_T("psychic"),_T("3 - tres"));
</source>

The Patricia tree structure will show as below, the edge of a tree contains a "label string" and the number in parentheses refers to a node Id.

<source lang = "cpp">
- "" (0)
\- "p" (4)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sychic" (5)
</source>
===Animation of Patricia tree===
A web page gives an animation of building a Patricia tree, you can see how the tree node added. See here [http://bootstrapping.wordpress.com/2008/01/24/prefix-searching-with-radix-tree/ Prefix searching with Radix Tree]

A better animation demo of Patricia tree can be found in [http://people.cis.ksu.edu/%7Erhowell/viewer/viewer.html Search Tree Viewer]. In this page, you can select the tree type, and enter some strings, then the tree will dynamically show in the window.

===SearchTree Node===
A Node should contains at least several essential element. They are:
# An edge: in the image below, the gray filled area shows a Node, since each edge belong to the next node, for example, the Node has an edge "abcd".
# SearchTreeItemMap: because our searchTree is a compact Patricia tree which means an edge contains many items. Such as, "ab" , "abc", "abcd" all the suffix string belong to the edge "abcd"
# SearchTreeLinkMap: This is an associated container map<wxChar,NodeId>, which store all "pointers" to its child Node. In the example below, "e" points to a Node of "efg", while "x" points to "xyz".
# Node depth: depth of Search Tree Node is defined by the string length from the "root node". See a depth of each node on the search tree above. For example, the Node of "hysi" has a m_Depth = 5 ("" + "p" + "hysi" = 5).

===Node Lable===
For example, the node "hysi" (2) has two children, they are "cs" (1) and "ology" (3), show below.

[[Image:Cb tree node lable.png]]

For more information, see the forum discussion here. [/index.php/topic,1696.0.html rickg22's SearchTree development] as a reference.

===How a new item is added to the tree===
When you add a new key (string) to the tree, some node should be splited, and new node need to be added. For example [/index.php/topic,1696.msg12617.html#msg12617 this post]show some details.

Suppose we have two nodes in the tree, the node id is 0 (root node) and 1, the tree hold only one key string(item) "physics":
<source lang = "cpp">
Adding word: physics
1 items in the tree
- "" (0)
\- "physics" (1)
</source>
Now, if another key string "physiology" is added to the tree, we now firstly check "physiology" is already in the tree, if not, we need to find the common string "physi", so the node 1 should be splited after the common string, so you get the following result.
<source lang = "cpp">
Adding word: physiology
2 items in the tree
- "" (0)
\- "physi" (2)
+- "cs" (1)
\- "ology" (3)
</source>
Here, the middle node "physi" is added. the original node 1's lable is shorten to "cs", and a new node "ology" is added as a new child node to the middle node.

In the other case, the new added item does not cause a new node to be added to the tree, only a node need to be extended by its ledge. For example:
<source lang = "cpp">
6 items in the tree
- "" (0)
\- "p" (4)
+- "aranormal" (8)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sych" (6)
+- "i" (9)
| +- "atrist" (10)
| \- "cs" (5)
\- "otic" (7)

</source>
Now, you add a new item "psychiatrists", pay attention to the node 10 in the above tree, we have already an item "psychiatrist", when the new item "psychiatrists" is added, we can just extend the node 10's edge from "artrist" to "artrists", thus no new node is needed.
<source lang = "cpp">
7 items in the tree
- "" (0)
\- "p" (4)
+- "aranormal" (8)
+- "hysi" (2)
| +- "cs" (1)
| \- "ology" (3)
\- "sych" (6)
+- "i" (9)
| +- "atrists" (10)
| \- "cs" (5)
\- "otic" (7)
</source>
Note that now, the node 20 now contains two items. It is a map (depth -> item).
<source lang = "cpp">
depth -> item
12 -> "psychiatrist"
13 -> "psychiatrists"
</source>

===How to query a Token by a keyword===
The parser collect all the Token information, and stored them in the TokenTree, the GUI function can query keywords from the database to show function tips or to build a Class Browser tree.

For example, if you want to find all the Tokens named "ab". In the picture above from TokenDatabase(TokenTree). we can search on the Patricia tree containing all the Tokens names, finaly, we find a tree node with a edge "abcd". So, "ab" is in it's Node's items list. Then, we can find a TokenIdxSet in a vector<TokenIdxSet>, this TokenIdxSet has all the index named by "ab", so, we can get the result like: There are many Tokens named "ab".Token "ab" may be a member varialbe name in a class, or a global function name...

<source lang = "cpp">
ClassA::ab
ClassB::ab
void ab()
....
</source>

[[Image:CCTokenTree1.png]]

==Flexible Parser structure==
The Parser class( in Parser.cpp and Parser.h ) has re-factored to support every project associate with a Parser object (svn revision > 6268 ). Which means: One Parser object per project, so, every project (xxx.cbp) will hold its own Token macro defines and Token trees.

Due to the new introduced conditional preprocessor handling mechanism, the same source file may give different Tokens due to the different macro defines in different project. Also, CC support parsing on the files which does not belong to any project.

#You open a project in CB, then all the files belong to the project( related to the project) will be parsed in CC.
#Now, you open another file( we call it a "separate file" later) which is not belong to the current project nor any other opened project.
#Then the CC will create a "temporary parser" named "NONE“ parser, and add this separate file to the "NONE" parser.
#So, you can still see the class tree when viewing the separate file.
#Once you close this separate file, the "NONE" parser will automatically be removed.

The main idea is: Now, We can let the CC do parse on some separate files
and support class browsing in Symbol browser.

==Automatic Code Completion==
===Find the search scope===

[[Image:CC SearchScope.png]]

For example, when you are editing, and the caret position was located at "E" as shown in the above image, the first thing doing an automatic code completion is find the '''search scope'''.

Here are some steps to get the initial(first) search scope:

*First, you need to correct all the "using namespace XXXX" directives at the beginning the the current source file.(labeled with "A"), this means all the child tokens of "namespace Scintilla" should be searched.
*Secondly, find the function body where the current caret position locates. eg, the above code, the caret is in the "RunStyles::RunFromPosition()" function, so the function parameter variable "position"(labeled with "C" and the local variable "run" (labeled as "D") is also a matching Tokens.
*Thirdly, look at the "B", this means we are in the class named "RunStyles", so, "RunStyles" is also a search scope.
*Finally, don't forget the global namespace scope, because the tokens of this scope are exposed to everywhere of the source.

===Break up the current statement===
<source lang = "cpp">
VariableA.m_VariableB.Functi
</source>
If you are entering the above statement, the caret is behind the "Functi". Then the whole line will be break up to several "parsing component".

There are three components: "'''VariableA'''" , "'''m_VariableB'''" and "'''Functi'''". In the next section, I will introduce that the AI matching routing will start from matching the first component with the initial(first) search scope.

===Do an AI match===
Doing an AI match is just like a walking on a tree, and find the final matching result.See the image below:

[[image:CC AI Match.png]]

'''Here is the matching algorithm''':

Now, suppose we have an initial "search scope", and a "component" array.

The AI match algorithm starts from matching the "sub search scopes" with the first "component", then, the matched "sub search scope"(red rectangle) will be the initial "search scope" again matching with the second "component", this matching routing is running continuously until we matches with the final component. Then we get the whole matching result, that will be show as a auto code completion list.

==Code completion debugging support==
===Debug Log output===
If you want to debug your plug-in, you may need to Logout the debug message to the "Code::Blocks Debug" panel. Here is the sample code:

<source lang = "cpp">
Manager::Get()->GetLogManager()->DebugLog(_("XXXXX "));

wxString name;
wxString args;
wxString m_Str;
//.....
Manager::Get()->GetLogManager()->DebugLog(F(_T("Add token name='")+name+_T("', args='")+args+_T("', return type='") + m_Str+ _T("'")));

</source>

Also, you need start the Code::Blocks with the command line argument. For example in windows.

'''codeblocks.exe --debug-log'''

then a Code::blocks debug panel will be shown to display the log.
[[Image:CbDebugLog.png|frame|none| Debug Log output panel]]

===TRACE macro support===
As you can see in the source file like "tokenizer.cpp" or "parserthread.cpp", there is a macro definition in the beginning of the source.

<source lang = "cpp">
#define CC_CODECOMPLETION_DEBUG_OUTPUT 0

#if CC_CODECOMPLETION_DEBUG_OUTPUT == 1
#define TRACE(format, args...) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args))
#define TRACE2(format, args...)
#elif CC_CODECOMPLETION_DEBUG_OUTPUT == 2
#define TRACE(format, args...) \
do \
{ \
if (g_EnableDebugTrace) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args)); \
} \
while (false)
#define TRACE2(format, args...) \
Manager::Get()->GetLogManager()->DebugLog(F(format, ##args))
#else
#define TRACE(format, args...)
#define TRACE2(format, args...)
#endif
</source>
This is a quite complex macro definition. So, if CC_CODECOMPLETION_DEBUG_OUTPUT is defined as 0, these debugging macros were disabled. If CC_CODECOMPLETION_DEBUG_OUTPUT is defined as 1, only the TRACE macro will be defined, so you can plot some messages to the Debug log. It is always the parser will parser many files, so the debug messages will be flooding. If we only interest in the debug message when we are parsing a specific source file, the best way was define CC_CODECOMPLETION_DEBUG_OUTPUT as 2. Now, TRACE macro will plot the message only in one source file. The source file name can be specified in token.cpp
<source lang = "cpp">
const wxString g_DebugTraceFile = _T("myfile.cpp");
</source>
This way, only the debug message when parsing "myfile.cpp" will be traced.

===Code-Completion debug tool dialog===
When you press '''shift''' and '''ctrl''' key and double click on any entry of the navigator tree entry, a debug tool dialog will pop up to give a more detail about the selected token. You can query its information such as its member variables, its Ancestors and so on.

[[Image:CcDebugToolDialog.png]]

===Debug Smart Sense log output ===
When you hold the'''shift''' and '''ctrl''' key and right click on any entry of the navigator tree entry, the context menu will have a "Debug SmartSense" menu entry shown. You can click it to enable it. See the image blow. Then, all the debug log information when doing an Auto-completion will be shown in the "Debug Log" panel.

[[File:Cc debug smartsense.png]]

==Mutexs and lockers in CC==
We need lockers to avoid multiply thread issues of wxString. More detailed can be found: [/index.php/topic,17543.0.html wxString and the locker issue in our CC code], to avoid such issue, we need lockers.
There are three main kind of lockers.
<nowiki>wxMutex s_ParserMutex;
wxMutex s_TokenTreeMutex;
wxMutex m_ClassBrowserBuilderThreadMutex;</nowiki>
The first one was to protect multiply access to Parser objects, this is a static variable. The second one tries to forbid the multiply access to the TokenTree, the last one is used to build the symbol browser tree(usually show in the left docked panels of the C::B main frame)

The associated Macros are below:
<source lang = "c">
// For tracking, either uncomment:
//#define CC_ENABLE_LOCKER_TRACK
// ...or:
#define CC_ENABLE_LOCKER_ASSERT
// ..or none of the above.

#if defined(CC_ENABLE_LOCKER_TRACK)
// TRACKING MUTXES
// [1] Implementations for tracking mutexes:
#define THREAD_LOCKER_MTX_LOCK(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Lock() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_LOCK_SUCCESS(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Lock().Success() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_UNLOCK(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Unlock() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_UNLOCK_SUCCESS(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Unlock().Success() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_MTX_FAIL(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Fail() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
// [2] Cumulative convenient macros for tracking mutexes [USE THESE!]:
#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) \
{ \
THREAD_LOCKER_MTX_LOCK(M); \
if (M.Lock()==wxMUTEX_NO_ERROR) \
THREAD_LOCKER_MTX_LOCK_SUCCESS(M); \
else \
THREAD_LOCKER_MTX_FAIL(M); \
}
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) \
{ \
THREAD_LOCKER_MTX_UNLOCK(M); \
if (M.Unlock()==wxMUTEX_NO_ERROR) \
THREAD_LOCKER_MTX_UNLOCK_SUCCESS(M); \
else \
THREAD_LOCKER_MTX_FAIL(M); \
}
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK

// TRACKING CRITICAL SECIONS
// [2] Implementations for tracking critical sections:
#define THREAD_LOCKER_CS_ENTER(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Enter() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_CS_ENTERED(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Entered() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
#define THREAD_LOCKER_CS_LEAVE(NAME) \
CCLogger::Get()->DebugLog(F(_T("%s.Leave() : %s(), %s, %d"), \
wxString(#NAME, wxConvUTF8).wx_str(), \
wxString(__FUNCTION__, wxConvUTF8).wx_str(), \
wxString(__FILE__, wxConvUTF8).wx_str(), \
__LINE__))
// [2] Cumulative convenient macros for tracking critical sections [USE THESE!]:
#define CC_LOCKER_TRACK_CS_ENTER(CS) \
{ \
THREAD_LOCKER_CS_ENTER(CS); \
CS.Enter(); \
THREAD_LOCKER_CS_ENTERED(CS); \
}
#define CC_LOCKER_TRACK_CS_LEAVE(CS) \
{ \
THREAD_LOCKER_CS_LEAVE(CS); \
CS.Leave(); \
}
#elif defined CC_ENABLE_LOCKER_ASSERT
#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();

#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) cbAssert(M.Lock()==wxMUTEX_NO_ERROR);
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) cbAssert(M.Unlock()==wxMUTEX_NO_ERROR);
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#else
#define CC_LOCKER_TRACK_CS_ENTER(CS) CS.Enter();
#define CC_LOCKER_TRACK_CS_LEAVE(CS) CS.Leave();

#define CC_LOCKER_TRACK_TT_MTX_LOCK(M) M.Lock();
#define CC_LOCKER_TRACK_TT_MTX_UNLOCK(M) M.Unlock();
#define CC_LOCKER_TRACK_CBBT_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_CBBT_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#define CC_LOCKER_TRACK_P_MTX_LOCK CC_LOCKER_TRACK_TT_MTX_LOCK
#define CC_LOCKER_TRACK_P_MTX_UNLOCK CC_LOCKER_TRACK_TT_MTX_UNLOCK
#endif
</source>

Each mutex need a Lock and Unlock macro, like for mutex for Parser, we need CC_LOCKER_TRACK_P_MTX_LOCK and CC_LOCKER_TRACK_P_MTX_UNLOCK.

==Usefull Links==

*A discussion on search tree in the forum [/index.php/topic,1696.0.html] and [/index.php/topic,1581.0.html].

*Another opensource IDE [http://vcfbuilder.org/?q=node/139 VCF builder]or[https://sourceforge.net/projects/vcfbuilder/ vcfbuilder on sf], By the way , VCF use a CodeStore based on [http://www.antlr.org/ antlr parser] to deal with parsing, the whole source code can be check out from
<pre>svn co https://vcfbuilder.svn.sourceforge.net/svnroot/vcfbuilder vcfbuilder</pre>

*online book[http://www.macs.hw.ac.uk/~alison/alg/details.html Data Structures and Algorithms II Course ] and [http://www.macs.hw.ac.uk/~alison/alg/lectures.html pdf lectures]

*A forum discussion on why a standard perprocessor and parser works slowly. [/index.php/topic,2494.msg19801.html#msg19801 parsing iostream header takes 5 seconds]

*[http://www.codelite.org CodeLite] is another open source IDE using wxWidgets, use Ctags as a indexing service, and do context expression syntactic analysis generated from Lex and Yacc tools.See the explanation in forum message by it's author eranif [/index.php/topic,10087.msg70875.html#msg70875 How does Codelite's CC work with CTags and Yacc&Lex]

*Hopefully, we can use the patricia tree from the standard library, see here:[http://gcc.gnu.org/onlinedocs/libstdc++/ext/pb_ds/trie_based_containers.html trie]

* a blog from KDE4's developer, it explain the code completion in KDE4, see here:[http://zwabel.wordpress.com/ zwabel' blog]

* QT creator source code from [http://qt.gitorious.org/qt-creator/qt-creator/trees/master QT-creator source]

* [http://websvn.kde.org/trunk/KDE/kdevelop/ Kdevelop source code] and it's [http://websvn.kde.org/trunk/KDE/kdevelop/languages/cpp/parser/ parser]

* [http://stackoverflow.com/questions/1220099/how-does-code-completion-work How does code completion work? - Stack Overflow]

* [/index.php/topic,11724.0.html Just a reminder Codelite IDE now have improved it's parser]

*[http://padator.org/software-yacfe.php Yacfe, a parser with proprocessor enabled]

*[/index.php/topic,1581.msg11701.html#msg11701 A Mini C++ interpreter] from the book "The Art of C++ by Herbert Schildt", source code can be download [http://books.mcgraw-hill.com/downloads/products/0072255129/0072255129_code.zip here]

*[http://www.macs.hw.ac.uk/~alison/alg/lectures/l7.pdf Lecture 7: Parsing (intro) (pdf)] and [http://www.macs.hw.ac.uk/~alison/alg/lectures/l8.pdf Lecture 8: Recursive Descent Parsing (pdf)] from [http://www.macs.hw.ac.uk/~alison/alg/lectures.html Data Structures and Algorithms II]

*There are some online "Compiler design" books listed in [http://www.freetechbooks.com/compiler-design-and-construction-f14.html Free Online Compiler Design and Construction Books :: FreeTechBooks.com], and the best one I think is : [http://www.diku.dk/hjemmesider/ansatte/torbenm/Basics/index.html Basics of Compiler Design], and you can get a basic understanding.

*[http://wiki.eclipse.org/CDT/designs/Overview_of_Parsing CDT/designs/Overview of Parsing].

* [http://en.literateprograms.org/Radix_tree_(C) Radix tree (C) - LiteratePrograms]

* LLVM's online tutorials on how to write a simple compiler [http://llvm.org/docs/tutorial/index.html LLVM Tutorial]

* Roberto Raggi's new parser[https://github.com/robertoraggi/cplusplus cplusplus 5 My experimental C++ front end], note Roberto Raggi is the author of the parser for both Qtcreator and Kdeveloper IDE.

* KDevelop are discussing clang now, see [http://milianw.de/blog/katekdevelop-sprint-2014-let-there-be-clang Kate/KDevelop Sprint 2014: Let There Be Clang | Milian Wolff]

Coding style

2014-02-10T14:15:15Z

Ollydbg: /* Commenting */ doxygen comment style

[[Category:Developer Documentation]]
The following are guidelines for the code formatting to use in Code::Blocks source code. Anyone writing code or a [[Creating a patch to submit to BerliOS (Patch Tracker)|patch]] for Code::Blocks, is required to follow these.

== General coding style ==

The general coding style is the ANSI one:

Example:
<pre>
namespace FooSpace
{
int Foo()
{
if (isBar)
{
Bar();
return 1;
}
else
return 0;
}
}
</pre>

== Variables naming ==

Class names do not start with 'C' (as in CObject, CWindow, etc). Only abstract base classes (interfaces) should start with 'I'.
But they all have to start with a capital letter.

Class member variables should start with <tt>m_</tt>. If the variable is a pointer, use <tt>m_p</tt> as a prefix.
Following the prefix is the variable's name. Use descriptive names and use capital letters at the start of each word (the first too). So a fictious variable holding a value for position would be named as <tt>m_ValueForPosition</tt>.

Non-class member variables should not start with a capital letter.

Function names should always start with a capital letter.

Examples:
<pre>// Good
int aLocalVar;
int m_SomeInt;
void* m_pSomePointer;
bool SomeFunc();

// Bad
int SomeInt; // either no m_ prefix if it's a class variable,
// or capital first letter if it's a local variable
int m_someInt; // no capital letter 'S'
void* m_SomePointer; // no m_p prefix
bool someFunc(); // function with non-capital first letter
</pre>

Parameters that are not absolutely required to be used in an interface or base class should preferrably be tagged with the <tt>cb_optional</tt> macro so users of the interface realize this, and as a side effect no compiler warnings are generated.

Parameters that are ''actually not used'' should be tagged <tt>cb_unused</tt> both to suppress a compiler warning and indicate that this is happening intentionally.

If the caller of a function takes ownership of the object referenced by the return value, tag the function as <tt>cb_must_consume_result</tt>.

== Variables declaration ==

One variable declared each time on a different line.
For pointer/reference variables, the '*' or '&' is part of the type.

Examples:
<pre>// Good
int& someInt;
void* pPtr;

// Bad
int &someInt; // & not after type
void* pPtr, pSomeOther; // multiple declarations in one line
</pre>

== Spacing ==

Prefer spaces over tabs. If you want to use tabs you won't be prosecuted (!) but please use a tab size of 4 spaces. 
Code indentation should be 4 spaces. 
In class declarations, the keywords <tt>public:</tt>, <tt>protected:</tt>, and <tt>private:</tt> should be indented. The same goes for all the class members.

Examples:
<pre>
// Good
class AClass
{
public:
AClass(){ ... }
protected:
int m_Member;
};

// Bad
class AClass
{
public:
AClass(){ ... }
protected:
int m_Member;
};
</pre>

== Commenting ==

* All three types of comments are used in Code::Blocks. C++ style ('//'), C style ('/* */'), and the Doxygen style ('/** */').
* The C++ style is used for just about everything. Use this style to describe what your code does.
* The C style is used only for very long comments (paragraphs), or for a license or description at the top of a C++ file.
* The Doxygen style is used for documenting functions only. These functions would be public, and protected class functions, and global helper functions.
* Comments should clearly describe what the code does. Comments should be concise, but coherent.

=== Doxygen style comments ===
This is the recommended Doxygen style, see [/index.php/topic,15948.msg107431.html#msg107431 comment style question] for details.
<source lang = "cpp">
/** Short description
*
* Long description
*/
</source>

== Header file include and Precompiled header rule ==
The NON-PCH compilation (I mean with NOPCH switch, that's different from simply disabling PCH!) will be helpful to detect missing includes. Keep in mind that no matter what we do - wx will do and use PCH unless we declare NOPCH at the compile time. So even if we disable our PCH, the patches won't stop unless we do it properly in the first place.

The rules are plain simple:
PCH file:
- include all rarely changing header files
- do the PCH macro vodoo (we have that already)
Header:
- If you access or define an object, include the header
- If you use pointers/references, use forward decl
- Put headers you need to include into such a section if they are part of your PCH file:
Code:

<source lang = "cpp">
#ifndef USE_PCH
#include <wx/dialog.h>
#endif
</source>

- Include headers you need to include that are not part of your PCH file as normal
Implementation:
- include the PCH file first
- same thing for headers needed as in the header file.

I do it that way in my own projects and i works flawlessly for ages! Of course, whenever I change code and use new classes, I need to check the above rules.

But (nevermind) if we decide to get rid of this because these rules are too hard - go ahead.

Here comes a simple small class:
Header:

<source lang = "cpp">

#ifndef USE_PCH
#include <wx/dialog.h> // is in wx_pch.h!
#endif

#include <wx/busyinfo.h> // NOT in wx_pch.h and used as object

class MyClass; // forward decsl due to pointer usage

class MyDlg: public wxDialog
{
MyDlg() { ; };
void Func(MyClass* c); // used as pointer
wxBusyInfo bi; // used as object
}
</source>
Implementation:

<source lang = "cpp">

#include <wx_pch.h> // our PCH file, may include the WX PCH file (if needed)

#include "MyDlg.h"

#ifndef USE_PCH
#include "MyClass.h" // is in wx_pch.h, but now used as object / accessed
#endif

#include "MyOhterClass.h" // NOT in wx_pch.h and used as object

void MyDlg::Func(MyClass* c)
{
MyOtherClass moc;
c->DoSomething(moc);
}
</source>
See some disscussion in our forum: [/index.php/topic,16028.msg108172.html#msg108172 Morten's comments on include file rules]

Also: [/index.php/topic,3321.msg26184.html#msg26184 include rules (by killerbot)]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-12T07:35:42Z

Ollydbg: /* Reference */

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference ===
* Forum discussion:[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]
* [[Installing Code::Blocks from source on Windows]]
* Note that PCH is disabled in Codeblocks_wx30.cbp, because it cause GCC build error (a bug in GCC 4.8.x [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=56926 Bug 56926 – Crash (without ICE) while compiling Boost.Math]), see discussions here: [/index.php/topic,18412.msg126028.html#msg126028 Re: wxWidgets 3.0 and Code::Blocks files question?] and [/index.php/topic,18568.msg127102.html#msg127102 Patches for Compiling Code::Blocks against wxWidgets 3.0 using MinGW GCC 4.8.1]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-12T07:34:55Z

Ollydbg: /* Reference */

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference ===
* Forum discussion:[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]
* [[Installing Code::Blocks from source on Windows]]
* Note that PCH is disabled in Codeblocks_wx30.cbp, because it cause GCC build error (a bug in GCC 4.8.x), see discussions here: [/index.php/topic,18412.msg126028.html#msg126028 Re: wxWidgets 3.0 and Code::Blocks files question?] and [/index.php/topic,18568.msg127102.html#msg127102 Patches for Compiling Code::Blocks against wxWidgets 3.0 using MinGW GCC 4.8.1]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-12T07:32:34Z

Ollydbg: /* Reference */

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference ===
* Forum discussion:[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]
* [[Installing Code::Blocks from source on Windows]]
* Note that PCH is disabled in Codeblocks_wx30.cbp, because it cause GCC build error (a bug in GCC 4.8.x), see discussions here: [/index.php/topic,18412.msg126028.html#msg126028 Re: wxWidgets 3.0 and Code::Blocks files question?]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-06T14:41:22Z

Ollydbg: add one reference

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference ===
*Forum discussion:[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]
*[[Installing Code::Blocks from source on Windows]]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-06T14:30:02Z

Ollydbg: update the build steps, remove unnecessary steps

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_dll directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 USE_OPENGL=1 VENDOR=cb CXXFLAGS="-fno-keep-inline-dllexport" >log.txt 2>&1</tt>

'''NOTE:''' If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]] named "wx30"
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Set the global variable cb_release_type to "-g". (no quote is needed when your enter the text)
*Compile Code::Blocks.

'''NOTE:''' A zip.exe file should be in your PATH, so they can run post steps correctly, see [https://wiki.codeblocks.org/index.php?title=Installing_Code::Blocks_from_source_on_Windows#zip.exe 1.6 zip.exe] for some details about zip.exe

=== Post compilation steps ===
When the compilation process is finished, simply run the update30.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference forum discussion ===
*[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-06T06:53:47Z

Ollydbg: first step to update the to wx3.0

'''Note, compiling Code::Blocks linked against the wxWidgets 3.0.0 is NOT ready for stable use; CodeBlocks developers are working hard to stabilize it, also patches are welcome to accelerate the migration'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 3.0.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#latest_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Editing the values to be used in wx/setup.h ===
Note, changing the value of wxUSE_STC prevents error compiling Code::Blocks because it has its own custom version of STC.
===== Open the folder <WXWIN>\include\wx\msw\ =====
===== If the file setup.h does not exist copy the file setup0.h to setup.h =====
===== With an text editor open <WXWIN>\include\wx\msw\setup.h =====
===== Change "#define wxUSE_STC 1" to "#define wxUSE_STC 0" =====
===== Save the changes =====

=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc MONOLITHIC=1 SHARED=1 UNICODE=1 USE_STC=0 USE_PROPGRID=1 BUILD=release clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_msw directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc MONOLITHIC=1 SHARED=1 UNICODE=1 USE_STC=0 USE_PROPGRID=1 BUILD=release</tt>

'''NOTE:''' These options are not the officially-supported Code::Blocks options because there is no official options for wxWidgets 2.9. The option of "USE_STC=0" is needed because Code::Blocks has its own customized version of it; and, if both exists it will cause errors building Code::Blocks plugins. The option "USE_PROPGRID=1" is used to help building plugins that depend on wxPropertyGrid. If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Code::Blocks project to use===
No patches are needed to compile Code::Blocks with wxWidgets 3.0, just use the project/workspace-files with the ''_wx30'' in the name and call ''update30.bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks_wx30.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]]
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-3.0.0\wxWidgets-3.0.0").
*Compile Code::Blocks.

=== Post compilation steps ===
When the compilation process is finished, simply run the update.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

=== Reference forum discussion ===
*[/index.php/topic,18412.msg125957.html#msg125957 Re: wxWidgets 3.0 and Code::Blocks files question?]

Compiling wxWidgets 2.9.0 to develop Code::Blocks (MSW)

2014-01-06T04:16:53Z

Ollydbg: moved Compiling wxWidgets 2.9.0 to develop Code::Blocks (MSW) to Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW): wx 3.0.0 is release, and wx 2.9.x is deprecated.

#REDIRECT [[Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)]]

Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW)

2014-01-06T04:16:53Z

Ollydbg: moved Compiling wxWidgets 2.9.0 to develop Code::Blocks (MSW) to Compiling wxWidgets 3.0.0 to develop Code::Blocks (MSW): wx 3.0.0 is release, and wx 2.9.x is deprecated.

'''Note, the wxWidgets 2.9.0 release is a development release NOT intended for production use.'''

'''Note, compiling Code::Blocks linked against the wxWidgets 2.9.0 is NOT ready for stable use; it crashes and fails to compile from time to time.'''

These are the instructions for compiling wxWidgets for use with Code::Blocks. They are primarily intended in preparation for compiling Code::Blocks itself but (hopefully) may also help installing wxWidgets for general development using that framework.

Although these instructions are targeted at the Windows operating system, it should be possible to apply them with slight adjustments to other platforms, since we make use of MinGW.

== Installing MinGW ==
Directions to install MinGW for Code::Blocks can be found here.
[[MinGW installation]]

== Installing the wxWidgets Source Code ==
The wxWidgets 2.9.0 distribution can be found at the [http://www.wxwidgets.org/downloads/#previous_stable wxWidgets download site]. (Note that there is also a winhelp file available.) You can choose between an installer and a zip file. You can just get the zip file because the installer is also a zipped version.

If you use the plain zip version, make sure to unzip using the full path. Otherwise the directories won't be created correctly.

'''NOTE:''' For the remainder of these instructions we call the wxWidgets directory ''<WXWIN>''. You have to change it to your corresponding directory (e.g. "c:\wxMSW-2.9.0\wxWidgets-2.9.0").

'''NOTE:''' You do not need MSYS. Furthermore, you cannot have MSYS in your path, or the wxWidgets compilation will fail. Thus, if you have MSYS installed, ensure that ''<MSYS>\bin'' '''is not''' in your path before compiling wxWidgets. wxWidgets must be compiled from a "regular" command line (like cmd.exe), not from a Unix-like shell. The same problem could arise if Cygwin is in the path.

'''NOTE:''' For the remainder of these instructions we call the MinGW directory ''<MINGW>''. You have to change it to your corresponding directory (e.g. "C:\MinGW").

== Checking make Version ==
If you didn't install MinGW yourself you have to ensure you are using a recent enough version of the make utility. Open a command prompt and type:
<tt>cd <MINGW>\bin
mingw32-make -v</tt>
The version should read 3.80 or higher.

== Building wxWidgets ==
=== Editing the values to be used in wx/setup.h ===
Note, changing the value of wxUSE_STC prevents error compiling Code::Blocks because it has its own custom version of STC.
===== Open the folder <WXWIN>\include\wx\msw\ =====
===== If the file setup.h does not exist copy the file setup0.h to setup.h =====
===== With an text editor open <WXWIN>\include\wx\msw\setup.h =====
===== Change "#define wxUSE_STC 1" to "#define wxUSE_STC 0" =====
===== Save the changes =====

=== Changing Directory and Setting Path ===
To compile wxWidgets, open the command prompt window and change to the wxWidgets directory:
<tt>cd /d <WXWIN>\build\msw</tt>

<tt>SET PATH=<MINGW>\bin</tt>
'''NOTE:''' This is normally SET PATH=C:\MingGW\bin

=== Cleaning wxWidgets Code ===
Now clean up the source:
<tt>mingw32-make -f makefile.gcc MONOLITHIC=1 SHARED=1 UNICODE=1 USE_STC=0 USE_PROPGRID=1 BUILD=release clean</tt>
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

'''NOTE:''' If you still have problems with compiling after cleaning, you could try to manually remove the gcc_msw directory under the build\msw directory. This directory is the place where the object files are stored.

=== Building wxWidgets Code ===
When everything is clean you can start compiling wxWidgets:
<tt>mingw32-make -f makefile.gcc MONOLITHIC=1 SHARED=1 UNICODE=1 USE_STC=0 USE_PROPGRID=1 BUILD=release</tt>

'''NOTE:''' These options are not the officially-supported Code::Blocks options because there is no official options for wxWidgets 2.9. The option of "USE_STC=0" is needed because Code::Blocks has its own customized version of it; and, if both exists it will cause errors building Code::Blocks plugins. The option "USE_PROPGRID=1" is used to help building plugins that depend on wxPropertyGrid. If you want another version of wxWidgets (debug or non-Unicode) you still have to make sure you build a MONOLITHIC version (one big DLL) for linking Code::Blocks.

Patience. This step takes time. Make sure there was no compilation error before you continue.

== Compiling Code::Blocks ==
=== Patching Code::Blocks to using 2.9 instead of 2.8 ===
No patches are needed to compile Code::Blocks with wxWidgets 2.9, just use the project/workspace-files with the ''_wx29'' in the name and call ''update29,bat'' to update the resources.

That does not mean, that everything runs absolutely bug-free, but we are working on it.

As always patches are welcome.

=== Setting up paths ===
Before finally compiling Code::Blocks itself, you need to setup the paths:
*Open the Code::Blocks project (CodeBlocks.cbp).
*It will ask you to define a [[Global compiler variables|Global variable]]
*Set the path to where you have wxWidgets installed (e.g. "c:\wxMSW-2.9.0\wxWidgets-2.9.0").
*Compile Code::Blocks.

=== Post compilation steps ===
When the compilation process is finished, simply run the update.bat script. It will ensure that all resource files Code::Blocks uses are in the right place and up to date.

Developer documentation

2014-01-06T04:02:30Z

Ollydbg: add some source mirrors