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 * nsIConsoleMessage subclass for representing JavaScript errors and warnings.
40 */
41
42
43 #include "nsISupports.idl"
44 #include "nsIConsoleMessage.idl"
45
46 [scriptable, uuid(b0196fc7-1913-441a-882a-453c0d8b89b8)]
47 interface nsIScriptError : nsIConsoleMessage
48 {
49 /** pseudo-flag for default case */
50 const unsigned long errorFlag = 0x0;
51
52 /** message is warning */
53 const unsigned long warningFlag = 0x1;
54
55 /** exception was thrown for this case - exception-aware hosts can ignore */
56 const unsigned long exceptionFlag = 0x2;
57
58 // XXX check how strict is implemented these days.
59 /** error or warning is due to strict option */
60 const unsigned long strictFlag = 0x4;
61
62 /**
63 * The error message without any context/line number information.
64 *
65 * @note nsIConsoleMessage.message will return the error formatted
66 * with file/line information.
67 */
68 readonly attribute AString errorMessage;
69
70 readonly attribute AString sourceName;
71 readonly attribute AString sourceLine;
72 readonly attribute PRUint32 lineNumber;
73 readonly attribute PRUint32 columnNumber;
74 readonly attribute PRUint32 flags;
75
76 /**
77 * Categories I know about -
78 * XUL javascript
79 * content javascript (both of these from nsDocShell, currently)
80 * component javascript (errors in JS components)
81 */
82 readonly attribute string category;
83
84 void init(in wstring message,
85 in wstring sourceName,
86 in wstring sourceLine,
87 in PRUint32 lineNumber,
88 in PRUint32 columnNumber,
89 in PRUint32 flags,
90 in string category);
91
92 AUTF8String toString();
93 };
94
95 %{ C++
96 #define NS_SCRIPTERROR_CLASSNAME "Script Error"
97
98 #define NS_SCRIPTERROR_CID \
99 { 0xe38e53b9, 0x5bb0, 0x456a, { 0xb5, 0x53, 0x57, 0x93, 0x70, 0xcb, 0x15, 0x67 }}
100
101 #define NS_SCRIPTERROR_CONTRACTID "@mozilla.org/scripterror;1"
102 %}