Back to index

lightning-sunbird  0.9+nobinonly
jsexn.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 /*
00041  * JS runtime exception classes.
00042  */
00043 
00044 #ifndef jsexn_h___
00045 #define jsexn_h___
00046 
00047 JS_BEGIN_EXTERN_C
00048 
00049 extern JSClass js_ErrorClass;
00050 
00051 /*
00052  * Initialize the exception constructor/prototype hierarchy.
00053  */
00054 extern JSObject *
00055 js_InitExceptionClasses(JSContext *cx, JSObject *obj);
00056 
00057 /*
00058  * Given a JSErrorReport, check to see if there is an exception associated with
00059  * the error number.  If there is, then create an appropriate exception object,
00060  * set it as the pending exception, and set the JSREPORT_EXCEPTION flag on the
00061  * error report.  Exception-aware host error reporters should probably ignore
00062  * error reports so flagged.  Returns JS_TRUE if an associated exception is
00063  * found and set, JS_FALSE otherwise..
00064  */
00065 extern JSBool
00066 js_ErrorToException(JSContext *cx, const char *message, JSErrorReport *reportp);
00067 
00068 /*
00069  * Called if a JS API call to js_Execute or js_InternalCall fails; calls the
00070  * error reporter with the error report associated with any uncaught exception
00071  * that has been raised.  Returns true if there was an exception pending, and
00072  * the error reporter was actually called.
00073  *
00074  * The JSErrorReport * that the error reporter is called with is currently
00075  * associated with a JavaScript object, and is not guaranteed to persist after
00076  * the object is collected.  Any persistent uses of the JSErrorReport contents
00077  * should make their own copy.
00078  *
00079  * The flags field of the JSErrorReport will have the JSREPORT_EXCEPTION flag
00080  * set; embeddings that want to silently propagate JavaScript exceptions to
00081  * other contexts may want to use an error reporter that ignores errors with
00082  * this flag.
00083  */
00084 extern JSBool
00085 js_ReportUncaughtException(JSContext *cx);
00086 
00087 extern JSErrorReport *
00088 js_ErrorFromException(JSContext *cx, jsval exn);
00089 
00090 extern const JSErrorFormatString *
00091 js_GetLocalizedErrorMessage(JSContext* cx, void *userRef, const char *locale,
00092                             const uintN errorNumber);
00093 
00094 JS_END_EXTERN_C
00095 
00096 #endif /* jsexn_h___ */