mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-07 23:32:42 +01:00
Updated to upcoming 23.09
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2393 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eifops
@@ -0,0 +1,12 @@
|
||||
[[Property:title|Change data share mode]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|52206181-e002-0914-d98d-c817d32ec02e]]
|
||||
Located in the '''View''' menu, named either '''Link context tool''' or '''Unlink context tool''', this command allows you to switch between the two possible [[Address bars|addressing modes]]. Toggling of Linked/Unlinked mode also can be accomplished through a button on the main toolbar ([[Image:context-link-icon]]). By default, this button is not visible, but can be added to the toolbar through [[Toolbar customization|toolbar customization]].
|
||||
|
||||
{{note|This command only applies to the development window where it is invoked, and this setting is not automatically saved when exiting EiffelStudio. }}
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Development Window Preferences|Change the default data sharing]]}}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
[[Property:title|Context tool address bar]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|1d68fcd1-8839-0b1e-a546-7ab51b3c0e74]]
|
||||
The address bar of the context tool has a different look from the [[Main address bar|main address bar]] , but provides the same functionality.
|
||||
|
||||
[[Image:context-address-bar]]
|
||||
|
||||
It also contains history arrows, and by clicking on the cluster, class or feature name, a window is popped up that contains fields similar to the ones of the [[Main address bar|main address bar]] , except that a cluster can also be entered, since the diagram tool and the metrics also work with clusters:
|
||||
|
||||
[[Image:context-address-window]]
|
||||
|
||||
{{tip|Labels in this address bar are pickable, to send the address to other tools easily. }}
|
||||
|
||||
|
||||
{{note|The context tool only has an address bar if it is unlinked from the editor. }}
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Change data share mode|Unlinking the context tool]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
[[Property:title|Address bars]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|e145c4d3-afd3-653d-cf7c-14fd80f4d566]]
|
||||
All development windows are composed of two major components, each of which can be centered on a given "address" (either a cluster, a class or a feature). One is the editor, with which go all the peripheral tools (including the [[Groups tool|groups tool]] and the [[Features tool|features tool]] ). The other is the context tool, which contains for example the [[Formatted information about compiled classes and features|class and feature tabs]] , the [[Diagram tool|diagram tool]] and the [[Metrics tool|metric tool]] .
|
||||
|
||||
It is possible to either link both components so that they share the same address (allowing to immediately have extended information on the class that is being edited), or to unlink them (allowing to have extended information on any class while editing a class).
|
||||
|
||||
When both are linked, only the [[Main address bar|main address bar]] appears, whereas when they are unlinked, the [[Context tool address bar|context tool address bar]] is also displayed, since it might point to a different location than the main address bar.
|
||||
|
||||
The [[Change data share mode|toggle data mode command]] allows you to switch between both modes.
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Development Window Preferences|Change the default data sharing]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
[[Property:title|Main address bar]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|491b7b6d-4d7c-287f-8442-2b35d000a54b]]
|
||||
The main address bar is located in the top part of windows, between the two [[Main toolbars|main toolbars]] (when they are displayed).
|
||||
|
||||
[[Image:main-address-bar]]
|
||||
|
||||
It has several components:
|
||||
* '''History back and forth arrows''' [[Image:view-previous-icon]] and [[Image:view-next-icon]]
|
||||
** These functions are also accessible from the menu path <code lang=text>View -> Go to</code>
|
||||
|
||||
* '''Current class and feature name fields'''
|
||||
** These fields display the names of the class and/or feature currently active in the editor pane.
|
||||
** It is possible to type a class or feature name to center the editor on it.
|
||||
** Typing a class name that does not exist in the set of known classes pops up a dialog to create a class of that name.
|
||||
** The "wildcard" characters '''*''' and '''?''' may be used in these fields.
|
||||
|
||||
* '''View icons''' [[Image:view-editor-icon]] , [[Image:view-clickable-icon]] , [[Image:view-flat-icon]] , [[Image:view-contracts-icon]] and [[Image:view-flat-contracts-icon]]
|
||||
** Click to change the view currently displayed in the editor.
|
||||
** Drop a pebble to retarget the editor to a class or feature using the selected view.
|
||||
|
||||
* '''Viewpoints selector'''
|
||||
** The Viewpoints selector can only be active if you have used [[Group Options#Renaming|renaming and/or prefixing]] in your project settings to specify alternate class names for some classes used by your project. Otherwise it is inactive. In a project with renaming and/or prefixing, the Viewpoints selector becomes active when both of the following are true:
|
||||
*** The editor window is focused on a class that has been renamed or prefixed in project settings.
|
||||
*** The class is being viewed in a formatted view, i.e., a view other than the '''Basic text view'''.
|
||||
** The Viewpoints selector allows you to select how you would like to view renamed or prefixed classes:
|
||||
*** As they really exist, i.e., as if you are their producer, or
|
||||
*** Using the alternative names that you have specified in your project settings.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
[[Property:title|Favorites menu]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|8157cc25-a299-3af6-8218-e5dfd094793d]]
|
||||
The '''favorites''' menu is composed of two parts.
|
||||
|
||||
First, there are three commands:
|
||||
* The '''Add to Favorites''' command, that adds the currently edited class to the root of the favorites tree.
|
||||
* The '''Show/Hide Favorites''' command, that shows or hides the [[Favorites tree|favorites tree]] .
|
||||
* The '''Organize Favorites''' command, that displays the [[Organize favorites dialog|Organize Favorites dialog]] .
|
||||
|
||||
After the separator, the favorites are displayed in a menu representation. Clicking on any of these menu items will send the selected favorite class to the editor.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
[[Property:title|Favorites tree]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|642c0a65-971e-b399-3e15-74af6dada046]]
|
||||
The favorites tree gives a graphical representation of the favorite classes of the system, as opposed to the favorites menu.
|
||||
|
||||
[[Image:favorites-tree]]
|
||||
|
||||
In this tree, the folders are user-definable through the [[Organize favorites dialog|Organize Favorites dialog]] . They have no other goal than ordering the favorites. In particular, they are entirely independent from the clusters of the system.
|
||||
|
||||
Clicking a class in the favorites tree edits it. Keyboard navigation is also available. Favorite classes are [[Pick-and-drop mechanism|pickable]] too, so that it is possible to send them to all interface components that accept classes.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Favorites tool]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|75cfeda2-3823-ef29-130a-39e686116f40]]
|
||||
The favorites tool ( [[Image:tool-favorites-icon]] ) gives a quick access to often used classes and features. These may be either classes of a library or classes that are often being modified. They are project-wide, which means they are shared by all development windows working on the same project.
|
||||
|
||||
[[Image:favorites-tool]]
|
||||
|
||||
The favorites tool mainly consists of [[Favorites menu|the favorites menu]] and of the left-panel tool, giving a [[Favorites tree|tree representation]] of the favorite classes.
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
[[Property:title|Create favorite folder command]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|a6d2f458-81ad-bc62-6476-2aabb3900a80]]
|
||||
This command [[Image:favorites-dialog-new-folder]] is accessible in the Organize favorites dialog. When clicked, a dialog is popped up that prompts for a name for the new folder:
|
||||
|
||||
[[Image:favorites-new-folder-dialog]]
|
||||
|
||||
After typing the name of the new folder, pressing '''OK''' adds it to the root of the favorites.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[[Property:title|Organize Favorites dialog]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|3e47cb30-c974-b0f4-1624-4bba035bd906]]
|
||||
The organize favorites dialog provides a way of sorting the favorites.
|
||||
|
||||
|
||||
[[Image:favorites-dialog]]
|
||||
|
||||
|
||||
The left part of this dialog is composed of a [[Favorites tree|tree representation]] of the favorites identical to the one in the [[Favorites tool|favorites tool]] .
|
||||
With it, it is possible to [[New favorite class command|add classes]] and [[Create favorite folder command|folders]] to the favorites or [[Remove favorite command|remove some]] , and also to [[Move to Folder command|spread]] the favorite classes among the favorite folders.
|
||||
|
||||
{{warning|Since the favorites are project-wide, any modifications made in this dialog are reported in all development windows. }}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
[[Property:title|Move to Folder command]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|087439e6-dc0c-d394-b3ed-ffaaf5928b39]]
|
||||
The Move to Folder command [[Image:favorites-dialog-move-to]] , located in the [[Organize favorites dialog|Organize Favorites dialog]], makes it possible to move favorite items (classes and folders) to specific folders. It is enabled only when an item is selected in the left-hand tree in this dialog. The source is the selected item that could be moved. You can select a different source item by clicking it in the tree, or by using the keyboard.
|
||||
|
||||
When pressed, a dialog is popped up, that prompts for the favorite folder the selected item should be moved to.
|
||||
|
||||
[[Image:favorites-choose-folder-dialog]]
|
||||
|
||||
Select the destination folder by expanding the tree and by clicking it. The top tree item, named Favorites, represents the root of the favorites.
|
||||
|
||||
Pressing '''OK''' moves the source item to the destination folder. Pressing '''Cancel''' discards the dialog box and does not move the source item.
|
||||
|
||||
{{tip|You can also move items around by picking them in the favorites tree and dropping them where you want. }}
|
||||
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Favorites tree|Favorites tree]] <br/>
|
||||
}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
[[Property:title|New favorite class command]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|18be5a70-d623-a45c-cf3d-45c1dc0a2ec5]]
|
||||
Located in the [[Organize favorites dialog|Organize Favorites dialog]] , this command:
|
||||
|
||||
[[Image:favorites-dialog-new-class]]
|
||||
|
||||
provides a way of adding a class to the favorites. When clicked, a new dialog is popped up, that allows to select a class among the clusters of the system:
|
||||
|
||||
[[Image:favorites-new-class-dialog]]
|
||||
|
||||
Clicking on a class name sets its name in the top text field, whereas double-clicking it automatically selects it and closes the dialog box. It is also possible to directly type the name of the wanted class in the top text field to select it.
|
||||
|
||||
The selected class goes to the root of the favorite tree. It is then possible to [[Move to Folder command|move]] it to a different favorite folder.
|
||||
|
||||
{{seealso|<br/>
|
||||
[[Favorites tool|Favorite tool]] <br/>
|
||||
[[Favorites menu|Favorite menu]] <br/>
|
||||
}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
[[Property:title|Remove favorite command]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|c55daacd-a7f8-294b-6b2c-9d503e6a3969]]
|
||||
The Remove favorite command [[Image:favorites-dialog-remove]] discards a favorite item from the favorites. It is enabled whenever an item is selected in the left-hand tree of the [[Organize favorites dialog|Organize favorites dialog]].
|
||||
|
||||
Pressing it removes the selected item from the favorites.
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
[[Property:title|Feature tree]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|6b5e1448-4547-2d4d-ef5d-165d5dbaedc1]]
|
||||
[[Image:feature-tree]]
|
||||
|
||||
The feature tree gives a summary of all the features of the currently edited class. They are in the same order as they are in the class file, and they are grouped by their feature clause.
|
||||
|
||||
The icon relative to the feature clause indicates the export status of the features inside it:
|
||||
* [[Image:folder-features-all-icon]] means features are exported to all classes
|
||||
* [[Image:folder-features-some-icon]] means features are exported to some classes
|
||||
* [[Image:folder-features-none-icon]] means features are not exported
|
||||
|
||||
The icon on the features indicates the nature of the feature:
|
||||
* [[Image:feature-attribute-icon]] for attributes
|
||||
* [[Image:feature-once-icon]] for once and constant features
|
||||
* [[Image:feature-deferred-icon]] for deferred features
|
||||
* [[Image:feature-external-icon]] for external features
|
||||
* [[Image:feature-frozen-routine-icon]] for frozen features
|
||||
* [[Image:feature-routine-icon]] for normal Eiffel routines
|
||||
|
||||
Clicking a feature or a feature clause in the tree centers the editor on it. Key navigation is also available. All features can be [[Pick-and-drop mechanism|picked]] , to [[Pick-and-drop mechanism|be dropped]] them into any component of the interface that accepts features.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
[[Property:title|Features tool]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|bc9b2ef1-b4c4-773a-9ba8-97143fb2727a]]
|
||||
{| border="0"
|
||||
|-
|
||||
| [[Image:feature-tool]]
|
||||
|
|
||||
And if you click on [[Image:feature-tool-signature-button|[S]]] the signature toggle button. <br/>
|
||||
You will see the signature for each feature
|
||||
|
||||
| [[Image:feature-tool-signature]]
|
||||
|}
|
||||
The Features tool gives a summary of all immediate (written-in) features of the currently edited class. They are listed in a [[Feature tree|tree representation]] , where the nodes are the feature clauses, and the leaves are the features.
|
||||
In the tool mini-toolbar, a [[New feature command|new feature command]] is available, which adds a new feature in the edited class.
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
[[Property:title|New feature command]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|3a670193-29dd-b829-0c90-eec8dd7e74b6]]
|
||||
The new feature command [[Image:new-feature-icon]] located in the [[Features tool|features tool]] acts like the [[New feature dialog|main new feature command]] . Clicking it pops up the same dialog, making it possible to add a new feature in the currently edited class.
|
||||
|
||||
This command is only available when the class currently in the editor is compiled, can be modified, and has a file on the disk (this may not be the case if the class is precompiled).
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
[[Property:title|Groups tool]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|0baebaa5-a9c8-4c7c-6ace-c11d82804906]]
|
||||
[[Image:tool-clusters-icon]]
|
||||
|
||||
[[Image:groups-tool]]
|
||||
|
||||
The groups tool gives a [[System tree representation|tree representation]] of all clusters, libraries and classes of the project. The toolbar contains a [[New cluster command|new cluster command]] , a [[New class command|new class command]] , and the [[Locate command|locate command]] .
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
[[Property:title|Locate command]]
|
||||
[[Property:weight|4]]
|
||||
[[Property:uuid|10d2cf53-4e11-d44c-ee05-12fc1c6c354c]]
|
||||
The locate command ( [[Image:general-search-icon]] ), located in the [[Groups tool|groups tool]], provides an easy way to find a class or a cluster in the [[System tree representation|cluster tree]] .
|
||||
|
||||
Clicking it automatically expands the clusters containing the edited class or cluster and selects it.
|
||||
|
||||
[[Pick-and-drop mechanism|Dropping]] a class or a cluster on it expands the clusters containing the searched item and selects it.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
[[Property:title|New class command]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|ca2a2b34-7bdf-52c7-c300-f780df40bca0]]
|
||||
The new class command ( [[Image:new-class-icon]] ) located in the groups tool toolbar creates a class in the same fashion as the main new class command. The only difference is that when using the groups tool command, the new class is by default located in the cluster selected in the [[System tree representation|cluster tree]] (or the parent cluster of the selected class, if a class is selected).
|
||||
|
||||
A dialog is then popped up in which it is possible to select the name of the new class, the name of the file it should be created in (by default ".e" is appended to the name of the new class to generate the file name), and the cluster in which the new class should be inserted. Only clusters that are not libraries are displayed in the list, since library clusters cannot be modified.
|
||||
|
||||
[[Image:new-class-dialog]]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
[[Property:title|New cluster command]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|8aa7c073-65dd-99d9-edba-73737d90fccf]]
|
||||
The new cluster command ( [[Image:new-cluster-icon]] ) located in the groups tool toolbar creates a cluster in the same fashion as the main new cluster command. The only difference is that when using the cluster tool command, the new cluster is by default located in the cluster selected in the [[System tree representation|cluster tree]] (or the selected class's parent cluster, if a class is selected).
|
||||
|
||||
A dialog is then popped up in which it is possible to select the name of the new cluster and the cluster in which the new cluster should be inserted. Only clusters that are not libraries are displayed in the list.
|
||||
|
||||
[[Image:new-cluster-dialog]]
|
||||
|
||||
Enabling the '''recursive''' option makes the compiler search not only the cluster directory but also all its sub-directories for classes. <br/>
|
||||
The '''library''' option optimizes compilations, since the classes inside a library cluster are compiled only once. However, if you modify the classes inside a library cluster, the modifications will not be taken into account in your project. Besides, you cannot add or remove classes in a library cluster, so use this option with care: if you intend to create new classes inside this cluster later in your design, do not select the library option. You should use this option only if the new cluster is given an existing directory, which already contains classes that you will not modify.
|
||||
|
||||
{{tip|You don't have to enter a path for the new cluster if you choose to create a sub-cluster: the new cluster directory will be a sub-directory of the directory of the parent cluster, and its name will be the name of the newly created cluster. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
[[Property:title|System tree representation]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|fc30ebd1-2a70-08ef-ae54-751ad834b489]]
|
||||
The groups tool is mainly composed of a tree representation of the system.
|
||||
|
||||
[[Image:cluster-tree]]
|
||||
|
||||
Here is the meaning of the symbols of the cluster tree:
|
||||
* [[Image:folder-cluster-icon]] , [[Image:folder-cluster-readonly-icon]] , [[Image:folder-blank-icon]] , [[Image:folder-override-cluster-icon]] , [[Image:folder-hidden-cluster-icon]] , are clusters (normal, readonly, subfolder in a recursive cluster, override cluster, hidden/implementation cluster)
|
||||
* [[Image:folder-library-icon]] are libraries
|
||||
* [[Image:folder-assembly-icon]] are assemblies
|
||||
* [[Image:folder-namespace-icon]] are namespaces in assemblies
|
||||
* [[Image:class-normal-icon]] , [[Image:class-frozen-icon]] , [[Image:expanded-normal-icon]] , [[Image:class-deferred-icon]] , [[Image:class-overriden-normal-icon]] , [[Image:class-override-normal-icon]] are compiled classes (normal, frozen, expanded, deferred, overriden, overriding)
|
||||
* Greyed out classes are classes outside the system.
|
||||
* Classes and clusters that are part of a readonly group are shown with a lock (for clusters) or brighter icon than normal (they cannot be modified)
|
||||
* [[Image:folder-target-icon]] are targets
|
||||
|
||||
Left-clicking on any item will send it to the editor. It is also possible to [[Pick-and-drop mechanism|pick]] items to send them to various components of the development window.
|
||||
|
||||
[[Pick-and-drop mechanism|Dropping]] a class in this tree representation moves it to a different cluster (either the cluster it is dropped on or the cluster containing the class it is dropped on, according to where it is dropped). This is only possible if the dropped class is not in a library cluster, if its source file is readable and writable, and if the destination cluster is not a library or precompiled cluster itself.
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[[Property:title|Browsing tools]]
|
||||
[[Property:weight|-13]]
|
||||
[[Property:uuid|b4e840c3-a635-b5dd-fbd2-0db69b3d6ce1]]
|
||||
The browsing tools are the address bars as well as all the tools that are in the left panel of development windows in normal mode. They help find an item in the system, such as a class, a cluster, a feature, some text, ... They include the [[Address bars|address bars]], the [[Groups tool|groups tool]], the [[Features tool|features tool]], the [[Favorites tool|favorites tool]], the [[Windows tool|windows tool]], and the [[Search tool|search tool]] .
|
||||
|
||||
{{seealso|<br/>
|
||||
[[EiffelStudio window overview|General window overview]] }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
[[Property:title|Search tool]]
|
||||
[[Property:weight|6]]
|
||||
[[Property:uuid|4d0cc8b3-2ffd-42d4-7855-672fa0c11cf8]]
|
||||
EiffelStudio includes a '''search tool''' which allows you to look for a word, phrase, string or even a pattern and, if you wish, to replace the matches it finds with some other word, phrase, or string. The search scope of the tool can be confined to the current editor pane, to the whole project, or to a custom domain of your choosing.
|
||||
|
||||
If the search tool is not currently visible, you can make it appear by clicking on the search icon [[Image:tool-search-icon]] or by following either menu path:
|
||||
<code lang="text">
|
||||
View -> Tools -> Search
|
||||
</code>
|
||||
or
|
||||
<code lang="text">
|
||||
Edit -> Find
|
||||
</code>
|
||||
|
||||
==The Search panel==
|
||||
|
||||
[[Image:search-tool]]
|
||||
|
||||
Fig. 1: Search panel
|
||||
|
||||
The search panel has two tabs. The '''search tab''' allows you to define how and for what strings and patterns you want to search (or search and replace). The '''scope tab''' allows you to define the limits of your search.
|
||||
|
||||
===The Search tab===
|
||||
|
||||
On the '''search tab''' of the search panel (shown in Fig. 1), you will find two combo boxes, labeled '''Search for:''' and '''Replace with:'''. These are used to enter the string or pattern for which you want to search and the word or phrase, if any, which you want the editor to use to replace matches resulting from the search.
|
||||
|
||||
Also in the Search tab, there are buttons that control whether you want to '''search''', to '''replace''' the most recently found match, or '''replace all''' matches.
|
||||
|
||||
====Using sub-patterns and back references====
|
||||
|
||||
If you are searching using '''regular expressions''' (see [[#The options group|The options group]] below), you can use '''sub-patterns''' in your search pattern. This allows you to capture the portion of a "match" that satisfies a sub-pattern the search. Then, in the replacement, you can make a '''back reference''' to that captured part of the match. You can create more than one sub-pattern in any search pattern.
|
||||
|
||||
To create a sub-pattern, in the '''Search for:''' combo box, enclose in parentheses any parts of the search that you want to capture for use in the replacement. Then, in the '''Replace with:''' combo box, you can back reference each capture by its index enclosed in backslashes. The following example should help make this clear.
|
||||
|
||||
Assume that the text you are searching contains the following:
|
||||
<code>
|
||||
-- The dog is chasing the cat
|
||||
</code>
|
||||
Then, you enter values into the '''Search for:''' and '''Replace with:''' boxes so that it looks like this:
|
||||
|
||||
|
||||
[[Image:Search capture boxes]]
|
||||
|
||||
After the replacement, your text will look like this:
|
||||
<code>
|
||||
-- The cat is being chased by the dog
|
||||
</code>
|
||||
|
||||
====The options group====
|
||||
|
||||
There are four search options, each of them represented by a check box:
|
||||
|
||||
* '''Match case:''' If this option is selected, the search will be case-sensitive, which means that if you search for "example", the tool will highlight "example" but not "EXAMPLE" or "Example", as there are no capital letters in the searched pattern.
|
||||
|
||||
* '''Whole word:''' If this option is selected, the tool will look for isolated words. A word is isolated if it is surrounded by spaces or if it is at the beginning or the end of a line.
|
||||
|
||||
* '''Use regular expressions:''' You can enter a regular expression as a pattern for matching. In Fig. 1, the regular expression in the '''Search for:''' box describes very simple quoted strings. Regular expressions give you the ability to create powerful pattern-oriented searches. If you are not familiar with regular expressions, you might check out the tutorial at [http://www.regular-expressions.info/ www.regular-expressions.info].
|
||||
|
||||
{{note|It might be good advice to temper your expectations of using regular expressions with these words, [http://www.devtopics.com/101-more-great-computer-quotes/ attributed] to Jamie Zawinski: "Some people, when confronted with a problem, think `I know, I'll use regular expressions.' Now they have two problems."}}
|
||||
|
||||
* '''Search backwards:''' If this option is selected, the tool will highlight the previous occurrence of the searched pattern instead of the next occurrence when you click the '''Search button'''.
|
||||
|
||||
{{note|If the search tool hits one end of the text, it will automatically continue from the other end. }}
|
||||
|
||||
===The Scope tab===
|
||||
|
||||
[[Image:search-tool-scope-tab]]
|
||||
|
||||
Fig. 2 Scope tab
|
||||
|
||||
In the scope tab, you can choose how wide a search you would like to make.
|
||||
|
||||
* '''Current editor''' Your search will be confined to the class which is the current target of the Editor pane.
|
||||
* '''Whole project''' The entire project universe will be searched.
|
||||
* '''Custom''' You are given the opportunity to choose which classes and clusters you would like to be included in the search scope.
|
||||
|
||||
When you make certain choices, one or both of the check boxes become enabled.
|
||||
|
||||
If you choose '''Whole project''', the '''Only compiled classes''' check box becomes enabled. If you check the box, then the search is confined to classes which are actually included in your system (i.e., reachable via relationships from your root class ... the classes shown with blue ovals). If you leave '''Only compiled classes''' unchecked, all classes in your project's universe are included in the search (blue and grey ovals). With '''Whole project''', the '''Recursive''' check box remains disabled.
|
||||
|
||||
If you choose '''Custom''', both the '''Only compiled classes''' check box and the '''Recursive''' check box become enabled. The '''Recursive''' check box allows the search to include recursively subclusters of any cluster included in the search.
|
||||
|
||||
==The Search Report panel==
|
||||
|
||||
[[Image:search-report-01]]
|
||||
|
||||
Fig. 3 Search Report panel
|
||||
|
||||
The search report panel will be visible whenever your search returns matches on multiple classes. The '''collapsed''' view of the search results shows the class name of classes in which matches were found, and the number of matches. When you '''expand''' and entry, you see the line number at which the match occurs, and the exact string that caused the match. If you have used [[#Using sub-patterns and back references|'''sub-patterns''']] in your search, then the captures for each sub-pattern will also be shown in the search report panel when the entries are completely expanded.
|
||||
|
||||
The items in the search report panel can be [[Pick-and-drop mechanism|picked and dropped]] into the editor or other appropriate targets in EiffelStudio.
|
||||
|
||||
|
||||
|
||||
|
||||
{{seealso|The [[Search functionality]] part of the EiffelStudio Editor section to learn keyboard shortcuts and menu entries to launch searches without using the search tool directly. }}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[[Property:title|Windows tool]]
|
||||
[[Property:weight|5]]
|
||||
[[Property:uuid|57b14a4b-8694-12f6-06c8-24411e331559]]
|
||||
The windows tool ( [[Image:windows-windows-icon]] ) gives a list of opened development windows.
|
||||
|
||||
[[Image:windows-tool]]
|
||||
|
||||
Its main component is the [[Window list|Window list]] .
|
||||
|
||||
It is also linked to the [[Window menu|Window menu]] menu.
|
||||
|
||||
[[Window related commands|Window related commands]] provide global management of windows.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
[[Property:title|Window list]]
|
||||
[[Property:weight|1]]
|
||||
[[Property:uuid|95058f0f-7c1b-841d-03df-dde4494afaf4]]
|
||||
The window list is the main part of the [[Windows tool|window tool]] .
|
||||
|
||||
[[Image:windows-tool]]
|
||||
|
||||
It displays all opened development windows. Left-clicking a development window in the list raises it so that it becomes the top-level window. Right-clicking one pops up a context menu.
|
||||
|
||||
The four first commands, '''Close''', '''Minimize''', '''Maximize''' and '''Raise''', are relative to the clicked development window. The last command, '''New window''', creates a new development window.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
[[Property:title|Window menu]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|539ef2b0-ed6b-3cfb-5c9f-535fb25a987d]]
|
||||
The '''window''' menu is divided into two parts. The first one is composed of the [[Window related commands|window-related commands]] . The second one is the list of all opened development windows. Clicking any of these raises the selected development window, so that it becomes the top-level window.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
[[Property:title|Window related commands]]
|
||||
[[Property:weight|3]]
|
||||
[[Property:uuid|2c8c28d2-7690-dbe2-a264-798d5ad256f7]]
|
||||
A few commands give the possibility to manage the development windows globally. They are located both in the [[Window menu|Window menu]] and in the main toolbar.
|
||||
* '''New window''': this command ( [[Image:new-window-icon]] ) creates a new empty development window. Note that it is also possible to [[Pick-and-drop mechanism|drop]] a class or a feature on it to create a development window that is immediately centered on the dropped item.
|
||||
* '''Minimize all''': this command ( [[Image:windows-minimize-all-icon]] ) iconifies all development windows.
|
||||
* '''Raise all''': this command ( [[Image:windows-raise-all-icon]] ) raises all minimized development windows.
|
||||
* '''Raise unsaved windows''': this command raises all the development windows that have not been saved. It may be combined with the '''Minimize all''' command to find easily which development windows need to be saved.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user