mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated to upcoming 23.09

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2393 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eifops
2023-09-25 09:13:12 +00:00
parent 246745930d
commit e2bb303f94
2975 changed files with 63910 additions and 342 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
documentation/23.09/eiffelstudio/eiffelstudio-reference/outputs-tool/external-compilation-pane.wiki Normal file
View File

@@ -0,0 +1,54 @@
[[Property:title|External compilation pane]]
[[Property:weight|3]]
[[Property:uuid|26525412-e8e5-8b1c-1074-58e00aed4c76]]
[[Image:External compilation pane 01]]
==Introduction==
During the majority of ordinary development projects in Eiffel, it may be rare for programmers to need to know what's going on with the external compilation that occurs during freezing and finalization steps. However, during the development of some types of systems, particularly those that involve interfaces to non-Eiffel components, it is helpful to monitor the external compilation.
The external compilation pane shows a log of the compilation output from the external (typically C language) compiler. But the external compilation pane is more than just a log. It has powerful features that help you deal with the results of external compilation.
==Selecting your locale==
If the external compiler uses a different locale than your default locale, you can select your particular locale in the "Locale" box on the bottom bar of the Outputs tool.
==Opening a project folder==
You can explore a project folder by using '''open folder''' ( [[Image:general-open-icon|open]] ) on the bottom bar. When you click the triangle ( [[Image:toolbar-dropdown-icon]] ) to the right of the '''open folder''' icon, you will see a list of project folders, as shown in the figure below.
[[Image:Outputs tool Open folder|open]]
Selecting one of this will cause the folder to be opened by the explorer appropriate to your platform, such as Windows Explorer in the case of the Microsoft Windows platform.
==Starting a terminal session in a project folder==
The Outputs tool gives you a way to create a new terminal or console window targeted to one of your project folders. To do this, click the triangle ( [[Image:toolbar-dropdown-icon]] ) to the right of the '''terminal''' icon ( [[Image:terminal-icon|terminal]] ). You'll see a list of project folders like the one shown [[#Opening a project folder|above]]. Choose a folder and a terminal window will be created and targeted to the folder you selected.
==Opening a file mentioned in the external compilation output==
You can open a file mentioned in the external compiler output in a specified external editor by selecting the file name and then clicking the '''send to external editor''' ( [[Image:metrics-tool--command-send-to-external-editor-icon|send to external editor]] ) button, shown in the bottom bar of the following figure:
[[Image:External compilation pane file selection|Selecting a file to open]]
If, as is often the case with C compilation errors, a line number is adjacent to the file name, you can select the line number and the file will be opened in the external editor and the cursor positioned at that line number.
==View external code for a class/feature==
You can view the external code for a particular Eiffel class or feature in an external editor. Pick the class or feature whose generated code you want to see, and drop it onto the [[Image:metrics-tool--command-send-to-external-editor-icon|send to external editor]] button. The external code for the class or feature will be shown in an external editor.
The figure below shows an example of picking the feature <code>make</code> and dropping it on the '''send to external editor''' button.
[[Image:External compilation pane edit feature]]
You can also drop a class or feature pebble on the '''open folder''' or '''terminal''' icon. This will get you to the folder in which the generated code for the class or feature resides.
===View external code from the finalized folder===
By default the code that you see in an external editor is from the workbench (W_code) folder. You can see the corresponding external code from the finalized (F_code) folder by holding the <code>CTRL</code> key while you drop the class or feature pebble.

7
documentation/23.09/eiffelstudio/eiffelstudio-reference/outputs-tool/general-output-pane.wiki Normal file
View File

@@ -0,0 +1,7 @@
[[Property:title|General output pane]]
[[Property:weight|0]]
[[Property:uuid|549e254e-3653-db7a-8874-c71b05c9295a]]
The General output pane contains information about the current EiffelStudio project.
[[Image:Outputs tool General pane]]

61
documentation/23.09/eiffelstudio/eiffelstudio-reference/outputs-tool/index.wiki Normal file
View File

@@ -0,0 +1,61 @@
[[Property:title|Outputs tool]]
[[Property:weight|-3]]
[[Property:uuid|4f35254c-9a22-7773-21ed-aa740c3eddd5]]
==Overview==
[[Image:Outputs tool 01]]
Several EiffelStudio facilities log their progress to the various panes of the '''Outputs tool'''.
You can view the outputs from different facilities by selecting the name of a pane from the '''Output:''' drop-down list, as shown below.
[[Image:Outputs tool 02]]
The output panes you see listed depend somewhat upon how you've been using EiffelStudio. A few of the panes are always present, but other panes only show up in the list after you used the facilities or tools that log information to those panes. For example, if during a session you edit and compile a project but never run it, you would not see the Debugger output pane. Then after you had run the system, the Debugger output pane would join the list.
==Common functionality==
On the top bar, the Outputs tool provides some functionality that is always present, and available to all output panes.
#The '''save''' button ( [[Image:16x16--general-save-icon]] )will allow you to save the content of the currently displayed output pane to a file.
#The '''search''' button ( [[Image:tool-search-icon]] ) will provide you with a search bar at the bottom of the current pane.
#The '''clear''' button ( [[Image:general-reset-icon]] ) clears the content of the output pane that is currently being displayed.
==Transient functionality==
As you work with EiffelStudio you will notice that some icons appear on the Outputs tool's top bar only occasionally. Generally, the Outputs tool will automatically change to the appropriate pane depending upon what's going on in EiffelStudio. For example, when you compile the Eiffel Compilation output pane appears, and when you run a system, the Debugger output pane appears.
You can adjust how panes change to some extent as you will see in the [[#Relevant EiffelStudio preferences|section on preferences]].
But sometimes things happen that change more than one output pane during an action. When this occurs, one or more transient buttons will be added to the Outputs tool's top bar to the right of the search button. This lets you know that there have been modifications to a pane other than the one that is currently displayed. If you click on one of these buttons, you will be taken to that pane, and the button will be dismissed.
The figure below shows the Outputs tool during an external compilation. Notice the transient button that has become visible indicating that new changes have been made in the Eiffel Compilation pane.
[[Image:Outputs tool transient functionality]]
==Relevant EiffelStudio preferences==
There are two EiffelStudio preferences that can control some of the behavior of the Outputs tool. Both can be found in the preferences path ''Interface -> Development window''.
===Outputs tool prompted===
The preference '''Outputs tool prompted''' controls whether the Outputs tool is made visible automatically whenever a compilation is launched. The value is '''True''' by default. So, in the default case, the Ouputs tool will be visible whenever you compile. If you have closed the tool, and recompile, the tool will reappear.
If you choose a value of '''False''', then the Outputs tool will remain visible if it is already visible. But if you close it, a recompile will not cause it to reappear.
===External compilation output prompted===
The preference '''External compilation output prompted ''' (''C output panel prompted'', in earlier versions) controls whether the [[External compilation pane|External compilation pane]] appears whenever an external compilation (usually a C compilation) occurs.
The default value is '''False'''. In this case, the External compilation pane does not appear automatically when an external compilation occurs, except when both of the following conditions are ture:
# The Outputs tool is already displayed, and
# The Eiffel Compilation pane is active.
So, regardless of the preference value, when an external compilation is performed, and the Eiffel Compilation output pane is already active in the Outputs tool, the External Compilation pane will become the active pane. When the external compilation completes, under most circumstances the Eiffel Compilation pane will become active again. However, the Eiffel Compilation pane will not become active if there were external compilation errors, or if you activated some other output pane during the external compilation.