Difference between revisions of "Compiling EiffelStudio"

(Updated instructions to the Gobo 3.5 release which we are using for the 6.0 release now)
(Updated to 15.01)
 
(49 intermediate revisions by 8 users not shown)
Line 4: Line 4:
 
== Installing EiffelStudio ==
 
== Installing EiffelStudio ==
  
−
To compile EiffelStudio, you need an already working EiffelStudio compiler on your machine. The current source tree '''requires at least version 6.0''' of EiffelStudio. You can download it from http://eiffelsoftware.origo.ethz.ch/downloads/builds/. Read the [http://docs.eiffel.com/eiffelstudio/installation/index.html existing documentation] to install EiffelStudio.
+
To compile EiffelStudio, you need an already working EiffelStudio compiler on your machine. The current source tree '''requires at least version 15.01''' of EiffelStudio. You can download it from [[Downloads]]. Read the [http://docs.eiffel.com/eiffelstudio/installation/ existing documentation] to install EiffelStudio.
  
−
'''Note:''' on Windows you will need the Microsoft C compiler to compile Eiffel Studio. How to install the free version of the Microsoft C compiler: [[Installing Microsoft C compiler]]. It is not possible to compile EiffelStudio with the free Borland compiler.
+
'''Note:''' on Windows you will need the Microsoft C compiler to compile Eiffel Studio. How to install the free version of the Microsoft C compiler: [[Installing Microsoft C compiler]]. It is not possible to compile EiffelStudio with the MinGW C compiler (GCC).
  
 
===Compilation methods===
 
===Compilation methods===
 
Currently there are two compilation methods.  
 
Currently there are two compilation methods.  
−
* You can use one of the [[Automatic Build Scripts]]
+
* You can compile EiffelStudio from scratch following the instructions in this document ('''This is the recommended approach''').
−
* Alternatively you can compile EiffelStudio from scratch following the instructions in this document.
+
* You can use one of the [[Automatic Build Scripts]], and if you encounter any errors please report them to the [http://forums.eiffel.com EiffelStudio Development forum].
−
 
+
−
If possible, use the [[Automatic Build Scripts]] and report any errors to the [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-devel developer mailing list].
+
  
 
==Extracting source code==
 
==Extracting source code==
 +
 +
Before checking out the source code, make sure to configure subversion properly using the [[Subversion_Settings|following instructions]].
  
 
===Checking out from SVN===
 
===Checking out from SVN===
−
#Point the environment variables called '''EIFFEL_SRC''' and '''ISE_LIBRARY''' to the directory where you want to compile EiffelStudio<br>Usually we use the '''XXdev''' convention for this directory name - where XX is the version number from the current developped version of the compiler.
+
#Point the environment variables called '''EIFFEL_SRC''' and '''ISE_LIBRARY''' to the directory where you want to compile EiffelStudio.<br>Usually we use the '''XXdev''' convention for this directory name - where XX is the version number of the currently developed version of the compiler.
−
#Make sure that '''ISE_EIFFEL''', '''ISE_PLATFORM''' and '''ISE_C_COMPILER''' (on windows only) are properly defined
+
#Make sure that '''ISE_EIFFEL''', '''ISE_PLATFORM''' and '''ISE_C_COMPILER''' (on Windows only) are properly defined. '''ISE_EIFFEL''' should point to the directory where you installed EiffelStudio, '''ISE_PLATFORM''' is the name of your platform (see [http://docs.eiffel.com/book/eiffelstudio/software-installation-eiffelstudio our documentation website for more details]) and '''ISE_C_COMPILER''' is only for the Windows platforms and it has to be msc (Visual Studio). At this time we do not support mingw (GCC) on Windows due to Microsoft specific dependencies.
 
#Perform the following checkout procedures:
 
#Perform the following checkout procedures:
  
Line 25: Line 25:
 
'''DOS'''
 
'''DOS'''
 
<pre>
 
<pre>
−
set SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
+
set SVNURL=https://svn.eiffel.com/eiffelstudio/trunk
−
svn co %SVNURL%/trunk/Src 60dev
+
svn co %SVNURL%/Src 15.01_dev
−
svn co %SVNURL%/trunk/Delivery 60dev/Delivery
+
svn co %SVNURL%/free_add_ons 15.01_dev/free_add_ons
−
svn co %SVNURL%/trunk/Documentation 60dev/Documentation
+
−
svn co %SVNURL%/trunk/free_add_ons 60dev/free_add_ons
+
 
</pre>
 
</pre>
  
 
'''Bash'''
 
'''Bash'''
 
<pre>
 
<pre>
−
export SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
+
export SVNURL=https://svn.eiffel.com/eiffelstudio/trunk
−
svn co $SVNURL/trunk/Src 60dev
+
svn co $SVNURL/Src 15.01_dev
−
svn co $SVNURL/trunk/Delivery 60dev/Delivery
+
svn co $SVNURL/free_add_ons 15.01_dev/free_add_ons
−
svn co $SVNURL/trunk/Documentation 60dev/Documentation
+
−
svn co $SVNURL/trunk/free_add_ons 60dev/free_add_ons
+
 
</pre>
 
</pre>
  
  
−
To update the sourcefiles to the latest revision, perform the following steps:
+
To update the source files to the latest revision, perform the following steps:
  
 
'''Bash and DOS'''
 
'''Bash and DOS'''
 
<pre>
 
<pre>
−
cd 60dev
+
cd 15.01_dev
 
svn up
 
svn up
 
svn up free_add_ons
 
svn up free_add_ons
−
svn up Delivery
 
−
svn up Documentation
 
−
</pre>
 
−
 
−
==Installing gobo==
 
−
 
−
Please make sure to use the version provided as testing has only been done with Gobo 3.5.
 
−
 
−
===Windows specific===
 
−
 
−
You have to extract the gobo distribution from $EIFFEL_SRC/free_add_ons/gobo/gobo_35_win.tbz2 and extract it into $EIFFEL_SRC/library. Here is how to do it:
 
−
 
−
'''DOS'''
 
−
<pre>cd %EIFFEL_SRC%\library
 
−
tar xvfj %EIFFEL_SRC%\free_add_ons\gobo\gobo_35_win.tbz2
 
−
</pre>
 
−
 
−
'''Bash'''
 
−
<pre>cd $EIFFEL_SRC/library
 
−
tar xvfj $EIFFEL_SRC/free_add_ons/gobo/gobo_35_win.tbz2
 
−
</pre>
 
−
 
−
===Unix specific===
 
−
 
−
You have to extract the gobo distribution from $EIFFEL_SRC/free_add_ons/gobo/gobo_35_unix.tbz2 and extract it into $EIFFEL_SRC/library. Here is the list of commands to do this:
 
−
<pre>cd $EIFFEL_SRC/library
 
−
tar xvjf $EIFFEL_SRC/free_add_ons/gobo/gobo_35_unix.tbz2
 
 
</pre>
 
</pre>
  
Line 81: Line 50:
  
 
===Compiling run-time on Windows===
 
===Compiling run-time on Windows===
−
 
−
Before being able to compile the run-time, you need to ensure that '''bash''' is in your '''PATH'''. You can download it from [http://www.cygwin.com http://www.cygwin.com]. Also make sure, that the path to the binaries of your c compiler is placed before the path to cygwin or else the wrong linker will be used. Once done you can do:<br>
 
−
 
  
 
'''DOS'''
 
'''DOS'''
 
<pre>cd %EIFFEL_SRC%/C
 
<pre>cd %EIFFEL_SRC%/C
−
configure [win32|win64] [b|m]</pre>
+
configure [win32|win64] [b|g|m|m6]</pre>
  
 
'''Bash'''
 
'''Bash'''
 
<pre>cd $EIFFEL_SRC/C
 
<pre>cd $EIFFEL_SRC/C
−
./configure.bat [win32|win64] [b|m]</pre>
+
./configure.bat [win32|win64] [b|g|m|m6]</pre>
  
−
The first argument indicated whether you are compiling the run-time for 32 or 64 bits. The second one is to tell which C compiler will be used. For now only `b' (Borland), `m' (Microsoft) and `m6' (for those forced to use Microsoft VC++ 6.0) are officially supported. We also informally support `g' (GCC) and `l' (LCC).
+
The first argument indicated whether you are compiling the run-time for 32 or 64 bits. The second one is to tell which C compiler will be used. For now only `b' (Borland), `g' (MinGW), `m' (Microsoft) and `m6' (for those forced to use Microsoft VC++ 6.0) are officially supported.
  
−
On Windows 32 bits to clean up all the generated files you do:
+
On Windows 32 bits to clean up all the generated files '''(including the library files needed by EiffelStudio)''' it suffices to do:
  
 
'''DOS'''
 
'''DOS'''
Line 109: Line 75:
 
This requires that '''ISE_PLATFORM''' is properly defined. The `quick_configure' script will look for the file CONFIGS/$ISE_PLATFORM and use it to extract the platform specific information to compile the run-time. If not found then an error will be reported.
 
This requires that '''ISE_PLATFORM''' is properly defined. The `quick_configure' script will look for the file CONFIGS/$ISE_PLATFORM and use it to extract the platform specific information to compile the run-time. If not found then an error will be reported.
  
−
To clean up the generated files:
+
To clean up the generated files '''including the library files needed by EiffelStudio''':
 
<pre>make clobber</pre>
 
<pre>make clobber</pre>
  
Line 118: Line 84:
 
'''DOS'''
 
'''DOS'''
 
<pre>cd %EIFFEL_SRC%\library\net\Clib
 
<pre>cd %EIFFEL_SRC%\library\net\Clib
−
make_msc.bat
+
finish_freezing -library
 
cd %EIFFEL_SRC%\library\vision2\Clib
 
cd %EIFFEL_SRC%\library\vision2\Clib
−
make_msc.bat
+
finish_freezing -library
 
cd %EIFFEL_SRC%\library\wel\Clib
 
cd %EIFFEL_SRC%\library\wel\Clib
−
make_msc.bat</pre>
+
finish_freezing -library
 +
cd %EIFFEL_SRC%\library\cURL\Clib
 +
finish_freezing -library
 +
cd %EIFFEL_SRC%\library\web_browser\Clib
 +
finish_freezing -library</pre>
 
'''Bash'''
 
'''Bash'''
 
<pre>cd $EIFFEL_SRC/library/net/Clib
 
<pre>cd $EIFFEL_SRC/library/net/Clib
−
./make_msc.bat
+
finish_freezing -library
 
cd $EIFFEL_SRC/library/vision2/Clib
 
cd $EIFFEL_SRC/library/vision2/Clib
−
./make_msc.bat
+
finish_freezing -library
 
cd $EIFFEL_SRC/library/wel/Clib
 
cd $EIFFEL_SRC/library/wel/Clib
−
./make_msc.bat</pre>
+
finish_freezing -library
 +
cd $EIFFEL_SRC/library/cURL/Clib
 +
finish_freezing -library
 +
cd $EIFFEL_SRC/library/web_browser/Clib
 +
finish_freezing -library</pre>
  
 
On Unix it is slightly different:
 
On Unix it is slightly different:
Line 137: Line 111:
 
finish_freezing -library
 
finish_freezing -library
 
cd $EIFFEL_SRC/library/vision2/implementation/gtk/Clib
 
cd $EIFFEL_SRC/library/vision2/implementation/gtk/Clib
 +
finish_freezing -library
 +
cd $EIFFEL_SRC/library/cURL/Clib
 
finish_freezing -library</pre>
 
finish_freezing -library</pre>
  
Line 143: Line 119:
 
===Compiling C code from C_library===
 
===Compiling C code from C_library===
  
−
This is only required on Windows to read PNG file. On Unix, this is not required because it is included in GTK+2.4. Simply do the following:
+
This is only required on Windows to read PNG file. On Unix, this is not required because it is included in GTK+2.4. So on Windows, simply do the following:
  
 
'''DOS'''
 
'''DOS'''
 
<pre>cd %EIFFEL_SRC%/C_library/zlib
 
<pre>cd %EIFFEL_SRC%/C_library/zlib
−
make_msc.bat
+
finish_freezing -library
 
cd %EIFFEL_SRC%/C_library/libpng
 
cd %EIFFEL_SRC%/C_library/libpng
−
make_msc.bat</pre>
+
finish_freezing -library</pre>
 
'''Bash'''
 
'''Bash'''
 
<pre>cd $EIFFEL_SRC/C_library/zlib
 
<pre>cd $EIFFEL_SRC/C_library/zlib
−
./make_msc.bat
+
finish_freezing -library
 
cd $EIFFEL_SRC/C_library/libpng
 
cd $EIFFEL_SRC/C_library/libpng
−
./make_msc.bat</pre>
+
finish_freezing -library</pre>
  
 
===Compiling C code from compiler===
 
===Compiling C code from compiler===
Line 168: Line 144:
 
'''DOS'''
 
'''DOS'''
 
<pre>cd %EIFFEL_SRC%/framework/cli_writer/Clib
 
<pre>cd %EIFFEL_SRC%/framework/cli_writer/Clib
−
nmake
+
finish_freezing -library
 
cd %EIFFEL_SRC%/framework/cli_debugger/Clib
 
cd %EIFFEL_SRC%/framework/cli_debugger/Clib
−
nmake</pre>
+
finish_freezing -library</pre>
 
'''Bash'''
 
'''Bash'''
 
<pre>cd $EIFFEL_SRC/framework/cli_writer/Clib
 
<pre>cd $EIFFEL_SRC/framework/cli_writer/Clib
−
nmake
+
finish_freezing -library
 
cd $EIFFEL_SRC/framework/cli_debugger/Clib
 
cd $EIFFEL_SRC/framework/cli_debugger/Clib
−
nmake</pre>
+
finish_freezing -library</pre>
  
 
==Compiling EiffelStudio==
 
==Compiling EiffelStudio==
Line 188: Line 164:
  
 
<pre>ec -config ec.ecf -target target_name -c_compile</pre>
 
<pre>ec -config ec.ecf -target target_name -c_compile</pre>
−
 
−
===Gotcha===
 
−
Also, if you encounter problems with your self-compiled version of EiffelStudio, you might try to compile it with GCC 3.x. Version 4 of GCC has a slight change in semantics and EiffelStudio has not been updated. You can see the change in behavior in the following code:
 
−
 
−
<code>[c,N]
 
−
#include <stdio.h>
 
−
 
−
int a;
 
−
int b;
 
−
int *pointer;
 
−
 
−
int foo()
 
−
{
 
−
  pointer = &b;
 
−
  return 4;
 
−
}
 
−
 
−
int main (int argc, char** argv)
 
−
{
 
−
  a = 3;
 
−
  b = 0;
 
−
 
−
  pointer = &a;
 
−
 
−
  *pointer = foo();
 
−
 
−
  printf ("You are using GCC %d.%d\n",a,b);
 
−
  return 0; 
 
−
}
 
−
</code>
 
  
 
===Mac OS X specific===
 
===Mac OS X specific===

Latest revision as of 09:08, 19 February 2015


Installing EiffelStudio

To compile EiffelStudio, you need an already working EiffelStudio compiler on your machine. The current source tree requires at least version 15.01 of EiffelStudio. You can download it from Downloads. Read the existing documentation to install EiffelStudio.

Note: on Windows you will need the Microsoft C compiler to compile Eiffel Studio. How to install the free version of the Microsoft C compiler: Installing Microsoft C compiler. It is not possible to compile EiffelStudio with the MinGW C compiler (GCC).

Compilation methods

Currently there are two compilation methods.

Extracting source code

Before checking out the source code, make sure to configure subversion properly using the following instructions.

Checking out from SVN

  1. Point the environment variables called EIFFEL_SRC and ISE_LIBRARY to the directory where you want to compile EiffelStudio.
    Usually we use the XXdev convention for this directory name - where XX is the version number of the currently developed version of the compiler.
  2. Make sure that ISE_EIFFEL, ISE_PLATFORM and ISE_C_COMPILER (on Windows only) are properly defined. ISE_EIFFEL should point to the directory where you installed EiffelStudio, ISE_PLATFORM is the name of your platform (see our documentation website for more details) and ISE_C_COMPILER is only for the Windows platforms and it has to be msc (Visual Studio). At this time we do not support mingw (GCC) on Windows due to Microsoft specific dependencies.
  3. Perform the following checkout procedures:


DOS 

set SVNURL=https://svn.eiffel.com/eiffelstudio/trunk
svn co %SVNURL%/Src 15.01_dev
svn co %SVNURL%/free_add_ons 15.01_dev/free_add_ons

Bash 

export SVNURL=https://svn.eiffel.com/eiffelstudio/trunk
svn co $SVNURL/Src 15.01_dev
svn co $SVNURL/free_add_ons 15.01_dev/free_add_ons


To update the source files to the latest revision, perform the following steps:

Bash and DOS 

cd 15.01_dev
svn up
svn up free_add_ons

Compiling C libraries

Compiling run-time on Windows

DOS 

cd %EIFFEL_SRC%/C
configure [win32|win64] [b|g|m|m6]

Bash 

cd $EIFFEL_SRC/C
./configure.bat [win32|win64] [b|g|m|m6]

The first argument indicated whether you are compiling the run-time for 32 or 64 bits. The second one is to tell which C compiler will be used. For now only `b' (Borland), `g' (MinGW), `m' (Microsoft) and `m6' (for those forced to use Microsoft VC++ 6.0) are officially supported.

On Windows 32 bits to clean up all the generated files (including the library files needed by EiffelStudio) it suffices to do:

DOS 

configure clean

Bash 

./configure.bat clean

Compiling run-time on Unix

The command is simply: 

cd $EIFFEL_SRC/C
./quick_configure

This requires that ISE_PLATFORM is properly defined. The `quick_configure' script will look for the file CONFIGS/$ISE_PLATFORM and use it to extract the platform specific information to compile the run-time. If not found then an error will be reported.

To clean up the generated files including the library files needed by EiffelStudio: 

make clobber

Compiling C code from libraries

Here is the list of commands to compile all required C libraries on Windows:

DOS 

cd %EIFFEL_SRC%\library\net\Clib
finish_freezing -library
cd %EIFFEL_SRC%\library\vision2\Clib
finish_freezing -library
cd %EIFFEL_SRC%\library\wel\Clib
finish_freezing -library
cd %EIFFEL_SRC%\library\cURL\Clib
finish_freezing -library
cd %EIFFEL_SRC%\library\web_browser\Clib
finish_freezing -library

Bash 

cd $EIFFEL_SRC/library/net/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/wel/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/cURL/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/web_browser/Clib
finish_freezing -library

On Unix it is slightly different: 

cd $EIFFEL_SRC/library/net/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/vision2/implementation/gtk/Clib
finish_freezing -library
cd $EIFFEL_SRC/library/cURL/Clib
finish_freezing -library

Make sure that ISE_EIFFEL is set correctly to your current "EiffelStudio" installation!

Compiling C code from C_library

This is only required on Windows to read PNG file. On Unix, this is not required because it is included in GTK+2.4. So on Windows, simply do the following:

DOS 

cd %EIFFEL_SRC%/C_library/zlib
finish_freezing -library
cd %EIFFEL_SRC%/C_library/libpng
finish_freezing -library

Bash 

cd $EIFFEL_SRC/C_library/zlib
finish_freezing -library
cd $EIFFEL_SRC/C_library/libpng
finish_freezing -library

Compiling C code from compiler

This is only required on Windows as this C code is a tiny wrapper around the Microsoft C++ API to generate and to debug .NET code.

To compile it, you first need to install the Microsoft .NET SDK. You can download it from their website.

After installing it, you need to update your LIB and INCLUDE environment variable to include the path the lib and include directory of the .NET Framework SDK.

Once properly installed, you can do:

DOS 

cd %EIFFEL_SRC%/framework/cli_writer/Clib
finish_freezing -library
cd %EIFFEL_SRC%/framework/cli_debugger/Clib
finish_freezing -library

Bash 

cd $EIFFEL_SRC/framework/cli_writer/Clib
finish_freezing -library
cd $EIFFEL_SRC/framework/cli_debugger/Clib
finish_freezing -library

Compiling EiffelStudio

Now that we have taken care of the C code compilation we can compile the compiler. We assume that ec is in your path.

The configuration file of the compiler contains two active targets:

  • batch: for the command line compiler.
  • bench: for the graphical compiler, aka EiffelStudio.

Go to $EIFFEL_SRC/Eiffel/Ace and type the following command and replace target_name with either batch or bench. 

ec -config ec.ecf -target target_name -c_compile

Mac OS X specific

Get a mac binary from here, then follow the instructions for unix.

Launching the Compiler

There are two ways of launching the compiler:

  1. Command line compiler: add the following arguments -config path_to_config_file.ecf. This will compile the project represented by `path_to_config_file.ecf'
  2. Graphical compiler (aka EiffelStudio): add the following argument -gui.
Retrieved from "https://dev.eiffel.com/index.php?title=Compiling_EiffelStudio&oldid=15266"