EiffelStudio: an EiffelSoftware project - User contributions [en]

Compiling EiffelStudio

2006-04-11T16:34:10Z

Askadar: Added link to linux compilation script

[[Category:Compiler]]
[[Category:EiffelStudio]]

== Installing EiffelStudio ==

To compile EiffelStudio, you need an already working EiffelStudio compiler on your machine. The current source tree '''requires at least version 5.7''' of EiffelStudio. You can download it from http://eiffelsoftware.origo.ethz.ch/builds. This version still requires a registration (we missed to remove the registration cluster while compiling). You need to '''activate''' EiffelStudio (see below), because in some cases the compiler won't work correctly if not activated. [[Installing EiffelStudio]] is covered in its own article.

===Compilation methods===
Currently there are two compilation methods.
* You can either compile EiffelStudio from scratch following the instructions in this document. This is the only method on Windows.
* Alternatively (on Linux/UNIX) you can use a compilation script that Bernd Schoeller has kindly posted to the developer mailinglist: [http://origo.ethz.ch/pipermail/es-devel/2006-April/000016.html Linux compilation script]
If possible, use the compilation script and report any errors to the developer mailing list.

==Extracting source code==

===Checking out from SVN===
Define the '''EIFFEL_SRC''' environment variable. Usually we use the '''XXdev''' convention where XX is the version number from the current developped version of the compiler.

Make sure that '''ISE_EIFFEL''', '''ISE_PLATFORM''' and '''ISE_C_COMPILER''' (on windows only) are properly defined

Perform the following checkout procedures:

'''Windows'''
<pre>
set SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
svn co %SVNURL%/trunk/Src -N 57dev
svn co %SVNURL%/trunk/Src/bench/C 57dev/C
svn co %SVNURL%/trunk/Src/bench/Eiffel 57dev/Eiffel
svn co %SVNURL%/trunk/Src/common 57dev/Eiffel/common
svn co %SVNURL%/trunk/Delivery -N 57dev/Delivery
svn co %SVNURL%/trunk/free_add_ons 57dev/free_add_ons

cd 57dev
svn up C_library
svn up dotnet
svn up library
svn up library.net
svn up tools
</pre>

'''Bash'''
<pre>
export SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
svn co $SVNURL/trunk/Src -N 57dev
svn co $SVNURL/trunk/Src/bench/C 57dev/C
svn co $SVNURL/trunk/Src/bench/Eiffel 57dev/Eiffel
svn co $SVNURL/trunk/Src/common 57dev/Eiffel/common
svn co $SVNURL/trunk/Delivery -N 57dev/Delivery
svn co $SVNURL/trunk/free_add_ons 57dev/free_add_ons

cd 57dev
svn up C_library
svn up dotnet
svn up library
svn up library.net
svn up tools
</pre>

==Installing gobo==

Please make sure to use the version provided or the very latest version from CVS. All other versions (including the official 3.4 release) will not work because of name clashes in the UC_STRING class between GOBO and EiffelStudio.

===Windows specific===

You have to unzip the gobo distribution from $EIFFEL_SRC/free_add_ons/gobo/gobo_34_win.tgz and extract it into $EIFFEL_SRC/library.

===Unix specific===

You have to unzip the gobo distribution from $EIFFEL_SRC/free_add_ons/gobo/gobo_34_unix.tgz and extract it into $EIFFEL_SRC/library. Here is the list of commands to do this:
<pre>cd $EIFFEL_SRC/library
tar -xvzf $EIFFEL_SRC/free_add_ons/gobo/gobo_34_unix.tgz
</pre>
==Compiling C libraries==

===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]. Once done you can do:

<pre>cd $EIFFEL_SRC/C
configure [win32|win64] [b|m]</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) and `m' (Microsoft) are officially supported. We also informally support `g' (GCC) and `l' (LCC).

On Windows 32 bits to clean up all the generated files you do:
<pre>configure clean</pre>

On Windows 64 bits, you do:
<pre>configure cleand</pre>

===Compiling run-time on Unix===

The command is simply:
<pre>cd $$EIFFEL_SRC/C
./quick_configure</pre>
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.

===Compiling C code from libraries===

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

<pre>cd $EIFFEL_SRC/library/net/Clib
make_msc.bat
cd $EIFFEL_SRC/library/vision2/Clib
make_msc.bat
cd $EIFFEL_SRC/library/wel/Clib
make_msc.bat</pre>

On Unix it is slightly different:
<pre>cd $EIFFEL_SRC/library/event/Clib
finish_freezing -library
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</pre>

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. Simply do the following:
<pre>cd $EIFFEL_SRC/C_library/zlib
make_msc.bat
cd $EIFFEL_SRC/C_library/libpng
make_msc.bat</pre>

===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:
<pre>cd $EIFFEL_SRC/Eiffel/library/cli_writer/Clib
nmake</pre>

==Compiling EiffelStudio==

