note
	description: "String to real/double convertor"
	library: "Free implementation of ELKS library"
	status: "See notice at end of class."
	legal: "See notice at end of class."
	date: "$Date: 2017-03-23 19:18:26 +0000 (Thu, 23 Mar 2017) $"
	revision: "$Revision: 100033 $"

frozen class interface
	STRING_TO_REAL_CONVERTOR

create 
	make
			-- Initialize.
		ensure
			leading_separators_set: leading_separators ~ " "
			trailing_separators_set: trailing_separators ~ " "
			leading_separators_not_acceptable: not leading_separators_acceptable
			trailing_separatorsnot_acceptable: not trailing_separators_acceptable

feature -- Access

	generating_type: TYPE [detachable STRING_TO_REAL_CONVERTOR]
			-- Type of current object
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void

	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
	
feature -- Comparison

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

	frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b))

	frozen is_deep_equal alias "≡≡≡" (other: STRING_TO_REAL_CONVERTOR): 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: STRING_TO_REAL_CONVERTOR): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b 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
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b))

	frozen standard_is_equal alias "≜" (other: STRING_TO_REAL_CONVERTOR): 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

	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

	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))
	
feature -- Status setting

	reset (type: INTEGER_32)
			-- Reset current convertor to parse real number string of type type.
		require -- from STRING_TO_NUMERIC_CONVERTOR
			type_valid: conversion_type_valid (type)
		ensure -- from STRING_TO_NUMERIC_CONVERTOR
			last_state_set: last_state = 0
			sign_set: sign = 0
			conversion_type_set: conversion_type = type
			not_overflowed: not overflowed
			not_underflowed: not underflowed
			parse_successful: parse_successful
		ensure then
			natural_part_set: natural_part = 0.to_double
			fractional_part_set: fractional_part = 0.to_double
			fractional_divider_set: fractional_divider = 0.to_double
			exponent_set: exponent = 0
			is_negative_set: not is_negative
			has_negative_exponent_set: not has_negative_exponent
			has_fractional_part_set: not has_fractional_part
			needs_digit_set: not needs_digit

	set_leading_separators (separators: STRING_8)
			-- Set leading_separators with separators.
			-- (from STRING_TO_NUMERIC_CONVERTOR)
		require -- from STRING_TO_NUMERIC_CONVERTOR
			separators_not_void: separators /= Void
			separators_valid: separators_valid (separators)
		ensure -- from STRING_TO_NUMERIC_CONVERTOR
			leading_separators_set: leading_separators ~ separators

	set_leading_separators_acceptable (b: BOOLEAN)
			-- Set leading_separators_acceptable to b.
			-- (from STRING_TO_NUMERIC_CONVERTOR)
		ensure -- from STRING_TO_NUMERIC_CONVERTOR
			leading_separators_acceptable_set: leading_separators_acceptable = b

	set_trailing_separators (separators: STRING_8)
			-- Set trailing_separators with separators.
			-- (from STRING_TO_NUMERIC_CONVERTOR)
		require -- from STRING_TO_NUMERIC_CONVERTOR
			separators_not_void: separators /= Void
			separators_valid: separators_valid (separators)
		ensure -- from STRING_TO_NUMERIC_CONVERTOR
			trailing_separators_set: trailing_separators ~ separators

	set_trailing_separators_acceptable (b: BOOLEAN)
			-- Set trailing_separators_acceptable to b.
			-- (from STRING_TO_NUMERIC_CONVERTOR)
		ensure -- from STRING_TO_NUMERIC_CONVERTOR
			trailing_separators_acceptable_set: trailing_separators_acceptable = b
	
feature -- Duplication

	copy (other: STRING_TO_REAL_CONVERTOR)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: Current ~ other

	frozen deep_copy (other: STRING_TO_REAL_CONVERTOR)
			-- Effect equivalent to that of:
			--		copy (other . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: STRING_TO_REAL_CONVERTOR
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: STRING_TO_REAL_CONVERTOR)
			-- Copy every field of other onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: STRING_TO_REAL_CONVERTOR
			-- New object field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: STRING_TO_REAL_CONVERTOR
			-- New object equal to Current
			-- twin calls copy; to change copying/twinning semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result ~ Current
	
feature -- Basic operations

	frozen default: detachable STRING_TO_REAL_CONVERTOR
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type POINTER
			-- (Avoid the need to write p.default for
			-- some p of type POINTER.)
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			out_not_void: Result /= Void

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			tagged_out_not_void: Result /= Void
	
feature -- Parse

	parse_character (c: CHARACTER_8)
			-- Parse character c.

	parse_string_with_type (s: READABLE_STRING_GENERAL; type: INTEGER_32)
			-- Parse string s as real number of type type.
		require -- from STRING_TO_NUMERIC_CONVERTOR
			s_not_void: s /= Void
			type_valid: conversion_type_valid (type)
	
feature -- Platform

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
	
