EiffelStudio: an EiffelSoftware project - User contributions [en]

File:Information Tool change analysis.PNG

2013-04-04T10:29:27Z

Ted:

Eiffel Information System

2013-04-04T10:29:04Z

Ted: /* Change analysis */

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
** SYSTEM_PATH, the path of the system in which current entry is written
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three parameters for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. "bookmark" parameter is supported (Windows Only)
** bookmark: Name of the bookmark in Word document.

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(SYSTEM_PATH)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Note_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol ===

EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

== Change analysis ==
Within EiffelStudio 7.3, there will be new functions in Infomation tool to track changes on target or external resouce side, and potentially affected items on either side are listed.
* New functions are:
** List of elements of current system that would be affected by external resource changes. (The first version limits the external resource to local files.)
** List of external resources that might be affected by changes of current system. (No limit of the type of external resources)
** Change acknowledgement.

Typical work flow to demo affected external resources caused by current system change:
# Open a class, add an Information entry with an external source in the class.
# Start working on that class, save it at as you normally do on regular basis.
# Open Info tool, go to Affected source item in the left tree.
# Check the list of external resouces that might be affected by last changes, as shown in the sceen cast bellow.
# Acknowledge the changes if you find that the external resources do not need a change for last changes of current system.

Typical work flow to demo affected items in the system caused by external resource change:
# Open a class, add an Information entry with an external document (limited to local files in 7.3) in the class.
# Start working on that document, save it at as you normally do on regular basis.
# Open Info tool, go to Affected target in the left tree.
# Check the list of targets that might be affected by last changes of the document. (You may need to click on the "sweep the system now." button to get a full list if auto-sweeping is not enabled.)
# Acknowledge the changes if you find that current system does not need a change for last changes of the document.

[[Image:Information_Tool_change_analysis.PNG]]

Eiffel Information System

2013-04-04T09:55:05Z

Ted:

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
** SYSTEM_PATH, the path of the system in which current entry is written
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three parameters for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. "bookmark" parameter is supported (Windows Only)
** bookmark: Name of the bookmark in Word document.

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(SYSTEM_PATH)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Note_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol ===

EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

== Change analysis ==
Within EiffelStudio 7.3, there will be new functions in Infomation tool to track changes on target or external resouce side, and potentially affected items either side are listed.
* New functions are:
** List of elements of current system that would be affected by external resource changes. (The first version limits the external resource to local files.)
** List of external resources that might be affected by changes of current system. (No limit of the type of external resources)
** Change acknowledgement.

Typical work flow:
*

[[Image:Information_Tool_change_analysis.PNG]]

Eiffel Information System

2013-04-04T09:21:33Z

Ted: /* EiffelStudio Action Protocol (Incoming Implementation) */

EiffelStudio 7.3 Releases

2013-04-04T04:32:24Z

Ted: /* 7.3.x.y (...) */

[[Category:Releases]]__NOTOC__{{ReleaseHistoryHeader}}

= EiffelStudio 7.3.x Releases=

Beta download: ftp://beta:beta57@ftp.eiffel.com/7.3/

==7.3.x.y (...)==

