Quelle  ToString.cpp   Sprache: C

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=8 sts=2 et sw=2 tw=80:
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "builtin/temporal/ToString.h"

#include "mozilla/Assertions.h"

#include <cstdlib>
#include <stddef.h>
#include <stdint.h>
#include <string_view>

#include "builtin/temporal/Calendar.h"
#include "builtin/temporal/Crash.h"
#include "builtin/temporal/Instant.h"
#include "builtin/temporal/PlainDate.h"
#include "builtin/temporal/PlainDateTime.h"
#include "builtin/temporal/PlainMonthDay.h"
#include "builtin/temporal/PlainYearMonth.h"
#include "builtin/temporal/Temporal.h"
#include "builtin/temporal/TemporalTypes.h"
#include "builtin/temporal/TemporalUnit.h"
#include "builtin/temporal/TimeZone.h"
#include "builtin/temporal/ZonedDateTime.h"
#include "js/RootingAPI.h"
#include "util/StringBuilder.h"
#include "vm/StringType.h"

using namespace js;
using namespace js::temporal;

enum class TemporalStringFormat {
  None,
  Date,
  Time,
  DateTime,
  YearMonth,
  MonthDay,
  ZonedDateTime,
  Instant,
};

enum class Critical : bool { No, Yes };

class TemporalStringBuilder {
  JSStringBuilder sb_;

  TemporalStringFormat kind_ = TemporalStringFormat::None;

#ifdef DEBUG
  bool reserved_ = false;
#endif

  static constexpr size_t reserveAmount(TemporalStringFormat format) {
    // Note: This doesn't reserve too much space, because the string builder
    // already internally reserves space for 64 characters.

    constexpr size_t datePart = 1 + 6 + 1 + 2 + 1 + 2;        // 13
    constexpr size_t timePart = 2 + 1 + 2 + 1 + 2 + 1 + 9;    // 18
    constexpr size_t dateTimePart = datePart + 1 + timePart;  // including 'T'
    constexpr size_t timeZoneOffsetPart = 1 + 2 + 1 + 2;      // 6

    switch (format) {
      case TemporalStringFormat::Date:
      case TemporalStringFormat::YearMonth:
      case TemporalStringFormat::MonthDay:
        return datePart;
      case TemporalStringFormat::Time:
        return timePart;
      case TemporalStringFormat::DateTime:
        return dateTimePart;
      case TemporalStringFormat::ZonedDateTime:
        return dateTimePart + timeZoneOffsetPart;
      case TemporalStringFormat::Instant:
        return dateTimePart + timeZoneOffsetPart;
      case TemporalStringFormat::None:
        break;
    }
    JS_CONSTEXPR_CRASH("invalid reserve amount");
  }

 public:
  TemporalStringBuilder(JSContext* cx, TemporalStringFormat kind)
      : sb_(cx), kind_(kind) {
    MOZ_ASSERT(kind != TemporalStringFormat::None);
  }

  bool reserve() {
    MOZ_ASSERT(!reserved_);

    if (!sb_.reserve(reserveAmount(kind_))) {
      return false;
    }

#ifdef DEBUG
    reserved_ = true;
#endif
    return true;
  }

  void append(char value) {
    MOZ_ASSERT(reserved_);
    sb_.infallibleAppend(value);
  }

  void appendTwoDigit(int32_t value) {
    MOZ_ASSERT(0 <= value && value <= 99);
    MOZ_ASSERT(reserved_);

    sb_.infallibleAppend(char('0' + (value / 10)));
    sb_.infallibleAppend(char('0' + (value % 10)));
  }

  void appendFourDigit(int32_t value) {
    MOZ_ASSERT(0 <= value && value <= 9999);
    MOZ_ASSERT(reserved_);

    sb_.infallibleAppend(char('0' + (value / 1000)));
    sb_.infallibleAppend(char('0' + (value % 1000) / 100));
    sb_.infallibleAppend(char('0' + (value % 100) / 10));
    sb_.infallibleAppend(char('0' + (value % 10)));
  }

  void appendSixDigit(int32_t value) {
    MOZ_ASSERT(0 <= value && value <= 999999);
    MOZ_ASSERT(reserved_);

    sb_.infallibleAppend(char('0' + (value / 100000)));
    sb_.infallibleAppend(char('0' + (value % 100000) / 10000));
    sb_.infallibleAppend(char('0' + (value % 10000) / 1000));
    sb_.infallibleAppend(char('0' + (value % 1000) / 100));
    sb_.infallibleAppend(char('0' + (value % 100) / 10));
    sb_.infallibleAppend(char('0' + (value % 10)));
  }

