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 "plugbase.h"
00042 #include "action.h"
00043 #include "log.h"
00044 #include "logFile.h"
00045 
00046 class CLogger
00047 {
00048 private:
00049   CPluginBase * m_pPlugin;
00050   NPP m_pPluginInstance;
00051   CLogItemList * m_pLog;
00052   CLogFile * m_pLogFile;
00053   BOOL m_bShowImmediately;
00054   BOOL m_bLogToFile;
00055   BOOL m_bLogToFrame;
00056   BOOL m_bBlockLogToFile;
00057   BOOL m_bBlockLogToFrame;
00058   char m_szTarget[256];
00059   NPStream * m_pStream;
00060   char m_szStreamType[80];
00061   DWORD m_dwStartTime;
00062   char m_szItemSeparator[80];
00063   int m_iStringDataWrap;
00064   BOOL m_bStale;
00065 
00066 public:
00067   CLogger(LPSTR szTarget = NULL);
00068   ~CLogger();
00069 
00070   void associate(CPluginBase * pPlugin);
00071 
00072   void setShowImmediatelyFlag(BOOL bFlagState);
00073   void setLogToFileFlag(BOOL bFlagState);
00074   void setLogToFrameFlag(BOOL bFlagState);
00075 
00076   BOOL getShowImmediatelyFlag();
00077   BOOL getLogToFileFlag();
00078   BOOL getLogToFrameFlag();
00079   int getStringDataWrap();
00080 
00081   void restorePreferences(LPSTR szFileName);
00082 
00083   BOOL onNPP_DestroyStream(NPStream * npStream);
00084 
00085   BOOL appendToLog(NPAPI_Action action, DWORD dwTickEnter, DWORD dwTickReturn, DWORD dwRet = 0L, 
00086                    DWORD dw1 = 0L, DWORD dw2 = 0L, DWORD dw3 = 0L, DWORD dw4 = 0L, 
00087                    DWORD dw5 = 0L, DWORD dw6 = 0L, DWORD dw7 = 0L);
00088   void dumpLogToTarget();
00089   void clearLog();
00090   void clearTarget();
00091   void resetStartTime();
00092   void blockDumpToFile(BOOL bBlock);
00093   void blockDumpToFrame(BOOL bBlock);
00094 
00095   void closeLogToFile();
00096 
00097   void markStale();
00098   BOOL isStale();
00099 };
00100 
00101 #define LOGGER_DEFAULT_STRING_WRAP    32
00102 #define LOGGER_DEFAULT_TARGET "_npapi_Log"
00103 
00104 // Preferences profile stuff
00105 #define SECTION_LOG           "Log"
00106 #define KEY_RECORD_SEPARATOR  "RecordSeparator"
00107 #define KEY_STRING_WRAP       "StringDataWrap"
00108 #define KEY_FILE_NAME         "FileName"
00109 
00110 #endif // __LOGGER_H__