xpcom/base/nsIConsoleService.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  *   Simon Bünzli <zeniko@gmail.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "nsIConsoleListener.idl"
  41 #include "nsIConsoleMessage.idl"
  42
  43 [scriptable, uuid(883472a0-ea9b-11da-8ad9-0800200c9a66)]
  44 interface nsIConsoleService : nsISupports
  45 {
  46     void logMessage(in nsIConsoleMessage message);
  47
  48     /**
  49      * Convenience method for logging simple messages.
  50      */
  51     void logStringMessage(in wstring message);
  52
  53     /**
  54      * Get an array of all the messages logged so far.  If no messages
  55      * are logged, this function will return a count of 0, but still
  56      * will allocate one word for messages, so as to show up as a
  57      * 0-length array when called from script.
  58      */
  59     void getMessageArray([array, size_is(count)] out nsIConsoleMessage messages,
  60                          out PRUint32 count);
  61
  62     /**
  63      * To guard against stack overflows from listeners that could log
  64      * messages (it's easy to do this inadvertently from listeners
  65      * implemented in JavaScript), we don't call any listeners when
  66      * another error is already being logged.
  67      */
  68     void registerListener(in nsIConsoleListener listener);
  69
  70     /**
  71      * Each registered listener should also be unregistered.
  72      */
  73     void unregisterListener(in nsIConsoleListener listener);
  74
  75     /**
  76      * Clear the message buffer (e.g. for privacy reasons).
  77      */
  78     void reset();
  79 };
  80
  81
  82 %{ C++
  83 #define NS_CONSOLESERVICE_CLASSNAME "Console Service"
  84
  85 #define NS_CONSOLESERVICE_CID \
  86 { 0x7e3ff85c, 0x1dd2, 0x11b2, { 0x8d, 0x4b, 0xeb, 0x45, 0x2c, 0xb0, 0xff, 0x40 }}
  87
  88 #define NS_CONSOLESERVICE_CONTRACTID "@mozilla.org/consoleservice;1"
  89 %}
  90