deep_time/alloc_parse/

parse_date.rs

use crate::{
    ClassifiedDate, DateClassification, Dt, DtErr, DtErrKind, Lang, Mode, Order, OrderFirst,
    ParseCfg, STRTIME_SIZE, an_err, classify_date, generate_ambiguous_day_first_candidates,
    generate_ambiguous_month_first_candidates, generate_ambiguous_year_first_candidates,
    generate_unambiguous_candidates, parse_pure_numeric_unix_timestamp, parse_syslog_no_year,
    parse_yyyy_mm, smart_detect_date_order, try_pure_numeric,
};
use alloc::borrow::Cow;
use alloc::string::String;

impl Dt {
    /// Automatically parses datetime [`str`] into a [`Dt`] by guessing and generating the format. Supports the vast
    /// majority of date formats.
    ///
    /// - Requires the `"parse"` feature (which enables `alloc`).
    /// - The returned [`Dt`] is internally on the TAI time scale. The `attos` field is an [`i128`] attosecond
    ///   count since TAI 2000-01-01 noon. See
    ///   [`Scale`](../enum.Scale.html)
    ///   for more information.
    /// - The returned [`Dt`] is **not** in local time, if a timezone is parsed then it's used to find the offset
    ///   to return non-local instant.
    ///
    /// ## Parameters
    ///
    /// - `s`: The string to parse. Must be non-empty and no longer than [`STRTIME_SIZE`] bytes. Empty strings
    ///   or overly long inputs return an error.
    /// - `opts`: The [`ParseCfg`] to use. Pass `&ParseCfg::DEFAULT` (or `&ParseCfg::default()`)
    ///   to use the standard smart defaults. You can create a `ParseCfg` once and pass `&cfg`
    ///   on every call for consistent behavior and to avoid repeated construction.
    ///
    /// ## Configuration Options
    ///
    /// These are the fields of the configuration options struct [`ParseCfg`], their types and defaults.
    ///
    /// See [`ParseCfg`] for more information.
    ///
    /// | Field          | Type and Default     | Effect |
    /// |----------------|----------------------------------|--------|
    /// | `lang`         | [`Lang::En`]                     | Language, scroll down to see currently supported languages                                        |
    /// | `order`        | [`Order::Smart`]                 | How to resolve ambiguous numeric dates like `01/02/03`                                            |
    /// | `mode`         | [`Mode::Auto`]                   | Special handling for purely numeric inputs                                                        |
    /// | `parse`        | [`Option<Vec<String>>`] - `None` | An explicit list of formats to try, if the [`Mode`] is Explicit then only these formats are tried |
    /// | `relative`     | [`bool`] - `true`                | Enable phrases like "tomorrow", "in 3 days"                   |
    /// | `ref_time`     | [`Option<Dt>`] - `None`          | Reference time for relative dates and syslog-style "no-year" dates                                |
    /// | `to_lower`     | [`bool`] - `true`                | Automatically lowercase the input, **only** set to false if it's already lowercase                |
    ///
    /// ## Purely Numeric Inputs
    ///
    /// When the input consists **only** of digits (and optionally a decimal point),
    /// the parser uses a fast, mode-aware path before trying any other strategies.
    /// The exact interpretation depends on the number of digits and the selected `mode`.
    ///
    /// | Digits | Example(s)               | `Mode`          | Interpreted as                          | Notes |
    /// |--------|--------------------------|-----------------|-----------------------------------------|-------|
    /// | 1–4    | `2024`, `24`, `5`        | `Auto`/`Legacy` | Year (2-digit uses 2000/1900 pivot)    | 1- and 3-digit years only work in `Scientific` |
    /// | 5      | `24123`, `60400`         | `Legacy`        | Ordinal date (YYDDD)                    | — |
    /// | 5      | `60400`, `60400.75`      | `Scientific`    | Modified Julian Date (MJD)              | Fractional days supported |
    /// | 5      | `24123`, `60400.75`      | `Auto`          | Ordinal (non-decimal) or MJD (decimal) | Smart default |
    /// | 6      | `240315`, `202403`       | `Auto`          | YYYYMM if plausible year, else YYMMDD   | Most common compact form |
    /// | 6      | `240315`                 | `Legacy`        | YYMMDD preferred                        | — |
    /// | 6      | `202403`                 | `Scientific`    | YYYYMM preferred                        | — |
    /// | 7      | `2024123`                | `Legacy`        | Ordinal date (YYYYDDD)                  | — |
    /// | 7      | `2460123`, `2460123.5`   | `Scientific`    | Julian Day (JD)                         | Fractional days supported |
    /// | 7      | `2024123`                | `Auto`          | Ordinal (integer) or JD (decimal)       | Smart default |
    /// | 10–11  | `1735689600`             | any             | Unix seconds                            | — |
    /// | 12–15  | `1735689600123`          | any             | Unix milliseconds                       | Most common high-precision case |
    /// | 16–18  | `1735689600123456`       | any             | Unix microseconds                       | — |
    /// | 19+    | `1735689600123456789`    | any             | Unix nanoseconds                        | Full precision |
    ///
    /// Use `Mode::UnixTimestamp` when you know the input is always a Unix timestamp.
    ///
    /// ## Ambiguous Numeric Dates
    ///
    /// Dates where the components could map to different orders (e.g. `01/02/03`,
    /// `3-4-5`, `15.03.24`, `2024.03.15`) are resolved via the `order` field:
    ///
    /// - **`Order::Smart`** (default) — Applies the fast heuristic described in [`Order::Smart`].
    ///   It strongly prefers modern/tech conventions (Year-first for compact/ISO-like data)
    ///   while handling the majority of international and US-style dates.
    ///
    /// - **`Order::Year`**, **`Order::Day`**, or **`Order::Month`** prefer that
    ///   order first, then try the other two (same fallback chains as Smart).
    ///
    /// ## Supported Formats
    ///
    /// The parser tokenizes known words (month/day names, relative phrases, timezones, etc.), generates candidate
    /// formats from the token pattern, and tries them until one matches. Thousands of layouts are supported.
    ///
    /// Separators generally don't matter, they could be spaces, slashes, or hyphens, but **not colons** - colons are
    /// reserved for the time connector, times, and offsets.
    ///
    /// Generally speaking the date part must come first, and stuff like time components, offsets and iana timezone names
    /// must come afterwards.
    ///
    /// - **ISO 8601** and variants: `2024-03-15`, `2024-03-15T14:30:00Z`, `2024-03-15T14:30:00+01:00[Europe/Paris]`
    /// - **Named dates** (in supported languages): `15 March 2024`, `15 mars 2024`, `15. März 2024`, `15 de marzo de 2024`
    /// - **Week dates**: `2024-W15`, `2024-W15-3`, `2024W15` (missing weekday defaults to Monday)
    /// - **Syslog-style** (no year): `Mar  5 10:23:45` (year inferred from `ref_time`)
    /// - **Relative expressions**: `tomorrow`, `in 3 days`, `2 weeks ago`
    /// - **12-hour time**: `2:30 PM`, `14:30:45.123`
    /// - **Offsets and timezones**: `+0100`, `-05:30`, `Z`, IANA timezone names (with the `jiff-tz` feature enabled)
    /// - **Library time scales**: `TAI`, `TT`, etc. are detected and parsed, must come after the date part of the input
    ///
    /// Relative dates are also automatically supported, except for bare numbers with no colons like `0900`, as these
    /// are differently interpreted.
    ///
    /// ## Examples
    ///
    /// ```rust
    /// use deep_time::{Dt, ParseCfg, Order, Mode, Scale};
    ///
    /// // Default smart parsing
    /// let dt = Dt::from_str_parse("2024-03-15 14:30:00", &ParseCfg::DEFAULT).unwrap();
    ///
    /// // German named date (requires the `de` feature)
    /// # #[cfg(feature = "de")]
    /// # {
    /// # use deep_time::Lang;
    /// let cfg = ParseCfg { lang: Lang::De, ..Default::default() };
    /// let dt = Dt::from_str_parse("15. März 2024 um 14:30", &cfg).unwrap();
    /// # }
    ///
    /// // Pure numeric compact form
    /// let dt = Dt::from_str_parse("20240315", &ParseCfg::DEFAULT).unwrap(); // March 15, 2024
    ///
    /// // Unix timestamp (milliseconds)
    /// let cfg = ParseCfg { mode: Mode::UnixTimestamp, ..Default::default() };
    /// let dt = Dt::from_str_parse("1735689600123", &cfg).unwrap();
    ///
    /// // Explicit formats only (no fallback). Partial dates (`%Y`, `%Y-%m`)
    /// // default missing month/day to 1.
    /// let cfg = ParseCfg {
    ///     parse: Some(vec!["%d/%m/%Y".into(), "%Y-%m-%d".into(), "%Y".into()]),
    ///     mode: Mode::Explicit,
    ///     ..Default::default()
    /// };
    /// let dt = Dt::from_str_parse("15/03/2024", &cfg).unwrap();
    /// let yr = Dt::from_str_parse("2024", &cfg).unwrap();
    /// assert_eq!(yr, Dt::from_ymd(2024, 1, 1, Scale::UTC, 0, 0, 0, 0));
    ///
    /// // Relative dates — build config once, borrow repeatedly
    /// let ref_time = Dt::from_ymd(2026, 6, 16, Scale::UTC, 12, 0, 0, 0);
    /// let cfg = ParseCfg {
    ///     ref_time: Some(ref_time),
    ///     ..Default::default()
    /// };
    /// let dt = Dt::from_str_parse("next Monday at 14:00", &cfg).unwrap();
    ///
    /// assert_eq!(dt, Dt::from_ymd(2026, 6, 22, Scale::UTC, 14, 0, 0, 0));
    /// ```
    ///
    /// ## Notes
    ///
    /// - The `Smart` + `Auto` combination gives the best real-world success rate for mixed data.
    /// - Relative expressions and syslog-style no-year dates need a reference time. If `ref_time` is `None`
    ///   and the `std` feature is enabled, system time is used; without `std`, set `ref_time` explicitly or
    ///   parsing will fail.
    /// - All successfully parsed [`Dt`] values are stored with attosecond precision on the internal
    ///   TAI timescale.
    /// - Timezone handling (IANA names and fixed offsets) is fully supported when the `jiff-tz` feature
    ///   is enabled.
    ///
    /// ## Supported Languages:
    ///
    /// Language support here basically means supporting abbreviated and full day and month names.
    /// Non-Ascii types of numeric characters are also supported such as full width digits.
    ///
    /// Some day/month names in non-English languages are not supported due to clashes, any such missing
    /// support is noted below.
    ///
    /// - En
    /// - De
    ///     - Won't parse "t" as short form for day.
    /// - Es
    ///     - English word "ago" won't be detected as relative date word.
    ///     - Won't parse "mar" as tuesday, will instead parse as march.
    /// - Fr
    ///     - Won't parse "mar" as tuesday, will instead parse as march.
    ///
    /// ## See also
    ///
    /// - [`ParseCfg`]
    /// - [`Order`]
    /// - [`Mode`]
    /// - [`Lang`]
    /// - [`Dt`](../struct.Dt.html)
    /// - [`Dt::from_str`](../struct.Dt.html#method.from_str)
    pub fn from_str_parse(s: &str, opts: &ParseCfg) -> Result<Dt, DtErr> {
        if s.is_empty() {
            return Err(an_err!(DtErrKind::Empty));
        } else if s.len() > STRTIME_SIZE {
            return Err(an_err!(DtErrKind::InvalidLen));
        }

        let lang: Lang = opts.lang;
        let ref_time = &opts.ref_time;

        let lowered: Cow<str> = if opts.to_lower {
            Cow::Owned(s.to_lowercase())
        } else {
            Cow::Borrowed(s)
        };

        let classification = match classify_date(&lowered, lang, ref_time, opts.relative) {
            Ok(ClassifiedDate::Parsed(time_point)) => return Ok(time_point),
            Ok(ClassifiedDate::Cls(c)) => c,
            Err(e) => {
                // std::eprintln!("{}", e);
                return Err(an_err!(" {}", s => e));
            }
        };

        // eprintln!("{:?}", classification);

        // let xx = &classification.date;
        // if xx != trimmed {
        //     eprintln!("NOT EQUAL: {:?}, {:?}", trimmed, xx);
        // }
        // eprintln!("BEFORE & AFTER: {:?}, {:?}", lowered, &classification.date);

        let normalized = &classification.date;

        let (mode, date_order) = if let Some(formats) = &opts.parse {
            if !formats.is_empty() {
                for fmt in formats {
                    // `allow_partial_date = true`: formats that omit month/day
                    // (e.g. `%Y`, `%Y-%m`, `%y`) default the missing fields to 1
                    // via [`Parts::finish`]. Matches `try_compatible_formats`.
                    // Without this, Explicit `%Y` on `"2024"` fails with Incomplete.
                    if let Ok(value) = Self::from_strptime(normalized, fmt, true, true, true) {
                        return Ok(value);
                    }
                }
                // None of the provided formats worked and mode is Explicit
                if opts.mode == Mode::Explicit {
                    return Err(an_err!(DtErrKind::InvalidInput, "{}", s));
                }
            }
            (opts.mode, opts.order)
        } else {
            (opts.mode, opts.order)
        };

        // if s == "on the 5th of april 2024 at 00:00am" {
        //     std::eprintln!("{:?}", classification);
        // }
        // std::eprintln!("{:?}", classification);

        if classification.is_pure_numeric {
            match mode {
                Mode::UnixTimestamp => {
                    if let Some(dt) = parse_pure_numeric_unix_timestamp(
                        normalized,
                        classification.num_non_decimal_digits as usize,
                    ) {
                        return Ok(dt);
                    }
                }
                _ => {
                    if let Some(dt) = try_pure_numeric(
                        normalized,
                        classification.num_digits,
                        classification.num_non_decimal_digits,
                        classification.is_decimal,
                        mode,
                    ) {
                        // std::eprintln!("NUMERIC INPUT SUCCESS: {:?}", s);
                        return Ok(dt);
                    }
                }
            }
        }
        if !classification.has_year
            && let Some(dt) = parse_syslog_no_year(normalized, lang, ref_time)
        {
            return Ok(dt);
        }
        if let Some(dt) = match date_order {
            Order::Smart => {
                let order = smart_detect_date_order(normalized, &classification);
                let mut result: Option<Dt>;

                match order {
                    OrderFirst::Day => {
                        result = try_compatible_formats(
                            normalized,
                            generate_ambiguous_day_first_candidates(&classification),
                        );
                        // std::eprintln!("done trying day first: {:?}", result);

                        if result.is_none() {
                            result = try_compatible_formats(
                                normalized,
                                generate_ambiguous_month_first_candidates(&classification),
                            );
                            // std::eprintln!("done trying month first: {:?}", result);
                        }

                        if result.is_none() {
                            result = try_compatible_formats(
                                normalized,
                                generate_ambiguous_year_first_candidates(&classification),
                            );
                            // std::eprintln!("done trying year first: {:?}", result);
                        }
                    }
                    OrderFirst::Month => {
                        result = try_compatible_formats(
                            normalized,
                            generate_ambiguous_month_first_candidates(&classification),
                        );
                        // std::eprintln!("done trying month first: {:?}", result);

                        if result.is_none() {
                            result = try_compatible_formats(
                                normalized,
                                generate_ambiguous_day_first_candidates(&classification),
                            );
                            // std::eprintln!("done trying day first: {:?}", result);
                        }

                        if result.is_none() {
                            result = try_compatible_formats(
                                normalized,
                                generate_ambiguous_year_first_candidates(&classification),
                            );
                            // std::eprintln!("done trying year first: {:?}", result);
                        }
                    }
                    OrderFirst::Year => {
                        result = try_compatible_formats(
                            normalized,
                            generate_ambiguous_year_first_candidates(&classification),
                        );
                        // std::eprintln!("done trying year first: {:?}", result);

                        if result.is_none() {
                            result = try_compatible_formats(
                                normalized,
                                generate_ambiguous_day_first_candidates(&classification),
                            );
                            // std::eprintln!("done trying day first: {:?}", result);
                        }

                        if result.is_none() {
                            result = try_compatible_formats(
                                normalized,
                                generate_ambiguous_month_first_candidates(&classification),
                            );
                            // std::eprintln!("done trying month first: {:?}", result);
                        }
                    }
                }

                result
            }
            // Preferred order first, then the other two (same chains as Smart).
            // try_unambiguous stays last, after this whole match.
            Order::Year => {
                let mut result = try_compatible_formats(
                    normalized,
                    generate_ambiguous_year_first_candidates(&classification),
                );
                if result.is_none() {
                    result = try_compatible_formats(
                        normalized,
                        generate_ambiguous_day_first_candidates(&classification),
                    );
                }
                if result.is_none() {
                    result = try_compatible_formats(
                        normalized,
                        generate_ambiguous_month_first_candidates(&classification),
                    );
                }
                result
            }
            Order::Day => {
                let mut result = try_compatible_formats(
                    normalized,
                    generate_ambiguous_day_first_candidates(&classification),
                );
                if result.is_none() {
                    result = try_compatible_formats(
                        normalized,
                        generate_ambiguous_month_first_candidates(&classification),
                    );
                }
                if result.is_none() {
                    result = try_compatible_formats(
                        normalized,
                        generate_ambiguous_year_first_candidates(&classification),
                    );
                }
                result
            }
            Order::Month => {
                let mut result = try_compatible_formats(
                    normalized,
                    generate_ambiguous_month_first_candidates(&classification),
                );
                if result.is_none() {
                    result = try_compatible_formats(
                        normalized,
                        generate_ambiguous_day_first_candidates(&classification),
                    );
                }
                if result.is_none() {
                    result = try_compatible_formats(
                        normalized,
                        generate_ambiguous_year_first_candidates(&classification),
                    );
                }
                result
            }
        } {
            return Ok(dt);
        }
        if let Some(dt) = try_unambiguous(normalized, &classification) {
            return Ok(dt);
        }
        // std::eprintln!("NOW trying numeric timestamp");
        if classification.is_pure_numeric
            && mode != Mode::UnixTimestamp
            && let Some(dt) = parse_pure_numeric_unix_timestamp(
                normalized,
                classification.num_non_decimal_digits as usize,
            )
        {
            return Ok(dt);
        }
        Err(an_err!(DtErrKind::InvalidInput, "{}", s))
    }

