Back to index

lightning-sunbird  0.9+nobinonly
jsbool.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator client code, released
00017  * March 31, 1998.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 1998
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef jsbool_h___
00041 #define jsbool_h___
00042 /*
00043  * JS boolean interface.
00044  */
00045 
00046 JS_BEGIN_EXTERN_C
00047 
00048 /*
00049  * Crypto-booleans, not visible to script but used internally by the engine.
00050  *
00051  * JSVAL_HOLE is a useful value for identifying a hole in an array.  It's also
00052  * used in the interpreter to represent "no exception pending".  In general it
00053  * can be used to represent "no value".
00054  *
00055  * JSVAL_ARETURN is used to throw asynchronous return for generator.close().
00056  */
00057 #define JSVAL_HOLE      BOOLEAN_TO_JSVAL(2)
00058 #define JSVAL_ARETURN   BOOLEAN_TO_JSVAL(3)
00059 
00060 extern JSClass js_BooleanClass;
00061 
00062 extern JSObject *
00063 js_InitBooleanClass(JSContext *cx, JSObject *obj);
00064 
00065 extern JSObject *
00066 js_BooleanToObject(JSContext *cx, JSBool b);
00067 
00068 extern JSString *
00069 js_BooleanToString(JSContext *cx, JSBool b);
00070 
00071 extern JSBool
00072 js_ValueToBoolean(JSContext *cx, jsval v, JSBool *bp);
00073 
00074 JS_END_EXTERN_C
00075 
00076 #endif /* jsbool_h___ */