immutable class CURSOR_ERRORS < $ENUMS{CURSOR_ERRORS}
****

________This_is_an_enumeration_class_which_describes_the_different
___units_of_measurement_which_may_be_used_for_import/export_of_data_values.
___Note_that_it_provides_an_ordered_domain.

________The_strings_to_be_read_into_the_Names_array_are_expected_to_be
___culturally_appropriate_strings_having_the_following_meanings_--

________The_item_found_was_expected_to_be_a_digit_but_is_not.

________An_attempt_has_been_made_to_go_beyond_the_end_of_the_buffer.

________An_attempt_has_been_made_to_go_before_the_start_of_the_buffer.

________During_an_attempt_to_convert_buffer_contents_to_a_value_of_some
________class_the_conversion_could_not_be_carried_out_because_of
________implementation_limitations_(eg_cardinal_number_out_of_implemented
________range).

________During_a_buffer_search_the_element_being_sought_was_not_found.

________During_an_attempt_to_convert_from_buffer_contents_to_a_value_of
________some_class_an_item_not_conforming_to_the_expected_syntax_for
________such_a_value_was_encountered.

________During_an_attempt_to_skip_past_some_item_in_the_buffer_the_end_of
________buffer_was_encountered.

________An_attempt_to_advance_by_an_item_has_occurred_when_the_end_had
________already_been_reached.


Ancestors
$ENUMS{_} $BINARY $NIL $IS_NIL
$ANCHORED_FMT $FMT $STR $TEXT
$HASH $IS_EQ



Public


Readable Attributes
attr enum : CARD ; .. Included as enum
**** Used also for transforming an enum to a cardinal value.

Constants
const cardinality : CARD := val_count ; .. Included as cardinality
**** the default value!
const offset : CARD := 1 ; .. Included as offset
****
________This_is_the_offset_from_the_index_of_first_element_of_the_Names_array
___(ie_zero)_to_the_first_enumeration_value_numeric_code.

Features
Already_at_End : SAME
Bad_Block : SAME
Conversion_Error : SAME
Element_Not_Found : SAME
Format_Error : SAME
Not_Digit : SAME
Past_Beginning : SAME
Past_End : SAME
binstr : BINSTR .. Included as binstr
build(cursor : BIN_CURSOR) : SAME .. Included as build
build( loc_cursor : STR_CURSOR ) : SAME .. Included as build
card : CARD .. Included as card
create(str : BINSTR) : SAME .. Included as create
create(num : CARD) : SAME .. Included as create
create( str : STR ) : SAME .. Included as create
****
________This_is_the_creation_routine_from_a_string_which_is_any_of_the
___abbreviations_listed_in_the_Name_table.____If_the_name_table_has_not_been
___read_in_this_is_done_first.
fmt( format : ANCHORED_DESCR ) : STR .. Included as fmt
fmt( format : ANCHORED_DESCR, lib : LIBCHARS ) : STR .. Included as fmt
hash : CARD .. Included as hash
is_enum( str : STR ) : CONVERSION_RESULTS .. Included as is_enum
is_eq(other : SAME) : BOOL .. Included as is_eq
****
________This_predicate_returns_true_if_and_only_if_self_and_other_are_the_same
___value_except_if_either_is_void_when_false_is_returned_identically.
is_eq(other : $OB) : BOOL .. Included as is_eq
**** This is the generic equality predicate. c.f. the class $IS_EQ
is_nil : BOOL .. Included as is_nil
****
________This_predicate_returns_true_if_and_only_if_self_is_'void'.
nil : SAME .. Included as nil
****
________This_feature_returns_a_value_which_is_a_'void'_for_the_enumeration.
___The_language-defined_void_may_be_implemented_differently.
read(index : BIN_CURSOR) : SAME .. Included as read
str( lib : LIBCHARS ) : STR .. Included as str
****
________This_routine_provides_a_string_representation_of_self_in_the_given
___character_repertoire_and_encoding_-_including_a_nil_value.
str : STR .. Included as str
****
________This_routine_provides_a_string_representation_of_self_in_the_default
___character_repertoire_and_encoding_-_including_a_nil_value.
write(fyle : BIN_FILE) .. Included as write

Iters
elt! : SAME .. Included as elt!
****
________This_iter_yields_in_turn_all_of_the_values_in_the_domain_of_the__enumeration.


Private

const Max_Val : CARD := val_count ; .. Included as Max_Val
shared Names : ARRAY{STR} ; .. Included as Names
**** for external representation!
shared Names : ARRAY{STR} ; .. Included as Names
**** for external representation!
check_names( loc_lib : LIBCHARS ) .. Included as check_names
attr enum : CARD ; .. Included as enum
**** Used also for transforming an enum to a cardinal value.
equals(first_lcase,second : STR) : BOOL .. Included as equals
**** This routine tests for string equality up to the length of first! The test is case independent.
shared lib : LIBCHARS ; .. Included as lib
shared lib : LIBCHARS ; .. Included as lib
lookup(str : STR) : CARD .. Included as lookup
scan!(str : STR) : CARD .. Included as scan!
const val_count : CARD := 8 ;
****
________The_next_routines_provide_the_enumeration_itself.

The Sather Home Page