indexing
	description: "A sequence of actions to be performed on call"
	legal: "See notice at end of class."
	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: 2008-05-05 05:26:45 -0700 (Mon, 05 May 2008) $"
	revision: "$Revision: 73316 $"

class interface
	ACTION_SEQUENCE [EVENT_DATA -> TUPLE create default_create end]


create 
	default_create
			-- Begin in Normal_state.

	make


create {ACTION_SEQUENCE}
	array_make (min_index, max_index: INTEGER_32)
			-- Allocate array; set index interval to
			-- `min_index' .. `max_index'; set all values to default.
			-- (Make array empty if `min_index' = `max_index' + 1).
			-- (from ARRAY)
		require -- from ARRAY
			valid_bounds: min_index <= max_index + 1
		ensure -- from ARRAY
			lower_set: lower = min_index
			upper_set: upper = max_index
			items_set: all_default

	arrayed_list_make (n: INTEGER_32)
			-- Allocate list with `n' items.
			-- (`n' may be zero for empty list.)
			-- (from ARRAYED_LIST)
		require -- from ARRAYED_LIST
			valid_number_of_items: n >= 0
		ensure -- from ARRAYED_LIST
			correct_position: before
			is_empty: is_empty

	make_filled (n: INTEGER_32)
			-- Allocate list with `n' items.
			-- (`n' may be zero for empty list.)
			-- This list will be full.
			-- (from ARRAYED_LIST)
		require -- from ARRAYED_LIST
			valid_number_of_items: n >= 0
		ensure -- from ARRAYED_LIST
			correct_position: before
			filled: full

feature -- Initialization

	arrayed_list_make (n: INTEGER_32)
			-- Allocate list with `n' items.
			-- (`n' may be zero for empty list.)
			-- (from ARRAYED_LIST)
		require -- from ARRAYED_LIST
			valid_number_of_items: n >= 0
		ensure -- from ARRAYED_LIST
			correct_position: before
			is_empty: is_empty

	make_filled (n: INTEGER_32)
			-- Allocate list with `n' items.
			-- (`n' may be zero for empty list.)
			-- This list will be full.
			-- (from ARRAYED_LIST)
		require -- from ARRAYED_LIST
			valid_number_of_items: n >= 0
		ensure -- from ARRAYED_LIST
			correct_position: before
			filled: full

	make_from_array (a: ARRAY [PROCEDURE [ANY, EVENT_DATA]])
			-- Create list from array `a'.
			-- (from ARRAYED_LIST)
		require -- from ARRAY
			array_exists: a /= Void
		ensure then -- from ARRAYED_LIST
			correct_position: before
			filled: count = a.count
	
feature -- Access

	cursor: ARRAYED_LIST_CURSOR
			-- Current cursor position
			-- (from ARRAYED_LIST)
		ensure -- from CURSOR_STRUCTURE
			cursor_not_void: Result /= Void

	first: like item
			-- Item at first position
			-- (from ARRAYED_LIST)
		require -- from CHAIN
			not_empty: not is_empty

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void
			generating_type_not_empty: not Result.is_empty

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty

	has (v: like item): BOOLEAN
			-- Does current include `v'?
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from ARRAYED_LIST)
		require -- from  CONTAINER
			True
		ensure -- from CONTAINER
			not_found_in_empty: Result implies not is_empty

	i_th alias "[]" (i: INTEGER_32): like item assign put_i_th
			-- Item at `i'-th position
			-- Was declared in ARRAYED_LIST as synonym of infix "@".
			-- (from ARRAYED_LIST)
		require -- from TABLE
			valid_key: valid_index (i)

	index: INTEGER_32
			-- Index of item, if valid.
			-- (from ARRAYED_LIST)

	index_of (v: like item; i: INTEGER_32): INTEGER_32
			-- Index of `i'-th occurrence of item identical to `v'.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- 0 if none.
			-- (from CHAIN)
		require -- from LINEAR
			positive_occurrences: i > 0
		ensure -- from LINEAR
			non_negative_result: Result >= 0

	item: PROCEDURE [ANY, EVENT_DATA]
			-- Current item
			-- (from ARRAYED_LIST)
		require -- from TRAVERSABLE
			not_off: not off
		require -- from ACTIVE
			readable: readable
		require else -- from ARRAYED_LIST
			index_is_valid: valid_index (index)

	item_for_iteration: PROCEDURE [ANY, EVENT_DATA]
			-- Item at current position
			-- (from LINEAR)
		require -- from LINEAR
			not_off: not off

	last: like first
			-- Item at last position
			-- (from ARRAYED_LIST)
		require -- from CHAIN
			not_empty: not is_empty

	name: ?STRING_8
			-- Textual description.
		ensure
			equal_to_name_internal: equal (Result, name_internal)

	sequential_occurrences (v: like item): INTEGER_32
			-- Number of times `v' appears.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from LINEAR)
		require -- from  BAG
			True
		ensure -- from BAG
			non_negative_occurrences: Result >= 0

	infix "@" (i: INTEGER_32): like item assign put_i_th
			-- Item at `i'-th position
			-- Was declared in ARRAYED_LIST as synonym of i_th.
			-- (from ARRAYED_LIST)
		require -- from TABLE
			valid_key: valid_index (i)
	
