indexing
	description: "Handling of input documents through a lexical analyzer"
	status: "See notice at end of class"
	date: "$Date$"
	revision: "$Revision$"

class interface
	INPUT

create 

	make
			-- Create an empty document

feature -- Initialization

	arrayed_list_make (n: INTEGER)
			-- 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

	make_filled (n: INTEGER)
			-- 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 [TOKEN])
			-- Create list from array a.
			-- (from ARRAYED_LIST)
		require -- from ARRAY
			array_exists: a /= void
	
feature -- Access

	analyzer: LEXICAL
			-- Lexical analyzer used

	cursor: CURSOR
			-- Current cursor position
			-- (from ARRAYED_LIST)

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

	has (v: like token): 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

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

	index_of (v: like token; 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

	token: like first
			-- 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)

	i_th (i: INTEGER): TOKEN
			-- Entry at index i, if in index interval
			-- Was declared in ARRAY as synonym of @.
			-- (from ARRAY)
		require -- from TABLE
			valid_key: array_valid_index (k)

	keyword_code (s: STRING): INTEGER
			-- Keyword code corresponding to s;
			-- -1 if no specimen of s is found.
		require
			lex_not_void: analyzer /= void

	keyword_string (code: INTEGER): STRING
			-- Keyword string corresponding to code
		require
			lex_not_void: analyzer /= void

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

	sequential_occurrences (v: TOKEN): INTEGER
			-- Number of times v appears.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from LINEAR)
		ensure -- from BAG
			non_negative_occurrences: Result >= 0

	set_lexical (lexical: LEXICAL)
			-- Designate lexical as the analyzer to be used.
		require
			lex_not_void: lexical /= void

	infix "@" (i: INTEGER): TOKEN
			-- Entry at index i, if in index interval
			-- Was declared in ARRAY as synonym of item.
			-- (from ARRAY)
		require -- from TABLE
			valid_key: array_valid_index (k)
	
