1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is Mozilla Breakpad Integration.
15 *
16 * The Initial Developer of the Original Code is
17 * Ted Mielczarek <ted.mielczarek@gmail.com>
18 *
19 * Portions created by the Initial Developer are Copyright (C) 2007
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 the GNU General Public License Version 2 or later (the "GPL"), or
26 * 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 #include "nsISupports.idl"
39
40 /**
41 * Provides access to crash reporting functionality.
42 * @status UNSTABLE - This interface is not frozen and will probably change in
43 * future releases.
44 */
45
46 [scriptable, uuid(4d6449fe-d642-45e5-9773-41af5793c99a)]
47 interface nsICrashReporter : nsISupports
48 {
49 /**
50 * Add some extra data to be submitted with a crash report.
51 * @param key
52 * Name of the data to be added.
53 * @param data
54 * Data to be added.
55 *
56 * @throw NS_ERROR_NOT_INITIALIZED if crash reporting not initialized
57 * @throw NS_ERROR_INVALID_ARG if key or data contain invalid characters.
58 * Invalid characters for key are '=' and
59 * '\n'. Invalid character for data is '\0'.
60 */
61 void annotateCrashReport(in ACString key, in ACString data);
62
63 /**
64 * Write a minidump immediately, with the user-supplied exception
65 * information. This is implemented on Windows only, because
66 * SEH (structured exception handling) exists on Windows only.
67 * @param aExceptionInfo EXCEPTION_INFO* provided by Window's SEH
68 */
69 [noscript] void WriteMinidumpForException(in voidPtr aExceptionInfo);
70 };