Code::Blocks - User contributions [en]

WxSmith tutorial: Hello world

2017-01-09T00:17:20Z

Alpha: Stop entire page from being in italics

[[Category:wxSmith Documentation]]
= Tutorial 1. "Hello, World!" =

In this first tutorial, we will use wxSmith to put the words "Hello, World!" on the screen. Ever since the appearance of ''The C Programming Language'' in 1978, writing such a program has been the traditional first step in learning nearly every computer language.

Before we start, you must either compile wxWidgets or download precompiled binaries and header files. These steps are described on the wiki pages mentioned here:
* Windows users should see the wiki page:[[Compiling wxWidgets 2.8.6 to develop Code::Blocks (MSW)]] or [[Installing Code::Blocks from source on Windows]] or [[WxWindowsQuickRef]]. There are two ways to install the wxWidgets libraries, You can download the wxWidgets source and compile it yourself, or you can download the wxPack from [http://wxpack.sourceforge.net/] and install it. The wxPack contains a pre-compiled wxWidgets library, so you can save a lot of time by that route.

*Ubuntu Linux users can install wxWidgets from the Ubuntu repositories. Be sure to install also '''build-essential''' to get the C++ compiler.

We will assume that you have wxWidgets ready and working with Code::Blocks. You should probably create a directory with a name something like CBProjects for saving your work on these tutorials. Each tutorial will be a separate "project" and will occupy a file in this directory.

After downloading and installing Code::Blocks, double-click its icon on the desktop to start it. Here is the Code::Blocks opening window:

[[Image:1a.png]]

Click "Create a New Project" and then find and double-click the wxWidgets Project icon, pointed to by the cursor in the screenshot below.

[[Image:wxs_tut01_002.png]]

The next screen is a "Welcome" screen. Unless you just enjoy being welcomed by the program, you will check the box which eliminates it on future startups.

The next screen looks like this:

[[Image:wxs_tut01_003.png]]

Select wxWidgets 2.8x and click the "Next >" button at the bottom of the screen.

That brings you to the window where you specify the Project title and folder where you want to save the project. Other fields are then filled automatically. I chose “Plain” as the Project title and the other fields then adjusted to look like this:

[[Image:1c.png]]

Then click the “Next >” button at the bottom.
The next screen, shown below, allows you to mark your work with your identity. Fill in what you wish.

[[Image:1d.png]]

That brings up the window for choosing the GUI builder you want to use, wxSmith or FormBuilder. We choose, of course, wxSmith.

[[Image:1e.png]]

Click the "Next" button at the bottom.

The next screen specifies what C++ compiler we want to use and whether we want a debug build (with extra code for debugging) or a smaller release build for use by others. We will go for the GNU CPP compiler and both build options, to be put in separate subfolders.

[[Image:1f.png]]

The final screen of this sort asks whether we want to use the standard, default, configuration or to use Advanced options. We will take the default. But, at the bottom, we choose to “Create and use precompiled headers" which speeds up compilations after the first.

[[Image:1g.png]]

In wxWidgets 3.0.2 the screen looks like this. [[User:WardXmodem|WardXmodem]] 21:38, 20 May 2015 (CEST)

[[Image:1g_3.0.2.png]]

On the form where we chose the directory for saving the project, we chose a real directory, but that choice may lead to problems when you want to compile your project on other computers. Another choice is to use the '''Global Variable system'''. To open the dialog below or modify or change this global variable, you should click on the Code::Blocks main menu item '''Settings | Global variables'''. That brings up the Global Variables Editor.

When you use it, the location of the wxWidgets library is read from the variable you supply. This means that the location of the wxWidgets directory is not hard-coded inside your project, but is stored inside the global configuration of Code::Blocks. When your project is opened on a different computer, it will use that comoputer's configuration. The easiest option to use this global variable is to leave ''$(#wx)'' which means to use the global variable named ''wx''. This name is reserved for wxWidgets and should be chosen in most cases.

When you use the global variable for the first time, it will ask for the wxWidgets directory. The only thing you need to do here is to enter a valid location in ''base'' field. This is required only for the first time since Code::Blocks will automatically use this setting for other projects you create.

==Overview of the Interactive Development Environment (IDE)==

At the end of this preliminary sequence of forms we come to the Code::Blocks main IDE window. It should look something like this:

[[Image:1h.png]]

In the middle of the right side of the window, under the word “Plainframe.wxs”, is a panel
with two square icons on the left; the one on the left brings up the menu bar editor while the one on the right brings up the status bar editor. We will return to the menu bar editor in the next tutorial. Below this panel and looking like a field of dots is the Editor window, where we will see both the GUI forms which we build and the C++ code we write. In the lower left corner of the whole window is the Properties/Events window, which will allow us to set properties of the component we are working on or to pick events, such as “OnClick” , to which we need to respond. To show properties, click on the left icon; to show events, click on the right icon marked {} to suggest C++ code.

Above the Properties/Events window is the Management window with three tabs, Projects, Symbols, and Resources. If all three tabs are not visible, drag the right border of the window to the right to reveal all three. (A “resource” in wxSmith parlance usually means a “form” or "window".) Above the Management window is a panel with several small but useful icons ([[Image:build-etc-icons.png]]) to
*Build the program, or
*Run it, or
*Build and run it, or
*Rebuild it, or
*Abort it. 
When you run the cursor over them, the tool tips will tell you which is which.

Now look back to the Editor window. First of all, note that the window can be configured to use different colors,fonts and font sizes. Click "Settings ..." on the Code::Blocks main menu, and then "Editor". The screens are more or less self-explanatory.

Now back to the Editor window. Across the top you see three black square called drag handles. They have been set to cover a space larger than can be seen, but scrolling down reveals the whole field.

As an experienced programmer, you know there has got to be some code somewhere but you don't see it. To reveal it, double left click in the field of dots. Presto, there is the C++ code, and the *PlainMain.cpp tab has appeared above it. Clicking back on the Plainframe.wxs should return you to the view of the form, still the field of dots. (Again, it is important to have CB 10.04 or later.) In fact, we still have not seen all of the code. In particular, you will search in vain for the all-important OnInit() routine that starts the program. You can find it, however, by clicking Search | Find in Files and searching for OnInit with the scope of the search set to be “Project files”. The search finds it, sure enough, in PlainApp.cpp and opens this module in the Editor window.

==== ''The following discussion on having to add close() is no longer true, at least at Code::Blocks 13.12, wxWidgets 3.0.2. '' ====

We don't need OnInit right now, but we do need to make a change in PlainMain.cpp. Click on it in the bar above the editor, and its code appears in the editor.

Sometimes a program has a lot to do when the user clicks the close icon in the program's title bar, so wxSmith generates a frame for writing the code for those actions but it provides no code. Consequently, if we ran our program just as initially written by wxSmith, we won't be able to close it by just clicking that icon. To fix that inconvenient problem, find the spot in the code with these lines:

<pre>
void PlainFrame::OnClose(wxCloseEvent& event)
{
}
</pre>

Add the call to the Close() function so that the spot looks like this:
<pre>
void PlainFrame::OnClose(wxCloseEvent& event)
{
Close();
}
</pre>
(''I found it had to be Destroy() not Close() [[User:WardXmodem|WardXmodem]] 04:43, 24 September 2013 (CEST)'')

(''use event.Skip(TRUE); instead of Close(); or Destroy(). (Some) later tutorials correctly reference this. [[User:Ensnarer|Ensnarer]] 03.08.2015'')

Remember to make this change immediately whenever you start a new project.

==== ''End of old "have to add close()" section. With newer releases the following is done for you:'' ====

<pre>
void PlainFrame::OnQuit(wxCommandEvent& event)
{
Close();
}
</pre>

[[User:WardXmodem|WardXmodem]] 22:43, 20 May 2015 (CEST)
==== End of updated close() information. ====

You can now build and run this super-simple program. To do so, you can do any one of three equivalent things: 
* in the top menu bar, click Build | Build and run.
* find and click the icon that looks like a right-pointing triangle in front of a cogwheel. Hovering the mouse pointer over it will show the tool tip “Build and run”.
* tap the F9 key.

If all goes well, you will see a window come up with a menu of two items: “File” and “Help”. Try the “Help” menu item first. Then you can use “File | Quit” or the exit icon on the title bar to exit the program.

''If you are using Ubuntu and get no main menu bar when you run this program, you have fallen victim to [https://bugs.launchpad.net/ubuntu/+source/wxwidgets2.8/+bug/662077 Ubuntu bug 662077]. Beginning with release 10.10, Ubuntu releases have had a bug causing programs built with wxSmith to fail to show their main menu bar. If this bug affects you, you may want to uninstall appmenu-gtk. You do that by clicking Applications | Software Sources, then using the search window to find appmenu-gtk. Clicking on it will allow you to choose to remove it.''

Well, so far we have a program that runs and quits, but it does not yet display "Hello, World!". That's next.

== Hello, World! ==

We now turn to the classic first program, namely getting the words “Hello, World!” onto the screen. The text could be added directly into the frame, as in GUI designers for a single operating sytem; but we need to learn to use sizers for cross-platform programming. What are sizers?

If you have been working with Java or Qt, you may remember something called Layout managers. The implementation in wxWidgets differs a little but does almost the same thing.

When adding components into windows you must somehow specify their position and size. wxWidgets tries to automate this process, and it uses sizers to do so. They automatically position and size window components, and they can also set the size of the window so that everything fits inside.

Sizers have one big advantage over direct placement of components. When you write cross-platform applications, you cannot assume that fonts, buttons, and so on have the same size on different operating systems. This problem can even occur on the same platform when using different window themes. When you use sizers, you don't have to worry about those problems. All sizing and placement is done automatically. Moreover, sizers can even reposition and resize window components when the main window changes size.

With that background, let's get started. When you look at the wxSmith editor, you'll notice that the area of the window is surrounded by eight black boxes or drag handles.

[[Image:wxs_tut01_009.png]]

These drag handles surround the currently selected item. In our case it's a whole window. Adding new components to the window is simply done by clicking on one of the buttons in the palette at the bottom of the editor and then clicking somewhere on the resource. As you can see here,

[[Image:wxs_tut01_010.png]]

when you keep your mouse cursor over a component in the palette, it will show its name. That feature may help you find components until you become familiar with their icons.

Let's add a new wxPanel component to our window; it is the fourth icon from the left on the standard tab. You will see that when you click the wxPanel item and then move the cursor over the editor, some part of the editor will change color. That's intentional and is used to show where on the window the new item will be added.

After the wxPanel is in place, you will notice that the background color of the window has changed to light gray. Now our window will look much more like other windows. Note that currently the selection changed to the added panel but since its size is equal to the frame's, it's hard to find out what's really selected. To make sure that wxPanel is selected, click somewhere on the light gray area of our window (Note to Linux users: wxFrame and wxPanel usually have the same background so it may look like nothing has changed; you may ensure that there's a wxPanel by looking into the resource browser).

If you want to see the selection exactly or select items that overlap, you can use the resource browser. To show it, click on the resources tab located in the same place where the project browser is:

[[Image:wxs_tut01_011.png]]

The resource tab consists of two parts. The first is the resource tree which shows the structure of your resources and the second one is the property browser which is common in GUI designers. Inside the resource tree you can find the currently selected item. In our case it is the wxPanel class we added before. The selected item also shows the name of this item: Panel1. This name is basically the variable which can be used to access this component in your code.

We added a new component by selecting the place for it. This is wxSmith's default behavior. However, there is another mode of adding items. In this mode, the new item is added right after you click on the palette's button. The position of the new item is relative to the current selection - just like a cursor in text editors. Basically we can add new items into three different positions relative to the selection:
* Before the selected widget
* After the selected widget
* Into the selected widget.
This insertion mode can be changed by clicking one of the four "placement" buttons on the right side of the editor:

[[Image:wxs_tut01_012.png]]

The uppermost is the mode we used - "point by mouse". The next one means "add into", followed by "add before", and the last one means "add after". The current mode is shown by a red check mark on the button.

Sometimes a few selection modes are disabled because they are not valid for the currently selected item. For example, you cannot add any component into the wxButton component since wxWidgets declares it as one that cannot have child components. Similarly, when the main component (the window) is selected, you won't be able to add anything after it or before it.

Ooops! I said we would use sizers and then forgot all about them! We have to get rid of that wxPanel. Select the panel and then click on the red X button just below the four buttons we have been describing. It looks like this:

[[Image:wxs_tut01_014.png]]

When you click this button, it deletes the current selection, so if the panel didn't disappear, make sure it's selected and click the button again. Now we should have returned to the state at the beginning.

To use sizers, first we have to add a sizer into the main frame and then add the wxPanel into it.
Sizers are available in the Layout tab on the palette. Switch to it and select wxBoxSizer:

[[Image:wxs_tut01_013.png]]

This sizer tries to position items in one line, either horizontal or vertical. Horizontal is the default, and we will use it.

After adding the sizer, two things have changed. The first is that our window now has a red border. This means that there is a sizer attached to it. When you look into the resource browser, you will also see that the sizer has been added. (You may need to click on the editor area to refresh the selection on the resource browser.) The second change is that the size of the window has shrunk to a small box. That is as it should be because the sizer is responsible for resizing the window to be no bigger than necessary to be visible and accommodate its components, and so far there are no components.

Now let's add our wxPanel. Make sure that you add it into the sizer, not into the main frame. After you do so, you will see something like this:

[[Image:wxs_tut01_015.png]]

Here we can see our panel surrounded by drag boxes. There's also some dark gray border around it (it won't be visible on Linux). Each component added into the sizer can be surrounded by such a border. It's useful when you want to have spacing between components. But in our case we should get rid of it to get a better looking window. To do so, we will have to change a property inside the property browser. Search for border size and change it from 5 to 0:

[[Image:wxs_tut01_016.png]]

Now when we have our panel adjusted, we can finally add the "Hello world" text. Since we will also use sizers to manage items added into wxPanel, we have to repeat the addition of wxBoxSizer into wxPanel. After the sizer is in its place, switch back into the '''Standard''' tab on the palette and add a wxStaticText control:

[[Image:wxs_tut01_017.png]]

With an eye to the future and for practice with adding components, let's add also a button next to the wxStaticText. First, click on wxButton. If you still have the "point by mouse" insertion mode turned on, then when you put the mouse over the wxStaticText component half of that component will be colored in light blue. When the left half of the text is highlighted, the new item will be added before the existing component; and when the right half is highlighted, the new component will be added after the existing one. Let's add the button after the text. Now we should have this content:

[[Image:wxs_tut01_018.png]]

Now let's finally set our "Hello, World!" text. The wxStaticText control which we added before has the text "Label" on it. It is the default text set to all newly created wxStaticText classes. We will change it using the property browser similarly to changing the border size in the wxPanel class. To do so, select the wxStaticText component in our window, then find the Label property in the property browser and change it to "Hello, World!":

[[Image:Wxs_tut01_019.png]]

If you want two or more lines of text on the wxStaticText control. click on the "..." button at the right end of the “Label” line or put "\n" inside the text, as in C formats.

At this point, you can click the "Build and run" and the program should run and show the magic words in the static text control. We could quit in triumph at this point, but the button we have put on the form is still a dud; clicking on it will do nothing. Let's give it a function.

Before going further, we need to deal with a question you may be asking. Why did we, after putting a box sizer onto our main window, proceed to put a wxPanel into it and then put another box sizer onto the panel? What is the point of the panel? Why not just put our two buttons into the first box sizer and eliminate the panel and second box sizer? The answer is that the panel gives us control of the background. We didn't use it, but it is often useful to be able to control it. In fact, these first three steps will be used in structuring every window used in these tutorials. To review, these three steps are:
* Put a box sizer on the window
* Put a panel into the first box of the sizer
* Put a sizer of some sort onto the panel.

== Responding to the Click of a Button ==

Since buttons usually cause something to happen when clicked, let's make our button close the window. The first thing we should do is to change the text shown on the button to tell the user what the button does. It is done just as in the case of the wxStaticText widget. Select the button, find "Label" in the property browser and set it to "Close" (or anything you like).

The second thing is to assign an event handler to this button. Basically, event handlers are functions which are called when some "event" occurs. In our case instead of "event" we could say more descriptively " a click on the button" because that is what we want to process. Like other GUI designers, wxSmith can automatically generate the framework code for such handlers. To bring up that ability, switch the property browser to the event browser by clicking on the second icon at the top of the property browser. The icon looks like {} to suggest C++ code.

[[Image:1Event_Icon.png]]

After you click on this icon, you will see all events supported by the currently selected component. The wxButton class supports only one event, the EVT_BUTTON event, so only this one is shown. When you click on this event and drop down the combo box, you will see the available options and handlers for this event:

[[Image:Wxs_tut01_021.png]]

