Revision as of 01:18, 9 April 2011

Eclipse CDT can be used as a multi-feature editor and debugger for gnucash. Eclipse is a Java IDE but has a C/C++ project which has become quite mature. See www.eclipse.org/cdt/

Eclipse 3.6 and gnucash

With Eclipse 3.6 ("Helios") and the "Eclipse CDT 7.x" installed, using eclipse to develop gnucash is rather easy:

• Get a local working copy of gnucash from SVN, as described on the SVN page, as follows:

svn checkout http://svn.gnucash.org/repo/gnucash/trunk gnucash
cd gnucash

• Open a console and change into the directory of the newly created working copy. As described on Building, call

./autogen.sh
./configure

• If that completed without error, start your Eclipse 3.6. Choose File -> New -> Other... -> C++ -> "Makefile Project with Existing Code". Choose some project name for yourself, and choose the newly created working copy directory as "Existing Code Location". Choose the "GNU Autotools Toolchain" as toolchain. Click Finish.

You can now edit the source code and also call "Build Project", and this will work as expected, i.e. it will result in the "gnucash" executable in src/bin.

Getting eclipse 3.x to work with gnucash

Precondition: Check out the sources. It might be best to make sure first that gnucash compiles and installs, before starting over with eclipse.

1. Download Eclipse IDE for C/C++ Developers from [1] and extract to some folder
2. Start eclipse
3. Create a new C-Project: File->New -> Empty C-Project:
   1. Location: enter the path to the existing source folder (e.g. C:\soft\gnucash\repos)
   2. deselect "Show project types and toolsets only if they are supported by the platform"
   3. Select Toolchain: "MinGW GCC"
4. Import include files: This is somehow ugly because you must set each directory you require.

   To browse the .h-includefiles you must enter each folder to the include path:

   • Project ->Properties -> C/C++ Build -> Tab "Tool Settings" -> Directories: add the relevant include paths: e.g. "${workspace_loc:/gnucash/lib/libqof/backend}", ${workspace_loc:/gnucash/src/app-utils} etc. and C:\soft\gnome\include\gtk-2.0 and so on

   See also http://wiki.eclipse.org/CDT/User/FAQ#How_do_I_add_an_external_library_to_my_C.2B.2B_project.3F

There is much more support available:

• Plugin for Subversion integration (subclipse). This is very helpful, because differences are highlighted in the editor. (Install Subclipse and also the Client Adapter for JavaHL. Then open the context menu on the project and select Team->Share Project)
• Scheme editor plugin: schemeway (You will also have to install "Eclipse Java development tools" and "Eclipse plug-in development environment" via Help->Software Updates->Available Software-><eclipse version codename> e.g. Ganymede.)

Edit

Some useful hints for editing:

• CTRL+Shift+T: Open Element (function, variable, Macro etc)
• CTRL+Shift+R: Open file
• F3: open the definition of an element
• CTRL+Alt+h: open call hierarchy

... and much more...

Build (not to build)

Eclipse won’t be a good help for building. You are always faster if you make_install in a shell window for the directory tree you were editing. To avoid annoying warnings, you should turn off automatic build:

• Project -> Build automatically
• Preferences->Run/Debug->Launching->"build (if required) before launching".

Debug

You can use eclipse as a debugging interface. The idea is to attach eclipse to the running gnucash process.

1. Run->Open Debug Dialog ->"C/C++ Attach to local app" -> New
2. Select C:\soft\gnucash\inst\bin\gnucash-bin.exe
3. You must specify the path to your source folder: Path mapping "../../../repos" to "C:\soft\gnucash\repos"
4. Now start gnucash as usual from inst/bin (ignore warnings about errors in workspace)
5. Launch your debugging configuration in eclipse
6. Select the process to attach to (gnucash-bin.exe)
7. The process will be interrupted. Try if you can browse to gnc_ui_start_event_loop. If not start over with the Source tab (see step 3).
8. Make sure you have put some breakpoints in and hit Continue
9. If a breakpoint is encountered you can step through with F6, F5 etc., inspect variables and so on.

Eclipse 3.5 for GnuCash under Ubuntu / Debian

It's 2010/02/24 and the latest stable Ubuntu is 9.10 "Karmic." I believe the Debian procedure may be similar. HOWEVER, the Ubuntu packages may not be in sync with Debian.

There have been some bugs reported that affect the function of the Eclipse windows and buttons. See http://blog.export.be/2009/10/fixing-eclipse-for-ubuntu-karmic-koala-9-10/ and https://bugs.eclipse.org/bugs/show_bug.cgi?id=291257 for some details, and a corresponding Launchpad bug with workaround is here: https://bugs.launchpad.net/ubuntu/+source/eclipse/+bug/458703

This problem with GTK may explain the redraw issues I describe in the steps below...?

Install Eclipse

Open Synaptic Package Manager or Aptitude or whatever and install the Eclipse package. The current version as of these instructions is "Galileo," version 3.5.1.

Add Plugin and Development Tool Software Sites

For some reason the Eclipse package installs with NO default links to the standard software sites. So the Help --> Install New Software panel has NOTHING in it until you add the appropriate URLs.

• Add the Galileo repository: click Add...

Name: Galileo
Location: http://download.eclipse.org/releases/galileo

• Add the Schemeway repository: click Add...

Name: Schemeway
Location: http://schemeway.sourceforge.net/update-site

• Once the software sites are included it's easy to install the C environment and Schemeway.

Install C/C++

1. choose Help --> Install New Software
2. In the Work with menu, choose Galileo. (For some odd reason, nothing shows up in the software list on my system. I found I could put a * or Enter or something in the filter text field and the software list shows up.)
3. Scroll down to Programming Languages
4. Choose Eclipse C/C++ Development Tools (Currently this installs version 6.0.0.200909110608)
5. Click the Next button a few times, maybe answer a licensing question, and then the Finish button. It takes a few minutes to finish.

Install Schemeway

1. (You may already be here) Help --> Install New Software
2. In the Work With menu, choose Schemeway.
3. Put an * or Enter or something in the filter text field to make the list show up.
4. Choose "SchemeWay Feature" (Currently this installs version 1.2.15)
5. Click the Next button a few times, maybe answer a licensing question, and then the Finish button. It takes a few seconds to finish.