EiffelStudio: an EiffelSoftware project - User contributions [en]

User:Sanakan

2007-01-17T20:38:15Z

Sanakan:

{|
| http://misc.sanakan.com/sanakan.png
|
| i'm a CS student at eth zurich, currently working on the [[Build_tool]] project, whose goal it is to provide an easy way to compile EiffelStudio. 
in summer 06 i was project leader (aka evil director of human resources) for the [[Folding_support]] project as part of the Software Engineering lecture. 
mail-contact: sanakan ~A~T~ student ~D~O~T~ ethz ~D~O~T~ ch

Build tool

2007-01-17T20:35:41Z

Sanakan: added todo, redefined "steps"

[[Category:Projects]]

== Overview ==
The whole build process of EiffelStudio is rather tedious at the moment. This project aims to simplify this by various means:
* Setup checker
* (modular) Build scripts
* Delivery scripts
This will lead to a better overall build infrastructure, automated (nightly) builds, and things alike. We work on our own branch of the sourcecode, but will sync it from time to time with SVN HEAD.

== Goals ==
We aim to have a compact build process by using only Eiffel related tools (mainly geant scripts) and thus minimizing the needed (alien) tools to get an EiffelStudio compilation going.

== Steps ==
* produce a one-click-and-go script for easy installation
* get rid of windows dependency for bash
* remove script-only tools like finish_freezing, Makefile.sh, etc.

== Done ==

* first draft of geant scripts to build c-libraries
* first draft of setup-checker tool

== Milestones ==

== Todo ==
* makefile/batchfile for getting the installation started (for users unexperienced with gobo/geant)
* expand setup-checker
** find more dependencies on windows
* automatical use of existing gobo-installations

== Team ==

Build tool

2006-11-22T21:38:57Z

Sanakan: first draft of modular build-tool scripts

Build tool

2006-11-17T21:36:34Z

Sanakan: initial wiki page for build tool project

Automatic Build Scripts

2006-07-18T16:53:16Z

Sanakan:

[[Category:Compiler]]
[[Category:EiffelStudio]]
This page references different build scripts that automate the process of building EiffelStudio.

== Windows ==

[[User:Barnski|Bernardo Buss]] created a set of scripts for the automated compilation of EiffelStudio under Windows.
* Script: http://homepage.hispeed.ch/barnski/EiffelStudio_batch_files.zip
* Announcement: http://origo.ethz.ch/pipermail/es-devel/2006-April/000052.html
'''Note:''' 
* You may need to keep "2_checkout_dev.bat" up to date by yourself according to [[Compiling_EiffelStudio#Checking_out_from_SVN|Checking out from SVN]].
* It is possible that the '''batchfiles only work partial''' with EiffelStudio '''newer than version 5.7.0826''' (especially parts of the compilation process may differ too much).
'''Update:''' 
* [[User:Philipp|Philipp Bönhof]] improved the scripts with customizable parameters. Download here: http://n.ethz.ch/student/pboenhof/autotest/Philipp_Eiffel_Compilation_Scripts.zip

== Linux ==

Bernd Schoeller has developed a build script vor use with .acex configuration files. it is available for download at http://se.inf.ethz.ch/people/schoeller/download/build-ec-acex

For use with the new .ecf configuration files, please use this updated version: 
http://n.ethz.ch/~bherlig/download/build-ec-ecf.sh

This script requires a single checkout from the SVN repository (with the EIFFEL_SVN environment variable pointing to it). It will compile the bench or the batch compiler (you need to modify the script for the second).

=== Gentoo ===
Eiffelstudio, Gobo, edoc, ewg, eiffelmedia and eclipse edt ebuilds for gentoo, can be downloaded [http://n.ethz.ch/~philipkr/eiffel-ebuilds.tar.gz here] or from cvs:
cvs -z3 -d:pserver:anonymous@waldorf.inf.ethz.ch:/public-cvs co -deiffel-ebuilds student/eiffel-ebuilds
Installation instructions can be found [http://n.ethz.ch/~philipkr/eiffel-tools.html here]

== Mac OSX ==
No that Mac builds are available, I guess you can use the Linux script on Mac OS, too.
I prefer this more simple script though:
<pre>
#!/bin/bash

cd $EIFFEL_SRC/C
make clobber
./quick_configure

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

cd $EIFFEL_SRC/Eiffel/Ace
ec -config ec.ecf -target bench -finalize -c_compile
</pre>
This basically automates the steps described [[Compiling_EiffelStudio|here]].

Automatic Build Scripts

2006-07-18T16:52:47Z

Sanakan: new linux buildscript for .ecf files

[[Category:Compiler]]
[[Category:EiffelStudio]]
This page references different build scripts that automate the process of building EiffelStudio.

== Windows ==

[[User:Barnski|Bernardo Buss]] created a set of scripts for the automated compilation of EiffelStudio under Windows.
* Script: http://homepage.hispeed.ch/barnski/EiffelStudio_batch_files.zip
* Announcement: http://origo.ethz.ch/pipermail/es-devel/2006-April/000052.html
'''Note:''' 
* You may need to keep "2_checkout_dev.bat" up to date by yourself according to [[Compiling_EiffelStudio#Checking_out_from_SVN|Checking out from SVN]].
* It is possible that the '''batchfiles only work partial''' with EiffelStudio '''newer than version 5.7.0826''' (especially parts of the compilation process may differ too much).
'''Update:''' 
* [[User:Philipp|Philipp Bönhof]] improved the scripts with customizable parameters. Download here: http://n.ethz.ch/student/pboenhof/autotest/Philipp_Eiffel_Compilation_Scripts.zip

== Linux ==

Bernd Schoeller has developed a build script vor use with .acex configuration files. it is available for download at http://se.inf.ethz.ch/people/schoeller/download/build-ec-acex

For use with the new .ecf configuration files, please use this updated version
http://n.ethz.ch/~bherlig/download/build-ec-ecf.sh

This script requires a single checkout from the SVN repository (with the EIFFEL_SVN environment variable pointing to it). It will compile the bench or the batch compiler (you need to modify the script for the second).

=== Gentoo ===
Eiffelstudio, Gobo, edoc, ewg, eiffelmedia and eclipse edt ebuilds for gentoo, can be downloaded [http://n.ethz.ch/~philipkr/eiffel-ebuilds.tar.gz here] or from cvs:
cvs -z3 -d:pserver:anonymous@waldorf.inf.ethz.ch:/public-cvs co -deiffel-ebuilds student/eiffel-ebuilds
Installation instructions can be found [http://n.ethz.ch/~philipkr/eiffel-tools.html here]

== Mac OSX ==
No that Mac builds are available, I guess you can use the Linux script on Mac OS, too.
I prefer this more simple script though:
<pre>
#!/bin/bash

cd $EIFFEL_SRC/C
make clobber
./quick_configure

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

cd $EIFFEL_SRC/Eiffel/Ace
ec -config ec.ecf -target bench -finalize -c_compile
</pre>
This basically automates the steps described [[Compiling_EiffelStudio|here]].

Folding support

2006-06-21T10:09:24Z

Sanakan: new screenshots

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* sanakan

====Done====
EB_FOLDING_AREA: 
Folding points of interests are gathered from the class ast via click_tool.current_class.ast. the of features of the class include
* next: EB_FOLDING_AREA
* previous: EB_FOLDING_AREA -- links to adjacent folding_areas
* hidden: BOOLEAN -- flag to indicate if the feature is hidden or not
* show
* hide
* toggle_hidden_status -- manipulate the hidden-flag

EB_FOLDING_AREA_TREE: 
EB_FOLDING_AREAs are inserted stored in an avl-tree EB_FOLDING_AREA_TREE with doubly-linked leaves. features of the class include
* first: EB_FOLDING_AREA
* last: EB_FOLDING_AREA -- links to the very first and very last folding_areas

EB_SMART_EDITOR: 
The editor was enchanced to support the generation an maintaining of folding areas. properties and functions include
* folding_areas: EB_FOLDING_AREA_TREE -- rooting point of the datastructure
* initialize_folding_areas -- deletes any existing tree & builds it anew from the currently loaded classtext
* update_folding_areas -- synchronizes with the shown/saved classtext. only executes if the syntax is correct.

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu
* salmanasar
* grippus
* thomas
* sanakan

====Done====
* added grey bar containing EDITOR_TOKEN_FOLDING_POINTs (the thingies to click on)
* added menu entry to toggle folding-support (edit menu -> toggle folding points)
* added keyboard shortcut for toggling folding-support (ctrl + p)
* prepared interface for code-folding (see "part three")

====images speak a thousand words====

{|
|-
!Basic bar
!Code-Folding bar with line numbers bar
!Code-Folding: menu entry
|-
|[[Image:Folding margin 1.png|code-folding: basic code-folding bar]]
|[[Image:Folding margin 2.png|code-folding: code-folding bar with line numbers]]
|[[Image:Folding_menu_1.png|code-folding: menu entry]]
|}

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications
* generation of points/areas-of-interest (aka folding-areas)
* graphical representation (aka folding bar)
* togglabillity (sp?) of graphical bar (aka ctrl-p)

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

Folding support

2006-06-18T00:40:25Z

Sanakan: moved adt to talk-page, as it is to be revised

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* sanakan

====Done====
EB_FOLDING_AREA: 
Folding points of interests are gathered from the class ast via click_tool.current_class.ast. the of features of the class include
* next: EB_FOLDING_AREA
* previous: EB_FOLDING_AREA -- links to adjacent folding_areas
* hidden: BOOLEAN -- flag to indicate if the feature is hidden or not
* show
* hide
* toggle_hidden_status -- manipulate the hidden-flag

EB_FOLDING_AREA_TREE: 
EB_FOLDING_AREAs are inserted stored in an avl-tree EB_FOLDING_AREA_TREE with doubly-linked leaves. features of the class include
* first: EB_FOLDING_AREA
* last: EB_FOLDING_AREA -- links to the very first and very last folding_areas

EB_SMART_EDITOR: 
The editor was enchanced to support the generation an maintaining of folding areas. properties and functions include
* folding_areas: EB_FOLDING_AREA_TREE -- rooting point of the datastructure
* initialize_folding_areas -- deletes any existing tree & builds it anew from the currently loaded classtext
* update_folding_areas -- synchronizes with the shown/saved classtext. only executes if the syntax is correct.

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu
* salmanasar
* grippus
* thomas
* sanakan

====Done====
* added grey bar containing EDITOR_TOKEN_FOLDING_POINTs (the thingies to click on)
* added menu entry to toggle folding-support (edit menu -> toggle folding points)
* added keyboard shortcut for toggling folding-support (ctrl + p)
* prepared interface for code-folding (see "part three")

====images speak a thousand words====
Basic bar: 
[[Image:Folding margin 1.png|code-folding: basic code-folding bar]] 
Code-Folding bar with line numbers bar 
[[Image:Folding margin 2.png|code-folding: code-folding bar with line numbers]] 
Code-Folding: menu entry 
[[Image:Folding_menu_1.png|code-folding: menu entry]] 

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications
* generation of points/areas-of-interest (aka folding-areas)
* graphical representation (aka folding bar)
* togglabillity (sp?) of graphical bar (aka ctrl-p)

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

Talk:Folding support

2006-06-18T00:40:02Z

Sanakan: cleanup

= general TODO =
[[User:Sanakan|Sanakan]] 02:40, 18 June 2006 (CEST) 
* revise code hiding/showing
-> assigned to: panarium, exception, sanakan
* testing!!!!!
-> assigned to: everyone

[[User:salmanasar|salmanasar]] 13:15, 9 May 2006 (CEST) 

I suggest, that every change in the classes is reported with a little comment (perhaps via the mailinglist), so that those of us who do part 3 and 4 are able to support the coders, as sanakan proposed.

= working title of the project =

A few ideas:
* Folding -> falten -> eiffel-origami
* FEES : Folding editor for Eiffel Studio
* hidden beauty project
* HYCs : Hide your code
* Folding Fields
* Heilige Dreifaltigkeit

any comments from team members?

[[User:Sanakan|Sanakan]] 22:02, 19 April 2006 (CEST)

[[User:Bayt|Bayt]]
I really like origamiE :-)

[[User:Bru|Bru]]
origamiE is cool. Another propasal: FEdEX (Folding: an Editor EXtension or an Folding for Editors: an Eiffel eXtension)

= Testing/Checking =

--[[User:Salmanasar|Salmanasar]] 12:35, 13 June 2006 (CEST)

I wrote a little Eiffel-program with which you can check if our folding-editor works:

<pre>
indexing
description : "System's root class, Class to test if folding editor works"
author: "salmanasar"
date: "11.06.2006"
revision: "1.1"

class
ROOT_CLASS

create
make

feature -- Initialization

make is
-- Creation procedure.
local
option : INTEGER
number : INTEGER
do
-- Print some welcome text.
io.put_string("Enter your option: {1,2,3}")
io.new_line
io.put_string("=========================")
io.new_line
io.read_integer
option := io.last_integer
io.new_line
io.new_line
io.put_string("Enter a number between 1 and 20")
io.new_line
io.put_string("===============================")
io.new_line
io.read_integer
number := io.last_integer
-- if to be folded
if (number > 0) and (number < 21) then
-- inspect to be folded
inspect option
when 1 then looping(number)
when 2 then casedecision(number)
when 3 then inspecting_thing(number)

else io.put_string("no such option!!")
end
end

end

feature -- cases

looping(n: INTEGER) is
-- feature with 2 loops, 1 if-then-else printing a checkered triangle
local
i, j, star: INTEGER
do
from
i := 1
star := 1
until
i > n
loop
from
j := 1
until
j > i
loop
if j \\ 2 = star then
io.put_character (' ')
else
io.put_character ('*')
end
j := j + 1
end
star := 1 - star
i := i + 1
io.put_new_line
end
end

casedecision(n:INTEGER) is
-- feature with if then elseif
do
-- if to be folded
if n > 10
then io.put_string ("What a huge number!!!")
elseif n >5
then io.put_string ("What a little number!!!")
else io.put_string ("What a tiny number!!!")
end
end

inspecting_thing(n:INTEGER) is
-- feature with weird inspecting thing
do
-- inspect to be folded
inspect n
when 1 then io.put_string ("one")
when 2 then io.put_string ("two")
when 3 then io.put_string ("three")
when 4 then io.put_string ("four")
when 5 then io.put_string ("five")
when 6 then io.put_string ("six")
when 7 then io.put_string ("seven")
when 8 then io.put_string ("eight")
else io.put_string ("too big")
end
end

end -- class ROOT_CLASS
</pre>

= ADT: general Talk =
[[User:Exception|Exception]] 14:45, 4 May 2006 (CEST) 
I think we need another data type / class that specifies where folding is possible and whether it's folded or not. I propose the name '''EV_FOLDING_AREA'''. 

it should have the following functions: 
'''create:''' -> EV_FOLDING_AREA 
the area goes from this character on. 
'''from:''' EV_FOLDING_AREA -> INTEGER 
the area goes from this character on. 
'''to:''' EV_FOLDING_AREA -> INTEGER 
the area goes until this character. 
'''folded:''' EV_FOLDING_AREA -> BOOLEAN 
is it folded or not? 
'''fold:''' EV_FOLDING_AREA -> EV_FOLDING_AREA 
fold the area. 
'''unfold:''' EV_FOLDING_AREA -> EV_FOLDING_AREA 
unfold the area. 
'''content:''' EV_FOLDING_AREA x EV_FOLDING_WIDGET -> STRING 
the content of the area. 

the structure would be controlled by the controller which knows of the AST. 

as always, this is only a proposal.

[[User:Bru|Bru]] 13:03, 9 May 2006 (CEST) 

How does Eiffel implement text as a sequence of characters? line by line? That will greatly influence our implementation of the folding widget I guess. A "folding area" will then contain the lines themselves and the start and end coordinates of the area, so that when the displayer draws the editor area it gets those coordinates from the folding controller and doesn't display those lines but puts a symbol there instead. Just thinking out loud here...

= ADT =
moved from front-page [[User:Sanakan|Sanakan]] 02:40, 18 June 2006 (CEST) 

NOTE: to be revised!
==Types==
FOLDING_WIDGET, TEXT_BLOCK, INTEGER, BOOLEAN,

==Features==

new -> FOLDING_WIDGET 
definearea: FOLDING_WIDGET X HIGHLIGHTED_TEXT_BLOCK -> FOLDING_WIDGET 
from: FOLDING_WIDGET -> INTEGER 
to: FOLDING_WIDGET -> INTEGER 
folded: FOLDING_WIDGET -> BOOLEAN 
fold: FOLDING_WIDGET -> FOLDING_WIDGET 
unfold: FOLDING_WIDGET -> FOLDING_WIDGET 
content: FOLDING_WIDGET -> BLOCK 
numberoflines: FOLDING_WIDGET -> INTEGER 

==Prerequisites==
none

==Axioms==

for all w,v :: FOLDING_WIDGET, tb :: TEXT_BLOCK

from(definearea(w,tb)) = firstline(tb)
to(definearea(w,tb) = lastline(tb)
content(new) = NULL
content(definearea(w,tb)) = tb
numberoflines(new) = 0
numberoflines(definearea(w,tb)) = to(definearea(w,tb)) - from(definearea(w,tb))
folded(new) = false
folded(fold(w)) = true

Folding support

2006-06-18T00:26:17Z

Sanakan: updated "part 2: graphical sidebar", with images

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

= ADT =
(note: to be revised)

==Types==
FOLDING_WIDGET, TEXT_BLOCK, INTEGER, BOOLEAN,

==Features==

new -> FOLDING_WIDGET 
definearea: FOLDING_WIDGET X HIGHLIGHTED_TEXT_BLOCK -> FOLDING_WIDGET 
from: FOLDING_WIDGET -> INTEGER 
to: FOLDING_WIDGET -> INTEGER 
folded: FOLDING_WIDGET -> BOOLEAN 
fold: FOLDING_WIDGET -> FOLDING_WIDGET 
unfold: FOLDING_WIDGET -> FOLDING_WIDGET 
content: FOLDING_WIDGET -> BLOCK 
numberoflines: FOLDING_WIDGET -> INTEGER 

==Prerequisites==
none

==Axioms==

for all w,v :: FOLDING_WIDGET, tb :: TEXT_BLOCK

from(definearea(w,tb)) = firstline(tb)
to(definearea(w,tb) = lastline(tb)
content(new) = NULL
content(definearea(w,tb)) = tb
numberoflines(new) = 0
numberoflines(definearea(w,tb)) = to(definearea(w,tb)) - from(definearea(w,tb))
folded(new) = false
folded(fold(w)) = true

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* sanakan

====Done====
EB_FOLDING_AREA: 
Folding points of interests are gathered from the class ast via click_tool.current_class.ast. the of features of the class include
* next: EB_FOLDING_AREA
* previous: EB_FOLDING_AREA -- links to adjacent folding_areas
* hidden: BOOLEAN -- flag to indicate if the feature is hidden or not
* show
* hide
* toggle_hidden_status -- manipulate the hidden-flag

EB_FOLDING_AREA_TREE: 
EB_FOLDING_AREAs are inserted stored in an avl-tree EB_FOLDING_AREA_TREE with doubly-linked leaves. features of the class include
* first: EB_FOLDING_AREA
* last: EB_FOLDING_AREA -- links to the very first and very last folding_areas

EB_SMART_EDITOR: 
The editor was enchanced to support the generation an maintaining of folding areas. properties and functions include
* folding_areas: EB_FOLDING_AREA_TREE -- rooting point of the datastructure
* initialize_folding_areas -- deletes any existing tree & builds it anew from the currently loaded classtext
* update_folding_areas -- synchronizes with the shown/saved classtext. only executes if the syntax is correct.

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu
* salmanasar
* grippus
* thomas
* sanakan

====Done====
* added grey bar containing EDITOR_TOKEN_FOLDING_POINTs (the thingies to click on)
* added menu entry to toggle folding-support (edit menu -> toggle folding points)
* added keyboard shortcut for toggling folding-support (ctrl + p)
* prepared interface for code-folding (see "part three")

====images speak a thousand words====
Basic bar: 
[[Image:Folding margin 1.png|code-folding: basic code-folding bar]] 
Code-Folding bar with line numbers bar 
[[Image:Folding margin 2.png|code-folding: code-folding bar with line numbers]] 
Code-Folding: menu entry 
[[Image:Folding_menu_1.png|code-folding: menu entry]] 

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications
* generation of points/areas-of-interest (aka folding-areas)
* graphical representation (aka folding bar)
* togglabillity (sp?) of graphical bar (aka ctrl-p)

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

File:Folding menu 1.png

2006-06-18T00:15:25Z

Sanakan: code-folding menu entry

code-folding menu entry

File:Folding margin 3.png

2006-06-18T00:15:10Z

Sanakan: code-folding bar with breakpoint bar

code-folding bar with breakpoint bar

File:Folding margin 2.png

2006-06-18T00:14:46Z

Sanakan: code-folding bar with line-numbers

code-folding bar with line-numbers

File:Folding margin 1.png

2006-06-18T00:14:24Z

Sanakan: basic code-folding bar

basic code-folding bar

Folding support

2006-06-14T01:26:00Z

Sanakan: job reassignment

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

= ADT =
(note: to be revised)

==Types==
FOLDING_WIDGET, TEXT_BLOCK, INTEGER, BOOLEAN,

==Features==

new -> FOLDING_WIDGET 
definearea: FOLDING_WIDGET X HIGHLIGHTED_TEXT_BLOCK -> FOLDING_WIDGET 
from: FOLDING_WIDGET -> INTEGER 
to: FOLDING_WIDGET -> INTEGER 
folded: FOLDING_WIDGET -> BOOLEAN 
fold: FOLDING_WIDGET -> FOLDING_WIDGET 
unfold: FOLDING_WIDGET -> FOLDING_WIDGET 
content: FOLDING_WIDGET -> BLOCK 
numberoflines: FOLDING_WIDGET -> INTEGER 

==Prerequisites==
none

==Axioms==

for all w,v :: FOLDING_WIDGET, tb :: TEXT_BLOCK

from(definearea(w,tb)) = firstline(tb)
to(definearea(w,tb) = lastline(tb)
content(new) = NULL
content(definearea(w,tb)) = tb
numberoflines(new) = 0
numberoflines(definearea(w,tb)) = to(definearea(w,tb)) - from(definearea(w,tb))
folded(new) = false
folded(fold(w)) = true

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* sanakan

====Done====
EB_FOLDING_AREA: 
Folding points of interests are gathered from the class ast via click_tool.current_class.ast. the of features of the class include
* next: EB_FOLDING_AREA
* previous: EB_FOLDING_AREA -- links to adjacent folding_areas
* hidden: BOOLEAN -- flag to indicate if the feature is hidden or not
* show
* hide
* toggle_hidden_status -- manipulate the hidden-flag

EB_FOLDING_AREA_TREE: 
EB_FOLDING_AREAs are inserted stored in an avl-tree EB_FOLDING_AREA_TREE with doubly-linked leaves. features of the class include
* first: EB_FOLDING_AREA
* last: EB_FOLDING_AREA -- links to the very first and very last folding_areas

EB_SMART_EDITOR: 
The editor was enchanced to support the generation an maintaining of folding areas. properties and functions include
* folding_areas: EB_FOLDING_AREA_TREE -- rooting point of the datastructure
* initialize_folding_areas -- deletes any existing tree & builds it anew from the currently loaded classtext
* update_folding_areas -- synchronizes with the shown/saved classtext. only executes if the syntax is correct.

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu
* salmanasar
* grippus
* thomas
* sanakan

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

Folding support

2006-06-14T01:22:30Z

Sanakan: generation and maintaining of folding-areas

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

= ADT =
(note: to be revised)

==Types==
FOLDING_WIDGET, TEXT_BLOCK, INTEGER, BOOLEAN,

==Features==

new -> FOLDING_WIDGET 
definearea: FOLDING_WIDGET X HIGHLIGHTED_TEXT_BLOCK -> FOLDING_WIDGET 
from: FOLDING_WIDGET -> INTEGER 
to: FOLDING_WIDGET -> INTEGER 
folded: FOLDING_WIDGET -> BOOLEAN 
fold: FOLDING_WIDGET -> FOLDING_WIDGET 
unfold: FOLDING_WIDGET -> FOLDING_WIDGET 
content: FOLDING_WIDGET -> BLOCK 
numberoflines: FOLDING_WIDGET -> INTEGER 

==Prerequisites==
none

==Axioms==

for all w,v :: FOLDING_WIDGET, tb :: TEXT_BLOCK

from(definearea(w,tb)) = firstline(tb)
to(definearea(w,tb) = lastline(tb)
content(new) = NULL
content(definearea(w,tb)) = tb
numberoflines(new) = 0
numberoflines(definearea(w,tb)) = to(definearea(w,tb)) - from(definearea(w,tb))
folded(new) = false
folded(fold(w)) = true

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* salmanasar
* grippus
* thomas
* sanakan

====Done====
EB_FOLDING_AREA: 
Folding points of interests are gathered from the class ast via click_tool.current_class.ast. the of features of the class include
* next: EB_FOLDING_AREA
* previous: EB_FOLDING_AREA -- links to adjacent folding_areas
* hidden: BOOLEAN -- flag to indicate if the feature is hidden or not
* show
* hide
* toggle_hidden_status -- manipulate the hidden-flag

EB_FOLDING_AREA_TREE: 
EB_FOLDING_AREAs are inserted stored in an avl-tree EB_FOLDING_AREA_TREE with doubly-linked leaves. features of the class include
* first: EB_FOLDING_AREA
* last: EB_FOLDING_AREA -- links to the very first and very last folding_areas

EB_SMART_EDITOR: 
The editor was enchanced to support the generation an maintaining of folding areas. properties and functions include
* folding_areas: EB_FOLDING_AREA_TREE -- rooting point of the datastructure
* initialize_folding_areas -- deletes any existing tree & builds it anew from the currently loaded classtext
* update_folding_areas -- synchronizes with the shown/saved classtext. only executes if the syntax is correct.

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

Folding support

2006-06-10T23:53:57Z

Sanakan: /* Part one :: generating the folding areas */

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

= ADT =
(note: to be revised)

==Types==
FOLDING_WIDGET, TEXT_BLOCK, INTEGER, BOOLEAN,

==Features==

new -> FOLDING_WIDGET 
definearea: FOLDING_WIDGET X HIGHLIGHTED_TEXT_BLOCK -> FOLDING_WIDGET 
from: FOLDING_WIDGET -> INTEGER 
to: FOLDING_WIDGET -> INTEGER 
folded: FOLDING_WIDGET -> BOOLEAN 
fold: FOLDING_WIDGET -> FOLDING_WIDGET 
unfold: FOLDING_WIDGET -> FOLDING_WIDGET 
content: FOLDING_WIDGET -> BLOCK 
numberoflines: FOLDING_WIDGET -> INTEGER 

==Prerequisites==
none

==Axioms==

for all w,v :: FOLDING_WIDGET, tb :: TEXT_BLOCK

from(definearea(w,tb)) = firstline(tb)
to(definearea(w,tb) = lastline(tb)
content(new) = NULL
content(definearea(w,tb)) = tb
numberoflines(new) = 0
numberoflines(definearea(w,tb)) = to(definearea(w,tb)) - from(definearea(w,tb))
folded(new) = false
folded(fold(w)) = true

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* salmanasar
* grippus
* thomas
* sanakan

====Done====
* EB_FOLDING_AREAs are gathered from the class ast via click_tool.current_class.ast
* EB_FOLDING_AREAs are inserted stored in an avl-tree EB_FOLDING_AREA_TREE with doubly-linked leaves. features of EB_FOLDING_AREA_TREE include
** first
** last
** item(k: key)

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

Folding support

2006-06-06T16:55:34Z

Sanakan: /* TO DO */

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

==Introduction==
While using an editor like the one provided by EiffelStudio the actual area in a
text, in thsi case source code, that is actually being edited is restricted to a
small part of the entire document. Therefor being able to remove text sequences
from the display without changing the actual text sequence could increase
productivity. One such approach is to use folding, which is a line-based
technique that "folds" a block of lines into a single line that is then
displayed in addition to a special symbol that marks the line as actually being
a "pile" of lines, and which also serves as the interface to unfold the passage
back into it's original state (and subsequent fold/unfold operations).

==The Goal==
The goal of this project was to implement folding support for the
EiffelStudio editor in order to be able to fold semantic blocks of code such as
entire features or loop blocks. The source text should however not be modified by this procedure in
the sense that folding or unfolding a text should not change the AST. In addition folding should also not
have any affects on any print output. A search for specific parts of code should also be able to enter
folded text areas. It is also critical that folded areas are always displayed to the user correctly. Nested folding
(e.g. a loop body in a feature, nested loops etc...) should also be possible.

= ADT =
(note: to be revised)

==Types==
FOLDING_WIDGET, TEXT_BLOCK, INTEGER, BOOLEAN,

==Features==

new -> FOLDING_WIDGET 
definearea: FOLDING_WIDGET X HIGHLIGHTED_TEXT_BLOCK -> FOLDING_WIDGET 
from: FOLDING_WIDGET -> INTEGER 
to: FOLDING_WIDGET -> INTEGER 
folded: FOLDING_WIDGET -> BOOLEAN 
fold: FOLDING_WIDGET -> FOLDING_WIDGET 
unfold: FOLDING_WIDGET -> FOLDING_WIDGET 
content: FOLDING_WIDGET -> BLOCK 
numberoflines: FOLDING_WIDGET -> INTEGER 

==Prerequisites==
none

==Axioms==

for all w,v :: FOLDING_WIDGET, tb :: TEXT_BLOCK

from(definearea(w,tb)) = firstline(tb)
to(definearea(w,tb) = lastline(tb)
content(new) = NULL
content(definearea(w,tb)) = tb
numberoflines(new) = 0
numberoflines(definearea(w,tb)) = to(definearea(w,tb)) - from(definearea(w,tb))
folded(new) = false
folded(fold(w)) = true

=Classes=
(note: to be revised)

EB_FOLDING_AREA
Class holding all information about a single foldable area, for example
* starting line:INTEGER
* ending line:INTEGER
* folded:BOOLEAN
* ...

=Testing=

The following testcases have been propsed:
- write a small application (source code to be provided by author) that includes multiple features, loops and nested loops
to check the correct creation and display of folded areas (ncl. nested folds).

- print the source code of the application mentioned above with and without folding support. The output
should be identical.

- compile and run both the source code with and without folding support. The applications behaviour should be identical.

- search for specific words and text segments within folded areas of the source. The search should find such segments.

=TO DO=

=== Part one :: generating the folding areas ===
This is the part where the data is gathered and put in to a datastructure to work on.
Assigned to
* salmanasar
* grippus
* thomas
* sanakan

=== Part two :: graphical sidebar===
A breakpoint-sidebar like widget to display our folding-handles in.
Assigned to
* ledergec
* bru
* lord bubu

=== Part three :: text-manipulation===
* Perro
* Panarium
* Exception

=== AST ===
To be familiar with ES' way of implementing the AST

==done==
* (half) ADT specified
* some specifications

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

[http://www.cs.unm.edu/~crowley/papers/sds/sds.html A paper about ADT's and text editors] ([http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps download of the file with graphics])

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]] (Project Supervisor)
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]] (aka. David, Quality Checking)

Folding support

2006-06-06T16:48:16Z

Sanakan: /* Classes */

Folding support

2006-05-24T20:11:45Z

Sanakan: link moved from talk page

Folding support

2006-05-24T20:09:04Z

Sanakan: formating of "features" corrected

Folding support

2006-05-23T16:11:07Z

Sanakan: overview, adt & testing added

Talk:Folding support

2006-05-03T18:37:46Z

Sanakan: todo-list

= general TODO =
[[User:Sanakan|Sanakan]] 20:37, 3 May 2006 (CEST)

syntax: phase <nr> [<who>] <deadline>

'''phase 0''' (everyone!) saturday, may 6
: specify ADT generate and discuss a complete ADT of the EV_FOLDING_WIDGET here, if it's complete & correct, we can copy it over to the main page.

'''phase 1''' (stefan, oliver, thomas, [[User:Grippus|Grippus]], [[User:Sanakan|sanakan]]) saturday, may 13
* implement first rough draft of the EV_FOLDING_WIDGET based on the ADT from above (see also hint below).

'''phase 2''' (lukas, lorenz, [[User:Lord _Bubu|Lord Bubu]], [[User:Sanakan|sanakan]]) ...
* write interface EV_FOLDING_CONTROLLER for users to use our folding widget by supplying an AST.

'''phase 3''' ([[User:Grippus|Grippus]], [[User:Ledergec|Ledergec]], david) ...
* extensive testing (all members)
* documentation

'''phase 4''' (to be assigned) ...
* integration with EiffelStudio (aka. wunschtraum...)

= hint =
[[User:Bayt|Bayt]]

The folding support should be included the: EDITABLE_TEXT_PANEL

= ADT =
WhatWhereWhenHowWhy 
[[User:Sanakan|Sanakan]] 16:59, 26 April 2006 (CEST)

discuss what the ADT of the widget should be like: 

--[[User:Unthomas|Unthomas]] 14:05, 1 May 2006 (CEST) 
Here a link to an interesting paper about ADTs and text editors (node 15):
http://www.cs.unm.edu/~crowley/papers/sds/sds.html 
Are you able to see the figures?

: no images over here, either... but here's a download of said paper: [http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps crowley98data.ps] [[User:Sanakan|Sanakan]] 01:06, 2 May 2006 (CEST)

= working title of the project =

A few ideas:
* Folding -> falten -> eiffel-origami
* FEES : Folding editor for Eiffel Studio
* hidden beauty project
* HYCs : Hide your code
* Folding Fields
* Heilige Dreifaltigkeit

any comments from team members?

[[User:Sanakan|Sanakan]] 22:02, 19 April 2006 (CEST)

[[User:Bayt|Bayt]]
I really like origamiE :-)

Talk:Folding support

2006-05-01T23:06:07Z

Sanakan: downloadlink of adt-paper

= ADT =
WhatWhereWhenHowWhy 
[[User:Sanakan|Sanakan]] 16:59, 26 April 2006 (CEST)

discuss what the ADT of the widget should be like: 

--[[User:Unthomas|Unthomas]] 14:05, 1 May 2006 (CEST) 
Here a link to an interesting paper about ADTs and text editors (node 15):
http://www.cs.unm.edu/~crowley/papers/sds/sds.html 
Are you able to see the figures?

: no images over here, either... but here's a download of said paper: [http://citeseer.ist.psu.edu/rd/0%2C162545%2C1%2C0.25%2CDownload/http://citeseer.ist.psu.edu/compress/0/papers/cs/1797/http:zSzzSzwww.bolthole.comzSzjwordzSzwppaper.ps.gz/crowley98data.ps crowley98data.ps] [[User:Sanakan|Sanakan]] 01:06, 2 May 2006 (CEST)

= working title of the project =

A few ideas:
* Folding -> falten -> eiffel-origami
* FEES : Folding editor for Eiffel Studio
* hidden beauty project
* HYCs : Hide your code
* Folding Fields

any comments from team members?

[[User:Sanakan|Sanakan]] 22:02, 19 April 2006 (CEST)

[[User:Bayt|Bayt]]
I really like origamiE :-)

Folding support

2006-04-30T09:14:49Z

Sanakan: team & mailinglist corrected

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

=Milestones=

==todo==
===M1: May 4th===
* ADT specified

===M2: May ??? ===
* be familiar with ES' way of implementing the AST
* with the above: think about a control wrapper from ES' AST to the project-widget

===Milestones TO DO ===
* implement support for word wrapping ("View" part of the widget)
* specify & implement "Controller"

==done==
* vast empty space 'ere....... yet!

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]

[http://jerry.cs.uiuc.edu/~plop/plop2003/Papers/Jones-ImplementingASTs.pdf How to implement an AST?]

[http://en.wikipedia.org/wiki/Visitor_pattern What's the Visitor Design-Pattern?]

=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui-fold es-ui-fold@origo.ethz.ch]

* [[User:Sanakan| sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* [[User:Bayt| Bayt]]
* [[User:Bru| Bru]]
* [[User:Exception| Exception]]
* [[User:Grippus| Grippus]]
* [[User:Ledergec| Ledergec]]
* [[User:Panarium| Panarium]]
* [[User:Perro| Perro]]
* [[User:salmanasar| salmanasar]]

Talk:Folding support

2006-04-26T14:59:26Z

Sanakan: ADT: discuss!

= ADT =
WhatWhereWhenHowWhy 
[[User:Sanakan|Sanakan]] 16:59, 26 April 2006 (CEST)

discuss what the ADT of the widget should be like: 

= working title of the project =

A few ideas:
* Folding -> falten -> eiffel-origami
* FEES : Folding editor for Eiffel Studio
* hidden beauty project
* HYCs : Hide your code
* Folding Fields

any comments from team members?

[[User:Sanakan|Sanakan]] 22:02, 19 April 2006 (CEST)

[[User:Bayt|Bayt]]
I really like origamiE :-)

Folding support

2006-04-26T14:55:37Z

Sanakan: Milestones

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

=Milestones=

==todo==
===M1: May 4th===
* ADT specified

===M2: May ??? ===
* be familiar with ES' way of implementing the AST
* with the above: think about a control wrapper from ES' AST to the project-widget

===Milestones TO DO ===
* implement support for word wrapping ("View" part of the widget)
* specify & implement "Controller"

==done==
* vast empty space 'ere....... yet!

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]
=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui es-ui@origo.ethz.ch]

* [[User:Sanakan| Sanakan]] (Project leader)
* [[User:lord Bubu| Lord Bubu]] (Project leader)
* TODO add project members
* [[User:Exception| Exception]]
* [[User:Panarium| Panarium]]
* [[User:Bayt| Bayt]]
* [[User:salmanasar| salmanasar]]
* [[User:Perro| Perro]]
* [[User:Bru| Bru]]
* [[User:Grippus| Grippus]]

User:Sanakan

2006-04-25T14:44:52Z

Sanakan:

{|
| http://misc.sanakan.com/sanakan.png
|
| i'm a CS student at eth zurich, currently working as a project leader (aka evil director of human resources) for the [[Folding_support]] project. mail-contact: sanakan ~A~T~ student ~D~O~T~ ethz ~D~O~T~ ch

User:Sanakan

2006-04-25T09:56:53Z

Sanakan: image added

{|
| http://misc.sanakan.com/sanakan.png
|
| i'm a student at eth zurich, currently working as a project leader for the [[Folding_support]] project. mail-contact: sanakan ~A~T~ student ~D~O~T~ ethz ~D~O~T~ ch

Folding support

2006-04-22T12:39:50Z

Sanakan:

[[Category:Projects]]
[[Category:EiffelVision2]]

=Overview=
The aim of this project is to enhance Vision with a RichText control that supports folding. The goal is to make this surface in the editor windows of EiffelStudio.

=Milestones=

==M1: April 25th==

==M2: May ??? ==
* implement support for word wrapping
* To be completed by the team

=Links=
[http://www.moria.de/~michael/fe/folding.html What is a folding editor?]
=Team=

Everyone intrested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-ui es-ui@origo.ethz.ch]

* [[User:Sanakan| Sanakan]] (Project leader)
* TODO add 2nd project leader Mario Deuss (Project leader)
* TODO add project members
* [[User:Exception| Exception]]
* [[User:Panarium| Panarium]]
* [[User:Bayt| Bayt]]

Talk:Folding support

2006-04-19T20:02:56Z

Sanakan:

== working title of the project ==

A few ideas:
* Folding -> falten -> eiffel-origami
* FEES : Folding editor for Eiffel Studio
* hidden beauty project
* HYCs : Hide your code
* Folding Fields

any comments from team members?

[[User:Sanakan|Sanakan]] 22:02, 19 April 2006 (CEST)

User:Sanakan

2006-04-18T20:37:09Z

Sanakan:

i'm a student at eth zurich, currently working as a project leader for the [[Folding_support]] project.

mail-contact: 
sanakan ~A~T~ student ~D~O~T~ ethz ~D~O~T~ ch

Folding support

2006-04-18T20:34:16Z

Sanakan: create page.make

The primary goal of this project is to create a Vision2 widget which supports the folding (and therefore hiding) of codeblocks. 
A secondary goal is to integrate this widget within EiffelStudio's editor window.

More information to follow...
In the meantime: for questions please contact wikiuser:[http://eiffelsoftware.origo.ethz.ch/index.php/User:Sanakan sanakan].

Editor

2006-04-18T20:29:36Z

Sanakan:

[[Category:Projects]]

Editor enhancements.

* Tabbed Editor (Team at Eiffel Software)
* Source code formatter
* Editing shortcuts
* [[Folding support]] (Team at ETHZ)
* Fully customizable UI layout, UI docking (Team at Eiffel Software)

Compiling EiffelStudio

2006-04-18T16:29:43Z

Sanakan: added link to latest gobo CVS package

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

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

'''Bash and Windows'''
<pre>
cd 57dev
svn up C
svn up Eiffel
svn up free_add_ons
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. 
As the anonymous CVS on sourceforge is currently broken, use the following link from the gobo newsgroup to get the [http://www.gobosoft.com/download/gobo-cvs-060418.zip 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:
<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]. 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:

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

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

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

The basic steps are:
* compile it under linux
* copy the F_Code directory to the mac
* compile it there using make
* fix whatever problems appear

Compiling EiffelStudio

2006-04-18T16:25:07Z

Sanakan: added svn update instructions

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

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

'''Bash and Windows'''
<pre>
cd 57dev
svn up C
svn up Eiffel
svn up free_add_ons
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]. 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:

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

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

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

The basic steps are:
* compile it under linux
* copy the F_Code directory to the mac
* compile it there using make
* fix whatever problems appear