If you select '''-- None --''' no handler function will be automatically assigned to this event. (But it may always be set manually.) Selecting '''-- Add new handler --''' will generate a frame for the code of the new handler function. Below are shown other event handlers known to wxSmith which can be assigned to this event. We can see here OnQuit and OnAbout. Those handlers were created by wizard. We could use the OnQuit handler, but to see what happens, let's write our own handler. Select the '''Add new handler''' option. You will be asked for a name for the handler. This name is simply the name of the function which will be called as a reaction to this event. wxSmith will suggest the name OnButton1Click, and we may as well use it.

When you enter a new handler name, wxSmith will generate the framing code of a new handler function by that name, open the program file with the proper source code and put the cursor inside the handler function. (You may need to scroll up or down to show the line with cursor.) This function is a member of the class we have been building, so it can access all of functions in that class, including the one called '''Close()''', which was created by the wizard. So when we want to close our window we just call the '''Close()''' function. The result looks like this:

[[Image:Wxs_tut01_022.png]]

Build and run our project. It should show our "Hello, World!" text and our "Close" button. Click the Close button, and it should close.

This is end of this first tutorial, I hope that you followed it easily and are beginning to feel comfortable with Code::Blocks and wxSmith.

The tutorial was originally written by BYO, the creator of wxSmith. It was revised in March 2012 by Grouch to take account of changes in Code::Blocks, add a few clarifications, and change the accent in the English from youthful Polish to elderly American.

----

<center>'''[[WxSmith tutorials|Index]] | [[Wxsmith tutorial: Working with items|Next]]'''</center>

Announcement for plugins/patches

2016-02-01T21:04:45Z

Alpha: link more recent clang work

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[QtPregenForCB plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [/index.php/topic,18785.0.html here] and [/index.php/topic,20623.0.html here])
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Main Page

2016-01-29T19:58:35Z

Alpha: Update to 16.01

__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 16.01]
* [/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/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>

MinGW installation

2015-09-25T04:15:59Z

Alpha: Update install recommendation

[[Category:User Documentation]]
==Install the MinGW Bundled Package==
The fastest way to set up a working compiler is to install '''packages of recent GCC releases targeting the MinGW compiler system''', from [http://www.tdragon.net/recentgcc/ TDM-MinGW installer ]. The Code::Blocks team recommends TDM builds of MinGW.

If you want to download each packages yourself, you can follow the chapters below.

==Using the MinGW installer==
Note: At the present time, it is still best to download the packages by hand, as the installers are not production quality (unless you really feel unsure about unpacking a couple of archives).

Also, the installer reportedly does not work on Windows Vista, follow the [[MinGW_installation#GCC_3.4.5_manual_install | manual installation instructions]]. 
''(In general, MinGW is not confirmed to work for any Windows Vista betas or RCs)''

'''MinGW has been confirmed working in Windows Vista Business!''' Thanks to [http://aarongiles.com/?p=199 Aaron Giles' Solving the Windows Vista Build Issues] for the solution.
In summary, the MinGW folder must be "a directory immediately off the root of your hard disk for some reason. So c:\mingw works fine, but c:\tools\mingw won’t." (You can use mklink to symbolic-link the folder, which also works). Secondly, set the GCC_EXEC_PREFIX environment variable to the MinGW root folder. Finally, add %GCC_EXEC_PREFIX%\libexec\gcc\mingw32\3.4.5 and %GCC_EXEC_PREFIX%\lib\bin to the PATH environment variable.

'''A HowTo exists [[Installing_MinGW_with_Vista | here]]'''

MinGW Installer 5.02 allows to choose the SF mirror while 5.03 does not (automatically picks one randomly).

MinGW Installer 5.0.x are broken because of changes done by sf.net; please use the MinGW Installer 5.1.x

Installers allows to downloads/installs "previous", "current" and "candidate" mingw packages.

*[http://prdownloads.sourceforge.net/mingw/MinGW-5.0.2.exe MinGW Installer 5.0.2]
*[http://prdownloads.sourceforge.net/mingw/MinGW-5.0.3.exe MinGW Installer 5.0.3]
*[http://prdownloads.sourceforge.net/mingw/MinGW-5.1.3.exe MinGW Installer 5.1.3]

'''Note that the MinGW version number is not related to the actual compiler version.'''

Note that the installer applications require an internet connection and will download the actual MinGW packages at the time of installation.

The required MinGW Components are "MinGW Base Tools", "g++ compiler" and "MinGW make".

==GCC 3.4.5 manual install==
This is the "candidate" release of MinGW, so it is not considered "stable" officially. Personally, I have not had any kind of problem with this release.

To do a manual install, simply download the desired files and extract them all into the same directory. If you have WinZip, PowerArchiver, or any other similar program, this is as easy as selecting all the archives simultaneously and choosing "unpack here" from the context menu.

For clarity, I recommend to put MinGW into C:\MinGW, but almost any other locations should do equally well. Avoid pathnames with spaces or exotic characters, as this may confuse some commandline tools (most notably <tt>gdb</tt>).
===Base system with C++===
*[http://prdownloads.sf.net/mingw/gcc-core-3.4.5-20060117-1.tar.gz http://prdownloads.sf.net/mingw/gcc-core-3.4.5-20060117-1.tar.gz]
*[http://prdownloads.sf.net/mingw/gcc-g%2B%2B-3.4.5-20060117-1.tar.gz http://prdownloads.sf.net/mingw/gcc-g++-3.4.5-20060117-1.tar.gz]
*[http://prdownloads.sf.net/mingw/mingw-runtime-3.9.tar.gz http://prdownloads.sf.net/mingw/mingw-runtime-3.9.tar.gz]
*[http://prdownloads.sf.net/mingw/mingw-utils-0.3.tar.gz http://prdownloads.sf.net/mingw/mingw-utils-0.3.tar.gz]
*[http://prdownloads.sf.net/mingw/w32api-3.6.tar.gz http://prdownloads.sf.net/mingw/w32api-3.6.tar.gz]
*[http://prdownloads.sf.net/mingw/binutils-2.17.50-20060824-1.tar.gz http://prdownloads.sf.net/mingw/binutils-2.17.50-20060824-1.tar.gz]
*[http://prdownloads.sf.net/mingw/mingw32-make-3.81-1.tar.gz http://prdownloads.sf.net/mingw/mingw32-make-3.81-1.tar.gz]

===Optionally:===
====Fortran77 compiler====
*[http://prdownloads.sf.net/mingw/gcc-g77-3.4.5-20060117-1.tar.gz http://prdownloads.sf.net/mingw/gcc-g77-3.4.5-20060117-1.tar.gz]
====gdb debugger====
*[http://prdownloads.sf.net/mingw/gdb-6.3-2.exe http://prdownloads.sf.net/mingw/gdb-6.3-2.exe]
====Other developer tools====
=====UnxUtils=====
Ports of the most often used Unix utilities. Note that some tools in UnxUtils are quite a bit outdated, so make sure you do not overwrite already existing MinGW files with their UnxUtils counterparts.
*[http://prdownloads.sf.net/unxutils/UnxUtils.zip UnxUtils]
*[http://prdownloads.sf.net/unxutils/UnxUpdates.zip UnxUtils-Latest-Updates]

=====GnuWin32=====
''More recent'' versions of commonly used Unix utilities. Also: utilities not found in UnxUtils at all.
*[http://prdownloads.sf.net/gnuwin32/coreutils-5.3.0-bin.zip coreutils-5.3.0]
*[http://prdownloads.sf.net/gnuwin32/zip-2.3-3-bin.zip zip-2.3.3] or [ftp://ftp.info-zip.org/pub/infozip/win32/zip300xn-x64.zip zip-3.0.0]
*[http://prdownloads.sf.net/gnuwin32/tar-1.13-1-bin.zip tar-1.13-1]
*[http://prdownloads.sf.net/gnuwin32/gzip-1.3.5-3-bin.zip gzip-1.3.5]
*[http://prdownloads.sf.net/gnuwin32/bzip2-1.0.3-1-bin.zip bzip2-1.0.0-1]
*[http://prdownloads.sf.net/gnuwin32/autoconf-2.59-bin.zip autoconf-2.59]
*[http://prdownloads.sf.net/gnuwin32/automake-1.9.4-bin.zip automake-1.9.4]
*[http://prdownloads.sf.net/gnuwin32/bison-2.1-bin.zip bison-2.1 (includes m4)]
*[http://prdownloads.sf.net/gnuwin32/flex-2.5.4a-1-bin.zip flex-2.5.4a]
*[http://prdownloads.sf.net/gnuwin32/gperf-3.0.1-bin.zip gperf-3.0.1]
*[http://prdownloads.sf.net/gnuwin32/diffutils-2.8.7-1-bin.zip diffutils-2.8.7]
*[http://prdownloads.sf.net/gnuwin32/patch-2.5.9-6-bin.zip patch-2.5.9-6] Note: The version 2.5.9 of patch from GnuWin32 seems to have a problem with unified diffs
*[http://prdownloads.sf.net/gnuwin32/grep-2.5.1a-bin.zip grep-2.5.1]
*[http://prdownloads.sf.net/gnuwin32/sed-4.1.4-bin.zip sed-4.1.4]
*[http://prdownloads.sf.net/gnuwin32/hextools-1.0-bin.zip hextools-1.0]
*[http://prdownloads.sf.net/gnuwin32/findutils-4.2.20-2-bin.zip findutils-4.2.20]
*[http://prdownloads.sf.net/gnuwin32/less-394-bin.zip less 3.94]
*[http://prdownloads.sf.net/gnuwin32/which-2.16-4.exe which 2.16-4]
*[http://prdownloads.sf.net/mingw/wget-1.9.1-mingwPORT.tar.bz2 wget-1.9.1]
*[http://www.gimp.org/~tml/gimp/win32/gettext-0.14.5.zip gettext-0.14.5]
*[http://www.gimp.org/~tml/gimp/win32/gettext-dev-0.14.5.zip gettext-dev-0.14.5]

Dependencies:
*[http://prdownloads.sf.net/gnuwin32/pcre-6.4-1-bin.zip pcre-6.4.1 (needed by grep and less)]
*[http://prdownloads.sf.net/gnuwin32/libintl-0.14.4-bin.zip libintl-0.14.4 (needed by most tools)]
*[http://prdownloads.sf.net/gnuwin32/libiconv-1.9.2-1-bin.zip libiconv-1.9.2-1 (needed by most tools)]

==Resulting Folder Layout==
[[Image:Lay.png]]

==GCC 3.4.4 manual install==
Some people have reported various problems with gcc version 3.4.4, so it may be worth a consideration to use the either the 3.4.5 or 3.4.2 releases until a build from the 4.x branch is available. Personally, I have not had any kind of problem with either 3.4.4 or 3.4.5.
===Base system with C++===
*[http://prdownloads.sf.net/mingw/gcc-core-3.4.4-20050522-1.tar.gz http://prdownloads.sf.net/mingw/gcc-core-3.4.4-20050522-1.tar.gz]
*[http://prdownloads.sf.net/mingw/gcc-g%2B%2B-3.4.4-20050522-1.tar.gz http://prdownloads.sf.net/mingw/gcc-g++-3.4.4-20050522-1.tar.gz]
*[http://prdownloads.sf.net/mingw/mingw-runtime-3.9.tar.gz http://prdownloads.sf.net/mingw/mingw-runtime-3.9.tar.gz]
*[http://prdownloads.sf.net/mingw/mingw-utils-0.3.tar.gz http://prdownloads.sf.net/mingw/mingw-utils-0.3.tar.gz]
*[http://prdownloads.sf.net/mingw/w32api-3.5.tar.gz http://prdownloads.sf.net/mingw/w32api-3.5.tar.gz]
*[http://prdownloads.sf.net/mingw/binutils-2.17.50-20060824-1.tar.gz http://prdownloads.sf.net/mingw/binutils-2.17.50-20060824-1.tar.gz]
*[http://prdownloads.sf.net/mingw/mingw32-make-3.80.0-3.tar.gz http://prdownloads.sf.net/mingw/mingw32-make-3.80.0-3.tar.gz]

===Optionally:===
====gdb debugger====
*[http://prdownloads.sf.net/mingw/gdb-6.3-2.exe http://prdownloads.sf.net/mingw/gdb-6.3-2.exe]
====Objective-C====
*[http://prdownloads.sf.net/mingw/gcc-objc-3.4.4-20050522-1.tar.gz http://prdownloads.sf.net/mingw/gcc-objc-3.4.4-20050522-1.tar.gz]
====Native Java (experimental)====
*[http://prdownloads.sf.net/mingw/gcc-java-3.4.4-20050522-1.tar.gz http://prdownloads.sf.net/mingw/gcc-java-3.4.4-20050522-1.tar.gz]
====Fortran-77====
*[http://prdownloads.sf.net/mingw/gcc-g77-3.4.4-20050522-1.tar.gz http://prdownloads.sf.net/mingw/gcc-g77-3.4.4-20050522-1.tar.gz]
====Ada====
*[http://prdownloads.sf.net/mingw/gcc-ada-3.4.4-20050522-1.tar.gz http://prdownloads.sf.net/mingw/gcc-ada-3.4.4-20050522-1.tar.gz]

==Other MinGW links==
[http://www.equation.com/servlet/equation.cmd?fa=fortran Unofficial MinGW package From Equation.com]

Fortran Project plugin

2015-08-01T13:46:14Z

Alpha: Update link to FP homepage.

[[Category:Code::Blocks 3rd Party Plugins]]
{{Infobox_Plugin|
name = FortranProject |
logo = [[File:Generic-plugin.png]] |
developer = Darius Markauskas |
maintainer = |
version = 1.2
}}

FortranProject plugin makes C::B more useful for Fortran programmers. It adds a symbol browser and code completion for Fortran files. Source code and pre-built binaries can be downloaded from the [http://cbfortran.sourceforge.net Fortran Project homepage] .

==See also==
* [[Fortran support in Code::Blocks|Fortran support in Code::Blocks]]

Main Page

2015-02-15T19:22:35Z

Alpha: add filters to bug/feature/patch 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/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/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 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

2015-01-22T18:42:08Z

Alpha: add link to online sdk docs

[[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.
: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).
: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.

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

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

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

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

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

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

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

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

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

* '''[[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]

Creating a patch to submit (Patch Tracker)

2014-10-26T19:50:48Z

Alpha: Note about git-svn use.

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

If you are using git or git-svn and sending to someone with an svn setup, the output can be more easily handled with either [/index.php/topic,19391.msg132530.html#msg132530 this script] or one of
: <tt>git diff --no-prefix > my.patch</tt>
: <tt>svn patch my.patch --strip 1</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!'''

Compiler options file

2014-06-24T23:59:29Z

Alpha: Add proposed updates for the compiler options file format to take advantage of wxPropGrid

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Format for storing compiler options in editable XML.

<source lang="xml" enclose="div">
<CodeBlocks_compiler_options extends="gcc">
[...]
</CodeBlocks_compiler_options>
</source>
I am a Code::Blocks compiler options file.

<tt>extends="</tt><id><tt>"</tt> (optional)
* Load the corresponding <tt>options_</tt><id><tt>.xml</tt> file first (use if this compiler is almost the same, with only a few altered programs or added switches, for example).

<source lang="xml" enclose="div">
<if platform="windows">
[...]
</if>
<else>
[...]
</else>
</source>
Standard <tt>if</tt> statement; contents of <tt>if</tt> block is evaluated if the <tt>if</tt> statement is true, otherwise the <tt>else</tt> block is evaluated (the <tt>else</tt> block is optional). Nesting is allowed.

<tt>platform="</tt><os><tt>"</tt>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>
<source lang="xml" enclose="div">
<if exec="bison -h">
[...]
</if>
</source>
True if the the command <tt>exec</tt> can be run.
<source lang="xml" enclose="div">
<if exec="C -dumpversion"
regex="^4\.[3-9]|^[5-9]\.[0-9]"
default="true">
[...]
</if>
</source>
If the text before the first space in <tt>exec</tt> is one of:
* <tt>C
* CPP
* LD
* LIB
* WINDRES
* MAKE</tt>
it will be replaced with the name of the corresponding executable.

True if <tt>regex</tt> matches the command's output (in this case, version number <tt>>=</tt> 4.3.0).

<tt>default</tt> is used if the command fails to execute (optional).

<source lang="xml" enclose="div">
<Program name="C" value="mingw32-gcc.exe"/>
</source>
Give the name of an executable

<tt>name="</tt><prog><tt>"</tt>. <prog> is one of:
* <tt>C
* CPP
* LD
* DBGconfig
* LIB
* WINDRES
* MAKE
value="</tt><exec><tt>"</tt> (actual name of the executable).

<source lang="xml" enclose="div">
<Switch name="includeDirs" value="-I"/>
</source>
Switches controlling compiler constants.

<tt>name="</tt><opt><tt>"</tt>. <opt> is one of:
* <tt>includeDirs
* libDirs
* linkLibs
* defines
* genericSwitch
* objectExtension
* forceFwdSlashes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceLinkerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceCompilerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* needDependencies</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* logging</tt>. <tt>value</tt> is one of:
** <tt>default</tt> (same as <tt>full</tt>)
** <tt>full
** simple
** none
* libPrefix
* libExtension
* linkerNeedsLibPrefix</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* linkerNeedsLibExtension</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* supportsPCH</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* PCHExtension
* UseFlatObjects</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* UseFullSourcePaths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* Use83Paths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false</tt>

<source lang="xml" enclose="div">
<Option name="Profile code when executed"
option="-pg"
additionalLibs="-pg -lgmon"
category="Profiling"
checkAgainst="-O -O1 -O2 -O3 -Os"
checkMessage="You have optimizations enabled. This is Not A Good Thing(tm) when producing debugging symbols..."
supersedes="-s"
exclusive="true"/>
</source>
Definition of a compiler flag.
* <tt>name</tt>. Human readable description of the flag.
* <tt>option</tt>. Flags to be sent to the compiler (optional).
* <tt>additionalLibs</tt>. Flags to be sent to the linker (optional).
* <tt>category</tt>. The category this flag is in (optional; defaults to "General").
* <tt>checkAgainst</tt>. Show a warning message if any of these flags are enabled (optional).
* <tt>checkMessage</tt>. Warning message to show upon conflict (optional).
* <tt>superseds</tt>. Automatically disable the list of superseded flags if this flag is enabled (optional).
* <tt>exclusive</tt>. Disable all other flags in this category if this flag is enabled. Is one of <tt>true</tt> or <tt>false</tt> (optional).

<source lang="xml" enclose="div">
<Category name="CPU architecture tuning"
exclusive="true">
[...]
</Category>
</source>
<tt>name="</tt><cat><tt>"</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>category</tt> attribute will be treated as category <cat>.

<tt>exclusive</tt>. Is one of <tt>true</tt> or <tt>false</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>exclusive</tt> attribute will be treated as this. (Optional.)

<source lang="xml" enclose="div">
<Common name="optimization"/>
</source>
Load options from a common file.

<tt>name="</tt><file><tt>"</tt>
* Loads <tt>options_common_</tt><file><tt>.xml</tt> (file syntax is exactly the same as this file).

<source lang="xml" enclose="div">
<Command name="CompileObject"
value="$compiler $options $includes -c $file -o $object"/>
</source>
Definitions for forming compiler commands.

<tt>name="</tt><cmd><tt>"</tt>. <cmd> is one of:
* <tt>CompileObject
* GenDependencies
* CompileResource
* LinkExe
* LinkConsoleExe
* LinkDynamic
* LinkStatic
* LinkNative</tt>
<source lang="xml" enclose="div">
<Command name="CompileObject"
value="bison -v -d $file -o $file_dir/$file_name.parser.cc"
ext="y"
gen="$file_dir/$file_name.parser.cc;$file_dir/$file_name.parser.hh"/>
</source>
Additional commands can be added to each category with a file extension filter.

<tt>ext="</tt><exts><tt>"</tt>. <exts> is a semicolon separated list of file extensions (without the leading <tt>"."</tt> period).

<tt>gen="</tt><files><tt>"</tt>. <files> is a semicolon separated list of generated files to be further processed (optional).

<source lang="xml" enclose="div">
<RegEx name="Info line"
type="info"
msg="1;2;4"
file="2"
line="3">
<![CDATA[(In file) ([][{}() \t#%$~[:alnum:]&_:+/\.-]+):([0-9]+)(\.[0-9]+.*:)*]]>
</RegEx>
</source>
Definitions for regular expressions to parse compiler output.

<tt>name="</tt><label><tt>"</tt>. <label> is the name this regex will be listed as.

<tt>type="</tt><tp><tt>"</tt>. <tp> is one of
* <tt>normal
* warning
* error
* info</tt>

<tt>msg="</tt><nums><tt>"</tt>. <nums> is a semicolon separated list of indices (minimum one, maximum three) for the locations of messages within the regex.

<tt>file="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant file (optional).

<tt>line="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant line number (optional).

The contents is the regex (use of a <tt>CDATA</tt> section is not required).

==Proposed Updates==
See: [/index.php/topic,19032.0.html Use wxPropGrid for compiler flags]

<source lang="xml" enclose="div" highlight="3-5">
<Option name="Intel Pentium (MMX)"
option="-march=pentium-mmx"
type="string"
default="pentium-mmx"
compose="-march=$(ENTRY)"/>
</source>
For <tt>type="string"</tt>, a free text editor is presented.

<tt>default="</tt><str><tt>"</tt>. <str> is the default text for the editor textbox.

<tt>compose="</tt><str><tt>"</tt>. <str> is the template for generating the compile command. All occurrences of <tt>$(ENTRY)</tt> are replaced with the content of the textbox. (Extensions: all occurrences of <tt>$(ENTRY_QUOTE)</tt> are replaced with the content of the textbox, and quoted/escaped as needed; <tt>$(ENTRY_STRIP)</tt> is replaced with the textbox content, all whitespace removed.)

<source lang="xml" enclose="div" highlight="4-10">
<Option name="Link time optimization"
option="-flto"
additionalLibs="-flto -O2"
type="integer"
default="1"
min="1"
max="16"
label="Parallel link jobs"
compose="-flto"
composeLib="-flto=$(ENTRY) -02"/>
</source>
For <tt>type="integer"</tt>, a spin dial is presented.

<tt>default="</tt><int><tt>"</tt>. <int> is the starting value.

<tt>min="</tt><int><tt>"</tt>. <int> the minimum allowed value.

<tt>max="</tt><int><tt>"</tt>. <int> the maximum allowed value.

<tt>label="</tt><str><tt>"</tt>. <str> descriptive information (displayed as a tooltip? or maybe a label next to it?).

<tt>compose="</tt><str><tt>"</tt>. <str> is the template for generating the compile command. All occurrences of <tt>$(ENTRY)</tt> are replaced with the value of the spin control.

<tt>composeLib="</tt><str><tt>"</tt>. <str> is the template for generating the link command. All occurrences of <tt>$(ENTRY)</tt> are replaced with the value of the spin control.

<source lang="xml" enclose="div" highlight="3">
<Option name="Intel i386"
option="-march=i386"
type="boolean"/>
</source>
For <tt>type="boolean"</tt>, a standard checkbox is supplied (this is default behavior if no <tt>type</tt> is specified).

<source lang="xml" enclose="div" highlight="2,5-7">
<Combo comboId="architecture"
label="Generate code for:"/>
<Option name="Generate code for Intel i386"
option="-march=i386"
type="combo"
comboId="architecture"
label="Intel i386"/>
</source>
<tt><Combo [...]/></tt> defines a combo select box with <tt>label="</tt><str><tt>"</tt>.

For <tt>type="combo"</tt>, an entry is added to a combo select box.

<tt>comboId="</tt><str><tt>"</tt>. <str> is the id of the combo box to add this command to.

<tt>label="</tt><str><tt>"</tt>. <str> is the text to name this entry in the combo box's list. (If not supplied, <tt>name="</tt><str><tt>"</tt> is used instead.)

All of these proposed changes maintain both forwards and backwards compatibility. The new attributes will be ignored by older versions of Code::Blocks. Any entry which does not contain the required fields for this updated format can be rendered as <tt>type="boolean"</tt> to read older files, with no loss of information. [[User:Alpha|Alpha]] 01:59, 25 June 2014 (CEST)

==See also==
* [[Compiler file]]
* [/index.php/topic,16463.0.html XML based compilers]

WxSmith tutorial: Hello world

2014-03-13T19:18:32Z

Alpha: Add link to Ubuntu bug 662077 page

[[Category:wxSmith Documentation]]
= Tutorial 1. "Hello, World!" =

In this first tutorial, we will use wxSmith to put the words "Hello, World!" on the screen. Ever since the appearance of ''The C Programming Language'' in 1978, writing such a program has been the traditional first step in learning nearly every computer language.

Before we start, you must either compile wxWidgets or download precompiled binaries and header files. These steps are described on the wiki pages mentioned here:
* Windows users should see the wiki page:[[Compiling wxWidgets 2.8.6 to develop Code::Blocks (MSW)]] or [[Installing Code::Blocks from source on Windows]] or [[WxWindowsQuickRef]]. There are two ways to install the wxWidgets libraries, You can download the wxWidgets source and compile it yourself, or you can download the wxPack from [http://wxpack.sourceforge.net/] and install it. The wxPack contains a pre-compiled wxWidgets library, so you can save a lot of time by that route.

*Ubuntu Linux users can install wxWidgets from the Ubuntu repositories. Be sure to install also '''build-essential''' to get the C++ compiler.

We will assume that you have wxWidgets ready and working with Code::Blocks. You should probably create a directory with a name something like CBProjects for saving your work on these tutorials. Each tutorial will be a separate "project" and will occupy a file in this directory.

After downloading and installing Code::Blocks, double-click its icon on the desktop to start it. Here is the Code::Blocks opening window:

[[Image:1a.png]]

Click "Create a New Project" and then find and double-click the wxWidgets Project icon, pointed to by the cursor in the screenshot below.

[[Image:wxs_tut01_002.png]]

The next screen is a "Welcome" screen. Unless you just enjoy being welcomed by the program, you will check the box which eliminates it on future startups.

The next screen looks like this:

[[Image:wxs_tut01_003.png]]

Select wxWidgets 2.8x and click the "Next >" button at the bottom of the screen.

That brings you to the window where you specify the Project title and folder where you want to save the project. Other fields are then filled automatically. I chose “Plain” as the Project title and the other fields then adjusted to look like this:

[[Image:1c.png]]

Then click the “Next >” button at the bottom.
The next screen, shown below, allows you to mark your work with your identity. Fill in what you wish.

[[Image:1d.png]]

That brings up the window for choosing the GUI builder you want to use, wxSmith or FormBuilder. We choose, of course, wxSmith.

[[Image:1e.png]]

Click the "Next" button at the bottom.

The next screen specifies what C++ compiler we want to use and whether we want a debug build (with extra code for debugging) or a smaller release build for use by others. We will go for the GNU CPP compiler and both build options, to be put in separate subfolders.

[[Image:1f.png]]

The final screen of this sort asks whether we want to use the standard, default, configuration or to use Advanced options. We will take the default. But, at the bottom, we choose to “Create and use precompiled headers" which speeds up compilations after the first.

[[Image:1g.png]]

On the form where we chose the directory for saving the project, we chose a real directory, but that choice may lead to problems when you want to compile your project on other computers. Another choice is to use the '''Global Variable system'''. To open the dialog below or modify or change this global variable, you should click on the Code::Blocks main menu item '''Settings | Global variables'''. That brings up the Global Variables Editor.

When you use it, the location of the wxWidgets library is read from the variable you supply. This means that the location of the wxWidgets directory is not hard-coded inside your project, but is stored inside the global configuration of Code::Blocks. When your project is opened on a different computer, it will use that comoputer's configuration. The easiest option to use this global variable is to leave ''$(#wx)'' which means to use the global variable named ''wx''. This name is reserved for wxWidgets and should be chosen in most cases.

When you use the global variable for the first time, it will ask for the wxWidgets directory. The only thing you need to do here is to enter a valid location in ''base'' field. This is required only for the first time since Code::Blocks will automatically use this setting for other projects you create.

==Overview of the Interactive Development Environment (IDE)==

At the end of this preliminary sequence of forms we come to the Code::Blocks main IDE window. It should look something like this:

[[Image:1h.png]]

In the middle of the right side of the window, under the word “Plainframe.wxs”, is a panel with two square icons on the left; the one on the left brings up the menu bar editor while the one on the right brings up the status bar editor. We will return to the menu bar editor in the next tutorial. Below this panel and looking like a field of dots is the Editor window, where we will see both the GUI forms which we build and the C++ code we write. In the lower left corner of the whole window is the Properties/Events window, which will allow us to set properties of the component we are working on or to pick events, such as “OnClick” , to which we need to respond. To show properties, click on the left icon; to show events, click on the right icon marked {} to suggest C++ code.

Above the Properties/Events window is the Management window with three tabs, Projects, Symbols, and Resources. If all three tabs are not visible, drag the right border of the window to the right to reveal all three. (A “resource” in wxSmith parlance usually means a “form” or "window".) Above the Management window is a panel with several small but useful icons to
*Build the program, or
*Run it, or
*Build and run it, or
*Rebuild it, or
*Abort it. 
When you run the cursor over them, the tool tips will tell you which is which.

Now look back to the Editor window. First of all, note that the window can be configured to use different colors,fonts and font sizes. Click "Settings ..." on the Code::Blocks main menu, and then "Editor". The screens are more or less self-explanatory.

Now back to the Editor window. Across the top you see three black square called drag handles. They have been set to cover a space larger than can be seen, but scrolling down reveals the whole field.

As an experienced programmer, you know there has got to be some code somewhere but you don't see it. To reveal it, double left click in the field of dots. Presto, there is the C++ code, and the *PlainMain.cpp tab has appeared above it. Clicking back on the Plainframe.wxs should return you to the view of the form, still the field of dots. (Again, it is important to have CB 10.04 or later.) In fact, we still have not seen all of the code. In particular, you will search in vain for the all-important OnInit() routine that starts the program. You can find it, however, by clicking Search | Find in Files and searching for OnInit with the scope of the search set to be “Project files”. The search finds it, sure enough, in PlainApp.cpp and opens this module in the Editor window.

We don't need OnInit right now, but we do need to make a change in PlainMain.cpp. Click on it in the bar above the editor, and its code appears in the editor.

Sometimes a program has a lot to do when the user clicks the close icon in the program's title bar, so wxSmith generates a frame for writing the code for those actions but it provides no code. Consequently, if we ran our program just as initially written by wxSmith, we won't be able to close it by just clicking that icon. To fix that inconvenient problem, find the spot in the code with these lines:

<pre>
void PlainFrame::OnClose(wxCloseEvent& event)
{
}
</pre>

Add the call to the Close() function so that the spot looks like this:
<pre>
void PlainFrame::OnClose(wxCloseEvent& event)
{
Close();
}
</pre>
(''I found it had to be Destroy() not Close() [[User:WardXmodem|WardXmodem]] 04:43, 24 September 2013 (CEST)'')

Remember to make this change immediately whenever you start a new project.

You can now build and run this super-simple program. To do so, you can do any one of three equivalent things: 
* in the top menu bar, click Build | Build and run.
* find and click the icon that looks like a right-pointing triangle in front of a cogwheel. Hovering the mouse pointer over it will show the tool tip “Build and run”.
* tap the F9 key.

If all goes well, you will see a window come up with a menu of two items: “File” and “Help”. Try the “Help” menu item first. Then you can use “File | Quit” or the exit icon on the title bar to exit the program.

''If you are using Ubuntu and get no main menu bar when you run this program, you have fallen victim to [https://bugs.launchpad.net/ubuntu/+source/wxwidgets2.8/+bug/662077 Ubuntu bug 662077]. Beginning with release 10.10, Ubuntu releases have had a bug causing programs built with wxSmith to fail to show their main menu bar. If this bug affects you, you may want to uninstall appmenu-gtk. You do that by clicking Applications | Software Sources, then using the search window to find appmenu-gtk. Clicking on it will allow you to choose to remove it.''

Well, so far we have a program that runs and quits, but it does not yet display "Hello, World!". That's next.

== Hello, World! ==

We now turn to the classic first program, namely getting the words “Hello, World!” onto the screen. The text could be added directly into the frame, as in GUI designers for a single operating sytem; but we need to learn to use sizers for cross-platform programming. What are sizers?

If you have been working with Java or Qt, you may remember something called Layout managers. The implementation in wxWidgets differs a little but does almost the same thing.

When adding components into windows you must somehow specify their position and size. wxWidgets tries to automate this process, and it uses sizers to do so. They automatically position and size window components, and they can also set the size of the window so that everything fits inside.

Sizers have one big advantage over direct placement of components. When you write cross-platform applications, you cannot assume that fonts, buttons, and so on have the same size on different operating systems. This problem can even occur on the same platform when using different window themes. When you use sizers, you don't have to worry about those problems. All sizing and placement is done automatically. Moreover, sizers can even reposition and resize window components when the main window changes size.

With that background, let's get started. When you look at the wxSmith editor, you'll notice that the area of the window is surrounded by eight black boxes or drag handles.

[[Image:wxs_tut01_009.png]]

These drag handles surround the currently selected item. In our case it's a whole window. Adding new components to the window is simply done by clicking on one of the buttons in the palette at the bottom of the editor and then clicking somewhere on the resource. As you can see here,

[[Image:wxs_tut01_010.png]]

when you keep your mouse cursor over a component in the palette, it will show its name. That feature may help you find components until you become familiar with their icons.

Let's add a new wxPanel component to our window; it is the fourth icon from the left on the standard tab. You will see that when you click the wxPanel item and then move the cursor over the editor, some part of the editor will change color. That's intentional and is used to show where on the window the new item will be added.

After the wxPanel is in place, you will notice that the background color of the window has changed to light gray. Now our window will look much more like other windows. Note that currently the selection changed to the added panel but since its size is equal to the frame's, it's hard to find out what's really selected. To make sure that wxPanel is selected, click somewhere on the light gray area of our window (Note to Linux users: wxFrame and wxPanel usually have the same background so it may look like nothing has changed; you may ensure that there's a wxPanel by looking into the resource browser).

If you want to see the selection exactly or select items that overlap, you can use the resource browser. To show it, click on the resources tab located in the same place where the project browser is:

[[Image:wxs_tut01_011.png]]

The resource tab consists of two parts. The first is the resource tree which shows the structure of your resources and the second one is the property browser which is common in GUI designers. Inside the resource tree you can find the currently selected item. In our case it is the wxPanel class we added before. The selected item also shows the name of this item: Panel1. This name is basically the variable which can be used to access this component in your code.

We added a new component by selecting the place for it. This is wxSmith's default behavior. However, there is another mode of adding items. In this mode, the new item is added right after you click on the palette's button. The position of the new item is relative to the current selection - just like a cursor in text editors. Basically we can add new items into three different positions relative to the selection:
* Before the selected widget
* After the selected widget
* Into the selected widget.
This insertion mode can be changed by clicking one of the four "placement" buttons on the right side of the editor:

[[Image:wxs_tut01_012.png]]

The uppermost is the mode we used - "point by mouse". The next one means "add into", followed by "add before", and the last one means "add after". The current mode is shown by a red check mark on the button.

Sometimes a few selection modes are disabled because they are not valid for the currently selected item. For example, you cannot add any component into the wxButton component since wxWidgets declares it as one that cannot have child components. Similarly, when the main component (the window) is selected, you won't be able to add anything after it or before it.

Ooops! I said we would use sizers and then forgot all about them! We have to get rid of that wxPanel. Select the panel and then click on the red X button just below the four buttons we have been describing. It looks like this:

[[Image:wxs_tut01_014.png]]

When you click this button, it deletes the current selection, so if the panel didn't disappear, make sure it's selected and click the button again. Now we should have returned to the state at the beginning.

To use sizers, first we have to add a sizer into the main frame and then add the wxPanel into it.
Sizers are available in the Layout tab on the palette. Switch to it and select wxBoxSizer:

[[Image:wxs_tut01_013.png]]

This sizer tries to position items in one line, either horizontal or vertical. Horizontal is the default, and we will use it.

After adding the sizer, two things have changed. The first is that our window now has a red border. This means that there is a sizer attached to it. When you look into the resource browser, you will also see that the sizer has been added. (You may need to click on the editor area to refresh the selection on the resource browser.) The second change is that the size of the window has shrunk to a small box. That is as it should be because the sizer is responsible for resizing the window to be no bigger than necessary to be visible and accommodate its components, and so far there are no components.

Now let's add our wxPanel. Make sure that you add it into the sizer, not into the main frame. After you do so, you will see something like this:

[[Image:wxs_tut01_015.png]]

Here we can see our panel surrounded by drag boxes. There's also some dark gray border around it (it won't be visible on Linux). Each component added into the sizer can be surrounded by such a border. It's useful when you want to have spacing between components. But in our case we should get rid of it to get a better looking window. To do so, we will have to change a property inside the property browser. Search for border size and change it from 5 to 0:

[[Image:wxs_tut01_016.png]]

Now when we have our panel adjusted, we can finally add the "Hello world" text. Since we will also use sizers to manage items added into wxPanel, we have to repeat the addition of wxBoxSizer into wxPanel. After the sizer is in its place, switch back into the '''Standard''' tab on the palette and add a wxStaticText control:

[[Image:wxs_tut01_017.png]]

With an eye to the future and for practice with adding components, let's add also a button next to the wxStaticText. First, click on wxButton. If you still have the "point by mouse" insertion mode turned on, then when you put the mouse over the wxStaticText component half of that component will be colored in light blue. When the left half of the text is highlighted, the new item will be added before the existing component; and when the right half is highlighted, the new component will be added after the existing one. Let's add the button after the text. Now we should have this content:

[[Image:wxs_tut01_018.png]]

Now let's finally set our "Hello, World!" text. The wxStaticText control which we added before has the text "Label" on it. It is the default text set to all newly created wxStaticText classes. We will change it using the property browser similarly to changing the border size in the wxPanel class. To do so, select the wxStaticText component in our window, then find the Label property in the property browser and change it to "Hello, World!":

[[Image:Wxs_tut01_019.png]]

If you want two or more lines of text on the wxStaticText control. click on the "..." button at the right end of the “Label” line or put "\n" inside the text, as in C formats.

At this point, you can click the "Build and run" and the program should run and show the magic words in the static text control. We could quit in triumph at this point, but the button we have put on the form is still a dud; clicking on it will do nothing. Let's give it a function.

Before going further, we need to deal with a question you may be asking. Why did we, after putting a box sizer onto our main window, proceed to put a wxPanel into it and then put another box sizer onto the panel? What is the point of the panel? Why not just put our two buttons into the first box sizer and eliminate the panel and second box sizer? The answer is that the panel gives us control of the background. We didn't use it, but it is often useful to be able to control it. In fact, these first three steps will be used in structuring every window used in these tutorials. To review, these three steps are:
* Put a box sizer on the window
* Put a panel into the first box of the sizer
* Put a sizer of some sort onto the panel.

== Responding to the Click of a Button ==

Since buttons usually cause something to happen when clicked, let's make our button close the window. The first thing we should do is to change the text shown on the button to tell the user what the button does. It is done just as in the case of the wxStaticText widget. Select the button, find "Label" in the property browser and set it to "Close" (or anything you like).

The second thing is to assign an event handler to this button. Basically, event handlers are functions which are called when some "event" occurs. In our case instead of "event" we could say more descriptively " a click on the button" because that is what we want to process. Like other GUI designers, wxSmith can automatically generate the framework code for such handlers. To bring up that ability, switch the property browser to the event browser by clicking on the second icon at the top of the property browser. The icon looks like {} to suggest C++ code.

[[Image:1Event_Icon.png]]

After you click on this icon, you will see all events supported by the currently selected component. The wxButton class supports only one event, the EVT_BUTTON event, so only this one is shown. When you click on this event and drop down the combo box, you will see the available options and handlers for this event:

[[Image:Wxs_tut01_021.png]]

If you select '''-- None --''' no handler function will be automatically assigned to this event. (But it may always be set manually.) Selecting '''-- Add new handler --''' will generate a frame for the code of the new handler function. Below are shown other event handlers known to wxSmith which can be assigned to this event. We can see here OnQuit and OnAbout. Those handlers were created by wizard. We could use the OnQuit handler, but to see what happens, let's write our own handler. Select the '''Add new handler''' option. You will be asked for a name for the handler. This name is simply the name of the function which will be called as a reaction to this event. wxSmith will suggest the name OnButton1Click, and we may as well use it.

When you enter a new handler name, wxSmith will generate the framing code of a new handler function by that name, open the program file with the proper source code and put the cursor inside the handler function. (You may need to scroll up or down to show the line with cursor.) This function is a member of the class we have been building, so it can access all of functions in that class, including the one called '''Close()''', which was created by the wizard. So when we want to close our window we just call the '''Close()''' function. The result looks like this:

[[Image:Wxs_tut01_022.png]]

Build and run our project. It should show our "Hello, World!" text and our "Close" button. Click the Close button, and it should close.

This is end of this first tutorial, I hope that you followed it easily and are beginning to feel comfortable with Code::Blocks and wxSmith.

The tutorial was originally written by BYO, the creator of wxSmith. It was revised in March 2012 by Grouch to take account of changes in Code::Blocks, add a few clarifications, and change the accent in the English from youthful Polish to elderly American.

----

<center>'''[[WxSmith tutorials|Index]] | [[Wxsmith tutorial: Working with items|Next]]'''</center>

Creating a new project

2013-02-12T02:00:30Z

Alpha: Fixed grammar.

[[Category: User Documentation]]
This page is a guide to many of the beginning (and some intermediate) features of the creation and modification of a Code::Blocks project. If this is your first experience with Code::Blocks, here is a good starting point.
==The project wizard==
Launch the Project Wizard through ''File->New->Project...'' to start a new project. Here there are many pre-configured templates for various types of projects, including the option to create custom templates. Select '''Console application''', as this is the most common for general purposes, an click '''Go'''.

[[File:ProjectWizard.png]]

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

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

[[File:ConsoleApplication.png]]

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

[[File:SelectSource.png]]

This file contains the following standard code.

''main.cpp''
<source lang="cpp" line>
#include <iostream>

using namespace std;

int main()
{
cout << "Hello world!" << endl;
return 0;
}</source>
==Changing file composition==
A single source file is of little uses in programs of any useful complexity. In order to handle this, Code::Blocks has several very simple methods of adding additional files to the project.
===Adding a blank file===
In this example, we will be splitting the function

''main.cpp''
<source lang="cpp" line start="7">
cout << "Hello world!" << endl;
</source>
into a separate file.

''Note: it is generally improper programming style to create a function this small; it is done here to give a simple example.''

To add the new file to the project, bring up the file template wizard through either ''File->New->File...'' or ''Main Toolbar->New file (button)->File...''

[[File:NewFile.png]]

Select '''C/C++ source''' and click '''Go'''. Continue through the following dialogs very much like the original project creation, selecting '''C++''' when prompted for a language. On the final page, you will be presented with several options. The first box will determine the new filename and location (as noted, the full path is required). You may optionally use the '''...''' button to bring up a file browser window to save the file's location. Checking '''Add file to active project''' will store the filename in the '''Sources''' folder of the '''Projects''' tab of the '''Management''' panel. Checking any of the build targets will alert Code::Blocks that the file should be compiled and linked into the selected target(s). This can be useful if, for example, the file contains debug specific code, as it will allow the inclusion to (or exclusion from) the appropriate build target(s). In this example, however, the hello function is of key importance, and is required in each target, so select all the boxes and click '''Finish''' to generate the file.

[[File:Hello.cpp.png]]

The newly created file should open automatically; if it does not, open it by double clicking on its file in the '''Projects''' tab of the '''Management''' panel. Now add in code for the function '''main.cpp''' will call.

''hello.cpp''
<source lang="cpp" line>
#include <iostream>

using namespace std;

void hello()
{
cout << "Hello world!" << endl;
}
</source>
===Adding a pre-existing file===
Now that the <code>hello()</code> function is in a separate file, the function must be declared for '''main.cpp''' to use it. Launch a plain text editor (for example Notepad or Gedit), and add the following code.

''hello.h''
<source lang="cpp" line>
#ifndef HELLO_H_INCLUDED
#define HELLO_H_INCLUDED

void hello();

#endif // HELLO_H_INCLUDED
</source>

Save this file as a header ('''hello.h''') in the same directory as the other source files in this project. Back in Code::Blocks, click ''Project->Add files...'' to open a file browser. Here you may select one or multiple files (using combinations of ''Ctrl'' and ''Shift''). (The option ''Project->Add files recursively...'' will search through all the subdirectories in the given folder, selecting the relevant files for inclusion.) Select '''hello.h''', and click '''Open''' to bring up a dialog requesting to which build targets the file(s) should belong. For this example, select both targets.

[[File:TargetBelonging.png]]

''Note: if the current project has only one build target, this dialog will be skipped.''

Returning to the main source ('''main.cpp''') include the header file and replace the <code>cout</code> function to match the new setup of the project.

''main.cpp''
<source lang="cpp" line>
#include "hello.h"

int main()
{
hello();
return 0;
}</source>
Press ''Ctrl-F9'', ''Build->Build'', or ''Compiler Toolbar->Build (button - the gear)'' to compile the project. If the following output is generated in the build log (in the bottom panel) then all steps were followed correctly.

<tt>-------------- Build: Debug in HelloWorld --------------- 
 
Compiling: main.cpp 
Compiling: hello.cpp 
Linking console executable: bin\Debug\HelloWorld.exe 
Output size is 923.25 KB 
''Process terminated with status 0 (0 minutes, 0 seconds)'' 
''0 errors, 0 warnings (0 minutes, 0 seconds)''</tt>

The executable may now be run by either clicking the ''Run'' button or hitting ''Ctrl-F10''.

''Note: the option ''F9'' (for build and run) combines these commands, and may be more useful in some situations.''

See [[the build process of Code::Blocks]] for what occurs behind the scenes during a compile.
===Removing a file===
Using the above steps, add a new C++ source file, '''useless.cpp''', to the project. Removing this unneeded file from the project is straightforward. Simply right-click on '''useless.cpp''' in the '''Projects''' tab of the '''Management''' pane and select '''Remove file from project'''.

[[File:RemoveFile.png]]

''Note: removing a file from a project does '''not''' physically delete it; Code::Blocks only removes it from the project management.''

==Modifying build options==
Build targets have come up several times so far. Changing between the two default generated ones - '''Debug''' and '''Release''' - can simply be done through the drop-down list on the '''Compiler Toolbar'''. Each of these targets has the ability to be a different type (for example: static library; console application), contain a different set of source files, custom variables, different build flags (for example: debug symbols ''-p''; size optimization ''-Os''; link time optimization ''-flto''), and several other options.

[[File:TargetSelect.png]]

Open ''Project->Properties...'' to access the main properties of the active project, '''HelloWorld'''. Most of the settings on the first tab, '''Project settings''', are rarely changed. '''Title:''' allows the name of the project to be changed. If '''Platforms:''' is changed to something other than its default '''All''', Code:Blocks will only allow the project to build on the selected targets. This is useful if, for example, the source code contains Windows API, and would therefore be invalid anywhere but Windows (or any other operating system specific situations). The '''Makefile:''' options are used only if the project should use a makefile instead of Code::Blocks' internal build system (see [[Code::Blocks and Makefiles]] for further details).
===Adding a new build target===
Switch to the '''Build targets''' tab. Click '''Add''' to create a new build target and name it '''Release Small'''. The highlight in the left hand column should automatically switch to the new target (if not, click on it to change the focus). As the default setting for '''Type:''' - "GUI application" - is incorrect for the '''HelloWorld''' program, change it to "Console application" via the drop-down list. The output filename '''HelloWorld.exe''' is fine except in that it will cause the executable to be output in the main directory. Add the path "bin\ReleaseSmall\" (Windows) or "bin/ReleaseSmall/" (Linux) in front of it to change the directory (it is a relative path from the root of the project). The '''Execution working dir:''' refers to where the program will be executed when '''Run''' or '''Build and run''' are selected. The default setting "." is fine (it refers to the project's directory). The '''Objects output dir:''' needs to be changed to "obj\ReleaseSmall\" (Windows) or "obj/ReleaseSmall/" (Linux) in order to be consistent with the remainder of the project. The '''Build target files:''' currently has nothing selected. This is a problem, as nothing will be compiled if this target is built. Check all the boxes.

[[File:TargetOptions.png]]

The next step is to change the target's settings. Click '''Build options...''' to access the settings. The first tab the comes up has a series of compiler flags accessible through check boxes. Select "Strip all symbols from binary" and "Optimize generated code for size". The flags here contain many of the more common options, however, custom arguments may be passed. Switch to the '''Other options''' sub-tab and add the following switches.

<tt>-fno-rtti 
-fno-exceptions 
-ffunction-sections 
-fdata-sections 
-flto</tt>

Now switch to the '''Linker settings''' tab. The '''Link libraries:''' box provides a spot to add various libraries (for example, ''wxmsw28u'' for the Windows Unicode version of the [[Compiling wxWidgets 2.8.6 to develop Code::Blocks (MSW)|wxWidgets]] monolithic dll). This program does not require any such libraries. The custom switches from the previous step require their link-time counterparts. Add

<tt>-flto 
-Os 
-Wl,--gc-sections 
-shared-libgcc 
-shared-libstdc++</tt>

to the '''Other linker options:''' tab. (For further details on what these switches do, see the GCC documentation on [http://gcc.gnu.org/onlinedocs/gcc-4.5.3/gcc/Optimize-Options.html optimization options] and [http://gcc.gnu.org/onlinedocs/gcc-4.5.3/gcc/Link-Options.html linker options].)

===Virtual Targets===
Click '''OK''' to accept these changes and return to the previous dialog. Now that there are two release builds, it will take two separate runs of '''Build''' or '''Build and run''' to compile both. Fortunately, Code::Blocks provides the option to chain multiple builds together. Click '''Virtual targets...''', then '''Add'''. Name the virtual target '''Releases''' and click '''OK'''. In the right-hand '''Build targets contained''' box, select both '''Release''' and '''Release small'''. Close out of this box and hit '''OK''' on the main window.

[[File:VirtualTargets.png]]

The virtual target '''Releases''' will now be available from the '''Compiler Toolbar'''; building this should result in the following output.

<tt>-------------- Build: Release in HelloWorld --------------- 
 
Compiling: main.cpp 
Compiling: hello.cpp 
Linking console executable: bin\Release\HelloWorld.exe 
Output size is 457.50 KB 
 
<nowiki></nowiki>-------------- Build: Release Small in HelloWorld --------------- 
 
Compiling: main.cpp 
Compiling: hello.cpp 
Linking console executable: bin\ReleaseSmall\HelloWorld.exe 
Output size is 8.00 KB 
''Process terminated with status 0 (0 minutes, 1 seconds)'' 
''0 errors, 0 warnings (0 minutes, 1 seconds)''</tt>

Code::Blocks Plugins

2012-12-28T15:56:38Z

Alpha: Added new plugins (todo: write the plugin pages).

[[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:'''
Surely you can work with plugin as you like, but here are some suggestions:
* Announce them in the plugin development board in the forums - including the (initial) source code at [/index.php/board,14.0.html].

OR

* Setup your own webpage (or use a file sharing platform) and post the link to the sources/binaries/svn access in the plugin development board in the forums at [/index.php/board,14.0.html].

OR

* Setup a repository, probably at BerliOS or SourceForge, post the link to the sources/binaries/svn access in the plugin development board in the forums at [/index.php/board,14.0.html]. Notice: This is very convenient as attachments in our forum might be deleted from time to time. So it is not safe to post source code in the forums.

THEN

# Enter the plugins description on this page.
# Announce the plugin '''[[Announcement_for_plugins/patches|here]]''' using '''[[Template_for_plugin_announcement|this]]''' template.

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

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

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

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

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

Languages supported by Code::Blocks lexers

2012-12-26T17:49:26Z

Alpha: Updated.

[[Category:Developer Documentation]]
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 50%; table-layout: fixed;"

|- style="background: #ececec;"
! style="width: 12em" | Language
! [https://www.codeblocks.org/ Code::Blocks]
! [http://www.scintilla.org/SciTE.html SciTE]
|-

|-
! style="text-align: left; background: #ececec;" | Ada
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | AngelScript (using the C++ lexer)
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | ANS.1 MIB definition files
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | APDL
| {{no}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Assembler (NASM, MASM)
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Assembler (Hitachi, using the C++ lexer)
| {{yes}} (Why it uses the C++ lexer????)
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | AutoIt
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Avenue
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Baan
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Bash
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Batch (MS-DOS)
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | BlitzBasic
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Bullant
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | C/C++
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Caml
| {{yes}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | C# (using the C++ lexer)
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Clarion
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | CMake
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | conf (Apache)
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | CSound
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | CSS
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | D
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | diff files
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | E-Script
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Eiffel
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Erlang
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Flagship (Clipper / XBase)
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Flash (ActionScript)
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Fortran
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Forth
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | GameMonkey script
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | Haskell
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | HTML
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | HTML with embedded JavaScript, VBScript, PHP and ASP
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | GameMonkey Script (using the C++ lexer)
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | Gui4Cli
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | IDL (both MSIDL and XPIDL)
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Java
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | JavaScript
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Lisp
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | LOT
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Lout
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Lua
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Make
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Matlab
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Metapost
| {{no}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | MMIXAL
| {{no}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Motorola 68k
| {{yes}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | MSSQL
| {{no}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | nnCron
| {{no}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | NSIS
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | nVidia cg (using the C++ lexer)
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | Objective C
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | Objective Caml
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Ogre Compositor script (using the C++ lexer)
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | Ogre Material script (using the C++ lexer)
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | OpenGL Shading Language (using the C++ lexer)
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | Octave
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Pascal/Delphi
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Perl
| {{yes}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | PostScript
| {{yes}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | POV-Ray
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | PowerBasic
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Properties
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | PureBasic
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Python
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Rebol
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Ruby
| {{yes}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Scheme
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | scriptol
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Smalltalk
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Specman E
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Spice
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | SQL and PLSQL
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Squirrel
| {{yes}}{{refun|CodeFolding}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | TADS3
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | TeX and LaTeX
| {{yes}}
| {{yes}}
|-

|-
! style="text-align: left; background: #ececec;" | Tcl/Tk
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | VB and VBScript
| {{yes}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | Verilog
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | VHDL
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | XBase
| {{yes}}
| {{no}}
|-

|-
! style="text-align: left; background: #ececec;" | XML
| {{yes}}{{refun|CodeFolding}}
| {{yes}}{{refun|CodeFolding}}
|-

|-
! style="text-align: left; background: #ececec;" | YAML
| {{no}}
| {{yes}}{{refun|CodeFolding}}
|-

|}

*{{note|CodeFolding}} Supports code-folding.

Compiler plugin

2012-12-19T15:49:14Z

Alpha: XML branch merged.

[[Category:Code::Blocks Core Plugins]]
{{Infobox_Plugin|
name = Compiler |
logo = [[File:Compiler.png]] |
developer = Yiannis Mandravellos |
maintainer = |
version = 0.99
}}

The '''Compiler''' plugin is an interface to various compilers:
* GNU GCC compiler
* Microsoft Visual C++ Free Toolkit 2003
* Borland C++ Compiler 5.5

==Compiler toolbar==

The icons in the Compiler toolbar have the following meanings:

; [[File:Compile.png|Build]] Ctrl-F9 : Compile (and link, if applicable) the active build target of the current project. If no project is open, Code::Blocks will attempt compilation of the active file in the editor.

; [[File:Run.png|Run]] Ctrl-F10 : Run the executable output of the active build target of the current project. If no project is open, Code::Blocks will attempt to run the executable output of the active file in the editor.

; [[File:CompileRun.png|Build and run]] F9 : Compile (and link, if applicable) the active build target of the current project and run the output. If no project is open, Code::Blocks will attempt to compile the active file in the editor, then run its output.

; [[File:Rebuild.png|Rebuild]] Ctrl-F11 : Clean (delete) all the object files and compiled output of the active build target of the current project, then compile (and link, if applicable) cleaned target. This function requires an active project.

; [[File:Stop.png|Abort]] : Stop a compilation before it has completed. This function requires an active project.

; [[File:TargetSelect.png]] : Change the active build target of the current project.

==See also==
Development documents:
* [[Compiler file]]
* [[Compiler options file]]

Compiler options file

2012-12-19T15:47:21Z

Alpha: XML branch merged.

Compiler file

2012-12-19T15:40:56Z

Alpha: XML branch merged.

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s).

<source lang="xml" enclose="div">
<CodeBlocks_compiler name="Digital Mars Compiler"
id="dmc"
weight="24"
platform="windows">
[...]
</CodeBlocks_compiler>
</source>
I am a Code::Blocks compiler file.

<tt>name="</tt><txt><tt>"</tt>
* <txt> is the descriptive name that will be shown to the user for this compiler.

<tt>id="</tt><id><tt>"</tt>
* Lowercase sequence of letters, numbers, underscores, and/or hyphens (it must, however, start with a letter) which is used internally to represent this compiler.

<tt>weight="</tt><num><tt>"</tt> (optional)
* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (keep <num> between 0 and 100).

<tt>platform="</tt><os><tt>"</tt> (optional). Only load this compiler if the current operating system is <os>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

All of the following routines are used during auto-detection.

Conditional <tt><if>[...]</if><else>[...]</else></tt> statements are available in the same form as in [[Compiler options file]]s.

<source lang="xml" enclose="div">
<Path type="master">
[...]
</Path>
</source>
<tt>type="</tt><tp><tt>"</tt> Determines what variable the results of the contained detection routine(s) will be stored in. <tp> is one of:
* <tt>master
* extra
* include
* resource
* lib</tt>

<source lang="xml" enclose="div">
<Search envVar="PATH"
for="C"/>
</source>
Searches all paths in the given environment variable.
* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.
* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

<source lang="xml" enclose="div">
<Search path="C:\MinGW"
for="C"/>
</source>
Same functionality as <tt><Search envVar="..."></tt> except that this tests a hard-coded path.

<source lang="xml" enclose="div">
<Search path="C:\WinAVR*"/>
</source>
Wildcards are allowed in <tt><Search path="..."></tt>.

<source lang="xml" enclose="div">
<Search registry="HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\SDCC"
value="InstallLocation"/>
</source>
Read a Windows registry key. If <tt>value</tt> is found in the registry key, and it is a valid folder, it will be added to the current <tt><Path type="..."></tt>.

<source lang="xml" enclose="div">
<Fallback path="/usr/local"/>
</source>
If the current <tt><Path type="..."></tt> is empty, add this path to it.

<source lang="xml" enclose="div">
<Add><master/><separator/>lib</Add>
</source>
Add a path to the current <tt><Path type="..."></tt>.
* <tt><master/></tt> is replaced by the contents of the master path.
* <tt><separator/></tt> is replaced by the system's native file path separator.

<source lang="xml" enclose="div">
<Add cFlag="-O"/>
</source>
Enable a compiler flag.

<source lang="xml" enclose="div">
<Add lFlag="-s"/>
</source>
Enable a linker flag.

<source lang="xml" enclose="div">
<Add lib="pthread"/>
</source>
Add a library.

==See also==
* [[Compiler options file]]
* [/index.php/topic,16463.0.html XML based compilers]

File formats description

2012-12-19T15:37:01Z

Alpha: XML branch merged.

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Code::Blocks projects/workspaces are described in XML files. Here are contained links to documentation for each one of them.

This information is of interest to anyone wanting to write an importer/exporter/generator for other build systems/environments and therefore add support for Code::Blocks.

* '''[[Workspace file]]''' (*.workspace)
:Defines a Code::Blocks workspace (collection of projects).

* '''[[Project file]]''' (*.cbp)
:Defines a Code::Blocks project.

Additional files used as of December 12, 1012 (from the merge of the [/index.php/topic,16463.0.html XML compiler branch]):

* '''[[Compiler file]]''' (compiler_*.xml)
:Defines a Code::Blocks compiler interface and auto-detection routines.

* '''[[Compiler options file]]''' (options_*.xml)
:Defines the options and regular expressions for a Code::Blocks compiler.

''Code::Blocks also produces a couple other files (*.layout and *.depend) but they only contain state information so they are not really useful to anyone else other than Code::Blocks itself.''

[[User:Mandrav|Mandrav]] 11:42, 1 March 2007 (UTC)

Main Page

2012-12-07T00:07:43Z

Alpha: 12.11!

__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 12.11]
* [/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://developer.berlios.de/projects/codeblocks/ Project page at BerliOS]
* '''Bugs''': [http://developer.berlios.de/bugs/?group_id=5358 Browse] or [http://developer.berlios.de/bugs/?func=addbug&group_id=5358 submit new]
* '''Features''': [http://developer.berlios.de/feature/?group_id=5358 Browse] or [http://developer.berlios.de/feature/?func=addfeature&group_id=5358 submit new]
* '''Patches''': [http://developer.berlios.de/patch/?group_id=5358 Browse] or [http://developer.berlios.de/patch/?func=addpatch&group_id=5358 submit new]
}}

{{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>

Announcement for plugins/patches

2012-11-04T12:06:10Z

Alpha: Added links; removed Java lexer link (it is in the trunk).

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Java lexer

2012-11-04T11:51:18Z

Alpha: Deletion request (lexer is in trunk).

[[Category:Deletion Requests]]
Lexer is in trunk
* Author: Alpha
* Purpose: Add support for language Java
* Version: (not versioned); State: '''stable'''
* Last update: 3. Jan. 2012
* Link for download: [http://developer.berlios.de/patch/?func=detailpatch&patch_id=3246&group_id=5358]
* Notes: If you have any questions or suggestions, please [/index.php start a thread in the forum].
 
...back to [[Announcement for plugins/patches]]:

Pretty Printers

2012-11-04T11:47:08Z

Alpha: Added links and category.

[[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/viewcvs/trunk/libstdc%2B%2B-v3/python/libstdcxx/v6/ 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:</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]]

Debugging with Code::Blocks

2012-11-04T11:44:27Z

Alpha: Added links.

[[Category: User Documentation]]
=Build debug version of your project=
Make sure that the project is compiled with the -g (debugging symbols) compiler option on, and the -s (strip symbols) option off. This ensures that the executable has debug symbols included.

Compiler optimization switches should be turned off, stripping symbols (-s) ''must'' be turned off.

Keep in mind that you may have to '''re'''-build your project as up-to-date object files might not be re-compiled with -g otherwise. Please be aware that in compilers other than GCC, -g and/or -s might be a different switch (-s might not be available at all).

Menu => Project => Build Options

[[Image:DbgProjBuildOpt.png|Set Project Build Options]]

=Add Watches=
== In version 10.05 ==
Open The Debugger Watches Window

[[Image:DbgWatchWindow.png|Open Watch Window]]

The list of watches can be saved to a file and later re-loaded. To do so, right click in the list of watches and select "save watch file" (and "load watch file" to re-load them again).

[[Image:Save watch.png]]

== In latest nightly builds ==
In the latest nightly builds the watches window has been redesigned and works differently that the one in 10.05.

Currently there are two ways of adding watches in it:
#Click in the empty last row in the watches window, type the name of the variable (or full expression) and hit enter.
#While the debugger has stopped on a breakpoint select a variable name or full expression, right click to open the context menu and then select "Add watch 'expression'".

The automatic inclusion of local variables and function arguments have not being reimplemented.
Sorry about the inconvenience.

= Double-clicking in the Call stack window =
Note : when debugging, double-clicking on a frame in the "call stack" debug window does not automatically update the variables displayed in the "watches" debug window.

You have to right-click on a frame in the "call stack" debug window and select "Switch to this frame".

[[File:DWCB_watches_01.png]]

=Set Breakpoints=
Find the line containing the variable to be watched. Set a breakpoint in a position that will allow you to observe the variable value.

Menu => Debug => Toggle Breakpoint

[[Image:DbgSetWatchVar.png|Choose Watch Variable]]

Run the debugger until the breakpoint is reached. Right click the variable to set a watch in the Watch Window.

Breakpoints may also be toggled with a left click in the left editor margin.

=Notes=
==Script support==
Code::Blocks natively use squirrel script language to deal with gdb, see: [[Debugger scripts]]. As gdb 7.x support python pretty printer, so, it can also use gdb(with python support) to show some complex variable values. see forum thread [/index.php/topic,11301.msg77000.html#msg77000 unofficial MinGW GDB gdb with python released] and [http://code.google.com/p/qp-gcc/wiki/GDB Use GDB python under Codeblocks] for more details.
==Single file debugging==
To debug your program you need to setup a project. Single file programs are not supported.

==Path with spaces==
Breakpoints could not work if the path/folder you've placed your project contains spaces or other special characters. To be safe use English letters, digits and '_'.

==Forking==
If your application uses the 'fork' system call you'll have trouble stopping the debugged program or setting breakpoints on the fly.
Here is a link explaining the forking modes of GDB: http://sourceware.org/gdb/onlinedocs/gdb/Forks.html

==Update to the newest version of MinGW==
From gdb 6.8 released on April 2008, it supports many features which does not exist in early versions. You can update by installing binaries from [http://www.tdragon.net/recentgcc/ TDM-Mingw package].

==Use 32bit CDB for 32bit programs and 64bit CDB for 64bit programs==
It seems that debugging a 32bit program with 64bit CDB doesn't work on Windows 7, but 32bit CDB works perfectly.

==Limits on the early version of MinGW==
If your are still using the MinGW and gdb 6.7 from [https://www.codeblocks.org/downloads/5 8.02 setup files], setting breakpoints in the constructor will not work. Here are some tricks.

Breakpoints do not work in constructors or destructors in GDB 6.7 and earlier version. They do, however, work in routines called from them. This is an early GDB restriction, not a bug. So you could do something like:

[[Image:DbgWithCBExp.png|Debugging ctor/dtor ]]

...and place a breakpoint in "DebugCtorDtor" at the line "int i = 0;" . The debugger will break at that line. If you then step the debugger (Menu Debug => Next Line; or alternatively F7) you'll reach the code in the constructor/destructor ("is_initialized = true/false;").

==See also==
* [[Debugger scripts]]
* [[Pretty Printers]]

Debugger plugin

2012-11-04T11:42:39Z

Alpha: Added link.

[[Category:Code::Blocks Core Plugins]]
{{Infobox_Plugin|
name = Debugger |
logo = [[File:Debugger.png]] |
developer = Yiannis Mandravellos |
maintainer = |
version = 0.3
}}

The '''Debugger''' plugin interfaces with the GNU GDB and MS CDB debuggers, providing a graphical interface to these command-line tools.

Currently, the debugger branch (wxpropgrid_debugger) contains significantly improved debugging capabilities. See the [/index.php/board,20.0.html nightly builds] to download a recent version.

2012-04-07, as of rev7920, the debugger branch was merged to trunk, so all the new debugger plugin features is now in trunk.

The next generation of debugger plugin will use the GDB-MI interface, and it is under developement, but it is at least usable. You can try it. see [/index.php/topic,16230.msg109713.html#msg109713 GDB-MI Plugin].

==See also==
* [[Debugging with Code::Blocks]]
* [[Debugger scripts]]: extend the debugger to support arbitrary data types.
* [[Pretty Printers]]

Creating a custom lexer for Code::Blocks editor

2012-09-26T03:30:30Z

Alpha: Added link to GtkSourceView.

[[Category:Developer Documentation]]
Code::Blocks can provide syntax highlighting for any of the languages supported by Scintilla http://www.scintilla.org (the Rich Editing API used by C::B to provide syntax highlighting, code folding etc). Each language that C::B provides highlighting for has a C::B specific xml file found under <tt>sdk/resources/lexers</tt> that specifies styles and keywords of the language (they're simple XML files with names of the form <tt>lexer_*.xml</tt>). Adding a new language that is supported by Scintilla is as simple as adding an xml file for that language. At a minimum, the xml file must list the available set of styles for the lexical elements of a language and provide for keywords (the file will also specify a file containing sample code for editing and previewing lexer styles in Code::Blocks). Actual styles and keywords for each language can be edited by users within Code::Blocks under Settings->Editors->Syntax Highlighting allowing them view the results in a preview window (for the preview to display you will need to provide this sample code in a separate file also located in <tt>sdk/resources/lexers</tt>). User customized styles and keywords are kept in the users <tt>default.conf</tt> file (i.e. the xml file is never changed within codeblocks) allowing users to easily revert to the xml file.

To illustrate how you might construct a new lexer xml file let's look at the pre-installed CPP lexer, whose styles and keywords are stored in <tt>lexer_cpp.xml</tt>.

==XML==

<?xml version="1.0"?>

Basically this says "I am an XML file". '''Very Important'''

==DOCTYPE==

<!DOCTYPE CodeBlocks_lexer_properties>

This needs to be in every lexer file. Code::Blocks '''will not''' load the lexer if this is not present.

==Lexers==

<Lexer name="C/C++"
index="3"
filemasks="*.c,*.cpp,*.cc,*.cxx,*.h,*.hpp,*.hh,*.hxx,*.inl">

Pretty much self explanatory, except for the "magic" ''index'' number (we'll come to it in a sec).

* '''name''' is the lexer's configuration name. This will appear in the editor's configuration dialog, in the languages drop down box (in colors editing page).

* '''filemasks''' is a comma separated list of the extensions that this lexer should be used for. This is case-insensitive.

* '''index''' corresponds with the <tt>wxSCI_LEX_*</tt> constants, found in [http://svn.berlios.de/wsvn/codeblocks/trunk/src/sdk/wxscintilla/include/wx/wxscintilla.h <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>]. In this example, if you look in <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>, you'll see that ''index 3'' matches <tt>wxSCI_LEX_CPP</tt>. That is the ''lexer id'' for C/C++ syntax highlighting.

If we were building a lexer configuration for let's say, XML (random choice) we would look up the constant <tt>wxSCI_LEX_XML</tt> which is defined to be number ''5''. So ''index=5''. Simple.

==Styles==

Next follows many <tt><Style></tt> tags defining the different styles:

<Style name="Default"
index="0"
fg="0,0,0"
bg="255,255,255"
bold="0"
italics="0"
underlined="0" />

* '''name''' is the style's name. It appears in the editor's configuration dialog, in the colors editing page.

* '''fg''' is the foreground color. Comma separated list of three numbers from 0 to 255. In order: red, green and blue (RGB).

* '''bg''' is the background color.

* '''bold''' is <tt>"0"</tt> for disabled, <tt>"1"</tt> for enabled.

* '''italics''' is <tt>"0"</tt> for disabled, <tt>"1"</tt> for enabled.

* '''underlined''' is <tt>"0"</tt> for disabled, <tt>"1"</tt> for enabled.

You don't have to define all of these attributes. It's good to define them all for the <tt>"default"</tt> style (all lexers have a default style), but only the attributes needed should be defined for the rest of the styles.

* The '''index''' number in the <tt><Style></tt> tags, comes from a different set of constants defined in <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>.

For each language supported by scintilla, there is a set of styles ''(lexical states)'' defined (these are what we're trying to configure with these files).

For example, for C/C++ files (<tt>wxSCI_LEX_CPP</tt>, remember?) the styles are defined as <tt>wxSCI_C_*</tt>.

For the <tt>"default"</tt> style shown above, this would be <tt>wxSCI_C_DEFAULT</tt> which is defined to be ''0''. Hence ''index=0'' for <tt>"default"</tt>.

<Style name="Comment (normal)"
index="1,2"
fg="160,160,160" />

This is the style definition for normal comments. As you can see you can define a single style for more than one style index, in this case two: ''1'' and ''2'' (always comma separated).

''1'' is for <tt>wxSCI_C_COMMENT</tt> (the C comment <tt>/* */</tt>) and ''2'' is for <tt>wxSCI_C_COMMENTLINE</tt> (the C++ comment to end of line <tt>// </tt>).

There are some special styles defined by Code::Blocks and are available to all lexers:

* '''index -99''' is the selected text style.
* '''index -98''' is the active line style (the line the caret is on).
* '''index -2''' is the breakpoint line style.
* '''index -3''' is the debugger active line style (while stepping the debugger).
* '''index -4''' is the compiler warning/error line style. ('''Note: this index was removed completely?''')

==Keywords==

Now on to the keywords.

<Keywords>
<Set index="0"
value="if int long try while and-so-on" />
<Set index="1" />
<Set index="2"
value="param remarks return $ @ \ & < > # { } and-so-on" />
</Keywords>

If you are defining a lexer configuration for a language that has keywords they should be added in the <tt><Keywords></tt> tag.
In the scintilla version used by Code::Blocks, you can setup up to 9 keyword sets (the "index" attribute). What each set does and which sets are used by a lexer, is defined by the lexer itself.

If you open LexCPP.cxx (from the scintilla sources), you will find the following:

static const char * const cppWordLists[] = {
"Primary keywords and identifiers",
"Secondary keywords and identifiers",
"Documentation comment keywords",
"Unused",
"Global classes and typedefs",
0,
};

This tells us which indices are valid and what each one represents:

Index 0, "Primary keywords and identifiers"

Index 1, "Secondary keywords and identifiers"

Index 2, "Documentation comment keywords"

(notice that index "3" is not used)

Index 4, "Global classes and typedefs"

==Sample Code==

The tag left is <tt>SampleCode</tt>. This is much pretty self explanatory:

<SampleCode value="lexer_cpp.sample"
breakpoint_line="20"
debug_line="22"
error_line="23"/>

* '''value''' is the filename of the code that will be shown in the Preview window.
When creating a <tt>lexer_*.sample</tt> try to do it with simple and concise sample code (like the ones found in a typical "Hello world!"), yet include all the styles of the lexer.

There are other optional options ('''Note: this index was removed completely?''')
* '''breakpoint_line''' is the number of the line in which a breakpoint line will be previewed.
* '''debug_line''' is the number of the line in which a debug line will be previewed.
* '''error_line''' is the number of the line in which an error line will be previewed.

==Tips==
When writting a lexer, this can be useful:
* .properties files of SciTE (the official Scintilla-based text editor) [http://scintilla.sourceforge.net/SciTE.html]
* .lang files of GtkSourceView (used Gedit) [http://git.gnome.org/browse/gtksourceview/tree/data/language-specs]

==Adding support for code-folding==

'''Note: support for code-folding can't be done from the lexer files. It must be done right in the Scintilla code'''.

See here: http://sphere.sourceforge.net/flik/docs/scintilla-folding.html

==Adding support for a lexer not supported in Scintilla==

'''Note: support for a lexer not supported in Scintilla is out of scope of Code::Blocks. It must be done right in the Scintilla code.'''

Here are some instructions: http://scintilla.sourceforge.net/Lexer.txt. To be able to use your newly created lexer in C::B, adjust the validity check of "lexer" in EditorColourSet::AddHighlightLanguage().

* After you've written the Scintilla lexer, submit the files to the [http://sourceforge.net/tracker/?group_id=2439 Scintilla tracker], following their own [http://scintilla.sourceforge.net/SciCoding.html coding style].

* After that, make any necesary change to wxScintilla and sumbit the files to the [http://sourceforge.net/tracker/?group_id=51305&atid=462818 wxScintilla tracker] or send a mail to the autor wyo@users.sourceforge.net (Otto Wyss).

* And finishing, be sure to send all to the [http://developer.berlios.de/patch/?func=addpatch&group_id=5358 Code::Blocks tracker] (Category: Lexer), and announce it at the [/index.php?board=7.0 Forum] and the [[Announcement for plugins/patches|Wiki announcement for plugins/patches]].

==See also==
* [[Languages supported by Code::Blocks lexers]]

Creating a patch to submit (Patch Tracker)

2012-09-03T23:30:40Z

Alpha: Grammar.

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

IPDefend Toolkit plugin

2012-08-23T01:34:39Z

Alpha: Added category.

[[Category:Code::Blocks 3rd Party Plugins]]
* Name: IPDefend Toolkit
* Author: Comsytec s.r.o.
* Purpose: This toolkit allows to create licensed binary images. For more information see the documentation at download page.
* Version: 2.0.0; State: '''stable'''
* Last update: 21. Aug. 2012
* Link for download: [[http://www.comsytec.com/ipdefend.php]]

Code::Blocks Plugins

2012-08-23T01:33:39Z

Alpha: Alphabetize and (minor) grammar fix.

[[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:'''
Surely you can work with plugin as you like, but here are some suggestions:
* Announce them in the plugin development board in the forums - including the (initial) source code at [/index.php/board,14.0.html].

OR

* Setup your own webpage (or use a file sharing platform) and post the link to the sources/binaries/svn access in the plugin development board in the forums at [/index.php/board,14.0.html].

OR

* Setup a repository, probably at BerliOS or SourceForge, post the link to the sources/binaries/svn access in the plugin development board in the forums at [/index.php/board,14.0.html]. Notice: This is very convenient as attachments in our forum might be deleted from time to time. So it is not safe to post source code in the forums.

THEN

# Enter the plugins description on this page.
# Announce the plugin '''[[Announcement_for_plugins/patches|here]]''' using '''[[Template_for_plugin_announcement|this]]''' template.

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

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

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

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

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

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

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

:Regular expressions testbed.

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

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

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

Talk:Compile Code::Blocks plugins based on a nightly

2012-08-23T01:26:55Z

Alpha: Created page with "When linking directly to a <tt>dll</tt> (with MinGW), the file extension is not required, so <tt>wxmsw28u_gcc_cb.dll</tt> can be simply <tt>wxmsw28u_gcc_cb</tt> and <tt>codeblock..."

When linking directly to a <tt>dll</tt> (with MinGW), the file extension is not required, so <tt>wxmsw28u_gcc_cb.dll</tt> can be simply <tt>wxmsw28u_gcc_cb</tt> and <tt>codeblocks</tt> can remain the unchanged. [[User:Alpha|Alpha]] 03:26, 23 August 2012 (CEST)

File formats description

2012-08-11T14:52:11Z

Alpha: Added links (not sure if this is the correct page, but if not, someone can move them).

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Code::Blocks projects/workspaces are described in XML files. Here are contained links to documentation for each one of them.

This information is of interest to anyone wanting to write an importer/exporter/generator for other build systems/environments and therefore add support for Code::Blocks.

* '''[[Workspace file]]''' (*.workspace)
:Defines a Code::Blocks workspace (collection of projects).

* '''[[Project file]]''' (*.cbp)
:Defines a Code::Blocks project.

Additional files used in the proposed [/index.php/topic,16463.0.html XML compiler branch]:

* '''[[Compiler file]]''' (compiler_*.xml)
:Defines a Code::Blocks compiler interface and auto-detection routines.

* '''[[Compiler options file]]''' (options_*.xml)
:Defines the options and regular expressions for a Code::Blocks compiler.

''Code::Blocks also produces a couple other files (*.layout and *.depend) but they only contain state information so they are not really useful to anyone else other than Code::Blocks itself.''

[[User:Mandrav|Mandrav]] 11:42, 1 March 2007 (UTC)

Compiler options file

2012-08-04T13:36:30Z

Alpha: Added category.

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Proposed format for storing compiler options in editable XML. See: [/index.php/topic,16463.0.html XML based compilers] and [[Compiler file]]s.
{{Layout_box2|1=
<tt>svn checkout <nowiki>svn://svn.berlios.de/codeblocks/branches/xml_compiler</nowiki></tt>
}}

<source lang="xml" enclose="div">
<CodeBlocks_compiler_options extends="gcc">
[...]
</CodeBlocks_compiler_options>
</source>
I am a Code::Blocks compiler options file.

<tt>extends="</tt><id><tt>"</tt> (optional)
* Load the corresponding <tt>options_</tt><id><tt>.xml</tt> file first (use if this compiler is almost the same, with only a few altered programs or added switches, for example).

<source lang="xml" enclose="div">
<if platform="windows">
[...]
</if>
<else>
[...]
</else>
</source>
Standard <tt>if</tt> statement; contents of <tt>if</tt> block is evaluated if the <tt>if</tt> statement is true, otherwise the <tt>else</tt> block is evaluated (the <tt>else</tt> block is optional). Nesting is allowed.

<tt>platform="</tt><os><tt>"</tt>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>
<source lang="xml" enclose="div">
<if exec="bison -h">
[...]
</if>
</source>
True if the the command <tt>exec</tt> can be run.
<source lang="xml" enclose="div">
<if exec="C -dumpversion"
regex="^4\.[3-9]|^[5-9]\.[0-9]"
default="true">
[...]
</if>
</source>
If the text before the first space in <tt>exec</tt> is one of:
* <tt>C
* CPP
* LD
* LIB
* WINDRES
* MAKE</tt>
it will be replaced with the name of the corresponding executable.

True if <tt>regex</tt> matches the command's output (in this case, version number <tt>>=</tt> 4.3.0).

<tt>default</tt> is used if the command fails to execute (optional).

<source lang="xml" enclose="div">
<Program name="C" value="mingw32-gcc.exe"/>
</source>
Give the name of an executable

<tt>name="</tt><prog><tt>"</tt>. <prog> is one of:
* <tt>C
* CPP
* LD
* DBGconfig
* LIB
* WINDRES
* MAKE
value="</tt><exec><tt>"</tt> (actual name of the executable).

<source lang="xml" enclose="div">
<Switch name="includeDirs" value="-I"/>
</source>
Switches controlling compiler constants.

<tt>name="</tt><opt><tt>"</tt>. <opt> is one of:
* <tt>includeDirs
* libDirs
* linkLibs
* defines
* genericSwitch
* objectExtension
* forceFwdSlashes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceLinkerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceCompilerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* needDependencies</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* logging</tt>. <tt>value</tt> is one of:
** <tt>default</tt> (same as <tt>full</tt>)
** <tt>full
** simple
** none
* libPrefix
* libExtension
* linkerNeedsLibPrefix</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* linkerNeedsLibExtension</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* supportsPCH</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* PCHExtension
* UseFlatObjects</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* UseFullSourcePaths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* Use83Paths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false</tt>

<source lang="xml" enclose="div">
<Option name="Profile code when executed"
option="-pg"
additionalLibs="-pg -lgmon"
category="Profiling"
checkAgainst="-O -O1 -O2 -O3 -Os"
checkMessage="You have optimizations enabled. This is Not A Good Thing(tm) when producing debugging symbols..."
supersedes="-s"
exclusive="true"/>
</source>
Definition of a compiler flag.
* <tt>name</tt>. Human readable description of the flag.
* <tt>option</tt>. Flags to be sent to the compiler (optional).
* <tt>additionalLibs</tt>. Flags to be sent to the linker (optional).
* <tt>category</tt>. The category this flag is in (optional; defaults to "General").
* <tt>checkAgainst</tt>. Show a warning message if any of these flags are enabled (optional).
* <tt>checkMessage</tt>. Warning message to show upon conflict (optional).
* <tt>superseds</tt>. Automatically disable the list of superseded flags if this flag is enabled (optional).
* <tt>exclusive</tt>. Disable all other flags in this category if this flag is enabled. Is one of <tt>true</tt> or <tt>false</tt> (optional).

<source lang="xml" enclose="div">
<Category name="CPU architecture tuning"
exclusive="true">
[...]
</Category>
</source>
<tt>name="</tt><cat><tt>"</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>category</tt> attribute will be treated as category <cat>.

<tt>exclusive</tt>. Is one of <tt>true</tt> or <tt>false</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>exclusive</tt> attribute will be treated as this. (Optional.)

<source lang="xml" enclose="div">
<Common name="optimization"/>
</source>
Load options from a common file.

<tt>name="</tt><file><tt>"</tt>
* Loads <tt>options_common_</tt><file><tt>.xml</tt> (file syntax is exactly the same as this file).

<source lang="xml" enclose="div">
<Command name="CompileObject"
value="$compiler $options $includes -c $file -o $object"/>
</source>
Definitions for forming compiler commands.

<tt>name="</tt><cmd><tt>"</tt>. <cmd> is one of:
* <tt>CompileObject
* GenDependencies
* CompileResource
* LinkExe
* LinkConsoleExe
* LinkDynamic
* LinkStatic
* LinkNative</tt>
<source lang="xml" enclose="div">
<Command name="CompileObject"
value="bison -v -d $file -o $file_dir/$file_name.parser.cc"
ext="y"
gen="$file_dir/$file_name.parser.cc;$file_dir/$file_name.parser.hh"/>
</source>
Additional commands can be added to each category with a file extension filter.

<tt>ext="</tt><exts><tt>"</tt>. <exts> is a semicolon separated list of file extensions (without the leading <tt>"."</tt> period).

<tt>gen="</tt><files><tt>"</tt>. <files> is a semicolon separated list of generated files to be further processed (optional).

<source lang="xml" enclose="div">
<RegEx name="Info line"
type="info"
msg="1;2;4"
file="2"
line="3">
<![CDATA[(In file) ([][{}() \t#%$~[:alnum:]&_:+/\.-]+):([0-9]+)(\.[0-9]+.*:)*]]>
</RegEx>
</source>
Definitions for regular expressions to parse compiler output.

<tt>name="</tt><label><tt>"</tt>. <label> is the name this regex will be listed as.

<tt>type="</tt><tp><tt>"</tt>. <tp> is one of
* <tt>normal
* warning
* error
* info</tt>

<tt>msg="</tt><nums><tt>"</tt>. <nums> is a semicolon separated list of indices (minimum one, maximum three) for the locations of messages within the regex.

<tt>file="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant file (optional).

<tt>line="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant line number (optional).

The contents is the regex (use of a <tt>CDATA</tt> section is not required).

Compiler file

2012-08-04T13:34:36Z

Alpha: Added category.

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Proposed format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s). See: [/index.php/topic,16463.0.html XML based compilers].
{{Layout_box2|1=
<tt>svn checkout <nowiki>svn://svn.berlios.de/codeblocks/branches/xml_compiler</nowiki></tt>
}}

<source lang="xml" enclose="div">
<CodeBlocks_compiler name="Digital Mars Compiler"
id="dmc"
weight="24"
platform="windows">
[...]
</CodeBlocks_compiler>
</source>
I am a Code::Blocks compiler file.

<tt>name="</tt><txt><tt>"</tt>
* <txt> is the descriptive name that will be shown to the user for this compiler.

<tt>id="</tt><id><tt>"</tt>
* Lowercase sequence of letters, numbers, underscores, and/or hyphens (it must, however, start with a letter) which is used internally to represent this compiler.

<tt>weight="</tt><num><tt>"</tt> (optional)
* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (keep <num> between 0 and 100).

<tt>platform="</tt><os><tt>"</tt> (optional). Only load this compiler if the current operating system is <os>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

All of the following routines are used during auto-detection.

Conditional <tt><if>[...]</if><else>[...]</else></tt> statements are available in the same form as in [[Compiler options file]]s.

<source lang="xml" enclose="div">
<Path type="master">
[...]
</Path>
</source>
<tt>type="</tt><tp><tt>"</tt> Determines what variable the results of the contained detection routine(s) will be stored in. <tp> is one of:
* <tt>master
* extra
* include
* resource
* lib</tt>

<source lang="xml" enclose="div">
<Search envVar="PATH"
for="C"/>
</source>
Searches all paths in the given environment variable.
* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.
* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

<source lang="xml" enclose="div">
<Search path="C:\MinGW"
for="C"/>
</source>
Same functionality as <tt><Search envVar="..."></tt> except that this tests a hard-coded path.

<source lang="xml" enclose="div">
<Search path="C:\WinAVR*"/>
</source>
Wildcards are allowed in <tt><Search path="..."></tt>.

<source lang="xml" enclose="div">
<Search registry="HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\SDCC"
value="InstallLocation"/>
</source>
Read a Windows registry key. If <tt>value</tt> is found in the registry key, and it is a valid folder, it will be added to the current <tt><Path type="..."></tt>.

<source lang="xml" enclose="div">
<Fallback path="/usr/local"/>
</source>
If the current <tt><Path type="..."></tt> is empty, add this path to it.

<source lang="xml" enclose="div">
<Add><master/><separator/>lib</Add>
</source>
Add a path to the current <tt><Path type="..."></tt>.
* <tt><master/></tt> is replaced by the contents of the master path.
* <tt><separator/></tt> is replaced by the system's native file path separator.

<source lang="xml" enclose="div">
<Add cFlag="-O"/>
</source>
Enable a compiler flag.

<source lang="xml" enclose="div">
<Add lFlag="-s"/>
</source>
Enable a linker flag.

<source lang="xml" enclose="div">
<Add lib="pthread"/>
</source>
Add a library.

Compiler file

2012-08-03T01:29:19Z

Alpha: More documentation.

Proposed format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s). See: [/index.php/topic,16463.0.html XML based compilers].
{{Layout_box2|1=
<tt>svn checkout <nowiki>svn://svn.berlios.de/codeblocks/branches/xml_compiler</nowiki></tt>
}}

<source lang="xml" enclose="div">
<CodeBlocks_compiler name="Digital Mars Compiler"
id="dmc"
weight="24"
platform="windows">
[...]
</CodeBlocks_compiler>
</source>
I am a Code::Blocks compiler file.

<tt>name="</tt><txt><tt>"</tt>
* <txt> is the descriptive name that will be shown to the user for this compiler.

<tt>id="</tt><id><tt>"</tt>
* Lowercase sequence of letters, numbers, underscores, and/or hyphens (it must, however, start with a letter) which is used internally to represent this compiler.

<tt>weight="</tt><num><tt>"</tt> (optional)
* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (keep <num> between 0 and 100).

<tt>platform="</tt><os><tt>"</tt> (optional). Only load this compiler if the current operating system is <os>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

<source lang="xml" enclose="div">
<Path type="master">
[...]
</Path>
</source>
<tt>type="</tt><tp><tt>"</tt> Determines what variable the results of the contained detection routine(s) will be stored in. <tp> is one of:
* <tt>master
* extra
* include
* resource
* lib</tt>

<source lang="xml" enclose="div">
<Search envVar="PATH"
for="C"/>
</source>
Searches all paths in the given environment variable.
* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.
* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

<source lang="xml" enclose="div">
<Search path="C:\MinGW"
for="C"/>
</source>
Same functionality as <tt><Search envVar="..."></tt> except that this tests a hard-coded path.

<source lang="xml" enclose="div">
<Search path="C:\WinAVR*"/>
</source>
Wildcards are allowed in <tt><Search path="..."></tt>.

<source lang="xml" enclose="div">
<Search registry="HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\SDCC"
value="InstallLocation"/>
</source>
Read a Windows registry key. If <tt>value</tt> is found in the registry key, and it is a valid folder, it will be added to the current <tt><Path type="..."></tt>.

<source lang="xml" enclose="div">
<Fallback path="/usr/local"/>
</source>
If the current <tt><Path type="..."></tt> is empty, add this path to it.

<source lang="xml" enclose="div">
<Add><master/><separator/>lib</Add>
</source>
Add a path to the current <tt><Path type="..."></tt>.
* <tt><master/></tt> is replaced by the contents of the master path.
* <tt><separator/></tt> is replaced by the system's native file path separator.

<source lang="xml" enclose="div">
<Add cFlag="-O"/>
</source>
Enable a compiler flag.

<source lang="xml" enclose="div">
<Add lFlag="-s"/>
</source>
Enable a linker flag.

<source lang="xml" enclose="div">
<Add lib="pthread"/>
</source>
Add a library.

Compiler file

2012-07-23T20:02:14Z

Alpha: Started documenting format.

Proposed format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s). See: [/index.php/topic,16463.0.html XML based compilers].
{{Layout_box2|1=
<tt>svn checkout <nowiki>svn://svn.berlios.de/codeblocks/branches/xml_compiler</nowiki></tt>
}}

<source lang="xml" enclose="div">
<CodeBlocks_compiler name="Digital Mars Compiler"
id="dmc"
weight="24"
platform="windows">
[...]
</CodeBlocks_compiler>
</source>
I am a Code::Blocks compiler file.

<tt>name="</tt><txt><tt>"</tt>
* <txt> is the descriptive name that will be shown to the user for this compiler.

<tt>id="</tt><id><tt>"</tt>
* Lowercase sequence of letters, numbers, underscores, and/or hyphens (it must, however, start with a letter) which is used internally to represent this compiler.

<tt>weight="</tt><num><tt>"</tt> (optional)
* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (try to keep <num> between 0 and 100).

<tt>platform="</tt><os><tt>"</tt> (optional). Only load this compiler if the current operating system is <os>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

<source lang="xml" enclose="div">
<Path type="master">
[...]
</Path>
</source>
<tt>type="</tt><tp><tt>"</tt> Determines what variable the results of the contained detection routine(s) will be stored in. <tp> is one of:
* <tt>master
* extra
* include
* resource
* lib</tt>

<source lang="xml" enclose="div">
<Search envVar="PATH"
for="C"/>
</source>
Searches all paths in the given environment variable.
* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.
* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

<source lang="xml" enclose="div">
<Search path="C:\MinGW"
for="C"/>
</source>
Same functionality as <tt><Search envVar="..."></tt> except that this tests a hard-coded path.

<source lang="xml" enclose="div">
<Search registry="HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\SDCC"
value="InstallLocation"/>
</source>
Read a Windows registry key. If <tt>value</tt> is found in the registry key, and it is a valid folder, it will be added to the current <tt><Path type="..."></tt>.

<source lang="xml" enclose="div">
<Fallback path="/usr/local"/>
</source>
If the current <tt><Path type="..."></tt> is empty, add this path to it.

Announcement for plugins/patches

2012-07-13T20:19:34Z

Alpha: Added links.

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with FortranProject plugin
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]
* [[Java lexer]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Compiler options file

2012-07-12T16:13:59Z

Alpha: Updated options.

Proposed format for storing compiler options in editable XML. See: [/index.php/topic,16463.0.html XML based compilers].
{{Layout_box2|1=
<tt>svn checkout <nowiki>svn://svn.berlios.de/codeblocks/branches/xml_compiler</nowiki></tt>
}}

<source lang="xml" enclose="div">
<CodeBlocks_compiler_options extends="gcc">
[...]
</CodeBlocks_compiler_options>
</source>
I am a Code::Blocks compiler options file.

<tt>extends="</tt><id><tt>"</tt> (optional)
* Load the corresponding <tt>options_</tt><id><tt>.xml</tt> file first (use if this compiler is almost the same, with only a few altered programs or added switches, for example).

<source lang="xml" enclose="div">
<if platform="windows">
[...]
</if>
<else>
[...]
</else>
</source>
Standard <tt>if</tt> statement; contents of <tt>if</tt> block is evaluated if the <tt>if</tt> statement is true, otherwise the <tt>else</tt> block is evaluated (the <tt>else</tt> block is optional). Nesting is allowed.

<tt>platform="</tt><os><tt>"</tt>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>
<source lang="xml" enclose="div">
<if exec="bison -h">
[...]
</if>
</source>
True if the the command <tt>exec</tt> can be run.
<source lang="xml" enclose="div">
<if exec="C -dumpversion"
regex="4\.[3-9]\.[0-9]|[5-9]\.[0-9]\.[0-9]"
default="true">
[...]
</if>
</source>
If the text before the first space in <tt>exec</tt> is one of:
* <tt>C
* CPP
* LD
* LIB
* WINDRES
* MAKE</tt>
it will be replaced with the name of the corresponding executable.

True if <tt>regex</tt> matches the command's output (in this case, version number <tt>>=</tt> 4.3.0).

<tt>default</tt> is used if the command fails to execute (optional).

<source lang="xml" enclose="div">
<Program name="C" value="mingw32-gcc.exe"/>
</source>
Give the name of an executable

<tt>name="</tt><prog><tt>"</tt>. <prog> is one of:
* <tt>C
* CPP
* LD
* DBGconfig
* LIB
* WINDRES
* MAKE
value="</tt><exec><tt>"</tt> (actual name of the executable).

<source lang="xml" enclose="div">
<Switch name="includeDirs" value="-I"/>
</source>
Switches controlling compiler constants.

<tt>name="</tt><opt><tt>"</tt>. <opt> is one of:
* <tt>includeDirs
* libDirs
* linkLibs
* defines
* genericSwitch
* objectExtension
* forceFwdSlashes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceLinkerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceCompilerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* needDependencies</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* logging</tt>. <tt>value</tt> is one of:
** <tt>default</tt> (same as <tt>full</tt>)
** <tt>full
** simple
** none
* libPrefix
* libExtension
* linkerNeedsLibPrefix</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* linkerNeedsLibExtension</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* supportsPCH</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* PCHExtension
* UseFlatObjects</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* UseFullSourcePaths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* Use83Paths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false</tt>

<source lang="xml" enclose="div">
<Option name="Profile code when executed"
option="-pg"
additionalLibs="-pg -lgmon"
category="Profiling"
checkAgainst="-O -O1 -O2 -O3 -Os"
checkMessage="You have optimizations enabled. This is Not A Good Thing(tm) when producing debugging symbols..."
supersedes="-s"
exclusive="true"/>
</source>
Definition of a compiler flag.
* <tt>name</tt>. Human readable description of the flag.
* <tt>option</tt>. Flags to be sent to the compiler (optional).
* <tt>additionalLibs</tt>. Flags to be sent to the linker (optional).
* <tt>category</tt>. The category this flag is in (optional; defaults to "General").
* <tt>checkAgainst</tt>. Show a warning message if any of these flags are enabled (optional).
* <tt>checkMessage</tt>. Warning message to show upon conflict (optional).
* <tt>superseds</tt>. Automatically disable the list of superseded flags if this flag is enabled (optional).
* <tt>exclusive</tt>. Disable all other flags in this category if this flag is enabled. Is one of <tt>true</tt> or <tt>false</tt> (optional).

<source lang="xml" enclose="div">
<Category name="CPU architecture tuning"
exclusive="true">
[...]
</Category>
</source>
<tt>name="</tt><cat><tt>"</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>category</tt> attribute will be treated as category <cat>.

<tt>exclusive</tt>. Is one of <tt>true</tt> or <tt>false</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>exclusive</tt> attribute will be treated as this. (Optional.)

<source lang="xml" enclose="div">
<Common name="optimization"/>
</source>
Load options from a common file.

<tt>name="</tt><file><tt>"</tt>
* Loads <tt>options_common_</tt><file><tt>.xml</tt> (file syntax is exactly the same as this file).

<source lang="xml" enclose="div">
<Command name="CompileObject"
value="$compiler $options $includes -c $file -o $object"/>
</source>
Definitions for forming compiler commands.

<tt>name="</tt><cmd><tt>"</tt>. <cmd> is one of:
* <tt>CompileObject
* GenDependencies
* CompileResource
* LinkExe
* LinkConsoleExe
* LinkDynamic
* LinkStatic
* LinkNative</tt>
<source lang="xml" enclose="div">
<Command name="CompileObject"
value="bison -v -d $file -o $file_dir/$file_name.parser.cc"
ext="y"
gen="$file_dir/$file_name.parser.cc;$file_dir/$file_name.parser.hh"/>
</source>
Additional commands can be added to each category with a file extension filter.

<tt>ext="</tt><exts><tt>"</tt>. <exts> is a semicolon separated list of file extensions (without the leading <tt>"."</tt> period).

<tt>gen="</tt><files><tt>"</tt>. <files> is a semicolon separated list of generated files to be further processed (optional).

<source lang="xml" enclose="div">
<RegEx name="Info line"
type="info"
msg="1;2;4"
file="2"
line="3">
<![CDATA[(In file) ([][{}() \t#%$~[:alnum:]&_:+/\.-]+):([0-9]+)(\.[0-9]+.*:)*]]>
</RegEx>
</source>
Definitions for regular expressions to parse compiler output.

<tt>name="</tt><label><tt>"</tt>. <label> is the name this regex will be listed as.

<tt>type="</tt><tp><tt>"</tt>. <tp> is one of
* <tt>normal
* warning
* error
* info</tt>

<tt>msg="</tt><nums><tt>"</tt>. <nums> is a semicolon separated list of indices (minimum one, maximum three) for the locations of messages within the regex.

<tt>file="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant file (optional).

<tt>line="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant line number (optional).

The contents is the regex (use of a <tt>CDATA</tt> section is not required).

Compiler options file

2012-06-27T02:49:18Z

Alpha: Updated options.

Proposed format for storing compiler options in editable XML. See: [/index.php/topic,16463.0.html XML based compilers].

<source lang="xml" enclose="div">
<CodeBlocks_compiler_options extends="gcc">
[...]
</CodeBlocks_compiler_options>
</source>
I am a Code::Blocks compiler options file.

<tt>extends="</tt><id><tt>"</tt> (optional)
* Load the corresponding <tt>options_</tt><id><tt>.xml</tt> file first (use if this compiler is almost the same, with only a few altered programs or added switches, for example).

<source lang="xml" enclose="div">
<if platform="windows">
[...]
</if>
<else>
[...]
</else>
</source>
Standard <tt>if</tt> statement; contents of <tt>if</tt> block is evaluated if the <tt>if</tt> statement is true, otherwise the <tt>else</tt> block is evaluated (the <tt>else</tt> block is optional). Nesting is allowed.

<tt>platform="</tt><os><tt>"</tt> (platform is the only condition currently defined). <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

<source lang="xml" enclose="div">
<Program name="C" value="mingw32-gcc.exe"/>
</source>
Give the name of an executable

<tt>name="</tt><prog><tt>"</tt>. <prog> is one of:
* <tt>C
* CPP
* LD
* DBG
* DBGconfig
* LIB
* WINDRES
* MAKE
value="</tt><exec><tt>"</tt> (actual name of the executable).

<source lang="xml" enclose="div">
<Switch name="includeDirs" value="-I"/>
</source>
Switches controlling compiler constants.

<tt>name="</tt><opt><tt>"</tt>. <opt> is one of:
* <tt>includeDirs
* libDirs
* linkLibs
* defines
* genericSwitch
* objectExtension
* forceFwdSlashes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceLinkerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceCompilerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* needDependencies</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* logging</tt>. <tt>value</tt> is one of:
** <tt>default</tt> (same as <tt>full</tt>)
** <tt>full
** simple
** none
* libPrefix
* libExtension
* linkerNeedsLibPrefix</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* linkerNeedsLibExtension</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* supportsPCH</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* PCHExtension
* UseFlatObjects</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* UseFullSourcePaths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* Use83Paths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false</tt>

<source lang="xml" enclose="div">
<Option name="Profile code when executed"
option="-pg"
additionalLibs="-pg -lgmon"
category="Profiling"
checkAgainst="-O -O1 -O2 -O3 -Os"
checkMessage="You have optimizations enabled. This is Not A Good Thing(tm) when producing debugging symbols..."
supersedes="-s"
exclusive="true"/>
</source>
Definition of a compiler flag.
* <tt>name</tt>. Human readable description of the flag.
* <tt>option</tt>. Flags to be sent to the compiler (optional).
* <tt>additionalLibs</tt>. Flags to be sent to the linker (optional).
* <tt>category</tt>. The category this flag is in (optional; defaults to "General").
* <tt>checkAgainst</tt>. Show a warning message if any of these flags are enabled (optional).
* <tt>checkMessage</tt>. Warning message to show upon conflict (optional).
* <tt>superseds</tt>. Automatically disable the list of superseded flags if this flag is enabled (optional).
* <tt>exclusive</tt>. Disable all other flags in this category if this flag is enabled. Is one of <tt>true</tt> or <tt>false</tt> (optional).

<source lang="xml" enclose="div">
<Category name="CPU architecture tuning"
exclusive="true">
[...]
</Category>
</source>
<tt>name="</tt><cat><tt>"</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>category</tt> attribute will be treated as category <cat>.

<tt>exclusive</tt>. Is one of <tt>true</tt> or <tt>false</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>exclusive</tt> attribute will be treated as this. (Optional.)

<source lang="xml" enclose="div">
<Common name="optimization"/>
</source>
Load options from a common file.

<tt>name="</tt><file><tt>"</tt>
* Loads <tt>options_common_</tt><file><tt>.xml</tt> (file syntax is exactly the same as this file).

<source lang="xml" enclose="div">
<Command name="CompileObject"
value="$compiler $options $includes -c $file -o $object"/>
</source>
Definitions for forming compiler commands.

<tt>name="</tt><cmd><tt>"</tt>. <cmd> is one of:
* <tt>CompileObject
* GenDependencies
* CompileResource
* LinkExe
* LinkConsoleExe
* LinkDynamic
* LinkStatic
* LinkNative</tt>
<source lang="xml" enclose="div">
<Command name="CompileObject"
value="bison -v -d $file -o $file_dir/$file_name.parser.cc"
ext="y"
gen="$file_dir/$file_name.parser.cc;$file_dir/$file_name.parser.hh"/>
</source>
Additional commands can be added to each category with a file extension filter.

<tt>ext="</tt><exts><tt>"</tt>. <exts> is a semicolon separated list of file extensions (without the leading <tt>"."</tt> period).

<tt>gen="</tt><files><tt>"</tt>. <files> is a semicolon separated list of generated files to be further processed (optional).

<source lang="xml" enclose="div">
<RegEx name="Info line"
type="info"
msg="1;2;4"
file="2"
line="3">
<![CDATA[(In file) ([][{}() \t#%$~[:alnum:]&_:+/\.-]+):([0-9]+)(\.[0-9]+.*:)*]]>
</RegEx>
</source>
Definitions for regular expressions to parse compiler output.

<tt>name="</tt><label><tt>"</tt>. <label> is the name this regex will be listed as.

<tt>type="</tt><tp><tt>"</tt>. <tp> is one of
* <tt>normal
* warning
* error
* info</tt>

<tt>msg="</tt><nums><tt>"</tt>. <nums> is a semicolon separated list of indices (minimum one, maximum three) for the locations of messages within the regex.

<tt>file="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant file (optional).

<tt>line="</tt><num><tt>"</tt>. <num> is the index of the regex which gives the relevant line number (optional).

The contents is the regex (use of a <tt>CDATA</tt> section is not required).

Adding support for non C/C++ files to the build system

2012-06-23T19:06:16Z

Alpha: Formatting.

[[Category: User Documentation]]
== Intro ==

As you may already know, Code::Blocks is designed mainly for C/C++ development. This means that when it "sees" C/C++ files in your project it knows how to compile and link them to generate the resulting binary output.
What about other types of files though? You may want to compile java or python files but, unfortunately, Code::Blocks knows nothing about them...

And there's this other case: in real world projects, it's not unusual for some of the files belonging to a project to be auto-generated. This is done through the use of another program/script that possibly takes an input file and generates one (or more) files based on that input. Code::Blocks, unfortunately, can't handle them either...

Or can it?

The answer is: ....... (drum-rolling) ........ (ta-da) ......... '''It sure can!'''.

Code::Blocks has been recently updated so it can be configured to recognize non C/C++ files and act accordingly on them during the build process. This article will describe those changes and provide a simple but real world example of usage.

== How things used to work... ==

In case you never had a look in advanced compiler options, you can find them by clicking ''<tt>Settings->Compiler and debugger->Other settings->Advanced options</tt>''. Look for "Advanced options" in lower right, it's easy to miss.

In that dialog you will find the command line macros used to build files. For example, each file belonging to the project, that had its compile flag on, would be compiled with the macro named "Compile single file to object file" (''<tt>"$compiler $options $includes -c $file -o $object"</tt>'', for the curious).

While this provide enough room for customizing the build system's configuration, it clearly didn't allow for some more generic customization.

If you wanted to include in your project and compile a java file, you would have to set a custom build command for that particular file, ''only'' for that file (right-click file in tree and choose properties). This is not only cumbersome (imagine having to do this for 10 or 100 java files) but impractical too.

== ...and how things have evolved ==

The new functionality described in this article aims to remove the above problems and allow for more customization of the build system. So, what is different now?

<center>[[Image:AdvancedCompilerOptions.png|Advanced compiler options]]</center>

For starters, the command line macros are now paired with a list of source file extensions. So each command line macro (like the "Compile single file to object file") can now hold different macros ''depending on the source file extension''. This is the core of the new functionality: by adding a new command-extension pair, you effectively add support for these extension(s) to the build system!

Another thing that also got added was the ability to keep a list of files the custom command will generate (for each command-extension pair). These generated files are then automatically shown in the project tree, become part of the build process, etc. In other words, they are dynamically - and transparently - affecting the project. If you find this confusing, have a look at the provided example and things will clear up :).

== Let's see an example already ==

Here comes a real world example. I recently worked on a side project that required me to use [http://www.swig.org SWIG]. What the <tt>swig</tt> program does, in simple words, is take a special interface file (usually <tt>*.i</tt>) as input and, based on this input, it generates a C/C++ file to include in your project. This sounds like the perfect scenario to use as an example here :).

Here's what I did:

Command: '''Compile single file to object file'''
Extension: '''i'''
Macro: '''swig -c++ -lua $includes -o $file_dir/$file_name.cpp $file'''
Generated files: '''$file_dir/$file_name.cpp'''

What do the above mean?

For any file with extension '''i''', use the above macro to process (compile) it. Also lets Code::Blocks know that this macro will create a new file, named '''$file_dir/$file_name.cpp'''.

With this info at hand, Code::Blocks will now do the following auto-magically when you add any *.i file to a project:

* Add the generated file(s) also to the project (even if they don't yet exist).
* Will display the file under the new "Auto-generated" tree folder (if files categorization is enabled).
* Will know how to process (compile) the *.i files.
* Will also schedule all the generated files for processing (compiling) ''after'' the *.i file is processed.
* Will still track dependencies so when the *.i file is changed, its generated files will be re-generated too.

== Another example - Ragel ==

Compile [http://www.complang.org/ragel/ Ragel State Machine Compiler] source into C++ file.

Command: '''Compile single file to object file'''
Extension: '''rl'''
Macro: '''ragel $file -C -L -o $file.cpp'''
Generated files: '''$file.cpp'''

(You have to ensure that the ragel executable is in the PATH.)

== Another example - Bison ==

Compile [http://www.gnu.org/software/bison/ Bison Parser] parser into C/C++ file.

Command: '''Compile single file to object file'''
Extension: '''y'''
Macro: '''bison -v -d $file -o $file_dir/$file_name.parser.cc'''
Generated files: '''$file_dir/$file_name.parser.cc'''
'''$file_dir/$file_name.parser.hh'''

(You have to ensure that the bison executable is in the PATH.)

== Another example - Flex ==

Compile [http://flex.sourceforge.net/ Flex] lexical analyser files into C/C++ file.

Command: '''Compile single file to object file'''
Extension: '''l'''
Macro: '''flex -o$file_dir/$file_name.scanner.cc $file'''
Generated files: '''$file_dir/$file_name.scanner.cc'''

(You have to ensure that the flex executable is in the PATH.)

== Notes ==

* All default commands are paired to no extension. These are used as fallback if a matching extension isn't defined.

== Known issues ==
* Currently, only the ''$file*'' macros are supported in the generated files names ($file, $file_dir, $file_name and $file_ext).
* If you change any of the settings mentioned here in advanced compiler options, you '''must''' close and re-open your project so the changes will take effect. No message is displayed currently to note this.
* If you are using a non-default compiler (to cross compile for example), you may need to make these settings in the default compiler, not the cross compiler where it seems to have no effect.

Creation: [[User:Mandrav|Mandrav]] 11:29, 12 October 2007 (UTC)
Update: [[User:MortenMacFly|MortenMacFly]] 17:53, 12 June 2012 (UTC)

Announcement for plugins/patches

2012-06-23T12:53:06Z

Alpha: Added link.

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with FortranProject plugin
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]
* [[Java lexer]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Compiler options file

2012-06-22T05:33:47Z

Alpha: Created page with "Proposed format for storing compiler options in editable XML. See: [/index.php/topic,16463.0.html XML based compilers]. <source lang="xml" enclose="..."

Proposed format for storing compiler options in editable XML. See: [/index.php/topic,16463.0.html XML based compilers].

<source lang="xml" enclose="div">
<CodeBlocks_compiler_options extends="gcc">
[...]
</CodeBlocks_compiler_options>
</source>
I am a Code::Blocks compiler options file.

<tt>extends="</tt><id><tt>"</tt> (optional)
* Load the corresponding <tt>options_</tt><id><tt>.xml</tt> file first (use if this compiler is almost the same, with only a few altered programs or added switches, for example).

<source lang="xml" enclose="div">
<if platform="windows">
[...]
</if>
<else>
[...]
</else>
</source>
Standard <tt>if</tt> statement; contents of <tt>if</tt> block is evaluated if the <tt>if</tt> statement is true, otherwise the <tt>else</tt> block is evaluated (the <tt>else</tt> block is optional). Nesting is allowed.

<tt>platform="</tt><os><tt>"</tt> (platform is the only condition currently defined). <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

<source lang="xml" enclose="div">
<Program name="C" value="mingw32-gcc.exe"/>
</source>
Give the name of an executable

<tt>name="</tt><prog><tt>"</tt>. <prog> is one of:
* <tt>C
* CPP
* LD
* DBG
* DBGconfig
* LIB
* WINDRES
* MAKE
value="</tt><exec><tt>"</tt> (actual name of the executable).

<source lang="xml" enclose="div">
<Switch name="includeDirs" value="-I"/>
</source>
Switches controlling compiler constants.

<tt>name="</tt><opt><tt>"</tt>. <opt> is one of:
* <tt>includeDirs
* libDirs
* linkLibs
* defines
* genericSwitch
* objectExtension
* forceFwdSlashes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceLinkerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* forceCompilerUseQuotes</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* needDependencies</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* logging</tt>. <tt>value</tt> is one of:
** <tt>default</tt> (same as <tt>full</tt>)
** <tt>full
** simple
** none
* libPrefix
* libExtension
* linkerNeedsLibPrefix</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* linkerNeedsLibExtension</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* supportsPCH</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* PCHExtension
* UseFlatObjects</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* UseFullSourcePaths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false
* Use83Paths</tt>. <tt>value</tt> is one of <tt>true</tt> or <tt>false</tt>

<source lang="xml" enclose="div">
<Option name="Profile code when executed"
option="-pg"
additionalLibs="-pg -lgmon"
category="Profiling"
checkAgainst="-O -O1 -O2 -O3 -Os"
checkMessage="You have optimizations enabled. This is Not A Good Thing(tm) when producing debugging symbols..."
supersedes="-s"
exclusive="true"/>
</source>
Definition of a compiler flag.
* <tt>name</tt>. Human readable description of the flag.
* <tt>option</tt>. Flags to be sent to the compiler (optional).
* <tt>additionalLibs</tt>. Flags to be sent to the linker (optional).
* <tt>category</tt>. The category this flag is in (optional; defaults to "General").
* <tt>checkAgainst</tt>. Show a warning message if any of these flags are enabled (optional).
* <tt>checkMessage</tt>. Warning message to show upon conflict (optional).
* <tt>superseds</tt>. Automatically disable the list of superseded flags if this flag is enabled (optional).
* <tt>exclusive</tt>. Disable all other flags in this category if this flag is enabled. Is one of <tt>true</tt> or <tt>false</tt> (optional).

<source lang="xml" enclose="div">
<Category name="CPU architecture tuning"
exclusive="true">
[...]
</Category>
</source>
<tt>name="</tt><cat><tt>"</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>category</tt> attribute will be treated as category <cat>.

<tt>exclusive</tt>. Is one of <tt>true</tt> or <tt>false</tt>. Any flags (<code><Option [...] /></code>) contained in here that lack the <tt>exclusive</tt> attribute will be treated as this. (Optional.)

<source lang="xml" enclose="div">
<Common name="optimization"/>
</source>
Load options from a common file.

<tt>name="</tt><file><tt>"</tt>
* Loads <tt>options_common_</tt><file><tt>.xml</tt> (file syntax is exactly the same as this file).

<source lang="xml" enclose="div">
<Command name="CompileObject"
value="$compiler $options $includes -c $file -o $object"/>
</source>
Definitions for forming compiler commands

<tt>name="</tt><cmd><tt>"</tt>. <cmd> is one of:
* <tt>CompileObject
* GenDependencies
* CompileResource
* LinkExe
* LinkConsoleExe
* LinkDynamic
* LinkStatic
* LinkNative</tt>

Fortran Project plugin

2012-06-06T20:10:49Z

Alpha: New version.

[[Category:Code::Blocks 3rd Party Plugins]]
{{Infobox_Plugin|
name = FortranProject |
logo = [[File:Generic-plugin.png]] |
developer = Darius Markauskas |
maintainer = |
version = 0.8
}}

FortranProject plugin makes C::B more useful for Fortran programmers. It adds a symbol browser and code completion for Fortran files. Source code and pre-built binaries can be downloaded from the [http://darmar.vgtu.lt Fortran Project homepage] .

==See also==
* [[Installing Fortran Compiler|Installing a Fortran compiler]]

Announcement for plugins/patches

2012-06-04T20:31:09Z

Alpha: Remove CMake link (lexer is now in trunk).

Announcement for plugins/patches

2012-05-20T16:05:49Z

Alpha: More links.

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] (Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc]
* [/index.php/topic,10901.0.html cbNSIS]
* [/index.php/topic,14184.0.html cbvcs]
* [https://github.com/Lalaland/ClangComplete ClangComplete]
* [/index.php/topic,14339.0.html CodePaste]
* [/index.php/topic,15915.0.html CompileOnDemand]
* [/index.php/topic,8568.0.html ColorCoder]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent]
* [/index.php/topic,13348.0.html InnoSetup]
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside]
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor]

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [http://developer.berlios.de/patch/?func=detailpatch&patch_id=3270&group_id=5358 CMake lexer]
* [[d_source File wizard]]
* [[Java lexer]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

FAQ-Compiling (general)

2012-05-11T02:32:13Z

Alpha: Wording.

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: What compiler can I use with Code::Blocks? ====

'''A:''' Code::Blocks philosophy is to be able to use any compiler on earth! Well, almost.

As a matter of fact it largely depends on the used compiler plugin. Some provided with the default Code::Blocks installation are GNU GCC (MinGW/Cygwin), MS Visual C++ Free Toolkit 2003, Borland's C++ Compiler 5.5, DigitalMars Free Compiler., OpenWatcom, Small Device C Compiler (SDCC) and others.

==== Q: My project should be compiled with a custom makefile. Is it possible with Code::Blocks? ====

'''A:''' Yes, you can. You need to change one settings with Code::Blocks 8.02:

In your project's Properties, check "This is a custom makefile".

And that's it! :)

==== Q: I have downloaded MS VC++ Toolkit 2003 for a compiler. How do I tell Code::Blocks that it is my compiler? ====

'''A:''' Click on "Project/Build options" and select the compiler you want for your project/target.

==== Q: Microsoft calls MSVCRT.DLL a "Known DLL." How do I know if I can/should use it? ====

Microsoft does not clearly describe what [http://msdn2.microsoft.com/en-us/library/abx4dbyh.aspx 'Known DLL'] means. A [http://www.zlib.net/DLL_FAQ.txt zLib FAQ entry] makes it much more clear. The short answer is that MSVCRT.DLL is a protected system component and to preserve system integrity it cannot be updated by any end user product installers but may be updated from time to time by system updates. If it works use it. If it doesn't you'll need use a non protected library such as MSVCR70 or MSVCR80 which not only can be updated but private versions can be installed. A small and simple C program is likely to work just fine with MSVCRT.DLL. A large and complex C++ program is more likely to need the additional functionality of MSVCR.

The MSVCRT.LIB that ships with 32 bit compiler Visual C++ Toolkit 2003 dynamically links to MSVCR71.DLL which is not present in a freshly installed Windows XP system. MSVCR only appears after some software package that needs it such as [http://www.adobe.com/ Adobe Acrobat Reader] is installed. This means that programs that depend on MSVCR must redistribute it or risk not working on a substantial percentage of systems for reasons not obvious to either the affected end users or the program supplier.

For projects that can safely use MSVCRT and where it is impractical to redistribute MSVCR, a Win32 MSVCRT.LIB that links to MSVCRT.DLL is available in any [http://www.microsoft.com/whdc/devtools/ddk/default.mspx Device Driver Kit]. It is best to preserve the MSVCRT.LIB provided by the compiler and alter the name of the MSVCRT.LIB extracted from a DDK. List your newly named MSVCRTxx in the lib. If you use MSVCRT.LIB from the Windows 2003 DDK you may encounter the link '''error LNK2001: unresolved external symbol ___security_cookie'''. This can be solved by switching to the MSVCRT.LIB in the Windows XP DDK or by linking '''bufferoverflowU.lib''' found in the Windows SDK. A Win64 MSVCRT.LIB that links to MSVCRT.DLL is available in the Windows SDK or Platform [http://www.microsoft.com/downloads/details.aspx?FamilyId=E15438AC-60BE-41BD-AA14-7F1E0F19CA0D&displaylang=en PSDK].

To prevent problems it is recommended to include both /MD and /NODEFAULTLIB:MSVCRT switches so that problems come up at link time instead of random crashes at run time. Be sure to load your programs into [http://www.dependencywalker.com/ Dependancy Walker] to ensure that functions aren't being linked into both MSVCRxx.DLL and MSVCRT.DLL. It is essential that malloc, calloc, realloc, free, and related memory allocation functions all import from the same DLL.

Source: [http://wiki.tcl.tk/11431 TCL Wiki]

==== Q: How can I use a DLL without DEF or LIB files? ====

'''A:''' I tried to find a solution, and the following script solved the problem for me. I used a cygwin environment for ''tclsh'' and ''sed'', but the MinGW tools for ''objdump'' and ''dlltool''. See here [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

TODO: Someone might add some informations about problems

Request: Is MinGW or Code::Blocks able to support automatic generation of import libraries ?

See also: http://www.mingw.org/wiki/CreateImportLibraries

See also: http://wyw.dcweb.cn/stdcall.htm

==== Q: Where are the libraries for the OpenGL, Ogre3D, SDL, QT, wxWidgets etc. projects? ====

'''A:''' They're not bundled. The templates were provided for your convenience, but you need to download the libraries on your own.
In common terms, "batteries not included" :)

==== Q: Is it possible to use Visual C++ 6.0 with Code::Blocks? ====

'''A:''' Yes. See [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]] for a detailed description on using VC++ 6.0 with Code::Blocks.

==== Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist? ====

'''A:''' You can specify them for your global environment or just for your project.

For global environment : 
- Menu Settings/Compiler and debugger 
- In the Global compiler settings, select the directories tab 
- Add the required paths for compiler and linker. 
 
For your project : 
- Right click on the project then select Build options 
- Select the directories tab 
- Add the required paths for compiler and linker. 
- Add your specific libraries in the linker tab. 
- Pay attention to project settings and target settings.
==== Q: How do I use both Debug and Release builds of wx libraries? ====
'''A:''' I would use the default method of doing it and the default folder naming.

Using these C::B custom varibles
WX_SUFFIX="" // ANSI Release
WX_SUFFIX="d" // ANSI Debug
WX_SUFFIX="u" // Unicode Release
WX_SUFFIX="ud" // Unicode debug

I use WX_CFG when I am using a special configuration
WX_CFG="rc3"

Remember, the CodeBlocks globel variable WX needs to point to the wxWidgets folder.

Example minGW build command for "Unicode debug" 2.8.0 RC3

mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

"VENDOR=" just puts rc3 in the DLL name; "CFG=" sets which folder the DLL is placed in. In this case in lib\gcc_dllrc3

Before using CFG in the mingw32-make build you need to do one prior wxWidget build without using it; else the build errors out. (See note below.)

"__WXDEBUG__" must be defined (in the codeblocks project setting) if you wish to link against the debug version of wxWidgets DLL. Else you will get a runtime error, when you try to run your project output.

Contributed by Tim S

Note:
*I have never gotten the following command to work
mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*unless I have first run this command on the same wxWidgets folders
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*I am guessing that the build without the CFG creates a file or directory needed by the build with the CFG.

==== Q: How do I add version information to windows executables and dll's? ====
'''A:''' You need to create a reosurce file with the extension .rc and write the version info there. Then add that file to the Code::Blocks project you are working on.

Sample content of a resource file that you can use and modify for your needs:
<source lang="cpp" enclose="div">
LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US

VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,0,0,1
PRODUCTVERSION 1,0,0,1
FILEFLAGSMASK 0x3fL // VS_FFI_FILEFLAGSMASK
#ifdef _DEBUG
FILEFLAGS 0x1L // VS_FF_DEBUG|VS_FF_PRIVATEBUILD|VS_FF_PRERELEASE
#else
FILEFLAGS 0x0L // final version
#endif
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
FILESUBTYPE VFT2_UNKNOWN // not used
{
BLOCK "StringFileInfo"
{
BLOCK "040904E4" // Lang=US English, CharSet=Windows Multilingual
{
VALUE "Build", "August 2007\0"
VALUE "Comments", "Free for personal use only.\0"
VALUE "CompanyName", "Fake Company\0"
VALUE "Developer", "The Developer\0"
VALUE "FileDescription", "Application implementing something\0"
VALUE "FileVersion", "1.0.000\0"
VALUE "InternalName", "AppInternalName\0"
VALUE "LegalCopyright", "Copyright (C) 2007 Fake Company\0"
VALUE "LegalTrademarks", "All rights reserved.\0"
VALUE "OriginalFilename", "TheEXE.exe\0"
VALUE "PrivateBuild", "\0"
VALUE "ProductName", "The EXE\0"
VALUE "ProductVersion", "1.0.000\0"
VALUE "SpecialBuild", "\0"
VALUE "Support", "TheEXE at fake-domain.com\0"
VALUE "Users", "Unlimited.\0"
} // BLOCK "040904E4"
} // BLOCK "StringFileInfo"
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x409, 1252 // 1252 = 0x04E4
} // BLOCK "VarFileInfo"
}
</source>

Also you can use the the [[AutoVersioning plugin]] to assist you on the generation of version information. For documentation of the syntax and values used on windows resource files, you can visit the following websites:
*http://msdn2.microsoft.com/en-us/library/aa380599.aspx
*http://www.cygwin.com/cygwin-ug-net/windres.html

==== Q: Code::Blocks does not force relink if the library is changed? ====

'''A:''' Open ''Project->Properties...->Build targets (tab)'' and select the executable. Click ''Dependencies...'' and add the name of the library (including its relative path) to ''External dependency files''. Also see [[The build process of Code::Blocks#Using project dependencies|inter-project dependencies]].

''Example:'' <tt>output\myLibrary\libdostuff.a</tt>

==== Q: How do I report a compilation problem on the forums? ====

'''A:''' Try building the project from command line. If the same error comes up, it is a problem with either the source file, the compiler, or the compiler setup. If this is the case, you are unlikely to receive support for it on the Code::Blocks forums, however, [[FAQ-Compiling (errors)#Q: How do I troubleshoot a compiler problem?|How do I troubleshoot a compiler problem?]] may help.

If it works fine building from command line, it is either a problem with your project, Code::Blocks' setup, or possibly an actual bug. When posting this problem, include the name of your compiler, operating system, Code::Blocks version, compiler log (go to ''Settings->Compiler and debugger...->Build options (tab)'' and check ''Save build log'' and ''Always output the full command line''), and, if it caused Code::Blocks to crash, the <tt>codeblocks.RPT</tt> file (located in the Code::Blocks installation directory).

''Template: Paste the following template into your post, editing the relevant sections.''
I am running Code::Blocks version ''Code::BlocksVersionNumber'' on ''MyOperatingSystem''
(version ''OperatingSystemVersionNumber''). The compiler I use is ''CompilerName''
version ''CompilerVersionNumber''.

When I ...
''Steps to reproduce problem.''

''Description of problem.''
... happens.

Build log:
[code]
''Paste '''full''' build log here.''
[/code]

Crash report:
[code]
''Paste the contents of'' codeblocks.RPT ''here (if Code::Blocks crashed).''
[/code]

''(Although the following is not necessary, showing that you''
''have tried increases the probability of a response.)''
I have already tried ...
''List of attempted solutions.''
... but none of them worked.

==== Q: All of the Build related options are grayed out? ====

'''A:''' Code::Blocks checks the file extension for individual files before allowing them to be compiled. Save your file with the correct file extension (<tt>*.c</tt> or <tt>*.cpp</tt>).

More often it is useful to [[Creating a new project|create a project]] so that Code::Blocks can manage the entire build.

----

Return to '''[[FAQ]]'''.

User documentation

2012-05-10T22:49:13Z

Alpha: Fix link.

[[Category:Code::Blocks Documentation]]
[[Category:User Documentation]]
== Official user document ==
The Official Code::Blocks user document can be found [https://www.codeblocks.org/user-manual here].
* Contributed [http://www.bt4.pl/programy/dla-programistow/code-blocks/ Polish translation].

== Articles for Code::Blocks users ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Application development ==

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

== Compilers ==

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

== User interface development ==


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

== Third-party libraries ==

* [[BoostWindowsQuickRef|Using Boost with Code::Blocks (Windows)]]
* [[Using wxWidgets|Using wxWidgets with Code::Blocks]]
* [[Using SDL with Code::Blocks]]
* [[Using GLFW with Code::Blocks]]
* [[Using Allegro with Code::Blocks]]
* [[Using FreeGlut with Code::Blocks]]
* [http://opencv.willowgarage.com/wiki/CodeBlocks Using OpenCV with Code::Blocks]

== Third-party Applications ==

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

RegEx Testbed plugin

2012-05-02T22:35:10Z

Alpha: Formatting.

[[Category:Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = RegExTestbed |
logo = [[File:Generic-plugin.png]] |
developer = Yiannis Mandravellos |
maintainer = |
version = 0.2
}}

[[wikipedia:Regular expression|Regular expressions]] enable advanced searching and parsing of strings, however, it can be tiresome to continually rebuild a project just to see if a small tweak allowed a regular expression to function properly. '''RegExTestbed''' provides a workspace in which to test out regular expressions instantaneously. See this [http://docs.wxwidgets.org/trunk/overview_resyntax.html#overview_resyntax_syntax wxWidgets documentation] for details on how to form a regular expression.

User documentation

2012-04-20T00:02:41Z

Alpha: Added link.

[[Category:Code::Blocks Documentation]]
[[Category:User Documentation]]
== Official user document ==
The Official Code::Blocks user document can be found [https://www.codeblocks.org/user-manual here].
* Contributed [http://www.beautifulcode.pl/programy/dla-programistow/code-blocks/ Polish translation].

== Articles for Code::Blocks users ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Application development ==

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

== Compilers ==

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

== User interface development ==


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

== Third-party libraries ==

* [[BoostWindowsQuickRef|Using Boost with Code::Blocks (Windows)]]
* [[Using wxWidgets|Using wxWidgets with Code::Blocks]]
* [[Using SDL with Code::Blocks]]
* [[Using GLFW with Code::Blocks]]
* [[Using Allegro with Code::Blocks]]
* [[Using FreeGlut with Code::Blocks]]
* [http://opencv.willowgarage.com/wiki/CodeBlocks Using OpenCV with Code::Blocks]

== Third-party Applications ==

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

HexEditor plugin

2012-04-18T02:01:05Z

Alpha: Spelling.

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = HexEditor |
logo = [[File:Generic-plugin.png]] |
developer = Bartlomiej Swiecki |
maintainer = |
version = 0.5
}}

The '''HexEditor''' plugin opens any selected file in completely editable binary mode. The hexadecimal value as well as the possible ASCII value are displayed. Searching for a specific string within the file is supported.

Editor Tweaks plugin

2012-04-18T01:58:45Z

Alpha: Formatting.

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = EditorTweaks |
logo = [[File:Generic-plugin.png]] |
developer = Damien Moore |
maintainer = |
version = 0.1
}}

The '''EditorTweaks''' plugin contains several different features. On a per-file basis, it controls
* word-wrap
* line-numbers
* ''tab'' key emissions (tab characters or spaces)
* number of spaces the ''tab'' key emits
* end of line characters (carriage-return + linefeed; carriage-return; linefeed)
* visibility of end of line characters
* on-demand striping of trailing white-space
* on-demand synchronization of end of line characters
* ''insert'' key suppression

From the merge with the [[Aligner plugin]], it has the ability to make sections of code more readable by aligning a specific character. For example, aligning the "=" in
<source lang="cpp" enclose="div">
int var = 1;
int longVarName = 2;
int foobar = 3;
</source>
will result in
<source lang="cpp" enclose="div">
int var = 1;
int longVarName = 2;
int foobar = 3;
</source>

Announcement for plugins/patches

2012-04-16T21:48:02Z

Alpha: More links.

Developer documentation

2012-03-26T00:54:33Z

Alpha: Added mirror.

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

'''Mirror''' (Read-only; refreshed every 30 minutes.)
* Subversion URL: <nowiki>svn://cb.biplab.in/codeblocks/trunk</nowiki> 
* Git URL: git://cb.biplab.in/codeblocks.git
}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Plug-In development ==

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

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

* [[wxSmith extensions]]
* [[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]]