Now that we have taken care of the C code compilation we can compile the compiler. There are four ace files in $EIFFEL_SRC/Eiffel/Ace:
* batch.mswin.ace
* newbench.mswin.ace
* batch.unix.ace
* newbench.linux.ace
The first two are for windows, the last two for unix (even if the last one says `linux').

To compile simply do:
<pre>ec -ace <chosen_ace_file> -c_compile</pre>

Please note: the 'ec' binary produced by the newbench .ace file contains the full Eiffel compiler, including the batch version. 'estudio' is just a wrapper (available in Src/bench/C/ipc/daemon). So, you need either the one or the other.

===Windows specific===

At the end of the compilation for the workbench version, the C compilation will fail reporting an undefined reference to `nbref'. This is because the ace file has been built for the finalized version of EiffelStudio not the workbench version. To fix this problem do the following:
<pre>copy ec.lnk h</pre>
Then edit the file `h' and replace '''mtcompiler.lib''' by '''mtwcompiler.lib'''.
Once this is done you can complete you do:
<pre>link @h</pre>
In order to update to the new version of metadata consumer tool, follow the instructions described [[Compiling Metadata Consumer|here]].

===Unix specific===

Like the windows version the C compilation, it will fail, but this time for two reasons:
* nbref
* linking order causing many errors to be reported

Here is the recommended way, make a copy of the generated Makefile and put it at the same level as your EIFGEN directory. Edit it and replace '''libmtcompiler.a''' by '''libmtwcompiler.a''', then search for "$(EXTERNALS) $(EIFLIB)" and replace it by "$(EIFLIB) $(EXTERNALS)". Once this is done, you can do:
<pre>make -f ../../Makefile</pre>

A little script that does the necessary changes: Place it at the same level as the EIFGEN directory is.

<code>[bash,N]
#!/bin/bash

cp EIFGEN/W_code/Makefile .
sed 's/libmtcompiler\.a/libmtwcompiler\.a/g' Makefile > tmp
sed 's/\$(EXTERNALS) \$(EIFLIB)/\$$EIFLIB$ \$$EXTERNALS$/g' tmp > Makefile
cd EIFGEN/W_code
make -f ../../Makefile
</code>

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===

nothing documented yet...

Downloads

2006-04-10T23:59:58Z

Askadar: /* EiffelStudio 5.7 Pre-releases */ Link to Installing EiffelStudio

==EiffelStudio 5.7 Pre-releases==
We currently provide versions of EiffelStudio for Windows and Linux (both 32 and 64-bit). Choose the version of your choice below:
* [http://eiffelsoftware.origo.ethz.ch/builds/Eiffel57_0826_linux-x86.tgz Linux 32-bit]
* [http://eiffelsoftware.origo.ethz.ch/builds/Eiffel57_0826_linux-x86-64.tgz Linux 64-bit]
* [http://eiffelsoftware.origo.ethz.ch/builds/Eiffel57_0826_windows.msi Windows 32-bit]
* [http://eiffelsoftware.origo.ethz.ch/builds/Eiffel57_0826_win64.msi Windows 64-bit]

While waiting for a new drop of the 5.7 release, the Linux version requires a CD-key, contact [http://www.eiffel.com/general/contact_details.html Eiffel Software] to get one.

Make sure you check out [[Installing EiffelStudio]] for installation instructions (they are missing in the download).

The documentation is a work in progress and the included documentation in the above packages does not reflect changes made in the new EiffelStudio 5.7 release.

To access older builds, go directly to http://eiffelsoftware.origo.ethz.ch/builds/OLD_RELEASES

==EiffelStudio 5.6==
You can download the official EiffelStudio 5.6 release from [http://www.eiffel.com/downloads/eiffelstudio.html Eiffel Software].

==Doc Builder==
You can download the documentation generation tool for Windows 32-bit with .NET 1.1 installed by extracting the content of [http://eiffelsoftware.origo.ethz.ch/builds/doc_builder.zip doc_builder.zip] onto your hard-drive. Once installed, you can launch the tool by launching the '''doc_builder.exe''' executable.

Compiling EiffelStudio

2006-04-10T23:53:41Z

Askadar: /* Installing EiffelStudio */ Split Installation into own article

[[Category:Compiler]]
[[Category:EiffelStudio]]

== Installing EiffelStudio ==

To compile EiffelStudio, you need an already working EiffelStudio compiler on your machine. The current source tree '''requires at least version 5.7''' of EiffelStudio. You can download it from http://eiffelsoftware.origo.ethz.ch/builds. This version still requires a registration (we missed to remove the registration cluster while compiling). You need to '''activate''' EiffelStudio (see below), because in some cases the compiler won't work correctly if not activated. [[Installing EiffelStudio]] is covered in its own article.

==Extracting source code==

===Checking out from SVN===
Define the '''EIFFEL_SRC''' environment variable. Usually we use the '''XXdev''' convention where XX is the version number from the current developped version of the compiler.

Make sure that '''ISE_EIFFEL''', '''ISE_PLATFORM''' and '''ISE_C_COMPILER''' (on windows only) are properly defined

Perform the following checkout procedures:

'''Windows'''
<pre>
set SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
svn co %SVNURL%/trunk/Src -N 57dev
svn co %SVNURL%/trunk/Src/bench/C 57dev/C
svn co %SVNURL%/trunk/Src/bench/Eiffel 57dev/Eiffel
svn co %SVNURL%/trunk/Src/common 57dev/Eiffel/common
svn co %SVNURL%/trunk/Delivery -N 57dev/Delivery
svn co %SVNURL%/trunk/free_add_ons 57dev/free_add_ons

cd 57dev
svn up C_library
svn up dotnet
svn up library
svn up library.net
svn up tools
</pre>

'''Bash'''
<pre>
export SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
svn co $SVNURL/trunk/Src -N 57dev
svn co $SVNURL/trunk/Src/bench/C 57dev/C
svn co $SVNURL/trunk/Src/bench/Eiffel 57dev/Eiffel
svn co $SVNURL/trunk/Src/common 57dev/Eiffel/common
svn co $SVNURL/trunk/Delivery -N 57dev/Delivery
svn co $SVNURL/trunk/free_add_ons 57dev/free_add_ons

cd 57dev
svn up C_library
svn up dotnet
svn up library
svn up library.net
svn up tools
</pre>

===Installing gobo===

You have to unzip the gobo distribution from $EIFFEL_SRC/free_add_ons/gobo/gobo_34_win.tgz and extract it into $EIFFEL_SRC/library.

Please make sure to use the version provided or the very latest version from CVS. All other versions (including the official 3.4 release) will not work because of name clashes in the UC_STRING class between GOBO and EiffelStudio.

==Compiling C libraries==

===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]. Once done you can do:

<pre>cd $EIFFEL_SRC/C
configure [win32|win64] [b|m]</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) and `m' (Microsoft) are officially supported. We also informally support `g' (GCC) and `l' (LCC).

On Windows 32 bits to clean up all the generated files you do:
<pre>configure clean</pre>

On Windows 64 bits, you do:
<pre>configure cleand</pre>

===Compiling run-time on Unix===

The command is simply:
<pre>./quick_configure</pre>
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.

===Compiling C code from libraries===

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

<pre>cd $EIFFEL_SRC/library/net/Clib
make_msc.bat
cd $EIFFEL_SRC/library/vision2/Clib
make_msc.bat
cd $EIFFEL_SRC/library/wel/Clib
make_msc.bat</pre>

On Unix it is slightly different:
<pre>cd $EIFFEL_SRC/library/event/Clib
finish_freezing -library
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</pre>

===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:
<pre>cd $EIFFEL_SRC/C_library/zlib
make_msc.bat
cd $EIFFEL_SRC/C_library/libpng
make_msc.bat</pre>

===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:
<pre>cd $EIFFEL_SRC/Eiffel/library/cli_writer/Clib
nmake</pre>

==Compiling EiffelStudio==

Now that we have taken care of the C code compilation we can compile the compiler. There are four ace files in $EIFFEL_SRC/Eiffel/Ace:
* batch.mswin.ace
* newbench.mswin.ace
* batch.unix.ace
* newbench.linux.ace
The first two are for windows, the last two for unix (even if the last one says `linux').

To compile simply do:
<pre>ec -ace <chosen_ace_file> -c_compile</pre>

Please note: the 'ec' binary produced by the newbench .ace file contains the full Eiffel compiler, including the batch version. 'estudio' is just a wrapper (available in Src/bench/C/ipc/daemon). So, you need either the one or the other.

===Windows specific===

At the end of the compilation for the workbench version, the C compilation will fail reporting an undefined reference to `nbref'. This is because the ace file has been built for the finalized version of EiffelStudio not the workbench version. To fix this problem do the following:
<pre>copy ec.lnk h</pre>
Then edit the file `h' and replace '''mtcompiler.lib''' by '''mtwcompiler.lib'''.
Once this is done you can complete you do:
<pre>link @h</pre>
In order to update to the new version of metadata consumer tool, follow the instructions described [[Compiling Metadata Consumer|here]].

===Unix specific===

Like the windows version the C compilation, it will fail, but this time for two reasons:
* nbref
* linking order causing many errors to be reported

Here is the recommended way, make a copy of the generated Makefile and put it at the same level as your EIFGEN directory. Edit it and replace '''libmtcompiler.a''' by '''libmtwcompiler.a''', then search for "$(EXTERNALS) $(EIFLIB)" and replace it by "$(EIFLIB) $(EXTERNALS)". Once this is done, you can do:
<pre>make -f ../../Makefile</pre>

A little script that does the necessary changes: Place it at the same level as the EIFGEN directory is.

<code>[bash,N]
#!/bin/bash

cp EIFGEN/W_code/Makefile .
sed 's/libmtcompiler\.a/libmtwcompiler\.a/g' Makefile > tmp
sed 's/\$(EXTERNALS) \$(EIFLIB)/\$$EIFLIB$ \$$EXTERNALS$/g' tmp > Makefile
cd EIFGEN/W_code
make -f ../../Makefile
</code>