mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-07 15:22:31 +01:00
Author:halw
Date:2008-10-13T22:01:47.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@79 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
@@ -53,6 +53,7 @@ The Eiffel category under the main Editor category contains preferences for Eiff
|
||||
| Underscore ' ' is a word separator?
|
||||
|}
|
||||
|
||||
|
||||
==Display Colors==
|
||||
|
||||
{| border="1"
|
||||
|
||||
@@ -13,59 +13,73 @@ This document describes the syntax used to customize keyword automatic completio
|
||||
** ''%T'' represents the tabulation
|
||||
** ''%B'' represents the back space
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
Examples :
|
||||
#
|
||||
You want the lines of code :
|
||||
|
||||
''if'' <br/>
|
||||
next_line_of_code <br/>
|
||||
1) You want the lines of code :
|
||||
|
||||
<code>
|
||||
if
|
||||
next_line_of_code
|
||||
</code><br/>
|
||||
|
||||
to become:
|
||||
''if'' <cursor here> ''then'' <br/>
|
||||
<one more tabulation> <br/>
|
||||
''end'' <br/>
|
||||
next_line_of_code <br/>
|
||||
|
||||
<code>
|
||||
if <cursor here> then
|
||||
<one more tabulation>
|
||||
end
|
||||
next_line_of_code
|
||||
</code>
|
||||
|
||||
as you press Space just after typing ''if''. You should define the "Customized auto complete (Space after keyword was typed)" string for ''if'' as :
|
||||
as you press Space just after typing <code>if</code>.
|
||||
|
||||
" $cursor$ then%N$indent$%T%N$indent$end"
|
||||
To make this happen, you should define the "Customized auto complete (Space after keyword was typed)" string for <code>if</code> as :
|
||||
|
||||
First, EiffelStudio editor has to insert a blank space after ''if''. The string begins therefore by a blank space. <br/>
|
||||
<code lang="text">
|
||||
$cursor$ then%N$indent$%T%N$indent$end
|
||||
</code>
|
||||
|
||||
First, EiffelStudio editor has to insert a blank space after <code>if</code>. The string begins therefore by a blank space. <br/>
|
||||
Then, ''$cursor$'' tells EiffelStudio to move the cursor to this position after the completion. <br/>
|
||||
''then'' is inserted after the cursor position. <br/>
|
||||
''%N'' indicates that you want to insert a new line after ''then''. <br/>
|
||||
''$indent$%T'' means that this line is filled with as many blank spaces as there are before ''if'' plus a tabulation. <br/>
|
||||
<code>then</code> is inserted after the cursor position. <br/>
|
||||
''%N'' indicates that you want to insert a new line after <code>then</code>. <br/>
|
||||
''$indent$%T'' means that this line is filled with as many blank spaces as there are before <code>if</code> plus a tabulation. <br/>
|
||||
Another line is inserted with ''%N''. <br/>
|
||||
Then ''$indent$end'' means that ''end'' will be inserted in this new line with the same indentation as ''if''.
|
||||
Then ''$indent$end'' means that <code>end</code> will be inserted in this new line with the same indentation as <code>if</code>.
|
||||
|
||||
#
|
||||
You want the lines of code :
|
||||
|
||||
''end'' <br/>
|
||||
2) You want the lines of code :
|
||||
|
||||
<code>
|
||||
end
|
||||
next_line_of_code
|
||||
</code>
|
||||
|
||||
to become:
|
||||
|
||||
''end'' <br/>
|
||||
<br/>
|
||||
<code>
|
||||
end
|
||||
|
||||
next_line_of_code
|
||||
</code>
|
||||
|
||||
as you press Return just after typing ''end''. You should define the "Customized auto complete (Return after keyword was typed)" string for ''end'' as :
|
||||
as you press Return just after typing <code>end</code>.
|
||||
|
||||
"%B%B%B%Bend%N$indent$%B$cursor$"
|
||||
To make this happen, you should define the "Customized auto complete (Return after keyword was typed)" string for <code>end</code> as :
|
||||
|
||||
The four ''%B'' will remove ''end'' plus one character before ''end'' (the tabulation character). <br/>
|
||||
''end'' will be inserted at this new position. <br/>
|
||||
<code lang="text">
|
||||
%B%B%B%Bend%N$indent$%B$cursor$
|
||||
</code>
|
||||
|
||||
The four ''%B'' will remove <code>end</code> plus one character before <code>end</code> (the tabulation character). <br/>
|
||||
<code>end</code> will be inserted at this new position. <br/>
|
||||
''%N'' indicates that you want to insert a new line. <br/>
|
||||
''$indent$%B$cursor$'' means that the cursor will be moved to the end of the line where one less blank space than before the original ''end'' will have been inserted.
|
||||
''$indent$%B$cursor$'' means that the cursor will be moved to the end of the line where one less blank space than before the original <code>end</code> will have been inserted.
|
||||
|
||||
|
||||
{{note|EiffelStudio editor can insert spaces instead of tabulation when you use special character ''%T''. This is set in [[General Editor Preferences|another section of the preferences]] . <br/>
|
||||
}}
|
||||
{{note|EiffelStudio editor can insert spaces instead of tabulation when you use special character ''%T''. This is set in [[General Editor Preferences|another section of the preferences]] .}}
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Keywords automatic completion preferences|Keywords automatic completion preferences]] <br/>
|
||||
|
||||
@@ -50,6 +50,7 @@ General Preferences
|
||||
| Should tab character be used for auto-indentation?
|
||||
|}
|
||||
|
||||
|
||||
Display Colors
|
||||
{| border="1"
|
||||
|-
|
||||
|
||||
@@ -23,6 +23,7 @@ This category gathers the preferences related to context tools.
|
||||
| Show all callers (as opposed to local callers) in `callers' form.
|
||||
|}
|
||||
|
||||
|
||||
Class views indices:
|
||||
{| border="1"
|
||||
|-
|
||||
|
||||
@@ -37,6 +37,7 @@ This category gathers the preferences related to the EiffelStudio BON Diagram to
|
||||
| Show suppliers of a class up to a level of preference value.
|
||||
|}
|
||||
|
||||
|
||||
==BON Preferences==
|
||||
|
||||
{| border="1"
|
||||
@@ -93,6 +94,7 @@ This category gathers the preferences related to the EiffelStudio BON Diagram to
|
||||
| Line width for BON inheritance links.
|
||||
|}
|
||||
|
||||
|
||||
==UML Preferences==
|
||||
|
||||
{| border="1"
|
||||
@@ -167,6 +169,7 @@ This category gathers the preferences related to the EiffelStudio BON Diagram to
|
||||
| Color for UML inheritance links.
|
||||
|}
|
||||
|
||||
|
||||
{{seealso|<br/>
|
||||
[[EiffelStudio Tools Preferences|Preferences for other tools]] }}
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
[[Property:title|Once routines and constants]]
|
||||
[[Property:weight|0]]
|
||||
[[Property:uuid|05007945-20fd-99d6-95cb-ec96845c131f]]
|
||||
The once view [[Image:class-features-once-icon]] displays all the [[Routines|routines]] declared as '''once''' and the constant [[Attributes|attributes]] in the current class (or in its [[Ancestors|ancestors.]] ). <br/>
|
||||
It is available through the '''Class''' tab of the [[EiffelStudio window overview|context tool]] .
|
||||
The once view [[Image:class-features-once-icon]] displays all the [[Routines|routines]] declared as '''once''' and the constant [[Attributes|attributes]] in the current class (or in its [[Ancestors|ancestors]]). <br/>
|
||||
It is available through the '''Class''' tab of the [[EiffelStudio window overview|context tool]].
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -14,12 +14,16 @@ For feature clause names it is recommended that you pick one from the standard o
|
||||
|
||||
==Generated code==
|
||||
The code that is inserted in your class as a result of the selections made for the feature clause, is of the form: <br/>
|
||||
<code>feature {EXPORT} -- Clause name</code><br/>
|
||||
except if you specified <eiffel>ANY</eiffel> as export status, which is similar to having no export status. <br/>
|
||||
<code>feature --Clause name</code>
|
||||
<code>
|
||||
feature {EXPORT} -- Clause name</code><br/>
|
||||
except if you specified <eiffel>ANY</eiffel> as export status, which has the same meaning as not specifying class names in the export status: <br/>
|
||||
<code>
|
||||
feature --Clause name</code>
|
||||
<br/>
|
||||
|
||||
For example, if you specified a the "Initialization" feature clause name, and specified <eiffel>NONE</eiffel> as export status, you get: <br/>
|
||||
<code>feature {NONE} -- Initialization</code>
|
||||
<code>
|
||||
feature {NONE} -- Initialization</code>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,7 +2,11 @@
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|c0708842-e5e0-5d5c-5746-0507d1709a3e]]
|
||||
There are two parts in the window. The upper part allows you to choose what type of feature you want to create, a procedure, a function or an attribute.
|
||||
[[Image:feature-wizard]]
|
||||
|
||||
|
||||
[[Image:feature-wizard]]
|
||||
|
||||
|
||||
The rest of the window is used to set the characteristics of the new feature. Information you will be asked depends on the type you chose. For more information, click on one of the links below:
|
||||
* [[New procedure layout|New procedure layout]]
|
||||
* [[New function layout|New function layout]]
|
||||
|
||||
@@ -16,19 +16,21 @@ When clicking '''Procedure''', the window changes to the procedure layout. It ha
|
||||
|
||||
This dialog box:<br/>
|
||||
<div> [[Image:feature-wizard-procedure-example]] </div><br/>
|
||||
|
||||
Produces this feature:<br/>
|
||||
<code>class
|
||||
<code>
|
||||
class
|
||||
PRODUCT
|
||||
|
||||
feature {PERSON} -- Element change
|
||||
|
||||
place_order (person: PERSON; quantity: INTEGER) is
|
||||
-- Mail `quantity' to `person'.
|
||||
require
|
||||
require
|
||||
person /= Void and quantity > 0
|
||||
do
|
||||
do
|
||||
person.mail_order (Current, quantity)
|
||||
ensure
|
||||
ensure
|
||||
person.has_ordered (Current)
|
||||
end
|
||||
|
||||
|
||||
@@ -1,14 +1,17 @@
|
||||
[[Property:title|Profiler wizard guided tour]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|e6166282-aa91-e4a9-9951-819f32d50b88]]
|
||||
# [[Select the Compilation mode|'''First step:''' Select which version of your system you ran using the profiler: Workbench or Finalized]] .
|
||||
# [[Reuse or Generate an Execution Profile| '''Second step (only appears when an ''' ''Execution Profile'' '''has already been generated for this system)''': Select an existing ''Execution Profile'' or choose to generate a new ''Execution Profile'' from a ''Run-time information record''. ]]
|
||||
# [[Select a Run-time information record to generate the Execution Profile| '''Third step (only appears when generating a new ''' ''Execution Profile''''')''': Generate a new ''Execution Profile'' from a ''Run-time information record''. ]]
|
||||
# [[Select the information you need and formulate your query|'''Final step''': Select the information you need and formulate your query.]]
|
||||
# [[Profile query window|Profile query window]]
|
||||
Using the Profiler Wizard consists of activities in four "states", each of which is represented by a wizard dialog box:
|
||||
|
||||
# [[Select the Compilation mode|Select which version of your system you ran using the profiler: ''Workbench'' or ''Finalized'']] .
|
||||
# [[Reuse or Generate an Execution Profile|Select an existing ''Execution Profile'' or choose to generate a new ''Execution Profile'' from a ''Run-time information record'' (This step only applies when an ''Execution Profile'' has already been generated for this system)]]
|
||||
# [[Select a Run-time information record to generate the Execution Profile|Generate a new ''Execution Profile'' from a ''Run-time information record'' (This step only applies when generating a new ''Execution Profile'')]]
|
||||
# [[Select the information you need and formulate your query|Select the information you need and formulate your query.]]
|
||||
|
||||
Results of your query are visible in the [[Profile query window|Profile query window]].
|
||||
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
|
||||
@@ -15,10 +15,9 @@ Click on the '''Save''' button to save the currently displayed results in a text
|
||||
|
||||
{{tip|To visualize the result in Microsoft Excel or any other spreadsheet, select the entire text (except the first three lines where the Execution Profile file is specified), copy it and then paste it into Excel. }}
|
||||
<br/>
|
||||
[[Image:profiler-query-window]] <br/>
|
||||
[[Image:profiler-query-window]] <br/>
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
|
||||
@@ -12,14 +12,13 @@ However, if you have not executed your system since the generation of the last '
|
||||
|
||||
{{tip|If you want to archive different ''Execution Profiles'' (to compare them for example), rename the ''profinfo.pfi'' file into a new name but keep the .pfi extension. The profiler wizard detects existing Execution Profiles by checking the file extensions. }}
|
||||
<br/>
|
||||
[[Image:profiler-wizard-second-state]] <br/>
|
||||
[[Image:profiler-wizard-second-state]] <br/>
|
||||
<br/>
|
||||
|
||||
Clicking '''Next''' will lead you to the [[Select a Run-time information record to generate the Execution Profile|Third state]] if you have selected '''Generate a profile from Run-time information record'''. On the other hand if you have selected '''Use existing profile''' you will go to the [[Select the information you need and formulate your query|Final state]] .
|
||||
<br/>
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
|
||||
@@ -5,14 +5,14 @@ The first screen of the wizard lets you specify the mode in which the profiled s
|
||||
|
||||
If you have run a finalized system under the control of the profiler then select '''Finalized mode''' and click '''Next'''. On the contrary if you have executed the system in Workbench mode then select '''Workbench mode''' and click '''Next'''.
|
||||
<br/>
|
||||
[[Image:profiler-wizard-first-state]] <br/>
|
||||
[[Image:profiler-wizard-first-state]] <br/>
|
||||
<br/>
|
||||
|
||||
Clicking '''Next''' will lead you to the [[Reuse or Generate an Execution Profile|Second state]] or to the [[Select a Run-time information record to generate the Execution Profile|Third state]] depending on whether an ''Execution Profile'' has already been generated for this compilation mode or not. If no ''Execution Profile'' has been generated so far (which happens the first time you execute this wizard for a specified project in a given compilation mode) you will go to the [[Select a Run-time information record to generate the Execution Profile|Third state]] , otherwise you will go to the [[Reuse or Generate an Execution Profile|Second state]] .
|
||||
<br/>
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard]] <br/> [[Profiling|How to profile a system]] }}
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Each sub-query must have the following syntax 'attribute operator value' where:
|
||||
|
||||
|
||||
<br/>
|
||||
[[Image:profiler-wizard-fourth-state]] <br/>
|
||||
[[Image:profiler-wizard-fourth-state]] <br/>
|
||||
<br/>
|
||||
|
||||
|
||||
@@ -51,7 +51,6 @@ Clicking '''Next''' will open the [[Profile query window|Profile query window]]
|
||||
<br/>
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
|
||||
@@ -5,20 +5,19 @@ The third screen of the wizard lets you generate an ''Execution Profile'' from a
|
||||
|
||||
Then, in the combo box labeled '''Profiler used to produce the above record''', select the profiler that has been used to produce the ''Run-time information record'' you have entered. If the profiler used to execute the system does not appear in the combo box, you have to add it. See [[How to set up a Profiler Configuration File|How to set up a Profiler Configuration File]] for more details on how to do so.
|
||||
|
||||
{{note|The Run-time information record'' has to be located in the ''EIFGENs/target_name/W_code'' directory of your project. }}
|
||||
{{note|The Run-time information record must be located in the ''EIFGENs/target_name/W_code'' directory of your project. }}
|
||||
|
||||
<br/>
|
||||
[[Image:profiler-wizard-third-state]] <br/>
|
||||
[[Image:profiler-wizard-third-state]] <br/>
|
||||
<br/>
|
||||
|
||||
|
||||
Clicking '''Next''' will lead you to the [[Select the information you need and formulate your query|Final state]] if the provided ''Run-time information record'' is valid. If the ''Run-time information record'' is not valid or is not located in the ''EIFGENs/target_name/W_code'' directory of the project, you will go to the '''Run-time Information Record Error state''' as shown below.
|
||||
<br/>
|
||||
[[Image:profiler-wizard-rtir-error-state]] <br/>
|
||||
[[Image:profiler-wizard-rtir-error-state]] <br/>
|
||||
<br/>
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard]] <br/>
|
||||
[[Profiling|How to profile a system]] <br/>
|
||||
[[How to set up a Profiler Configuration File|How to set up a Profiler Configuration File]] }}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user