1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
//! This module contains types and implementations for the Coptic calendar.
//!
//! ```rust
//! use icu::calendar::{cal::Coptic, Date, DateTime};
//!
//! // `Date` type
//! let date_iso = Date::try_new_iso(1970, 1, 2)
//! .expect("Failed to initialize ISO Date instance.");
//! let date_coptic = Date::new_from_iso(date_iso, Coptic);
//!
//! // `DateTime` type
//! let datetime_iso = DateTime::try_new_iso(1970, 1, 2, 13, 1, 0)
//! .expect("Failed to initialize ISO DateTime instance.");
//! let datetime_coptic = DateTime::new_from_iso(datetime_iso, Coptic);
//!
//! // `Date` checks
//! assert_eq!(date_coptic.year().era_year_or_extended(), 1686);
//! assert_eq!(date_coptic.month().ordinal, 4);
//! assert_eq!(date_coptic.day_of_month().0, 24);
//!
//! // `DateTime` type
//! assert_eq!(datetime_coptic.date.year().era_year_or_extended(), 1686);
//! assert_eq!(datetime_coptic.date.month().ordinal, 4);
//! assert_eq!(datetime_coptic.date.day_of_month().0, 24);
//! assert_eq!(datetime_coptic.time.hour.number(), 13);
//! assert_eq!(datetime_coptic.time.minute.number(), 1);
//! assert_eq!(datetime_coptic.time.second.number(), 0);
//! ```
use crate::calendar_arithmetic::{ArithmeticDate, CalendarArithmetic};
use crate::error::DateError;
use crate::iso::Iso;
use crate::{types, Calendar, Date, DateDuration, DateDurationUnit, DateTime, RangeError, Time};
use calendrical_calculations::helpers::I32CastError;
use calendrical_calculations::rata_die::RataDie;
use tinystr::tinystr;
/// The [Coptic Calendar]
///
/// The [Coptic calendar] is a solar calendar used by the Coptic Orthodox Church, with twelve normal months
/// and a thirteenth small epagomenal month.
///
/// This type can be used with [`Date`] or [`DateTime`] to represent dates in this calendar.
///
/// [Coptic calendar]: https://en.wikipedia.org/wiki/Coptic_calendar
///
/// # Era codes
///
/// This calendar supports two era codes: `"bd"`, and `"ad"`, corresponding to the Before Diocletian and After Diocletian/Anno Martyrum
/// eras. 1 A.M. is equivalent to 284 C.E.
///
/// # Month codes
///
/// This calendar supports 13 solar month codes (`"M01" - "M13"`), with `"M13"` being used for the short epagomenal month
/// at the end of the year.
#[derive(Copy, Clone, Debug, Hash, Default, Eq, PartialEq, PartialOrd, Ord)]
#[allow(clippy::exhaustive_structs)] // this type is stable
pub struct Coptic;
/// The inner date type used for representing [`Date`]s of [`Coptic`]. See [`Date`] and [`Coptic`] for more details.
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq, PartialOrd, Ord)]
pub struct CopticDateInner(pub(crate) ArithmeticDate<Coptic>);
impl CalendarArithmetic for Coptic {
type YearInfo = ();
fn month_days(year: i32, month: u8, _data: ()) -> u8 {
if (1..=12).contains(&month) {
30
} else if month == 13 {
if Self::is_leap_year(year, ()) {
6
} else {
5
}
} else {
0
}
}
fn months_for_every_year(_: i32, _data: ()) -> u8 {
13
}
fn is_leap_year(year: i32, _data: ()) -> bool {
year.rem_euclid(4) == 3
}
fn last_month_day_in_year(year: i32, _data: ()) -> (u8, u8) {
if Self::is_leap_year(year, ()) {
(13, 6)
} else {
(13, 5)
}
}
fn days_in_provided_year(year: i32, _data: ()) -> u16 {
if Self::is_leap_year(year, ()) {
366
} else {
365
}
}
}
impl Calendar for Coptic {
type DateInner = CopticDateInner;
fn date_from_codes(
&self,
era: Option<types::Era>,
year: i32,
month_code: types::MonthCode,
day: u8,
) -> Result<Self::DateInner, DateError> {
let year = if let Some(era) = era {
if era.0 == tinystr!(16, "ad") || era.0 == tinystr!(16, "coptic") {
if year <= 0 {
return Err(DateError::Range {
field: "year",
value: year,
min: 1,
max: i32::MAX,
});
}
year
} else if era.0 == tinystr!(16, "bd") || era.0 == tinystr!(16, "coptic-inverse") {
if year <= 0 {
return Err(DateError::Range {
field: "year",
value: year,
min: 1,
max: i32::MAX,
});
}
1 - year
} else {
return Err(DateError::UnknownEra(era));
}
} else {
year
};
ArithmeticDate::new_from_codes(self, year, month_code, day).map(CopticDateInner)
}
fn date_from_iso(&self, iso: Date<Iso>) -> CopticDateInner {
let fixed_iso = Iso::fixed_from_iso(*iso.inner());
Self::coptic_from_fixed(fixed_iso)
}
fn date_to_iso(&self, date: &Self::DateInner) -> Date<Iso> {
let fixed_coptic = Coptic::fixed_from_coptic(date.0);
Iso::iso_from_fixed(fixed_coptic)
}
fn months_in_year(&self, date: &Self::DateInner) -> u8 {
date.0.months_in_year()
}
fn days_in_year(&self, date: &Self::DateInner) -> u16 {
date.0.days_in_year()
}
fn days_in_month(&self, date: &Self::DateInner) -> u8 {
date.0.days_in_month()
}
fn day_of_week(&self, date: &Self::DateInner) -> types::IsoWeekday {
Iso.day_of_week(Coptic.date_to_iso(date).inner())
}
fn offset_date(&self, date: &mut Self::DateInner, offset: DateDuration<Self>) {
date.0.offset_date(offset, &());
}
#[allow(clippy::field_reassign_with_default)]
fn until(
&self,
date1: &Self::DateInner,
date2: &Self::DateInner,
_calendar2: &Self,
_largest_unit: DateDurationUnit,
_smallest_unit: DateDurationUnit,
) -> DateDuration<Self> {
date1.0.until(date2.0, _largest_unit, _smallest_unit)
}
fn year(&self, date: &Self::DateInner) -> types::YearInfo {
year_as_coptic(date.0.year)
}
fn is_in_leap_year(&self, date: &Self::DateInner) -> bool {
Self::is_leap_year(date.0.year, ())
}
fn month(&self, date: &Self::DateInner) -> types::MonthInfo {
date.0.month()
}
fn day_of_month(&self, date: &Self::DateInner) -> types::DayOfMonth {
date.0.day_of_month()
}
fn day_of_year_info(&self, date: &Self::DateInner) -> types::DayOfYearInfo {
let prev_year = date.0.year - 1;
let next_year = date.0.year + 1;
types::DayOfYearInfo {
day_of_year: date.0.day_of_year(),
days_in_year: date.0.days_in_year(),
prev_year: year_as_coptic(prev_year),
days_in_prev_year: Coptic::days_in_year_direct(prev_year),
next_year: year_as_coptic(next_year),
}
}
fn debug_name(&self) -> &'static str {
"Coptic"
}
fn any_calendar_kind(&self) -> Option<crate::AnyCalendarKind> {
Some(crate::any_calendar::IntoAnyCalendar::kind(self))
}
}
impl Coptic {
fn fixed_from_coptic(date: ArithmeticDate<Coptic>) -> RataDie {
calendrical_calculations::coptic::fixed_from_coptic(date.year, date.month, date.day)
}
pub(crate) fn coptic_from_fixed(date: RataDie) -> CopticDateInner {
let (year, month, day) = match calendrical_calculations::coptic::coptic_from_fixed(date) {
Err(I32CastError::BelowMin) => return CopticDateInner(ArithmeticDate::min_date()),
Err(I32CastError::AboveMax) => return CopticDateInner(ArithmeticDate::max_date()),
Ok(ymd) => ymd,
};
CopticDateInner(ArithmeticDate::new_unchecked(year, month, day))
}
fn days_in_year_direct(year: i32) -> u16 {
if Coptic::is_leap_year(year, ()) {
366
} else {
365
}
}
}
impl Date<Coptic> {
/// Construct new Coptic Date.
///
/// Negative years are in the B.D. era, starting with 0 = 1 B.D.
///
/// ```rust
/// use icu::calendar::Date;
///
/// let date_coptic = Date::try_new_coptic(1686, 5, 6)
/// .expect("Failed to initialize Coptic Date instance.");
///
/// assert_eq!(date_coptic.year().era_year_or_extended(), 1686);
/// assert_eq!(date_coptic.month().ordinal, 5);
/// assert_eq!(date_coptic.day_of_month().0, 6);
/// ```
pub fn try_new_coptic(year: i32, month: u8, day: u8) -> Result<Date<Coptic>, RangeError> {
ArithmeticDate::new_from_ordinals(year, month, day)
.map(CopticDateInner)
.map(|inner| Date::from_raw(inner, Coptic))
}
}
impl DateTime<Coptic> {
/// Construct a new Coptic datetime from integers.
///
/// Negative years are in the B.D. era, starting with 0 = 1 B.D.
///
/// ```rust
/// use icu::calendar::DateTime;
///
/// let datetime_coptic = DateTime::try_new_coptic(1686, 5, 6, 13, 1, 0)
/// .expect("Failed to initialize Coptic DateTime instance.");
///
/// assert_eq!(datetime_coptic.date.year().era_year_or_extended(), 1686);
/// assert_eq!(datetime_coptic.date.month().ordinal, 5);
/// assert_eq!(datetime_coptic.date.day_of_month().0, 6);
/// assert_eq!(datetime_coptic.time.hour.number(), 13);
/// assert_eq!(datetime_coptic.time.minute.number(), 1);
/// assert_eq!(datetime_coptic.time.second.number(), 0);
/// ```
pub fn try_new_coptic(
year: i32,
month: u8,
day: u8,
hour: u8,
minute: u8,
second: u8,
) -> Result<DateTime<Coptic>, DateError> {
Ok(DateTime {
date: Date::try_new_coptic(year, month, day)?,
time: Time::try_new(hour, minute, second, 0)?,
})
}
}
fn year_as_coptic(year: i32) -> types::YearInfo {
if year > 0 {
types::YearInfo::new(
year,
types::EraYear {
standard_era: tinystr!(16, "coptic").into(),
formatting_era: types::FormattingEra::Index(1, tinystr!(16, "AD")),
era_year: year,
ambiguity: types::YearAmbiguity::CenturyRequired,
},
)
} else {
types::YearInfo::new(
year,
types::EraYear {
standard_era: tinystr!(16, "coptic-inverse").into(),
formatting_era: types::FormattingEra::Index(0, tinystr!(16, "BD")),
era_year: 1 - year,
ambiguity: types::YearAmbiguity::EraAndCenturyRequired,
},
)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_coptic_regression() {
// https://github.com/unicode-org/icu4x/issues/2254
let iso_date = Date::try_new_iso(-100, 3, 3).unwrap();
let coptic = iso_date.to_calendar(Coptic);
let recovered_iso = coptic.to_iso();
assert_eq!(iso_date, recovered_iso);
}
}