note description: "Absolute temporal values composed of a date and a time" 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 $" access: date, time eis: "name=Obtaining a DATE from a DATE_TIME and vice versa", "src=$(ISE_DOC_UUID)/195849fc-1a9c-d734-2d2b-acae78133886#Obtaining_a_DATE_from_a_DATE_TIME_and_vice_versa", "tag=EiffelTime" eis: "name=DATE / TIME to STRING Conversion", "src=$(ISE_DOC_UUID)/88972ba4-694b-8558-b0c8-87b1fc40afc4", "tag=EiffelTime" class DATE_TIME create make, make_fine, make_by_date_time, make_by_date, make_now, make_now_utc, make_from_epoch, make_from_string, make_from_string_with_base, make_from_string_default, make_from_string_default_with_base feature -- Initialization make (y, mo, d, h, mi, s: INTEGER_32) -- Set year, month day to y, mo, d. -- Set hour, minute, second to h, mi, s. require correct_date_time: is_correct_date_time (y, mo, d, h, mi, s.to_double, False) do create date.make (y, mo, d) create time.make (h, mi, s) ensure year_set: year = y month_set: month = mo day_set: day = d hour_set: hour = h minute_set: minute = mi second_set: second = s end make_by_date (d: DATE) -- Set date to d and time to origin of time. require d_exists: d /= Void do date := d create time.make (0, 0, 0) ensure date_set: date = d time_set: time.is_equal (time.Origin) end make_by_date_time (d: DATE; t: TIME) -- Set date to d and time to t require d_exists: d /= Void t_exists: t /= Void do date := d time := t ensure date_set: date = d time_set: time = t end make_fine (y, mo, d, h, mi: INTEGER_32; s: REAL_64) -- Set year, month day to y, mo, d. -- Set hour, minute, second to h, m, s. require correct_date_time: is_correct_date_time (y, mo, d, h, mi, s, False) do create date.make (y, mo, d) create time.make_fine (h, mi, s) ensure year_set: year = y month_set: month = mo day_set: day = d hour_set: hour = h minute_set: minute = mi second_set: fine_second = s end make_from_epoch (s: INTEGER_32) -- Create a new date time from the number of -- seconds since epoch (1 Jan 1970 at 00:00:00). local d: INTEGER_32 ss: INTEGER_32 l_dur: DATE_TIME_DURATION do if s < 0 then ss := - s else ss := s end d := ss // Seconds_in_day ss := ss \\ Seconds_in_day create l_dur.make_definite (d, 0, 0, ss) make_fine (1970, 1, 1, 0, 0, 0.0) if s < 0 then add (- l_dur) else add (l_dur) end end make_from_string (s: STRING_8; code: STRING_8) -- Initialize from a "standard" string of form -- code. -- (For 2-digit year specifications, the current century is used as -- base century.) require s_exists: s /= Void c_exists: code /= Void date_time_valid: date_time_valid (s, code) local date_time: DATE_TIME do date_time := (create {DATE_TIME_CODE_STRING}.make (code)).create_date_time (s) make_by_date_time (date_time.date, date_time.time) end make_from_string_default (s: STRING_8) -- Initialize from a "standard" string of form -- default_format_string. -- (For 2-digit year specifications, the current century is used as -- base century.) require s_exists: s /= Void date_time_valid: date_time_valid (s, default_format_string) do make_from_string (s, default_format_string) end make_from_string_default_with_base (s: STRING_8; base: INTEGER_32) -- Initialize from a "standard" string of form -- default_format_string with base century base. require s_exists: s /= Void base_valid: base > 0 and (base \\ 100 = 0) date_time_valid: date_time_valid_with_base (s, default_format_string, base) do make_from_string_with_base (s, default_format_string, base) end make_from_string_with_base (s: STRING_8; code: STRING_8; base: INTEGER_32) -- Initialize from a "standard" string of form -- code with base century base. require s_exists: s /= Void c_exists: code /= Void base_valid: base > 0 and (base \\ 100 = 0) date_time_valid: date_time_valid_with_base (s, code, base) local code_string: DATE_TIME_CODE_STRING date_time: DATE_TIME do create code_string.make (code) code_string.set_base_century (base) date_time := code_string.create_date_time (s) make_by_date_time (date_time.date, date_time.time) end make_now -- Get the date and the time from the system. local l_date: C_DATE do create l_date create date.make (l_date.year_now, l_date.month_now, l_date.day_now) create time.make_fine (l_date.hour_now, l_date.minute_now, l_date.second_now.to_double + l_date.millisecond_now / 1000) end make_now_utc -- Get the date and the time from the system. local l_date: C_DATE do create l_date.make_utc create date.make (l_date.year_now, l_date.month_now, l_date.day_now) create time.make_fine (l_date.hour_now, l_date.minute_now, l_date.second_now.to_double + l_date.millisecond_now / 1000) end feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature -- Access date: DATE -- Date of the current object date_default_format_string: STRING_8 -- Default output format for dates -- (from DATE_CONSTANTS) do Result := Date_time_tools.Date_default_format_string end date_duration: DATE_DURATION -- Definite duration between origin of date and current date do Result := date.duration end Date_time_tools: DATE_TIME_TOOLS -- Tools for outputting dates and times in different formats -- (from TIME_UTILITY) once create Result end day: INTEGER_32 -- Day of the current object -- (from DATE_TIME_MEASUREMENT) require -- from DATE_MEASUREMENT True do Result := date.day ensure -- from DATE_TIME_MEASUREMENT same_day: Result = date.day end days: INTEGER_32 -- Number of days elapsed since Origin do Result := date.days end days_in_i_th_month (i, y: INTEGER_32): INTEGER_32 -- Number of days in the i th month at year y -- (from DATE_CONSTANTS) require -- from DATE_CONSTANTS i_large_enough: i >= 1 i_small_enough: i <= Months_in_year do Result := Days_in_months @ i if i = 2 and then is_leap_year (y) then Result := Result + 1 end end Days_in_leap_year: INTEGER_32 = 366 -- Number of days in a leap year -- (from DATE_CONSTANTS) Days_in_non_leap_year: INTEGER_32 = 365 -- Number of days in a non-leap year -- (from DATE_CONSTANTS) Days_in_week: INTEGER_32 = 7 -- Number of days in a week -- (from DATE_CONSTANTS) days_text: ARRAY [STRING_8] -- Short text representation of days -- (from DATE_CONSTANTS) do Result := Date_time_tools.Days_text 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 DATE_TIME_MEASUREMENT) require -- from TIME_MEASUREMENT True do Result := time.fine_second ensure -- from DATE_TIME_MEASUREMENT same_fine_second: Result = time.fine_second end fractional_second: REAL_64 -- Fractional part of fine_second -- (from TIME_VALUE) generating_type: TYPE [detachable DATE_TIME] -- 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 hour: INTEGER_32 -- Hour of the current object -- (from DATE_TIME_MEASUREMENT) require -- from TIME_MEASUREMENT True do Result := time.hour ensure -- from DATE_TIME_MEASUREMENT same_hour: Result = time.hour end Hours_in_day: INTEGER_32 = 24 -- Number of hours in a day -- (from TIME_CONSTANTS) long_days_text: ARRAY [STRING_8] -- Long text representation of days -- (from DATE_CONSTANTS) do Result := Date_time_tools.Long_days_text end long_months_text: ARRAY [STRING_8] -- Long text representation of months -- (from DATE_CONSTANTS) do Result := Date_time_tools.Long_months_text end Max_weeks_in_year: INTEGER_32 = 53 -- Maximun number of weeks in a year -- (from DATE_CONSTANTS) minute: INTEGER_32 -- Minute of the current object -- (from DATE_TIME_MEASUREMENT) require -- from TIME_MEASUREMENT True do Result := time.minute ensure -- from DATE_TIME_MEASUREMENT same_minute: Result = time.minute end Minutes_in_hour: INTEGER_32 = 60 -- Number of minutes in an hour -- (from TIME_CONSTANTS) month: INTEGER_32 -- Month of the current object -- (from DATE_TIME_MEASUREMENT) require -- from DATE_MEASUREMENT True do Result := date.month ensure -- from DATE_TIME_MEASUREMENT same_month: Result = date.month end Months_in_year: INTEGER_32 = 12 -- Number of months in year -- (from DATE_CONSTANTS) months_text: ARRAY [STRING_8] -- Short text representation of months -- (from DATE_CONSTANTS) do Result := Date_time_tools.Months_text end Origin: DATE_TIME -- Origin date with origin time once create Result.make_by_date_time (date.Origin, time.Origin) ensure -- from ABSOLUTE result_exists: Result /= Void end second: INTEGER_32 -- Second of the current object -- (from DATE_TIME_MEASUREMENT) require -- from TIME_MEASUREMENT True do Result := time.second ensure -- from DATE_TIME_MEASUREMENT same_second: Result = time.second end seconds: INTEGER_32 -- Number of seconds elapsed from midnight of the current date do Result := time.seconds 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: TIME -- Time of the current object time_default_format_string: STRING_8 -- Default output format for times -- (from TIME_CONSTANTS) do Result := Date_time_tools.Time_default_format_string end time_duration: TIME_DURATION -- Duration elapsed from midnight of the current date do Result := time.duration end year: INTEGER_32 -- Year of the current object -- (from DATE_TIME_MEASUREMENT) require -- from DATE_MEASUREMENT True do Result := date.year ensure -- from DATE_TIME_MEASUREMENT same_year: Result = date.year end feature {NONE} -- Access compact_date: INTEGER_32 obsolete "Use `ordered_compact_date' instead. But be careful in your update since `compact_date' and `ordered_compact_date' do not have the same encoding. [2017-05-31]" -- Day, month and year coded. -- (from DATE_VALUE) do Result := year | (month |<< 16) | (day |<< 24) end compact_time: INTEGER_32 -- Hour, minute, second coded. -- (from TIME_VALUE) 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 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 ordered_compact_date: INTEGER_32 -- Year, month, day coded for fast comparison between dates. -- (from DATE_VALUE) feature -- Measurement duration: DATE_TIME_DURATION -- Definite duration elapsed from Origin require -- from ABSOLUTE True do create Result.make_by_date_time (date_duration, time_duration) ensure then definite_result: Result.definite 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: DATE_TIME): 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: like Current): BOOLEAN -- Is the current object equal to other? require -- from ANY other_not_void: other /= Void do Result := equal (date, other.date) and then equal (time, other.time) ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result ensure then -- from COMPARABLE trichotomy: Result = (not (Current < other) and not (other < Current)) end is_greater alias ">" (other: DATE_TIME): BOOLEAN -- Is current object greater than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := other < Current ensure then -- from COMPARABLE definition: Result = (other < Current) end is_greater_equal alias ">=" (other: DATE_TIME): BOOLEAN -- Is current object greater than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := not (Current < other) ensure then -- from COMPARABLE definition: Result = (other <= Current) end is_less alias "<" (other: like Current): BOOLEAN -- Is the current object before other? require -- from PART_COMPARABLE other_exists: other /= Void do Result := date < other.date or else (date.is_equal (other.date) and then (time < other.time)) ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) end is_less_equal alias "<=" (other: DATE_TIME): BOOLEAN -- Is current object less than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void do Result := not (other < Current) ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) end max (other: DATE_TIME): DATE_TIME -- The greater of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current >= other then Result := Current else Result := other end ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other end min (other: DATE_TIME): DATE_TIME -- The smaller of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current <= other then Result := Current else Result := other end ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other 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: DATE_TIME): 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 three_way_comparison (other: DATE_TIME): INTEGER_32 -- If current object equal to other, 0; -- if smaller, -1; if greater, 1 -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void do if Current < other then Result := -1 elseif other < Current then Result := 1 end ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) 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 i_th_leap_year (i: INTEGER_32): BOOLEAN obsolete "Use `is_leap_year' instead. [2017-05-31]" -- (from DATE_CONSTANTS) do Result := is_leap_year (i) end is_leap_year (y: INTEGER_32): BOOLEAN -- Is year y a leap year? -- (from DATE_CONSTANTS) do Result := (mod (y, 4) = 0) and ((mod (y, 100) /= 0) or (mod (y, 400) = 0)) 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_compact_date (y, m, d: INTEGER_32) -- Set year with y, month with m and day with d. -- (from DATE_VALUE) require -- from DATE_MEASUREMENT d_large_enough: d >= 1 m_large_enough: m >= 1 m_small_enough: m <= Months_in_year d_small_enough: d <= days_in_i_th_month (m, y) local l_date: like ordered_compact_date do l_date := l_date & Day_mask.bit_not l_date := l_date | d l_date := l_date & Month_mask.bit_not l_date := l_date | (m |<< Month_shift) l_date := l_date & Year_mask.bit_not l_date := l_date | (y |<< Year_shift) ordered_compact_date := l_date ensure -- from DATE_MEASUREMENT day_set: day = d month_set: month = m year_set: year = y end set_day (d: INTEGER_32) -- Set day to d. -- (from DATE_VALUE) require -- from DATE_MEASUREMENT d_large_enough: d >= 1 d_small_enough: d <= days_in_month local l_date: like ordered_compact_date do l_date := ordered_compact_date l_date := l_date & Day_mask.bit_not l_date := l_date | d ordered_compact_date := l_date ensure -- from DATE_MEASUREMENT day_set: day = d end 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_internal_compact_date (a_compact_date: like compact_date) obsolete "Use `ordered_compact_date' instead. But be careful in your update since `compact_date' and `ordered_compact_date' do not have the same encoding. [2017-05-31]" -- Set a_compact_date to compact_date. -- (from DATE_VALUE) do set_private_internal_compact_date (a_compact_date) ensure -- from DATE_VALUE compact_date_set: year | (month |<< 16) | (day |<< 24) = a_compact_date end set_internal_ordered_compact_date (a_ordered_compact_date: like ordered_compact_date) -- Set a_ordered_compact_date to ordered_compact_date. -- (from DATE_VALUE) do ordered_compact_date := a_ordered_compact_date ensure -- from DATE_VALUE ordered_compact_date_set: ordered_compact_date = a_ordered_compact_date 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_month (m: INTEGER_32) -- Set month to m. -- (from DATE_VALUE) require -- from DATE_MEASUREMENT m_large_enough: m >= 1 m_small_enough: m <= Months_in_year d_small_enough: day <= days_in_i_th_month (m, year) local l_date: like ordered_compact_date do l_date := ordered_compact_date l_date := l_date & Month_mask.bit_not l_date := l_date | (m |<< Month_shift) ordered_compact_date := l_date ensure -- from DATE_MEASUREMENT month_set: month = 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 set_year (y: INTEGER_32) -- Set year to y. -- (from DATE_VALUE) require -- from DATE_MEASUREMENT can_not_cut_29th_feb: day <= days_in_i_th_month (month, y) local l_date: like ordered_compact_date do l_date := ordered_compact_date l_date := l_date & Year_mask.bit_not l_date := l_date | (y |<< Year_shift) ordered_compact_date := l_date ensure -- from DATE_MEASUREMENT year_set: year = y 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 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: DATE_TIME) -- 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: DATE_TIME -- 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: DATE_TIME) -- 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: DATE_TIME -- 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: DATE_TIME -- 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 -- Basic operations add (dtd: DATE_TIME_DURATION) -- Adds dtd to current duration require dtd_not_void: dtd /= Void do if dtd.definite then day_add (dtd.day) else date.year_month_add (dtd.year, dtd.month) day_add (dtd.day) end day_add ((dtd.time + time_duration).to_days) time := time.Origin + (dtd.time + time_duration).time_modulo_day end frozen as_attached: attached DATE_TIME 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 day_add (d: INTEGER_32) -- Add d days to the current date. do date.make_by_days (days + d) ensure days_set: days = old days + d end frozen default: detachable DATE_TIME -- 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 definite_duration (other: like Current): DATE_TIME_DURATION -- Duration from other to the current date, converted to a -- definite duration require other_exists: other /= Void do Result := relative_duration (other) Result.date.to_definite (other.date) ensure definite_result: Result.definite end frozen do_nothing -- Execute a null action. -- (from ANY) do ensure -- from ANY instance_free: class end fine_second_add (s: REAL_64) -- Add s seconds to the current object. -- if s has decimals, fractional_second from time is modified. local total_second: REAL_64 do total_second := time.fine_second + s if total_second < 0.to_double or else total_second >= Seconds_in_minute.to_double then time.set_fine_second (total_second - div (total_second.floor, Seconds_in_minute) * Seconds_in_minute.to_double) minute_add (div (total_second.floor, Seconds_in_minute)) else time.set_fine_second (total_second) end end hour_add (h: INTEGER_32) -- Add h hours to the current time. local total_hour: INTEGER_32 do total_hour := hour + h if total_hour < 0 or else total_hour >= Hours_in_day then time.set_hour (mod (total_hour, Hours_in_day)) day_add (div (total_hour, Hours_in_day)) else time.set_hour (total_hour) end end minus alias "-" (other: DATE_TIME): INTERVAL [DATE_TIME] -- Interval between current object and other. -- (from ABSOLUTE) require -- from ABSOLUTE other_exists: other /= Void other_smaller_than_current: other <= Current do create Result.make (other, Current) ensure -- from ABSOLUTE result_exists: Result /= Void result_set: Result.start_bound.is_equal (other) and then Result.end_bound.is_equal (Current) end minute_add (m: INTEGER_32) -- Add m minutes to the current time. local total_minute: INTEGER_32 do total_minute := minute + m if total_minute < 0 or else total_minute >= Minutes_in_hour then time.set_minute (mod (total_minute, Minutes_in_hour)) hour_add (div (total_minute, Minutes_in_hour)) else time.set_minute (total_minute) end end plus alias "+" (d: DATE_TIME_DURATION): like Current -- Sum the current object with d require d_not_void: d /= Void do Result := twin Result.add (d) ensure result_exists: Result /= Void end relative_duration (other: like Current): DATE_TIME_DURATION -- Duration from other to current date require -- from ABSOLUTE other_exists: other /= Void do create Result.make_fine (0, 0, days - other.days, hour - other.hour, minute - other.minute, fine_second - other.fine_second) Result := Result.to_canonical (other) Result.set_origin_date_time (other.twin) ensure -- from ABSOLUTE result_exists: Result /= Void ensure then origin_set: equal (other, Result.origin_date_time) end second_add (s: INTEGER_32) -- Add s seconds to the current time. local total_second: INTEGER_32 do total_second := second + s if total_second < 0 or else total_second >= Seconds_in_minute then time.set_second (mod (total_second, Seconds_in_minute)) minute_add (div (total_second, Seconds_in_minute)) else time.set_second (total_second) end 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 {NONE} -- Implementation Compact_date_attribute_name: STRING_8 = "compact_date" -- Name of compacte_date attribute in 5.3 and older version. -- (from DATE_VALUE) Day_mask: INTEGER_32 = 255 -- (from DATE_VALUE) Day_shift: INTEGER_32 = 0 -- Shift needed to extract/set year, month and day. -- (from DATE_VALUE) Days_in_months: ARRAY [INTEGER_32] -- Array containing number of days for each month of -- a non-leap year. -- (from DATE_CONSTANTS) once Result := <<31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31>> ensure -- from DATE_CONSTANTS result_exists: Result /= Void valid_count: Result.count = Months_in_year end 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) Month_mask: INTEGER_32 = 65280 -- (from DATE_VALUE) Month_shift: INTEGER_32 = 8 -- (from DATE_VALUE) Second_mask: INTEGER_32 = 255 -- Mask used to extract/set hour, minute and second. -- (from TIME_VALUE) set_private_internal_compact_date (a_compact_date: like compact_date) -- Set a_compact_date to compact_date. -- (from DATE_VALUE) do set_compact_date (a_compact_date & 65535, (a_compact_date & 16711680) |>> 16, ((a_compact_date & 4278190080) |>> 24) & 255) ensure -- from DATE_VALUE compact_date_set: year | (month |<< 16) | (day |<< 24) = a_compact_date end Year_mask: INTEGER_32 = 4294901760 -- Mask used to extract/set year, month and day. -- (from DATE_VALUE) Year_shift: INTEGER_32 = 16 -- (from DATE_VALUE) feature {NONE} -- Correction correct_mismatch -- Attempt to correct object mismatch using Mismatch_information. -- (from DATE_VALUE) do if attached {INTEGER_32_REF} Mismatch_information.item (Compact_date_attribute_name) as l_compact_date then set_private_internal_compact_date (l_compact_date.item) else Precursor {MISMATCH_CORRECTOR} end end Mismatch_information: MISMATCH_INFORMATION -- Original attribute values of mismatched object -- (from MISMATCH_CORRECTOR) once create Result end feature -- Element Change copy (other: like Current) -- set date and time with the other attributes. require -- from ANY other_not_void: other /= Void type_identity: same_type (other) do if other /= Current then Precursor {ABSOLUTE} (other) date := other.date.twin time := other.time.twin end ensure -- from ANY is_equal: Current ~ other end set_date (d: DATE) -- Set date to d. require d_exists: d /= Void do date := d ensure date_set: date = d end set_time (t: TIME) -- Set time to t. require t_exists: t /= Void do time := t ensure time_set: time = t end feature -- Output debug_output: STRING_8 -- Printable representation of the current object -- With "standard" form: default_format_string -- Was declared in DATE_TIME as synonym of out. do Result := formatted_out (default_format_string) ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void end formatted_out (s: STRING_8): STRING_8 -- Printable representation of the current object -- With "standard" form: s require s_exists: s /= Void do Result := (create {DATE_TIME_CODE_STRING}.make (s)).create_string (Current) end 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 -- Printable representation of the current object -- With "standard" form: default_format_string -- Was declared in DATE_TIME as synonym of debug_output. do Result := formatted_out (default_format_string) 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 date_time_valid (s: STRING_8; code_string: STRING_8): BOOLEAN -- Is the code_string enough precise -- To create an instance of type DATE_TIME -- And does the string s correspond to code_string? -- (from DATE_TIME_VALIDITY_CHECKER) require -- from DATE_TIME_VALIDITY_CHECKER s_exists: s /= Void code_exists: code_string /= Void local code: DATE_TIME_CODE_STRING do create code.make (code_string) Result := code.precise and code.correspond (s) and then code.is_date_time (s) end date_time_valid_with_base (s: STRING_8; code_string: STRING_8; base: INTEGER_32): BOOLEAN -- Is the code_string enough precise -- To create an instance of type DATE_TIME -- And does the string s correspond to code_string? -- Use base century base. -- (from DATE_TIME_VALIDITY_CHECKER) require -- from DATE_TIME_VALIDITY_CHECKER s_exists: s /= Void code_exists: code_string /= Void base_valid: base > 0 and (base \\ 100 = 0) local code: DATE_TIME_CODE_STRING do create code.make (code_string) code.set_base_century (base) Result := code.precise and code.correspond (s) and then code.is_date_time (s) end is_correct_date_time (y, mo, d, h, mi: INTEGER_32; s: REAL_64; twelve_hour_scale: BOOLEAN): BOOLEAN -- Is date-time specified by y, mo, d, h, mi, s -- correct? -- twelve_hour_scale specifies if the hour range is 1 - 12 -- (if True) or 0 - 23 (if False). -- (from DATE_TIME_VALIDITY_CHECKER) do Result := is_correct_date (y, mo, d) and is_correct_time (h, mi, s, twelve_hour_scale) end feature {NONE} -- Preconditions compact_date_valid (c_d: INTEGER_32): BOOLEAN -- Is compact date c_d valid? -- (from DATE_VALIDITY_CHECKER) local l_cd: INTEGER_32 y, m, d: INTEGER_32 do l_cd := ordered_compact_date set_private_internal_compact_date (c_d) d := day m := month y := year ordered_compact_date := l_cd Result := is_correct_date (y, m, d) end compact_time_valid (c_t: INTEGER_32): BOOLEAN -- Is compact time c_t valid? -- (from TIME_VALIDITY_CHECKER) 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 date_valid (s: STRING_8; code_string: STRING_8): BOOLEAN -- Is the code_string enough precise -- To create an instance of type DATE -- And does the string s correspond to code_string? -- (from DATE_VALIDITY_CHECKER) require -- from DATE_VALIDITY_CHECKER s_exists: s /= Void code_exists: code_string /= Void local code: DATE_TIME_CODE_STRING do create code.make (code_string) Result := code.precise_date and code.correspond (s) and then code.is_date (s) end date_valid_default (s: STRING_8): BOOLEAN -- Is the code_string enough precise -- To create an instance of type DATE -- And does the string s correspond to -- date_default_format_string? -- (from DATE_VALIDITY_CHECKER) require -- from DATE_VALIDITY_CHECKER s_exists: s /= Void do Result := date_valid (s, date_default_format_string) end date_valid_default_with_base (s: STRING_8; base: INTEGER_32): BOOLEAN -- Is the code_string enough precise -- To create an instance of type DATE -- And does the string s correspond to -- date_default_format_string? -- Use base century base. -- (from DATE_VALIDITY_CHECKER) require -- from DATE_VALIDITY_CHECKER s_exists: s /= Void base_valid: base > 0 and (base \\ 100 = 0) do Result := date_valid_with_base (s, date_default_format_string, base) end date_valid_with_base (s: STRING_8; code_string: STRING_8; base: INTEGER_32): BOOLEAN -- Is the code_string enough precise -- To create an instance of type DATE -- And does the string s correspond to code_string? -- Use base century base. -- (from DATE_VALIDITY_CHECKER) require -- from DATE_VALIDITY_CHECKER s_exists: s /= Void code_exists: code_string /= Void base_valid: base > 0 and (base \\ 100 = 0) local code: DATE_TIME_CODE_STRING do create code.make (code_string) code.set_base_century (base) Result := code.precise_date and code.correspond (s) and then code.is_date (s) end is_correct_date (y, m, d: INTEGER_32): BOOLEAN -- Is date specified by y, m, and d a correct date? -- (from DATE_VALIDITY_CHECKER) do Result := m >= 1 and m <= Months_in_year and then d >= 1 and d <= days_in_i_th_month (m, y) and then y >= 0 and then y <= 65535 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). -- (from TIME_VALIDITY_CHECKER) 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 ordered_compact_date_valid (c_d: INTEGER_32): BOOLEAN -- Is compact date c_d valid? -- (from DATE_VALIDITY_CHECKER) local l_cd: INTEGER_32 y, m, d: INTEGER_32 do l_cd := ordered_compact_date ordered_compact_date := c_d d := day m := month y := year ordered_compact_date := l_cd Result := is_correct_date (y, m, d) 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? -- (from TIME_VALIDITY_CHECKER) require -- from TIME_VALIDITY_CHECKER 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 feature {NONE} -- Status Report days_in_month: INTEGER_32 -- Number of days in month 'month'. -- (from DATE_MEASUREMENT) do Result := days_in_i_th_month (month, year) ensure -- from DATE_MEASUREMENT positive_result: Result > 0 end invariant -- from COMPARABLE irreflexive_comparison: not (Current < Current) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from DATE_TIME_MEASUREMENT date_exists: date /= Void time_exists: time /= Void 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 DATE_TIME
Generated by ISE EiffelStudio