Author:admin

Date:2008-09-17T13:53:28.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@3 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
jfiat
2008-09-17 13:53:28 +00:00
parent 4fee9356ea
commit 2ee31ab9c7
763 changed files with 36576 additions and 0 deletions

View File

@@ -0,0 +1,20 @@
[[Property:title|Reference for `attribute_exists']]
[[Property:link_title|attribute_exists]]
[[Property:weight|-15]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"'''
'''EIF_BOOLEAN attribute_exists (EIF_REFERENCE''' ''object'', '''char *''' ''name''''')''';</code>
==DESCRIPTION==
The '''attribute_exists()''' macro returns '''EIF_TRUE''' or '''EIF_FALSE''' when the attribute of name ''name'' exists in the Eiffel object (reference) ''ref'' '''. '''
==RETURN VALUE==
'''EIF_TRUE''' or '''EIF_FALSE'''.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==SEE ALSO==
'''eif_attribute''' (1).

View File

@@ -0,0 +1,20 @@
[[Property:title|Reference for `eif_access']]
[[Property:link_title|eif_access]]
[[Property:weight|-14]]
==SYNOPSYS==
<code>
'''#include "eif_hector.h"
EIF_REFERENCE eif_access (EIF_OBJECT''' ''obj''''');'''</code>
==DESCRIPTION==
The '''eif_access()''' macro accesses the Eiffel object ''obj''.
==RETURN VALUE==
It returns the Eiffel reference protected by ''obj'' and which can be passed to Eiffel routines.
==CONFORMANCE==
ISE Eiffel 4.1 and later.
==SEE ALSO==
'''eif_wean'''(1) , '''eif_adopt'''(1), '''eif_protect'''(1).

View File

@@ -0,0 +1,20 @@
[[Property:title|Reference for `eif_adopt']]
[[Property:link_title|eif_adopt]]
[[Property:weight|-13]]
==SYNOPSYS==
<code>
'''#include "eif_hector.h"
EIF_OBJECT eif_adopt (EIF_OBJECT''' ''obj''''');'''</code>
==DESCRIPTION==
The '''eif_adopt()''' function adopts ''obj''. By adopting it, the user prevents ''obj'' from being unprotected automatically by the Eiffel run-time. The run-time protects automatically the Eiffel objects passed to a C external before entering in it and unprotects them after exiting the C external. To keep this protection later on, you must call '''eif_adopt()'''.
==RETURN VALUE==
The '''eif_adopt()''' function returns an EIF_OBJECT. This return value can be used later on to access the nested protected Eiffel reference with '''eif_access()'''.
==CONFORMANCE==
ISE Eiffel 4.1 and later.
==SEE ALSO==
'''eif_access''' (1), '''eif_protect''' (1), '''eif_wean''' (1).

View File

@@ -0,0 +1,20 @@
[[Property:title|Reference for `eif_attribute_type']]
[[Property:link_title|eif_attribute_type]]
[[Property:weight|-11]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
int eif_attribute_type (char *''' ''attr''''', EIF_TYPE_ID''' ''tid''''');'''</code>
==DESCRIPTION==
The '''eif_attribute_type()''' function returns the type of the attribute ''attr'', from the Eiffel type, which type identifier is ''tid'' '''. '''
==RETURN VALUE==
Upon failure, it returns EIF_NO_TYPE. Otherwise, the return value can be one of the following: '''EIF_INTEGER_TYPE''', '''EIF_CHARACTER_TYPE''', '''EIF_BOOLEAN_TYPE''', '''EIF_DOUBLE_TYPE''', '''EIF_REAL_TYPE''', '''EIF_REFERENCE_TYPE''', '''EIF_EXPANDED_TYPE''', '''EIF_BIT_TYPE'''.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==SEE ALSO==
'''eif_protect'''(1) , '''attribute_exists'''(1) , '''eif_procedure'''(1) , '''eif_reference_function'''(1).

View File

@@ -0,0 +1,34 @@
[[Property:title|Reference for `eif_attribute'.]]
[[Property:link_title|eif_attribute]]
[[Property:weight|-12]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
EIFFEL_TYPE eif_attribute (EIF_REFERENCE''' ''object''''', char *''' ''name''''', EIFFEL_TYPE, int *''' ''status'');</code>
==DESCRIPTION==
The '''eif_attribute()''' macro returns the attribute of name ''name'', which is of type ''EIFFEL_TYPE''.
''EIFFEL_TYPE'' is the type of the Eiffel attribute. It can be: '''EIF_INTEGER''', '''EIF_CHARACTER''', '''EIF_BOOLEAN''', '''EIF_DOUBLE''', '''EIF_REAL''', or '''EIF_REFERENCE'''.
If ''status'' is NULL then no status is set. Otherwise the status of the call is put into ''*status''. Its value is one of the following:
If the visible exception is enabled, then a visible exception is raised upon failure ( '''EIF_NO_ATTRIBUTE''', '''EIF_CECIL_ERROR''').
==RETURN VALUE==
Upon failure, it returns ( ''EIFFEL_TYPE'') 0, otherwise the attribute is returned.
==NOTES==
If the return value is an '''EIF_REFERENCE''', you must protect it with '''eif_protect()'''. <br/>
You cannot access a constant attribute, or the result of a once function with '''eif_attribute()'''.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==COMPATIBILITY==
'''eif_attribute (''' ''object'' ''',''' ''name'' ''',''' ''type'' ''',''' ''NULL'' ''')''' <br/>
is equivalent to: <br/>
'''eif_field (''' ''object'' ''',''' ''name'' ''',''' ''type'' ''')''' <br/>
which is deprecated.
==SEE ALSO==
'''eif_protect'''(1) , '''attribute_exists'''(1) , '''eif_procedure'''(1) , '''eif_reference_function'''(1). Markup created by 1. 0, November 15, 1999.

View File

@@ -0,0 +1,23 @@
[[Property:title|Reference for `eif_create']]
[[Property:link_title|eif_create]]
[[Property:weight|-7]]
==SYNOPSYS==
<code>
'''#include "eif_cecil. h"'''
'''EIF_OBJECT eif_create (EIF_TYPE_ID''' ''tid''''');'''</code>
==DESCRIPTION==
The '''eif_create()''' function creates an Eiffel object, which type identifier is ''tid''.
==RETURN VALUE==
It returns an Eiffel object, which is already protected.
==NOTES==
You cannot pass the return value to Eiffel routines as is: you must call '''eif_access()''' to pass it to Eiffel routine. <br/>
To release the protection of an Eiffel object created with '''eif_create()''', call '''eif_wean()'''. It will be collected during the next collection.
==CONFORMANCE==
ISE Eiffel 4.1 and later.
==SEE ALSO==
'''eif_wean'''(1) , '''eif_type_id'''(1).

View File

@@ -0,0 +1,23 @@
[[Property:title|Reference for `eif_disable_visible_exception']]
[[Property:link_title|eif_disable_visible_exception]]
[[Property:weight|-6]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
void eif_enable_visible_exception ();
void eif_disable_visible_exception ();'''</code>
==DESCRIPTION==
The '''eif_enable_visble_exception()''' routine enables the visible exception, while '''eif_disable_visible_exception()'''disables it. These routines can be used for debugging purpose. A visible exception is raised when the user tries to access to an Eiffel attribute or a Eiffel routine address which is not visible.
The visible exception is disabled by default.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==COMPATIBILTY==
In ISE Eiffel 4.3 and 4.4, the visible exception is enabled by default.
==SEE ALSO==
'''eif_attribute'''(1) , '''eif_procedure'''(1), '''eif_reference_function'''(1).

View File

@@ -0,0 +1,23 @@
[[Property:title|Reference for `eif_enable_visible_exception']]
[[Property:link_title|eif_enable_visible_exception]]
[[Property:weight|-4]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
void eif_enable_visible_exception ();
void eif_disable_visible_exception ();'''</code>
==DESCRIPTION==
The '''eif_enable_visble_exception()''' routine enables the visible exception, while '''eif_disable_visible_exception()'''disables it. These routines can be used for debugging purpose. A visible exception is raised when the user tries to access to an Eiffel attribute or a Eiffel routine address which is not visible.
The visible exception is disabled by default.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==COMPATIBILITY==
In ISE Eiffel 4.3 and 4.4, the visible exception is enabled by default.
==SEE ALSO==
'''eif_attribute'''(1) , '''eif_procedure'''(1), '''eif_reference_function'''(1).

View File

@@ -0,0 +1,22 @@
[[Property:title|Reference for `eif_name_by_tid']]
[[Property:link_title|eif_name_by_tid]]
[[Property:weight|-1]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
char *eif_name_by_tid (EIF_TYPE_ID''' ''tid''''');'''</code>
==DESCRIPTION==
The '''eif_name_by_tid()''' function returns the name of the class corresponding to ''tid''.
==RETURN VALUE==
A statically allocated C string which is the name of the class. If ''tid'' is invalid, it returns NULL.
==CONFORMANCE==
ISE Eiffel 4.4 and later.
==COMPATIBILITY==
'''eif_name()''' is equivalent to '''eif_name_by_tid()'''.
==SEE ALSO==
'''eif_type'''(1) , '''eif_type_by_reference'''(1), '''eif_type_id'''(1).

View File

@@ -0,0 +1,22 @@
[[Property:title|Reference for `eif_name']]
[[Property:link_title|eif_name]]
[[Property:weight|-2]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
char *eif_name (EIF_TYPE_ID '''''tid''''');'''</code>
==DESCRIPTION==
The '''eif_name()''' function returns the name of the class corresponding to ''tid''.
==RETURN VALUE==
A statically allocated C string which is the name of the class. If ''tid'' is invalid, it returns NULL.
==CONFORMANCE==
ISE Eiffel 4.4 and later.
==COMPATIBILITY==
'''eif_name()''' is equivalent to '''eif_name_by_tid()'''.
==SEE ALSO==
'''eif_type'''(1) , '''eif_type_by_reference'''(1), '''eif_type_id'''(1).

View File

@@ -0,0 +1,28 @@
[[Property:title|Reference for `eif_procedure']]
[[Property:link_title|eif_procedure]]
[[Property:weight|1]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
EIF_PROCEDURE eif_procedure (char *''' ''name''''', int *''' ''tid''''');'''</code>
==DESCRIPTION==
The '''eif_procedure()''' function returns the address of the Eiffel procedure of name ''name'' from the class, which type identifier is ''tid''.
If the visible exception is enabled, it raises an visible exception upon failure.
==RETURN VALUE==
It returns NULL when it fails ( the procedure does not exist or is not visible). Otherwise, the address of the procedure is returned.
==NOTES==
The Eiffel procedure cannot be a C external. In this case, you must directly call the C routine. <br/>
The return value is an address: to use it as a routine, you must call it with arguments or at least with (). <br/>
No argument type checking is done. You may cast the address of an Eiffel routine obtained with '''eif_procedure()''' when calling it with real arguments.
==CONFORMANCE==
ISE Eiffel 4.4 and later.
==COMPATIBILITY==
'''eif_procedure()''' is equivalent to '''eif_proc()''', which is deprecated.
==SEE ALSO==
'''eif_type_id'''(1), '''eif_reference_function'''(1).

View File

@@ -0,0 +1,22 @@
[[Property:title|Reference for `eif_protect']]
[[Property:link_title|eif_protect]]
[[Property:weight|2]]
==SYNOPSYS==
<code>
'''#include "eif_hector.h"
EIF_OBJECT eif_protect (EIF_REFERENCE''' ''ref''''');'''</code>
==DESCRIPTION==
The '''eif_protect()''' function protects the Eiffel reference ''ref'' from the GC. It keeps a reference on it so that the Garbage Collector does not collect it if it is not referenced from Eiffel any longer.
==RETURN VALUE==
The '''eif_protect()''' function returns an EIF_OBJECT. This EIF_OBJECT can be used later on to access ''ref'' with '''eif_access ()'''.
==CONFORMANCE==
ISE Eiffel 4.4 and later.
==COMPATIBILTY==
It is equivalent to '''henter()''', which is deprecated.
==SEE ALSO==
'''eif_access'''(1), '''eif_protect'''(1) , '''eif_wean'''(1).

View File

@@ -0,0 +1,24 @@
[[Property:title|Reference for `eif_string']]
[[Property:link_title|eif_string]]
[[Property:weight|5]]
==SYNOPSYS==
<code>
'''#include "eif_plug.h"
EIF_REFERENCE eif_string (char *''' ''string''''');'''</code>
==DESCRIPTION==
The '''eif_string()''' macro returns the corresponding Eiffel string corresponding to the C string ''string''.
The return value does not reference ''string''.
==NOTES==
This function return an Eiffel reference, which must be protected with '''eif_protect()'''.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==COMPATIBILITY==
'''eif_string()''' is equivalent to '''RTMS()''', which is deprecated.
==SEE ALSO==
'''eif_protect'''(1) , '''eif_create'''(1).

View File

@@ -0,0 +1,25 @@
[[Property:title|Reference for `eif_type_id']]
[[Property:link_title|eif_type_id]]
[[Property:weight|9]]
==SYNOPSYS==
<code>
'''#include "eif_gen_conf.h"
EIF_TYPE_ID eif_type_id (char *''' ''type''''');'''</code>
==DESCRIPTION==
The '''eif_type_id()''' function returns the type identifier corresponding to ''type'', which is the name of the type.
==RETURN VALUE==
The '''eif_type_id()''' function returns the type
==NOTES==
An error cannot be caught by a visible exception. <br/>
The type is not necessary visible.
==CONFORMANCE==
ISE Eiffel 4.3 and later.
==COMPATIBILITY==
'''eif_type_id()''' is equivalent to '''eif_type_by_name()'''. With ISE Eiffel 4.2 and earlier, use '''eif_generic_type()''' for generic types.
==SEE ALSO==
'''eif_reference_function'''(1) , '''eif_procedure'''(1) , '''eif_type'''(1), '''eif_name'''(1).

View File

@@ -0,0 +1,25 @@
[[Property:title|Reference for `eif_type_by_name']]
[[Property:link_title|eif_type_by_name]]
[[Property:weight|7]]
==SYNOPSYS==
<code>
'''#include "eif_gen_conf.h"
EIF_TYPE_ID eif_type_by_name (char *''' ''type''''');'''</code>
==DESCRIPTION==
The '''eif_type_by_name()''' function returns the type identifier corresponding to ''type'', which is the name of the type.
==RETURN VALUE==
The '''eif_type_by_name()''' function returns the type
==NOTES==
An error cannot be caught by a visible exception. <br/>
The type is not necessary visible.
==CONFORMANCE==
ISE Eiffel 4.3 and later.
==COMPATIBILITY==
'''eif_type_by_name()''' is equivalent to '''eif_type_id()'''.
==SEE ALSO==
'''eif_reference_function'''(1) , '''eif_procedure'''(1) , '''eif_type'''(1), '''eif_name'''(1).

View File

@@ -0,0 +1,20 @@
[[Property:title|Reference for `eif_type_by_reference']]
[[Property:link_title|eif_type_by_reference]]
[[Property:weight|8]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
EIF_TYPE_ID eif_type_by_reference (EIF_REFERENCE''' ''reference''''');'''</code>
==DESCRIPTION==
The '''eif_type_by_reference()''' function returns the type identifier corresponding to ''reference''.
==RETURN VALUE==
Type identifier of ''reference''. The behavior is unknown if ''reference'' is not a valid Eiffel reference.
==CONFORMANCE==
ISE Eiffel 4.5 and later.
==SEE ALSO==
'''eif_type'''(1) , '''eif_name'''(1), '''eif_type_id'''(1).

View File

@@ -0,0 +1,22 @@
[[Property:title|Reference for `eif_type']]
[[Property:link_title|eif_type]]
[[Property:weight|6]]
==SYNOPSYS==
<code>
'''#include "eif_cecil.h"
EIF_TYPE_ID eif_type (EIF_OBJECT '''''object''''');'''</code>
==DESCRIPTION==
The '''eif_type()''' function returns the type identifier corresponding to ''object''.
==RETURN VALUE==
Type identifier of ''object''. The behavior is unknown if ''object'' is not a valid Eiffel object.
==CONFORMANCE==
ISE Eiffel 4.3 and later.
==COMPATIBILITY==
'''eif_type()''' is equivalent to '''eif_type_by_reference(eif_access (object))'''.
==SEE ALSO==
'''eif_type_by_reference'''(1) , '''eif_type_id'''(1).

View File

@@ -0,0 +1,20 @@
[[Property:title|Reference for `eif_wean']]
[[Property:link_title|eif_wean]]
[[Property:weight|10]]
==SYNOPSYS==
<code>
'''#include "eif_hector.h"
EIF_REFERENCE eif_wean (EIF_OBJECT''' ''obj''''');'''</code>
==DESCRIPTION==
The '''eif_wean()''' function releases the protection of the Eiffel reference, which is protected by the Eiffel object ''obj''.
==RETURN VALUE==
It returns the Eiffel reference previously protected by obj.
==CONFORMANCE==
ISE Eiffel 4.1 and later.
==SEE ALSO==
'''eif_access'''(1) , '''eif_adopt'''(1), '''eif_protect'''(1).

View File

@@ -0,0 +1,32 @@
[[Property:title|CECIL Reference]]
[[Property:weight|4]]
Index of CECIL features
* [[Reference for `RTMS'|RTMS()]]
* [[Reference for `attribute_exists'|attribute_exists()]]
* [[Reference for `eif_adopt'|eif_adopt()]]
* [[Reference for `eif_attribute'.|eif_attribute()]]
* [[Reference for `eif_attribute_type'|eif_attribute_type()]]
* [[Reference for `eif_bit_function'|eif_bit_function()]]
* [[Reference for 'eif_boolean_function'|eif_boolean_function()]]
* [[Reference for `eif_character_function'|eif_character_function()]]
* [[Reference for `eif_disable_visible_exception'|eif_disable_visible_exception()]]
* [[Reference for `eif_double_function'|eif_double_function()]]
* [[Reference for `eif_enable_visible_exception'|eif_enable_visible_exception()]]
* [[Reference for `eif_integer_function'|eif_integer_function()]]
* [[Reference for `eif_name'|eif_name()]]
* [[Reference for `eif_name_by_tid'|eif_name_by_tid()]]
* [[Reference for `eif_pointer_function'|eif_pointer_function()]]
* [[Reference for `eif_procedure'|eif_procedure()]]
* [[Reference for `eif_protect'|eif_protect()]]
* [[Reference for `eif_real_function'|eif_real_function()]]
* [[Reference for `eif_reference_function'|eif_reference_function()]]
* [[Reference for `eif_string'|eif_string()]]
* [[Reference for `eif_type'|eif_type()]]
* [[Reference for `eif_type_by_name'|eif_type_by_name()]]
* [[Reference for `eif_type_by_reference'|eif_type_by_reference()]]
* [[Reference for `eif_type_id'|eif_type_id()]]
* [[Reference for `eif_wean'|eif_wean()]]