js/src/jsbool.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 #ifndef jsbool_h___
  41 #define jsbool_h___
  42 /*
  43  * JS boolean interface.
  44  */
  45
  46 JS_BEGIN_EXTERN_C
  47
  48 /*
  49  * Crypto-booleans, not visible to script but used internally by the engine.
  50  *
  51  * JSVAL_HOLE is a useful value for identifying a hole in an array.  It's also
  52  * used in the interpreter to represent "no exception pending".  In general it
  53  * can be used to represent "no value".
  54  *
  55  * JSVAL_ARETURN is used to throw asynchronous return for generator.close().
  56  */
  57 #define JSVAL_HOLE      BOOLEAN_TO_JSVAL(2)
  58 #define JSVAL_ARETURN   BOOLEAN_TO_JSVAL(3)
  59
  60 extern JSClass js_BooleanClass;
  61
  62 extern JSObject *
  63 js_InitBooleanClass(JSContext *cx, JSObject *obj);
  64
  65 extern JSString *
  66 js_BooleanToString(JSContext *cx, JSBool b);
  67
  68 extern JSBool
  69 js_ValueToBoolean(JSContext *cx, jsval v, JSBool *bp);
  70
  71 JS_END_EXTERN_C
  72
  73 #endif /* jsbool_h___ */