diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/customizing-eiffelstudio/choosing-classes-be-ignored-bon-diagrams.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/customizing-eiffelstudio/choosing-classes-be-ignored-bon-diagrams.wiki index cbe1aa4e..67cfa531 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/customizing-eiffelstudio/choosing-classes-be-ignored-bon-diagrams.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/customizing-eiffelstudio/choosing-classes-be-ignored-bon-diagrams.wiki @@ -1,8 +1,8 @@ [[Property:title|Choosing classes to be ignored in BON diagrams]] [[Property:weight|5]] [[Property:uuid|18dcc14f-2ad0-3f3b-4b2e-fc9251035b6f]] -Every class in your system inherits from ANY. INTEGER, like other classes that represent basic types, is very often a supplier of the classes the user wrote. It may therefore not be interesting to display classes such as ANY or INTEGER in [[Diagram tool: Introduction|BON diagrams]] . -EiffelStudio allows you to customize a list of classes that it has to ignore when it creates diagrams. This list is stored in the [[EiffelStudio preferences]] . To modify it, first open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category of the "Tools" category in the preferences tree. On the right, you will then see a table of preferences, which includes "Show ALL classes in the diagram" and "Names of classes that should not appear in generated diagrams". If "Show ALL classes in the diagram" is not False, click on it and set it to False. Then click on "Names of classes that should not appear in generated diagrams" and edit the list. Class names must be separated by semicolons. +Every class in your system inherits from ANY. INTEGER, like other classes that represent basic types, is very often a supplier of the classes the user wrote. It may therefore not be interesting to display classes such as ANY or INTEGER in [[Diagram tool|BON diagrams]]. +EiffelStudio allows you to customize a list of classes that it has to ignore when it creates diagrams. This list is stored in the [[EiffelStudio preferences]] . To modify it, first open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category of the "Tools" category in the preferences tree. On the right, you will then see a table of preferences, which includes "Show ALL classes in the diagram" and "Names of classes that should not appear in generated diagrams". If "Show ALL classes in the diagram" is not False, click on it and set it to False. Then click on "Names of classes that should not appear in generated diagrams" and edit the list. Class names must be separated by semicolons. After modifying the list, click on '''save and exit''' to complete the change. diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-class.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-class.wiki index a4516784..7a4924cf 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-class.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-class.wiki @@ -19,7 +19,7 @@ To make the window appear, you can: * Click [[Image:16x16--new-class-icon]] in the [[Main toolbars|standard toolbar]] . * Select '''New class''' in the '''Tools''' menu. * Type the name of the new class in the class field of the [[Main address bar|main address bar]] or the [[Context tool address bar|context tool address bar]] . The current cluster will then be preselected. -* Use the [[Diagram tool: Introduction|diagram tool]] : Pick the icon [[Image:16x16--new-class-icon]] and drop it on the diagram in the right cluster. This will make the dialog window appear with the chosen cluster selected. +* Use the [[Diagram tool]] : Pick the icon [[Image:16x16--new-class-icon]] and drop it on the diagram in the right cluster. This will make the dialog window appear with the chosen cluster selected. {{seealso|
diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/opening-new-feature-dialog.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/opening-new-feature-dialog.wiki index 6c289d88..acd41a07 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/opening-new-feature-dialog.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/adding-feature/opening-new-feature-dialog.wiki @@ -4,7 +4,7 @@ To make the [[New feature dialog overview|new feature window]] appear, you can: * Click [[Image:16x16--new-feature-icon]] in the [[Main toolbars|standard toolbar]] . * Select '''New feature''' in the '''Tools''' menu. -* Use the [[Diagram tool: Introduction|diagram tool]] : First, select '''create new client-supplier links''' by clicking on [[Image:new-supplier-link-icon]] .Then, pick the class to which you want to add the new feature. Lastly, drop the pebble on the class that corresponds to the type returned by the new feature.
+* Use the [[Diagram tool]]: First, select '''create new client-supplier links''' by clicking on [[Image:new-supplier-link-icon]] .Then, pick the class to which you want to add the new feature. Lastly, drop the pebble on the class that corresponds to the type returned by the new feature.
This last method does not allow you to create procedures. The first thing to do when the dialog is displayed is to choose the kind of feature you want to create. The rest of the process depends on what you selected : [[Adding a procedure|procedure]] , [[Adding a function|function]] or [[Adding an attribute|attribute]] . diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/moving-class.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/moving-class.wiki index b81a6766..87a660e2 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/moving-class.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/moving-class.wiki @@ -1,7 +1,7 @@ [[Property:title|Moving a class]] [[Property:weight|7]] [[Property:uuid|10947266-61c8-ddd5-445e-9eb0de61cd05]] -To move a class from a cluster to another one, you have to use the [[Diagram tool: Introduction|Diagram tool]] . First, [[Centering tools on a component|center the tool]] on the cluster that contains the class you want to move. Then, if the destination cluster is not shown on the diagram, [[Pick-and-drop mechanism|pick]] it in the [[Cluster tool|cluster tool]] and drop it in the [[Diagram tool: Introduction|diagram]] . Once both clusters are displayed, you just have to drag the class to its destination. +To move a class from a cluster to another one, you have to use the [[Diagram tool]]. First, [[Centering tools on a component|center the tool]] on the cluster that contains the class you want to move. Then, if the destination cluster is not shown on the diagram, [[Pick-and-drop mechanism|pick]] it in the [[Cluster tool|cluster tool]] and drop it in the [[Diagram tool|diagram]]. Once both clusters are displayed, you just have to drag the class to its destination. {{seealso|
[[Looking for a class|Find where a class is]]
[[Looking for a cluster|Find where a cluster is]] }} diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-class.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-class.wiki index 086bc410..f394956a 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-class.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-class.wiki @@ -2,8 +2,8 @@ [[Property:weight|5]] [[Property:uuid|f975b6e2-7f81-874b-82f2-e76db588ff5e]] To remove a class, you can: -* [[Centering tools on a component|Center the editor on the component]] , and click [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or select '''Remove current item''' in the '''Tools''' menu. -* [[Pick-and-drop mechanism|Drop a pebble]] of this component on [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or in the [[Diagram tool: Introduction|Diagram tool]] [[Diagram toolbar|toolbar]] . +* [[Centering tools on a component|Center the editor on the component]], and click [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or select '''Remove current item''' in the '''Tools''' menu. +* [[Pick-and-drop mechanism|Drop a pebble]] of this component on [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or in the [[Diagram tool]] [[Diagram toolbar|toolbar]]. {{warning|Removing a class from the system implies the deletion of the corresponding file on disk. }} diff --git a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-cluster.wiki b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-cluster.wiki index dd715eb1..3ab27aae 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-cluster.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-how-tos/editing-project/removing-cluster.wiki @@ -2,8 +2,8 @@ [[Property:weight|4]] [[Property:uuid|aebcf24c-758b-7c03-4130-533cf34650f5]] To remove clusters, you can: -* [[Centering tools on a component|Center the editor on the component]] , and click [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or select '''Remove current item''' in the '''Tools''' menu. -* [[Pick-and-drop mechanism|Drop a pebble]] of this component on [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or in the [[Diagram tool: Introduction|Diagram tool]] [[Diagram toolbar|toolbar]] . +* [[Centering tools on a component|Center the editor on the component]], and click [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or select '''Remove current item''' in the '''Tools''' menu. +* [[Pick-and-drop mechanism|Drop a pebble]] of this component on [[Image:16x16--general-delete-icon]] in the [[Main toolbars|standard toolbar]] or in the [[Diagram tool]] [[Diagram toolbar|toolbar]]. * Use the cluster tab in the project configuration window. {{seealso|
diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-preferences.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-preferences.wiki index f40be5d9..c8a57145 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-preferences.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-preferences.wiki @@ -1,11 +1,19 @@ [[Property:title|Debugging preferences]] [[Property:weight|-4]] [[Property:uuid|05e820ff-917f-e41f-d921-990283ac886f]] -Two main preferences are available for the debugger, in order to speed up the objects display : -* Enable/disable the debug_output display (see [[Debug output|debug output]] ) -* Enable/disable the full generic type display (for instance see ARRAY [INTEGER] instead of only ARRAY -* To avoid infinite evalution processing, the debugger abort evaluation after "max evaluation duration" timeout. So you can change this value to fit your needs. - [[Image:debugging-tools-preferences]] +Debugger preferences are available as part of the [[EiffelStudio Preferences]]. + +The debugger section of the EiffelStudio preferences looks like this: +[[Image:debugging-tools-preferences]] + + +The EiffelStudio preference documentation contains a guide to the [[Debugger Preferences]]. + +Some preferences have an effect upon the speed at which the debugger can display objects: +* Enable/disable the debug_output display (see [[Debug output|debug output]]) +* Enable/disable the full generic type display (for example, ARRAY [INTEGER] is displayed, instead of only ARRAY) +* To avoid infinite evaluation processing, the debugger aborts evaluation after "max evaluation duration" timeout. + diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-tips-objects-grid-view.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-tips-objects-grid-view.wiki index 2a3c7619..a5538f3e 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-tips-objects-grid-view.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/debugging-tips-objects-grid-view.wiki @@ -2,13 +2,13 @@ [[Property:weight|-5]] [[Property:uuid|56b3c189-8fda-d78e-7e7c-c4cf4f786ff6]] General behavior -* Double clicking on the grid's header separator will resize the corresponding column. If you hold the [SHIFT] key at the same time, it will resize according to the displayed cells. +* Double clicking on the grid's header separator will resize the corresponding column. If you hold the SHIFT key at the same time, it will resize according to the displayed cells. * Right clicking on the header's cell will popup a menu that enable or disable the auto resizing on the selected column. This can be useful to resize automatically the "name" column when inspecting an object value. -* Pressing [CONTROL] + [E] when the selected line represents a value with potential text representation (STRING, DEBUG_OUPUT ...) will open the [[Object Viewer (also known as Expanded display)|expanded view dialog]] +* Pressing CTRL+E when the selected line represents a value with potential text representation (STRING, DEBUG_OUPUT ...) will open the [[Object Viewer (also known as Expanded display)|expanded view dialog]]. -Watch tools (alias evaluation tool) -* Dropping an object value on a [[Evaluation tool or Watch tool|watch tool ]] will open the [[New expression dialog|expression definition dialog]] with the object's address filled. This way you can evalute expression directly on this object. If you press [Ctrl] during the dropping, the dropped object will be added as expression in the watch tool as itself. -* You can also drop the object on the notebook tab of the wanted watch tool. +Evaluation tool (also known as Watch tool) +* Dropping an object value on a [[Evaluation tool or Watch tool|Evaluation tool ]] will open the [[New expression dialog|expression definition dialog]] with the object's address filled. This way you can evaluate expression directly on this object. If you hold the CTRL key while dropping, the dropped object will be added as expression in the Evaluation tool as itself. +* You can also drop the object on the notebook tab of the desired Evaluation tool. diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/exceptions-handling-tool.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/exceptions-handling-tool.wiki index f8628de4..f7f0278a 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/exceptions-handling-tool.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/exceptions-handling-tool.wiki @@ -1,24 +1,43 @@ [[Property:title|Exceptions handling tool]] [[Property:weight|-7]] [[Property:uuid|9a62611f-46ba-7d74-ba1c-989f6709074b]] -This tool is used to precise whether the debugger stops or continues on specific exceptions.
-To show this tool, go to menu : '''Debug > Exception handling''' .
-Note: now that exception are object in Eiffel too, the mechanism is unified for classic and dotnet system using the Eiffel exception class names. +This Exceptions handling tool is used to specify whether the debugger stops or continues on specific exceptions. -==Exception handling dialog== +To access this tool, follow the menu path: -If the "filter exceptions" is enabled, for each exception you can leave the exception action as '''Disabled''' (default behavior: catch), '''Catch''' (stop on such exception), '''Ignore''' (do not stop on such exception). By double clicking on the exception name you toggle Ignore/Catch. -In the following picture, we stop on every exception except the "External Exception". + +Execution --> Exception handling + + +{{note|Now that exceptions are objects in Eiffel, the mechanism is unified for classic and .NET systems, using the Eiffel exception class names. }} + + +==Tailoring exception handling behavior== + +The image below shows the Exceptions handling tool. + [[Image:exceptions-handling-tool|Exception handling tool]] -{{tip|Using the "Pattern" field, you can add you own filter using regular expression.}} + +In the top two checkboxes, the tool provides a way to enable and disable "Catcall" warnings on the console or in the debugger. + +If the "filter exceptions" checkbox is enabled, for each exception you can specify the exception action as one of: +* '''Disabled''' means that filtering for this exception is not enabled. Therefore, the default behavior of '''Catch''' applies. +* '''Catch''' means stop on such an exception. +* '''Ignore''' means do not stop on such an exception. +You can double clicking an exception name to toggle its status between '''Ignore''' and '''Catch'''. + +Clicking the button labeled ''Ignore External Exception?'' will set the status of a set of external exceptions to '''Ignore'''. + +Click the button labeled ''Apply'' to apply your selections, or ''Reset'' to reset the tool to its default values. + + +{{tip|Using the "Pattern" field, you can add your own filters using regular expression.}} + -==Cat call detection during the execution== - -This dialog also provides a way to disable/enable the cat call warning on the console or in the debugger with the first two checkbox fields. diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/record-execution.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/record-execution.wiki index 6f94e0ec..58c101ac 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/record-execution.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/record-execution.wiki @@ -23,14 +23,19 @@ For performance reason, the recording mechanism has a few parameters. For now th {{warning|Since there is no way to restore local values when the execution left the related call stack frame, the recording discards the recorded local values.}} -The recording functionality is graphically available on the Call stack tool, or though the "Execution" menu (formerly the "Debug" menu). +The recording functionality is graphically available on the Call stack tool, or though the "Execution" menu (formerly the "Debug" menu). -After you start debugging, if at some point you decide to start recording, click on the "record" button: +After you start debugging, if at some point you decide to start recording, click on the "record" button in the Call stack tool: [[Image:exec-replay-00]] +or follow the menu path: + +Execution --> Activate Execution Recording + + {{note|If you want to record from the beginning, just enable the recording before starting the debug session (the recording button is a toggle button)}} diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/replay-recorded-execution.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/replay-recorded-execution.wiki index d8a1ad17..a369f4fa 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/replay-recorded-execution.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/execution-record-and-replay/replay-recorded-execution.wiki @@ -4,7 +4,7 @@ The replay functionality is available from a button on the Call stack tool, or though EiffelStudio's "Execution" menu. -{{note|First, you must be sure execution recording is activated ([[Record execution|read how to record execution]] ).}} +{{note|First, you must be sure execution recording is activated ([[Record execution|read how to record execution]]).}} Now, whenever the application is stopped in the debugger, you can replay the recorded execution by clicking on the "Replay" button: diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/stack-overflow-prevention.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/stack-overflow-prevention.wiki index 9e1579d6..e45d443e 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/stack-overflow-prevention.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/stack-overflow-prevention.wiki @@ -1,14 +1,24 @@ [[Property:title|Stack overflow prevention]] [[Property:weight|-6]] [[Property:uuid|bd988599-a444-6090-c3c4-a5c7de20b294]] -Accessible via the '''Debug/Overflow prevention...''' menu, this command makes it possible to detect stack overflows before they occur. Selecting it pops up a dialog that lets you decide at which call stack depth a warning should be issued. +Stack overflow prevention makes it possible to have the debugger detect stack overflow situations and warn you before they occur. + +You can control this option through a dialog accessible via the menu path: + + +Execution --> Overflow prevention... + + +The dialog lets you decide at which call stack depth a warning should be issued. + [[Image:stack-overflow-dlg]] -By default a warning is issued when the debugged program reaches a stack depth of 1,000 elements. + +By default, a warning is issued when the debugged program reaches a stack depth of 1,000 elements. + {{note|Once an application has stopped at the selected level, it will not stop again until its stack depth goes below the critical stack depth again. }} - diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/threads-tool.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/threads-tool.wiki index 8829d301..fea7cb49 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/threads-tool.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/debugger/threads-tool.wiki @@ -4,7 +4,7 @@ This tool displays the list of current Eiffel threads.
To show this tool, use the menu path: -Debug --> Tools --> Threads +Execution --> Tools --> Threads [[Image:threads-tool|Threads tool]] diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/diagram-tool/index.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/diagram-tool/index.wiki index 0b645424..e72d1ebe 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/diagram-tool/index.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/diagram-tool/index.wiki @@ -1,13 +1,12 @@ [[Property:title|Diagram tool]] [[Property:weight|-6]] [[Property:uuid|a3ca34e5-10e9-fac3-4795-9222074273a6]] -* [[Diagram tool: Introduction|Introduction]] -* [[Notation|Notation]] -* [[Diagram toolbar|Diagram toolbar]] -* [[Views|Views]] -* [[Contexts|Contexts]] -* [[Diagram tool: Code generation|Code generation]] - +The Diagram Tool of EiffelStudio is your graphical interface to system structures. You can use it both to ''examine'' systems already built or under development, and to ''build'' these systems graphically. EiffelStudio supports complete seamlessness and reversibility between the Diagram Tool's graphical view and the text view of other EiffelStudio tools: whenever you make a change or addition with the graphical tool, EiffelStudio will update the text; and when you change the text, EiffelStudio will update the Diagram Tool's representation on the next compilation. + +Use the diagram tool to design new Eiffel systems, or create [http://bon-method.com BON] (Business Object Notation) diagrams of existing ones. BON is a simple, clear, self-explanatory notation that you will learn in a few minutes just by looking at some examples. The Diagram Tool provides you with lots of features to manage different views of an Eiffel system, or parts of it. + + +
[[Image:devel-diagram]]
diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-general-interface-description/eiffelstudio-window-overview.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-general-interface-description/eiffelstudio-window-overview.wiki index 73a11a10..843c51f6 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-general-interface-description/eiffelstudio-window-overview.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/eiffelstudio-general-interface-description/eiffelstudio-window-overview.wiki @@ -66,7 +66,7 @@ By default, the context tool is unlinked from the rest of the window, which mean [[Main toolbars|Toolbar customization]]
[[EiffelStudio Editor]]
[[Formatted information about compiled classes and features]]
-[[Diagram tool: Introduction|Diagram reference]]
+[[Diagram tool]]
[[Metrics tool|Metric tool]] }} diff --git a/documentation/current/eiffelstudio/eiffelstudio-reference/error-list-tool.wiki b/documentation/current/eiffelstudio/eiffelstudio-reference/error-list-tool.wiki index 2daa0a53..7d66631b 100644 --- a/documentation/current/eiffelstudio/eiffelstudio-reference/error-list-tool.wiki +++ b/documentation/current/eiffelstudio/eiffelstudio-reference/error-list-tool.wiki @@ -1,51 +1,65 @@ [[Property:title|Error List Tool]] [[Property:weight|-7]] [[Property:uuid|62f36efa-1d3a-9e48-3a6a-7da40b7e2046]] -The Error List Tool is a general purpose tool for logging error and warning conditions raised when compiling or using other parts of the EiffelStudio IDE. The tool can optional filter both errors and warnings to aid in the process of fixing them. +The Error List Tool is a general purpose tool for logging error and warning conditions raised when compiling or using other parts of the EiffelStudio interactive development environment. Optionally, the tool can aid in the process of fixing problems by filtering both errors and warnings. + ==Accessing the Tool== -The contract editor tool can be accessed from the EiffelStudio tools menu '''View''' > '''Tools''' > '''Error List'''. The tool can also be accessed from the default shortcut key CTRL+ALT+E. Respecting this, the tool will be shown automatically at the end of a compilation if an error occurs during any part of the compilation. +The Error List Tool will be shown automatically at the end of a compilation if an error occurs during any part of the compilation, + +or it can be accessed via the EiffelStudio menu path: + +View --> Tools --> Error List + +or from the default shortcut key CTRL+ALT+E. + ==Reading Errors and Warnings== -There are numerous ways to gather information on the errors and warnings logged to the tool. Even when the tool is not shown directly, because it is displayed tabbed behind another tool or docked as a hidden slide-in tool on one of the IDE's bounding window edges, there's enough visible information to indicate how may errors and warnings were generated during the last compilation or in another processing task. +There are numerous ways to gather information on the errors and warnings logged to the tool. Even when the tool is not shown directly, because it is displayed tabbed behind another tool or docked as a hidden slide-in tool on one of the EiffelStudio's bounding window edges, there's enough visible information to indicate how many errors and warnings were generated during the last compilation or in another processing task. -By default the tool's title (in the tab-docked tab or on the tool's title bar when visible) will read'' 'Error List'''. In it's default state there are no errors or warning and the title reads as such. When performing a compilation resulting in the logging of any number of errors or warnings the tool title will be update to indicate the respective number of errors and warning as '''Error List (#Errors, #Warning)''' where ''#Errors'' indicates the number of logged errors and ''#Warnings'' indicates the number of logged warnings. When there are no errors or warnings the tool's title will be reset to the default title '''Error List'''. +By default, the tool's title (in the tab-docked tab or on the tool's title bar when visible) will read'' 'Error List'''. In its default state there are no errors or warnings. When performing a compilation resulting in the logging of any number of errors or warnings the tool title will be update to indicate the respective number of errors and warning as '''Error List (#Errors, #Warning)''' where '''#Errors''' indicates the number of logged errors and '''#Warnings''' indicates the number of logged warnings. When there are no errors or warnings the tool's title will be reset to the default title '''Error List'''. When the tool is visible, not only does the tab (if docked) and the title bar reflect the number of logged errors and warnings but the tool bar '''Errors''' and '''Warnings''' filter toggle buttons also reflect the number of respective logged errors and warnings. For more information on filtering error and warnings, see [[#filtering_errors_and_warnings|Filtering Errors and Warnings]] . ===Reading Logged Error and Warning Reports=== -When performing a task that produces errors and/or warning the tool will display a number of rows containing information on the logged errors and warnings. Error rows are indicated with the error icon ( [[Image:error]] ) and warnings with the exclamation icon ( [[Image:warning]] ). Both error and warnings show a single-line terse description of the offending issue and can be expanded using the adjacent (+) to reveal a verbose description and an indication on how to possibility fix the problem. You can also press RIGHT or + (PLUS) to expand a selected row. To collapse a row either click the (-), press LEFT or - (MINUS). +When performing a task that produces errors and/or warning the tool will display a number of rows containing information on the logged errors and warnings. Error rows are indicated with the error icon ( [[Image:error]] ) and warnings with the exclamation icon ( [[Image:warning]] ). Both errors and warnings show a single-line, terse description of the offending issue. Error and warning entries can be expanded by clicking the adjacent (+) to reveal a verbose description and an indication on how possibly to fix the problem. You can also press RIGHT (right arrow) or + (plus) to expand a selected row. To collapse a row either click the (-), or press LEFT or - . Error can be automatically expanded to reveal the more verbose information immediately. Toggling the Expand Errors ( [[Image:expand-errors]] ) button will automatically expand or collapse when toggled on or off respectively. ===Error and Warning Help=== -If you are unsure what the actually error or warning code refers to then you can receive help by selecting the error and pressing the Error Info tool bar button ( [[Image:error-info]] ). Alternately [[Pick-and-drop mechanism|pick and drop]] may be used to pick the error code from the error or warning onto the Error Info button. +If you are unsure exactly what the error or warning code means, then you can receive help by selecting the error and pressing the Error Info tool bar button ( [[Image:error-info]] ). Alternately [[Pick-and-drop mechanism|pick and drop]] may be used to pick the error code from the error or warning onto the Error Info button. ==Filtering Errors and Warnings== -There is no limit set on the number of errors or warnings shown in the tool because all the errors and warnings mean something and should be addressed. However it is desirable to filter both errors and warnings whilst working through fixing the cause of them, or to temporarily set the level of warnings without modifying the project configuration. +There is no limit on the number of errors or warnings that can be shown in the tool. All the errors and warnings mean something and should be addressed. However, sometimes it is desirable to filter errors and warnings while you work through the process of fixing the causes of them. Also sometimes it is advantageous to set temporarily the level of warnings you receive without modifying the project configuration. -There are two types of filtration, basic and fine-grained. Both the logged errors and warnings can be filtered using the basic filtering, which takes an all or nothing approach. However, filtering of logged errors is provided only as a convenience and as such finer-grained control over filtering is prohibited, only warnings can be filtered in this way. +There are two types of filtration, basic and fine-grained. Basic filtering can be applied to both warnings and errors. Fine-grained filtering applies only to warnings. Basic filtering of the errors and warnings can be achieved by toggling with tool bar '''Errors''' and/or '''Warnings''' button. Both are toggled on by default so all errors and warnings are displayed. Toggling either off will hide the error or warnings respectively. -For warnings, it might be desirable to temporarily filter out specific warnings without modifying the project's configuration file. This can be achieved using the Filter ( [[Image:filter]] ) tool bar button and unchecking those warnings undesired to be shown in the tool. When warnings are being filtered the Filter button is displayed with exclamation icon overlay ( [[Image:filter-active]] ) to indicate that some warnings may not appear in the tool because they are filtered out. The explicitly unchecked warnings configuration, of the tool, is only kept whilst the project is open. Anything more permanent should be done by way of [[EiffelStudio: Project settings window|configuring]] the project. +For warnings, it might be desirable to filter out specific warnings temporarily without modifying the project's configuration file. You can do this by using the Filter ( [[Image:filter]] ) tool bar button. Uncheck any warnings that you do not want to be shown in the tool. When warnings are being filtered, the Filter button is displayed with exclamation icon overlay ( [[Image:filter-active]] ) to indicate that some warnings may not appear in the tool because they are being filtered out. The fine-grained filter state is only effective during the current EiffelStudio project session. Anything more permanent should be done by changing the [[EiffelStudio: Project settings window|project settings]]. -When performing any type of filtering the error and warning count information is unaffected, to indicate there are more than errors and warnings then there is seen in the tool. +When performing any type of filtering, the error and warning count information is unaffected. This indicates that there can be more errors and warnings than are actually visible in the tool. ==Navigating Errors and Warnings== There are multiple ways to navigate the logged errors and warnings in the Error List Tool and for some, it doesn't even require the tool to be in view or even opened at all. -All navigation functions off of the currently selected logged error or warning. When the Error List tool is open and in view the most direct way to navigate between the errors and warnings is through the tool itself. There are four tool bar button designed for this purpose; Go to Next Error ( [[Image:next-error]] ), Go to Previous Error ( [[Image:previous-error]] ), Go to Next Warning ( [[Image:next-warning]] ) and Go to Previous Warning ( [[Image:previous-warning]] ). These tool bar buttons are mirrored in the '''Project''' main menu. Those actions mirror in the '''Project''' menu do not require the tool to be opened or be in view, proving a shortcut to their actual function. +All navigation functions off of the currently selected logged error or warning. When the Error List tool is open and in view the most direct way to navigate between the errors and warnings is through the tool itself. There are four tool bar buttons designed for this purpose: +* Go to Next Error ( [[Image:next-error]] ) +* Go to Previous Error ( [[Image:previous-error]] ) +* Go to Next Warning ( [[Image:next-warning]] ) +* Go to Previous Warning ( [[Image:previous-warning]] ) -There are also a matching number of keyboard shortcuts that can be used with or without the Error List tool being in view; To go to the next error use CTRL+F8, To go to the previous error use CTRL+SHIFT+F8, to go to the next warning use CTRL+ALT+F8 and to go to the previous warning use CTRL+ALT+SHIFT+F8. +These tool bar buttons are mirrored in the '''Project''' main menu. Those actions mirrored in the '''Project''' menu do not require the tool to be opened or be in view, providing a shortcut to their actual function. -In the event of no visible errors or warnings, the respective Next/Previous buttons and menu items will be unavailable. This is also effective when [[#filtering_errors_and_warnings|filtering errors and warnings]] , as the unseen logged error and warnings are treated as if they had never been logged ensuring that, when navigating, the irrelevant errors and warnings are not navigated to. +There are also a matching number of keyboard shortcuts that can be used with or without the Error List tool being in view; To go to the next error use CTRL+F8, To go to the previous error use CTRL+SHIFT+F8, to go to the next warning use CTRL+ALT+F8 and to go to the previous warning use CTRL+ALT+SHIFT+F8. + +In the event of no visible errors or warnings, the respective Next/Previous buttons and menu items will be unavailable. This is also effective when [[#filtering_errors_and_warnings|filtering errors and warnings]], as the unseen logged error and warnings are treated as if they had never been logged ensuring that, when navigating, the irrelevant errors and warnings are bypassed. When navigating between a logged error or warning the context where the error/warning occurred is shown. At anytime, double-left clicking on an error or warning will show the corresponding context to that logged error/warning. Pressing ENTER on the selected error or warning will also show the correspond context. @@ -53,7 +67,7 @@ The [[Pick-and-drop mechanism|pick and drop]] mechanism may also be used to nav ==Copying Errors and Warnings== -From time to time is may be necessary to copy the information in one or more logger errors and/or warnings. To perform a copy of the information select one or more logged errors and/or warning in the tool and press CTRL+C. The selected error and warning information will then be placed into the resident operating systems clipboard. +From time to time it may be helpful to copy the information in one or more logger errors and/or warnings. To perform a copy of the information, select one or more logged errors and/or warning in the tool and press CTRL+C. The selected error and warning information will then be placed into the clipboard of the resident operating system.