Code::Blocks - User contributions [en]

SpellChecker plugin

2012-01-11T11:34:54Z

Vodoomoth: /* Thesaurus files */ Spell-checking: changed "there" into "their"

[[Category:Code::Blocks Contrib Plugins]]

{{Infobox_Plugin|
name = SpellChecker |
logo = [[File:SpellChecker.png]] |
developer = Daniel Anselmi |
maintainer = Daniel Anselmi |
version = 0.1
}}

=Introduction=
A plugin to check the spelling of strings and comments. The spelling gets checked during typing. Additionally a thesaurus is provided. Both may be accessed on-demand by selecting the word in question, then choosing either ''Spelling...'' or ''Thesaurus...'' for the ''Edit'' menu (the operation can be bound to a hot-key via the [[Keyboard Shortcuts plugin]]).

=Configuration=
Configuration is in the menu Settings > Editor. The spell check option are about half way down the list on the left.
[[File:ConfigureSpellChecker.png]]

The meaning of the controls are:

'''Enable online spell checker'''
:Enable or disable the spell checker.

'''Language'''
:The language used for spell checking and the thesaurus is selected by choosing a dictionary. This can also be changed in the status bar.

'''Path settings, Dictionaries'''
:The plugin is looking in this path for the dictionary files.

'''Path settings, Thesauri'''
:The plugin is looking in this path for the files needed by the thesaurus.

'''Path settings, Bitmaps'''
:(Optional) The plugin is looking in this path for the flags to show in the status bar.

