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 the GNU General Public License Version 2 or later (the "GPL"), or
26 * 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#ifndef _LOGGER_H__
39#define __LOGGER_H__
40
41#include "npupp.h"
42#include "format.h"
43#include "logfile.h"
44
45#define TOTAL_NUMBER_OF_API_CALLS 60
46#define DEFAULT_LOG_FILE_NAME "spylog.txt"
47
48class Logger
49{
50public:
51  BOOL bMutedAll;
52  BOOL bToWindow;
53  BOOL bToConsole;
54  BOOL bToFile;
55  BOOL bOnTop;
56  BOOL bSPALID; //ShutdownPluginAfterLastInstanceDestroyed
57                // as opposed to 'only when NS asks to'
58  CLogFile filer;
59
60  BOOL bSaveSettings;
61  char szFile[_MAX_PATH];
62
63  // 37 is the total number of API calls
64  // (NPN_* and NPP_* only, NPP_Initialize and NPP_Shutdown not included)
65  BOOL bMutedCalls[TOTAL_NUMBER_OF_API_CALLS];
66
67public:
68  Logger();
69  ~Logger();
70
71  BOOL init();
72  void shut();
73
74  // platform dependent virtuals
75  virtual BOOL platformInit() = 0;
76  virtual void platformShut() = 0;
77  virtual void dumpStringToMainWindow(const std::string& string) = 0;
78
79  void setOnTop(BOOL ontop);
80  void setToFile(BOOL tofile, char * filename);
81
82  BOOL * getMutedCalls();
83  void setMutedCalls(BOOL * mutedcalls);
84
85  BOOL isMuted(NPAPI_Action action);
86
87  void logNS_NP_GetEntryPoints();
88  void logNS_NP_Initialize();
89  void logNS_NP_Shutdown();
90
91  void logSPY_NP_GetEntryPoints(NPPluginFuncs * pNPPFuncs);
92  void logSPY_NP_Initialize();
93  void logSPY_NP_Shutdown(char * mimetype);
94
95  void logMessage(const char *msg);
96
97  void logCall(NPAPI_Action action, DWORD dw1 = 0L, DWORD dw2 = 0L,
98               DWORD dw3 = 0L, DWORD dw4 = 0L, DWORD dw5 = 0L, DWORD dw6 = 0L, DWORD dw7 = 0L);
99  void logReturn(NPAPI_Action action, DWORD dwRet = 0L);
100};
101
102Logger * NewLogger();
103void DeleteLogger(Logger * logger);
104
105#endif
106