note
	description: "Values of date"
	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

class 
	DATE_VALUE

create 
	default_create

feature {NONE} -- Initialization

	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end
	
feature -- 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.
		do
			Result := year | (month |<< 16) | (day |<< 24)
		end

	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_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
		do
			Result := ordered_compact_date & Day_mask
		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

	generating_type: TYPE [detachable DATE_VALUE]
			-- 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

	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)

	month: INTEGER_32
			-- Month of the current object
		do
			Result := (ordered_compact_date & Month_mask) |>> Month_shift
		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

	ordered_compact_date: INTEGER_32
			-- Year, month, day coded for fast comparison between dates.

	year: INTEGER_32
			-- Year of the current object
		do
			Result := ((ordered_compact_date & Year_mask) |>> Year_shift) & 65535
		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_VALUE): 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: DATE_VALUE): 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: DATE_VALUE): 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

	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 -- Element change

	set_date (y, m, d: INTEGER_32)
			-- Set year with y, month with m and day with d.
		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.
		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_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.
		do
			set_private_internal_compact_date (a_compact_date)
		ensure
			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.
		do
			ordered_compact_date := a_ordered_compact_date
		ensure
			ordered_compact_date_set: ordered_compact_date = a_ordered_compact_date
		end

	set_month (m: INTEGER_32)
			-- Set month to m.
		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_year (y: INTEGER_32)
			-- Set year to y.
		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

	copy (other: DATE_VALUE)
			-- 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: DATE_VALUE)
			-- 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_VALUE
			-- 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_VALUE)
			-- 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_VALUE
			-- 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_VALUE
			-- 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 DATE_VALUE
		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 DATE_VALUE
			-- 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

	Compact_date_attribute_name: STRING_8 = "compact_date"
			-- Name of compacte_date attribute in 5.3 and older version.

	Day_mask: INTEGER_32 = 255

	Day_shift: INTEGER_32 = 0
			-- Shift needed to extract/set year, month and day.

	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

	Month_mask: INTEGER_32 = 65280

	Month_shift: INTEGER_32 = 8

	set_private_internal_compact_date (a_compact_date: like compact_date)
			-- Set a_compact_date to compact_date.
		do
			set_date (a_compact_date & 65535, (a_compact_date & 16711680) |>> 16, ((a_compact_date & 4278190080) |>> 24) & 255)
		ensure
			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.

	Year_shift: INTEGER_32 = 16
	
feature -- Correction

	correct_mismatch
			-- Attempt to correct object mismatch using Mismatch_information.
		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 -- 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 {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 -- 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 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 DATE_VALUE

Generated by ISE EiffelStudio