- 19.05 (released) ...
Eiffel has a remarkably small set of instructions. The basic computational instructions have been seen: creation, assignment, procedure call, retry. They are complemented by control structures: conditional, multi-branch, loop, as well as debug and check.
Assignment and attachment
As noted above we have already introduced assignment. But let's take another look at the assignment in the context of the more abstract concept of attachment. Attachment can occur with reference types by assignment such as:
x := y
In this assignment,
x is the target of the assignment and
y is the source. The object associated with
y becomes attached to the entity
Attachment also occurs in other contexts. For example, when actual arguments are substituted for formal arguments in a call to a routine.
In the call to
f above, the object associated with the actual argument
w will be attached to the formal argument for the duration of the execution of
f. So, in this case,
w can be viewed as the source of the attachment and the formal argument of
f is the target.
Other situations in which attachment occurs include creation instructions, attachment of object test local variables, and the attachment of local iteration cursors in the iteration form of the loop construct.
We learned in the section on polymorphism, that the type of the source of an assignment must conform to the type of the assignment's target.
The rule that governs validity of assignments expands upon this and is generalized to apply to all attachments.
The phrase "compatible with" in this rule means that either it "conforms to" or "converts to".
A conditional instruction has the form
if ... then
elseif ... then
then ... part (of which there may be more than one) and the
else ... part are optional. After
elseif comes a boolean expression; after
else come zero or more instructions.
A multi-branch instruction has the form
when v1 then
when v2 then
else inst0 part is optional,
exp is a character or integer expression,
v1, ... are constant values of the same type as
exp, all different, and
inst2, ... are sequences of zero or more instructions.
The effect of such a multi-branch instruction, if the value of
exp is one of the
vi, is to execute the corresponding
insti. If none of the
vi matches, the instruction executes
inst0, unless there is no
else part, in which case it triggers an exception.
The loop construct provides a flexible framework for iterative computation. Its flexibility lies in how the complete form can be tailored and simplified for certain purposes by including or omitting optional parts.
You'll learn that the loop construct is always used in one of two forms: a base form which allows precise control over details of all loop aspects, and an iteration form which abstracts many of the details and provides a concise notation, ideal for traversing data structures and other objects which support iteration.
We will explore the entire mechanism, but let's approach things a little at a time.
Two forms -- two examples
First let's take a look at two examples. These examples accomplish the same goal: they both use a loop to visit and print the content of each node of a linked list of character strings. So, the list in question might be declared like this:
my_list: LINKED_LIST [STRING]
Here's one example:
Loop example 1.
and the other:
across my_list as ic loop print (ic.item) end
Loop example 2.
At first observation, it may not appear that both of these examples are using the same language construct. But, indeed, they are simply two different forms of a single language construct, as you will see.
Incidentally, there is no requirement that Loop example 1 occupy multiple lines, and Loop example 2 occupy only one line. Loop example 1 could have been written like this:
from my_list.start until my_list.off
loop print (my_list.item) my_list.forth end
just as Loop example 2 could have been written to take multiple lines. It comes down to a matter of balance among traditional style, conciseness, and readability.
In fact, these two examples illustrate the two basic usage forms of the loop construct in Eiffel. The two basic forms can be differentiated by the parts of the construct with which they begin.
The form shown in Loop example 1 begins with an Initialization part (
from my_list.start ), which starts with the keyword
from. Let's call this form the base form. So, the type of loop you see in Loop example 1 has been the traditional mechanism for accomplishing iterative computation, including iterating across data structures. However, extensions to Eiffel's loop construct have provided a more concise way of expressing traversing "iterable" structures.
This is the form shown in Loop example 2. It begins with an Iteration part (
across my_list as c ), which starts with the keyword
across. We'll call this form the iteration form.
A closer look at the base form
What is happening in Loop example 1? Let's dissect it and see.
First there is the initialization part:
The first thing to occur in the execution of the base loop is the execution of any instructions in the initialization part (it is permissible for the initialization part to be empty of instructions, but the keyword
from must be present to distinguish the base loop form). In our example, the feature
start is applied to
my_list which will attempt to set the list cursor to the first element in
The Exit condition part:
Exit condition part.
The exit condition part of the loop construct defines the conditions under which the loop body (explained below) should no longer be executed. In our example, the loop will no longer execute if the cursor is "off", that is, there is no current item. So, if the list is empty, the loop body will not execute at all.
loop body part:
loop body part.
The loop body part contains the sequence of instructions to be executed during each iteration. In the example, that includes printing the current list item and then advancing the cursor. At some point, the cursor will pass the last item in the list, causing the exit condition to become true and stop the loop's execution. So, at the risk of stating the obvious, the key to loops that always complete is to ensure that there is something in the loop body that is guaranteed always to cause the exit condition eventually to become true. Loop correctness will discussed in more detail later.
And finally, there's the End part:
A closer look at the iteration form
Now let's examine the iteration form (sometimes called the "across syntax") used in Loop example 2.
The example begins with an iteration part:
across my_list as ic
The iteration form is special in the sense that it is designed to work with objects which are iterable, usually data structures. The iteration form always targets a particular object (usually a data structure) based on a class that inherits, either directly or indirectly from the library class
ITERABLE. The iteration part specifies such a target for the iteration, in the case of our example, the target is
as ic" indicates that a local iteration cursor object referenced by the name
ic, and available only for the scope of the iteration, will be created to effect the iteration. The element of
my_list which is currently referenced by the cursor
ic is accessed through
ic.item as you see in the loop body:
loop print (ic.item)
loop body part.
Notice that the loop body does not contain the call to the structure's
forth feature, as our example in base form did. Neither do you see the call to
start nor the check of
off in the exit condition. The iteration form abstracts these for you, relieving you of their burden ... while eliminating some opportunities for error.
Notice also that the call "
print (ic.item)"" accesses the current item as "
ic.item"" versus "
my_list.item"" in the base form. This is because in the iteration form, access to the current item is through the cursor variable, "
ic" in the case of Loop example 2.
Concerning cursors, both ways of using the loop construct to traverse a structure employ a cursor. In the base form, the cursor is internal to the structure object. In the case of the example, that would be the instance of
LINKED_LIST [STRING] called
my_list. Applying the feature
my_list retrieves the list element currently referenced by the cursor. In the iteration version of traversal, the variable
ic holds the iteration cursor, external to the list object. So, you apply
ic.item to get the current list element. The advantage to the external cursor is that multiple traversals of the structure can occur simultaneously without interfering with one another. This is possible in the base form, but only by saving and restoring the structure's cursor.
Lastly, of course, the iteration form includes an
end part ... at the end.
The iteration form as a boolean expression
In Loop example 2, the loop behaves as an instruction. But it is possible to have the iteration loop form behave as a boolean expression. This is helpful in cases in which you might want to ask a question that can be answered by traversing all or part of a structure.
To get this effect, you use the iteration form with one of two alternative body notations, the
all body part or the
some body part in place of the
loop body. When you use either of these notations, the body is a boolean expression. So, the forms for these body parts are:
all body part.
some body part.
So, to know if all the strings in
my_list have lengths greater than three characters, we could code:
across my_list as ic all ic.item.count > 3 end
Loop example 3.
To know if at least one string in
my_list has a length greater than three characters, we would use the
some body part:
across my_list as ic some ic.item.count > 3 end
Loop example 4.
Of course you can use iteration loops with "
all" or "
some" bodies in the same way that you would any other boolean expression; in conditionals, for example.
Loop anatomy and rules for constructing loops
Now that we've seen examples of the two forms of loops and broken down their component parts, we're ready to examine the anatomy of the entire construct in more detail. You may remember from the beginning of this discussion that the flexibility of the loop construct lies in its ability to use or omit its various parts to gain certain effects.
Here are all the possible loop parts, most of which we've seen in examples, in the order in which they must appear when we code them:
|This loop part:||Has this pattern:|
|Iteration part|| |
|Initialization part|| |
|Invariant part|| |
|Exit condition part|| |
|Body part|| |
|Variant part|| |
| || |
Apart from seeing examples, it is useful to understand some of the rules of constructing loops from these parts. Here's an informal summary of what you should know about putting together valid loops:
- Any loop parts being used must appear in the order shown in the table above.
- Every loop used will assume one of the two forms mentioned early. As a result, every loop will begin either with the
acrosskeyword (iteration form) or the
fromkeyword (base form).
- A Body part and an End part are both required for every loop.
- Body parts using either the
allkeyword or the
somekeyword are only allowed in the absence of an initialization part.
- Body parts using either the
- An exit condition part is required for all loops of base form.
- The expression you use in an iteration part, must have a type that is based on a class that inherits from the library class
- The identifier you choose for the internal cursor used in loops of the iteration form shouldn't be the same as another identifier you are using.
There are implications of these rules that are worth understanding. Let's look at some of them.
Consider that all parts must appear in order (1) and that every loop starts with one of two keywords: either
from (2). Taken together, these imply that it would be invalid for a loop in base form to include an iteration part. However, the opposite is not true. Because the initialization part falls after the iteration part it is possible for a loop in iteration form to contain an initialization part. Imagine for example, that we wanted to compute the sum of the number of characters in all elements of the list of strings in our examples. The initialization part could be used to initialize the sum entity before starting the iteration:
my_list as ic
sum := 0
sum := sum + ic.item.count
Loops of the base form require an exit condition part (4). This allows the possibility that Iteration loops may contain an exit condition part. Indeed they may, but it is not required. Using an exit condition part in a loop of the iteration can be useful if you want to impose an early exit condition on an iteration. So, extending the previous example, if we wanted to sum the length of elements, but only until we reached an element whose content matched a certain criterion, we could add the exit condition part:
my_list as ic
sum := 0
ic.item ~ "Stop now"
sum := sum + ic.item.count
For loops of the iteration form, types of iteration targets must be based on classes inheriting from
ITERABLE (5). What classes meet this criterion? All the appropriate classes in the EiffelBase library: lists, hash tables, arrays, intervals, etc. Although the details are beyond the scope of this tutorial, you also should recognize the implication that your own classes could be made iterable.
One useful descendant of
ITERABLE is the integer interval. The general operator "
|..|" provides a concise way of creating the interval between two integers. So, you can use this to loop across a range of integers without a lot of setup. This example:
5 |..| 15 as ic
endprints the integers in the interval 5 through 15.
Also descending from
ITERABLE are the iteration cursors themselves. This means that a cursor can be the target of a loop of the iteration form. Consider this example that prints the items in
my_list in reverse order:
my_list.new_cursor.reversed as ic
end Here the feature
new_cursor is applied to
my_list. The result is a new iteration cursor for traversing
my_list. Then the
reversed feature is applied to that result, which itself results in an iteration cursor having the order of the elements reversed. It is this cursor that is used for
ic in the traversal.
Loop invariants and variants
The only loop parts that we have yet to address are the invariant part and the variant part. These two optional loop parts exist to help guarantee the correctness of loops. The invariant part expresses a loop invariant (not to be confused with class invariants). For the loop to be correct, the instructions in initialization part must ensure that the loop invariant assertion is true, and then every execution of the loop body must preserve the invariant; so the effect of the loop is to yield a state, eventually, in which both the loop invariant and the exit condition are true.
The loop must terminate after a finite number of iterations, of course. This can be guaranteed by including the loop variant part. The variant part provides an integer expression whose value is non-negative after the execution of the instructions in the initialization part. The value of the variant is then decreased by at least one, while remaining non-negative, by any execution of the loop body. Because a non-negative integer cannot be decreased forever, this guarantees that the loop will terminate.
When assertion monitoring is enabled for loop invariants and variants, the integrity of these properties is checked after initialization and after each loop iteration. An exception will be triggered if the loop invariant does not hold, or if the variant either becomes negative or does not decrease.
An occasionally useful instruction is
end where instructions is a sequence of zero or more instructions and the part in parentheses is optional, containing if present one or more strings, called debug keys. The EiffelStudio compiler lets you specify the corresponding
debug compilation option:
no, or an explicit debug key. The instructions will be executed if and only if the corresponding option is on. The obvious use is for instructions that should be part of the system but executed only in some circumstances, for example to provide extra debugging information.
The final instruction is connected with Design by Contract. The instruction
endwhere Assertion is a sequence of zero or more assertions, will have no effect unless assertion monitoring is turned on at the
Check level or higher. If so it will evaluate all the assertions listed, having no further effect if they are all satisfied; if any one of them does not hold, the instruction will trigger an exception.
This instruction serves to state properties that are expected to be satisfied at some stages of the computation -- other than the specific stages, such as routine entry and exit, already covered by the other assertion mechanisms such as preconditions, postconditions and invariants. A recommended use of
check involves calling a routine with a precondition, where the call, for good reason, does not explicitly test for the precondition. Consider a routine of the form
r (a_count: INTEGER)
valid_count: a_count >= minimum_allowable
This routine will only work if its precondition is satisfied on entry. To guarantee this precondition, the caller may protect it by the corresponding test, as in
if my_count >= a.minimum_allowable then
In effect, this says that if the value of
r's precondition requirement, then call
r, otherwise continue execution. This implies that there is something useful to be done in the case that the call to
r could not be executed because the value of
my_count did not meet the precondition.
But suppose that due to previous processing, it is reasonably expected that
my_count should always have a value that complies with
r's precondition. In other words, it would always be expected that the call to
r should proceed without failure. In this case it might be a good idea to use a
check to document this property,
my_count_is_large_enough: my_count >= a.minimum_allowable
-- Should always be large enough because ...
endif only to make sure that a reader of the code will realize that the omission of an explicit test was not a mistake.
In production (finalized) mode, when assertion monitoring is typically turned off, this instruction will have no effect. But it will be precious for a maintainer of the software who is trying to figure out what it does, and in the process to reconstruct the original developer's reasoning. (The maintainer might of course be the same person as the developer, six months later.) And if the rationale is wrong somewhere, turning assertion checking on will immediately uncover the bug.
There is, however, one form of
check that continues to be monitored even when assertion monitoring is turned off.
check Assertion then
Assertion is a list of assertions as above, and
Compound is a list of zero or more executable instructions.
This variant is used often when ensuring void-safety. It is used make certain that certain detachable entities are actually attached to objects when expected, and to create a new void-safe scope for accessing the objects. For example:
check attached my_detachable as l_temp then
endIn cases in which
my_detachable is attached to an object (as is expected), the local entity l_temp will allow controlled access to the object during the scope of the
check instruction. If a case occurs in which
my_detachable is not attached to an object, then an exception is triggered. As noted above, for this variant of
check, assertion monitoring is always in effect, even if it has been turned off for other cases.
So, the form
check ... then ... end is somewhat similar to
if ... then ... end. The difference is that the
if ... then ... end allows the possibility that valid cases might occur in which the boolean expression is not true, and processing continues. The
check ... then ... end does not allow such a possibility. The boolean expression is expected always to hold. In fact, if the expression is not true, then like other assertion violations, this is indicative of a bug, and will cause an exception to be raised.