feature -- Measurement

	capacity: INTEGER_32
			-- Number of available indices
			-- Was declared in ARRAY as synonym of count.
			-- (from ARRAY)
		require -- from  BOUNDED
			True
		ensure then -- from ARRAY
			consistent_with_bounds: Result = upper - lower + 1

	count: INTEGER_32
			-- Number of items.
			-- (from ARRAYED_LIST)

	index_set: INTEGER_INTERVAL
			-- Range of acceptable indexes
			-- (from CHAIN)
		require -- from  INDEXABLE
			True
		ensure -- from INDEXABLE
			not_void: Result /= Void
		ensure then -- from CHAIN
			count_definition: Result.count = count

	occurrences (v: like item): INTEGER_32
			-- Number of times `v' appears.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from CHAIN)
		require -- from  BAG
			True
		require -- from  LINEAR
			True
		ensure -- from BAG
			non_negative_occurrences: Result >= 0
	
feature -- Comparison

	frozen deep_equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies (other /= Void and then some.same_type (other))
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	frozen is_deep_equal (other: ACTION_SEQUENCE [EVENT_DATA]): BOOLEAN
			-- Are `Current' and `other' attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)

	is_equal (other: ACTION_SEQUENCE [EVENT_DATA]): BOOLEAN
			-- Does `other' contain the same elements?
			-- (from LIST)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result
		ensure then -- from LIST
			indices_unchanged: index = old index and other.index = old other.index
			true_implies_same_size: Result implies count = other.count

	frozen standard_equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: ACTION_SEQUENCE [EVENT_DATA]): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	after: BOOLEAN
			-- Is there no valid cursor position to the right of cursor?
			-- (from LIST)
		require -- from  LINEAR
			True

	before: BOOLEAN
			-- Is there no valid cursor position to the left of cursor?
			-- (from LIST)
		require -- from  BILINEAR
			True

	blocked_state: INTEGER_32 is 3

	call_is_underway: BOOLEAN
			-- Is call currently being executed?
		ensure
			Result = not is_aborted_stack.is_empty

	changeable_comparison_criterion: BOOLEAN
			-- May object_comparison be changed?
			-- (Answer: yes by default.)
			-- (from CONTAINER)

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	exhausted: BOOLEAN
			-- Has structure been completely explored?
			-- (from LINEAR)
		ensure -- from LINEAR
			exhausted_when_off: off implies Result

	extendible: BOOLEAN is True
			-- May new items be added? (Answer: yes.)
			-- (from DYNAMIC_CHAIN)

	full: BOOLEAN
			-- Is structure filled to capacity?
			-- (from ARRAYED_LIST)
		require -- from  BOX
			True

	is_empty: BOOLEAN
			-- Is structure empty?
			-- (from FINITE)
		require -- from  CONTAINER
			True

	is_inserted (v: PROCEDURE [ANY, EVENT_DATA]): BOOLEAN
			-- Has `v' been inserted at the end by the most recent put or
			-- extend?
			-- (from ARRAYED_LIST)

	isfirst: BOOLEAN
			-- Is cursor at first position?
			-- (from CHAIN)
		ensure -- from CHAIN
			valid_position: Result implies not is_empty

	islast: BOOLEAN
			-- Is cursor at last position?
			-- (from CHAIN)
		ensure -- from CHAIN
			valid_position: Result implies not is_empty

	normal_state: INTEGER_32 is 1

	object_comparison: BOOLEAN
			-- Must search operations use equal rather than `='
			-- for comparing references? (Default: no, use `='.)
			-- (from CONTAINER)

	off: BOOLEAN
			-- Is there no current item?
			-- (from CHAIN)
		require -- from  TRAVERSABLE
			True

	paused_state: INTEGER_32 is 2

	prunable: BOOLEAN
			-- May items be removed? (Answer: yes.)
			-- (from ARRAYED_LIST)
		require -- from  COLLECTION
			True

	readable: BOOLEAN
			-- Is there a current item that may be read?
			-- (from SEQUENCE)
		require -- from  ACTIVE
			True

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))

	state: INTEGER_32
			-- One of Normal_state Paused_state or Blocked_state

	valid_cursor (p: CURSOR): BOOLEAN
			-- Can the cursor be moved to position `p'?
			-- (from ARRAYED_LIST)

	valid_cursor_index (i: INTEGER_32): BOOLEAN
			-- Is `i' correctly bounded for cursor movement?
			-- (from CHAIN)
		ensure -- from CHAIN
			valid_cursor_index_definition: Result = ((i >= 0) and (i <= count + 1))

	valid_index (i: INTEGER_32): BOOLEAN
			-- Is `i' a valid index?
			-- (from ARRAYED_LIST)
		require -- from  TABLE
			True
		require -- from  TO_SPECIAL
			True
		ensure then -- from INDEXABLE
			only_if_in_index_set: Result implies ((i >= index_set.lower) and (i <= index_set.upper))
		ensure then -- from CHAIN
			valid_index_definition: Result = ((i >= 1) and (i <= count))

	writable: BOOLEAN
			-- Is there a current item that may be modified?
			-- (from SEQUENCE)
		require -- from  ACTIVE
			True
	
feature -- Status setting

	abort
			-- Abort the current call.
			-- (The current item.call will be completed.)
		require
			call_is_underway: call_is_underway
		ensure
			is_aborted_set: is_aborted_stack.item

	block
			-- Ignore subsequent calls.
		ensure
			blocked_state: state = blocked_state

	compare_objects
			-- Ensure that future search operations will use equal
			-- rather than `=' for comparing references.
			-- (from CONTAINER)
		require -- from CONTAINER
			changeable_comparison_criterion: changeable_comparison_criterion
		ensure -- from CONTAINER
			object_comparison

	compare_references
			-- Ensure that future search operations will use `='
			-- rather than equal for comparing references.
			-- (from CONTAINER)
		require -- from CONTAINER
			changeable_comparison_criterion: changeable_comparison_criterion
		ensure -- from CONTAINER
			reference_comparison: not object_comparison

	flush
			-- Discard any buffered calls.
		ensure
			call_buffer_empty: call_buffer.is_empty

	pause
			-- Buffer subsequent calls for later execution.
			-- If `is_blocked' calls will simply be ignored.
		ensure
			paused_state: state = paused_state

	resume
			-- Used after block or pause to resume normal call
			-- execution.  Executes any buffered calls.
		ensure
			normal_state: state = normal_state
	