==Dictionaries==
SpellChecker uses a library called [http://hunspell.sourceforge.net/ hunspell]. Hunspell is the spell checker of OpenOffice.org, Mozilla Firefox and other projects. Dictionaries available for those applications are compatible with this plugin.

Open Office provides a collection of dictionaries for several languages and dialects to [http://wiki.services.openoffice.org/wiki/Dictionaries download]. The OOo 3.x extensions (*.oxt) are compressed archives which can be opened with your favourite archiver (for example [http://www.7-zip.org/ 7-Zip] or File Roller).
Copy the '''.aff''' file and the '''.dic''' file to the directory configured in 'Path settings, Dictionaries' (see above).

If you're running Linux you've probably already got compatible dictionaries installed. Look in '''/usr/share/hunspell''' or my choice is '''/usr/share/myspell/dicts'''. The reason I like the myspell files is they already include thesaurus files which are named correctly to work with the thesaurus, and everything is all in one location. Don't copy these files. Just point the spell checker to where the files are already located.

I understand on Windows, Firefox and Thunderbird also install compatible dictionary files. These can be found in...
'''C:\Program Files\Mozilla Firefox\dictionaries''' or '''C:\Program Files\Mozilla Thunderbird\dictionaries'''

The Google Chrome browser also installs dictionaries, but they are '''.bdic''' format and the Code::Blocks spell checker plugin will not work with them.

==Thesaurus files==
The files for the thesaurus are also available from OOo, like the dictionaries. Copy the thesaurus files ('''th_*.dat''' and '''th_*.idx''') to the directory configured in
'Path settings, Thesauri' (see above) and rename them to match the name of the dictionary but prepend "th_" and let the extension as is.

Example: If the dictionary files (for one language) are "en_GB.aff" and "en_GB.dic" the files used for the thesaurus are "th_en_GB.idx" and "th_en_GB.dat".

On my Linux system I found thesaurus files already installed in '''/usr/share/myspell/dicts''' and '''/usr/share/mythes'''. Again, don't move the files. Set the spell checker to use the files from their current location.

==Bitmaps (flags)==
The bitmap of the actually selected language is shown in the status bar. If no bitmap is found, the name of the language is shown. The bitmap must be a PNG image. Choose a flag from the [http://www.famfamfam.com/lab/icons/flags '''famfamfam_flag_icons'''] and copy it to the directory configured in 'Path settings, Bitmaps' (see above) and rename it to match the name of the dictionary but let the extension png.

Example: If the dictionary files (for one language) are "en_GB.aff" and "en_GB.dic" the the bitmap is named "en_GB.png" .

==Styles to check==
Only text with specific styles gets checked (for example only comments and strings). Styles are automatically set by Scintilla (CodeBlocks editing component).

The file '''OnlineSpellChecking.xml''' contains a list with indices of the styles to check. The indices differ for different programming-languages so the file contains a list for every programming-language. To add styles, look for the name of the programming-language and the indices in the corresponding [https://wiki.codeblocks.org/index.php?title=Creating_a_custom_lexer_for_Code::Blocks_editor#Lexers '''lexer_XY.xml'''] file and add this information to the file OnlineSpellChecking.xml.

For example, to check the spelling of plain text (<tt>*.txt</tt>) files, add the line:
<'''Language''' name="Plain text" index="0" '''/'''>

Installing Code::Blocks from source on Windows

2011-03-01T19:51:03Z

Vodoomoth: /* MinGW compiler */

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

=== Note for RC2 users ===

The older Code::Blocks RC2 does not support global compiler variables which were added after RC2 was released and is unable to read project files generated with post-RC2 versions.
To build Code::Blocks, you need a post-RC2 build, such as ''8.02'' or any of the ''nightly builds'' obtainable by [/index.php?board=20.0 searching the forum].

=== MinGW compiler ===

At the present time, Code::Blocks only compiles successfully with the MinGW compiler (or any other gcc for that matter). You will need a complete, working [[MinGW installation]] or [http://www.tdragon.net/recentgcc/ TDM-MinGW package GCC 4.4.1].

'''Do not''' use the barebones MinGW with GCC 4.5.1 as you'll run (with this specific version) into [http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43601 a linker bug] (which happened to me on Vista SP1 32-bit on 2011-02-28); the solution is to use the TDM-GCC 4.5.1 package.

=== wxWidgets ===

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

Code::Blocks uses
* since 28 March 2009 wxWidgets 2.8.10 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.10.zip wxMSW-2.8.10.zip]

* since 18 October 2008 wxWidgets 2.8.9 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.9.zip wxMSW-2.8.9.zip]

* since 19 July 2008 wxWidgets 2.8.8 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.8.zip wxMSW-2.8.8.zip]

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

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

* since May 2007 wxWidgets 2.8.4 Download: [http://prdownloads.sourceforge.net/wxwindows/wxMSW-2.8.4.zip wxMSW-2.8.4.zip]

For latest infos check forum: [/index.php?topic=3299.0 Important changes to the nightly builds]

You do ''not'' need MSYS (''in fact, if you have MSYS, make sure it is not in your PATH when building wxWidgets'').

=== SVN client ===

In order to check out the Code::Blocks sources you will need a SVN client.
For convenience, it is recommended that you install [http://tortoisesvn.net/downloads TortoiseSVN] on your machine, as this is a lot more comfortable. However, if you get a bad feeling when some program is messing with your Explorer menu, then you can use the [http://subversion.tigris.org/project_packages.html svn command-line client] equally well.

It is generally a good idea to install the command-line client (and adding it to PATH) even if you use TortoiseSVN for convenience. The <tt>autorevision</tt> tool which is used during the build of Code::Blocks makes use of the <tt>svn</tt> binary if it is available. This is preferable to the manual parsing of the entries file that is used as fall-back.

Please do note that working copies checked out with the 1.4 version of Subversion are no longer compatible with earlier versions (Subversion will transparently update existing repositories).

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

=== svn.exe ===
If you want to show the SVN number in your code::blocks dialog box.

[[Image:Svn number.png|300*300px]]

You should also let svn.exe exist in the PATH of your windows system.
A command line SVN package can be download here [http://www.open.collab.net/downloads/subversion/ CollabNet Subversion Command-Line Client v1.6 (for Windows)].

=== zip.exe ===

You'll also need a working 'zip' program.
If you have the version listed on our [https://wiki.codeblocks.org/index.php?title=Mingw#Other_developer_tools tools page], you'll be fine.

The zip program coming with cygwin will ''not'' work properly. You do ''not'' need WinZip.

Make sure the zip binary is in your PATH so the <tt>update.bat</tt> script will be able to find it (alternatively, you can edit the batch file, setting the ZIPCMD variable to something else).

The easiest way is to put zip.exe into <tt>bin</tt> inside your MinGW installation directory (that folder is normally in the path).

=== Code::Blocks sources ===

You will also (obviously) need the Code::Blocks sources.

Using ''TortoiseSVN'', make a folder where you want to store the sources, right-click on the folder, and select "SVN Checkout...".

[[Image:Win svn checkout.png]]

In the top box, enter svn://svn.berlios.de/codeblocks/trunk and hit the OK button.

Using ''svn'', you have to open a command prompt ("DOS Window"). Make a folder, change directory, and run svn:

mkdir codeblocks-head
cd codeblocks-head
svn checkout svn://svn.berlios.de/codeblocks/trunk

== Unicode Build ==

=== Compile wxWidgets in Unicode mode ===

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets:
<pre>
set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1
</pre>
This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

''remark: If you want to use wxWidgets not only for building Code::Blocks, but also for writing wxWidgets programs, and if you want to use the debugger in those programs, you have to compile a debug build of wxWidgets as well.''
''Use the same commands as for the release build, but replace "release" by "debug".''

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

=== Compile Code::Blocks ===
Now, before this step, you have prepared all the stuff to build code::blocks. It's very interesting that we use code::blocks to build code::blocks binaries.

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

[[Image:Global_variable.png]]

[[Image:Global_variable2.png]]

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

[[Image:Win build button.png]]

[[Image:Win build target.png]]

[[Image:Win build finish.png]]

====Copy wxWidgets support DLL====
After the compilation has finished, copy <tt>lib\gcc_dll\wxmsw28u_gcc_custom.dll</tt> from the wxWidgets directory to the <tt>src\devel</tt> directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into dll hell).

[[Image:Win output folder.png]]

[[Image:Win copy dll.png]]

====Runing script file====
Run <tt>src\update.bat</tt> (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.

[[Image:Win run bat.png]]

The stripped ("production") executable is found in <tt>output</tt> together with all libraries and data files. If you want a version with debug symbols instead (caution: huge size!), use the one found in the <tt>devel</tt> folder. 
Congratulations, you own a freshly built version of Code::Blocks!

[[Image:Win final folder.png]]

====Note for future updates====
Go to the Code::Blocks root directory and run <tt>svn update</tt> (or use TurtoiseSVN to the same effect). 
Then open and build the project as described before (and any contrib plugins that you wish to use), and re-run <tt>src\update.bat</tt>.

=== Install Code::Blocks ===

Copy the folder output to where you want Code::Blocks to reside.

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

The workspace file '''ContribPlugins.workspace''' contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). 

[[Image:Contribute plugin.png]]

When you open the contrib plugins workspace, you will be asked to define the <tt>$(#cb)</tt> global compiler variable. This is the path that contains the sdk folder normally this is codeblocks\src. The build process uses this information to place the plugins and data files into the correct place. Enter the location of the Code::Blocks sources in the same way as for the <tt>$(#wx)</tt> variable earlier.

Don't forget to run update.bat again after building the contrib plugins.

== ANSI Build ==

<div style="background-color: #f7d9d9; border: 1px solid #000">
<div style="margin: 5px;">

==== DEPRECATION WARNING: ====
As of February 2006, the official default build for Code::Blocks is '''Unicode''' (see above). Although ANSI builds are technically possible, we discourage their use unless there is a good reason. 
''Support for ANSI builds is likely to be dropped after Version 1.0 is out.''

There is hardly any good argument against using a Unicode build if your OS supports Unicode, even if you do not understand any other language than English, as a Unicode version guarantees that it will be able to work with whatever languages you may possibly encounter in the future -- at a very reasonable cost.

However, if you absolutely don't care about Unicode or if you are bound to use Windows 95, then you may want to build an ANSI version nevertheless.

</div>
</div>

==== Compile wxWidgets in ANSI mode ====

After unpacking the zip file to a directory of your choice, open a cmd prompt, and navigate to the folder build/msw inside the wxWidgets folder. Use the following commands to compile wxWidgets

set path=c:\mingw\bin;c:\mingw\mingw32\bin
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0 clean
mingw32-make -f makefile.gcc USE_XRC=1 SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=0

This assumes your MinGW installation is in C:\mingw. Use a different path if you installed MinGW somewhere else.

You will see a lot of warning messages during compilation. Don't worry, this is normal, you are compiling wxWidgets. The build process may take 10-30 minutes, depending on your computer's speed.

'''Optional:'''

To reduce the size of your wxWidgets library, you can disable features which are not used by Code::Blocks. However, you should not do this unless you know what you are doing. You have to delete the generated setup.h from lib/gcc_dll/msw/wx before building, because your changes to include/wx/msw will otherwise not be honoured.

==== Compile Code::Blocks ====

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

'''Important:''' The project file is set to compile an Unicode version of Code::Blocks by default. To make an ANSI build, you have to make the following two changes to build options before compiling:
1. In the "Compiler" tab, under "#defines", remove the entry wxUSE_UNICODE.
2. Under "Custom variables", set the variable WX_SUFFIX to empty (default value: u).

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

After the compilation has finished, copy wxmsw28u_gcc_custom.dll from lib\gcc_dll inside the wxWidgets directory to the devel directory inside the Code::Blocks source folder (it will also work if you keep a copy of that library in your Windows folder or anywhere in your system path, but this is generally not recommended because you can get into [http://en.wikipedia.org/wiki/DLL_hell dll hell] ).
Run update.bat (located in the root source directory). This will pack the resource files and copy libraries and plugins to their correct locations.
The location of executable is src\output in C::B tree. From here you'll not need the nightly build anymore.

One little note for svn updates and rebuilds : just go into the codeblocks root directory and do '''svn update''' (or use Turtoise svn).

Then run the src/output/codeblocks.exe, reload project, build it, reload plugins workspace, build it, quit codeblocks and re-run update.bat. You'll have an up-to-date C::B in 3 minutes !

==== Install Code::Blocks ====

Copy the folder output to where you want Code::Blocks to reside.

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

The workspace file ContribPlugins.workspace contains the project files for all contributed plugins. Open that workspace and compile the plugins which you would like to use (or select "Build Workspace" from the context menu if you want them all). Don't forget to run update.bat again after building the contrib plugins.

Note that the Nassi Shneiderman plugin (part of the contrib plugins) has a dependency on [http://www.boost.org boost] which is needed to compile this plugin. Boost does not need to be compiled therefore.