JSDOC/Scope.js
[gnome.introspection-doc-generator] / Date.js
1 /*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * <script type="text/javascript">
10  */
11 // usage: Seed.include('Date.js')
12
13
14 String          = imports.String.String;
15 XObject         = imports.XObject.XObject;
16
17
18 /**
19  * @class Date
20  *
21  * The date parsing and format syntax is a subset of
22  * <a href="http://www.php.net/date">PHP's date() function</a>, and the formats that are
23  * supported will provide results equivalent to their PHP versions.
24  *
25  * Following is the list of all currently supported formats:
26  *<pre>
27 Sample date:
28 'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)'
29
30 Format  Output      Description
31 ------  ----------  --------------------------------------------------------------
32   d      10         Day of the month, 2 digits with leading zeros
33   D      Wed        A textual representation of a day, three letters
34   j      10         Day of the month without leading zeros
35   l      Wednesday  A full textual representation of the day of the week
36   S      th         English ordinal day of month suffix, 2 chars (use with j)
37   w      3          Numeric representation of the day of the week
38   z      9          The julian date, or day of the year (0-365)
39   W      01         ISO-8601 2-digit week number of year, weeks starting on Monday (00-52)
40   F      January    A full textual representation of the month
41   m      01         Numeric representation of a month, with leading zeros
42   M      Jan        Month name abbreviation, three letters
43   n      1          Numeric representation of a month, without leading zeros
44   t      31         Number of days in the given month
45   L      0          Whether it's a leap year (1 if it is a leap year, else 0)
46   Y      2007       A full numeric representation of a year, 4 digits
47   y      07         A two digit representation of a year
48   a      pm         Lowercase Ante meridiem and Post meridiem
49   A      PM         Uppercase Ante meridiem and Post meridiem
50   g      3          12-hour format of an hour without leading zeros
51   G      15         24-hour format of an hour without leading zeros
52   h      03         12-hour format of an hour with leading zeros
53   H      15         24-hour format of an hour with leading zeros
54   i      05         Minutes with leading zeros
55   s      01         Seconds, with leading zeros
56   O      -0600      Difference to Greenwich time (GMT) in hours
57   T      CST        Timezone setting of the machine running the code
58   Z      -21600     Timezone offset in seconds (negative if west of UTC, positive if east)
59 </pre>
60  *
61  * Example usage (note that you must escape format specifiers with '\\' to render them as character literals):
62  * <pre><code>
63 var dt = new Date('1/10/2007 03:05:01 PM GMT-0600');
64 document.write(dt.format('Y-m-d'));                         //2007-01-10
65 document.write(dt.format('F j, Y, g:i a'));                 //January 10, 2007, 3:05 pm
66 document.write(dt.format('l, \\t\\he dS of F Y h:i:s A'));  //Wednesday, the 10th of January 2007 03:05:01 PM
67  </code></pre>
68  *
69  * Here are some standard date/time patterns that you might find helpful.  They
70  * are not part of the source of Date.js, but to use them you can simply copy this
71  * block of code into any script that is included after Date.js and they will also become
72  * globally available on the Date object.  Feel free to add or remove patterns as needed in your code.
73  * <pre><code>
74 Date.patterns = {
75     ISO8601Long:"Y-m-d H:i:s",
76     ISO8601Short:"Y-m-d",
77     ShortDate: "n/j/Y",
78     LongDate: "l, F d, Y",
79     FullDateTime: "l, F d, Y g:i:s A",
80     MonthDay: "F d",
81     ShortTime: "g:i A",
82     LongTime: "g:i:s A",
83     SortableDateTime: "Y-m-d\\TH:i:s",
84     UniversalSortableDateTime: "Y-m-d H:i:sO",
85     YearMonth: "F, Y"
86 };
87 </code></pre>
88  *
89  * Example usage:
90  * <pre><code>
91 var dt = new Date();
92 document.write(dt.format(Date.patterns.ShortDate));
93  </code></pre>
94  */
95
96 /*
97  * Most of the date-formatting functions below are the excellent work of Baron Schwartz.
98  * They generate precompiled functions from date formats instead of parsing and
99  * processing the pattern every time you format a date.  These functions are available
100  * on every Date object (any javascript function).
101  *
102  * The original article and download are here:
103  * http://www.xaprb.com/blog/2005/12/12/javascript-closures-for-runtime-efficiency/
104  *
105  */
106  
107      
108      // was in core
109     /**
110      Returns the number of milliseconds between this date and date
111      @param {Date} date (optional) Defaults to now
112      @return {Number} The diff in milliseconds
113      @member Date getElapsed
114      */
115 Date = XObject.extend(Date,
116     {
117         
118         // private
119         parseFunctions : {count:0},
120         // private
121         parseRegexes : [],
122         // private
123         formatFunctions : {count:0},
124             
125             
126         // private
127         // safari setMonth is broken
128          
129         /** Date interval constant 
130         * @static 
131         * @type String */
132         MILLI : "ms",
133         /** Date interval constant 
134         * @static 
135         * @type String */
136         SECOND : "s",
137         /** Date interval constant 
138         * @static 
139         * @type String */
140         MINUTE : "mi",
141         /** Date interval constant 
142         * @static 
143         * @type String */
144         HOUR : "h",
145         /** Date interval constant 
146         * @static 
147         * @type String */
148         DAY : "d",
149         /** Date interval constant 
150         * @static 
151         * @type String */
152         MONTH : "mo",
153         /** Date interval constant 
154         * @static 
155         * @type String */
156         YEAR : "y",
157
158         // private
159         daysInMonth : [31,28,31,30,31,30,31,31,30,31,30,31],
160
161         /**
162          * An array of textual month names.
163          * Override these values for international dates, for example...
164          * Date.monthNames = ['JanInYourLang', 'FebInYourLang', ...];
165          * @type Array
166          * @static
167          */
168         monthNames : [
169             "January",
170             "February",
171             "March",
172             "April",
173             "May",
174             "June",
175             "July",
176             "August",
177             "September",
178             "October",
179             "November",
180             "December"],
181
182         /**
183          * An array of textual day names.
184          * Override these values for international dates, for example...
185          * Date.dayNames = ['SundayInYourLang', 'MondayInYourLang', ...];
186          * @type Array
187          * @static
188          */
189         dayNames : [
190             "Sunday",
191             "Monday",
192             "Tuesday",
193             "Wednesday",
194             "Thursday",
195             "Friday",
196             "Saturday"],
197
198         // private
199         y2kYear : 50,
200         // private
201         monthNumbers : {
202             Jan:0,
203             Feb:1,
204             Mar:2,
205             Apr:3,
206             May:4,
207             Jun:5,
208             Jul:6,
209             Aug:7,
210             Sep:8,
211             Oct:9,
212             Nov:10,
213             Dec:11},
214         
215         createNewFormat : function(format) {
216             var funcName = "format" + Date.formatFunctions.count++;
217             Date.formatFunctions[format] = funcName;
218             var code = "Date.prototype." + funcName + " = function(){return ";
219             var special = false;
220             var ch = '';
221             for (var i = 0; i < format.length; ++i) {
222                 ch = format.charAt(i);
223                 if (!special && ch == "\\") {
224                     special = true;
225                 }
226                 else if (special) {
227                     special = false;
228                     code += "'" + String.escape(ch) + "' + ";
229                 }
230                 else {
231                     code += Date.getFormatCode(ch);
232                 }
233             }
234             /** eval:var:zzzzzzzzzzzzz */
235             eval(code.substring(0, code.length - 3) + ";}");
236         },
237
238         // private
239         getFormatCode : function(character) {
240             switch (character) {
241             case "d":
242                 return "String.leftPad(this.getDate(), 2, '0') + ";
243             case "D":
244                 return "Date.dayNames[this.getDay()].substring(0, 3) + ";
245             case "j":
246                 return "this.getDate() + ";
247             case "l":
248                 return "Date.dayNames[this.getDay()] + ";
249             case "S":
250                 return "this.getSuffix() + ";
251             case "w":
252                 return "this.getDay() + ";
253             case "z":
254                 return "this.getDayOfYear() + ";
255             case "W":
256                 return "this.getWeekOfYear() + ";
257             case "F":
258                 return "Date.monthNames[this.getMonth()] + ";
259             case "m":
260                 return "String.leftPad(this.getMonth() + 1, 2, '0') + ";
261             case "M":
262                 return "Date.monthNames[this.getMonth()].substring(0, 3) + ";
263             case "n":
264                 return "(this.getMonth() + 1) + ";
265             case "t":
266                 return "this.getDaysInMonth() + ";
267             case "L":
268                 return "(this.isLeapYear() ? 1 : 0) + ";
269             case "Y":
270                 return "this.getFullYear() + ";
271             case "y":
272                 return "('' + this.getFullYear()).substring(2, 4) + ";
273             case "a":
274                 return "(this.getHours() < 12 ? 'am' : 'pm') + ";
275             case "A":
276                 return "(this.getHours() < 12 ? 'AM' : 'PM') + ";
277             case "g":
278                 return "((this.getHours() % 12) ? this.getHours() % 12 : 12) + ";
279             case "G":
280                 return "this.getHours() + ";
281             case "h":
282                 return "String.leftPad((this.getHours() % 12) ? this.getHours() % 12 : 12, 2, '0') + ";
283             case "H":
284                 return "String.leftPad(this.getHours(), 2, '0') + ";
285             case "i":
286                 return "String.leftPad(this.getMinutes(), 2, '0') + ";
287             case "s":
288                 return "String.leftPad(this.getSeconds(), 2, '0') + ";
289             case "O":
290                 return "this.getGMTOffset() + ";
291             case "T":
292                 return "this.getTimezone() + ";
293             case "Z":
294                 return "(this.getTimezoneOffset() * -60) + ";
295             default:
296                 return "'" + String.escape(character) + "' + ";
297             }
298         },
299
300         /**
301          * Parses the passed string using the specified format. Note that this function expects dates in normal calendar
302          * format, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates.  Any part of
303          * the date format that is not specified will default to the current date value for that part.  Time parts can also
304          * be specified, but default to 0.  Keep in mind that the input date string must precisely match the specified format
305          * string or the parse operation will fail.
306          * Example Usage:
307         <pre><code>
308         //dt = Fri May 25 2007 (current date)
309         var dt = new Date();
310
311         //dt = Thu May 25 2006 (today's month/day in 2006)
312         dt = Date.parseDate("2006", "Y");
313
314         //dt = Sun Jan 15 2006 (all date parts specified)
315         dt = Date.parseDate("2006-1-15", "Y-m-d");
316
317         //dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST)
318         dt = Date.parseDate("2006-1-15 3:20:01 PM", "Y-m-d h:i:s A" );
319         </code></pre>
320          * @param {String} input The unparsed date as a string
321          * @param {String} format The format the date is in
322          * @return {Date} The parsed date
323          * @static
324          */
325         parseDate : function(input, format) {
326             if (Date.parseFunctions[format] == null) {
327                 Date.createParser(format);
328             }
329             var func = Date.parseFunctions[format];
330             return Date[func](input);
331         },
332
333         /**
334         * @private
335         */
336         createParser : function(format) {
337             var funcName = "parse" + Date.parseFunctions.count++;
338             var regexNum = Date.parseRegexes.length;
339             var currentGroup = 1;
340             Date.parseFunctions[format] = funcName;
341
342             var code = "Date." + funcName + " = function(input){\n"
343                 + "var y = -1, m = -1, d = -1, h = -1, i = -1, s = -1, o, z, v;\n"
344                 + "var d = new Date();\n"
345                 + "y = d.getFullYear();\n"
346                 + "m = d.getMonth();\n"
347                 + "d = d.getDate();\n"
348                 + "var results = input.match(Date.parseRegexes[" + regexNum + "]);\n"
349                 + "if (results && results.length > 0) {";
350             var regex = "";
351
352             var special = false;
353             var ch = '';
354             for (var i = 0; i < format.length; ++i) {
355                 ch = format.charAt(i);
356                 if (!special && ch == "\\") {
357                     special = true;
358                 }
359                 else if (special) {
360                     special = false;
361                     regex += String.escape(ch);
362                 }
363                 else {
364                     var obj = Date.formatCodeToRegex(ch, currentGroup);
365                     currentGroup += obj.g;
366                     regex += obj.s;
367                     if (obj.g && obj.c) {
368                         code += obj.c;
369                     }
370                 }
371             }
372
373             code += "if (y >= 0 && m >= 0 && d > 0 && h >= 0 && i >= 0 && s >= 0)\n"
374                 + "{v = new Date(y, m, d, h, i, s);}\n"
375                 + "else if (y >= 0 && m >= 0 && d > 0 && h >= 0 && i >= 0)\n"
376                 + "{v = new Date(y, m, d, h, i);}\n"
377                 + "else if (y >= 0 && m >= 0 && d > 0 && h >= 0)\n"
378                 + "{v = new Date(y, m, d, h);}\n"
379                 + "else if (y >= 0 && m >= 0 && d > 0)\n"
380                 + "{v = new Date(y, m, d);}\n"
381                 + "else if (y >= 0 && m >= 0)\n"
382                 + "{v = new Date(y, m);}\n"
383                 + "else if (y >= 0)\n"
384                 + "{v = new Date(y);}\n"
385                 + "}return (v && (z || o))?\n" // favour UTC offset over GMT offset
386                 + "    ((z)? v.add(Date.SECOND, (v.getTimezoneOffset() * 60) + (z*1)) :\n" // reset to UTC, then add offset
387                 + "        v.add(Date.HOUR, (v.getGMTOffset() / 100) + (o / -100))) : v\n" // reset to GMT, then add offset
388                 + ";}";
389
390             Date.parseRegexes[regexNum] = new RegExp("^" + regex + "$");
391              /** eval:var:zzzzzzzzzzzzz */
392             eval(code);
393         },
394
395         // private
396         formatCodeToRegex : function(character, currentGroup) {
397             switch (character) {
398             case "D":
399                 return {g:0,
400                 c:null,
401                 s:"(?:Sun|Mon|Tue|Wed|Thu|Fri|Sat)"};
402             case "j":
403                 return {g:1,
404                     c:"d = parseInt(results[" + currentGroup + "], 10);\n",
405                     s:"(\\d{1,2})"}; // day of month without leading zeroes
406             case "d":
407                 return {g:1,
408                     c:"d = parseInt(results[" + currentGroup + "], 10);\n",
409                     s:"(\\d{2})"}; // day of month with leading zeroes
410             case "l":
411                 return {g:0,
412                     c:null,
413                     s:"(?:" + Date.dayNames.join("|") + ")"};
414             case "S":
415                 return {g:0,
416                     c:null,
417                     s:"(?:st|nd|rd|th)"};
418             case "w":
419                 return {g:0,
420                     c:null,
421                     s:"\\d"};
422             case "z":
423                 return {g:0,
424                     c:null,
425                     s:"(?:\\d{1,3})"};
426             case "W":
427                 return {g:0,
428                     c:null,
429                     s:"(?:\\d{2})"};
430             case "F":
431                 return {g:1,
432                     c:"m = parseInt(Date.monthNumbers[results[" + currentGroup + "].substring(0, 3)], 10);\n",
433                     s:"(" + Date.monthNames.join("|") + ")"};
434             case "M":
435                 return {g:1,
436                     c:"m = parseInt(Date.monthNumbers[results[" + currentGroup + "]], 10);\n",
437                     s:"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)"};
438             case "n":
439                 return {g:1,
440                     c:"m = parseInt(results[" + currentGroup + "], 10) - 1;\n",
441                     s:"(\\d{1,2})"}; // Numeric representation of a month, without leading zeros
442             case "m":
443                 return {g:1,
444                     c:"m = parseInt(results[" + currentGroup + "], 10) - 1;\n",
445                     s:"(\\d{2})"}; // Numeric representation of a month, with leading zeros
446             case "t":
447                 return {g:0,
448                     c:null,
449                     s:"\\d{1,2}"};
450             case "L":
451                 return {g:0,
452                     c:null,
453                     s:"(?:1|0)"};
454             case "Y":
455                 return {g:1,
456                     c:"y = parseInt(results[" + currentGroup + "], 10);\n",
457                     s:"(\\d{4})"};
458             case "y":
459                 return {g:1,
460                     c:"var ty = parseInt(results[" + currentGroup + "], 10);\n"
461                         + "y = ty > Date.y2kYear ? 1900 + ty : 2000 + ty;\n",
462                     s:"(\\d{1,2})"};
463             case "a":
464                 return {g:1,
465                     c:"if (results[" + currentGroup + "] == 'am') {\n"
466                         + "if (h == 12) { h = 0; }\n"
467                         + "} else { if (h < 12) { h += 12; }}",
468                     s:"(am|pm)"};
469             case "A":
470                 return {g:1,
471                     c:"if (results[" + currentGroup + "] == 'AM') {\n"
472                         + "if (h == 12) { h = 0; }\n"
473                         + "} else { if (h < 12) { h += 12; }}",
474                     s:"(AM|PM)"};
475             case "g":
476             case "G":
477                 return {g:1,
478                     c:"h = parseInt(results[" + currentGroup + "], 10);\n",
479                     s:"(\\d{1,2})"}; // 12/24-hr format  format of an hour without leading zeroes
480             case "h":
481             case "H":
482                 return {g:1,
483                     c:"h = parseInt(results[" + currentGroup + "], 10);\n",
484                     s:"(\\d{2})"}; //  12/24-hr format  format of an hour with leading zeroes
485             case "i":
486                 return {g:1,
487                     c:"i = parseInt(results[" + currentGroup + "], 10);\n",
488                     s:"(\\d{2})"};
489             case "s":
490                 return {g:1,
491                     c:"s = parseInt(results[" + currentGroup + "], 10);\n",
492                     s:"(\\d{2})"};
493             case "O":
494                 return {g:1,
495                     c:[
496                         "o = results[", currentGroup, "];\n",
497                         "var sn = o.substring(0,1);\n", // get + / - sign
498                         "var hr = o.substring(1,3)*1 + Math.floor(o.substring(3,5) / 60);\n", // get hours (performs minutes-to-hour conversion also)
499                         "var mn = o.substring(3,5) % 60;\n", // get minutes
500                         "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))?\n", // -12hrs <= GMT offset <= 14hrs
501                         "    (sn + String.leftPad(hr, 2, 0) + String.leftPad(mn, 2, 0)) : null;\n"
502                     ].join(""),
503                     s:"([+\-]\\d{4})"};
504             case "T":
505                 return {g:0,
506                     c:null,
507                     s:"[A-Z]{1,4}"}; // timezone abbrev. may be between 1 - 4 chars
508             case "Z":
509                 return {g:1,
510                     c:"z = results[" + currentGroup + "];\n" // -43200 <= UTC offset <= 50400
511                           + "z = (-43200 <= z*1 && z*1 <= 50400)? z : null;\n",
512                     s:"([+\-]?\\d{1,5})"}; // leading '+' sign is optional for UTC offset
513             default:
514             
515                 return {g:0,
516                     c:null,
517                     s:String.escape(character)};
518             }
519         }
520
521         
522     
523 }); // end static date..
524
525 // now add functions to date..
526 XObject.extend(Date.prototype,
527     {
528
529         getElapsed : function(date) {
530             return Math.abs((date || new Date()).getTime()-this.getTime());
531         },
532          
533
534         /**
535          * Formats a date given the supplied format string
536          * @param {String} format The format string
537          * @return {String} The formatted date
538          * @method
539          */
540
541         
542         format : function(format) {
543             if (Date.formatFunctions[format] == null) {
544                 Date.createNewFormat(format);
545             }
546             var func = Date.formatFunctions[format];
547             return this[func]();
548         },
549
550         // private - why is dataFormat an alias?
551         //format : dateFormat;
552
553         // private
554
555         /**
556          * Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').
557          * @return {String} The abbreviated timezone name (e.g. 'CST')
558          */
559         getTimezone : function() {
560             return this.toString().replace(/^.*? ([A-Z]{1,4})[\-+][0-9]{4} .*$/, "$1");
561         },
562
563         /**
564          * Get the offset from GMT of the current date (equivalent to the format specifier 'O').
565          * @return {String} The 4-character offset string prefixed with + or - (e.g. '-0600')
566          */
567         getGMTOffset : function() {
568             return (this.getTimezoneOffset() > 0 ? "-" : "+")
569                 + String.leftPad(Math.abs(Math.floor(this.getTimezoneOffset() / 60)), 2, "0")
570                 + String.leftPad(this.getTimezoneOffset() % 60, 2, "0");
571         },
572
573         /**
574          * Get the numeric day number of the year, adjusted for leap year.
575          * @return {Number} 0 through 364 (365 in leap years)
576          */
577         getDayOfYear : function() {
578             var num = 0;
579             Date.daysInMonth[1] = this.isLeapYear() ? 29 : 28;
580             for (var i = 0; i < this.getMonth(); ++i) {
581                 num += Date.daysInMonth[i];
582             }
583             return num + this.getDate() - 1;
584         },
585
586         /**
587          * Get the string representation of the numeric week number of the year
588          * (equivalent to the format specifier 'W').
589          * @return {String} '00' through '52'
590          */
591         getWeekOfYear : function() {
592             // Skip to Thursday of this week
593             var now = this.getDayOfYear() + (4 - this.getDay());
594             // Find the first Thursday of the year
595             var jan1 = new Date(this.getFullYear(), 0, 1);
596             var then = (7 - jan1.getDay() + 4);
597             return String.leftPad(((now - then) / 7) + 1, 2, "0");
598         },
599
600         /**
601          * Whether or not the current date is in a leap year.
602          * @return {Boolean} True if the current date is in a leap year, else false
603          */
604         isLeapYear : function() {
605             var year = this.getFullYear();
606             return ((year & 3) == 0 && (year % 100 || (year % 400 == 0 && year)));
607         },
608
609         /**
610          * Get the first day of the current month, adjusted for leap year.  The returned value
611          * is the numeric day index within the week (0-6) which can be used in conjunction with
612          * the {@link #monthNames} array to retrieve the textual day name.
613          * Example:
614          *<pre><code>
615         var dt = new Date('1/10/2007');
616         document.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'
617         </code></pre>
618          * @return {Number} The day number (0-6)
619          */
620         getFirstDayOfMonth : function() {
621             var day = (this.getDay() - (this.getDate() - 1)) % 7;
622             return (day < 0) ? (day + 7) : day;
623         },
624
625         /**
626          * Get the last day of the current month, adjusted for leap year.  The returned value
627          * is the numeric day index within the week (0-6) which can be used in conjunction with
628          * the {@link #monthNames} array to retrieve the textual day name.
629          * Example:
630          *<pre><code>
631         var dt = new Date('1/10/2007');
632         document.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'
633         </code></pre>
634          * @return {Number} The day number (0-6)
635          */
636         getLastDayOfMonth : function() {
637             var day = (this.getDay() + (Date.daysInMonth[this.getMonth()] - this.getDate())) % 7;
638             return (day < 0) ? (day + 7) : day;
639         },
640
641
642         /**
643          * Get the first date of this date's month
644          * @return {Date}
645          */
646         getFirstDateOfMonth : function() {
647             return new Date(this.getFullYear(), this.getMonth(), 1);
648         },
649
650         /**
651          * Get the last date of this date's month
652          * @return {Date}
653          */
654         getLastDateOfMonth : function() {
655             return new Date(this.getFullYear(), this.getMonth(), this.getDaysInMonth());
656         },
657         /**
658          * Get the number of days in the current month, adjusted for leap year.
659          * @return {Number} The number of days in the month
660          */
661         getDaysInMonth : function() {
662             Date.daysInMonth[1] = this.isLeapYear() ? 29 : 28;
663             return Date.daysInMonth[this.getMonth()];
664         },
665
666         /**
667          * Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').
668          * @return {String} 'st, 'nd', 'rd' or 'th'
669          */
670         getSuffix : function() {
671             switch (this.getDate()) {
672                 case 1:
673                 case 21:
674                 case 31:
675                     return "st";
676                 case 2:
677                 case 22:
678                     return "nd";
679                 case 3:
680                 case 23:
681                     return "rd";
682                 default:
683                     return "th";
684             }
685         },
686
687
688         /**
689          * Creates and returns a new Date instance with the exact same date value as the called instance.
690          * Dates are copied and passed by reference, so if a copied date variable is modified later, the original
691          * variable will also be changed.  When the intention is to create a new variable that will not
692          * modify the original instance, you should create a clone.
693          *
694          * Example of correctly cloning a date:
695          * <pre><code>
696         //wrong way:
697         var orig = new Date('10/1/2006');
698         var copy = orig;
699         copy.setDate(5);
700         document.write(orig);  //returns 'Thu Oct 05 2006'!
701
702         //correct way:
703         var orig = new Date('10/1/2006');
704         var copy = orig.clone();
705         copy.setDate(5);
706         document.write(orig);  //returns 'Thu Oct 01 2006'
707         </code></pre>
708          * @return {Date} The new Date instance
709          */
710         clone : function() {
711             return new Date(this.getTime());
712         },
713
714         /**
715          * Clears any time information from this date
716          @param {Boolean} clone true to create a clone of this date, clear the time and return it
717          @return {Date} this or the clone
718          */
719         clearTime : function(clone){
720             if(clone){
721                 return this.clone().clearTime();
722             }
723             this.setHours(0);
724             this.setMinutes(0);
725             this.setSeconds(0);
726             this.setMilliseconds(0);
727             return this;
728         },
729
730         /**
731          * Provides a convenient method of performing basic date arithmetic.  This method
732          * does not modify the Date instance being called - it creates and returns
733          * a new Date instance containing the resulting date value.
734          *
735          * Examples:
736          * <pre><code>
737         //Basic usage:
738         var dt = new Date('10/29/2006').add(Date.DAY, 5);
739         document.write(dt); //returns 'Fri Oct 06 2006 00:00:00'
740
741         //Negative values will subtract correctly:
742         var dt2 = new Date('10/1/2006').add(Date.DAY, -5);
743         document.write(dt2); //returns 'Tue Sep 26 2006 00:00:00'
744
745         //You can even chain several calls together in one line!
746         var dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);
747         document.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'
748          </code></pre>
749          *
750          * @param {String} interval   A valid date interval enum value
751          * @param {Number} value      The amount to add to the current date
752          * @return {Date} The new Date instance
753          */
754         add : function(interval, value){
755           var d = this.clone();
756           if (!interval || value === 0) return d;
757           switch(interval.toLowerCase()){
758             case Date.MILLI:
759               d.setMilliseconds(this.getMilliseconds() + value);
760               break;
761             case Date.SECOND:
762               d.setSeconds(this.getSeconds() + value);
763               break;
764             case Date.MINUTE:
765               d.setMinutes(this.getMinutes() + value);
766               break;
767             case Date.HOUR:
768               d.setHours(this.getHours() + value);
769               break;
770             case Date.DAY:
771               d.setDate(this.getDate() + value);
772               break;
773             case Date.MONTH:
774               var day = this.getDate();
775               if(day > 28){
776                   day = Math.min(day, this.getFirstDateOfMonth().add('mo', value).getLastDateOfMonth().getDate());
777               }
778               d.setDate(day);
779               d.setMonth(this.getMonth() + value);
780               break;
781             case Date.YEAR:
782               d.setFullYear(this.getFullYear() + value);
783               break;
784           }
785           return d;
786         }
787
788 });