Code::Blocks - User contributions [en]

Tools+ reference

2025-03-03T09:15:15Z

Mgimenez: /* Export makefile */ Make link absolute

[[Category: User Documentation]]
=Tool Creation=
[[File:ToolsSetup.png|right]]
Creating a new tool is fairly simple, and can be completed in a few simple steps. First open ''Tools(+)->Configure Tools...'' to access the "User-defined Tools" dialog.
==Tool Name==
This is the name that will be displayed in the Tools(+) drop-down menu. It will also be displayed as the tab name for tools that redirect to the Tools output window.
==Command Line==
Any valid command line function and switches can be placed here. Variable substitution is also accepted. The following list contains the more useful variables; see [[variable expansion]] for the full list.

<code>$relfile</code>,<code>$file</code>: respectively the relative and absolute name of a selected file

<code>$reldir</code>,<code>$dir</code>: respectively the relative and absolute name of a selected directory

<code>$relpath</code>,<code>$path</code>: the relative and absolute name of the selected file or directory

<code>$mpaths</code>: a list of selected files or directories (absolute paths only)

<code>$fname</code>,<code>$fext</code>: the name without extension and the extension without name of a selected file

<code>$inputstr{prompt}</code>: prompts the user to enter a string of text which is substituted into the command line

<code>$if(condition){true clause}{false clause}</code>: resolves to <code>false clause</code> if <code>condition</code> is empty, 0, or false; otherwise <code>true clause</code>
==File Types==
Wildcard expressions separated by semicolons will restrict population of the right click menu of a file, directory, or multiple paths in the Project Tree, File Explorer, or Editor Pane to the specified type(s). Leave blank to handle all file/directory types.
==Working Directory==
The directory from which the command is executed. Code::Blocks variables, project variables, and global variables are available. Also,
# If you have specified <code>$dir</code> in the command line then you can use <code>$dir</code> here also.
# <code>$parentdir</code> is available for <code>$relfile</code>, <code>$file</code>, <code>$reldir</code>, <code>$dir</code>, <code>$relpath</code>, <code>$path</code>, <code>$fname</code>, <code>$fext</code> and is the absolute path of the directory containing the item.
==Tools Menu Path==
[[File:ToolsMenuPath.png|right]]
Controls the placement of the command in the Tools(+) menu, giving the option of adding submenues (multiple levels are allowed).
: Submenu/Tool1
: Submenu/Tool2
: Tool3
Will create this structure.

The command name will be used if this entry is blank. If the first character is a period, the command will be hidden.
==Context Menu Path==
[[File:ToolsContextPath.png|right]]
This controls the command's placement in the right-click menu of the Projects and Files tabs of the Management pane. The same rules of structure with the Tools Menu Path apply here.

Please note that the command will not show up in the context menu unless the Command Line contains one or more of the following: <code>$relfile</code>, <code>$file</code>, <code>$reldir</code>, <code>$dir</code>, <code>$relpath</code>, <code>$path</code>, <code>$fname</code>, and <code>$fext</code>.
==Output to==
This determines where the output of the command will be redirected. The purpose and function of the command will determine which is best to select.
===Tools Output Window===
Tools that only output results command line (and require no input) generally use this setting. The program will be run invisibly and any output will be redirected to the appropriate tab of the Tools Output Window. The text '''<nowiki>[DONE]</nowiki>''' will be added upon the tool's completion.

[[File:ToolOutput.png]]
===Code::Blocks Console===
This will cause the program to be run through the executable '''cb_console_runner''' (the same program that is launched after '''Build and run'''). This is generally used for command line tools with more advanced user interactions, although GUI programs can also be used (especially if the program is unstable and/or also leaves messages in the standard output). Console runner will pause the window (prevent it from closing), display the run time, and the exit code when the program finishes.
===Standard Shell===
This is the same as placing the command in a batch or shell script, then running it. The program will run in whatever its default method is, and when it finishes, its window will close. This setting is useful for running a program (for example a file or web browser) that must remain open after Code::Blocks is closed.
==Notes==
As the Tools+ plugin is not yet complete, some functionality - specifically Menu Priority and Environment Variables - are not available.

If the Tools Output window is open when Code::Blocks is closed, it may trigger Code::Blocks to crash.
=Example Tools=
===Open file browser to selected file===
* Windows Explorer
: <code>explorer /select,"$(PROJECTFILE)"</code> (Tools Menu)
: <code>explorer /select,"$path"</code> (Context Menu)
* Dolphin
: <code>dolphin --select "$(PROJECTFILE)"</code> (Tools Menu)
: <code>dolphin --select "$path"</code> (Context Menu)
''Note: the following three commands Context Menu only support folders (but not files). If you know how to script a conversion to cause ''<code>$path</code>'' or ''<code>$file</code>'' to return the parent directory, please add it here.''
* Nautilus
: <code>nautilus --no-desktop --browser "$(PROJECTDIR)"</code> (Tools Menu)
: <code>nautilus --no-desktop --browser "$dir"</code> (Context Menu)
* Thunar
: <code>thunar "$(PROJECTDIR)"</code> (Tools Menu)
: <code>thunar "$dir"</code> (Context Menu)
* PCMan File Manager
: <code>pcmanfm "$(PROJECTDIR)"</code> (Tools Menu)
: <code>pcmanfm "$dir"</code> (Context Menu)
===Update Subversion directory===
* Windows
: <code>"'''''path_to_svn'''''\bin\svn" update "$inputstr{Directory}"</code> (Tools Menu)
: <code>"'''''path_to_svn'''''\bin\svn" update "$dir"</code> (Context Menu and Tools Menu)
* Linux
: <code>svn update "$inputstr{Directory}"</code> (Tools Menu)
: <code>svn update "$dir"</code> (Context Menu and Tools Menu)
===Export makefile===
''Note: this uses the command line-tool cbp2make. Discussion: ''[https://wiki.codeblocks.org/index.php/topic,13675.0.html]'' Download: ''[https://sourceforge.net/projects/cbp2make/files/]
* Windows
: <code>"'''''path_to_cbp2make'''''\cbp2make" -in "$(PROJECTFILE)"</code> (Tools Menu)
* Linux
: <code>"'''''path_to_cbp2make'''''/cbp2make" -in "$(PROJECTFILE)"</code> (Tools Menu)

===Compress active project to archive===
* Windows
** 7z or zip
: <code>"'''''path_to_7z'''''\7z" a -t$if(zip == $inputstr{7z or zip?}){zip -mm=Deflate -mmt=on -mx9 -mfb=128 -mpass=10}{7z -m0=LZMA -mx9 -md=64m -mfb=64 -ms=on} -sccUTF-8 "-w$(PROJECTDIR).." "$(PROJECTDIR)..\$(PROJECT_NAME)" "$(PROJECTDIR)*"</code> (Tools Menu)
:* tar.gz or tar.bz2 ''(Note: works in ''Tools Output Window'' and ''Standard Shell'', but not ''Code::Blocks Console''.)''
: <code>cmd /c ""'''''path_to_7z'''''\7z" a -ttar -mx0 -sccUTF-8 "-w$(PROJECTDIR).." "$(PROJECTDIR)..\$(PROJECT_NAME)" "$(PROJECTDIR)*" && "'''''path_to_7z'''''\7z" a -t$if(gz == $inputstr{gz or bz2?}){gzip -mx9 -mfb=128 -mpass=10 -sccUTF-8 "-w$(PROJECTDIR).." "$(PROJECTDIR)..\$(PROJECT_NAME).tar.gz}{bzip2 -mmt=on -mx9 -md=900k -mpass=7 -sccUTF-8 "-w$(PROJECTDIR).." "$(PROJECTDIR)..\$(PROJECT_NAME).tar.bz2}" "$(PROJECTDIR)..\$(PROJECT_NAME).tar" && cmd /c del "$(PROJECTDIR)..\$(PROJECT_NAME).tar""</code> (Tools Menu)
* Linux
** 7z or zip
: <code>7z a -t$if(zip == $inputstr{7z or zip?}){zip -mm=Deflate -mmt=on -mx9 -mfb=128 -mpass=10}{7z -m0=LZMA -mx9 -md=64m -mfb=64 -ms=on} -sccUTF-8 "-w$(PROJECTDIR).." "$(PROJECTDIR)../$(PROJECT_NAME)" "$(PROJECTDIR)*"</code> (Tools Menu)
:* tar.gz or tar.bz2
: <code>tar -cf "$(PROJECTDIR)../$(PROJECT_NAME).tar.$if(gz == $inputstr{gz or bz2?}){gz" -I 'gzip}{bz2" -I 'bzip2} -9' "$(PROJECTDIR)*"</code> (Tools Menu)

Code::Blocks command line arguments

2024-11-05T13:18:14Z

Mgimenez: /* Command line arguments */ Add missing arguments and remove duplicated ones

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

=== Windows ===

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

'''Example'''

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

=== *nix ===

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

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

'''Example'''

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

== Command line arguments ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|+
|- style="background: #ececec; border: 1px solid gray"
!
! Argument
! Function
|-
|-
|Windows
|Windows(MSYS2, WSL)
Linux, Unix, MacOS
|
|-
|
|''<filename>''
| Specifies the project *.cbp filename or workspace *.workspace filename. For instance ''<filename>'' may be ''c:\some\where\a\project.cbp''. Place this argument at end of command line, just before output redirection if any.
|-
|-

|-
|'''/h''', '''/?'''
|'''--help''', '''--?'''
| Shows a help message about the command line arguments.
|-
|
|'''--safe-mode'''
|Load in safe mode (all plugins will be disabled).
|-

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

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

|-
|'''/ns'''
|'''--no-splash-screen'''
| Hides the splash screen when the application is loading.
|-
|
|'''--multiple-instance'''
|Allow running multiple instances.
|-

|-
|'''/d'''
|'''--debug-log'''
| Display application's debug log.
|-
|'''/nc'''
|'''--no-crash-handler'''
|Do not use the crash handler (useful for debugging C::B).
|-

|-
|'''/v'''
|'''--verbose'''
| Show more debugging messages.
|-
|
|'''--prefix''='''''<nowiki/>''<str>''
| Sets the shared data directory prefix.
|-

|-
|
|'''--user-data-dir'''=<str>
| Specify an alternative directory for user settings and user installed plugins
|-
|'''/p''' str
|'''--personality='''''<str>'', '''--profile''='''''<nowiki/>''<str>''
| Sets the [[Personalities|personality]] to use. You can use ''ask'' as the parameter to list available personalities.
|-
|
|'''--no-log'''
|Turn off the application log.
|-
|
|'''--log-to-file'''
|Redirect application log to a file.
|-
|
|'''--debug-log-to-file'''
|Redirect application debug log to a file.
|-
|-
|'''/S''' name
|'''--set'''=name
|Set <nowiki>''</nowiki>name<nowiki>''</nowiki> to current active set for global variables (after [r13245]).
|-
|'''/D''' str
|
|If ''str'' = "<set>.uservar.mem=val", set the member ''mem'' of uservariable ''uservar'' in ''set'' to value ''val''. This overrides the current set value (after [r13245]).
|-
|
|'''--rebuild'''
| Clean and build the project / workspace.
|-

|-
|
|'''--build'''
| Build the project / workspace.
|-
|-
|
|'''--clean'''
| Clean the project/workspace
|-
|
|'''--target''='''''<nowiki/>''<str>''
| Sets target for batch build, for example --target="Release".
|-

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

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

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

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

|-
|
|'''--dbg-config'''=<str>
| Selects the debugger config used for attaching.
|-
|-
|-
|
|'''--dbg-attach'''=<str>
|''str'' is passed to debugger plugin which is used for attaching to a process.
|-
|
|'''>''' ''<build log file>''
| Placed in the very last position of command line, this may be used to redirect standard output to log file, this is not a codeblock option as such, but just a DOS/*nix shell usual standard output redirection
|-

|}

Internationalization

2024-10-01T11:08:27Z

Mgimenez: /* Create and use the .mo file */ Enhance intructions

[[Category:Developer Documentation]]

This article is about how to realize and use localized C:B.

Original article written by heromyth.

Reviewed by gd_on.

== Get the English POT file ==

The url of the english POT file is at:

for the '''original site''' (''but obsolete'') : https://translations.launchpad.net/codeblocks/trunk/+pots/codeblocks

or

for a '''new site''' : https://translations.launchpad.net/codeblocks-gd

More information can be seen at: https://forums.codeblocks.org/index.php/topic,10204.msg70638.html.

or :

https://forums.codeblocks.org/index.php/topic,1022.msg159075.html#msg159075

Of course, you can run extract.cmd (shown below) to generate the POT file. It extracts all the text chains from .cpp files and .xrc file, for the main core and the contribs plugins. It also extract strings from compiler's xml files and descriptions fields found in manifest*.xml from plugins. You can place it in a subdirectory of your codeblocks_src (created by svn for example), as src\i18n or a specific src\My_i18n.

This tool uses several unix-like tools as find, rm, grep, xargs, xgettext, msgcat, sed. Some of them are available with many MinGW distributions or Msys2.

'''Note''' : you '''must''' use the unix-like find.exe, ''not'' the Windows one : they have not the same syntax. So, the unix-like find.exe must be found in your PATH, before the Windows one!

The tool wxrc is used in these command files. You can find the source in wxWidgets/utils and build it.