===New features===
* base: Added ability to inspect object that contains references to objects with copy semantics.
* base: Changed <e>TUPLE</e> and depending classes to allow for separate items (rev#92359).
* base: test#scoop031 - Changed <e>ROUTINE</e> and descendants to be usable for agents with separate targets (rev#92360).
* {{Red|compiler, run-time: test#scoop030, test#scoop031 - Supported agents with targets of separate types (rev#92361, rev#92362).}}
* studio: "Affected target" and "Affected source" in Info tool. They are used to report potential target or source changes that are affected by corresponding source and target.(rev#92389)

===Improvements===
===Feature removed===
===Bug fixes===
* base: Fixed bug#18559 in SED_MEMORY_READER_WRITER where if you retrieve a large chunk, we would not allocate enough memory. (rev#92366)
* base: Fixed bug#18560 where comparing an EQUALITY_TUPLE it would only care about the last elements, not the first different element. (rev#92365)
* wel/vision2: Fixed an issue with {WEL_CHOOSE_FOLDER_DIALOG} where `set_starting_path' had no effect (rev#92337).
* compiler: test#scoop020 - Fixed a bug that caused incorrect conformance checks for formal generics of different separate status(rev#92353).
* compiler: test#scoop020 - Fixed a bug that might cause incorrect conformance checks for attachment and separateness status of a constrained formal generic parameter against a class type (rev#92358).
* compiler: test#scoop021 - Fixed a C code generation bug that might cause an access on an invalid address during object test evaluation with an expression of a separate type (rev#92355).
* studio: Fixed the bug that a class directly belongs to a cluster (no folder layer in between) could not be located by the locating function in Groups tool. (rev#92369)
* studio: Fixed a memory corruption that would occur when you have multiple errors during a compilation and you are opening each error in its own tab editor, after opening 4 or 5 tabs, EiffelStudio could become unstable. (rev#92368)

===User changes===

===Developer changes===
* store: Do not remove trailing spaces for STRING_* data types. (rev#92394)
* store: Changed type mapping from STRING_* to varchar instead of char at table allocation (ODBC, rev#92394)

==7.3.9.1412 (Monday March 18th 2013)==

===New features===
*vision2: Added {EV_PIXEL_BUFFER}.stretched which gives you a stretched version of an EV_PIXEL_BUFFER. The quality of the stretch image is much better than of EV_PIXMAP for Windows. On Unix it is the same quality as EV_PIXMAP. (rev#91208)
*base: Added ability to store/retrieve expanded objects with SED (but not yet those that are reference with copy semantics).
*EiffelStudio: Completion window tooltip with contracts.
*EiffelStudio: Debug tooltip that display value of expression when mouse pointer moves over.

===Improvements===
*vision2: Improved stretching of EV_PIXMAP on Windows by using the Color on Color stretching mode of the Win32 API StretchBlt. (rev#91207)
*autotest: Now tests will be executed under the location of the ECFs, and not in the Testing subdirectory of the EIFGENs directory. (rev#91247)

===Feature removed===
* {{Red|Dropped BIT type.}}

===Bug fixes===
* vision2: Fixed <e>{EV_GRID_COLUMN}.required_width_of_item_span</e> to only take into account visible item. (code review#9356052 and rev#91224).
* vision2: Fixed a resizing bug when you have a vertical/horizontal box with a minimum size set, if one of the item has a minimum size larger than its parent, then in some circumstances the child will be shrinked beyond its minimum size causing some visual glitches. See regression tests TEST_EV_CONTAINER.test_horizontal_box_resizing and TEST_EV_CONTAINER.test_vertical_box_resizing for scenario. (code review#9351166 and rev#91251).
* wel: Fixed a 64-bit truncation bug in WEL which was only found when compiling a Vision2 project using an EV_COMBO_BOX on Windows 8 using VCExpress 2012. (rev#91290).
* vision2/wel: Fixed a memory corruption that would occur when loading a 32-bit BMP image as a background image of a container in a 16-bit or lower display. (rev#91377).

===User changes===
*{{Red|base: Storables made using SED from version 6.6 or earlier of EiffelStudio not using the `is_for_fast_retrieval' setting won't be recoverable.}}

===Developer changes===

EiffelStudio 7.3 Releases

2013-03-28T10:42:56Z

Ted: /* New features */

[[Category:Releases]]__NOTOC__{{ReleaseHistoryHeader}}

= EiffelStudio 7.3.x Releases=

Beta download: ftp://beta:beta57@ftp.eiffel.com/7.3/

==7.3.x.y (...)==

===New features===
* base: Added ability to inspect object that contains references to objects with copy semantics.
* base: Changed <e>TUPLE</e> and depending classes to allow for separate items (rev#92359).
* base: test#scoop031 - Changed <e>ROUTINE</e> and descendants to be usable for agents with separate targets (rev#92360).
* {{Red|compiler, run-time: test#scoop030, test#scoop031 - Supported agents with targets of separate types (rev#92361, rev#92362).}}

===Improvements===
===Feature removed===
===Bug fixes===
* wel/vision2: Fixed an issue with {WEL_CHOOSE_FOLDER_DIALOG} where `set_starting_path' had no effect (rev#92337).
* compiler: test#scoop020 - Fixed a bug that caused incorrect conformance checks for formal generics of different separate status(rev#92353).
* compiler: test#scoop020 - Fixed a bug that might cause incorrect conformance checks for attachment and separateness status of a constrained formal generic parameter against a class type (rev#92358).
* compiler: test#scoop021 - Fixed a C code generation bug that might cause an access on an invalid address during object test evaluation with an expression of a separate type (rev#92355).
* EiffelStudio: Fixed the bug that a class directly belongs to a cluster (no folder layer in between) could not be located by the locating function in Groups tool. (rev#92369)

===User changes===
===Developer changes===

==7.3.9.1412 (Monday March 18th 2013)==

===New features===
*vision2: Added {EV_PIXEL_BUFFER}.stretched which gives you a stretched version of an EV_PIXEL_BUFFER. The quality of the stretch image is much better than of EV_PIXMAP for Windows. On Unix it is the same quality as EV_PIXMAP. (rev#91208)
*base: Added ability to store/retrieve expanded objects with SED (but not yet those that are reference with copy semantics).
*EiffelStudio: Completion window tooltip with contracts.
*EiffelStudio: Debug tooltip that display value of expression when mouse pointer moves over.

===Improvements===
*vision2: Improved stretching of EV_PIXMAP on Windows by using the Color on Color stretching mode of the Win32 API StretchBlt. (rev#91207)
*autotest: Now tests will be executed under the location of the ECFs, and not in the Testing subdirectory of the EIFGENs directory. (rev#91247)

===Feature removed===
* {{Red|Dropped BIT type.}}

===Bug fixes===
* vision2: Fixed <e>{EV_GRID_COLUMN}.required_width_of_item_span</e> to only take into account visible item. (code review#9356052 and rev#91224).
* vision2: Fixed a resizing bug when you have a vertical/horizontal box with a minimum size set, if one of the item has a minimum size larger than its parent, then in some circumstances the child will be shrinked beyond its minimum size causing some visual glitches. See regression tests TEST_EV_CONTAINER.test_horizontal_box_resizing and TEST_EV_CONTAINER.test_vertical_box_resizing for scenario. (code review#9351166 and rev#91251).
* wel: Fixed a 64-bit truncation bug in WEL which was only found when compiling a Vision2 project using an EV_COMBO_BOX on Windows 8 using VCExpress 2012. (rev#91290).
* vision2/wel: Fixed a memory corruption that would occur when loading a 32-bit BMP image as a background image of a container in a 16-bit or lower display. (rev#91377).

===User changes===
*{{Red|base: Storables made using SED from version 6.6 or earlier of EiffelStudio not using the `is_for_fast_retrieval' setting won't be recoverable.}}

===Developer changes===

EiffelStudio 7.3 Releases

2013-03-28T10:37:33Z

Ted: /* Bug fixes */

[[Category:Releases]]__NOTOC__{{ReleaseHistoryHeader}}

= EiffelStudio 7.3.x Releases=

Beta download: ftp://beta:beta57@ftp.eiffel.com/7.3/

==7.3.x.y (...)==

===New features===
* base: Added ability to inspect object that contains references to objects with copy semantics.
* base: Changed <e>TUPLE</e> and depending classes to allow for separate items (rev#92359).
* base: test#scoop031 - Changed <e>ROUTINE</e> and descendants to be usable for agents with separate targets (rev#92360).
* {{Red|compiler, run-time: test#scoop030, test#scoop031 - Supported agents with targets of separate types (rev#92361, rev#92362).}}

===Improvements===
===Feature removed===
===Bug fixes===
* wel/vision2: Fixed an issue with {WEL_CHOOSE_FOLDER_DIALOG} where `set_starting_path' had no effect (rev#92337).
* compiler: test#scoop020 - Fixed a bug that caused incorrect conformance checks for formal generics of different separate status(rev#92353).
* compiler: test#scoop020 - Fixed a bug that might cause incorrect conformance checks for attachment and separateness status of a constrained formal generic parameter against a class type (rev#92358).
* compiler: test#scoop021 - Fixed a C code generation bug that might cause an access on an invalid address during object test evaluation with an expression of a separate type (rev#92355).
* EiffelStudio: Fixed the bug that a class directly belongs to a cluster (no folder layer in between) could not be located by the locating function in Groups tool. (rev#92369)

===User changes===
===Developer changes===

==7.3.9.1412 (Monday March 18th 2013)==

===New features===
*vision2: Added {EV_PIXEL_BUFFER}.stretched which gives you a stretched version of an EV_PIXEL_BUFFER. The quality of the stretch image is much better than of EV_PIXMAP for Windows. On Unix it is the same quality as EV_PIXMAP. (rev#91208)
*base: Added ability to store/retrieve expanded objects with SED (but not yet those that are reference with copy semantics).

===Improvements===
*vision2: Improved stretching of EV_PIXMAP on Windows by using the Color on Color stretching mode of the Win32 API StretchBlt. (rev#91207)
*autotest: Now tests will be executed under the location of the ECFs, and not in the Testing subdirectory of the EIFGENs directory. (rev#91247)

===Feature removed===
* {{Red|Dropped BIT type.}}

===Bug fixes===
* vision2: Fixed <e>{EV_GRID_COLUMN}.required_width_of_item_span</e> to only take into account visible item. (code review#9356052 and rev#91224).
* vision2: Fixed a resizing bug when you have a vertical/horizontal box with a minimum size set, if one of the item has a minimum size larger than its parent, then in some circumstances the child will be shrinked beyond its minimum size causing some visual glitches. See regression tests TEST_EV_CONTAINER.test_horizontal_box_resizing and TEST_EV_CONTAINER.test_vertical_box_resizing for scenario. (code review#9351166 and rev#91251).
* wel: Fixed a 64-bit truncation bug in WEL which was only found when compiling a Vision2 project using an EV_COMBO_BOX on Windows 8 using VCExpress 2012. (rev#91290).
* vision2/wel: Fixed a memory corruption that would occur when loading a 32-bit BMP image as a background image of a container in a 16-bit or lower display. (rev#91377).

===User changes===
*{{Red|base: Storables made using SED from version 6.6 or earlier of EiffelStudio not using the `is_for_fast_retrieval' setting won't be recoverable.}}

===Developer changes===

Exception mechanism internals

2012-06-26T07:10:55Z

Ted:

[[Category:Exception]]
== Overview ==
This article documents exception handling mechanisms at implementation level, including runtime and code generation.

== Typical execution/trace stack operation in a routine ==
Once or routine with old variable is slightly different.
See following pseudocode:

<eiffel>
-- entry

new_exset
do
-- eif_stack: Create a new vector EX_CALL on eif_stack.
end

if not setjmp then

-- Routine body

else

exresc

do

-- eif_trace: Check the stack of eif_trace top element must be EN_FAIL or EN_RES

-- eif_trace: Mark top node as rescued

-- eif_trace: Create new EN_ILVL item on eif_trace, indicating entering a new level

-- eif_stack: Create new EX_RESC vector on eif_stack.

end

Rescue_body

-- If there is retry clause, it calls

exret

do

-- eif_stack: Check top vector of eif_stack is EX_RESC

-- eif_stack: Override top item of eif_stack with the vector of current routine (saved as local). Change the type of the vector to EX_RETY

-- eif_trace: Pop off eif_trace, which must be EN_ILVL item

-- eif_trace: unwind_trace, pop items from eif_trace until EN_ILVL item is found. Restore `exdata' at previous level.

end

-- If no retry is called, call at the end:

exfail

do

-- eif_stack: pop EX_RESC from eif_stack

-- eif_trace: pop EN_ILVL from eif_trace, leaving call failures created by `draise' on stack.

-- create last_exception (ROUTINE_FAILURE)

-- eif_stack: call `backtrack' which will pop eif_stack until find the top most jmpbuf.

-- Call longjmp with the found jmpbuf.

end

end

exok

do

-- eif_stack: Pop eif_stack until a EX_CALL, EX_RESC, EX_RETY or EX_OSTK is found and popped.

-- eif_trace: unwind_trace, pop item from eif_trace until we find EN_ILVL item. Restore `exdata' at previous level.

end
</eiffel>

== Raise an exception (draise, eraise, com_raise, ) ==

* Create a new item on eif_trace, with the type the exception.

* Pop and push back eif_stack in order to get information. Fill those information into `exdata'.

* Setup information for top node in eif_trace.

* In make_exception, when building trace, traverse eif_stack, and push corresponding items into eif_trace, until jmp pointer is found. In the meantime, if the item is EX_RESC, we change it to EN_OLVL and put into eif_trace.

* Continue buidling trace from the rest element of eif_stack until root node is reached.

* Call `back_track' to really pop off items in eif_stack and call longjmp when the first jmp pointer is found.

== System signal handler ==

* Push an EN_ILVL item on eif_trace

* Push an EX_HDLR item on eif_stack and setup a jmpbuf

* Call exception handler and be ready to longjmp back and call eraise to populate the exception.

Exception mechanism internals

2012-06-26T07:01:14Z

Ted: New page: Category:Exception == Overview == This article documents exception handling mechanisms at implementation level, including runtime and code generation. == Typical execution/trace stack...

File:Information (EIS) Tool.PNG

2012-06-26T04:35:34Z

Ted: uploaded a new version of "Image:Information (EIS) Tool.PNG": For 7.1

Information (EIS) Tool, screen shot

Eiffel Information System

2012-06-26T04:30:50Z

Ted: /* Syntax for Annotations */

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
** SYSTEM_PATH, the path of the system in which current entry is written
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three parameters for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. "bookmark" parameter is supported (Windows Only)
** bookmark: Name of the bookmark in Word document.

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(SYSTEM_PATH)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Node_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol (Incoming Implementation) ===
{{red|(immature and incomplete)}} 
EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

Compiler and encoding

2012-05-31T04:19:27Z

Ted: /* Validility */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
=== Data Storage ===
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes.

Here is an example of how a character é is represented at various levels.
<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

=== Validility ===
Source code encoding is either explicitly or implicitly specified.
* Explicit
** File level: UTF-8 (BOM) is implemented
** Class level: note clause (not implemented)
** Configure file: .ecf (not implemented)
* Implicit
** Implicit encoding is taken as ISO-8859-1 for compatibility, if no source code encoding is specified.

The following table shows how manifest strings are validated by the compiler:
{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
|
| Explicit Encoding
| Implicit Encoding (ISO-8859-1)
|-
| STRING_8 manifest
| Unicode point (0-255)?
| Valid (taken as bytes)
|-
| STRING_32 manifest
| Valid
| Valid
|}

Compiler and encoding

2012-05-31T04:16:35Z

Ted: /* Data Storage */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
=== Data Storage ===
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes.

Here is an example of how a character é is represented at various levels.
<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

=== Validility ===
Source code encoding is either explicitly or implicitly specified.
* Explicit
** File level: UTF-8 (BOM) is implemented
** Class level: note clause (not implemented)
** Configure file: .ecf (not implemented)
* Implicit
** Implicit encoding is taken as ISO-8859-1 for compatibility, if no source code encoding is specified.

The following table shows how manifest strings are validated by the compiler:
{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
|
| Explicit Encoding
| Implicit Encoding (ISO-8859-1)
|-
| STRING_8 manifest
| Only Standard ASCII is valid (0-127)
| Valid (taken as bytes)
|-
| STRING_32 manifest
| Valid
| Valid
|}

Compiler and encoding

2012-05-31T03:29:30Z

Ted: /* Validility */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
=== Data Storage ===
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes.

Here is an example of how a character é is represented at various levels.
<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8 Rejected)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

=== Validility ===
Source code encoding is either explicitly or implicitly specified.
* Explicit
** File level: UTF-8 (BOM) is implemented
** Class level: note clause (not implemented)
** Configure file: .ecf (not implemented)
* Implicit
** Implicit encoding is taken as ISO-8859-1 for compatibility, if no source code encoding is specified.

The following table shows how manifest strings are validated by the compiler:
{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
|
| Explicit Encoding
| Implicit Encoding (ISO-8859-1)
|-
| STRING_8 manifest
| Only Standard ASCII is valid (0-127)
| Valid (taken as bytes)
|-
| STRING_32 manifest
| Valid
| Valid
|}

Compiler and encoding

2012-05-31T03:27:40Z

Ted: /* Validility */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
=== Data Storage ===
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes.

Here is an example of how a character é is represented at various levels.
<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8 Rejected)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

=== Validility ===
Source code encoding is either explicitly or implicitly specified.
* Explicit
** File level: UTF-8 (BOM) is implemented
** Class level: note clause (not implemented)
** Configure file: .ecf (not implemented)
* Implicit
** Implicit encoding is taken as ISO-8859-1 for compatibility, if no source code encoding is specified.

The following table shows how manifest strings are validated by the compiler:
{|
|
| Explicit Encoding
| Implicit Encoding (ISO-8859-1)
|-
| STRING_8 manifest
| Only Standard ASCII is valid (0-127)
| Valid (taken as bytes)
|-
| STRING_32 manifest
| Valid
| Valid
|}

Compiler and encoding

2012-05-31T03:11:00Z

Ted: /* Internals */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
=== Data Storage ===
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes.

Here is an example of how a character é is represented at various levels.
<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8 Rejected)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

=== Validility ===
Source code encoding is either explicitly or implicitly specified.
* Explicit
** File level: UTF-8 (BOM) is implemented
** Class level: note clause (not implemented)
** Configure file: .ecf (not implemented)
* Implicit
** Implicit encoding is taken as ISO-8859-1 for compatibility, if no source code encoding is specified.

Compiler and encoding

2012-05-30T12:04:58Z

Ted: /* Internals */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes.

Here is an example of how a character é is represented at various levels.
<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8 Rejected)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

