xpcom/base/nsConsoleService.h

   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  * nsConsoleService class declaration.
  40  */
  41
  42 #ifndef __nsconsoleservice_h__
  43 #define __nsconsoleservice_h__
  44
  45 #include "nsCOMPtr.h"
  46 #include "nsHashtable.h"
  47 #include "nsAutoLock.h"
  48
  49 #include "nsIConsoleService.h"
  50
  51 class nsConsoleService : public nsIConsoleService
  52 {
  53 public:
  54     nsConsoleService();
  55     nsresult Init();
  56
  57     NS_DECL_ISUPPORTS
  58     NS_DECL_NSICONSOLESERVICE
  59
  60 private:
  61     ~nsConsoleService();
  62
  63     // build (or find) a proxy for the listener
  64     nsresult GetProxyForListener(nsIConsoleListener* aListener,
  65                                  nsIConsoleListener** aProxy);
  66
  67     // Circular buffer of saved messages
  68     nsIConsoleMessage **mMessages;
  69
  70     // How big?
  71     PRUint32 mBufferSize;
  72
  73     // Index of slot in mMessages that'll be filled by *next* log message
  74     PRUint32 mCurrent;
  75
  76     // Is the buffer full? (Has mCurrent wrapped around at least once?)
  77     PRBool mFull;
  78
  79     // Listeners to notify whenever a new message is logged.
  80     nsSupportsHashtable mListeners;
  81
  82     // Current listener being notified of a logged error - to prevent
  83     // stack overflows.
  84     PRBool mListening;
  85
  86     // To serialize interesting methods.
  87     PRLock *mLock;
  88 };
  89
  90 #endif /* __nsconsoleservice_h__ */