source: trunk/third/firefox/xpcom/base/nsIConsoleService.idl @ 21695

Revision 21695, 3.2 KB checked in by rbasch, 20 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r21694, which included commits to RCS files with non-trunk default branches.
Line 
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/* ***** BEGIN LICENSE BLOCK *****
3 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Netscape Public License
6 * Version 1.1 (the "License"); you may not use this file except in
7 * compliance with the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/NPL/
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 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 NPL, 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 NPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#include "nsISupports.idl"
39#include "nsIConsoleListener.idl"
40#include "nsIConsoleMessage.idl"
41
42[scriptable, uuid(a647f184-1dd1-11b2-a9d1-8537b201161b)]
43interface nsIConsoleService : nsISupports
44{
45    void logMessage(in nsIConsoleMessage message);
46
47    /**
48     * Convenience method for logging simple messages.
49     */
50    void logStringMessage(in wstring message);
51
52    /**
53     * Get an array of all the messages logged so far.  If no messages
54     * are logged, this function will return a count of 0, but still
55     * will allocate one word for messages, so as to show up as a
56     * 0-length array when called from script.
57     */
58    void getMessageArray([array, size_is(count)] out nsIConsoleMessage messages,
59                         out PRUint32 count);
60
61    /**
62     * To guard against stack overflows from listeners that could log
63     * messages (it's easy to do this inadvertently from listeners
64     * implemented in JavaScript), we don't call any listeners when
65     * another error is already being logged.
66     */
67    void registerListener(in nsIConsoleListener listener);
68
69    /**
70     * Each registered listener should also be unregistered.
71     */
72    void unregisterListener(in nsIConsoleListener listener);
73   
74};
75
76
77%{ C++
78#define NS_CONSOLESERVICE_CLASSNAME "Console Service"
79
80#define NS_CONSOLESERVICE_CID \
81{ 0x7e3ff85c, 0x1dd2, 0x11b2, { 0x8d, 0x4b, 0xeb, 0x45, 0x2c, 0xb0, 0xff, 0x40 }}
82
83#define NS_CONSOLESERVICE_CONTRACTID "@mozilla.org/consoleservice;1"
84%}
85
Note: See TracBrowser for help on using the repository browser.