xpcom/base/nsIException.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /*
  39  * Interfaces for representing cross-language exceptions and stack traces.
  40  */
  41
  42
  43 #include "nsISupports.idl"
  44 #include "nsIProgrammingLanguage.idl"
  45
  46 // XXX - most "string"s in this file should probably move to Unicode
  47 //       so may as well use AStrings...
  48
  49
  50 [scriptable, uuid(91d82105-7c62-4f8b-9779-154277c0ee90)]
  51 interface nsIStackFrame : nsISupports
  52 {
  53     // see nsIProgrammingLanguage for list of language consts
  54     readonly attribute PRUint32                language;
  55     readonly attribute string                  languageName;
  56     readonly attribute string                  filename;
  57     readonly attribute string                  name;
  58     // Valid line numbers begin at '1'. '0' indicates unknown.
  59     readonly attribute PRInt32                 lineNumber;
  60     readonly attribute string                  sourceLine;
  61     readonly attribute nsIStackFrame           caller;
  62
  63     string toString();
  64 };
  65
  66 [scriptable, uuid(F3A8D3B4-C424-4edc-8BF6-8974C983BA78)]
  67 interface nsIException : nsISupports
  68 {
  69     // A custom message set by the thrower.
  70     [binaryname(MessageMoz)] readonly attribute string message;
  71     // The nsresult associated with this exception.
  72     readonly attribute nsresult                result;
  73     // The name of the error code (ie, a string repr of |result|)
  74     readonly attribute string                  name;
  75
  76     // Filename location.  This is the location that caused the
  77     // error, which may or may not be a source file location.
  78     // For example, standard language errors would generally have
  79     // the same location as their top stack entry.  File
  80     // parsers may put the location of the file they were parsing,
  81     // etc.
  82
  83     // null indicates "no data"
  84     readonly attribute string                  filename;
  85     // Valid line numbers begin at '1'. '0' indicates unknown.
  86     readonly attribute PRUint32                lineNumber;
  87     // Valid column numbers begin at 0.
  88     // We don't have an unambiguous indicator for unknown.
  89     readonly attribute PRUint32                columnNumber;
  90
  91     // A stack trace, if available.
  92     readonly attribute nsIStackFrame           location;
  93     // An inner exception that triggered this, if available.
  94     readonly attribute nsIException            inner;
  95
  96     // Arbitary data for the implementation.
  97     readonly attribute nsISupports             data;
  98
  99     // A generic formatter - make it suitable to print, etc.
 100     string toString();
 101 };