Automatic generation produced by ISE Eiffel
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 (~send_card (?, ?, "Sam") birthday_actions.extend (~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: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" class interface ACTION_SEQUENCE [EVENT_DATA -> TUPLE create make end] create default_create -- Begin in Normal_state. make feature -- Initialization linked_list_make -- Create an empty list. -- (from LINKED_LIST) ensure -- from LINKED_LIST is_before: before feature -- Access cursor: CURSOR -- Current cursor position -- (from LINKED_LIST) dummy_event_data: EVENT_DATA -- Attribute of the generic type. -- Useful for introspection and use in like statements. event_data_names: ARRAY [STRING] -- Textual description of each event datum. ensure equal_to_event_data_names_internal: deep_equal (Result, event_data_names_internal) first: like item -- Item at first position -- (from LINKED_LIST) require -- from CHAIN not_empty: not is_empty has (v: like item): BOOLEAN -- Does chain include v? -- (Reference or object equality, -- based on object_comparison.) -- (from CHAIN) ensure -- from CONTAINER not_found_in_empty: Result implies not is_empty i_th (i: INTEGER): like item -- Item at i-th position -- Was declared in CHAIN as synonym of @. -- (from CHAIN) require -- from TABLE valid_key: valid_index (k) index: INTEGER -- Index of current position -- (from LINKED_LIST) index_of (v: like item; i: INTEGER): INTEGER -- 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 LINKED_LIST) require -- from TRAVERSABLE not_off: not off require -- from ACTIVE readable: readable last: like item -- Item at last position -- (from LINKED_LIST) require -- from CHAIN not_empty: not is_empty name: STRING -- Textual description. ensure equal_to_name_internal: Result.is_equal (name_internal) sequential_occurrences (v: PROCEDURE [ANY, EVENT_DATA]): INTEGER -- Number of times v appears. -- (Reference or object equality, -- based on object_comparison.) -- (from LINEAR) ensure -- from BAG non_negative_occurrences: Result >= 0 infix "@" (i: INTEGER): like item -- Item at i-th position -- Was declared in CHAIN as synonym of i_th. -- (from CHAIN) require -- from TABLE valid_key: valid_index (k) feature -- Measurement count: INTEGER -- Number of items -- (from LINKED_LIST) index_set: INTEGER_INTERVAL -- Range of acceptable indexes -- (from CHAIN) ensure -- from INDEXABLE not_void: Result /= void ensure then -- from CHAIN count_definition: Result.count = count occurrences (v: like item): INTEGER -- Number of times v appears. -- (Reference or object equality, -- based on object_comparison.) -- (from CHAIN) ensure -- from BAG non_negative_occurrences: Result >= 0 occurrences (v: like item): INTEGER -- Number of times v appears. -- (Reference or object equality, -- based on object_comparison.) -- (from CHAIN) ensure -- from BAG non_negative_occurrences: Result >= 0 feature -- Comparison is_equal (other: like Current): 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 feature -- Status report after: BOOLEAN -- Is there no valid cursor position to the right of cursor? -- (from LINKED_LIST) before: BOOLEAN -- Is there no valid cursor position to the left of cursor? -- (from LINKED_LIST) Blocked_state: INTEGER 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) 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 False -- Is structured filled to capacity? (Answer: no.) -- (from LINKED_LIST) is_empty: BOOLEAN -- Is structure empty? -- (from FINITE) is_inserted (v: PROCEDURE [ANY, EVENT_DATA]): BOOLEAN -- Has v been inserted at the end by the most recent put or -- extend? -- (from LINKED_LIST) isfirst: BOOLEAN -- Is cursor at first position? -- (from LINKED_LIST) ensure -- from CHAIN valid_position: Result implies not is_empty islast: BOOLEAN -- Is cursor at last position? -- (from LINKED_LIST) ensure -- from CHAIN valid_position: Result implies not is_empty Normal_state: INTEGER 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 LINKED_LIST) Paused_state: INTEGER is 2 prunable: BOOLEAN -- May items be removed? (Answer: yes.) -- (from DYNAMIC_CHAIN) readable: BOOLEAN -- Is there a current item that may be read? -- (from LINKED_LIST) state: INTEGER -- One of Normal_state Paused_state or Blocked_state valid_cursor (p: CURSOR): BOOLEAN -- Can the cursor be moved to position p? -- (from LINKED_LIST) valid_cursor_index (i: INTEGER): 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): BOOLEAN -- Is i within allowable bounds? -- (from CHAIN) 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) 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 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 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 to previous item. -- (from LINKED_LIST) require -- from BILINEAR not_before: not before finish -- Move cursor to last position. -- (Go before if empty) -- (from LINKED_LIST) ensure then -- from CHAIN at_last: not is_empty implies islast ensure then -- from LINKED_LIST empty_convention: is_empty implies before forth -- Move cursor to next position. -- (from LINKED_LIST) require -- from LINEAR not_after: not after ensure then -- from LIST moved_forth: index = old index + 1 go_i_th (i: INTEGER) -- Move cursor to i-th position. -- (from LINKED_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 LINKED_LIST) require -- from CURSOR_STRUCTURE cursor_position_valid: valid_cursor (p) move (i: INTEGER) -- Move cursor i positions. The cursor -- may end up off if the offset is too big. -- (from LINKED_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) ensure then -- from LINKED_LIST moved_if_inbounds: ((old index + i) >= 0 and (old index + i) <= (count + 1)) implies index = (old index + i) before_set: (old index + i) <= 0 implies before after_set: (old index + i) >= (count + 1) implies after 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 BILINEAR) 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. -- (from LINKED_LIST) ensure then -- from CHAIN at_first: not is_empty implies isfirst ensure then -- from LINKED_LIST empty_convention: is_empty implies after feature -- Element change append (s: SEQUENCE [PROCEDURE [ANY, EVENT_DATA]]) -- Append a copy of s. -- (from SEQUENCE) 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. -- (from LINKED_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 COLLECTION) require -- from COLLECTION other_not_void: other /= void extendible force (v: like item) -- Add v to end. -- (from SEQUENCE) require -- from SEQUENCE extendible: extendible ensure then -- from SEQUENCE new_count: count = old count + 1 item_inserted: has (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: like item) -- Add v to beginning. -- Do not move cursor. -- (from LINKED_LIST) ensure -- from DYNAMIC_CHAIN new_count: count = old count + 1 item_inserted: first = v put_i_th (v: like item; i: INTEGER) -- Put v at i-th position. -- (from CHAIN) require -- from TABLE valid_key: valid_index (k) ensure then -- from INDEXABLE insertion_done: i_th (k) = v put_left (v: like item) -- Add v to the left of cursor position. -- Do not move cursor. -- (from LINKED_LIST) require -- from DYNAMIC_CHAIN extendible: extendible not_before: not before ensure -- from DYNAMIC_CHAIN new_count: count = old count + 1 new_index: index = old index + 1 ensure then -- from LINKED_LIST previous_exists: previous /= void item_inserted: previous.item = v put_right (v: like item) -- Add v to the right of cursor position. -- Do not move cursor. -- (from LINKED_LIST) require -- from DYNAMIC_CHAIN extendible: extendible not_after: not after ensure -- from DYNAMIC_CHAIN new_count: count = old count + 1 same_index: index = old index ensure then -- from LINKED_LIST next_exists: next /= void item_inserted: not old before implies next.item = v item_inserted_before: old before implies active.item = v replace (v: like item) -- Replace current item by v. -- (from LINKED_LIST) require -- from ACTIVE writable: writable ensure -- from ACTIVE item_replaced: item = v feature -- Removal prune (v: like item) -- Remove first occurrence of v, if any, -- after cursor position. -- If found, move cursor to right neighbor; -- if not, make structure exhausted. -- (from DYNAMIC_CHAIN) require -- from COLLECTION prunable: prunable prune_all (v: like item) -- Remove all occurrences of v. -- (Reference or object equality, -- based on object_comparison.) -- Leave structure exhausted. -- (from DYNAMIC_CHAIN) require -- from COLLECTION prunable ensure -- from COLLECTION no_more_occurrences: not has (v) ensure then -- from DYNAMIC_CHAIN is_exhausted: exhausted remove -- Remove current item. -- Move cursor to right neighbor -- (or after if no right neighbor). -- (from LINKED_LIST) require -- from ACTIVE prunable: prunable writable: writable ensure then -- from DYNAMIC_LIST after_when_empty: is_empty implies after remove_left -- Remove item to the left of cursor position. -- Do not move cursor. -- (from LINKED_LIST) require -- from DYNAMIC_CHAIN left_exists: index > 1 require else -- from DYNAMIC_LIST not_before: not before ensure -- from DYNAMIC_CHAIN new_count: count = old count - 1 new_index: index = old index - 1 remove_right -- Remove item to the right of cursor position. -- Do not move cursor. -- (from LINKED_LIST) require -- from DYNAMIC_CHAIN right_exists: index < count ensure -- from DYNAMIC_CHAIN new_count: count = old count - 1 same_index: index = old index feature -- Transformation swap (i: INTEGER) -- Exchange item at i-th position with item -- at cursor position. -- (from CHAIN) require -- from CHAIN not_off: not off valid_index: valid_index (i) ensure -- from CHAIN swapped_to_item: item = old i_th (i) swapped_from_item: i_th (i) = old item feature -- Conversion linear_representation: LINEAR [PROCEDURE [ANY, EVENT_DATA]] -- Representation as a linear structure -- (from LINEAR) feature -- Duplication copy (other: like Current) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from LINKED_LIST) require -- from ANY other_not_void: other /= void type_identity: same_type (other) ensure -- from ANY is_equal: is_equal (other) duplicate (n: INTEGER): like Current -- Copy of sub-chain beginning at current position -- and having min (n, from_here) items, -- where from_here is the number of items -- at or to the right of current position. -- (from DYNAMIC_CHAIN) require -- from CHAIN not_off_unless_after: off implies after valid_subchain: n >= 0 feature -- Basic operations call (event_data: EVENT_DATA) -- Call each procedure in order unless is_blocked. -- If is_paused delay execution until resume. -- Stop at current point in list on abort. ensure is_aborted_stack_unchanged: old is_aborted_stack.is_equal (is_aborted_stack) feature -- Element Change merge_left (other: like Current) -- Merge other into current structure after cursor -- position. Do not move cursor. Empty other require -- from DYNAMIC_CHAIN extendible: extendible not_before: not before other_exists: other /= void 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 ensure then -- from DYNAMIC_LIST other_empty: other.is_empty merge_right (other: like Current) -- Merge other into current structure before cursor -- position. Do not move cursor. Empty other require -- from DYNAMIC_CHAIN extendible: extendible not_after: not after other_exists: other /= void ensure -- from DYNAMIC_CHAIN new_count: count = old count + old other.count same_index: index = old index other_is_empty: other.is_empty ensure then -- from DYNAMIC_LIST other_empty: other.is_empty prune_when_called (an_action: like item) -- Remove an_action after the next time it is called. require has (an_action) wipe_out -- Remove all items. require -- from COLLECTION prunable ensure -- from COLLECTION wiped_out: is_empty ensure then -- from DYNAMIC_LIST is_before: before feature -- Event handling empty_actions: LINKED_LIST [PROCEDURE [ANY, TUPLE]] -- Actions to be performed on transition from not is_empty to is_empty. not_empty_actions: LINKED_LIST [PROCEDURE [ANY, TUPLE]] -- Actions to be performed on transition from is_empty to not is_empty. feature -- Iteration do_all (action: PROCEDURE [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]]]) -- Apply action to every item. -- Semantics not guaranteed if action changes the structure; -- in such a case, apply iterator to clone of structure instead. -- (from LINEAR) require -- from TRAVERSABLE action_exists: action /= void do_if (action: PROCEDURE [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]]]; test: FUNCTION [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]], BOOLEAN]) -- Apply action to every item that satisfies test. -- Semantics not guaranteed if action or test changes the structure; -- in such a case, apply iterator to clone of structure instead. -- (from LINEAR) require -- from TRAVERSABLE action_exists: action /= void test_exits: test /= void for_all (test: FUNCTION [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]], BOOLEAN]): BOOLEAN -- Is test true for all items? -- (from LINEAR) require -- from TRAVERSABLE test_exits: test /= void there_exists (test: FUNCTION [ANY, TUPLE [PROCEDURE [ANY, EVENT_DATA]], BOOLEAN]): BOOLEAN -- Is test true for at least one item? -- (from LINEAR) require -- from 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 -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from LINKED_LIST prunable: prunable empty_constraint: is_empty implies ((first_element = void) and (active = void)) not_void_unless_empty: (active = void) implies is_empty before_constraint: before implies (active = first_element) after_constraint: after implies (active = last_element) -- from LIST before_definition: before = (index = 0) after_definition: after = (index = count + 1) -- from 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 -- from ACTIVE writable_constraint: writable implies readable empty_constraint: is_empty implies (not readable) and (not writable) -- from INDEXABLE index_set_not_void: index_set /= void -- from BILINEAR not_both: not (after and before) before_constraint: before implies off -- from LINEAR after_constraint: after implies off -- from TRAVERSABLE empty_constraint: is_empty implies off -- from FINITE empty_definition: is_empty = (count = 0) non_negative_count: count >= 0 -- from 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 -- class ACTION_SEQUENCE -- Generated by ISE Eiffel --
For more details: www.eiffel.com