Compiler and encoding

2012-05-30T12:03:09Z

Ted: /* Internals */

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accepts UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==
Abstracted syntax tree now stores STRING_8 as UTF-8 data on each node. There are also different features exporting UTF-8, UTF-32 or the written bytes. Here is an example of how a character é is represented in various levels.

<div class="WordSection1" style="layout-grid: 15.6pt">

{| class="MsoTableGrid" style="width: 431.25pt; border-collapse: collapse; border: none" width="575" border="1"
| style="width: 147.15pt; border: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Source encoding
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
UTF-8 (BOM)
| style="width: 142.05pt; border: solid windowtext 1.0pt; border-left: none; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
ISO-8859-1
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
Bytes in source
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
1. {STRING_AS}.value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
2. {STRING_AS}.binary_value
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
3. {STRING_AS}.value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
4. {STRING_AS}.string_value_32
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9
|-
| style="width: 147.15pt; border: solid windowtext 1.0pt; border-top: none; padding: 0cm 5.4pt 0cm 5.4pt" width="196" valign="top" |
5. Runtime
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xC3A9 (STRING_8 Rejected)

0xE9 (STRING_32)
| style="width: 142.05pt; border-top: none; border-left: none; border-bottom: solid windowtext 1.0pt; border-right: solid windowtext 1.0pt; padding: 0cm 5.4pt 0cm 5.4pt" width="189" valign="top" |
0xE9 (STRING_8)

0xE9 (STRING_32)
|}

