| Note | ||
|---|---|---|
| ||
This page needs your help to finish. |
Tips on how to configure Eclipse to contribute to sipXconfig project.
| Tip |
|---|
If you are building sipXecs older than 4.5, look at this page's history for any specific details. |
General Remarks
You should feel free to use whatever developement environment suits your needs. If you happen to use NetBeans, emacs or anything else please share your experience. Let sipx-dev@sipfoundry.org us know if you would like to keep configuration files for your environment in sipXconfig subversion repository.
...
- excellent code browser
- built-in refactoring support
- code formatter that can be configured to comply with sipX coding standards
- unit test support - writing and executing unit test from IDE
- good subversion plugin - commit, update, diff and graphical merge support
- other plugins for libraries and technologies used in sipXconfig: SQL Explorer, Spring, Tapestry, XML etc.
- decent remote debugging support
- decent GWT debugging support
Installation
Get the latest stable build of Eclipse and install it on the system. Some Linux distributions (Fedora Core 4) include eclipse. However Eclipse install without any problems on Linux, Windows and Mac OS X.
...
Eclipse has a notion of workspaces and project. Workspace is a set of related projects that share common options (compilation, code formatting etc.). From my experience it's best to have one workspace per subversion branch (i.e. a separate workspaces for main, 2.8, 2.6 etc.)
Configuration
Set common configuration options.
Classpath
- Go to Windows->Preference screen
- Select Java->Build Path->Classpath Variables and add the following
| Panel |
|---|
SIPX_SRC_TOPSRCDIR=path to top source directory SIPX SIPXCONFIG_BUILD_TOP=path to top build directory |
If you are working on sipXconfig 4.0 or earlier you also need:
| Panel |
|---|
SIPX_CONFIG=path to sipXconfig directory - SIPX_SRC_TOP/sipXconfig |
The sipXconfig directory is located where you checked it out using Subversion or git.
You need a separate Eclipse workspace for each Eclipse branch, since each branch will have a different SIPX_SRC_TOP setting.
| Panel |
|---|
JAVA_LIBDIR=path to the default jar installation directory |
On most systems it will be: /usr/share/java. If your distribution is using jpackage-utils to install java packages you can probably find the proper value for this property by running:
| Panel |
|---|
grep JAVA_LIBDIR /etc/java/java.conf |
If you have source code for Tapestry, Spring, and other modules, then set the LIB_SRC variable to point to the parent directory of the directory in which sources are kept, for example:
| Panel |
|---|
LIB_SRC=/opt/libsrc |
...
SRCDIR=SIPX_SRCDIR/sipXconfig used to avoid some circular imports in Eclipse |
You need a separate Eclipse workspace for each source code directory, since each branch will have a different SIPX_SRCDIR setting.
Classpath variables used in other projects:
| Panel |
|---|
SIPX_PREFIX=path to top install directory |
Java Code Style Options
Go to Windows->Preferences->Java->Code Style
...
Consider configuring Save Actions to clean-up changed files and format changed lines in the file.
Java Compatibility Options
SipXconfig requires Java 1.6:
- Go to Windows->Preferences->Java->Compiler and check that the "compiler compliance level" is set to 1.6.
- Go to Windows->Preferences->Java->Installed JREs and select a 1.6 JRE. If there is no 1.6 JRE on your computer, then you will need to install one.
Other useful options
Plugins
Installing these plugins is optional, but they do have plenty of features that would simplify developement.
...
Other plugins have to be downloaded and install manually (by copying the plugin to /path/to/eclipse/plugins directory).
Checkstyle Plugin
Step 1. Install checkstyle plugin from with update URL: http://eclipse-cs.sf.net/update/
Step 2. Go to Window->Preferences->Checkstyle
Step 3. Click "New..." in the "Global Check Configurations" and add new "External Configuration File" entry call "sipxecs" with location specifying path to your-source-directory/config/checkstyle/checktyle.xml. Before leaving this dialog, click on "Additional properties", and specify your-source-directory/config/checkstyle for variable "top.dir"
Step 4. Click on the new "sipxecs" Check Configuration and "Set as Default" button.
Projects
The last step is opening sipXconfig projects. All necessary configuration files are kept in subversion repository (these are .project and .classpath file in sipXconfig subdirectories) - it's easy to open projects in Eclipse by importing them.
- go to File->Import...
- select General->Existing Project into Workspace
- browse for your sipXconfig sipXecs source code directory (the same as set in SIPX_CONFIG SRCDIR property above) and press OK
- Eclipse 3.1 will find all sipXconfig eclipse projects (neoconf, web, profilegenerator etc.), older versions of Eclipse will prompt you for each project separatelypress Select All, and , select only the project you think you'll need. You will almost alway need sipXcommons project because most project will require that project to be loaded.
- press Finish
All projects are automatically compiled in background. You are ready to go.
Using Eclipse for C/C++ projects
Eclipse can be used as a C/C++ development environment. You need to install the C/C++ Development Toolkit (CDT) that can be found at http://www.eclipse.org/cdt/ .
You will need to get Eclipse (version 3.3.0 at least) (http://www.eclipse.org/downloads/) and the Eclipse CDT (download.eclipse.org/tools/cdt/releases/europa).
Please see this document for more details.
Eclipse on Gentoo
...
.
...