FreeWRL / FreeX3D
4.3.0
nsPluginLogging.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 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
/* Plugin Module Logging usage instructions and includes */
40
#ifndef nsPluginLogging_h__
41
#define nsPluginLogging_h__
42
43
#define FORCE_PR_LOG
/* Allow logging in the release build */
44
#define PR_LOGGING 1
45
46
#ifdef PR_LOGGING
47
#include "prlog.h"
48
49
#ifndef PLUGIN_LOGGING
// allow external override
50
#define PLUGIN_LOGGING 1
// master compile-time switch for pluging logging
51
#endif
52
54
// Basic Plugin Logging Usage Instructions
55
//
56
// 1. Set this environment variable: NSPR_LOG_MODULES=<name>:<level>
57
58
// Choose the <name> and <level> from this list (no quotes):
59
60
// Log Names <name>
61
#define NPN_LOG_NAME "PluginNPN"
62
#define NPP_LOG_NAME "PluginNPP"
63
#define PLUGIN_LOG_NAME "Plugin"
64
65
// Levels <level>
66
#define PLUGIN_LOG_ALWAYS 1
67
#define PLUGIN_LOG_BASIC 3
68
#define PLUGIN_LOG_NORMAL 5
69
#define PLUGIN_LOG_NOISY 7
70
#define PLUGIN_LOG_MAX 9
71
72
// 2. You can combine logs and levels by separating them with a comma:
73
// My favorite Win32 Example: SET NSPR_LOG_MODULES=Plugin:5,PluginNPP:5,PluginNPN:5
74
75
// 3. Instead of output going to the console, you can log to a file. Additionally, set the
76
// NSPR_LOG_FILE environment variable to point to the full path of a file.
77
// My favorite Win32 Example: SET NSPR_LOG_FILE=c:\temp\pluginLog.txt
78
79
// 4. For complete information see the NSPR Reference:
80
// http://www.mozilla.org/projects/nspr/reference/html/prlog.html
81
82
83
#ifdef PLUGIN_LOGGING
84
85
class
nsPluginLogging
86
{
87
public
:
88
static
PRLogModuleInfo* gNPNLog;
// 4.x NP API, calls into navigator
89
static
PRLogModuleInfo* gNPPLog;
// 4.x NP API, calls into plugin
90
static
PRLogModuleInfo* gPluginLog;
// general plugin log
91
};
92
93
#endif
// PLUGIN_LOGGING
94
95
#endif
// PR_LOGGING
96
97
// Quick-use macros
98
#ifdef PLUGIN_LOGGING
99
#define NPN_PLUGIN_LOG(a, b) \
100
PR_BEGIN_MACRO \
101
PR_LOG(nsPluginLogging::gNPNLog, a, b); \
102
PR_LogFlush(); \
103
PR_END_MACRO
104
#else
105
#define NPN_PLUGIN_LOG(a, b)
106
#endif
107
108
#ifdef PLUGIN_LOGGING
109
#define NPP_PLUGIN_LOG(a, b) \
110
PR_BEGIN_MACRO \
111
PR_LOG(nsPluginLogging::gNPPLog, a, b); \
112
PR_LogFlush(); \
113
PR_END_MACRO
114
#else
115
#define NPP_PLUGIN_LOG(a, b)
116
#endif
117
118
#ifdef PLUGIN_LOGGING
119
#define PLUGIN_LOG(a, b) \
120
PR_BEGIN_MACRO \
121
PR_LOG(nsPluginLogging::gPluginLog, a, b); \
122
PR_LogFlush(); \
123
PR_END_MACRO
124
#else
125
#define PLUGIN_LOG(a, b)
126
#endif
127
128
#endif
// nsPluginLogging_h__
129
nsPluginLogging
Definition
nsPluginLogging.h:86
src
plugin_win32
include
nsPluginLogging.h
Generated by
1.11.0