</div>

Compiler and encoding

2012-05-30T11:34:41Z

Ted:

Compiler and encoding

2012-05-30T11:00:51Z

Ted: New page: Category:compiler From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accept UTF-8 source code, for simplicity and generality. Before source cod...

[[Category:compiler]]

From 6.7, the compiler has been equiped with a Unicode parser. The core of the parser only accept UTF-8 source code, for simplicity and generality. Before source code is passed into the core process of parsing, it is preprocessed and converted into UTF-8.

== Internals ==

Eiffel Information System

2012-05-07T11:16:35Z

Ted: /* Variables */

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
** SYSTEM_PATH, the path of the system in which current entry is written
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three parameters for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. "bookmark" parameter is supported (Windows Only)
** bookmark: Name of the bookmark in Word document.

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Node_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol (Incoming Implementation) ===
{{red|(immature and incomplete)}} 
EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

Eiffel Information System

2012-05-07T11:15:19Z

Ted: /* Protocol */

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
** SYSTEM_PATH, the written location of current entry
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three parameters for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. "bookmark" parameter is supported (Windows Only)
** bookmark: Name of the bookmark in Word document.

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Node_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol (Incoming Implementation) ===
{{red|(immature and incomplete)}} 
EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

Eiffel Information System

2012-05-07T11:13:43Z

