Code::Blocks - User contributions [en]

Code::Blocks Plugins

2010-07-01T10:23:49Z

Rirififi:

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

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

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

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

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

OR

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

OR

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

THEN

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

== Core Plugins ==

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

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

:Saves project files between intervals.

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

:Provides wizard for creating new classes.

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

:Provides code completion functionality and class browser.

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

:Provides support for various compilers in one interface.

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

:Provides support for various debuggers in one interface.

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

:Adds extra file extension handlers.

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

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

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

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

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

:Provides scripted wizard functionality.

'''[[Source Code Formatter plugin|Source Code Formatter]]'''

:Formats source code files with specific style.

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

:Adds to-do items to source code.

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

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

== Contrib Plugins ==

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

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

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

'''[[Browse Tracker plugins|Browse Tracker]]'''

:Browse to previous source positions.

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

:Games in a integrated development environment? You bet.

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

:Provides graphical interface to GNU GProf profiler.

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

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

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

:Shows various statistics from source code files.

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

:Copies literal strings from the current editor to clipboard.

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

:Installs and updates DevC++ DevPaks.

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

:Enables dragging and scrolling with mouse.

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

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

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

:Integrates third-party help files to the interface.

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

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

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

:Manages menu shortcuts.

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

:Queries the Koders webpage for keywords.

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

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

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

:Regular expressions testbed.

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

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

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

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

'''[[ThreadSearch]]'''

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

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

:Valgrind analysis tools integration.

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

:RAD tool for creating wxWidgets dialogs.

== 3rd Party Plugins ==

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

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

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

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

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

'''[[TRACE32 Debugger]]'''

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

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

AutoVersioning plugin

2009-01-20T14:34:36Z

Rirififi:

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = AutoVersioning |
logo = [[Image:AutoVersioningLogo.png]] |
developer = [[User:jgm|JGM]], [[User:killerbot|KILLERBOT]] |
maintainer = JGM |
version = 1.1
}}

An application versioning plug in that increments the version and build number of your application every time a change has been made and stores it in version.h with easy to use variable declarations. Also have a feature for committing changes a la SVN style, a version scheme editor, a change log generator and more...

==Introduction==
The idea of the AutoVersioning plugin was made during the development of a pre-alpha software that required the version info and status. Been to busy coding, without time to maintain the version number, just decided to develop a plugin that could do the job with little intervention as possible.

==Features==
Here is the list of features the plugin covers summarized:

