Code::Blocks - User contributions [en]

Installing Uniwin remote compiler

2023-05-31T20:45:57Z

Benjamin Loison: /* Troubleshooting */ Correct a link

[[Category:User Documentation]]
== What is Uniwin ==
If you already know what Uniwin is and what it does, please skip to the next section.

This is from Uniwin's readme file:

<tt>
Uniwin is a ssh/sftp based toolset to develop C/C++ systems on remote Unix servers (including all Unix systems supporting ssh and sftp) based on Windows clients. By automatically synchronizing the source files on the client with the server and replacing GNU toolsets with some small stubs for them, Uniwin presents a seamless interface for remote development. Nothing needs to be changed to your favorite development environment just like you are developing on a local system. With a simple configuration procedure, all operations such as editing, compiling, and debugging will be exactly same as developing a local program.

Uniwin also can be used as an automatical SFTP file synchronizing system between local Windows client and remote server. Another usage of Uniwin may be treating it as a FTP to SFTP Bridge. In fact, a fully functioned, multi-threaded FTP to SFTP Bridge is incorporated into the package to support the team synchronizing tools provided by eclipse.

The advantage of Uniwin is it brings no change to you but providing a remote development environment in the backend.
</tt>

The rest of this document will describe everything needed to setup a valid Code::Blocks/Uniwin combination.

== Installing Uniwin ==
The first step is to download Uniwin. You can get it now by clicking [http://sourceforge.net/projects/uniwin here].
Once the file is downloaded you may extract it in any location you like. For the rest of this document I will assume you installed it on the root of the C: drive (e.g. C:\Uniwin).

The next step is to configure it. To do this now, launch C:\Uniwin\Uniwin.exe.

[[Image:Uniwin1.png]]

The "ssh" page defines the SSH connection settings for the build commands.
You need to adjust the fields for your setup:

* Remote host: The name or IP address of the unix host you will build your software on.
* Username: Your username on the remote unix host.
* Password: Your password.
* Leave the rest as they are. They 're sensible defaults.

Now switch to the "sftp" page. SFTP is used to synchronize the local directory with the remote one and vice-versa.

[[Image:Uniwin2.png]]

Edit the top three fields and use the same values as those you used in the "ssh" page.

Next, switch to the "Dir mapping" page. In this page you "map" local directories to remote ones.

[[Image:Uniwin3.png]]

In the picture above you can see that I have defined one directory mapping:
C:\Devel\NetTest --> /home/op/NetTest
What this does is keep those two directories (local and remote) synchronized when any file/folder is changed.

You can add as many directory mappings as you like. Usually one is enough though (the base directory of your workspace/project).

That was all the configuration that was needed. Pretty easy, huh? :).
Now click the OK button. This will close the Uniwin configuration dialog.

'''Very important note:'''

''Uniwin must be running while you work on a project that uses it. This means that you should launch the Uniwin configuration before building a project with Uniwin and let it run while you work on that project. To hide Uniwin out of sight, hit the Close button on the top-right of the window (do '''not''' click OK or Cancel). This will shove it to systray and let it run there.''

== Configuring Code::Blocks for Uniwin ==
The "hard part" is over now. You can return to the comfortable Code::Blocks environment (pun intended) to configure it to use Uniwin ;).

What you need to do is add a new compiler. To do this, click on the menu "Settings->Compiler and debugger".
The dialog that comes up will read "Global compiler settings", which is exactly what we want.

Now, make sure you have the "GNU GCC Compiler" selected in the "Selected compiler" section:

[[Image:Uniwin4.png]]

Click the "Copy" button. Code::Blocks will ask you to enter a name for the new compiler. Use "GCC (Uniwin)" as the name. An informational message will appear. Click OK to close it and switch to the "Programs" page.

Change the installation directory and programs like shown below:

[[Image:Uniwin5.png]]

Once done, switch to the "Other" page and click the button labeled "Advanced options...". In the new dialog that opens, switch to the "Others" page:

[[Image:Uniwin6.png]]

Check the box labeled "Force forward slash as path separator".

That's it! This wasn't so hard, was it?