Ted: /* Variables */

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
** SYSTEM_PATH, the written location of current entry
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three attributes for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. (Not implemented)

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Node_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol (Incoming Implementation) ===
{{red|(immature and incomplete)}} 
EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

Eiffel Information System

2012-05-07T09:21:05Z

Ted: /* Protocol */

[[Category:EiffelStudio]]
[[Category:Eiffel Information System]]

== Purpose ==
The Eiffel Information System (EIS) provides a unified mechanism for linking development objects — classes, features and so on — of Eiffel systems with '''external information'''. This term refers to information other than Eiffel program texts. Usually the tools maintaining external information are separate tools, such as a browser; we call them '''external tools'''. Examples of external information and possible corresponding external tools are:
* Web page — the default browser
* PDF document — Acrobat
* MS Word documents — Microsoft Word
EIS is also intended to be the standard mechanism for obtaining help on Eiffel and EiffelStudio, replacing previous solutions. In that case "external tools" may actually be Eiffel tools.

== Functionalities ==
The basic mechanisms that EIS makes available to users include two categories: outgoing (from Eiffel to external tools), incoming (the reverse).

* Examples of outgoing mechanisms include:
** Annotating Eiffel targets, classes and features to include references to external information. Such annotations can include tags.
** By selecting an annotation in EiffelStudio, automatically open the corresponding external tool to display or edit that information.
** Provide a list of all external information (in a class, cluster or entire system) corresponding to a specified tag.
** For a change to the software — either after the change has been performed, or before a contemplated change has been performed — display a list of all external information that may be affected as indicated by the annotations (not implemented in 6.2)

* Examples of incoming mechanisms include:
** For supported tools, select external information linked to an Eiffel developer object and have EiffelStudio directly open on that object. In 6.2, eiffel: schema is supported on Windows.

== Outgoing ==
=== Annotations ===
Annotations may be applicable to:

* An individual class or feature. In this case the annotation figures in the class text, as part of an Eiffel "note" clause ("indexing" is still supported, it depends on which syntax level the user choose).
* A target, library or cluster. In this case the annotation figures in the associated ECF file; EiffelStudio provides support for entering it through a Information (EIS) Tool.

Most of the following rules use note clauses as examples, but all applicable facilities must be supported by both variants; the syntax is designed to be as close as possible.

The basic way to specify a dependency is to include such an annotation. The required part of every annotation is:
* The "EIS" marker.

However the following parts are suggested:
* The "protocol", indicating the type of external information, and making it possible for EIS to determine the associated external tool. Without the "protocol" part, the source defaults to a web page.
* The source, which identifies where to find the information itself, for example a URL, or a file name optionally complemented by a page number.

=== Variables ===
Not all information must be literal: annotations can use variables, defined at various levels including:

