note description: "Facility routines to check the validity of TIMEs" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-03-29 12:26:46 +0000 (Wed, 29 Mar 2017) $" revision: "$Revision: 100065 $" class TIME_VALIDITY_CHECKER create default_create feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature {NONE} -- Access compact_time: INTEGER_32 -- Hour, minute, second coded. -- (from TIME_VALUE) Date_time_tools: DATE_TIME_TOOLS -- Tools for outputting dates and times in different formats -- (from TIME_UTILITY) once create Result end default_format_string: STRING_8 -- Default output format string -- (from TIME_UTILITY) do Result := Date_time_tools.Default_format_string end fine_second: REAL_64 -- Representation of second with decimals -- (from TIME_VALUE) do Result := second.to_double + fractional_second end fractional_second: REAL_64 -- Fractional part of fine_second -- (from TIME_VALUE) hour: INTEGER_32 -- Hour of the current time -- (from TIME_VALUE) do Result := (compact_time & Hour_mask) |>> Hour_shift end Hours_in_day: INTEGER_32 = 24 -- Number of hours in a day -- (from TIME_CONSTANTS) micro_second: INTEGER_32 -- Microsecond of the current time -- (from TIME_VALUE) do Result := (fractional_second * 1000000.to_double).truncated_to_integer Result := Result \\ 1000 end milli_second: INTEGER_32 -- Millisecond of the current time -- (from TIME_VALUE) do Result := (fractional_second * 1000.to_double).truncated_to_integer end minute: INTEGER_32 -- Minute of the current time -- (from TIME_VALUE) do Result := (compact_time & Minute_mask) |>> Minute_shift end Minutes_in_hour: INTEGER_32 = 60 -- Number of minutes in an hour -- (from TIME_CONSTANTS) nano_second: INTEGER_32 -- Nanosecond of the current time -- (from TIME_VALUE) do Result := (fractional_second * 1000000000.to_double).truncated_to_integer Result := Result \\ 1000 end second: INTEGER_32 -- Second of the current time -- (from TIME_VALUE) do Result := compact_time & Second_mask end Seconds_in_day: INTEGER_32 = 86400 -- Number of seconds in an hour -- (from TIME_CONSTANTS) Seconds_in_hour: INTEGER_32 = 3600 -- Number of seconds in an hour -- (from TIME_CONSTANTS) Seconds_in_minute: INTEGER_32 = 60 -- Number of seconds in a minute -- (from TIME_CONSTANTS) time_default_format_string: STRING_8 -- Default output format for times -- (from TIME_CONSTANTS) do Result := Date_time_tools.Time_default_format_string end feature -- Access generating_type: TYPE [detachable TIME_VALIDITY_CHECKER] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) external "built_in" ensure -- from ANY generating_type_not_void: Result /= Void end generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) external "built_in" ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty end 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) do if a = Void then Result := b = Void else Result := b /= Void and then a.is_deep_equal (b) end 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) end 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) do if a = Void then Result := b = Void else Result := b /= Void and then a.is_equal (b) end 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)) end frozen is_deep_equal (other: TIME_VALIDITY_CHECKER): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" 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) end is_equal (other: TIME_VALIDITY_CHECKER): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result end 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) do if a = Void then Result := b = Void else Result := b /= Void and then a.standard_is_equal (b) end 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)) end frozen standard_is_equal (other: TIME_VALIDITY_CHECKER): 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 external "built_in" ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) end 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 external "built_in" end 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 external "built_in" ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) end feature {NONE} -- Element change set_fine_second (s: REAL_64) -- Set fine_second to s -- (from TIME_VALUE) require -- from TIME_MEASUREMENT s_large_enough: s >= 0.to_double s_small_enough: s < Seconds_in_minute.to_double local s_tmp: INTEGER_32 do s_tmp := s.truncated_to_integer set_second (s_tmp) fractional_second := s - s_tmp.to_double ensure -- from TIME_MEASUREMENT fine_second_set: fine_second = s end set_fractionals (f: REAL_64) -- Set fractional_second to f. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT f_large_enough: f >= 0.to_double f_small_enough: f < 1.to_double do fractional_second := f ensure -- from TIME_MEASUREMENT second_same: second = old second end set_hour (h: INTEGER_32) -- Set hour to h. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT h_large_enough: h >= 0 h_small_enough: h < Hours_in_day do compact_time := compact_time & Hour_mask.bit_not compact_time := compact_time | (h |<< Hour_shift) ensure -- from TIME_MEASUREMENT hour_set: hour = h end set_minute (m: INTEGER_32) -- Set minute to m. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT m_large_enough: m >= 0 m_small_enough: m < Minutes_in_hour do compact_time := compact_time & Minute_mask.bit_not compact_time := compact_time | (m |<< Minute_shift) ensure -- from TIME_MEASUREMENT minute_set: minute = m end set_second (s: INTEGER_32) -- Set second to s. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT s_large_enough: s >= 0 s_small_enough: s < Seconds_in_minute do compact_time := compact_time & Second_mask.bit_not compact_time := compact_time | s ensure -- from TIME_MEASUREMENT second_set: second = s end feature -- Duplication frozen clone (other: detachable ANY): like other obsolete "Use `twin' instead. [2017-05-31]" -- Void if other is void; otherwise new object -- equal to other -- -- For non-void other, clone calls copy; -- to change copying/cloning semantics, redefine copy. -- (from ANY) do if other /= Void then Result := other.twin end ensure -- from ANY instance_free: class equal: Result ~ other end copy (other: TIME_VALIDITY_CHECKER) -- 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) external "built_in" ensure -- from ANY is_equal: Current ~ other end frozen deep_clone (other: detachable ANY): like other obsolete "Use `deep_twin' instead. [2017-05-31]" -- Void if other is void: otherwise, new object structure -- recursively duplicated from the one attached to other -- (from ANY) do if other /= Void then Result := other.deep_twin end ensure -- from ANY instance_free: class deep_equal: deep_equal (other, Result) end frozen deep_copy (other: TIME_VALIDITY_CHECKER) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void do copy (other.deep_twin) ensure -- from ANY deep_equal: deep_equal (Current, other) end frozen deep_twin: TIME_VALIDITY_CHECKER -- New object structure recursively duplicated from Current. -- (from ANY) external "built_in" ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) end frozen standard_clone (other: detachable ANY): like other obsolete "Use `standard_twin' instead. [2017-05-31]" -- Void if other is void; otherwise new object -- field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) do if other /= Void then Result := other.standard_twin end ensure -- from ANY instance_free: class equal: standard_equal (Result, other) end frozen standard_copy (other: TIME_VALIDITY_CHECKER) -- 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) external "built_in" ensure -- from ANY is_standard_equal: standard_is_equal (other) end frozen standard_twin: TIME_VALIDITY_CHECKER -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) external "built_in" ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) end frozen twin: TIME_VALIDITY_CHECKER -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) external "built_in" ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current end feature {NONE} -- Basic operations div (i, j: INTEGER_32): INTEGER_32 -- (i \\ j) if i positive -- (i \\ j + 1) if i negative -- (from TIME_UTILITY) do Result := i // j if Result.to_double > i / j then Result := Result - 1 end ensure -- from TIME_UTILITY result_definition: i = j * Result + mod (i, j) end mod (i, j: INTEGER_32): INTEGER_32 -- (i \\ j) if i positive -- (i \\ j + j) if i negative -- (from TIME_UTILITY) do Result := i \\ j if Result < 0 then Result := Result + j end ensure -- from TIME_UTILITY positive_result: Result >= 0 result_definition: i = j * div (i, j) + Result end feature -- Basic operations frozen as_attached: attached TIME_VALIDITY_CHECKER obsolete "Remove calls to this feature. [2017-05-31]" -- Attached version of Current. -- (Can be used during transitional period to convert -- non-void-safe classes to void-safe ones.) -- (from ANY) do Result := Current end frozen default: detachable TIME_VALIDITY_CHECKER -- Default value of object's type -- (from ANY) do end frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) do ensure -- from ANY instance_free: class end default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) do end frozen do_nothing -- Execute a null action. -- (from ANY) do ensure -- from ANY instance_free: class end feature {NONE} -- Implementation Hour_mask: INTEGER_32 = 16711680 -- (from TIME_VALUE) Hour_shift: INTEGER_32 = 16 -- (from TIME_VALUE) Minute_mask: INTEGER_32 = 65280 -- (from TIME_VALUE) Minute_shift: INTEGER_32 = 8 -- Shift needed to extract/set hour and minute. -- (from TIME_VALUE) Second_mask: INTEGER_32 = 255 -- Mask used to extract/set hour, minute and second. -- (from TIME_VALUE) feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) once create Result Result.set_output_default ensure -- from ANY instance_free: class io_not_void: Result /= Void end out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) do Result := tagged_out ensure -- from ANY out_not_void: Result /= Void end print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) do if o /= Void then Io.put_string (o.out) end ensure -- from ANY instance_free: class end frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) external "built_in" ensure -- from ANY tagged_out_not_void: Result /= Void end feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) once create Result ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void end feature -- Preconditions compact_time_valid (c_t: INTEGER_32): BOOLEAN -- Is compact time c_t valid? local h, m, s: INTEGER_32 l_c_t: like compact_time do l_c_t := compact_time compact_time := c_t h := hour m := minute s := second compact_time := l_c_t Result := h >= 0 and h < Hours_in_day and m >= 0 and m < Minutes_in_hour and s >= 0 and s < Seconds_in_minute end is_correct_time (h, m: INTEGER_32; s: REAL_64; twelve_hour_scale: BOOLEAN): BOOLEAN -- Is time represented by h, m, code, and s correct? -- twelve_hour_scale specifies if the hour range is 1 - 12 -- (if True) or 0 - 23 (if False). local min_hour: INTEGER_32 max_hour: INTEGER_32 do if twelve_hour_scale then min_hour := 1 max_hour := 12 else min_hour := 0 max_hour := Hours_in_day - 1 end Result := h >= min_hour and h <= max_hour and then m >= 0 and m < Minutes_in_hour and then s >= 0.to_double and s < Seconds_in_minute.to_double end time_valid (s: STRING_8; code_string: STRING_8): BOOLEAN -- Is the code_string enough precise -- to create an instance of type TIME? -- And does the string s correspond to code_string? require s_exists: s /= Void code_exists: code_string /= Void local code: DATE_TIME_CODE_STRING do create code.make (code_string) Result := code.precise_time and code.correspond (s) and then code.is_time (s) end feature {NONE} -- Retrieval frozen internal_correct_mismatch -- Called from runtime to perform a proper dynamic dispatch on correct_mismatch -- from MISMATCH_CORRECTOR. -- (from ANY) local l_msg: STRING_8 l_exc: EXCEPTIONS do if attached {MISMATCH_CORRECTOR} Current as l_corrector then l_corrector.correct_mismatch else create l_msg.make_from_string ("Mismatch: ") create l_exc l_msg.append (generating_type.name) l_exc.raise_retrieval_exception (l_msg) end end invariant -- 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 TIME_VALIDITY_CHECKER
Generated by ISE EiffelStudio