js/src/builtin/temporal/ToString.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: set ts=8 sts=2 et sw=2 tw=80:
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef builtin_temporal_ToString_h
   8 #define builtin_temporal_ToString_h
   9
  10 #include "builtin/temporal/Temporal.h"
  11 #include "builtin/temporal/TemporalRoundingMode.h"
  12 #include "builtin/temporal/TemporalUnit.h"
  13 #include "js/TypeDecls.h"
  14
  15 namespace js::temporal {
  16
  17 class CalendarValue;
  18 class InstantObject;
  19 class PlainDateObject;
  20 class PlainMonthDayObject;
  21 class PlainYearMonthObject;
  22 class TimeZoneValue;
  23 class ZonedDateTime;
  24
  25 struct PlainDateTime;
  26 struct PlainTime;
  27
  28 /**
  29  * TemporalInstantToString ( instant, timeZone, precision )
  30  */
  31 JSString* TemporalInstantToString(JSContext* cx,
  32                                   JS::Handle<InstantObject*> instant,
  33                                   JS::Handle<TimeZoneValue> timeZone,
  34                                   Precision precision);
  35
  36 /**
  37  * TemporalDateToString ( temporalDate, showCalendar )
  38  */
  39 JSString* TemporalDateToString(JSContext* cx,
  40                                JS::Handle<PlainDateObject*> temporalDate,
  41                                CalendarOption showCalendar);
  42
  43 /**
  44  * TemporalDateTimeToString ( isoYear, isoMonth, isoDay, hour, minute, second,
  45  * millisecond, microsecond, nanosecond, calendar, precision, showCalendar )
  46  */
  47 JSString* TemporalDateTimeToString(JSContext* cx, const PlainDateTime& dateTime,
  48                                    JS::Handle<CalendarValue> calendar,
  49                                    Precision precision,
  50                                    CalendarOption showCalendar);
  51
  52 /**
  53  * TemporalTimeToString ( hour, minute, second, millisecond, microsecond,
  54  * nanosecond, precision )
  55  */
  56 JSString* TemporalTimeToString(JSContext* cx, const PlainTime& time,
  57                                Precision precision);
  58
  59 /**
  60  * TemporalMonthDayToString ( monthDay, showCalendar )
  61  */
  62 JSString* TemporalMonthDayToString(JSContext* cx,
  63                                    JS::Handle<PlainMonthDayObject*> monthDay,
  64                                    CalendarOption showCalendar);
  65
  66 /**
  67  * TemporalYearMonthToString ( yearMonth, showCalendar )
  68  */
  69 JSString* TemporalYearMonthToString(JSContext* cx,
  70                                     JS::Handle<PlainYearMonthObject*> yearMonth,
  71                                     CalendarOption showCalendar);
  72
  73 /**
  74  * TemporalZonedDateTimeToString ( zonedDateTime, precision, showCalendar,
  75  * showTimeZone, showOffset [ , increment, unit, roundingMode ] )
  76  */
  77 JSString* TemporalZonedDateTimeToString(
  78     JSContext* cx, JS::Handle<ZonedDateTime> zonedDateTime, Precision precision,
  79     CalendarOption showCalendar, TimeZoneNameOption showTimeZone,
  80     ShowOffsetOption showOffset, Increment increment = Increment{1},
  81     TemporalUnit unit = TemporalUnit::Nanosecond,
  82     TemporalRoundingMode roundingMode = TemporalRoundingMode::Trunc);
  83
  84 } /* namespace js::temporal */
  85
  86 #endif /* builtin_temporal_ToString_h */