    /// Same parsing logic as [`Dt::from_str_parse`](../struct.Dt.html#method.from_str_parse),
    /// but returns attoseconds since the library epoch: 2000-01-01 12:00:00 UTC
    /// (on the UTC scale).
    ///
    /// Returns `Some(attos)` on success (negative for pre-2000 dates) or `None`
    /// on any parse error.
    #[inline]
    pub fn str_to_attos(s: &str, opts: &ParseCfg) -> Option<i128> {
        Dt::from_str_parse(s, opts).ok().map(|dt| dt.to_attos())
    }

    /// Same parsing logic as [`Dt::from_str_parse`](../struct.Dt.html#method.from_str_parse),
    /// but returns milliseconds since the library epoch: 2000-01-01 12:00:00 UTC
    /// (on the UTC scale).
    ///
    /// Returns `Some(millis)` on success (negative for pre-2000 dates) or `None`
    /// on any parse error.
    #[inline]
    pub fn str_to_ms(s: &str, opts: &ParseCfg) -> Option<i128> {
        Dt::from_str_parse(s, opts).ok().map(|dt| dt.to_ms().0)
    }

    /// Same parsing logic as [`Dt::from_str_parse`](../struct.Dt.html#method.from_str_parse),
    /// but returns nanoseconds since the library epoch: 2000-01-01 12:00:00 UTC
    /// (on the UTC scale).
    ///
    /// Returns `Some(nanos)` on success (negative for pre-2000 dates) or `None`
    /// on any parse error.
    #[inline]
    pub fn str_to_ns(s: &str, opts: &ParseCfg) -> Option<i128> {
        Dt::from_str_parse(s, opts).ok().map(|dt| dt.to_ns().0)
    }

