class EL_DATE_TEXT

(source code)

Client examples: DATE_TIME_TEST_SET

description

Date text

note
	description: "Date text"

	author: "Finnian Reilly"
	copyright: "Copyright (c) 2001-2022 Finnian Reilly"
	contact: "finnian at eiffel hyphen loop dot com"

	license: "MIT license (See: en.wikipedia.org/wiki/MIT_License)"
	date: "2024-02-22 17:47:44 GMT (Thursday 22nd February 2024)"
	revision: "26"

class
	EL_DATE_TEXT

inherit
	EL_DATE_TIME_TOOLS
		export
			{NONE} all
		end

	EL_DATE_FORMATS
		export
			{NONE} all
			{ANY} Var, new_format
		end

	EL_MODULE_DEFERRED_LOCALE

create
	make, make_default

feature {NONE} -- Initialization

	make (a_locale: EL_DEFERRED_LOCALE_I)
		do
			create template_table.make_equal (3, agent new_template)
			function_table := new_function_table
			create day.make_with_locale (a_locale)
			create month.make_with_locale (a_locale)
		end

	make_default
		do
			make (Locale)
		end

feature -- Access

	formatted (date: DATE; format: STRING): ZSTRING
		require
			valid_format: is_valid_format (format)
		do
			Result := template (format).substituted (date)
		end

	from_ISO_8601_formatted (iso8601_string: STRING): EL_DATE_TIME
		do
			if iso8601_string.has ('-') then
				create Result.make_iso_8601_extended (iso8601_string)
			else
				create Result.make_iso_8601 (iso8601_string)
			end
		end

	iso_8601_formatted (dt: DATE_TIME; extended: BOOLEAN): STRING
		-- format as "yyyy[0]mm[0]Tdd[0]hh[0]mi[0]ssZ"
		do
			Once_date_time.make_from_other (dt)
			if extended then
				Result := Once_date_time.formatted_out (ISO_8601.format_extended)
			else
				Result := Once_date_time.formatted_out (ISO_8601.format)
			end
		end

	short_year (date: DATE): ZSTRING
		do
			Result := (date.year \\ 100).out
		end

	year (date: DATE): ZSTRING
		do
			Result := date.year.out
		end

feature -- Day of week

	long_day_name (date: DATE): ZSTRING
			-- long day of week name
		do
			Result := week_day_name (date.day_of_the_week, False)
		end

	long_week_day_names_list: EL_ZSTRING_LIST
		do
			Result := week_day_names_list (False)
		end

	short_day_name (date: DATE): ZSTRING
		do
			Result := week_day_name (date.day_of_the_week, True)
		end

	short_week_day_names_list: EL_ZSTRING_LIST
		do
			Result := week_day_names_list (True)
		end

feature -- Day of month

	canonical_numeric_day (date: DATE): ZSTRING
			-- day of month number with ordinal indicator
		do
			Result := numeric_day (date)
			inspect date.day
				when 1, 21, 31 then
					Result.append (ordinal_indicator (1))

				when 2, 22 then
					Result.append (ordinal_indicator (2))

				when 3, 23 then
					Result.append (ordinal_indicator (3))

			else
				Result.append (ordinal_indicator (0))

			end
		end

	numeric_day (date: DATE): ZSTRING
			-- numeric day of month
		do
			Result := date.day.out
		end

feature -- Month of year

	long_month_name (date: DATE): ZSTRING
		do
			Result := month_name (date.month, False)
		end

	long_month_names_list: EL_ZSTRING_LIST
		do
			Result := month_names_list (False)
		end

	numeric_month (date: DATE): ZSTRING
			-- month of year number
		do
			Result := date.month.out
		end

	short_month_name (date: DATE): ZSTRING
		do
			Result := month_name (date.month, True)
		end

	short_month_names_list: EL_ZSTRING_LIST
		do
			Result := month_names_list (True)
		end

feature {NONE} -- Implementation

	month_name (month_of_year: INTEGER; short: BOOLEAN): ZSTRING
			--
		do
			if short then
				Result := Month.short_names [month_of_year]
			else
				Result := Month.full_names [month_of_year]
			end
		end

	month_names_list (short: BOOLEAN): EL_ZSTRING_LIST
			--
		do
			create Result.make (12)
			across 1 |..| 12 as month_of_year loop
				Result.extend (month_name (month_of_year.item, short))
			end
		end

	new_function_table: EL_DATE_FUNCTION_TABLE
		do
			create Result.make (<<
				[Var.canonical_numeric_day,	agent canonical_numeric_day],
				[Var.numeric_day,					agent numeric_day],
				[Var.numeric_month,				agent numeric_month],

				[Var.short_day_name,				agent short_day_name],
				[Var.short_month_name,			agent short_month_name],

				[Var.long_month_name,			agent long_month_name],
				[Var.long_day_name,				agent long_day_name],

				[Var.year,							agent year],
				[Var.short_year,					agent short_year]
			>>)
		end

	new_template (format: STRING): EL_DATE_TEXT_TEMPLATE
		do
			create Result.make (format, function_table)
		end

	ordinal_indicator (i: INTEGER): ZSTRING
		require
			valid_number: i >= 0 and i <= 3
		do
			inspect i
				when 1 .. 3 then
					Result := Month.ordinal_indicators [i]
			else
				Result := Month.ordinal_indicators.last
			end
		end

	template (format: STRING): EL_DATE_TEXT_TEMPLATE
		do
			Result := template_table.item (format)
		end

	week_day_name (day_of_week: INTEGER; short: BOOLEAN): ZSTRING
			--
		do
			if short then
				Result := Day.short_names [day_of_week]
			else
				Result := Day.full_names [day_of_week]
			end
		end

	week_day_names_list (short: BOOLEAN): EL_ZSTRING_LIST
			-- Day of week names
		do
			create Result.make (7)
			across 1 |..| 7 as n loop
				Result.extend (week_day_name (n.item, short))
			end
		end

feature -- Contract Support

	is_valid_format (format: STRING): BOOLEAN
		do
			Result := template (format).valid_variables
		end

feature {NONE} -- Internal attributes

	day: EL_DAY_OF_WEEK_TEXTS

	function_table: like new_function_table

	month: EL_MONTH_TEXTS

	template_table: EL_AGENT_CACHE_TABLE [like template, STRING]

feature {NONE} -- Constants

	Once_date_time: EL_DATE_TIME
		once
			create Result.make_now
		end

end