feature -- Cursor movement

	back
			-- Move cursor one position backward.
			-- (from ARRAYED_LIST)
		require -- from BILINEAR
			not_before: not before

	finish
			-- Move cursor to last position if any.
			-- (from ARRAYED_LIST)
		require -- from  LINEAR
			True
		ensure then -- from CHAIN
			at_last: not is_empty implies islast
		ensure then -- from ARRAYED_LIST
			before_when_empty: is_empty implies before

	forth
			-- Move cursor one position forward.
			-- (from ARRAYED_LIST)
		require -- from LINEAR
			not_after: not after
		ensure then -- from LIST
			moved_forth: index = old index + 1

	go_i_th (i: INTEGER_32)
			-- Move cursor to `i'-th position.
			-- (from ARRAYED_LIST)
		require -- from CHAIN
			valid_cursor_index: valid_cursor_index (i)
		ensure -- from CHAIN
			position_expected: index = i

	go_to (p: CURSOR)
			-- Move cursor to position `p'.
			-- (from ARRAYED_LIST)
		require -- from CURSOR_STRUCTURE
			cursor_position_valid: valid_cursor (p)

	move (i: INTEGER_32)
			-- Move cursor `i' positions.
			-- (from ARRAYED_LIST)
		ensure -- from 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)
			-- Move to first position (at or after current
			-- position) where item and `v' are equal.
			-- If structure does not include `v' ensure that
			-- exhausted will be true.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from ARRAYED_LIST)
		require -- from  LINEAR
			True
		ensure -- from LINEAR
			object_found: (not exhausted and object_comparison) implies equal (v, item)
			item_found: (not exhausted and not object_comparison) implies v = item

	start
			-- Move cursor to first position if any.
			-- (from ARRAYED_LIST)
		require -- from  TRAVERSABLE
			True
		ensure then -- from CHAIN
			at_first: not is_empty implies isfirst
		ensure then -- from ARRAYED_LIST
			after_when_empty: is_empty implies after
	
feature -- Element change

	append (s: SEQUENCE [PROCEDURE [ANY, EVENT_DATA]])
			-- Append a copy of `s'.
			-- (from ARRAYED_LIST)
		require -- from SEQUENCE
			argument_not_void: s /= Void
		ensure -- from SEQUENCE
			new_count: count >= old count

	extend (v: like item)
			-- Add `v' to end.
			-- Do not move cursor.
			-- Was declared in ARRAYED_LIST as synonym of force.
			-- (from ARRAYED_LIST)
		require -- from COLLECTION
			extendible: extendible
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)
		ensure then -- from BAG
			one_more_occurrence: occurrences (v) = old (occurrences (v)) + 1

	fill (other: CONTAINER [PROCEDURE [ANY, EVENT_DATA]])
			-- Fill with as many items of `other' as possible.
			-- The representations of `other' and current structure
			-- need not be the same.
			-- (from CHAIN)
		require -- from COLLECTION
			other_not_void: other /= Void
			extendible: extendible

	force (v: like item)
			-- Add `v' to end.
			-- Do not move cursor.
			-- Was declared in ARRAYED_LIST as synonym of extend.
			-- (from ARRAYED_LIST)
		require -- from SEQUENCE
			extendible: extendible
		ensure then -- from SEQUENCE
			new_count: count = old count + 1
			item_inserted: has (v)

	merge_left (other: ARRAYED_LIST [PROCEDURE [ANY, EVENT_DATA]])
			-- Merge `other' into current structure before cursor.
			-- (from ARRAYED_LIST)
		require -- from DYNAMIC_CHAIN
			extendible: extendible
			not_before: not before
			other_exists: other /= Void
			not_current: other /= Current
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + old other.count
			new_index: index = old index + old other.count
			other_is_empty: other.is_empty

	merge_right (other: ARRAYED_LIST [PROCEDURE [ANY, EVENT_DATA]])
			-- Merge `other' into current structure after cursor.
			-- (from ARRAYED_LIST)
		require -- from DYNAMIC_CHAIN
			extendible: extendible
			not_after: not after
			other_exists: other /= Void
			not_current: other /= Current
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + old other.count
			same_index: index = old index
			other_is_empty: other.is_empty

	put_i_th (v: like i_th; i: INTEGER_32)
			-- Replace `i'-th entry, if in index interval, by `v'.
			-- (from ARRAY)
		require -- from TABLE
			valid_key: valid_index (i)
		require -- from TO_SPECIAL
			valid_index: valid_index (i)
		ensure then -- from INDEXABLE
			insertion_done: i_th (i) = v
		ensure -- from TO_SPECIAL
			inserted: array_item (i) = v

	put (v: like item)
			-- Replace current item by `v'.
			-- (Synonym for replace)
			-- (from CHAIN)
		require -- from COLLECTION
			extendible: extendible
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)
		ensure then -- from CHAIN
			same_count: count = old count

	put_front (v