/js/src/jsdate.h

  1/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2 *
  3 * ***** BEGIN LICENSE BLOCK *****
  4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5 *
  6 * The contents of this file are subject to the Mozilla Public License Version
  7 * 1.1 (the "License"); you may not use this file except in compliance with
  8 * the License. You may obtain a copy of the License at
  9 * http://www.mozilla.org/MPL/
 10 *
 11 * Software distributed under the License is distributed on an "AS IS" basis,
 12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 13 * for the specific language governing rights and limitations under the
 14 * License.
 15 *
 16 * The Original Code is Mozilla Communicator client code, released
 17 * March 31, 1998.
 18 *
 19 * The Initial Developer of the Original Code is
 20 * Netscape Communications Corporation.
 21 * Portions created by the Initial Developer are Copyright (C) 1998
 22 * the Initial Developer. All Rights Reserved.
 23 *
 24 * Contributor(s):
 25 *
 26 * Alternatively, the contents of this file may be used under the terms of
 27 * either of the GNU General Public License Version 2 or later (the "GPL"),
 28 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 29 * in which case the provisions of the GPL or the LGPL are applicable instead
 30 * of those above. If you wish to allow use of your version of this file only
 31 * under the terms of either the GPL or the LGPL, and not to allow others to
 32 * use your version of this file under the terms of the MPL, indicate your
 33 * decision by deleting the provisions above and replace them with the notice
 34 * and other provisions required by the GPL or the LGPL. If you do not delete
 35 * the provisions above, a recipient may use your version of this file under
 36 * the terms of any one of the MPL, the GPL or the LGPL.
 37 *
 38 * ***** END LICENSE BLOCK ***** */
 39
 40/*
 41 * JS Date class interface.
 42 */
 43
 44#ifndef jsdate_h___
 45#define jsdate_h___
 46
 47#include "jscntxt.h"
 48
 49#define HalfTimeDomain  8.64e15
 50
 51#define TIMECLIP(d) ((JSDOUBLE_IS_FINITE(d) \
 52                      && !((d < 0 ? -d : d) > HalfTimeDomain)) \
 53                     ? js_DoubleToInteger(d + (+0.)) : js_NaN)
 54
 55extern JSObject *
 56js_InitDateClass(JSContext *cx, JSObject *obj);
 57
 58/*
 59 * These functions provide a C interface to the date/time object
 60 */
 61
 62/*
 63 * Construct a new Date Object from a time value given in milliseconds UTC
 64 * since the epoch.
 65 */
 66extern JS_FRIEND_API(JSObject*)
 67js_NewDateObjectMsec(JSContext* cx, jsdouble msec_time);
 68
 69/*
 70 * Construct a new Date Object from an exploded local time value.
 71 *
 72 * Assert that mon < 12 to help catch off-by-one user errors, which are common
 73 * due to the 0-based month numbering copied into JS from Java (java.util.Date
 74 * in 1995).
 75 */
 76extern JS_FRIEND_API(JSObject*)
 77js_NewDateObject(JSContext* cx, int year, int mon, int mday,
 78                 int hour, int min, int sec);
 79
 80extern JS_FRIEND_API(int)
 81js_DateGetYear(JSContext *cx, JSObject* obj);
 82
 83extern JS_FRIEND_API(int)
 84js_DateGetMonth(JSContext *cx, JSObject* obj);
 85
 86extern JS_FRIEND_API(int)
 87js_DateGetDate(JSContext *cx, JSObject* obj);
 88
 89extern JS_FRIEND_API(int)
 90js_DateGetHours(JSContext *cx, JSObject* obj);
 91
 92extern JS_FRIEND_API(int)
 93js_DateGetMinutes(JSContext *cx, JSObject* obj);
 94
 95extern JS_FRIEND_API(int)
 96js_DateGetSeconds(JSContext *cx, JSObject* obj);
 97
 98typedef uint32_t JSIntervalTime;
 99
100extern JS_FRIEND_API(JSIntervalTime)
101js_IntervalNow();
102
103/* Date constructor native. Exposed only so the JIT can know its address. */
104JSBool
105js_Date(JSContext *cx, uintN argc, js::Value *vp);
106
107#endif /* jsdate_h___ */