* EiffelStudio installation built in variables
** ISE_WIKI = http://dev.eiffel.com
** EIFFELROOM = http://www.eiffelroom.com
** ISE_DOC = http://docs.eiffel.com
** ISE_DOC_UUID = http://doc.eiffel.com/isedoc/uuid
** ISE_DOC_REF = http://doc.eiffel.com/isedoc/eis
* Context related built in variables. These variables can be used in a specific context. For instance, '''feature_name''' refers to the name of the feature in which the annotation is written.
** feature_name
** class_name
** group_name
** target_name
** unique_id
*** The `unique_id' returns a unique id of a class in a compiled system. The id usually consists of target uuid, target name, group name and class name.
* Individual user preferences (Not implemented)
* Individual system or library preferences (in ECF)
* Environment variables

It should be possible to enter an annotation graphically through the EiffelStudio Information (EIS) Tool; in that case the relevant clause (feature, class, cluster, system) will be added automatically.

=== Protocol ===

* URI: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
* PDF: PDF protocol supports three attributes for now. "type" "page" and "nameddest". (Windows only)
** type: "file" is used to open PDF files in the PDF reader. Otherwise it opens in a browser.
** page: Specify the page number to navigate to.
** nameddest: Specify the named destination to navigate to.
* DOC: Microsoft Word document. (Not implemented)

=== Syntax for Annotations ===
The following example illustrates the basic form of an EIS note entry:

<e>EIS: "name=Project Requirement", "src=$(PROJ)/docs/requirements.pdf", "protocol=PDF", "nameddest=4.1", "tag=requirement"</e>

The label (Node_entry as called in the ECMA/ISO Eiffel Standard syntax) is '''EIS''', '''EIS''' Note_value tells the Eiffel Information System that this Note_entry is of interest to EIS, as distinct from any other information that might be expressed through a Note_entry. The file name (src) includes '''$PROJ''', referring to a variable — set at any of the above 5 levels, rather than the second one "Context related built in variables" — defining the project location. The protocol is '''PDF'''. The '''nameddest''' property (name destination) is a specific property of PDF documents. The tag '''requirement''' indicating that this entry links the enclosing Eiffel class or feature with some part of the requirements document.

Similarly, the following example demonstrates how annotations look like in ECF files:
<code>
<note>
<eis auto="true" src="$(ISE_DOC_REF)$(unique_id)"/>
<eis src="$(ISE_DOC_UUID)/3d96626f-11f3-67a2-dec6-69f7faf4a8d6" tag="EiffelTime" name="EiffelTime"/>
</note>
</code>

There is only one major difference here, targets in .ecf support automatic entry specification which enables automatic entry for classes in that target. The note element in ECF is supported in [[http://www.eiffel.com/developers/xml/configuration-1-4-0.xsd schema 1.4]] and greater.

=== Automatic Entry ===

Targets in a .ecf file are allowed to specify automatic entry like this:
<code>
<eis auto="true" src="$(ISE_DOC_REF)/$(unique_id)"/>
</code>
When `auto' is set with `true', automatic entry is enabled in the target. In Info tool, each class in a target with automatic entry enabled displays an entry, actually not existing in code, is bound to a source `src'.

An automatic entry of a class can be overridden too, by specifying "override=true" in one of the written entry, or check the check box in the column of Info tool.

One can modify the automatic entry specification in a target via the first button with an "A" in Info tool. Of course, select a target node in the tree first.

=== Information (EIS) Tool ===

The tool is an output of the EIS outgoing mechanism. Through the tool, users can graphically manage all EIS information in current system. See [[Information (EIS) Tool]] for more information.
There is a screen shot of the tool.

[[Image:Information_(EIS)_Tool.PNG]]

== Incoming ==
Incoming mechanism is based on URI, and introduces a new URI scheme: '''eiffel'''. By entering the URI into address of a browser, or clicking on the hyper link, an existing EiffelStudio instance or new EiffelStudio instance will try to resolve the URI and display corresponding resources.

=== URI scheme Syntax ===
'''eiffel:?<eiffel-resource>'''
<eiffel-resource> is a combination of following parts, connected by '''"&"''' if more than one part are required:
* <system>, in the form of '''system=to_be_replaced''', "to_be_replaced" consists of system_name or uuid of the system, or both connected by '''"."'''.
* <target>, in the form of '''target=to_be_replaced''', "to_be_replaced" consists of target_name or uuid of the system, or both connected by '''"."'''.
* <cluster>, in the form of '''cluster=to_be_replaced''', "to_be_replaced" is the name of the cluster.
* <class>, in the form of '''class=to_be_replaced''', "to_be_replaced" is the name of the class.
* <feature>, in the form of '''feature=to_be_replaced''', "to_be_replaced" is the name of the feature.
{{note|All parts above are unordered.}}

Examples:
eiffel:?class=STRING_8&feature=is_equal
eiffel:?cluster=elks&class=STRING_8&feature=is_equal
eiffel:?target=base&cluster=elks&class=STRING_8&feature=is_equal
eiffel:?system=ec.D398E904-E3C8-4F8A-B9E7-6FE493CEA02F&target=base&cluster=elks&class=STRING_8&feature=is_equal

=== Protocal Registration (Windows) ===
The following example shows how to register eiffel scheme on Windows, estudio.exe in this case, to handle an eiffel URI.
* HKEY_CLASSES_ROOT
** eiffel
** (Default) = "URL:Eiffel Protocol"
** URL Protocol = ""
*** DefaultIcon
*** (Default) = "estudio.exe"
*** shell
**** open
***** command
***** (Default) = "%ISE_EIFFEL%\studio\spec\windows\bin\estudio.exe" /ec_action eisi:"%1"

=== EiffelStudio Action Protocol (Incoming Implementation) ===
{{red|(immature and incomplete)}} 
EiffelStudio uses estudio.exe to interact with all existing instances of ec.exe. The protocol is used for this goal.
The action protocol can be used for those tools that want to control running EiffelStudio instances. For the moment, this is completely transparent to end users because of its immaturity.
It was designed to fit the requirement of EIS incoming mechanism, with limited extendibility. In the future, as required, it could be designed as XML style, after precise analysis on requirements of all kinds of new functionalities.

The pattern EiffelStudio accept is:
[<eiffelstudio-module-ID><predefined-status>]<eiffelstudio-module-ID><modulewise-action>
The part bracketed is optional condition. A command with conditional part is a conditional command.
Without conditional part, the command is direct command.
<eiffelstudio-module-ID> refers to a module defined in EiffelStudio. For example, <com.eiffel.compiler>, the compiler module in EiffelStudio; <com.eiffel.eis_incoming>, EIS incoming module.
<predefined-status> stands for a status of that module, as a conditional status which should trigger the actual <modulewise-action>.
<modulewise-action> indicate the predefined action a module in EiffelStudio should actually react.

The following are examples now implemented on the purpose of EIS incoming functions:
Example: <com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor now.

Example: <com.eiffel.compiler><project_ready><com.eiffel.eis_incoming><eiffel:?class=string_8&feature=out>
Explanation: Demand EiffelStudio open the feature {STRING_8}.out in the editor, when the project is ready.

The protocol is loaded through [https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/framework/command_tunnel Command Tunnel Library]. This library is now only implemented on Windows.

File:Behavior 6 1 result.PNG

2012-05-04T06:58:27Z

Ted:

Paste with Indentation

2012-05-04T06:58:02Z

Ted:

[[Category:Editor]]
=Description=

This article describes a new pasting behavior which is smarter than the regular paste-as-it-is behavior in terms of indentation. However the implementation will remain simple without using heavy Eiffel parser to reformat the text being pasted.

= Behaviors =

In general:
Adjust the number of leading tabs for each line in the pasting text by the result of the number of existing tabs before the editor cursor subtracting the number of leading tabs in the pasting text.

Except:
* There is a non-tabulation character before the editor cursor
* NC = 0
* NP = 0

Note:
* Number of tabulations before the cursor (NC)
* Number of leading tabulations of the text being pasted (NP)

== Behavior 1: Multiple lines with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_1_copied_text.PNG]]
=== Behavior 1.1 ===

Pasted at:

[[Image:Behavior_1_1_pasted_at.PNG]]

Result:

[[Image:Behavior_1_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 1.2 ===
Pasted at:

[[Image:Behavior_1_2_pasted_at.PNG]]

Result:

[[Image:Behavior_1_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 1.3 ===
Pasted at:

[[Image:Behavior_1_3_pasted_at.PNG]]

Result:

[[Image:Behavior_1_3_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NC = 0

== Behavior 2: Multiple lines with no tab in pasting text ==
Copied text:

[[Image:Behavior_2_copied_text.PNG]]

=== Behavior 2.1 ===
Pasted at:

[[Image:Behavior_2_1_pasted_at.PNG]]

Result:

[[Image:Behavior_2_1_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

=== Behavior 2.2 ===
Pasted at:

[[Image:Behavior_2_2_pasted_at.PNG]]

Result:

[[Image:Behavior_2_2_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

== Behavior 3: Single line with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_3_copied_text.PNG]]
=== Behavior 3.1 ===
Pasted at:

[[Image:Behavior_3_1_pasted_at.PNG]]

Result:

[[Image:Behavior_3_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 3.2 ===
Pasted at:

[[Image:Behavior_3_2_pasted_at.PNG]]

Result:

[[Image:Behavior_3_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 3.3 ===
Pasted at:

[[Image:Behavior_3_3_pasted_at.PNG]]

Result:

[[Image:Behavior_3_3_result.PNG]]

Summury:
* Nothing is done to the text pasted when NC = 0

== Behavior 4 ==
Copied text:

[[Image:Behavior_4_copied_text.PNG]]

=== Behavior 4.1 ===
Pasted at:

[[Image:Behavior_4_1_pasted_at.PNG]]

Result:

[[Image:Behavior_4_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)
* This is a good example to show this pasting behavior's advantage. Paste-as-it-is requires 4 steps to get this result.

== Behavior 5: Multiple lines with improperly formatted pasting text ==
Copied text:

[[Image:Behavior_5_copied_text.PNG]]

=== Behavior 5.1 ===
Pasted at:

[[Image:Behavior_5_1_pasted_at.PNG]]

Result:

[[Image:Behavior_5_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)
* The result is not perfect before the copied text is improperly formatted. One has to adjust it manually after pasting.

== Behavior 6: Paste immediately after copy ==
Copied text:

[[Image:Behavior_5_copied_text.PNG]]

=== Behavior 6.1 ===
Pasted at:

[[Image:Behavior_5_copied_text.PNG]]

Result:

[[Image:Behavior_6_1_result.PNG]]

Summury:
* Paste as it is if the selection is the same as the text being pasted.

File:Behavior 5 1 result.PNG

2012-05-04T06:11:29Z

Ted:

File:Behavior 5 1 pasted at.PNG

2012-05-04T06:11:12Z

Ted:

File:Behavior 5 copied text.PNG

2012-05-04T06:10:45Z

Ted:

Paste with Indentation

2012-05-04T05:41:54Z

Ted: /* Behavior 5: Multiple lines with improperly formatted pasting text == */

Paste with Indentation

2012-05-04T05:41:23Z

Ted:

[[Category:Editor]]
=Description=

This article describes a new pasting behavior which is smarter than the regular paste-as-it-is behavior in terms of indentation. However the implementation will remain simple without using heavy Eiffel parser to reformat the text being pasted.

= Behaviors =

In general:
Adjust the number of leading tabs for each line in the pasting text by the result of the number of existing tabs before the editor cursor subtracting the number of leading tabs in the pasting text.

Except:
* There is a non-tabulation character before the editor cursor
* NC = 0
* NP = 0

Note:
* Number of tabulations before the cursor (NC)
* Number of leading tabulations of the text being pasted (NP)

== Behavior 1: Multiple lines with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_1_copied_text.PNG]]
=== Behavior 1.1 ===

Pasted at:

[[Image:Behavior_1_1_pasted_at.PNG]]

Result:

[[Image:Behavior_1_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 1.2 ===
Pasted at:

[[Image:Behavior_1_2_pasted_at.PNG]]

Result:

[[Image:Behavior_1_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 1.3 ===
Pasted at:

[[Image:Behavior_1_3_pasted_at.PNG]]

Result:

[[Image:Behavior_1_3_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NC = 0

== Behavior 2: Multiple lines with no tab in pasting text ==
Copied text:

[[Image:Behavior_2_copied_text.PNG]]

=== Behavior 2.1 ===
Pasted at:

[[Image:Behavior_2_1_pasted_at.PNG]]

Result:

[[Image:Behavior_2_1_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

=== Behavior 2.2 ===
Pasted at:

[[Image:Behavior_2_2_pasted_at.PNG]]

Result:

[[Image:Behavior_2_2_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

== Behavior 3: Single line with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_3_copied_text.PNG]]
=== Behavior 3.1 ===
Pasted at:

[[Image:Behavior_3_1_pasted_at.PNG]]

Result:

[[Image:Behavior_3_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 3.2 ===
Pasted at:

[[Image:Behavior_3_2_pasted_at.PNG]]

Result:

[[Image:Behavior_3_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 3.3 ===
Pasted at:

[[Image:Behavior_3_3_pasted_at.PNG]]

Result:

[[Image:Behavior_3_3_result.PNG]]

Summury:
* Nothing is done to the text pasted when NC = 0

== Behavior 4 ==
Copied text:

[[Image:Behavior_4_copied_text.PNG]]

=== Behavior 4.1 ===
Pasted at:

[[Image:Behavior_4_1_pasted_at.PNG]]

Result:

[[Image:Behavior_4_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)
* This is a good example to show this pasting behavior's advantage. Paste-as-it-is requires 4 steps to get this result.

== Behavior 5: Multiple lines with improperly formatted pasting text == ==
Copied text:

[[Image:Behavior_5_copied_text.PNG]]

=== Behavior 5.1 ===
Pasted at:

[[Image:Behavior_5_1_pasted_at.PNG]]

Result:

[[Image:Behavior_5_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)
* The result is not perfect before the copied text is improperly formatted. One has to adjust it manually after pasting.

File:Behavior 1 1 result.PNG

2012-04-28T01:35:03Z

Ted: uploaded a new version of "Image:Behavior 1 1 result.PNG": Corrected the image

File:Behavior 2 1 pasted at.PNG

2012-04-27T09:29:58Z

Ted:

File:Behavior 2 1 result.PNG

2012-04-27T09:29:04Z

Ted:

File:Behavior 3 3 result.PNG

2012-04-27T09:27:25Z

Ted:

Paste with Indentation

2012-04-27T06:09:23Z

Ted: /* Behaviors */

[[Category:Editor]]
=Description=

This article describes a new pasting behavior which is smarter than the regular paste-as-it-is behavior in terms of indentation. However the implementation will remain simple without using heavy Eiffel parser to reformat the text being pasted.

= Behaviors =

In general:
Adjust the number of leading tabs for each line in the pasting text by the result of the number of existing tabs before the editor cursor
substracting the number of leading tabs in the pasting text.

Except:
* There is already non-tabulation character before the editor cursor
* NC = 0
* NP = 0

Note:
* Number of tabulations before the cursor (NC)
* Number of leading tabulations of the text being pasted (NP)

== Behavior 1: Multiple lines with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_1_copied_text.PNG]]
=== Behavior 1.1 ===

Pasted at:

[[Image:Behavior_1_1_pasted_at.PNG]]

Result:

[[Image:Behavior_1_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 1.2 ===
Pasted at:

[[Image:Behavior_1_2_pasted_at.PNG]]

Result:

[[Image:Behavior_1_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 1.3 ===
Pasted at:

[[Image:Behavior_1_3_pasted_at.PNG]]

Result:

[[Image:Behavior_1_3_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NC = 0

== Behavior 2: Multiple lines with no tab in pasting text ==
Copied text:

[[Image:Behavior_2_copied_text.PNG]]

=== Behavior 2.1 ===
Pasted at:

[[Image:Behavior_2_1_pasted_at.PNG]]

Result:

[[Image:Behavior_2_1_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

=== Behavior 2.2 ===
Pasted at:

[[Image:Behavior_2_2_pasted_at.PNG]]

Result:

[[Image:Behavior_2_2_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

== Behavior 3: Single line with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_3_copied_text.PNG]]
=== Behavior 3.1 ===
Pasted at:

[[Image:Behavior_3_1_pasted_at.PNG]]

Result:

[[Image:Behavior_3_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 3.2 ===
Pasted at:

[[Image:Behavior_3_2_pasted_at.PNG]]

Result:

[[Image:Behavior_3_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 3.3 ===
Pasted at:

[[Image:Behavior_3_3_pasted_at.PNG]]

Result:

[[Image:Behavior_3_3_result.PNG]]

Summury:
* Nothing is done to the text pasted when NC = 0

== Behavior 4 ==
Copied text:

[[Image:Behavior_4_copied_text.PNG]]

=== Behavior 4.1 ===
Pasted at:

[[Image:Behavior_4_1_pasted_at.PNG]]

Result:

[[Image:Behavior_4_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)
* This is a good example to show this pasting behavior's advantage. Paste-as-it-is requires 4 steps to get this result.

File:Behavior 4 1 result.PNG

2012-04-27T05:57:38Z

Ted:

File:Behavior 4 1 pasted at.PNG

2012-04-27T05:57:27Z

Ted:

File:Behavior 4 copied text.PNG

2012-04-27T05:56:53Z

Ted:

File:Behavior 3 3 pasted at.PNG

2012-04-27T05:56:02Z

Ted:

File:Behavior 3 2 result.PNG

2012-04-27T05:55:07Z

Ted:

File:Behavior 3 2 pasted at.PNG

2012-04-27T05:54:54Z

Ted:

File:Behavior 3 1 result.PNG

2012-04-27T05:54:20Z

Ted:

File:Behavior 3 1 pasted at.PNG

2012-04-27T05:54:10Z

Ted:

File:Behavior 3 copied text.PNG

2012-04-27T05:53:08Z

Ted:

File:Behavior 2 2 result.PNG

2012-04-27T05:52:53Z

Ted:

File:Behavior 2 2 pasted at.PNG

2012-04-27T05:52:32Z

Ted:

File:Behavior 2 copied text.PNG

2012-04-27T05:49:44Z

Ted:

Paste with Indentation

2012-04-27T05:47:57Z

Ted: /* Behavior 4 */

[[Category:Editor]]
=Description=

This article describes a new pasting behavior which is smarter than the regular paste-as-it-is behavior in terms of indentation. However the implementation will remain simple without using heavy Eiffel parser to reformat the text being pasted.

= Behaviors =
Note:
* Number of tabulations before the cursor (NC)
* Number of leading tabulations of the text being pasted (NP)

== Behavior 1: Multiple lines with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_1_copied_text.PNG]]
=== Behavior 1.1 ===

Pasted at:

[[Image:Behavior_1_1_pasted_at.PNG]]

Result:

[[Image:Behavior_1_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 1.2 ===
Pasted at:

[[Image:Behavior_1_2_pasted_at.PNG]]

Result:

[[Image:Behavior_1_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 1.3 ===
Pasted at:

[[Image:Behavior_1_3_pasted_at.PNG]]

Result:

[[Image:Behavior_1_3_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NC = 0

== Behavior 2: Multiple lines with no tab in pasting text ==
Copied text:

[[Image:Behavior_2_copied_text.PNG]]

=== Behavior 2.1 ===
Pasted at:

[[Image:Behavior_2_1_pasted_at.PNG]]

Result:

[[Image:Behavior_2_1_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

=== Behavior 2.2 ===
Pasted at:

[[Image:Behavior_2_2_pasted_at.PNG]]

Result:

[[Image:Behavior_2_2_result.PNG]]

Summury:
* Nothing has been done to the pasted text when NP = 0

== Behavior 3: Single line with leading tabs in pasting text ==
Copied text:

[[Image:Behavior_3_copied_text.PNG]]
=== Behavior 3.1 ===
Pasted at:

[[Image:Behavior_3_1_pasted_at.PNG]]

Result:

[[Image:Behavior_3_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)

=== Behavior 3.2 ===
Pasted at:

[[Image:Behavior_3_2_pasted_at.PNG]]

Result:

[[Image:Behavior_3_2_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is not modified when (NC - NP) = 0

=== Behavior 3.3 ===
Pasted at:

[[Image:Behavior_3_3_pasted_at.PNG]]

Result:

[[Image:Behavior_3_3_result.PNG]]

Summury:
* Nothing is done to the text pasted when NC = 0

== Behavior 4 ==
Copied text:

[[Image:Behavior_4_copied_text.PNG]]

=== Behavior 4.1 ===
Pasted at:

[[Image:Behavior_4_1_pasted_at.PNG]]

Result:

[[Image:Behavior_4_1_result.PNG]]

Summury:
* Remove tabs before the cursor.
* The text pasted is indented by one tabulation (NC - NP)
* This is a good example to show this pasting behavior's advantage. Paste-as-it-is requires 4 steps to get this result.

Paste with Indentation

2012-04-27T05:41:40Z

Ted: /* Behavior 3: Single line with leading tabs in pasting text */