    /// Same parsing logic as [`Dt::from_str_parse`](../struct.Dt.html#method.from_str_parse),
    /// but returns milliseconds since the UNIX epoch: (1970-01-01 00:00:00 UTC).
    ///
    /// Returns `Some(millis)` on success (negative for pre-2000 dates) or `None`
    /// on any parse error.
    #[inline]
    pub fn str_to_unix_ms(s: &str, opts: &ParseCfg) -> Option<i128> {
        Dt::from_str_parse(s, opts)
            .ok()
            .map(|dt| dt.to_scale_and_diff(Dt::UNIX_EPOCH, false).to_ms().0)
    }

    /// Same parsing logic as [`Dt::from_str_parse`](../struct.Dt.html#method.from_str_parse),
    /// but returns nanoseconds since the UNIX epoch: (1970-01-01 00:00:00 UTC).
    ///
    /// Returns `Some(nanos)` on success (negative for pre-2000 dates) or `None`
    /// on any parse error.
    #[inline]
    pub fn str_to_unix_ns(s: &str, opts: &ParseCfg) -> Option<i128> {
        Dt::from_str_parse(s, opts)
            .ok()
            .map(|dt| dt.to_scale_and_diff(Dt::UNIX_EPOCH, false).to_ns().0)
    }
}