feature -- Measurement

	count: INTEGER
			-- Number of items.
			-- (from ARRAYED_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 token): 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 token): 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  -- Measurement

	capacity: INTEGER
			-- Number of available indices
			-- Was declared in ARRAY as synonym of count.
			-- (from ARRAY)
		ensure then -- from ARRAY
			consistent_with_bounds: Result = upper - lower + 1
	
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 LIST)

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

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

	end_of_document: BOOLEAN
			-- Has end of document been reached?

	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)

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

	is_inserted (v: TOKEN): 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

	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)

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

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

	valid_cursor (p: CURSOR): BOOLEAN
			-- Can the cursor be moved to position p?
			-- (from ARRAYED_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 a valid index?
			-- (from ARRAYED_LIST)
		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))

	valid_index (i: INTEGER): BOOLEAN
			-- Is i a valid index?
			-- (from ARRAYED_LIST)
		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

	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

	set_input_file (filename: STRING)
			-- Set the name of the input file to be read
			-- by the lexical analyzer.
		require
			lex_not_void: analyzer /= void
			name_not_void: filename /= void

	set_input_string (stringname: STRING)
			-- Set the name of the input string to be read
			-- by the lexical analyzer.
	
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)
		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)
			-- 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)
			-- 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 token)
			-- 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, token)
			item_found: (not exhausted and not object_comparison) implies v = token

	start
			-- Move cursor to first position if any.
			-- (from ARRAYED_LIST)
		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 [TOKEN])
			-- 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 token)
			-- 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 [TOKEN])
			-- 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 token)
			-- 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 [TOKEN])
			-- Merge other into current structure before cursor.
			-- (from ARRAYED_LIST)
		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: ARRAYED_LIST [TOKEN])
			-- Merge other into current structure after cursor.
			-- (from ARRAYED_LIST)
		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

	put (v: like token)
			-- 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_i_th (v: like i_th; i: INTEGER)
			-- Replace i-th entry, if in index interval, by v.
			-- (from ARRAY)
		require -- from TABLE
			valid_key: array_valid_index (k)
		ensure then -- from INDEXABLE
			insertion_done: i_th (k) = v

	put_front (v: like token)
			-- Add v to the beginning.
			-- Do not move cursor.
			-- (from ARRAYED_LIST)
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + 1
			item_inserted: first = v

	put_left (v: like token)
			-- Add v to the left of current position.
			-- Do not move cursor.
			-- (from ARRAYED_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

	put_right (v: like token)
			-- Add v to the right of current position.
			-- Do not move cursor.
			-- (from ARRAYED_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

	replace (v: like first)
			-- Replace current item by v.
			-- (from ARRAYED_LIST)
		require -- from ACTIVE
			writable: writable
		ensure -- from ACTIVE
			item_replaced: token = v
	
feature -- Removal

	prune (v: like token)
			-- Remove first occurrence of v, if any,
			-- after cursor position.
			-- Move cursor to right neighbor.
			-- (or after if no right neighbor or v does not occur)
			-- (from ARRAYED_LIST)
		require -- from COLLECTION
			prunable: prunable

	prune_all (v: like token)
			-- Remove all occurrences of v.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from ARRAYED_LIST)
		require -- from COLLECTION
			prunable
		ensure -- from COLLECTION
			no_more_occurrences: not has (v)
		ensure then -- from DYNAMIC_CHAIN
			is_exhausted: exhausted
		ensure then -- from ARRAYED_LIST
			is_after: after

	remove
			-- Remove current item.
			-- Move cursor to right neighbor
			-- (or after if no right neighbor)
			-- (from ARRAYED_LIST)
		require -- from ACTIVE
			prunable: prunable
			writable: writable
		ensure then -- from DYNAMIC_LIST
			after_when_empty: is_empty implies after
		ensure then -- from ARRAYED_LIST
			index: index = old index

	remove_left
			-- Remove item to the left of cursor position.
			-- Do not move cursor.
			-- (from ARRAYED_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 ARRAYED_LIST)
		require -- from DYNAMIC_CHAIN
			right_exists: index < count
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count - 1
			same_index: index = old index

	wipe_out
			-- Remove all items.
			-- (from ARRAYED_LIST)
		require -- from COLLECTION
			prunable
		ensure -- from COLLECTION
			wiped_out: is_empty
		ensure then -- from DYNAMIC_LIST
			is_before: before
	
feature -- Transformation

	swap (i: INTEGER)
			-- Exchange item at i-th position with item
			-- at cursor position.
			-- (from ARRAYED_LIST)
		require -- from CHAIN
			not_off: not off
			valid_index: array_valid_index (i)
		ensure -- from CHAIN
			swapped_to_item: token = old i_th (i)
			swapped_from_item: i_th (i) = old token
	
feature -- Conversion

	linear_representation: LINEAR [TOKEN]
			-- Representation as a linear structure
			-- (from LINEAR)
	
feature -- Duplication

	copy (other: like Current)
			-- Reinitialize by copying all the items of other.
			-- (This is also used by clone.)
			-- (from ARRAY)
		require -- from ANY
			other_not_void: other /= void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)
		ensure then -- from ARRAY
			equal_areas: area.is_equal (other.area)

	duplicate (n: INTEGER): like Current
			-- Copy of sub-list beginning at current position
			-- and having min (n, count - index + 1) items.
			-- (from ARRAYED_LIST)
		require -- from CHAIN
			not_off_unless_after: off implies after
			valid_subchain: n >= 0
	
feature -- Initialisation

	make
			-- Create an empty document
	
feature -- Input

	get_token
			-- Make next token accessible with `token'

	retrieve_lex (filename: STRING)
			-- Retrieve analyzer from filename if exists.
		require
			name_not_void: filename /= void
	
feature -- Iteration

	do_all (action: PROCEDURE [ANY, TUPLE [TOKEN]])
			-- 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 [TOKEN]]; test: FUNCTION [ANY, TUPLE [TOKEN], 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 [TOKEN], BOOLEAN]): BOOLEAN
			-- Is test true for all items?
			-- (from LINEAR)
		require -- from TRAVERSABLE
			test_exits: test /= void

	there_exists (test: FUNCTION [ANY, TUPLE [TOKEN], BOOLEAN]): BOOLEAN
			-- Is test true for at least one item?
			-- (from LINEAR)
		require -- from TRAVERSABLE
			test_exits: test /= void
	
feature -- Output

	out_list
			-- Output tokens recognized so far.

	raise_error (s: STRING)
			-- Print error message s.
	
invariant

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)
		-- from ARRAYED_LIST
	prunable: prunable
	starts_from_one: lower = 1
	empty_means_storage_empty: is_empty implies all_default
		-- from ARRAY
	area_exists: area /= void
	consistent_size: capacity = upper - lower + 1
	non_negative_count: count >= 0
	index_set_has_same_count: valid_index_set
		-- from RESIZABLE
	increase_by_at_least_one: minimal_increase >= 1
		-- from BOUNDED
	valid_count: count <= capacity
	full_definition: full = (count = capacity)
		-- from FINITE
	empty_definition: is_empty = (count = 0)
	non_negative_count: count >= 0
		-- from INDEXABLE
	index_set_not_void: index_set /= void
		-- 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 (token = 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 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 DYNAMIC_CHAIN
	extendible: extendible

end -- class INPUT