Back to index

lightning-sunbird  0.9+nobinonly
nsIExceptionService.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * ActiveState Tool Corp..
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Mark Hammond <MarkH@ActiveState.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 #include "nsIException.idl"
00041 
00042 // An exception provider.  These can turn special nsresult codes
00043 // into nsIExceptions
00044 
00045 [scriptable, uuid(0577744c-c1d2-47f2-8bcc-ce7a9e5a88fc)]
00046 interface nsIExceptionProvider : nsISupports
00047 {
00049     nsIException getException(in nsresult result, in nsIException defaultException);
00050 };
00051 
00052 // A ScriptErrorManager for a single thread.  These objects
00053 // are _not_ thread-safe.  Use the ScriptErrorService
00054 // to get a script error manager for your current thread.
00055 [scriptable, uuid(efc9d00b-231c-4feb-852c-ac017266a415)]
00056 interface nsIExceptionManager : nsISupports
00057 {
00059     void setCurrentException( in nsIException error);
00060 
00062      nsIException getCurrentException();
00063 
00066     nsIException getExceptionFromProvider( in nsresult rc, in nsIException defaultException);
00067 };
00068 
00069 
00070 // The Exception Service.  Allows you to get an set exceptions in a thread
00071 // safe manner, or to get an ExceptionManager for your specific thread.
00072 [scriptable, uuid(35A88F54-F267-4414-92A7-191F6454AB52)]
00073 interface nsIExceptionService : nsIExceptionManager
00074 {
00076     readonly attribute nsIExceptionManager currentExceptionManager;
00077 
00086     void registerExceptionProvider( in nsIExceptionProvider provider, in PRUint32 moduleCode );
00087     void unregisterExceptionProvider( in nsIExceptionProvider provider, in PRUint32 moduleCode );
00088 };
00089 
00090 
00091 %{ C++
00092 #define NS_EXCEPTIONSERVICE_CLASSNAME "Exception Service"
00093 // {35A88F54-F267-4414-92A7-191F6454AB52}
00094 #define NS_EXCEPTIONSERVICE_CID \
00095 { 0x35a88f54, 0xf267, 0x4414, { 0x92, 0xa7, 0x19, 0x1f, 0x64, 0x54, 0xab, 0x52 } }
00096 #define NS_EXCEPTIONSERVICE_CONTRACTID "@mozilla.org/exceptionservice;1"
00097 %}