Automatic generation produced by ISE Eiffel
note description: "Parser facility for dates and times" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2020-05-19 06:45:25 -0800 (Tue, 19 May 2020) $" revision: "$Revision: 104270 $" class interface DATE_TIME_PARSER create make (c: HASH_TABLE [DATE_TIME_CODE, INTEGER_32]) -- Create parser with date/time code c, months array m, -- days array d, and base century b. require code_exists: c /= Void ensure code_set: code = c feature -- Access compact_time: INTEGER_32 -- Hour, minute, second coded. -- (from TIME_VALUE) date_default_format_string: STRING_8 -- Default output format for dates -- (from DATE_CONSTANTS) Date_time_tools: DATE_TIME_TOOLS -- Tools for outputting dates and times in different formats -- (from TIME_UTILITY) checker_day: INTEGER_32 -- Day of the current object -- (from DATE_VALUE) day: INTEGER_32 -- Day part of `source_string` require value_parsed: parsed day_text: detachable READABLE_STRING_8 -- Text representation of `day` require value_parsed: parsed 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 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) default_format_string: STRING_8 -- Default output format string -- (from TIME_UTILITY) checker_fine_second: REAL_64 -- Representation of second with decimals -- (from TIME_VALUE) fine_second: REAL_64 -- Seconds part of `source_string` require value_parsed: parsed fractional_second: REAL_64 -- Fractional part of `fine_second` -- (from TIME_VALUE) generating_type: TYPE [detachable DATE_TIME_PARSER] -- 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 hour: INTEGER_32 -- Hour part of `source_string` require value_parsed: parsed checker_hour: INTEGER_32 -- Hour of the current time -- (from TIME_VALUE) 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) long_months_text: ARRAY [STRING_8] -- Long text representation of months -- (from DATE_CONSTANTS) Max_weeks_in_year: INTEGER_32 = 53 -- Maximun number of weeks in a year -- (from DATE_CONSTANTS) micro_second: INTEGER_32 -- Microsecond of the current time -- (from TIME_VALUE) milli_second: INTEGER_32 -- Millisecond of the current time -- (from TIME_VALUE) minute: INTEGER_32 -- Minute part of `source_string` require value_parsed: parsed checker_minute: INTEGER_32 -- Minute of the current time -- (from TIME_VALUE) Minutes_in_hour: INTEGER_32 = 60 -- Number of minutes in an hour -- (from TIME_CONSTANTS) month: INTEGER_32 -- Month part of `source_string` require value_parsed: parsed checker_month: INTEGER_32 -- Month of the current object -- (from DATE_VALUE) 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) nano_second: INTEGER_32 -- Nanosecond of the current time -- (from TIME_VALUE) ordered_compact_date: INTEGER_32 -- Year, month, day coded for fast comparison between dates. -- (from DATE_VALUE) second: INTEGER_32 -- Second of the current time -- (from TIME_VALUE) 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) source_string: detachable READABLE_STRING_8 -- String to be parsed time_default_format_string: STRING_8 -- Default output format for times -- (from TIME_CONSTANTS) year: INTEGER_32 -- Year part of `source_string` require value_parsed: parsed checker_year: INTEGER_32 -- Year of the current object -- (from DATE_VALUE) 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: DATE_TIME_PARSER): 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: DATE_TIME_PARSER): 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: DATE_TIME_PARSER): 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 is_date: BOOLEAN -- Does `source_string` contain a DATE? require string_parsed: parsed is_date_time: BOOLEAN -- Does `source_string` contain a DATE_TIME? require string_parsed: parsed is_leap_year (y: INTEGER_32): BOOLEAN -- Is year y a leap year? -- (from DATE_CONSTANTS) is_set_up: BOOLEAN -- Has parser been set up completely? is_time: BOOLEAN -- Does `source_string` contain a TIME? require string_parsed: parsed is_value_valid: BOOLEAN -- Is parsed value valid? parsed: BOOLEAN -- Has `source_string` been parsed? 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 set_base_century (c: INTEGER_32) -- Set base century to c. require base_century_valid: c /= 0 and (c \\ 100 = 0) ensure base_century_set: base_century = c set_day_array (d: ARRAY [READABLE_STRING_8]) -- Set day array to d. require not_void: d /= Void ensure days_set: days = d set_month_array (m: ARRAY [READABLE_STRING_8]) -- Set month array to m. require not_void: m /= Void ensure months_set: months = m set_source_string (s: READABLE_STRING_8) -- Assign s to `source_string`. require non_empty_string: s /= Void and then not s.is_empty ensure source_set: source_string = s not_parsed: not parsed feature -- Element change set_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) ensure -- from DATE_MEASUREMENT day_set: checker_day = d month_set: checker_month = m year_set: checker_year = y 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 ensure -- from DATE_MEASUREMENT day_set: checker_day = d 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 ensure -- from TIME_MEASUREMENT fine_second_set: checker_fine_second = s 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 ensure -- from TIME_MEASUREMENT second_same: second = old second 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 ensure -- from TIME_MEASUREMENT hour_set: checker_hour = h 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) ensure -- from DATE_VALUE ordered_compact_date_set: ordered_compact_date = a_ordered_compact_date 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 ensure -- from TIME_MEASUREMENT minute_set: checker_minute = m 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: checker_day <= days_in_i_th_month (m, checker_year) ensure -- from DATE_MEASUREMENT month_set: checker_month = m 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 ensure -- from TIME_MEASUREMENT second_set: second = s set_year (y: INTEGER_32) -- Set `year` to y. -- (from DATE_VALUE) require -- from DATE_MEASUREMENT can_not_cut_29th_feb: checker_day <= days_in_i_th_month (checker_month, y) ensure -- from DATE_MEASUREMENT year_set: checker_year = y feature -- Duplication copy (other: DATE_TIME_PARSER) -- 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: DATE_TIME_PARSER) -- 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: DATE_TIME_PARSER -- 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: DATE_TIME_PARSER) -- 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: DATE_TIME_PARSER -- 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: DATE_TIME_PARSER -- 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 DATE_TIME_PARSER -- 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) div (i, j: INTEGER_32): INTEGER_32 -- (i \\ j) if i positive -- (i \\ j + 1) if i negative -- (from TIME_UTILITY) ensure -- from TIME_UTILITY result_definition: i = j * Result + mod (i, j) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class mod (i, j: INTEGER_32): INTEGER_32 -- (i \\ j) if i positive -- (i \\ j + j) if i negative -- (from TIME_UTILITY) ensure -- from TIME_UTILITY positive_result: Result >= 0 result_definition: i = j * div (i, j) + Result parse -- Parse `source_string`. require setup_complete: is_set_up ensure string_parsed: parsed feature -- Correction correct_mismatch -- Attempt to correct object mismatch using `mismatch_information`. -- (from DATE_VALUE) Mismatch_information: MISMATCH_INFORMATION -- Original attribute values of mismatched object -- (from MISMATCH_CORRECTOR) 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 -- 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 -- Preconditions compact_time_valid (c_t: INTEGER_32): BOOLEAN -- Is compact time c_t valid? -- (from TIME_VALIDITY_CHECKER) date_time_valid (s: READABLE_STRING_8; code_string: READABLE_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 date_time_valid_with_base (s: READABLE_STRING_8; code_string: READABLE_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) date_valid (s: READABLE_STRING_8; code_string: READABLE_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 ensure -- from DATE_VALIDITY_CHECKER class date_valid_default (s: READABLE_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 date_valid_default_with_base (s: READABLE_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) date_valid_with_base (s: READABLE_STRING_8; code_string: READABLE_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) is_correct_date (y, m, d: INTEGER_32): BOOLEAN -- Is date specified by y, m, and d a correct date? -- (from DATE_VALIDITY_CHECKER) 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) 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) ordered_compact_date_valid (c_d: INTEGER_32): BOOLEAN -- Is compact date c_d valid? -- (from DATE_VALIDITY_CHECKER) time_valid (s: READABLE_STRING_8; code_string: READABLE_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 feature -- Status Report days_in_month: INTEGER_32 -- Number of days in month 'month'. -- (from DATE_MEASUREMENT) ensure -- from DATE_MEASUREMENT positive_result: Result > 0 invariant valid_value_definition: is_value_valid = (parsed and then (is_date or is_time or is_date_time)) valid_value_implies_parsing: is_value_valid implies parsed -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2020, 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_PARSER -- Generated by Eiffel Studio --
For more details: eiffel.org