| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is Mozilla Breakpad Integration. |
| * |
| * The Initial Developer of the Original Code is |
| * Ted Mielczarek <ted.mielczarek@gmail.com> |
| * |
| * Portions created by the Initial Developer are Copyright (C) 2007 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| |
| /** |
| * Provides access to crash reporting functionality. |
| * @status UNSTABLE - This interface is not frozen and will probably change in |
| * future releases. |
| */ |
| |
| [scriptable, uuid(4d6449fe-d642-45e5-9773-41af5793c99a)] |
| interface nsICrashReporter : nsISupports |
| { |
| /** |
| * Add some extra data to be submitted with a crash report. |
| * @param key |
| * Name of the data to be added. |
| * @param data |
| * Data to be added. |
| * |
| * @throw NS_ERROR_NOT_INITIALIZED if crash reporting not initialized |
| * @throw NS_ERROR_INVALID_ARG if key or data contain invalid characters. |
| * Invalid characters for key are '=' and |
| * '\n'. Invalid character for data is '\0'. |
| */ |
| void annotateCrashReport(in ACString key, in ACString data); |
| |
| /** |
| * Write a minidump immediately, with the user-supplied exception |
| * information. This is implemented on Windows only, because |
| * SEH (structured exception handling) exists on Windows only. |
| * @param aExceptionInfo EXCEPTION_INFO* provided by Window's SEH |
| */ |
| [noscript] void WriteMinidumpForException(in voidPtr aExceptionInfo); |
| }; |
| |
| [scriptable, uuid(5d0c6cc1-e1e7-42ce-ae99-ff7b9466a909)] |
| interface nsICrashReporter_MOZILLA_1_9_BRANCH : nsISupports |
| { |
| /** |
| * Append some data to the "Notes" field, to be submitted with a crash report. |
| * Unlike annotateCrashReport, this method will append to existing data. |
| * |
| * @param data |
| * Data to be added. |
| * |
| * @throw NS_ERROR_NOT_INITIALIZED if crash reporting not initialized |
| * @throw NS_ERROR_INVALID_ARG if or data contains invalid characters. |
| * The only invalid character is '\0'. |
| */ |
| void appendAppNotesToCrashReport(in ACString data); |
| |
| /** |
| * Append note containing an Obj-C exception's info. |
| * @param aException NSException object to append note for |
| */ |
| [noscript] void appendObjCExceptionInfoToAppNotes(in voidPtr aException); |
| }; |