Back to index

lightning-sunbird  0.9+nobinonly
nsConsoleService.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039  * nsConsoleService class declaration.
00040  */
00041 
00042 #ifndef __nsconsoleservice_h__
00043 #define __nsconsoleservice_h__
00044 
00045 #include "nsCOMPtr.h"
00046 #include "nsHashtable.h"
00047 #include "nsAutoLock.h"
00048 
00049 #include "nsIConsoleService.h"
00050 
00051 class nsConsoleService : public nsIConsoleService_MOZILLA_1_8_BRANCH
00052 {
00053 public:
00054     nsConsoleService();
00055     nsresult Init();
00056 
00057     NS_DECL_ISUPPORTS
00058     NS_DECL_NSICONSOLESERVICE
00059     NS_DECL_NSICONSOLESERVICE_MOZILLA_1_8_BRANCH
00060 
00061 private:
00062     ~nsConsoleService();
00063 
00064     // build (or find) a proxy for the listener
00065     nsresult GetProxyForListener(nsIConsoleListener* aListener,
00066                                  nsIConsoleListener** aProxy);
00067 
00068     // Circular buffer of saved messages
00069     nsIConsoleMessage **mMessages;
00070 
00071     // How big?
00072     PRUint32 mBufferSize;
00073 
00074     // Index of slot in mMessages that'll be filled by *next* log message
00075     PRUint32 mCurrent;
00076 
00077     // Is the buffer full? (Has mCurrent wrapped around at least once?)
00078     PRBool mFull;
00079 
00080     // Listeners to notify whenever a new message is logged.
00081     nsSupportsHashtable mListeners;
00082 
00083     // Current listener being notified of a logged error - to prevent
00084     // stack overflows.
00085     PRBool mListening;
00086 
00087     // To serialize interesting methods.
00088     PRLock *mLock;
00089 };
00090 
00091 #endif /* __nsconsoleservice_h__ */