feature -- Status reporting

	conversion_type: INTEGER_32
			-- Type to which a string will be converted
			-- See NUMERIC_INFORMATION for more information.
			-- (from STRING_TO_NUMERIC_CONVERTOR)

	conversion_type_valid (type: INTEGER_32): BOOLEAN
			-- Is conversion type type valid?

	is_integral_double: BOOLEAN
			-- Is character sequence that has been parsed represents a valid double?

	is_integral_real: BOOLEAN
			-- Is character sequence that has been parsed represents a valid real?	

	is_part_of_double: BOOLEAN
			-- Is character sequence that has been parsed so far a valid start part of double?

	is_part_of_real: BOOLEAN
			-- Is character sequence that has been parsed so far a valid start part of real?

	leading_separators: STRING_8
			-- Leading separators
			-- (from STRING_TO_NUMERIC_CONVERTOR)

	leading_separators_acceptable: BOOLEAN
			-- Are leading separators acceptable?
			-- (from STRING_TO_NUMERIC_CONVERTOR)

	overflowed: BOOLEAN
			-- Is real number parsed so far overflowed?

	parse_successful: BOOLEAN
			-- This only means we didn't enter an invalid state when parsing,
			-- it doesn't mean that we have got an valid double/real number.
			-- You need to check is_double or is_real.

	parsed_double: REAL_64
			-- Parsed double value

	parsed_real: REAL_32
			-- Parsed real value

	separators_valid (separators: STRING_8): BOOLEAN
			-- Are separators contained in separators valid?
		require -- from STRING_TO_NUMERIC_CONVERTOR
			separators_not_void: separators /= Void

	trailing_separators: STRING_8
			-- Trailing separators
			-- (from STRING_TO_NUMERIC_CONVERTOR)

	trailing_separators_acceptable: BOOLEAN
			-- Are trailing separators acceptable?
			-- (from STRING_TO_NUMERIC_CONVERTOR)

	underflowed: BOOLEAN
			-- Is real number parsed so far underflowed?
	
feature -- Type checking

	double_type_valid (type: INTEGER_32): BOOLEAN
			-- Is type a valid double type?
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	integer_natural_type_valid (type: INTEGER_32): BOOLEAN
			-- Is type a valid integer/natural type?
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	integer_type_valid (type: INTEGER_32): BOOLEAN
			-- Is type a valid integer type?
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	natural_type_valid (type: INTEGER_32): BOOLEAN
			-- Is type a valid natural type?
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	real_double_type_valid (type: INTEGER_32): BOOLEAN
			-- Is type a valid real/double type?
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	real_type_valid (type: INTEGER_32): BOOLEAN
			-- Is type a valid real type?
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class
	
feature -- Types

	max_integer_type: INTEGER_64
			-- INTEGER type of max word length
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	max_natural_type: NATURAL_64
			-- NATURAL type of max word length
			-- (from NUMERIC_INFORMATION)
		ensure -- from NUMERIC_INFORMATION
			instance_free: class

	Type_count: INTEGER_32 = 4
			-- Number of types of integer/natural in Eiffel
			-- (from NUMERIC_INFORMATION)

	Type_double: INTEGER_32 = 101
			-- Real/Double type indicators
			-- (from NUMERIC_INFORMATION)

	Type_integer: INTEGER_32 = 3
			-- Was declared in NUMERIC_INFORMATION as synonym of Type_integer_32.
			-- (from NUMERIC_INFORMATION)

	Type_integer_16: INTEGER_32 = 2
			-- (from NUMERIC_INFORMATION)

	Type_integer_32: INTEGER_32 = 3
			-- Was declared in NUMERIC_INFORMATION as synonym of Type_integer.
			-- (from NUMERIC_INFORMATION)

	Type_integer_64: INTEGER_32 = 4
			-- (from NUMERIC_INFORMATION)

	Type_integer_8: INTEGER_32 = 1
			-- (from NUMERIC_INFORMATION)

	Type_integer_natural_separator: INTEGER_32 = 10
			-- (from NUMERIC_INFORMATION)

	Type_natural: INTEGER_32 = 13
			-- Was declared in NUMERIC_INFORMATION as synonym of Type_natural_32.
			-- (from NUMERIC_INFORMATION)

	Type_natural_16: INTEGER_32 = 12
			-- (from NUMERIC_INFORMATION)

	Type_natural_32: INTEGER_32 = 13
			-- Was declared in NUMERIC_INFORMATION as synonym of Type_natural.
			-- (from NUMERIC_INFORMATION)

	Type_natural_64: INTEGER_32 = 14
			-- Integer/natural type indicators
			-- (from NUMERIC_INFORMATION)

	Type_natural_8: INTEGER_32 = 11
			-- (from NUMERIC_INFORMATION)

	Type_no_limitation: INTEGER_32 = 0
			-- Type representing a number sequence (no length limitation)
			-- (from NUMERIC_INFORMATION)

	Type_real: INTEGER_32 = 100
			-- (from NUMERIC_INFORMATION)
	
invariant
		-- from STRING_TO_NUMERIC_CONVERTOR
	leading_separators_not_void: leading_separators /= Void
	trailing_separators_not_void: trailing_separators /= Void

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

note
	copyright: "Copyright (c) 1984-2017, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		5949 Hollister Ave., Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class STRING_TO_REAL_CONVERTOR

Generated by ISE EiffelStudio