1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.nashorn.internal.runtime;
import java.io.PrintWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
import jdk.nashorn.internal.runtime.options.Options;
/**
* Wrapper class for Logging system. This is how you are supposed to register a logger and use it
*/
public final class DebugLogger {
@SuppressWarnings("NonConstantLogger")
private final Logger logger;
private final boolean isEnabled;
private int indent;
private static final int INDENT_SPACE = 4;
/**
* Constructor
*
* @param loggerName name of logger - this is the unique key with which it can be identified
*/
public DebugLogger(final String loggerName) {
this(loggerName, null);
}
/**
* Constructor
*
* A logger can be paired with a property, e.g. {@code --log:codegen:info} is equivalent to {@code -Dnashorn.codegen.log}
*
* @param loggerName name of logger - this is the unique key with which it can be identified
* @param property system property activating the logger on {@code info} level
*/
public DebugLogger(final String loggerName, final String property) {
if (property != null && Options.getBooleanProperty(property)) {
this.logger = Logging.getOrCreateLogger(loggerName, Level.INFO);
} else {
this.logger = Logging.getLogger(loggerName);
}
this.isEnabled = logger.getLevel() != Level.OFF;
}
/**
* Get the output writer for the logger. Loggers always default to
* stderr for output as they are used mainly to output debug info
*
* Can be inherited so this should not be static.
*
* @return print writer for log output.
*/
@SuppressWarnings("static-method")
public PrintWriter getOutputStream() {
return Context.getCurrentErr();
}
/**
* Check if the logger is enabled
* @return true if enabled
*/
public boolean isEnabled() {
return isEnabled;
}
/**
* If you want to change the indent level of your logger, call indent with a new position.
* Positions start at 0 and are increased by one for a new "tab"
*
* @param pos indent position
*/
public void indent(final int pos) {
if (isEnabled) {
indent += pos * INDENT_SPACE;
}
}
/**
* Add an indent position
*/
public void indent() {
indent += INDENT_SPACE;
}
/**
* Unindent a position
*/
public void unindent() {
indent -= INDENT_SPACE;
if (indent < 0) {
indent = 0;
}
}
/**
* Check if the logger is above of the level of detail given
* @see java.util.logging.Level
*
* @param level logging level
* @return true if level is above the given one
*/
public boolean levelAbove(final Level level) {
return logger.getLevel().intValue() > level.intValue();
}
/**
* Shorthand for outputting a log string as log level {@link java.util.logging.Level#FINEST} on this logger
* @param str the string to log
*/
public void finest(final String str) {
log(str, Level.FINEST);
}
/**
* Shorthand for outputting a log string as log level
* {@link java.util.logging.Level#FINER} on this logger
* @param str the string to log
*/
public void finer(final String str) {
log(str, Level.FINER);
}
/**
* Shorthand for outputting a log string as log level
* {@link java.util.logging.Level#FINE} on this logger
* @param str the string to log
*/
public void fine(final String str) {
log(str, Level.FINE);
}
/**
* Shorthand for outputting a log string as log level
* {@link java.util.logging.Level#CONFIG} on this logger
* @param str the string to log
*/
public void config(final String str) {
log(str, Level.CONFIG);
}
/**
* Shorthand for outputting a log string as log level
* {@link java.util.logging.Level#INFO} on this logger
* @param str the string to log
*/
public void info(final String str) {
log(str, Level.INFO);
}
/**
* Shorthand for outputting a log string as log level
* {@link java.util.logging.Level#WARNING} on this logger
* @param str the string to log
*/
public void warning(final String str) {
log(str, Level.WARNING);
}
/**
* Shorthand for outputting a log string as log level
* {@link java.util.logging.Level#SEVERE} on this logger
* @param str the string to log
*/
public void severe(final String str) {
log(str, Level.SEVERE);
}
/**
* Output log line on this logger at a given level of verbosity
* @see java.util.logging.Level
*
* @param str string to log
* @param level minimum log level required for logging to take place
*/
public void log(final String str, final Level level) {
if (isEnabled) {
final StringBuilder sb = new StringBuilder();
for (int i = 0 ; i < indent ; i++) {
sb.append(' ');
}
sb.append(str);
logger.log(level, sb.toString());
}
}
}
|