*Supports C and C++.
*Generates and auto increment version variables.
*Software status editor.
*Integrated scheme editor for changing the behavior of the auto incrementation of version values.
*Date declarations as month, date and year.
*Ubuntu style version.
*Svn revision check.
*Change log generator.
*Works on Windows and Linux (doesn't have Mac to test).

==Sources==
Usually source and news about new releases are posted on the Code::Blocks forums on the plugins development section. You can access this plugin topic over [/index.php/topic,6294.msg48225.html#msg48225 here], recent sources are attached on the first post (you have to be logged in to download attachments on the forum).

The plugin also have a project page at [http://www.berlios.de www.berlios.de]. The link is [http://developer.berlios.de/projects/autoversioning/ http://developer.berlios.de/projects/autoversioning/]. Submit all features request and bugs on the project page.

Svn check out: '''svn://svn.berlios.de/autoversioning'''

==Usage==

After downloading the sources, compiling them and installing the plugin to Code::Blocks just go to '''Project->Autoversioning''' menu. A pop up window like this will appear: 
[[Image:AvAskConfigure.png]] 

When hitting yes on the ask to configure message box, the main auto versioning configuration dialog will open, to let you configure the version info of your project. Each editable control has a tool tip with information that explains you its features, so if you put the mouse on the control the tool tip will pop up. Below is a low quality screenshot showing all the tabs: 
[[Image:AvDialog.png]] 

After configuring your project for auto versioning, the settings that you entered on the configuration dialog will be stored on the project file, and a version.h file will be created. For now, every time that you hit the '''Project->Autoversioning''' menu the configuration dialog will popup to let you edit your project version and versioning related settings, unless you don't save the new changes made by the plugin to the project file.

==Dialog notebook tabs==

===Version Values===

Here you just enter the corresponding version values or let the auto versioning plugin increment them for you.

*Major - Increments by 1 when the minor version reaches its maximum
*Minor - Increments by 1 when the build number pass the barrier of build times, the value is reset to 0 when it reach its maximum value.
*Build number (also equivalent to Release) - Increments by 1 every time that the revision number is incremented.
*Revision - Increments randomly when the project has been modified and then compiled.

===Status===

Some fields to keep track of your software status with a list of predefined values for convenience.

*Software Status - The typical example should be v1.0 Alpha
*Abbreviation - Same as software status but like this: v1.0a

===Scheme===

Lets you edit how the plugin will increment the version values.

*Minor maximum - The maximum number that the Minor value can reach, after this value is reached the Major is incremented by 1 and next time project is compiled the Minor is set to 0.
*Build Number maximum - When the value is reached, the next time the project is compiled is set to 0. Put a 0 for unlimited.
*Revision maximum - Same as Build Number maximum. Put a 0 for unlimited
*Revision random maximum - The revision increments by random numbers that you decide, if you put here 1, the revision obviously will increment by 1.
*Build times before incrementing Minor - After successful changes to code and compilation the build history will increment, and when it reaches this value the Minor will increment.

===Settings===

Here you can set some settings of the auto versioning behavior.

*Autoincrement Major and Minor - lets the plugin increments this values by you using the scheme. If not marked only the Build Number and Revision will increment.
*Create date declarations - create entries in the version.h file with dates and ubuntu style version.
*Do Auto Increment - this tells the plugin to automatically increment the changes when a modification is made, this incrementation will occur before compilation.
*Header language - select the language output of version.h
*Ask to increment - if marked, ''Do Auto Increment'', it ask you before compilation (if changes has been made) to increment the version values.
*svn enabled - search for the svn revision and date in the current folder and generates the correct entries in version.h

===Changes Log===

This lets you enter every change made to the project to generate a '''ChangesLog.txt''' file.

*Show changes editor when incrementing version - will pop up the changes log editor when incrementing the version.
*Title Format - a format able title with a list of predefined values.

==Including in your code==
To use the variables generated by the plugin just ''#include <version.h>'' (or the real name in case you changed the default name). An example code would be like the following:
<pre>
#include <iostream>
#include "version.h"

void main(){
std::cout<<AutoVersion::MAJOR<<endl;
}
</pre>

===Output of version.h===
The generated header file. Here is a sample content of the file on c++ mode: 
<pre>
#ifndef VERSION_H
#define VERSION_H

namespace AutoVersion{

//Date Version Types
static const char DATE[] = "15";
static const char MONTH[] = "09";
static const char YEAR[] = "2007";
static const double UBUNTU_VERSION_STYLE = 7.09;

//Software Status
static const char STATUS[] = "Pre-alpha";
static const char STATUS_SHORT[] = "pa";

//Standard Version Type
static const long MAJOR = 0;
static const long MINOR = 10;
static const long BUILD = 1086;
static const long REVISION = 6349;

//Miscellaneous Version Types
static const long BUILDS_COUNT = 1984;
#define RC_FILEVERSION 0,10,1086,6349
#define RC_FILEVERSION_STRING "0, 10, 1086, 6349\0"
static const char FULLVERSION_STRING[] = "0.10.1086.6349";

}
#endif //VERSION_h
</pre>

On C mode is the same as C++ but without the namespace: 
<pre>
#ifndef VERSION_H
#define VERSION_H

//Date Version Types
static const char DATE[] = "15";
static const char MONTH[] = "09";
static const char YEAR[] = "2007";
static const double UBUNTU_VERSION_STYLE = 7.09;

//Software Status
static const char STATUS[] = "Pre-alpha";
static const char STATUS_SHORT[] = "pa";

//Standard Version Type
static const long MAJOR = 0;
static const long MINOR = 10;
static const long BUILD = 1086;
static const long REVISION = 6349;

//Miscellaneous Version Types
static const long BUILDS_COUNT = 1984;
#define RC_FILEVERSION 0,10,1086,6349
#define RC_FILEVERSION_STRING "0, 10, 1086, 6349\0"
static const char FULLVERSION_STRING[] = "0.10.1086.6349";

#endif //VERSION_h
</pre>

==Change log generator==
This dialog is accessible from the menu '''Project->Changes Log'''. Also if checked '''Show changes editor when incrementing version''' on the changes log settings, the window will open to let you enter the list of changes after a modification to the project sources or an incrementation event. Below is an example screen shot: 

[[Image:AvChangesList.png]] 

===Buttons Summary===
*Add - appends a row in to the data grid
*Edit - enables the modification of the selected cell
*Delete - removes the current row from the data grid
*Save - stores into a temporary file (changes.tmp) the actual data for later procesing into the changes log file
*Write - process the data grid data to the changes log file
*Cancel - just closes the dialog without taking any action

 

Here is an example of the output generated by the plugin to the ChangesLog.txt file: 
<pre>
03 September 2007
released version 0.7.34 of AutoVersioning-Linux

Change log:
-Fixed: pointer declaration
-Bug: blah blah

02 September 2007
released version 0.7.32 of AutoVersioning-Linux

Change log:
-Documented some areas of the code
-Reorganized the code for readability

01 September 2007
released version 0.7.30 of AutoVersioning-Linux

Change log:
-Edited the change log window
-If the change log windows is leave blank no changes.txt is modified
</pre>