Compiling EiffelStudio

Revision as of 07:12, 21 April 2006 by Manus (Talk | contribs) (Made it clearer that bash just mean using bash on Windows, and use DOS instead of Windows otherwise)


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/downloads/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.

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

Compilation methods

Currently there are two compilation methods.

  • You can either compile EiffelStudio from scratch following the instructions in this document.
  • Alternatively you can use a Automatic Build Scripts

If possible, use the compilation script and report any errors to the developer mailing list.

Extracting source code

Checking out from SVN

  1. Point an environment variable called EIFFEL_SRC 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 from the current developped version of the compiler.
  2. Make sure that ISE_EIFFEL, ISE_PLATFORM and ISE_C_COMPILER (on windows only) are properly defined
  3. Perform the following checkout procedures:


DOS 

set SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
svn co %SVNURL%/trunk/Src 57dev
svn co %SVNURL%/trunk/Delivery 57dev/Delivery
svn co %SVNURL%/trunk/free_add_ons 57dev/free_add_ons

Bash 

export SVNURL=https://eiffelsoftware.origo.ethz.ch/svn/es
svn co $SVNURL/trunk/Src 57dev
svn co $SVNURL/trunk/Delivery 57dev/Delivery
svn co $SVNURL/trunk/free_add_ons 57dev/free_add_ons


To update the sourcefiles to the latest revision, perform the following steps:

Bash and DOS 

cd 57dev
svn up
svn up free_add_ons
svn up Delivery

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.
As the anonymous CVS on sourceforge is currently broken, use the following link from the gobo newsgroup to get the CVS-checkout of 18.April.


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: 

cd $EIFFEL_SRC/library
tar -xvzf $EIFFEL_SRC/free_add_ons/gobo/gobo_34_unix.tgz

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. 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:

DOS 

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

Bash 

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

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:

DOS 

configure clean

Bash 

./configure.bat clean

On Windows 64 bits, you do: 

configure cleand

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.

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
make_msc.bat
cd %EIFFEL_SRC%/library/vision2/Clib
make_msc.bat
cd %EIFFEL_SRC%/library/wel/Clib
make_msc.bat

Bash 

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

On Unix it is slightly different: 

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

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:

DOS 

cd %EIFFEL_SRC%/C_library/zlib
make_msc.bat
cd %EIFFEL_SRC%/C_library/libpng
make_msc.bat

Bash 

cd $EIFFEL_SRC/C_library/zlib
./make_msc.bat
cd $EIFFEL_SRC/C_library/libpng
./make_msc.bat

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%/Eiffel/library/cli_writer/Clib
nmake

Bash 

cd $EIFFEL_SRC/Eiffel/library/cli_writer/Clib
nmake

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: 

ec -ace <chosen_ace_file> -c_compile

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: 

copy ec.lnk h

Then edit the file `h' and replace mtcompiler.lib by mtwcompiler.lib. Once this is done you can complete you do: 

link @h

In order to update to the new version of metadata consumer tool, follow the instructions described 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: 

make -f ../../Makefile

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

#!/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

Note: These changes are not required if you try to compile a finalized version of EiffelStudio, but only if you want to create a workbench version of EiffelStudio for development and debugging.

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: 

#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;  
}

Mac OS X specific

The basic steps are:

  • compile it under linux (as described above, but finalize with ec -ace <chosen_ace_file> -finalize -c_compile)
  • copy the F_Code directory to the mac (and build the whole source arround it... so that it almost looks like under linux)
  • compile it there using make (compile all the dependencies as described above, then try to compile ... & ok change a lot of stuff in the Makefile.SH's or do it otherwise! )
  • fix whatever problems appear

for more information : try the experimental release from http://eiffelsoftware.origo.ethz.ch/downloads/porting/ and have a look at the basher.sh - skript

still todo : skript to generate a working environement for EiffelStudio

note : it seems to be neccessary to install gtk-2.6 if you want to build a working environement for EiffelStudio

Retrieved from "https://dev.eiffel.com/index.php?title=Compiling_EiffelStudio&oldid=2063"