Back to index

lightning-sunbird  0.9+nobinonly
nsIException.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  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039  * Interfaces for representing cross-language exceptions and stack traces.
00040  */
00041 
00042 
00043 #include "nsISupports.idl"
00044 #include "nsIProgrammingLanguage.idl"
00045 
00046 // XXX - most "string"s in this file should probably move to Unicode
00047 //       so may as well use AStrings...
00048 
00049 
00050 [scriptable, uuid(91d82105-7c62-4f8b-9779-154277c0ee90)]
00051 interface nsIStackFrame : nsISupports
00052 {
00053     // see nsIProgrammingLanguage for list of language consts
00054     readonly attribute PRUint32                language;
00055     readonly attribute string                  languageName;
00056     readonly attribute string                  filename;
00057     readonly attribute string                  name;
00058     // Valid line numbers begin at '1'. '0' indicates unknown.
00059     readonly attribute PRInt32                 lineNumber;
00060     readonly attribute string                  sourceLine;
00061     readonly attribute nsIStackFrame           caller;
00062 
00063     string toString();
00064 };
00065 
00066 [scriptable, uuid(F3A8D3B4-C424-4edc-8BF6-8974C983BA78)]
00067 interface nsIException : nsISupports
00068 {
00069     // A custom message set by the thrower.
00070     readonly attribute string                  message;
00071     // The nsresult associated with this exception.
00072     readonly attribute nsresult                result;
00073     // The name of the error code (ie, a string repr of |result|)
00074     readonly attribute string                  name;
00075 
00076     // Filename location.  This is the location that caused the
00077     // error, which may or may not be a source file location.
00078     // For example, standard language errors would generally have
00079     // the same location as their top stack entry.  File
00080     // parsers may put the location of the file they were parsing,
00081     // etc.
00082 
00083     // null indicates "no data"
00084     readonly attribute string                  filename;
00085     // Valid line numbers begin at '1'. '0' indicates unknown.
00086     readonly attribute PRUint32                lineNumber;
00087     // Valid column numbers begin at 0. 
00088     // We don't have an unambiguous indicator for unknown.
00089     readonly attribute PRUint32                columnNumber;
00090 
00091     // A stack trace, if available.
00092     readonly attribute nsIStackFrame           location;
00093     // An inner exception that triggered this, if available.
00094     readonly attribute nsIException            inner;
00095 
00096     // Arbitary data for the implementation.
00097     readonly attribute nsISupports             data;
00098 
00099     // A generic formatter - make it suitable to print, etc.
00100     string toString();
00101 };