  void appendYear(int32_t year) {
    if (0 <= year && year <= 9999) {
      appendFourDigit(year);
    } else {
      append(year < 0 ? '-' : '+');
      appendSixDigit(std::abs(year));
    }
  }

  bool appendCalendarAnnnotation(std::string_view id, Critical critical) {
    std::string_view start = bool(critical) ? "[!u-ca=" : "[u-ca=";
    return sb_.append(start.data(), start.length()) &&
           sb_.append(id.data(), id.length()) && sb_.append(']');
  }

  bool appendTimeZoneAnnnotation(const JSLinearString* id, Critical critical) {
    std::string_view start = bool(critical) ? "[!" : "[";
    return sb_.append(start.data(), start.length()) && sb_.append(id) &&
           sb_.append(']');
  }

  auto* finishString() { return sb_.finishString(); }
};

/**
 * FormatFractionalSeconds ( subSecondNanoseconds, precision )
 */
static void FormatFractionalSeconds(TemporalStringBuilder& result,
                                    int32_t subSecondNanoseconds,
                                    Precision precision) {
  MOZ_ASSERT(0 <= subSecondNanoseconds && subSecondNanoseconds < 1'000'000'000);
  MOZ_ASSERT(precision != Precision::Minute());

  // Steps 1-2.
  if (precision == Precision::Auto()) {
    // Step 1.a.
    if (subSecondNanoseconds == 0) {
      return;
    }

    // Step 3. (Reordered)
    result.append('.');

    // Steps 1.b-c.
    int32_t k = 100'000'000;
    do {
      result.append(char('0' + (subSecondNanoseconds / k)));
      subSecondNanoseconds %= k;
      k /= 10;
    } while (subSecondNanoseconds);
  } else {
    // Step 2.a.
    uint8_t p = precision.value();
    if (p == 0) {
      return;
    }

    // Step 3. (Reordered)
    result.append('.');

    // Steps 2.b-c.
    int32_t k = 100'000'000;
    for (uint8_t i = 0; i < p; i++) {
      result.append(char('0' + (subSecondNanoseconds / k)));
      subSecondNanoseconds %= k;
      k /= 10;
    }
  }
}

/**
 * FormatTimeString ( hour, minute, second, subSecondNanoseconds, precision )
 */
static void FormatTimeString(TemporalStringBuilder& result, const Time& time,
                             Precision precision) {
  // Step 1.
  result.appendTwoDigit(time.hour);

  // Step 2.
  result.append(':');
  result.appendTwoDigit(time.minute);

  // Steps 4-7.
  if (precision != Precision::Minute()) {
    result.append(':');
    result.appendTwoDigit(time.second);

    int32_t subSecondNanoseconds = time.millisecond * 1'000'000 +
                                   time.microsecond * 1'000 + time.nanosecond;
    FormatFractionalSeconds(result, subSecondNanoseconds, precision);
  }
}

static void FormatDateString(TemporalStringBuilder& result,
                             const ISODate& date) {
  result.appendYear(date.year);
  result.append('-');
  result.appendTwoDigit(date.month);
  result.append('-');
  result.appendTwoDigit(date.day);
}

static void FormatDateTimeString(TemporalStringBuilder& result,
                                 const ISODateTime& dateTime,
                                 Precision precision) {
  FormatDateString(result, dateTime.date);
  result.append('T');
  FormatTimeString(result, dateTime.time, precision);
}

/**
 * FormatOffsetTimeZoneIdentifier ( offsetMinutes [ , style ] )
 */
static void FormatOffsetTimeZoneIdentifier(TemporalStringBuilder& result,
                                           int32_t offsetMinutes) {
  MOZ_ASSERT(std::abs(offsetMinutes) < UnitsPerDay(TemporalUnit::Minute),
             "time zone offset mustn't exceed 24-hours");

  // Step 1.
  char sign = offsetMinutes >= 0 ? '+' : '-';

  // Step 2.
  int32_t absoluteMinutes = std::abs(offsetMinutes);

  // Step 3.
  int32_t hours = absoluteMinutes / 60;

  // Step 4.
  int32_t minutes = absoluteMinutes % 60;

  // Steps 5-6. (Inlined FormatTimeString)
  result.append(sign);
  result.appendTwoDigit(hours);
  result.append(':');
  result.appendTwoDigit(minutes);
}

// Returns |RoundNumberToIncrement(offsetNanoseconds, 60 × 10^9, "halfExpand")|
// divided by |60 × 10^9|.
static int32_t RoundNanosecondsToMinutes(int64_t offsetNanoseconds) {
  MOZ_ASSERT(std::abs(offsetNanoseconds) < ToNanoseconds(TemporalUnit::Day));

  constexpr int64_t increment = ToNanoseconds(TemporalUnit::Minute);

  int64_t quotient = offsetNanoseconds / increment;
  int64_t remainder = offsetNanoseconds % increment;
  if (std::abs(remainder * 2) >= increment) {
    quotient += (offsetNanoseconds > 0 ? 1 : -1);
  }
  return int32_t(quotient);
}

/**
 * FormatDateTimeUTCOffsetRounded ( offsetNanoseconds )
 */
static void FormatDateTimeUTCOffsetRounded(TemporalStringBuilder& result,
                                           int64_t offsetNanoseconds) {
  MOZ_ASSERT(std::abs(offsetNanoseconds) < ToNanoseconds(TemporalUnit::Day));

  // Steps 1-3.
  int32_t offsetMinutes = RoundNanosecondsToMinutes(offsetNanoseconds);

  // Step 4.
  FormatOffsetTimeZoneIdentifier(result, offsetMinutes);
}

/**
 * FormatCalendarAnnotation ( id, showCalendar )
 */
static bool FormatCalendarAnnotation(TemporalStringBuilder& result,
                                     const CalendarValue& calendar,
                                     ShowCalendar showCalendar) {
  switch (showCalendar) {
    case ShowCalendar::Never:
      return true;

    case ShowCalendar::Auto: {
      if (calendar.identifier() == CalendarId::ISO8601) {
        return true;
      }
      [[fallthrough]];
    }

    case ShowCalendar::Always: {
      auto id = CalendarIdentifier(calendar);
      return result.appendCalendarAnnnotation(id, Critical::No);
    }

    case ShowCalendar::Critical: {
      auto id = CalendarIdentifier(calendar);
      return result.appendCalendarAnnnotation(id, Critical::Yes);
    }
  }
  MOZ_CRASH("bad calendar option");
}

static bool FormatTimeZoneAnnotation(TemporalStringBuilder& result,
                                     const TimeZoneValue& timeZone,
                                     ShowTimeZoneName showTimeZone) {
  switch (showTimeZone) {
    case ShowTimeZoneName::Never:
      return true;

    case ShowTimeZoneName::Auto:
      return result.appendTimeZoneAnnnotation(timeZone.identifier(),
                                              Critical::No);

    case ShowTimeZoneName::Critical:
      return result.appendTimeZoneAnnnotation(timeZone.identifier(),
                                              Critical::Yes);
  }
  MOZ_CRASH("bad time zone option");
}

/**
 * TemporalInstantToString ( instant, timeZone, precision )
 */
JSString* js::temporal::TemporalInstantToString(JSContext* cx,
                                                const EpochNanoseconds& epochNs,
                                                Handle<TimeZoneValue> timeZone,
                                                Precision precision) {
  TemporalStringBuilder result(cx, TemporalStringFormat::Instant);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-2.
  int64_t offsetNanoseconds = 0;
  if (timeZone) {
    if (!GetOffsetNanosecondsFor(cx, timeZone, epochNs, &offsetNanoseconds)) {
      return nullptr;
    }
    MOZ_ASSERT(std::abs(offsetNanoseconds) < ToNanoseconds(TemporalUnit::Day));
  }

  // Step 3. (Not applicable in our implementation.)

  // Step 4.
  auto dateTime = GetISODateTimeFor(epochNs, offsetNanoseconds);

  // Step 5. (Inlined ISODateTimeToString)
  FormatDateTimeString(result, dateTime, precision);

  // Steps 6-7.
  Rooted<JSString*> timeZoneString(cx);
  if (!timeZone) {
    result.append('Z');
  } else {
    FormatDateTimeUTCOffsetRounded(result, offsetNanoseconds);
  }

  // Step 8.
  return result.finishString();
}

/**
 * TemporalDateToString ( temporalDate, showCalendar )
 */
JSString* js::temporal::TemporalDateToString(
    JSContext* cx, Handle<PlainDateObject*> temporalDate,
    ShowCalendar showCalendar) {
  auto date = temporalDate->date();

  TemporalStringBuilder result(cx, TemporalStringFormat::Date);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-3.
  FormatDateString(result, date);

  // Step 4.
  if (!FormatCalendarAnnotation(result, temporalDate->calendar(),
                                showCalendar)) {
    return nullptr;
  }

  // Step 5.
  return result.finishString();
}

/**
 * ISODateTimeToString ( isoDateTime, calendar, precision, showCalendar )
 */
JSString* js::temporal::ISODateTimeToString(JSContext* cx,
                                            const ISODateTime& isoDateTime,
                                            Handle<CalendarValue> calendar,
                                            Precision precision,
                                            ShowCalendar showCalendar) {
  MOZ_ASSERT(IsValidISODateTime(isoDateTime));

  TemporalStringBuilder result(cx, TemporalStringFormat::DateTime);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-5.
  FormatDateTimeString(result, isoDateTime, precision);

  // Step 6.
  if (!FormatCalendarAnnotation(result, calendar, showCalendar)) {
    return nullptr;
  }

  // Step 7.
  return result.finishString();
}

/**
 * TimeRecordToString ( time, precision )
 */
JSString* js::temporal::TimeRecordToString(JSContext* cx, const Time& time,
                                           Precision precision) {
  TemporalStringBuilder result(cx, TemporalStringFormat::Time);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-2.
  FormatTimeString(result, time, precision);

  return result.finishString();
}

/**
 * TemporalMonthDayToString ( monthDay, showCalendar )
 */
JSString* js::temporal::TemporalMonthDayToString(
    JSContext* cx, Handle<PlainMonthDayObject*> monthDay,
    ShowCalendar showCalendar) {
  TemporalStringBuilder result(cx, TemporalStringFormat::MonthDay);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-4.
  auto date = monthDay->date();
  if (showCalendar == ShowCalendar::Always ||
      showCalendar == ShowCalendar::Critical ||
      monthDay->calendar().identifier() != CalendarId::ISO8601) {
    FormatDateString(result, date);
  } else {
    result.appendTwoDigit(date.month);
    result.append('-');
    result.appendTwoDigit(date.day);
  }

  // Steps 5-6.
  if (!FormatCalendarAnnotation(result, monthDay->calendar(), showCalendar)) {
    return nullptr;
  }

  // Step 7.
  return result.finishString();
}

/**
 * TemporalYearMonthToString ( yearMonth, showCalendar )
 */
JSString* js::temporal::TemporalYearMonthToString(
    JSContext* cx, Handle<PlainYearMonthObject*> yearMonth,
    ShowCalendar showCalendar) {
  TemporalStringBuilder result(cx, TemporalStringFormat::YearMonth);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-4.
  auto date = yearMonth->date();
  if (showCalendar == ShowCalendar::Always ||
      showCalendar == ShowCalendar::Critical ||
      yearMonth->calendar().identifier() != CalendarId::ISO8601) {
    FormatDateString(result, date);
  } else {
    result.appendYear(date.year);
    result.append('-');
    result.appendTwoDigit(date.month);
  }

  // Steps 5-6.
  if (!FormatCalendarAnnotation(result, yearMonth->calendar(), showCalendar)) {
    return nullptr;
  }

  // Step 7.
  return result.finishString();
}

/**
 * TemporalZonedDateTimeToString ( zonedDateTime, precision, showCalendar,
 * showTimeZone, showOffset [ , increment, unit, roundingMode ] )
 */
JSString* js::temporal::TemporalZonedDateTimeToString(
    JSContext* cx, Handle<ZonedDateTime> zonedDateTime, Precision precision,
    ShowCalendar showCalendar, ShowTimeZoneName showTimeZone,
    ShowOffset showOffset, Increment increment, TemporalUnit unit,
    TemporalRoundingMode roundingMode) {
  TemporalStringBuilder result(cx, TemporalStringFormat::ZonedDateTime);
  if (!result.reserve()) {
    return nullptr;
  }

  // Steps 1-3. (Not applicable in our implementation.)

  // Steps 4-5.
  auto epochNs = RoundTemporalInstant(zonedDateTime.epochNanoseconds(),
                                      increment, unit, roundingMode);

  // Step 6.
  auto timeZone = zonedDateTime.timeZone();

  // Step 7.
  int64_t offsetNanoseconds;
  if (!GetOffsetNanosecondsFor(cx, timeZone, epochNs, &offsetNanoseconds)) {
    return nullptr;
  }
  MOZ_ASSERT(std::abs(offsetNanoseconds) < ToNanoseconds(TemporalUnit::Day));

  // Step 8.
  auto isoDateTime = GetISODateTimeFor(epochNs, offsetNanoseconds);

  // Step 9. (Inlined ISODateTimeToString)
  FormatDateTimeString(result, isoDateTime, precision);

  // Steps 10-11.
  if (showOffset != ShowOffset::Never) {
    FormatDateTimeUTCOffsetRounded(result, offsetNanoseconds);
  }

  // Steps 12-13.
  if (!FormatTimeZoneAnnotation(result, timeZone, showTimeZone)) {
    return nullptr;
  }

  // Step 14.
  if (!FormatCalendarAnnotation(result, zonedDateTime.calendar(),
                                showCalendar)) {
    return nullptr;
  }

  // Step 15.
  return result.finishString();
}