== Configuring a project for Uniwin ==
This is the easiest part of all :).
Just select the newly added compiler for each project you want to build using Uniwin.

''Don't forget to run Uniwin.exe before trying to build a project using this compiler.''
== Troubleshooting ==
With the current Uniwin versions, you can't actually debug remote projects from inside Code::Blocks. I have patched Uniwin's proxy gdb.exe to allow for this. You can get the patched file from [https://forums.codeblocks.org/index.php?topic=4516.msg36708#msg36708 this forum message]. Just decompress it in Uniwin's folder, replacing the old gdb.exe.

Cscope plugin

2023-05-20T14:07:40Z

Benjamin Loison: /* Installing CScope */ Add a missing dot.

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = Cscope |
logo = [[Image:Generic-plugin.png]] |
developer = Daniel Anselmi |
maintainer = |
version = 0.3
}}

== General information ==

This plugin integrates the source code searching features of [http://cscope.sourceforge.net/ Cscope] into Code::Blocks (a Windows build is available at [http://code.google.com/p/cscope-win32/ Cscope-win32]). Cscope is especially useful on large projects, and can search for:
* all references to a symbol
* global definitions
* functions called by a function
* functions calling a function
* text string
* regular expression pattern
* a file
* files including a file
Although the parser within Cscope is targeted at C, it retains enough flexibility to provide functionality with C++ (and Java) code.
== Installing CScope ==
This instruction is for codeblocks SVN Version > 11828.
=== Linux ===
Under Linux installing cscope should be as easy as calling your favorite package manager and installing cscope. Codeblocks should find the executable by default. If it can not find the cscope executable please set it in Settings->Environement->CScope . You can find the path to the cscope executable by typing <code>locate cscope</code> in your favorite terminal.

=== Windows ===
It is hard to find a precompiled binary for cscope on windows. The easiest solution is to install msys2 [https://www.msys2.org/]. Follow the instruction on the website to install msys2. After installing and updating as described open the msys terminal and type <code>pacman -S cscope</code>. This will install cscope from the global package repository.

Now you have to setup codeblocks:
# Open Codeblocks
# Settings->Environment->CScope
# Press the button with the <code>...</code> dots
# Search the ''cscope.exe'' executable. It is probably under <code>INSTALL_DIRECTORY_OF_MSYS2\usr\bin\cscope.exe</code>
# Close the dialog with OK
# Now you should be able to use the cscope functions in codeblocks (for ex. "Find functions calling XXXX").

Cscope plugin

2023-05-20T14:07:05Z

Benjamin Loison: /* Windows */ Correct a typo.

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = Cscope |
logo = [[Image:Generic-plugin.png]] |
developer = Daniel Anselmi |
maintainer = |
version = 0.3
}}

== General information ==

This plugin integrates the source code searching features of [http://cscope.sourceforge.net/ Cscope] into Code::Blocks (a Windows build is available at [http://code.google.com/p/cscope-win32/ Cscope-win32]). Cscope is especially useful on large projects, and can search for:
* all references to a symbol
* global definitions
* functions called by a function
* functions calling a function
* text string
* regular expression pattern
* a file
* files including a file
Although the parser within Cscope is targeted at C, it retains enough flexibility to provide functionality with C++ (and Java) code.
== Installing CScope ==
This instruction is for codeblocks SVN Version > 11828
=== Linux ===
Under Linux installing cscope should be as easy as calling your favorite package manager and installing cscope. Codeblocks should find the executable by default. If it can not find the cscope executable please set it in Settings->Environement->CScope . You can find the path to the cscope executable by typing <code>locate cscope</code> in your favorite terminal.

=== Windows ===
It is hard to find a precompiled binary for cscope on windows. The easiest solution is to install msys2 [https://www.msys2.org/]. Follow the instruction on the website to install msys2. After installing and updating as described open the msys terminal and type <code>pacman -S cscope</code>. This will install cscope from the global package repository.

Now you have to setup codeblocks:
# Open Codeblocks
# Settings->Environment->CScope
# Press the button with the <code>...</code> dots
# Search the ''cscope.exe'' executable. It is probably under <code>INSTALL_DIRECTORY_OF_MSYS2\usr\bin\cscope.exe</code>
# Close the dialog with OK
# Now you should be able to use the cscope functions in codeblocks (for ex. "Find functions calling XXXX").

Cscope plugin

2023-05-20T14:03:38Z

Benjamin Loison: /* Windows */ Remove unnecessary square brackets.

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = Cscope |
logo = [[Image:Generic-plugin.png]] |
developer = Daniel Anselmi |
maintainer = |
version = 0.3
}}

