Back to index

lightning-sunbird  0.9+nobinonly
logger.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 the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 #ifndef _LOGGER_H__
00039 #define __LOGGER_H__
00040 
00041 #include "npupp.h"
00042 #include "format.h"
00043 #include "logfile.h"
00044 
00045 #define TOTAL_NUMBER_OF_API_CALLS 37
00046 #define DEFAULT_LOG_FILE_NAME "spylog.txt"
00047 
00048 class Logger
00049 {
00050 public:
00051   BOOL bMutedAll;
00052   BOOL bToWindow;
00053   BOOL bToConsole;
00054   BOOL bToFile;
00055   BOOL bOnTop;
00056   BOOL bSPALID; //ShutdownPluginAfterLastInstanceDestroyed
00057                 // as opposed to 'only when NS asks to'
00058   CLogFile filer;
00059 
00060   BOOL bSaveSettings;
00061   char szFile[_MAX_PATH];
00062   
00063   // 37 is the total number of API calls 
00064   // (NPN_* and NPP_* only, NPP_Initialize and NPP_Shutdown not included)
00065   BOOL bMutedCalls[TOTAL_NUMBER_OF_API_CALLS];
00066 
00067 public:
00068   Logger();
00069   ~Logger();
00070 
00071   BOOL init();
00072   void shut();
00073 
00074   // platform dependent virtuals
00075   virtual BOOL platformInit() = 0;
00076   virtual void platformShut() = 0;
00077   virtual void dumpStringToMainWindow(char * string) = 0;
00078 
00079   void setOnTop(BOOL ontop);
00080   void setToFile(BOOL tofile, char * filename);
00081 
00082   BOOL * getMutedCalls();
00083   void setMutedCalls(BOOL * mutedcalls);
00084 
00085   BOOL isMuted(NPAPI_Action action);
00086 
00087   void logNS_NP_GetEntryPoints();
00088   void logNS_NP_Initialize();
00089   void logNS_NP_Shutdown();
00090 
00091   void logSPY_NP_GetEntryPoints(NPPluginFuncs * pNPPFuncs);
00092   void logSPY_NP_Initialize();
00093   void logSPY_NP_Shutdown(char * mimetype);
00094 
00095   void logCall(NPAPI_Action action, DWORD dw1 = 0L, DWORD dw2 = 0L, 
00096                DWORD dw3 = 0L, DWORD dw4 = 0L, DWORD dw5 = 0L, DWORD dw6 = 0L, DWORD dw7 = 0L);
00097   void logReturn(DWORD dwRet = 0L);
00098 };
00099 
00100 Logger * NewLogger();
00101 void DeleteLogger(Logger * logger);
00102 
00103 #endif