/// Core zero-allocation helper (updated to match the new `&str` signature).
///
/// The `fmt` we get from the iterator is still `'static`, but it coerces automatically
/// to `&str`, so everything continues to work.
#[inline]
pub(crate) fn try_compatible_formats<I>(s: &str, formats: I) -> Option<Dt>
where
    I: IntoIterator<Item = String>,
{
    // let mut dt = None;

    // for fmt in formats.into_iter() {
    //     eprintln!("TRYING FMT: {}", fmt);
    //     dt = match Dt::from_strptime(s, &fmt, true, true, true) {
    //         Ok(parsed) => Some(parsed),
    //         Err(e) => {
    //             eprintln!("  FAILED with: {:?}", e);
    //             continue;
    //         }
    //     };
    //     if dt.is_some() {
    //         break;
    //     }
    //     // === DEBUG ===
    //     // eprintln!("Tried format: {:?}", fmt);
    // }

    // dt
    formats
        .into_iter()
        .find_map(|fmt| Dt::from_strptime(s, &fmt, true, true, true).ok())
}

#[inline]
pub(crate) fn try_unambiguous(s: &str, classification: &DateClassification) -> Option<Dt> {
    if matches!(classification.bytes_len, 6..=8)
        && let Some(dt) = parse_yyyy_mm(s.as_bytes())
    {
        return Some(dt);
    }
    try_compatible_formats(s, generate_unambiguous_candidates(classification))
}