== General information ==

This plugin integrates the source code searching features of [http://cscope.sourceforge.net/ Cscope] into Code::Blocks (a Windows build is available at [http://code.google.com/p/cscope-win32/ Cscope-win32]). Cscope is especially useful on large projects, and can search for:
* all references to a symbol
* global definitions
* functions called by a function
* functions calling a function
* text string
* regular expression pattern
* a file
* files including a file
Although the parser within Cscope is targeted at C, it retains enough flexibility to provide functionality with C++ (and Java) code.
== Installing CScope ==
This instruction is for codeblocks SVN Version > 11828
=== Linux ===
Under Linux installing cscope should be as easy as calling your favorite package manager and installing cscope. Codeblocks should find the executable by default. If it can not find the cscope executable please set it in Settings->Environement->CScope . You can find the path to the cscope executable by typing <code>locate cscope</code> in your favorite terminal.

=== Windows ===
It is hard to find a precompiled binary for cscope on windows. The easiest solution is to install msys2 [https://www.msys2.org/]. Follow the instruction on the website to install msys2. After installing and updating as described open the msys terminal and type <code>pacman -S cscope</code>. This will install cscope from the global package repository.

Now you have to setup codeblocks:
# Open Codeblocks
# Settings->Environment->CScope
# Press the button with the <code>...</code> dots
# Search the ''cscope.exe'' executable. It is probably under <code>INSTALL_DIRECTORY_OD_MSYS2\usr\bin\cscope.exe</code>
# Close the dialog with OK
# Now you should be able to use the cscope functions in codeblocks (for ex. "Find functions calling XXXX").

Cscope plugin

2023-05-20T13:22:59Z

Benjamin Loison: /* General information */ Correct a typo.

[[Category: Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = Cscope |
logo = [[Image:Generic-plugin.png]] |
developer = Daniel Anselmi |
maintainer = |
version = 0.3
}}

== General information ==

This plugin integrates the source code searching features of [http://cscope.sourceforge.net/ Cscope] into Code::Blocks (a Windows build is available at [http://code.google.com/p/cscope-win32/ Cscope-win32]). Cscope is especially useful on large projects, and can search for:
* all references to a symbol
* global definitions
* functions called by a function
* functions calling a function
* text string
* regular expression pattern
* a file
* files including a file
Although the parser within Cscope is targeted at C, it retains enough flexibility to provide functionality with C++ (and Java) code.
== Installing CScope ==
This instruction is for codeblocks SVN Version > 11828
=== Linux ===
Under Linux installing cscope should be as easy as calling your favorite package manager and installing cscope. Codeblocks should find the executable by default. If it can not find the cscope executable please set it in Settings->Environement->CScope . You can find the path to the cscope executable by typing <code>locate cscope</code> in your favorite terminal.

=== Windows ===
It is hard to find a precompiled binary for cscope on windows. The easiest solution is to install msys2 [[https://www.msys2.org/]]. Follow the instruction on the website to install msys2. After installing and updating as described open the msys terminal and type <code>pacman -S cscope</code>. This will install cscope from the global package repository.

Now you have to setup codeblocks:
# Open Codeblocks
# Settings->Environment->CScope
# Press the button with the <code>...</code> dots
# Search the ''cscope.exe'' executable. It is probably under <code>INSTALL_DIRECTORY_OD_MSYS2\usr\bin\cscope.exe</code>
# Close the dialog with OK
# Now you should be able to use the cscope functions in codeblocks (for ex. "Find functions calling XXXX").