indexing
description: "A sequence of actions to be performed on `call'"
instructions: "[
Use features inherited from LIST to add/remove actions.
An action is a procedure of ANY class that takes EVENT_DATA.
When `call' is called the actions in the list will be executed
in order stating at `first'.
An action may call `abort' which will cause `call' to stop executing
actions in the sequence. (Until the next call to `call').
Descendants may redefine `initialize' to arrange for `call' to
be called by an event source.
Use `block', `pause', `flush' and `resume' to change the behavior
of `call'.
eg.
birthday_data: TUPLE [INTEGER, STRING] -- (age, name)
birthday_actions: ACTIONS_SEQUENCE [like birthday_data]
create birthday_actions.make ("birthday", <<"age","name">>)
send_card (age: INTEGER, name, from: STRING) is ...
buy_gift (age: INTEGER, name, gift, from: STRING) is ...
birthday_actions.extend (agent send_card (?, ?, "Sam")
birthday_actions.extend (agent buy_gift (?, ?, "Wine", "Sam")
birthday_actions.call ([35, "Julia"])
causes call to: send_card (35, "Julia", "Sam")
buy_gift (35, "Julia", "Wine", "Sam")
]"
status: "See notice at end of class"
keywords: "event, action"
date: "$Date$"
revision: "$Revision$"
class interface
ACTION_SEQUENCE [EVENT_DATA -> TUPLE create make end]
create
default_create
Normal_state
make
feature
arrayed_list_make (n: INTEGER)
n
n
ARRAYED_LIST
require ARRAYED_LIST
valid_number_of_items: n >= 0
ensure ARRAYED_LIST
correct_position: before
make_filled (n: INTEGER)
n
n
ARRAYED_LIST
require ARRAYED_LIST
valid_number_of_items: n >= 0
ensure ARRAYED_LIST
correct_position: before
filled: full
make_from_array (a: ARRAY [PROCEDURE [ANY, EVENT_DATA]])
a
ARRAYED_LIST
require ARRAY
array_exists: a /= void
feature
cursor: CURSOR
ARRAYED_LIST
dummy_event_data: EVENT_DATA
event_data_names: ARRAY [STRING]
ensure
equal_to_event_data_names_internal: deep_equal (Result, event_data_names_internal)
first: PROCEDURE [ANY, EVENT_DATA]
ARRAYED_LIST
require CHAIN
not_empty: not is_empty
has (v: like item): BOOLEAN
v
object_comparison
CHAIN
ensure CONTAINER
not_found_in_empty: Result implies not is_empty
index: INTEGER
item
ARRAYED_LIST
index_of (v: like item; i: INTEGER): INTEGER
iv
object_comparison
CHAIN
require LINEAR
positive_occurrences: i > 0
ensure LINEAR
non_negative_result: Result >= 0
item: like first
ARRAYED_LIST
require TRAVERSABLE
not_off: not off
require ACTIVE
readable: readable
require else ARRAYED_LIST
index_is_valid: valid_index (index)
i_th (i: INTEGER): PROCEDURE [ANY, EVENT_DATA]
i
ARRAY@
ARRAY
require TABLE
valid_key: array_valid_index (k)
last: like first
ARRAYED_LIST
require CHAIN
not_empty: not is_empty
name: STRING
ensure
equal_to_name_internal: Result.is_equal (name_internal)
sequential_occurrences (v: PROCEDURE [ANY, EVENT_DATA]): INTEGER
v
object_comparison
LINEAR
ensure BAG
non_negative_occurrences: Result >= 0
infix "@" (i: INTEGER): PROCEDURE [ANY, EVENT_DATA]
i
ARRAYitem
ARRAY
require TABLE
valid_key: array_valid_index (k)
feature
count: INTEGER
ARRAYED_LIST
index_set: INTEGER_INTERVAL
CHAIN
ensure INDEXABLE
not_void: Result /= void
ensure then CHAIN
count_definition: Result.count = count
occurrences (v: like item): INTEGER
v
object_comparison
CHAIN
ensure BAG
non_negative_occurrences: Result >= 0
occurrences (v: like item): INTEGER
v
object_comparison
CHAIN
ensure BAG
non_negative_occurrences: Result >= 0
feature
capacity: INTEGER
ARRAYcount
ARRAY
ensure then ARRAY
consistent_with_bounds: Result = upper - lower + 1
feature
is_equal (other: like Current): BOOLEAN
other
LIST
require ANY
other_not_void: other /= void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
ensure then LIST
indices_unchanged: index = old index and other.index = old other.index
true_implies_same_size: Result implies count = other.count
feature
after: BOOLEAN
LIST
before: BOOLEAN
LIST
Blocked_state: INTEGER is 3
call_is_underway: BOOLEAN
call
ensure
Result = not is_aborted_stack.is_empty
changeable_comparison_criterion: BOOLEAN
object_comparison
CONTAINER
exhausted: BOOLEAN
LINEAR
ensure LINEAR
exhausted_when_off: off implies Result
Extendible: BOOLEAN is True
DYNAMIC_CHAIN
full: BOOLEAN
ARRAYED_LIST
is_empty: BOOLEAN
FINITE
is_inserted (v: PROCEDURE [ANY, EVENT_DATA]): BOOLEAN
vput
extend
ARRAYED_LIST
isfirst: BOOLEAN
CHAIN
ensure CHAIN
valid_position: Result implies not is_empty
islast: BOOLEAN
CHAIN
ensure CHAIN
valid_position: Result implies not is_empty
Normal_state: INTEGER is 1
object_comparison: BOOLEAN
equal=
=
CONTAINER
off: BOOLEAN
CHAIN
Paused_state: INTEGER is 2
prunable: BOOLEAN
ARRAYED_LIST
readable: BOOLEAN
SEQUENCE
state: INTEGER
Normal_statePaused_stateBlocked_state
valid_cursor (p: CURSOR): BOOLEAN
p
ARRAYED_LIST
valid_cursor_index (i: INTEGER): BOOLEAN
i
CHAIN
ensure CHAIN
valid_cursor_index_definition: Result = ((i >= 0) and (i <= count + 1))
valid_index (i: INTEGER): BOOLEAN
i
ARRAYED_LIST
ensure then INDEXABLE
only_if_in_index_set: Result implies ((i >= index_set.lower) and (i <= index_set.upper))
ensure then CHAIN
valid_index_definition: Result = ((i >= 1) and (i <= count))
valid_index (i: INTEGER): BOOLEAN
i
ARRAYED_LIST
ensure then INDEXABLE
only_if_in_index_set: Result implies ((i >= index_set.lower) and (i <= index_set.upper))
ensure then CHAIN
valid_index_definition: Result = ((i >= 1) and (i <= count))
writable: BOOLEAN
SEQUENCE
feature
abort
call
require
call_is_underway: call_is_underway
ensure
is_aborted_set: is_aborted_stack.item
block
call
ensure
blocked_state: state = blocked_state
compare_objects
equal
=
CONTAINER
require CONTAINER
changeable_comparison_criterion
ensure CONTAINER
object_comparison
compare_references
=
equal
CONTAINER
require CONTAINER
changeable_comparison_criterion
ensure CONTAINER
reference_comparison: not object_comparison
flush
call
ensure
call_buffer_empty: call_buffer.is_empty
pause
call
is_blocked
ensure
paused_state: state = paused_state
resume
blockpausecall
call
ensure
normal_state: state = normal_state
feature
back
ARRAYED_LIST
require BILINEAR
not_before: not before
finish
ARRAYED_LIST
ensure then CHAIN
at_last: not is_empty implies islast
ensure then ARRAYED_LIST
before_when_empty: is_empty implies before
forth
ARRAYED_LIST
require LINEAR
not_after: not after
ensure then LIST
moved_forth: index = old index + 1
go_i_th (i: INTEGER)
i
ARRAYED_LIST
require CHAIN
valid_cursor_index: valid_cursor_index (i)
ensure CHAIN
position_expected: index = i
go_to (p: CURSOR)
p
ARRAYED_LIST
require CURSOR_STRUCTURE
cursor_position_valid: valid_cursor (p)
move (i: INTEGER)
i
ARRAYED_LIST
ensure CHAIN
too_far_right: (old index + i > count) implies exhausted
too_far_left: (old index + i < 1) implies exhausted
expected_index: (not exhausted) implies (index = old index + i)
search (v: like item)
itemv
v
exhausted
object_comparison
BILINEAR
ensure LINEAR
object_found: (not exhausted and object_comparison) implies equal (v, item)
item_found: (not exhausted and not object_comparison) implies v = item
start
ARRAYED_LIST
ensure then CHAIN
at_first: not is_empty implies isfirst
ensure then ARRAYED_LIST
after_when_empty: is_empty implies after
feature
append (s: SEQUENCE [PROCEDURE [ANY, EVENT_DATA]])
s
SEQUENCE
require SEQUENCE
argument_not_void: s /= void
ensure SEQUENCE
new_count: count >= old count
extend (v: like item)
v
ARRAYED_LISTforce
ARRAYED_LIST
require COLLECTION
extendible: extendible
ensure COLLECTION
item_inserted: is_inserted (v)
ensure then BAG
one_more_occurrence: occurrences (v) = old (occurrences (v)) + 1
fill (other: CONTAINER [PROCEDURE [ANY, EVENT_DATA]])
other
other
COLLECTION
require COLLECTION
other_not_void: other /= void
extendible
force (v: like item)
v
ARRAYED_LISTextend
ARRAYED_LIST
require SEQUENCE
extendible: extendible
ensure then SEQUENCE
new_count: count = old count + 1
item_inserted: has (v)
merge_left (other: ARRAYED_LIST [PROCEDURE [ANY, EVENT_DATA]])
other
ARRAYED_LIST
require DYNAMIC_CHAIN
extendible: extendible
not_before: not before
other_exists: other /= void
ensure DYNAMIC_CHAIN
new_count: count = old count + old other.count
new_index: index = old index + old other.count
other_is_empty: other.is_empty
ensure then DYNAMIC_LIST
other_empty: other.is_empty
merge_right (other: ARRAYED_LIST [PROCEDURE [ANY, EVENT_DATA]])
other
ARRAYED_LIST
require DYNAMIC_CHAIN
extendible: extendible
not_after: not after
other_exists: other /= void
ensure DYNAMIC_CHAIN
new_count: count = old count + old other.count
same_index: index = old index
other_is_empty: other.is_empty
ensure then DYNAMIC_LIST
other_empty: other.is_empty
put (v: like item)
v
replace
CHAIN
require COLLECTION
extendible: extendible
ensure COLLECTION
item_inserted: is_inserted (v)
ensure then CHAIN
same_count: count = old count
put_i_th (v: like i_th; i: INTEGER)
iv
ARRAY
require TABLE
valid_key: array_valid_index (k)
ensure then INDEXABLE
insertion_done: i_th (k) = v
put_front (v: like item)
v
ARRAYED_LIST
ensure DYNAMIC_CHAIN
new_count: count = old count + 1
item_inserted: first = v
put_left (v: like item)
v
ARRAYED_LIST
require DYNAMIC_CHAIN
extendible: extendible
not_before: not before
ensure DYNAMIC_CHAIN
new_count: count = old count + 1
new_index: index = old index + 1
put_right (v: like item)
v
ARRAYED_LIST
require DYNAMIC_CHAIN
extendible: extendible
not_after: not after
ensure DYNAMIC_CHAIN
new_count: count = old count + 1
same_index: index = old index
replace (v: like first)
v
ARRAYED_LIST
require ACTIVE
writable: writable
ensure ACTIVE
item_replaced: item = v
feature
prune (v: like item)
v
afterv
ARRAYED_LIST
require COLLECTION
prunable: prunable
prune_all (v: like item)
v
object_comparison
ARRAYED_LIST
require COLLECTION
prunable
ensure COLLECTION
no_more_occurrences: not has (v)
ensure then DYNAMIC_CHAIN
is_exhausted: exhausted
ensure then ARRAYED_LIST
is_after: after
remove
after
ARRAYED_LIST
require ACTIVE
prunable: prunable
writable: writable
ensure then DYNAMIC_LIST
after_when_empty: is_empty implies after
ensure then ARRAYED_LIST
index: index = old index
remove_left
ARRAYED_LIST
require DYNAMIC_CHAIN
left_exists: index > 1
require else DYNAMIC_LIST
not_before: not before
ensure DYNAMIC_CHAIN
new_count: count = old count - 1
new_index: index = old index - 1
remove_right
ARRAYED_LIST
require DYNAMIC_CHAIN
right_exists: index < count
ensure DYNAMIC_CHAIN
new_count: count = old count - 1
same_index: index = old index
wipe_out
ARRAYED_LIST
require COLLECTION
prunable
ensure COLLECTION
wiped_out: is_empty
ensure then DYNAMIC_LIST
is_before: before
feature
swap (i: INTEGER)
i
ARRAYED_LIST
require CHAIN
not_off: not off
valid_index: array_valid_index (i)
ensure CHAIN
swapped_to_item: item = old i_th (i)
swapped_from_item: i_th (i) = old item
feature
linear_representation: LINEAR [PROCEDURE [ANY, EVENT_DATA]]
LINEAR
feature
copy (other: like Current)
other
clone
ARRAY
require ANY
other_not_void: other /= void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
ensure then ARRAY
equal_areas: area.is_equal (other.area)
duplicate (n: INTEGER): like Current
ncountindex
ARRAYED_LIST
require CHAIN
not_off_unless_after: off implies after
valid_subchain: n >= 0
feature
call (event_data: EVENT_DATA)
is_blocked
is_pausedresume
abort
ensure
is_aborted_stack_unchanged: old is_aborted_stack.is_equal (is_aborted_stack)
feature
prune_when_called (an_action: like item)
an_action
require
has (an_action)
feature
empty_actions: ARRAYED_LIST [PROCEDURE [ANY, TUPLE]]
is_emptyis_empty
not_empty_actions: ARRAYED_LIST [PROCEDURE [ANY, TUPLE]]
is_emptyis_empty
feature
do_all (action: PROCEDURE [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]]])
action
action
LINEAR
require TRAVERSABLE
action_exists: action /= void
do_if (action: PROCEDURE [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]]]; test: FUNCTION [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]], BOOLEAN])
actiontest
actiontest
LINEAR
require TRAVERSABLE
action_exists: action /= void
test_exits: test /= void
for_all (test: FUNCTION [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]], BOOLEAN]): BOOLEAN
test
LINEAR
require TRAVERSABLE
test_exits: test /= void
there_exists (test: FUNCTION [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]], BOOLEAN]): BOOLEAN
test
LINEAR
require TRAVERSABLE
test_exits: test /= void
invariant
is_aborted_stack_not_void: is_aborted_stack /= void
call_buffer_not_void: call_buffer /= void
not_has_void: not has (void)
valid_state: state = normal_state or state = paused_state or state = blocked_state
call_buffer_consistent: state = normal_state implies call_buffer.is_empty
not_empty_actions_not_void: not_empty_actions /= void
empty_actions_not_void: empty_actions /= void
ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
ARRAYED_LIST
prunable: prunable
starts_from_one: lower = 1
empty_means_storage_empty: is_empty implies all_default
ARRAY
area_exists: area /= void
consistent_size: capacity = upper - lower + 1
non_negative_count: count >= 0
index_set_has_same_count: valid_index_set
RESIZABLE
increase_by_at_least_one: minimal_increase >= 1
BOUNDED
valid_count: count <= capacity
full_definition: full = (count = capacity)
FINITE
empty_definition: is_empty = (count = 0)
non_negative_count: count >= 0
INDEXABLE
index_set_not_void: index_set /= void
LIST
before_definition: before = (index = 0)
after_definition: after = (index = count + 1)
CHAIN
non_negative_index: index >= 0
index_small_enough: index <= count + 1
off_definition: off = ((index = 0) or (index = count + 1))
isfirst_definition: isfirst = ((not is_empty) and (index = 1))
islast_definition: islast = ((not is_empty) and (index = count))
item_corresponds_to_index: (not off) implies (item = i_th (index))
index_set_has_same_count: index_set.count = count
ACTIVE
writable_constraint: writable implies readable
empty_constraint: is_empty implies (not readable) and (not writable)
BILINEAR
not_both: not (after and before)
before_constraint: before implies off
LINEAR
after_constraint: after implies off
TRAVERSABLE
empty_constraint: is_empty implies off
DYNAMIC_CHAIN
extendible: extendible
indexing
library: "[
EiffelBase: Library of reusable components for Eiffel.
]"
status: "[
Copyright 1986-2001 Interactive Software Engineering (ISE).
For ISE customers the original versions are an ISE product
covered by the ISE Eiffel license and support agreements.
]"
license: "[
EiffelBase may now be used by anyone as FREE SOFTWARE to
develop any product, public-domain or commercial, without
payment to ISE, under the terms of the ISE Free Eiffel Library
License (IFELL) at http://eiffel.com/products/base/license.html.
]"
source: "[
Interactive Software Engineering Inc.
ISE Building
360 Storke Road, Goleta, CA 93117 USA
Telephone 805-685-1006, Fax 805-685-6869
Electronic mail <info@eiffel.com>
Customer support http://support.eiffel.com
]"
info: "[
For latest info see award-winning pages: http://eiffel.com
]"
end -- ACTION_SEQUENCE