[INTL] Implement Date.prototype.toLocaleString in ECMA-402
[WebKit-https.git] / Source / JavaScriptCore / builtins / DatePrototype.js
1 /*
2  * Copyright (C) 2015 Andy VanWagoner <thetalecrafter@gmail.com>.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 // @conditional=ENABLE(INTL)
27
28 function toLocaleString(/* locales, options */)
29 {
30     "use strict";
31
32     function toDateTimeOptionsAnyAll(opts)
33     {
34         // ToDateTimeOptions abstract operation (ECMA-402 2.0)
35         // http://ecma-international.org/publications/standards/Ecma-402.htm
36
37         // 1. If options is undefined, then let options be null, else let options be ToObject(options).
38         // 2. ReturnIfAbrupt(options).
39         var optObj;
40         if (opts === undefined)
41             optObj = null;
42         else if (opts === null)
43             throw new @TypeError("null is not an object");
44         else
45             optObj = @Object(opts);
46
47         // 3. Let options be ObjectCreate(options).
48         var options = @Object.create(optObj);
49
50         // 4. Let needDefaults be true.
51         // 5. If required is "date" or "any",
52         // a. For each of the property names "weekday", "year", "month", "day":
53         // i. Let prop be the property name.
54         // ii. Let value be Get(options, prop).
55         // iii. ReturnIfAbrupt(value).
56         // iv. If value is not undefined, then let needDefaults be false.
57         // 6. If required is "time" or "any",
58         // a. For each of the property names "hour", "minute", "second":
59         // i. Let prop be the property name.
60         // ii. Let value be Get(options, prop).
61         // iii. ReturnIfAbrupt(value).
62         // iv. If value is not undefined, then let needDefaults be false.
63         // Check optObj instead of options to reduce lookups up the prototype chain.
64         var needsDefaults = !optObj || (
65             optObj.weekday === undefined &&
66             optObj.year === undefined &&
67             optObj.month === undefined &&
68             optObj.day === undefined &&
69             optObj.hour === undefined &&
70             optObj.minute === undefined &&
71             optObj.second === undefined
72         );
73
74         // 7. If needDefaults is true and defaults is either "date" or "all", then a. For each of the property names "year", "month", "day":
75         // i. Let status be CreateDatePropertyOrThrow(options, prop, "numeric").
76         // ii. ReturnIfAbrupt(status).
77         // 8. If needDefaults is true and defaults is either "time" or "all", then
78         // a. For each of the property names "hour", "minute", "second":
79         // i. Let status be CreateDatePropertyOrThrow(options, prop, "numeric").
80         // ii. ReturnIfAbrupt(status).
81         if (needsDefaults) {
82             options.year = "numeric";
83             options.month = "numeric";
84             options.day = "numeric";
85             options.hour = "numeric";
86             options.minute = "numeric";
87             options.second = "numeric";
88         }
89
90         // 9. Return options.
91         return options;
92     }
93
94     // 13.3.1 Date.prototype.toLocaleString ([locales [, options ]]) (ECMA-402 2.0)
95     // http://ecma-international.org/publications/standards/Ecma-402.htm
96
97     // 1. Let x be thisTimeValue(this value).
98     // 2. ReturnIfAbrupt(x).
99     var value = @thisTimeValue.@call(this);
100
101     // 3. If x is NaN, return "Invalid Date".
102     if (@isNaN(value))
103         return "Invalid Date";
104
105     // 4. Let options be ToDateTimeOptions(options, "any", "all").
106     // 5. ReturnIfAbrupt(options).
107     var options = toDateTimeOptionsAnyAll(arguments[1]);
108
109     // 6. Let dateFormat be Construct(%DateTimeFormat%, Ā«locales, optionsĀ»).
110     // 7. ReturnIfAbrupt(dateFormat).
111     var locales = arguments[0];
112     var dateFormat = new @DateTimeFormat(locales, options);
113
114     // 8. Return FormatDateTime(dateFormat, x).
115     return dateFormat.format(value);
116 }