1 /*******************************************************************************
2 * Copyright (c) 2000, 2004 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Common Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/cpl-v10.html
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 package net.sourceforge.phpdt.internal.compiler.impl;
13 import java.io.ByteArrayInputStream;
14 import java.io.InputStreamReader;
15 import java.io.UnsupportedEncodingException;
16 import java.util.HashMap;
19 import net.sourceforge.phpdt.core.compiler.CharOperation;
20 import net.sourceforge.phpdt.internal.compiler.Compiler;
21 import net.sourceforge.phpdt.internal.compiler.env.IConstants;
22 import net.sourceforge.phpdt.internal.compiler.lookup.ProblemReasons;
23 import net.sourceforge.phpdt.internal.compiler.problem.ProblemSeverities;
25 public class CompilerOptions implements ProblemReasons, ProblemSeverities, IConstants {
30 public static final String OPTION_PHPVarDeprecatedWarning = "net.sourceforge.phpeclipse.compiler.problem.phpVarDeprecatedWarning"; //$NON-NLS-1$
32 public static final String OPTION_LocalVariableAttribute = "net.sourceforge.phpeclipse.compiler.debug.localVariable"; //$NON-NLS-1$
33 public static final String OPTION_LineNumberAttribute = "net.sourceforge.phpeclipse.compiler.debug.lineNumber"; //$NON-NLS-1$
34 public static final String OPTION_SourceFileAttribute = "net.sourceforge.phpeclipse.compiler.debug.sourceFile"; //$NON-NLS-1$
35 // public static final String OPTION_PreserveUnusedLocal = "net.sourceforge.phpeclipse.compiler.codegen.unusedLocal"; //$NON-NLS-1$
36 public static final String OPTION_ReportMethodWithConstructorName = "net.sourceforge.phpeclipse.compiler.problem.methodWithConstructorName"; //$NON-NLS-1$
37 public static final String OPTION_ReportOverridingPackageDefaultMethod = "net.sourceforge.phpeclipse.compiler.problem.overridingPackageDefaultMethod"; //$NON-NLS-1$
38 public static final String OPTION_ReportDeprecation = "net.sourceforge.phpeclipse.compiler.problem.deprecation"; //$NON-NLS-1$
39 public static final String OPTION_ReportDeprecationInDeprecatedCode = "net.sourceforge.phpeclipse.compiler.problem.deprecationInDeprecatedCode"; //$NON-NLS-1$
40 public static final String OPTION_ReportDeprecationWhenOverridingDeprecatedMethod = "net.sourceforge.phpeclipse.compiler.problem.deprecationWhenOverridingDeprecatedMethod"; //$NON-NLS-1$
41 public static final String OPTION_ReportHiddenCatchBlock = "net.sourceforge.phpeclipse.compiler.problem.hiddenCatchBlock"; //$NON-NLS-1$
42 public static final String OPTION_ReportUnusedLocal = "net.sourceforge.phpeclipse.compiler.problem.unusedLocal"; //$NON-NLS-1$
43 public static final String OPTION_ReportUnusedParameter = "net.sourceforge.phpeclipse.compiler.problem.unusedParameter"; //$NON-NLS-1$
44 public static final String OPTION_ReportUnusedParameterWhenImplementingAbstract = "net.sourceforge.phpeclipse.compiler.problem.unusedParameterWhenImplementingAbstract"; //$NON-NLS-1$
45 public static final String OPTION_ReportUnusedParameterWhenOverridingConcrete = "net.sourceforge.phpeclipse.compiler.problem.unusedParameterWhenOverridingConcrete"; //$NON-NLS-1$
46 public static final String OPTION_ReportUnusedImport = "net.sourceforge.phpeclipse.compiler.problem.unusedImport"; //$NON-NLS-1$
47 public static final String OPTION_ReportSyntheticAccessEmulation = "net.sourceforge.phpeclipse.compiler.problem.syntheticAccessEmulation"; //$NON-NLS-1$
48 public static final String OPTION_ReportNoEffectAssignment = "net.sourceforge.phpeclipse.compiler.problem.noEffectAssignment"; //$NON-NLS-1$
49 public static final String OPTION_ReportLocalVariableHiding = "net.sourceforge.phpeclipse.compiler.problem.localVariableHiding"; //$NON-NLS-1$
50 public static final String OPTION_ReportSpecialParameterHidingField = "net.sourceforge.phpeclipse.compiler.problem.specialParameterHidingField"; //$NON-NLS-1$
51 public static final String OPTION_ReportFieldHiding = "net.sourceforge.phpeclipse.compiler.problem.fieldHiding"; //$NON-NLS-1$
52 public static final String OPTION_ReportPossibleAccidentalBooleanAssignment = "net.sourceforge.phpeclipse.compiler.problem.possibleAccidentalBooleanAssignment"; //$NON-NLS-1$
53 public static final String OPTION_ReportNonExternalizedStringLiteral = "net.sourceforge.phpeclipse.compiler.problem.nonExternalizedStringLiteral"; //$NON-NLS-1$
54 public static final String OPTION_ReportIncompatibleNonInheritedInterfaceMethod = "net.sourceforge.phpeclipse.compiler.problem.incompatibleNonInheritedInterfaceMethod"; //$NON-NLS-1$
55 public static final String OPTION_ReportUnusedPrivateMember = "net.sourceforge.phpeclipse.compiler.problem.unusedPrivateMember"; //$NON-NLS-1$
56 public static final String OPTION_ReportNoImplicitStringConversion = "net.sourceforge.phpeclipse.compiler.problem.noImplicitStringConversion"; //$NON-NLS-1$
57 public static final String OPTION_ReportAssertIdentifier = "net.sourceforge.phpeclipse.compiler.problem.assertIdentifier"; //$NON-NLS-1$
58 public static final String OPTION_ReportNonStaticAccessToStatic = "net.sourceforge.phpeclipse.compiler.problem.staticAccessReceiver"; //$NON-NLS-1$
59 public static final String OPTION_ReportIndirectStaticAccess = "net.sourceforge.phpeclipse.compiler.problem.indirectStaticAccess"; //$NON-NLS-1$
60 public static final String OPTION_ReportSuperfluousSemicolon = "net.sourceforge.phpeclipse.compiler.problem.superfluousSemicolon"; //$NON-NLS-1$
61 public static final String OPTION_ReportUnnecessaryTypeCheck = "net.sourceforge.phpeclipse.compiler.problem.unnecessaryTypeCheck"; //$NON-NLS-1$
62 public static final String OPTION_ReportUndocumentedEmptyBlock = "net.sourceforge.phpeclipse.compiler.problem.undocumentedEmptyBlock"; //$NON-NLS-1$
63 public static final String OPTION_ReportInvalidJavadoc = "net.sourceforge.phpeclipse.compiler.problem.invalidJavadoc"; //$NON-NLS-1$
64 public static final String OPTION_ReportInvalidJavadocTags = "net.sourceforge.phpeclipse.compiler.problem.invalidJavadocTags"; //$NON-NLS-1$
65 public static final String OPTION_ReportInvalidJavadocTagsVisibility = "net.sourceforge.phpeclipse.compiler.problem.invalidJavadocTagsVisibility"; //$NON-NLS-1$
66 public static final String OPTION_ReportMissingJavadocTags = "net.sourceforge.phpeclipse.compiler.problem.missingJavadocTags"; //$NON-NLS-1$
67 public static final String OPTION_ReportMissingJavadocTagsVisibility = "net.sourceforge.phpeclipse.compiler.problem.missingJavadocTagsVisibility"; //$NON-NLS-1$
68 public static final String OPTION_ReportMissingJavadocTagsOverriding = "net.sourceforge.phpeclipse.compiler.problem.missingJavadocTagsOverriding"; //$NON-NLS-1$
69 public static final String OPTION_ReportMissingJavadocComments = "net.sourceforge.phpeclipse.compiler.problem.missingJavadocComments"; //$NON-NLS-1$
70 public static final String OPTION_ReportMissingJavadocCommentsVisibility = "net.sourceforge.phpeclipse.compiler.problem.missingJavadocCommentsVisibility"; //$NON-NLS-1$
71 public static final String OPTION_ReportMissingJavadocCommentsOverriding = "net.sourceforge.phpeclipse.compiler.problem.missingJavadocCommentsOverriding"; //$NON-NLS-1$
72 public static final String OPTION_ReportFinallyBlockNotCompletingNormally = "net.sourceforge.phpeclipse.compiler.problem.finallyBlockNotCompletingNormally"; //$NON-NLS-1$
73 public static final String OPTION_ReportUnusedDeclaredThrownException = "net.sourceforge.phpeclipse.compiler.problem.unusedDeclaredThrownException"; //$NON-NLS-1$
74 public static final String OPTION_ReportUnusedDeclaredThrownExceptionWhenOverriding = "net.sourceforge.phpeclipse.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding"; //$NON-NLS-1$
75 public static final String OPTION_ReportUnqualifiedFieldAccess = "net.sourceforge.phpeclipse.compiler.problem.unqualifiedFieldAccess"; //$NON-NLS-1$
76 // public static final String OPTION_Source = "net.sourceforge.phpeclipse.compiler.source"; //$NON-NLS-1$
77 // public static final String OPTION_TargetPlatform = "net.sourceforge.phpeclipse.compiler.codegen.targetPlatform"; //$NON-NLS-1$
78 // public static final String OPTION_Compliance = "net.sourceforge.phpeclipse.compiler.compliance"; //$NON-NLS-1$
79 public static final String OPTION_Encoding = "net.sourceforge.phpeclipse.encoding"; //$NON-NLS-1$
80 public static final String OPTION_MaxProblemPerUnit = "net.sourceforge.phpeclipse.compiler.maxProblemPerUnit"; //$NON-NLS-1$
81 public static final String OPTION_TaskTags = "net.sourceforge.phpeclipse.compiler.taskTags"; //$NON-NLS-1$
82 public static final String OPTION_TaskPriorities = "net.sourceforge.phpeclipse.compiler.taskPriorities"; //$NON-NLS-1$
84 // Backward compatibility
85 public static final String OPTION_ReportInvalidAnnotation = "net.sourceforge.phpeclipse.compiler.problem.invalidAnnotation"; //$NON-NLS-1$
86 public static final String OPTION_ReportMissingAnnotation = "net.sourceforge.phpeclipse.compiler.problem.missingAnnotation"; //$NON-NLS-1$
87 public static final String OPTION_ReportMissingJavadoc = "net.sourceforge.phpeclipse.compiler.problem.missingJavadoc"; //$NON-NLS-1$
89 /* should surface ??? */
90 // public static final String OPTION_PrivateConstructorAccess = "net.sourceforge.phpeclipse.compiler.codegen.constructorAccessEmulation"; //$NON-NLS-1$
93 * Possible values for configurable options
95 public static final String GENERATE = "generate";//$NON-NLS-1$
96 public static final String DO_NOT_GENERATE = "do not generate"; //$NON-NLS-1$
97 public static final String PRESERVE = "preserve"; //$NON-NLS-1$
98 // public static final String OPTIMIZE_OUT = "optimize out"; //$NON-NLS-1$
99 // public static final String VERSION_1_1 = "1.1"; //$NON-NLS-1$
100 // public static final String VERSION_1_2 = "1.2"; //$NON-NLS-1$
101 // public static final String VERSION_1_3 = "1.3"; //$NON-NLS-1$
102 // public static final String VERSION_1_4 = "1.4"; //$NON-NLS-1$
103 // public static final String VERSION_1_5 = "1.5"; //$NON-NLS-1$
104 public static final String ERROR = "error"; //$NON-NLS-1$
105 public static final String WARNING = "warning"; //$NON-NLS-1$
106 public static final String IGNORE = "ignore"; //$NON-NLS-1$
107 public static final String ENABLED = "enabled"; //$NON-NLS-1$
108 public static final String DISABLED = "disabled"; //$NON-NLS-1$
109 public static final String PUBLIC = "public"; //$NON-NLS-1$
110 public static final String PROTECTED = "protected"; //$NON-NLS-1$
111 public static final String DEFAULT = "default"; //$NON-NLS-1$
112 public static final String PRIVATE = "private"; //$NON-NLS-1$
115 * Bit mask for configurable problems (error/warning threshold)
121 public static final long MethodWithConstructorName = 0x1000L;
122 public static final long OverriddenPackageDefaultMethod = 0x2000L;
123 public static final long UsingDeprecatedAPI = 0x4000L;
124 public static final long MaskedCatchBlock = 0x8000L;
125 public static final long UnusedLocalVariable = 0x10000L;
126 public static final long UnusedArgument = 0x20000L;
127 public static final long NoImplicitStringConversion = 0x40000L;
128 public static final long AccessEmulation = 0x80000L;
129 public static final long NonExternalizedString = 0x100000L;
130 public static final long AssertUsedAsAnIdentifier = 0x200000L;
131 public static final long UnusedImport = 0x400000L;
132 public static final long NonStaticAccessToStatic = 0x800000L;
133 public static final long Task = 0x1000000L;
134 public static final long NoEffectAssignment = 0x2000000L;
135 public static final long IncompatibleNonInheritedInterfaceMethod = 0x4000000L;
136 public static final long UnusedPrivateMember = 0x8000000L;
137 public static final long LocalVariableHiding = 0x10000000L;
138 public static final long FieldHiding = 0x20000000L;
139 public static final long AccidentalBooleanAssign = 0x40000000L;
140 public static final long SuperfluousSemicolon = 0x80000000L;
141 public static final long IndirectStaticAccess = 0x100000000L;
142 public static final long UndocumentedEmptyBlock = 0x200000000L;
143 public static final long UnnecessaryTypeCheck = 0x400000000L;
144 public static final long InvalidJavadoc = 0x800000000L;
145 public static final long FinallyBlockNotCompleting = 0x1000000000L;
146 public static final long UnusedDeclaredThrownException = 0x2000000000L;
147 public static final long UnqualifiedFieldAccess = 0x4000000000L;
148 public static final long MissingJavadocTags = 0x8000000000L;
149 public static final long MissingJavadocComments = 0x10000000000L;
151 public static final long PHPVarDeprecatedWarning = 0x20000000000L;
152 // Default severity level for handlers
153 public long errorThreshold = 0;
155 public long warningThreshold =
156 MethodWithConstructorName
159 | OverriddenPackageDefaultMethod
161 | NonStaticAccessToStatic
163 | IncompatibleNonInheritedInterfaceMethod
164 | NoImplicitStringConversion
165 | FinallyBlockNotCompleting
166 | AssertUsedAsAnIdentifier
167 | PHPVarDeprecatedWarning;
170 public static final int Source = 1; // SourceFileAttribute
171 public static final int Lines = 2; // LineNumberAttribute
172 public static final int Vars = 4; // LocalVariableTableAttribute
174 // By default only lines and source attributes are generated.
175 public int produceDebugAttributes = Lines | Source;
177 // public long complianceLevel = JDK1_4; // by default be compliant with 1.4
178 // public long sourceLevel = JDK1_3; //1.3 source behavior by default
179 // public long targetJDK = JDK1_2; // default generates for JVM1.2
181 // toggle private access emulation for 1.2 (constr. accessor has extra arg on constructor) or 1.3 (make private constructor default access when access needed)
182 public boolean isPrivateConstructorAccessChangingVisibility = false; // by default, follows 1.2
184 // source encoding format
185 public String defaultEncoding = null; // will use the platform default encoding
187 // print what unit is being processed
188 public boolean verbose = Compiler.DEBUG;
190 // indicates if reference info is desired
191 public boolean produceReferenceInfo = false;
193 // indicates if unused/optimizable local variables need to be preserved (debugging purpose)
194 public boolean preserveAllLocalVariables = false;
196 // indicates whether literal expressions are inlined at parse-time or not
197 public boolean parseLiteralExpressionsAsConstants = true;
199 // max problems per compilation unit
200 public int maxProblemsPerUnit = 100; // no more than 100 problems per default
202 // tags used to recognize tasks in comments
203 public char[][] taskTags = null;
205 // priorities of tasks in comments
206 public char[][] taskPriorites = null;
208 // deprecation report
209 public boolean reportDeprecationInsideDeprecatedCode = false;
210 public boolean reportDeprecationWhenOverridingDeprecatedMethod = false;
212 // unused parameters report
213 public boolean reportUnusedParameterWhenImplementingAbstract = false;
214 public boolean reportUnusedParameterWhenOverridingConcrete = false;
216 // unused declaration of thrown exception
217 public boolean reportUnusedDeclaredThrownExceptionWhenOverriding = false;
219 // constructor/setter parameter hiding
220 public boolean reportSpecialParameterHidingField = false;
222 // check javadoc comments
223 public int reportInvalidJavadocTagsVisibility = AccPrivate;
224 public boolean reportInvalidJavadocTags = true;
226 // check missing javadoc tags
227 public int reportMissingJavadocTagsVisibility = AccPrivate;
228 public boolean reportMissingJavadocTagsOverriding = true;
230 // check missing javadoc comments
231 public int reportMissingJavadocCommentsVisibility = AccPublic;
232 public boolean reportMissingJavadocCommentsOverriding = true;
235 * Initializing the compiler options with defaults
237 public CompilerOptions(){
238 // use default options
242 * Initializing the compiler options with external settings
245 public CompilerOptions(Map settings){
247 if (settings == null) return;
251 public Map getMap() {
252 Map optionsMap = new HashMap(30);
253 optionsMap.put(OPTION_PHPVarDeprecatedWarning, getSeverityString(PHPVarDeprecatedWarning));
255 optionsMap.put(OPTION_LocalVariableAttribute, (this.produceDebugAttributes & Vars) != 0 ? GENERATE : DO_NOT_GENERATE);
256 optionsMap.put(OPTION_LineNumberAttribute, (this.produceDebugAttributes & Lines) != 0 ? GENERATE : DO_NOT_GENERATE);
257 optionsMap.put(OPTION_SourceFileAttribute, (this.produceDebugAttributes & Source) != 0 ? GENERATE : DO_NOT_GENERATE);
258 // optionsMap.put(OPTION_PreserveUnusedLocal, this.preserveAllLocalVariables ? PRESERVE : OPTIMIZE_OUT);
259 optionsMap.put(OPTION_ReportMethodWithConstructorName, getSeverityString(MethodWithConstructorName));
260 optionsMap.put(OPTION_ReportOverridingPackageDefaultMethod, getSeverityString(OverriddenPackageDefaultMethod));
261 optionsMap.put(OPTION_ReportDeprecation, getSeverityString(UsingDeprecatedAPI));
262 optionsMap.put(OPTION_ReportDeprecationInDeprecatedCode, this.reportDeprecationInsideDeprecatedCode ? ENABLED : DISABLED);
263 optionsMap.put(OPTION_ReportDeprecationWhenOverridingDeprecatedMethod, this.reportDeprecationWhenOverridingDeprecatedMethod ? ENABLED : DISABLED);
264 optionsMap.put(OPTION_ReportHiddenCatchBlock, getSeverityString(MaskedCatchBlock));
265 optionsMap.put(OPTION_ReportUnusedLocal, getSeverityString(UnusedLocalVariable));
266 optionsMap.put(OPTION_ReportUnusedParameter, getSeverityString(UnusedArgument));
267 optionsMap.put(OPTION_ReportUnusedImport, getSeverityString(UnusedImport));
268 optionsMap.put(OPTION_ReportSyntheticAccessEmulation, getSeverityString(AccessEmulation));
269 optionsMap.put(OPTION_ReportNoEffectAssignment, getSeverityString(NoEffectAssignment));
270 optionsMap.put(OPTION_ReportNonExternalizedStringLiteral, getSeverityString(NonExternalizedString));
271 optionsMap.put(OPTION_ReportNoImplicitStringConversion, getSeverityString(NoImplicitStringConversion));
272 optionsMap.put(OPTION_ReportNonStaticAccessToStatic, getSeverityString(NonStaticAccessToStatic));
273 optionsMap.put(OPTION_ReportIndirectStaticAccess, getSeverityString(IndirectStaticAccess));
274 optionsMap.put(OPTION_ReportIncompatibleNonInheritedInterfaceMethod, getSeverityString(IncompatibleNonInheritedInterfaceMethod));
275 optionsMap.put(OPTION_ReportUnusedPrivateMember, getSeverityString(UnusedPrivateMember));
276 optionsMap.put(OPTION_ReportLocalVariableHiding, getSeverityString(LocalVariableHiding));
277 optionsMap.put(OPTION_ReportFieldHiding, getSeverityString(FieldHiding));
278 optionsMap.put(OPTION_ReportPossibleAccidentalBooleanAssignment, getSeverityString(AccidentalBooleanAssign));
279 optionsMap.put(OPTION_ReportSuperfluousSemicolon, getSeverityString(SuperfluousSemicolon));
280 optionsMap.put(OPTION_ReportAssertIdentifier, getSeverityString(AssertUsedAsAnIdentifier));
281 optionsMap.put(OPTION_ReportUndocumentedEmptyBlock, getSeverityString(UndocumentedEmptyBlock));
282 optionsMap.put(OPTION_ReportUnnecessaryTypeCheck, getSeverityString(UnnecessaryTypeCheck));
283 optionsMap.put(OPTION_ReportInvalidJavadoc, getSeverityString(InvalidJavadoc));
284 optionsMap.put(OPTION_ReportInvalidJavadocTagsVisibility, getVisibilityString(this.reportInvalidJavadocTagsVisibility));
285 optionsMap.put(OPTION_ReportInvalidJavadocTags, this.reportInvalidJavadocTags? ENABLED : DISABLED);
286 optionsMap.put(OPTION_ReportMissingJavadocTags, getSeverityString(MissingJavadocTags));
287 optionsMap.put(OPTION_ReportMissingJavadocTagsVisibility, getVisibilityString(this.reportMissingJavadocTagsVisibility));
288 optionsMap.put(OPTION_ReportMissingJavadocTagsOverriding, this.reportMissingJavadocTagsOverriding ? ENABLED : DISABLED);
289 optionsMap.put(OPTION_ReportMissingJavadocComments, getSeverityString(MissingJavadocComments));
290 optionsMap.put(OPTION_ReportMissingJavadocCommentsVisibility, getVisibilityString(this.reportMissingJavadocCommentsVisibility));
291 optionsMap.put(OPTION_ReportMissingJavadocCommentsOverriding, this.reportMissingJavadocCommentsOverriding ? ENABLED : DISABLED);
292 optionsMap.put(OPTION_ReportFinallyBlockNotCompletingNormally, getSeverityString(FinallyBlockNotCompleting));
293 optionsMap.put(OPTION_ReportUnusedDeclaredThrownException, getSeverityString(UnusedDeclaredThrownException));
294 optionsMap.put(OPTION_ReportUnusedDeclaredThrownExceptionWhenOverriding, this.reportUnusedDeclaredThrownExceptionWhenOverriding ? ENABLED : DISABLED);
295 optionsMap.put(OPTION_ReportUnqualifiedFieldAccess, getSeverityString(UnqualifiedFieldAccess));
296 // optionsMap.put(OPTION_Compliance, versionFromJdkLevel(this.complianceLevel));
297 // optionsMap.put(OPTION_Source, versionFromJdkLevel(this.sourceLevel));
298 // optionsMap.put(OPTION_TargetPlatform, versionFromJdkLevel(this.targetJDK));
299 if (this.defaultEncoding != null) {
300 optionsMap.put(OPTION_Encoding, this.defaultEncoding);
302 optionsMap.put(OPTION_TaskTags, this.taskTags == null ? "" : new String(CharOperation.concatWith(this.taskTags,','))); //$NON-NLS-1$
303 optionsMap.put(OPTION_TaskPriorities, this.taskPriorites == null ? "" : new String(CharOperation.concatWith(this.taskPriorites,','))); //$NON-NLS-1$
304 optionsMap.put(OPTION_ReportUnusedParameterWhenImplementingAbstract, this.reportUnusedParameterWhenImplementingAbstract ? ENABLED : DISABLED);
305 optionsMap.put(OPTION_ReportUnusedParameterWhenOverridingConcrete, this.reportUnusedParameterWhenOverridingConcrete ? ENABLED : DISABLED);
306 optionsMap.put(OPTION_ReportSpecialParameterHidingField, this.reportSpecialParameterHidingField ? ENABLED : DISABLED);
307 optionsMap.put(OPTION_MaxProblemPerUnit, String.valueOf(this.maxProblemsPerUnit));
312 public int getSeverity(long irritant) {
313 if((this.warningThreshold & irritant) != 0)
315 if((this.errorThreshold & irritant) != 0)
320 public String getSeverityString(long irritant) {
321 if((this.warningThreshold & irritant) != 0)
323 if((this.errorThreshold & irritant) != 0)
328 public String getVisibilityString(int level) {
341 public void set(Map optionsMap) {
344 if ((optionValue = optionsMap.get(OPTION_LocalVariableAttribute)) != null) {
345 if (GENERATE.equals(optionValue)) {
346 this.produceDebugAttributes |= Vars;
347 } else if (DO_NOT_GENERATE.equals(optionValue)) {
348 this.produceDebugAttributes &= ~Vars;
351 if ((optionValue = optionsMap.get(OPTION_LineNumberAttribute)) != null) {
352 if (GENERATE.equals(optionValue)) {
353 this.produceDebugAttributes |= Lines;
354 } else if (DO_NOT_GENERATE.equals(optionValue)) {
355 this.produceDebugAttributes &= ~Lines;
358 if ((optionValue = optionsMap.get(OPTION_SourceFileAttribute)) != null) {
359 if (GENERATE.equals(optionValue)) {
360 this.produceDebugAttributes |= Source;
361 } else if (DO_NOT_GENERATE.equals(optionValue)) {
362 this.produceDebugAttributes &= ~Source;
365 // if ((optionValue = optionsMap.get(OPTION_PreserveUnusedLocal)) != null) {
366 // if (PRESERVE.equals(optionValue)) {
367 // this.preserveAllLocalVariables = true;
368 // } else if (OPTIMIZE_OUT.equals(optionValue)) {
369 // this.preserveAllLocalVariables = false;
372 if ((optionValue = optionsMap.get(OPTION_ReportDeprecationInDeprecatedCode)) != null) {
373 if (ENABLED.equals(optionValue)) {
374 this.reportDeprecationInsideDeprecatedCode = true;
375 } else if (DISABLED.equals(optionValue)) {
376 this.reportDeprecationInsideDeprecatedCode = false;
379 if ((optionValue = optionsMap.get(OPTION_ReportDeprecationWhenOverridingDeprecatedMethod)) != null) {
380 if (ENABLED.equals(optionValue)) {
381 this.reportDeprecationWhenOverridingDeprecatedMethod = true;
382 } else if (DISABLED.equals(optionValue)) {
383 this.reportDeprecationWhenOverridingDeprecatedMethod = false;
386 if ((optionValue = optionsMap.get(OPTION_ReportUnusedDeclaredThrownExceptionWhenOverriding)) != null) {
387 if (ENABLED.equals(optionValue)) {
388 this.reportUnusedDeclaredThrownExceptionWhenOverriding = true;
389 } else if (DISABLED.equals(optionValue)) {
390 this.reportUnusedDeclaredThrownExceptionWhenOverriding = false;
393 // if ((optionValue = optionsMap.get(OPTION_Compliance)) != null) {
394 // long level = versionToJdkLevel(optionValue);
395 // if (level != 0) this.complianceLevel = level;
397 // if ((optionValue = optionsMap.get(OPTION_Source)) != null) {
398 // long level = versionToJdkLevel(optionValue);
399 // if (level != 0) this.sourceLevel = level;
401 // if ((optionValue = optionsMap.get(OPTION_TargetPlatform)) != null) {
402 // long level = versionToJdkLevel(optionValue);
403 // if (level != 0) this.targetJDK = level;
405 if ((optionValue = optionsMap.get(OPTION_Encoding)) != null) {
406 if (optionValue instanceof String) {
407 this.defaultEncoding = null;
408 String stringValue = (String) optionValue;
409 if (stringValue.length() > 0){
411 new InputStreamReader(new ByteArrayInputStream(new byte[0]), stringValue);
412 this.defaultEncoding = stringValue;
413 } catch(UnsupportedEncodingException e){
414 // ignore unsupported encoding
419 // if ((optionValue = optionsMap.get(OPTION_PrivateConstructorAccess)) != null) {
420 // long level = versionToJdkLevel(optionValue);
421 // if (level >= JDK1_3) this.isPrivateConstructorAccessChangingVisibility = true;
423 if ((optionValue = optionsMap.get(OPTION_ReportUnusedParameterWhenImplementingAbstract)) != null) {
424 if (ENABLED.equals(optionValue)) {
425 this.reportUnusedParameterWhenImplementingAbstract = true;
426 } else if (DISABLED.equals(optionValue)) {
427 this.reportUnusedParameterWhenImplementingAbstract = false;
430 if ((optionValue = optionsMap.get(OPTION_ReportUnusedParameterWhenOverridingConcrete)) != null) {
431 if (ENABLED.equals(optionValue)) {
432 this.reportUnusedParameterWhenOverridingConcrete = true;
433 } else if (DISABLED.equals(optionValue)) {
434 this.reportUnusedParameterWhenOverridingConcrete = false;
437 if ((optionValue = optionsMap.get(OPTION_ReportSpecialParameterHidingField)) != null) {
438 if (ENABLED.equals(optionValue)) {
439 this.reportSpecialParameterHidingField = true;
440 } else if (DISABLED.equals(optionValue)) {
441 this.reportSpecialParameterHidingField = false;
444 if ((optionValue = optionsMap.get(OPTION_MaxProblemPerUnit)) != null) {
445 if (optionValue instanceof String) {
446 String stringValue = (String) optionValue;
448 int val = Integer.parseInt(stringValue);
449 if (val >= 0) this.maxProblemsPerUnit = val;
450 } catch(NumberFormatException e){
451 // ignore ill-formatted limit
455 if ((optionValue = optionsMap.get(OPTION_TaskTags)) != null) {
456 if (optionValue instanceof String) {
457 String stringValue = (String) optionValue;
458 if (stringValue.length() == 0) {
459 this.taskTags = null;
461 this.taskTags = CharOperation.splitAndTrimOn(',', stringValue.toCharArray());
465 if ((optionValue = optionsMap.get(OPTION_TaskPriorities)) != null) {
466 if (optionValue instanceof String) {
467 String stringValue = (String) optionValue;
468 if (stringValue.length() == 0) {
469 this.taskPriorites = null;
471 this.taskPriorites = CharOperation.splitAndTrimOn(',', stringValue.toCharArray());
475 if ((optionValue = optionsMap.get(OPTION_PHPVarDeprecatedWarning)) != null) updateSeverity(PHPVarDeprecatedWarning, optionValue);
477 if ((optionValue = optionsMap.get(OPTION_ReportMethodWithConstructorName)) != null) updateSeverity(MethodWithConstructorName, optionValue);
478 if ((optionValue = optionsMap.get(OPTION_ReportOverridingPackageDefaultMethod)) != null) updateSeverity(OverriddenPackageDefaultMethod, optionValue);
479 if ((optionValue = optionsMap.get(OPTION_ReportDeprecation)) != null) updateSeverity(UsingDeprecatedAPI, optionValue);
480 if ((optionValue = optionsMap.get(OPTION_ReportHiddenCatchBlock)) != null) updateSeverity(MaskedCatchBlock, optionValue);
481 if ((optionValue = optionsMap.get(OPTION_ReportUnusedLocal)) != null) updateSeverity(UnusedLocalVariable, optionValue);
482 if ((optionValue = optionsMap.get(OPTION_ReportUnusedParameter)) != null) updateSeverity(UnusedArgument, optionValue);
483 if ((optionValue = optionsMap.get(OPTION_ReportUnusedImport)) != null) updateSeverity(UnusedImport, optionValue);
484 if ((optionValue = optionsMap.get(OPTION_ReportUnusedPrivateMember)) != null) updateSeverity(UnusedPrivateMember, optionValue);
485 if ((optionValue = optionsMap.get(OPTION_ReportUnusedDeclaredThrownException)) != null) updateSeverity(UnusedDeclaredThrownException, optionValue);
486 if ((optionValue = optionsMap.get(OPTION_ReportNoImplicitStringConversion)) != null) updateSeverity(NoImplicitStringConversion, optionValue);
487 if ((optionValue = optionsMap.get(OPTION_ReportSyntheticAccessEmulation)) != null) updateSeverity(AccessEmulation, optionValue);
488 if ((optionValue = optionsMap.get(OPTION_ReportLocalVariableHiding)) != null) updateSeverity(LocalVariableHiding, optionValue);
489 if ((optionValue = optionsMap.get(OPTION_ReportFieldHiding)) != null) updateSeverity(FieldHiding, optionValue);
490 if ((optionValue = optionsMap.get(OPTION_ReportPossibleAccidentalBooleanAssignment)) != null) updateSeverity(AccidentalBooleanAssign, optionValue);
491 if ((optionValue = optionsMap.get(OPTION_ReportSuperfluousSemicolon)) != null) updateSeverity(SuperfluousSemicolon, optionValue);
492 if ((optionValue = optionsMap.get(OPTION_ReportNonExternalizedStringLiteral)) != null) updateSeverity(NonExternalizedString, optionValue);
493 if ((optionValue = optionsMap.get(OPTION_ReportAssertIdentifier)) != null) updateSeverity(AssertUsedAsAnIdentifier, optionValue);
494 if ((optionValue = optionsMap.get(OPTION_ReportNonStaticAccessToStatic)) != null) updateSeverity(NonStaticAccessToStatic, optionValue);
495 if ((optionValue = optionsMap.get(OPTION_ReportIndirectStaticAccess)) != null) updateSeverity(IndirectStaticAccess, optionValue);
496 if ((optionValue = optionsMap.get(OPTION_ReportIncompatibleNonInheritedInterfaceMethod)) != null) updateSeverity(IncompatibleNonInheritedInterfaceMethod, optionValue);
497 if ((optionValue = optionsMap.get(OPTION_ReportUndocumentedEmptyBlock)) != null) updateSeverity(UndocumentedEmptyBlock, optionValue);
498 if ((optionValue = optionsMap.get(OPTION_ReportUnnecessaryTypeCheck)) != null) updateSeverity(UnnecessaryTypeCheck, optionValue);
499 if ((optionValue = optionsMap.get(OPTION_ReportFinallyBlockNotCompletingNormally)) != null) updateSeverity(FinallyBlockNotCompleting, optionValue);
500 if ((optionValue = optionsMap.get(OPTION_ReportUnqualifiedFieldAccess)) != null) updateSeverity(UnqualifiedFieldAccess, optionValue);
501 if ((optionValue = optionsMap.get(OPTION_ReportNoEffectAssignment)) != null) updateSeverity(NoEffectAssignment, optionValue);
504 if ((optionValue = optionsMap.get(OPTION_ReportInvalidJavadoc)) != null) {
505 updateSeverity(InvalidJavadoc, optionValue);
507 if ((optionValue = optionsMap.get(OPTION_ReportInvalidJavadocTagsVisibility)) != null) {
508 if (PUBLIC.equals(optionValue)) {
509 this.reportInvalidJavadocTagsVisibility = AccPublic;
510 } else if (PROTECTED.equals(optionValue)) {
511 this.reportInvalidJavadocTagsVisibility = AccProtected;
512 // } else if (DEFAULT.equals(optionValue)) {
513 // this.reportInvalidJavadocTagsVisibility = AccDefault;
514 } else if (PRIVATE.equals(optionValue)) {
515 this.reportInvalidJavadocTagsVisibility = AccPrivate;
518 if ((optionValue = optionsMap.get(OPTION_ReportInvalidJavadocTags)) != null) {
519 if (ENABLED.equals(optionValue)) {
520 this.reportInvalidJavadocTags= true;
521 } else if (DISABLED.equals(optionValue)) {
522 this.reportInvalidJavadocTags = false;
525 if ((optionValue = optionsMap.get(OPTION_ReportMissingJavadocTags)) != null) {
526 updateSeverity(MissingJavadocTags, optionValue);
528 if ((optionValue = optionsMap.get(OPTION_ReportMissingJavadocTagsVisibility)) != null) {
529 if (PUBLIC.equals(optionValue)) {
530 this.reportMissingJavadocTagsVisibility = AccPublic;
531 } else if (PROTECTED.equals(optionValue)) {
532 this.reportMissingJavadocTagsVisibility = AccProtected;
533 // } else if (DEFAULT.equals(optionValue)) {
534 // this.reportMissingJavadocTagsVisibility = AccDefault;
535 } else if (PRIVATE.equals(optionValue)) {
536 this.reportMissingJavadocTagsVisibility = AccPrivate;
539 if ((optionValue = optionsMap.get(OPTION_ReportMissingJavadocTagsOverriding)) != null) {
540 if (ENABLED.equals(optionValue)) {
541 this.reportMissingJavadocTagsOverriding = true;
542 } else if (DISABLED.equals(optionValue)) {
543 this.reportMissingJavadocTagsOverriding = false;
546 if ((optionValue = optionsMap.get(OPTION_ReportMissingJavadocComments)) != null) {
547 updateSeverity(MissingJavadocComments, optionValue);
549 if ((optionValue = optionsMap.get(OPTION_ReportMissingJavadocCommentsVisibility)) != null) {
550 if (PUBLIC.equals(optionValue)) {
551 this.reportMissingJavadocCommentsVisibility = AccPublic;
552 } else if (PROTECTED.equals(optionValue)) {
553 this.reportMissingJavadocCommentsVisibility = AccProtected;
554 // } else if (DEFAULT.equals(optionValue)) {
555 // this.reportMissingJavadocCommentsVisibility = AccDefault;
556 } else if (PRIVATE.equals(optionValue)) {
557 this.reportMissingJavadocCommentsVisibility = AccPrivate;
560 if ((optionValue = optionsMap.get(OPTION_ReportMissingJavadocCommentsOverriding)) != null) {
561 if (ENABLED.equals(optionValue)) {
562 this.reportMissingJavadocCommentsOverriding = true;
563 } else if (DISABLED.equals(optionValue)) {
564 this.reportMissingJavadocCommentsOverriding = false;
569 public void setVerboseMode(boolean flag) {
573 public String toString() {
575 StringBuffer buf = new StringBuffer("CompilerOptions:"); //$NON-NLS-1$
576 buf.append("\n\t- var is deprecated keyword: ").append(getSeverityString(PHPVarDeprecatedWarning)); //$NON-NLS-1$
578 buf.append("\n\t- local variables debug attributes: ").append((this.produceDebugAttributes & Vars) != 0 ? "ON" : " OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
579 buf.append("\n\t- line number debug attributes: ").append((this.produceDebugAttributes & Lines) != 0 ? "ON" : " OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
580 buf.append("\n\t- source debug attributes: ").append((this.produceDebugAttributes & Source) != 0 ? "ON" : " OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
581 buf.append("\n\t- preserve all local variables: ").append(this.preserveAllLocalVariables ? "ON" : " OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
582 buf.append("\n\t- method with constructor name: ").append(getSeverityString(MethodWithConstructorName)); //$NON-NLS-1$
583 buf.append("\n\t- overridden package default method: ").append(getSeverityString(OverriddenPackageDefaultMethod)); //$NON-NLS-1$
584 buf.append("\n\t- deprecation: ").append(getSeverityString(UsingDeprecatedAPI)); //$NON-NLS-1$
585 buf.append("\n\t- masked catch block: ").append(getSeverityString(MaskedCatchBlock)); //$NON-NLS-1$
586 buf.append("\n\t- unused local variable: ").append(getSeverityString(UnusedLocalVariable)); //$NON-NLS-1$
587 buf.append("\n\t- unused parameter: ").append(getSeverityString(UnusedArgument)); //$NON-NLS-1$
588 buf.append("\n\t- unused import: ").append(getSeverityString(UnusedImport)); //$NON-NLS-1$
589 buf.append("\n\t- synthetic access emulation: ").append(getSeverityString(AccessEmulation)); //$NON-NLS-1$
590 buf.append("\n\t- assignment with no effect: ").append(getSeverityString(NoEffectAssignment)); //$NON-NLS-1$
591 buf.append("\n\t- non externalized string: ").append(getSeverityString(NonExternalizedString)); //$NON-NLS-1$
592 buf.append("\n\t- static access receiver: ").append(getSeverityString(NonStaticAccessToStatic)); //$NON-NLS-1$
593 buf.append("\n\t- indirect static access: ").append(getSeverityString(IndirectStaticAccess)); //$NON-NLS-1$
594 buf.append("\n\t- incompatible non inherited interface method: ").append(getSeverityString(IncompatibleNonInheritedInterfaceMethod)); //$NON-NLS-1$
595 buf.append("\n\t- unused private member: ").append(getSeverityString(UnusedPrivateMember)); //$NON-NLS-1$
596 buf.append("\n\t- local variable hiding another variable: ").append(getSeverityString(LocalVariableHiding)); //$NON-NLS-1$
597 buf.append("\n\t- field hiding another variable: ").append(getSeverityString(FieldHiding)); //$NON-NLS-1$
598 buf.append("\n\t- possible accidental boolean assignment: ").append(getSeverityString(AccidentalBooleanAssign)); //$NON-NLS-1$
599 buf.append("\n\t- superfluous semicolon: ").append(getSeverityString(SuperfluousSemicolon)); //$NON-NLS-1$
600 buf.append("\n\t- uncommented empty block: ").append(getSeverityString(UndocumentedEmptyBlock)); //$NON-NLS-1$
601 buf.append("\n\t- unnecessary type check: ").append(getSeverityString(UnnecessaryTypeCheck)); //$NON-NLS-1$
602 buf.append("\n\t- invalid javadoc: ").append(getSeverityString(InvalidJavadoc)); //$NON-NLS-1$
603 buf.append("\n\t- report invalid javadoc tags: ").append(this.reportInvalidJavadocTags ? ENABLED : DISABLED); //$NON-NLS-1$
604 buf.append("\n\t- visibility level to report invalid javadoc tags: ").append(getVisibilityString(this.reportInvalidJavadocTagsVisibility)); //$NON-NLS-1$
605 buf.append("\n\t- missing javadoc tags: ").append(getSeverityString(MissingJavadocTags)); //$NON-NLS-1$
606 buf.append("\n\t- visibility level to report missing javadoc tags: ").append(getVisibilityString(this.reportMissingJavadocTagsVisibility)); //$NON-NLS-1$
607 buf.append("\n\t- report missing javadoc tags in overriding methods: ").append(this.reportMissingJavadocTagsOverriding ? ENABLED : DISABLED); //$NON-NLS-1$
608 buf.append("\n\t- missing javadoc comments: ").append(getSeverityString(MissingJavadocComments)); //$NON-NLS-1$
609 buf.append("\n\t- visibility level to report missing javadoc comments: ").append(getVisibilityString(this.reportMissingJavadocCommentsVisibility)); //$NON-NLS-1$
610 buf.append("\n\t- report missing javadoc comments in overriding methods: ").append(this.reportMissingJavadocCommentsOverriding ? ENABLED : DISABLED); //$NON-NLS-1$
611 buf.append("\n\t- finally block not completing normally: ").append(getSeverityString(FinallyBlockNotCompleting)); //$NON-NLS-1$
612 buf.append("\n\t- unused declared thrown exception: ").append(getSeverityString(UnusedDeclaredThrownException)); //$NON-NLS-1$
613 buf.append("\n\t- unused declared thrown exception when overriding ").append(this.reportUnusedDeclaredThrownExceptionWhenOverriding ? ENABLED : DISABLED); //$NON-NLS-1$
614 // buf.append("\n\t- JDK compliance level: "+ versionFromJdkLevel(this.complianceLevel)); //$NON-NLS-1$
615 // buf.append("\n\t- JDK source level: "+ versionFromJdkLevel(this.sourceLevel)); //$NON-NLS-1$
616 // buf.append("\n\t- JDK target level: "+ versionFromJdkLevel(this.targetJDK)); //$NON-NLS-1$
617 buf.append("\n\t- private constructor access: ").append(this.isPrivateConstructorAccessChangingVisibility ? "extra argument" : "make default access"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
618 buf.append("\n\t- verbose : ").append(this.verbose ? "ON" : "OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
619 buf.append("\n\t- produce reference info : ").append(this.produceReferenceInfo ? "ON" : "OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
620 buf.append("\n\t- parse literal expressions as constants : ").append(this.parseLiteralExpressionsAsConstants ? "ON" : "OFF"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
621 buf.append("\n\t- encoding : ").append(this.defaultEncoding == null ? "<default>" : this.defaultEncoding); //$NON-NLS-1$ //$NON-NLS-2$
622 buf.append("\n\t- task tags: ").append(this.taskTags == null ? "" : new String(CharOperation.concatWith(this.taskTags,','))); //$NON-NLS-1$ //$NON-NLS-2$
623 buf.append("\n\t- task priorities : ").append(this.taskPriorites == null ? "" : new String(CharOperation.concatWith(this.taskPriorites,','))); //$NON-NLS-1$ //$NON-NLS-2$
624 buf.append("\n\t- report deprecation inside deprecated code : ").append(this.reportDeprecationInsideDeprecatedCode ? "ENABLED" : "DISABLED"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
625 buf.append("\n\t- report deprecation when overriding deprecated method : ").append(this.reportDeprecationWhenOverridingDeprecatedMethod ? "ENABLED" : "DISABLED"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
626 buf.append("\n\t- report unused parameter when implementing abstract method : ").append(this.reportUnusedParameterWhenImplementingAbstract ? "ENABLED" : "DISABLED"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
627 buf.append("\n\t- report unused parameter when overriding concrete method : ").append(this.reportUnusedParameterWhenOverridingConcrete ? "ENABLED" : "DISABLED"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
628 buf.append("\n\t- report constructor/setter parameter hiding existing field : ").append(this.reportSpecialParameterHidingField ? "ENABLED" : "DISABLED"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
629 return buf.toString();
632 void updateSeverity(long irritant, Object severityString) {
633 if (ERROR.equals(severityString)) {
634 this.errorThreshold |= irritant;
635 this.warningThreshold &= ~irritant;
636 } else if (WARNING.equals(severityString)) {
637 this.errorThreshold &= ~irritant;
638 this.warningThreshold |= irritant;
639 } else if (IGNORE.equals(severityString)) {
640 this.errorThreshold &= ~irritant;
641 this.warningThreshold &= ~irritant;
644 // public static long versionToJdkLevel(Object versionID) {
645 // if (VERSION_1_1.equals(versionID)) {
647 // } else if (VERSION_1_2.equals(versionID)) {
649 // } else if (VERSION_1_3.equals(versionID)) {
651 // } else if (VERSION_1_4.equals(versionID)) {
653 // } else if (VERSION_1_5.equals(versionID)) {
656 // return 0; // unknown
659 // public static String versionFromJdkLevel(long jdkLevel) {
660 // if (jdkLevel == JDK1_1) {
661 // return VERSION_1_1;
662 // } else if (jdkLevel == JDK1_2) {
663 // return VERSION_1_2;
664 // } else if (jdkLevel == JDK1_3) {
665 // return VERSION_1_3;
666 // } else if (jdkLevel == JDK1_4) {
667 // return VERSION_1_4;
668 // } else if (jdkLevel == JDK1_5) {
669 // return VERSION_1_5;
671 // return ""; // unknown version //$NON-NLS-1$