For your convenience, some unix tools (extracted from msys2) and a wxrc.exe (statically linked with wxWidgets 3.2.1, 64 bit) can be downloaded from a git repository [https://github.com/gerard-durand/codeblocks_gd_extract_tools/tree/master/Unix_Tools Unix-Tools]

The content of '''extract.cmd''' is below (or you can download it from a git repository [https://github.com/gerard-durand/codeblocks_gd_extract_tools Extract-Tools] containing a copy of unix tools and wxrc):

rem ======= Begin of extract.cmd =======

echo off
echo ****************************
echo * creating core .pot files *
echo ****************************
echo *
find ../sdk ../src | grep -F .cpp | grep -v svn-base | grep -v .svn | grep -v .cpp.org | xargs xgettext --keyword=_ -o codeblocks1.pot 2> log.txt
find ../sdk ../src ../include | grep -F .h | grep -v svn-base | grep -v .svn | grep -v .h.org | grep -v html | xargs xgettext --keyword=_ -o codeblocks2.pot 2>> log.txt
find ../scripts | grep -F .script | grep -v svn-base | grep -v .svn | xargs xgettext --keyword=_ -o codeblocks3.pot 2>> log.txt
find ../plugins/scriptedwizard/resources | grep -F .script | grep -v svn-base | grep -v .svn | xargs xgettext --keyword=_ -o codeblocks4.pot 2>> log.txt
find codeblocks1.pot > files.txt
find codeblocks2.pot >> files.txt
find codeblocks3.pot >> files.txt
find codeblocks4.pot >> files.txt

find ../plugins | grep -v contrib | grep -F .cpp | grep -v .svn | grep -v svn-base | grep -v .patch | xargs xgettext --keyword=_ -o coreplugins1.pot 2>> log.txt
find ../plugins | grep -v contrib | grep -F .h | grep -v .svn | grep -v svn-base | grep -v html | xargs xgettext --keyword=_ -o coreplugins2.pot 2>> log.txt
find coreplugins1.pot >> files.txt
find coreplugins2.pot >> files.txt

echo *
echo *******************************
echo * creating contrib .pot files *
echo *******************************
echo *

find ../plugins/contrib | grep -F .cpp | grep -v .svn | grep -v svn-base > file_c.txt
find ../plugins/contrib | grep -F .h | grep -v .svn | grep -v svn-base | grep -v html | grep -v .gch >> file_c.txt
xgettext -f file_c.txt --keyword=_ -o contribplugins.pot 2>> log.txt
find contribplugins.pot >> files.txt

echo *
echo ***************************************
echo * creating .cpp files from .xrc files *
echo ***************************************
echo *
find ../src/resources | grep -F .xrc | grep -v .svn | grep -v svn-base | xargs wxrc -g -o src_xrc.cpp 2>> log.txt
find ../sdk/resources | grep -F .xrc | grep -v .svn | grep -v svn-base | xargs wxrc -g -o sdk_xrc.cpp 2>> log.txt
find ../plugins | grep -F .xrc | grep -v .svn | grep -v svn-base | xargs wxrc -g -o plugins_xrc2.cpp 2>> log.txt
REM Why next lines? modifications in recent wxrc? string modif? Only one line (1515) in compiler_options.xrc has a problem, though the same syntax in a previous line (1151) is OK !
sed -i 's/\"Compiling <file>...\"/\\\"Compiling <file>...\\\"/g' plugins_xrc2.cpp
REM Eliminate a truncated string containing only "At ".
sed -i 's/\"else\"/\\\"else\\\"/g' plugins_xrc2.cpp
REM In .xrc files, there is no way to indicate that a string is translatable or not. So those following grep - v try to eliminate some lines.
grep -v msp430x plugins_xrc2.cpp | grep -v dragon_ | grep -v msp430x | grep -v cc430x | grep -v jtag1 | grep -v jtag2 | grep -v jtagm | grep -v atxmega | grep -v atmega | grep -v attiny | grep -v at86 | grep -v at90 | grep -v AT90 | grep -v TC1 > plugins_xrc.cpp

del plugins_xrc2.cpp

echo *
echo *************************************************
echo * creating .pot files from those local new .cpp *
echo *************************************************
echo *
find . | grep -F .cpp | xargs xgettext --keyword=_ -o xrc.pot 2>> log.txt
sed "s/\$\$*/\$/g" xrc.pot > xrc.pox
sed 's/\\\\\\\\/\\\\/g' xrc.pox > xrc.pot
find xrc.pot >> files.txt

REM Extracting strings from files as .xml, .xrc need more work because there is nothing to speify than a string is translatable or not.
REM May also need additionnal filters if the serached string is on several lines.

echo *
echo *************************************************
echo * extracting strings from .xml compilers files *
echo *************************************************
echo *
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "CodeBlocks_compiler name" > src_xml.cpp 2>> log.txt
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "Option name" >> src_xml.cpp 2>> log.txt
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "Category name" >> src_xml.cpp 2>> log.txt
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "checkMessage" >> src_xml.cpp 2>> log.txt
REM In .xml files, there is no way to indicate that a string is translatable or not. So those following grep - v try to eliminate some lines.
grep -v mabi src_xml.cpp | grep -v mno | grep -v apcs | grep -v mtpcs | grep -v mshed | grep -v msoft | grep -v mhard | grep -v mfpe | grep -v msched | grep -v mlong | grep -v mpic | grep -v mcirrus | grep -v mcalle | grep -v mpoke | grep -v mwords | grep -v "MSP430 1" | grep -v "MSP430 2" | grep -v "MSP430 3" | grep -v "MSP430 4" | grep -v "MSP430 5" | grep -v "MSP430 6" | grep -v "MSP430 E" | grep -v "MSP430 W" | grep -v "MSP430 MS" | grep -v "MSP430 G4" | grep -v "CC430 5" | grep -v "CC430 6" | grep -v ATmega | grep -v Atmega | grep -v atmega | grep -v ATXmega | grep -v AT90 | grep -v AT43 | grep -v AT86 | grep -v AT76 | grep -v ATA | grep -v ata | grep -v ATtiny | grep -v Attiny | grep -v attiny | grep -v mcpu | grep -v TC1 > src_xml2.cpp
xgettext -a -o xml.pox src_xml2.cpp
sed "s/"/\\\\""/g" xml.pox > xml1.pot
find xml1.pot >> files.txt

echo *
echo *************************************************"
echo * extracting strings from manifest*.xml files *"
echo *************************************************"
echo *

REM On Windows, the find option -name manifest*.xml is not (still) accepted (msys2 version), so the output is filtered with 2 -F options.

find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs grep -F "title" >> src_xml_title.cpp 2>> log.txt
xgettext -a -s -o xml2_a.pot src_xml_title.cpp
find xml2_a.pot >> files.txt
REM The find for "title" does not work correctly for "description" if the string expands on several lines ! Only the first line is kept => the extracted text is truncated.
REM With the following version, the string begin with "description" line and ends on "author" line => this implies than the order of the fields are the same in all manifests.
REM More, if in manifest*.xml, in the description string, there is a CR/LF, it should be kept in the original string, because even if poedit "complains" the translation takes it into account.
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs sed -n -e "/description/,/>/p" | sed '/author/d' | sed ":a;N;$!ba;s/\n/\\\n/g" | sed 's/""//g' | sed "s/"/\\\\""/g" | sed "s/&/\&/g" > src_xml_desc.cpp 2>> log.txt
xgettext -a -s -o xml2_b.pot src_xml_desc.cpp
find xml2_b.pot >> files.txt

REM for keyword thanksTo
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs sed -n -e "/thanksTo/,/>/p" | sed '/license/d' | sed ":a;N;$!ba;s/\n/\\\n/g" | sed 's/""//g' | sed "s/"/\\\\""/g" | sed "s/&/\&/g" > src_xml_thanks.cpp 2>> log.txt
xgettext -a -s -o xml2_c.pot src_xml_thanks.cpp
find xml2_c.pot >> files.txt

REM for keyword authort: need to modify manifest.xml in wxSmithAUI because author contains characters with accents.
REM Add the = sign to avoid authorEmail and/or authorWeb lines which does not need to be translated
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs sed -n -e "/author=/,/>/p" | sed '/authorEmail/d' | sed ":a;N;$!ba;s/\n/\\\n/g" | sed 's/""//g' | sed "s/"/\\\\""/g" | sed "s/&/\&/g" > src_xml_author.cpp 2>> log.txt
xgettext -a -s -o xml2_d.pot src_xml_author.cpp
find xml2_d.pot >> files.txt

REM for keyword license (single line); include the = sign to be sure that lines containing the word license in a sentence are not kept.
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs grep -F "license=" >> src_xml_lic.cpp 2>> log.txt
xgettext -a -s -o xml2_e.pot src_xml_lic.cpp
find xml2_e.pot >> files.txt

echo *
echo **********************************
echo * Merging and sorting .pot files *
echo **********************************
echo *
msgcat -s -f files.txt -o All_codeblocks.pox 2>> log.txt
rm -f *.pot *.cpp files.txt file_c.txt
sed "s/#, c-format//g" All_codeblocks.pox > All_codeblocks.pot

rm -f *.pox

echo *
echo ***************
echo * The END*!!! *
echo ***************
echo on

rem ======= End of extract.cmd =======

== The tools for translation ==

Usually, we use the poEdit tool which can be downloaded [http://www.poedit.net/download.php here].

Of course, you can do the translation directly on [https://translations.launchpad.net/codeblocks-gd Launchpad].

You'll find on Launchpad, two available downloads : a .po file, that you can use to edit or modify it, and a .mo file, a compiled ready to use in Code::Blocks. It's name may be quite long, but it does not matter. Only the extension is important.

== Translating with poEdit ==

Rename or copy All_codeblocks.pot into All_codeblocks.po. Use poEdit to open the file All_codeblocks.po. Change a few settings like:

[File]->[Preferences]->[Personalize]

[Catalog]->[Settings]->[Project info]->[Team/email/Language/Charset]

If Code::Blocks is compiled with Unicode, the charset should be set to utf-8; If Code::Blocks is compiled with ANSI, the charset should be set to your own language charset like gb2312, koi8-r etc.

After these settings are done, you can start translating. Don't be fooled, it's a long work! During the process, of course, you can use your translation at any time.

You can also download the .po file from Launchpad, work on it with poedit locally on your machine, and re-upload it on Launchpad to update and share your work.

'''Note:''' It may be necessary to approve this work, and sometimes to validate your own translations (or wait for someone else to validate them).

== Create and use the .mo file ==

Pressing Ctrl+S in poEdit, you can get a *.mo file like All_codeblocks.mo which is what we need. To use All_codeblocks.mo, we just place it into C:\Program Files\CodeBlocks\share\CodeBlocks\locale\<lang>\. My language is French and I have installed C::B into C:\, so I place All_codeblocks.mo into C:\Program Files\CodeBlocks\share\CodeBlocks\locale\fr_FR.

If you want to use All_codeblocks.mo under Linux or Unix, you just place it into /usr/X11R6/share/locale/<lang>/LC_MESSAGES/ or in the share/locale/<lang< sub-directory of your codeblocks installation, as in Windows (may be something like /usr/share/codeblocks/locale/<lang> (for me <lang> is fr_FR). Create sub-directories if necessary.

Details about internationalization using wxWidgets can be found in the wxWidgets docs.

You will also need the wxWidgets' *.mo file for your language. Download the *.po file from [https://github.com/wxWidgets/wxWidgets/tree/master/locale here] and generate the *.mo file (using poEdit), or get the *.mo file directly from the wxWidgets' release used when compiling C::B. Copy this file to the folder specified above.

== Let Code::Blocks support your language ==

In Code::Blocks menu, Settings, Environment, View, you'll find a check-box for Internationalization. If you check it, you'll normally find your language in the dropdown list.

Internationalization

2024-10-01T11:06:47Z

Mgimenez: /* Create and use the .mo file */ Remark the wxWidgets' .mo file is also needed

[[Category:Developer Documentation]]

This article is about how to realize and use localized C:B.

Original article written by heromyth.

Reviewed by gd_on.

== Get the English POT file ==

The url of the english POT file is at:

for the '''original site''' (''but obsolete'') : https://translations.launchpad.net/codeblocks/trunk/+pots/codeblocks

or

for a '''new site''' : https://translations.launchpad.net/codeblocks-gd

More information can be seen at: https://forums.codeblocks.org/index.php/topic,10204.msg70638.html.

or :

https://forums.codeblocks.org/index.php/topic,1022.msg159075.html#msg159075

Of course, you can run extract.cmd (shown below) to generate the POT file. It extracts all the text chains from .cpp files and .xrc file, for the main core and the contribs plugins. It also extract strings from compiler's xml files and descriptions fields found in manifest*.xml from plugins. You can place it in a subdirectory of your codeblocks_src (created by svn for example), as src\i18n or a specific src\My_i18n.

This tool uses several unix-like tools as find, rm, grep, xargs, xgettext, msgcat, sed. Some of them are available with many MinGW distributions or Msys2.

'''Note''' : you '''must''' use the unix-like find.exe, ''not'' the Windows one : they have not the same syntax. So, the unix-like find.exe must be found in your PATH, before the Windows one!

The tool wxrc is used in these command files. You can find the source in wxWidgets/utils and build it.

For your convenience, some unix tools (extracted from msys2) and a wxrc.exe (statically linked with wxWidgets 3.2.1, 64 bit) can be downloaded from a git repository [https://github.com/gerard-durand/codeblocks_gd_extract_tools/tree/master/Unix_Tools Unix-Tools]

The content of '''extract.cmd''' is below (or you can download it from a git repository [https://github.com/gerard-durand/codeblocks_gd_extract_tools Extract-Tools] containing a copy of unix tools and wxrc):

rem ======= Begin of extract.cmd =======

echo off
echo ****************************
echo * creating core .pot files *
echo ****************************
echo *
find ../sdk ../src | grep -F .cpp | grep -v svn-base | grep -v .svn | grep -v .cpp.org | xargs xgettext --keyword=_ -o codeblocks1.pot 2> log.txt
find ../sdk ../src ../include | grep -F .h | grep -v svn-base | grep -v .svn | grep -v .h.org | grep -v html | xargs xgettext --keyword=_ -o codeblocks2.pot 2>> log.txt
find ../scripts | grep -F .script | grep -v svn-base | grep -v .svn | xargs xgettext --keyword=_ -o codeblocks3.pot 2>> log.txt
find ../plugins/scriptedwizard/resources | grep -F .script | grep -v svn-base | grep -v .svn | xargs xgettext --keyword=_ -o codeblocks4.pot 2>> log.txt
find codeblocks1.pot > files.txt
find codeblocks2.pot >> files.txt
find codeblocks3.pot >> files.txt
find codeblocks4.pot >> files.txt

find ../plugins | grep -v contrib | grep -F .cpp | grep -v .svn | grep -v svn-base | grep -v .patch | xargs xgettext --keyword=_ -o coreplugins1.pot 2>> log.txt
find ../plugins | grep -v contrib | grep -F .h | grep -v .svn | grep -v svn-base | grep -v html | xargs xgettext --keyword=_ -o coreplugins2.pot 2>> log.txt
find coreplugins1.pot >> files.txt
find coreplugins2.pot >> files.txt

echo *
echo *******************************
echo * creating contrib .pot files *
echo *******************************
echo *

find ../plugins/contrib | grep -F .cpp | grep -v .svn | grep -v svn-base > file_c.txt
find ../plugins/contrib | grep -F .h | grep -v .svn | grep -v svn-base | grep -v html | grep -v .gch >> file_c.txt
xgettext -f file_c.txt --keyword=_ -o contribplugins.pot 2>> log.txt
find contribplugins.pot >> files.txt

echo *
echo ***************************************
echo * creating .cpp files from .xrc files *
echo ***************************************
echo *
find ../src/resources | grep -F .xrc | grep -v .svn | grep -v svn-base | xargs wxrc -g -o src_xrc.cpp 2>> log.txt
find ../sdk/resources | grep -F .xrc | grep -v .svn | grep -v svn-base | xargs wxrc -g -o sdk_xrc.cpp 2>> log.txt
find ../plugins | grep -F .xrc | grep -v .svn | grep -v svn-base | xargs wxrc -g -o plugins_xrc2.cpp 2>> log.txt
REM Why next lines? modifications in recent wxrc? string modif? Only one line (1515) in compiler_options.xrc has a problem, though the same syntax in a previous line (1151) is OK !
sed -i 's/\"Compiling <file>...\"/\\\"Compiling <file>...\\\"/g' plugins_xrc2.cpp
REM Eliminate a truncated string containing only "At ".
sed -i 's/\"else\"/\\\"else\\\"/g' plugins_xrc2.cpp
REM In .xrc files, there is no way to indicate that a string is translatable or not. So those following grep - v try to eliminate some lines.
grep -v msp430x plugins_xrc2.cpp | grep -v dragon_ | grep -v msp430x | grep -v cc430x | grep -v jtag1 | grep -v jtag2 | grep -v jtagm | grep -v atxmega | grep -v atmega | grep -v attiny | grep -v at86 | grep -v at90 | grep -v AT90 | grep -v TC1 > plugins_xrc.cpp

del plugins_xrc2.cpp

echo *
echo *************************************************
echo * creating .pot files from those local new .cpp *
echo *************************************************
echo *
find . | grep -F .cpp | xargs xgettext --keyword=_ -o xrc.pot 2>> log.txt
sed "s/\$\$*/\$/g" xrc.pot > xrc.pox
sed 's/\\\\\\\\/\\\\/g' xrc.pox > xrc.pot
find xrc.pot >> files.txt

REM Extracting strings from files as .xml, .xrc need more work because there is nothing to speify than a string is translatable or not.
REM May also need additionnal filters if the serached string is on several lines.

echo *
echo *************************************************
echo * extracting strings from .xml compilers files *
echo *************************************************
echo *
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "CodeBlocks_compiler name" > src_xml.cpp 2>> log.txt
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "Option name" >> src_xml.cpp 2>> log.txt
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "Category name" >> src_xml.cpp 2>> log.txt
find ../plugins/compilergcc/resources/compilers | grep -F .xml | xargs grep -F "checkMessage" >> src_xml.cpp 2>> log.txt
REM In .xml files, there is no way to indicate that a string is translatable or not. So those following grep - v try to eliminate some lines.
grep -v mabi src_xml.cpp | grep -v mno | grep -v apcs | grep -v mtpcs | grep -v mshed | grep -v msoft | grep -v mhard | grep -v mfpe | grep -v msched | grep -v mlong | grep -v mpic | grep -v mcirrus | grep -v mcalle | grep -v mpoke | grep -v mwords | grep -v "MSP430 1" | grep -v "MSP430 2" | grep -v "MSP430 3" | grep -v "MSP430 4" | grep -v "MSP430 5" | grep -v "MSP430 6" | grep -v "MSP430 E" | grep -v "MSP430 W" | grep -v "MSP430 MS" | grep -v "MSP430 G4" | grep -v "CC430 5" | grep -v "CC430 6" | grep -v ATmega | grep -v Atmega | grep -v atmega | grep -v ATXmega | grep -v AT90 | grep -v AT43 | grep -v AT86 | grep -v AT76 | grep -v ATA | grep -v ata | grep -v ATtiny | grep -v Attiny | grep -v attiny | grep -v mcpu | grep -v TC1 > src_xml2.cpp
xgettext -a -o xml.pox src_xml2.cpp
sed "s/"/\\\\""/g" xml.pox > xml1.pot
find xml1.pot >> files.txt

echo *
echo *************************************************"
echo * extracting strings from manifest*.xml files *"
echo *************************************************"
echo *

REM On Windows, the find option -name manifest*.xml is not (still) accepted (msys2 version), so the output is filtered with 2 -F options.

find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs grep -F "title" >> src_xml_title.cpp 2>> log.txt
xgettext -a -s -o xml2_a.pot src_xml_title.cpp
find xml2_a.pot >> files.txt
REM The find for "title" does not work correctly for "description" if the string expands on several lines ! Only the first line is kept => the extracted text is truncated.
REM With the following version, the string begin with "description" line and ends on "author" line => this implies than the order of the fields are the same in all manifests.
REM More, if in manifest*.xml, in the description string, there is a CR/LF, it should be kept in the original string, because even if poedit "complains" the translation takes it into account.
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs sed -n -e "/description/,/>/p" | sed '/author/d' | sed ":a;N;$!ba;s/\n/\\\n/g" | sed 's/""//g' | sed "s/"/\\\\""/g" | sed "s/&/\&/g" > src_xml_desc.cpp 2>> log.txt
xgettext -a -s -o xml2_b.pot src_xml_desc.cpp
find xml2_b.pot >> files.txt

REM for keyword thanksTo
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs sed -n -e "/thanksTo/,/>/p" | sed '/license/d' | sed ":a;N;$!ba;s/\n/\\\n/g" | sed 's/""//g' | sed "s/"/\\\\""/g" | sed "s/&/\&/g" > src_xml_thanks.cpp 2>> log.txt
xgettext -a -s -o xml2_c.pot src_xml_thanks.cpp
find xml2_c.pot >> files.txt

REM for keyword authort: need to modify manifest.xml in wxSmithAUI because author contains characters with accents.
REM Add the = sign to avoid authorEmail and/or authorWeb lines which does not need to be translated
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs sed -n -e "/author=/,/>/p" | sed '/authorEmail/d' | sed ":a;N;$!ba;s/\n/\\\n/g" | sed 's/""//g' | sed "s/"/\\\\""/g" | sed "s/&/\&/g" > src_xml_author.cpp 2>> log.txt
xgettext -a -s -o xml2_d.pot src_xml_author.cpp
find xml2_d.pot >> files.txt

REM for keyword license (single line); include the = sign to be sure that lines containing the word license in a sentence are not kept.
find ../plugins | grep -F manifest | grep -F .xml | grep -v svn-base | grep -v .svn | xargs grep -F "license=" >> src_xml_lic.cpp 2>> log.txt
xgettext -a -s -o xml2_e.pot src_xml_lic.cpp
find xml2_e.pot >> files.txt

echo *
echo **********************************
echo * Merging and sorting .pot files *
echo **********************************
echo *
msgcat -s -f files.txt -o All_codeblocks.pox 2>> log.txt
rm -f *.pot *.cpp files.txt file_c.txt
sed "s/#, c-format//g" All_codeblocks.pox > All_codeblocks.pot

rm -f *.pox

echo *
echo ***************
echo * The END*!!! *
echo ***************
echo on

rem ======= End of extract.cmd =======

== The tools for translation ==

Usually, we use the poEdit tool which can be downloaded [http://www.poedit.net/download.php here].

Of course, you can do the translation directly on [https://translations.launchpad.net/codeblocks-gd Launchpad].

You'll find on Launchpad, two available downloads : a .po file, that you can use to edit or modify it, and a .mo file, a compiled ready to use in Code::Blocks. It's name may be quite long, but it does not matter. Only the extension is important.

== Translating with poEdit ==

Rename or copy All_codeblocks.pot into All_codeblocks.po. Use poEdit to open the file All_codeblocks.po. Change a few settings like:

[File]->[Preferences]->[Personalize]

[Catalog]->[Settings]->[Project info]->[Team/email/Language/Charset]

If Code::Blocks is compiled with Unicode, the charset should be set to utf-8; If Code::Blocks is compiled with ANSI, the charset should be set to your own language charset like gb2312, koi8-r etc.

After these settings are done, you can start translating. Don't be fooled, it's a long work! During the process, of course, you can use your translation at any time.

You can also download the .po file from Launchpad, work on it with poedit locally on your machine, and re-upload it on Launchpad to update and share your work.

'''Note:''' It may be necessary to approve this work, and sometimes to validate your own translations (or wait for someone else to validate them).

== Create and use the .mo file ==

Pressing Ctrl+S in poEdit, you can get a *.mo file like All_codeblocks.mo which is what we need. To use All_codeblocks.mo, we just place it into C:\Program Files\CodeBlocks\share\CodeBlocks\locale\<lang>\. My language is French and I have installed C::B into C:\, so I place All_codeblocks.mo into C:\Program Files\CodeBlocks\share\CodeBlocks\locale\fr_FR.

If you want to use All_codeblocks.mo under Linux or Unix, you just place it into /usr/X11R6/share/locale/<lang>/LC_MESSAGES/ or in the share/locale/<lang< sub-directory of your codeblocks installation, as in Windows (may be something like /usr/share/codeblocks/locale/<lang> (for me <lang> is fr_FR). Create sub-directories if necessary.

Details about internationalization using wxWidgets can be found in the wxWidgets docs.

You will also need the wxWidgets' *.mo file for your language. Download the *.po file from [https://github.com/wxWidgets/wxWidgets/tree/master/locale here] and generate the *.mo file (using poEdit), or get the *.mo file directly from the wxWidgets' release used when compiling C::B.

== Let Code::Blocks support your language ==

In Code::Blocks menu, Settings, Environment, View, you'll find a check-box for Internationalization. If you check it, you'll normally find your language in the dropdown list.

Installing Code::Blocks from source on Windows

2024-01-02T13:10:58Z

Mgimenez: /* wxWidgets */ Fix typo

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

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

=== Utilities ===

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

==== ZIP ====

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

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T09:43:28Z

Mgimenez: /* Generate Production Output */ Remark src must be the current directory when running update

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

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

=== Utilities ===

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

==== ZIP ====

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

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T09:39:58Z

Mgimenez: /* Open project */ Remark instructions are valid for wx3.2

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

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

=== Utilities ===

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

==== ZIP ====

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

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T09:35:30Z

Mgimenez: /* wxWidgets */ Specify minimal wx supported version

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

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

=== Utilities ===

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

==== ZIP ====

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

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T09:32:09Z

Mgimenez: /* ZIP */ Remark that some toolchains include zip.exe

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

At this moment the latest wxWidgets stable release is 3.2.4, download it in [https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.4/wxWidgets-3.2.4.zip zip] or [https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.4/wxWidgets-3.2.4.7z 7z] format.

=== Utilities ===

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

==== ZIP ====

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

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T09:29:26Z

Mgimenez: /* wxWidgets */ Update links and wxWidgets version

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

At this moment the latest wxWidgets stable release is 3.2.4, download it in [https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.4/wxWidgets-3.2.4.zip zip] or [https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.4/wxWidgets-3.2.4.7z 7z] format.

=== Utilities ===

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

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T08:33:53Z

Mgimenez: /* Configure Build Options */ Remove colon

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

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

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T08:32:08Z

Mgimenez: /* Code::Blocks Sources */ Remove colon

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

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

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T08:30:02Z

Mgimenez: /* MinGW Compiler */ Remove colon

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

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

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2024-01-02T08:29:16Z

Mgimenez: /* Bootstrap Code::Blocks */ Remove colon

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

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

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Installing Code::Blocks from source on Windows

2023-12-13T08:35:00Z

Mgimenez: /* Configure Build Options */ Removed misleading information about 64-bit compilation

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

=== Self-Hosting ===

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

== Prerequisites ==

=== Bootstrap Code::Blocks ===

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

=== MinGW Compiler ===

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

=== wxWidgets ===

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

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

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

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

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

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

==== SVN ====

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

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

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

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

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

==== TortoiseSVN ====

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

[[Image:Tor_SVN.png]]

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

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

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

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

== Build wxWidgets Support Library ==

=== Configure Build Options ===

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

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

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

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

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

=== Build wxWidgets Library ===

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

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

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

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

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

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

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

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

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

== Build Code::Blocks ==

=== Self-Hosting ===

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

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

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

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

[[Image:Compiler_Settings.png]]

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

[[Image:Unused_Local_Typedefs.png]]

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

[[Image:Compile_All.png]]

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

[[Image:Build_Log.png]]

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

[[Image:Update_Devel_Output.png]]

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

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

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

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

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

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

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

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

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

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

Compiling wxWidgets (MSW) 2.8.12 on Windows using makefile.gcc

2023-11-16T15:30:07Z

Mgimenez: Mention Direct2D and newer wxWidgets versions.

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

The same instructions are valid for newer versions of wxWidgets, just replace 2.8.12 with the version you are using (p.e. 3.2.3).

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

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

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

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

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

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

'''NOTE:''' If you intend to compile C::B itself with this wxWidgets version then you must edit <WXWIN>\include\wx\msw\setup_0.h (or setup.h if the former does not exist), locate the line defining wxUSE_GRAPHICS_DIRECT2D and change the assigned value to 1. Do not start compilation before changing this or you will waste a lot of time fixing this.

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

'''NOTE:''' the <code>/D</code> flag after <code>cd</code> may be omitted from all commands; it simply allows command prompt to change drives if necessary.

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

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

Now clean up the source:
mingw32-make -f makefile.gcc MONOLITHIC=1 SHARED=1 UNICODE=1 BUILD=release clean
'''NOTE:''' Make sure you use exactly the same options for this step and for the build step below. The clean target uses these variables and only cleans the specified version of the generated object and library files. (It will not clean the intended files if these variables are not identical.)

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

When everything is clean you can start compiling wxWidgets:
mingw32-make -f makefile.gcc MONOLITHIC=1 SHARED=1 UNICODE=1 BUILD=release

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

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

== Errors while building wxWidgets ==
Navigate to the folder build/msw inside wxWidgets directory. In this folder is a text file named config.gcc which you can edit with notepad to control the build options. There are two lines to note, CFLAGS ?= and CXXFLAGS ?=. The options given here will go in either or both of those lines.

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

If your compiler errors out, usually referencing monotree.dll or similar:

-D_WIN32_IE=0x0603

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

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

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

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

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

Managing Plug-in Resources

2023-11-16T15:16:14Z

Mgimenez: /* Prerequisites */ CHange text also

[[Category:Plugin development]]

==Prerequisites==

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

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

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

==Overview==

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

==Plugin File Structure==

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

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

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

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

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

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

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

1. Select file -> new -> project

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

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

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

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

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

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

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

==Working with XML Based wxWidgets Resources==

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

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

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

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

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

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

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

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

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

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

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

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

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

7. Select wxSmith -> Add panel

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

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

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

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

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

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

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

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

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

[[File:Prewiew.png]]

17. Close the wxSmith editor.

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

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

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

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

TODO: wxWidgets links for more info

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CONTENT COMING SOON

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

CONTENT COMING SOON

==Working with Extra Files==

MORE CONTENT COMING SOON...

==Further Information==

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

Managing Plug-in Resources

2023-11-16T15:14:48Z

Mgimenez: /* Prerequisites */ Change link from 2.8.6 to to 2.8.12

[[Category:Plugin development]]

==Prerequisites==

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

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

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

==Overview==

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

==Plugin File Structure==

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

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

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

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

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

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

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

1. Select file -> new -> project

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

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

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

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

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

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

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

==Working with XML Based wxWidgets Resources==

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

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

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

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

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

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

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

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

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

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

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

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

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

7. Select wxSmith -> Add panel

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

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

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

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

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

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

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

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

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

[[File:Prewiew.png]]

17. Close the wxSmith editor.

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

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

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

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

TODO: wxWidgets links for more info

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CONTENT COMING SOON

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

CONTENT COMING SOON

==Working with Extra Files==

MORE CONTENT COMING SOON...

==Further Information==

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

Installing Code::Blocks

2023-11-13T14:35:39Z

Mgimenez: /* Mac OS X */ Added information about Macports working with all versions

[[Category:Installing Code::Blocks]]
__TOC__
* [[Compiled packages of Code::Blocks]]

== MS Windows ==

* [[Installing the latest official version of Code::Blocks on Windows]]
* [[Installing Code::Blocks nightly build on Windows]]
* [[Installing Code::Blocks from source on Windows]]

== Linux ==

* [[Installing Code::Blocks from source on Linux]] (applies to all distros)

=== Ubuntu ===

:* [[Installing Code::Blocks nightly build on Ubuntu]]

=== Debian ===

:* [http://apt.jenslody.de/ Installing Code::Blocks nightly build on Debian]

=== Fedora ===

:* [[Installing Code::Blocks nightly build on Fedora]]

=== Blag ===

:* [[Installing Code::Blocks nightly build on Blag]]

=== Gentoo ===

:* [[Installing Code::Blocks from source on Gentoo]]

=== Platypux ===

:* [[Installing Code::Blocks with LZM binary on Platypux]]

=== Arch Linux ===

:* [[Installing Code::Blocks from source on Arch Linux]]

=== Mageia 7 ===

:* [[Installing Code::Blocks from source on Mageia 7]]

=== RPM based distributions ===

Such as: Red Hat Linux, Yellow Dog Linux, Fedora Core, CentOS, etc. etc.

:* [[Installing Code::Blocks nightly build on RPM based distributions]]
:* [[Installing Code::Blocks from source on RPM based distributions]]

== BSD ==

=== FreeBSD ===

:* [[Installing Code::Blocks from source on FreeBSD]]

=== OpenBSD ===
:* http://openports.se/devel/codeblocks

== Solaris ==

* [[Installing Code::Blocks from source on Solaris]]

== Mac OS X ==

* [[Installing the latest official version of Code::Blocks on Mac OS X]]

* [[Installing Code::Blocks nightly build on Mac OS X]]

* [[Installing Code::Blocks from source on Mac OS X]]

You can use also use [https://www.macports.org/ Macports] to install Code::Blocks on MacOS X upto Sonoma.

== Derivatives ==

* [http://codeblocks.codecutter.org/ Code::Blocks EDU-Portable] - portable installation configured for learners and instructors of C/C++.

* [http://darmar.vgtu.lt/ Code::Blocks IDE for Fortran] - additional features for Fortran oriented programmers.

==Working on Code::Blocks sources from within Code::Blocks!==

The following applies for all platforms where you have Code::Blocks installed and working.

After correct install of Code::Blocks you will find two folders under .../trunk/src , one named "devel30" and another one named "output30" (the number depends on wxWidgets version).

These two folders will contain the same files and directory structure and you can use the IDE from either of these two directories. This structure has been created so that you can work in Code::Blocks while editing Code::Blocks' sources ;).

Basically, you'll be using the "output30/CodeBlocks.exe" executable. Code::Blocks' project settings are such that all output goes under "devel30", so you can edit Code::Blocks' sources inside Code::Blocks and, when pressing "Run", it will run the "devel30/CodeBlocks.exe" executable ;). This way, you can't ruin the main executable you're using (under "output30"). When your changes satisfy you and all works well, quit Code::Blocks, open a console, change to the src directory and run "update30.bat" (Windows) or "./update30" (Linux) from command line. Then re-launch "output30/CodeBlocks.exe". You'll be working on your brand new IDE!.

Compiler file

2023-05-26T09:53:33Z

Mgimenez: /* See also */ Make link absolute

[[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 you do not have a <Search envVar= then the compiler auto detection code will not set the masterpath and cause compiler issues.

(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]]
* [https://forums.codeblocks.org/index.php/topic,16463.0.html XML based compilers]

Off-site documentation

2023-03-20T13:06:02Z

Mgimenez: /* General */

[[Category: Code::Blocks Documentation]]
This page is for links to '''off-site documentation''' i.e. information that has not yet been (or cannot be) added to the Wiki but exists in the Web.

== General ==

* French programming site, [http://loulou.developpez.com Developpez.com], has a [http://loulou.developpez.com/tutoriels/cpp/codeblocks/ tutorial about using Code::Blocks] (French only, [http://translate.google.com/translate?u=http%3A%2F%2Floulou.developpez.com%2Ftutoriels%2Fcpp%2Fcodeblocks%2F&langpair=fr%7Cen&hl=en&ie=UTF-8&oe=UTF-8&prev=%2Flanguage_tools English translation] by Google Translate).

* [http://www.sci.brooklyn.cuny.edu/~goetz/codeblocks/ Instruction manual for Code::Blocks] by the Dept. of Computer and Information Science of Brooklyn College of CUNY.

* [http://onilink.byethost18.com/?tag=codeblocks Introduction to C++] - beginning C++ with Code::Blocks.

* [https://github.com/arnholm/cross-pi Cross-compiling with Code::Blocks for Raspberry PI.] - write-up and scripts to set up cross compilation with Code::Blocks from Ubuntu.

* [https://github.com/PBfordev/wxpbguide PB’s Guide to Starting with wxWidgets on Microsoft Windows with MinGW and Code::Blocks]

* [https://sourceforge.net/p/codeblocks-gd-user-manual/code/ci/master/tree/htmlweb/manual_codeblocks_en.pdf Gerard Durand's user manual for Code::Blocks], available also in [https://sourceforge.net/p/codeblocks-gd-user-manual/code/ci/master/tree/htmlweb/manual_codeblocks_fr.pdf french]

* [https://github.com/arnholm/cpde_utils/blob/master/doc/toolchain/CodeBlocks_MSVC2019_setup.pdf Configuring MSVC2019 in Code::Blocks] by Carsten Arnholm.

Off-site documentation

2023-03-20T13:05:31Z

Mgimenez: /* General */ Added MSVC2019 setup guide

WxSmith tutorial: Accessing items in resource

2022-12-30T13:03:34Z

Mgimenez: /* Setting Up the Form */ Clarify growable property usage

[[Category:wxSmith Documentation]]
= Accessing Components in a Form =

Welcome to the next tutorial. This time I'll show you how to access items in a resource. I'll show you some basics - for example how to read data from text boxes, change labels, and some more advanced things like changing colours and fonts while the application is running. As usual we will start with an empty application. You shouldn't have any problems with it - all instructions are in the first tutorial.

== Setting Up the Form ==

In this tutorial we will work on items so let's add some:

[[Image:wxs_tut06_001.png]]

In this form, there is a wxBoxSizer, and in it a wxPanel, and on the panel, a wxFlexGridSizer with 2 columns, both growable (to achieve this enter “0,1” (without the quotes) in the Growable Cols property of the sizer, indicating columns 0 and 1). The following array shows which widgets are where in the window.
<pre>
wxStaticText wxButton
wxTextCtrl wxButton
wxGauge wxButton
wxStaticText wxSlider
wxStaticText wxButton
</pre>

All widgets and the wxPanel behind them have their Expand property checked.

Here is what we want to make the buttons do:
*The button in the first row will change the text in the static text left of it.
*The button in the second row will read whatever text the user has written into the TextCtrl left of it and display that text in a message box.
*The button in the third row will advance the gauge to the left of it by one tenth of the distance across the gauge, thus simulating a typical progress bar.
*Moving the slider in the fourth row will change the size of the font in the static text just left of it.
* A click on the button in the bottom row will allow the user to change the color of the text in the StaticText control just left of it.

== Accessing Components through their Member Functions ==

If you add an item to the form in the editor, in most cases wxSmith will add a new member variable into the form's C++ class. All those members are listed in the header file, in our present case, the file ''Tutorial_6Main.h''. They are between wxSmith's special comments: ''//(*Declarations...'' and ''//*)''. The list should look like this:

<pre>
...
class Tutorial_6Frame: public wxFrame
{
...

//(*Declarations(Tutorial_6Frame)
wxSlider* Slider1;
wxButton* Button4;
wxStaticText* StaticText2;
wxButton* Button1;
wxGauge* Gauge1;
wxStaticText* StaticText1;
wxStaticText* StaticText3;
wxButton* Button2;
wxButton* Button3;
wxStatusBar* StatusBar1;
wxTextCtrl* TextCtrl1;
//*)
...
};
...
</pre>
Each component which has such a member variable will also have the following properties:
* '''Var name''' - name of the used variable
* '''Is member''' - switch whether this item should be accessible through a class member variable

So if you want to change the name used to access the item, '''Var name''' is the right property to change.

wxSmith forces a few restrictions on variable names. The most obvious is that each variable name must be a valid C++ identifier, so you cannot use special characters or even spaces. Another limitation is that variable names must be unique.

If the name is invalid, wxSmith will automatically replace it with a name that matches the criteria.

== Changing the Label in wxStaticText ==

Let's do a basic exercise. When we click the “Change label” button, we want the program to change the label of the first wxStaticText control to “Label changed”. To make it do so, double click on the button to generate an event handler and change the code to the following:

<pre>
void Tutorial_6Frame::OnButton1Click(wxCommandEvent& event)
{
StaticText1->SetLabel(_("Label changed"));
Layout();
}
</pre>

In the first line of the function body, we used the '''SetLabel()''' function to change the text of the label. Because the length of the text changes, we must recalculate positions, which is done by calling the '''Layout()''' function.

Static items (those which can't be changed by the user) usually have two functions: GetLabel and SetLabel which read and write content presented by this item.

You may wonder why we used some weird notation for the string:
_("Label changed")
instead of a simple
"Label changed"

There are two advantages of this device:
* By adding _(...) around our string we prepare our application for the translation process. wxWidgets can help in developing multi-language applications. When a translation is being made, wxWidgets will automatically search for the translation of the phrase "Label changed" in a database of equivalent strings in the source and target languages.

* wxWidgets may be provided in two versions: with Unicode support and without it (ANSI build). In the case of a Unicode version, we would have to use Unicode strings: '''L"Label changed"''' and in case of the ANSI version we would have to use standard string notation: '''"Label changed"'''. Using the '''_(...)''' macro insures that no matter what wxWidgets version is used, it will always produce the proper code.

There's an alternative version of the string macro which works similarly to _(...) which is written in the form _T(...) or wxT(...). It works like the _() one but the string is never translated.

== Reading the Value from wxTextCtrl ==

Now let's read something that's written by the user. We will use the wxTextCtrl (with variable TextCtrl1) for this and show the text using a standard message box. Let's double click the '''Read text''' button and change the code to the following:

<pre>
void Tutorial_6Frame::OnButton2Click(wxCommandEvent& event)
{
wxString Text = TextCtrl1->GetValue();
wxMessageBox(_("User entered text:\n") + Text);
}
</pre>

In the first line, we read the value from the TextCtrl and store it in a variable called Text and of the type wxString. wxString is the wxWidgets implementation of a string class and this library uses it as a base for string representation.

In the second line, we call the '''wxMessageBox''' function which shows a standard message box just as if it were a modal dialog.

Usually items which provide content entered by the user have two member functions: GetValue and SetValue. You can use them to read and write the content of such items.

== Changing the value of wxGauge ==

Now let's combine reading and writing of a component's value in one function. We will use wxGauge for this. We will use it's two member functions: GetValue and SetValue. I've written earlier that those functions usually exist in items where the user can enter some value. Well, that rule is not without exceptions as we will now see as we write the handler for the third button. Double click the button and fill in the handler as follows:

void Tutorial_6Frame::OnButton3Click(wxCommandEvent& event)
{
int NewValue = Gauge1->GetValue()+10;
if ( NewValue > 100 ) NewValue = 0;
Gauge1->SetValue(NewValue);
}

In the first line, we generate a new progress value by reading the current one and adding 10 to it. In the second line, we prevent the value from getting out of range. (By default, wxGauge has a range set to 0...100. These values can be changed in the Properties browser.) In the third line, we write the new value into the gauge.

== Using the Value from wxSlider to Change Font Size ==

Now let's do something more advanced. In our resource there is a wxSlider and text saying that it changes font size. We will change the font of this label. But we will have to update the font size in two steps:

* As long as the user drags the slider we should change the font size only
* When the user finishes dragging we should layout the window because the size of the text changes

wxSlider provides two events that can be used precisely for this purpose. The first is '''EVT_COMMAND_SCROLL_THUMB_TRACK''' which is fired while dragging the slider. The second is '''EVT_COMMAND_SCROLL_THUMB_RELEASE''' which is fired when the user finishes dragging.

Because we are using events which are not default for the slider, double clicking on the slider will not work -- as it did with buttons -- to create a frame for the handler. We have to add the two handlers through the Properties browser. You can switch between editing standard properties and editing events by clicking on buttons at the top of browser:

[[Image:wxs_tut06_002.png]].

When you have switched to events, search for the required events and choose '''Add new handler''' from the drop-down list.

Here's the code for the '''EVT_COMMAND_SCROLL_THUMB_TRACK''' handler:

void Tutorial_6Frame::OnSlider1CmdScrollThumbTrack(wxScrollEvent& event)
{
wxFont Font = StaticText2->GetFont();
Font.SetPointSize( Slider1->GetValue() );
StaticText2->SetFont(Font);
}

Here we get the font used by the StaticText control by using the '''GetFont()''' function, change the font's size by using '''SetPointSize()''' and write the font back by using the '''SetFont()''' function. '''GetFont()''' and '''SetFont()''' are available for most components.

Now let's code '''EVT_COMMAND_SCROLL_THUMB_RELEASE''':

void Tutorial_6Frame::OnSlider1CmdScrollThumbRelease(wxScrollEvent& event)
{
Layout();
GetSizer()->SetSizeHints(this);
}

In the first line, we adapt the positions of items to the new font size just as in the case of changing the label in wxStaticText. In the second line, we recalculate the minimal size of the window making sure that all items will have enough space.

(''Use Panel1.GetSizer()->SetSizeHints(this);for the second line in the above statement, where Panel1 is the name of the base panel in your frame.The original code, rather than resize to the new required size, just resizes to the original, default size.[[User:Ensnarer|Ensnarer]] 03.08.2015'')

== Changing a Component's Color ==

The last thing we will do in this tutorial is to change the color of some item. As in the case of fonts we will change the label on the left side of the '''Change''' button. Since we will use the standard event of this button, we can add an event handler by double-clicking on it. And here's the code:

void Tutorial_6Frame::OnButton4Click(wxCommandEvent& event)
{
wxColour OldColour = StaticText3->GetForegroundColour();
wxColour NewColour = wxGetColourFromUser(this,OldColour);

if ( NewColour.IsOk() )
{
StaticText3->SetForegroundColour(NewColour);
Refresh();
}
}

(wxWidets originated in Edinburgh and therefore uses some quaint spellings going back to Anglo-Norman times.) At the beginning we read the current color into the variable '''OldColour'''. In the next line, we call the '''wxGetColourFromUser''' function which opens a dialog where the user can choose a colour.

At the end, we set the new colour by using the '''SetForegroundColour''' function. Refresh is needed to change colour after setting it.

If, however, you try to compile this code, you will get an error message telling you that wxGetColourFromUser() is an unknown function. Since we put it in manually, we must also put in manually its header. So open the Tutorial_6Main.h file and add #include <wx/colordlg.h>.

The NewColour.IsOk() call is used because if the user cancels the colour selection it will return false.
But on the Ubuntu Linux 11.10 installation of wxWidgets, the wxColour class did not have an IsOk() funtion, so in fact you must remove this call. According to wxWidgets documentation, the wxColour class '''does''' indeed have the IsOk() member function, but it was not found.

== More information ==

We've reached the end of this tutorial. I showed only a few operations on typical components; there is much more you can do. For more details you can check wxWidgets' documentation available [http://www.wxwidgets.org/manuals/stable/wx_contents.html here].

----

<center>'''[[WxSmith tutorial: Using wxPanel resources|Previous]] | [[WxSmith tutorials|Index]] | [[WxSmith tutorial: Creating items with custom paint and mouse handling|Next]]'''</center>

Main Page

2022-12-27T20:19:25Z

Mgimenez: Further clarifying

__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 edit pages, you must create an account on the [https://forums.codeblocks.org/ forums] and authenticate there. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

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


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

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

|-

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

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


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

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


|-

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

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


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

|-

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

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

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


|}
</div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Main Page

2022-12-27T20:18:35Z

Mgimenez: Clarify login process

__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 [https://forums.codeblocks.org/ forums] and authenticate there. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

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


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

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

|-

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

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


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

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


|-

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

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


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

|-

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

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

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


|}
</div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Main Page

2022-12-27T19:48:20Z

Mgimenez: Make forum URL absolute

__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 [https://forums.codeblocks.org/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

 
}}

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


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

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

|-

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

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


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

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


|-

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

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


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

|-

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

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

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


|}
</div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Off-site documentation

2022-12-26T19:57:06Z

Mgimenez: /* General */ Add links to PB's guide and gd_on's user manual

FAQ-Issues and Workarounds

2022-12-26T19:45:54Z

Mgimenez: /* Q: I cannot find any text in my Code::Blocks logs? */ Make forum URL absolute

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

----

==== Q: Sometime, in the text editor, space bar triggers Code Completion, how do I fix that? ====

'''A:''' '''The problem is solved in the version 12.11.'''

On Ubuntu 12.04 LTS, version 10.05 from the official repos makes this space bar problem, upgrading to codeblocks 12.11 solved the problem.

For earlier versions, there are (at least) 3 working fixes :
* [[#setxkbmap_Solution: | setxkbmap]]
* [[#Hal_Solution_.28Ubuntu_8.10_and_above.29: | Hal]]
* [[#setxkbmap_Solution: | xorg.conf]]

Information found [/index.php/topic,8291.0.html on the forum]

===== ''setxkbmap Solution:'' =====

run this command before running Code::Blocks (works fines for KUbuntu)
setxkbmap -option nbsp:none
if it's not enough you can try:
setxkbmap -option nbsp:none -model pc 105 -layout fr -variant latin 9

===== ''Hal Solution (Ubuntu 8.10 and above):'' =====

Note : Hal is now [https://wiki.ubuntu.com/Halsectomy deprecated]

For Ubuntu (and other gnome desktops), another simple solution for the current user is to change a preference.
# Menu System => Preferences => Keyboard
# Select Tab Layout
# Edit "Layout Options..."
# Expand last option "Using space key to input non-breakable space character"
# Select the last choice "Usual Space at any level"
This is not system wide.

A system wide solution would be to add an fdi file there (for instance)
/etc/hal/fdi/policy/99-x11-key_space_fix.fdi
put the right thing in it (I did not succeed), unplug your keyboard, plug it again.

===== ''Xorg Solution (prior Hal based distrib):'' =====

as root, edit /etc/X11/xorg.conf and find something like :

Section "InputDevice"
Identifier "Generic Keyboard"
Driver "kbd"
...
Option "XkbVariant" "oss"
EndSection

Try one of the following workarounds :

1. you comment the line
Option "XkbVariant" "oss"
like this
# Option "XkbVariant" "oss"

2. you replace
"XkbVariant" "oss"
with
"XkbVariant" "latin9"

This works for Ubuntu '''prior 8.10''' (before hal)

It seems that KUbuntu requires the following line:
Option "XkbOptions" "nbsp:none"

==== Q: IDE is drawing the text from Right to Left? ====

'''A:''' Uncheck "Settings -> Environment -> View -> Internationalization" and restart Code::Blocks

==== Q: All the options in the debug menu are grayed out? ====

'''A:''' Code::Blocks can only use integrated debugging on an active project. Start a [[Creating a new project|new project]] and [[Creating a new project#Adding a pre-existing file|add the file]] to it. Also see [[debugging with Code::Blocks]].

''Note: Code::Blocks currently only supports the GNU GDB and MSVC CDB debuggers.''

==== Q: My project works everywhere except one computer? ====

'''A:''' Some parts of Code::Blocks or the back-end compiler may not support non-ASCII characters (such as é) or possibly spaces. Try moving the project on the affected computer to a directory that contains neither of these in its path.

==== Q: Syntax highlighting is broken; how do I fix it? ====

'''A:''' Code::Blocks cannot know how to highlight your code unless it knows what lexer to use. This is normally automatically determined by the file extension, so it is important to save the file and name it correctly (for example, <tt>*.c</tt> or <tt>*.cpp</tt> for C and C++ code). It is also possible to activate syntax highlighting on a temporary basis. Open ''Edit->Highlight mode'' and select the language the current file is using. Alternatively add the extension to the lexer configuration in the editor options. This will permanently apply the chosen syntax highlighting for all files with this extension.

==== Q: I posted on the forums that Code::Blocks was not working, but no one could help me? ====

'''A:''' There is a distinct lack of crystal balls and divining mirrors here, so you may want to post some information. Using this [[FAQ-Compiling (general)#Q: How do I report a compilation problem on the forums?|template]] in your problem description would be a great help.

==== Q: I cannot find any text in my Code::Blocks logs? ====

'''A:''' On MS Windows, wxWidgets sometimes does not show the content of logs at first; scrolling in the log will bring the text to visibility. Please note that this is a known wxWidgets bug in wxWidgets v2.8.x. See more details in [https://forums.codeblocks.org/index.php/topic,15940.msg108421.html#msg108421 refresh issue in wx2.8.12]

==== Q: Scrolling causes gray areas/distortions to obscure my code in the editor? ====

'''A:''' This has been a reported problem, sometimes occurring on Ubuntu (and its derivatives). There are several actions that seem to resolve the issue.

* Install all the newest updates from Update Manager.
* Reset Unity.
: <tt>unity --reset</tt>
* Reload compiz by switching to metacity, then back to compiz.

==== Q: I cannot type a greater-than '>' sign? ====

'''A:''' The keyboard shortcut ''Ctrl-Alt-.'' is known to occasionally conflict with this.

Open ''Settings->Editor...->Keyboard shortcuts''. The command ''Ctrl-Alt-.'' is assigned to ''Menu bar->Search->Open include file'' by default. Changing or removing this shortcut should resolve the problem.

==== Q: Using Code::Blocks with high dpi screens and windows ====

'''A:''' https://forums.codeblocks.org/index.php/topic,21119.msg145906.html#msg145906

----

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

FAQ-Issues and Workarounds

2022-12-26T19:44:56Z

Mgimenez: /* Q: Using Code::Blocks with high dpi screens and windows */ Make URL absolute

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

----

==== Q: Sometime, in the text editor, space bar triggers Code Completion, how do I fix that? ====

'''A:''' '''The problem is solved in the version 12.11.'''

On Ubuntu 12.04 LTS, version 10.05 from the official repos makes this space bar problem, upgrading to codeblocks 12.11 solved the problem.

For earlier versions, there are (at least) 3 working fixes :
* [[#setxkbmap_Solution: | setxkbmap]]
* [[#Hal_Solution_.28Ubuntu_8.10_and_above.29: | Hal]]
* [[#setxkbmap_Solution: | xorg.conf]]

Information found [/index.php/topic,8291.0.html on the forum]

===== ''setxkbmap Solution:'' =====

run this command before running Code::Blocks (works fines for KUbuntu)
setxkbmap -option nbsp:none
if it's not enough you can try:
setxkbmap -option nbsp:none -model pc 105 -layout fr -variant latin 9

===== ''Hal Solution (Ubuntu 8.10 and above):'' =====

Note : Hal is now [https://wiki.ubuntu.com/Halsectomy deprecated]

For Ubuntu (and other gnome desktops), another simple solution for the current user is to change a preference.
# Menu System => Preferences => Keyboard
# Select Tab Layout
# Edit "Layout Options..."
# Expand last option "Using space key to input non-breakable space character"
# Select the last choice "Usual Space at any level"
This is not system wide.

A system wide solution would be to add an fdi file there (for instance)
/etc/hal/fdi/policy/99-x11-key_space_fix.fdi
put the right thing in it (I did not succeed), unplug your keyboard, plug it again.

===== ''Xorg Solution (prior Hal based distrib):'' =====

as root, edit /etc/X11/xorg.conf and find something like :

Section "InputDevice"
Identifier "Generic Keyboard"
Driver "kbd"
...
Option "XkbVariant" "oss"
EndSection

Try one of the following workarounds :

1. you comment the line
Option "XkbVariant" "oss"
like this
# Option "XkbVariant" "oss"

2. you replace
"XkbVariant" "oss"
with
"XkbVariant" "latin9"

This works for Ubuntu '''prior 8.10''' (before hal)

It seems that KUbuntu requires the following line:
Option "XkbOptions" "nbsp:none"

==== Q: IDE is drawing the text from Right to Left? ====

'''A:''' Uncheck "Settings -> Environment -> View -> Internationalization" and restart Code::Blocks

==== Q: All the options in the debug menu are grayed out? ====

'''A:''' Code::Blocks can only use integrated debugging on an active project. Start a [[Creating a new project|new project]] and [[Creating a new project#Adding a pre-existing file|add the file]] to it. Also see [[debugging with Code::Blocks]].

''Note: Code::Blocks currently only supports the GNU GDB and MSVC CDB debuggers.''

==== Q: My project works everywhere except one computer? ====

'''A:''' Some parts of Code::Blocks or the back-end compiler may not support non-ASCII characters (such as é) or possibly spaces. Try moving the project on the affected computer to a directory that contains neither of these in its path.

==== Q: Syntax highlighting is broken; how do I fix it? ====

'''A:''' Code::Blocks cannot know how to highlight your code unless it knows what lexer to use. This is normally automatically determined by the file extension, so it is important to save the file and name it correctly (for example, <tt>*.c</tt> or <tt>*.cpp</tt> for C and C++ code). It is also possible to activate syntax highlighting on a temporary basis. Open ''Edit->Highlight mode'' and select the language the current file is using. Alternatively add the extension to the lexer configuration in the editor options. This will permanently apply the chosen syntax highlighting for all files with this extension.

==== Q: I posted on the forums that Code::Blocks was not working, but no one could help me? ====

'''A:''' There is a distinct lack of crystal balls and divining mirrors here, so you may want to post some information. Using this [[FAQ-Compiling (general)#Q: How do I report a compilation problem on the forums?|template]] in your problem description would be a great help.

==== Q: I cannot find any text in my Code::Blocks logs? ====

'''A:''' On MS Windows, wxWidgets sometimes does not show the content of logs at first; scrolling in the log will bring the text to visibility. Please note that this is a known wxWidgets bug in wxWidgets v2.8.x. See more details in [/index.php/topic,15940.msg108421.html#msg108421 refresh issue in wx2.8.12]

==== Q: Scrolling causes gray areas/distortions to obscure my code in the editor? ====

'''A:''' This has been a reported problem, sometimes occurring on Ubuntu (and its derivatives). There are several actions that seem to resolve the issue.

* Install all the newest updates from Update Manager.
* Reset Unity.
: <tt>unity --reset</tt>
* Reload compiz by switching to metacity, then back to compiz.

==== Q: I cannot type a greater-than '>' sign? ====

'''A:''' The keyboard shortcut ''Ctrl-Alt-.'' is known to occasionally conflict with this.

Open ''Settings->Editor...->Keyboard shortcuts''. The command ''Ctrl-Alt-.'' is assigned to ''Menu bar->Search->Open include file'' by default. Changing or removing this shortcut should resolve the problem.

==== Q: Using Code::Blocks with high dpi screens and windows ====

'''A:''' https://forums.codeblocks.org/index.php/topic,21119.msg145906.html#msg145906

----

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

Installing a supported compiler

2022-11-17T06:52:24Z

Mgimenez: /* MinGW/GCC */ Make link to forum absolute

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

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

== Compiler-neutral setup steps ==

Before using a compiler with Code::Blocks you have to install it. The method for installing the compiler depends on the Operating system you're using, the Compiler you intend to use and so on.
If you installed the compiler on its default installation directory, there is nothing more to configure (if the compiler is natively supported by Code::Blocks). Launch Code::Blocks and you're all set :)

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

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

== Windows ==

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

At the time of this writing, Code::Blocks supports the following compilers in Windows:
* [http://www.mingw.org MinGW GCC C/C++ Free Compiler, including GFortran]
** [http://www.cygwin.org Cygwin GCC C/C++ Free Compiler]
*** [[#HOWTO: Use Cygwin 1.7 with Code::Blocks|HOWTO: Use Cygwin 1.7 with Code::Blocks]]
* [http://www.ti.com/tool/msp430-gcc-opensource MSP430 GCC C/C++]
* [http://www.hightec-rt.com/en/downloads/evaluation-version.html TriCore GCC C/C++]
* [http://www.hightec-rt.com/en/downloads/evaluation-version.html PowerPC GCC C/C++]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.digitalmars.com/ Digital Mars Free C/C++ Compiler]
* [http://www.digitalmars.com/d/2.0/dmd-windows.html Digital Mars D Compiler for Windows]
These compilers are generally still under active development by their publishers, so a new version of their software could be released that is incompatible with the current version of Code::Blocks.

The following compilers are still supported by Code::Blocks, but are no longer available from their original publishers.
* Microsoft's Visual C++ 2003 - 2010
* Borland's C/C++ Free Compiler 5.5

The following publishers have released newer versions of their compilers which should be tested against the current configuration. In other words, it is not known yet whether these compilers still work with Code::Blocks.

* [http://www.openwatcom.org/download.php OpenWatcom Free C/C++ Compiler]
* [https://software.intel.com/en-us/c-compilers/ipsxe Intel C/C++ Compiler] 

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

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

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

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

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

==== HOWTO: Use Cygwin 1.7 with Code::Blocks ====
Cygwin 1.7 changed the way symlinks were created and handled when invoked from a command prompt. I couldn't find a way to force CB to use a unix-link shell, but was able to find a work around when perusing the Cygwin mailing lists.

The symptom would show up with a message similar to the one below:

Execution of 'g++.exe -Wall -fexceptions -g -c c:/dev/code/cb1/main.cpp -o obj/Debug/main.o' in 'c:\dev\code\cb1' failed.

Executing the same command from the CMD.EXE prompt yields an "Access is denied" message. This was how I was able to track down why the issue occurred. For more info, see this cygwin mailing list thread: http://www.mail-archive.com/cygwin@cygwin.com/msg104088.html

'''Solution'''

The solution is to point your compiler and linker directly to the version of gcc and g++ that you want to use.

In my case, I wanted to use gcc-4.exe and g++-4.exe and so, I went into Settings->Compiler and Debugger->Toolchain executables. There I changed the "C Complier", "C++ Compiler" and "Linker for dynamic libs" to point to gcc-4.exe, g++-4.exe and g++-4.exe.

After this, compilation and linking worked fine.

It would also be a good idea to add an environment variable CYGWIN with a value of nodosfilewarning in Settings->Environment->Environment Variables. This eliminates the following (harmless) warning message:

MS-DOS style path detected: c:/
Preferred POSIX equivalent is: /c
CYGWIN environment variable option "nodosfilewarning" turns off this warning.
Consult the user's guide for more details about POSIX paths:
http://cygwin.com/cygwin-ug-net/using.html#using-pathnames

See also: [[Installing Cygwin Compiler]]

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

Packages required (suggested) for TDM's GCC/mingw32 Builds v4.4.1-tdm-2 SJLJ:
...which can be found here: [http://sourceforge.net/projects/tdm-gcc/files/] under: TDM-GCC 4.4 series -> 4.4.1-tdm-2 SJLJ.
* Compiler:
** gcc-4.4.1-tdm-2-core.zip
** gcc-4.4.1-tdm-2-g++.zip
* Components:
** binutils-2.19.1-mingw32-bin.tar.gz
** gdb-6.8-mingw-3.tar.bz2
** mingw32-make-3.81-20080326-3.tar.gz
** mingwrt-3.16-mingw32-dev.tar.gz
** mingwrt-3.16-mingw32-dll.tar.gz
** w32api-3.13-mingw32-dev.tar.gz
These packages are included in both the [http://sourceforge.net/projects/tdm-gcc/files/TDM-MinGW%20Installer/1.908.0/tdm-mingw-1.908.0-4.4.1-2.exe/download Bundled Installer] and the [http://sourceforge.net/projects/tdm-gcc/files/TDM-MinGW%20Installer/1.908.0/tdm-mingw-1.908.0-webdl.exe/download On-Demand Installer] available via TDMs page referenced above for users who do not wish to download and install them manually.

=== Embarcadero C++ Compiler BCC32C ===
Formerly Borland's C++ Compiler, this compiler is now published by Embarcadero, with active on-going development; the current version is 10.1 as of this writing. Go to [https://www.embarcadero.com/free-tools/ccompiler their product download page] to download. You will be asked to enter some registration information (registration is free) then the download will begin. You will receive a ZIP archive which contains installation instructions in a text file in the root directory of the archive; it does not have an installer program.

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

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

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

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

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

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

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

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

=== Digital Mars D Compiler for Windows ===
Now Digital Mars D Compiler (DMD) supports 32bit Windows, and in future it will support 64bit Windows.
If you want to build D program in CodeBlocks on 32bit Windows, please following the instructions as bellow.

1). Install DMD(2.0) into your Windows system.

You should correctly combine the DMD compiler and install it into your system. Please view the instructions on digitalmars.com website.
DMD for Windows http://www.digitalmars.com/d/2.0/dmd-windows.html

The newest DMD2 source you can get here: https://github.com/D-Programming-Language

2). Settings in CodeBlocks.

You should add correct DMD pathes into CodeBlocks '''Global compiler settings'''

2.1). "Settings -> Compiler and debugger settings" and choose compiler to "'''Digital Mars D Compiler'''";
2.2). click "Compiler settings -> Other options", add '''-m32''' into the field;
2.3). click "Linker settings", and add "'''D:\Program\DMD2\windows\lib\phobos.lib'''" into the "Link libraries";
2.4). click "Search directories -> Compiler", and add "'''D:\Program\DMD2\src\phobos'''" into the field;
2.5). click "Search directories -> Linker", and add "'''D:\Program\DMD2\windows\lib'''" into the field;
2.6). click "Toolchain executables", add "'''D:\Program\DMD2\windows'''" into the "Compiler's installation directory" filed;
(if you installed DMD2 correctly acc. to Installation setp, just click 'Auto-detect' button.)
2.7). Additional: If you wan to specify the DMC (Digital Mars C/C++ Compiler) you can do like this:
click "Toolchain executables -> Additional Paths", and add "D:\Program\DMC\bin" into the field.

The "D:\Program\DMD2" or "D:\Program\DMC\bin" here should change to your own DMD or DMC path in your system.

3). Testing D program in CodeBlocks.

In CodeBlocks, produce a '''D Application''' project, and input your own D code into the .d file in the project, then '''build/run'''.

== Linux ==

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

===Digital Mars D Compiler for Linux===
Now Digital Mars D Compiler (DMD) supports 32bit and 64bit Linux, and 'support Linux library' is under construction. If you want to build D program in CodeBlocks on 32bit and 64bit Linux, please following the instructions as bellow.

1). Install DMD(2.0) into your Linux system.

You should correctly combine the DMD compiler and install it into your system. Please view the instructions on digitalmars.com website.
DMD for Linux http://www.digitalmars.com/d/2.0/dmd-linux.html

The newest DMD2 source you can get here:
https://github.com/D-Programming-Language

2). Settings in CodeBlocks.

A). 32bit Linux & 32bit DMD2.

On 32bit Linux, you should combine 32bit DMD2 from DMD2 source and install it into your system.

You should add correct DMD pathes into CodeBlocks '''Global compiler settings'''.

A.1). "Settings -> Compiler and debugger settings" and choose compiler to "'''Digital Mars D Compiler'''";
A.2). click "Compiler settings -> Other options", add '''-m32''' into the field.
A.3). click "Linker settings", and add "'''/opt/dmd2/linux/lib32/libphobos2.a'''" into the "Link libraries".
A.4). click "Search directories -> Compiler", and add "'''/opt/dmd2/src/phobos'''" into the field.
A.5). click "Search directories -> Linker", and add "'''/opt/dmd2/linux/lib32'''" into the field.
A.6). click "Toolchain executables", add "'''/opt/dmd2/linux'''" into the "Compiler's installation directory" filed.
A.7). change the value of "Program Files -> Linker for dynamic libs" to "'''gcc -m32 -lrt'''" or "'''gcc -lrt'''".

If you installed DMD2 to a different path, please modify "/opt/dmd2" to your own DMD2 path.

B1). 64bit Linux & '''64bit DMD2'''.

On 64bit Linux, you can combine 64bit DMD2 from DMD2 source and install it into your system.

You should add correct DMD paths into CodeBlocks '''Global compiler settings'''.

B1.1). "Settings -> Compiler and debugger settings" and choose compiler to "'''Digital Mars D Compiler'''";
B1.2). click "Compiler settings -> Other options", add '''-m64''' into the field.
B1.3). click "Linker settings", and add "'''/opt/dmd2/linux/lib64/libphobos2.a'''" into the "Link libraries".
B1.4). click "Search directories -> Compiler", and add "'''/opt/dmd2/src/phobos'''" into the field.
B1.5). click "Search directories -> Linker", and add "'''/opt/dmd2/linux/lib64'''" into the field.
B1.6). click "Toolchain executables", add "'''/opt/dmd2/linux'''" into the "Compiler's installation directory" filed.
B1.7). change the value of "Program Files -> Linker for dynamic libs" to "'''gcc -m64 -lrt'''" or "'''gcc -lrt'''".

If you installed DMD2 to a different path, please modify "/opt/dmd2" to your own DMD2 path.

B2). 64bit Linux with '''32bit DMD2'''.

On 64bit Linux, you can combine 32bit DMD2 with 64bit together from DMD2 source and install them into your system.

You should add correct DMD paths into CodeBlocks '''Global compiler settings'''.

B2.1). "Settings -> Compiler and debugger settings" and choose compiler to "'''Digital Mars D Compiler'''";
B2.2). click "Compiler settings -> Other options", add '''-m32''' into the field.
B2.3). click "Linker settings", and add "'''/opt/dmd2/linux/lib32/libphobos2.a'''" into the "Link libraries".
B2.4). click "Search directories -> Compiler", and add "'''/opt/dmd2/src/phobos'''" into the field.
B2.5). click "Search directories -> Linker", and add "'''/opt/dmd2/linux/lib32'''" into the field.
B2.6). click "Toolchain executables", add "'''/opt/dmd2/linux'''" into the "Compiler's installation directory" filed.
B2.7). change the value of "Program Files -> Linker for dynamic libs" to "'''gcc -m32 -lrt'''".

If you installed DMD2 to a different path, please modify "/opt/dmd2" to your own DMD2 path.

3). Testing D program in CodeBlocks.

In CodeBlocks, produce a '''D Application''' project, and input your own D code into the .d file in the project, then '''build/run'''.

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

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

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

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

Under Mac you'll need to install a ''compatible'' version Xcode Tools from http://developer.apple.com/tools/ (or http://developer.apple.com/downloads). You need the "Command Line Tools".

This will install Apple versions of:

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

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

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

=== Setting up compiler switches ===

Usually you need to tweak the compiler options to be able to compile C++ applications - that's the stuff Xcode hides from your eyes, but you better should know. You need to point to the GNU compiler's C/C++ include folders, to the GNU linkers libraries folder and a adjust the compiler options to setup the GNU compiler root path. Those path's differ depending on what hardware (processor architecture) and what version of MacOS is used. For an Intel based Mac with MacOS 10.6.2 and Xcode v3.2.2 the following should work:

Compiler search directories ("include" folders):

<code>
/Developer/SDKs/MacOSX10.6.sdk/usr/include
</code>

<code>
/Developer/SDKs/MacOSX10.6.sdk/usr/include/c++/4.2.1
</code>

Linker search directories ("library" folders):

<code>
/Developer/SDKs/MacOSX10.6.sdk/usr/lib
</code>

<code>
/Developer/SDKs/MacOSX10.6.sdk/usr/lib/gcc/i686-apple-darwin10/4.2.1
</code>

Additional compiler flags:

<code>
-isysroot /Developer/SDKs/MacOSX10.6.sdk -mmacosx-version-min=10.6 -gdwarf-2
</code>

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

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

== Misc. Custom Compilers ==
There are several user contributions for different (non-C/C++) compiler which are listed here:

https://wiki.codeblocks.org/index.php?title=User_documentation#Compilers

Developer documentation

2022-11-13T11:07:17Z

Mgimenez: Make link to forum absolute

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

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

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

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

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

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

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

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

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

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

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

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

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

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [https://forums.codeblocks.org/index.php/topic,16096.msg128152.html#msg128152 Re: Read-only Git, SVN Repo for Code::Blocks], also stahta01 has a nice instruction about how to use git, see [https://forums.codeblocks.org/index.php/topic,19533.msg133422.html#msg133422 Development How to use a Code::Blocks Git Repo].

If you want to create a SVN style patch from git, see: [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530 This forum post].

== Debugging C::B ==

* When C::B crashes, it will generate a call-stack file "codeblocks.RPT", at the crash point (see [[FAQ-Compiling_(general)#Q: How do I report a compilation problem on the forums?|this]] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface that works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

File formats description

2022-10-28T06:03:35Z

Mgimenez: Make forum URL absolute

[[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 [https://forums.codeblocks.org/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)

Creating a patch to submit (Patch Tracker)

2022-09-05T11:56:49Z

Mgimenez: /* Patch creation */ Link format

[[Category:Developer Documentation]]
== Introduction ==
Do 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 [https://forums.codeblocks.org/index.php/board,20.0.html nightly builds] of Code::Blocks. 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 [https://forums.codeblocks.org forum] for advice.

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 [https://www.codeblocks.org/downloads/7 here]. 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 [https://forums.codeblocks.org/index.php/board,7.0.html development 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>

''Note: if you use Powershell on Windows, the generated file can not be used directly because it will be in UTF-16 format. Use Notepad++ to reencode in ANSI or generate it again using this command:''
: <tt>svn diff | out-file -encoding ascii 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 following [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530 these steps] or one of the following commands:
: <tt>git diff --no-prefix > my.patch</tt>
: <tt>svn patch my.patch --strip 1</tt>

=== Patch application and testing ===
Most Subversion front-end UI tools (like TortoiseSVN or SmartSVN) have an option to apply this patch files directly.

If you are using svn version ≥ 1.7.0, the command:
:<tt>svn patch my.patch</tt>

...will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

If you only need the command line without SVN tooling (why would you do so?), then 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>

'''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 "Tickets" section ([https://sourceforge.net/p/codeblocks/tickets/?source=navbar Tickets]) of the Code::Blocks project page. Click on "Submit A Patch" and fill out the form that appears. For now you only need to select a category for your patch, a '''descriptive''' summary and the patch itself. Make sure you enable the checkbox "Upload Patch" and provide the patch file you've just created. Then you are ready for submission - click on the "Submit patch" button on the bottom of the page.

You should now see the current list of patches with your patch at the top. Please note you can add additional comments or updates to your patch by simply clicking on the patch in the list and fill out the form that appears.

'''Thank you very much for your submission!'''

Creating a patch to submit (Patch Tracker)

2022-09-05T11:52:01Z

Mgimenez: /* What is required? */ Fix link format

[[Category:Developer Documentation]]
== Introduction ==
Do 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 [https://forums.codeblocks.org/index.php/board,20.0.html nightly builds] of Code::Blocks. 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 [https://forums.codeblocks.org forum] for advice.

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 [https://www.codeblocks.org/downloads/7 here]. 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 [https://forums.codeblocks.org/index.php/board,7.0.html development 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>

''Note: if you use Powershell on Windows, the generated file can not be used directly because it will be in UTF-16 format. Use Notepad++ to reencode in ANSI or generate it again using this command:''
: <tt>svn diff | out-file -encoding ascii 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 [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530<nowiki>] or one of</nowiki>
: <tt>git diff --no-prefix > my.patch</tt>
: <tt>svn patch my.patch --strip 1</tt>

=== Patch application and testing ===
Most Subversion front-end UI tools (like TortoiseSVN or SmartSVN) have an option to apply this patch files directly.

If you are using svn version ≥ 1.7.0, the command:
:<tt>svn patch my.patch</tt>

...will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

If you only need the command line without SVN tooling (why would you do so?), then 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>

'''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 "Tickets" section ([https://sourceforge.net/p/codeblocks/tickets/?source=navbar Tickets]) of the Code::Blocks project page. Click on "Submit A Patch" and fill out the form that appears. For now you only need to select a category for your patch, a '''descriptive''' summary and the patch itself. Make sure you enable the checkbox "Upload Patch" and provide the patch file you've just created. Then you are ready for submission - click on the "Submit patch" button on the bottom of the page.

You should now see the current list of patches with your patch at the top. Please note you can add additional comments or updates to your patch by simply clicking on the patch in the list and fill out the form that appears.

'''Thank you very much for your submission!'''

Creating a patch to submit (Patch Tracker)

2022-09-05T11:50:55Z

Mgimenez: /* Patch creation */ Fix link format

[[Category:Developer Documentation]]
== Introduction ==
Do 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 [https://forums.codeblocks.org/index.php/board,20.0.html nightly builds] of Code::Blocks. 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 [https://forums.codeblocks.org forum] for advice.

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 [https://forums.codeblocks.org/index.php/board,7.0.html development 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>

''Note: if you use Powershell on Windows, the generated file can not be used directly because it will be in UTF-16 format. Use Notepad++ to reencode in ANSI or generate it again using this command:''
: <tt>svn diff | out-file -encoding ascii 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 [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530<nowiki>] or one of</nowiki>
: <tt>git diff --no-prefix > my.patch</tt>
: <tt>svn patch my.patch --strip 1</tt>

=== Patch application and testing ===
Most Subversion front-end UI tools (like TortoiseSVN or SmartSVN) have an option to apply this patch files directly.

If you are using svn version ≥ 1.7.0, the command:
:<tt>svn patch my.patch</tt>

...will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

If you only need the command line without SVN tooling (why would you do so?), then 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>

'''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 "Tickets" section ([https://sourceforge.net/p/codeblocks/tickets/?source=navbar Tickets]) of the Code::Blocks project page. Click on "Submit A Patch" and fill out the form that appears. For now you only need to select a category for your patch, a '''descriptive''' summary and the patch itself. Make sure you enable the checkbox "Upload Patch" and provide the patch file you've just created. Then you are ready for submission - click on the "Submit patch" button on the bottom of the page.

You should now see the current list of patches with your patch at the top. Please note you can add additional comments or updates to your patch by simply clicking on the patch in the list and fill out the form that appears.

'''Thank you very much for your submission!'''

Creating a patch to submit (Patch Tracker)

2022-09-05T11:47:34Z

Mgimenez: /* Introduction */ Make links to forum absolute

[[Category:Developer Documentation]]
== Introduction ==
Do 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 [https://forums.codeblocks.org/index.php/board,20.0.html nightly builds] of Code::Blocks. 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 [https://forums.codeblocks.org forum] for advice.

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 ([https://forums.codeblocks.org/index.php/board,7.0.html<nowiki>]) for support.</nowiki>

''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>

''Note: if you use Powershell on Windows, the generated file can not be used directly because it will be in UTF-16 format. Use Notepad++ to reencode in ANSI or generate it again using this command:''
: <tt>svn diff | out-file -encoding ascii 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 [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530<nowiki>] or one of</nowiki>
: <tt>git diff --no-prefix > my.patch</tt>
: <tt>svn patch my.patch --strip 1</tt>

=== Patch application and testing ===
Most Subversion front-end UI tools (like TortoiseSVN or SmartSVN) have an option to apply this patch files directly.

If you are using svn version ≥ 1.7.0, the command:
:<tt>svn patch my.patch</tt>

...will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

If you only need the command line without SVN tooling (why would you do so?), then 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>

'''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 "Tickets" section ([https://sourceforge.net/p/codeblocks/tickets/?source=navbar Tickets]) of the Code::Blocks project page. Click on "Submit A Patch" and fill out the form that appears. For now you only need to select a category for your patch, a '''descriptive''' summary and the patch itself. Make sure you enable the checkbox "Upload Patch" and provide the patch file you've just created. Then you are ready for submission - click on the "Submit patch" button on the bottom of the page.

You should now see the current list of patches with your patch at the top. Please note you can add additional comments or updates to your patch by simply clicking on the patch in the list and fill out the form that appears.

'''Thank you very much for your submission!'''

Creating a patch to submit (Patch Tracker)

2022-09-04T19:55:48Z

Mgimenez: /* Patch creation */ Explain why some MSW-generated patch files are ignored silently when patching

[[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 ([https://forums.codeblocks.org/index.php/board,7.0.html<nowiki>]) for support.</nowiki>

''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>

''Note: if you use Powershell on Windows, the generated file can not be used directly because it will be in UTF-16 format. Use Notepad++ to reencode in ANSI or generate it again using this command:''
: <tt>svn diff | out-file -encoding ascii 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 [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530<nowiki>] or one of</nowiki>
: <tt>git diff --no-prefix > my.patch</tt>
: <tt>svn patch my.patch --strip 1</tt>

=== Patch application and testing ===
Most Subversion front-end UI tools (like TortoiseSVN or SmartSVN) have an option to apply this patch files directly.

If you are using svn version ≥ 1.7.0, the command:
:<tt>svn patch my.patch</tt>

...will perform some checks and then will patch your files using the difference information saved in the patch file (''my.patch'' in the example).

If you only need the command line without SVN tooling (why would you do so?), then 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>

'''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 "Tickets" 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!'''

Developer documentation

2022-04-11T12:23:27Z

Mgimenez: /* Developing C::B with Git */ Make links to the forum absolute

[[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.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [https://forums.codeblocks.org/index.php/topic,16096.msg128152.html#msg128152 Re: Read-only Git, SVN Repo for Code::Blocks], also stahta01 has a nice instruction about how to use git, see [https://forums.codeblocks.org/index.php/topic,19533.msg133422.html#msg133422 Development How to use a Code::Blocks Git Repo].

If you want to create a SVN style patch from git, see: [https://forums.codeblocks.org/index.php/topic,19391.msg132530.html#msg132530 This forum post].

== Debugging C::B ==

* When C::B crashes, it will generate a call-stack file "codeblocks.RPT", at the crash point (see [[FAQ-Compiling_(general)#Q: How do I report a compilation problem on the forums?|this]] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface that works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Developer documentation

2022-04-11T12:22:18Z

Mgimenez: /* Debugging C::B */ Fix link to the FAQ

[[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.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [/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 crashes, it will generate a call-stack file "codeblocks.RPT", at the crash point (see [[FAQ-Compiling_(general)#Q: How do I report a compilation problem on the forums?|this]] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface that works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Common problems and solutions

2022-04-11T12:17:27Z

Mgimenez: /* Solution */ Remark that codeblocks.RPT may be in the config directory

[[Category:Deletion Requests]]
[[Category:User Documentation]]
''All content has been moved to the [[FAQ]].''

This page contains many of the common problems Code::Blocks users may run into and their solutions.

==I cannot use the debugger==

===Problem===
All the options in the debug menu are grayed out.

===Solution===
Code::Blocks can only use integrated debugging on an active project. Start a [[Creating a new project|new project]] and [[Creating a new project#Adding a pre-existing file|add the file]] to it. Also see [[debugging with Code::Blocks]].

''Note: Code:Blocks only supports the GNU GDB and MSVC CDB debuggers.''

==Multi-targets library and executable ignore interdependence==

===Problem===
My project contains a two targets: static/dynamic library and an executable that links to it. Code::Blocks does not
* build the library first.
* force relink if the library is changed.

===Solution===
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>

==I want to report compile problem ''abc''==

===Problem===
Every time I build my project ''xyz'', compile problem ''abc'' happens, and I want to report it on the forums as a Code::Blocks bug.

===Solution===
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#Q: How do I troubleshoot an compiler problem?|How do I troubleshoot an 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 if it is writable or in the config directory if it is not).

''Template: Paste the following template into your post, editing the relevant sections.''
OS = ''MyOperatingSystem''
CB Version = ''Code::BlocksVersionNumber''
Compiler = ''CompilerName CompilerVersionNumber''

''Description of relevant events.''

Build log:
[code]
''Paste build log here''
[/code]

Crash report:
[code]
''If Code::Blocks crashed, paste the contents of'' codeblocks.RPT ''here.''
[/code]

==I cannot build my project==

===Problem===
All of the ''Build'' related options are grayed out.

===Solution===
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

==Code::Blocks option ''xyz'' is missing==

===Problem===
The useful feature ''xyz'' I was told to use is nowhere to be found in Code::Blocks.

===Solution===
Many features of Code::Blocks are implemented by means of plugins. First open ''Plugins->Manage plugins...'' and ensure that the one you are trying to use is not disabled. If plugin ''xyz'' is not in the list, it is possible that you removed/disabled it on installation. To acquire the plugin, [[Installing Code::Blocks|reinstall Code::Blocks]] (double checking that the desired plugin is included).

==Syntax highlighting is broken==

===Problem===
I am typing valid code, but it is all appearing as black text.

===Solution===
Code::Blocks cannot know how to highlight your code unless it knows what lexer to use. This is normally automatically determined by the file extension, so it is important to save the file and name it correctly (<tt>*.c</tt> or <tt>*.cpp</tt> for C and C++ code). It is also possible to activate syntax highlighting on a temporary basis. Open ''Edit->Highlight mode'' and select the language the current file is using.

==Untraceable reoccurring error==

===Problem===
Project ''abc'' works everywhere except one computer where it gets stuck on step ''xyz''.

===Solution===
Some parts of Code::Blocks or the back-end compiler may not support non ASCII characters (such as é) or possibly spaces. Try moving the project on the affected computer to a directory that contains neither of these in its path.

==Help, no one can solve my problem==

===Problem===
I posted on the forums that Code::Blocks was not working, but no one could help me.

===Solution===
There is a distinct lack of crystal balls and divining mirrors here, so you may want to post some information. Using this [[#I want to report compile problem abc|template]] in your problem description would be a great help.

==Multiple ''undefined reference'' errors==

===Problem===
Every time I build, Code::Blocks reports multiple <tt>undefined reference</tt> errors.

''Example:''
undefined reference to `WSACleanup@8
undefined reference to `WSACleanup@0

===Solution===
Most of the time it is because the required library is not linked with your project. Go to ''Project->Build options...->Linker settings (tab)'' and add the required library or libraries.

If the error includes a line number, it is likely that this is a problem with your code. Track down down your function declarations and implementations. Ensure they all match up, are spelled correctly, and have the correct scope resolution.

FAQ-Compiling (general)

2022-04-11T12:15:18Z

Mgimenez: /* Q: How do I report a compilation problem on the forums? */ Explain codeblock.RPT will be in the config folder if C::B's one is not writable

[[Category:Code::Blocks Documentation]]
__TOC__
Return to '''[[FAQ]]'''.

----

==== Q: What compiler can I use with Code::Blocks? ====

'''A:''' Code::Blocks philosophy is to be able to use any compiler on earth! Well, almost.

As a matter of fact it largely depends on the used compiler plugin. Some provided with the default Code::Blocks installation are GNU GCC (MinGW/Cygwin), MS Visual C++ Free Toolkit 2003, Borland's C++ Compiler 5.5, DigitalMars Free Compiler., OpenWatcom, Small Device C Compiler (SDCC) and others.

==== Q: My project should be compiled with a custom makefile. Is it possible with Code::Blocks? ====

'''A:''' Yes, you can. You need to change one settings with Code::Blocks 8.02:

In your project's Properties, check "This is a custom makefile".

And that's it! :)

==== Q: I have downloaded MS VC++ Toolkit 2003 for a compiler. How do I tell Code::Blocks that it is my compiler? ====

'''A:''' Click on "Project/Build options" and select the compiler you want for your project/target.

==== Q: Microsoft calls MSVCRT.DLL a "Known DLL." How do I know if I can/should use it? ====

Microsoft does not clearly describe what [http://msdn2.microsoft.com/en-us/library/abx4dbyh.aspx 'Known DLL'] means. A [http://www.zlib.net/DLL_FAQ.txt zLib FAQ entry] makes it much more clear. The short answer is that MSVCRT.DLL is a protected system component and to preserve system integrity it cannot be updated by any end user product installers but may be updated from time to time by system updates. If it works use it. If it doesn't you'll need use a non protected library such as MSVCR70 or MSVCR80 which not only can be updated but private versions can be installed. A small and simple C program is likely to work just fine with MSVCRT.DLL. A large and complex C++ program is more likely to need the additional functionality of MSVCR.

The MSVCRT.LIB that ships with 32 bit compiler Visual C++ Toolkit 2003 dynamically links to MSVCR71.DLL which is not present in a freshly installed Windows XP system. MSVCR only appears after some software package that needs it such as [http://www.adobe.com/ Adobe Acrobat Reader] is installed. This means that programs that depend on MSVCR must redistribute it or risk not working on a substantial percentage of systems for reasons not obvious to either the affected end users or the program supplier.

For projects that can safely use MSVCRT and where it is impractical to redistribute MSVCR, a Win32 MSVCRT.LIB that links to MSVCRT.DLL is available in any [http://www.microsoft.com/whdc/devtools/ddk/default.mspx Device Driver Kit]. It is best to preserve the MSVCRT.LIB provided by the compiler and alter the name of the MSVCRT.LIB extracted from a DDK. List your newly named MSVCRTxx in the lib. If you use MSVCRT.LIB from the Windows 2003 DDK you may encounter the link '''error LNK2001: unresolved external symbol ___security_cookie'''. This can be solved by switching to the MSVCRT.LIB in the Windows XP DDK or by linking '''bufferoverflowU.lib''' found in the Windows SDK. A Win64 MSVCRT.LIB that links to MSVCRT.DLL is available in the Windows SDK or Platform [http://www.microsoft.com/downloads/details.aspx?FamilyId=E15438AC-60BE-41BD-AA14-7F1E0F19CA0D&displaylang=en PSDK].

To prevent problems it is recommended to include both /MD and /NODEFAULTLIB:MSVCRT switches so that problems come up at link time instead of random crashes at run time. Be sure to load your programs into [http://www.dependencywalker.com/ Dependancy Walker] to ensure that functions aren't being linked into both MSVCRxx.DLL and MSVCRT.DLL. It is essential that malloc, calloc, realloc, free, and related memory allocation functions all import from the same DLL.

Source: [http://wiki.tcl.tk/11431 TCL Wiki]

==== Q: How can I use a DLL without DEF or LIB files? ====

'''A:''' I tried to find a solution, and the following script solved the problem for me. I used a cygwin environment for ''tclsh'' and ''sed'', but the MinGW tools for ''objdump'' and ''dlltool''. See here [http://wiki.tcl.tk/2435 tclsh script to extract import .lib from (any?) DLL (MinGW)]

TODO: Someone might add some informations about problems

Request: Is MinGW or Code::Blocks able to support automatic generation of import libraries ?

See also: http://www.mingw.org/wiki/CreateImportLibraries

See also: http://wyw.dcweb.cn/stdcall.htm

==== Q: Where are the libraries for the OpenGL, Ogre3D, SDL, QT, wxWidgets etc. projects? ====

'''A:''' They're not bundled. The templates were provided for your convenience, but you need to download the libraries on your own.
In common terms, "batteries not included" :)

==== Q: Is it possible to use Visual C++ 6.0 with Code::Blocks? ====

'''A:''' Yes. See [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]] for a detailed description on using VC++ 6.0 with Code::Blocks.

==== Q: I would like to compile a project using some non-standard libraries. How can I indicate to CodeBlocks that these libraries and include files exist? ====

'''A:''' You can specify them for your global environment or just for your project.

For global environment : 
- Menu Settings/Compiler and debugger 
- In the Global compiler settings, select the directories tab 
- Add the required paths for compiler and linker. 
 
For your project : 
- Right click on the project then select Build options 
- Select the directories tab 
- Add the required paths for compiler and linker. 
- Add your specific libraries in the linker tab. 
- Pay attention to project settings and target settings.
==== Q: How do I use both Debug and Release builds of wx libraries? ====
'''A:''' I would use the default method of doing it and the default folder naming.

Using these C::B custom varibles
WX_SUFFIX="" // ANSI Release
WX_SUFFIX="d" // ANSI Debug
WX_SUFFIX="u" // Unicode Release
WX_SUFFIX="ud" // Unicode debug

I use WX_CFG when I am using a special configuration
WX_CFG="rc3"

Remember, the CodeBlocks globel variable WX needs to point to the wxWidgets folder.

Example minGW build command for "Unicode debug" 2.8.0 RC3

mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

"VENDOR=" just puts rc3 in the DLL name; "CFG=" sets which folder the DLL is placed in. In this case in lib\gcc_dllrc3

Before using CFG in the mingw32-make build you need to do one prior wxWidget build without using it; else the build errors out. (See note below.)

"__WXDEBUG__" must be defined (in the codeblocks project setting) if you wish to link against the debug version of wxWidgets DLL. Else you will get a runtime error, when you try to run your project output.

Contributed by Tim S

Note:
*I have never gotten the following command to work
mingw32-make -f makefile.gcc VENDOR=rc3 CFG=rc3 USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*unless I have first run this command on the same wxWidgets folders
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=debug UNICODE=1

*I am guessing that the build without the CFG creates a file or directory needed by the build with the CFG.

==== Q: How do I add version information to windows executables and dll's? ====
'''A:''' You need to create a resource file with the extension .rc and write the version info there. Then add that file to the Code::Blocks project you are working on.

Sample content of a resource file that you can use and modify for your needs:
<source lang="cpp" enclose="div">
LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US

VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,0,0,1
PRODUCTVERSION 1,0,0,1
FILEFLAGSMASK 0x3fL // VS_FFI_FILEFLAGSMASK
#ifdef _DEBUG
FILEFLAGS 0x1L // VS_FF_DEBUG|VS_FF_PRIVATEBUILD|VS_FF_PRERELEASE
#else
FILEFLAGS 0x0L // final version
#endif
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
FILESUBTYPE VFT2_UNKNOWN // not used
{
BLOCK "StringFileInfo"
{
BLOCK "040904E4" // Lang=US English, CharSet=Windows Multilingual
{
VALUE "Build", "August 2007\0"
VALUE "Comments", "Free for personal use only.\0"
VALUE "CompanyName", "Fake Company\0"
VALUE "Developer", "The Developer\0"
VALUE "FileDescription", "Application implementing something\0"
VALUE "FileVersion", "1.0.000\0"
VALUE "InternalName", "AppInternalName\0"
VALUE "LegalCopyright", "Copyright (C) 2007 Fake Company\0"
VALUE "LegalTrademarks", "All rights reserved.\0"
VALUE "OriginalFilename", "TheEXE.exe\0"
VALUE "PrivateBuild", "\0"
VALUE "ProductName", "The EXE\0"
VALUE "ProductVersion", "1.0.000\0"
VALUE "SpecialBuild", "\0"
VALUE "Support", "TheEXE at fake-domain.com\0"
VALUE "Users", "Unlimited.\0"
} // BLOCK "040904E4"
} // BLOCK "StringFileInfo"
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x409, 1252 // 1252 = 0x04E4
} // BLOCK "VarFileInfo"
}
</source>

Also you can use the the [[AutoVersioning plugin]] to assist you on the generation of version information. For documentation of the syntax and values used on windows resource files, you can visit the following websites:
*http://msdn2.microsoft.com/en-us/library/aa380599.aspx
*http://www.cygwin.com/cygwin-ug-net/windres.html

==== Q: Code::Blocks does not force relink if the library is changed? ====

'''A:''' Open ''Project->Properties...->Build targets (tab)'' and select the executable. Click ''Dependencies...'' and add the name of the library (including its relative path) to ''External dependency files''. Also see [[The build process of Code::Blocks#Using project dependencies|inter-project dependencies]].

''Example:'' <tt>output\myLibrary\libdostuff.a</tt>

==== Q: How do I report a compilation problem on the forums? ====

'''A:''' Try building the project from command line. If the same error comes up, it is a problem with either the source file, the compiler, or the compiler setup. If this is the case, you are unlikely to receive support for it on the Code::Blocks forums, however, [[FAQ-Compiling (errors)#Q: How do I troubleshoot a compiler problem?|How do I troubleshoot a compiler problem?]] may help.

If it works fine building from command line, it is either a problem with your project, Code::Blocks' setup, or possibly an actual bug. When posting this problem, include the name of your compiler, operating system, Code::Blocks version, compiler log (go to ''Settings->Compiler and debugger...->Build options (tab)'' and check ''Save build log'' and ''Always output the full command line''), and, if it caused Code::Blocks to crash, the <tt>codeblocks.RPT</tt> file. This file is located in the Code::Blocks installation directory if it is writable, and in the config directory if it is not. On MSW you can open the config directory pressing Windows+R and writing "%appdata%\CodeBlocks" in the edit box.

[[File:forum_code_tag.png|frame|Button for code tags in the new post editor of the forum]]

'''Important''' If you post code or log message to the forum, please use code tags: Click the "#" button in the new post editor (see image) and post your code/log between the two "[code][/code]" words. This helps to distinguish between your text and the log and it shortens the posts.

''Template: Paste the following template into your post, editing the relevant sections.''
I am running Code::Blocks version ''Code::BlocksVersionNumber'' on ''MyOperatingSystem''
(version ''OperatingSystemVersionNumber''). The compiler I use is ''CompilerName''
version ''CompilerVersionNumber''.

When I ...
''Steps to reproduce problem.''

''Description of problem.''
... happens.

Build log:
[code]
''Paste '''full''' build log here. (It is found in the 'Build log' tab). Please make always a 'rebuild' (Menu: Build->Rebuild) or a 'clean' and 'build' before you copy the full build log. ''
[/code]

Crash report:
[code]
''Paste the contents of'' codeblocks.RPT ''here (if Code::Blocks crashed).''
[/code]

''(Although the following is not necessary, showing that you''
''have tried increases the probability of a response.)''
I have already tried ...
''List of attempted solutions.''
... but none of them worked.

==== Q: All of the Build related options are grayed out? ====

'''A:''' Code::Blocks checks the file extension for individual files before allowing them to be compiled. Save your file with the correct file extension (<tt>*.c</tt> or <tt>*.cpp</tt>).

More often it is useful to [[Creating a new project|create a project]] so that Code::Blocks can manage the entire build.

==== Q: I get a blank (black) terminal window on windows ====

'''A:''' Your Anti Virus is blocking your executable. Modern Anti Virus (AV) programs use heuristics to determine if a program is a virus or not. Often this gives false positives and your AV will block your self created applications. [[Solution:]] Deactivate your AV, or for the paranoid: add your project folder, gcc folder and probably also the c::b folder to the AV exception.

==== Q: My program runs in codeblocks but if i start it from the outside it only flashes and closes immediately ====

'''A:''' Your program does exactly what you tell him. You have written that the program should return as soon as it is finished with his code. Codeblocks adds a convenient layer and keeps the console open until you press a key. You can add this to your program with the following lines of code in c++:

<source lang="cpp" enclose="div">
//clear buffer, wait for input to close program
std::cin.clear(); std::cin.ignore(INT_MAX, '\n');
std::cin.get();
return 0;
</source>

for c it is not that easy. You can use

<source lang="cpp" enclose="div">
getch()
</source>
but the user has to press ENTER to continue.

----

Return to '''[[FAQ]]'''.

Developer documentation

2022-04-11T12:06:45Z

Mgimenez: /* Debugging C::B */ Close bracket

[[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.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [/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 crashes, it will generate a call-stack file "codeblocks.rpt", at the crash point (see [https://wiki.codeblocks.org/index.php/index.php/FAQ-Compiling_(general)#Q:_How_do_I_report_a_compilation_problem_on_the_forums.3F this] for more information). This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Developer documentation

2022-04-11T12:06:16Z

Mgimenez: /* Debugging C::B */ ABsolute address

[[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.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [/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 crashes, it will generate a call-stack file "codeblocks.rpt", at the crash point (see [https://wiki.codeblocks.org/index.php/index.php/FAQ-Compiling_(general)#Q:_How_do_I_report_a_compilation_problem_on_the_forums.3F this] for more information. This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Developer documentation

2022-04-11T12:05:38Z

Mgimenez: /* Debugging C::B */ Add link to the FAQ, correct relative links, fix wording.

[[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.
:Browse SDK documentation at http://alpha0010.github.io/cb-docs/ as html.

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

:Code::Blocks uses Launchpad to coordinate translation efforts.
* '''[http://launchpad.net/products/codeblocks/ Old Translation page]'''
* '''[http://launchpad.net/products/codeblocks-gd/ New Translation page]'''
:See also [/index.php/topic,1022.msg159075.html#msg159075 Code::Blocks' translation]

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Plugin structure of C::B]]
* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Developing C::B with Git ==
For devs who want to use Git to develop C::B, here are some steps to follow, especially you need to correctly set the SVN and GIT properties so that you can make your local git commits back to the official SVN repo. See [/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 crashes, it will generate a call-stack file "codeblocks.rpt", at the crash point (see [index.php/FAQ-Compiling_(general)#Q:_How_do_I_report_a_compilation_problem_on_the_forums.3F this] for more information. This is a text file that you can open; if your C::B contains the debug information, it will have file and line information about each call. If your C::B is a stripped version, but you have the debug version of C::B, you can try to run the [https://forums.codeblocks.org/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is an address2line UI interface works under Windows.
* You can debug C::B under C::B (with the debugger plugin), also, you can link C::B to the debug version of wxWidgets library, so you can see whether a bug is located in C::B source code or wxWidgets' source code, see here: [https://forums.codeblocks.org/index.php/topic,17316.msg130972.html#msg130972 patch to build C::B against wx debug library]

Adding support for non C/C++ files to the build system

2022-04-06T07:27:09Z

Mgimenez: /* ...and how things have evolved */ Specify the path to the dialog

[[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->Other settings</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?. Goto to Settings -> Compiler -> Global compiler settings -> Other settings and click on Advanced options, you will get this dialog:

<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)

Installing Code::Blocks from source on Windows

2022-03-10T15:47:38Z

Mgimenez: /* Build wxWidgets Support Library */ Clarify why support for wx < 3.1.3 was removed

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Overview ==

=== Self-Hosting ===

The build process described on this page is a kind of "[https://en.wikipedia.org/wiki/Self-hosting Self-Hosting]." You use an existing version of Code::Blocks to compile the next version. When that version is proven to function correctly it is used to compile the next, and so on.

== Prerequisites ==

=== Bootstrap Code::Blocks ===

A properly working Code::Blocks is required to compile the next SVN version. A: [[Installing_Code::Blocks_nightly_build_on_Windows | Nightly Build]] is a good candidate to use. It will be paired with a MinGW compiler in the next item.

=== MinGW Compiler ===

At the present time, Code::Blocks only compiles successfully with a MinGW compiler toolchain on Windows. You will need a complete, working: [[MinGW installation]].

=== wxWidgets ===

wxWidgets is the "[https://en.wikipedia.org/wiki/Graphical_user_interface graphical user interface toolkit]" that Code::Blocks is built on top of.

For information about wxWidgets, see their official site ➡ [http://www.wxwidgets.org/ wxWidgets.org]

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

ZIP and SVN functions are not required to run Code::Blocks but ZIP is required to build it and a SVN client is strongly recommended but not absolutely necessary.

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

Make sure <tt>zip.exe</tt> is in your [https://en.wikipedia.org/wiki/PATH_(variable) PATH] as it is used both during the compilation in your current version of Code::Blocks and also by the <tt>update.bat</tt> script.

==== SVN ====

It is recommended, but not required, that you install a SVN client. If you are a absolute beginner in programming skip this part and go to [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_Sources Code::Blocks Sources]. An example would be [http://tortoisesvn.net/downloads TortoiseSVN] if you would like an all-in-one SVN solution. ''TortoiseSVN'' includes optional command-line client tools, which you should install as they provide a command-line SVN client. Choosing to install the command-line client tools will automatically add them to your PATH. However, if you do not wish to have the ''TortoiseSVN'' Explorer extensions in your right-click context menu or just don't feel a need for a graphical client in particular then you can use another: [http://subversion.apache.org/packages.html SVN command-line client] equally well. Just make sure that whichever client you install has its executable in your PATH.

The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn.exe</tt> binary if it is available (in your PATH) and also uses the SVN meta-data generated by a SVN checkout. If you have both a SVN command-line client in your PATH, and the meta-data, the resulting build of Code::Blocks will show the revision on the loading splash window, the Start here page, and in the About dialog (shown here in the About dialog, indicated by the red arrow):

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

If you don't wish to use a SVN utility, you can download a snapshot from: [https://sourceforge.net/p/codeblocks/code/HEAD/tree/ here] clicking on "Download Snapshot". Now you can go on to the [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Build_wxWidgets_Support_Library next section]

The last item is to acquire the Code::Blocks source code. Follow the appropriate instructions for whether you have a graphical or command line SVN client.

==== TortoiseSVN ====

If you prefer a graphical SVN client you can use ''TortoiseSVN'' - make a directory where you want to store the sources, right-click on the directory, and select "'''SVN Checkout'''," and as shown you will get a checkout dialog:

[[Image:Tor_SVN.png]]

In the URL of the repository box, enter <tt><nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki></tt> and verify the checkout directory is where you would like it to be. The example given here is "''C:\cb_svn''" - once satisfied with the arguments click the OK button to process the checkout.

==== Command-Line SVN ====

If you do not wish to use a graphical SVN client then a command-line equivalent to the above is to use the <tt>svn</tt> command - open a command prompt, make a directory, change into that directory, and then checkout a copy of the repository:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Build wxWidgets Support Library ==

=== Configure Build Options ===

Please note that support has been removed for wxWidgets < 3.1.3 because it lacks Direct2D support.

Unpack the wxWidgets zip file to a directory of your choice, open a command-line prompt, and navigate to the directory <tt>build/msw</tt> inside the wxWidgets directory. In this directory there is a text file named <tt>config.gcc</tt> which you can edit with notepad to control the build options. There are two lines to note, <tt>CFLAGS ?=</tt> and <tt>CXXFLAGS ?=</tt>. The options given here will go in either or both of those lines.

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

Some versions of the MinGW Windows Runtime Library will cause an error during compilation. See: [https://sourceforge.net/p/tdm-gcc/bugs/269/ Bug #269]. If this is the case with the toolchain you are using then try this workaround:

-D_WIN32_IE=0x0603

To silence warnings that can significantly slow down the compilation process:

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

All of these options apply to both <tt>CFLAGS</tt> and <tt>CXXFLAGS</tt> so the two lines containing all the options would look like this:

CFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

CXXFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

To compile wxWidgets in 64-bit mode add <tt>CFG=64</tt> to the build line that is given next or use a compiler that defaults to 64 bit output. For example, MinGW-w64 has toolchains targetting 32 bits and others targetting 64 bits. Of course, you will have to compile Code::Blocks also in 64-bit mode and add <tt>_64</tt> suffix to folders and batch files.

=== Build wxWidgets Library ===

First you must edit include\wx\msw\setup.h; locate a line containing

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

If you can not find setup.h please copy setup0.h to setup.h

At a command-line, inside the <tt>build/msw</tt> directory, use the following commands to build wxWidgets:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

If your compiler toolchain is not in your PATH (it should be on a development machine), then put it in your path first:

set PATH=X:\path\to\toolchain\bin;%PATH%

Where "'''''X'''''" is the drive letter, and "'''''\path\to\toolchain\bin'''''" is where your toolchain is located.

If your compilation fails for any reason then make sure to run the ''clean'' line before trying again.

== Build Code::Blocks ==

=== Self-Hosting ===

All the preparation work is now complete and we can actually perform a self-hosting compile of the next Code::Blocks with our current one. If you do not make any changes to your non-Code::Blocks prepared items, like your MinGW compiler version, and the wxWidgets library, then when building subsequent SVN versions of Code::Blocks you can keep all the preparation from a previous build and start with this section. When restarting from this point you can refresh your current Code::Blocks local source with ''TortoiseSVN''. Right-click on your local source directory, go to "TortoiseSVN" in the context-menu, then choose "update to revision." The "head" is always the latest version. If you are using a command-line SVN, just run <tt>svn update</tt> in the root of your local source directory.

=== Open project ===
Open the project file '''CodeBlocks_wx31.cbp''' (or '''CodeBlocks_wx31_64.cbp''' for 64-bit mode).
*You will be prompted to define the global variable $(#wx31). In the base field, enter the root of the location where you unpacked wxWidgets.

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

Building Code::Blocks against the wxWidgets library will generate an excessive amount of warnings during the compilation. This can significantly impact the time it takes to compile both the main project and the contributors workspace as each warning has to be printed to the build log. To silence these warnings, go to Compiler Settings:

[[Image:Compiler_Settings.png]]

And under the "Compiler settings" tab (red arrow), "Other compiler options" sub-tab (green arrow), enter "<tt>-Wno-unused-local-typedefs</tt>" (blue arrow), and you may also add "<tt>-Wno-deprecated-declarations</tt>" on its own line here too.

[[Image:Unused_Local_Typedefs.png]]

=== Compile project ===
Make sure that "All" is selected as the target (blue arrow), and then click the Build icon (red arrow).

[[Image:Compile_All.png]]

If everything builds correctly your build messages should end with no errors.

[[Image:Build_Log.png]]

=== Copy wxWidgets support DLL ===
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw31u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>devel31</tt> (or <tt>devel31_64</tt> for 64-bit) directory in the Code::Blocks <tt>src</tt> directory. If you are confident enough you can copy it instead to System32 (on 32 bits Windows) or SysWOW64 (on 64 bits Windows).

[[Image:Update_Devel_Output.png]]

The <tt>devel31</tt> directory is created by compiling the Code::Blocks project in Code::Blocks.

=== Generate Production Output ===
Run <tt>update_31.bat</tt> (located in the <tt>src</tt> directory). This will pack the resource files and copy the executables, libraries, and plugins to the <tt>output_31</tt> directory. It will also create the <tt>output_31</tt> directory if it does not exist. If you are compiling the 64-bit version please call <tt>update_31_64.bat</tt> and use folders <tt>devel_31_64</tt> and <tt>output_31_64</tt>.

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

The NassiShneiderman plugin has a dependency on the "[http://www.boost.org/ Boost]" library. If you do not wish to use that plugin and therefore not need the library, just right-click on that plugin and choose "close project."

Don't forget to run <tt>update_31.bat</tt> or <tt>update_31_64.bat</tt> again after building the contributed plugins.

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

Copy or move the <tt>output_31</tt> or <tt>output_31_64</tt> directory to where you want Code::Blocks to reside. Then you probably want to rename the directory to something else. You can also optionally right-click on <tt>codeblocks.exe</tt> and choose "Create shortcut" and then rename that shortcut to your liking and move it to another location such as your desktop for easy access.

If you want to run Code::Blocks on a machine without your compiler toolchain being in the PATH then you will likely have to include, in the same directory as the <tt>codeblocks.exe</tt> is fine, support .dll files from your compiler toolchain. The easiest way to determine the required files is to not have your compiler toolchain in your PATH and repeatedly run Code::Blocks and copy over each .dll it says is missing until all have been found.

Installing Code::Blocks from source on Windows

2022-03-10T15:44:28Z

Mgimenez: /* Build wxWidgets Library */ Add instructions for multithreaded compilation

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Overview ==

=== Self-Hosting ===

The build process described on this page is a kind of "[https://en.wikipedia.org/wiki/Self-hosting Self-Hosting]." You use an existing version of Code::Blocks to compile the next version. When that version is proven to function correctly it is used to compile the next, and so on.

== Prerequisites ==

=== Bootstrap Code::Blocks ===

A properly working Code::Blocks is required to compile the next SVN version. A: [[Installing_Code::Blocks_nightly_build_on_Windows | Nightly Build]] is a good candidate to use. It will be paired with a MinGW compiler in the next item.

=== MinGW Compiler ===

At the present time, Code::Blocks only compiles successfully with a MinGW compiler toolchain on Windows. You will need a complete, working: [[MinGW installation]].

=== wxWidgets ===

wxWidgets is the "[https://en.wikipedia.org/wiki/Graphical_user_interface graphical user interface toolkit]" that Code::Blocks is built on top of.

For information about wxWidgets, see their official site ➡ [http://www.wxwidgets.org/ wxWidgets.org]

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

ZIP and SVN functions are not required to run Code::Blocks but ZIP is required to build it and a SVN client is strongly recommended but not absolutely necessary.

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

Make sure <tt>zip.exe</tt> is in your [https://en.wikipedia.org/wiki/PATH_(variable) PATH] as it is used both during the compilation in your current version of Code::Blocks and also by the <tt>update.bat</tt> script.

==== SVN ====

It is recommended, but not required, that you install a SVN client. If you are a absolute beginner in programming skip this part and go to [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_Sources Code::Blocks Sources]. An example would be [http://tortoisesvn.net/downloads TortoiseSVN] if you would like an all-in-one SVN solution. ''TortoiseSVN'' includes optional command-line client tools, which you should install as they provide a command-line SVN client. Choosing to install the command-line client tools will automatically add them to your PATH. However, if you do not wish to have the ''TortoiseSVN'' Explorer extensions in your right-click context menu or just don't feel a need for a graphical client in particular then you can use another: [http://subversion.apache.org/packages.html SVN command-line client] equally well. Just make sure that whichever client you install has its executable in your PATH.

The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn.exe</tt> binary if it is available (in your PATH) and also uses the SVN meta-data generated by a SVN checkout. If you have both a SVN command-line client in your PATH, and the meta-data, the resulting build of Code::Blocks will show the revision on the loading splash window, the Start here page, and in the About dialog (shown here in the About dialog, indicated by the red arrow):

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

If you don't wish to use a SVN utility, you can download a snapshot from: [https://sourceforge.net/p/codeblocks/code/HEAD/tree/ here] clicking on "Download Snapshot". Now you can go on to the [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Build_wxWidgets_Support_Library next section]

The last item is to acquire the Code::Blocks source code. Follow the appropriate instructions for whether you have a graphical or command line SVN client.

==== TortoiseSVN ====

If you prefer a graphical SVN client you can use ''TortoiseSVN'' - make a directory where you want to store the sources, right-click on the directory, and select "'''SVN Checkout'''," and as shown you will get a checkout dialog:

[[Image:Tor_SVN.png]]

In the URL of the repository box, enter <tt><nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki></tt> and verify the checkout directory is where you would like it to be. The example given here is "''C:\cb_svn''" - once satisfied with the arguments click the OK button to process the checkout.

==== Command-Line SVN ====

If you do not wish to use a graphical SVN client then a command-line equivalent to the above is to use the <tt>svn</tt> command - open a command prompt, make a directory, change into that directory, and then checkout a copy of the repository:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Build wxWidgets Support Library ==

=== Configure Build Options ===

Please note that support has been removed for wxWidgets < 3.1.3

Unpack the wxWidgets zip file to a directory of your choice, open a command-line prompt, and navigate to the directory <tt>build/msw</tt> inside the wxWidgets directory. In this directory there is a text file named <tt>config.gcc</tt> which you can edit with notepad to control the build options. There are two lines to note, <tt>CFLAGS ?=</tt> and <tt>CXXFLAGS ?=</tt>. The options given here will go in either or both of those lines.

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

Some versions of the MinGW Windows Runtime Library will cause an error during compilation. See: [https://sourceforge.net/p/tdm-gcc/bugs/269/ Bug #269]. If this is the case with the toolchain you are using then try this workaround:

-D_WIN32_IE=0x0603

To silence warnings that can significantly slow down the compilation process:

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

All of these options apply to both <tt>CFLAGS</tt> and <tt>CXXFLAGS</tt> so the two lines containing all the options would look like this:

CFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

CXXFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

To compile wxWidgets in 64-bit mode add <tt>CFG=64</tt> to the build line that is given next or use a compiler that defaults to 64 bit output. For example, MinGW-w64 has toolchains targetting 32 bits and others targetting 64 bits. Of course, you will have to compile Code::Blocks also in 64-bit mode and add <tt>_64</tt> suffix to folders and batch files.

=== Build wxWidgets Library ===

First you must edit include\wx\msw\setup.h; locate a line containing

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

If you can not find setup.h please copy setup0.h to setup.h

At a command-line, inside the <tt>build/msw</tt> directory, use the following commands to build wxWidgets:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

or, if you want to build using multiple threads:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 setup_h
mingw32-make -f makefile.gcc -j8 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

If your compiler toolchain is not in your PATH (it should be on a development machine), then put it in your path first:

set PATH=X:\path\to\toolchain\bin;%PATH%

Where "'''''X'''''" is the drive letter, and "'''''\path\to\toolchain\bin'''''" is where your toolchain is located.

If your compilation fails for any reason then make sure to run the ''clean'' line before trying again.

== Build Code::Blocks ==

=== Self-Hosting ===

All the preparation work is now complete and we can actually perform a self-hosting compile of the next Code::Blocks with our current one. If you do not make any changes to your non-Code::Blocks prepared items, like your MinGW compiler version, and the wxWidgets library, then when building subsequent SVN versions of Code::Blocks you can keep all the preparation from a previous build and start with this section. When restarting from this point you can refresh your current Code::Blocks local source with ''TortoiseSVN''. Right-click on your local source directory, go to "TortoiseSVN" in the context-menu, then choose "update to revision." The "head" is always the latest version. If you are using a command-line SVN, just run <tt>svn update</tt> in the root of your local source directory.

=== Open project ===
Open the project file '''CodeBlocks_wx31.cbp''' (or '''CodeBlocks_wx31_64.cbp''' for 64-bit mode).
*You will be prompted to define the global variable $(#wx31). In the base field, enter the root of the location where you unpacked wxWidgets.

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

Building Code::Blocks against the wxWidgets library will generate an excessive amount of warnings during the compilation. This can significantly impact the time it takes to compile both the main project and the contributors workspace as each warning has to be printed to the build log. To silence these warnings, go to Compiler Settings:

[[Image:Compiler_Settings.png]]

And under the "Compiler settings" tab (red arrow), "Other compiler options" sub-tab (green arrow), enter "<tt>-Wno-unused-local-typedefs</tt>" (blue arrow), and you may also add "<tt>-Wno-deprecated-declarations</tt>" on its own line here too.

[[Image:Unused_Local_Typedefs.png]]

=== Compile project ===
Make sure that "All" is selected as the target (blue arrow), and then click the Build icon (red arrow).

[[Image:Compile_All.png]]

If everything builds correctly your build messages should end with no errors.

[[Image:Build_Log.png]]

=== Copy wxWidgets support DLL ===
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw31u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>devel31</tt> (or <tt>devel31_64</tt> for 64-bit) directory in the Code::Blocks <tt>src</tt> directory. If you are confident enough you can copy it instead to System32 (on 32 bits Windows) or SysWOW64 (on 64 bits Windows).

[[Image:Update_Devel_Output.png]]

The <tt>devel31</tt> directory is created by compiling the Code::Blocks project in Code::Blocks.

=== Generate Production Output ===
Run <tt>update_31.bat</tt> (located in the <tt>src</tt> directory). This will pack the resource files and copy the executables, libraries, and plugins to the <tt>output_31</tt> directory. It will also create the <tt>output_31</tt> directory if it does not exist. If you are compiling the 64-bit version please call <tt>update_31_64.bat</tt> and use folders <tt>devel_31_64</tt> and <tt>output_31_64</tt>.

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

The NassiShneiderman plugin has a dependency on the "[http://www.boost.org/ Boost]" library. If you do not wish to use that plugin and therefore not need the library, just right-click on that plugin and choose "close project."

Don't forget to run <tt>update_31.bat</tt> or <tt>update_31_64.bat</tt> again after building the contributed plugins.

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

Copy or move the <tt>output_31</tt> or <tt>output_31_64</tt> directory to where you want Code::Blocks to reside. Then you probably want to rename the directory to something else. You can also optionally right-click on <tt>codeblocks.exe</tt> and choose "Create shortcut" and then rename that shortcut to your liking and move it to another location such as your desktop for easy access.

If you want to run Code::Blocks on a machine without your compiler toolchain being in the PATH then you will likely have to include, in the same directory as the <tt>codeblocks.exe</tt> is fine, support .dll files from your compiler toolchain. The easiest way to determine the required files is to not have your compiler toolchain in your PATH and repeatedly run Code::Blocks and copy over each .dll it says is missing until all have been found.

Installing Code::Blocks from source on Windows

2022-03-10T12:12:09Z

Mgimenez: /* Code::Blocks Sources */ Update snapshot link

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Overview ==

=== Self-Hosting ===

The build process described on this page is a kind of "[https://en.wikipedia.org/wiki/Self-hosting Self-Hosting]." You use an existing version of Code::Blocks to compile the next version. When that version is proven to function correctly it is used to compile the next, and so on.

== Prerequisites ==

=== Bootstrap Code::Blocks ===

A properly working Code::Blocks is required to compile the next SVN version. A: [[Installing_Code::Blocks_nightly_build_on_Windows | Nightly Build]] is a good candidate to use. It will be paired with a MinGW compiler in the next item.

=== MinGW Compiler ===

At the present time, Code::Blocks only compiles successfully with a MinGW compiler toolchain on Windows. You will need a complete, working: [[MinGW installation]].

=== wxWidgets ===

wxWidgets is the "[https://en.wikipedia.org/wiki/Graphical_user_interface graphical user interface toolkit]" that Code::Blocks is built on top of.

For information about wxWidgets, see their official site ➡ [http://www.wxwidgets.org/ wxWidgets.org]

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

ZIP and SVN functions are not required to run Code::Blocks but ZIP is required to build it and a SVN client is strongly recommended but not absolutely necessary.

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

Make sure <tt>zip.exe</tt> is in your [https://en.wikipedia.org/wiki/PATH_(variable) PATH] as it is used both during the compilation in your current version of Code::Blocks and also by the <tt>update.bat</tt> script.

==== SVN ====

It is recommended, but not required, that you install a SVN client. If you are a absolute beginner in programming skip this part and go to [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_Sources Code::Blocks Sources]. An example would be [http://tortoisesvn.net/downloads TortoiseSVN] if you would like an all-in-one SVN solution. ''TortoiseSVN'' includes optional command-line client tools, which you should install as they provide a command-line SVN client. Choosing to install the command-line client tools will automatically add them to your PATH. However, if you do not wish to have the ''TortoiseSVN'' Explorer extensions in your right-click context menu or just don't feel a need for a graphical client in particular then you can use another: [http://subversion.apache.org/packages.html SVN command-line client] equally well. Just make sure that whichever client you install has its executable in your PATH.

The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn.exe</tt> binary if it is available (in your PATH) and also uses the SVN meta-data generated by a SVN checkout. If you have both a SVN command-line client in your PATH, and the meta-data, the resulting build of Code::Blocks will show the revision on the loading splash window, the Start here page, and in the About dialog (shown here in the About dialog, indicated by the red arrow):

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

If you don't wish to use a SVN utility, you can download a snapshot from: [https://sourceforge.net/p/codeblocks/code/HEAD/tree/ here] clicking on "Download Snapshot". Now you can go on to the [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Build_wxWidgets_Support_Library next section]

The last item is to acquire the Code::Blocks source code. Follow the appropriate instructions for whether you have a graphical or command line SVN client.

==== TortoiseSVN ====

If you prefer a graphical SVN client you can use ''TortoiseSVN'' - make a directory where you want to store the sources, right-click on the directory, and select "'''SVN Checkout'''," and as shown you will get a checkout dialog:

[[Image:Tor_SVN.png]]

In the URL of the repository box, enter <tt><nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki></tt> and verify the checkout directory is where you would like it to be. The example given here is "''C:\cb_svn''" - once satisfied with the arguments click the OK button to process the checkout.

==== Command-Line SVN ====

If you do not wish to use a graphical SVN client then a command-line equivalent to the above is to use the <tt>svn</tt> command - open a command prompt, make a directory, change into that directory, and then checkout a copy of the repository:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Build wxWidgets Support Library ==

=== Configure Build Options ===

Please note that support has been removed for wxWidgets < 3.1.3

Unpack the wxWidgets zip file to a directory of your choice, open a command-line prompt, and navigate to the directory <tt>build/msw</tt> inside the wxWidgets directory. In this directory there is a text file named <tt>config.gcc</tt> which you can edit with notepad to control the build options. There are two lines to note, <tt>CFLAGS ?=</tt> and <tt>CXXFLAGS ?=</tt>. The options given here will go in either or both of those lines.

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

Some versions of the MinGW Windows Runtime Library will cause an error during compilation. See: [https://sourceforge.net/p/tdm-gcc/bugs/269/ Bug #269]. If this is the case with the toolchain you are using then try this workaround:

-D_WIN32_IE=0x0603

To silence warnings that can significantly slow down the compilation process:

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

All of these options apply to both <tt>CFLAGS</tt> and <tt>CXXFLAGS</tt> so the two lines containing all the options would look like this:

CFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

CXXFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

To compile wxWidgets in 64-bit mode add <tt>CFG=64</tt> to the build line that is given next or use a compiler that defaults to 64 bit output. For example, MinGW-w64 has toolchains targetting 32 bits and others targetting 64 bits. Of course, you will have to compile Code::Blocks also in 64-bit mode and add <tt>_64</tt> suffix to folders and batch files.

=== Build wxWidgets Library ===

First you must edit include\wx\msw\setup.h, locate a line containing

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

If you can not find setup.h please copy setup0.h to setup.h

At a command-line, inside the <tt>build/msw</tt> directory, use the following commands to build wxWidgets:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

If your compiler toolchain is not in your PATH, it should be on a development machine, then put it in your path first:

set PATH=X:\path\to\toolchain\bin;%PATH%

Where "'''''X'''''" is the drive letter, and "'''''\path\to\toolchain\bin'''''" is where your toolchain is located.

If your compilation fails for any reason then make sure to run the ''clean'' line before trying again.

== Build Code::Blocks ==

=== Self-Hosting ===

All the preparation work is now complete and we can actually perform a self-hosting compile of the next Code::Blocks with our current one. If you do not make any changes to your non-Code::Blocks prepared items, like your MinGW compiler version, and the wxWidgets library, then when building subsequent SVN versions of Code::Blocks you can keep all the preparation from a previous build and start with this section. When restarting from this point you can refresh your current Code::Blocks local source with ''TortoiseSVN''. Right-click on your local source directory, go to "TortoiseSVN" in the context-menu, then choose "update to revision." The "head" is always the latest version. If you are using a command-line SVN, just run <tt>svn update</tt> in the root of your local source directory.

=== Open project ===
Open the project file '''CodeBlocks_wx31.cbp''' (or '''CodeBlocks_wx31_64.cbp''' for 64-bit mode).
*You will be prompted to define the global variable $(#wx31). In the base field, enter the root of the location where you unpacked wxWidgets.

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

Building Code::Blocks against the wxWidgets library will generate an excessive amount of warnings during the compilation. This can significantly impact the time it takes to compile both the main project and the contributors workspace as each warning has to be printed to the build log. To silence these warnings, go to Compiler Settings:

[[Image:Compiler_Settings.png]]

And under the "Compiler settings" tab (red arrow), "Other compiler options" sub-tab (green arrow), enter "<tt>-Wno-unused-local-typedefs</tt>" (blue arrow), and you may also add "<tt>-Wno-deprecated-declarations</tt>" on its own line here too.

[[Image:Unused_Local_Typedefs.png]]

=== Compile project ===
Make sure that "All" is selected as the target (blue arrow), and then click the Build icon (red arrow).

[[Image:Compile_All.png]]

If everything builds correctly your build messages should end with no errors.

[[Image:Build_Log.png]]

=== Copy wxWidgets support DLL ===
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw31u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>devel31</tt> (or <tt>devel31_64</tt> for 64-bit) directory in the Code::Blocks <tt>src</tt> directory. If you are confident enough you can copy it instead to System32 (on 32 bits Windows) or SysWOW64 (on 64 bits Windows).

[[Image:Update_Devel_Output.png]]

The <tt>devel31</tt> directory is created by compiling the Code::Blocks project in Code::Blocks.

=== Generate Production Output ===
Run <tt>update_31.bat</tt> (located in the <tt>src</tt> directory). This will pack the resource files and copy the executables, libraries, and plugins to the <tt>output_31</tt> directory. It will also create the <tt>output_31</tt> directory if it does not exist. If you are compiling the 64-bit version please call <tt>update_31_64.bat</tt> and use folders <tt>devel_31_64</tt> and <tt>output_31_64</tt>.

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

The NassiShneiderman plugin has a dependency on the "[http://www.boost.org/ Boost]" library. If you do not wish to use that plugin and therefore not need the library, just right-click on that plugin and choose "close project."

Don't forget to run <tt>update_31.bat</tt> or <tt>update_31_64.bat</tt> again after building the contributed plugins.

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

Copy or move the <tt>output_31</tt> or <tt>output_31_64</tt> directory to where you want Code::Blocks to reside. Then you probably want to rename the directory to something else. You can also optionally right-click on <tt>codeblocks.exe</tt> and choose "Create shortcut" and then rename that shortcut to your liking and move it to another location such as your desktop for easy access.

If you want to run Code::Blocks on a machine without your compiler toolchain being in the PATH then you will likely have to include, in the same directory as the <tt>codeblocks.exe</tt> is fine, support .dll files from your compiler toolchain. The easiest way to determine the required files is to not have your compiler toolchain in your PATH and repeatedly run Code::Blocks and copy over each .dll it says is missing until all have been found.

Installing Code::Blocks from source on Windows

2022-03-10T12:08:44Z

Mgimenez: /* wxWidgets */ Update wxWidgets recommended version

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks from source]]
== Overview ==

=== Self-Hosting ===

The build process described on this page is a kind of "[https://en.wikipedia.org/wiki/Self-hosting Self-Hosting]." You use an existing version of Code::Blocks to compile the next version. When that version is proven to function correctly it is used to compile the next, and so on.

== Prerequisites ==

=== Bootstrap Code::Blocks ===

A properly working Code::Blocks is required to compile the next SVN version. A: [[Installing_Code::Blocks_nightly_build_on_Windows | Nightly Build]] is a good candidate to use. It will be paired with a MinGW compiler in the next item.

=== MinGW Compiler ===

At the present time, Code::Blocks only compiles successfully with a MinGW compiler toolchain on Windows. You will need a complete, working: [[MinGW installation]].

=== wxWidgets ===

wxWidgets is the "[https://en.wikipedia.org/wiki/Graphical_user_interface graphical user interface toolkit]" that Code::Blocks is built on top of.

For information about wxWidgets, see their official site ➡ [http://www.wxwidgets.org/ wxWidgets.org]

Download: [https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.5/wxWidgets-3.1.5.zip wxWidgets-3.1.5.zip]

=== Utilities ===

ZIP and SVN functions are not required to run Code::Blocks but ZIP is required to build it and a SVN client is strongly recommended but not absolutely necessary.

==== ZIP ====

You will need a command-line <tt>zip.exe</tt> program. The recommended one can be found on the: [[MinGW installation#Development Tools|Development Tools]] page. You do ''not'' need WinZip.

Make sure <tt>zip.exe</tt> is in your [https://en.wikipedia.org/wiki/PATH_(variable) PATH] as it is used both during the compilation in your current version of Code::Blocks and also by the <tt>update.bat</tt> script.

==== SVN ====

It is recommended, but not required, that you install a SVN client. If you are a absolute beginner in programming skip this part and go to [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Code::Blocks_Sources Code::Blocks Sources]. An example would be [http://tortoisesvn.net/downloads TortoiseSVN] if you would like an all-in-one SVN solution. ''TortoiseSVN'' includes optional command-line client tools, which you should install as they provide a command-line SVN client. Choosing to install the command-line client tools will automatically add them to your PATH. However, if you do not wish to have the ''TortoiseSVN'' Explorer extensions in your right-click context menu or just don't feel a need for a graphical client in particular then you can use another: [http://subversion.apache.org/packages.html SVN command-line client] equally well. Just make sure that whichever client you install has its executable in your PATH.

The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn.exe</tt> binary if it is available (in your PATH) and also uses the SVN meta-data generated by a SVN checkout. If you have both a SVN command-line client in your PATH, and the meta-data, the resulting build of Code::Blocks will show the revision on the loading splash window, the Start here page, and in the About dialog (shown here in the About dialog, indicated by the red arrow):

[[Image:About_SVN10627.png]]

=== Code::Blocks Sources ===

If you don't wish to use a SVN utility, you can download a snapshot from: http://sourceforge.net/p/codeblocks/code ➡ "Download Snapshot.". Now you can go on to the [https://wiki.codeblocks.org/index.php/Installing_Code::Blocks_from_source_on_Windows#Build_wxWidgets_Support_Library next section]

The last item is to acquire the Code::Blocks source code. Follow the appropriate instructions for whether you have a graphical or command line SVN client.

==== TortoiseSVN ====

If you prefer a graphical SVN client you can use ''TortoiseSVN'' - make a directory where you want to store the sources, right-click on the directory, and select "'''SVN Checkout'''," and as shown you will get a checkout dialog:

[[Image:Tor_SVN.png]]

In the URL of the repository box, enter <tt><nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki></tt> and verify the checkout directory is where you would like it to be. The example given here is "''C:\cb_svn''" - once satisfied with the arguments click the OK button to process the checkout.

==== Command-Line SVN ====

If you do not wish to use a graphical SVN client then a command-line equivalent to the above is to use the <tt>svn</tt> command - open a command prompt, make a directory, change into that directory, and then checkout a copy of the repository:

mkdir codeblocks-head
cd codeblocks-head
svn checkout <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

== Build wxWidgets Support Library ==

=== Configure Build Options ===

Please note that support has been removed for wxWidgets < 3.1.3

Unpack the wxWidgets zip file to a directory of your choice, open a command-line prompt, and navigate to the directory <tt>build/msw</tt> inside the wxWidgets directory. In this directory there is a text file named <tt>config.gcc</tt> which you can edit with notepad to control the build options. There are two lines to note, <tt>CFLAGS ?=</tt> and <tt>CXXFLAGS ?=</tt>. The options given here will go in either or both of those lines.

If your linker runs out of memory while building use:

-fno-keep-inline-dllexport

Some versions of the MinGW Windows Runtime Library will cause an error during compilation. See: [https://sourceforge.net/p/tdm-gcc/bugs/269/ Bug #269]. If this is the case with the toolchain you are using then try this workaround:

-D_WIN32_IE=0x0603

To silence warnings that can significantly slow down the compilation process:

-Wno-unused-local-typedefs

and

-Wno-deprecated-declarations

All of these options apply to both <tt>CFLAGS</tt> and <tt>CXXFLAGS</tt> so the two lines containing all the options would look like this:

CFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

CXXFLAGS ?= -fno-keep-inline-dllexport -D_WIN32_IE=0x0603 -Wno-unused-local-typedefs -Wno-deprecated-declarations

To compile wxWidgets in 64-bit mode add <tt>CFG=64</tt> to the build line that is given next or use a compiler that defaults to 64 bit output. For example, MinGW-w64 has toolchains targetting 32 bits and others targetting 64 bits. Of course, you will have to compile Code::Blocks also in 64-bit mode and add <tt>_64</tt> suffix to folders and batch files.

=== Build wxWidgets Library ===

First you must edit include\wx\msw\setup.h, locate a line containing

#define wxUSE_GRAPHICS_DIRECT2D 0

and change it to

#define wxUSE_GRAPHICS_DIRECT2D 1

If you can not find setup.h please copy setup0.h to setup.h

At a command-line, inside the <tt>build/msw</tt> directory, use the following commands to build wxWidgets:

mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

If your compiler toolchain is not in your PATH, it should be on a development machine, then put it in your path first:

set PATH=X:\path\to\toolchain\bin;%PATH%

Where "'''''X'''''" is the drive letter, and "'''''\path\to\toolchain\bin'''''" is where your toolchain is located.

If your compilation fails for any reason then make sure to run the ''clean'' line before trying again.

== Build Code::Blocks ==

=== Self-Hosting ===

All the preparation work is now complete and we can actually perform a self-hosting compile of the next Code::Blocks with our current one. If you do not make any changes to your non-Code::Blocks prepared items, like your MinGW compiler version, and the wxWidgets library, then when building subsequent SVN versions of Code::Blocks you can keep all the preparation from a previous build and start with this section. When restarting from this point you can refresh your current Code::Blocks local source with ''TortoiseSVN''. Right-click on your local source directory, go to "TortoiseSVN" in the context-menu, then choose "update to revision." The "head" is always the latest version. If you are using a command-line SVN, just run <tt>svn update</tt> in the root of your local source directory.

=== Open project ===
Open the project file '''CodeBlocks_wx31.cbp''' (or '''CodeBlocks_wx31_64.cbp''' for 64-bit mode).
*You will be prompted to define the global variable $(#wx31). In the base field, enter the root of the location where you unpacked wxWidgets.

*You will also be prompted to enter the global variable '''cb_release_type'''. Here you can add compiler optimization or debug-flags. Enter '''-g''' in the '''base''' field as a default or any other options you require for your specific needs.

[[Image:Global_Variables.png]]

[[Image:Global_wx.png]]

=== Prevent unnecessary warnings ===

Building Code::Blocks against the wxWidgets library will generate an excessive amount of warnings during the compilation. This can significantly impact the time it takes to compile both the main project and the contributors workspace as each warning has to be printed to the build log. To silence these warnings, go to Compiler Settings:

[[Image:Compiler_Settings.png]]

And under the "Compiler settings" tab (red arrow), "Other compiler options" sub-tab (green arrow), enter "<tt>-Wno-unused-local-typedefs</tt>" (blue arrow), and you may also add "<tt>-Wno-deprecated-declarations</tt>" on its own line here too.

[[Image:Unused_Local_Typedefs.png]]

=== Compile project ===
Make sure that "All" is selected as the target (blue arrow), and then click the Build icon (red arrow).

[[Image:Compile_All.png]]

If everything builds correctly your build messages should end with no errors.

[[Image:Build_Log.png]]

=== Copy wxWidgets support DLL ===
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw31u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>devel31</tt> (or <tt>devel31_64</tt> for 64-bit) directory in the Code::Blocks <tt>src</tt> directory. If you are confident enough you can copy it instead to System32 (on 32 bits Windows) or SysWOW64 (on 64 bits Windows).

[[Image:Update_Devel_Output.png]]

The <tt>devel31</tt> directory is created by compiling the Code::Blocks project in Code::Blocks.

=== Generate Production Output ===
Run <tt>update_31.bat</tt> (located in the <tt>src</tt> directory). This will pack the resource files and copy the executables, libraries, and plugins to the <tt>output_31</tt> directory. It will also create the <tt>output_31</tt> directory if it does not exist. If you are compiling the 64-bit version please call <tt>update_31_64.bat</tt> and use folders <tt>devel_31_64</tt> and <tt>output_31_64</tt>.

[[Image:Update_bat.png]]

The stripped ("production") executable is found in <tt>output_31</tt> directory together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel_31</tt> directory.

[[Image:Update_Output.png]]

=== Compile contributed (or your own) plugins ===

The workspace file '''ContribPlugins_wx31.workspace''' (or '''ContribPlugins_wx31_64.workspace''' for 64-bit compilation) contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build workspace" from the Build menu if you want them all).

The NassiShneiderman plugin has a dependency on the "[http://www.boost.org/ Boost]" library. If you do not wish to use that plugin and therefore not need the library, just right-click on that plugin and choose "close project."

Don't forget to run <tt>update_31.bat</tt> or <tt>update_31_64.bat</tt> again after building the contributed plugins.

[[Image:Build_Workspace.png]]

== Install Code::Blocks ==

Copy or move the <tt>output_31</tt> or <tt>output_31_64</tt> directory to where you want Code::Blocks to reside. Then you probably want to rename the directory to something else. You can also optionally right-click on <tt>codeblocks.exe</tt> and choose "Create shortcut" and then rename that shortcut to your liking and move it to another location such as your desktop for easy access.

If you want to run Code::Blocks on a machine without your compiler toolchain being in the PATH then you will likely have to include, in the same directory as the <tt>codeblocks.exe</tt> is fine, support .dll files from your compiler toolchain. The easiest way to determine the required files is to not have your compiler toolchain in your PATH and repeatedly run Code::Blocks and copy over each .dll it says is missing until all have been found.

Installing Code::Blocks nightly build on Ubuntu

2022-03-10T11:30:10Z

Mgimenez: Update information (incomplete and untested, but better than nothing)

[[Category:Installing Code::Blocks]]
[[Category:Installing Code::Blocks nightly build]]
This is a quick guide to get Code::Blocks up and running on your Ubuntu based Linux distribution. It is also going to make sure you can develop wxWidgets applications on your box as well. Look at the bottom of this guide for a complete command line that will install all the packages in one operation.

First be sure you have the necessary software to compile and debug programs.

1. Install the compiler.
sudo apt-get install build-essential

2. Install the debugger.
sudo apt-get install gdb

You'll need to install wxWidgets to use Codeblocks (support for wxWidgets < 3.0.0 has been removed). If you want to install them, make sure you have your universe and multiverse [https://help.ubuntu.com/ubuntu/desktopguide/C/extra-repositories.html repositories enabled] and install the following packages.

3. Install wxWidgets library. (This package is all that is needed to run any application that uses wxWidgets. ie. Code::Blocks). The version may be different in you Ubuntu.
sudo apt-get install libwxgtk3.0-4

4. Install the wxWidgets developement packages. (This is used to develop wxWidgets applications of your own.)
sudo apt-get install libwxgtk3.0-dev

5. ''(OPTIONAL)'' Install the wxWidgets documentation.
sudo apt-get install wx3.0-doc

Now go get the nightly build and install it. All dependencies should now be met.

1. Get the latest nigtly build of Code::Blocks from the [https://forums.codeblocks.org/index.php?board=20.0 nightly builds forum].

2. Install Code::Blocks.
sudo dpkg -i <Name_Of_Daily_Build.deb>

Codeblocks is packaged into separate Debian packages and the packages are archived together in a tar.gz file.

1. Download the tar.gz file to your computer and extract the files to an empty directory, such as one called temp for example.
tar xvf CB_''date-of-build_revision-number''_Ubuntu22.04+20.03_wx3.0.4.tar.gz

2. Install all the packages at the same time.
sudo dpkg -i *.deb

The packages can be installed individually, if you prefer not to install everything. The first package to install is libcodeblocks0 followed by the codeblocks package. All the other packages are optional. If you want to install the wxsmith and/or contrib packages, you must install the libwxsmithlib0 package first.

==See also==
* [http://apt.jenslody.de/ Jens' (un-)official debian-repository]: additional instructions and downloads.
* [https://launchpad.net/~pasgui/+archive/ppa/ PPA for pasgui]: an Ubuntu repository.
* [https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable PPA of dmoore]: an alternative Ubuntu repository.